diff options
author | Mike Pritchard <mpp@FreeBSD.org> | 1996-04-08 04:18:31 +0000 |
---|---|---|
committer | Mike Pritchard <mpp@FreeBSD.org> | 1996-04-08 04:18:31 +0000 |
commit | edf0e5b3f896da8bf8b1fd0b923401d0c0141aa4 (patch) | |
tree | 78fa3bb3a263f5518e1eaa6bea101b7b19200ce5 /share | |
parent | b5cfb15faded88a85755caf4ccdb4876fd99fe44 (diff) | |
download | src-edf0e5b3f896da8bf8b1fd0b923401d0c0141aa4.tar.gz src-edf0e5b3f896da8bf8b1fd0b923401d0c0141aa4.zip |
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.
Notes
Notes:
svn path=/head/; revision=15135
Diffstat (limited to 'share')
-rw-r--r-- | share/man/man3/sysexits.3 | 4 | ||||
-rw-r--r-- | share/man/man4/icmp.4 | 4 | ||||
-rw-r--r-- | share/man/man4/ip.4 | 9 | ||||
-rw-r--r-- | share/man/man4/netintro.4 | 10 | ||||
-rw-r--r-- | share/man/man4/pty.4 | 16 | ||||
-rw-r--r-- | share/man/man4/su.4 | 2 | ||||
-rw-r--r-- | share/man/man4/tcp.4 | 8 | ||||
-rw-r--r-- | share/man/man4/termios.4 | 50 | ||||
-rw-r--r-- | share/man/man4/udp.4 | 4 | ||||
-rw-r--r-- | share/man/man4/uk.4 | 2 | ||||
-rw-r--r-- | share/man/man4/worm.4 | 4 | ||||
-rw-r--r-- | share/man/man4/yp.4 | 34 | ||||
-rw-r--r-- | share/man/man5/fs.5 | 2 | ||||
-rw-r--r-- | share/man/man5/fstab.5 | 4 | ||||
-rw-r--r-- | share/man/man5/link.5 | 47 | ||||
-rw-r--r-- | share/man/man5/networks.5 | 2 | ||||
-rw-r--r-- | share/man/man5/printcap.5 | 10 | ||||
-rw-r--r-- | share/man/man5/remote.5 | 18 | ||||
-rw-r--r-- | share/man/man5/utmp.5 | 4 | ||||
-rw-r--r-- | share/man/man7/clocks.7 | 19 | ||||
-rw-r--r-- | share/man/man7/environ.7 | 16 | ||||
-rw-r--r-- | share/man/man7/hier.7 | 2 | ||||
-rw-r--r-- | share/man/man8/rc.8 | 2 | ||||
-rw-r--r-- | share/man/man8/yp.8 | 34 |
24 files changed, 180 insertions, 127 deletions
diff --git a/share/man/man3/sysexits.3 b/share/man/man3/sysexits.3 index da4169ebdb49..4c409e59c89d 100644 --- a/share/man/man3/sysexits.3 +++ b/share/man/man3/sysexits.3 @@ -23,7 +23,7 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.\" $Id$ +.\" $Id: sysexits.3,v 1.1 1996/03/31 22:33:54 joerg Exp $ .\" .\" " .Dd March 31, 1996 @@ -87,7 +87,7 @@ does not exist in the passwd file. .It Sy EX_OSFILE Pq 72 Some system file (e.g., .Pa /etc/passwd , -.Pa /etc/utmp , +.Pa /var/run/utmp , etc.) does not exist, cannot be opened, or has some sort of error (e.g., syntax error). .It Sy EX_CANTCREAT Pq 73 diff --git a/share/man/man4/icmp.4 b/share/man/man4/icmp.4 index d87772f9fec6..01cda3b8d91c 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 acefe0e5ab73..6c41c188a301 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 7a0901605b67..79a01792c7b7 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 dd982c348121..b8b6b877d714 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 b89842f35761..dc846031746c 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 5aecf1d45e49..522e037877a3 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 1722286cd963..519c82e47078 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 939866b710eb..900aa701dd2d 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 e69c527f5097..24e87ccdf440 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 c3a18da6b981..e10075a58b3f 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 576338daeb1f..ac78f40740fc 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 diff --git a/share/man/man5/fs.5 b/share/man/man5/fs.5 index 7b674dedd866..1c31f2ba0a25 100644 --- a/share/man/man5/fs.5 +++ b/share/man/man5/fs.5 @@ -292,7 +292,7 @@ These blocks are read in from in addition to the super-block. .Pp .Sy N.B.: -.Xr sizeof Pq Fa struct csum +.Fn sizeof "struct csum" must be a power of two in order for the .Fn fs_cs diff --git a/share/man/man5/fstab.5 b/share/man/man5/fstab.5 index 27a73dde1315..a1bf7c01c7be 100644 --- a/share/man/man5/fstab.5 +++ b/share/man/man5/fstab.5 @@ -166,7 +166,7 @@ is used for these filesystems by the .Xr dump 8 command to determine which filesystems need to be dumped. If the fifth field is not present, a value of zero is returned and -.Xr dump +.Nm dump will assume that the filesystem does not need to be dumped. .Pp The sixth field, @@ -185,7 +185,7 @@ but filesystems on different drives will be checked at the same time to utilize parallelism available in the hardware. If the sixth field is not present or zero, a value of zero is returned and -.Xr fsck +.Xr fsck 8 will assume that the filesystem does not need to be checked. .Bd -literal #define FSTAB_RW "rw" /* read-write device */ diff --git a/share/man/man5/link.5 b/share/man/man5/link.5 index 2d86997052bf..c7e02d1107f2 100644 --- a/share/man/man5/link.5 +++ b/share/man/man5/link.5 @@ -26,7 +26,7 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.\" $Id: link.5,v 1.3 1996/01/20 07:29:06 mpp Exp $ +.\" $Id: link.5,v 1.4 1996/01/30 13:51:35 mpp Exp $ .\" .Dd October 23, 1993 .Dt LINK 5 @@ -56,7 +56,7 @@ The collection of data structures described here will be referred to as the .Em Run-time Relocation Section (RRS) and is embedded in the standard text and data segments of the dynamically linked program or shared object image as the existing -.Xr a.out +.Xr a.out 5 format offers no room for it elsewhere. .Pp Several utilities cooperate to ensure that the task of getting a program @@ -118,7 +118,11 @@ struct _dynamic { .Bl -tag -width d_version .It Fa d_version This field provides for different versions of the dynamic linking -implementation. The current version numbers understood by ld and ld.so are +implementation. The current version numbers understood by +.Xr ld 1 +and +.Xr ld.so 1 +are .Em LD_VERSION_SUN (3), which is used by the SunOS 4.x releases, and .Em LD_VERSION_BSD (8), @@ -160,7 +164,7 @@ struct section_dispatch_table { .Bl -tag -width sdt_filler1 .It Fa sdt_loaded A pointer to the first link map loaded (see below). This field is set by -.Xr ld.so. +.Nm ld.so .It Fa sdt_sods The start of a (linked) list of shared object descriptors needed by .Em this @@ -231,7 +235,9 @@ The offset in the text segment of a string describing this link object. .It Fa sod_library If set, .Fa sod_name -specifies a library that is to be searched for by ld.so. The path name +specifies a library that is to be searched for by +.Nm ld.so . +The path name is obtained by searching a set of directories .Po see also @@ -316,7 +322,7 @@ struct nzlist { .It Fa nlist .Po see -.Xr nlist 5 +.Xr nlist 3 .Pc . .It Fa nz_size The size of the data represented by this symbol. @@ -372,7 +378,8 @@ The symbol description. .It Fa rt_next Virtual address of next rt_symbol. .It Fa rt_link -Next in hash bucket. Used by internally by ld.so. +Next in hash bucket. Used by internally by +.Nm ld.so . .It Fa rt_srcaddr Location of the source of initialized data within a shared object. .It Fa rt_smp @@ -429,9 +436,11 @@ may be interested in. .Pp The .Em ld_entry -structure defines a set of service routines within ld.so. See -.Xr libdl.a -for more information. +structure defines a set of service routines within +.Nm ld.so . +.\" See +.\" .Xr libdl.a +.\" for more information. .Bd -literal -offset indent struct ld_entry { void *(*dlopen)(char *, int); @@ -443,7 +452,8 @@ struct ld_entry { The .Fa crt_ldso -structure defines the interface between the start-up code in crt0 and ld.so. +structure defines the interface between the start-up code in crt0 and +.Nm ld.so . .Bd -literal -offset indent struct crt_ldso { int crt_ba; @@ -463,13 +473,16 @@ struct crt_ldso { .Ed .Bl -tag -width crt_dzfd .It Fa crt_ba -The virtual address at which ld.so was loaded by crt0. +The virtual address at which +.Nm ld.so +was loaded by crt0. .It Fa crt_dzfd On SunOS systems, this field contains an open file descriptor to -.Dq /dev/zero +.Dq Pa /dev/zero used to get demand paged zeroed pages. On FreeBSD systems it contains -1. .It Fa crt_ldfd -Contains an open file descriptor that was used by crt0 to load ld.so. +Contains an open file descriptor that was used by crt0 to load +.Nm ld.so . .It Fa crt_dp A pointer to main's .Fa _dynamic @@ -492,8 +505,10 @@ The and .Fa hints_bucket structures define the layout of the library hints, normally found in -.Dq /var/run/ld.so.hints, -which is used by ld.so to quickly locate the shared object images in the +.Dq Pa /var/run/ld.so.hints , +which is used by +.Nm ld.so +to quickly locate the shared object images in the filesystem. The organization of the hints file is not unlike that of an .Dq a.out diff --git a/share/man/man5/networks.5 b/share/man/man5/networks.5 index f8f4c4e438c1..0e5167107680 100644 --- a/share/man/man5/networks.5 +++ b/share/man/man5/networks.5 @@ -39,7 +39,7 @@ .Nd network name data base .Sh DESCRIPTION The -.Xr networks +.Nm networks file contains information regarding the known networks which comprise the .Tn DARPA diff --git a/share/man/man5/printcap.5 b/share/man/man5/printcap.5 index cd2cd11948ed..05fba6632ac4 100644 --- a/share/man/man5/printcap.5 +++ b/share/man/man5/printcap.5 @@ -52,7 +52,7 @@ file every time it is used, allowing dynamic addition and deletion of printers. Each entry in the data base is used to describe one printer. This data base may not be substituted for, as is possible for -.Xr termcap , +.Xr termcap 5 , because it may allow accounting to be bypassed. .Pp The default printer is normally @@ -167,7 +167,7 @@ flag is passed only if the .Fl l flag (pass control characters literally) is specified to -.Xr lpr . +.Xr lpr 1 . The .Ar Width function @@ -249,8 +249,8 @@ and must not ignore .Sh LOGGING Error messages generated by the line printer programs themselves (that is, the -.Xr lp Ns * -programs) +.Xr lpd 8 +and related programs) are logged by .Xr syslog 3 using the @@ -263,7 +263,7 @@ are sent to the corresponding .Cm lf file. The filters may, of course, use -.Xr syslog +.Xr syslog 8 themselves. .Pp Error messages sent to the console have a carriage return and a line diff --git a/share/man/man5/remote.5 b/share/man/man5/remote.5 index 27c83f69a71e..1a0a33e56ba5 100644 --- a/share/man/man5/remote.5 +++ b/share/man/man5/remote.5 @@ -46,7 +46,7 @@ file which is structured somewhat like the .Xr termcap 5 file. Each line in the file provides a description for a single -.Xr system . +.Em system . Fields are separated by a colon (``:''). Lines ending in a \e character with an immediately following newline are continued on the next line. @@ -59,17 +59,17 @@ name followed by a `#' sign indicates a following numeric value. .Pp Entries named ``tip*'' and ``cu*'' are used as default entries by -.Xr tip , +.Xr tip 1 , and the -.Xr cu +.Xr cu 1 interface to -.Xr tip , +.Nm tip , as follows. When -.Xr tip +.Nm tip is invoked with only a phone number, it looks for an entry of the form ``tip300'', where 300 is the baud rate with which the connection is to be made. When the -.Xr cu +.Nm cu interface is used, entries of the form ``cu300'' are used. .Sh CAPABILITIES Capabilities are either strings (str), numbers (num), or boolean @@ -122,7 +122,7 @@ The default is .Dv NULL . `~' escapes are only recognized by -.Xr tip +.Nm tip after one of the characters in `el', or after a carriage-return. .It Cm \&fs @@ -145,7 +145,7 @@ Output end-of-file string. The default is .Dv NULL . When -.Xr tip +.Nm tip is transferring a file, this string is sent at end-of-file. .It Cm \&pa @@ -160,7 +160,7 @@ is even parity. Telephone number(s) for this host. If the telephone number field contains an @ sign, -.Xr tip +.Nm tip searches the file .Pa /etc/phones file for a list of telephone numbers; diff --git a/share/man/man5/utmp.5 b/share/man/man5/utmp.5 index a3ac4b0f514a..b25b4da483a5 100644 --- a/share/man/man5/utmp.5 +++ b/share/man/man5/utmp.5 @@ -90,7 +90,7 @@ struct utmp { .Ed .Pp Each time a user logs in, the -.Xr login +.Xr login 1 program looks up the user's .Tn UID in the file @@ -102,7 +102,7 @@ are written to the standard output. (Providing the login is not see .Xr login 1 . ) The -.Xr login +.Nm login program then records the new login time in the file .Nm lastlog . .Pp diff --git a/share/man/man7/clocks.7 b/share/man/man7/clocks.7 index 7c3babf346c6..fa6abe578eec 100644 --- a/share/man/man7/clocks.7 +++ b/share/man/man7/clocks.7 @@ -25,7 +25,7 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.\" $Id: clocks.7,v 1.1 1996/04/05 08:51:22 joerg Exp $ +.\" $Id: clocks.7,v 1.2 1996/04/07 21:12:10 mpp Exp $ .\" " .Dd April 1, 1996 .Os @@ -52,8 +52,11 @@ happens to be 128. It isn't directly available to applications. The clock reported by .Xr clock 3 . This is a virtual clock with a frequency that happens to be 128. It's -actual frequency is given by the macro CLOCKS_PER_SEC. Note that -CLOCKS_PER_SEC may be floating point. Don't use +actual frequency is given by the macro +.Dv CLOCKS_PER_SEC . +Note that +.Dv CLOCKS_PER_SEC +may be floating point. Don't use .Fn clock in new programs under FreeBSD. It is feeble compared with .Xr getrusage 2 . @@ -64,13 +67,15 @@ and throwing away information and resolution. The clock reported by .Xr times 3 . This is a virtual clock with a frequency that happens to be 128. It's -actual frequency is given by the macro CLK_TCK (deprecated; don't use) -and by +actual frequency is given by the macro +.Dv CLK_TCK +(deprecated; don't use) and by .Fn sysconf SC_CLK_TCK and by .Xr sysctl 3 . -Note that its frequency may be different from CLOCKS_PER_SEC. Don't -use +Note that its frequency may be different from +.Dv CLOCKS_PER_SEC . +Don't use .Xr times 3 in new programs under FreeBSD. It is feeble compared with .Xr gettimeofday 2 diff --git a/share/man/man7/environ.7 b/share/man/man7/environ.7 index e969e3c7e435..1b222210f601 100644 --- a/share/man/man7/environ.7 +++ b/share/man/man7/environ.7 @@ -54,7 +54,8 @@ The size of the block units used by several commands, most notably .Xr du 1 and .Xr ls 1 . -BLOCKSIZE may be specified in units of a byte by specifying a number, +.Ev BLOCKSIZE +may be specified in units of a byte by specifying a number, in units of a kilobyte by specifying a number followed by ``K'' or ``k'', in units of a megabyte by specifying a number followed by ``M'' or ``m'' and in units of a gigabyte by specifying a number followed @@ -72,9 +73,9 @@ A user's login directory, set by from the password file .Xr passwd 5 . .It Ev LANG -This variable configure all programs which use +This variable configures all programs which use .Xr setlocale 3 -to specified locale. +to use the specified locale. .It Ev PATH The sequence of directories, separated by colons, searched by .Xr csh 1 , @@ -82,7 +83,8 @@ The sequence of directories, separated by colons, searched by .Xr system 3 , .Xr execvp 3 , etc, when looking for an executable file. -PATH is set to ``/usr/bin:/bin'' initially by +.Ev PATH +is set to ``/usr/bin:/bin'' initially by .Xr login 1 . .It Ev PRINTER The name of the default printer to be used by @@ -103,7 +105,9 @@ which may exploit special terminal capabilities. See .Pq Xr termcap 5 for a list of terminal types. .It Ev TERMCAP -The string describing the terminal in TERM, or, if +The string describing the terminal in +.Ev TERM , +or, if it begins with a '/', the name of the termcap file. See .Ev TERMPATH @@ -134,7 +138,7 @@ Setting this variable will make them use another directory. .It Ev TZ The timezone to use when displaying dates. The normal format is a pathname relative to -.Dq /usr/share/zoneinfo . +.Dq Pa /usr/share/zoneinfo . For example, the command .Dq env TZ=US/Pacific date displays the current time in California. diff --git a/share/man/man7/hier.7 b/share/man/man7/hier.7 index 3013278dd524..c7f1eb691d9b 100644 --- a/share/man/man7/hier.7 +++ b/share/man/man7/hier.7 @@ -76,7 +76,7 @@ see .It Li mtree/ mtree configuration files; see -.Xr mtree 1 +.Xr mtree 8 .It Li namedb/ named configuration files; see diff --git a/share/man/man8/rc.8 b/share/man/man8/rc.8 index 1e953a63088e..162aa3c765c3 100644 --- a/share/man/man8/rc.8 +++ b/share/man/man8/rc.8 @@ -76,7 +76,7 @@ and clears the scratch directory .Pp .Nm Rc.local is executed immediately before any other commands after a successful -.Xr fsck . +.Nm fsck . Normally, the first commands placed in the .Nm rc.local file define the machine's name, using diff --git a/share/man/man8/yp.8 b/share/man/man8/yp.8 index 576338daeb1f..ac78f40740fc 100644 --- a/share/man/man8/yp.8 +++ b/share/man/man8/yp.8 @@ -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 |