xref: /freebsd/lib/libc/gen/getttyent.3 (revision 1e413cf93298b5b97441a21d9a50fdcd0ee9945e)
1.\" Copyright (c) 1989, 1991, 1993
2.\"	The Regents of the University of California.  All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\" 4. Neither the name of the University nor the names of its contributors
13.\"    may be used to endorse or promote products derived from this software
14.\"    without specific prior written permission.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26.\" SUCH DAMAGE.
27.\"
28.\"     @(#)getttyent.3	8.1 (Berkeley) 6/4/93
29.\" $FreeBSD$
30.\"
31.Dd November 17, 1996
32.Dt GETTTYENT 3
33.Os
34.Sh NAME
35.Nm getttyent ,
36.Nm getttynam ,
37.Nm setttyent ,
38.Nm endttyent ,
39.Nm isdialuptty ,
40.Nm isnettty
41.Nd
42.Xr ttys 5
43file routines
44.Sh LIBRARY
45.Lb libc
46.Sh SYNOPSIS
47.In ttyent.h
48.Ft struct ttyent *
49.Fn getttyent void
50.Ft struct ttyent *
51.Fn getttynam "const char *name"
52.Ft int
53.Fn setttyent void
54.Ft int
55.Fn endttyent void
56.Ft int
57.Fn isdialuptty "const char *name"
58.Ft int
59.Fn isnettty "const char *name"
60.Sh DESCRIPTION
61The
62.Fn getttyent ,
63and
64.Fn getttynam
65functions
66each return a pointer to an object, with the following structure,
67containing the broken-out fields of a line from the tty description
68file.
69.Bd -literal
70struct ttyent {
71	char	*ty_name;	/* terminal device name */
72	char	*ty_getty;	/* command to execute, usually getty */
73	char	*ty_type;	/* terminal type for termcap */
74#define	TTY_ON		0x01	/* enable logins (start ty_getty program) */
75#define	TTY_SECURE	0x02	/* allow uid of 0 to login */
76#define	TTY_DIALUP	0x04	/* is a dialup tty */
77#define	TTY_NETWORK	0x08	/* is a network tty */
78	int	ty_status;	/* status flags */
79	char	*ty_window;	/* command to start up window manager */
80	char	*ty_comment;	/* comment field */
81	char	*ty_group;	/* tty group name */
82};
83.Ed
84.Pp
85The fields are as follows:
86.Bl -tag -width ty_comment
87.It Fa ty_name
88The name of the character-special file.
89.It Fa ty_getty
90The name of the command invoked by
91.Xr init 8
92to initialize tty line characteristics.
93.It Fa ty_type
94The name of the default terminal type connected to this tty line.
95.It Fa ty_status
96A mask of bit fields which indicate various actions allowed on this
97tty line.
98The possible flags are as follows:
99.Bl -tag -width TTY_NETWORK
100.It Dv TTY_ON
101Enables logins (i.e.,
102.Xr init 8
103will start the command referenced by
104.Fa ty_getty
105on this entry).
106.It Dv TTY_SECURE
107Allow users with a uid of 0 to login on this terminal.
108.It Dv TTY_DIALUP
109Identifies a tty as a dialin line.
110If this flag is set, then
111.Fn isdialuptty
112will return a non-zero value.
113.It Dv TTY_NETWORK
114Identifies a tty used for network connections.
115If this flag is set, then
116.Fn isnettty
117will return a non-zero value.
118.El
119.It Fa ty_window
120The command to execute for a window system associated with the line.
121.It Fa ty_group
122A group name to which the tty belongs.
123If no group is specified in the ttys description file,
124then the tty is placed in an anonymous group called "none".
125.It Fa ty_comment
126Any trailing comment field, with any leading hash marks (``#'') or
127whitespace removed.
128.El
129.Pp
130If any of the fields pointing to character strings are unspecified,
131they are returned as null pointers.
132The field
133.Fa ty_status
134will be zero if no flag values are specified.
135.Pp
136See
137.Xr ttys 5
138for a more complete discussion of the meaning and usage of the
139fields.
140.Pp
141The
142.Fn getttyent
143function
144reads the next line from the ttys file, opening the file if necessary.
145The
146.Fn setttyent
147function
148rewinds the file if open, or opens the file if it is unopened.
149The
150.Fn endttyent
151function
152closes any open files.
153.Pp
154The
155.Fn getttynam
156function
157searches from the beginning of the file until a matching
158.Fa name
159is found
160(or until
161.Dv EOF
162is encountered).
163.Sh RETURN VALUES
164The routines
165.Fn getttyent
166and
167.Fn getttynam
168return a null pointer on
169.Dv EOF
170or error.
171The
172.Fn setttyent
173function
174and
175.Fn endttyent
176return 0 on failure and 1 on success.
177.Pp
178The routines
179.Fn isdialuptty
180and
181.Fn isnettty
182return non-zero if the dialup or network flag is set for the
183tty entry relating to the tty named by the argument, and
184zero otherwise.
185.Sh FILES
186.Bl -tag -width /etc/ttys -compact
187.It Pa /etc/ttys
188.El
189.Sh SEE ALSO
190.Xr login 1 ,
191.Xr ttyslot 3 ,
192.Xr gettytab 5 ,
193.Xr termcap 5 ,
194.Xr ttys 5 ,
195.Xr getty 8 ,
196.Xr init 8
197.Sh HISTORY
198The
199.Fn getttyent ,
200.Fn getttynam ,
201.Fn setttyent ,
202and
203.Fn endttyent
204functions appeared in
205.Bx 4.3 .
206.Sh BUGS
207These functions use static data storage;
208if the data is needed for future use, it should be
209copied before any subsequent calls overwrite it.
210