GETTTYENT
Section: C Library Functions (3)
Index
Return to Main Contents
BSD mandoc
BSD 4.3
NAME
getttyent
getttynam
setttyent
endttyent
- get ttys file entry
SYNOPSIS
Fd #include <ttyent.h>
Ft struct ttyent *
Fn getttyent
Ft struct ttyent *
Fn getttynam char *name
Ft int
Fn setttyent void
Ft int
Fn endttyent void
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.
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 */
int ty_status; /* flag values */
char *ty_window; /* command for window manager */
char *ty_comment; /* comment field */
};
The fields are as follows:
- Fa ty_name
-
The name of the character-special file.
- Fa ty_getty
-
The name of the command invoked by
init(8)
to initialize tty line characteristics.
- Fa ty_type
-
The name of the default terminal type connected to this tty line.
- Fa ty_status
-
A mask of bit fields which indicate various actions allowed on this
tty line.
The possible flags are as follows:
- TTY_ON
-
Enables logins (i.e.,
init(8)
will start the command referenced by
Fa ty_getty
on this entry).
- TTY_SECURE
-
Allow users with a uid of 0 to login on this terminal.
- Fa ty_window
-
The command to execute for a window system associated with the line.
- Fa ty_comment
-
Any trailing comment field, with any leading hash marks (``#'') or
whitespace removed.
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.
See
ttys(5)
for a more complete discussion of the meaning and usage of the
fields.
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 endttyent
function
closes any open files.
The
Fn getttynam
function
searches from the beginning of the file until a matching
Fa name
is found
(or until
EOF
is encountered).
RETURN VALUES
The routines
Fn getttyent
and
Fn getttynam
return a null pointer on
EOF
or error.
The
Fn setttyent
function
and
Fn endttyent
return 0 on failure and 1 on success.
FILES
- /etc/ttys
-
SEE ALSO
login(1),
ttyslot(3),
gettytab(5),
termcap(5),
ttys(5),
getty(8),
init(8)
HISTORY
The
Fn getttyent ,
Fn getttynam ,
Fn setttyent ,
and
Fn endttyent
functions appeared in
BSD 4.3
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.
Index
- NAME
-
- SYNOPSIS
-
- DESCRIPTION
-
- RETURN VALUES
-
- FILES
-
- SEE ALSO
-
- HISTORY
-
- BUGS
-
This document was created by
man2html,
using the manual pages.
Time: 06:42:07 GMT, May 19, 2025