Annotation of 43BSDReno/libexec/getty/gettytab.5, revision 1.1.1.1

1.1       root        1: .\" Copyright (c) 1983 Regents of the University of California.
                      2: .\" All rights reserved.  The Berkeley software License Agreement
                      3: .\" specifies the terms and conditions for redistribution.
                      4: .\"
                      5: .\"    @(#)gettytab.5  6.4 (Berkeley) 6/23/90
                      6: .\"
                      7: .TH GETTYTAB 5 "June 23, 1990"
                      8: .UC 5
                      9: .SH NAME
                     10: gettytab \- terminal configuration data base
                     11: .SH SYNOPSIS
                     12: /etc/gettytab
                     13: .SH DESCRIPTION
                     14: .I Gettytab
                     15: is a simplified version of the
                     16: .IR termcap (5)
                     17: data base
                     18: used to describe terminal lines.
                     19: The initial terminal login process
                     20: .IR getty (8)
                     21: accesses the
                     22: .I gettytab
                     23: file each time it starts, allowing simpler
                     24: reconfiguration of terminal characteristics.
                     25: Each entry in the data base
                     26: is used to describe one class of terminals.
                     27: .PP
                     28: There is a default terminal class,
                     29: .IR default ,
                     30: that is used to set global defaults for all other classes.
                     31: (That is, the
                     32: .I default 
                     33: entry is read, then the entry for the class required
                     34: is used to override particular settings.)
                     35: .SH CAPABILITIES
                     36: Refer to
                     37: .IR termcap (5)
                     38: for a description of the file layout.
                     39: The
                     40: .I default
                     41: column below lists defaults obtained if there is
                     42: no entry in the table obtained, nor one in the special
                     43: .I default
                     44: table.
                     45: .nf
                     46: 
                     47: .ta \w'k0-k9  'u +\w'Type  'u +\w'``/usr/bin/login"  'u
                     48: \fBName        Type    Default Description\fR
                     49: ap     bool    false   terminal uses any parity
                     50: bd     num     0       backspace delay
                     51: bk     str     0377    alternate end of line character (input break)
                     52: cb     bool    false   use crt backspace mode
                     53: cd     num     0       carriage-return delay
                     54: ce     bool    false   use crt erase algorithm
                     55: ck     bool    false   use crt kill algorithm
                     56: cl     str     NULL    screen clear sequence
                     57: co     bool    false   console - add \\n after login prompt
                     58: ds     str     ^Y      delayed suspend character
                     59: dx     bool    false   set DECCTLQ
                     60: ec     bool    false   leave echo \s-2OFF\s0
                     61: ep     bool    false   terminal uses even parity
                     62: er     str     ^?      erase character
                     63: et     str     ^D      end of text (\s-2EOF\s0) character
                     64: ev     str     NULL    initial enviroment
                     65: f0     num     unused  tty mode flags to write messages
                     66: f1     num     unused  tty mode flags to read login name
                     67: f2     num     unused  tty mode flags to leave terminal as
                     68: fd     num     0       form-feed (vertical motion) delay
                     69: fl     str     ^O      output flush character
                     70: hc     bool    false   do \s-2NOT\s0 hangup line on last close
                     71: he     str     NULL    hostname editing string
                     72: hn     str     hostname        hostname
                     73: ht     bool    false   terminal has real tabs
                     74: ig     bool    false   ignore garbage characters in login name
                     75: im     str     NULL    initial (banner) message
                     76: in     str     ^C      interrupt character
                     77: is     num     unused  input speed
                     78: kl     str     ^U      kill character
                     79: lc     bool    false   terminal has lower case
                     80: lm     str     login:  login prompt
                     81: ln     str     ^V      ``literal next'' character
                     82: lo     str     /usr/bin/login  program to exec when name obtained
                     83: nd     num     0       newline (line-feed) delay
                     84: nl     bool    false   terminal has (or might have) a newline character
                     85: nx     str     default next table (for auto speed selection)
                     86: op     bool    false   terminal uses odd parity
                     87: os     num     unused  output speed
                     88: pc     str     \\0     pad character
                     89: pe     bool    false   use printer (hard copy) erase algorithm
                     90: pf     num     0       delay between first prompt and following flush (seconds)
                     91: ps     bool    false   line connected to a MICOM port selector
                     92: qu     str     ^\\     quit character
                     93: rp     str     ^R      line retype character
                     94: rw     bool    false   do \s-2NOT\s0 use raw for input, use cbreak
                     95: sp     num     unused  line speed (input and output)
                     96: su     str     ^Z      suspend character
                     97: tc     str     none    table continuation
                     98: to     num     0       timeout (seconds)
                     99: tt     str     NULL    terminal type (for enviroment)
                    100: ub     bool    false   do unbuffered output (of prompts etc)
                    101: uc     bool    false   terminal is known upper case only
                    102: we     str     ^W      word erase character
                    103: xc     bool    false   do \s-2NOT\s0 echo control chars as ^X
                    104: xf     str     ^S      XOFF (stop output) character
                    105: xn     str     ^Q      XON (start output) character
                    106: .br
                    107: .fi
                    108: .PP
                    109: If no line speed is specified, speed will not be altered
                    110: from that which prevails when getty is entered.
                    111: Specifying an input or output speed will override
                    112: line speed for stated direction only.
                    113: .PP
                    114: Terminal modes to be used for the output of the message,
                    115: for input of the login name,
                    116: and to leave the terminal set as upon completion,
                    117: are derived from the boolean flags specified.
                    118: If the derivation should prove inadequate,
                    119: any (or all) of these three may be overriden
                    120: with one of the
                    121: .BR f0 ,
                    122: .BR f1 ", or"
                    123: .B f2
                    124: numeric specifications, which can be used to specify
                    125: (usually in octal, with a leading '0')
                    126: the exact values of the flags.
                    127: Local (new tty) flags are set in the top 16 bits
                    128: of this (32 bit) value.
                    129: .PP
                    130: Should
                    131: .I getty
                    132: receive a null character
                    133: (presumed to indicate a line break)
                    134: it will restart using the table indicated by the
                    135: .B nx
                    136: entry. If there is none, it will re-use its original table.
                    137: .PP
                    138: Delays are specified in milliseconds, the nearest possible
                    139: delay available in the tty driver will be used.
                    140: Should greater certainty be desired, delays
                    141: with values 0, 1, 2, and 3 are interpreted as
                    142: choosing that particular delay algorithm from the driver.
                    143: .PP
                    144: The
                    145: .B cl
                    146: screen clear string may be preceded by a (decimal) number
                    147: of milliseconds of delay required (a la termcap).
                    148: This delay is simulated by repeated use of the pad character
                    149: .BR pc .
                    150: .PP
                    151: The initial message, and login message,
                    152: .B im
                    153: and
                    154: .B lm
                    155: may include the character sequence \fB%h\fP or \fB%t\fP to obtain
                    156: the hostname or tty name respectively.
                    157: (\fB%%\fP obtains a single '%' character.)
                    158: The hostname is normally obtained from the system,
                    159: but may be set by the
                    160: .B hn
                    161: table entry.
                    162: In either case it may be edited with
                    163: .BR he .
                    164: The
                    165: .B he
                    166: string is a sequence of characters, each character that
                    167: is neither '@' nor '#' is copied into the final hostname.
                    168: A '@' in the
                    169: .B he
                    170: string, causes one character from the real hostname to
                    171: be copied to the final hostname.
                    172: A '#' in the
                    173: .B he
                    174: string, causes the next character of the real hostname
                    175: to be skipped.
                    176: Surplus '@' and '#' characters are ignored.
                    177: .PP
                    178: When getty execs the login process, given
                    179: in the
                    180: .B lo
                    181: string (usually "/usr/bin/login"), it will have set
                    182: the enviroment to include the terminal type, as indicated
                    183: by the
                    184: .B tt
                    185: string (if it exists).
                    186: The
                    187: .B ev
                    188: string, can be used to enter additional data into
                    189: the environment.
                    190: It is a list of comma separated strings, each of which
                    191: will presumably be of the form
                    192: .IR name=value .
                    193: .PP
                    194: If a non-zero timeout is specified, with
                    195: .BR to ,
                    196: then getty will exit within the indicated
                    197: number of seconds, either having
                    198: received a login name and passed control
                    199: to
                    200: .IR login ,
                    201: or having received an alarm signal, and exited.
                    202: This may be useful to hangup dial in lines.
                    203: .PP
                    204: Output from
                    205: .I getty
                    206: is even parity unless
                    207: .B op
                    208: is specified.
                    209: .B Op
                    210: may be specified with
                    211: .B ap
                    212: to allow any parity on input, but generate odd parity output.
                    213: Note: this only applies while getty is being run,
                    214: terminal driver limitations prevent a more complete
                    215: implementation.
                    216: .I Getty
                    217: does not check parity of input characters in
                    218: .I RAW
                    219: mode.
                    220: .SH "SEE ALSO"
                    221: login(1),
                    222: termcap(5),
                    223: getty(8).
                    224: .SH BUGS
                    225: The special characters (erase, kill, etc.) are reset to system defaults
                    226: by
                    227: .IR login (1).
                    228: In
                    229: .B all
                    230: cases, '#' or '^H' typed in a login name will be treated as
                    231: an erase character, and '@' will be treated as a kill character.
                    232: .PP
                    233: The delay stuff is a real crock.
                    234: Apart form its general lack of flexibility, some
                    235: of the delay algorithms are not implemented.
                    236: The terminal driver should support sane delay settings.
                    237: .PP
                    238: The
                    239: .B he
                    240: capability is stupid.
                    241: .PP
                    242: .I Termcap
                    243: format is horrid, something more rational should
                    244: have been chosen.

unix.superglobalmegacorp.com

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.