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