4.4BSD/usr/share/man/cat3/getttyent.0

GETTTYENT(3)                BSD Programmer's Manual               GETTTYENT(3)

NNAAMMEE
     ggeettttttyyeenntt, ggeettttttyynnaamm, sseettttttyyeenntt, eennddttttyyeenntt - get ttys file entry

SSYYNNOOPPSSIISS
     ##iinncclluuddee <<ttttyyeenntt..hh>>

     _s_t_r_u_c_t _t_t_y_e_n_t _*
     ggeettttttyyeenntt();

     _s_t_r_u_c_t _t_t_y_e_n_t _*
     ggeettttttyynnaamm(_c_h_a_r _*_n_a_m_e);

     _i_n_t
     sseettttttyyeenntt(_v_o_i_d);

     _i_n_t
     eennddttttyyeenntt(_v_o_i_d);

DDEESSCCRRIIPPTTIIOONN
     The ggeettttttyyeenntt(), and ggeettttttyynnaamm() 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:

     _t_y___n_a_m_e     The name of the character-special file.

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

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

     _t_y___s_t_a_t_u_s   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 com-
                             mand referenced by _t_y___g_e_t_t_y on this entry).

                 TTY_SECURE  Allow users with a uid of 0 to login on this ter-
                             minal.

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

     _t_y___c_o_m_m_e_n_t  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 _t_y___s_t_a_t_u_s 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 ggeettttttyyeenntt() function reads the next line from the ttys file, opening
     the file if necessary.  The sseettttttyyeenntt() function rewinds the file if
     open, or opens the file if it is unopened.  The eennddttttyyeenntt() function
     closes any open files.

     The ggeettttttyynnaamm() function searches from the beginning of the file until a
     matching _n_a_m_e is found (or until EOF is encountered).

RREETTUURRNN VVAALLUUEESS
     The routines ggeettttttyyeenntt() and ggeettttttyynnaamm() return a null pointer on EOF or
     error.  The sseettttttyyeenntt() function and eennddttttyyeenntt() return 0 on failure and
     1 on success.

FFIILLEESS
     /etc/ttys

SSEEEE AALLSSOO
     login(1),  ttyslot(3),  gettytab(5),  termcap(5),  ttys(5),  getty(8),
     init(8)

HHIISSTTOORRYY
     The ggeettttttyyeenntt(), ggeettttttyynnaamm(), sseettttttyyeenntt(), and eennddttttyyeenntt() functions ap-
     peared in 4.3BSD.

BBUUGGSS
     These functions use static data storage; if the data is needed for future
     use, it should be copied before any subsequent calls overwrite it.

4.3 Berkeley Distribution        June 4, 1993                                2