xref: /original-bsd/lib/libc/gen/getttyent.3 (revision 64af1d24)
Copyright (c) 1985 Regents of the University of California.
All rights reserved. The Berkeley software License Agreement
specifies the terms and conditions for redistribution.

@(#)getttyent.3 6.4 (Berkeley) 05/20/86

GETTTYENT 3 ""
C 6
NAME
getttyent, getttynam, setttyent, endttyent - get ttys file entry
SYNOPSIS
 #include <ttyent.h> 

struct ttyent *getttyent()

struct ttyent *getttynam(name) char *name;

setttyent()

endttyent()

DESCRIPTION
Getttyent, and getttynam each return a pointer to an object with the following structure containing the broken-out fields of a line from the tty description file.

ty_name \w'ty_comment'u+3
is the name of the character-special file in the directory ``/dev". For various reasons, it must reside in the directory ``/dev".
ty_getty
is the command (usually getty (8)) which is invoked by init to initialize tty line characteristics. In fact, any arbitrary command can be used; a typical use is to initiate a terminal emulator in a window system.
ty_type
is the name of the default terminal type connected to this tty line. This is typically a name from the termcap (5) data base. The environment variable `TERM' is initialized with this name by getty (8) or login (1).
ty_status
is a mask of bit fields which indicate various actions to be allowed on this tty line. The following is a description of each flag.

TTY_ON \w'TTY_SECURE'u+3
Enables logins (i.e., init (8) will start the specified ``getty" command on this entry).
TTY_SECURE
Allows root to login on this terminal. Note that `TTY_ON' must be included for this to be useful.
ty_window
is the command to execute for a window system associated with the line. The window system will be started before the command specified in the ty_getty entry is executed. If none is specified, this will be null.
ty_comment
is the trailing comment field, if any; a leading delimiter and white space will be removed.

Getttyent reads the next line from the ttys file, opening the file if necessary; setttyent rewinds the file; endttyent closes it.

Getttynam searches from the beginning of the file until a matching name is found (or until EOF is encountered).

FILES
/etc/ttys
"SEE ALSO"
login(1), ttyslot(3), ttys(5), gettytab(5), termcap(5), getty(8), init(8)
DIAGNOSTICS
Null pointer (0) returned on EOF or error.
BUGS
All information is contained in a static area so it must be copied if it is to be saved.