BSD 4_4 release
[unix-history] / usr / src / libexec / getty / gettytab.5
index 76daed6..ea11fae 100644 (file)
-.\" Copyright (c) 1983 Regents of the University of California.
-.\" All rights reserved.  The Berkeley software License Agreement
-.\" specifies the terms and conditions for redistribution.
+.\" Copyright (c) 1983, 1991, 1993
+.\"    The Regents of the University of California.  All rights reserved.
 .\"
 .\"
-.\"    @(#)gettytab.5  6.4 (Berkeley) 6/23/90
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\" 3. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"    This product includes software developed by the University of
+.\"    California, Berkeley and its contributors.
+.\" 4. Neither the name of the University nor the names of its contributors
+.\"    may be used to endorse or promote products derived from this software
+.\"    without specific prior written permission.
 .\"
 .\"
-.TH GETTYTAB 5 "June 23, 1990"
-.UC 5
-.SH NAME
-gettytab \- terminal configuration data base
-.SH SYNOPSIS
-/etc/gettytab
-.SH DESCRIPTION
-.I Gettytab
+.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.\"     @(#)gettytab.5 8.1 (Berkeley) 6/4/93
+.\"
+.Dd June 4, 1993
+.Dt GETTYTAB 5
+.Os BSD 4.2
+.Sh NAME
+.Nm gettytab
+.Nd terminal configuration data base
+.Sh SYNOPSIS
+.Nm gettytab
+.Sh DESCRIPTION
+The
+.Nm gettytab
+file
 is a simplified version of the
 is a simplified version of the
-.IR termcap (5)
+.Xr termcap 5
 data base
 used to describe terminal lines.
 The initial terminal login process
 data base
 used to describe terminal lines.
 The initial terminal login process
-.IR getty (8)
+.Xr getty 8
 accesses the
 accesses the
-.I gettytab
+.Nm gettytab
 file each time it starts, allowing simpler
 reconfiguration of terminal characteristics.
 Each entry in the data base
 is used to describe one class of terminals.
 file each time it starts, allowing simpler
 reconfiguration of terminal characteristics.
 Each entry in the data base
 is used to describe one class of terminals.
-.PP
+.Pp
 There is a default terminal class,
 There is a default terminal class,
-.IR default ,
+.Em default ,
 that is used to set global defaults for all other classes.
 (That is, the
 that is used to set global defaults for all other classes.
 (That is, the
-.I default 
+.Em default
 entry is read, then the entry for the class required
 is used to override particular settings.)
 entry is read, then the entry for the class required
 is used to override particular settings.)
-.SH CAPABILITIES
+.Sh CAPABILITIES
 Refer to
 Refer to
-.IR termcap (5)
+.Xr termcap 5
 for a description of the file layout.
 The
 for a description of the file layout.
 The
-.I default
+.Em default
 column below lists defaults obtained if there is
 no entry in the table obtained, nor one in the special
 column below lists defaults obtained if there is
 no entry in the table obtained, nor one in the special
-.I default
+.Em default
 table.
 table.
-.nf
-
-.ta \w'k0-k9  'u +\w'Type  'u +\w'``/usr/bin/login"  'u
-\fBName        Type    Default Description\fR
-ap     bool    false   terminal uses any parity
-bd     num     0       backspace delay
-bk     str     0377    alternate end of line character (input break)
-cb     bool    false   use crt backspace mode
-cd     num     0       carriage-return delay
-ce     bool    false   use crt erase algorithm
-ck     bool    false   use crt kill algorithm
-cl     str     NULL    screen clear sequence
-co     bool    false   console - add \\n after login prompt
-ds     str     ^Y      delayed suspend character
-dx     bool    false   set DECCTLQ
-ec     bool    false   leave echo \s-2OFF\s0
-ep     bool    false   terminal uses even parity
-er     str     ^?      erase character
-et     str     ^D      end of text (\s-2EOF\s0) character
-ev     str     NULL    initial enviroment
-f0     num     unused  tty mode flags to write messages
-f1     num     unused  tty mode flags to read login name
-f2     num     unused  tty mode flags to leave terminal as
-fd     num     0       form-feed (vertical motion) delay
-fl     str     ^O      output flush character
-hc     bool    false   do \s-2NOT\s0 hangup line on last close
-he     str     NULL    hostname editing string
-hn     str     hostname        hostname
-ht     bool    false   terminal has real tabs
-ig     bool    false   ignore garbage characters in login name
-im     str     NULL    initial (banner) message
-in     str     ^C      interrupt character
-is     num     unused  input speed
-kl     str     ^U      kill character
-lc     bool    false   terminal has lower case
-lm     str     login:  login prompt
-ln     str     ^V      ``literal next'' character
-lo     str     /usr/bin/login  program to exec when name obtained
-nd     num     0       newline (line-feed) delay
-nl     bool    false   terminal has (or might have) a newline character
-nx     str     default next table (for auto speed selection)
-op     bool    false   terminal uses odd parity
-os     num     unused  output speed
-pc     str     \\0     pad character
-pe     bool    false   use printer (hard copy) erase algorithm
-pf     num     0       delay between first prompt and following flush (seconds)
-ps     bool    false   line connected to a MICOM port selector
-qu     str     ^\\     quit character
-rp     str     ^R      line retype character
-rw     bool    false   do \s-2NOT\s0 use raw for input, use cbreak
-sp     num     unused  line speed (input and output)
-su     str     ^Z      suspend character
-tc     str     none    table continuation
-to     num     0       timeout (seconds)
-tt     str     NULL    terminal type (for enviroment)
-ub     bool    false   do unbuffered output (of prompts etc)
-uc     bool    false   terminal is known upper case only
-we     str     ^W      word erase character
-xc     bool    false   do \s-2NOT\s0 echo control chars as ^X
-xf     str     ^S      XOFF (stop output) character
-xn     str     ^Q      XON (start output) character
-.br
-.fi
-.PP
+.Bl -column Namexx /usr/bin/login Default
+.It Sy Name    Type    Default Description
+.It "ap        bool    false   terminal uses any parity"
+.It "bd        num     0       backspace delay"
+.It "bk        str     0377    alternate end of line character (input break)"
+.It "cb        bool    false   use crt backspace mode"
+.It "cd        num     0       carriage-return delay"
+.It "ce        bool    false   use crt erase algorithm"
+.It "ck        bool    false   use crt kill algorithm"
+.It "cl        str" Ta Dv NULL Ta
+.No "screen clear sequence"
+.It "co        bool    false   console - add"
+.Ql \en
+after login prompt
+.It "ds        str" Ta So Li ^Y Sc Ta
+.No "delayed suspend character"
+.It "dx        bool    false   set"
+.Dv DECCTLQ
+.It "ec        bool    false   leave echo"
+.Tn OFF
+.It "ep        bool    false   terminal uses even parity"
+.It "er        str" Ta So Li ^? Sc Ta
+.No "erase character"
+.It "et        str" Ta So Li ^D Sc Ta
+.No "end of text"
+.Pq Dv EOF
+character
+.It "ev        str" Ta Dv NULL Ta
+.No "initial enviroment"
+.It "f0        num     unused  tty mode flags to write messages"
+.It "f1        num     unused  tty mode flags to read login name"
+.It "f2        num     unused  tty mode flags to leave terminal as"
+.It "fd        num     0       form-feed (vertical motion) delay"
+.It "fl        str" Ta So Li ^O Sc Ta
+.No "output flush character"
+.It "hc        bool    false   do"
+.Tn NOT
+hangup line on last close
+.It "he        str" Ta Dv NULL Ta
+.No "hostname editing string"
+.It "hn        str     hostname        hostname"
+.It "ht        bool    false   terminal has real tabs"
+.It "ig        bool    false   ignore garbage characters in login name"
+.It "im        str" Ta Dv NULL Ta
+.No "initial (banner) message"
+.It "in        str" Ta So Li ^C Sc Ta
+.No "interrupt character"
+.It "is        num     unused  input speed"
+.It "kl        str" Ta So Li ^U Sc Ta
+.No "kill character"
+.It "lc        bool    false   terminal has lower case"
+.It "lm        str     login:  login prompt"
+.It "ln        str" Ta So Li ^V Sc Ta
+.No "``literal next'' character"
+.It "lo        str" Ta Pa /usr/bin/login Ta
+.No "program to exec when name obtained"
+.It "nd        num     0       newline (line-feed) delay"
+.It "nl        bool    false   terminal has (or might have) a newline character"
+.It "nx        str     default next table (for auto speed selection)"
+.It "op        bool    false   terminal uses odd parity"
+.It "os        num     unused  output speed"
+.It "pc        str" Ta So Li \e0 Sc Ta
+.No "pad character"
+.It "pe        bool    false   use printer (hard copy) erase algorithm"
+.It "pf        num     0       delay"
+between first prompt and following flush (seconds)
+.It "ps        bool    false   line connected to a"
+.Tn MICOM
+port selector
+.It "qu        str" Ta So Li \&^\e Sc Ta
+.No "quit character"
+.It "rp        str" Ta So Li ^R Sc Ta
+.No "line retype character"
+.It "rw        bool    false   do"
+.Tn NOT
+use raw for input, use cbreak
+.It "sp        num     unused  line speed (input and output)"
+.It "su        str" Ta So Li ^Z Sc Ta
+.No "suspend character"
+.It "tc        str     none    table continuation"
+.It "to        num     0       timeout (seconds)"
+.It "tt        str" Ta Dv NULL Ta
+.No "terminal type (for environment)"
+.It "ub        bool    false   do unbuffered output (of prompts etc)"
+.It "uc        bool    false   terminal is known upper case only"
+.It "we        str" Ta So Li ^W Sc Ta
+.No "word erase character"
+.It "xc        bool    false   do
+.Tn NOT
+echo control chars as
+.Ql ^X
+.It "xf        str" Ta So Li ^S Sc Ta Dv XOFF
+(stop output) character
+.It "xn        str" Ta So Li ^Q Sc Ta Dv XON
+(start output) character
+.El
+.Pp
 If no line speed is specified, speed will not be altered
 from that which prevails when getty is entered.
 Specifying an input or output speed will override
 line speed for stated direction only.
 If no line speed is specified, speed will not be altered
 from that which prevails when getty is entered.
 Specifying an input or output speed will override
 line speed for stated direction only.
-.PP
+.Pp
 Terminal modes to be used for the output of the message,
 for input of the login name,
 and to leave the terminal set as upon completion,
 Terminal modes to be used for the output of the message,
 for input of the login name,
 and to leave the terminal set as upon completion,
@@ -118,127 +182,142 @@ are derived from the boolean flags specified.
 If the derivation should prove inadequate,
 any (or all) of these three may be overriden
 with one of the
 If the derivation should prove inadequate,
 any (or all) of these three may be overriden
 with one of the
-.BR f0 ,
-.BR f1 ", or"
-.B f2
+.Em \&f0 ,
+.Em \&f1 ,
+or
+.Em \&f2
 numeric specifications, which can be used to specify
 (usually in octal, with a leading '0')
 the exact values of the flags.
 Local (new tty) flags are set in the top 16 bits
 of this (32 bit) value.
 numeric specifications, which can be used to specify
 (usually in octal, with a leading '0')
 the exact values of the flags.
 Local (new tty) flags are set in the top 16 bits
 of this (32 bit) value.
-.PP
+.Pp
 Should
 Should
-.I getty
+.Xr getty
 receive a null character
 (presumed to indicate a line break)
 it will restart using the table indicated by the
 receive a null character
 (presumed to indicate a line break)
 it will restart using the table indicated by the
-.B nx
+.Em nx
 entry. If there is none, it will re-use its original table.
 entry. If there is none, it will re-use its original table.
-.PP
+.Pp
 Delays are specified in milliseconds, the nearest possible
 delay available in the tty driver will be used.
 Should greater certainty be desired, delays
 with values 0, 1, 2, and 3 are interpreted as
 choosing that particular delay algorithm from the driver.
 Delays are specified in milliseconds, the nearest possible
 delay available in the tty driver will be used.
 Should greater certainty be desired, delays
 with values 0, 1, 2, and 3 are interpreted as
 choosing that particular delay algorithm from the driver.
-.PP
+.Pp
 The
 The
-.cl
+.Em \&cl
 screen clear string may be preceded by a (decimal) number
 of milliseconds of delay required (a la termcap).
 This delay is simulated by repeated use of the pad character
 screen clear string may be preceded by a (decimal) number
 of milliseconds of delay required (a la termcap).
 This delay is simulated by repeated use of the pad character
-.BR pc .
-.PP
+.Em \&pc .
+.Pp
 The initial message, and login message,
 The initial message, and login message,
-.im
+.Em \&im
 and
 and
-.B lm
-may include the character sequence \fB%h\fP or \fB%t\fP to obtain
+.Em \&lm
+may include the character sequence
+.Em \&%h
+or
+.Em \&%t
+to obtain
 the hostname or tty name respectively.
 the hostname or tty name respectively.
-(\fB%%\fP obtains a single '%' character.)
+.Pf ( Em %%
+obtains a single '%' character.)
 The hostname is normally obtained from the system,
 but may be set by the
 The hostname is normally obtained from the system,
 but may be set by the
-.hn
+.Em \&hn
 table entry.
 In either case it may be edited with
 table entry.
 In either case it may be edited with
-.BR he .
+.Em \&he .
 The
 The
-.he
+.Em \&he
 string is a sequence of characters, each character that
 is neither '@' nor '#' is copied into the final hostname.
 A '@' in the
 string is a sequence of characters, each character that
 is neither '@' nor '#' is copied into the final hostname.
 A '@' in the
-.he
+.Em \&he
 string, causes one character from the real hostname to
 be copied to the final hostname.
 A '#' in the
 string, causes one character from the real hostname to
 be copied to the final hostname.
 A '#' in the
-.he
+.Em \&he
 string, causes the next character of the real hostname
 to be skipped.
 Surplus '@' and '#' characters are ignored.
 string, causes the next character of the real hostname
 to be skipped.
 Surplus '@' and '#' characters are ignored.
-.PP
+.Pp
 When getty execs the login process, given
 in the
 When getty execs the login process, given
 in the
-.B lo
-string (usually "/usr/bin/login"), it will have set
+.Em \&lo
+string (usually
+.Dq Pa /usr/bin/login ) ,
+it will have set
 the enviroment to include the terminal type, as indicated
 by the
 the enviroment to include the terminal type, as indicated
 by the
-.tt
+.Em \&tt
 string (if it exists).
 The
 string (if it exists).
 The
-.ev
+.Em \&ev
 string, can be used to enter additional data into
 the environment.
 It is a list of comma separated strings, each of which
 will presumably be of the form
 string, can be used to enter additional data into
 the environment.
 It is a list of comma separated strings, each of which
 will presumably be of the form
-.IR name=value .
-.PP
+.Em name=value .
+.Pp
 If a non-zero timeout is specified, with
 If a non-zero timeout is specified, with
-.BR to ,
+.Em \&to ,
 then getty will exit within the indicated
 number of seconds, either having
 received a login name and passed control
 to
 then getty will exit within the indicated
 number of seconds, either having
 received a login name and passed control
 to
-.IR login ,
+.Xr login ,
 or having received an alarm signal, and exited.
 This may be useful to hangup dial in lines.
 or having received an alarm signal, and exited.
 This may be useful to hangup dial in lines.
-.PP
+.Pp
 Output from
 Output from
-.I getty
+.Xr getty
 is even parity unless
 is even parity unless
-.op
+.Em \&op
 is specified.
 is specified.
-.B Op
+The
+.Em \&op
+string
 may be specified with
 may be specified with
-.ap
+.Em \&ap
 to allow any parity on input, but generate odd parity output.
 Note: this only applies while getty is being run,
 terminal driver limitations prevent a more complete
 implementation.
 to allow any parity on input, but generate odd parity output.
 Note: this only applies while getty is being run,
 terminal driver limitations prevent a more complete
 implementation.
-.I Getty
+.Xr Getty
 does not check parity of input characters in
 does not check parity of input characters in
-.I RAW
+.Dv RAW
 mode.
 mode.
-.SH "SEE ALSO"
-login(1),
-termcap(5),
-getty(8).
-.SH BUGS
+.Sh SEE ALSO
+.Xr login 1 ,
+.Xr termcap 5 ,
+.Xr getty 8 .
+.Sh BUGS
 The special characters (erase, kill, etc.) are reset to system defaults
 by
 The special characters (erase, kill, etc.) are reset to system defaults
 by
-.IR login (1).
+.Xr login 1 .
 In
 In
-.B all
+.Em all
 cases, '#' or '^H' typed in a login name will be treated as
 an erase character, and '@' will be treated as a kill character.
 cases, '#' or '^H' typed in a login name will be treated as
 an erase character, and '@' will be treated as a kill character.
-.PP
+.Pp
 The delay stuff is a real crock.
 Apart form its general lack of flexibility, some
 of the delay algorithms are not implemented.
 The terminal driver should support sane delay settings.
 The delay stuff is a real crock.
 Apart form its general lack of flexibility, some
 of the delay algorithms are not implemented.
 The terminal driver should support sane delay settings.
-.PP
+.Pp
 The
 The
-.he
+.Em \&he
 capability is stupid.
 capability is stupid.
-.PP
-.I Termcap
+.Pp
+The
+.Xr termcap
 format is horrid, something more rational should
 have been chosen.
 format is horrid, something more rational should
 have been chosen.
+.Sh HISTORY
+The
+.Nm gettytab
+file format appeared in 4.2BSD.