Copyright (c) 1989, 1991, 1993
The Regents of the University of California. All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
3. Neither the name of the University nor the names of its contributors
may be used to endorse or promote products derived from this software
without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.
@(#)getttyent.3 8.1 (Berkeley) 6/4/93
.Dd February 7, 2014 .Dt GETTTYENT 3 .Os .Sh NAME .Nm getttyent , .Nm getttynam , .Nm setttyent , .Nm setttyentpath , .Nm endttyent .Nd get ttys file entry .Sh LIBRARY .Lb libc .Sh SYNOPSIS n ttyent.h .Ft struct ttyent * .Fn getttyent void .Ft struct ttyent * .Fn getttynam "const char *name" .Ft int .Fn setttyent void .Ft int .Fn setttyentpath "const char *path" .Ft int .Fn endttyent void .Sh DESCRIPTION The .Fn getttyent , and .Fn getttynam functions each return a pointer to an object, with the following structure, containing the broken-out fields of a line from the tty description file. d -literal struct ttyent { char *ty_name; /* terminal device name */ char *ty_getty; /* command to execute */ char *ty_type; /* terminal type */ #define TTY_ON 0x01 /* enable logins */ #define TTY_SECURE 0x02 /* allow uid of 0 to login */ #define TTY_LOCAL 0x04 /* set 'CLOCAL' on open (dev. specific) */ #define TTY_RTSCTS 0x08 /* set 'CRTSCTS' on open (dev. specific) */ #define TTY_SOFTCAR 0x10 /* ignore hardware carrier (dev. spec.) */ #define TTY_MDMBUF 0x20 /* set 'MDMBUF' on open (dev. specific) */ #define TTY_DTRCTS 0x40 /* set 'CDTRCTS' on open (dev. specific) */ int ty_status; /* flag values */ char *ty_window; /* command for window manager */ char *ty_comment; /* comment field */ char *ty_class; /* category of tty usage */ }; .Ed
p The fields are as follows: l -tag -width ty_comment t Fa ty_name The name of the character-special file. t Fa ty_getty The name of the command invoked by .Xr init 8 to initialize tty line characteristics. t Fa ty_type The name of the default terminal type connected to this tty line. t Fa ty_status A mask of bit fields which indicate various actions allowed on this tty line. The possible flags are as follows: l -tag -width TTY_SOFTCAR t Dv TTY_ON Enables logins (i.e., .Xr init 8 will start the command referenced by .Fa ty_getty on this entry). t Dv TTY_SECURE Allow users with a uid of 0 to login on this terminal. t Dv TTY_LOCAL If the terminal port's driver supports it, cause the line to be treated as ``local.'' t Dv TTY_MDMBUF If the terminal port's driver supports it, use DTR/DCD hardware flow control on the line by default. t Dv TTY_RTSCTS If the terminal port's driver supports it, use full-duplex RTS/CTS hardware flow control on the line by default. t Dv TTY_SOFTCAR If the terminal port's driver supports it, ignore hardware carrier on the line. .El t Fa ty_window The command to execute for a window system associated with the line. t Fa ty_comment Any trailing comment field, with any leading hash marks (``#'') or whitespace removed. t Fa ty_class A key indexing into a capfile style database (/etc/ttyclasses) of attributes for this class of tty. No attributes are currently defined or used, so there are currently no functions to retrieve them. .El
p If any of the fields pointing to character strings are unspecified, they are returned as null pointers. The field .Fa ty_status will be zero if no flag values are specified.
p See .Xr ttys 5 for a more complete discussion of the meaning and usage of the fields.
p The .Fn getttyent function reads the next line from the ttys file, opening the file if necessary. The .Fn setttyent function rewinds the file if open, or opens the file if it is unopened. The .Fn setttyentpath function is equivalent to .Fn setttyent but accepts an additional argument to read the ttys information from an alternate file instead of the default location
q defined in Dv _PATH_TTYS . The .Fn endttyent function closes any open files.
p The .Fn getttynam function searches from the beginning of the file until a matching .Fa name is found (or until .Dv EOF is encountered). .Sh RETURN VALUES The routines .Fn getttyent and .Fn getttynam return a null pointer on .Dv EOF or error. The .Fn setttyent and .Fn setttyentpath functions and .Fn endttyent return 0 on failure and 1 on success. .Sh FILES l -tag -width /etc/ttys -compact t Pa /etc/ttys .El .Sh SEE ALSO .Xr login 1 , .Xr ttyslot 3 , .Xr capfile 5 , .Xr gettytab 5 , .Xr ttys 5 , .Xr getty 8 , .Xr init 8 , .Xr ttyflags 8 .Sh HISTORY The .Fn getttyent , .Fn getttynam , .Fn setttyent , and .Fn endttyent functions appeared in x 4.3 . The .Fn setttyentpath function appeared in .Nx 4.0 . .Sh BUGS These functions use static data storage; if the data is needed for future use, it should be copied before any subsequent calls overwrite it.
Indexes created Sun Nov 02 07:10:05 GMT 2025