summaryrefslogtreecommitdiffstats
path: root/share/man/man4
diff options
context:
space:
mode:
authormpp <mpp@FreeBSD.org>1996-04-08 04:18:31 +0000
committermpp <mpp@FreeBSD.org>1996-04-08 04:18:31 +0000
commit3c57dc77537bfff8a25b061e147f5a1194613a28 (patch)
tree78fa3bb3a263f5518e1eaa6bea101b7b19200ce5 /share/man/man4
parentcdc4afc0a8a13743387100d7e5e163b1dcd87323 (diff)
downloadFreeBSD-src-3c57dc77537bfff8a25b061e147f5a1194613a28.zip
FreeBSD-src-3c57dc77537bfff8a25b061e147f5a1194613a28.tar.gz
Correct some man page xrefs, and some other minor changes to bring some
man pages up to mdoc guidelines and fix some minor formatting glitches. Also fixed a number of man pages to not abuse the .Xr macro to display functions and path names and a lot of other junk.
Diffstat (limited to 'share/man/man4')
-rw-r--r--share/man/man4/icmp.44
-rw-r--r--share/man/man4/ip.49
-rw-r--r--share/man/man4/netintro.410
-rw-r--r--share/man/man4/pty.416
-rw-r--r--share/man/man4/su.42
-rw-r--r--share/man/man4/tcp.48
-rw-r--r--share/man/man4/termios.450
-rw-r--r--share/man/man4/udp.44
-rw-r--r--share/man/man4/uk.42
-rw-r--r--share/man/man4/worm.44
-rw-r--r--share/man/man4/yp.434
11 files changed, 84 insertions, 59 deletions
diff --git a/share/man/man4/icmp.4 b/share/man/man4/icmp.4
index d87772f..01cda3b 100644
--- a/share/man/man4/icmp.4
+++ b/share/man/man4/icmp.4
@@ -62,9 +62,9 @@ is obtained from
.Tn ICMP
sockets are connectionless,
and are normally used with the
-.Xr sendto
+.Xr sendto 2
and
-.Xr recvfrom
+.Xr recvfrom 2
calls, though the
.Xr connect 2
call may also be used to fix the destination for future
diff --git a/share/man/man4/ip.4 b/share/man/man4/ip.4
index acefe0e..6c41c18 100644
--- a/share/man/man4/ip.4
+++ b/share/man/man4/ip.4
@@ -63,7 +63,8 @@ special-purpose applications.
.Pp
There are several
.Tn IP-level
-.Xr setsockopt 2 / Ns
+.Xr setsockopt 2
+and
.Xr getsockopt 2
options.
.Dv IP_OPTIONS
@@ -115,7 +116,7 @@ option is enabled on a
.Dv SOCK_DGRAM
socket,
the
-.Xr recvmsg
+.Xr recvmsg 2
call will return the destination
.Tn IP
address for a
@@ -296,9 +297,9 @@ Raw
.Tn IP
sockets are connectionless,
and are normally used with the
-.Xr sendto
+.Xr sendto 2
and
-.Xr recvfrom
+.Xr recvfrom 2
calls, though the
.Xr connect 2
call may also be used to fix the destination for future
diff --git a/share/man/man4/netintro.4 b/share/man/man4/netintro.4
index 7a09016..79a0179 100644
--- a/share/man/man4/netintro.4
+++ b/share/man/man4/netintro.4
@@ -174,10 +174,10 @@ certain interfaces such as the loopback interface,
do not.
.Pp
The following
-.Xr ioctl
+.Xr ioctl 2
calls may be used to manipulate network interfaces.
The
-.Xr ioctl
+.Fn ioctl
is made on a socket (typically of type
.Dv SOCK_DGRAM )
in the desired domain.
@@ -218,7 +218,7 @@ Set point to point address for protocol family and interface.
Set broadcast address for protocol family and interface.
.El
.Pp
-.Xr Ioctl
+.Fn Ioctl
requests to obtain addresses and requests both to set and
retrieve other data are still fully supported
and use the
@@ -263,9 +263,9 @@ to each family (replacing each sockaddr by one
of the family-specific type).
Where the sockaddr itself is larger than the
default size, one needs to modify the
-.Xr ioctl
+.Fn ioctl
identifier itself to include the total size, as described in
-.Xr ioctl .
+.Fn ioctl .
.It Dv SIOCDIFADDR
This requests deletes the specified address from the list
associated with an interface. It also uses the
diff --git a/share/man/man4/pty.4 b/share/man/man4/pty.4
index dd982c3..b8b6b87 100644
--- a/share/man/man4/pty.4
+++ b/share/man/man4/pty.4
@@ -42,7 +42,7 @@
.Op Ar count
.Sh DESCRIPTION
The
-.Xr pty
+.Nm pty
driver provides support for a device-pair termed a
.Em pseudo terminal .
A pseudo terminal is a pair of character devices, a
@@ -92,7 +92,7 @@ mode. Packet mode is enabled by specifying (by reference)
a nonzero parameter and disabled by specifying (by reference)
a zero parameter. When applied to the master side of a pseudo
terminal, each subsequent
-.Xr read
+.Xr read 2
from the terminal will return data written on the slave part of
the pseudo terminal preceded by a zero byte (symbolically
defined as
@@ -140,7 +140,7 @@ used by other similar programs.
.El
.It Dv TIOCUCNTL
Enable/disable a mode that allows a small number of simple user
-.Xr ioctl
+.Xr ioctl 2
commands to be passed through the pseudo-terminal,
using a protocol similar to that of
.Dv TIOCPKT .
@@ -154,12 +154,12 @@ by specifying (by reference)
a nonzero parameter and disabled by specifying (by reference)
a zero parameter.
Each subsequent
-.Xr read
+.Xr read 2
from the master side will return data written on the slave part of
the pseudo terminal preceded by a zero byte,
or a single byte reflecting a user control operation on the slave side.
A user control command consists of a special
-.Xr ioctl
+.Xr ioctl 2
operation with no data; the command is given as
.Dv UIOCCMD Ns (n) ,
where
@@ -168,17 +168,17 @@ is a number in the range 1-255.
The operation value
.Ar n
will be received as a single byte on the next
-.Xr read
+.Xr read 2
from the master side.
The
-.Xr ioctl
+.Xr ioctl 2
.Dv UIOCCMD Ns (0)
is a no-op that may be used to probe for
the existence of this facility.
As with
.Dv TIOCPKT
mode, command operations may be detected with a
-.Xr select
+.Xr select 2
for exceptional conditions.
.It Dv TIOCREMOTE
A mode for the master half of a pseudo terminal, independent
diff --git a/share/man/man4/su.4 b/share/man/man4/su.4
index b89842f..dc84603 100644
--- a/share/man/man4/su.4
+++ b/share/man/man4/su.4
@@ -8,7 +8,7 @@
.Nm device-driver su
.Sh DESCRIPTION
The
-.Xr su
+.Nm su
driver provides support for a
process to address arbitrary locations on the scsi bus. Minor
numbers are mapped 1:1 to bus:target:lun. The lowest three bits being LUN
diff --git a/share/man/man4/tcp.4 b/share/man/man4/tcp.4
index 5aecf1d..522e037 100644
--- a/share/man/man4/tcp.4
+++ b/share/man/man4/tcp.4
@@ -30,7 +30,7 @@
.\" SUCH DAMAGE.
.\"
.\" From: @(#)tcp.4 8.1 (Berkeley) 6/5/93
-.\" $Id: tcp.4,v 1.3 1995/02/15 03:30:54 wollman Exp $
+.\" $Id: tcp.4,v 1.4 1995/02/15 22:07:27 wollman Exp $
.\"
.Dd February 14, 1995
.Dt TCP 4
@@ -150,9 +150,9 @@ will set the
.Dq push
bit and begin transmission immediately (if permitted) at the end of
every user call to
-.Xr write
+.Xr write 2
or
-.Xr writev .
+.Xr writev 2 .
The
.Dv TCP_NOPUSH
option is provided to allow servers to easily make use of Transaction
@@ -165,7 +165,7 @@ or the internal send buffer is filled.
.El
.Pp
The option level for the
-.Xr setsockopt
+.Xr setsockopt 2
call is the protocol number for
.Tn TCP ,
available from
diff --git a/share/man/man4/termios.4 b/share/man/man4/termios.4
index 1722286..519c82e 100644
--- a/share/man/man4/termios.4
+++ b/share/man/man4/termios.4
@@ -85,6 +85,7 @@ is created when a user logs in, and the login terminal is setup
to be the controlling terminal; all processes spawned from that
login shell are in the same session, and inherit the controlling
terminal.
+.Pp
A job control shell
operating interactively (that is, reading commands from a terminal)
normally groups related processes together by placing them into the
@@ -199,7 +200,7 @@ the writing process is orphaned, and the writing process is not ignoring
or blocking
.Dv SIGTTOU ,
the
-.Xr write
+.Xr write 2
returns -1 with
errno set to
.Er Dv EIO
@@ -252,9 +253,9 @@ canonical or noncanonical mode.
Another dependency is whether the
.Dv O_NONBLOCK
flag is set by
-.Xr open()
+.Xr open 2
or
-.Xr fcntl() .
+.Xr fcntl 2 .
If the
.Dv O_NONBLOCK
flag is clear, then the read request is
@@ -355,7 +356,7 @@ process the bytes received.
.Dv MIN
represents the minimum number of bytes that should be received when
the
-.Xr read
+.Xr read 2
function successfully returns.
.Dv TIME
is a timer of 0.1 second
@@ -402,8 +403,11 @@ and
.Dv TIME
mechanisms are
activated by the receipt of the first byte, or a signal is received. If
-data is in the buffer at the time of the read(), the result is as
-if data had been received immediately after the read().
+data is in the buffer at the time of the
+.Fn read ,
+the result is as
+if data had been received immediately after the
+.Fn read .
.Ss "Case B: MIN > 0, TIME = 0"
In this case, since the value of
.Dv TIME
@@ -451,7 +455,8 @@ field (see the
.Sx "Output Modes
section). The
implementation may provide a buffering mechanism; as such, when a call to
-write() completes, all of the bytes written have been scheduled for
+.Fn write
+completes, all of the bytes written have been scheduled for
transmission to the device, but the transmission will not necessarily
have been completed.
.\" See also .Sx "6.4.2" for the effects of
@@ -532,7 +537,8 @@ is discarded. Thus, if there are no bytes waiting (that
is, the
.Dv EOF
occurred at the beginning of a line), a byte
-count of zero is returned from the read(),
+count of zero is returned from the
+.Fn read ,
representing an end-of-file indication. If
.Dv ICANON
is
@@ -653,7 +659,9 @@ character, except that
the
.Dv SIGTSTP
signal is delivered when one of the processes
-in the foreground process group issues a read() to the
+in the foreground process group issues a
+.Fn read
+to the
controlling terminal.
.It Dv LNEXT
Special character on input and is recognized if the
@@ -712,7 +720,9 @@ the terminal, the
signal is sent to the controlling
process associated with the terminal. Unless other arrangements have
been made, this causes the controlling process to terminate.
-Any subsequent call to the read() function returns the value zero,
+Any subsequent call to the
+.Fn read
+function returns the value zero,
indicating end of file. Thus, processes that read a terminal
file and test for end-of-file can terminate appropriately after a
disconnect.
@@ -726,7 +736,9 @@ disconnect.
.\" .Pf [ Dv EIO
.\" ] is returned.
Any
-subsequent write() to the terminal device returns -1, with
+subsequent
+.Fn write
+to the terminal device returns -1, with
.Va errno
set to
.Er EIO ,
@@ -958,7 +970,9 @@ is set and the input queue is full, subsequent input shall cause an
character to be transmitted to the
the output queue.
.Pp
-The initial input control value after open() is implementation defined.
+The initial input control value after
+.Fn open
+is implementation defined.
.Ss Output Modes
Values of the
.Fa c_oflag
@@ -1098,13 +1112,17 @@ status lines. If
is clear, the modem status lines are
monitored.
.Pp
-Under normal circumstances, a call to the open() function waits for
+Under normal circumstances, a call to the
+.Fn open
+function waits for
the modem connection to complete. However, if the
.Dv O_NONBLOCK
flag is set
or if
.Dv CLOCAL
-has been set, the open() function returns
+has been set, the
+.Fn open
+function returns
immediately without waiting for the connection.
.Pp
The
@@ -1406,6 +1424,8 @@ entries of the
array.
.Pp
The initial values of the flags and control characters
-after open() is set according to
+after
+.Fn open
+is set according to
the values in the header
.Aq Pa sys/ttydefaults.h .
diff --git a/share/man/man4/udp.4 b/share/man/man4/udp.4
index 939866b..900aa70 100644
--- a/share/man/man4/udp.4
+++ b/share/man/man4/udp.4
@@ -52,9 +52,9 @@ protocol family.
.Tn UDP
sockets are connectionless, and are
normally used with the
-.Xr sendto
+.Xr sendto 2
and
-.Xr recvfrom
+.Xr recvfrom 2
calls, though the
.Xr connect 2
call may also be used to fix the destination for future
diff --git a/share/man/man4/uk.4 b/share/man/man4/uk.4
index e69c527..24e87cc 100644
--- a/share/man/man4/uk.4
+++ b/share/man/man4/uk.4
@@ -8,7 +8,7 @@
.Nm device uk
.Sh DESCRIPTION
The
-.Xr uk
+.Nm uk
driver provides support for a
process to address devices on the scsi bus for which there is no configured
driver.
diff --git a/share/man/man4/worm.4 b/share/man/man4/worm.4
index c3a18da..e10075a 100644
--- a/share/man/man4/worm.4
+++ b/share/man/man4/worm.4
@@ -32,7 +32,7 @@
.\" USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
.\" DAMAGE.
.\"
-.\" $Id: worm.4,v 1.2 1996/01/27 17:55:54 joerg Exp $
+.\" $Id: worm.4,v 1.3 1996/01/30 13:51:19 mpp Exp $
.\"
.Dd January 27, 1996
.Dt WORM 4
@@ -45,7 +45,7 @@
.Cd disk worm0 target 5 lun 0
.Sh DESCRIPTION
The
-.Xr worm
+.Nm worm
driver provides support for a
.Em SCSI
write-once device, in particular for a CD-R recording device. The
diff --git a/share/man/man4/yp.4 b/share/man/man4/yp.4
index 576338d..ac78f40 100644
--- a/share/man/man4/yp.4
+++ b/share/man/man4/yp.4
@@ -26,7 +26,7 @@
.\" SUCH DAMAGE.
.\"
.\" from: @(#)yp.8 1.0 (deraadt) 4/26/93
-.\" $Id: yp.4,v 1.4 1995/09/02 04:20:01 wpaul Exp $
+.\" $Id: yp.4,v 1.5 1996/01/30 13:51:21 mpp Exp $
.\"
.Dd April 5, 1993
.Dt YP 4
@@ -51,7 +51,7 @@ entries through the functions
and
.Xr ethers 3 .
The
-.Nm bootparamd
+.Xr bootparamd 8
daemon makes direct NIS library calls since there are no
functions in the standard C library for reading bootparams. NIS
support for the hosts, services and rpc databases is enabled by
@@ -69,7 +69,7 @@ subsystem is started automatically in
if it has been initialized in
.Pa /etc/sysconfig
and if the directory
-.Nm /var/yp
+.Pa /var/yp
exists (which it does in the default distribution). The default
NIS domain must also be set with the
.Xr domainname 1
@@ -140,7 +140,7 @@ updated by the master.
.El
.Pp
An NIS client establishes what is called a
-.Nm binding
+.Em binding
to a particular NIS server using the
.Xr ypbind 8
daemon.
@@ -180,38 +180,41 @@ is designed to handle, most of which are implemented as functions
within the standard C library:
.Bl -bullet -offset indent
.It
-.Nm yp_order()
+.Fn yp_order
-- check the creation date of a particular map
.It
-.Nm yp_master()
+.Fn yp_master
-- obtain the name of the NIS master server for a given
map/domain
.It
-.Nm yp_match()
+.Fn yp_match
-- lookup the data corresponding to a given in key in a particular
map/domain
.It
-.Nm yp_first()
+.Fn yp_first
-- obtain the first key/data pair in a particular map/domain
.It
-.Nm yp_next()
+.Fn yp_next
-- pass
.Xr ypserv 8
a key in a particular map/domain and have it return the
-key/data pair immediately following it (yp_first() and yp_next()
+key/data pair immediately following it (the functions
+.Fn yp_first
+and
+.Fn yp_next
can be used to do a sequential search of an NIS map)
.It
-.Nm yp_all()
+.Fn yp_all
-- retrieve the entire contents of a map
.El
.Pp
There are a few other requests which
-.Xr ypserv
+.Xr ypserv 8
is capable of handling (i.e. acknowledge whether or not you can handle
a particular domain (YPPROC_DOMAIN), or acknowledge only if you can
handle the domain and be silent otherwise (YPPROC_DOMAIN_NONACK)) but
these requests are usually generated only by
-.Xr ypbind
+.Xr ypbind 8
and are not meant to be used by standard utilities.
.Pp
On networks with a large number of hosts, it is often a good idea to
@@ -268,7 +271,7 @@ is specially designed to provided enhanced security (compared to
other NIS implementations) when used exclusively with FreeBSD client
systems. The FreeBSD password database system (which is derived directly
form 4.4BSD) includes support for
-.Nm shadow passwords .
+.Em "shadow passwords" .
The standard password database does not contain users' encrypted
passwords: these are instead stored (along with other information)
is a separate database which is accessible only by the super-user.
@@ -355,7 +358,8 @@ and
functions do not yet have NIS support. Fortunately, these files
don't need to be updated that often.
.Pp
-Many more manual pages should be written, especially ypclnt(3).
+Many more manual pages should be written, especially
+.Xr ypclnt 3 .
For the time being, seek out a local Sun machine and read the
manuals for there.
.Pp
OpenPOWER on IntegriCloud