Copyright (c) 1989 The Regents of the University of California.
All rights reserved.

%sccs.include.redist.man%

@(#)getttyent.3 6.6 (Berkeley) 06/23/90

C 6 getttyent, getttynam, setttyent, endttyent - get ttys file entry

 #include <ttyent.h> 

 struct ttyent *getttyent() 

 struct ttyent *getttynam(name)  char *name; 

 setttyent() 

 endttyent() 

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.

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:

ty_name The name of the character-special file.

ty_getty The name of the command invoked by init (8) to initialize tty line characteristics.

ty_type The name of the default terminal type connected to this tty line.

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 ty_getty on this entry). TTY_SECURE Allow users with a uid of 0 to login on this terminal.

ty_window The command to execute for a window system associated with the line.

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 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.

Getttyent reads the next line from the ttys file, opening the file if necessary. Setttyent rewinds the file if open, or opens the file if it is unopened. Endttyent closes any open files.

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

/etc/ttys login(1), ttyslot(3), gettytab(5), termcap(5), ttys(5), getty(8), init(8) The routines getttyent and getttynam return a null pointer on EOF or error. Setttyent and endttyent return 0 on failure and 1 on success. All information is contained in a static area so it must be copied if it is to be saved.