Thu Apr 28 12:15:35 2011 UTC ()

New sentence, new line.


(wiz)

diff -r1.26 -r1.27 src/share/man/man4/tty.4

--- src/share/man/man4/tty.4 2010/03/22 18:58:31	1.26
+++ src/share/man/man4/tty.4 2011/04/28 12:15:35	1.27

 @@ -1,14 +1,14 @@
-.\"	$NetBSD: tty.4,v 1.26 2010/03/22 18:58:31 joerg Exp $
+.\"	$NetBSD: tty.4,v 1.27 2011/04/28 12:15:35 wiz Exp $
 .\"
 .\" Copyright (c) 1991, 1992, 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. Neither the name of the University nor the names of its contributors
 @@ -50,128 +50,132 @@ and
 .Pa /dev/dty03 ) .
 .Pp
 The
 .Pa /dev/ttyXX
 special file is used for dial-in modems and terminals.
 When a user logs into
 the system on one of these hardware terminal ports, the system has already
 opened the associated device and prepared the line for normal interactive
 use (see
 .Xr getty 8 ) .
 .Pp
 The
 .Pa /dev/dtyXX
-special file is a SunOS-compatible dial-out device.  Unlike
+special file is a SunOS-compatible dial-out device.
-the dial-in device, opening the dial-out device never blocks.  If the
+Unlike the dial-in device, opening the dial-out device never blocks.
-corresponding dial-in device is already opened (not blocked in the open waiting
+If the corresponding dial-in device is already opened (not blocked
-for carrier), then the dial-out open will fail immediately; otherwise it will
+in the open waiting for carrier), then the dial-out open will fail
-succeed immediately.  While the dial-out device is open, the dial-in device may
+immediately; otherwise it will succeed immediately.
-not be opened.  If the dial-in open is blocking, it will wait until the dial-out
+While the dial-out device is open, the dial-in device may not be opened.
 If the dial-in open is blocking, it will wait until the dial-out
 device is closed (and carrier is detected); otherwise it will fail immediately.
 .Pp
 There is also a special case of a terminal file that connects not to
 a hardware terminal port, but to another program on the other side.
 These special terminal devices are called
 .Em ptys
 (pseudo terminals)
 and provide the mechanism necessary to give users the same interface to the
 system when logging in over a network (using
 .Xr rlogin 1 ,
 or
 .Xr telnet 1
 for example.)  Even in these cases the details of how the terminal
 file was opened and set up is already handled by special software
 in the system.
 Thus, users do not normally need to worry about the details of
-how these lines are opened or used.  Also, these lines are often used
+how these lines are opened or used.
-for dialing out of a system (through an out-calling modem), but again
+Also, these lines are often used for dialing out of a system (through
-the system provides programs that hide the details of accessing
+an out-calling modem), but again the system provides programs that
-these terminal special files (see
+hide the details of accessing these terminal special files (see
 .Xr tip 1 ) .
 .Pp
 When an interactive user logs in, the system prepares the line to
 behave in a certain way (called a
 .Em line discipline ) ,
 the particular details of which is described in
 .Xr stty 1
 at the command level, and in
 .Xr termios 4
-at the programming level.  A user may be concerned with changing
+at the programming level.
-settings associated with his particular login terminal and should refer
+A user may be concerned with changing settings associated with his
-to the preceding man pages for the common cases.  The remainder of
+particular login terminal and should refer to the preceding man
-this man page is concerned
+pages for the common cases.
 The remainder of this man page is concerned
 with describing details of using and controlling terminal devices
 at a low level, such as that possibly required by a program wishing
 to provide features similar to those provided by the system.
 .Ss Line disciplines
 A terminal file is used like any other file in the system in that
-it can be opened, read, and written to using standard system
+it can be opened, read, and written to using standard system calls.
-calls.  For each existing terminal file, there is a software processing module
+For each existing terminal file, there is a software processing module
 called a
 .Em line discipline
-associated with it.  The
+associated with it.
 The
 .Em line discipline
 essentially glues the low level device driver code with the high
 level generic interface routines (such as
 .Xr read 2
 and
 .Xr write 2 ) ,
 and is responsible for implementing the semantics associated
-with the device.  When a terminal file is first opened by a program,
+with the device.
-the default
+When a terminal file is first opened by a program, the default
 .Em line discipline
 called the
 .Dv termios
-line discipline is associated with the file.  This is the primary
+line discipline is associated with the file.
-line discipline that is used in most cases and provides the semantics
+This is the primary line discipline that is used in most cases and
-that users normally associate with a terminal.  When the
+provides the semantics that users normally associate with a terminal.
 When the
 .Dv termios
 line discipline is in effect, the terminal file behaves and is
 operated according to the rules described in
 .Xr termios 4 .
 Please refer to that man page for a full description of the terminal
 semantics.
 The operations described here
 generally represent features common
 across all
 .Em line disciplines ,
 however some of these calls may not
 make sense in conjunction with a line discipline other than
 .Dv termios ,
 and some may not be supported by the underlying
 hardware (or lack thereof, as in the case of ptys).
 .Ss Terminal File Operations
 All of the following operations are invoked using the
 .Xr ioctl 2
-system call.  Refer to that man page for a description of
+system call.
-the
+Refer to that man page for a description of the
 .Em request
 and
 .Em argp
 parameters.
 In addition to the ioctl
 .Em requests
 defined here, the specific line discipline
 in effect will define other
 .Em requests
 specific to it (actually
 .Xr termios 4
 defines them as function calls, not ioctl
 .Em requests . )
-The following section lists the available ioctl requests.  The
+The following section lists the available ioctl requests.
-name of the request, a description of its purpose, and the typed
+The name of the request, a description of its purpose, and the typed
 .Em argp
-parameter (if any)
+parameter (if any) are listed.
-are listed.  For example, the first entry says
+For example, the first entry says
 .Pp
 .D1 Em TIOCSLINED char name[32]
 .Pp
 and would be called on the terminal associated with
 file descriptor zero by the following code fragment:
 .Bd -literal
 	ioctl(0, TIOCSLINED, "termios");
 .Ed
 .Ss Terminal File Request Descriptions
 .Bl -tag -width TIOCGWINSZ
 .It Dv TIOCSLINED Fa char name[32]
 Change to the new line discipline called
 .Fa name .
 @@ -225,122 +229,128 @@ option.
 .It Dv TIOCSETAF Fa struct termios *term
 First wait for any output to complete, clear any pending input,
 then set the termios state associated with the device.
 This is the underlying call that implements the
 .Xr tcsetattr 3
 call with the
 .Dv TCSAFLUSH
 option.
 .It Dv TIOCOUTQ Fa int *num
 Place the current number of characters in the output queue in the
 integer pointed to by
 .Fa num .
 .It Dv TIOCSTI Fa char *cp
-Simulate typed input.  Pretend as if the terminal received the
+Simulate typed input.
-character pointed to by
+Pretend as if the terminal received the character pointed to by
 .Fa cp .
 .It Dv TIOCNOTTY Fa void
-This call is obsolete but left for compatibility.  In the past, when
+This call is obsolete but left for compatibility.
-a process that didn't have a controlling terminal (see
+In the past, when a process that didn't have a controlling terminal
 (see
 .Em The Controlling Terminal
 in
 .Xr termios 4 )
 first opened a terminal device, it acquired that terminal as its
-controlling terminal.  For some programs this was a hazard as they
+controlling terminal.
-didn't want a controlling terminal in the first place, and this
+For some programs this was a hazard as they didn't want a controlling
-provided a mechanism to disassociate the controlling terminal from
+terminal in the first place, and this provided a mechanism to
-the calling process.  It
+disassociate the controlling terminal from the calling process.
 It
 .Em must
 be called by opening the file
 .Pa /dev/tty
 and calling
 .Dv TIOCNOTTY
 on that file descriptor.
 .Pp
 The current system does not allocate a controlling terminal to
 a process on an
 .Fn open
 call: there is a specific ioctl called
 .Dv TIOCSCTTY
 to make a terminal the controlling
 terminal.
 In addition, a program can
 .Fn fork
 and call the
 .Fn setsid
 system call which will place the process into its own session - which
-has the effect of disassociating it from the controlling terminal.  This
+has the effect of disassociating it from the controlling terminal.
-is the new and preferred method for programs to lose their controlling
+This is the new and preferred method for programs to lose their
-terminal.
+controlling terminal.
 .It Dv TIOCSTOP Fa void
 Stop output on the terminal (like typing ^S at the keyboard).
 .It Dv TIOCSTART Fa void
 Start output on the terminal (like typing ^Q at the keyboard).
 .It Dv TIOCSCTTY Fa void
 Make the terminal the controlling terminal for the process (the process
 must not currently have a controlling terminal).
 .It Dv TIOCDRAIN Fa void
 Wait until all output is drained.
 .It Dv TIOCEXCL Fa void
-Set exclusive use on the terminal.  No further opens are permitted
+Set exclusive use on the terminal.
-except by root.  Of course, this means that programs that are run by
+No further opens are permitted except by root.
-root (or setuid) will not obey the exclusive setting - which limits
+Of course, this means that programs that are run by root (or setuid)
-the usefulness of this feature.
+will not obey the exclusive setting - which limits the usefulness
 of this feature.
 .It Dv TIOCNXCL Fa void
-Clear exclusive use of the terminal.  Further opens are permitted.
+Clear exclusive use of the terminal.
 Further opens are permitted.
 .It Dv TIOCFLUSH Fa int *what
 If the value of the int pointed to by
 .Fa what
 contains the
 .Dv FREAD
 bit as defined in
 .In sys/fcntl.h ,
-then all characters in the input queue are cleared.  If it contains
+then all characters in the input queue are cleared.
-the
+If it contains the
 .Dv FWRITE
-bit, then all characters in the output queue are cleared.  If the
+bit, then all characters in the output queue are cleared.
-value of the integer is zero, then it behaves as if both the
+If the value of the integer is zero, then it behaves as if both the
 .Dv FREAD
 and
 .Dv FWRITE
 bits were set (i.e. clears both queues).
 .It Dv TIOCGWINSZ Fa struct winsize *ws
 Put the window size information associated with the terminal in the
 .Va winsize
 structure pointed to by
 .Fa ws .
 The window size structure contains the number of rows and columns (and pixels
-if appropriate) of the devices attached to the terminal.  It is set by user software
+if appropriate) of the devices attached to the terminal.
-and is the means by which most full\&-screen oriented programs determine the
+It is set by user software and is the means by which most full\&-screen
-screen size.  The
+oriented programs determine the screen size.
 The
 .Va winsize
 structure is defined in
 .In sys/ioctl.h .
 .It Dv TIOCSWINSZ Fa struct winsize *ws
 Set the window size associated with the terminal to be the value in
 the
 .Va winsize
 structure pointed to by
 .Fa ws
 (see above).
 .It Dv TIOCCONS Fa int *on
 If
 .Fa on
 points to a non-zero integer, redirect kernel console output (kernel printf's)
 to this terminal.
 If
 .Fa on
 points to a zero integer, redirect kernel console output back to the normal
-console.  This is usually used on workstations to redirect kernel messages
+console.
 This is usually used on workstations to redirect kernel messages
 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:
 .Pp
 .Bl -tag -width TIOCMXCTS -compact
 .It TIOCM_LE
 Line Enable.
 .It TIOCM_DTR
 Data Terminal Ready.
 .It TIOCM_RTS
 @@ -408,29 +418,29 @@ Set the
 .Dv MDMBUF
 flag on open.
 .El
 .Pp
 This call sets the serial port state to that represented by
 .Fa state .
 Not all serial ports may support this.
 .It Dv TIOCGFLAGS Fa int *state
 Return the current state of the serial port as represented
 above in the integer pointed to by
 .Fa state .
 .El
 .Sh COMPATIBILITY
-Two ioctls are maintained for backwards compatibility.  They provide
+Two ioctls are maintained for backwards compatibility.
-methods to get and set the current line discipline, but are not
+They provide methods to get and set the current line discipline,
-extensible.
+but are not extensible.
 .Bl -tag -width TIOCGWINSZ
 .It Dv TIOCSETD Fa int *ldisc
 Change to the new line discipline pointed to by
 .Fa ldisc .
 The old list of available line disciplines are listed in
 .In sys/ttycom.h
 and are:
 .Pp
 .Bl -tag -width TIOCGWINSZ -compact
 .It TTYDISC
 Termios interactive line discipline.
 .It TABLDISC
 Tablet line discipline.
 @@ -448,16 +458,18 @@ Return the current line discipline in th
 .El
 .Sh SEE ALSO
 .Xr stty 1 ,
 .Xr ioctl 2 ,
 .Xr tcgetattr 3 ,
 .Xr tcsetattr 3 ,
 .Xr ttyaction 3 ,
 .Xr pty 4 ,
 .Xr termios 4 ,
 .Xr ttys 5 ,
 .Xr getty 8 ,
 .Xr linedisc 9
 .Sh HISTORY
-Separate dial-out device files were implemented in SunOS 4.  They were cloned
+Separate dial-out device files were implemented in SunOS 4.
-by Charles M. Hannum for
+They were cloned by
 .An Charles M. Hannum
 for
 .Nx 1.4 .