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.\" $Id: gettytab.5,v 1.3 1996/12/10 07:58:29 deraadt Exp $ 34.\" 35.Dd April 19, 1994 36.Dt GETTYTAB 5 37.Os BSD 4.2 38.Sh NAME 39.Nm gettytab 40.Nd terminal configuration data base 41.Sh SYNOPSIS 42.Nm gettytab 43.Sh DESCRIPTION 44The 45.Nm gettytab 46file 47is a simplified version of the 48.Xr termcap 5 49data base 50used to describe terminal lines. 51The initial terminal login process 52.Xr getty 8 53accesses the 54.Nm gettytab 55file each time it starts, allowing simpler 56reconfiguration of terminal characteristics. 57Each entry in the data base 58is used to describe one class of terminals. 59.Pp 60There is a default terminal class, 61.Em default , 62that is used to set global defaults for all other classes. 63(That is, the 64.Em default 65entry is read, then the entry for the class required 66is used to override particular settings.) 67.Sh CAPABILITIES 68Refer to 69.Xr termcap 5 70for a description of the file layout. 71The 72.Em default 73column below lists defaults obtained if there is 74no entry in the table obtained, nor one in the special 75.Em default 76table. 77.Bl -column Namexx /usr/bin/login Default 78.It Sy Name Type Default Description 79.It "ap bool false terminal uses any parity" 80.It "bk str 0377 alternate end of line character (input break)" 81.It "c0 num unused tty control flags to write messages" 82.It "c1 num unused tty control flags to read login name" 83.It "c2 num unused tty control flags to leave terminal as" 84.It "ce bool false use crt erase algorithm" 85.It "ck bool false use crt kill algorithm" 86.It "cl str" Ta Dv NULL Ta 87.No "screen clear sequence" 88.It "co bool false console - add" 89.Ql \en 90after login prompt 91.It "ds str" Ta So Li ^Y Sc Ta 92.No "delayed suspend character" 93.It "dx bool false set" 94.Dv DECCTLQ 95.It "ec bool false leave echo" 96.Tn OFF 97.It "ep bool false terminal uses even parity" 98.It "er str" Ta So Li ^? Sc Ta 99.No "erase character" 100.It "et str" Ta So Li ^D Sc Ta 101.No "end of text" 102.Pq Dv EOF 103character 104.It "ev str" Ta Dv NULL Ta 105.No "initial environment" 106.It "f0 num unused tty mode flags to write messages" 107.It "f1 num unused tty mode flags to read login name" 108.It "f2 num unused tty mode flags to leave terminal as" 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 "i0 num unused tty input flags to write messages" 119.It "i1 num unused tty input flags to read login name" 120.It "i2 num unused tty input flags to leave terminal as" 121.It "ig bool false ignore garbage characters in login name" 122.It "im str" Ta Dv NULL Ta 123.No "initial (banner) message" 124.It "in str" Ta So Li ^C Sc Ta 125.No "interrupt character" 126.It "is num unused input speed" 127.It "kl str" Ta So Li ^U Sc Ta 128.No "kill character" 129.It "l0 num unused tty local flags to write messages" 130.It "l1 num unused tty local flags to read login name" 131.It "l2 num unused tty local flags to leave terminal as" 132.It "lc bool false terminal has lower case" 133.It "lm str login: login prompt" 134.It "ln str" Ta So Li ^V Sc Ta 135.No "``literal next'' character" 136.It "lo str" Ta Pa /usr/bin/login Ta 137.No "program to exec when name obtained" 138.It "mb bool false do flow control based on carrier" 139.It "nl bool false terminal has (or might have) a newline character" 140.It "np bool false terminal uses no parity (i.e. 8-bit characters)" 141.It "nx str default next table (for auto speed selection)" 142.It "o0 num unused tty output flags to write messages" 143.It "o1 num unused tty output flags to read login name" 144.It "o2 num unused tty output flags to leave terminal as" 145.It "op bool false terminal uses odd parity" 146.It "os num unused output speed" 147.It "pc str" Ta So Li \e0 Sc Ta 148.No "pad character" 149.It "pe bool false use printer (hard copy) erase algorithm" 150.It "pf num 0 delay" 151between first prompt and following flush (seconds) 152.It "pp str unused PPP authentication program" 153.It "ps bool false line connected to a" 154.Tn MICOM 155port selector 156.It "qu str" Ta So Li \&^\e Sc Ta 157.No "quit character" 158.It "rp str" Ta So Li ^R Sc Ta 159.No "line retype character" 160.It "rw bool false do" 161.Tn NOT 162use raw for input, use cbreak 163.It "sp num unused line speed (input and output)" 164.It "su str" Ta So Li ^Z Sc Ta 165.No "suspend character" 166.It "tc str none table continuation" 167.It "to num 0 timeout (seconds)" 168.It "tt str" Ta Dv NULL Ta 169.No "terminal type (for environment)" 170.It "ub bool false do unbuffered output (of prompts etc)" 171.It "we str" Ta So Li ^W Sc Ta 172.No "word erase character" 173.It "xc bool false do 174.Tn NOT 175echo control chars as 176.Ql ^X 177.It "xf str" Ta So Li ^S Sc Ta Dv XOFF 178(stop output) character 179.It "xn str" Ta So Li ^Q Sc Ta Dv XON 180(start output) character 181.El 182.Pp 183The following capabilities are no longer supported by getty(8): 184.Bl -column Namexx /usr/bin/login Default 185.It "bd num 0 backspace delay" 186.It "cb bool false use crt backspace mode" 187.It "cd num 0 carriage-return delay" 188.It "fd num 0 form-feed (vertical motion) delay" 189.It "nd num 0 newline (line-feed) delay" 190.It "uc bool false terminal is known upper case only" 191.El 192.Pp 193If no line speed is specified, speed will not be altered 194from that which prevails when getty is entered. 195Specifying an input or output speed will override 196line speed for stated direction only. 197.Pp 198Terminal modes to be used for the output of the message, 199for input of the login name, 200and to leave the terminal set as upon completion, 201are derived from the boolean flags specified. 202If the derivation should prove inadequate, 203any (or all) of these three may be overridden 204with one of the 205.Em \&c0 , 206.Em \&c1 , 207.Em \&c2 , 208.Em \&i0 , 209.Em \&i1 , 210.Em \&i2 , 211.Em \&l0 , 212.Em \&l1 , 213.Em \&l2 , 214.Em \&o0 , 215.Em \&o1 , 216or 217.Em \&o2 218numeric specifications, which can be used to specify 219(usually in octal, with a leading '0') 220the exact values of the flags. 221These flags correspond to the termios 222.Em c_cflag , 223.Em c_iflag , 224.Em c_lflag , 225and 226.Em c_oflag 227fields, respectively. Each these sets must be completely specified to be 228effective. 229The 230.Em \&f0 , 231.Em \&f1 , 232and 233.Em \&f2 234are excepted for backwards compatibility with a previous incarnation of 235the TTY sub-system. In these flags the bottom 16 bits of the (32 bits) 236value contain the sgttyb 237.Em sg_flags 238field, while the top 16 bits represent the local mode word. 239.Pp 240Should 241.Xr getty 8 242receive a null character 243(presumed to indicate a line break) 244it will restart using the table indicated by the 245.Em nx 246entry. If there is none, it will re-use its original table. 247.Pp 248Delays are specified in milliseconds, the nearest possible 249delay available in the tty driver will be used. 250Should greater certainty be desired, delays 251with values 0, 1, 2, and 3 are interpreted as 252choosing that particular delay algorithm from the driver. 253.Pp 254The 255.Em \&cl 256screen clear string may be preceded by a (decimal) number 257of milliseconds of delay required (a la termcap). 258This delay is simulated by repeated use of the pad character 259.Em \&pc . 260.Pp 261The initial message, and login message, 262.Em \&im 263and 264.Em \&lm 265may include any of the following character sequences, which expand to 266information about the environment in which 267.Xr getty 8 268is running. 269.Pp 270.Bl -tag -width \&%xxx -compact 271.It \&%d 272The current date. 273.It \&%h 274The hostname of the machine, which is normally obtained from the 275system using 276.Xr gethostname 2 , 277but may also be overridden by the 278.Em \&hn 279table entry. 280In either case it may be edited with the 281.Em \&he 282string. 283A '@' in the 284.Em \&he 285string causes one character from the real hostname to 286be copied to the final hostname. 287A '#' in the 288.Em \&he 289string causes the next character of the real hostname 290to be skipped. 291Each character that 292is neither '@' nor '#' is copied into the final hostname. 293Surplus '@' and '#' characters are ignored. 294.It \&%t 295The tty name. 296.It "\&%m, \&%r, \&%s, \&%v" 297The type of machine, release of the operating system, name of the 298operating system, and version of the kernel, respectively, as 299returned by 300.Xr uname 2 . 301.It \&%% 302A 303.Dq % 304character. 305.El 306.Pp 307When getty execs the login process, given 308in the 309.Em \&lo 310string (usually 311.Dq Pa /usr/bin/login ) , 312it will have set 313the environment to include the terminal type, as indicated 314by the 315.Em \&tt 316string (if it exists). 317The 318.Em \&ev 319string, can be used to enter additional data into 320the environment. 321It is a list of comma separated strings, each of which 322will presumably be of the form 323.Em name=value . 324.Pp 325If a non-zero timeout is specified, with 326.Em \&to , 327then getty will exit within the indicated 328number of seconds, either having 329received a login name and passed control 330to 331.Xr login 1 , 332or having received an alarm signal, and exited. 333This may be useful to hangup dial in lines. 334.Pp 335Output from 336.Xr getty 8 337is even parity unless 338.Em \&op 339or 340.Em \&np 341is specified. 342The 343.Em \&op 344string 345may be specified with 346.Em \&ap 347to allow any parity on input, but generate odd parity output. 348Note: this only applies while getty is being run, 349terminal driver limitations prevent a more complete 350implementation. 351.Xr Getty 8 352does not check parity of input characters in 353.Dv RAW 354mode. 355.Pp 356If 357.Em \&pp 358string is specified and a PPP link bringup sequence is recognized, 359getty will invoke the program referenced by the pp option. This 360can be used to handle incoming PPP calls. 361.Sh SEE ALSO 362.Xr login 1 , 363.Xr gethostname 2 , 364.Xr uname 2 , 365.Xr termcap 5 , 366.Xr getty 8 . 367.Sh BUGS 368The special characters (erase, kill, etc.) are reset to system defaults 369by 370.Xr login 1 . 371In 372.Em all 373cases, '#' or '^H' typed in a login name will be treated as 374an erase character, and '@' will be treated as a kill character. 375.Pp 376The delay stuff is a real crock. 377Apart form its general lack of flexibility, some 378of the delay algorithms are not implemented. 379The terminal driver should support sane delay settings. 380.Pp 381The 382.Em \&he 383capability is stupid. 384.Pp 385The 386.Xr termcap 387format is horrid, something more rational should 388have been chosen. 389.Sh HISTORY 390The 391.Nm gettytab 392file format appeared in 4.2BSD. 393