1 .\" Copyright (c) 1989, 1991, 1993
2 .\" The Regents of the University of California. All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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 .\" 3. All advertising materials mentioning features or use of this software
13 .\" must display the following acknowledgement:
14 .\" This product includes software developed by the University of
15 .\" California, Berkeley and its contributors.
16 .\" 4. Neither the name of the University nor the names of its contributors
17 .\" may be used to endorse or promote products derived from this software
18 .\" without specific prior written permission.
20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 .\" @(#)getttyent.3 8.1 (Berkeley) 6/4/93
33 .\" $FreeBSD: src/lib/libc/gen/getttyent.3,v 1.9.2.4 2003/03/13 18:05:37 trhodes Exp $
34 .\" $DragonFly: src/lib/libcr/gen/Attic/getttyent.3,v 1.2 2003/06/17 04:26:42 dillon Exp $
44 .Nd get ttys file entry
47 .Nd determine tty type from ttys file entry
55 .Fn getttynam "const char *name"
61 .Fn isdialuptty "const char *name"
63 .Fn isnettty "const char *name"
70 each return a pointer to an object, with the following structure,
71 containing the broken-out fields of a line from the tty description
75 char *ty_name; /* terminal device name */
76 char *ty_getty; /* command to execute, usually getty */
77 char *ty_type; /* terminal type for termcap */
78 #define TTY_ON 0x01 /* enable logins (start ty_getty program) */
79 #define TTY_SECURE 0x02 /* allow uid of 0 to login */
80 #define TTY_DIALUP 0x04 /* is a dialup tty */
81 #define TTY_NETWORK 0x08 /* is a network tty */
82 int ty_status; /* status flags */
83 char *ty_window; /* command to start up window manager */
84 char *ty_comment; /* comment field */
85 char *ty_group; /* tty group name */
89 The fields are as follows:
90 .Bl -tag -width ty_comment
92 The name of the character-special file.
94 The name of the command invoked by
96 to initialize tty line characteristics.
98 The name of the default terminal type connected to this tty line.
100 A mask of bit fields which indicate various actions allowed on this
102 The possible flags are as follows:
103 .Bl -tag -width TTY_NETWORK
105 Enables logins (i.e.,
107 will start the command referenced by
111 Allow users with a uid of 0 to login on this terminal.
113 Identifies a tty as a dialin line.
114 If this flag is set, then
116 will return a non-zero value.
118 Identifies a tty used for network connections.
119 If this flag is set, then
121 will return a non-zero value.
124 The command to execute for a window system associated with the line.
126 A group name to which the tty belongs.
127 If no group is specified in the ttys description file,
128 then the tty is placed in an anonymous group called "none".
130 Any trailing comment field, with any leading hash marks (``#'') or
134 If any of the fields pointing to character strings are unspecified,
135 they are returned as null pointers.
138 will be zero if no flag values are specified.
142 for a more complete discussion of the meaning and usage of the
148 reads the next line from the ttys file, opening the file if necessary.
152 rewinds the file if open, or opens the file if it is unopened.
156 closes any open files.
161 searches from the beginning of the file until a matching
172 return a null pointer on
180 return 0 on failure and 1 on success.
186 return non-zero if the dialup or network flag is set for the
187 tty entry relating to the tty named by the argument, and
190 .Bl -tag -width /etc/ttys -compact
208 functions appeared in
211 These functions use static data storage;
212 if the data is needed for future use, it should be
213 copied before any subsequent calls overwrite it.