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