]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - libexec/getty/ttys.5
Import libucl 0.8.0
[FreeBSD/FreeBSD.git] / libexec / getty / ttys.5
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. Neither the name of the University nor the names of its contributors
13 .\"    may be used to endorse or promote products derived from this software
14 .\"    without specific prior written permission.
15 .\"
16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 .\" SUCH DAMAGE.
27 .\"
28 .\"     from: @(#)ttys.5        8.1 (Berkeley) 6/4/93
29 .\" $FreeBSD$
30 .\" "
31 .Dd March 9, 2014
32 .Dt TTYS 5
33 .Os
34 .Sh NAME
35 .Nm ttys
36 .Nd terminal initialization information
37 .Sh DESCRIPTION
38 The file
39 .Nm
40 contains information that is used by various routines to initialize
41 and control the use of terminal special files.
42 Pseudo-terminals (see
43 .Xr pts 4 )
44 are not listed.
45 This information is read with the
46 .Xr getttyent 3
47 library routines.
48 There is one line in the
49 .Nm
50 file per special device file.
51 Fields are separated by tabs and/or spaces.
52 Fields comprised of more than one word should be enclosed in double
53 quotes (``"'').
54 Blank lines and comments may appear anywhere in the file; comments
55 are delimited by hash marks (``#'') and new lines.
56 Any unspecified fields will default to null.
57 .Pp
58 The first field is normally the
59 name of the terminal special file as it is found in
60 .Pa /dev .
61 However, it can be any arbitrary string
62 when the associated command is not related to a tty.
63 .Pp
64 The second field of the file is the command to execute for the line,
65 usually
66 .Xr getty 8 ,
67 which initializes and opens the line, setting the speed, waiting for
68 a user name and executing the
69 .Xr login 1
70 program.
71 It can be, however, any desired command, for example
72 the start up for a window system terminal emulator or some other
73 daemon process, and can contain multiple words if quoted.
74 .Pp
75 The third field is the type of terminal usually connected to that
76 tty line, normally the one found in the
77 .Xr termcap 5
78 data base file.
79 The environment variable
80 .Ev TERM
81 is initialized with the value by
82 either
83 .Xr getty 8
84 or
85 .Xr login 1 .
86 .Pp
87 The remaining fields set flags in the
88 .Fa ty_status
89 entry (see
90 .Xr getttyent 3 ) ,
91 specify a window system process that
92 .Xr init 8
93 will maintain for the terminal line, optionally determine the
94 type of tty (whether dialin, network or otherwise),
95 or specify a tty group
96 name that allows the login class database (see
97 .Xr login.conf 5 )
98 to refer to many ttys as a group, to selectively allow or
99 deny access or enable or disable accounting facilities for
100 ttys as a group.
101 .Pp
102 As flag values, the strings ``on'' and ``off'' specify that
103 .Xr init 8
104 should (should not) execute the command given in the second field.
105 ``onifconsole'' will cause this line to be enabled if and only if it is
106 an active kernel console device (it is equivalent to ``on'' in this
107 case).
108 The flag ``secure'' (if the console is enabled) allows users with a
109 uid of 0 to login on
110 this line.
111 The flag ``dialin'' indicates that a tty entry describes a dialin
112 line, and ``network'' is obsolete and does nothing.
113 Either of these strings may also be specified in the terminal type
114 field.
115 The string ``window='' may be followed by a quoted command
116 string which
117 .Xr init 8
118 will execute
119 .Em before
120 starting the command specified by the second field.
121 .Pp
122 The string ``group='' may be followed by a group name comprised of
123 alphanumeric characters that can be used by
124 .Xr login.conf 5
125 to refer to many tty lines as a group to enable or disable access
126 and accounting facilities.
127 If no group is specified, then the tty becomes a member of the group
128 "none".
129 For backwards compatibility, the ``group='' should appear last on the
130 line, immediately before the optional comment.
131 .Pp
132 Both the second field and any command specified with ``window=''
133 will be split into words and executed using
134 .Xr execve 2 .
135 Words are separated by any combinations of tabs and spaces.
136 Arguments containing whitespace should be enclosed in single quotes
137 .Pq Li ' .
138 Note that no shell-style globbing or other variable substitution occurs.
139 .Sh FILES
140 .Bl -tag -width /etc/ttys -compact
141 .It Pa /etc/ttys
142 .El
143 .Sh EXAMPLES
144 .Bd -literal
145 # root login on console at 1200 baud
146 console "/usr/libexec/getty std.1200"   vt100   on secure
147 # dialup at 1200 baud, no root logins
148 ttyd0   "/usr/libexec/getty d1200"      dialup  on group=dialup # 555-1234
149 # Mike's terminal: hp2621
150 ttyh0   "/usr/libexec/getty std.9600"   hp2621-nl       on group=dialup # 457 Evans
151 # John's terminal: vt100
152 ttyh1   "/usr/libexec/getty std.9600"   vt100   on group=dialup         # 459 Evans
153 # terminal emulate/window system
154 ttyv0   "/usr/local/bin/xterm -display :0"      xterm   on window="/usr/local/bin/X :0"
155 .Ed
156 .Sh SEE ALSO
157 .Xr login 1 ,
158 .Xr getttyent 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
167 A
168 .Nm
169 file appeared in
170 .At v6 .