xref: /freebsd/libexec/getty/gettytab.5 (revision 17ee9d00bc1ae1e598c38f25826f861e4bc6c3ce)
1.\" Copyright (c) 1983, 1991 The Regents of the University of California.
2.\" 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.\"     @(#)gettytab.5	6.7 (Berkeley) 5/10/91
33.\"
34.Dd May 10, 1991
35.Dt GETTYTAB 5
36.Os BSD 4.2
37.Sh NAME
38.Nm gettytab
39.Nd terminal configuration data base
40.Sh SYNOPSIS
41.Nm gettytab
42.Sh DESCRIPTION
43The
44.Nm gettytab
45file
46is a simplified version of the
47.Xr termcap 5
48data base
49used to describe terminal lines.
50The initial terminal login process
51.Xr getty 8
52accesses the
53.Nm gettytab
54file each time it starts, allowing simpler
55reconfiguration of terminal characteristics.
56Each entry in the data base
57is used to describe one class of terminals.
58.Pp
59There is a default terminal class,
60.Em default ,
61that is used to set global defaults for all other classes.
62(That is, the
63.Em default
64entry is read, then the entry for the class required
65is used to override particular settings.)
66.Sh CAPABILITIES
67Refer to
68.Xr termcap 5
69for a description of the file layout.
70The
71.Em default
72column below lists defaults obtained if there is
73no entry in the table obtained, nor one in the special
74.Em default
75table.
76.Bl -column Namexx /usr/bin/login Default
77.It Sy Name	Type	Default	Description
78.It "ap	bool	false	terminal uses any parity"
79.It "bd	num	0	backspace delay"
80.It "bk	str	0377	alternate end of line character (input break)"
81.It "cb	bool	false	use crt backspace mode"
82.It "cd	num	0	carriage-return delay"
83.It "ce	bool	false	use crt erase algorithm"
84.It "ck	bool	false	use crt kill algorithm"
85.It "cl	str" Ta Dv NULL	Ta
86.No "screen clear sequence"
87.It "co	bool	false	console - add"
88.Ql \en
89after login prompt
90.It "ds	str" Ta So Li ^Y Sc Ta
91.No "delayed suspend character"
92.It "dx	bool	false	set"
93.Dv DECCTLQ
94.It "ec	bool	false	leave echo"
95.Tn OFF
96.It "ep	bool	false	terminal uses even parity"
97.It "er	str" Ta So Li ^? Sc Ta
98.No "erase character"
99.It "et	str" Ta So Li ^D Sc Ta
100.No "end of text"
101.Pq Dv EOF
102character
103.It "ev	str" Ta Dv NULL	Ta
104.No "initial environment"
105.It "f0	num	unused	tty mode flags to write messages"
106.It "f1	num	unused	tty mode flags to read login name"
107.It "f2	num	unused	tty mode flags to leave terminal as"
108.It "fd	num	0	form-feed (vertical motion) delay"
109.It "fl	str" Ta So Li ^O Sc Ta
110.No "output flush character"
111.It "hc	bool	false	do"
112.Tn NOT
113hangup line on last close
114.It "he	str" Ta Dv NULL	Ta
115.No "hostname editing string"
116.It "hn	str	hostname	hostname"
117.It "ht	bool	false	terminal has real tabs"
118.It "ig	bool	false	ignore garbage characters in login name"
119.It "im	str" Ta Dv NULL Ta
120.No "initial (banner) message"
121.It "in	str" Ta So Li ^C Sc Ta
122.No "interrupt character"
123.It "is	num	unused	input speed"
124.It "kl	str" Ta So Li ^U Sc Ta
125.No "kill character"
126.It "lc	bool	false	terminal has lower case"
127.It "lm	str	login:	login prompt"
128.It "ln	str" Ta So Li ^V Sc Ta
129.No "``literal next'' character"
130.It "lo	str" Ta Pa /usr/bin/login Ta
131.No "program to exec when name obtained"
132.It "nd	num	0	newline (line-feed) delay"
133.It "nl	bool	false	terminal has (or might have) a newline character"
134.It "np	bool	false	terminal uses no parity (8bit chars)"
135.It "nx	str	default	next table (for auto speed selection)"
136.It "op	bool	false	terminal uses odd parity"
137.It "os	num	unused	output speed"
138.It "pc	str" Ta So Li \e0 Sc Ta
139.No "pad character"
140.It "pe	bool	false	use printer (hard copy) erase algorithm"
141.It "pf	num	0	delay"
142between first prompt and following flush (seconds)
143.It "ps	bool	false	line connected to a"
144.Tn MICOM
145port selector
146.It "qu	str" Ta So Li \&^\e Sc Ta
147.No "quit character"
148.It "rp	str" Ta So Li ^R Sc Ta
149.No "line retype character"
150.It "rw	bool	false	do"
151.Tn NOT
152use raw for input, use cbreak
153.It "sp	num	unused	line speed (input and output)"
154.It "su	str" Ta So Li ^Z Sc Ta
155.No "suspend character"
156.It "tc	str	none	table continuation"
157.It "to	num	0	timeout (seconds)"
158.It "tt	str" Ta Dv NULL Ta
159.No "terminal type (for environment)"
160.It "ub	bool	false	do unbuffered output (of prompts etc)"
161.It "uc	bool	false	terminal is known upper case only"
162.It "we	str" Ta So Li ^W Sc Ta
163.No "word erase character"
164.It "xc	bool	false	do
165.Tn NOT
166echo control chars as
167.Ql ^X
168.It "xf	str" Ta So Li ^S Sc Ta Dv XOFF
169(stop output) character
170.It "xn	str" Ta So Li ^Q Sc Ta Dv XON
171(start output) character
172.El
173.Pp
174If no line speed is specified, speed will not be altered
175from that which prevails when getty is entered.
176Specifying an input or output speed will override
177line speed for stated direction only.
178.Pp
179Terminal modes to be used for the output of the message,
180for input of the login name,
181and to leave the terminal set as upon completion,
182are derived from the boolean flags specified.
183If the derivation should prove inadequate,
184any (or all) of these three may be overridden
185with one of the
186.Em \&f0 ,
187.Em \&f1 ,
188or
189.Em \&f2
190numeric specifications, which can be used to specify
191(usually in octal, with a leading '0')
192the exact values of the flags.
193Local (new tty) flags are set in the top 16 bits
194of this (32 bit) value.
195.Pp
196Should
197.Xr getty
198receive a null character
199(presumed to indicate a line break)
200it will restart using the table indicated by the
201.Em nx
202entry. If there is none, it will re-use its original table.
203.Pp
204Delays are specified in milliseconds, the nearest possible
205delay available in the tty driver will be used.
206Should greater certainty be desired, delays
207with values 0, 1, 2, and 3 are interpreted as
208choosing that particular delay algorithm from the driver.
209.Pp
210The
211.Em \&cl
212screen clear string may be preceded by a (decimal) number
213of milliseconds of delay required (a la termcap).
214This delay is simulated by repeated use of the pad character
215.Em \&pc .
216.Pp
217The initial message, and login message,
218.Em \&im
219and
220.Em \&lm
221may include the character sequence
222.Em \&%h
223or
224.Em \&%t
225to obtain
226the hostname or tty name respectively.
227.Pf ( Em %%
228obtains a single '%' character.)
229The hostname is normally obtained from the system,
230but may be set by the
231.Em \&hn
232table entry.
233In either case it may be edited with
234.Em \&he .
235The
236.Em \&he
237string is a sequence of characters, each character that
238is neither '@' nor '#' is copied into the final hostname.
239A '@' in the
240.Em \&he
241string, causes one character from the real hostname to
242be copied to the final hostname.
243A '#' in the
244.Em \&he
245string, causes the next character of the real hostname
246to be skipped.
247Surplus '@' and '#' characters are ignored.
248.Pp
249When getty execs the login process, given
250in the
251.Em \&lo
252string (usually
253.Dq Pa /usr/bin/login ) ,
254it will have set
255the environment to include the terminal type, as indicated
256by the
257.Em \&tt
258string (if it exists).
259The
260.Em \&ev
261string, can be used to enter additional data into
262the environment.
263It is a list of comma separated strings, each of which
264will presumably be of the form
265.Em name=value .
266.Pp
267If a non-zero timeout is specified, with
268.Em \&to ,
269then getty will exit within the indicated
270number of seconds, either having
271received a login name and passed control
272to
273.Xr login ,
274or having received an alarm signal, and exited.
275This may be useful to hangup dial in lines.
276.Pp
277Output from
278.Xr getty
279is even parity unless
280.Em \&op
281is specified.
282The
283.Em \&op
284string
285may be specified with
286.Em \&ap
287to allow any parity on input, but generate odd parity output.
288Note: this only applies while getty is being run,
289terminal driver limitations prevent a more complete
290implementation.
291.Xr Getty
292does not check parity of input characters in
293.Dv RAW
294mode.
295.Sh SEE ALSO
296.Xr login 1 ,
297.Xr termcap 5 ,
298.Xr getty 8 .
299.Sh BUGS
300The special characters (erase, kill, etc.) are reset to system defaults
301by
302.Xr login 1 .
303In
304.Em all
305cases, '#' or '^H' typed in a login name will be treated as
306an erase character, and '@' will be treated as a kill character.
307.Pp
308The delay stuff is a real crock.
309Apart form its general lack of flexibility, some
310of the delay algorithms are not implemented.
311The terminal driver should support sane delay settings.
312.Pp
313The
314.Em \&he
315capability is stupid.
316.Pp
317The
318.Xr termcap
319format is horrid, something more rational should
320have been chosen.
321.Sh HISTORY
322The
323.Nm gettytab
324file format appeared in 4.2BSD.
325