diff options
139 files changed, 928 insertions, 620 deletions
diff --git a/sbin/setkey/setkey.8 b/sbin/setkey/setkey.8 index f56e22b08465..5861ced56802 100644 --- a/sbin/setkey/setkey.8 +++ b/sbin/setkey/setkey.8 @@ -54,13 +54,15 @@ .Fl x .\" .Sh DESCRIPTION +The .Nm -adds, updates, dumps, or flushes +utility adds, updates, dumps, or flushes Security Association Database (SAD) entries as well as Security Policy Database (SPD) entries in the kernel. .Pp +The .Nm -takes a series of operations from the standard input +utility takes a series of operations from the standard input (if invoked with .Fl c ) or the file named @@ -79,8 +81,7 @@ If with .Fl P , the SPD entries are flushed. .It Fl a -.Nm -usually does not display dead SAD entries with +Dead SAD entries are usually not displayed with .Fl D . If with .Fl a , @@ -195,8 +196,9 @@ Meta-arguments are as follows: .It Ar dst Source/destination of the secure communication is specified as IPv4/v6 address. +The .Nm -does not consult hostname-to-address for arguments +utility does not consult hostname-to-address for arguments .Ar src and .Ar dst . @@ -368,8 +370,9 @@ The square bracket around is really necessary. They are not manpage metacharacters. .Pp +The .Nm -does not consult hostname-to-address for arguments +utility does not consult hostname-to-address for arguments .Ar src and .Ar dst . @@ -623,7 +626,7 @@ The command exits with 0 on success, and non-zero on errors. .Sh HISTORY The .Nm -command first appeared in WIDE Hydrangea IPv6 protocol stack kit. +utility first appeared in WIDE Hydrangea IPv6 protocol stack kit. The command was completely re-designed in June 1998. .\" .\" .Sh BUGS diff --git a/usr.sbin/IPXrouted/IPXrouted.8 b/usr.sbin/IPXrouted/IPXrouted.8 index fc1a1a19ed8b..0a08e0086146 100644 --- a/usr.sbin/IPXrouted/IPXrouted.8 +++ b/usr.sbin/IPXrouted/IPXrouted.8 @@ -48,8 +48,9 @@ .Op Fl t .Op Ar logfile .Sh DESCRIPTION +The .Nm -is invoked at boot time to manage the IPX routing tables. +utility is invoked at boot time to manage the IPX routing tables. The IPX routing daemon uses the Novell IPX Routing Information Protocol in maintaining up to date kernel routing table entries. @@ -110,8 +111,9 @@ system and marked is ignored). If multiple interfaces are present, it is assumed the host will forward packets between networks. +The .Nm -then transmits a +utility then transmits a .Em request packet on each interface (using a broadcast packet if the interface supports it) and enters a loop, listening diff --git a/usr.sbin/ac/ac.8 b/usr.sbin/ac/ac.8 index adbc46bce8d7..4be565929aa7 100644 --- a/usr.sbin/ac/ac.8 +++ b/usr.sbin/ac/ac.8 @@ -52,7 +52,9 @@ times are written to it by and .Xr init 8 , respectively. -.Nm \&Ac +The +.Nm +utility examines these records and writes the accumulated connect time (in hours) for all logins to the standard output. .Pp diff --git a/usr.sbin/accton/accton.8 b/usr.sbin/accton/accton.8 index 8be1951496b5..20eb45a54b0c 100644 --- a/usr.sbin/accton/accton.8 +++ b/usr.sbin/accton/accton.8 @@ -12,7 +12,7 @@ .Sh DESCRIPTION The .Nm -command is used +utility is used for switching system accounting on or off. If called with the argument .Ar acctfile , diff --git a/usr.sbin/acpi/acpiconf/acpiconf.8 b/usr.sbin/acpi/acpiconf/acpiconf.8 index 5c8ec3b1943c..71ea3815356b 100644 --- a/usr.sbin/acpi/acpiconf/acpiconf.8 +++ b/usr.sbin/acpi/acpiconf/acpiconf.8 @@ -40,7 +40,7 @@ .Sh DESCRIPTION The .Nm -command allows the user control of the ACPI power management +utility allows the user control of the ACPI power management functions. The following command-line options are recognized: .Bl -tag -width indent @@ -67,13 +67,13 @@ and .Sh HISTORY The .Nm -command appeared in +utility appeared in .Fx 5.0 . .Sh AUTHORS .An -nosplit The .Nm -command was written by +utility was written by .An Mitsuru Iwasaki Aq iwasaki@FreeBSD.org . This manual page was written by .An Dag-Erling Co\(:idan Sm\(/orgrav Aq des@FreeBSD.org . diff --git a/usr.sbin/acpi/acpidump/acpidump.8 b/usr.sbin/acpi/acpidump/acpidump.8 index e825ab191e17..ecb0a7e1f94d 100644 --- a/usr.sbin/acpi/acpidump/acpidump.8 +++ b/usr.sbin/acpi/acpidump/acpidump.8 @@ -47,7 +47,8 @@ .Sh DESCRIPTION The .Nm -command analyzes ACPI tables in physical memory and dumps them to standard output. +utility analyzes ACPI tables in physical memory and dumps them to +standard output. In addition, .Nm can disassemble AML @@ -60,8 +61,9 @@ Differentiated System Description Table), that includes information used on the kernel side such as detailed information about PnP hardware, procedures for controlling power management support and so on. +The .Nm -can extract the DSDT data block from physical memory and store it into +utility can extract the DSDT data block from physical memory and store it into a DSDT data file, and also can generate an output in ASL from a given DSDT data file. .Pp @@ -87,8 +89,9 @@ called SDTs and their header has a common format which consists of items such as Signature, Length, Revision, Checksum, OEMID, OEM Table ID, OEM Revision, Creator ID and Creator Revision. +The .Nm -dumps contents of these SDTs. +utility dumps contents of these SDTs. For further information about formats of each table, see chapter 5: .Dq ACPI Software Programming Model @@ -180,5 +183,5 @@ and .Sh HISTORY The .Nm -command appeared in +utility appeared in .Fx 5.0 . diff --git a/usr.sbin/acpi/amldb/amldb.8 b/usr.sbin/acpi/amldb/amldb.8 index d10e900b7a21..ba988f25b3e3 100644 --- a/usr.sbin/acpi/amldb/amldb.8 +++ b/usr.sbin/acpi/amldb/amldb.8 @@ -40,15 +40,17 @@ .Op Fl dhst .Ar dsdt_file ... .Sh DESCRIPTION -.Nm Amldb -parses the DSDT +The +.Nm +utility parses the DSDT (Differentiated System Description Table) files, which usually are acquired from ACPI BIOS, and executes the sequence of ACPI Control Methods described in AML (ACPI Machine Language) with its AML interpreter. -.Nm Amldb -also has a simple ACPI virtual machine. During execution of the +The +.Nm +utility also has a simple ACPI virtual machine. During execution of the Control Methods each access to the region, such as SystemMemory, SystemIO, PCI_Config, does not affect the real hardware but only the virtual machine. @@ -229,7 +231,7 @@ DSDT data file is read. .El .Sh EXAMPLES The following is an example including, invoking the -.Nm , +.Nm Ns , searching .Li _PRS (Possible Resource Settings) @@ -332,5 +334,5 @@ and .Sh HISTORY The .Nm -command appeared in +utility appeared in .Fx 5.0 . diff --git a/usr.sbin/adduser/adduser.8 b/usr.sbin/adduser/adduser.8 index 71078a3307f7..0f52c3b9956a 100644 --- a/usr.sbin/adduser/adduser.8 +++ b/usr.sbin/adduser/adduser.8 @@ -48,9 +48,9 @@ .Op Fl v | verbose .Ek .Sh DESCRIPTION -.Nm Adduser -is a simple program for adding new users. -Adduser checks +The +.Nm +utility is a simple program for adding new users. It checks the passwd, group and shell databases. It creates passwd/group entries, .Ev HOME @@ -189,8 +189,9 @@ Recommended for novice users. .Ql Pa # is a comment. .It Sy configuration file -.Nm Adduser -reads and writes this file. +The +.Nm +utility reads and writes this file. See .Pa /etc/adduser.conf for more details. @@ -239,5 +240,5 @@ logfile for adduser .Sh HISTORY The .Nm -command appeared in +utility appeared in .Fx 2.1 . diff --git a/usr.sbin/adduser/rmuser.8 b/usr.sbin/adduser/rmuser.8 index d3ed35333d88..2e55694122c2 100644 --- a/usr.sbin/adduser/rmuser.8 +++ b/usr.sbin/adduser/rmuser.8 @@ -37,8 +37,9 @@ .Op Fl y .Op Ar username .Sh DESCRIPTION -The utility +The .Nm +utility .Pp .Bl -enum .It @@ -76,7 +77,9 @@ the group is removed; this complements per-user unique groups). .El .Pp -.Nm Rmuser +The +.Nm +utility politely refuses to remove users whose uid is 0 (typically root), since certain actions (namely, killing all the user's processes, and perhaps removing the user's home directory) would cause damage to a running system. @@ -139,17 +142,19 @@ interactively asks for the user to be removed. .Sh HISTORY The .Nm -command appeared in +utility appeared in .Fx 2.2 . .\" .Sh AUTHOR .\" Guy Helmer, Ames, Iowa .Sh BUGS -.Nm Rmuser -does not comprehensively search the filesystem for all files +The +.Nm +utility does not comprehensively search the filesystem for all files owned by the removed user and remove them; to do so on a system of any size is prohibitively slow and I/O intensive. -.Nm Rmuser -also is unable to remove symbolic links that were created by the +The +.Nm +utility also is unable to remove symbolic links that were created by the user in .Pa /tmp or @@ -165,6 +170,7 @@ and .Pa /var/mail/.pop.username that are not owned by the removed user but should be removed. .Pp -.Nm Rmuser -has no knowledge of NIS (Yellow Pages), and it operates only on the +The +.Nm +utility has no knowledge of NIS (Yellow Pages), and it operates only on the local password file. diff --git a/usr.sbin/ancontrol/ancontrol.8 b/usr.sbin/ancontrol/ancontrol.8 index 5e0927f5ae83..c038bc1d8707 100644 --- a/usr.sbin/ancontrol/ancontrol.8 +++ b/usr.sbin/ancontrol/ancontrol.8 @@ -105,7 +105,7 @@ .Sh DESCRIPTION The .Nm -command controls the operation of Aironet wireless networking +utility controls the operation of Aironet wireless networking devices via the .Xr an 4 driver. @@ -117,7 +117,7 @@ to point) or infrastructure mode, and the network name of a service set to join. The .Nm -command can also be used to view the current NIC status, configuration +utility can also be used to view the current NIC status, configuration and to dump out the values of the card's statistics counters. .Pp The @@ -134,7 +134,7 @@ will be assumed. .Pp The .Nm -command is not designed to support the combination of arguments from different +utility is not designed to support the combination of arguments from different .Sx SYNOPSIS lines in a single .Nm @@ -507,7 +507,7 @@ and uses transmit key 0. .Sh HISTORY The .Nm -command first appeared in +utility first appeared in .Fx 4.0 . .Sh BUGS The statistics counters do not seem to show the amount of transmit @@ -522,5 +522,5 @@ Setting the channel does not seem to have any effect. .Sh AUTHORS The .Nm -command was written by +utility was written by .An Bill Paul Aq wpaul@ee.columbia.edu . diff --git a/usr.sbin/apm/apm.8 b/usr.sbin/apm/apm.8 index 9a0767598765..e9263bf45e26 100644 --- a/usr.sbin/apm/apm.8 +++ b/usr.sbin/apm/apm.8 @@ -27,11 +27,14 @@ .Pp .Nm zzz .Sh DESCRIPTION -.Nm Apm +The +.Nm +utility controls the Intel / Microsoft APM (Advanced Power Management) BIOS and displays the current status of APM on laptop PCs. -.Nm Zzz -suspends the system by controlling APM. +The +.Nm zzz +utility suspends the system by controlling APM. .Pp The following options are available for .Nm diff --git a/usr.sbin/apmd/apmd.8 b/usr.sbin/apmd/apmd.8 index 3de23c852656..7f374f416608 100644 --- a/usr.sbin/apmd/apmd.8 +++ b/usr.sbin/apmd/apmd.8 @@ -40,7 +40,9 @@ .Op Fl f file .Op Fl v .Sh DESCRIPTION -.Nm Apmd +The +.Nm +utility monitors the occurrence of the specified Advanced Power Management .Pq Tn APM events and, if one of the events occurs, it executes the sequence of @@ -58,8 +60,9 @@ Therefore, if you wish action to be taken when these events occur, you need to explicitly configure the appropriate commands or built-in functions in the configuration file. .Pp -.Nm Apmd -recognizes the following runtime options: +The +.Nm +utility recognizes the following runtime options: .Bl -tag -width -f_file .It Fl d Starts in debug mode. This causes @@ -88,8 +91,9 @@ If the process receives a SIGHUP, it will reread its configuration file and notify the APM device driver of any changes to its configuration. .Pp -.Nm Apmd -uses the device +The +.Nm +utility uses the device .Pa /dev/apmctl to issue .Xr ioctl 2 @@ -114,7 +118,7 @@ complete the request just yet. .Pp The .Nm -daemon creates the file +utility creates the file .Pa /var/run/apmd.pid , and stores its process id there. @@ -202,15 +206,17 @@ The command list for the event should be enclosed by .Ql { and .Ql } . +The .Nm -uses +utility uses .Pa /bin/sh for double-quotation enclosed command execution, just as with .Xr system 3 . Each command is executed in order until the end of the list is reached or a command finishes with a non-zero status code. +The .Nm -will report any failed command's status code via +utility will report any failed command's status code via .Xr syslog 3 and will then reject the request event posted by the APM BIOS. .Ed @@ -292,5 +298,5 @@ and .Sh HISTORY The .Nm -command appeared in +utility appeared in .Fx 3.3 . diff --git a/usr.sbin/arp/arp.8 b/usr.sbin/arp/arp.8 index e954df8408ee..802243d728ed 100644 --- a/usr.sbin/arp/arp.8 +++ b/usr.sbin/arp/arp.8 @@ -64,7 +64,7 @@ .Sh DESCRIPTION The .Nm -program displays and modifies the Internet-to-Ethernet address translation +utility displays and modifies the Internet-to-Ethernet address translation tables used by the address resolution protocol .Pq Xr arp 4 . With no flags, the program displays the current @@ -149,7 +149,7 @@ except any existing .Tn ARP entry for this host will be deleted first. .It Fl f Ar filename -Causes the file +Cause the file .Ar filename to be read and multiple entries to be set in the .Tn ARP @@ -171,5 +171,5 @@ with argument meanings as given above. .Sh HISTORY The .Nm -command appeared in +utility appeared in .Bx 4.3 . diff --git a/usr.sbin/atm/atmarpd/atmarpd.8 b/usr.sbin/atm/atmarpd/atmarpd.8 index 49aaebc6de50..351b0c19c646 100644 --- a/usr.sbin/atm/atmarpd/atmarpd.8 +++ b/usr.sbin/atm/atmarpd/atmarpd.8 @@ -38,12 +38,14 @@ .Aq Ar net_intf .Ar ... .Sh DESCRIPTION -.Nm Atmarpd -provides an interface between the ATMARP server in the +The +.Nm +utility provides an interface between the ATMARP server in the kernel and the SCSP daemon for the Host ATM Research Platform (HARP) networking software. -.Nm Atmarpd -reads the ATMARP cache from the kernel periodically +The +.Nm +utility reads the ATMARP cache from the kernel periodically and passes any updated entries to .Xr scspd 8 so they will be @@ -67,14 +69,14 @@ itself into the background. The command-line options are: .Bl -tag -width "-l <log_file>" .It Fl l Aq Ar log_file -Specifies that +Specify that .Nm is to write log messages to the file named .Aq Ar log_file rather than to the system log. .It Fl d -Specifies that +Specify that .Nm is to be run in debug mode. In debug mode, @@ -83,7 +85,7 @@ is not put into the background. Log messages are written to standard output instead of to the log file. .It Aq Ar net_intf -Specifies the network interface(s) for which the host is providing +Specify the network interface(s) for which the host is providing ATMARP service and whose caches are to be synchronized using SCSP. If multiple network interface names are specified, .Nm @@ -118,8 +120,9 @@ its control blocks to a text file (see .Sm on .Xc Debugging information dump file name. -.Nm Atmarpd -writes a summary of its control blocks to this file +The +.Nm +utility writes a summary of its control blocks to this file when it receives a .Dv SIGINT signal. diff --git a/usr.sbin/atm/scspd/scspd.8 b/usr.sbin/atm/scspd/scspd.8 index dcb432ce3b1f..d369f611b70f 100644 --- a/usr.sbin/atm/scspd/scspd.8 +++ b/usr.sbin/atm/scspd/scspd.8 @@ -37,12 +37,14 @@ .Op Fl d .Op Fl T Ns Aq Ar options .Sh DESCRIPTION -.Nm Scspd -is an implementation of the Server Cache Synchronization +The +.Nm +utility is an implementation of the Server Cache Synchronization Protocol (SCSP) for the Host ATM Research Platform (HARP) networking software. -.Nm Scspd -synchronizes the cache(s) of server(s) +The +.Nm +utility synchronizes the cache(s) of server(s) running on a host with the caches of servers on remote hosts. SCSP is defined for a number of different protocols, but the present version of @@ -71,8 +73,9 @@ and must be running before any ATMARP cache synchronization can take place. .Pp -.Nm Scspd -implements SCSP as specified in RFC 2334, +The +.Nm +utility implements SCSP as specified in RFC 2334, .%T "Server Cache Synchronization Protocol (SCSP)" and .Pa draft\-ietf\-ion\-scspd\-atmarpd\-00.txt , @@ -472,8 +475,9 @@ statement specifies how .Nm is to log information about its operation. -.Nm Scspd -can write log information to a file, to the system log, +The +.Nm +utility can write log information to a file, to the system log, or both. .Bl -tag -width indent .It Ic File Aq Ar file\ name ; @@ -492,8 +496,9 @@ statement specifies that .Nm is to write its log messages to the syslog facility. -.Nm Scspd -writes its messages to syslog with a facility code +The +.Nm +utility writes its messages to syslog with a facility code of .Dv LOG_DAEMON . .El @@ -553,7 +558,7 @@ its control blocks to a text file (see .Sh FILES .Bl -tag -width indent .It Pa /etc/scspd.conf -.Nm Scspd +.Nm default configuration file name. A different file name can be specified with the .Fl f @@ -568,9 +573,10 @@ option. .Pa .out .Sm on .Xc -Debugging information dump file name. -.Nm Scspd -writes a summary of its control blocks to this file +debugging information dump file name. +The +.Nm +utility writes a summary of its control blocks to this file when it receives a .Dv SIGINT signal. @@ -586,9 +592,10 @@ number which is incremented every time a dump is taken. .Pa .trace .Sm on .Xc -Trace file. -.Nm Scspd -writes trace information to this file if the +trace file. +The +.Nm +utility writes trace information to this file if the .Fl T option is specified on the command line. .El diff --git a/usr.sbin/boot0cfg/boot0cfg.8 b/usr.sbin/boot0cfg/boot0cfg.8 index 0937f68b28cc..fd4d8d8a6f1b 100644 --- a/usr.sbin/boot0cfg/boot0cfg.8 +++ b/usr.sbin/boot0cfg/boot0cfg.8 @@ -150,7 +150,7 @@ image The following is an example of a typical usage of the .Nm -command to affect the next boot: +utility to affect the next boot: .Pp .Dl "boot0cfg -s 2 ad0" .Sh DIAGNOSTICS diff --git a/usr.sbin/boot98cfg/boot98cfg.8 b/usr.sbin/boot98cfg/boot98cfg.8 index fb55d61e6a68..6d24b1957130 100644 --- a/usr.sbin/boot98cfg/boot98cfg.8 +++ b/usr.sbin/boot98cfg/boot98cfg.8 @@ -57,7 +57,7 @@ table. The IPL loads the HDD boot menu that starts from 0x400. .Pp The .Nm -installs and makes backup copy of the IPL and the HDD boot menu; and +utility installs and makes backup copy of the IPL and the HDD boot menu; and allows changing the version number field in the sector 0. .Pp Note that the format command in NEC's OSs replaces the HDD boot menu diff --git a/usr.sbin/bootparamd/bootparamd/bootparamd.8 b/usr.sbin/bootparamd/bootparamd/bootparamd.8 index 37bd886e081a..fabbe3c1f790 100644 --- a/usr.sbin/bootparamd/bootparamd/bootparamd.8 +++ b/usr.sbin/bootparamd/bootparamd/bootparamd.8 @@ -12,8 +12,9 @@ .Op Fl r Ar router .Op Fl f Ar file .Sh DESCRIPTION -.Nm Bootparamd -is a server process that provides information to +The +.Nm +utility is a server process that provides information to .Xr diskless 8 clients necessary for booting. It consults the diff --git a/usr.sbin/burncd/burncd.8 b/usr.sbin/burncd/burncd.8 index d0b6564467cc..c1c0beff81da 100644 --- a/usr.sbin/burncd/burncd.8 +++ b/usr.sbin/burncd/burncd.8 @@ -174,12 +174,12 @@ Probably, please report when found. .Sh HISTORY The .Nm -command appeared in +utility appeared in .Fx 4.0 . .Sh AUTHORS The .Nm -command and this manpage was contributed by +utility and this manpage was contributed by .An S\(/oren Schmidt , Denmark .Aq sos@FreeBSD.org . diff --git a/usr.sbin/chown/chown.8 b/usr.sbin/chown/chown.8 index b10b59a402d3..1add3daf65be 100644 --- a/usr.sbin/chown/chown.8 +++ b/usr.sbin/chown/chown.8 @@ -56,8 +56,9 @@ .No : Ns Ar group .Ar .Sh DESCRIPTION -.Nm Chown -changes the user ID and/or the group ID of the specified files. +The +.Nm +utility changes the user ID and/or the group ID of the specified files. Symbolic links named by arguments are silently left unchanged unless .Fl h is used. @@ -150,11 +151,11 @@ option is non-standard and its use in scripts is not recommended. .Sh STANDARDS The .Nm -command is expected to be +utility is expected to be .St -p1003.2 compliant. .Sh HISTORY A .Nm -command appeared in +utility appeared in .At v1 . diff --git a/usr.sbin/chroot/chroot.8 b/usr.sbin/chroot/chroot.8 index 454155cfd073..c60152cd8f59 100644 --- a/usr.sbin/chroot/chroot.8 +++ b/usr.sbin/chroot/chroot.8 @@ -45,7 +45,7 @@ .Sh DESCRIPTION The .Nm -command changes its current and root directories to the supplied directory +utility changes its current and root directories to the supplied directory .Ar newroot and then exec's .Ar command , diff --git a/usr.sbin/config/config.8 b/usr.sbin/config/config.8 index 8e6af76bc960..d2a7448d3f80 100644 --- a/usr.sbin/config/config.8 +++ b/usr.sbin/config/config.8 @@ -46,7 +46,7 @@ .Sh DESCRIPTION This is the old version of the .Nm -program. +utility. It understands the old autoconfiguration scheme used on the HP300, i386, DECstation, and derivative platforms. The new version of @@ -58,8 +58,9 @@ Only the version of applicable to the architecture that you are running will be installed on your machine. .Pp +The .Nm -builds a set of system configuration files from the file +utility builds a set of system configuration files from the file .Ar SYSTEM_NAME which describes the system to configure. @@ -102,8 +103,9 @@ containing device specifications, configuration options and other system parameters for one system configuration. .El .Pp +The .Nm -should be run from the +utility should be run from the .Pa conf subdirectory of the system source (usually .Pa /sys/ Ns Va ARCH Ns Pa /conf ) , @@ -111,8 +113,9 @@ where .Va ARCH represents one of the architectures supported by .Fx . +The .Nm -creates the directory +utility creates the directory .Pa ../compile/ Ns Ar SYSTEM_NAME or the one given with the .Fl d @@ -135,16 +138,17 @@ definitions of the number of various devices that will be compiled into the system. .Pp After running -.Nm , +.Nm Ns , it is necessary to run .Dq Li make depend in the directory where the new makefile was created. +The .Nm -prints a reminder of this when it completes. +utility prints a reminder of this when it completes. .Pp If any other error messages are produced by -.Nm , +.Nm Ns , the problems in the configuration file should be corrected and .Nm should be run again. @@ -251,5 +255,5 @@ The line numbers reported in error messages are usually off by one. .Sh HISTORY The .Nm -command appeared in +utility appeared in .Bx 4.1 . diff --git a/usr.sbin/cron/cron/cron.8 b/usr.sbin/cron/cron/cron.8 index d47735bbc833..bd5cf3505659 100644 --- a/usr.sbin/cron/cron/cron.8 +++ b/usr.sbin/cron/cron/cron.8 @@ -29,26 +29,31 @@ .Op Fl o .Op Fl x Ar debugflag Ns Op , Ns Ar ... .Sh DESCRIPTION -.Nm Cron -should be started from +The +.Nm +utility should be started from .Pa /etc/rc or .Pa /etc/rc.local . It will return immediately, so you don't need to start it with '&'. .Pp -.Nm Cron -searches +The +.Nm +utility searches .Pa /var/cron/tabs for crontab files which are named after accounts in .Pa /etc/passwd ; crontabs found are loaded into memory. -.Nm Cron -also searches for +The +.Nm +utility also searches for .Pa /etc/crontab which is in a different format (see .Xr crontab 5 ) . -.Nm Cron +The +.Nm +utility then wakes up every minute, examining all stored crontabs, checking each command to see if it should be run in the current minute. When executing commands, any output is mailed to the owner of the crontab (or to the user diff --git a/usr.sbin/dev_mkdb/dev_mkdb.8 b/usr.sbin/dev_mkdb/dev_mkdb.8 index 3d420e2bb6ce..291626de3e73 100644 --- a/usr.sbin/dev_mkdb/dev_mkdb.8 +++ b/usr.sbin/dev_mkdb/dev_mkdb.8 @@ -47,7 +47,7 @@ database .Sh DESCRIPTION The .Nm -command creates a +utility creates a .Xr db 3 hash access method database in .Ar file @@ -74,9 +74,9 @@ field. .Sh FILES .Bl -tag -width ".Pa /var/run/dev.db" -compact .It Pa /dev -Default device directory. +default device directory .It Pa /var/run/dev.db -Default database file. +default database file .El .Sh SEE ALSO .Xr ps 1 , @@ -87,5 +87,5 @@ Default database file. .Sh HISTORY The .Nm -command appeared in +utility appeared in .Bx 4.4 . diff --git a/usr.sbin/digictl/digictl.8 b/usr.sbin/digictl/digictl.8 index 1636e6fca76a..cc99fd27f390 100644 --- a/usr.sbin/digictl/digictl.8 +++ b/usr.sbin/digictl/digictl.8 @@ -19,7 +19,7 @@ devices .Sh DESCRIPTION The .Nm -program provides control of the +utility provides control of the .Tn Digiboard installed with the given .Ar ctrl-device @@ -114,5 +114,5 @@ existing ports. .Sh HISTORY The .Nm -command first appeared in +utility first appeared in .Fx 5.0 . diff --git a/usr.sbin/edquota/edquota.8 b/usr.sbin/edquota/edquota.8 index 6ad0c8585890..8e43dab94dc1 100644 --- a/usr.sbin/edquota/edquota.8 +++ b/usr.sbin/edquota/edquota.8 @@ -61,8 +61,9 @@ .Fl g .Op Fl f Ar fspath .Sh DESCRIPTION -.Nm Edquota -is a quota editor. +The +.Nm +utility is a quota editor. By default, or if the .Fl u flag is specified, diff --git a/usr.sbin/elf2exe/elf2exe.8 b/usr.sbin/elf2exe/elf2exe.8 index 4817cbae1c4d..d41198cb7a63 100644 --- a/usr.sbin/elf2exe/elf2exe.8 +++ b/usr.sbin/elf2exe/elf2exe.8 @@ -22,7 +22,9 @@ .Ar infile .Ar outfile .Sh DESCRIPTION -.Nm Elf2exe +The +.Nm +utility creates an executable that can be loaded by the AlphaBIOS or ARCS consoles as found on systems designed for .Tn Windows/NT . @@ -42,11 +44,13 @@ ld -o a.out -M -N -Ttext 0x80900000 src.o elf2exe a.out a.exe .Ed .Sh BUGS -.Nm Elf2exe +The +.Nm +utility does not even attempt to verify that the input file matches the requirements for an ARC executable. .Sh HISTORY The .Nm -command appeared in +utility appeared in .Fx 4.0 . diff --git a/usr.sbin/extattrctl/extattrctl.8 b/usr.sbin/extattrctl/extattrctl.8 index 511e4e693483..e7ae5c6d3c82 100644 --- a/usr.sbin/extattrctl/extattrctl.8 +++ b/usr.sbin/extattrctl/extattrctl.8 @@ -64,10 +64,11 @@ .Ar attrnamespace .Ar attrname .Sh DESCRIPTION +The .Nm +utility is the management utility for extended attributes over the UFS1 file system. -.Nm -allows the starting and stopping of extended attributes on a file system, +It allows the starting and stopping of extended attributes on a file system, as well as initialization of attribute backing files, and enabling and disabling of specific extended attributes on a file system. .Pp diff --git a/usr.sbin/faithd/faithd.8 b/usr.sbin/faithd/faithd.8 index 655f8d01d5ab..177396b37a24 100644 --- a/usr.sbin/faithd/faithd.8 +++ b/usr.sbin/faithd/faithd.8 @@ -42,9 +42,9 @@ .Ar service .Op Ar serverpath Op Ar serverargs .Sh DESCRIPTION +The .Nm -provides IPv6-to-IPv4 TCP relay. -.Nm +utility provides IPv6-to-IPv4 TCP relay. It must be used on an IPv4/v6 dual stack router. .Pp When @@ -99,8 +99,9 @@ and .Xr sysctl 8 commands. .Pp +The .Nm -needs a special name-to-address translation logic, so that +utility needs a special name-to-address translation logic, so that hostnames gets resolved into special .Tn IPv6 address prefix. @@ -122,8 +123,9 @@ When is invoked as a standalone program, .Nm will daemonize itself. +The .Nm -will listen to +utility will listen to .Tn TCPv6 port .Ar service . @@ -147,8 +149,9 @@ By specifying to .Nm , you can run local daemons on the router. +The .Nm -will invoke local daemon at +utility will invoke local daemon at .Ar serverpath if the destination address is local interface address, and will perform translation to IPv4 TCP in other cases. @@ -174,11 +177,13 @@ and this flag is not necessary as special program code is supplied. .El .Pp +The .Nm -will relay both normal and out-of-band TCP data. +utility will relay both normal and out-of-band TCP data. It is capable of emulating TCP half close as well. +The .Nm -includes special support for protocols used by +utility includes special support for protocols used by .Xr ftp 1 and .Xr rlogin 1 . @@ -218,8 +223,9 @@ will invoke service-specific daemon like by using the command argument passed from .Xr inetd 8 . .Pp +The .Nm -determines operation mode by the local TCP port number, +utility determines operation mode by the local TCP port number, and enables special protocol handling whenever necessary/possible. For example, if .Nm @@ -343,8 +349,9 @@ Whenever connection comes in, will be invoked by .Xr inetd 8 . If it the connection endpoint is in the reserved IPv6 address prefix. +The .Nm -will relay the connection. +utility will relay the connection. Otherwise, .Nm will invoke service-specific daemon like @@ -364,8 +371,9 @@ setting. 3ffe:501:ffff::/48 permit 0.0.0.0/0 .Ed .Sh RETURN VALUES +The .Nm -exits with +utility exits with .Dv EXIT_SUCCESS .Pq 0 on success, and @@ -388,7 +396,7 @@ on error. .Sh HISTORY The .Nm -command first appeared in WIDE Hydrangea IPv6 protocol stack kit. +utility first appeared in WIDE Hydrangea IPv6 protocol stack kit. .\" .Pp IPv6 and IPsec support based on the KAME Project (http://www.kame.net/) stack diff --git a/usr.sbin/getextattr/getextattr.8 b/usr.sbin/getextattr/getextattr.8 index 72c165f1ef63..b2798eb96832 100644 --- a/usr.sbin/getextattr/getextattr.8 +++ b/usr.sbin/getextattr/getextattr.8 @@ -41,8 +41,9 @@ .Ar attrname .Ar filename ... .Sh DESCRIPTION +The .Nm -is a user tool to retrieve a named extended attribute on a file or +utility is a user tool to retrieve a named extended attribute on a file or directory. The .Ar attrnamespace diff --git a/usr.sbin/gifconfig/gifconfig.8 b/usr.sbin/gifconfig/gifconfig.8 index b7762a3de8e6..4aaa094f152a 100644 --- a/usr.sbin/gifconfig/gifconfig.8 +++ b/usr.sbin/gifconfig/gifconfig.8 @@ -46,8 +46,9 @@ .Nm .Fl a .Sh DESCRIPTION +The .Nm -configures the physical address for the generic IP tunnel +utility configures the physical address for the generic IP tunnel inteface, such as "gif0". Argument .Ar physsrc @@ -78,8 +79,9 @@ just deletes the existing source and destination addresses on .Ar interface . If no outer addresses are specified, this usage has no effect. .Pp +The .Nm -takes the following optional argument: +utility takes the following optional argument: .Bl -tag -width Ds .It Fl a Display information associated with all @@ -153,7 +155,7 @@ The command exits with exit status of 1 on errors, 0 on success. .Sh HISTORY The .Nm -command first appeared in WIDE Hydrangea IPv6 protocol stack kit. +utility first appeared in WIDE Hydrangea IPv6 protocol stack kit. .Pp IPv6 and IPsec support based on the KAME Project (http://www.kame.net/) stack was initially integrated into diff --git a/usr.sbin/i4b/isdnd/isdnd.8 b/usr.sbin/i4b/isdnd/isdnd.8 index e1bd734e9869..42c01f179426 100644 --- a/usr.sbin/i4b/isdnd/isdnd.8 +++ b/usr.sbin/i4b/isdnd/isdnd.8 @@ -49,7 +49,9 @@ .Op Fl u Ar charging unit length .Op Fl m .Sh DESCRIPTION -.Nm Isdnd +The +.Nm +utility is the isdn4bsd package daemon which manages all ISDN related connection and disconnection of ISDN devices supported by the package. .Pp @@ -118,7 +120,7 @@ or will pop-up a command window. Because the .Nm -daemon will not listen to messages while the command window is active, +utility will not listen to messages while the command window is active, this command window will disappear automatically after 5 seconds without any command key press. .Pp @@ -206,7 +208,9 @@ file option .Em monitor-allowed . .El .Sh INTERACTION WITH THE KERNEL -.Nm Isdnd +The +.Nm +utility communicates with the kernel part of isdn4bsd by receiving status and event messages .Xr ( read 2 @@ -279,7 +283,7 @@ sends a .Em MSG_DIALOUT_IND to the .Nm -daemon. +utility. .Pp The daemon requests a new CDID from the kernel by using the .Em I4B_CDID_REQ @@ -390,8 +394,9 @@ isdnd -d0xf9 -F .Pp This will start isdnd with reasonable debugging settings and produce output on the current terminal. -.Nm Isdnd -can then be terminated by entering Control-C. +The +.Nm +utility can then be terminated by entering Control-C. .Pp Another example, the command: .Bd -literal -offset indent @@ -419,5 +424,5 @@ Still one or more left. .Sh AUTHORS The .Nm -daemon and this manual page were written by +utility and this manual page were written by .An Hellmuth Michaelis Aq hm@FreeBSD.org . diff --git a/usr.sbin/i4b/isdndebug/isdndebug.8 b/usr.sbin/i4b/isdndebug/isdndebug.8 index 0db47d00dc17..0eb9d923193c 100644 --- a/usr.sbin/i4b/isdndebug/isdndebug.8 +++ b/usr.sbin/i4b/isdndebug/isdndebug.8 @@ -49,8 +49,9 @@ .Op Fl C .Op Fl Q .Sh DESCRIPTION +The .Nm -is part of the isdn4bsd package and is used to control the level of +utility is part of the isdn4bsd package and is used to control the level of debugging output of the isdn4bsd kernel part. Every layer of the isdn4bsd kernel uses a debugging mask which can be manipulated using this utility. diff --git a/usr.sbin/i4b/isdndecode/isdndecode.8 b/usr.sbin/i4b/isdndecode/isdndecode.8 index 86b04968a86b..36c5b6fbd036 100644 --- a/usr.sbin/i4b/isdndecode/isdndecode.8 +++ b/usr.sbin/i4b/isdndecode/isdndecode.8 @@ -52,8 +52,9 @@ .Op Fl R Ar unit .Op Fl T Ar unit .Sh DESCRIPTION +The .Nm -is part of the isdn4bsd package and is used to provide the user with a +utility is part of the isdn4bsd package and is used to provide the user with a detailed mnemonic display of the layers 1, 2 and 3 protocol activities on the D channel and hex dump of the B channel(s) activities. .Pp diff --git a/usr.sbin/i4b/isdnmonitor/isdnmonitor.8 b/usr.sbin/i4b/isdnmonitor/isdnmonitor.8 index 9a102a74de24..5e6d5c3a9a88 100644 --- a/usr.sbin/i4b/isdnmonitor/isdnmonitor.8 +++ b/usr.sbin/i4b/isdnmonitor/isdnmonitor.8 @@ -43,8 +43,9 @@ .Op Fl l Ar pathname .Op Fl p Ar portspec .Sh DESCRIPTION -.Nm Isdnmonitor -is used to remotely monitor the operation of the isdn daemon, +The +.Nm +utility is used to remotely monitor the operation of the isdn daemon, .Xr isdnd 8 , which manages all ISDN related connection and disconnection of ISDN devices supported by the isdn4bsd package. diff --git a/usr.sbin/i4b/isdnphone/isdnphone.8 b/usr.sbin/i4b/isdnphone/isdnphone.8 index 7eb5ee61e1a9..879e05eab6b4 100644 --- a/usr.sbin/i4b/isdnphone/isdnphone.8 +++ b/usr.sbin/i4b/isdnphone/isdnphone.8 @@ -41,7 +41,9 @@ .Op Fl n Ar number .Op Fl u Ar unit .Sh DESCRIPTION +The .Nm +utility is part of the isdn4bsd package and is used to handle dialing and hangup for the telephone control interfaces .Pa /dev/i4bteld Ns Aq Ar n . diff --git a/usr.sbin/i4b/isdntel/isdntel.8 b/usr.sbin/i4b/isdntel/isdntel.8 index eef84505cb69..7e1ed50d8e53 100644 --- a/usr.sbin/i4b/isdntel/isdntel.8 +++ b/usr.sbin/i4b/isdntel/isdntel.8 @@ -41,8 +41,9 @@ .Op Fl p Ar playcommand .Op Fl t Ar timeout .Sh DESCRIPTION +The .Nm -is used to provide an "answering machine" functionality for incoming +utility is used to provide an "answering machine" functionality for incoming telephone voice messages. .Pp The following options are supported: diff --git a/usr.sbin/i4b/isdntelctl/isdntelctl.8 b/usr.sbin/i4b/isdntelctl/isdntelctl.8 index 7e5ac2460288..2078825f899d 100644 --- a/usr.sbin/i4b/isdntelctl/isdntelctl.8 +++ b/usr.sbin/i4b/isdntelctl/isdntelctl.8 @@ -43,7 +43,9 @@ .Op Fl U .Op Fl N .Sh DESCRIPTION +The .Nm +utility is part of the isdn4bsd package and is used to configure the sound format conversion facilities of the /dev/i4btel interfaces. .Pp diff --git a/usr.sbin/i4b/isdntest/isdntest.8 b/usr.sbin/i4b/isdntest/isdntest.8 index 172a0ff1b365..639a9ac54c50 100644 --- a/usr.sbin/i4b/isdntest/isdntest.8 +++ b/usr.sbin/i4b/isdntest/isdntest.8 @@ -44,13 +44,15 @@ .Op Fl t Ar num .Op Fl w .Sh DESCRIPTION +The .Nm -is part of the isdn4bsd package and may be used as a stimulation tool +utility is part of the isdn4bsd package and may be used as a stimulation tool for debugging the isdn4bsd kernel functionality. .Pp NOTE: -.Nm Isdntest -must be run +The +.Nm +utility must be run .Em instead of the .Xr isdnd 8 @@ -80,8 +82,9 @@ utility is currently of not much use for end users, it is primarily a debugging tool for development and is part of the release in the hope, that someone enhances it as a real self test and setup-verification tool! .Pp -.Nm Isdntest -does almost no error checking and error recovery, so unexpected +The +.Nm +utility does almost no error checking and error recovery, so unexpected hangs or crashes may occur. .Sh EXAMPLES For the following example, it is assumed that a machine with isdn4bsd @@ -98,8 +101,9 @@ isdntest -i 42 -o 42 .Pp will setup an outgoing call from that machine to itself, connect to itself and disconnect after 5 seconds. -.Nm Isdntest -has to be finished by the user by entering Control-C. +The +.Nm +utility has to be finished by the user by entering Control-C. .Sh FILES .Bl -tag -width indent .It Pa /dev/i4b diff --git a/usr.sbin/i4b/isdntrace/isdntrace.8 b/usr.sbin/i4b/isdntrace/isdntrace.8 index 4017dd10560a..2d06664a0583 100644 --- a/usr.sbin/i4b/isdntrace/isdntrace.8 +++ b/usr.sbin/i4b/isdntrace/isdntrace.8 @@ -55,8 +55,9 @@ .Op Fl R Ar unit .Op Fl T Ar unit .Sh DESCRIPTION +The .Nm -is part of the isdn4bsd package and is used to provide the user with a +utility is part of the isdn4bsd package and is used to provide the user with a mnemonic display of the layers 1, 2 and 3 protocol activities on the D channel and hex dump of the B channel(s) activities. .Pp @@ -171,7 +172,9 @@ of the 1TR6 protocol is included but not supported since i dont have any longer access to a 1TR6 based ISDN installation.) .El .Pp -.Nm Isdntrace +The +.Nm +utility automatically detects the layer 3 protocol being used by looking at the Protocol Discriminator (see: Q.931/1993 pp. 53). .Sh FILES diff --git a/usr.sbin/ifmcstat/ifmcstat.8 b/usr.sbin/ifmcstat/ifmcstat.8 index 5f5a37f174bf..cc2a92ea31c5 100644 --- a/usr.sbin/ifmcstat/ifmcstat.8 +++ b/usr.sbin/ifmcstat/ifmcstat.8 @@ -40,7 +40,7 @@ .Sh DESCRIPTION The .Nm -program dumps multicast group information from the kernel. +utility dumps multicast group information from the kernel. It is similar but not identical to the output from .Nm netstat Fl ina . .Pp diff --git a/usr.sbin/inetd/inetd.8 b/usr.sbin/inetd/inetd.8 index f9d70f2dd045..8dbbfe5f7e99 100644 --- a/usr.sbin/inetd/inetd.8 +++ b/usr.sbin/inetd/inetd.8 @@ -54,8 +54,7 @@ .Sh DESCRIPTION The .Nm -program -should be run at boot time by +utility should be run at boot time by .Pa /etc/rc (see .Xr rc 8 ) . @@ -353,7 +352,7 @@ use the .Dq nowait entry. Connection requests for these services are accepted by -.Nm , +.Nm Ns , and the server is given only the newly-accepted socket connected to a client of the service. Most stream-based services operate in this manner. @@ -524,8 +523,7 @@ instead of the name of the system as reported by .Pp The .Nm -program -also provides several other +utility also provides several other .Dq trivial services internally by use of routines within itself. These services are @@ -574,8 +572,7 @@ facility. .Pp The .Nm -program -rereads its configuration file when it receives a hangup signal, +utility rereads its configuration file when it receives a hangup signal, .Dv SIGHUP . Services may be added, deleted or modified when the configuration file is reread. @@ -862,7 +859,7 @@ field is invalid. .It "setsockopt(SO_PRIVSTATE): Operation not supported" The .Nm -program attempted to renounce the privileged state associated with a +utility attempted to renounce the privileged state associated with a socket but was unable to. .El .Sh SEE ALSO @@ -890,7 +887,7 @@ socket but was unable to. .Sh HISTORY The .Nm -command appeared in +utility appeared in .Bx 4.3 . TCPMUX is based on code and documentation by Mark Lottor. Support for diff --git a/usr.sbin/iostat/iostat.8 b/usr.sbin/iostat/iostat.8 index c93dcb4d51c9..9e38e929ea86 100644 --- a/usr.sbin/iostat/iostat.8 +++ b/usr.sbin/iostat/iostat.8 @@ -84,8 +84,9 @@ statistics .Op Fl w Ar wait .Op Ar drives .Sh DESCRIPTION -.Nm Iostat -displays kernel +The +.Nm +utility displays kernel .Tn I/O statistics on terminal, device and cpu operations. The first statistics that are printed are averaged over the system uptime. @@ -138,8 +139,9 @@ instead of the default Display up to .Ar devs number of devices. +The .Nm -will display fewer devices if there aren't +utility will display fewer devices if there aren't .Ar devs devices present. .It Fl N @@ -241,8 +243,9 @@ is specified, the default is infinity. Display a usage statement and exit. .El .Pp -.Nm Iostat -displays its information in the following format: +The +.Nm +utility displays its information in the following format: .Bl -tag -width flag .It tty .Bl -tag -width indent -compact @@ -254,7 +257,9 @@ characters written to terminals .It devices Device operations. The header of the field is the device name and unit number. +The .Nm +utility will display as many devices as will fit in a standard 80 column screen, or the maximum number of devices in the system, whichever is smaller. If @@ -267,7 +272,9 @@ To force .Nm to display specific drives, their names may be supplied on the command line. +The .Nm +utility will not display more devices than will fit in an 80 column screen, unless the .Fl n diff --git a/usr.sbin/jail/jail.8 b/usr.sbin/jail/jail.8 index 2abe498fcec6..0d4b03e6491a 100644 --- a/usr.sbin/jail/jail.8 +++ b/usr.sbin/jail/jail.8 @@ -45,7 +45,7 @@ .Sh DESCRIPTION The .Nm -command imprisons a process and all future descendants. +utility imprisons a process and all future descendants. .Pp Please see the .Xr jail 2 @@ -391,7 +391,7 @@ by setting this MIB entry to 1. .Sh HISTORY The .Nm -command appeared in +utility appeared in .Fx 4.0 . .Sh AUTHORS .An -nosplit diff --git a/usr.sbin/kernbb/kernbb.8 b/usr.sbin/kernbb/kernbb.8 index fa3b28774b16..0143de9a7dd1 100644 --- a/usr.sbin/kernbb/kernbb.8 +++ b/usr.sbin/kernbb/kernbb.8 @@ -40,8 +40,9 @@ .Sh SYNOPSIS .Nm .Sh DESCRIPTION -.Nm Kernbb -is a tool used to dump the basic-block profiling buffers of the running +The +.Nm +utility is used to dump the basic-block profiling buffers of the running kernel. .Pp At least one source file in the running kernel must have been compiled @@ -67,6 +68,6 @@ the default memory .Sh AUTHORS The .Nm -command was written by +utility was written by .An Poul-Henning Kamp , along with the kernel-support. diff --git a/usr.sbin/keyadmin/keyadmin.8 b/usr.sbin/keyadmin/keyadmin.8 index 4b3f374395cd..a125e9929bca 100644 --- a/usr.sbin/keyadmin/keyadmin.8 +++ b/usr.sbin/keyadmin/keyadmin.8 @@ -68,7 +68,7 @@ .Sh DESCRIPTION The .Nm -command is used to manually enter security associations into the kernel +utility is used to manually enter security associations into the kernel key/security association database. (See .Xr key 4 ) . .Pp @@ -220,10 +220,12 @@ An EOF will also end interaction with .Sh HISTORY The .Nm -command first appeared in NRL's +utility first appeared in NRL's .Bx 4.4 IPv6 networking distribution. -.Nm Keyadmin +The +.Nm +utility started its life as a pipe dream thought up by Dan McDonald, and came to life through the excruciating efforts of Ran Atkinson, Dan McDonald, Craig Metz, and Bao Phan. @@ -234,8 +236,9 @@ but was renamed to because of the conflict with .Xr key 1 . .Sh BUGS -.Nm Keyadmin -needs a -n flag like +The +.Nm +utility needs a -n flag like .Xr route 8 to avoid name lookups. .Pp diff --git a/usr.sbin/keyserv/keyserv.8 b/usr.sbin/keyserv/keyserv.8 index b54e5e4711b1..04cab067ec28 100644 --- a/usr.sbin/keyserv/keyserv.8 +++ b/usr.sbin/keyserv/keyserv.8 @@ -18,12 +18,14 @@ .Op Fl p Ar path .Op Fl v .Sh DESCRIPTION -.Nm Keyserv -is a daemon that is used for storing the +The +.Nm +utility is a daemon that is used for storing the private encryption keys of each user logged into the system. These encryption keys are used for accessing -secure network services such as secure NFS. +secure network services such as secure +.Tn NFS . .Pp Normally, root's key is read from the file .Pa /etc/.rootkey @@ -32,7 +34,7 @@ This is useful during power-fail reboots when no one is around to type a password. .Pp If a client with no secret key calls -.Nm , +.Nm Ns , then the key of user .Em nobody is used instead as the default key. @@ -44,7 +46,7 @@ Disable the use of default keys for .Em nobody . .It Fl D Run in debugging mode and log all requests to -.Nm . +.Nm Ns . .It Fl n Root's secret key is not read from .Pa /etc/.rootkey . @@ -68,7 +70,7 @@ Default is Display status of DES support (enabled/disabled). .El .Sh FILES -.Bl -tag -width /usr/lib/libdes.so.3. -compact +.Bl -tag -width /usr/lib/libdes.so.3 -compact .It Pa /etc/.rootkey .It Pa /usr/lib/libdes.so.3 .El diff --git a/usr.sbin/kgmon/kgmon.8 b/usr.sbin/kgmon/kgmon.8 index 8dc7881f0ad0..facffb7eb435 100644 --- a/usr.sbin/kgmon/kgmon.8 +++ b/usr.sbin/kgmon/kgmon.8 @@ -44,8 +44,9 @@ .Op Fl M core .Op Fl N system .Sh DESCRIPTION -.Nm Kgmon -is a tool used when profiling the operating system. +The +.Nm +utility is used when profiling the operating system. When no arguments are supplied, .Nm indicates the state of operating system profiling as running, @@ -128,5 +129,5 @@ inconsistent if profiling is in progress. .Sh HISTORY The .Nm -command appeared in +utility appeared in .Bx 4.2 . diff --git a/usr.sbin/kldxref/kldxref.8 b/usr.sbin/kldxref/kldxref.8 index bcbb3edc567d..3c03e25f15ae 100644 --- a/usr.sbin/kldxref/kldxref.8 +++ b/usr.sbin/kldxref/kldxref.8 @@ -40,7 +40,7 @@ .Sh DESCRIPTION The .Nm -command is used to generate hint files which list modules, their +utility is used to generate hint files which list modules, their version numbers, and the files that contain them. These hints are used by the kernel loader to determine where to find a particular KLD module. @@ -81,13 +81,13 @@ To build hint files for all installed kernels: .Sh HISTORY The .Nm -command first appeared in +utility first appeared in .Fx 5.0 . .Sh AUTHORS .An -nosplit The .Nm -command was implemented by +utility was implemented by .An Boris Popov Aq bp@FreeBSD.org . This manual page was written by .An Boris Popov Aq bp@FreeBSD.org diff --git a/usr.sbin/lastlogin/lastlogin.8 b/usr.sbin/lastlogin/lastlogin.8 index f2792b81b1e5..ce401ed69cb5 100644 --- a/usr.sbin/lastlogin/lastlogin.8 +++ b/usr.sbin/lastlogin/lastlogin.8 @@ -41,8 +41,9 @@ .Nm .Op Ar user ... .Sh DESCRIPTION +The .Nm -will list the last login session of each specified +utility will list the last login session of each specified .Ar user , or for all users by default. Each line of output contains the user name, the tty from which the session was conducted, any @@ -54,8 +55,9 @@ is given, the session information for each user is printed in the order given on the command line. Otherwise, information for all users is printed, sorted by uid. .Pp +The .Nm -differs from +utility differs from .Xr last 1 in that it only prints information regarding the very last login session. The last login database is never turned over or deleted in standard usage. diff --git a/usr.sbin/lpr/chkprintcap/chkprintcap.8 b/usr.sbin/lpr/chkprintcap/chkprintcap.8 index 44b47cb884fb..e026662d6445 100644 --- a/usr.sbin/lpr/chkprintcap/chkprintcap.8 +++ b/usr.sbin/lpr/chkprintcap/chkprintcap.8 @@ -37,8 +37,9 @@ .Op Fl d .Op Fl f Ar printcap .Sh DESCRIPTION -.Nm Chkprintcap -scans a +The +.Nm +utility scans a .Xr printcap 5 database (named by the @@ -60,8 +61,9 @@ No two printers share the same spool directory capability). .El .Pp -.Nm Chkprintcap -exits with a status equal to the number of errors encountered before +The +.Nm +utility exits with a status equal to the number of errors encountered before processing stopped. (In some cases, processing can stop before the entire file is scanned.) .Pp @@ -84,7 +86,7 @@ capability in the database (default 1, which corresponds to user .Sh AUTHORS The .Nm -command was written by +utility was written by .An Garrett A. Wollman Aq wollman@lcs.mit.edu . .Sh BUGS Not enough sanity-checking is done. At a minimum, the ownership and diff --git a/usr.sbin/lpr/lpc/lpc.8 b/usr.sbin/lpr/lpc/lpc.8 index aebbf0e56040..8d62b3ff738c 100644 --- a/usr.sbin/lpr/lpc/lpc.8 +++ b/usr.sbin/lpr/lpc/lpc.8 @@ -42,8 +42,9 @@ .Nm .Op Ar command Op Ar argument ... .Sh DESCRIPTION -.Nm Lpc -is used by the system administrator to control the +The +.Nm +utility is used by the system administrator to control the operation of the line printer system. For each line printer configured in .Pa /etc/printcap , @@ -225,5 +226,5 @@ you must be a member of group "operator" or root to execute this command .Sh HISTORY The .Nm -command appeared in +utility appeared in .Bx 4.2 . diff --git a/usr.sbin/lpr/lpd/lpd.8 b/usr.sbin/lpr/lpd/lpd.8 index f27b36e18e16..f9169dc1171d 100644 --- a/usr.sbin/lpr/lpd/lpd.8 +++ b/usr.sbin/lpr/lpd/lpd.8 @@ -43,7 +43,9 @@ .Op Fl cdlpsW46 .Op Ar port# .Sh DESCRIPTION -.Nm Lpd +The +.Nm +utility is the line printer daemon (spool area handler) and is normally invoked at boot time from the .Xr rc 8 @@ -256,13 +258,15 @@ If a file cannot be opened, a message will be logged via using the .Em LOG_LPR facility. -.Nm Lpd -will try up to 20 times +The +.Nm +utility will try up to 20 times to reopen a file it expects to be there, after which it will skip the file to be printed. .Pp -.Nm Lpd -uses +The +.Nm +utility uses .Xr flock 2 to provide exclusive access to the lock file and to prevent multiple daemons from becoming active simultaneously. If the daemon should be killed diff --git a/usr.sbin/lpr/pac/pac.8 b/usr.sbin/lpr/pac/pac.8 index 2c94214bae66..2d7bfe70e23b 100644 --- a/usr.sbin/lpr/pac/pac.8 +++ b/usr.sbin/lpr/pac/pac.8 @@ -48,8 +48,9 @@ .Op Fl r .Op Ar name ... .Sh DESCRIPTION -.Nm Pac -reads the printer/plotter accounting files, accumulating the number +The +.Nm +utility reads the printer/plotter accounting files, accumulating the number of pages (the usual case) or feet (for raster devices) of paper consumed by each user, and printing out how much each user consumed in pages or feet and dollars. @@ -103,5 +104,5 @@ as yet unknown. .Sh HISTORY The .Nm -command appeared in +utility appeared in .Bx 4.0 . diff --git a/usr.sbin/lptcontrol/lptcontrol.8 b/usr.sbin/lptcontrol/lptcontrol.8 index ec165cc49873..65d848b9f8d7 100644 --- a/usr.sbin/lptcontrol/lptcontrol.8 +++ b/usr.sbin/lptcontrol/lptcontrol.8 @@ -24,7 +24,7 @@ .Sh DESCRIPTION The .Nm -command is used to set either the interrupt-driven, extended or polling mode +utility is used to set either the interrupt-driven, extended or polling mode of individual .Xr lpt 4 devices. @@ -78,6 +78,6 @@ Sure to be some. .Sh HISTORY The .Nm -command +utility first appeared in .Fx 1.1.5 diff --git a/usr.sbin/mailwrapper/mailwrapper.8 b/usr.sbin/mailwrapper/mailwrapper.8 index 7f45e289b8e5..1e8c73d801ce 100644 --- a/usr.sbin/mailwrapper/mailwrapper.8 +++ b/usr.sbin/mailwrapper/mailwrapper.8 @@ -104,7 +104,7 @@ information in a read-only .Pp The .Nm -program is designed to replace +utility is designed to replace .Pa /usr/sbin/sendmail and to invoke an appropriate MTA instead of .Xr sendmail 8 @@ -122,8 +122,9 @@ is typically set up as a symbolic link to .Nm which is not usually invoked on its own. .Sh DIAGNOSTICS +The .Nm -will return an error value and print a diagnostic if its configuration +utility will return an error value and print a diagnostic if its configuration file is missing or malformed, or does not contain a mapping for the name under which .Nm @@ -135,8 +136,9 @@ was invoked. .Xr mailer.conf 5 , .Xr sendmail 8 .Sh HISTORY +The .Nm -first appeared in +utility first appeared in .Nx 1.4 and then .Fx 4.0 . diff --git a/usr.sbin/manctl/manctl.8 b/usr.sbin/manctl/manctl.8 index b244d30c2f54..b8e001dbc872 100644 --- a/usr.sbin/manctl/manctl.8 +++ b/usr.sbin/manctl/manctl.8 @@ -37,8 +37,9 @@ .Op Fl help .Ar path ... .Sh DESCRIPTION -.Nm Manctl -compress or uncompress manual pages in directory path. +The +.Nm +utility compress or uncompress manual pages in directory path. If possible, .so's are replaced with hard links. .Pp The following options are available: diff --git a/usr.sbin/memcontrol/memcontrol.8 b/usr.sbin/memcontrol/memcontrol.8 index 998d9cdce18d..989eb16f2cf2 100644 --- a/usr.sbin/memcontrol/memcontrol.8 +++ b/usr.sbin/memcontrol/memcontrol.8 @@ -55,14 +55,16 @@ A number of supported system architectures allow the behaviour of the CPU cache to be programmed to behave differently depending on the region being written. .Pp -.Nm Memcontrol +The +.Nm +utility provides an interface to this facility, allowing CPU cache behavior to be altered for ranges of system physical memory. .Pp These ranges are typically power-of-2 aligned and sized, however the specific rules governing their layout vary between architectures. The .Nm -program does not attempt to enforce these rules, however the system will +utility does not attempt to enforce these rules, however the system will reject any attempt to set an illegal combination. .Bl -tag -width clear .It Ar list diff --git a/usr.sbin/mergemaster/mergemaster.8 b/usr.sbin/mergemaster/mergemaster.8 index 3bb7558603e2..6675ff1e5af0 100644 --- a/usr.sbin/mergemaster/mergemaster.8 +++ b/usr.sbin/mergemaster/mergemaster.8 @@ -40,8 +40,9 @@ .Op Fl w Ar N .Op Fl D Ar /path .Sh DESCRIPTION +The .Nm -is a Bourne shell script which is designed to aid you +utility is a Bourne shell script which is designed to aid you in updating the various configuration and other files associated with .Fx . @@ -90,8 +91,9 @@ You can also specify that the script ignore the $Id strings and compare every file. .Pp +The .Nm -checks your umask and issues a warning for anything +utility checks your umask and issues a warning for anything other than 022. While it is not mandatory to grant world read permissions for most configuration files, you may run into problems without them. @@ -118,8 +120,9 @@ and file permissions as specified by the umask. Unified diffs are used by default to display any differences unless you choose context diffs. .Pp +The .Nm -will source scripts that you specify right before +utility will source scripts that you specify right before it starts the comparison, and after it's done running. The easiest way to handle this is to place the path to the script(s) in the appropriate variables in your @@ -225,7 +228,7 @@ Specify the destination directory for the installed files. .Sh ENVIRONMENT The .Nm -script uses the +utility uses the .Ev PAGER environment variable if set. Otherwise it uses @@ -277,8 +280,9 @@ comparison, use: .It Pa $HOME/.mergemasterrc .El .Pp +The .Nm -will . (source) these files if they exist. +utility will . (source) these files if they exist. Command line options will override rc file options. .Pa $HOME/.mergemasterrc @@ -361,7 +365,7 @@ Failure to populate the temporary root .Sh HISTORY The .Nm -script was first publicly available on one of my +utility was first publicly available on one of my web pages in a much simpler form under the name .Pa comproot on 13 March 1998. The idea for creating the diff --git a/usr.sbin/mixer/mixer.8 b/usr.sbin/mixer/mixer.8 index 9c725a868487..3f5a926b1bfc 100644 --- a/usr.sbin/mixer/mixer.8 +++ b/usr.sbin/mixer/mixer.8 @@ -53,7 +53,7 @@ .Sh DESCRIPTION The .Nm -command is used to set and display soundcard mixer device levels. +utility is used to set and display soundcard mixer device levels. It may also be used to start and stop recording from the soundcard. The list of mixer devices that may be modified are: @@ -136,7 +136,7 @@ the default mixer device .Sh HISTORY The .Nm -command first appeared in +utility first appeared in .Fx 2.0.5 . .Sh AUTHORS .An -nosplit diff --git a/usr.sbin/mld6query/mld6query.8 b/usr.sbin/mld6query/mld6query.8 index 8b2f7c05c127..cc361d03df10 100644 --- a/usr.sbin/mld6query/mld6query.8 +++ b/usr.sbin/mld6query/mld6query.8 @@ -44,8 +44,9 @@ .Op Ar maddr .\" .Sh DESCRIPTION +The .Nm -sends an IPv6 multicast listener discovery (MLD) query packet toward +utility sends an IPv6 multicast listener discovery (MLD) query packet toward the specified multicast address, .Ar maddr , toward interface @@ -82,8 +83,9 @@ The program exits with 0 on success, non-zero on failures. .Sh HISTORY The .Nm -command first appeared in WIDE/KAME IPv6 protocol stack kit. +utility first appeared in WIDE/KAME IPv6 protocol stack kit. .Sh BUGS -.Nm Mld6query -does not take care of multicast addresses which have non link-local +The +.Nm +utility does not take care of multicast addresses which have non link-local scope. diff --git a/usr.sbin/moused/moused.8 b/usr.sbin/moused/moused.8 index 2b0bc3b5cc88..bf665a88871e 100644 --- a/usr.sbin/moused/moused.8 +++ b/usr.sbin/moused/moused.8 @@ -57,9 +57,9 @@ .Fl p Ar port .Fl i Ar info .Sh DESCRIPTION -The mouse daemon +The .Nm -and the console driver work together to support +utility and the console driver work together to support mouse operation in the text console and user programs. They virtualize the mouse and provide user programs with mouse data in the standard format @@ -117,7 +117,7 @@ When the third button emulation is enabled (see above), the .Nm -daemon waits +utility waits .Ar timeout msec at most before deciding whether two buttons are being pressed simultaneously. @@ -127,7 +127,7 @@ Set the report rate (reports/sec) of the device if supported. .It Fl I Ar file Write the process id of the .Nm -daemon in the specified file. +utility in the specified file. Without this option, the process id will be stored in .Pa /var/run/moused.pid . .It Fl P @@ -137,7 +137,7 @@ If this option is given together with the .Fl i option, the .Nm -command will not be able to print useful information for the serial mouse. +utility will not be able to print useful information for the serial mouse. .It Fl R Lower RTS on the serial port. This option is valid only if @@ -195,7 +195,7 @@ data format standard. .It Ar model Mouse model. The .Nm -command may not always be able to identify the model. +utility may not always be able to identify the model. .It Ar all All of the above items. Print port, interface, type and model in this order in one line. @@ -203,7 +203,7 @@ in one line. .Pp If the .Nm -command cannot determine the requested information, it prints ``unknown'' +utility cannot determine the requested information, it prints ``unknown'' or ``generic''. .It Fl m Ar N=M Assign the physical button @@ -237,7 +237,7 @@ You may explicitly specify a type listed below, or use .Ar auto to let the .Nm -command to automatically select an appropriate protocol for the given +utility to automatically select an appropriate protocol for the given mouse. If you entirely ommit this options in the command line, .Fl t Ar auto @@ -245,7 +245,7 @@ is assumed. Under normal circumstances, you need to use this option only if the .Nm -command is not able to detect the protocol automatically +utility is not able to detect the protocol automatically (see the .Sx "Configuring Mouse Daemon" ) . .Pp @@ -278,7 +278,9 @@ For the serial mouse: .It Ar microsoft Microsoft serial mouse protocol. Most 2-button serial mice use this protocol. .It Ar intellimouse -Microsoft IntelliMouse protocol. Genius NetMouse, ASCII Mie Mouse, +Microsoft IntelliMouse protocol. Genius NetMouse, +.Tn ASCII +Mie Mouse, Logitech MouseMan+ and FirstMouse+ use this protocol too. Other mice with a roller/wheel may be compatible with this protocol. .It Ar mousesystems @@ -433,10 +435,10 @@ can easily distinguish which is your ``mouse'' port later. The next step is to guess the appropriate protocol type for the mouse. The .Nm -command may be able to automatically determine the protocol type. +utility may be able to automatically determine the protocol type. Run the .Nm -command with the +utility with the .Fl i option and see what it says. If the command can identify the protocol type, no further investigation is necessary on your part. @@ -462,7 +464,7 @@ If the .Fl i option yields nothing, you need to specify a protocol type to the .Nm -command by the +utility by the .Fl t option. You have to make a guess and try. @@ -565,7 +567,7 @@ USB mouse driver .It Pa /var/run/moused.pid process id of the currently running .Nm -daemon +utility .It Pa /var/run/MouseRemote UNIX-domain stream socket for X10 MouseRemote events .El @@ -574,7 +576,7 @@ UNIX-domain stream socket for X10 MouseRemote events .Pp Let the .Nm -command determine the protocol type of the mouse at the serial port +utility determine the protocol type of the mouse at the serial port .Pa /dev/cuaa0 . If successful, the command will print the type, otherwise it will say ``unknown''. @@ -584,7 +586,7 @@ If successful, the command will print the type, otherwise it will say .Pp If the .Nm -command is able to identify the protocol type of the mouse at the specified +utility is able to identify the protocol type of the mouse at the specified port automatically, you can start the daemon without the .Fl t option and enable the mouse pointer in the text console as above. @@ -614,7 +616,7 @@ and positive Z axis movement as the button 5 pressed. .Sh CAVEATS The .Nm -command does not currently work with the alternative console driver +utility does not currently work with the alternative console driver .Xr pcvt 4 . .Pp Many pad devices behave as if the first (left) button were pressed if @@ -653,7 +655,7 @@ option to assign the physical right button to the logical middle button: .Sh STANDARDS The .Nm -command partially supports +utility partially supports .Dq Plug and Play External COM Device Specification in order to support PnP serial mice. However, due to various degrees of conformance to the specification by @@ -666,7 +668,7 @@ for the given serial mouse. .An -nosplit The .Nm -command was written by +utility was written by .An Michael Smith Aq msmith@FreeBSD.org . This manual page was written by .An Mike Pritchard Aq mpp@FreeBSD.org . @@ -675,5 +677,5 @@ The command and manual page have since been updated by .Sh HISTORY The .Nm -command first appeared in +utility first appeared in .Fx 2.2 . diff --git a/usr.sbin/mrouted/map-mbone.8 b/usr.sbin/mrouted/map-mbone.8 index 526004279be0..a6e9e5841c27 100644 --- a/usr.sbin/mrouted/map-mbone.8 +++ b/usr.sbin/mrouted/map-mbone.8 @@ -16,14 +16,18 @@ .Op Fl t Ar timeout_count .Op Ar starting_router .Sh DESCRIPTION -.Nm Map-mbone +The +.Nm +utility attempts to display all multicast routers that are reachable from the multicast .Ar starting_router . If not specified on the command line, the default multicast .Ar starting_router is the localhost. .Pp -.Nm Map-mbone +The +.Nm +utility traverses neighboring multicast routers by sending the ASK_NEIGHBORS IGMP message to the multicast starting_router. If this multicast router responds, @@ -81,8 +85,9 @@ reply before retrying. Default timeout is 2 seconds. .El .Sh IMPORTANT NOTE -.Nm Map-mbone -must be run as root. +The +.Nm +utility must be run as root. .Sh SEE ALSO .Xr mrinfo 8 , .Xr mrouted 8 , diff --git a/usr.sbin/mrouted/mrinfo.8 b/usr.sbin/mrouted/mrinfo.8 index b06b4b948613..6e655a8ff435 100644 --- a/usr.sbin/mrouted/mrinfo.8 +++ b/usr.sbin/mrouted/mrinfo.8 @@ -13,12 +13,15 @@ .Op Fl t Ar timeout_count .Ar multicast_router .Sh DESCRIPTION -.Nm Mrinfo +The +.Nm +utility attempts to display the configuration information from the multicast router .Ar multicast_router . .Pp -.Nm Mrinfo -uses the ASK_NEIGHBORS IGMP message to the specified multicast router. +The +.Nm +utility uses the ASK_NEIGHBORS IGMP message to the specified multicast router. If this multicast router responds, the version number and a list of their neighboring multicast router addresses is part of that response. @@ -77,8 +80,9 @@ If the queried multicast router has a newer version number, the type (tunnel, srcrt) and status (disabled, down) of the connection is displayed. .Sh IMPORTANT NOTE -.Nm Mrinfo -must be run as root. +The +.Nm +utility must be run as root. .Sh SEE ALSO .Xr map-mbone 8 , .Xr mrouted 8 , diff --git a/usr.sbin/mrouted/mrouted.8 b/usr.sbin/mrouted/mrouted.8 index 695ae6429f9e..27a22563026a 100644 --- a/usr.sbin/mrouted/mrouted.8 +++ b/usr.sbin/mrouted/mrouted.8 @@ -14,15 +14,17 @@ .Op Fl d Op Ar debug_level .Op Fl p .Sh DESCRIPTION -.Nm Mrouted -is an implementation of the Distance-Vector Multicast Routing +The +.Nm +utility is an implementation of the Distance-Vector Multicast Routing Protocol (DVMRP), an earlier version of which is specified in RFC-1075. It maintains topological knowledge via a distance-vector routing protocol (like RIP, described in RFC-1058), upon which it implements a multicast datagram forwarding algorithm called Reverse Path Multicasting. .Pp -.Nm Mrouted -forwards a multicast datagram along a shortest (reverse) path tree +The +.Nm +utility forwards a multicast datagram along a shortest (reverse) path tree rooted at the subnet on which the datagram originates. The multicast delivery tree may be thought of as a broadcast delivery tree that has @@ -60,11 +62,14 @@ the purpose of multicasting only, which is independent of the physical internet, and which may span multiple Autonomous Systems. This capability is intended for experimental support of internet multicasting only, pending widespread support for multicast routing by the regular (unicast) routers. -.Nm Mrouted -suffers from the well-known scaling problems of any distance-vector +The +.Nm +utility suffers from the well-known scaling problems of any distance-vector routing protocol, and does not (yet) support hierarchical multicast routing. .Pp -.Nm Mrouted +The +.Nm +utility handles multicast routing only; there may or may not be unicast routing software running on the same machine as .Nm . @@ -131,8 +136,9 @@ writes its pid to the file .Pa /var/run/mrouted.pid . .El .Sh CONFIGURATION -.Nm Mrouted -automatically configures itself to forward on all multicast-capable +The +.Nm +utility automatically configures itself to forward on all multicast-capable interfaces, i.e., interfaces that have the IFF_MULTICAST flag set (excluding the loopback "interface"), and it finds other DVMRP routers directly reachable via those interfaces. To override the default configuration, or to add @@ -174,7 +180,9 @@ the time to recover from a reboot. For use in this situation, the prune_lifetime keyword may be specified on an interface as described below. .It noflood -.Nm Mrouted +The +.Nm +utility uses a DVMRP optimization to prevent having to keep individual routing tables for each neighbor; part of this optimization is that .Nm @@ -189,8 +197,7 @@ Turning on noflood can cause black holes on restart, which will generally last approximately one full route report interval. The noflood keyword can also be specified on individual interfaces. .It rexmit_prunes Ar [on|off] -.Nm Mrouted Ns 's -default is to retransmit prunes on all point-to-point interfaces +Default is to retransmit prunes on all point-to-point interfaces (including tunnels) but no multi-access interfaces. This option may be used to make the default on (or off) for all interfaces. The rexmit_prunes keyword can also be specified on individual interfaces. @@ -379,8 +386,9 @@ filters are only applied on input. Poison reverse routes are never filtered out. .El .Pp -.Nm Mrouted -will not initiate execution if it has fewer than two enabled vifs, +The +.Nm +utility will not initiate execution if it has fewer than two enabled vifs, where a vif (virtual interface) is either a physical multicast-capable interface or a tunnel. It will log a warning if all of its vifs are tunnels; such an @@ -426,8 +434,9 @@ tunnel 192.168.5.4 10.11.12.13 metric 1 threshold 32 boundary LOCAL boundary EE .Ed .Sh SIGNALS -.Nm Mrouted -responds to the following signals: +The +.Nm +utility responds to the following signals: .Bl -tag -width indent .It HUP Restarts @@ -515,8 +524,9 @@ the outgoing vif is connected to a leaf of the broadcast tree rooted at the origin, and a multicast datagram from that origin will be forwarded on that outgoing vif only if there are members of the destination group on that leaf. .Pp -.Nm Mrouted -also maintains a copy of the kernel forwarding cache table. +The +.Nm +utility also maintains a copy of the kernel forwarding cache table. Entries are created and deleted by .Nm . diff --git a/usr.sbin/mrouted/mtrace.8 b/usr.sbin/mrouted/mtrace.8 index f4d1a44733e1..e95b59dd2dbd 100644 --- a/usr.sbin/mrouted/mtrace.8 +++ b/usr.sbin/mrouted/mtrace.8 @@ -64,8 +64,9 @@ .Sh DESCRIPTION Assessing problems in the distribution of IP multicast traffic can be difficult. -.Nm Mtrace -utilizes a tracing feature implemented in multicast routers that is +The +.Nm +utility utilizes a tracing feature implemented in multicast routers that is accessed via an extension to the IGMP protocol. A trace query is passed hop-by-hop along the reverse path from the .Ar receiver @@ -212,7 +213,7 @@ seconds (default 3 seconds). .Ss "How It Works" The technique used by the .Nm traceroute -tool to trace unicast network paths will not work for IP multicast +utility to trace unicast network paths will not work for IP multicast because ICMP responses are specifically forbidden for multicast traffic. Instead, a tracing feature has been built into the multicast routers. This technique has the advantage that additional information about @@ -331,8 +332,9 @@ will try to query the next hop router with a DVMRP_ASK_NEIGHBORS2 request (as used by the .Nm mrinfo program) to see what kind of router it is. +The .Nm -will try to query three (changed with the +utility will try to query three (changed with the .Fl e option) hops past a non-responding router, in the hopes that even though it isn't capable of sending a response, it might be capable of diff --git a/usr.sbin/mtest/mtest.8 b/usr.sbin/mtest/mtest.8 index e988e8efe02b..5976dd116464 100644 --- a/usr.sbin/mtest/mtest.8 +++ b/usr.sbin/mtest/mtest.8 @@ -11,7 +11,9 @@ .Sh SYNOPSIS .Nm .Sh DESCRIPTION +The .Nm +utility is a small program for testing the multicast membership socket operations and ioctls. It accepts the following commands, interactively: .Bl -tag -width "a ifname e.e.e.e.e.e" -compact -offset indent diff --git a/usr.sbin/mtree/mtree.8 b/usr.sbin/mtree/mtree.8 index 6762edae4d59..c983544547b1 100644 --- a/usr.sbin/mtree/mtree.8 +++ b/usr.sbin/mtree/mtree.8 @@ -60,9 +60,9 @@ .Op Fl X Ar exclude-list .Ek .Sh DESCRIPTION -The utility +The .Nm -compares the file hierarchy rooted in the current directory against a +utility compares the file hierarchy rooted in the current directory against a specification read from the standard input. Messages are written to the standard output for any files whose characteristics do not match the specifications, or which are diff --git a/usr.sbin/ndp/ndp.8 b/usr.sbin/ndp/ndp.8 index 1f96902ab26f..f06ce4cf0da4 100644 --- a/usr.sbin/ndp/ndp.8 +++ b/usr.sbin/ndp/ndp.8 @@ -82,7 +82,7 @@ .Sh DESCRIPTION The .Nm -command manipulates the address mapping table +utility manipulates the address mapping table used by Neighbor Discovery Protocol (NDP). .Bl -tag -width Ds .It Fl a @@ -168,7 +168,7 @@ Most useful when used with .Sh RETURN VALUES The .Nm -command will exit with 0 on success, and non-zero on errors. +utility will exit with 0 on success, and non-zero on errors. .\" .Sh SEE ALSO .Xr arp 8 @@ -176,7 +176,7 @@ command will exit with 0 on success, and non-zero on errors. .Sh HISTORY The .Nm -command first appeared in WIDE Hydrangea IPv6 protocol stack kit. +utility first appeared in WIDE Hydrangea IPv6 protocol stack kit. .\" .\" .Sh BUGS .\" (to be written) diff --git a/usr.sbin/newsyslog/newsyslog.8 b/usr.sbin/newsyslog/newsyslog.8 index c2b253a864ed..4d282e18688a 100644 --- a/usr.sbin/newsyslog/newsyslog.8 +++ b/usr.sbin/newsyslog/newsyslog.8 @@ -30,8 +30,9 @@ .Op Fl a Ar directory .Op Ar .Sh DESCRIPTION -.Nm Newsyslog -is a program that should be scheduled to run periodically by +The +.Nm +utility should be scheduled to run periodically by .Xr cron 8 . When it is executed it archives log files if necessary. If a log file is determined to require archiving, diff --git a/usr.sbin/nghook/nghook.8 b/usr.sbin/nghook/nghook.8 index 48a0e511835e..d786a3adf00a 100644 --- a/usr.sbin/nghook/nghook.8 +++ b/usr.sbin/nghook/nghook.8 @@ -50,8 +50,9 @@ node .Ar path .Op Ar hookname .Sh DESCRIPTION +The .Nm -creates a +utility creates a .Xr ng_socket 4 socket type node and connects it to hook .Ar hookname @@ -66,8 +67,9 @@ is assumed. At this point all data written to standard input is sent to the node and all data received from the node is relayed to standard output. +The .Nm -exits when +utility exits when .Dv EOF is detected on standard input. .Pp @@ -85,8 +87,9 @@ Loops all received data back to the hook in addition to writing it to standard output. .It Fl n Don't attempt to read any data from standard input. +The .Nm -will continue reading from the node until stopped by a signal. +utility will continue reading from the node until stopped by a signal. .El .Sh BUGS Although all input is read in unbuffered mode, diff --git a/usr.sbin/ntp/doc/ntp-genkeys.8 b/usr.sbin/ntp/doc/ntp-genkeys.8 index 3af0f47b3c3e..7a1b116f2c4f 100644 --- a/usr.sbin/ntp/doc/ntp-genkeys.8 +++ b/usr.sbin/ntp/doc/ntp-genkeys.8 @@ -14,7 +14,9 @@ .Op Fl g Ar target .Op Fl k Ar keyfile .Sh DESCRIPTION -This program generates random keys used by either or both the +The +.Nm +utility generates random keys used by either or both the NTPv3/NTPv4 symmetric key or the NTPv4 public key (Autokey) cryptographic authentication schemes. .Pp @@ -105,7 +107,7 @@ the same security compartment. While the key identifiers for MD5 and DES keys must be in the range 1-65534, inclusive, the .Nm -program uses only the identifiers from 1 to +utility uses only the identifiers from 1 to 16. The key identifier for each association is specified as the key argument in the diff --git a/usr.sbin/ntp/doc/ntpd.8 b/usr.sbin/ntp/doc/ntpd.8 index f4107aafc98a..0f5646762ce2 100644 --- a/usr.sbin/ntp/doc/ntpd.8 +++ b/usr.sbin/ntp/doc/ntpd.8 @@ -25,7 +25,7 @@ .Sh DESCRIPTION The .Nm -program is an operating system daemon which sets +utility is an operating system daemon which sets and maintains the system time of day in synchronism with Internet standard time servers. It is a complete implementation of the @@ -33,8 +33,9 @@ Network Time Protocol (NTP) version 4, but also retains compatibility with version 3, as defined by RFC-1305, and version 1 and 2, as defined by RFC-1059 and RFC-1119, respectively. .Pp +The .Nm -does most computations in 64-bit floating point +utility does most computations in 64-bit floating point arithmetic and does relatively clumsy 64-bit fixed point operations only when necessary to preserve the ultimate precision, about 232 picoseconds. @@ -206,7 +207,7 @@ option. .Ss "How NTP Operates" The .Nm -program operates by exchanging messages with +utility operates by exchanging messages with one or more configured servers at designated poll intervals. When started, whether for the first or subsequent times, the program @@ -360,8 +361,9 @@ immediately. After that the current frequency offset is written to the file at hourly intervals. .Ss "Operating Modes" +The .Nm -can operate in any of several modes, including +utility can operate in any of several modes, including symmetric active/passive, client/server broadcast/multicast and manycast, as described in the .Qq Association Management @@ -574,8 +576,9 @@ A snapshot of this documentation is available in HTML format in .%O RFC1305 .Re .Sh BUGS +The .Nm -has gotten rather fat. +utility has gotten rather fat. While not huge, it has gotten larger than might be desirable for an elevated-priority .Nm diff --git a/usr.sbin/ntp/doc/ntpdate.8 b/usr.sbin/ntp/doc/ntpdate.8 index 7ff96da49200..139d7389b6dd 100644 --- a/usr.sbin/ntp/doc/ntpdate.8 +++ b/usr.sbin/ntp/doc/ntpdate.8 @@ -33,11 +33,12 @@ page. After a suitable period of mourning, the .Nm -program is to be retired from this +utility is to be retired from this distribution. .Pp +The .Nm -sets the local date and time by polling the +utility sets the local date and time by polling the Network Time Protocol (NTP) server(s) given as the .Ar server arguments to determine the correct time. @@ -167,8 +168,9 @@ version identification string to be logged. .El .Pp +The .Nm -can be run manually as necessary to set the +utility can be run manually as necessary to set the host clock, or it can be run from the host startup script to set the clock at boot time. This is useful in some cases to set the @@ -221,8 +223,9 @@ is run by every hour or two. .Pp +The .Nm -will decline to set the date if an NTP server +utility will decline to set the date if an NTP server daemon (e.g., .Xr ntpd 8 ) is running on the same host. diff --git a/usr.sbin/ntp/doc/ntpdc.8 b/usr.sbin/ntp/doc/ntpdc.8 index bca7479255e1..acc8990fb9f4 100644 --- a/usr.sbin/ntp/doc/ntpdc.8 +++ b/usr.sbin/ntp/doc/ntpdc.8 @@ -13,8 +13,9 @@ .Op Fl c Ar command .Op Ar host ... .Sh DESCRIPTION +The .Nm -is used to query the +utility is used to query the .Xr ntpd 8 daemon about its current state and to request changes in that state. @@ -81,19 +82,22 @@ will attempt to read commands from the standard input and execute these on the NTP server running on the first host given on the command line, again defaulting to localhost when no other host is specified. +The .Nm -will prompt for +utility will prompt for commands if the standard input is a terminal device. .Pp +The .Nm -uses NTP mode 7 packets to communicate with the +utility uses NTP mode 7 packets to communicate with the NTP server, and hence can be used to query any compatable server on the network which permits it. Note that since NTP is a UDP protocol this communication will be somewhat unreliable, especially over large distances in terms of network topology. +The .Nm -makes +utility makes no attempt to retransmit requests, and will time requests out if the remote host is not heard from within a suitable timeout time. @@ -107,7 +111,7 @@ daemon and can be expected to work only with this and maybe some previous versions of the daemon. Requests from a remote .Nm -program which affect the +utility which affect the state of the local server must be authenticated, which requires both the remote program and local server share a common key and key identifier. @@ -136,7 +140,7 @@ followed by a file name, to the command line. A number of interactive format commands are executed entirely within the .Nm -program itself and do not result in NTP +utility itself and do not result in NTP mode 7 requests being sent to a server. These are described following. @@ -709,8 +713,9 @@ See the source listing for further information. .%O RFC1305 .Re .Sh BUGS +The .Nm -is a crude hack. +utility is a crude hack. Much of the information it shows is deadly boring and could only be loved by its implementer. The diff --git a/usr.sbin/ntp/doc/ntpq.8 b/usr.sbin/ntp/doc/ntpq.8 index d47afbd1348c..6fc08c4109b8 100644 --- a/usr.sbin/ntp/doc/ntpq.8 +++ b/usr.sbin/ntp/doc/ntpq.8 @@ -15,7 +15,7 @@ .Sh DESCRIPTION The .Nm -utility program is used to query NTP servers +utility is used to query NTP servers which implement the recommended NTP mode 6 control message format about current state and to request changes in that state. The @@ -24,8 +24,9 @@ command line arguments. Requests to read and write arbitrary variables can be assembled, with raw and pretty-printed output options being available. +The .Nm -can also obtain and print a +utility can also obtain and print a list of peers in a common format by sending multiple queries to the server. .Pp @@ -42,19 +43,22 @@ will attempt to read commands from the standard input and execute these on the NTP server running on the first host given on the command line, again defaulting to localhost when no other host is specified. +The .Nm -will prompt for +utility will prompt for commands if the standard input is a terminal device. .Pp +The .Nm -uses NTP mode 6 packets to communicate with the +utility uses NTP mode 6 packets to communicate with the NTP server, and hence can be used to query any compatible server on the network which permits it. Note that since NTP is a UDP protocol this communication will be somewhat unreliable, especially over large distances in terms of network topology. +The .Nm -makes +utility makes one attempt to retransmit requests, and will time requests out if the remote host is not heard from within a suitable timeout time. @@ -119,7 +123,7 @@ A number of interactive format commands are executed entirely within the .Nm -program itself and do not result in NTP mode 6 +utility itself and do not result in NTP mode 6 requests being sent to a server. These are described following. .Bl -tag -width indent @@ -151,8 +155,9 @@ where the .Ql =value is ignored, and can be omitted, in requests to the server to read variables. +The .Nm -maintains an internal list in which data to be included in control +utility maintains an internal list in which data to be included in control messages can be assembled, and sent using the .Ic readlist and diff --git a/usr.sbin/ntp/doc/ntptime.8 b/usr.sbin/ntp/doc/ntptime.8 index 2572cdff57b9..f130307457f3 100644 --- a/usr.sbin/ntp/doc/ntptime.8 +++ b/usr.sbin/ntp/doc/ntptime.8 @@ -17,7 +17,9 @@ .Op Fl s Ar status .Op Fl t Ar time_constant .Sh DESCRIPTION -This program is useful only with special kernels +The +.Nm +utility is useful only with special kernels described in the .Qo A Kernel Model for Precision Timekeeping diff --git a/usr.sbin/ntp/doc/ntptrace.8 b/usr.sbin/ntp/doc/ntptrace.8 index c76288f746a2..82e1ff38e478 100644 --- a/usr.sbin/ntp/doc/ntptrace.8 +++ b/usr.sbin/ntp/doc/ntptrace.8 @@ -14,8 +14,9 @@ .Op Fl t Ar timeout .Op Ar server .Sh DESCRIPTION +The .Nm -determines where a given Network Time Protocol (NTP) server gets +utility determines where a given Network Time Protocol (NTP) server gets its time from, and follows the chain of NTP servers back to their master time source. If given no arguments, it starts with diff --git a/usr.sbin/pccard/pccardc/pccardc.8 b/usr.sbin/pccard/pccardc/pccardc.8 index 147e731e093b..5fcc941b29cf 100644 --- a/usr.sbin/pccard/pccardc/pccardc.8 +++ b/usr.sbin/pccard/pccardc/pccardc.8 @@ -39,10 +39,10 @@ .Ar subcommand .Op Ar arg ... .Sh DESCRIPTION +The .Nm -controls PC-CARD slots and configures and displays information about PCMCIA cards. -.Nm -understands the following subcommands: +utility controls PC-CARD slots and configures and displays information +about PCMCIA cards. It understands the following subcommands: .Pp .Bl -tag -width pccardmem -compact .It Ic beep diff --git a/usr.sbin/pccard/pccardd/pccardd.8 b/usr.sbin/pccard/pccardd/pccardd.8 index 266c9aeb352e..71523d4096a7 100644 --- a/usr.sbin/pccard/pccardd/pccardd.8 +++ b/usr.sbin/pccard/pccardd/pccardd.8 @@ -40,8 +40,9 @@ .Op Fl I .Op Fl f Ar configfile .Sh DESCRIPTION -.Nm Pccardd -is normally started at boot time, and manages the insertion +The +.Nm +utility is normally started at boot time, and manages the insertion and removal of PC-CARD cards. .Pp When started, @@ -52,8 +53,9 @@ which includes .Pa /etc/pccard.conf as the user configuration file) and scans the available PC-CARD slots for cards. -.Nm Pccardd -then waits for +The +.Nm +utility then waits for .Em "card events" , such as the insertion of a new card or the removal of a card. @@ -65,8 +67,9 @@ actions are taken: The kernel driver detects the card insertion and applies power to the card. .It -.Nm Pccardd -reads the +The +.Nm +utility reads the .Em CIS data from the attribute memory of the card, and uses the manufacturer name and card version to match @@ -171,8 +174,9 @@ process id of the currently running Developed by .An Andrew McRae Aq andrew@mega.com.au . .Sh BUGS -.Nm Pccardd -can set up card parameters, but cannot guarantee that +The +.Nm +utility can set up card parameters, but cannot guarantee that particular drivers can work with the card. .Pp Removing cards may cause problems if system resources diff --git a/usr.sbin/pciconf/pciconf.8 b/usr.sbin/pciconf/pciconf.8 index a632f7cf2972..cb9ed7fd74db 100644 --- a/usr.sbin/pciconf/pciconf.8 +++ b/usr.sbin/pciconf/pciconf.8 @@ -42,7 +42,7 @@ .Sh DESCRIPTION The .Nm -command provides a command line interface to the functionality provided by +utility provides a command line interface to the functionality provided by .Pa /dev/pci Ns 's .Xr ioctl 2 interface. @@ -175,7 +175,7 @@ This path can be overridden by setting the environment variable .Sh HISTORY The .Nm -command appeared first in +utility appeared first in .Fx 2.2 . The .Fl a @@ -187,7 +187,7 @@ KLD support in .An -nosplit The .Nm -facility was written by +utility was written by .An Stefan Esser and .An Garrett Wollman . @@ -197,7 +197,7 @@ The and .Fl h options are implemented in -.Nm , +.Nm Ns , but not in the underlying .Xr ioctl 2 . .Pp diff --git a/usr.sbin/pcvt/vgaio/vgaio.8 b/usr.sbin/pcvt/vgaio/vgaio.8 index 657eba26d40f..e7f3b246a615 100644 --- a/usr.sbin/pcvt/vgaio/vgaio.8 +++ b/usr.sbin/pcvt/vgaio/vgaio.8 @@ -45,7 +45,9 @@ .Op Fl d .Sh DESCRIPTION .Ss Purpose -.Nm Vgaio +The +.Nm +utility is used to perform register-level input/output on a Video Graphics Array. Since some of the sequences required to access those registers are very silly, diff --git a/usr.sbin/periodic/periodic.8 b/usr.sbin/periodic/periodic.8 index b350ee03292f..2753bee04185 100644 --- a/usr.sbin/periodic/periodic.8 +++ b/usr.sbin/periodic/periodic.8 @@ -36,7 +36,7 @@ .Sh DESCRIPTION The .Nm -program is intended to be called by +utility is intended to be called by .Xr cron 8 to execute shell scripts located in the specified directory. @@ -72,7 +72,7 @@ setting in .Pp The .Nm -program will run each executable file in the directory or directories +utility will run each executable file in the directory or directories specified. If a file does not have the executable bit set, it is silently ignored. .Pp @@ -142,7 +142,7 @@ is not set or is empty, output is sent to standard output. .Sh ENVIRONMENT The .Nm -command sets the +utility sets the .Ev PATH environment to include all standard system directories, but no additional directories, such as @@ -150,22 +150,22 @@ directories, such as If executables are added which depend upon other path components, each executable must be responsible for configuring its own appropriate environment. .Sh FILES -.Bl -tag -width ".Pa /etc/periodic.conf" +.Bl -tag -width ".Pa /etc/defaults/periodic.conf" .It Pa /etc/crontab -The +the .Nm -program is typically called via entries in the system default +utility is typically called via entries in the system default .Xr cron 8 -table. +table .It Pa /etc/periodic -The top level directory containing +the top level directory containing .Pa daily , .Pa weekly , and .Pa monthly -subdirectories which contain standard system periodic executables. +subdirectories which contain standard system periodic executables .It Pa /etc/defaults/periodic.conf -The +the .Pa periodic.conf system registry contains variables that control the behaviour of .Nm @@ -173,11 +173,11 @@ and the standard .Pa daily , weekly , and .Pa monthly -scripts. +scripts .It Pa /etc/periodic.conf -This file contains local overrides for the default +this file contains local overrides for the default .Nm -configuration. +configuration .El .Sh EXAMPLES The system crontab should have entries for @@ -236,7 +236,7 @@ Self explanatory. .Sh HISTORY The .Nm -program first appeared in +utility first appeared in .Fx 3.0 . .Sh BUGS Since one specifies information about a directory using shell diff --git a/usr.sbin/pppctl/pppctl.8 b/usr.sbin/pppctl/pppctl.8 index 1e90579d7a25..c51259168cde 100644 --- a/usr.sbin/pppctl/pppctl.8 +++ b/usr.sbin/pppctl/pppctl.8 @@ -19,13 +19,14 @@ .Sm on .Oc .Sh DESCRIPTION -This program provides command line control of the +This utility provides command line control of the .Xr ppp 8 daemon. Its primary use is to facilitate simple scripts that control a running daemon. .Pp -.Nm Pppctl -is passed at least one argument, specifying the socket on which +The +.Nm +utility is passed at least one argument, specifying the socket on which .Nm ppp is listening. Refer to the .Sq set server @@ -208,5 +209,5 @@ commands in .Sh HISTORY The .Nm -command first appeared in +utility first appeared in .Fx 2.2.5 . diff --git a/usr.sbin/prefix/prefix.8 b/usr.sbin/prefix/prefix.8 index b5b2e2f016c4..6ef6ea667d00 100644 --- a/usr.sbin/prefix/prefix.8 +++ b/usr.sbin/prefix/prefix.8 @@ -44,8 +44,9 @@ .Op Cm set | delete .Ek .Sh DESCRIPTION +The .Nm -is used to assign an prefix +utility is used to assign an prefix to a network interface. This command is currently just a frontend of .Xr ifconfig 8 , @@ -58,7 +59,7 @@ and is not recommended to be used. .Sh HISTORY The .Nm -command first appeared in WIDE/KAME IPv6 protocol stack kit. +utility first appeared in WIDE/KAME IPv6 protocol stack kit. Previously, this command was used to manipulate prefixes separately from interface identifiers, intending to be used for prefix renumbering. diff --git a/usr.sbin/procctl/procctl.8 b/usr.sbin/procctl/procctl.8 index 9058ac17211b..1add286472f4 100644 --- a/usr.sbin/procctl/procctl.8 +++ b/usr.sbin/procctl/procctl.8 @@ -11,7 +11,7 @@ .Sh DESCRIPTION The .Nm -command clears the +utility clears the .Xr procfs 5 event mask used by .Xr truss 1 . @@ -28,7 +28,7 @@ goes through the list and clears the event masks for each specified process. .Sh HISTORY The .Nm -command was written by +utility was written by .An Sean Eric Fagan for .Fx . diff --git a/usr.sbin/pstat/pstat.8 b/usr.sbin/pstat/pstat.8 index 66d486d9222a..d73c88db3d29 100644 --- a/usr.sbin/pstat/pstat.8 +++ b/usr.sbin/pstat/pstat.8 @@ -50,8 +50,9 @@ .Op Fl M Ar core .Op Fl N Ar system .Sh DESCRIPTION -.Nm Pstat -displays open file entry, swap space utilization, +The +.Nm +utility displays open file entry, swap space utilization, terminal state, and vnode data structures. .Pp If invoked as @@ -258,5 +259,5 @@ swap servers. .Sh HISTORY The .Nm -command appeared in +utility appeared in .Bx 4.0 . diff --git a/usr.sbin/pw/pw.8 b/usr.sbin/pw/pw.8 index 9be66b5dacdc..2b73f8a8664e 100644 --- a/usr.sbin/pw/pw.8 +++ b/usr.sbin/pw/pw.8 @@ -183,8 +183,9 @@ .Op Fl C Ar config .Op Fl q .Sh DESCRIPTION -.Nm Pw -is a command-line based editor for the system +The +.Nm +utility is a command-line based editor for the system .Ar user and .Ar group @@ -192,10 +193,15 @@ files, allowing the superuser an easy to use and standardized way of adding, modifying and removing users and groups. Note that .Nm -only operates on the local user and group files. NIS users and groups must be -maintained on the NIS server. -.Nm Pw -handles updating the +only operates on the local user and group files. +.Tn NIS +users and groups must be +maintained on the +.Tn NIS +server. +The +.Nm +utility handles updating the .Pa passwd , .Pa master.passwd , .Pa group @@ -289,10 +295,16 @@ to run .Xr make 1 after changing to the directory .Pa /var/yp . -This is intended to allow automatic updating of NIS database files. -If separate passwd and group files are being used by NIS, then use the +This is intended to allow automatic updating of +.Tn NIS +database files. +If separate passwd and group files are being used by +.Tn NIS , +then use the .Fl y Ar path -option to specify the location of the NIS passwd database so that +option to specify the location of the +.Tn NIS +passwd database so that .Nm will concurrently update it with the system password databases. @@ -385,7 +397,7 @@ Set the account's primary group to the given group. .Ar group may be defined by either its name or group number. .It Fl G Ar grouplist -Sets additional group memberships for an account. +Set additional group memberships for an account. .Ar grouplist is a comma-separated list of group names or group numbers. The user's name is added to the group lists in @@ -629,11 +641,16 @@ method requires that the superuser use .Xr passwd 1 to render the account accessible with a password. .It Fl y Ar path -This sets the pathname of the database used by NIS if you are not sharing +This sets the pathname of the database used by +.Tn NIS +if you are not sharing the information from .Pa /etc/master.passwd -directly with NIS. -You should only set this option for NIS servers. +directly with +.Tn NIS . +You should only set this option for +.Tn NIS +servers. .El .Pp The @@ -650,8 +667,9 @@ The additional option is: This tells .Nm to remove the user's home directory and all of its contents. -.Nm Pw -errs on the side of caution when removing files from the system. +The +.Nm +utility errs on the side of caution when removing files from the system. Firstly, it will not do so if the uid of the account being removed is also used by another account on the system, and the 'home' directory in the password file is a valid path that commences with the character @@ -775,7 +793,9 @@ The command .Ar groupnext returns the next available group id on standard output. .Sh USER LOCKING -.Nm Pw +The +.Nm +utility supports a simple password locking mechanism for users; it works by prepending the string .Ql *LOCKED* @@ -795,8 +815,9 @@ and .Fl q options as described above are accepted by these commands. .Sh DIAGNOSTICS -.Nm Pw -returns EXIT_SUCCESS on successful operation, otherwise +The +.Nm +utility returns EXIT_SUCCESS on successful operation, otherwise .Nm returns one of the following exit codes defined by @@ -871,8 +892,9 @@ For example, .Dl pw useradd help lists all available options for the useradd operation. .Pp -.Nm Pw -allows 8-bit characters in the passwd GECOS field (user's full name, +The +.Nm +utility allows 8-bit characters in the passwd GECOS field (user's full name, office, work and home phone number subfields), but disallows them in user login and group names. Use 8-bit characters with caution, as connection to the Internet will @@ -919,8 +941,9 @@ Pw default options file .Xr pwd_mkdb 8 , .Xr vipw 8 .Sh HISTORY -.Nm Pw -was written to mimic many of the options used in the SYSV +The +.Nm +utility was written to mimic many of the options used in the SYSV .Em shadow support suite, but is modified for passwd and group fields specific to the diff --git a/usr.sbin/pwd_mkdb/pwd_mkdb.8 b/usr.sbin/pwd_mkdb/pwd_mkdb.8 index 55be90b9a030..670c9420ceed 100644 --- a/usr.sbin/pwd_mkdb/pwd_mkdb.8 +++ b/usr.sbin/pwd_mkdb/pwd_mkdb.8 @@ -48,8 +48,9 @@ .Op Fl u Ar username .Ar file .Sh DESCRIPTION -.Nm Pwd_mkdb -creates +The +.Nm +utility creates .Xr db 3 style secure and insecure databases for the specified file. These databases are then installed into @@ -102,8 +103,9 @@ encrypted password and the insecure version has an asterisk (``*'') The databases are used by the C library password routines (see .Xr getpwent 3 ) . .Pp -.Nm Pwd_mkdb -exits zero on success, non-zero on failure. +The +.Nm +utility exits zero on success, non-zero on failure. .Sh ENVIRONMENT If the .Ev PW_SCAN_BIG_IDS diff --git a/usr.sbin/quot/quot.8 b/usr.sbin/quot/quot.8 index 238c869a0148..d4199fe11678 100644 --- a/usr.sbin/quot/quot.8 +++ b/usr.sbin/quot/quot.8 @@ -40,7 +40,9 @@ .Op Fl acfhknv .Op Ar filesystem ... .Sh DESCRIPTION -.Nm Quot +The +.Nm +utility is used to gather statistics about the disk usage for each local user. .Pp The following options are available: diff --git a/usr.sbin/quotaon/quotaon.8 b/usr.sbin/quotaon/quotaon.8 index cdf260e6027d..926a8c88fea8 100644 --- a/usr.sbin/quotaon/quotaon.8 +++ b/usr.sbin/quotaon/quotaon.8 @@ -63,17 +63,21 @@ .Op Fl v .Fl a .Sh DESCRIPTION -.Nm Quotaon +The +.Nm +utility announces to the system that disk quotas should be enabled on one or more filesystems. -.Nm Quotaoff -announces to the system that the specified +The +.Nm quotaoff +utility announces to the system that the specified filesystems should have any disk quotas turned off. The filesystems specified must have entries in .Pa /etc/fstab and be mounted. -.Nm Quotaon -expects each filesystem to have quota files named +The +.Nm +utility expects each filesystem to have quota files named .Pa quota.user and .Pa quota.group @@ -133,5 +137,5 @@ filesystem table .Sh HISTORY The .Nm -command appeared in +utility appeared in .Bx 4.2 . diff --git a/usr.sbin/rarpd/rarpd.8 b/usr.sbin/rarpd/rarpd.8 index 73f44a6fba0d..cbc61e01d701 100644 --- a/usr.sbin/rarpd/rarpd.8 +++ b/usr.sbin/rarpd/rarpd.8 @@ -31,8 +31,9 @@ .Op Fl t Ar directory .Op Ar interface .Sh DESCRIPTION +The .Nm -services Reverse ARP requests on the Ethernet connected to +utility services Reverse ARP requests on the Ethernet connected to .Ar interface . Upon receiving a request, .Nm @@ -132,8 +133,9 @@ and .An Steven McCanne Aq mccanne@ee.lbl.gov . Lawrence Berkeley Laboratory, University of California, Berkeley, CA. .Sh BUGS +The .Nm -can depend on the DNS to resolve the name discovered from +utility can depend on the DNS to resolve the name discovered from .Pa /etc/ethers . If this name is not in the DNS but is in .Pa /etc/hosts , diff --git a/usr.sbin/raycontrol/raycontrol.8 b/usr.sbin/raycontrol/raycontrol.8 index 4bbaef86fd7c..9cbe5a2edf65 100644 --- a/usr.sbin/raycontrol/raycontrol.8 +++ b/usr.sbin/raycontrol/raycontrol.8 @@ -96,7 +96,7 @@ .Sh DESCRIPTION The .Nm -command controls the operation of Raylink/Webgear wireless networking +utility controls the operation of Raylink/Webgear wireless networking devices via the .Xr ray 4 driver. @@ -108,7 +108,7 @@ or infrastructure mode, and the network name of a service set to join - the BSS in ad-hoc mode or ESS if infrastructure mode is enabled. The .Nm -command can also be used to view the current settings of these parameters +utility can also be used to view the current settings of these parameters and to dump out the values of the card's statistics counters. .Pp The @@ -116,7 +116,7 @@ The argument given to .Nm should be the logical interface name associated with the Raylink/Webgear -device (ray0, ray1, etc...). +device (ray0, ray1, ...). .Sh OPTIONS The options are as follows: .Bl -tag -width Fl @@ -169,7 +169,7 @@ are 0 (ad-hoc mode) and 1 (infrastructure mode). In ad-hoc mode, the station can communicate directly with any other stations within direct radio range (provided that they are also operating in ad-hoc mode). -In inrastructure mode, +In infrastructure mode, hosts must associate with a service set controlled by an access point, that relays traffic between end stations. The default setting is 0 @@ -254,11 +254,11 @@ is specified in milliseconds. The default is 100. .It Fl i Ar iface Fl Z Clear the signal strength cache maintained internally by the -.Nm ray +.Xr ray 4 driver. .It Fl i Ar iface Fl C Display the cached signal strength information maintained by the -.Nm ray +.Xr ray 4 driver. The driver retains information about signal strength and noise level for packets received from different hosts. @@ -275,17 +275,17 @@ transmitting. .Sh HISTORY The .Nm -command first appeared in +utility first appeared in .Fx 4.0 . .Sh AUTHORS .An -nosplit The .Nm -command was written by +utility was written by .An Duncan Barclay Aq dmlb@ragnet.demon.co.uk and based on the .Nm wicontrol -command by +utility by .An Bill Paul Aq wpaul@ctr.columbia.edu . .Sh BUGS The diff --git a/usr.sbin/repquota/repquota.8 b/usr.sbin/repquota/repquota.8 index b92e20661670..c33daf016703 100644 --- a/usr.sbin/repquota/repquota.8 +++ b/usr.sbin/repquota/repquota.8 @@ -53,8 +53,9 @@ .Op Fl v .Fl a .Sh DESCRIPTION -.Nm Repquota -prints a summary of the disk usage and quotas for the +The +.Nm +utility prints a summary of the disk usage and quotas for the specified filesystems. .Pp Available options: @@ -100,5 +101,5 @@ Various messages about inaccessible files; self-explanatory. .Sh HISTORY The .Nm -command appeared in +utility appeared in .Bx 4.2 . diff --git a/usr.sbin/rip6query/rip6query.8 b/usr.sbin/rip6query/rip6query.8 index 210234f7810c..931aa466db4b 100644 --- a/usr.sbin/rip6query/rip6query.8 +++ b/usr.sbin/rip6query/rip6query.8 @@ -43,8 +43,9 @@ .Ar destination .\" .Sh DESCRIPTION +The .Nm -requests remote RIPng daemon on +utility requests remote RIPng daemon on .Ar destination to dump RIPng routing information. .Fl I @@ -60,4 +61,4 @@ and is useful when link-local address is specified for .Sh HISTORY The .Nm -command first appeared in WIDE Hydrangea IPv6 protocol stack kit. +utility first appeared in WIDE Hydrangea IPv6 protocol stack kit. diff --git a/usr.sbin/rmt/rmt.8 b/usr.sbin/rmt/rmt.8 index 824d7258b676..e686173c57bb 100644 --- a/usr.sbin/rmt/rmt.8 +++ b/usr.sbin/rmt/rmt.8 @@ -41,12 +41,11 @@ .Sh SYNOPSIS .Nm .Sh DESCRIPTION -.Nm Rmt -is a program used by the remote dump and restore programs +The +.Nm +utility is used by the remote dump and restore programs in manipulating a magnetic tape drive through an interprocess -communication connection. -.Nm Rmt -is normally started up with an +communication connection. It is normally started up with an .Xr rexec 3 or .Xr rcmd 3 @@ -54,7 +53,7 @@ call. .Pp The .Nm -program accepts requests specific to the manipulation of +utility accepts requests specific to the manipulation of magnetic tapes, performs the commands, then responds with a status indication. All responses are in .Tn ASCII @@ -138,8 +137,9 @@ call. .It Sy W Ar count No \en .Sm on Write data onto the open device. -.Nm Rmt -reads +The +.Nm +utility reads .Ar count bytes from the connection, aborting if a premature end-of-file is encountered. @@ -157,8 +157,9 @@ If .Ar count exceeds the size of the data buffer (10 kilobytes), it is truncated to the data buffer size. -.Nm Rmt -then performs the requested +The +.Nm +utility then performs the requested .Xr read 2 and responds with .Sm off @@ -217,5 +218,5 @@ file access protocol. .Sh HISTORY The .Nm -command appeared in +utility appeared in .Bx 4.2 . diff --git a/usr.sbin/route6d/route6d.8 b/usr.sbin/route6d/route6d.8 index b24e84e19e1a..015e8c7a9c71 100644 --- a/usr.sbin/route6d/route6d.8 +++ b/usr.sbin/route6d/route6d.8 @@ -48,7 +48,7 @@ .Sh DESCRIPTION The .Nm -is a routing daemon which supports RIP over IPv6. +utility is a routing daemon which supports RIP over IPv6. .Pp Options are: .Bl -tag -width indent @@ -78,8 +78,9 @@ and advertises the aggregated route .Ar prefix/preflen , to the interfaces specified in the comma-separated interface list, .Ar if1[,if2...] . +The .Nm -creates a static route to +utility creates a static route to .Ar prefix/preflen with .Dv RTF_REJECT @@ -122,8 +123,9 @@ option assumes that all interfaces are in the same site. .It Fl L Ar prefix/preflen,if1[,if2...] Filter incoming routes from interfaces .Ar if1,[if2...] . +The .Nm -will accept incoming routes that are in +utility will accept incoming routes that are in .Ar prefix/preflen . If multiple .Fl L @@ -224,8 +226,9 @@ or .Re .\" .Sh NOTE +The .Nm -uses IPv6 advanced API, +utility uses IPv6 advanced API, defined in RFC2292, for communicating with peers using link-local addresses. .Pp diff --git a/usr.sbin/rpc.lockd/rpc.lockd.8 b/usr.sbin/rpc.lockd/rpc.lockd.8 index 92640503a54c..da2ad7426466 100644 --- a/usr.sbin/rpc.lockd/rpc.lockd.8 +++ b/usr.sbin/rpc.lockd/rpc.lockd.8 @@ -46,7 +46,7 @@ .Sh DESCRIPTION The .Nm -daemon provides monitored and unmonitored file and record locking services +utility provides monitored and unmonitored file and record locking services in an NFS environment. To monitor the status of hosts requesting locks, the locking daemon typically operates in conjunction @@ -93,7 +93,7 @@ and facility .Pp The .Nm -daemon must NOT be invoked by +utility must NOT be invoked by .Xr inetd 8 because the protocol assumes that the daemon will run from system start time. Instead, it should be configured in diff --git a/usr.sbin/rpc.statd/rpc.statd.8 b/usr.sbin/rpc.statd/rpc.statd.8 index 901735ed5a5a..730f1951e3e0 100644 --- a/usr.sbin/rpc.statd/rpc.statd.8 +++ b/usr.sbin/rpc.statd/rpc.statd.8 @@ -43,8 +43,12 @@ .Nm .Op Fl d .Sh DESCRIPTION -.Nm Rpc.statd -is a daemon which co-operates with rpc.statd daemons on other hosts to provide +The +.Nm +utility +is a daemon which co-operates with +.Nm +daemons on other hosts to provide a status monitoring service. The daemon accepts requests from programs running on the local host (typically, .Xr rpc.lockd 8 , @@ -68,7 +72,7 @@ of this option, using level LOG_ERR. .Pp The .Nm -daemon must NOT be invoked by +utility must NOT be invoked by .Xr inetd 8 because the protocol assumes that the daemon will run from system start time. Instead, it should be run from diff --git a/usr.sbin/rpc.umntall/rpc.umntall.8 b/usr.sbin/rpc.umntall/rpc.umntall.8 index 2aa128e1ae1a..6a634c4c7d25 100644 --- a/usr.sbin/rpc.umntall/rpc.umntall.8 +++ b/usr.sbin/rpc.umntall/rpc.umntall.8 @@ -39,8 +39,9 @@ .Op Fl p Ar remotepath .Op Fl v .Sh DESCRIPTION +The .Nm -is as command as proposed in the +utility is proposed in the .Tn NFS RPC specification; see .Rs @@ -58,7 +59,7 @@ This ensures that does not display old and expired entries. The .Nm -command +utility is only needed on client side, where .Xr mount_nfs 8 adds a mount entry with the current date to @@ -68,7 +69,7 @@ and removes the entry again. The .Nm -command +utility cares about all remaining entries in this table which result from crashes or unproper shutdowns. .Pp @@ -115,7 +116,7 @@ mounted nfs-filesystems .Sh HISTORY The .Nm -command first appeared in +utility first appeared in .Fx 4.0 . .Sh SEE ALSO .Xr mountd 8 , diff --git a/usr.sbin/rpc.yppasswdd/rpc.yppasswdd.8 b/usr.sbin/rpc.yppasswdd/rpc.yppasswdd.8 index 46877c140430..0da25ee209c2 100644 --- a/usr.sbin/rpc.yppasswdd/rpc.yppasswdd.8 +++ b/usr.sbin/rpc.yppasswdd/rpc.yppasswdd.8 @@ -52,13 +52,15 @@ .Sh DESCRIPTION The .Nm -daemon allows users to change their NIS passwords and certain +utility allows users to change their NIS passwords and certain other information using the .Xr yppasswd 1 and .Xr ypchpass 1 commands. -.Nm Rpc.yppasswdd +The +.Nm +utility is an RPC-based server that accepts incoming password change requests, authenticates them, places the updated information in the .Pa /var/yp/master.passwd @@ -70,7 +72,7 @@ maps. .Pp The .Nm -server allows a normal NIS user to change +utility allows a normal NIS user to change his or her NIS password, full name (also known as 'GECOS' field) or shell. These updates are typically done using @@ -93,7 +95,7 @@ rules outlined in .Xr ypserv 8 manual page for more information on securenets; the .Nm -server uses the same access control mechanism as +utility uses the same access control mechanism as .Xr ypserv 8 . ) .Pp The server then @@ -133,7 +135,7 @@ the network. .Pp The .Nm -daemon can only be run on a machine that is an NIS master server. +utility can only be run on a machine that is an NIS master server. .Sh OPTIONS The following options are available: .Bl -tag -width indent @@ -161,7 +163,7 @@ maps. .It Fl d Ar domain The .Nm -server can support multiple domains, however it must +utility can support multiple domains, however it must choose one domain as a default. It will try to use the system default domain name as set by the .Xr domainname 1 diff --git a/usr.sbin/rpc.ypxfrd/rpc.ypxfrd.8 b/usr.sbin/rpc.ypxfrd/rpc.ypxfrd.8 index fc25ca6b7dca..844a585c6e71 100644 --- a/usr.sbin/rpc.ypxfrd/rpc.ypxfrd.8 +++ b/usr.sbin/rpc.ypxfrd/rpc.ypxfrd.8 @@ -42,7 +42,7 @@ .Sh DESCRIPTION The .Nm -daemon is used to speed up the distribtion of very large NIS maps +utility is used to speed up the distribtion of very large NIS maps from NIS master to NIS slave servers. The normal method for transfering maps involves several steps: @@ -87,7 +87,7 @@ and .Pp The .Nm -server speeds up the transfer process by allowing NIS slave servers to +utility speeds up the transfer process by allowing NIS slave servers to simply copy the master server's map files rather than building their own from scratch. Simply put, @@ -100,7 +100,7 @@ to build a new map from scratch. .Pp The .Nm -server uses the same access restriction mechanism as +utility uses the same access restriction mechanism as .Xr ypserv 8 . This means that slave servers will only be permitted to transfer files if the rules in the diff --git a/usr.sbin/rpcbind/rpcbind.8 b/usr.sbin/rpcbind/rpcbind.8 index 42d0579e7e37..8418cb10eda5 100644 --- a/usr.sbin/rpcbind/rpcbind.8 +++ b/usr.sbin/rpcbind/rpcbind.8 @@ -12,8 +12,9 @@ .Nm .Op Fl dilLs .Sh DESCRIPTION +The .Nm -is a server that converts +utility is a server that converts .Tn RPC program numbers into universal addresses. @@ -41,8 +42,9 @@ the address where .Tn RPC requests should be sent. .Pp +The .Nm -should be started before any other RPC service. +utility should be started before any other RPC service. Normally, standard .Tn RPC servers are started by port monitors, so @@ -60,8 +62,9 @@ services cannot function correctly in this situation, .Nm reports the condition and terminates. .Pp +The .Nm -can only be started by the super-user. +utility can only be started by the super-user. .Sh OPTIONS .Bl -tag -width indent .It Fl d @@ -98,7 +101,7 @@ to the list. .It Fl i .Dq Insecure mode. -Allows calls to SET and UNSET from any host. +Allow calls to SET and UNSET from any host. Normally .Nm accepts these requests only from the loopback interface for security reasons. @@ -106,9 +109,9 @@ This change is necessary for programs that were compiled with earlier versions of the rpc library and do not make those requests using the loopback interface. .It Fl l -Turns on libwrap connection logging. +Turn on libwrap connection logging. .It Fl s -Causes +Cause .Nm to change to the user daemon as soon as possible. This causes diff --git a/usr.sbin/rrenumd/rrenumd.8 b/usr.sbin/rrenumd/rrenumd.8 index 09e308987a91..3ad9a3c3521c 100644 --- a/usr.sbin/rrenumd/rrenumd.8 +++ b/usr.sbin/rrenumd/rrenumd.8 @@ -42,8 +42,9 @@ .Fl c Ar conf_file | Fl s .Oc .Sh DESCRIPTION +The .Nm -transmits router renumbering request packets, +utility transmits router renumbering request packets, to renumber the routers in the site network. .Pp On KAME-based systems, @@ -97,6 +98,6 @@ The program exits with 0 on success, and non-zero on failures. .Sh HISTORY The .Nm -command first appeared in KAME IPv6 protocol stack kit. +utility first appeared in KAME IPv6 protocol stack kit. .\" .Sh BUGS .\" (to be written) diff --git a/usr.sbin/rtadvd/rtadvd.8 b/usr.sbin/rtadvd/rtadvd.8 index 519d73515765..4edb19fa3c37 100644 --- a/usr.sbin/rtadvd/rtadvd.8 +++ b/usr.sbin/rtadvd/rtadvd.8 @@ -40,8 +40,9 @@ .Op Fl c Ar configfile .Ar interface ... .Sh DESCRIPTION +The .Nm -sends router advertisement packets to the specified +utility sends router advertisement packets to the specified .Ar interfaces . .Pp The program will daemonize itself on invocation. @@ -61,8 +62,9 @@ In particular, reads all the interface routes from the routing table and advertises them as on-link prefixes. .Pp +The .Nm -also watches the routing table. +utility also watches the routing table. If an interface direct route is added on an advertising interface and no static prefixes are specified by the configuration file, @@ -188,7 +190,7 @@ dumps its internal state. .Sh HISTORY The .Nm -command first appeared in WIDE Hydrangea IPv6 protocol stack kit. +utility first appeared in WIDE Hydrangea IPv6 protocol stack kit. .Sh CAVEAT There used to be some text that recommended users not to let .Nm diff --git a/usr.sbin/rtsold/rtsold.8 b/usr.sbin/rtsold/rtsold.8 index f148694da5ee..abefea5a56c9 100644 --- a/usr.sbin/rtsold/rtsold.8 +++ b/usr.sbin/rtsold/rtsold.8 @@ -52,8 +52,9 @@ .Fl a .\" .Sh DESCRIPTION +The .Nm -is the daemon program to send ICMPv6 Router Solicitation messages +utility is the daemon program to send ICMPv6 Router Solicitation messages on the specified interfaces. If a node (re)attaches to a link, .Nm @@ -61,8 +62,9 @@ sends some Router Solicitations on the link destined to the link-local scope all-routers multicast address to discover new routers and to get non link-local addresses. .Pp +The .Nm -should be used on IPv6 hosts +utility should be used on IPv6 hosts (non-router nodes) only. .Pp @@ -92,8 +94,9 @@ Just after invocation of daemon. .It The interface is up after a temporary interface failure. +The .Nm -detects such failures by periodically probing to see if the status +utility detects such failures by periodically probing to see if the status of the interface is active or not. Note that some network cards and drivers do not allow the extraction of link state. @@ -136,7 +139,9 @@ will dump the current internal state into .Bl -tag -width indent .It Fl a Autoprobe outgoing interface. +The .Nm +utility will try to find a non-loopback, non-point-to-point, IPv6-capable interface. If .Nm @@ -149,8 +154,7 @@ Enable debugging. .It Fl D Enable more debugging including the printing of internal timer information. .It Fl f -.Fl f -prevents +Prevent .Nm from becoming a daemon (foreground mode). Warning messages are generated to standard error @@ -194,11 +198,12 @@ dumps internal state on. .Sh HISTORY The .Nm -command is based on the +utility is based on the .Nm rtsol -command, which first appeared in WIDE/KAME IPv6 protocol stack kit. +utility, which first appeared in WIDE/KAME IPv6 protocol stack kit. +The .Nm rtsol -is now integrated into +utility is now integrated into .Xr rtsold 8 . .\" .Sh BUGS diff --git a/usr.sbin/rwhod/rwhod.8 b/usr.sbin/rwhod/rwhod.8 index 97a319108c92..1fba005426f3 100644 --- a/usr.sbin/rwhod/rwhod.8 +++ b/usr.sbin/rwhod/rwhod.8 @@ -45,8 +45,9 @@ .Op Fl l .Op Fl m Op Ar ttl .Sh DESCRIPTION -.Nm Rwhod -is the server which maintains the database used by the +The +.Nm +utility is the server which maintains the database used by the .Xr rwho 1 and .Xr ruptime 1 @@ -56,8 +57,9 @@ or .Em multicast messages on a network. .Pp -.Nm Rwhod -operates as both a producer and consumer of status information, +The +.Nm +utility operates as both a producer and consumer of status information, unless the .Fl l (listen mode) option is specified, in which case @@ -212,8 +214,9 @@ format described above. .Pp Status messages are generated approximately once every 3 minutes. -.Nm Rwhod -performs an +The +.Nm +utility performs an .Xr nlist 3 on .Pa /boot/kernel/kernel @@ -231,5 +234,5 @@ as a machine going down. .Sh HISTORY The .Nm -command appeared in +utility appeared in .Bx 4.2 . diff --git a/usr.sbin/sa/sa.8 b/usr.sbin/sa/sa.8 index 5eb22d7bee34..794626e5f18d 100644 --- a/usr.sbin/sa/sa.8 +++ b/usr.sbin/sa/sa.8 @@ -47,8 +47,9 @@ utility reports on, cleans up, and generally maintains system accounting files. .Pp -.Nm Sa -is able to condense the information in +The +.Nm +utility is able to condense the information in .Pa /var/account/acct into the summary files .Pa /var/account/savacct diff --git a/usr.sbin/sade/sade.8 b/usr.sbin/sade/sade.8 index 201b8e70bb58..d304c8451dad 100644 --- a/usr.sbin/sade/sade.8 +++ b/usr.sbin/sade/sade.8 @@ -36,8 +36,9 @@ .Op Ar function .Op Ar ... .Sh DESCRIPTION +The .Nm -is a utility for installing and configuring +utility is used for installing and configuring .Fx systems. It is the first utility invoked by the @@ -51,7 +52,7 @@ systems for use in later configuring the system. .Pp The .Nm -program is generally invoked without arguments for the default +utility is generally invoked without arguments for the default behavior, where the main installation/configuration menu is presented. .Pp On those occasions where it is deemed necessary to invoke a subsystem @@ -62,8 +63,9 @@ script, each command-line argument corresponding to a line of script, the reader is encouraged to read the section on scripting for more information on this feature. .Sh NOTES +The .Nm -is essentially nothing more than a monolithic C program with +utility is essentially nothing more than a monolithic C program with the ability to write MBRs and disk labels (through the services of the .Xr libdisk 3 @@ -82,8 +84,9 @@ performs most file system operations by calling the relevant syscalls .Xr mount 2 ) directly. .Pp +The .Nm -currently uses the +utility currently uses the .Xr dialog 3 library to do user interaction with simple ANSI line graphics, color support for which is enabled by either running on a syscons VTY or some @@ -95,8 +98,9 @@ termcap entry). This product is currently at the end of its life cycle and will eventually be replaced. .Sh RUNNING SCRIPTS +The .Nm -may be either driven interactively through its various internal menus +utility may be either driven interactively through its various internal menus or run in batch mode, driven by an external script. Such a script may be loaded and executed in one of 3 ways: .Bl -tag -width Ds diff --git a/usr.sbin/setextattr/setextattr.8 b/usr.sbin/setextattr/setextattr.8 index fbe64d6cd240..ea9a1479087a 100644 --- a/usr.sbin/setextattr/setextattr.8 +++ b/usr.sbin/setextattr/setextattr.8 @@ -38,7 +38,9 @@ .Ar filename .Ar attrvalue .Sh DESCRIPTION +The .Nm +utility is a user tool to set a named extended attribute on a file or directory to the provided string. The @@ -52,8 +54,9 @@ argument should be the name of the attribute, the name of the file or directory to set the attribute for, and .Ar attrvalue a string to store in the attribute. +The .Nm -will store the string in the file's attribute. +utility will store the string in the file's attribute. In order for .Nm to succeed, the attribute service must be available on the file system, @@ -81,5 +84,6 @@ to be associated with each file or directory. .Sh AUTHORS Robert N M Watson .Sh BUGS +The .Nm -can only be used to set attributes to strings. +utility can only be used to set attributes to strings. diff --git a/usr.sbin/setkey/setkey.8 b/usr.sbin/setkey/setkey.8 index f56e22b08465..5861ced56802 100644 --- a/usr.sbin/setkey/setkey.8 +++ b/usr.sbin/setkey/setkey.8 @@ -54,13 +54,15 @@ .Fl x .\" .Sh DESCRIPTION +The .Nm -adds, updates, dumps, or flushes +utility adds, updates, dumps, or flushes Security Association Database (SAD) entries as well as Security Policy Database (SPD) entries in the kernel. .Pp +The .Nm -takes a series of operations from the standard input +utility takes a series of operations from the standard input (if invoked with .Fl c ) or the file named @@ -79,8 +81,7 @@ If with .Fl P , the SPD entries are flushed. .It Fl a -.Nm -usually does not display dead SAD entries with +Dead SAD entries are usually not displayed with .Fl D . If with .Fl a , @@ -195,8 +196,9 @@ Meta-arguments are as follows: .It Ar dst Source/destination of the secure communication is specified as IPv4/v6 address. +The .Nm -does not consult hostname-to-address for arguments +utility does not consult hostname-to-address for arguments .Ar src and .Ar dst . @@ -368,8 +370,9 @@ The square bracket around is really necessary. They are not manpage metacharacters. .Pp +The .Nm -does not consult hostname-to-address for arguments +utility does not consult hostname-to-address for arguments .Ar src and .Ar dst . @@ -623,7 +626,7 @@ The command exits with 0 on success, and non-zero on errors. .Sh HISTORY The .Nm -command first appeared in WIDE Hydrangea IPv6 protocol stack kit. +utility first appeared in WIDE Hydrangea IPv6 protocol stack kit. The command was completely re-designed in June 1998. .\" .\" .Sh BUGS diff --git a/usr.sbin/sicontrol/sicontrol.8 b/usr.sbin/sicontrol/sicontrol.8 index 53b88cdce44f..aa56df30f4a2 100644 --- a/usr.sbin/sicontrol/sicontrol.8 +++ b/usr.sbin/sicontrol/sicontrol.8 @@ -11,11 +11,13 @@ device .Ar command Op Ar param ... .Sh DESCRIPTION -.Nm Sicontrol -is used to configure and monitor the SI/XIO device driver. +The +.Nm +utility is used to configure and monitor the SI/XIO device driver. .Pp -.Nm Sicontrol -operates on the specified +The +.Nm +utility operates on the specified .Ar device to indicate which port is to be used. .Pp @@ -23,10 +25,12 @@ The special .Ar device string `-' is used to indicate the global driver settings instead. .Pp -A '/dev/' is included if necessary. +A +.Pa /dev/ +is included if necessary. .Pp The following commands are used for the global settings and should be -specified with the '-' device name. +specified with the '-' device name: .Bl -tag -width 4n .It Cm int_throttle Op Cm value Configure the `aggregate interrupt throttle value'. @@ -72,7 +76,7 @@ This is not much use outside of debugging the driver. .Bl -tag -width /dev/si_control -compact .It Pa /dev/si_control global driver control file for use by -.Xr sicontrol 8 . +.Xr sicontrol 8 .It Pa /dev/ttyA* terminal control ports .It Pa /dev/ttyiA* @@ -91,8 +95,9 @@ Generally self explanatory..... .Xr tty 4 , .Xr comcontrol 8 .Sh HISTORY -.Nm Sicontrol -is loosely based on a utility called +The +.Nm +utility is loosely based on a utility called .Nm siconfig which was written by .An Andy Rutter Aq andy@acronym.co.uk diff --git a/usr.sbin/sliplogin/sliplogin.8 b/usr.sbin/sliplogin/sliplogin.8 index 38c7f98523d6..614723d56ea0 100644 --- a/usr.sbin/sliplogin/sliplogin.8 +++ b/usr.sbin/sliplogin/sliplogin.8 @@ -42,8 +42,9 @@ .Nm .Op Ar loginname Op Ar device .Sh DESCRIPTION -.Nm Sliplogin -is used to turn the terminal line on standard input (or +The +.Nm +utility is used to turn the terminal line on standard input (or .Ar device ) into a Serial Line IP .Pq Tn SLIP @@ -231,8 +232,9 @@ may run The system administrator should make sure that all legitimate users are a member of the correct group. .Sh DIAGNOSTICS -.Nm Sliplogin -logs various information to the system log daemon, +The +.Nm +utility logs various information to the system log daemon, .Xr syslogd 8 , with a facility code of .Em daemon . @@ -306,6 +308,5 @@ contains the PID of the sliplogin process which is using interface .Sh HISTORY The .Nm -command -appeared in +utility appeared in .Bx 4.3 Reno . diff --git a/usr.sbin/spkrtest/spkrtest.8 b/usr.sbin/spkrtest/spkrtest.8 index 1128afba287d..58eced5be0de 100644 --- a/usr.sbin/spkrtest/spkrtest.8 +++ b/usr.sbin/spkrtest/spkrtest.8 @@ -30,8 +30,9 @@ .Nm spkrtest .Nd test script for the speaker driver .Sh DESCRIPTION -.Nm Spkrtest -is an easy to use test script for the speaker driver. +The +.Nm +utility is an easy to use test script for the speaker driver. .Sh FILES .Bl -tag -width /dev/speakerxx .It Pa /dev/speaker @@ -43,5 +44,5 @@ speaker device file .Sh HISTORY The .Nm -script appeared in +utility appeared in .Fx 1.0 diff --git a/usr.sbin/spray/spray.8 b/usr.sbin/spray/spray.8 index 6718e60aad40..e10704886771 100644 --- a/usr.sbin/spray/spray.8 +++ b/usr.sbin/spray/spray.8 @@ -36,8 +36,9 @@ .Op Fl l Ar length .Ar host .Sh DESCRIPTION -.Nm Spray -sends multiple RPC packets to +The +.Nm +utility sends multiple RPC packets to .Ar host and records how many of them were correctly received and how long it took. .Pp @@ -58,12 +59,14 @@ bytes. Not all values of .Ar length are possible because RPC data is encoded using XDR. -.Nm Spray -rounds up to the nearest possible value. +The +.Nm +utility rounds up to the nearest possible value. .El .Pp -.Nm Spray -is intended for use in network testing, measurement, and management. +The +.Nm +utility is intended for use in network testing, measurement, and management. This command .Em "can be very hard on a network and should be used with caution" . .Sh SEE ALSO diff --git a/usr.sbin/stallion/stlload/stlload.8 b/usr.sbin/stallion/stlload/stlload.8 index e47247525c6a..b1e398230ddc 100644 --- a/usr.sbin/stallion/stlload/stlload.8 +++ b/usr.sbin/stallion/stlload/stlload.8 @@ -46,7 +46,9 @@ .Op Fl B Ar boot-banner .Op Fl b Ar unit-number .Sh DESCRIPTION -.Nm Stlload +The +.Nm +utility is used to download the firmware code to Stallion Technologies intelligent multiport serial boards. A firmware download is only required for those boards that use the Stallion @@ -109,8 +111,9 @@ Specify the unit (board) number to be downloaded. The default is to download board 0. .El .Pp -.Nm Stlload -would typically be run from +The +.Nm +utility would typically be run from .Pa /etc/rc.serial . .Sh FILES .Bl -tag -width /usr/libdata/stallion/2681.sys diff --git a/usr.sbin/stallion/stlstats/stlstats.8 b/usr.sbin/stallion/stlstats/stlstats.8 index 985c67e23db3..5863b737eafa 100644 --- a/usr.sbin/stallion/stlstats/stlstats.8 +++ b/usr.sbin/stallion/stlstats/stlstats.8 @@ -44,12 +44,15 @@ .Op Fl p Ar port-number .Op Fl d Ar port-device .Sh DESCRIPTION -.Nm Stlstats +The +.Nm +utility is used to display statistical information about the ports on Stallion Technologies multiport serial boards. .Pp -.Nm Stlstats -normally runs as a full screen menu driven application. +The +.Nm +utility normally runs as a full screen menu driven application. A help line is displayed at the bottom of each screen with the valid input keys for this screen. .Pp @@ -102,8 +105,9 @@ Output version information. Output only the board type information. This output is useful for scripts or other programs that need to know a little bit about the board (for example an automated download script). -.Nm Stlstats -will not enter full screen interactive mode. +The +.Nm +utility will not enter full screen interactive mode. .It Fl c Ar control-device Specify the board control device through which to gather port statistics. The default is @@ -113,7 +117,9 @@ Specify the board number to display first. The default is to display board 0. .It Fl p Ar port-number Specify the port number to display first. -.Nm Stlstats +The +.Nm +utility will go straight into the port display screen (bypassing board display) when this option is used. .It Fl d Ar port-device diff --git a/usr.sbin/sysinstall/sysinstall.8 b/usr.sbin/sysinstall/sysinstall.8 index 201b8e70bb58..d304c8451dad 100644 --- a/usr.sbin/sysinstall/sysinstall.8 +++ b/usr.sbin/sysinstall/sysinstall.8 @@ -36,8 +36,9 @@ .Op Ar function .Op Ar ... .Sh DESCRIPTION +The .Nm -is a utility for installing and configuring +utility is used for installing and configuring .Fx systems. It is the first utility invoked by the @@ -51,7 +52,7 @@ systems for use in later configuring the system. .Pp The .Nm -program is generally invoked without arguments for the default +utility is generally invoked without arguments for the default behavior, where the main installation/configuration menu is presented. .Pp On those occasions where it is deemed necessary to invoke a subsystem @@ -62,8 +63,9 @@ script, each command-line argument corresponding to a line of script, the reader is encouraged to read the section on scripting for more information on this feature. .Sh NOTES +The .Nm -is essentially nothing more than a monolithic C program with +utility is essentially nothing more than a monolithic C program with the ability to write MBRs and disk labels (through the services of the .Xr libdisk 3 @@ -82,8 +84,9 @@ performs most file system operations by calling the relevant syscalls .Xr mount 2 ) directly. .Pp +The .Nm -currently uses the +utility currently uses the .Xr dialog 3 library to do user interaction with simple ANSI line graphics, color support for which is enabled by either running on a syscons VTY or some @@ -95,8 +98,9 @@ termcap entry). This product is currently at the end of its life cycle and will eventually be replaced. .Sh RUNNING SCRIPTS +The .Nm -may be either driven interactively through its various internal menus +utility may be either driven interactively through its various internal menus or run in batch mode, driven by an external script. Such a script may be loaded and executed in one of 3 ways: .Bl -tag -width Ds diff --git a/usr.sbin/syslogd/syslogd.8 b/usr.sbin/syslogd/syslogd.8 index 57d8b416c5f7..cba8c03c6d05 100644 --- a/usr.sbin/syslogd/syslogd.8 +++ b/usr.sbin/syslogd/syslogd.8 @@ -51,17 +51,17 @@ .Sh DESCRIPTION The .Nm -daemon reads and logs messages to the system console, log files, other +utility reads and logs messages to the system console, log files, other machines and/or users as specified by its configuration file. .Pp The options are as follows: .Bl -tag -width indent .It Fl 4 -Forces +Force .Nm to use IPv4 addresses only. .It Fl 6 -Forces +Force .Nm to use IPv6 addresses only. .It Fl A @@ -228,7 +228,7 @@ message. .Pp The .Nm -daemon reads its configuration file when it starts up and whenever it +utility reads its configuration file when it starts up and whenever it receives a hangup signal. For information on the format of the configuration file, see @@ -236,7 +236,7 @@ see .Pp The .Nm -daemon reads messages from the +utility reads messages from the .Tn UNIX domain socket .Pa /var/run/log , @@ -248,7 +248,7 @@ and from the special device .Pp The .Nm -daemon creates its process ID file, +utility creates its process ID file, by default .Pa /var/run/syslog.pid , and stores its process @@ -292,7 +292,7 @@ kernel log device .Sh HISTORY The .Nm -command appeared in +utility appeared in .Bx 4.3 . .Pp The diff --git a/usr.sbin/timed/timed/timed.8 b/usr.sbin/timed/timed/timed.8 index 8c36e9e58e8a..5102e6f14248 100644 --- a/usr.sbin/timed/timed/timed.8 +++ b/usr.sbin/timed/timed/timed.8 @@ -47,7 +47,7 @@ .Sh DESCRIPTION The .Nm -daemon is a time server daemon +utility is a time server daemon which is normally invoked at boot time from the .Xr rc.network 8 file. @@ -79,8 +79,9 @@ This option may be specified multiple times to add more than one network to the list. .It Fl F Ar host ... Create a list of trusted hosts. +The .Nm -will only accept trusted hosts as masters. +utility will only accept trusted hosts as masters. If it finds an untrusted host claiming to be master, .Nm will suppress incoming messages from that host @@ -141,8 +142,9 @@ flag is not used, .Nm will treat all machines as trustworthy. .Pp +The .Nm -is based on a master-slave +utility is based on a master-slave scheme. When .Nm @@ -160,7 +162,7 @@ and with .Xr timedc 8 , a .Nm -control program. +control utility. If the machine running the master becomes unreachable, the slaves will elect a new master from among those slaves @@ -187,8 +189,9 @@ or flags, it will provide synchronization service on any attached networks on which no trusted master server was detected. Such a server propagates the time computed by the top-level master. +The .Nm -will periodically check for the presence of a master +utility will periodically check for the presence of a master on those networks for which it is operating as a slave. If it finds that there are no trusted masters on a network, it will begin the election process on that network. @@ -260,5 +263,5 @@ log file for master timed .Sh HISTORY The .Nm -daemon appeared in +utility appeared in .Bx 4.3 . diff --git a/usr.sbin/timed/timedc/timedc.8 b/usr.sbin/timed/timedc/timedc.8 index c431c56de5d6..1a24e965fd97 100644 --- a/usr.sbin/timed/timedc/timedc.8 +++ b/usr.sbin/timed/timedc/timedc.8 @@ -42,8 +42,9 @@ .Nm .Op Ar command Op Ar argument ... .Sh DESCRIPTION -.Nm Timedc -is used to control the operation of the +The +.Nm +utility is used to control the operation of the .Xr timed 8 program. It may be used to: @@ -139,5 +140,5 @@ command can be executed by root only .Sh HISTORY The .Nm -command appeared in +utility appeared in .Bx 4.3 . diff --git a/usr.sbin/traceroute6/traceroute6.8 b/usr.sbin/traceroute6/traceroute6.8 index 879e34eaad4f..b67af366e44a 100644 --- a/usr.sbin/traceroute6/traceroute6.8 +++ b/usr.sbin/traceroute6/traceroute6.8 @@ -110,7 +110,7 @@ Specify the delay time between probes. .Sh RETURN VALUES The .Nm -command will exit with 0 on success, and non-zero on errors. +utility will exit with 0 on success, and non-zero on errors. .\" .Sh SEE ALSO .Xr ping 8 , @@ -120,4 +120,4 @@ command will exit with 0 on success, and non-zero on errors. .Sh HISTORY The .Nm -command first appeared in WIDE hydrangea IPv6 protocol stack kit. +utility first appeared in WIDE hydrangea IPv6 protocol stack kit. diff --git a/usr.sbin/trpt/trpt.8 b/usr.sbin/trpt/trpt.8 index 1cbd6ae7ca8d..226ca4af5db1 100644 --- a/usr.sbin/trpt/trpt.8 +++ b/usr.sbin/trpt/trpt.8 @@ -50,8 +50,9 @@ .Ar system Op Ar core .Oc .Sh DESCRIPTION -.Nm Trpt -interrogates the buffer of +The +.Nm +utility interrogates the buffer of .Tn TCP trace records created when a socket is marked for @@ -148,5 +149,5 @@ here. .Sh HISTORY The .Nm -command appeared in +utility appeared in .Bx 4.2 . diff --git a/usr.sbin/tzsetup/tzsetup.8 b/usr.sbin/tzsetup/tzsetup.8 index 6d368918312f..642be782057b 100644 --- a/usr.sbin/tzsetup/tzsetup.8 +++ b/usr.sbin/tzsetup/tzsetup.8 @@ -36,12 +36,13 @@ .Sh DESCRIPTION The .Nm -program reads a database of timezone information and presents a menu +utility reads a database of timezone information and presents a menu allowing the user to select a specific zone without knowing the details of the database layout. The selected zone is installed as the system default zone. +The .Nm -also determines whether any adjustment is necessary for systems where +utility also determines whether any adjustment is necessary for systems where the hardware clock does not keep .Tn UTC . .Pp diff --git a/usr.sbin/usbd/usbd.8 b/usr.sbin/usbd/usbd.8 index 5cd61a661961..7fff877c42c2 100644 --- a/usr.sbin/usbd/usbd.8 +++ b/usr.sbin/usbd/usbd.8 @@ -50,8 +50,9 @@ .Op Fl t Ar timeout .Op Fl v .Sh DESCRIPTION +The .Nm -handles the USB device attachment and detachment. +utility handles the USB device attachment and detachment. It does two things. Through opening the .Pa /dev/usb0 , @@ -132,7 +133,7 @@ more verbose. .Sh HISTORY The .Nm -command appeared in +utility appeared in .Nx 1.4 . .Sh AUTHORS .An -nosplit diff --git a/usr.sbin/usbdevs/usbdevs.8 b/usr.sbin/usbdevs/usbdevs.8 index e469231800a7..fb2f87af103e 100644 --- a/usr.sbin/usbdevs/usbdevs.8 +++ b/usr.sbin/usbdevs/usbdevs.8 @@ -47,8 +47,9 @@ .Op Fl f Ar dev .Op Fl v .Sh DESCRIPTION +The .Nm -prints a listing of all USB devices connected to the system +utility prints a listing of all USB devices connected to the system with some information about each device. The indentation of each line indicates its distance from the root. .Pp @@ -68,5 +69,5 @@ Be verbose. .Sh HISTORY The .Nm -command appeared in +utility appeared in .Nx 1.4 . diff --git a/usr.sbin/vipw/vipw.8 b/usr.sbin/vipw/vipw.8 index a4f704a54a35..539a22fcafa3 100644 --- a/usr.sbin/vipw/vipw.8 +++ b/usr.sbin/vipw/vipw.8 @@ -42,8 +42,9 @@ .Nm .Op Fl d Ar directory .Sh DESCRIPTION -.Nm Vipw -edits the password file after setting the appropriate locks, +The +.Nm +utility edits the password file after setting the appropriate locks, and does any necessary processing after the password file is unlocked. If the password file is already locked for editing by another user, .Nm @@ -64,8 +65,9 @@ option may be used to specify an alternative .Ar directory to work with. .Pp -.Nm Vipw -performs a number of consistency checks on the password entries, +The +.Nm +utility performs a number of consistency checks on the password entries, and will not allow a password file with a .Dq mangled entry to be @@ -105,5 +107,5 @@ See .Sh HISTORY The .Nm -command appeared in +utility appeared in .Bx 4.0 . diff --git a/usr.sbin/watch/watch.8 b/usr.sbin/watch/watch.8 index f855ec1f60d8..a549518d1ff4 100644 --- a/usr.sbin/watch/watch.8 +++ b/usr.sbin/watch/watch.8 @@ -13,8 +13,9 @@ .Op Fl f Ar snpdev .Op Ar tty .Sh DESCRIPTION -.Nm Watch -allows the user to examine all data coming through a specified tty +The +.Nm +utility allows the user to examine all data coming through a specified tty using the .Xr snp 4 device. @@ -24,8 +25,9 @@ device is not available, .Nm will attempt to load the module .Pq Nm snp . -.Nm Watch -writes to standard output. +The +.Nm +utility writes to standard output. .Pp The options are as follows: .Bl -tag -width indent @@ -108,6 +110,7 @@ All user output is reproduced as-is. .Sh AUTHORS .An Ugen J.S. Antsilevich Aq ugen@NetVision.net.il .Sh HISTORY -.Nm Watch -first appeared in +The +.Nm +utility first appeared in .Fx 2.1 . diff --git a/usr.sbin/wicontrol/wicontrol.8 b/usr.sbin/wicontrol/wicontrol.8 index 9c0d968f264c..c1e49103421b 100644 --- a/usr.sbin/wicontrol/wicontrol.8 +++ b/usr.sbin/wicontrol/wicontrol.8 @@ -108,7 +108,7 @@ .Sh DESCRIPTION The .Nm -command controls the operation of WaveLAN/IEEE wireless networking +utility controls the operation of WaveLAN/IEEE wireless networking devices via the .Xr wi 4 driver. @@ -120,7 +120,7 @@ to point) or BSS (service set) mode, and the network name of a service set to join (IBSS) if BSS mode is enabled. The .Nm -command can also be used to view the current settings of these parameters +utility can also be used to view the current settings of these parameters and to dump out the values of the card's statistics counters. .Pp The @@ -457,10 +457,10 @@ bytes are random and not confined to ASCII characters. .Sh HISTORY The .Nm -command first appeared in +utility first appeared in .Fx 3.0 . .Sh AUTHORS The .Nm -command was written by +utility was written by .An Bill Paul Aq wpaul@ctr.columbia.edu . diff --git a/usr.sbin/wlconfig/wlconfig.8 b/usr.sbin/wlconfig/wlconfig.8 index cfbd4b330c6d..106732dbc1a8 100644 --- a/usr.sbin/wlconfig/wlconfig.8 +++ b/usr.sbin/wlconfig/wlconfig.8 @@ -13,7 +13,7 @@ .Sh DESCRIPTION The .Nm -command can be used to read and set parameters for the NCR/AT&T Wavelan +utility can be used to read and set parameters for the NCR/AT&T Wavelan radio LAN card. Various parameters stored in the non-volatile Parameter Storage Area (PSA) on the card can be modified with this program, replacing the DOS-based @@ -88,7 +88,7 @@ which clears out the cache in case you want to store new samples. Note that if the IRQ on the Wavelan card is incorrect, the interface will be configured, but will not function. The .Nm -program should then be used to reconfigure the card to a sensible +utility should then be used to reconfigure the card to a sensible value. .Sh EXAMPLES Set the NWID to 0x1234: @@ -132,7 +132,7 @@ Print a scaled version of the signal strength cache: .Sh HISTORY This implementation of the .Nm -command is completely new, written for Hilink Internet by +utility is completely new, written for Hilink Internet by .An Michael Smith , and updated by .An Jim Binkley &c . diff --git a/usr.sbin/yp_mkdb/yp_mkdb.8 b/usr.sbin/yp_mkdb/yp_mkdb.8 index f0d3651440af..f7b8f2242bd3 100644 --- a/usr.sbin/yp_mkdb/yp_mkdb.8 +++ b/usr.sbin/yp_mkdb/yp_mkdb.8 @@ -53,14 +53,16 @@ .Ar inputfile .Ar dbname .Sh DESCRIPTION -.Nm Yp_mkdb -creates +The +.Nm +utility creates .Xr db 3 style databases for use with .Fx Ns 's NIS server. -.Nm Yp_mkdb -reads data from +The +.Nm +utility reads data from .Ar inputfile , and writes it to .Ar dbname @@ -79,11 +81,13 @@ These databases are typically stored in where .Ar domainname is the name of the NIS domain being served. -.Nm Yp_mkdb -is usually invoked by +The +.Nm +utility is usually invoked by .Pa /var/yp/Makefile . -.Nm Yp_mkdb -can also be used to dump an NIS database file so that its +The +.Nm +utility can also be used to dump an NIS database file so that its contents can be examined. For security reasons, all databases that .Nm diff --git a/usr.sbin/ypbind/ypbind.8 b/usr.sbin/ypbind/ypbind.8 index 3c3d4f7b182c..779cc8565761 100644 --- a/usr.sbin/ypbind/ypbind.8 +++ b/usr.sbin/ypbind/ypbind.8 @@ -50,8 +50,9 @@ .Sm on .Oc .Sh DESCRIPTION -.Nm Ypbind -is the process that maintains NIS binding information. +The +.Nm +utility is the process that maintains NIS binding information. At startup, it searches for an NIS server responsible for serving the system's default domain (as set by the @@ -75,8 +76,9 @@ If it fails to receive a reply to one of these requests, .Nm assumes that the server is no longer running and resumes its network broadcasts until another binding is established. -.Nm Ypbind -will also log warning messages using the +The +.Nm +utility will also log warning messages using the .Xr syslog 3 facility each time it detects that a server has stopped responding, as well as when it has bound to a new server. @@ -173,7 +175,7 @@ flag, it has no effect). .Sh NOTES The .Nm -program will not make continuous attempts to keep secondary domains bound. +utility will not make continuous attempts to keep secondary domains bound. If a server for a secondary domain fails to respond to a ping, .Nm will broadcast for a new server only once before giving up. diff --git a/usr.sbin/yppoll/yppoll.8 b/usr.sbin/yppoll/yppoll.8 index 1784154b623c..ad90d902e146 100644 --- a/usr.sbin/yppoll/yppoll.8 +++ b/usr.sbin/yppoll/yppoll.8 @@ -1,5 +1,3 @@ -.\" $NetBSD: yppoll.8,v 1.4 1997/07/30 22:55:00 jtc Exp $ -.\" .\" Copyright (c) 1996 The NetBSD Foundation, Inc. .\" All rights reserved. .\" @@ -48,7 +46,9 @@ .Op Fl d Ar domain .Ar mapname .Sh DESCRIPTION -.Nm Yppoll +The +.Nm +utility asks a YP server process for the order number and which host is the master server for .Ar mapname . diff --git a/usr.sbin/yppush/yppush.8 b/usr.sbin/yppush/yppush.8 index d4dedd31584a..ca5e483181d6 100644 --- a/usr.sbin/yppush/yppush.8 +++ b/usr.sbin/yppush/yppush.8 @@ -47,8 +47,9 @@ .Op Fl v .Ar mapname .Sh DESCRIPTION -.Nm Yppush -distributes updated NIS databases (or +The +.Nm +utility distributes updated NIS databases (or .Pa maps ) from an NIS master server to NIS slave servers within an NIS domain. @@ -107,8 +108,9 @@ controls how long will wait for a response from a slave server before sending a map transfer request to the next slave server in its list. .It Fl j Ar #parallel jobs -.Nm Yppush -normally performs transfers serially, meaning that it will +The +.Nm +utility normally performs transfers serially, meaning that it will send a map transfer request to one slave server and then wait for it to respond before moving on to the next slave server. In environments @@ -152,7 +154,7 @@ The flag can be used to specify an alternate path in the event that the system administrator decides to store the NIS maps somewhere else. .It Fl v -Verbose mode: causes +Verbose mode: it causes .Nm to print debugging messages as it runs. Specifying this flag twice diff --git a/usr.sbin/ypserv/ypinit.8 b/usr.sbin/ypserv/ypinit.8 index 6d25e4268f34..a3a7a8d4ab65 100644 --- a/usr.sbin/ypserv/ypinit.8 +++ b/usr.sbin/ypserv/ypinit.8 @@ -50,7 +50,8 @@ .Sh DESCRIPTION The .Nm -script sets up databases on a Network Information Service (NIS) +utility is a script which sets up databases on a Network Information Service +(NIS) master or slave server. .Pp On a master server, @@ -65,8 +66,8 @@ to create and populate an initial set of NIS maps. The maps are created from local source files using the .Xr yp_mkdb 8 -command. -The script will prompt the user for a list of servers +utility. +The utility will prompt the user for a list of servers that support the specified domain; this list is used to populate the ypservers map. .Pp @@ -78,32 +79,37 @@ populates it with copies of the NIS maps from the master. The maps are obtained from the master using the .Xr ypxfr 8 -command. +utility. The .Nm -script obtains the list of maps to transfer in one of two ways: if +utility obtains the list of maps to transfer in one of two ways: if the system is configured as an NIS client and is bound to the master server, .Nm is able to use the .Xr ypwhich 1 -command to obtain a list of maps exported by the master server. +utility to obtain a list of maps exported by the master server. If the system is not configured as a client of the NIS master, .Nm uses a hardcoded list of maps, some of which may or may not actually exist on the master. -The system administrator can edit the script and +The system administrator can edit the +.Nm +script and modify the map list if necessary. -Otherwise, indivudual maps can +Otherwise, individual maps can be transfered manually from the master using .Xr ypxfr 8 . .Sh OPTIONS -.Nm Ypinit -supports the following options: +The +.Nm +utility supports the following options: .Bl -tag -width indent .It Fl m Op Ar domainname Set up a master server. -By default, the script sets up a server for +By default, +.Nm +sets up a server for the system default domain. The user can override this default by specifying .Ar domainname @@ -111,7 +117,7 @@ explicitly. Maps are constructed from scratch using local files as templates using the .Xr yp_mkdb 8 -command. +utility. .It Fl s Ar master_server Op Ar domainname Set up a slave server using .Ar master_name @@ -120,7 +126,9 @@ Maps are copied from .Ar master_server to the slave using .Xr ypxfr 8 . -By default, the script sets up a server for +By default, +.Nm +sets up a server for the system default domain. The user can override this default by specifying .Ar domainname diff --git a/usr.sbin/ypserv/ypserv.8 b/usr.sbin/ypserv/ypserv.8 index d8c09900b03b..88882cfc6b7e 100644 --- a/usr.sbin/ypserv/ypserv.8 +++ b/usr.sbin/ypserv/ypserv.8 @@ -59,7 +59,7 @@ updated from a single location. .Pp The .Nm -program is the server that distributes +utility is the server that distributes .Tn NIS databases to client systems within an .Tn NIS @@ -111,7 +111,7 @@ good general practice. .Pp The .Nm -program is started by +utility is started by .Pa /etc/rc.network if it has been enabled in .Pa /etc/rc.conf . @@ -271,7 +271,7 @@ will allow connections from any host. .Pp The .Nm -program also has support for Wietse Venema's +utility also has support for Wietse Venema's .Em tcpwrapper package. This allows the administrator to use the tcpwrapper diff --git a/usr.sbin/ypset/ypset.8 b/usr.sbin/ypset/ypset.8 index d15b60d39689..49ad6e0b67ae 100644 --- a/usr.sbin/ypset/ypset.8 +++ b/usr.sbin/ypset/ypset.8 @@ -45,8 +45,9 @@ which YP server process to use .Op Fl d Ar domain .Ar server .Sh DESCRIPTION -.Nm Ypset -tells the +The +.Nm +utility tells the .Xr ypbind 8 process on the current machine which YP server process to communicate with. If @@ -56,7 +57,9 @@ a YP client process attempts to access a YP map, at which time .Xr ypbind 8 tests the binding and takes appropriate action. .Pp -.Nm Ypset +The +.Nm +utility is most useful for binding a YP client that is not on the same broadcast network as the closest YP server, but can also be used for debugging a local network's YP configuration, testing specific YP client diff --git a/usr.sbin/zic/zdump.8 b/usr.sbin/zic/zdump.8 index eb4d954138a3..696159571580 100644 --- a/usr.sbin/zic/zdump.8 +++ b/usr.sbin/zic/zdump.8 @@ -14,8 +14,9 @@ .Op Fl c Ar cutoffyear .Op Ar zonename ... .Sh DESCRIPTION -.Nm Zdump -prints the current time in each +The +.Nm +utility prints the current time in each .Ar zonename named on the command line. .Pp diff --git a/usr.sbin/zic/zic.8 b/usr.sbin/zic/zic.8 index 4bc115e7ed77..5355c80d3338 100644 --- a/usr.sbin/zic/zic.8 +++ b/usr.sbin/zic/zic.8 @@ -18,8 +18,9 @@ .Op Fl y Ar command .Op Ar filename ... .Sh DESCRIPTION -.Nm Zic -reads text from the file(s) named on the command line +The +.Nm +utility reads text from the file(s) named on the command line and creates the time conversion information files specified in this input. If a .Ar filename @@ -53,8 +54,9 @@ no leap second information appears in output files. Use the given .Ar time zone as local time. -.Nm Zic -will act as if the input contained a link line of the form +The +.Nm +utility will act as if the input contained a link line of the form .Bd -literal -offset indent .No "Link timezone localtime .Ed @@ -75,8 +77,9 @@ Use the given .Ar "time zone" Ns 's rules when handling POSIX-format time zone environment variables. -.Nm Zic -will act as if the input contained a link line of the form +The +.Nm +utility will act as if the input contained a link line of the form .Bd -literal -offset indent .No "Link timezone posixrules .Ed |