If a neighbor solictation or neighbor advertisement isn't from the
[dragonfly.git] / libexec / getty / gettytab.5
1 .\" Copyright (c) 1983, 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: @(#)gettytab.5    8.4 (Berkeley) 4/19/94
33 .\" $FreeBSD: src/libexec/getty/gettytab.5,v 1.21.2.10 2003/02/06 11:45:31 sobomax Exp $
34 .\" $DragonFly: src/libexec/getty/gettytab.5,v 1.4 2008/05/02 02:05:04 swildner Exp $
35 .\" "
36 .Dd April 19, 1994
37 .Dt GETTYTAB 5
38 .Os
39 .Sh NAME
40 .Nm gettytab
41 .Nd terminal configuration data base
42 .Sh SYNOPSIS
43 .Nm
44 .Sh DESCRIPTION
45 The
46 .Nm
47 file
48 is a simplified version of the
49 .Xr termcap 5
50 data base
51 used to describe terminal lines.
52 The initial terminal login process
53 .Xr getty 8
54 accesses the
55 .Nm
56 file each time it starts, allowing simpler
57 reconfiguration of terminal characteristics.
58 Each entry in the data base
59 is used to describe one class of terminals.
60 .Pp
61 There is a default terminal class,
62 .Em default ,
63 that is used to set global defaults for all other classes.
64 (That is, the
65 .Em default
66 entry is read, then the entry for the class required
67 is used to override particular settings.)
68 .Sh CAPABILITIES
69 Refer to
70 .Xr termcap 5
71 for a description of the file layout.
72 The
73 .Em default
74 column below lists defaults obtained if there is
75 no entry in the table obtained, nor one in the special
76 .Em default
77 table.
78 .Bl -column Name Type /usr/bin/login
79 .It Sy "Name    Type    Default Description
80 .It "ac str     unused  expect-send chat script for modem answer"
81 .It "al str     unused  user to auto-login instead of prompting"
82 .It "ap bool    false   terminal uses any parity"
83 .It "bk str     0377    alternate end of line character (input break)"
84 .It "c0 num     unused  tty control flags to write messages"
85 .It "c1 num     unused  tty control flags to read login name"
86 .It "c2 num     unused  tty control flags to leave terminal as"
87 .It "ce bool    false   use crt erase algorithm"
88 .It "ck bool    false   use crt kill algorithm"
89 .It "cl str" Ta Dv NULL Ta
90 .No "screen clear sequence"
91 .It "co bool    false   console - add"
92 .Ql \en
93 after login prompt
94 .It "ct num     10      chat timeout for ac/ic scripts"
95 .It "dc num     0       chat debug bitmask"
96 .It "de num     0       delay secs and flush input before writing first prompt"
97 .It "df str     %+      the" Xr strftime 3 "format used for \&%d in the banner message"
98 .It "ds str" Ta So Li ^Y Sc Ta
99 .No "delayed suspend character"
100 .It "dx bool    false   set"
101 .Dv DECCTLQ
102 .It "ec bool    false   leave echo"
103 .Tn OFF
104 .It "ep bool    false   terminal uses even parity"
105 .It "er str" Ta So Li ^? Sc Ta
106 .No "erase character"
107 .It "et str" Ta So Li ^D Sc Ta
108 .No "end of text"
109 .Pq Dv EOF
110 character
111 .It "ev str" Ta Dv NULL Ta
112 .No "initial environment"
113 .It "f0 num     unused  tty mode flags to write messages"
114 .It "f1 num     unused  tty mode flags to read login name"
115 .It "f2 num     unused  tty mode flags to leave terminal as"
116 .It "fl str" Ta So Li ^O Sc Ta
117 .No "output flush character"
118 .It "hc bool    false   do"
119 .Tn NOT
120 hangup line on last close
121 .It "he str" Ta Dv NULL Ta
122 .No "hostname editing string"
123 .It "hn str     hostname        hostname"
124 .It "ht bool    false   terminal has real tabs"
125 .It "hw bool    false   do cts/rts hardware flow control"
126 .It "i0 num     unused  tty input flags to write messages"
127 .It "i1 num     unused  tty input flags to read login name"
128 .It "i2 num     unused  tty input flags to leave terminal as"
129 .It "ic str     unused  expect-send chat script for modem initialization"
130 .It "if str     unused  display named file before prompt, like /etc/issue"
131 .It "ig bool    false   ignore garbage characters in login name"
132 .It "im str" Ta Dv NULL Ta
133 .No "initial (banner) message"
134 .It "in str" Ta So Li ^C Sc Ta
135 .No "interrupt character"
136 .It "is num     unused  input speed"
137 .It "kl str" Ta So Li ^U Sc Ta
138 .No "kill character"
139 .It "l0 num     unused  tty local flags to write messages"
140 .It "l1 num     unused  tty local flags to read login name"
141 .It "l2 num     unused  tty local flags to leave terminal as"
142 .It "lm str     login:  login prompt"
143 .It "ln str" Ta So Li ^V Sc Ta
144 .No "``literal next'' character"
145 .It "lo str" Ta Pa /usr/bin/login Ta
146 .No "program to exec when name obtained"
147 .It "mb bool    false   do flow control based on carrier"
148 .It "nc bool    false   terminal does not supply carrier (set clocal)"
149 .It "nl bool    false   terminal has (or might have) a newline character"
150 .It "np bool    false   terminal uses no parity (i.e. 8-bit characters)"
151 .It "nx str     default next table (for auto speed selection)"
152 .It "o0 num     unused  tty output flags to write messages"
153 .It "o1 num     unused  tty output flags to read login name"
154 .It "o2 num     unused  tty output flags to leave terminal as"
155 .It "op bool    false   terminal uses odd parity"
156 .It "os num     unused  output speed"
157 .It "pc str" Ta So Li \e0 Sc Ta
158 .No "pad character"
159 .It "pe bool    false   use printer (hard copy) erase algorithm"
160 .It "pf num     0       delay"
161 between first prompt and following flush (seconds)
162 .It "pp str     unused  PPP authentication program"
163 .It "pl bool    false   don't detect PPP sequence, but start PPP login"
164 program referenced by pp automatically
165 .It "ps bool    false   line connected to a"
166 .Tn MICOM
167 port selector
168 .It "qu str" Ta So Li \&^\e Sc Ta
169 .No "quit character"
170 .It "rp str" Ta So Li ^R Sc Ta
171 .No "line retype character"
172 .It "rt num     unused  ring timeout when using ac"
173 .It "rw bool    false   do"
174 .Tn NOT
175 use raw for input, use cbreak
176 .It "sp num     unused  line speed (input and output)"
177 .It "su str" Ta So Li ^Z Sc Ta
178 .No "suspend character"
179 .It "tc str     none    table continuation"
180 .It "to num     0       timeout (seconds)"
181 .It "tt str" Ta Dv NULL Ta
182 .No "terminal type (for environment)"
183 .It "ub bool    false   do unbuffered output (of prompts etc)"
184 .It "we str" Ta So Li ^W Sc Ta
185 .No "word erase character"
186 .It "xc bool    false   do
187 .Tn NOT
188 echo control chars as
189 .Ql ^X
190 .It "xf str" Ta So Li ^S Sc Ta Dv XOFF
191 (stop output) character
192 .It "xn str" Ta So Li ^Q Sc Ta Dv XON
193 (start output) character
194 .It "Lo str     C       the locale name used for \&%d in the banner message"
195 .El
196 .Pp
197 The following capabilities are no longer supported by
198 .Xr getty 8 Ns :
199 .Bl -column Name Type /usr/bin/login
200 .It "bd num     0       backspace delay"
201 .It "cb bool    false   use crt backspace mode"
202 .It "cd num     0       carriage-return delay"
203 .It "fd num     0       form-feed (vertical motion) delay"
204 .It "lc bool    false   terminal has lower case"
205 .It "nd num     0       newline (line-feed) delay"
206 .It "uc bool    false   terminal is known upper case only"
207 .El
208 .Pp
209 If no line speed is specified, speed will not be altered
210 from that which prevails when getty is entered.
211 Specifying an input or output speed will override
212 line speed for stated direction only.
213 .Pp
214 Terminal modes to be used for the output of the message,
215 for input of the login name,
216 and to leave the terminal set as upon completion,
217 are derived from the boolean flags specified.
218 If the derivation should prove inadequate,
219 any (or all) of these three may be overridden
220 with one of the
221 .Em \&c0 ,
222 .Em \&c1 ,
223 .Em \&c2 ,
224 .Em \&i0 ,
225 .Em \&i1 ,
226 .Em \&i2 ,
227 .Em \&l0 ,
228 .Em \&l1 ,
229 .Em \&l2 ,
230 .Em \&o0 ,
231 .Em \&o1 ,
232 or
233 .Em \&o2
234 numeric specifications, which can be used to specify
235 (usually in octal, with a leading '0')
236 the exact values of the flags.
237 These flags correspond to the termios
238 .Em c_cflag ,
239 .Em c_iflag ,
240 .Em c_lflag ,
241 and
242 .Em c_oflag
243 fields, respectively. Each these sets must be completely specified to be
244 effective.
245 The
246 .Em \&f0 ,
247 .Em \&f1 ,
248 and
249 .Em \&f2
250 are excepted for backwards compatibility with a previous incarnation of
251 the TTY sub-system. In these flags the bottom 16 bits of the (32 bits)
252 value contain the sgttyb
253 .Em sg_flags
254 field, while the top 16 bits represent the local mode word.
255 .Pp
256 Should
257 .Xr getty 8
258 receive a null character
259 (presumed to indicate a line break)
260 it will restart using the table indicated by the
261 .Em nx
262 entry. If there is none, it will re-use its original table.
263 .Pp
264 Delays are specified in milliseconds, the nearest possible
265 delay available in the tty driver will be used.
266 Should greater certainty be desired, delays
267 with values 0, 1, 2, and 3 are interpreted as
268 choosing that particular delay algorithm from the driver.
269 .Pp
270 The
271 .Em \&cl
272 screen clear string may be preceded by a (decimal) number
273 of milliseconds of delay required (a la termcap).
274 This delay is simulated by repeated use of the pad character
275 .Em \&pc .
276 .Pp
277 The initial message, login message, and initial file;
278 .Em \&im ,
279 .Em \&lm
280 and
281 .Em \&if
282 may include any of the following character sequences, which expand to
283 information about the environment in which
284 .Xr getty 8
285 is running.
286 .Bl -tag -offset indent -width \&%xxxxxxxxxxxxxx
287 .It \&%d
288 The current date and time formatted according to the
289 .Em \&Lo
290 and
291 .Em \&df
292 strings.
293 .It \&%h
294 The hostname of the machine, which is normally obtained from the
295 system using
296 .Xr gethostname 3 ,
297 but may also be overridden by the
298 .Em \&hn
299 table entry.
300 In either case it may be edited with the
301 .Em \&he
302 string.
303 A '@' in the
304 .Em \&he
305 string causes one character from the real hostname to
306 be copied to the final hostname.
307 A '#' in the
308 .Em \&he
309 string causes the next character of the real hostname
310 to be skipped.
311 Each character that
312 is neither '@' nor '#' is copied into the final hostname.
313 Surplus '@' and '#' characters are ignored.
314 .It \&%t
315 The tty name.
316 .It "\&%m, \&%r, \&%s, \&%v"
317 The type of machine, release of the operating system, name of the
318 operating system, and version of the kernel, respectively, as
319 returned by
320 .Xr uname 3 .
321 .It \&%%
322 A
323 .Dq %
324 character.
325 .El
326 .Pp
327 When getty execs the login process, given
328 in the
329 .Em \&lo
330 string (usually
331 .Dq Pa /usr/bin/login ) ,
332 it will have set
333 the environment to include the terminal type, as indicated
334 by the
335 .Em \&tt
336 string (if it exists).
337 The
338 .Em \&ev
339 string, can be used to enter additional data into
340 the environment.
341 It is a list of comma separated strings, each of which
342 will presumably be of the form
343 .Em name=value .
344 .Pp
345 If a non-zero timeout is specified, with
346 .Em \&to ,
347 then getty will exit within the indicated
348 number of seconds, either having
349 received a login name and passed control
350 to
351 .Xr login 1 ,
352 or having received an alarm signal, and exited.
353 This may be useful to hangup dial in lines.
354 .Pp
355 Output from
356 .Xr getty 8
357 is even parity unless
358 .Em \&op
359 or
360 .Em \&np
361 is specified.
362 The
363 .Em \&op
364 string
365 may be specified with
366 .Em \&ap
367 to allow any parity on input, but generate odd parity output.
368 Note: this only applies while getty is being run,
369 terminal driver limitations prevent a more complete
370 implementation.
371 .Xr Getty 8
372 does not check parity of input characters in
373 .Dv RAW
374 mode.
375 .Pp
376 If
377 .Em \&pp
378 string is specified and a PPP link bring up sequence is recognized,
379 getty will invoke the program referenced by the pp option.  This
380 can be used to handle incoming PPP calls.
381 .Pp
382 .Nm Getty
383 provides some basic intelligent modem handling by providing a chat
384 script feature available via two capabilities:
385 .Pp
386 .Bl -tag -offset indent -width \&xxxxxxxx -compact
387 .It ic
388 Chat script to initialize modem.
389 .It ac
390 Chat script to answer a call.
391 .El
392 .Pp
393 A chat script is a set of expect/send string pairs.
394 When a chat string starts,
395 .Nm getty
396 will wait for the first string, and if it finds it, will send the
397 second, and so on.
398 Strings specified are separated by one or more tabs or spaces.
399 Strings may contain standard ASCII characters and special 'escapes',
400 which consist of a backslash character followed by one or more
401 characters which are interpreted as follows:
402 .Pp
403 .Bl -tag -offset indent -width \&xxxxxxxx -compact
404 .It \ea
405 bell character.
406 .It \eb
407 backspace.
408 .It \en
409 newline.
410 .It \ee
411 escape.
412 .It \ef
413 formfeed.
414 .It \ep
415 half-second pause.
416 .It \er
417 carriage return.
418 .It \eS , \es
419 space character.
420 .It \et
421 tab.
422 .It \exNN
423 hexadecimal byte value.
424 .It \e0NNN
425 octal byte value.
426 .El
427 .Pp
428 Note that the
429 .Ql \ep
430 sequence is only valid for send strings and causes a half-second
431 pause between sending the previous and next characters.
432 Hexadecimal values are, at most, 2 hex digits long, and octal
433 values are a maximum of 3 octal digits.
434 .Pp
435 The
436 .Em \&ic
437 chat sequence is used to initialize a modem or similar device.
438 A typical example of an init chat script for a modem with a
439 hayes compatible command set might look like this:
440 .Pp
441 .Dl :ic="" ATE0Q0V1\er OK\er ATS0=0\er OK\er:
442 .Pp
443 This script waits for nothing (which always succeeds), sends
444 a sequence to ensure that the modem is in the correct mode
445 (suppress command echo, send responses in verbose mode),
446 and then disables auto-answer.
447 It waits for an "OK" response before it terminates.
448 The init sequence is used to check modem responses to ensure that
449 the modem is functioning correctly.
450 If the init script fails to complete,
451 .Nm getty
452 considers this to be fatal, and results in an error logged via
453 .Xr syslogd 8 ,
454 and exiting.
455 .Pp
456 Similarly, an answer chat script is used to manually answer the
457 phone in response to (usually) a "RING".
458 When run with an answer script,
459 .Nm getty
460 opens the port in non-blocking mode, clears any extraneous input
461 and waits for data on the port.
462 As soon as any data is available, the answer chat script is
463 started and scanned for a string, and responds according to
464 the answer chat script.
465 With a hayes compatible modem, this would normally look something
466 like:
467 .Pp
468 .Dl :ac=RING\er ATA\er CONNECT:
469 .Pp
470 This causes the modem to answer the call via the "ATA" command,
471 then scans input for a "CONNECT" string.
472 If this is received before a
473 .Em \&ct timeout, then a normal login sequence commences.
474 .Pp
475 The
476 .Em \&ct
477 capability specifies a timeout for all send and expect strings.
478 This timeout is set individually for each expect wait and send
479 string and must be at least as long as the time it takes for
480 a connection to be established between a remote and local
481 modem (usually around 10 seconds).
482 .Pp
483 In most situations, you will want to flush any additional
484 input after the connection has been detected, and the
485 .Em \&de
486 capability may be used to do that, as well as delay for a
487 short time after the connection has been established during
488 which all of the connection data has been sent by the modem.
489 .Sh SEE ALSO
490 .Xr login 1 ,
491 .Xr gethostname 3 ,
492 .Xr uname 3 ,
493 .Xr termcap 5 ,
494 .Xr getty 8 ,
495 .Xr telnetd 8
496 .Sh HISTORY
497 The
498 .Nm
499 file format appeared in
500 .Bx 4.2 .
501 .Sh BUGS
502 The special characters (erase, kill, etc.) are reset to system defaults
503 by
504 .Xr login 1 .
505 In
506 .Em all
507 cases, '#' or '^H' typed in a login name will be treated as
508 an erase character, and '@' will be treated as a kill character.
509 .Pp
510 The delay stuff is a real crock.
511 Apart form its general lack of flexibility, some
512 of the delay algorithms are not implemented.
513 The terminal driver should support sane delay settings.
514 .Pp
515 The
516 .Em \&he
517 capability is stupid.
518 .Pp
519 The
520 .Xr termcap 5
521 format is horrid, something more rational should
522 have been chosen.