1 .\" Copyright (c) 1983, 1991, 1993
2 .\" The Regents of the University of California. All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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.
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
32 .\" from: @(#)gettytab.5 8.4 (Berkeley) 4/19/94
40 .Nd terminal configuration data base
47 is a simplified version of the
50 used to describe terminal lines.
51 The initial terminal login process
55 file each time it starts, allowing simpler
56 reconfiguration of terminal characteristics.
57 Each entry in the data base
58 is used to describe one class of terminals.
60 There is a default terminal class,
62 that is used to set global defaults for all other classes.
65 entry is read, then the entry for the class required
66 is used to override particular settings.)
70 for a description of the file layout.
73 column below lists defaults obtained if there is
74 no entry in the table obtained, nor one in the special
77 .Bl -column Name Type /usr/bin/login
78 .It Sy "Name Type Default Description
79 .It "ac str unused expect-send chat script for modem answer"
80 .It "al str unused user to auto-login instead of prompting"
81 .It "ap bool false terminal uses any parity"
82 .It "bk str 0377 alternate end of line character (input break)"
83 .It "c0 num unused tty control flags to write messages"
84 .It "c1 num unused tty control flags to read login name"
85 .It "c2 num unused tty control flags to leave terminal as"
86 .It "ce bool false use crt erase algorithm"
87 .It "ck bool false use crt kill algorithm"
88 .It "cl str" Ta Dv NULL Ta
89 .No "screen clear sequence"
90 .It "co bool false console - add"
93 .It "ct num 10 chat timeout for"
98 .It "dc num 0 chat debug bitmask"
99 .It "de num 0 delay secs and flush input before writing first prompt"
100 .It "df str %+ the" Xr strftime 3 "format used for \&%d in the banner message"
101 .It "ds str" Ta So Li ^Y Sc Ta
102 .No "delayed suspend character"
103 .It "dx bool false set"
105 .It "ec bool false leave echo"
107 .It "ep bool false terminal uses even parity"
108 .It "er str" Ta So Li ^? Sc Ta
109 .No "erase character"
110 .It "et str" Ta So Li ^D Sc Ta
114 .It "ev str" Ta Dv NULL Ta
115 .No "initial environment"
116 .It "f0 num unused tty mode flags to write messages"
117 .It "f1 num unused tty mode flags to read login name"
118 .It "f2 num unused tty mode flags to leave terminal as"
119 .It "fl str" Ta So Li ^O Sc Ta
120 .No "output flush character"
121 .It "hc bool false do"
123 hangup line on last close
124 .It "he str" Ta Dv NULL Ta
125 .No "hostname editing string"
126 .It "hn str hostname hostname"
127 .It "ht bool false terminal has real tabs"
128 .It "hw bool false do cts/rts hardware flow control"
129 .It "i0 num unused tty input flags to write messages"
130 .It "i1 num unused tty input flags to read login name"
131 .It "i2 num unused tty input flags to leave terminal as"
132 .It "ic str unused expect-send chat script for modem initialization"
133 .It "if str unused display named file before prompt, like /etc/issue"
134 .It "ig bool false ignore garbage characters in login name"
135 .It "im str" Ta Dv NULL Ta
136 .No "initial (banner) message"
137 .It "in str" Ta So Li ^C Sc Ta
138 .No "interrupt character"
139 .It "is num unused input speed"
140 .It "kl str" Ta So Li ^U Sc Ta
142 .It "l0 num unused tty local flags to write messages"
143 .It "l1 num unused tty local flags to read login name"
144 .It "l2 num unused tty local flags to leave terminal as"
145 .It "lm str login: login prompt"
146 .It "ln str" Ta So Li ^V Sc Ta
147 .No "``literal next'' character"
148 .It "lo str" Ta Pa /usr/bin/login Ta
149 .No "program to exec when name obtained"
150 .It "mb bool false do flow control based on carrier"
151 .It "nc bool false terminal does not supply carrier (set clocal)"
152 .It "nl bool false terminal has (or might have) a newline character"
153 .It "np bool false terminal uses no parity (i.e. 8-bit characters)"
154 .It "nx str default next table (for auto speed selection)"
155 .It "o0 num unused tty output flags to write messages"
156 .It "o1 num unused tty output flags to read login name"
157 .It "o2 num unused tty output flags to leave terminal as"
158 .It "op bool false terminal uses odd parity"
159 .It "os num unused output speed"
160 .It "pc str" Ta So Li \e0 Sc Ta
162 .It "pe bool false use printer (hard copy) erase algorithm"
164 between first prompt and following flush (seconds)
165 .It "pl bool false start PPP login program unconditionally if"
168 .It "pp str unused PPP login program"
169 .It "ps bool false line connected to a"
172 .It "qu str" Ta So Li \&^\e Sc Ta
174 .It "rp str" Ta So Li ^R Sc Ta
175 .No "line retype character"
176 .It "rt num unused ring timeout when using"
178 .It "rw bool false do"
180 use raw for input, use cbreak
181 .It "sp num unused line speed (input and output)"
182 .It "su str" Ta So Li ^Z Sc Ta
183 .No "suspend character"
184 .It "tc str none table continuation"
185 .It "to num 0 timeout (seconds)"
186 .It "tt str" Ta Dv NULL Ta
187 .No "terminal type (for environment)"
188 .It "ub bool false do unbuffered output (of prompts etc)"
189 .It "we str" Ta So Li ^W Sc Ta
190 .No "word erase character"
191 .It "xc bool false do
193 echo control chars as
195 .It "xf str" Ta So Li ^S Sc Ta Dv XOFF
196 (stop output) character
197 .It "xn str" Ta So Li ^Q Sc Ta Dv XON
198 (start output) character
199 .It "Lo str C the locale name used for \&%d in the banner message"
202 The following capabilities are no longer supported by
204 .Bl -column Name Type /usr/bin/login
205 .It "bd num 0 backspace delay"
206 .It "cb bool false use crt backspace mode"
207 .It "cd num 0 carriage-return delay"
208 .It "fd num 0 form-feed (vertical motion) delay"
209 .It "lc bool false terminal has lower case"
210 .It "nd num 0 newline (line-feed) delay"
211 .It "uc bool false terminal is known upper case only"
214 If no line speed is specified, speed will not be altered
215 from that which prevails when getty is entered.
216 Specifying an input or output speed will override
217 line speed for stated direction only.
219 Terminal modes to be used for the output of the message,
220 for input of the login name,
221 and to leave the terminal set as upon completion,
222 are derived from the boolean flags specified.
223 If the derivation should prove inadequate,
224 any (or all) of these three may be overridden
239 numeric specifications, which can be used to specify
240 (usually in octal, with a leading '0')
241 the exact values of the flags.
242 These flags correspond to the termios
248 fields, respectively.
249 Each these sets must be completely specified to be effective.
255 are excepted for backwards compatibility with a previous incarnation of
257 In these flags the bottom 16 bits of the (32 bits)
258 value contain the sgttyb
260 field, while the top 16 bits represent the local mode word.
264 receive a null character
265 (presumed to indicate a line break)
266 it will restart using the table indicated by the
269 If there is none, it will re-use its original table.
271 Delays are specified in milliseconds, the nearest possible
272 delay available in the tty driver will be used.
273 Should greater certainty be desired, delays
274 with values 0, 1, 2, and 3 are interpreted as
275 choosing that particular delay algorithm from the driver.
279 screen clear string may be preceded by a (decimal) number
280 of milliseconds of delay required (a la termcap).
281 This delay is simulated by repeated use of the pad character
284 The initial message, login message, and initial file;
289 may include any of the following character sequences, which expand to
290 information about the environment in which
294 .Bl -tag -offset indent -width \&%xxxxxxxxxxxxxx
296 The current date and time formatted according to the
302 The hostname of the machine, which is normally obtained from the
305 but may also be overridden by the
308 In either case it may be edited with the
313 string causes one character from the real hostname to
314 be copied to the final hostname.
317 string causes the next character of the real hostname
320 is neither '@' nor '#' is copied into the final hostname.
321 Surplus '@' and '#' characters are ignored.
324 .It "\&%m, \&%r, \&%s, \&%v"
325 The type of machine, release of the operating system, name of the
326 operating system, and version of the kernel, respectively, as
335 When getty execs the login process, given
339 .Dq Pa /usr/bin/login ) ,
341 the environment to include the terminal type, as indicated
344 string (if it exists).
347 string, can be used to enter additional data into
349 It is a list of comma separated strings, each of which
350 will presumably be of the form
353 If a non-zero timeout is specified, with
355 then getty will exit within the indicated
356 number of seconds, either having
357 received a login name and passed control
360 or having received an alarm signal, and exited.
361 This may be useful to hangup dial in lines.
365 is even parity unless
373 may be specified with
375 to allow any parity on input, but generate odd parity output.
376 Note: this only applies while getty is being run,
377 terminal driver limitations prevent a more complete
381 utility does not check parity of input characters in
387 string is specified and a PPP link bring-up sequence is recognized,
388 getty will invoke the program referenced by the
391 This can be used to handle incoming PPP calls.
394 option is true as well,
396 will skip the user name prompt and the PPP detection phase, and will
397 invoke the program specified by
402 provides some basic intelligent modem handling by providing a chat
403 script feature available via two capabilities:
405 .Bl -tag -offset indent -width \&xxxxxxxx -compact
407 Chat script to initialize modem.
409 Chat script to answer a call.
412 A chat script is a set of expect/send string pairs.
413 When a chat string starts,
415 will wait for the first string, and if it finds it, will send the
417 Strings specified are separated by one or more tabs or spaces.
418 Strings may contain standard ASCII characters and special 'escapes',
419 which consist of a backslash character followed by one or more
420 characters which are interpreted as follows:
422 .Bl -tag -offset indent -width \&xxxxxxxx -compact
442 hexadecimal byte value.
449 sequence is only valid for send strings and causes a half-second
450 pause between sending the previous and next characters.
451 Hexadecimal values are, at most, 2 hex digits long, and octal
452 values are a maximum of 3 octal digits.
456 chat sequence is used to initialize a modem or similar device.
457 A typical example of an init chat script for a modem with a
458 hayes compatible command set might look like this:
460 .Dl :ic="" ATE0Q0V1\er OK\er ATS0=0\er OK\er:
462 This script waits for nothing (which always succeeds), sends
463 a sequence to ensure that the modem is in the correct mode
464 (suppress command echo, send responses in verbose mode),
465 and then disables auto-answer.
466 It waits for an "OK" response before it terminates.
467 The init sequence is used to check modem responses to ensure that
468 the modem is functioning correctly.
469 If the init script fails to complete,
471 considers this to be fatal, and results in an error logged via
475 Similarly, an answer chat script is used to manually answer the
476 phone in response to (usually) a "RING".
477 When run with an answer script,
479 opens the port in non-blocking mode, clears any extraneous input
480 and waits for data on the port.
481 As soon as any data is available, the answer chat script is
482 started and scanned for a string, and responds according to
483 the answer chat script.
484 With a hayes compatible modem, this would normally look something
487 .Dl :ac=RING\er ATA\er CONNECT:
489 This causes the modem to answer the call via the "ATA" command,
490 then scans input for a "CONNECT" string.
491 If this is received before a
493 timeout, then a normal login sequence commences.
497 capability specifies a timeout for all send and expect strings.
498 This timeout is set individually for each expect wait and send
499 string and must be at least as long as the time it takes for
500 a connection to be established between a remote and local
501 modem (usually around 10 seconds).
503 In most situations, you will want to flush any additional
504 input after the connection has been detected, and the
506 capability may be used to do that, as well as delay for a
507 short time after the connection has been established during
508 which all of the connection data has been sent by the modem.
519 file format appeared in
522 The special characters (erase, kill, etc.) are reset to system defaults
527 cases, '#' or '^H' typed in a login name will be treated as
528 an erase character, and '@' will be treated as a kill character.
530 The delay stuff is a real crock.
531 Apart form its general lack of flexibility, some
532 of the delay algorithms are not implemented.
533 The terminal driver should support sane delay settings.
537 capability is stupid.
541 format is horrid, something more rational should