From 2410103c1d01e5581dbe8c80c0fbbdb90c1fdadc Mon Sep 17 00:00:00 2001 From: Ruslan Ermilov Date: Wed, 7 Jul 2004 19:57:16 +0000 Subject: [PATCH] mdoc(7) fixes. --- lib/libc/stdlib/getenv.3 | 5 +++-- libexec/tftpd/tftpd.8 | 7 +++++-- sbin/devd/devd.8 | 4 +++- sbin/md5/md5.1 | 2 +- share/man/man3/queue.3 | 2 +- share/man/man4/acpi.4 | 8 ++++---- share/man/man4/pcm.4 | 2 +- share/man/man5/make.conf.5 | 4 ++-- share/man/man5/nsswitch.conf.5 | 2 +- share/man/man8/rc.8 | 2 +- share/man/man9/sema.9 | 7 ++++++- sys/boot/common/loader.8 | 4 ++-- usr.bin/cut/cut.1 | 2 +- usr.bin/find/find.1 | 4 ++-- usr.bin/ktrdump/ktrdump.8 | 4 ++-- usr.bin/paste/paste.1 | 2 +- usr.sbin/boot0cfg/boot0cfg.8 | 2 +- usr.sbin/daemon/daemon.8 | 6 ++++-- usr.sbin/traceroute6/traceroute6.8 | 22 +++++++++++----------- usr.sbin/watchdogd/watchdog.8 | 2 ++ 20 files changed, 54 insertions(+), 39 deletions(-) diff --git a/lib/libc/stdlib/getenv.3 b/lib/libc/stdlib/getenv.3 index fc17c68bd4db..c5ed228238f9 100644 --- a/lib/libc/stdlib/getenv.3 +++ b/lib/libc/stdlib/getenv.3 @@ -113,8 +113,9 @@ from the list. .Sh RETURN VALUES The .Fn getenv -function returns the value of the environment variable as a nul terminated -string. +function returns the value of the environment variable as a +.Dv NUL Ns +-terminated string. If the variable .Fa name is not in the current environment, diff --git a/libexec/tftpd/tftpd.8 b/libexec/tftpd/tftpd.8 index 3d746ac3c8e6..63e1e75d51a8 100644 --- a/libexec/tftpd/tftpd.8 +++ b/libexec/tftpd/tftpd.8 @@ -167,9 +167,12 @@ The user must be specified by name, not a numeric UID. .It Fl U Ar umask Set the .Ar umask -for newly created files. The default is 022 (S_IWGRP|S_IWOTH). +for newly created files. +The default is 022 +.Pq Dv S_IWGRP | S_IWOTH . .It Fl w -Allow writes requests to create new files. By default +Allow writes requests to create new files. +By default .Nm requires that the file specified in a write request exist. .El diff --git a/sbin/devd/devd.8 b/sbin/devd/devd.8 index 97cc104a47a0..8c96eaf45796 100644 --- a/sbin/devd/devd.8 +++ b/sbin/devd/devd.8 @@ -112,7 +112,9 @@ config files. .Pp All messages that .Nm -receives are forwarded to the unix domain socket at +receives are forwarded to the +.Ux +domain socket at .Pa /var/run/devd.pipe . .Sh SEE ALSO .Xr devctl 4 , diff --git a/sbin/md5/md5.1 b/sbin/md5/md5.1 index 9d37731ed9d5..67daaa283adc 100644 --- a/sbin/md5/md5.1 +++ b/sbin/md5/md5.1 @@ -19,7 +19,7 @@ .Op Fl s Ar string .Op Ar .Sh DESCRIPTION -The +The .Nm md5 , sha1 and .Nm rmd160 diff --git a/share/man/man3/queue.3 b/share/man/man3/queue.3 index 692bccc59070..6b689ac14030 100644 --- a/share/man/man3/queue.3 +++ b/share/man/man3/queue.3 @@ -859,7 +859,7 @@ assigning each element in turn to However, unlike their unsafe counterparts, .Nm TAILQ_FOREACH and -.Nm TAILQ_FOREACH_REVERSE +.Nm TAILQ_FOREACH_REVERSE permit to both remove .Fa var as well as free it from within the loop safely without interfering with the diff --git a/share/man/man4/acpi.4 b/share/man/man4/acpi.4 index e36919bdedf6..9f441de20f92 100644 --- a/share/man/man4/acpi.4 +++ b/share/man/man4/acpi.4 @@ -214,16 +214,16 @@ enabled, there is a BIOS blacklist. Currently, the blacklist only controls whether .Nm should be disabled or not. -In the future, it will have more granularity to control features (the +In the future, it will have more granularity to control features (the infrastructure for that is already there). .Pp To enable .Nm -(for debugging purposes, etc.) on machines that are on the blacklist, set the +(for debugging purposes, etc.) on machines that are on the blacklist, set the kernel environment variable .Va hint.acpi.0.disabled to 0. -Before trying this, consider updating your BIOS to a more recent version that +Before trying this, consider updating your BIOS to a more recent version that may be compatible with ACPI. .Pp To disable the @@ -349,7 +349,7 @@ Name of the DSDT table to load, if loading is enabled. Selectively disables portions of ACPI for debugging purposes. .It Va hint.acpi.0.disabled Set this to 1 to disable all of ACPI. -If ACPI has been disabled on your system due to a blacklist entry for your +If ACPI has been disabled on your system due to a blacklist entry for your BIOS, you can set this to 0 to re-enable ACPI for testing. .It Va hw.acpi.ec.poll_timeout Delay in milliseconds to wait for the EC to respond. diff --git a/share/man/man4/pcm.4 b/share/man/man4/pcm.4 index fedee2e9571c..d89beb104d64 100644 --- a/share/man/man4/pcm.4 +++ b/share/man/man4/pcm.4 @@ -25,7 +25,7 @@ .\" .\" $FreeBSD$ .\" -.Dd November 14, 2003 +.Dd June 24, 2004 .Dt PCM 4 .Os .Sh NAME diff --git a/share/man/man5/make.conf.5 b/share/man/man5/make.conf.5 index 8d35a37556e0..2cd394dcb49e 100644 --- a/share/man/man5/make.conf.5 +++ b/share/man/man5/make.conf.5 @@ -106,7 +106,7 @@ upgrades from older versions of .It Va CFLAGS .Pq Vt str Controls the compiler setting when compiling C code. -Optimization levels others than +Optimization levels other than .Fl O and .Fl O2 @@ -509,7 +509,7 @@ and related programs. .Pq Vt bool Set to not build .Xr acpiconf 8 , -.Xr acpidump 8 +.Xr acpidump 8 and related programs. .It Va NO_VINUM .Pq Vt bool diff --git a/share/man/man5/nsswitch.conf.5 b/share/man/man5/nsswitch.conf.5 index 1af28d86f38b..ad5db6715661 100644 --- a/share/man/man5/nsswitch.conf.5 +++ b/share/man/man5/nsswitch.conf.5 @@ -32,7 +32,7 @@ .\" TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE .\" USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.Dd January 22, 1998 +.Dd June 21, 2004 .Dt NSSWITCH.CONF 5 .Os .Sh NAME diff --git a/share/man/man8/rc.8 b/share/man/man8/rc.8 index a70404bba85e..c1ab2c85d11c 100644 --- a/share/man/man8/rc.8 +++ b/share/man/man8/rc.8 @@ -564,7 +564,7 @@ is unnecessary, but is often included. .It Pa /var/run/dmesg.boot .Xr dmesg 1 results soon after the -.Nm +.Nm process begins. Useful when dmesg buffer in the kernel no longer has this information. .El diff --git a/share/man/man9/sema.9 b/share/man/man9/sema.9 index 1617e6e40aae..020790085381 100644 --- a/share/man/man9/sema.9 +++ b/share/man/man9/sema.9 @@ -100,7 +100,9 @@ specifies the minimum time in ticks to wait before returning with failure. .Fn sema_value is used to read the current value of the semaphore. .Sh RETURN VALUES +The .Fn sema_value +function returns the current value of the semaphore. .Pp If decrementing the semaphore would result in its value being negative, @@ -108,12 +110,15 @@ If decrementing the semaphore would result in its value being negative, returns 0 to indicate failure. Otherwise, a non-zero value is returned to indicate success. .Pp +The .Fn sema_timedwait +function returns 0 if waiting on the semaphore succeeded; otherwise a non-zero error code is returned. .Sh ERRORS +The .Fn sema_timedwait -will fail if: +function will fail if: .Bl -tag -width Er .It Bq Er EWOULDBLOCK Timeout expired. diff --git a/sys/boot/common/loader.8 b/sys/boot/common/loader.8 index ab816709433b..a77a828412e2 100644 --- a/sys/boot/common/loader.8 +++ b/sys/boot/common/loader.8 @@ -387,8 +387,8 @@ Defaults to .Dq Li "${currdev}>" . .It Va root_disk_unit If the code which detects the disk unit number for the root disk is -confused, e.g. by a mix of SCSI and IDE disks, or IDE disks with -gaps in the sequence (e.g. no primary slave), the unit number can +confused, e.g.\& by a mix of SCSI and IDE disks, or IDE disks with +gaps in the sequence (e.g.\& no primary slave), the unit number can be forced by setting this variable. .It Va rootdev By default the value of diff --git a/usr.bin/cut/cut.1 b/usr.bin/cut/cut.1 index c595e17eb086..2138d7681b8c 100644 --- a/usr.bin/cut/cut.1 +++ b/usr.bin/cut/cut.1 @@ -58,7 +58,7 @@ The .Nm utility selects portions of each line (as specified by -.Ar list ) +.Ar list ) from each .Ar file and writes them to the standard output. diff --git a/usr.bin/find/find.1 b/usr.bin/find/find.1 index 1d23ca57f648..61a8bd32f0b1 100644 --- a/usr.bin/find/find.1 +++ b/usr.bin/find/find.1 @@ -276,11 +276,11 @@ same as the option. .It Ic -depth Ar n True if the depth of the file relative to the starting point of the traversal -is +is .Ar n . .It Ic -empty True if the current file or directory is empty. -.It Ic -exec Ar utility Oo Ar argument ... Oc Li \&; +.It Ic -exec Ar utility Oo Ar argument ... Oc Li \&; True if the program named .Ar utility returns a zero value as its exit status. diff --git a/usr.bin/ktrdump/ktrdump.8 b/usr.bin/ktrdump/ktrdump.8 index ec235e5cbd41..5bdd984fc2cc 100644 --- a/usr.bin/ktrdump/ktrdump.8 +++ b/usr.bin/ktrdump/ktrdump.8 @@ -25,7 +25,7 @@ .\" .\" $FreeBSD$ .\" -.Dd April 1, 2002 +.Dd May 5, 2004 .Dt KTRDUMP 8 .Os .Sh NAME @@ -49,7 +49,7 @@ Print the CPU number that each entry was logged from. .It Fl f Print the file and line number that each entry was logged from. .It Fl q -Quiet mode; don't print the column header. +Quiet mode; do not print the column header. .It Fl r Print relative timestamps rather than absolute timestamps. .It Fl t diff --git a/usr.bin/paste/paste.1 b/usr.bin/paste/paste.1 index dee2cd3e9bd3..c9a8f845a337 100644 --- a/usr.bin/paste/paste.1 +++ b/usr.bin/paste/paste.1 @@ -59,7 +59,7 @@ of empty lines. .Pp The options are as follows: .Bl -tag -width Fl -.It Fl d Ar list +.It Fl d Ar list Use one or more of the provided characters to replace the newline characters instead of the default tab. The characters in diff --git a/usr.sbin/boot0cfg/boot0cfg.8 b/usr.sbin/boot0cfg/boot0cfg.8 index ff21a852775c..d54560801685 100644 --- a/usr.sbin/boot0cfg/boot0cfg.8 +++ b/usr.sbin/boot0cfg/boot0cfg.8 @@ -83,7 +83,7 @@ Specify which .Sq boot0 image to use. The default is -.Pa /boot/boot0 +.Pa /boot/boot0 which will use the video card as output, alternatively .Pa /boot/boot0sio can be used for output to the COM1 port. diff --git a/usr.sbin/daemon/daemon.8 b/usr.sbin/daemon/daemon.8 index 23702db9d75e..a1048fd78724 100644 --- a/usr.sbin/daemon/daemon.8 +++ b/usr.sbin/daemon/daemon.8 @@ -52,7 +52,7 @@ Change the current working directory to the root Redirect standard input, standard output and standard error to .Pa /dev/null . .It Fl p Ar file -Write the id of the created process into the +Write the ID of the created process into the .Ar file . Note, that the file will be created shortly before the process is actually executed, and will remain after the process exits (although @@ -63,7 +63,9 @@ The .Nm utility exits 1 if an error is returned by the .Xr daemon 3 -library routine, 2 if the pid-file is requested, but can not be opened, +library routine, 2 if the +.Ar pidfile +is requested, but cannot be opened, otherwise 0. If the command cannot be executed, an error message is displayed on standard error unless the diff --git a/usr.sbin/traceroute6/traceroute6.8 b/usr.sbin/traceroute6/traceroute6.8 index 99d84482d0ab..04c800d3f4df 100644 --- a/usr.sbin/traceroute6/traceroute6.8 +++ b/usr.sbin/traceroute6/traceroute6.8 @@ -69,17 +69,18 @@ .Ek .\" .Sh DESCRIPTION +The .Nm +utility uses the IPv6 protocol hop limit field to elicit an ICMPv6 TIME_EXCEEDED response from each gateway along the path to some host. .Pp The only mandatory parameter is the destination host name or IPv6 address. The default probe datagram carries 12 bytes of payload, in addition to the IPv6 header. -The size of the payload can be specified by giving a length -.Po in bytes -.Pc -after the destination host name. +The size of the payload can be specified by giving a length +(in bytes) +after the destination host name. .Pp Other options are: .Bl -tag -width Ds @@ -123,21 +124,20 @@ Be verbose. Specify the delay time between probes. .El .Pp -This program prints the route to the given destination and the round-trip +This program prints the route to the given destination and the round-trip time to each gateway, in the same manner as traceroute. .Pp Here is a list of possible annotations after the round-trip time for each gateway: -.Pp .Bl -hang -offset indent -.It !N +.It !N Destination Unreachable - No Route to Host. -.It !P +.It !P Destination Unreachable - Administratively Prohibited. -.It !S +.It !S Destination Unreachable - Not a Neighbour. -.It !A +.It !A Destination Unreachable - Address Unreachable. -.It ! +.It !\& This is printed if the hop limit is <= 1 on a port unreachable message. This means that the packet got to the destination, but that the reply had a hop limit that was just large enough to diff --git a/usr.sbin/watchdogd/watchdog.8 b/usr.sbin/watchdogd/watchdog.8 index f305b1fdf251..7813947e36fb 100644 --- a/usr.sbin/watchdogd/watchdog.8 +++ b/usr.sbin/watchdogd/watchdog.8 @@ -42,10 +42,12 @@ utility can be used to control the kernel's watchdog facility. .Pp The .Fl d +option enables debugging. .Pp The .Fl t Ar timeout +option specifies the desired timeout period in seconds, a value of zero will disable the watchdog. .Sh SEE ALSO