Remove advertising header from man pages.
[dragonfly.git] / libexec / getty / getty.8
1 .\" Copyright (c) 1980, 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 .\" 4. 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: @(#)getty.8       8.1 (Berkeley) 6/4/93
29 .\" $FreeBSD: src/libexec/getty/getty.8,v 1.10.2.3 2001/08/16 10:44:15 ru Exp $
30 .\" $DragonFly: src/libexec/getty/getty.8,v 1.4 2006/02/17 19:33:31 swildner Exp $
31 .\" "
32 .Dd June 4, 1993
33 .Dt GETTY 8
34 .Os
35 .Sh NAME
36 .Nm getty
37 .Nd set terminal mode
38 .Sh SYNOPSIS
39 .Nm
40 .Oo
41 .Ar type
42 .Op Ar tty
43 .Oc
44 .Sh DESCRIPTION
45 The
46 .Nm
47 program
48 is called by
49 .Xr init 8
50 to open and initialize the tty line, read a login name, and invoke
51 .Xr login 1 .
52 .Pp
53 The argument
54 .Ar tty
55 is the special device file in
56 .Pa /dev
57 to open for the terminal (for example, ``ttyh0'').
58 If there is no argument or the argument is
59 .Sq Fl ,
60 the tty line is assumed to be open as file descriptor 0.
61 .Pp
62 The
63 .Ar type
64 argument can be used to make
65 .Nm
66 treat the terminal line specially.
67 This argument is used as an index into the
68 .Xr gettytab 5
69 database, to determine the characteristics of the line.
70 If there is no argument, or there is no such table, the
71 .Em default
72 table is used.
73 If there is no
74 .Pa /etc/gettytab
75 a set of system defaults is used.
76 If indicated by the table located,
77 .Nm
78 will clear the terminal screen,
79 print a banner heading,
80 and prompt for a login name.
81 Usually either the banner or the login prompt will include
82 the system hostname.
83 .Pp
84 Most of the default actions of
85 .Nm
86 can be circumvented, or modified, by a suitable
87 .Pa gettytab
88 table.
89 .Pp
90 The
91 .Nm
92 program
93 can be set to timeout after some interval,
94 which will cause dial up lines to hang up
95 if the login name is not entered reasonably quickly.
96 .Sh FILES
97 .Bl -tag -width /etc/gettytab -compact
98 .It Pa /etc/gettytab
99 .It Pa /etc/ttys
100 .El
101 .Sh DIAGNOSTICS
102 .Bl -diag
103 .It "ttyxx: No such device or address."
104 .It "ttyxx: No such file or address."
105 .Pp
106 A terminal which is turned
107 on in the
108 .Pa ttys
109 file cannot be opened, likely because the requisite
110 lines are either not configured into the system, the associated device
111 was not attached during boot-time system configuration,
112 or the special file in
113 .Pa /dev
114 does not exist.
115 .El
116 .Sh SEE ALSO
117 .Xr login 1 ,
118 .Xr ioctl 2 ,
119 .Xr tty 4 ,
120 .Xr gettytab 5 ,
121 .Xr ttys 5 ,
122 .Xr init 8
123 .Sh HISTORY
124 A
125 .Nm
126 program appeared in
127 .At v6 .