If a neighbor solictation or neighbor advertisement isn't from the
[dragonfly.git] / libexec / getty / getty.8
CommitLineData
984263bc
MD
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.\" 3. All advertising materials mentioning features or use of this software
13.\" must display the following acknowledgement:
14.\" This product includes software developed by the University of
15.\" California, Berkeley and its contributors.
16.\" 4. Neither the name of the University nor the names of its contributors
17.\" may be used to endorse or promote products derived from this software
18.\" without specific prior written permission.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30.\" SUCH DAMAGE.
31.\"
32.\" from: @(#)getty.8 8.1 (Berkeley) 6/4/93
33.\" $FreeBSD: src/libexec/getty/getty.8,v 1.10.2.3 2001/08/16 10:44:15 ru Exp $
d600454b 34.\" $DragonFly: src/libexec/getty/getty.8,v 1.4 2006/02/17 19:33:31 swildner Exp $
984263bc
MD
35.\" "
36.Dd June 4, 1993
37.Dt GETTY 8
38.Os
39.Sh NAME
40.Nm getty
41.Nd set terminal mode
42.Sh SYNOPSIS
43.Nm
44.Oo
45.Ar type
46.Op Ar tty
47.Oc
48.Sh DESCRIPTION
49The
50.Nm
51program
52is called by
53.Xr init 8
54to open and initialize the tty line, read a login name, and invoke
55.Xr login 1 .
56.Pp
57The argument
58.Ar tty
59is the special device file in
60.Pa /dev
61to open for the terminal (for example, ``ttyh0'').
62If there is no argument or the argument is
e5ab4b11 63.Sq Fl ,
984263bc
MD
64the tty line is assumed to be open as file descriptor 0.
65.Pp
66The
67.Ar type
68argument can be used to make
69.Nm
70treat the terminal line specially.
71This argument is used as an index into the
72.Xr gettytab 5
73database, to determine the characteristics of the line.
74If there is no argument, or there is no such table, the
75.Em default
76table is used.
77If there is no
78.Pa /etc/gettytab
79a set of system defaults is used.
80If indicated by the table located,
81.Nm
82will clear the terminal screen,
83print a banner heading,
84and prompt for a login name.
85Usually either the banner or the login prompt will include
86the system hostname.
87.Pp
88Most of the default actions of
89.Nm
90can be circumvented, or modified, by a suitable
91.Pa gettytab
92table.
93.Pp
94The
95.Nm
96program
97can be set to timeout after some interval,
98which will cause dial up lines to hang up
99if the login name is not entered reasonably quickly.
d600454b
SW
100.Sh FILES
101.Bl -tag -width /etc/gettytab -compact
102.It Pa /etc/gettytab
103.It Pa /etc/ttys
104.El
984263bc
MD
105.Sh DIAGNOSTICS
106.Bl -diag
107.It "ttyxx: No such device or address."
108.It "ttyxx: No such file or address."
109.Pp
110A terminal which is turned
111on in the
112.Pa ttys
113file cannot be opened, likely because the requisite
114lines are either not configured into the system, the associated device
115was not attached during boot-time system configuration,
116or the special file in
117.Pa /dev
118does not exist.
119.El
984263bc
MD
120.Sh SEE ALSO
121.Xr login 1 ,
122.Xr ioctl 2 ,
123.Xr tty 4 ,
124.Xr gettytab 5 ,
125.Xr ttys 5 ,
126.Xr init 8
127.Sh HISTORY
128A
129.Nm
130program appeared in
131.At v6 .