-.\" Copyright (c) 1989 The Regents of the University of California.
+.\" Copyright (c) 1989, 1991 The Regents of the University of California.
.\" All rights reserved.
.\"
-.\" %sccs.include.redist.man%
+.\" 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. All advertising materials mentioning features or use of this software
+.\" must display the following acknowledgement:
+.\" This product includes software developed by the University of
+.\" California, Berkeley and its contributors.
+.\" 4. 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.
.\"
-.\" @(#)getttyent.3 6.6 (Berkeley) %G%
+.\" 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.
.\"
-.TH GETTTYENT 3 ""
-.UC 6
-.SH NAME
-getttyent, getttynam, setttyent, endttyent \- get ttys file entry
-.SH SYNOPSIS
-.nf
-.B #include <ttyent.h>
-.PP
-.B struct ttyent *getttyent()
-.PP
-.B struct ttyent *getttynam(name)
-.B char *name;
-.PP
-.B setttyent()
-.PP
-.B endttyent()
-.fi
-.SH DESCRIPTION
-.I Getttyent,
+.\" @(#)getttyent.3 6.7 (Berkeley) 4/19/91
+.\"
+.Dd April 19, 1991
+.Dt GETTTYENT 3
+.Os BSD 4.3
+.Sh NAME
+.Nm getttyent ,
+.Nm getttynam ,
+.Nm setttyent ,
+.Nm endttyent
+.Nd get ttys file entry
+.Sh 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
+.Sh DESCRIPTION
+The
+.Fn getttyent ,
and
-.I getttynam
+.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.
-.sp
-.nf
+.Bd -literal
struct ttyent {
- char *ty_name; /* terminal device name */
- char *ty_getty; /* command to execute */
- char *ty_type; /* terminal type */
+ 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 */
+ int ty_status; /* flag values */
+ char *ty_window; /* command for window manager */
+ char *ty_comment; /* comment field */
};
-.fi
-.PP
+.Ed
+.Pp
The fields are as follows:
-.TP
-ty_name
+.Bl -tag -width ty_comment
+.It Fa ty_name
The name of the character-special file.
-.TP
-ty_getty
+.It Fa ty_getty
The name of the command invoked by
-.IR init (8)
+.Xr init 8
to initialize tty line characteristics.
-.TP
-ty_type
+.It Fa ty_type
The name of the default terminal type connected to this tty line.
-.TP
-ty_status
+.It Fa ty_status
A mask of bit fields which indicate various actions allowed on this
tty line.
The possible flags are as follows:
-.IP
-TTY_ON
-.IP
+.Bl -tag -width TTY_SECURE
+.It Dv TTY_ON
Enables logins (i.e.,
-.IR init (8)
+.Xr init 8
will start the command referenced by
-.I ty_getty
+.Fa ty_getty
on this entry).
-.IP
-TTY_SECURE
-.IP
+.It Dv TTY_SECURE
Allow users with a uid of 0 to login on this terminal.
-.TP
-ty_window
+.El
+.It Fa ty_window
The command to execute for a window system associated with the line.
-.TP
-ty_comment
+.It Fa ty_comment
Any trailing comment field, with any leading hash marks (``#'') or
whitespace removed.
-.PP
+.El
+.Pp
If any of the fields pointing to character strings are unspecified,
they are returned as null pointers.
The field
-.I ty_status
+.Fa ty_status
will be zero if no flag values are specified.
-.PP
+.Pp
See
-.IR ttys (5)
+.Xr ttys 5
for a more complete discussion of the meaning and usage of the
fields.
-.PP
-.I Getttyent
+.Pp
+The
+.Fn getttyent
+function
reads the next line from the ttys file, opening the file if necessary.
-.I Setttyent
+The
+.Fn setttyent
+function
rewinds the file if open, or opens the file if it is unopened.
-.I Endttyent
+The
+.Fn endttyent
+function
closes any open files.
-.PP
-.I Getttynam
+.Pp
+The
+.Fn getttynam
+function
searches from the beginning of the file until a matching
-.I name
+.Fa name
is found
-(or until EOF is encountered).
-.SH FILES
-/etc/ttys
-.SH "SEE ALSO"
-login(1), ttyslot(3), gettytab(5), termcap(5), ttys(5), getty(8), init(8)
-.SH DIAGNOSTICS
+(or until
+.Dv EOF
+is encountered).
+.Sh RETURN VALUES
The routines
-.I getttyent
+.Fn getttyent
and
-.I getttynam
-return a null pointer on EOF or error.
-.I Setttyent
+.Fn getttynam
+return a null pointer on
+.Dv EOF
+or error.
+The
+.Fn setttyent
+function
and
-.I endttyent
+.Fn endttyent
return 0 on failure and 1 on success.
-.SH BUGS
-All information is contained in a static area so it must be copied if
-it is to be saved.
+.Sh FILES
+.Bl -tag -width /etc/ttys -compact
+.It Pa /etc/ttys
+.El
+.Sh SEE ALSO
+.Xr login 1 ,
+.Xr ttyslot 3 ,
+.Xr gettytab 5 ,
+.Xr termcap 5 ,
+.Xr ttys 5 ,
+.Xr getty 8 ,
+.Xr init 8
+.Sh HISTORY
+The
+.Fn getttyent ,
+.Fn getttynam ,
+.Fn setttyent ,
+and
+.Fn endttyent
+functions appeared in
+.Bx 4.3 .
+.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.
projects / unix-history / blobdiff