PR/13478: Greg A. Woods: some tty-related documentation fixes

Patch applied with "minor tweaks" from me, thanks!
This commit is contained in:
elad 2006-10-06 22:07:44 +00:00
parent e723f89fb8
commit 516c371048
6 changed files with 114 additions and 41 deletions

View File

@ -1,4 +1,4 @@
.\" $NetBSD: gettytab.5,v 1.32 2005/05/21 17:18:51 christos Exp $
.\" $NetBSD: gettytab.5,v 1.33 2006/10/06 22:07:44 elad Exp $
.\"
.\" Copyright (c) 1983, 1991, 1993
.\" The Regents of the University of California. All rights reserved.
@ -29,7 +29,7 @@
.\"
.\" from: @(#)gettytab.5 8.4 (Berkeley) 4/19/94
.\"
.Dd May 21, 2005
.Dd October 7, 2006
.Dt GETTYTAB 5
.Os
.Sh NAME
@ -66,6 +66,18 @@ that is used to set global defaults for all other classes.
.Em default
entry is read, then the entry for the class required
is used to override particular settings.)
The
.Em default
entry is also normally read by other programs that present login prompts
to the user, such as
.Xr telnetd 8 ,
in order to retrieve the values of the
.Em he ,
.Em hn ,
.Em im ,
and
.EM if
capabilities.
.Sh CAPABILITIES
Refer to
.Xr termcap 5
@ -78,6 +90,7 @@ no entry in the table obtained, nor one in the special
table.
.Bl -column Namexx /usr/bin/login Default
.It Sy Name Type Default Description
.It "ab bool false Auto-baud speed select mechanism for the Micom 600 portselector. Selection is done by looking at how the character `\er' is garbled at 300, 1200, 4800, and 9600 baud."
.It "al str NULL user to auto-login instead of prompting"
.It "ap bool false terminal uses any parity"
.It "bk str 0377 alternative end of line character (input break)"
@ -90,7 +103,7 @@ table.
.It "cl str" Ta Dv NULL Ta
.No "screen clear sequence"
.It "co bool false console - add"
.Ql \en
.Ql \er\en
after login prompt
.It "cs bool false clear screen based on terminal type in /etc/ttys"
.It "ds str" Ta So Li ^Y Sc Ta
@ -381,6 +394,7 @@ calls.
.Xr login 1 ,
.Xr gethostname 3 ,
.Xr uname 3 ,
.Xr telnetd 8 ,
.Xr termcap 5 ,
.Xr ttys 5 ,
.Xr getty 8 ,

View File

@ -1,4 +1,4 @@
.\" $NetBSD: ttys.5,v 1.16 2003/08/07 09:46:42 agc Exp $
.\" $NetBSD: ttys.5,v 1.17 2006/10/06 22:07:44 elad Exp $
.\"
.\" Copyright (c) 1985, 1991, 1993
.\" The Regents of the University of California. All rights reserved.
@ -29,7 +29,7 @@
.\"
.\" from: @(#)ttys.5 8.1 (Berkeley) 6/4/93
.\"
.Dd June 4, 1993
.Dd October 7, 2006
.Dt TTYS 5
.Os
.Sh NAME
@ -105,31 +105,38 @@ is specified, allows users with a uid of 0
.Pq e.g. Qq root
to login on this line.
.It Sy local
Sets
.Dv CLOCAL
.Xr termios 4
Sets the
.Dv TIOCFLAG_CLOCAL
.Xr tty 4
flag for the device.
Tells device to ignore modem control signal lines.
.It Sy softcar
Causes the driver to ignore hardware carrier on the line.
.It Sy rtscts
Sets
.Dv CRTSCTS
This will cause the
.Xr termios 4
.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
.Dv TIOCFLAG_SOFTCAR
.Xr tty 4
flag).
.It Sy rtscts
Sets the
.Dv TIOCFLAG_CRTSCTS
.Xr tty 4
flag for the device to enable
.Tn RTS /
.Tn CTS
.Qq hardware
flow control.
flow control by default.
.It Sy mdmbuf
Sets
.Dv MDMBUF
.Xr termios 4
Sets the
.Dv TIOCFLAG_MDMBUF
.Xr tty 4
flag for the device to enable
.Tn DTR /
.Tn DCD
.Qq hardware
flow control.
flow control by default.
.El
.Pp
The flags
@ -179,7 +186,7 @@ to
does
.Em not
change the state of the various
.Xr termios 4
.Xr tty 4
device flags listed above; the
.Xr ttyflags 8
program must be run for changes in those flags to take effect on the devices.
@ -207,6 +214,7 @@ ttyp1 none network off
.Xr login 1 ,
.Xr getttyent 3 ,
.Xr ttyslot 3 ,
.Xr tty 4 ,
.Xr gettytab 5 ,
.Xr termcap 5 ,
.Xr getty 8 ,

View File

@ -1,4 +1,4 @@
.\" $NetBSD: ttyflags.8,v 1.11 2003/02/14 16:21:49 grant Exp $
.\" $NetBSD: ttyflags.8,v 1.12 2006/10/06 22:07:44 elad Exp $
.\"
.\" Copyright (c) 1994 Christopher G. Demetriou
.\" All rights reserved.
@ -32,7 +32,7 @@
.\"
.\" <<Id: LICENSE,v 1.2 2000/06/14 15:57:33 cgd Exp>>
.\"
.Dd March 30, 1994
.Dd October 7, 2006
.Dt TTYFLAGS 8
.Os
.Sh NAME
@ -44,8 +44,9 @@
.Op Fl a | Ar tty ...
.Sh DESCRIPTION
.Nm
sets the device-specific flags for terminals, based on the flags
found on the terminal's line in
sets the device-specific flags for terminals using
.Dv TIOCSFLAGS ,
based on the flags found on the terminal's line in
.Pa /etc/ttys .
.Pp
The options are as follows:
@ -73,6 +74,7 @@ the ttys, as found in
.El
.Sh SEE ALSO
.Xr getttyent 3 ,
.Xr tty 4 ,
.Xr ttys 5
.Sh HISTORY
The

View File

@ -1,4 +1,4 @@
.\" $NetBSD: pty.4,v 1.10 2003/08/07 10:31:03 agc Exp $
.\" $NetBSD: pty.4,v 1.11 2006/10/06 22:07:44 elad Exp $
.\"
.\" Copyright (c) 1983, 1991, 1993
.\" The Regents of the University of California. All rights reserved.
@ -29,7 +29,7 @@
.\"
.\" @(#)pty.4 8.2 (Berkeley) 11/30/93
.\"
.Dd November 30, 1993
.Dd October 7, 2006
.Dt PTY 4
.Os
.Sh NAME
@ -222,6 +222,13 @@ slave pseudo terminals
.El
.Sh DIAGNOSTICS
None.
.Sh SEE ALSO
.Xr ioctl 2 ,
.Xr openpty 3 ,
.Xr read 2 ,
.Xr select 2 ,
.Xr tty 4 ,
.Xr write 2
.Sh HISTORY
The
.Nm

View File

@ -1,4 +1,4 @@
.\" $NetBSD: termios.4,v 1.29 2004/09/18 11:41:08 wiz Exp $
.\" $NetBSD: termios.4,v 1.30 2006/10/06 22:07:44 elad Exp $
.\"
.\" Copyright (c) 1991, 1992, 1993
.\" The Regents of the University of California. All rights reserved.
@ -29,7 +29,7 @@
.\"
.\" @(#)termios.4 8.4 (Berkeley) 4/19/94
.\"
.Dd February 13, 1998
.Dd October 7, 2006
.Dt TERMIOS 4
.Os
.Sh NAME
@ -1155,8 +1155,9 @@ specified are supported by all hardware.
.Dv CTS
flow control of output */
.It Dv CRTSCTS
/* same as
.Dv CCTS_OFLOW
/* logically the same as
.Dv CCTS_OFLOW \&|
.Dv CCTS_IFLOW
*/
.It Dv CRTS_IFLOW
/* RTS flow control of input */
@ -1228,16 +1229,45 @@ has been set, the
.Xr open 2
function returns immediately without waiting for the connection.
.Pp
If the
.Xr tty 4
.Dv TIOCFLAG_CLOCAL
flag has been set on the port then the
.Dv CLOCAL
flag will automatically be set on every open.
.Pp
The
.Dv CCTS_OFLOW
.Pf ( Dv CRTSCTS )
flag is currently unused.
and
.Dv CRTS_IFLOW
flags are currently unused. Only
.Dv CRTSCTS ,
which has the combined effect, is implemented.
Note that
.Dv CRTSCTS
support is hardware and driver dependent.
Check the specific port driver manual page to see if hardware flow control
is supported on the port you are using.
.Pp
If the
.Xr tty 4
.Dv TIOCFLAG_CRTSCTS
flag has been set on the port then the
.Dv CRTSCTS
flag will automatically be set on every open.
.Pp
If
.Dv MDMBUF
is set then output flow control is controlled by the state
of Carrier Detect.
.Pp
If the
.Xr tty 4
.Dv TIOCFLAG_MDMBUF
flag has been set on the port then the
.Dv MDMBUF
flag will automatically be set on every open.
.Pp
If the object for which the control modes are set is not an asynchronous
serial connection, some of the modes may be ignored; for example, if an
attempt is made to set the baud rate on a network connection to a

View File

@ -1,4 +1,4 @@
.\" $NetBSD: tty.4,v 1.22 2003/08/07 10:31:04 agc Exp $
.\" $NetBSD: tty.4,v 1.23 2006/10/06 22:07:44 elad Exp $
.\"
.\" Copyright (c) 1991, 1992, 1993
.\" The Regents of the University of California. All rights reserved.
@ -29,7 +29,7 @@
.\"
.\" @(#)tty.4 8.3 (Berkeley) 4/19/94
.\"
.Dd August 14, 1992
.Dd October 7, 2006
.Dt TTY 4
.Os
.Sh NAME
@ -334,8 +334,8 @@ to a particular window.
.It Dv TIOCMSET Fa int *state
The integer pointed to by
.Fa state
contains bits that correspond to modem state. Following is a list
of defined variables and the modem state they represent:
contains bits that correspond to modem state.
Following is a list of defined variables and the modem state they represent:
.Pp
.Bl -tag -width TIOCMXCTS -compact
.It TIOCM_LE
@ -384,18 +384,28 @@ is cleared in the terminal.
.It Dv TIOCSFLAGS Fa int *state
The bits in the integer pointed to by
.Fa state
contain bits that correspond to serial port state. Following is a list
of defined variables and the serial port state they represent:
contain bits that correspond to serial port state.
Following is a list of defined flag values and the serial port state they
represent:
.Pp
.Bl -tag -width TIOCFLAG_SOFTCAR -compact
.It TIOCFLAG_SOFTCAR
Ignore hardware carrier.
.It TIOCFLAG_CLOCAL
Set clocal on open.
Set the
.Xr termios 4
.Dv CLOCAL
flag on open.
.It TIOCFLAG_CRTSCTS
Set crtscts on open.
Set the
.Xr termios 4
.Dv CRTSCTS
flag on open.
.It TIOCFLAG_MDMBUF
Set mdmbuf on open.
Set the
.Xr termios 4
.Dv MDMBUF
flag on open.
.El
.Pp
This call sets the serial port state to that represented by
@ -442,7 +452,9 @@ Return the current line discipline in the integer pointed to by
.Xr tcsetattr 3 ,
.Xr pty 4 ,
.Xr termios 4 ,
.Xr ttys 5 ,
.Xr getty 8 ,
.Xr ttyaction 8 ,
.Xr linedisc 9
.Sh HISTORY
Separate dial-out device files were implemented in SunOS 4. They were cloned