Module Name: src
Committed By: uwe
Date: Wed Jul 3 15:19:54 UTC 2024
Modified Files:
src/libexec/getty: ttys.5
Log Message:
ttys(5): touch up markup
Make the original SIGHUP example at the end of the text more visible
by using a display to show it. I will let riastradh@ decide how he
wants to deal with that duplicate. The one at the end also mentions
ttyflags(8) which refers to the flags documented in this manpage, so
it's a bit awkward to move that paragraph to the beginning of the
page.
To generate a diff of this commit:
cvs rdiff -u -r1.21 -r1.22 src/libexec/getty/ttys.5
Please note that diffs are not public domain; they are subject to the
copyright notices on the relevant files.
Modified files:
Index: src/libexec/getty/ttys.5
diff -u src/libexec/getty/ttys.5:1.21 src/libexec/getty/ttys.5:1.22
--- src/libexec/getty/ttys.5:1.21 Wed Jul 3 14:15:21 2024
+++ src/libexec/getty/ttys.5 Wed Jul 3 15:19:54 2024
@@ -1,4 +1,4 @@
-.\" $NetBSD: ttys.5,v 1.21 2024/07/03 14:15:21 riastradh Exp $
+.\" $NetBSD: ttys.5,v 1.22 2024/07/03 15:19:54 uwe Exp $
.\"
.\" Copyright (c) 1985, 1991, 1993
.\" The Regents of the University of California. All rights reserved.
@@ -47,6 +47,7 @@ library routines, and is used by
which can be notified of changes to
.Nm
by:
+.Pp
.Dl kill -HUP 1
.Pp
There is one line in the
@@ -54,14 +55,18 @@ There is one line in the
file per special device file.
Fields are separated by tabs and/or spaces.
Fields comprising more than one word should be enclosed in double
-quotes (``"'').
+quotes
+.Pq Ql \*q .
Blank lines and comments may appear anywhere in the file; comments
-are delimited by hash marks (``#'') and new lines.
+are delimited by hash marks
+.Pq Ql #
+and new lines.
Any unspecified fields will default to null.
.Pp
Each line in
.Nm
has the format:
+.Pp
.Dl tty command type flags
.Pp
The first field is the
@@ -84,7 +89,7 @@ tty line, normally the one found in the
.Xr terminfo 5
data base file.
The environment variable
-.Dv TERM
+.Ev TERM
is initialized with the value by either
.Xr getty 8
or
@@ -92,24 +97,29 @@ or
.Pp
The remaining fields set flags in the
.Fa ty_status
-entry (see
-.Xr getttyent 3 )
+entry
+.Pq see Xr getttyent 3
or specify a window system process that
.Xr init 8
will maintain for the terminal line
-or a key into a database of tty attributes (currently unused).
-.Pp
-.Bl -tag -width softcar
-.It Sy on No or Sy off
+or a key into a database of tty attributes
+.Pq currently unused .
+.Bl -tag -offset indent -width Ic
+.\"
+.It Ic on No or Ic off
.Xr init 8
-should (or should not) execute the command given in the second field.
-.It Sy secure
+should
+.Pq or should not
+execute the command given in the second field.
+.\"
+.It Ic secure
If
-.Sy on
+.Ic on
is specified, allows users with a uid of 0
.Pq e.g. Qq root
to login on this line.
-.It Sy local
+.\"
+.It Ic local
Sets the
.Dv TIOCFLAG_CLOCAL
.Xr tty 4
@@ -119,49 +129,57 @@ This will cause the
.Dv CLOCAL
flag to be set on every open and thus modem control signal lines will be
ignored by default.
-.It Sy softcar
-Causes the driver to ignore hardware carrier on the line (by setting the
+.\"
+.It Ic softcar
+Causes the driver to ignore hardware carrier on the line
+.Po
+by setting the
.Dv TIOCFLAG_SOFTCAR
.Xr tty 4
-flag).
-.It Sy rtscts
+flag
+.Pc .
+.\"
+.It Ic rtscts
Sets the
.Dv TIOCFLAG_CRTSCTS
.Xr tty 4
flag for the device to enable
-.Tn RTS /
-.Tn CTS
-.Qq hardware
+.Tn RTS Ns / Ns Tn CTS
+.Dq hardware
flow control by default.
-.It Sy mdmbuf
+.\"
+.It Ic mdmbuf
Sets the
.Dv TIOCFLAG_MDMBUF
.Xr tty 4
flag for the device to enable
-.Tn DTR /
-.Tn DCD
-.Qq hardware
+.Tn DTR Ns / Ns Tn DCD
+.Dq hardware
flow control by default.
.El
.Pp
The flags
-.Qq local ,
-.Qq rtscts ,
-.Qq mdmbuf ,
+.Ic local ,
+.Ic rtscts ,
+.Ic mdmbuf ,
and
-.Qq softcar
+.Ic softcar
modify the default behaviour of the terminal line, and their actions
are device driver dependent.
These flag fields should not be quoted.
.Pp
-The string ``window='' may be followed by a quoted command
+The string
+.Ql 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 ``class='' may be followed by a quoted string used
+The string
+.Ql class=
+may be followed by a quoted string used
as a key into a database of attributes for that category of tty.
See
.Xr getttynam 3
@@ -174,7 +192,9 @@ file a
signal can be sent to
.Xr init 8
with the command
-.Dq Li "kill \-s HUP 1" .
+.Pp
+.Dl kill -s HUP 1
+.Pp
On receipt of this signal,
.Xr init 8
will re-read the
@@ -183,7 +203,7 @@ file and spawn any necessary
.Xr getty 8
processes.
.Pp
-.Sy Nota Bene :
+.Sy NB :
Sending
.Dv SIGHUP
to
@@ -196,24 +216,24 @@ device flags listed above; the
.Xr ttyflags 8
program must be run for changes in those flags to take effect on the devices.
.Sh FILES
-.Bl -tag -width /etc/ttys -compact
+.Bl -tag -width Pa -compact
.It Pa /etc/ttys
.El
.Sh EXAMPLES
.Bd -literal
# root login on console at 1200 baud
-console "/usr/libexec/getty std.1200" vt100 on secure
+console "/usr/libexec/getty std.1200" vt100 on secure
# dialup at 1200 baud, no root logins
-tty00 "/usr/libexec/getty d1200" dialup on # 555-1234
+tty00 "/usr/libexec/getty d1200" dialup on # 555-1234
# Mike's terminal: hp2621
-ttyh0 "/usr/libexec/getty std.9600" hp2621-nl on # 457 Evans
+ttyh0 "/usr/libexec/getty std.9600" hp2621-nl on # 457 Evans
# John's terminal: vt100
-ttyh1 "/usr/libexec/getty std.9600" vt100 on # 459 Evans
+ttyh1 "/usr/libexec/getty std.9600" vt100 on # 459 Evans
# terminal emulate/window system
-ttyv0 "/usr/new/xterm -L :0" vs100 on window="/usr/new/Xvs100 0"
+ttyv0 "/usr/new/xterm -L :0" vs100 on window="/usr/new/Xvs100 0"
# Network pseudo ttys -- don't enable getty
ttyp0 none network
-ttyp1 none network off
+ttyp1 none network off
.Ed
.Sh SEE ALSO
.Xr login 1 ,
