freebsd-dev/libexec/getty/ttys.5

.\" Copyright (c) 1985, 1991, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" 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.
.\"
.\" 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.
.\"
.\"     from: @(#)ttys.5	8.1 (Berkeley) 6/4/93
.\" $FreeBSD$
.\" "
.Dd November 17, 1996
.Dt TTYS 5
.Os
.Sh NAME
.Nm ttys
.Nd terminal initialization information
.Sh DESCRIPTION
The file
.Nm
contains information that is used by various routines to initialize
and control the use of terminal special files.
This information is read with the
.Xr getttyent 3
library routines.
There is one line in the
.Nm
file per special device file.
Fields are separated by tabs and/or spaces.
Fields comprised of more than one word should be enclosed in double
quotes (``"'').
Blank lines and comments may appear anywhere in the file; comments
are delimited by hash marks (``#'') and new lines.
Any unspecified fields will default to null.
.Pp
The first field is normally the
name of the terminal special file as it is found in
.Pa /dev .
However, it can be any arbitrary string
when the associated command is not related to a tty.
.Pp
The second field of the file is the command to execute for the line,
usually
.Xr getty 8 ,
which initializes and opens the line, setting the speed, waiting for
a user name and executing the
.Xr login 1
program.
It can be, however, any desired command, for example
the start up for a window system terminal emulator or some other
daemon process, and can contain multiple words if quoted.
.Pp
The third field is the type of terminal usually connected to that
tty line, normally the one found in the
.Xr termcap 5
data base file.
The environment variable
.Ev TERM
is initialized with the value by
either
.Xr getty 8
or
.Xr login 1 .
.Pp
The remaining fields set flags in the
.Fa ty_status
entry (see
.Xr getttyent 3 ) ,
specify a window system process that
.Xr init 8
will maintain for the terminal line, optionally determine the
type of tty (whether dialin, network or otherwise),
or specify a tty group
name that allows the login class database (see
.Xr login.conf 5 )
to refer to many ttys as a group, to selectively allow or
deny access or enable or disable accounting facilities for
ttys as a group.
.Pp
As flag values, the strings ``on'' and ``off'' specify that
.Xr init 8
should (should not) execute the command given in the second field,
while ``secure'' (if ``on'' is also specified) allows users with a
uid of 0 to login on
this line.
The flag ``dialin'' indicates that a tty entry describes a dialin
line, and ``network'' indicates that a tty entry provides a
network connection.
Either of these strings may also be specified in the terminal type
field.
The string ``window='' may be followed by a quoted command
string which
.Xr init 8
will execute
.Em before
starting the command specified by the second field.
.Pp
The string ``group='' may be followed by a group name comprised of
alphanumeric characters that can be used by
.Xr login.conf 5
to refer to many tty lines as a group to enable or disable access
and accounting facilities.
If no group is specified, then the tty becomes a member of the group
"none".
For backwards compatibility, the ``group='' should appear last on the
line, immediately before the optional comment.
.Pp
Both the second field and any command specified with ``window=''
will be split into words and executed using
.Xr execve 2 .
Words are separated by any combinations of tabs and spaces.
Arguments containing whitespace should be enclosed in single quotes
.Pq Li ' .
Note that no shell-style globbing or other variable substitution occurs.
.Sh EXAMPLES
.Bd -literal
# root login on console at 1200 baud
console	"/usr/libexec/getty std.1200"	vt100	on secure
# dialup at 1200 baud, no root logins
ttyd0	"/usr/libexec/getty d1200"	dialup	on group=dialup	# 555-1234
# Mike's terminal: hp2621
ttyh0	"/usr/libexec/getty std.9600"	hp2621-nl	on group=dialup	# 457 Evans
# John's terminal: vt100
ttyh1	"/usr/libexec/getty std.9600"	vt100	on group=dialup		# 459 Evans
# terminal emulate/window system
ttyv0	"/usr/new/xterm -L :0"		vs100	on window="/usr/new/Xvs100 0"
# Network pseudo ttys -- don't enable getty
ttyp0	none	network 	group=pty
ttyp1	none	network	off	group=pty
.Ed
.Sh FILES
.Bl -tag -width /etc/ttys -compact
.It Pa /etc/ttys
.El
.Sh SEE ALSO
.Xr login 1 ,
.Xr getttyent 3 ,
.Xr ttyslot 3 ,
.Xr gettytab 5 ,
.Xr login.conf 5 ,
.Xr termcap 5 ,
.Xr getty 8 ,
.Xr init 8
.\".Xr init 8 ,
.\".Xr ttyflags 8
.Sh HISTORY
A
.Nm
file appeared in
.At v6 .
Finally commit the changes that make getty(8) no longer depend on the COMPAT_43 cruft. This is supposedly the last core utility that has been using it! (So now, one should be able to remove this option from the config files. Be aware that the last officially released xterm however still requires it.) The getty has been running now for several weeks on my modem line, so i feel safe about it. Obtained from: mostly from the NetBSD vendor-branch 1996-05-05 19:01:13 +00:00			`.\" Copyright (c) 1985, 1991, 1993`
			`.\" The Regents of the University of California. All rights reserved.`
BSD 4.4 Lite Libexec Sources 1994-05-27 12:39:25 +00:00			`.\"`
			`.\" 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.`
			`.\"`
			.\" 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.`
			`.\"`
Finally commit the changes that make getty(8) no longer depend on the COMPAT_43 cruft. This is supposedly the last core utility that has been using it! (So now, one should be able to remove this option from the config files. Be aware that the last officially released xterm however still requires it.) The getty has been running now for several weeks on my modem line, so i feel safe about it. Obtained from: mostly from the NetBSD vendor-branch 1996-05-05 19:01:13 +00:00			`.\" from: @(#)ttys.5 8.1 (Berkeley) 6/4/93`
$Id$ -> $FreeBSD$ 1999-08-28 00:22:10 +00:00			`.\" $FreeBSD$`
Finally commit the changes that make getty(8) no longer depend on the COMPAT_43 cruft. This is supposedly the last core utility that has been using it! (So now, one should be able to remove this option from the config files. Be aware that the last officially released xterm however still requires it.) The getty has been running now for several weeks on my modem line, so i feel safe about it. Obtained from: mostly from the NetBSD vendor-branch 1996-05-05 19:01:13 +00:00			`.\" "`
Added group= facility to /etc/ttys for tty grouping for more more manageable and convenient referencing by login.conf (login class database) and (e.g.) login.access. This is the first of a group of commits which implements the login class capabilities database. 1997-01-02 08:05:43 +00:00			`.Dd November 17, 1996`
BSD 4.4 Lite Libexec Sources 1994-05-27 12:39:25 +00:00			`.Dt TTYS 5`
			`.Os`
			`.Sh NAME`
			`.Nm ttys`
			`.Nd terminal initialization information`
			`.Sh DESCRIPTION`
			`The file`
Correct incompletes .Xrs. Remove duplicate #includes and unused variables. 1997-11-21 07:43:53 +00:00			`.Nm`
BSD 4.4 Lite Libexec Sources 1994-05-27 12:39:25 +00:00			`contains information that is used by various routines to initialize`
			`and control the use of terminal special files.`
			`This information is read with the`
			`.Xr getttyent 3`
			`library routines.`
Remove whitespace at EOL. 2001-07-15 07:53:42 +00:00			`There is one line in the`
Correct incompletes .Xrs. Remove duplicate #includes and unused variables. 1997-11-21 07:43:53 +00:00			`.Nm`
BSD 4.4 Lite Libexec Sources 1994-05-27 12:39:25 +00:00			`file per special device file.`
			`Fields are separated by tabs and/or spaces.`
			`Fields comprised of more than one word should be enclosed in double`
			quotes (``"'').
			`Blank lines and comments may appear anywhere in the file; comments`
			are delimited by hash marks (``#'') and new lines.
			`Any unspecified fields will default to null.`
			`.Pp`
Correct the ttys.5 and init.8 manpages with respect to the incorrect assumption that only getty processes can be managed. Describe the SysV-like ability to keep arbitrary long-running processes alive using a non-device first field in /etc/ttys. PR: 12767 Submitted by: Peter Jeremy <peter.jeremy@alcatel.com.au> 1999-12-06 09:07:14 +00:00			`The first field is normally the`
BSD 4.4 Lite Libexec Sources 1994-05-27 12:39:25 +00:00			`name of the terminal special file as it is found in`
			`.Pa /dev .`
Correct the ttys.5 and init.8 manpages with respect to the incorrect assumption that only getty processes can be managed. Describe the SysV-like ability to keep arbitrary long-running processes alive using a non-device first field in /etc/ttys. PR: 12767 Submitted by: Peter Jeremy <peter.jeremy@alcatel.com.au> 1999-12-06 09:07:14 +00:00			`However, it can be any arbitrary string`
			`when the associated command is not related to a tty.`
BSD 4.4 Lite Libexec Sources 1994-05-27 12:39:25 +00:00			`.Pp`
			`The second field of the file is the command to execute for the line,`
			`usually`
			`.Xr getty 8 ,`
			`which initializes and opens the line, setting the speed, waiting for`
			`a user name and executing the`
			`.Xr login 1`
			`program.`
			`It can be, however, any desired command, for example`
			`the start up for a window system terminal emulator or some other`
			`daemon process, and can contain multiple words if quoted.`
			`.Pp`
			`The third field is the type of terminal usually connected to that`
			`tty line, normally the one found in the`
			`.Xr termcap 5`
			`data base file.`
			`The environment variable`
Correct incompletes .Xrs. Remove duplicate #includes and unused variables. 1997-11-21 07:43:53 +00:00			`.Ev TERM`
BSD 4.4 Lite Libexec Sources 1994-05-27 12:39:25 +00:00			`is initialized with the value by`
			`either`
			`.Xr getty 8`
			`or`
			`.Xr login 1 .`
			`.Pp`
			`The remaining fields set flags in the`
			`.Fa ty_status`
			`entry (see`
Prepare for mdoc(7)NG. 2001-01-16 09:15:57 +00:00			`.Xr getttyent 3 ) ,`
Added group= facility to /etc/ttys for tty grouping for more more manageable and convenient referencing by login.conf (login class database) and (e.g.) login.access. This is the first of a group of commits which implements the login class capabilities database. 1997-01-02 08:05:43 +00:00			`specify a window system process that`
BSD 4.4 Lite Libexec Sources 1994-05-27 12:39:25 +00:00			`.Xr init 8`
Remove text about unsupported flags 'mdmbuf', 'local', 'crtscts' etc that are in reality handled in gettytab. Document the new 'dialin' and 'network' tty flags. 1997-04-13 21:29:50 +00:00			`will maintain for the terminal line, optionally determine the`
			`type of tty (whether dialin, network or otherwise),`
			`or specify a tty group`
Added group= facility to /etc/ttys for tty grouping for more more manageable and convenient referencing by login.conf (login class database) and (e.g.) login.access. This is the first of a group of commits which implements the login class capabilities database. 1997-01-02 08:05:43 +00:00			`name that allows the login class database (see`
			`.Xr login.conf 5 )`
			`to refer to many ttys as a group, to selectively allow or`
			`deny access or enable or disable accounting facilities for`
			`ttys as a group.`
BSD 4.4 Lite Libexec Sources 1994-05-27 12:39:25 +00:00			`.Pp`
			As flag values, the strings ``on'' and ``off'' specify that
Correct incompletes .Xrs. Remove duplicate #includes and unused variables. 1997-11-21 07:43:53 +00:00			`.Xr init 8`
BSD 4.4 Lite Libexec Sources 1994-05-27 12:39:25 +00:00			`should (should not) execute the command given in the second field,`
			while ``secure'' (if ``on'' is also specified) allows users with a
			`uid of 0 to login on`
			`this line.`
Remove text about unsupported flags 'mdmbuf', 'local', 'crtscts' etc that are in reality handled in gettytab. Document the new 'dialin' and 'network' tty flags. 1997-04-13 21:29:50 +00:00			The flag ``dialin'' indicates that a tty entry describes a dialin
			line, and ``network'' indicates that a tty entry provides a
			`network connection.`
			`Either of these strings may also be specified in the terminal type`
			`field.`
BSD 4.4 Lite Libexec Sources 1994-05-27 12:39:25 +00:00			The string ``window='' may be followed by a quoted command
			`string which`
Correct incompletes .Xrs. Remove duplicate #includes and unused variables. 1997-11-21 07:43:53 +00:00			`.Xr init 8`
BSD 4.4 Lite Libexec Sources 1994-05-27 12:39:25 +00:00			`will execute`
			`.Em before`
			`starting the command specified by the second field.`
Added group= facility to /etc/ttys for tty grouping for more more manageable and convenient referencing by login.conf (login class database) and (e.g.) login.access. This is the first of a group of commits which implements the login class capabilities database. 1997-01-02 08:05:43 +00:00			`.Pp`
			The string ``group='' may be followed by a group name comprised of
			`alphanumeric characters that can be used by`
login.group => login.conf. PR: 3748 Reviewed by: Submitted by: Obtained from: 1997-06-02 21:03:20 +00:00			`.Xr login.conf 5`
Added group= facility to /etc/ttys for tty grouping for more more manageable and convenient referencing by login.conf (login class database) and (e.g.) login.access. This is the first of a group of commits which implements the login class capabilities database. 1997-01-02 08:05:43 +00:00			`to refer to many tty lines as a group to enable or disable access`
			`and accounting facilities.`
			`If no group is specified, then the tty becomes a member of the group`
			`"none".`
			For backwards compatibility, the ``group='' should appear last on the
			`line, immediately before the optional comment.`
Correct the ttys.5 and init.8 manpages with respect to the incorrect assumption that only getty processes can be managed. Describe the SysV-like ability to keep arbitrary long-running processes alive using a non-device first field in /etc/ttys. PR: 12767 Submitted by: Peter Jeremy <peter.jeremy@alcatel.com.au> 1999-12-06 09:07:14 +00:00			`.Pp`
			Both the second field and any command specified with ``window=''
			`will be split into words and executed using`
			`.Xr execve 2 .`
			`Words are separated by any combinations of tabs and spaces.`
			`Arguments containing whitespace should be enclosed in single quotes`
mdoc(7) police: Avoid using parenthesis enclosure macros (.Pq and .Po/.Pc) with plain text. Not only this slows down the mdoc(7) processing significantly, but it also has an undesired (in this case) effect of disabling hyphenation within the entire enclosed block. 2001-08-07 15:48:51 +00:00			`.Pq Li ' .`
Correct the ttys.5 and init.8 manpages with respect to the incorrect assumption that only getty processes can be managed. Describe the SysV-like ability to keep arbitrary long-running processes alive using a non-device first field in /etc/ttys. PR: 12767 Submitted by: Peter Jeremy <peter.jeremy@alcatel.com.au> 1999-12-06 09:07:14 +00:00			`Note that no shell-style globbing or other variable substitution occurs.`
BSD 4.4 Lite Libexec Sources 1994-05-27 12:39:25 +00:00			`.Sh EXAMPLES`
			`.Bd -literal`
			`# root login on console at 1200 baud`
			`console "/usr/libexec/getty std.1200" vt100 on secure`
			`# dialup at 1200 baud, no root logins`
Added group= facility to /etc/ttys for tty grouping for more more manageable and convenient referencing by login.conf (login class database) and (e.g.) login.access. This is the first of a group of commits which implements the login class capabilities database. 1997-01-02 08:05:43 +00:00			`ttyd0 "/usr/libexec/getty d1200" dialup on group=dialup # 555-1234`
BSD 4.4 Lite Libexec Sources 1994-05-27 12:39:25 +00:00			`# Mike's terminal: hp2621`
Added group= facility to /etc/ttys for tty grouping for more more manageable and convenient referencing by login.conf (login class database) and (e.g.) login.access. This is the first of a group of commits which implements the login class capabilities database. 1997-01-02 08:05:43 +00:00			`ttyh0 "/usr/libexec/getty std.9600" hp2621-nl on group=dialup # 457 Evans`
BSD 4.4 Lite Libexec Sources 1994-05-27 12:39:25 +00:00			`# John's terminal: vt100`
Added group= facility to /etc/ttys for tty grouping for more more manageable and convenient referencing by login.conf (login class database) and (e.g.) login.access. This is the first of a group of commits which implements the login class capabilities database. 1997-01-02 08:05:43 +00:00			`ttyh1 "/usr/libexec/getty std.9600" vt100 on group=dialup # 459 Evans`
BSD 4.4 Lite Libexec Sources 1994-05-27 12:39:25 +00:00			`# terminal emulate/window system`
			`ttyv0 "/usr/new/xterm -L :0" vs100 on window="/usr/new/Xvs100 0"`
			`# Network pseudo ttys -- don't enable getty`
Added group= facility to /etc/ttys for tty grouping for more more manageable and convenient referencing by login.conf (login class database) and (e.g.) login.access. This is the first of a group of commits which implements the login class capabilities database. 1997-01-02 08:05:43 +00:00			`ttyp0 none network group=pty`
			`ttyp1 none network off group=pty`
BSD 4.4 Lite Libexec Sources 1994-05-27 12:39:25 +00:00			`.Ed`
			`.Sh FILES`
			`.Bl -tag -width /etc/ttys -compact`
			`.It Pa /etc/ttys`
			`.El`
			`.Sh SEE ALSO`
			`.Xr login 1 ,`
			`.Xr getttyent 3 ,`
			`.Xr ttyslot 3 ,`
			`.Xr gettytab 5 ,`
Added group= facility to /etc/ttys for tty grouping for more more manageable and convenient referencing by login.conf (login class database) and (e.g.) login.access. This is the first of a group of commits which implements the login class capabilities database. 1997-01-02 08:05:43 +00:00			`.Xr login.conf 5 ,`
BSD 4.4 Lite Libexec Sources 1994-05-27 12:39:25 +00:00			`.Xr termcap 5 ,`
			`.Xr getty 8 ,`
			`.Xr init 8`
Finally commit the changes that make getty(8) no longer depend on the COMPAT_43 cruft. This is supposedly the last core utility that has been using it! (So now, one should be able to remove this option from the config files. Be aware that the last officially released xterm however still requires it.) The getty has been running now for several weeks on my modem line, so i feel safe about it. Obtained from: mostly from the NetBSD vendor-branch 1996-05-05 19:01:13 +00:00			`.\".Xr init 8 ,`
			`.\".Xr ttyflags 8`
BSD 4.4 Lite Libexec Sources 1994-05-27 12:39:25 +00:00			`.Sh HISTORY`
			`A`
			`.Nm`
			`file appeared in`
			`.At v6 .`