xref: /freebsd/libexec/getty/ttys.5 (revision a8445737e740901f5f2c8d24c12ef7fc8b00134e)
1.\" Copyright (c) 1985, 1991, 1993
2.\"	The Regents of the University of California.  All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\" 3. All advertising materials mentioning features or use of this software
13.\"    must display the following acknowledgement:
14.\"	This product includes software developed by the University of
15.\"	California, Berkeley and its contributors.
16.\" 4. Neither the name of the University nor the names of its contributors
17.\"    may be used to endorse or promote products derived from this software
18.\"    without specific prior written permission.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30.\" SUCH DAMAGE.
31.\"
32.\"     from: @(#)ttys.5	8.1 (Berkeley) 6/4/93
33.\"	$Id: ttys.5,v 1.8 1997/06/02 21:03:20 davidn Exp $
34.\" "
35.Dd November 17, 1996
36.Dt TTYS 5
37.Os
38.Sh NAME
39.Nm ttys
40.Nd terminal initialization information
41.Sh DESCRIPTION
42The file
43.Nm
44contains information that is used by various routines to initialize
45and control the use of terminal special files.
46This information is read with the
47.Xr getttyent 3
48library routines.
49There is one line in the
50.Nm
51file per special device file.
52Fields are separated by tabs and/or spaces.
53Fields comprised of more than one word should be enclosed in double
54quotes (``"'').
55Blank lines and comments may appear anywhere in the file; comments
56are delimited by hash marks (``#'') and new lines.
57Any unspecified fields will default to null.
58.Pp
59The first field is the
60name of the terminal special file as it is found in
61.Pa /dev .
62.Pp
63The second field of the file is the command to execute for the line,
64usually
65.Xr getty 8 ,
66which initializes and opens the line, setting the speed, waiting for
67a user name and executing the
68.Xr login 1
69program.
70It can be, however, any desired command, for example
71the start up for a window system terminal emulator or some other
72daemon process, and can contain multiple words if quoted.
73.Pp
74The third field is the type of terminal usually connected to that
75tty line, normally the one found in the
76.Xr termcap 5
77data base file.
78The environment variable
79.Ev TERM
80is initialized with the value by
81either
82.Xr getty 8
83or
84.Xr login 1 .
85.Pp
86The remaining fields set flags in the
87.Fa ty_status
88entry (see
89.Xr getttyent 3 ),
90specify a window system process that
91.Xr init 8
92will maintain for the terminal line, optionally determine the
93type of tty (whether dialin, network or otherwise),
94or specify a tty group
95name that allows the login class database (see
96.Xr login.conf 5 )
97to refer to many ttys as a group, to selectively allow or
98deny access or enable or disable accounting facilities for
99ttys as a group.
100.Pp
101As flag values, the strings ``on'' and ``off'' specify that
102.Xr init 8
103should (should not) execute the command given in the second field,
104while ``secure'' (if ``on'' is also specified) allows users with a
105uid of 0 to login on
106this line.
107The flag ``dialin'' indicates that a tty entry describes a dialin
108line, and ``network'' indicates that a tty entry provides a
109network connection.
110Either of these strings may also be specified in the terminal type
111field.
112The string ``window='' may be followed by a quoted command
113string which
114.Xr init 8
115will execute
116.Em before
117starting the command specified by the second field.
118.Pp
119The string ``group='' may be followed by a group name comprised of
120alphanumeric characters that can be used by
121.Xr login.conf 5
122to refer to many tty lines as a group to enable or disable access
123and accounting facilities.
124If no group is specified, then the tty becomes a member of the group
125"none".
126For backwards compatibility, the ``group='' should appear last on the
127line, immediately before the optional comment.
128.Sh EXAMPLES
129.Bd -literal
130# root login on console at 1200 baud
131console	"/usr/libexec/getty std.1200"	vt100	on secure
132# dialup at 1200 baud, no root logins
133ttyd0	"/usr/libexec/getty d1200"	dialup	on group=dialup	# 555-1234
134# Mike's terminal: hp2621
135ttyh0	"/usr/libexec/getty std.9600"	hp2621-nl	on group=dialup	# 457 Evans
136# John's terminal: vt100
137ttyh1	"/usr/libexec/getty std.9600"	vt100	on group=dialup		# 459 Evans
138# terminal emulate/window system
139ttyv0	"/usr/new/xterm -L :0"		vs100	on window="/usr/new/Xvs100 0"
140# Network pseudo ttys -- don't enable getty
141ttyp0	none	network 	group=pty
142ttyp1	none	network	off	group=pty
143.Ed
144.Sh FILES
145.Bl -tag -width /etc/ttys -compact
146.It Pa /etc/ttys
147.El
148.Sh SEE ALSO
149.Xr login 1 ,
150.Xr getttyent 3 ,
151.Xr ttyslot 3 ,
152.Xr gettytab 5 ,
153.Xr login.conf 5 ,
154.Xr termcap 5 ,
155.Xr getty 8 ,
156.Xr init 8
157.\".Xr init 8 ,
158.\".Xr ttyflags 8
159.Sh HISTORY
160A
161.Nm
162file appeared in
163.At v6 .
164