libexec/getty/getty.8

   1 .\"     $NetBSD: getty.8,v 1.17 2003/08/07 09:46:42 agc Exp $
   2 .\"
   3 .\" Copyright (c) 1980, 1991, 1993
   4 .\"     The Regents of the University of California.  All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\" 3. Neither the name of the University nor the names of its contributors
  15 .\"    may be used to endorse or promote products derived from this software
  16 .\"    without specific prior written permission.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28 .\" SUCH DAMAGE.
  29 .\"
  30 .\"     from: @(#)getty.8       8.1 (Berkeley) 6/4/93
  31 .\"
  32 .Dd December 12, 1998
  33 .Dt GETTY 8
  34 .Os
  35 .Sh NAME
  36 .Nm getty ,
  37 .Nm uugetty
  38 .Nd set terminal modes for system access
  39 .Sh SYNOPSIS
  40 .Nm
  41 .Oo
  42 .Ar type
  43 .Op Ar tty
  44 .Oc
  45 .Nm uugetty
  46 .Oo
  47 .Ar type
  48 .Op Ar tty
  49 .Oc
  50 .Sh DESCRIPTION
  51 The
  52 .Nm
  53 program
  54 is called by
  55 .Xr init 8
  56 to open and initialize the tty line, read a login name, and invoke
  57 .Xr login 1 .
  58 The devices on which to run
  59 .Nm
  60 are normally determined by
  61 .Xr ttys 5 .
  62 .Pp
  63 The
  64 .Nm
  65 program can also recognize a Point to Point Protocol
  66 .Pq Tn PPP
  67 negotiation, and, if the
  68 .Sy pp
  69 attribute in
  70 .Xr gettytab 5
  71 is set, invoke the program given by that string, e.g.,
  72 .Xr pppd 8 ,
  73 instead of
  74 .Xr login 1 .
  75 This makes it possible to use a single serial port for either a
  76 .Qq shell
  77 account with command line interface, or a
  78 .Tn PPP
  79 network link.
  80 .Pp
  81 The argument
  82 .Ar tty
  83 is the special device file in
  84 .Pa /dev
  85 to open for the terminal
  86 .Po
  87 for example,
  88 .Qq ttyh0
  89 .Pc .
  90 If there is no argument or the argument is
  91 .Ql Fl ,
  92 the tty line is assumed to be open as file descriptor 0.
  93 .Pp
  94 The
  95 .Ar type
  96 argument can be used to make
  97 .Nm
  98 treat the terminal line specially.
  99 This argument is used as an index into the
 100 .Xr gettytab 5
 101 database, to determine the characteristics of the line.
 102 If there is no argument, or there is no such table, the
 103 .Em default
 104 table is used.
 105 If there is no
 106 .Pa /etc/gettytab
 107 a set of system defaults is used.
 108 If indicated by the table located,
 109 .Nm
 110 will clear the terminal screen,
 111 print a banner heading,
 112 and prompt for a login name.
 113 Usually either the banner or the login prompt will include
 114 the system hostname.
 115 .Pp
 116 .Nm
 117 uses the
 118 .Xr ttyaction 3
 119 facility with an action of
 120 .Qq getty
 121 and user
 122 .Qq root
 123 to execute site-specific commands when it starts.
 124 .Pp
 125 Most of the default actions of
 126 .Nm
 127 can be circumvented, or modified, by a suitable
 128 .Xr gettytab 5
 129 table.
 130 .Pp
 131 The
 132 .Nm
 133 program can be set to timeout after some interval,
 134 which will cause dial up lines to hang up
 135 if the login name is not entered reasonably quickly.
 136 .Pp
 137 The
 138 .Nm uugetty
 139 program is the same, except that it uses
 140 .Xr pidlock 3
 141 to respect the locks in
 142 .Pa /var/spool/lock
 143 of processes that dial out on that tty.
 144 .Sh FILES
 145 .Bl -tag -width /var/spool/lock/LCK..ttyXX -compact
 146 .It Pa /etc/gettytab
 147 .It Pa /etc/ttys
 148 .It Pa /var/spool/lock/LCK..ttyXX
 149 .El
 150 .Sh DIAGNOSTICS
 151 .Bl -diag
 152 .It "ttyxx: No such device or address."
 153 .It "ttyxx: No such file or address."
 154 A terminal which is turned on in the
 155 .Xr ttys 5
 156 file cannot be opened, likely because the requisite
 157 lines are either not configured into the system, the associated device
 158 was not attached during boot-time system configuration,
 159 or the special file in
 160 .Pa /dev
 161 does not exist.
 162 .El
 163 .Sh SEE ALSO
 164 .Xr login 1 ,
 165 .Xr ioctl 2 ,
 166 .Xr pidlock 3 ,
 167 .Xr ttyaction 3 ,
 168 .Xr tty 4 ,
 169 .Xr gettytab 5 ,
 170 .Xr ttys 5 ,
 171 .Xr init 8 ,
 172 .Xr pppd 8
 173 .Sh HISTORY
 174 A
 175 .Nm
 176 program appeared in
 177 .At v6 .