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 45The 46.Nm 47file 48is a simplified version of the 49.Xr termcap 5 50data base 51used to describe terminal lines. 52The initial terminal login process 53.Xr getty 8 54accesses the 55.Nm 56file each time it starts, allowing simpler 57reconfiguration of terminal characteristics. 58Each entry in the data base 59is used to describe one class of terminals. 60.Pp 61There is a default terminal class, 62.Em default , 63that is used to set global defaults for all other classes. 64(That is, the 65.Em default 66entry is read, then the entry for the class required 67is used to override particular settings.) 68.Sh CAPABILITIES 69Refer to 70.Xr termcap 5 71for a description of the file layout. 72The 73.Em default 74column below lists defaults obtained if there is 75no entry in the table obtained, nor one in the special 76.Em default 77table. 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 93after 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 110character 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 120hangup 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" 161between 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" 164program referenced by pp automatically 165.It "ps bool false line connected to a" 166.Tn MICOM 167port 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 175use 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 188echo 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 197The 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 209If no line speed is specified, speed will not be altered 210from that which prevails when getty is entered. 211Specifying an input or output speed will override 212line speed for stated direction only. 213.Pp 214Terminal modes to be used for the output of the message, 215for input of the login name, 216and to leave the terminal set as upon completion, 217are derived from the boolean flags specified. 218If the derivation should prove inadequate, 219any (or all) of these three may be overridden 220with 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 , 232or 233.Em \&o2 234numeric specifications, which can be used to specify 235(usually in octal, with a leading '0') 236the exact values of the flags. 237These flags correspond to the termios 238.Em c_cflag , 239.Em c_iflag , 240.Em c_lflag , 241and 242.Em c_oflag 243fields, respectively. Each these sets must be completely specified to be 244effective. 245The 246.Em \&f0 , 247.Em \&f1 , 248and 249.Em \&f2 250are excepted for backwards compatibility with a previous incarnation of 251the TTY sub-system. In these flags the bottom 16 bits of the (32 bits) 252value contain the sgttyb 253.Em sg_flags 254field, while the top 16 bits represent the local mode word. 255.Pp 256Should 257.Xr getty 8 258receive a null character 259(presumed to indicate a line break) 260it will restart using the table indicated by the 261.Em nx 262entry. If there is none, it will re-use its original table. 263.Pp 264Delays are specified in milliseconds, the nearest possible 265delay available in the tty driver will be used. 266Should greater certainty be desired, delays 267with values 0, 1, 2, and 3 are interpreted as 268choosing that particular delay algorithm from the driver. 269.Pp 270The 271.Em \&cl 272screen clear string may be preceded by a (decimal) number 273of milliseconds of delay required (a la termcap). 274This delay is simulated by repeated use of the pad character 275.Em \&pc . 276.Pp 277The initial message, login message, and initial file; 278.Em \&im , 279.Em \&lm 280and 281.Em \&if 282may include any of the following character sequences, which expand to 283information about the environment in which 284.Xr getty 8 285is running. 286.Bl -tag -offset indent -width \&%xxxxxxxxxxxxxx 287.It \&%d 288The current date and time formatted according to the 289.Em \&Lo 290and 291.Em \&df 292strings. 293.It \&%h 294The hostname of the machine, which is normally obtained from the 295system using 296.Xr gethostname 3 , 297but may also be overridden by the 298.Em \&hn 299table entry. 300In either case it may be edited with the 301.Em \&he 302string. 303A '@' in the 304.Em \&he 305string causes one character from the real hostname to 306be copied to the final hostname. 307A '#' in the 308.Em \&he 309string causes the next character of the real hostname 310to be skipped. 311Each character that 312is neither '@' nor '#' is copied into the final hostname. 313Surplus '@' and '#' characters are ignored. 314.It \&%t 315The tty name. 316.It "\&%m, \&%r, \&%s, \&%v" 317The type of machine, release of the operating system, name of the 318operating system, and version of the kernel, respectively, as 319returned by 320.Xr uname 3 . 321.It \&%% 322A 323.Dq % 324character. 325.El 326.Pp 327When getty execs the login process, given 328in the 329.Em \&lo 330string (usually 331.Dq Pa /usr/bin/login ) , 332it will have set 333the environment to include the terminal type, as indicated 334by the 335.Em \&tt 336string (if it exists). 337The 338.Em \&ev 339string, can be used to enter additional data into 340the environment. 341It is a list of comma separated strings, each of which 342will presumably be of the form 343.Em name=value . 344.Pp 345If a non-zero timeout is specified, with 346.Em \&to , 347then getty will exit within the indicated 348number of seconds, either having 349received a login name and passed control 350to 351.Xr login 1 , 352or having received an alarm signal, and exited. 353This may be useful to hangup dial in lines. 354.Pp 355Output from 356.Xr getty 8 357is even parity unless 358.Em \&op 359or 360.Em \&np 361is specified. 362The 363.Em \&op 364string 365may be specified with 366.Em \&ap 367to allow any parity on input, but generate odd parity output. 368Note: this only applies while getty is being run, 369terminal driver limitations prevent a more complete 370implementation. 371.Xr Getty 8 372does not check parity of input characters in 373.Dv RAW 374mode. 375.Pp 376If 377.Em \&pp 378string is specified and a PPP link bring up sequence is recognized, 379getty will invoke the program referenced by the pp option. This 380can be used to handle incoming PPP calls. 381.Pp 382.Nm Getty 383provides some basic intelligent modem handling by providing a chat 384script feature available via two capabilities: 385.Pp 386.Bl -tag -offset indent -width \&xxxxxxxx -compact 387.It ic 388Chat script to initialize modem. 389.It ac 390Chat script to answer a call. 391.El 392.Pp 393A chat script is a set of expect/send string pairs. 394When a chat string starts, 395.Nm getty 396will wait for the first string, and if it finds it, will send the 397second, and so on. 398Strings specified are separated by one or more tabs or spaces. 399Strings may contain standard ASCII characters and special 'escapes', 400which consist of a backslash character followed by one or more 401characters which are interpreted as follows: 402.Pp 403.Bl -tag -offset indent -width \&xxxxxxxx -compact 404.It \ea 405bell character. 406.It \eb 407backspace. 408.It \en 409newline. 410.It \ee 411escape. 412.It \ef 413formfeed. 414.It \ep 415half-second pause. 416.It \er 417carriage return. 418.It \eS , \es 419space character. 420.It \et 421tab. 422.It \exNN 423hexadecimal byte value. 424.It \e0NNN 425octal byte value. 426.El 427.Pp 428Note that the 429.Ql \ep 430sequence is only valid for send strings and causes a half-second 431pause between sending the previous and next characters. 432Hexadecimal values are, at most, 2 hex digits long, and octal 433values are a maximum of 3 octal digits. 434.Pp 435The 436.Em \&ic 437chat sequence is used to initialize a modem or similar device. 438A typical example of an init chat script for a modem with a 439hayes compatible command set might look like this: 440.Pp 441.Dl :ic="" ATE0Q0V1\er OK\er ATS0=0\er OK\er: 442.Pp 443This script waits for nothing (which always succeeds), sends 444a sequence to ensure that the modem is in the correct mode 445(suppress command echo, send responses in verbose mode), 446and then disables auto-answer. 447It waits for an "OK" response before it terminates. 448The init sequence is used to check modem responses to ensure that 449the modem is functioning correctly. 450If the init script fails to complete, 451.Nm getty 452considers this to be fatal, and results in an error logged via 453.Xr syslogd 8 , 454and exiting. 455.Pp 456Similarly, an answer chat script is used to manually answer the 457phone in response to (usually) a "RING". 458When run with an answer script, 459.Nm getty 460opens the port in non-blocking mode, clears any extraneous input 461and waits for data on the port. 462As soon as any data is available, the answer chat script is 463started and scanned for a string, and responds according to 464the answer chat script. 465With a hayes compatible modem, this would normally look something 466like: 467.Pp 468.Dl :ac=RING\er ATA\er CONNECT: 469.Pp 470This causes the modem to answer the call via the "ATA" command, 471then scans input for a "CONNECT" string. 472If this is received before a 473.Em \&ct timeout, then a normal login sequence commences. 474.Pp 475The 476.Em \&ct 477capability specifies a timeout for all send and expect strings. 478This timeout is set individually for each expect wait and send 479string and must be at least as long as the time it takes for 480a connection to be established between a remote and local 481modem (usually around 10 seconds). 482.Pp 483In most situations, you will want to flush any additional 484input after the connection has been detected, and the 485.Em \&de 486capability may be used to do that, as well as delay for a 487short time after the connection has been established during 488which 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 497The 498.Nm 499file format appeared in 500.Bx 4.2 . 501.Sh BUGS 502The special characters (erase, kill, etc.) are reset to system defaults 503by 504.Xr login 1 . 505In 506.Em all 507cases, '#' or '^H' typed in a login name will be treated as 508an erase character, and '@' will be treated as a kill character. 509.Pp 510The delay stuff is a real crock. 511Apart form its general lack of flexibility, some 512of the delay algorithms are not implemented. 513The terminal driver should support sane delay settings. 514.Pp 515The 516.Em \&he 517capability is stupid. 518.Pp 519The 520.Xr termcap 5 521format is horrid, something more rational should 522have been chosen. 523