diff options
Diffstat (limited to 'usr.bin')
92 files changed, 509 insertions, 335 deletions
diff --git a/usr.bin/calendar/calendar.1 b/usr.bin/calendar/calendar.1 index c1cdd6916250f..b42c28198fa7f 100644 --- a/usr.bin/calendar/calendar.1 +++ b/usr.bin/calendar/calendar.1 @@ -50,8 +50,9 @@ .Sm on .Oc .Sh DESCRIPTION -.Nm Calendar -checks the current directory for a file named +The +.Nm +utility checks the current directory for a file named .Pa calendar and displays lines that begin with either today's date or tomorrow's. @@ -231,5 +232,6 @@ A command appeared in .At v7 . .Sh BUGS -.Nm Calendar -doesn't handle Jewish holidays and moon phases. +The +.Nm +utility doesn't handle Jewish holidays and moon phases. diff --git a/usr.bin/colldef/colldef.1 b/usr.bin/colldef/colldef.1 index 35212cac64758..47a7584e842a8 100644 --- a/usr.bin/colldef/colldef.1 +++ b/usr.bin/colldef/colldef.1 @@ -37,8 +37,9 @@ .Op Fl o Ar out_file .Op Ar filename .Sh DESCRIPTION -.Nm Colldef -converts a collation sequence source definition +The +.Nm +utility converts a collation sequence source definition into a format usable by the .Fn strxfrm and @@ -60,8 +61,9 @@ or transforms its arguments and does a comparison. .Pp -.Nm Colldef -reads the collation sequence source definition +The +.Nm +utility reads the collation sequence source definition from the standard input and stores the converted definition in filename. The output file produced contains the database with collating sequence information in a form @@ -240,8 +242,9 @@ is used for continuation. In this case, no characters are permitted after the backslash character. .Sh DIAGNOSTICS -.Nm Colldef -exits with the following values: +The +.Nm +utility exits with the following values: .Bl -tag -width indent .It Li 0 No errors were found and the output was successfully created. diff --git a/usr.bin/find/find.1 b/usr.bin/find/find.1 index b66276a0ef967..47bd748f9f344 100644 --- a/usr.bin/find/find.1 +++ b/usr.bin/find/find.1 @@ -48,8 +48,9 @@ .Op Ar pathname ... .Ar expression .Sh DESCRIPTION -.Nm Find -recursively descends the directory tree for each +The +.Nm +utility recursively descends the directory tree for each .Ar pathname listed, evaluating an .Ar expression diff --git a/usr.bin/fstat/fstat.1 b/usr.bin/fstat/fstat.1 index 6b0cfaa21dc66..4f0de5acab16c 100644 --- a/usr.bin/fstat/fstat.1 +++ b/usr.bin/fstat/fstat.1 @@ -47,8 +47,9 @@ .Op Fl u Ar user .Op Ar .Sh DESCRIPTION -.Nm Fstat -identifies open files. +The +.Nm +utility identifies open files. A file is considered open by a process if it was explicitly opened, is the working directory, root directory, active executable text, or kernel trace file for that process. diff --git a/usr.bin/gprof/gprof.1 b/usr.bin/gprof/gprof.1 index 2390e11a64914..ac3e155731bd0 100644 --- a/usr.bin/gprof/gprof.1 +++ b/usr.bin/gprof/gprof.1 @@ -43,8 +43,9 @@ .Op options .Op Ar a.out Op Ar a.out.gmon ... .Sh DESCRIPTION -.Nm Gprof -produces an execution profile of C, Pascal, or Fortran77 programs. +The +.Nm +utility produces an execution profile of C, Pascal, or Fortran77 programs. The effect of called routines is incorporated in the profile of each caller. The profile data is taken from the call graph profile file which is created by programs that are compiled with the @@ -69,8 +70,7 @@ compiler or linker you can use .Fl l Ns Ar c_p instead of .Fl l Ns Ar c . -.Nm Gprof -reads the given object file (the default is +Read the given object file (the default is .Pa a.out) and establishes the relation between its symbol table and the call graph profile. @@ -83,8 +83,9 @@ the .Nm output shows the sum of the profile information in the given profile files. .Pp -.Nm Gprof -calculates the amount of time spent in each routine. +The +.Nm +utility calculates the amount of time spent in each routine. Next, these times are propagated along the edges of the call graph. Cycles are discovered, and calls into a cycle are made to share the time of the cycle. diff --git a/usr.bin/hesinfo/hesinfo.1 b/usr.bin/hesinfo/hesinfo.1 index dbe62ebac7d54..ef84c2df220fe 100644 --- a/usr.bin/hesinfo/hesinfo.1 +++ b/usr.bin/hesinfo/hesinfo.1 @@ -27,8 +27,9 @@ .Op Fl bl .Ar HesiodName HesiodNameType .Sh DESCRIPTION +The .Nm -takes two arguments, a name to be resolved and a string, known +utility takes two arguments, a name to be resolved and a string, known as a .Ar HesiodNameType . It then prints the information returned by @@ -39,8 +40,7 @@ The value returned by is of the type .Ar HesiodNameType . .Pp -.Nm -understands the following options: +The following options are available: .Bl -tag -width indent .It Fl l Selects long format. diff --git a/usr.bin/indent/indent.1 b/usr.bin/indent/indent.1 index ab12d808ee799..c0b77ab755d1b 100644 --- a/usr.bin/indent/indent.1 +++ b/usr.bin/indent/indent.1 @@ -81,11 +81,12 @@ .Op Fl troff .Op Fl v | Fl \&nv .Sh DESCRIPTION -.Nm Indent -is a -.Ar C +The +.Nm +utility is a +.Em C program formatter. It reformats the -.Ar C +.Em C program in the .Ar input-file according to the switches. The switches which can be @@ -381,7 +382,9 @@ switches. The switches should be separated by spaces, tabs or newlines. .Ss Comments .Sq Em Box .Em comments . -.Nm Indent +The +.Nm +utility assumes that any comment with a dash or star immediately after the start of comment (that is, `/*\-' or `/**') is a comment surrounded by a box of stars. Each line of such a comment is left unchanged, except that its indentation @@ -390,8 +393,9 @@ of the comment. .Pp .Em Straight text . All other comments are treated as straight text. -.Nm Indent -fits as many words (separated by blanks, tabs, or newlines) on a +The +.Nm +utility fits as many words (separated by blanks, tabs, or newlines) on a line as possible. Blank lines break paragraphs. .Pp .Ss Comment indentation @@ -421,8 +425,9 @@ attempts to correctly compensate for the syntactic peculiarities introduced. .Pp .Ss C syntax -.Nm Indent -understands a substantial amount about the syntax of C, but it +The +.Nm +utility understands a substantial amount about the syntax of C, but it has a `forgiving' parser. It attempts to cope with the usual sorts of incomplete and misformed syntax. In particular, the use of macros like: .Pp @@ -430,8 +435,9 @@ incomplete and misformed syntax. In particular, the use of macros like: .Pp is handled properly. .Sh ENVIRONMENT -.Nm Indent -uses the +The +.Nm +utility uses the .Ev HOME environment variable. .Sh FILES @@ -447,8 +453,9 @@ The command appeared in .Bx 4.2 . .Sh BUGS -.Nm Indent -has even more switches than +The +.Nm +utility has even more switches than .Xr ls 1 . .Pp A common mistake that often causes grief is typing: @@ -456,5 +463,6 @@ A common mistake that often causes grief is typing: .Dl indent *.c .Pp to the shell in an attempt to indent all the -C programs in a directory. +.Em C +programs in a directory. This is probably a bug, not a feature. diff --git a/usr.bin/ipcrm/ipcrm.1 b/usr.bin/ipcrm/ipcrm.1 index 9d59cc2dfe66d..21eb593f6dd97 100644 --- a/usr.bin/ipcrm/ipcrm.1 +++ b/usr.bin/ipcrm/ipcrm.1 @@ -39,8 +39,9 @@ .Op Fl S Ar semkey .Ar ... .Sh DESCRIPTION -.Nm Ipcrm -removes the specified message queues, semaphores and shared memory +The +.Nm +utility removes the specified message queues, semaphores and shared memory segments. These System V IPC objects can be specified by their creation id or any associated key. .Pp diff --git a/usr.bin/ipcs/ipcs.1 b/usr.bin/ipcs/ipcs.1 index 71989aec1d62e..7dcd03e54a364 100644 --- a/usr.bin/ipcs/ipcs.1 +++ b/usr.bin/ipcs/ipcs.1 @@ -43,7 +43,7 @@ .Sh DESCRIPTION The .Nm -program provides information on System V interprocess communication +utility provides information on System V interprocess communication (IPC) facilities on the system. .Pp The options are as follows: diff --git a/usr.bin/jot/jot.1 b/usr.bin/jot/jot.1 index e5f93577e00ae..5326d6f741445 100644 --- a/usr.bin/jot/jot.1 +++ b/usr.bin/jot/jot.1 @@ -47,8 +47,9 @@ .Op Fl p Ar precision .Op reps Op begin Op end Op s .Sh DESCRIPTION -.Nm Jot -is used to print out increasing, decreasing, random, +The +.Nm +utility is used to print out increasing, decreasing, random, or redundant data, usually numbers, one per line. .Pp The following options are available: diff --git a/usr.bin/keylogin/keylogin.1 b/usr.bin/keylogin/keylogin.1 index f0fd8edd5cf21..16da68678f0b9 100644 --- a/usr.bin/keylogin/keylogin.1 +++ b/usr.bin/keylogin/keylogin.1 @@ -11,8 +11,9 @@ .Sh SYNOPSIS .Nm .Sh DESCRIPTION -.Nm Keylogin -prompts the user for their login password, and uses it to decrypt +The +.Nm +utility prompts the user for their login password, and uses it to decrypt the user's secret key stored in the .Xr publickey 5 database. diff --git a/usr.bin/keylogout/keylogout.1 b/usr.bin/keylogout/keylogout.1 index 7a3503e55e0a6..6d643c90d1ad0 100644 --- a/usr.bin/keylogout/keylogout.1 +++ b/usr.bin/keylogout/keylogout.1 @@ -10,8 +10,9 @@ .Nm .Op Fl f .Sh DESCRIPTION -.Nm Keylogout -deletes the key stored by the key server process +The +.Nm +utility deletes the key stored by the key server process .Xr keyserv 8 to be used by any secure network services, such as NFS. Further access to the key is revoked, @@ -25,7 +26,8 @@ Also since only one copy is kept on a machine of the key, it is a bad idea to place this in your .Pa .logout file since it will affect other sessions on the same machine. -.Sh OPTIONS +.Pp +The following option is available: .Bl -tag -width indent .It Fl f Forget the rootkey. diff --git a/usr.bin/killall/killall.1 b/usr.bin/killall/killall.1 index 2771bbe76d747..2345ff292ece6 100644 --- a/usr.bin/killall/killall.1 +++ b/usr.bin/killall/killall.1 @@ -45,8 +45,9 @@ .Op Fl SIGNAL .Op Ar procname ... .Sh DESCRIPTION -.Nm Killall -kills processes selected by name, as opposed to the selection by pid +The +.Nm +utility kills processes selected by name, as opposed to the selection by pid as done by .Xr kill 1 . By default, it will send a @@ -111,7 +112,7 @@ if there are zombie processes that match the specified pattern. .El .Sh ALL PROCESSES Sending a signal to all processes with uid -.Nm XYZ +.Em XYZ is already supported by .Xr kill 1 . So use diff --git a/usr.bin/ktrace/ktrace.1 b/usr.bin/ktrace/ktrace.1 index 50775a4906ff2..728929649216f 100644 --- a/usr.bin/ktrace/ktrace.1 +++ b/usr.bin/ktrace/ktrace.1 @@ -52,7 +52,7 @@ .Sh DESCRIPTION The .Nm -command enables kernel trace logging for the specified processes. +utility enables kernel trace logging for the specified processes. Kernel trace data is logged to the file .Pa ktrace.out . The kernel operations that are traced include system calls, namei diff --git a/usr.bin/lam/lam.1 b/usr.bin/lam/lam.1 index 2d1a4f01c0617..1852d6dcfdcad 100644 --- a/usr.bin/lam/lam.1 +++ b/usr.bin/lam/lam.1 @@ -50,8 +50,9 @@ .Op Fl t Ar c .Ar .Sh DESCRIPTION -.Nm Lam -copies the named files side by side onto the standard output. +The +.Nm +utility copies the named files side by side onto the standard output. The .Em n-th input lines from the input @@ -66,7 +67,7 @@ Normally, each option affects only the after it. If the option letter is capitalized it affects all subsequent files until it appears again uncapitalized. -The options are described below. +The options are described below: .Bl -tag -width indent .It Fl f Ar min . Ns Ar max Print line fragments according to the format string diff --git a/usr.bin/last/last.1 b/usr.bin/last/last.1 index c1f68dc990628..c8c99f87c4065 100644 --- a/usr.bin/last/last.1 +++ b/usr.bin/last/last.1 @@ -58,8 +58,9 @@ .Op Fl w .Op Ar user ... .Sh DESCRIPTION -.Nm Last -will either list the sessions of specified +The +.Nm +utility will either list the sessions of specified .Ar users , .Ar ttys , and @@ -75,6 +76,7 @@ a crash or shutdown, .Nm will so indicate. .Pp +The following options are available: .Bl -tag -width indent-two .It Fl Ar n Limits the report to @@ -140,8 +142,7 @@ If the .Ar SS letter pair is not specified, the value defaults to 0. .It Fl f Ar file -.Nm Last -reads the file +Read the file .Ar file instead of the default, .Pa /var/log/wtmp . @@ -210,6 +211,7 @@ In this case, .Nm will indicate the logout time as "shutdown". .Sh HISTORY -.Nm Last -appeared in +A +.Nm +utility last appeared in .Bx 3.0 . diff --git a/usr.bin/ldd/ldd.1 b/usr.bin/ldd/ldd.1 index 83d79d11de9f4..7ec710e787e77 100644 --- a/usr.bin/ldd/ldd.1 +++ b/usr.bin/ldd/ldd.1 @@ -13,8 +13,9 @@ .Op Fl f Ar format .Ar program ... .Sh DESCRIPTION +The .Nm -displays all shared objects that are needed to run the given program or +utility displays all shared objects that are needed to run the given program or to load the given shared object. Contrary to .Xr nm 1 , diff --git a/usr.bin/leave/leave.1 b/usr.bin/leave/leave.1 index 948a6a3ba7647..ba0cc03ebc103 100644 --- a/usr.bin/leave/leave.1 +++ b/usr.bin/leave/leave.1 @@ -42,8 +42,9 @@ .Nm .Op Oo Cm \&+ Oc Ns Ar hhmm .Sh DESCRIPTION -.Nm Leave -waits until the specified time, then reminds you that you +The +.Nm +utility waits until the specified time, then reminds you that you have to leave. You are reminded 5 minutes and 1 minute before the actual time, at the time, and every minute thereafter. diff --git a/usr.bin/limits/limits.1 b/usr.bin/limits/limits.1 index c0f8751ad9ce7..59cc90adc7d8b 100644 --- a/usr.bin/limits/limits.1 +++ b/usr.bin/limits/limits.1 @@ -51,8 +51,9 @@ .Op Ar name Ns = Ns Ar value ... .Op Ar command .Sh DESCRIPTION -.Nm Limits -either prints or sets kernel resource limits, and may optionally set +The +.Nm +utility either prints or sets kernel resource limits, and may optionally set environment variables like .Xr env 1 and run a program with the selected resources. @@ -300,7 +301,9 @@ When invoked to execute a program, the failure of to raise a hard limit is considered a fatal error. .El .Sh DIAGNOSTICS -.Nm Limits +The +.Nm +utility exits with EXIT_FAILURE if usage is incorrect in any way; i.e. an invalid option, or set/display options are selected in the same invocation, .Fl e @@ -321,8 +324,9 @@ will be whatever the executed program returns. .Xr login.conf 5 , .Xr sysctl 8 .Sh BUGS -.Nm Limits -does not handle commands with equal (``='') signs in their +The +.Nm +utility does not handle commands with equal (``='') signs in their names, for obvious reasons. .Pp When eval output is selected, the @@ -340,8 +344,9 @@ in eval mode prior mounting may only occur in standard bourne shell scripts. .Pp -.Nm Limits -makes no effort to ensure that resource settings emitted or displayed +The +.Nm +utility makes no effort to ensure that resource settings emitted or displayed are valid and settable by the current user. Only a superuser account may raise hard limits, and when doing so the diff --git a/usr.bin/lock/lock.1 b/usr.bin/lock/lock.1 index 60348a5c0f46f..785fc4a7d74b5 100644 --- a/usr.bin/lock/lock.1 +++ b/usr.bin/lock/lock.1 @@ -44,8 +44,9 @@ .Op Fl p .Op Fl t Ar timeout .Sh DESCRIPTION -.Nm Lock -requests a password from the user, reads it again for verification +The +.Nm +utility requests a password from the user, reads it again for verification and then will normally not relinquish the terminal until the password is repeated. There are two other conditions under which it will terminate: it diff --git a/usr.bin/lockf/lockf.1 b/usr.bin/lockf/lockf.1 index b7f35c0c3f87f..9d067586b5358 100644 --- a/usr.bin/lockf/lockf.1 +++ b/usr.bin/lockf/lockf.1 @@ -101,7 +101,9 @@ as follows: .It Dv EX_TEMPFAIL The specified lock file was already locked by another process. .It Dv EX_CANTCREAT +The .Nm +utility was unable to create the lock file, e.g., because of insufficient access privileges. .It Dv EX_USAGE @@ -115,8 +117,9 @@ A system call (e.g., fork) failed unexpectedly. .Xr flock 2 , .Xr sysexits 3 .Sh HISTORY +A .Nm -first appeared in +utility first appeared in .Fx 2.2 . .Sh AUTHORS .An John Polstra Aq jdp@polstra.com . diff --git a/usr.bin/logger/logger.1 b/usr.bin/logger/logger.1 index bf9dca0db6f2a..21189b5142151 100644 --- a/usr.bin/logger/logger.1 +++ b/usr.bin/logger/logger.1 @@ -47,8 +47,9 @@ .Op Fl t Ar tag .Op Ar message ... .Sh DESCRIPTION -.Nm Logger -provides a shell command interface to the +The +.Nm +utility provides a shell command interface to the .Xr syslog 3 system log module. .Pp diff --git a/usr.bin/login/login.1 b/usr.bin/login/login.1 index 21a6bfa159255..5160c73614487 100644 --- a/usr.bin/login/login.1 +++ b/usr.bin/login/login.1 @@ -105,15 +105,17 @@ If the file exists in the user's home directory, all of these messages are suppressed. This is to simplify logins for non-human users, such as .Xr uucp 1 . -.Nm Login -then records an entry in the +The +.Nm +utility then records an entry in the .Xr wtmp 5 and .Xr utmp 5 files and executes the user's command interpreter. .Pp -.Nm Login -enters information into the environment (see +The +.Nm +utility enters information into the environment (see .Xr environ 7 ) specifying the user's home directory (HOME), command interpreter (SHELL), search path (PATH), terminal type (TERM) and user name (both LOGNAME and diff --git a/usr.bin/look/look.1 b/usr.bin/look/look.1 index 9d5d7222e02e6..1fdbf9da15108 100644 --- a/usr.bin/look/look.1 +++ b/usr.bin/look/look.1 @@ -101,6 +101,7 @@ option was specified. This was incorrect and the current man page matches the historic implementation. .Sh HISTORY -.Nm Look -appeared in +A +.Nm +utility appeared in .At v7 . diff --git a/usr.bin/lorder/lorder.1 b/usr.bin/lorder/lorder.1 index 68b074b2bdb58..e0bbaa559a332 100644 --- a/usr.bin/lorder/lorder.1 +++ b/usr.bin/lorder/lorder.1 @@ -48,8 +48,9 @@ utility uses .Xr nm 1 to determine interdependencies in the list of object files specified on the command line. -.Nm Lorder -outputs a list of file names where the first file contains a symbol +The +.Nm +utility outputs a list of file names where the first file contains a symbol which is defined by the second file. .Pp The output is normally used with diff --git a/usr.bin/m4/m4.1 b/usr.bin/m4/m4.1 index 0ba26f8eb8360..4fd0747645888 100644 --- a/usr.bin/m4/m4.1 +++ b/usr.bin/m4/m4.1 @@ -111,8 +111,9 @@ ranges (e.g., a-z), regular expressions mimic emacs behavior, and the number of diversions is unlimited. .El .Sh SYNTAX -.Nm m4 -provides the following built-in macros. +The +.Nm +utility provides the following built-in macros. They may be redefined, losing their original meaning. Return values are null unless otherwise stated. .Bl -tag -width changequotexxx diff --git a/usr.bin/mail/mail.1 b/usr.bin/mail/mail.1 index 037206c008fe3..4582bf55c68ad 100644 --- a/usr.bin/mail/mail.1 +++ b/usr.bin/mail/mail.1 @@ -56,8 +56,9 @@ .Op Fl EiInNv .Op Fl u Ar user .Sh INTRODUCTION -.Nm Mail -is an intelligent mail processing system, which has +The +.Nm +utility is an intelligent mail processing system, which has a command syntax reminiscent of .Xr ed 1 with lines replaced by messages. @@ -144,8 +145,9 @@ option. Next, the commands in the user's personal command file .Pa ~/.mailrc are executed. +The .Nm -then examines its command line options to determine whether a +utility then examines its command line options to determine whether a new message is to be sent, or whether an existing mailbox is to be read. .Ss "Sending Mail" @@ -303,8 +305,9 @@ See .Xr mailaddr 7 for a description of network addresses. .Pp -.Nm Mail -has a number of options which can be set in the +The +.Nm +utility has a number of options which can be set in the .Pa .mailrc file to alter its behavior; thus .Dq Li "set askcc" @@ -714,8 +717,9 @@ program text over the message system. A synonym for .Ic exit . .It Ic z -.Nm Mail -presents message headers in windowfuls as described under the +The +.Nm +utility presents message headers in windowfuls as described under the .Ic headers command. You can move @@ -1108,8 +1112,9 @@ with the command; normally, the first five lines are printed. .El .Sh ENVIRONMENT -.Nm Mail -utilizes the +The +.Nm +utility utilizes the .Ev HOME and .Ev USER diff --git a/usr.bin/make/make.1 b/usr.bin/make/make.1 index ba4ad3383c621..fce162eb934d2 100644 --- a/usr.bin/make/make.1 +++ b/usr.bin/make/make.1 @@ -54,8 +54,9 @@ .Op Ar variable Ns No = Ns Ar value .Op Ar target ... .Sh DESCRIPTION -.Nm Make -is a program designed to simplify the maintenance of other programs. +The +.Nm +utility is a program designed to simplify the maintenance of other programs. Its input is a list of specifications describing dependency relationships between the generation of files and programs. @@ -467,8 +468,9 @@ was executed with A path to the directory where .Nm was executed. -.Nm Make -sets +The +.Nm +utility sets .Va .CURDIR to the canonical path given by .Xr getcwd 3 . @@ -512,8 +514,9 @@ If they are undefined and is unable to change into any of the remaining three directories, then the current directory is used. .Pp -.Nm Make -sets +The +.Nm +utility sets .Va .OBJDIR to the canonical path given by .Xr getcwd 3 . @@ -1120,7 +1123,9 @@ variable. .It Ic .PATH\fIsuffix\fR The sources are directories which are to be searched for suffixed files not found in the current directory. -.Nm Make +The +.Nm +utility first searches the suffixed search path, before reverting to the default path if the file is not found there. This form is required for @@ -1173,8 +1178,9 @@ Most of the more esoteric features of .Nm should probably be avoided for greater compatibility. .Sh ENVIRONMENT -.Nm Make -uses the following environment variables, if they exist: +The +.Nm +utility uses the following environment variables, if they exist: .Ev MACHINE , .Ev MAKE , .Ev MAKEFLAGS , diff --git a/usr.bin/minigzip/minigzip.1 b/usr.bin/minigzip/minigzip.1 index c13857f5eb065..0bfe89964ea5e 100644 --- a/usr.bin/minigzip/minigzip.1 +++ b/usr.bin/minigzip/minigzip.1 @@ -35,8 +35,9 @@ .Op Fl d .Op Ar .Sh DESCRIPTION -.Nm Minigzip -is a minimal implementation of the +The +.Nm +utility is a minimal implementation of the .Xr gzip 1 utility. It supports compression and decompression of individual files, as well as @@ -66,6 +67,7 @@ to standard output. .Sh SEE ALSO .Xr gzip 1 .Sh AUTHORS -.Nm Minigzip -was written by +The +.Nm +utility was written by .An Jean-loup Gailly . diff --git a/usr.bin/mkdep/mkdep.1 b/usr.bin/mkdep/mkdep.1 index ef96bcc752cb7..d96d2670b6c9e 100644 --- a/usr.bin/mkdep/mkdep.1 +++ b/usr.bin/mkdep/mkdep.1 @@ -45,8 +45,9 @@ .Op Ar flags .Ar .Sh DESCRIPTION -.Nm Mkdep -takes a set of flags for the C compiler and a list +The +.Nm +utility takes a set of flags for the C compiler and a list of C source files as arguments and constructs a set of include file dependencies which are written into the file ``.depend''. An example of its use in a Makefile might be: diff --git a/usr.bin/mkfifo/mkfifo.1 b/usr.bin/mkfifo/mkfifo.1 index e637bc659a267..7ce479c827997 100644 --- a/usr.bin/mkfifo/mkfifo.1 +++ b/usr.bin/mkfifo/mkfifo.1 @@ -48,7 +48,7 @@ .Sh DESCRIPTION The .Nm -command creates the fifos requested, in the order specified. +utility creates the fifos requested, in the order specified. .Pp The options are as follows: .Bl -tag -width indent @@ -78,7 +78,7 @@ modified by the of the calling process. The .Nm -command requires write permission in the parent directory. +utility requires write permission in the parent directory. .Sh DIAGNOSTICS .Ex -std .Sh STANDARDS diff --git a/usr.bin/mkstr/mkstr.1 b/usr.bin/mkstr/mkstr.1 index 03f37c11b0f5c..0e1bf3907e6db 100644 --- a/usr.bin/mkstr/mkstr.1 +++ b/usr.bin/mkstr/mkstr.1 @@ -44,8 +44,9 @@ .Ar messagefile .Ar prefix Ar .Sh DESCRIPTION -.Nm Mkstr -creates files containing error messages extracted from C source, +The +.Nm +utility creates files containing error messages extracted from C source, and restructures the same C source, to utilize the created error message file. The intent of @@ -55,8 +56,9 @@ reduce swapping (see .Sx BUGS section below). .Pp -.Nm Mkstr -processes each of the specified +The +.Nm +utility processes each of the specified .Ar files , placing a restructured version of the input in a file whose name consists of the specified @@ -81,13 +83,13 @@ Options: .It Fl Error messages are placed at the end of the specified message file for recompiling part of a large -.Nm -ed +.Nm Ns ed program. .El .Pp -.Nm Mkstr -finds error messages in the source by +The +.Nm +utility finds error messages in the source by searching for the string .Li \&`error("' in the input stream. @@ -121,12 +123,14 @@ error(a1, a2, a3, a4) .Xr xstr 1 , .Xr lseek 2 .Sh HISTORY -.Nm Mkstr -appeared in +A +.Nm +utility appeared in .Bx 3.0 . .Sh BUGS -.Nm Mkstr -was intended for the limited architecture of the PDP 11 family. +The +.Nm +utility was intended for the limited architecture of the PDP 11 family. Very few programs actually use it. The Pascal interpreter, .Xr \&pi 1 diff --git a/usr.bin/mktemp/mktemp.1 b/usr.bin/mktemp/mktemp.1 index 08a4d33403b33..78308b397a1df 100644 --- a/usr.bin/mktemp/mktemp.1 +++ b/usr.bin/mktemp/mktemp.1 @@ -106,8 +106,9 @@ including one based on the internal template resulting from the .Fl t flag. .Pp -.Nm Mktemp -is provided to allow shell scripts to safely use temporary files. +The +.Nm +utility is provided to allow shell scripts to safely use temporary files. Traditionally, many shell scripts take the name of the program with the pid as a suffix and use that as a temporary file name. This kind of naming scheme is predictable and the race condition it creates diff --git a/usr.bin/msgs/msgs.1 b/usr.bin/msgs/msgs.1 index e2657bb45005e..b646a469caf95 100644 --- a/usr.bin/msgs/msgs.1 +++ b/usr.bin/msgs/msgs.1 @@ -49,15 +49,17 @@ .Op Fl c .Op \-days .Sh DESCRIPTION -.Nm Msgs -is used to read system messages. +The +.Nm +utility is used to read system messages. These messages are sent by mailing to the login `msgs' and should be short pieces of information which are suitable to be read once by most users of the system. .Pp -.Nm Msgs -is normally invoked each time you login, by placing it in the file +The +.Nm +utility is normally invoked each time you login, by placing it in the file .Pa .login (or .Pa .profile @@ -99,8 +101,9 @@ is invoked on that mailbox. Both `m' and `s' accept a numeric argument in place of the `\-'. .El .Pp -.Nm Msgs -keeps track of the next message you will see by a number in the file +The +.Nm +utility keeps track of the next message you will see by a number in the file .Pa \&.msgsrc in your home directory. In the directory @@ -203,8 +206,9 @@ you can also go to any specific message by typing its number when .Nm requests input as to what to do. .Sh ENVIRONMENT -.Nm Msgs -uses the +The +.Nm +utility uses the .Ev HOME and .Ev TERM diff --git a/usr.bin/mt/mt.1 b/usr.bin/mt/mt.1 index 35f16152b64c7..13331e1fbf9d8 100644 --- a/usr.bin/mt/mt.1 +++ b/usr.bin/mt/mt.1 @@ -45,8 +45,9 @@ .Ar command .Op Ar count .Sh DESCRIPTION -.Nm \&Mt -is used to give commands to a magnetic tape drive. +The +.Nm +utility is used to give commands to a magnetic tape drive. By default .Nm performs the requested operation once. Operations @@ -226,8 +227,9 @@ does not exist; uses the device .Pa /dev/nsa0 . .Pp -.Nm \&Mt -returns a 0 exit status when the operation(s) were successful, +The +.Nm +utility returns a 0 exit status when the operation(s) were successful, 1 if the command was unrecognized, and 2 if an operation failed. .Pp The following density table was taken from the @@ -306,8 +308,9 @@ If the following environment variable exists, it is utilized by .Nm Ns . .Bl -tag -width Fl .It Ev TAPE -.Nm \&Mt -checks the +The +.Nm +utility checks the .Ev TAPE environment variable if the argument diff --git a/usr.bin/ncal/ncal.1 b/usr.bin/ncal/ncal.1 index 359cc6787bdc1..7de5f2cb03e7f 100644 --- a/usr.bin/ncal/ncal.1 +++ b/usr.bin/ncal/ncal.1 @@ -49,8 +49,9 @@ .Op Fl Jeo .Op Ar year .Sh DESCRIPTION -.Nm Cal -displays a simple calendar in traditional format and +The +.Nm +utility displays a simple calendar in traditional format and .Nm ncal offers an alternative layout, more options and the date of easter. The new format is a little cramped but it makes a year fit diff --git a/usr.bin/ncplogin/ncplogin.1 b/usr.bin/ncplogin/ncplogin.1 index 8fb1530f808cc..f44852687c2a9 100644 --- a/usr.bin/ncplogin/ncplogin.1 +++ b/usr.bin/ncplogin/ncplogin.1 @@ -181,8 +181,9 @@ Only the superuser can override the attribute for a connection. .It Fl P Mark the connection as permanent. +The .Nm -always creates permanent connections. +utility always creates permanent connections. This option can be used in other ncp* programs. .It Fl R Ar retry_count diff --git a/usr.bin/ncplogin/ncplogout.1 b/usr.bin/ncplogin/ncplogout.1 index 86e7bda3f3870..295708550150c 100644 --- a/usr.bin/ncplogin/ncplogout.1 +++ b/usr.bin/ncplogin/ncplogout.1 @@ -16,7 +16,7 @@ .Sh DESCRIPTION The .Nm -will schedule a connection created by +utility will schedule a connection created by .Xr ncplogin 1 command to be closed. If the connection is busy (i.e. used by other processes) it will diff --git a/usr.bin/nice/nice.1 b/usr.bin/nice/nice.1 index 5e2a180914e2b..35a3244ccc7ba 100644 --- a/usr.bin/nice/nice.1 +++ b/usr.bin/nice/nice.1 @@ -44,8 +44,9 @@ .Ar command .Op Ar arguments .Sh DESCRIPTION -.Nm Nice -runs +The +.Nm +utility runs .Ar command at a low priority. (Think of low and slow). @@ -56,8 +57,9 @@ is not given, assumes the value 10. The priority is a value in the range -20 to 20. The default priority is 0, priority 20 is the lowest possible. -.Nm Nice -will execute +The +.Nm +utility will execute .Ar command at priority .Ar number diff --git a/usr.bin/objformat/objformat.1 b/usr.bin/objformat/objformat.1 index ffd0f248e4b9e..c5575b481d431 100644 --- a/usr.bin/objformat/objformat.1 +++ b/usr.bin/objformat/objformat.1 @@ -88,8 +88,9 @@ command appeared in .Fx 3.0 . .Sh AUTHORS .An -nosplit +The .Nm -was written by +utility was written by .An Peter Wemm Aq peter@netplex.com.au . This manual page was written by .An David O'Brien Aq obrien@NUXI.com . diff --git a/usr.bin/pagesize/pagesize.1 b/usr.bin/pagesize/pagesize.1 index 723ab90d6dba9..e4287e18cb0e2 100644 --- a/usr.bin/pagesize/pagesize.1 +++ b/usr.bin/pagesize/pagesize.1 @@ -41,8 +41,9 @@ .Sh SYNOPSIS .Nm .Sh DESCRIPTION -.Nm Pagesize -prints the size of a page of memory in bytes, as +The +.Nm +utility prints the size of a page of memory in bytes, as returned by .Xr getpagesize 3 . This program is useful in constructing portable diff --git a/usr.bin/passwd/passwd.1 b/usr.bin/passwd/passwd.1 index abd51e87201fd..b62bbbd157233 100644 --- a/usr.bin/passwd/passwd.1 +++ b/usr.bin/passwd/passwd.1 @@ -49,8 +49,9 @@ .Op Fl h Ar host .Op Fl o .Sh DESCRIPTION -.Nm Passwd -changes the user's local, Kerberos, or NIS password. +The +.Nm +utility changes the user's local, Kerberos, or NIS password. If the user is not the super-user, .Nm first prompts for the current password and will not continue unless the correct @@ -58,8 +59,9 @@ password is entered. .Pp When entering the new password, the characters entered do not echo, in order to avoid the password being seen by a passer-by. +The .Nm -prompts for the new password twice in order to detect typing errors. +utility prompts for the new password twice in order to detect typing errors. .Pp The new password should be at least six characters long (which may be overridden using the @@ -106,8 +108,9 @@ followed by The super-user is not required to provide a user's current password if only the local password is modified. .Sh NIS INTERACTION -.Nm Passwd -has built-in support for NIS. +The +.Nm +utility has built-in support for NIS. If a user exists in the NIS password database but does not exist locally, .Nm diff --git a/usr.bin/printenv/printenv.1 b/usr.bin/printenv/printenv.1 index eb34cb672d8a7..cc9a15d93333f 100644 --- a/usr.bin/printenv/printenv.1 +++ b/usr.bin/printenv/printenv.1 @@ -49,8 +49,9 @@ .Op Ar name Ns = Ns Ar value ... .Op Ar command .Sh DESCRIPTION -.Nm Printenv -prints out the names and values of the variables in the environment, +The +.Nm +utility prints out the names and values of the variables in the environment, with one name/value pair per line. If .Ar name @@ -64,8 +65,9 @@ Consult the .Xr builtin 1 manual page. .Pp -.Nm Env -executes +The +.Nm env +utility executes .Ar command after modifying the environment as specified on the command line. @@ -98,8 +100,9 @@ If no command is specified, prints out the names and values of the variables in the environment, with one name/value pair per line. .Pp +The .Nm env -is sometimes useful with the +utility is sometimes useful with the .Dq Li #! construct (see .Xr execve 2 ) . @@ -142,6 +145,7 @@ The command appeared in .Bx 3.0 . .Sh BUGS -.Nm Env -doesn't handle commands with equal (``='') signs in their +The +.Nm env +utility doesn't handle commands with equal (``='') signs in their names, for obvious reasons. diff --git a/usr.bin/printf/printf.1 b/usr.bin/printf/printf.1 index 483bb949f4ebd..abeac55c00e98 100644 --- a/usr.bin/printf/printf.1 +++ b/usr.bin/printf/printf.1 @@ -45,8 +45,9 @@ .Nm .Ar format Op Ar arguments ... .Sh DESCRIPTION -.Nm Printf -formats and prints its arguments, after the first, under control +The +.Nm +utility formats and prints its arguments, after the first, under control of the .Ar format . The diff --git a/usr.bin/quota/quota.1 b/usr.bin/quota/quota.1 index 9cece56fdb7d3..76c59328b5af0 100644 --- a/usr.bin/quota/quota.1 +++ b/usr.bin/quota/quota.1 @@ -55,8 +55,9 @@ .Op Fl v | Fl q .Ar group .Sh DESCRIPTION -.Nm Quota -displays users' disk usage and limits. +The +.Nm +utility displays users' disk usage and limits. By default only the user quotas are printed. .Pp The following options are available: @@ -68,8 +69,7 @@ The optional .Fl u flag is equivalent to the default. .It Fl v -.Nm Quota -will display quotas on filesystems +Display quotas on filesystems where no storage is allocated. .It Fl q Print a more terse message, @@ -101,8 +101,9 @@ flag takes precedence over the .Fl v flag. .Pp -.Nm Quota -tries to report the quotas of all mounted filesystems. +The +.Nm +utility tries to report the quotas of all mounted filesystems. If the filesystem is mounted via .Tn NFS , it will attempt to contact the diff --git a/usr.bin/ranlib/ranlib.1 b/usr.bin/ranlib/ranlib.1 index cac26f8b04ed8..cd33c00865947 100644 --- a/usr.bin/ranlib/ranlib.1 +++ b/usr.bin/ranlib/ranlib.1 @@ -43,8 +43,9 @@ .Op Fl t .Ar .Sh DESCRIPTION -.Nm Ranlib -creates a table of external references for archive libraries, +The +.Nm +utility creates a table of external references for archive libraries, normally used by the loader, .Xr ld 1 . This table is named ``__.SYMDEF'' and is prepended to the archive. diff --git a/usr.bin/rlogin/rlogin.1 b/usr.bin/rlogin/rlogin.1 index 4fe8a9a259ff2..2b15e99b9a6d1 100644 --- a/usr.bin/rlogin/rlogin.1 +++ b/usr.bin/rlogin/rlogin.1 @@ -47,11 +47,14 @@ .Op Fl l Ar username .Ar host .Sh DESCRIPTION -.Nm Rlogin -starts a terminal session on a remote host +The +.Nm +utility starts a terminal session on a remote host .Ar host . .Pp -.Nm Rlogin +The +.Nm +utility first attempts to use the Kerberos authorization mechanism, described below. If the remote host does not support Kerberos the standard Berkeley .Pa rhosts @@ -231,8 +234,9 @@ command appeared in .Pp IPv6 support was added by WIDE/KAME project. .Sh BUGS -.Nm Rlogin -will be replaced by +The +.Nm +utility will be replaced by .Xr telnet 1 in the near future. .Pp diff --git a/usr.bin/rpcgen/rpcgen.1 b/usr.bin/rpcgen/rpcgen.1 index c0e355c36d964..4f4385f425d68 100644 --- a/usr.bin/rpcgen/rpcgen.1 +++ b/usr.bin/rpcgen/rpcgen.1 @@ -1,6 +1,7 @@ .\" @(#)rpcgen.1 1.35 93/06/02 SMI .\" $FreeBSD$ .\" Copyright 1985-1993 Sun Microsystems, Inc. +.\" .Dd March 28, 1993 .Dt RPCGEN 1 .Os @@ -50,8 +51,9 @@ .\" .LP .\" SUNWcsu .Sh DESCRIPTION -.Nm Rpcgen -is a tool that generates C code to implement an +The +.Nm +utility is a tool that generates C code to implement an .Tn RPC protocol. The input to @@ -60,8 +62,9 @@ is a language similar to C known as .Tn RPC Language (Remote Procedure Call Language). .Pp -.Nm Rpcgen -is normally used as in the first synopsis where +The +.Nm +utility is normally used as in the first synopsis where it takes an input file and generates three output files. If the .Ar infile @@ -85,8 +88,9 @@ it also generates the dispatch table in .Pa proto_tbl.i . .Pp -.Nm Rpcgen -can also generate sample client and server files +The +.Nm +utility can also generate sample client and server files that can be customized to suit a particular application. The .Fl \&Sc , @@ -382,7 +386,7 @@ However, the functions are not yet MT-safe, which means that rpcgen generated server-side code will not be MT-safe. .It Fl N -This option allows procedures to have multiple arguments. +Allow procedures to have multiple arguments. It also uses the style of parameter passing that closely resembles C. So, when passing an argument to a remote procedure, you do not have to pass a pointer to the argument, but can pass the argument itself. diff --git a/usr.bin/rs/rs.1 b/usr.bin/rs/rs.1 index dd4a3c3d07fdd..4187d8db882ba 100644 --- a/usr.bin/rs/rs.1 +++ b/usr.bin/rs/rs.1 @@ -47,8 +47,9 @@ .Oc .Op Ar rows Op Ar cols .Sh DESCRIPTION -.Nm Rs -reads the standard input, interpreting each line as a row +The +.Nm +utility reads the standard input, interpreting each line as a row of blank-separated entries in an array, transforms the array according to the options, and writes it on the standard output. @@ -168,8 +169,9 @@ unless the first non-ignored line is longer than the display width. Option letters which take numerical arguments interpret a missing number as zero unless otherwise indicated. .Sh EXAMPLES -.Nm Rs -can be used as a filter to convert the stream output +The +.Nm +utility can be used as a filter to convert the stream output of certain programs (e.g., .Xr spell , .Xr du , diff --git a/usr.bin/rsh/rsh.1 b/usr.bin/rsh/rsh.1 index 5ca5887aea187..ed02ea3c2144e 100644 --- a/usr.bin/rsh/rsh.1 +++ b/usr.bin/rsh/rsh.1 @@ -47,14 +47,16 @@ .Ar host .Op command .Sh DESCRIPTION -.Nm Rsh -executes +The +.Nm +utility executes .Ar command on .Ar host . .Pp -.Nm Rsh -copies its standard input to the remote command, the standard +The +.Nm +utility copies its standard input to the remote command, the standard output of the remote command to its standard output, and the standard error of the remote command to its standard error. Interrupt, quit and terminate signals are propagated to the remote diff --git a/usr.bin/rup/rup.1 b/usr.bin/rup/rup.1 index 0241076d460cf..d543ba05288ae 100644 --- a/usr.bin/rup/rup.1 +++ b/usr.bin/rup/rup.1 @@ -43,8 +43,9 @@ .Nm .Op Ar host ... .Sh DESCRIPTION -.Nm Rup -displays a summary of the current system status of a particular +The +.Nm +utility displays a summary of the current system status of a particular .Ar host or all hosts on the local network. The output shows the current time of day, how long the system has @@ -57,8 +58,9 @@ The .Xr rpc.rstatd 8 daemon must be running on the remote host for this command to work. -.Nm Rup -uses an RPC protocol defined in +The +.Nm +utility uses an RPC protocol defined in .Pa /usr/include/rpcsvc/rstat.x . .Sh EXAMPLES .Bd -literal diff --git a/usr.bin/ruptime/ruptime.1 b/usr.bin/ruptime/ruptime.1 index 533f09cb866dc..f15153aaeeddc 100644 --- a/usr.bin/ruptime/ruptime.1 +++ b/usr.bin/ruptime/ruptime.1 @@ -42,8 +42,9 @@ .Nm .Op Fl alrtu .Sh DESCRIPTION -.Nm Ruptime -gives a status line like +The +.Nm +utility gives a status line like .Xr uptime 1 for each machine on the local network; these are formed from packets broadcast by each host on the network once every three minutes. @@ -78,6 +79,7 @@ data files .Xr uptime 1 , .Xr rwhod 8 .Sh HISTORY -.Nm Ruptime -appeared in +A +.Nm +utility appeared in .Bx 4.2 . diff --git a/usr.bin/script/script.1 b/usr.bin/script/script.1 index 506da270a1939..e455dfc1dcab8 100644 --- a/usr.bin/script/script.1 +++ b/usr.bin/script/script.1 @@ -46,8 +46,9 @@ .Op Fl t Ar time .Op Ar file Op command ... .Sh DESCRIPTION -.Nm Script -makes a typescript of everything printed on your terminal. +The +.Nm +utility makes a typescript of everything printed on your terminal. It is useful for students who need a hardcopy record of an interactive session as proof of an assignment, as the typescript file can be printed out later with @@ -108,8 +109,9 @@ C-shell, Certain interactive commands, such as .Xr vi 1 , create garbage in the typescript file. -.Nm Script -works best with commands that do not manipulate the screen. +The +.Nm +utility works best with commands that do not manipulate the screen. The results are meant to emulate a hardcopy terminal, not an addressable one. .Sh ENVIRONMENT The following environment variable is utilized by @@ -138,8 +140,9 @@ The command appeared in .Bx 3.0 . .Sh BUGS -.Nm Script -places +The +.Nm +utility places .Sy everything in the log file, including linefeeds and backspaces. This is not what the naive user expects. diff --git a/usr.bin/size/size.1 b/usr.bin/size/size.1 index 96be1c5f0a730..30eea9651fba2 100644 --- a/usr.bin/size/size.1 +++ b/usr.bin/size/size.1 @@ -42,8 +42,9 @@ .Nm .Op Ar object_file ... .Sh DESCRIPTION -.Nm Size -displays the text, data and bss segment sizes of the specified +The +.Nm +utility displays the text, data and bss segment sizes of the specified .Ar object_file in bytes (in decimal), and the sum of the three segments (in decimal and hexadecimal). diff --git a/usr.bin/soelim/soelim.1 b/usr.bin/soelim/soelim.1 index 406b9a1a810c6..31aeca12dbdf2 100644 --- a/usr.bin/soelim/soelim.1 +++ b/usr.bin/soelim/soelim.1 @@ -42,7 +42,9 @@ .Nm .Op Ar .Sh DESCRIPTION -.Nm Soelim +The +.Nm +utility reads the specified files or the standard input and performs the textual inclusion implied by the .Xr nroff 1 diff --git a/usr.bin/strings/strings.1 b/usr.bin/strings/strings.1 index 3b820ba7feb96..94b6bce16ad0d 100644 --- a/usr.bin/strings/strings.1 +++ b/usr.bin/strings/strings.1 @@ -44,7 +44,9 @@ .Op Fl n Ar number .Op Ar .Sh DESCRIPTION -.Nm Strings +The +.Nm +utility displays the sequences of printable characters in each of the specified files, or in the standard input, by default. By default, a sequence must be at least four characters in length @@ -73,8 +75,9 @@ Each string is preceded by its decimal offset in the file. .El .Pp -.Nm Strings -is useful for identifying random binaries, among other things. +The +.Nm +utility is useful for identifying random binaries, among other things. .Sh SEE ALSO .Xr hexdump 1 .Sh BUGS diff --git a/usr.bin/strip/strip.1 b/usr.bin/strip/strip.1 index e91d6d9ada336..bc344cb03f4cf 100644 --- a/usr.bin/strip/strip.1 +++ b/usr.bin/strip/strip.1 @@ -60,8 +60,9 @@ Delete only debugging and empty symbols. Delete only debugging, compiler identification, and local symbols. .El .Pp -.Nm Strip -exits 0 on success and 1 if an error occurred. +The +.Nm +utility exits 0 on success and 1 if an error occurred. .Sh SEE ALSO .Xr cc 1 , .Xr ld 1 , diff --git a/usr.bin/su/su.1 b/usr.bin/su/su.1 index 6eb2882740556..472d5db3ba296 100644 --- a/usr.bin/su/su.1 +++ b/usr.bin/su/su.1 @@ -45,8 +45,9 @@ .Op Fl c Ar class .Op Ar login Op Ar args .Sh DESCRIPTION -.Nm Su -requests appropriate user credentials via PAM +The +.Nm +utility requests appropriate user credentials via PAM and switches to that user ID (the default user is the superuser). A shell is then executed. diff --git a/usr.bin/systat/systat.1 b/usr.bin/systat/systat.1 index abeaa12d62cd1..9e6812687dd1e 100644 --- a/usr.bin/systat/systat.1 +++ b/usr.bin/systat/systat.1 @@ -43,8 +43,9 @@ .Op Fl display .Op Ar refresh-interval .Sh DESCRIPTION -.Nm Systat -displays various system statistics in a screen oriented fashion +The +.Nm +utility displays various system statistics in a screen oriented fashion using the curses screen display library, .Xr ncurses 3 . .Pp diff --git a/usr.bin/talk/talk.1 b/usr.bin/talk/talk.1 index 95021afcd2a37..91e2cc4dea03a 100644 --- a/usr.bin/talk/talk.1 +++ b/usr.bin/talk/talk.1 @@ -43,8 +43,9 @@ .Ar person .Op Ar ttyname .Sh DESCRIPTION -.Nm Talk -is a visual communication program which copies lines from your +The +.Nm +utility is a visual communication program which copies lines from your terminal to that of another user. .Pp Options available: diff --git a/usr.bin/tconv/tconv.1 b/usr.bin/tconv/tconv.1 index 0419dca69fc68..1e52bebc7a76d 100644 --- a/usr.bin/tconv/tconv.1 +++ b/usr.bin/tconv/tconv.1 @@ -27,8 +27,9 @@ .Op Fl OUGdk .Op Ar file .Sh DESCRIPTION -.Nm Tconv -converts between the three terminal descriptions, +The +.Nm +utility converts between the three terminal descriptions, termcap, terminfo source, and terminfo binary, that the .Em tinfo @@ -98,8 +99,9 @@ but not of much use in most cases, as fields will be followed and incorporated into the output terminal description. .Pp -.Nm Tconv -should be able translate all standard termcap parameterized strings +The +.Nm +utility should be able translate all standard termcap parameterized strings terminfo format, but complex strings using GNU's %a code may be too hard to translate. If @@ -161,7 +163,8 @@ may refer to the last line of an entry instead of the line in the entry that generated the warning. .Sh BUGS More warning messages could be generated. -.Nm Tconv -can't translate to termcap. Binaries generated will have canceled +The +.Nm +utility can't translate to termcap. Binaries generated will have canceled capabilities marked as canceled, which is incompatible with System V Release 2.0 terminfo. diff --git a/usr.bin/tcopy/tcopy.1 b/usr.bin/tcopy/tcopy.1 index 1891f6572b4e2..8f48d1897be24 100644 --- a/usr.bin/tcopy/tcopy.1 +++ b/usr.bin/tcopy/tcopy.1 @@ -45,11 +45,13 @@ .Oo Ar src Op Ar dest .Oc .Sh DESCRIPTION -.Nm Tcopy -is designed to copy magnetic tapes. The only assumption made +The +.Nm +utility is designed to copy magnetic tapes. The only assumption made about the tape is that there are two tape marks at the end. -.Nm Tcopy -with only a source tape +The +.Nm +utility with only a source tape .Pf ( Ar /dev/rsa0 by default) specified will print information about the sizes of records and tape files. If a destination diff --git a/usr.bin/telnet/telnet.1 b/usr.bin/telnet/telnet.1 index 7e06a0b556ab6..ad036a3ead919 100644 --- a/usr.bin/telnet/telnet.1 +++ b/usr.bin/telnet/telnet.1 @@ -1380,8 +1380,9 @@ is specified, will print the help information for just that command. .El .Sh ENVIRONMENT +The .Nm -uses at least the +utility uses at least the .Ev HOME , .Ev SHELL , .Ev DISPLAY , diff --git a/usr.bin/tftp/tftp.1 b/usr.bin/tftp/tftp.1 index 7f21590398133..aef3bf0d6bae5 100644 --- a/usr.bin/tftp/tftp.1 +++ b/usr.bin/tftp/tftp.1 @@ -42,8 +42,9 @@ .Nm .Op Ar host .Sh DESCRIPTION -.Nm Tftp -is the user interface to the Internet +The +.Nm +utility is the user interface to the Internet .Tn TFTP (Trivial File Transfer Protocol), which allows users to transfer files to and from a remote machine. diff --git a/usr.bin/tip/tip/tip.1 b/usr.bin/tip/tip/tip.1 index f74caaa933be3..e2b13df362e24 100644 --- a/usr.bin/tip/tip/tip.1 +++ b/usr.bin/tip/tip/tip.1 @@ -80,12 +80,14 @@ Escape to a shell (exiting the shell will return you to tip). .It Ic \&~> Copy file from local to remote. -.Nm Tip -prompts for the name of a local file to transmit. +The +.Nm +utility prompts for the name of a local file to transmit. .It Ic \&~< Copy file from remote to local. -.Nm Tip -prompts first for the name of the file to be sent, then for +The +.Nm +utility prompts first for the name of the file to be sent, then for a command to be executed on the remote machine. .It Ic \&~p Ar from Op Ar to Send a file to a remote @@ -161,8 +163,9 @@ the side that displays output from the remote host, is left running. Get a summary of the tilde escapes .El .Pp -.Nm Tip -uses the file +The +.Nm +utility uses the file .Pa /etc/remote to find how to reach a particular system and to find out how it should operate while talking @@ -192,8 +195,9 @@ erase and kill characters. A null line in response to a prompt, or an interrupt, will abort the dialogue and return you to the remote machine. .Pp -.Nm Tip -guards against multiple users connecting to a remote system +The +.Nm +utility guards against multiple users connecting to a remote system by opening modems and terminal lines with exclusive access, and by honoring the locking protocol used by .Xr uucico 8 . @@ -215,18 +219,21 @@ When .Nm must dial a phone number to connect to a system it will print various messages indicating its actions. -.Nm Tip -supports modems that use the AT command set. -.Nm Tip -uses the file +The +.Nm +utility supports modems that use the AT command set. +The +.Nm +utility uses the file .Pa /etc/modems to find out how to operate with a particular modem; refer to .Xr modems 5 for a full description. .Ss VARIABLES -.Nm Tip -maintains a set of +The +.Nm +utility maintains a set of .Ar variables which control its operation. Some of these variables are read-only to normal users (root is allowed @@ -291,8 +298,9 @@ a ~> file transfer command; abbreviated .Ar eofw . .It Ar eol (str) The set of characters which indicate an end-of-line. -.Nm Tip -will recognize escape characters only after an end-of-line. +The +.Nm +utility will recognize escape characters only after an end-of-line. .It Ar escape (char) The command prefix (escape) character; abbreviated .Ar es ; @@ -398,8 +406,9 @@ of lines transferred during a file transfer operations, and more. .El .Sh ENVIRONMENT -.Nm Tip -uses the following environment variables: +The +.Nm +utility uses the following environment variables: .Bl -tag -width Fl .It Ev SHELL (str) The name of the shell to use for the ~! command; default diff --git a/usr.bin/true/true.1 b/usr.bin/true/true.1 index 5068d0c93eaac..58d3a0236878c 100644 --- a/usr.bin/true/true.1 +++ b/usr.bin/true/true.1 @@ -62,6 +62,6 @@ manual page. .Sh STANDARDS The .Nm -function is expected to be +utility is expected to be .St -p1003.2 compatible. diff --git a/usr.bin/truss/truss.1 b/usr.bin/truss/truss.1 index a0ef8dd55968f..f2a99cc79c03c 100644 --- a/usr.bin/truss/truss.1 +++ b/usr.bin/truss/truss.1 @@ -17,8 +17,9 @@ command .Op args .Sh DESCRIPTION -.Nm Truss -traces the system calls called by the specified process or program. +The +.Nm +utility traces the system calls called by the specified process or program. Output is to the specified output file, or standard error by default. It does this by stopping and restarting the process being monitored via .Xr procfs 5 . diff --git a/usr.bin/tset/tset.1 b/usr.bin/tset/tset.1 index 185aafc0fcd0a..2eb0dcbf3c4a4 100644 --- a/usr.bin/tset/tset.1 +++ b/usr.bin/tset/tset.1 @@ -57,10 +57,10 @@ .Op Fl m Ar mapping .Op Ar terminal .Sh DESCRIPTION -.Nm Tset -initializes terminals. -.Nm Tset -first determines the type of terminal that you are using. +The +.Nm +utility initializes terminals. +It first determines the type of terminal that you are using. This determination is done as follows, using the first terminal type found. .Pp .Bl -bullet -compact -offset indent diff --git a/usr.bin/tsort/tsort.1 b/usr.bin/tsort/tsort.1 index 724c15117e21f..f629b6130bfbe 100644 --- a/usr.bin/tsort/tsort.1 +++ b/usr.bin/tsort/tsort.1 @@ -48,8 +48,9 @@ .Op Fl q .Op Ar file .Sh DESCRIPTION -.Nm Tsort -takes a list of pairs of node names representing directed arcs in +The +.Nm +utility takes a list of pairs of node names representing directed arcs in a graph and prints the nodes in topological order on standard output. Input is taken from the named .Ar file , diff --git a/usr.bin/tty/tty.1 b/usr.bin/tty/tty.1 index dbf0e777661c5..357432f2f8497 100644 --- a/usr.bin/tty/tty.1 +++ b/usr.bin/tty/tty.1 @@ -65,7 +65,9 @@ option is deprecated in favor of the command. .El .Pp -.Nm Tty +The +.Nm +utility exits 0 if the standard input is a terminal, 1 if the standard input is not a terminal, and >1 if an error occurs. .Sh SEE ALSO diff --git a/usr.bin/uac/uac.1 b/usr.bin/uac/uac.1 index 0246a66160299..4256417676f90 100644 --- a/usr.bin/uac/uac.1 +++ b/usr.bin/uac/uac.1 @@ -34,8 +34,9 @@ .Nm .Op Fl fprs .Sh DESCRIPTION +The .Nm -sets the per-process handling of +utility sets the per-process handling of .Dq Unaligned Access events. Unlike many other CPU's the DEC Alpha processor cannot access unaligned data. @@ -88,8 +89,9 @@ command syntax is incompatible with the DEC OSF/1 syntax. .Sh SEE ALSO .Xr signal 3 .Sh HISTORY +A .Nm -first appeared in DEC OSF/1. +utility first appeared in DEC OSF/1. .Sh AUTHORS .An -nosplit The diff --git a/usr.bin/ul/ul.1 b/usr.bin/ul/ul.1 index 256930bff77c9..2deb3025ffec1 100644 --- a/usr.bin/ul/ul.1 +++ b/usr.bin/ul/ul.1 @@ -44,8 +44,9 @@ .Op Fl t Ar terminal .Op Ar name Ar ... .Sh DESCRIPTION -.Nm Ul -reads the named files (or standard input if none are given) +The +.Nm +utility reads the named files (or standard input if none are given) and translates occurrences of underscores to the sequence which indicates underlining for the terminal in use, as specified by the environment variable diff --git a/usr.bin/unifdef/unifdef.1 b/usr.bin/unifdef/unifdef.1 index 6d10c3610a6b7..b282c024474e8 100644 --- a/usr.bin/unifdef/unifdef.1 +++ b/usr.bin/unifdef/unifdef.1 @@ -53,11 +53,13 @@ .Ar ... .Op Ar file .Sh DESCRIPTION -.Nm Unifdef -is useful for removing ifdef'ed lines +The +.Nm +utility removes ifdef'ed lines from a file while otherwise leaving the file alone. -.Nm Unifdef -acts on +The +.Nm +utility acts on #ifdef, #ifndef, #else, and #endif lines, and it knows only enough about C to know when one of these is inactive @@ -130,8 +132,9 @@ and above. .El .Pp -.Nm Unifdef -copies its output to +The +.Nm +utility copies its output to .Em stdout and will take its input from .Em stdin @@ -139,8 +142,9 @@ if no .Ar file argument is given. .Pp -.Nm Unifdef -works nicely with the +The +.Nm +utility works nicely with the .Fl D Ns Ar sym option added to .Xr diff 1 diff --git a/usr.bin/unvis/unvis.1 b/usr.bin/unvis/unvis.1 index 7b9f88558751a..658bfa323f006 100644 --- a/usr.bin/unvis/unvis.1 +++ b/usr.bin/unvis/unvis.1 @@ -42,8 +42,9 @@ .Nm .Op Ar .Sh DESCRIPTION -.Nm Unvis -is the inverse function of +The +.Nm +utility is the inverse function of .Xr vis 1 . It reverts a visual representation of data back to its original form on standard output. diff --git a/usr.bin/usbhidctl/usbhidctl.1 b/usr.bin/usbhidctl/usbhidctl.1 index 3a9a49a8aeb3a..027b045a28af3 100644 --- a/usr.bin/usbhidctl/usbhidctl.1 +++ b/usr.bin/usbhidctl/usbhidctl.1 @@ -52,8 +52,9 @@ .Op Fl v .Op Ar item ... .Sh DESCRIPTION +The .Nm -can be used to dump the state of a USB HID (Human Interface Device). +utility can be used to dump the state of a USB HID (Human Interface Device). Each named .Ar item is printed. @@ -79,8 +80,9 @@ Be verbose. .Pa /usr/share/misc/usb_hid_usages The default HID usage table. .Sh BUGS +The .Nm -cannot show nor set output and feature items. +utility cannot show nor set output and feature items. .Sh SEE ALSO .Xr usb 3 , .Xr uhid 4 , diff --git a/usr.bin/users/users.1 b/usr.bin/users/users.1 index 7474464c6a220..c3454c6784d0b 100644 --- a/usr.bin/users/users.1 +++ b/usr.bin/users/users.1 @@ -41,8 +41,9 @@ .Sh SYNOPSIS .Nm .Sh DESCRIPTION -.Nm Users -lists the login names of the users currently on the system, +The +.Nm +utility lists the login names of the users currently on the system, in sorted order, space separated, on a single line. .Sh FILES .Bl -tag -width /var/run/utmp diff --git a/usr.bin/uuencode/uuencode.1 b/usr.bin/uuencode/uuencode.1 index ab1f328f8f093..c254ec215a5e9 100644 --- a/usr.bin/uuencode/uuencode.1 +++ b/usr.bin/uuencode/uuencode.1 @@ -53,16 +53,18 @@ .Fl o Ar output_file .Op Ar file .Sh DESCRIPTION -.Nm Uuencode +The +.Nm and .Nm uudecode -are used to transmit binary files over transmission mediums +utilities are used to transmit binary files over transmission mediums that do not support other than simple .Tn ASCII data. .Pp -.Nm Uuencode -reads +The +.Nm +utility reads .Ar file (or by default the standard input) and writes an encoded version to the standard output, or @@ -76,8 +78,9 @@ mode of the file and the operand for use by .Nm uudecode . .Pp -.Nm Uudecode -transforms +The +.Nm uudecode +utility transforms .Em uuencoded files (or by default, the standard input) into the original form. The resulting file is named either @@ -87,8 +90,9 @@ or (depending on options passed to .Ar output_file and will have the mode of the original file except that setuid and execute bits are not retained. -.Nm Uudecode -ignores any leading and trailing lines. +The +.Nm uudecode +utility ignores any leading and trailing lines. .Pp The following options are available for .Nm : diff --git a/usr.bin/vgrind/vgrind.1 b/usr.bin/vgrind/vgrind.1 index c26485b718c11..e6d51ba5935a4 100644 --- a/usr.bin/vgrind/vgrind.1 +++ b/usr.bin/vgrind/vgrind.1 @@ -53,16 +53,18 @@ .Op Fl x .Ar name Ar ... .Sh DESCRIPTION -.Nm Vgrind -formats the program sources which are arguments +The +.Nm +utility formats the program sources which are arguments in a nice style using .Xr troff 1 Comments are placed in italics, keywords in bold face, and the name of the current function is listed down the margin of each page as it is encountered. .Pp -.Nm Vgrind -runs in two basic modes, filter mode (see the +The +.Nm +utility runs in two basic modes, filter mode (see the .Fl f option) or regular mode. In filter mode .Nm diff --git a/usr.bin/vis/vis.1 b/usr.bin/vis/vis.1 index 53196cdfa3404..274574145bc38 100644 --- a/usr.bin/vis/vis.1 +++ b/usr.bin/vis/vis.1 @@ -44,8 +44,9 @@ .Op Fl F Ar foldwidth .Op Ar .Sh DESCRIPTION -.Nm Vis -is a filter for converting non-printable characters +The +.Nm +utility is a filter for converting non-printable characters into a visual representation. It differs from .Ql cat -v in that diff --git a/usr.bin/wall/wall.1 b/usr.bin/wall/wall.1 index b68b293926cbe..7759f768b3516 100644 --- a/usr.bin/wall/wall.1 +++ b/usr.bin/wall/wall.1 @@ -43,8 +43,9 @@ .Op Fl g Ar group .Op Ar file .Sh DESCRIPTION -.Nm Wall -displays the contents of +The +.Nm +utility displays the contents of .Ar file or, by default, its standard input, on the terminals of all currently logged in users. diff --git a/usr.bin/which/which.1 b/usr.bin/which/which.1 index 5563e2474827c..e64ccbb576847 100644 --- a/usr.bin/which/which.1 +++ b/usr.bin/which/which.1 @@ -40,7 +40,9 @@ .Op Ar command .Ar ... .Sh DESCRIPTION -.Nm Which +The +.Nm +utility takes a list of command names and searches the path for each executable file that would be run had these commands actually been invoked. .Pp diff --git a/usr.bin/whois/whois.1 b/usr.bin/whois/whois.1 index d6c894637aeac..f3153426835e6 100644 --- a/usr.bin/whois/whois.1 +++ b/usr.bin/whois/whois.1 @@ -45,8 +45,9 @@ .Op Fl p Ar port .Ar name ... .Sh DESCRIPTION +The .Nm -looks up records in the databases maintained by several +utility looks up records in the databases maintained by several Network Information Centers .Pq Tn NICs . .Pp diff --git a/usr.bin/window/window.1 b/usr.bin/window/window.1 index d3e0432059fd6..a8701680f7140 100644 --- a/usr.bin/window/window.1 +++ b/usr.bin/window/window.1 @@ -49,8 +49,9 @@ .Op Fl e Ar escape-char .Op Fl c Ar command .Sh DESCRIPTION -.Nm Window -implements a window environment on +The +.Nm +utility implements a window environment on .Tn ASCII terminals. .Pp @@ -367,8 +368,9 @@ A statement is either a conditional or an expression. Expression statements are terminated with a new line or ``;''. To continue an expression on the next line, terminate the first line with ``\\''. .Ss Conditional Statement -.Nm Window -has a single control structure: +The +.Nm +utility has a single control structure: the fully bracketed if statement in the form .Pp .Bd -literal -offset indent -compact @@ -926,8 +928,9 @@ field of the terminal's entry, is used. .El .Sh ENVIRONMENT -.Nm Window -utilizes these environment variables: +The +.Nm +utility utilizes these environment variables: .Ev HOME , .Ev SHELL , .Ev TERM , diff --git a/usr.bin/write/write.1 b/usr.bin/write/write.1 index 0f8df123197be..ff004de3321d9 100644 --- a/usr.bin/write/write.1 +++ b/usr.bin/write/write.1 @@ -46,8 +46,9 @@ .Ar user .Op Ar ttyname .Sh DESCRIPTION -.Nm Write -allows you to communicate with other users, by copying lines from +The +.Nm +utility allows you to communicate with other users, by copying lines from your terminal to theirs. .Pp When you run the diff --git a/usr.bin/xinstall/install.1 b/usr.bin/xinstall/install.1 index 443cbd3caba08..e2e0ad9a3ed27 100644 --- a/usr.bin/xinstall/install.1 +++ b/usr.bin/xinstall/install.1 @@ -224,12 +224,14 @@ exits abnormally. File flags cannot be set by .Xr fchflags 2 over a NFS file system. Other file systems do not have a concept of flags. +The .Nm -will only warn when flags could not be set on a file system +utility will only warn when flags could not be set on a file system that does not support them. .Pp +The .Nm -with +utility with .Fl v falsely says a file is copied when .Fl C diff --git a/usr.bin/xlint/xlint/lint.1 b/usr.bin/xlint/xlint/lint.1 index 8bd14d71afbbc..182edddc3cf8f 100644 --- a/usr.bin/xlint/xlint/lint.1 +++ b/usr.bin/xlint/xlint/lint.1 @@ -67,14 +67,16 @@ .Ar .Ek .Sh DESCRIPTION +The .Nm -attempts to detect features of the named C program files +utility attempts to detect features of the named C program files that are likely to be bugs, to be non-portable, or to be wasteful. It also performs stricter type checking than does the C compiler. +The .Nm -runs the C preprocessor as its first phase, with the +utility runs the C preprocessor as its first phase, with the preprocessor symbol .Dq Dv lint defined to allow certain questionable code to be altered @@ -119,14 +121,16 @@ files are analogous to the from .Pa .c files. +The .Nm -also accepts special libraries specified with the +utility also accepts special libraries specified with the .Fl l option, which contain definitions of library routines and variables. .Pp +The .Nm -takes all the +utility takes all the .Pa .c , .ln , and .Pa llib-l Ns Ar library Ns Pa .ln @@ -357,8 +361,9 @@ and before searching the standard place. .It Fl F Print pathnames of files. +The .Nm -normally prints the filename without the path. +utility normally prints the filename without the path. .It Fl H If a complaint stems from an included file .Nm @@ -405,8 +410,9 @@ and ids can be found in .Ss Input Grammar .Nm Ns 's first pass reads standard C source files. +The .Nm -recognizes the following C comments as commands. +utility recognizes the following C comments as commands. .Bl -tag -width indent .It Li /* ARGSUSED Ns Ar n Li */ makes diff --git a/usr.bin/xstr/xstr.1 b/usr.bin/xstr/xstr.1 index 2adbcc74bc344..390e398a5248b 100644 --- a/usr.bin/xstr/xstr.1 +++ b/usr.bin/xstr/xstr.1 @@ -45,8 +45,9 @@ .Op Fl v .Op Ar file .Sh DESCRIPTION -.Nm Xstr -maintains a file +The +.Nm +utility maintains a file .Pa strings into which strings in component parts of a large program are hashed. These strings are replaced with references to this common area. @@ -56,11 +57,9 @@ are also read-only. Available options: .Bl -tag -width Ds .It Fl -.Nm Xstr -reads from the standard input. +Read from the standard input. .It Fl c -.Nm Xstr -will extract the strings from the C source +Extract the strings from the C source .Ar file or the standard input .Pq Fl , @@ -98,8 +97,9 @@ of the program. If possible, the array can be made read-only (shared) saving space and swap overhead. .Pp -.Nm Xstr -can also be used on a single file. +The +.Nm +utility can also be used on a single file. A command .Bd -literal -offset indent xstr name @@ -128,8 +128,9 @@ cc \-c x.c mv x.o name.o .Ed .Pp -.Nm Xstr -does not touch the file +The +.Nm +utility does not touch the file .Pa strings unless new items are added, thus .Xr make 1 diff --git a/usr.bin/yacc/yacc.1 b/usr.bin/yacc/yacc.1 index c41bb728a1191..fb9178c4188a3 100644 --- a/usr.bin/yacc/yacc.1 +++ b/usr.bin/yacc/yacc.1 @@ -50,14 +50,16 @@ .Op Fl p Ar symbol_prefix .Ar filename .Sh DESCRIPTION -.Nm Yacc -reads the grammar specification in the file +The +.Nm +utility reads the grammar specification in the file .Ar filename and generates an LR(1) parser for it. The parsers consist of a set of LALR(1) parsing tables and a driver routine written in the C programming language. -.Nm Yacc -normally writes the parse tables and the driver routine to the file +The +.Nm +utility normally writes the parse tables and the driver routine to the file .Pa y.tab.c . .Pp The following options are available: diff --git a/usr.bin/yes/yes.1 b/usr.bin/yes/yes.1 index de28a88b57c9b..9b4b37712a6c7 100644 --- a/usr.bin/yes/yes.1 +++ b/usr.bin/yes/yes.1 @@ -42,8 +42,9 @@ .Nm .Op Ar expletive .Sh DESCRIPTION -.Nm Yes -outputs +The +.Nm +utility outputs .Ar expletive , or, by default, .Dq y , diff --git a/usr.bin/ypcat/ypcat.1 b/usr.bin/ypcat/ypcat.1 index 4bc09e37fd511..8a2565200354b 100644 --- a/usr.bin/ypcat/ypcat.1 +++ b/usr.bin/ypcat/ypcat.1 @@ -42,8 +42,9 @@ .Nm .Fl x .Sh DESCRIPTION -.Nm Ypcat -prints out the values of all keys from the +The +.Nm +utility prints out the values of all keys from the .Tn YP database specified by .Ar mapname , diff --git a/usr.bin/ypmatch/ypmatch.1 b/usr.bin/ypmatch/ypmatch.1 index b34980a9eb9f7..5f4a4cab278df 100644 --- a/usr.bin/ypmatch/ypmatch.1 +++ b/usr.bin/ypmatch/ypmatch.1 @@ -43,8 +43,9 @@ .Nm .Fl x .Sh DESCRIPTION -.Nm Ypmatch -prints out the values of one or more keys from the +The +.Nm +utility prints out the values of one or more keys from the .Tn YP database specified by .Ar mapname , diff --git a/usr.bin/ypwhich/ypwhich.1 b/usr.bin/ypwhich/ypwhich.1 index 1c6b813e3a556..47d4292d49e67 100644 --- a/usr.bin/ypwhich/ypwhich.1 +++ b/usr.bin/ypwhich/ypwhich.1 @@ -46,8 +46,9 @@ .Nm .Fl x .Sh DESCRIPTION -.Nm Ypwhich -tells which +The +.Nm +utility tells which .Tn YP server supplies .Tn YP |