xref: /freebsd/libexec/getty/ttys.5 (revision df7f5d4de4592a8948a25ce01e5bddfbb7ce39dc)
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$
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 ttys
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 ttys
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.Dv 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, or specify a tty group
93name that allows the login class database (see
94.Xr login.conf 5 )
95to refer to many ttys as a group, to selectively allow or
96deny access or enable or disable accounting facilities for
97ttys as a group.
98.Pp
99As flag values, the strings ``on'' and ``off'' specify that
100.Xr init
101should (should not) execute the command given in the second field,
102while ``secure'' (if ``on'' is also specified) allows users with a
103uid of 0 to login on
104this line.
105The flags ``local'', ``rtscts'', ``mdmbuf'', and ``softcar''
106modify the default behaviour of the terminal line, and their actions
107are driver dependent.
108The ``local'' flag causes the driver to
109treat the line as if it locally connected.
110The ``rtscts'' flag
111instructs the driver to use RTS/CTS hardware flow control, if
112possible.
113The ``mdmbuf'' flag instructs the driver to use
114DTR/DCD flow control, if possible.
115The ``softcar'' flag causes the driver to ignore
116hardware carrier on the line.
117These flag fields should not be quoted.
118.Pp
119The string ``window='' may be followed by a quoted command
120string which
121.Xr init
122will execute
123.Em before
124starting the command specified by the second field.
125.Pp
126The string ``group='' may be followed by a group name comprised of
127alphanumeric characters that can be used by
128.Xr login.group 5
129to refer to many tty lines as a group to enable or disable access
130and accounting facilities.
131If no group is specified, then the tty becomes a member of the group
132"none".
133For backwards compatibility, the ``group='' should appear last on the
134line, immediately before the optional comment.
135.Sh EXAMPLES
136.Bd -literal
137# root login on console at 1200 baud
138console	"/usr/libexec/getty std.1200"	vt100	on secure
139# dialup at 1200 baud, no root logins
140ttyd0	"/usr/libexec/getty d1200"	dialup	on group=dialup	# 555-1234
141# Mike's terminal: hp2621
142ttyh0	"/usr/libexec/getty std.9600"	hp2621-nl	on group=dialup	# 457 Evans
143# John's terminal: vt100
144ttyh1	"/usr/libexec/getty std.9600"	vt100	on group=dialup		# 459 Evans
145# terminal emulate/window system
146ttyv0	"/usr/new/xterm -L :0"		vs100	on window="/usr/new/Xvs100 0"
147# Network pseudo ttys -- don't enable getty
148ttyp0	none	network 	group=pty
149ttyp1	none	network	off	group=pty
150.Ed
151.Sh FILES
152.Bl -tag -width /etc/ttys -compact
153.It Pa /etc/ttys
154.El
155.Sh SEE ALSO
156.Xr login 1 ,
157.Xr getttyent 3 ,
158.Xr ttyslot 3 ,
159.Xr gettytab 5 ,
160.Xr login.conf 5 ,
161.Xr termcap 5 ,
162.Xr getty 8 ,
163.Xr init 8
164.\".Xr init 8 ,
165.\".Xr ttyflags 8
166.Sh HISTORY
167A
168.Nm
169file appeared in
170.At v6 .
171