diff --git a/usr.bin/c89/c89.1 b/usr.bin/c89/c89.1 index e7411822bdf0..1d75d30b65f9 100644 --- a/usr.bin/c89/c89.1 +++ b/usr.bin/c89/c89.1 @@ -60,7 +60,8 @@ object files that are produced. .It Fl D Ar name Ns Op = Ns Ar value Define name as if by a C-language .Ic #define -directive. If +directive. +If no .Dq = Ns Ar value is given, a value of 1 will be used. @@ -69,11 +70,13 @@ translation as specified by .St -p1003.2 you need to define .Dv _POSIX_SOURCE -either in the source or using this option. The +either in the source or using this option. +The .Fl D option has lower precedence than the .Fl U -option. That is, if +option. +That is, if .Ar name is used in both a .Fl U @@ -81,7 +84,8 @@ and a .Fl D option, .Ar name -will be undefined regardless of the order of the options. The +will be undefined regardless of the order of the options. +The .Fl D option may be specified more than once. .It Fl E @@ -93,20 +97,24 @@ Produce symbolic information in the object or executable files. Change the algorithm for searching for headers whose names are not absolute pathnames to look in the directory named by the .Ar directory -pathname before looking in the usual places. Thus, headers whose +pathname before looking in the usual places. +Thus, headers whose names are enclosed in double-quotes ("") will be searched for first in the directory of the file with the .Ic #include line, then in directories named in .Fl I -options, and last in the usual places. For +options, and last in the usual places. +For headers whose names are enclosed in angle brackets (<>), the header will be searched for only in directories named in .Fl I -options and then in the usual places. Directories named in +options and then in the usual places. +Directories named in .Fl I -options shall be searched in the order specified. The +options shall be searched in the order specified. +The .Fl I option may be specified more than once. .It Fl L Ar directory @@ -114,9 +122,11 @@ Change the algorithm of searching for the libraries named in the .Fl l objects to look in the directory named by the .Ar directory -pathname before looking in the usual places. Directories named in +pathname before looking in the usual places. +Directories named in .Fl L -options will be searched in the order specified. The +options will be searched in the order specified. +The .Fl L option may be specified more than once. .It Fl o Ar outfile @@ -141,11 +151,14 @@ option may be specified more than once. .Pp An operand is either in the form of a pathname or the form .Fl l -library. At least one operand of the pathname form needs to be -specified. Supported operands are of the form: +library. +At least one operand of the pathname form needs to be +specified. +Supported operands are of the form: .Bl -tag -offset indent -width "-l library" .It Ar file Ns Pa .c -A C-language source file to be compiled and optionally linked. The +A C-language source file to be compiled and optionally linked. +The operand must be of this form if the .Fl c option is used. diff --git a/usr.bin/calendar/calendar.1 b/usr.bin/calendar/calendar.1 index eb9d92c092bf..8a86482ee5b0 100644 --- a/usr.bin/calendar/calendar.1 +++ b/usr.bin/calendar/calendar.1 @@ -128,7 +128,7 @@ or negative integer. ``Paskha'', is Orthodox Easter for this year, and may be followed by a positive or negative integer. .Pp -Weekdays may be followed by ``-4'' ... ``+5'' (aliases for +Weekdays may be followed by ``-4'' ...\& ``+5'' (aliases for last, first, second, third, fourth) for moving events like ``the last Monday in April''. .Pp @@ -217,7 +217,7 @@ Calendar of events in France. .It Pa calendar.german Calendar of events in Germany. .It Pa calendar.history -Everything else, mostly U.S. historical events. +Everything else, mostly U.S.\& historical events. .It Pa calendar.holiday Other holidays, including the not-well-known, obscure, and .Em really @@ -236,7 +236,7 @@ Russian calendar. .It Pa calendar.southafrica Calendar of events in South Africa. .It Pa calendar.usholiday -U.S. holidays. +U.S.\& holidays. This calendar should be updated yearly by the local system administrator so that roving holidays are set correctly for the current year. .It Pa calendar.world diff --git a/usr.bin/checknr/checknr.1 b/usr.bin/checknr/checknr.1 index 57fd49baba03..addbceeaaefd 100644 --- a/usr.bin/checknr/checknr.1 +++ b/usr.bin/checknr/checknr.1 @@ -90,11 +90,11 @@ size changes. Delimiters checked are: .Bl -enum .It -Font changes using \efx ... \efP. +Font changes using \efx ...\& \efP. .It -Size changes using \esx ... \es0. +Size changes using \esx ...\& \es0. .It -Macros that come in open ... close forms, for example, +Macros that come in open ...\& close forms, for example, the .TS and .TE macros which must always come in pairs. .El .Pp diff --git a/usr.bin/chpass/chpass.1 b/usr.bin/chpass/chpass.1 index d059d71cda6d..e6c9e18db032 100644 --- a/usr.bin/chpass/chpass.1 +++ b/usr.bin/chpass/chpass.1 @@ -163,7 +163,8 @@ Both of these fields should be unique across the system (and often across a group of systems) as they control file access. .Pp While it is possible to have multiple entries with identical login names -and/or identical user id's, it is usually a mistake to do so. Routines +and/or identical user id's, it is usually a mistake to do so. +Routines that manipulate these files will often return only one of the multiple entries, and that one by random selection. .Pp @@ -447,7 +448,8 @@ When invoked by the super-user on the NIS master server, allows unrestricted changes to the NIS passwd maps using dedicated, non-RPC-based mechanism (in this case, a .Ux -domain socket). The +domain socket). +The .Fl o flag can be used to force .Nm diff --git a/usr.bin/compress/compress.1 b/usr.bin/compress/compress.1 index 335d47fe3996..541b56b4dd42 100644 --- a/usr.bin/compress/compress.1 +++ b/usr.bin/compress/compress.1 @@ -128,7 +128,8 @@ If it is increasing, continues to use the existing code dictionary. However, if the compression ratio decreases, .Nm -discards the table of substrings and rebuilds it from scratch. This allows +discards the table of substrings and rebuilds it from scratch. +This allows the algorithm to adapt to the next "block" of the file. .Pp The diff --git a/usr.bin/du/du.1 b/usr.bin/du/du.1 index 355f296818a9..7e656f925176 100644 --- a/usr.bin/du/du.1 +++ b/usr.bin/du/du.1 @@ -72,11 +72,13 @@ This is the default. .It Fl a Display an entry for each file in a file hierarchy. .It Fl h -"Human-readable" output. Use unit suffixes: Byte, Kilobyte, Megabyte, +"Human-readable" output. +Use unit suffixes: Byte, Kilobyte, Megabyte, Gigabyte, Terabyte and Petabyte .It Fl r Generate messages about directories that cannot be read, files -that cannot be opened, and so on. This is the default case. +that cannot be opened, and so on. +This is the default case. This option exists solely for conformance with .St -xpg4 . .It Fl s diff --git a/usr.bin/ee/ee.1 b/usr.bin/ee/ee.1 index ad9676beea40..f57c99290ef7 100644 --- a/usr.bin/ee/ee.1 +++ b/usr.bin/ee/ee.1 @@ -20,9 +20,11 @@ The .Nm utility -is a simple screen oriented text editor. It is always in text insertion +is a simple screen oriented text editor. +It is always in text insertion mode unless there is a prompt at the bottom of the terminal, or a -menu present (in a box in the middle of the terminal). The +menu present (in a box in the middle of the terminal). +The .Nm ree utility is the same as .Nm , @@ -33,12 +35,14 @@ For .Nm to work properly, the environment variable .Ev TERM -must be set to indicate the type of terminal being used. For +must be set to indicate the type of terminal being used. +For example, for an .Tn HP 700/92 terminal, the .Ev TERM -variable should be set to "70092". See your System Administrator if +variable should be set to "70092". +See your System Administrator if you need more information. .Pp The following options are available: @@ -67,7 +71,8 @@ arrow keys, etc.). Since not all terminals have function keys, .Nm has the basic cursor movement functions assigned to control keys as -well as more intuitive keys on the keyboard when available. For +well as more intuitive keys on the keyboard when available. +For instance, to move the cursor up, the user can use the up arrow key, or .Em ^u . @@ -126,9 +131,11 @@ Pop up menu. .Ss "EMACS keys mode" Since many shells provide an Emacs mode (for cursor movement and other editing operations), some bindings that may be more useful for people familiar with -those bindings have been provided. These are accessible via the +those bindings have been provided. +These are accessible via the .Em settings -menu, or via the initialization file (see below). The mappings are as follows: +menu, or via the initialization file (see below). +The mappings are as follows: .Bl -tag -width indent .It ^a Move to the beginning of the line. @@ -196,10 +203,12 @@ Move the cursor in the direction indicated. .El .Ss Commands Some operations require more information than a single keystroke can -provide. For the most basic operations, there is a menu that can be +provide. +For the most basic operations, there is a menu that can be obtained by pressing the .Tn ESC -key. The same operations, and more can be performed by obtaining the +key. +The same operations, and more can be performed by obtaining the command prompt (^c) and typing in one of the commands below. .Bl -tag -width indent .It ! Ns Ar cmd @@ -242,8 +251,10 @@ key (or .Em ^[ if no .Em escape -key is present). When in the menu, the escape key can be -used to leave the menu without performing any operations. Use the up and +key is present). +When in the menu, the escape key can be +used to leave the menu without performing any operations. +Use the up and down arrow keys, or .Em ^u for moving up and @@ -272,11 +283,14 @@ the editor to a print command (see the section .It redraw screen Provide a means to repaint the screen if the screen has been corrupted. .It settings -Show the current values of the operating modes, and right margin. By +Show the current values of the operating modes, and right margin. +By pressing return when the cursor is on a particular item, the value can be -changed. To leave this menu, press the +changed. +To leave this menu, press the .Em escape -key. (See +key. +(See .Sx Modes below.) .It search @@ -304,7 +318,8 @@ A paragraph may be formatted two ways: explicitly by choosing the menu item, or by setting .Nm to automatically -format paragraphs. The automatic mode may be set via a menu, or via the +format paragraphs. +The automatic mode may be set via a menu, or via the initialization file. .Pp There are three states for text operation in @@ -312,29 +327,34 @@ There are three states for text operation in free-form, margins, and automatic formatting. .Pp -"Free-form" is best used for things like programming. There are no +"Free-form" is best used for things like programming. +There are no restrictions on the length of lines, and no formatting takes place. .Pp "Margins" allows the user to type in text without having to worry about going beyond the right margin (the right margin may be set in the .Em settings menu, the default is for the margin to be the right edge of the -terminal). This is the mode that allows the +terminal). +This is the mode that allows the .Em format paragraph menu item to work. .Pp -"Automatic formatting" provides word-processor-like behavior. The user +"Automatic formatting" provides word-processor-like behavior. +The user may type in text, while .Nm will make sure the entire paragraph fits within the width of the terminal every time the user inserts a space after -typing or deleting text. Margin observation must also be enabled in order for +typing or deleting text. +Margin observation must also be enabled in order for automatic formatting to occur. .Ss Modes Although .Nm is a 'modeless' editor (it is in text insertion mode all the -time), there are modes in some of the things it does. These include: +time), there are modes in some of the things it does. +These include: .Bl -tag -width indent .It tab expansion Tabs may be inserted as a single tab character, or replaced with spaces. @@ -348,7 +368,7 @@ While typing in text, the editor can try to keep it looking reasonably well within the width of the screen. .It eightbit characters Toggle whether eight bit characters are displayed as their value in angle -brackets (e.g. "<220>") or as a character. +brackets (e.g.\& "<220>") or as a character. .It info window A window showing the keyboard operations that can be performed can be displayed or not. @@ -356,7 +376,8 @@ displayed or not. Control keys may be given bindings similar to emacs, or not. .It 16 bit characters Toggles whether sixteen bit characters are handled as one 16-bit quantities or -two 8-bit quantities. This works primarily with the Chinese Big 5 code set. +two 8-bit quantities. +This works primarily with the Chinese Big 5 code set. .El .Pp You may set these modes via the initialization file (see below), or with a @@ -374,7 +395,8 @@ command. Using .Nm spell , the words that are not recognized will be placed at the top -of the file. For the +of the file. +For the .Nm ispell option, the file is written to disk, then @@ -391,13 +413,15 @@ initialization command .Em printcommand (see the section .Sx Initializing ee from a file -below). The default is to send the contents to +below). +The default is to send the contents to .Xr lp 1 . .Pp Whatever the user assigns to .Em printcommand must take input from -standard input. See your system administrator for more details. +standard input. +See your system administrator for more details. .Ss "Shell operations" Shell commands can be executed from within .Nm @@ -408,25 +432,31 @@ item in the menu, or by placing an exclamation mark ("!") before the command to execute at the .Em command: -prompt. Additionally, the user may direct the contents of the edit buffer +prompt. +Additionally, the user may direct the contents of the edit buffer out to a shell operation (via a pipe) by using the left angle bracket -(">"), followed by a "!" and the shell command to execute. The output of +(">"), followed by a "!" and the shell command to execute. +The output of a shell operation can also be directed into the edit buffer by using a -right angle bracket ("<") before the exclamation mark. These can even be +right angle bracket ("<") before the exclamation mark. +These can even be used together to send output to a shell operation and read back the -results into the editor. So, if the editor contained a list of words +results into the editor. +So, if the editor contained a list of words to be sorted, they could be sorted by typing the following at the command prompt: .Dl >\e0 (because all strings are greater than the null string). .It message -The message to be printed if the comparison succeeds. If the string +The message to be printed if the comparison succeeds. +If the string contains a .Xr printf 3 format specification, the value from the file (with any specified masking @@ -170,9 +174,11 @@ performed) is printed using the message as the format string. .El .Pp Some file formats contain additional information which is to be printed -along with the file type. A line which begins with the character +along with the file type. +A line which begins with the character .Em > -indicates additional tests and messages to be printed. The number of +indicates additional tests and messages to be printed. +The number of .Em > on the line indicates the level of the test; a line with no .Em > @@ -186,7 +192,8 @@ If the test on a line at level .Em n succeeds, the tests specified in all the subsequent lines at level .Em n+1 -are performed, and the messages printed if the tests succeed. The next +are performed, and the messages printed if the tests succeed. +The next line at level .Em n terminates this. diff --git a/usr.bin/finger/finger.1 b/usr.bin/finger/finger.1 index 68ac8b909608..21cb684feaa2 100644 --- a/usr.bin/finger/finger.1 +++ b/usr.bin/finger/finger.1 @@ -94,7 +94,8 @@ option, the office location and office phone information is displayed instead of the name of the remote host. .It Fl g This option restricts the gecos output to only the users' real -name. It also has the side-effect of restricting the output +name. +It also has the side-effect of restricting the output of the remote host when used in conjunction with the .Fl h option. @@ -247,6 +248,8 @@ command appeared in .Bx 3.0 . .Sh BUGS The current FINGER protocol RFC requires that the client keep the connection -fully open until the server closes. This prevents the use of the optimal -three-packet T/TCP exchange. (Servers which depend on this requirement are +fully open until the server closes. +This prevents the use of the optimal +three-packet T/TCP exchange. +(Servers which depend on this requirement are bogus but have nonetheless been observed in the Internet at large.) diff --git a/usr.bin/fstat/fstat.1 b/usr.bin/fstat/fstat.1 index 0c2ebf23afd4..5134d1e89ee9 100644 --- a/usr.bin/fstat/fstat.1 +++ b/usr.bin/fstat/fstat.1 @@ -79,7 +79,8 @@ which is the kernel image the system has booted from. Include memory-mapped files in the listing; normally these are excluded due to the extra processing required. .It Fl n -Numerical format. Print the device number (maj,min) of the file system +Numerical format. +Print the device number (maj,min) of the file system the file resides in rather than the mount point name; for special files, print the device number that the special device refers to rather than the filename @@ -91,12 +92,15 @@ Report all files open by the specified process. .It Fl u Report all files open by the specified user. .It Fl v -Verbose mode. Print error messages upon failures to locate particular -system data structures rather than silently ignoring them. Most of +Verbose mode. +Print error messages upon failures to locate particular +system data structures rather than silently ignoring them. +Most of these data structures are dynamically created or deleted and it is possible for them to disappear while .Nm -is running. This +is running. +This is normal and unavoidable since the rest of the system is running while .Nm itself is running. @@ -145,7 +149,8 @@ major/minor number of the device that this file resides in. .It Li INUM The inode number of the file. .It Li MODE -The mode of the file. If the +The mode of the file. +If the .Fl n flag isn't specified, the mode is printed using a symbolic format (see @@ -154,7 +159,8 @@ otherwise, the mode is printed as an octal number. .It Li SZ\&|DV If the file is not a character or block special, prints the size of -the file in bytes. Otherwise, if the +the file in bytes. +Otherwise, if the .Fl n flag is not specified, prints the name of the special file as located in @@ -177,7 +183,8 @@ flag is not, then this field is present and is the name associated with the given file. Normally the name cannot be determined since there is no mapping from an open file back to the directory entry that was used to open -that file. Also, since different directory entries may reference +that file. +Also, since different directory entries may reference the same file (via .Xr ln 1 ) , the name printed may not be the actual diff --git a/usr.bin/gcore/gcore.1 b/usr.bin/gcore/gcore.1 index 81f83d206811..64fa2474bfcc 100644 --- a/usr.bin/gcore/gcore.1 +++ b/usr.bin/gcore/gcore.1 @@ -68,8 +68,10 @@ Write the core file to the specified file instead of .Dq Pa core. . .It Fl s Stop the process while gathering the core image, and resume it -when done. This guarantees that the resulting core dump will -be in a consistent state. The process is resumed even if it was +when done. +This guarantees that the resulting core dump will +be in a consistent state. +The process is resumed even if it was already stopped. The same effect can be achieved manually with .Xr kill 1 . diff --git a/usr.bin/gencat/gencat.1 b/usr.bin/gencat/gencat.1 index 45a30271cd4e..6fffa51fd472 100644 --- a/usr.bin/gencat/gencat.1 +++ b/usr.bin/gencat/gencat.1 @@ -45,7 +45,8 @@ into a formatted message catalog file .Ar "output-file" . The file .Ar "output-file" -will be created if it does not already exist. If +will be created if it does not already exist. +If .Ar "output-file" does exist, its messages will be included in the new .Ar "output-file" . @@ -54,7 +55,8 @@ If set and message numbers collide, the new message text defined in will replace the old message text currently contained in .Ar "output-file" . .Sh INPUT FILES -The format of a message text source file is defined below. Note that +The format of a message text source file is defined below. +Note that the fields of a message text source line are separated by a single space character: any other space characters are considered to be part of the field contents. @@ -64,21 +66,27 @@ field contents. This line specifies the set identifier of the following messages until the next .Li $set -or end-of-file appears. The argument +or end-of-file appears. +The argument .Ar n is the set identifier which is defined as a number in the range -[1, (NL_SETMAX)]. Set identifiers must occur in ascending order within -a single source file, but need not be contiguous. Any string following -a space following the set identifier is treated as a comment. If no +[1, (NL_SETMAX)]. +Set identifiers must occur in ascending order within +a single source file, but need not be contiguous. +Any string following +a space following the set identifier is treated as a comment. +If no .Li $set directive is specified in a given source file, all messages will be located in the default message set NL_SETD. .It Li $del Ar n comment This line deletes messages from set .Ar n -from a message catalog. The +from a message catalog. +The .Ar n -specifies a set number. Any string following a space following the set +specifies a set number. +Any string following a space following the set number is treated as a comment. .It Li $ Ar comment A line beginning with @@ -87,7 +95,8 @@ followed by a space is treated as a comment. .It Ar m message-text A message line consists of a message identifier .Ar m -in the range [1, (NL_MSGMAX)]. The +in the range [1, (NL_MSGMAX)]. +The .Ar message-text is stored in the message catalog with the set identifier specified by the last @@ -97,13 +106,16 @@ directive, and the message identifier If the .Ar message-text is empty, and there is a space character following the message identifier, -an empty string is stored in the message catalog. If the +an empty string is stored in the message catalog. +If the .Ar message-text is empty, and if there is no space character following the message identifier, then the existing message in the current set with the -specified message identifier is deleted from the catalog. Message +specified message identifier is deleted from the catalog. +Message identifiers must be in ascending order within a single set, but -need not be contiguous. The +need not be contiguous. +The .Ar message-text length must be in the range [0, (NL_TEXTMAX)]. .It Li $quote Ar c @@ -112,19 +124,22 @@ This line specifies an optional quote character which can be used to surround .Ar message-text so that trailing space or empty messages are visible in message -source files. By default, or if an empty +source files. +By default, or if an empty .Li $quote directive is specified, no quoting of .Ar message-text will be recognized. .El .Pp -Empty lines in message source files are ignored. The effect of lines +Empty lines in message source files are ignored. +The effect of lines beginning with any character other than those described above is undefined. .Pp Text strings can contain the following special characters and escape -sequences. In addition, if a quote character is defined, it may be +sequences. +In addition, if a quote character is defined, it may be escaped as well to embed a literal quote character. .Pp .Bl -tag -width "\eooo" -offset indent -compact diff --git a/usr.bin/getopt/getopt.1 b/usr.bin/getopt/getopt.1 index 09680ff21ea1..3de5c77e5d84 100644 --- a/usr.bin/getopt/getopt.1 +++ b/usr.bin/getopt/getopt.1 @@ -109,7 +109,8 @@ has. .Pp Arguments containing white space or embedded shell metacharacters generally will not survive intact; this looks easy to fix but -isn't. People trying to fix +isn't. +People trying to fix .Nm or the example in this manpage should check the history of this file in @@ -129,6 +130,7 @@ command to set the arguments without disrupting the value(s) of shell options varies from one shell version to another. .Pp Each shellscript has to carry complex code to parse arguments halfway -correctly (like the example presented here). A better getopt-like tool +correctly (like the example presented here). +A better getopt-like tool would move much of the complexity into the tool and keep the client shell scripts simpler. diff --git a/usr.bin/gprof/gprof.1 b/usr.bin/gprof/gprof.1 index c6e842243194..55e8be808d31 100644 --- a/usr.bin/gprof/gprof.1 +++ b/usr.bin/gprof/gprof.1 @@ -67,7 +67,7 @@ option also links in versions of the library routines that are compiled for profiling. By convention these libraries have their name suffixed with .Pa _p , -i.e. the profiled version of +i.e., the profiled version of .Pa libc.a is .Pa libc_p.a @@ -237,10 +237,12 @@ to accumulate profile data across several runs of an file. .It Fl u Suppress the printing of functions whose names are not visible to -C programs. For the ELF object format, this means names that +C programs. +For the ELF object format, this means names that contain the .Ql .\& -character. For the a.out object format, it means names that do not +character. +For the a.out object format, it means names that do not begin with a .Ql _ character. diff --git a/usr.bin/hesinfo/hesinfo.1 b/usr.bin/hesinfo/hesinfo.1 index ef84c2df220f..e54d63d7496f 100644 --- a/usr.bin/hesinfo/hesinfo.1 +++ b/usr.bin/hesinfo/hesinfo.1 @@ -58,7 +58,7 @@ database. .Bl -tag -width indent .It Aq Ar username the 8\-character\-or\-less string used to identify users or classes -(e.g. joeuser, root, 1.00, etc). +(e.g.\& joeuser, root, 1.00, etc). Used with the .Ar Hesiod_Name_Types .Cm passwd , @@ -84,9 +84,9 @@ the name of an .Tn NFS server and its partition separated by a colon. .It Aq Ar workstation\-name -the machine name of an Athena workstation (e.g. E40\-343\-3). +the machine name of an Athena workstation (e.g.\& E40\-343\-3). .It Aq Ar service\-name -name of an Athena service (e.g. Zephyr). +name of an Athena service (e.g.\& Zephyr). .It Aq Ar service\-type name of .Ux diff --git a/usr.bin/hexdump/hexdump.1 b/usr.bin/hexdump/hexdump.1 index b53d47f85425..1a8273883ec6 100644 --- a/usr.bin/hexdump/hexdump.1 +++ b/usr.bin/hexdump/hexdump.1 @@ -310,7 +310,7 @@ If, as a result of the specification of the .Fl n option or end-of-file being reached, input data only partially satisfies a format string, the input block is zero-padded sufficiently -to display all available data (i.e. any format units overlapping the +to display all available data (i.e., any format units overlapping the end of data will display some number of the zero bytes). .Pp Further output by such format strings is replaced by an equivalent diff --git a/usr.bin/indent/indent.1 b/usr.bin/indent/indent.1 index d4ea504074be..cbbeb9454f16 100644 --- a/usr.bin/indent/indent.1 +++ b/usr.bin/indent/indent.1 @@ -88,12 +88,15 @@ The .Nm utility is a .Em C -program formatter. It reformats the +program formatter. +It reformats the .Em C program in the .Ar input-file -according to the switches. The switches which can be -specified are described below. They may appear before or after the file +according to the switches. +The switches which can be +specified are described below. +They may appear before or after the file names. .Pp .Sy NOTE : @@ -104,7 +107,8 @@ done `in-place', that is, the formatted file is written back into .Ar input-file and a backup copy of .Ar input-file -is written in the current directory. If +is written in the current directory. +If .Ar input-file is named .Sq Pa /blah/blah/file , @@ -125,24 +129,28 @@ The options listed below control the formatting style imposed by If .Fl bad is specified, a blank line is forced after every block of -declarations. Default: +declarations. +Default: .Fl nbad . .It Fl bap , nbap If .Fl bap -is specified, a blank line is forced after every procedure body. Default: +is specified, a blank line is forced after every procedure body. +Default: .Fl nbap . .It Fl bbb , nbbb If .Fl bbb -is specified, a blank line is forced before every block comment. Default: +is specified, a blank line is forced before every block comment. +Default: .Fl nbbb . .It Fl \&bc , nbc If .Fl \&bc is specified, then a newline is forced after each comma in a declaration. .Fl nbc -turns off this option. Default: +turns off this option. +Default: .Fl \&nbc . .It Fl \&br , \&bl Specifying @@ -165,12 +173,15 @@ if (...) { .Ed .Pp .It Fl c Ns Ar n -The column in which comments on code start. The default is 33. +The column in which comments on code start. +The default is 33. .It Fl cd Ns Ar n -The column in which comments on declarations start. The default +The column in which comments on declarations start. +The default is for these comments to start in the same column as those on code. .It Fl cdb , ncdb -Enables (disables) the placement of comment delimiters on blank lines. With +Enables (disables) the placement of comment delimiters on blank lines. +With this option enabled, comments look like this: .Bd -literal -offset indent /* @@ -184,18 +195,21 @@ Rather than like this: .Ed .Pp This only affects block comments, not comments to the right of -code. The default is +code. +The default is .Fl cdb . .It Fl ce , nce Enables (disables) forcing of `else's to cuddle up to the immediately preceding -`}'. The default is +`}'. +The default is .Fl \&ce . .It Fl \&ci Ns Ar n Sets the continuation indent to be .Ar n . Continuation lines will be indented that far from the beginning of the first line of the -statement. Parenthesized expressions have extra indentation added to +statement. +Parenthesized expressions have extra indentation added to indicate the nesting, unless .Fl \&lp is in effect @@ -210,17 +224,21 @@ tab stops to the right of the containing .Ic switch statement. .Fl cli0.5 -causes case labels to be indented half a tab stop. The +causes case labels to be indented half a tab stop. +The default is .Fl cli0 . .It Fl d Ns Ar n Controls the placement of comments which are not to the -right of code. For example, +right of code. +For example, .Fl \&d\&1 means that such comments are placed one indentation level to the -left of code. Specifying the default +left of code. +Specifying the default .Fl \&d\&0 -lines-up these comments with the code. See the section on comment +lines-up these comments with the code. +See the section on comment indentation below. .It Fl \&di Ns Ar n Specifies the indentation, in character positions, @@ -232,18 +250,21 @@ The default is .Fl \&dj left justifies declarations. .Fl ndj -indents declarations the same as code. The default is +indents declarations the same as code. +The default is .Fl ndj . .It Fl \&ei , nei Enables (disables) special .Ic else-if -processing. If it's enabled, an +processing. +If it's enabled, an .Ic if following an .Ic else will have the same indentation as the preceding .Ic \&if -statement. The default is +statement. +The default is .Fl ei . .It Fl fbs , nfbs Enables (disables) splitting the function declaration and opening brace @@ -253,10 +274,12 @@ The default is .It Fl fc1 , nfc1 Enables (disables) the formatting of comments that start in column 1. Often, comments whose leading `/' is in column 1 have been carefully -hand formatted by the programmer. In such cases, +hand formatted by the programmer. +In such cases, .Fl nfc1 should be -used. The default is +used. +The default is .Fl fc1 . .It Fl fcb , nfcb Enables (disables) the formatting of block comments (ones that begin @@ -271,13 +294,16 @@ Block comments are then handled like box comments. The default is .Fl fcb . .It Fl i Ns Ar n -The number of spaces for one indentation level. The default is 8. +The number of spaces for one indentation level. +The default is 8. .It Fl \&ip , nip Enables (disables) the indentation of parameter declarations from the left -margin. The default is +margin. +The default is .Fl \&ip . .It Fl l Ns Ar n -Maximum length of an output line. The default is 78. +Maximum length of an output line. +The default is 78. .It Fl \&ldi Ns Ar n Specifies the indentation, in character positions, of local variable names @@ -285,10 +311,12 @@ relative to the beginning of their type declaration. The default is for local variable names to be indented by the same amount as global ones. .It Fl \&lp , nlp -Lines-up code surrounded by parenthesis in continuation lines. If a line +Lines-up code surrounded by parenthesis in continuation lines. +If a line has a left paren which is not closed on that line, then continuation lines will be lined up to start at the character position just after the left -paren. For example, here is how a piece of continued code looks with +paren. +For example, here is how a piece of continued code looks with .Fl nlp in effect: .Bd -literal -offset indent @@ -321,24 +349,29 @@ to be ignored. If true .Pq Fl pcs all procedure calls will have a space inserted between -the name and the `('. The default is +the name and the `('. +The default is .Fl npcs . .It Fl psl , npsl If true .Pq Fl psl the names of procedures being defined are placed in -column 1 \- their types, if any, will be left on the previous lines. The +column 1 \- their types, if any, will be left on the previous lines. +The default is .Fl psl . .It Fl \&sc , nsc Enables (disables) the placement of asterisks (`*'s) at the left edge of all -comments. The default is +comments. +The default is .Fl sc . .It Fl sob , nsob If .Fl sob -is specified, indent will swallow optional blank lines. You can use this to -get rid of blank lines after declarations. Default: +is specified, indent will swallow optional blank lines. +You can use this to +get rid of blank lines after declarations. +Default: .Fl nsob . .It Fl \&st Causes @@ -347,14 +380,17 @@ to take its input from stdin and put its output to stdout. .It Fl T Ns Ar typename Adds .Ar typename -to the list of type keywords. Names accumulate: +to the list of type keywords. +Names accumulate: .Fl T -can be specified more than once. You need to specify all the typenames that +can be specified more than once. +You need to specify all the typenames that appear in your program that are defined by .Ic typedef \- nothing will be harmed if you miss a few, but the program won't be formatted as nicely as -it should. This sounds like a painful thing to have to do, but it's really +it should. +This sounds like a painful thing to have to do, but it's really a symptom of a problem in C: .Ic typedef causes a syntactic change in the @@ -382,10 +418,12 @@ The default is .Fl v turns on `verbose' mode; .Fl \&nv -turns it off. When in verbose mode, +turns it off. +When in verbose mode, .Nm reports when it splits one line of input into two or more lines of output, -and gives some size statistics at completion. The default is +and gives some size statistics at completion. +The default is .Fl \&nv . .El .Pp @@ -394,12 +432,16 @@ You may set up your own `profile' of defaults to by creating a file called .Pa .indent.pro in your login directory and/or the current directory and including -whatever switches you like. A `.indent.pro' in the current directory takes -precedence over the one in your login directory. If +whatever switches you like. +A `.indent.pro' in the current directory takes +precedence over the one in your login directory. +If .Nm is run and a profile file exists, then it is read to set up the program's -defaults. Switches on the command line, though, always override profile -switches. The switches should be separated by spaces, tabs or newlines. +defaults. +Switches on the command line, though, always override profile +switches. +The switches should be separated by spaces, tabs or newlines. .Pp .Ss Comments .Sq Em Box @@ -418,28 +460,34 @@ All other comments are treated as straight text. The .Nm utility fits as many words (separated by blanks, tabs, or newlines) on a -line as possible. Blank lines break paragraphs. +line as possible. +Blank lines break paragraphs. .Pp .Ss Comment indentation If a comment is on a line with code it is started in the `comment column', which is set by the .Fl c Ns Ns Ar n -command line parameter. Otherwise, the comment is started at +command line parameter. +Otherwise, the comment is started at .Ar n indentation levels less than where code is currently being placed, where .Ar n is specified by the .Fl d Ns Ns Ar n -command line parameter. If the code on a line extends past the comment +command line parameter. +If the code on a line extends past the comment column, the comment starts further to the right, and the right margin may be automatically extended in extreme cases. .Pp .Ss Preprocessor lines In general, .Nm -leaves preprocessor lines alone. The only -reformatting that it will do is to straighten up trailing comments. It -leaves embedded comments alone. Conditional compilation +leaves preprocessor lines alone. +The only +reformatting that it will do is to straighten up trailing comments. +It +leaves embedded comments alone. +Conditional compilation .Pq Ic #ifdef...#endif is recognized and .Nm @@ -450,8 +498,10 @@ compensate for the syntactic peculiarities introduced. 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: +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 .Dl #define forever for(;;) .Pp diff --git a/usr.bin/ipcrm/ipcrm.1 b/usr.bin/ipcrm/ipcrm.1 index ee1e34874484..b7e7c841da20 100644 --- a/usr.bin/ipcrm/ipcrm.1 +++ b/usr.bin/ipcrm/ipcrm.1 @@ -42,7 +42,8 @@ The .Nm utility removes the specified message queues, semaphores and shared memory -segments. These System V IPC objects can be specified by their +segments. +These System V IPC objects can be specified by their creation id or any associated key. .Pp The following options are used to specify which IPC objects will be removed. diff --git a/usr.bin/ipcs/ipcs.1 b/usr.bin/ipcs/ipcs.1 index 5dc9852da993..5d32d2c2e721 100644 --- a/usr.bin/ipcs/ipcs.1 +++ b/usr.bin/ipcs/ipcs.1 @@ -63,7 +63,8 @@ and options.) .It Fl b Show the maximum allowed sizes for active semaphores, message queues, -and shared memory segments. The +and shared memory segments. +The .Dq maximum allowed size is the maximum number of bytes in a message on a message queue, the size of a shared memory segment, @@ -75,13 +76,15 @@ and shared memory segments. Display information about active shared memory segments. .It Fl o Show outstanding usage for active message queues, -and shared memory segments. The +and shared memory segments. +The .Dq outstanding usage is the number of messages in a message queue, or the number of processes attached to a shared memory segment. .It Fl p Show the process ID information for active semaphores, message queues, -and shared memory segments. The +and shared memory segments. +The .Dq process ID information is the last process to send a message to or receive a message from a message queue, @@ -93,7 +96,8 @@ Display information about active message queues. Display information about active semaphores. .It Fl t Show access times for active semaphores, message queues, -and shared memory segments. The access times is the time +and shared memory segments. +The access times is the time of the last control operation on an IPC object, the last send or receive of a message, the last attach or detach of a shared memory segment, diff --git a/usr.bin/join/join.1 b/usr.bin/join/join.1 index 6a7477fc3f2a..8a807d529e75 100644 --- a/usr.bin/join/join.1 +++ b/usr.bin/join/join.1 @@ -82,7 +82,7 @@ and leading tabs and spaces are ignored. The default output field separator is a single space character. .Pp Many of the options use file and field numbers. -Both file numbers and field numbers are 1 based, i.e. the first file on +Both file numbers and field numbers are 1 based, i.e., the first file on the command line is file number 1 and the first field is field number 1. The following options are available: .Bl -tag -width indent @@ -218,7 +218,6 @@ command conforms to .Xr sort 1 , .Xr uniq 1 .Sh BUGS -.Pp The .Nm utility does not recognize multibyte characters. diff --git a/usr.bin/jot/jot.1 b/usr.bin/jot/jot.1 index a83c2159a264..09f64296e62a 100644 --- a/usr.bin/jot/jot.1 +++ b/usr.bin/jot/jot.1 @@ -168,11 +168,11 @@ may be obtained through .Pp and thirty .Xr ed 1 -substitution commands applying to lines 2, 7, 12, etc. is +substitution commands applying to lines 2, 7, 12, etc.\& is the result of .Dl jot -w %ds/old/new/ 30 2 - 5 .Pp -The stuttering sequence 9, 9, 8, 8, 7, etc. can be +The stuttering sequence 9, 9, 8, 8, 7, etc.\& can be produced by suitable choice of step size, as in .Dl jot - 9 0 -.5 diff --git a/usr.bin/killall/killall.1 b/usr.bin/killall/killall.1 index 709f99beb29c..9580d05c0971 100644 --- a/usr.bin/killall/killall.1 +++ b/usr.bin/killall/killall.1 @@ -58,7 +58,8 @@ The super-user is allowed to kill any process. The options are as follows: .Bl -tag -width 10n -offset indent .It Fl d | v -Be more verbose about what will be done. For a single +Be more verbose about what will be done. +For a single .Fl d option, a list of the processes that will be sent the signal will be printed, or a message indicating that no matching processes have been @@ -78,7 +79,8 @@ Match the argument .Ar procname as a (case sensitive) regular expression against the names of processes found. -CAUTION! This is dangerous, a single dot will match any process +CAUTION! +This is dangerous, a single dot will match any process running under the real UID of the caller. .It Fl s Show only what would be done, but do not send any signal. @@ -120,15 +122,17 @@ is already supported by .Xr kill 1 . So use .Xr kill 1 -for this job (e.g. $ kill -TERM -1 or +for this job (e.g.\& $ kill -TERM -1 or as root $ echo kill -TERM -1 | su -m ) .Sh DIAGNOSTICS The .Nm command will respond with a short usage message and exit with a status -of 2 in case of a command error. A status of 1 will be returned if +of 2 in case of a command error. +A status of 1 will be returned if either no matching process has been found or not all processes have -been signalled successfully. Otherwise, a status of 0 will be +been signalled successfully. +Otherwise, a status of 0 will be returned. .Pp Diagnostic messages will only be printed if requested by diff --git a/usr.bin/limits/limits.1 b/usr.bin/limits/limits.1 index 52a07032c618..75efca3dff2c 100644 --- a/usr.bin/limits/limits.1 +++ b/usr.bin/limits/limits.1 @@ -90,7 +90,7 @@ format, suitable for the calling shell. The calling shell is determined by examining the entries in the .Pa /proc file system for the parent process. -If the shell is known (i.e. it is one of +If the shell is known (i.e., it is one of .Nm sh , csh , bash , tcsh , ksh , pdksh or .Nm rc ) , @@ -346,7 +346,7 @@ The utility exits with .Dv EXIT_FAILURE -if usage is incorrect in any way; i.e. an invalid +if usage is incorrect in any way; i.e., an invalid option, or set/display options are selected in the same invocation, .Fl e is used when running a program, etc. diff --git a/usr.bin/locate/locate/locate.1 b/usr.bin/locate/locate/locate.1 index 48d1f06b79ab..25cb9e1061fe 100644 --- a/usr.bin/locate/locate/locate.1 +++ b/usr.bin/locate/locate/locate.1 @@ -77,7 +77,8 @@ As a special case, a pattern containing no globbing characters is matched as though it were .Dq *foo* . .Pp -Historically, locate only stored characters between 32 and 127. The +Historically, locate only stored characters between 32 and 127. +The current implementation store any character except newline .Pq Sq \en and NUL @@ -99,7 +100,8 @@ Search in instead the default file name database. Multiple .Fl d -options are allowed. Each additional +options are allowed. +Each additional .Fl d option adds the specified database to the list of databases to be searched. @@ -155,7 +157,8 @@ $ zcat database.gz | locate -d - pattern .Ed .Pp This might be useful on machines with a fast CPU and little RAM and slow -I/O. Note: you can only use +I/O. +Note: you can only use .Ar one pattern for stdin. .It Fl i @@ -212,11 +215,13 @@ option was specified. The .Nm program may fail to list some files that are present, or may -list files that have been removed from the system. This is because +list files that have been removed from the system. +This is because locate only reports files that are present in the database, which is typically only regenerated once a week by the .Pa /etc/periodic/weekly/310.locate -script. Use +script. +Use .Xr find 1 to locate files that are of a more transitory nature. .Pp @@ -233,7 +238,7 @@ group .Dq nobody , or world. -E.g. if your HOME directory is not world-readable, all your +E.g.\& if your HOME directory is not world-readable, all your files are .Ar not in the database. diff --git a/usr.bin/lock/lock.1 b/usr.bin/lock/lock.1 index 3dce031d7e3d..f74dd9772cb2 100644 --- a/usr.bin/lock/lock.1 +++ b/usr.bin/lock/lock.1 @@ -55,7 +55,8 @@ with the appropriate permission. The following options are available: .Bl -tag -width indent .It Fl n -Don't use a timeout value. Terminal will be locked forever. +Don't use a timeout value. +Terminal will be locked forever. .It Fl p A password is not requested, instead the user's current login password is used. diff --git a/usr.bin/lockf/lockf.1 b/usr.bin/lockf/lockf.1 index 9d067586b535..1b9b6ea8b284 100644 --- a/usr.bin/lockf/lockf.1 +++ b/usr.bin/lockf/lockf.1 @@ -74,14 +74,16 @@ Causes to operate silently. Failure to acquire the lock is indicated only in the exit status. .It Fl t Ar seconds -Specifies a timeout for waiting for the lock. By default, +Specifies a timeout for waiting for the lock. +By default, .Nm waits indefinitely to acquire the lock. If a timeout is specified with this option, .Nm will wait at most the given number of .Ar seconds -before giving up. A timeout of 0 may be given, in which case +before giving up. +A timeout of 0 may be given, in which case .Nm will fail unless it can acquire the lock immediately. .El diff --git a/usr.bin/login/login.access.5 b/usr.bin/login/login.access.5 index 33e3bf3ae0b9..2f2d8f25e40f 100644 --- a/usr.bin/login/login.access.5 +++ b/usr.bin/login/login.access.5 @@ -17,7 +17,8 @@ When someone logs in, the .Nm is scanned for the first entry that matches the (user, host) combination, or, in case of non-networked -logins, the first entry that matches the (user, tty) combination. The +logins, the first entry that matches the (user, tty) combination. +The permissions field of that table entry determines whether the login will be accepted or refused. .Pp @@ -29,11 +30,13 @@ character: The first field should be a "+" (access granted) or "-" (access denied) character. The second field should be a list of one or more login names, -group names, or ALL (always matches). The third field should be a list +group names, or ALL (always matches). +The third field should be a list of one or more tty names (for non-networked logins), host names, domain names (begin with "."), host addresses, internet network numbers (end with "."), ALL (always matches) or LOCAL (matches any string that does -not contain a "." character). If you run NIS you can use @netgroupname +not contain a "." character). +If you run NIS you can use @netgroupname in host or user patterns. .Pp The EXCEPT operator makes it possible to write very compact rules. diff --git a/usr.bin/look/look.1 b/usr.bin/look/look.1 index b8a7685d042f..3a35d21dfd47 100644 --- a/usr.bin/look/look.1 +++ b/usr.bin/look/look.1 @@ -68,12 +68,12 @@ alphabetic characters is ignored. The following options are available: .Bl -tag -width indent .It Fl d -Dictionary character set and order, i.e. only alphanumeric characters +Dictionary character set and order, i.e., only alphanumeric characters are compared. .It Fl f Ignore the case of alphabetic characters. .It Fl t -Specify a string termination character, i.e. only the characters +Specify a string termination character, i.e., only the characters in .Ar string up to and including the first occurrence of diff --git a/usr.bin/lsvfs/lsvfs.1 b/usr.bin/lsvfs/lsvfs.1 index 5c629d87a2ce..c9874d8d870e 100644 --- a/usr.bin/lsvfs/lsvfs.1 +++ b/usr.bin/lsvfs/lsvfs.1 @@ -15,11 +15,13 @@ The .Nm command lists information about the currently loaded virtual file system -modules. When +modules. +When .Ar vfsname arguments are given, .Nm -lists information about the specified VFS modules. Otherwise, +lists information about the specified VFS modules. +Otherwise, .Nm lists all currently loaded modules. The information is as follows: diff --git a/usr.bin/m4/m4.1 b/usr.bin/m4/m4.1 index a4e6ea84293e..a314c113172c 100644 --- a/usr.bin/m4/m4.1 +++ b/usr.bin/m4/m4.1 @@ -248,7 +248,7 @@ argument is not found, returns \-1. .It Ic indir Indirectly calls the macro whose name is passed as the first arguments, -with the remaining arguments passed as first, etc. arguments. +with the remaining arguments passed as first, etc.\& arguments. .It Ic len Returns the number of characters in the first argument. Extra arguments diff --git a/usr.bin/make/make.1 b/usr.bin/make/make.1 index cad5e50da508..b358da04cc36 100644 --- a/usr.bin/make/make.1 +++ b/usr.bin/make/make.1 @@ -347,7 +347,7 @@ Append the value to the current value of the variable. .It Ic \&?= Assign the value to the variable if it is not already defined. .It Ic \&:= -Assign with expansion, i.e. expand the value before assigning it +Assign with expansion, i.e., expand the value before assigning it to the variable. Normally, expansion is not done until the variable is referenced. .It Ic \&!= @@ -1058,7 +1058,7 @@ Loops are not being detected and targets that form loops will be silently ignored. .El .Sh "SPECIAL TARGETS" -Special targets may not be included with other targets, i.e. they must be +Special targets may not be included with other targets, i.e., they must be the only target specified. .Bl -tag -width Ic .It Ic .BEGIN diff --git a/usr.bin/makewhatis/makewhatis.local.8 b/usr.bin/makewhatis/makewhatis.local.8 index 1261667889df..dfe252fdd961 100644 --- a/usr.bin/makewhatis/makewhatis.local.8 +++ b/usr.bin/makewhatis/makewhatis.local.8 @@ -44,7 +44,8 @@ utility starts only for file systems physically mounted on the system where the .Nm -is being executed. Running makewhatis +is being executed. +Running makewhatis by .Pa periodic weekly for rw nfs-mounted /usr may kill diff --git a/usr.bin/minigzip/minigzip.1 b/usr.bin/minigzip/minigzip.1 index 8a0dc6f817ee..ddd2b957a6b1 100644 --- a/usr.bin/minigzip/minigzip.1 +++ b/usr.bin/minigzip/minigzip.1 @@ -39,7 +39,8 @@ The .Nm utility is a minimal implementation of the .Xr gzip 1 -utility. It supports +utility. +It supports compression and decompression of individual files, as well as streaming compression and decompression via standard input and output. @@ -52,9 +53,11 @@ flag on the commandline. If any .Ar file arguments are supplied, the operation is performed on each file -separately. Compression replaces the original file with one having a +separately. +Compression replaces the original file with one having a .Pa .gz -suffix. Decompression will remove a +suffix. +Decompression will remove a .Pa .gz suffix if one is present. .Pp diff --git a/usr.bin/mkdep/mkdep.1 b/usr.bin/mkdep/mkdep.1 index 2364d4cd0110..446f5493ae5e 100644 --- a/usr.bin/mkdep/mkdep.1 +++ b/usr.bin/mkdep/mkdep.1 @@ -63,7 +63,8 @@ where the macro SRCS is the list of C source files and the macro CFLAGS is the list of flags for the C compiler. .Pp The user has the ability to change the preprocessor and preprocessor options -used. For instance, to use gcc as the preprocessor and to ignore system +used. +For instance, to use gcc as the preprocessor and to ignore system headers, one would use .Bd -literal -offset indent depend: @@ -101,12 +102,15 @@ module. .Sh ENVIRONMENT .Bl -tag -width MKDEP_CPP_OPTS .It Ev CC -Specifies the C compiler to use. The specified compiler is expected to have +Specifies the C compiler to use. +The specified compiler is expected to have options consistent with the GNU C compiler. .It Ev MKDEP_CPP -Specifies the preprocessor to use. The default is "${CC} -E". +Specifies the preprocessor to use. +The default is "${CC} -E". .It Ev MKDEP_CPP_OPTS -Specifies the non-CFLAGS options for the preprocessor. The default is +Specifies the non-CFLAGS options for the preprocessor. +The default is "-M". .El .Sh SEE ALSO diff --git a/usr.bin/mklocale/mklocale.1 b/usr.bin/mklocale/mklocale.1 index 8239f1be8da9..8d7010271c9c 100644 --- a/usr.bin/mklocale/mklocale.1 +++ b/usr.bin/mklocale/mklocale.1 @@ -65,7 +65,8 @@ The format of .Ar src-file is quite simple. It consists of a series of lines which start with a keyword and have -associated data following. C style comments are used +associated data following. +C style comments are used to place comments in the file. .Pp Following options are available: @@ -121,9 +122,11 @@ Used to indicate ranges. The follow characters are taken literally: .Bl -tag -width ".Dv <\|\|(\|\|[" .It Dv "<\|(\|[" -Used to start a mapping. All are equivalent. +Used to start a mapping. +All are equivalent. .It Dv ">\|\^)\|]" -Used to end a mapping. All are equivalent. +Used to end a mapping. +All are equivalent. .It Dv : Used as a delimiter in mappings. .El diff --git a/usr.bin/mktemp/mktemp.1 b/usr.bin/mktemp/mktemp.1 index 684db7ad6d67..a21d79c5ef92 100644 --- a/usr.bin/mktemp/mktemp.1 +++ b/usr.bin/mktemp/mktemp.1 @@ -54,8 +54,10 @@ The .Nm utility takes each of the given file name templates and overwrites a -portion of it to create a file name. This file name is unique -and suitable for use by the application. The template may be +portion of it to create a file name. +This file name is unique +and suitable for use by the application. +The template may be any file name with some number of .Ql X Ns s appended @@ -110,12 +112,16 @@ 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 +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 -is easy for an attacker to win. A safer, though still inferior, approach -is to make a temporary directory using the same naming scheme. While +is easy for an attacker to win. +A safer, though still inferior, approach +is to make a temporary directory using the same naming scheme. +While this does allow one to guarantee that a temporary file will not be -subverted, it still allows a simple denial of service attack. For these +subverted, it still allows a simple denial of service attack. +For these reasons it is suggested that .Nm be used instead. @@ -125,7 +131,8 @@ The available options are as follows: .It Fl d Make a directory instead of a file. .It Fl q -Fail silently if an error occurs. This is useful if +Fail silently if an error occurs. +This is useful if a script does not want error output to go to standard error. .It Fl t Ar prefix Generate a template (using the supplied @@ -136,11 +143,14 @@ if set) to create a filename template. .It Fl u Operate in .Dq unsafe -mode. The temp file will be unlinked before +mode. +The temp file will be unlinked before .Nm -exits. This is slightly better than +exits. +This is slightly better than .Xr mktemp 3 -but still introduces a race condition. Use of this +but still introduces a race condition. +Use of this option is not encouraged. .El .Sh DIAGNOSTICS diff --git a/usr.bin/mt/mt.1 b/usr.bin/mt/mt.1 index d4e65e836cab..e37952548c38 100644 --- a/usr.bin/mt/mt.1 +++ b/usr.bin/mt/mt.1 @@ -50,7 +50,8 @@ The utility is used to give commands to a magnetic tape drive. By default .Nm -performs the requested operation once. Operations +performs the requested operation once. +Operations may be performed multiple times by specifying .Ar count . Note @@ -58,7 +59,8 @@ that .Ar tapename must reference a raw (not block) tape device. .Pp -The available commands are listed below. Only as many +The available commands are listed below. +Only as many characters as are required to uniquely identify a command need be specified. .Bl -tag -width "eof, weof" @@ -146,19 +148,24 @@ Print (and clear) error status information about this device. For every normal operation (e.g., a read or a write) and every control operation (e.g,, a rewind), the driver stores up the last command executed and it's associated -status and any residual counts (if any). This command retrieves and prints this +status and any residual counts (if any). +This command retrieves and prints this information. If possible, this also clears any latched error information. .It Cm blocksize -Set the block size for the tape unit. Zero means variable-length +Set the block size for the tape unit. +Zero means variable-length blocks. .It Cm density -Set the density for the tape unit. For the density codes, see below. +Set the density for the tape unit. +For the density codes, see below. The density value could be given either numerically, or as a string, corresponding to the .Dq Reference -field. If the string is abbreviated, it will be resolved in the order -shown in the table, and the first matching entry will be used. If the +field. +If the string is abbreviated, it will be resolved in the order +shown in the table, and the first matching entry will be used. +If the given string and the resulting canonical density name do not match exactly, an informational message is printed about what the given string has been taken for. @@ -209,11 +216,13 @@ DCLZ compression algorithm (0x20). .El .Pp In addition to the above recognized compression keywords, the user can -supply a numeric compression algorithm for the tape drive to use. In most +supply a numeric compression algorithm for the tape drive to use. +In most cases, simply turning the compression .Sq on will have the desired effect of enabling the default compression algorithm -supported by the drive. If this is not the case (see the +supported by the drive. +If this is not the case (see the .Cm status display to see which compression algorithm is currently in use), the user can manually specify one of the supported compression keywords (above), or diff --git a/usr.bin/ncal/ncal.1 b/usr.bin/ncal/ncal.1 index 925c2b803ed9..f5734b77c852 100644 --- a/usr.bin/ncal/ncal.1 +++ b/usr.bin/ncal/ncal.1 @@ -85,7 +85,8 @@ associated with the If not specified, .Nm ncal tries to guess the switch date from the local environment or -falls back to September 2, 1752. This was when Great +falls back to September 2, 1752. +This was when Great Britain and her colonies switched to the Gregorian Calendar. .It Fl w Print the number of the week below each week column. diff --git a/usr.bin/ncplogin/ncplogout.1 b/usr.bin/ncplogin/ncplogout.1 index 295708550150..c228de79d22e 100644 --- a/usr.bin/ncplogin/ncplogout.1 +++ b/usr.bin/ncplogin/ncplogout.1 @@ -19,7 +19,7 @@ The 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 +If the connection is busy (i.e., used by other processes) it will be closed when the last process using it is terminated. This command is similar to the .Tn DOS diff --git a/usr.bin/nfsstat/nfsstat.1 b/usr.bin/nfsstat/nfsstat.1 index 8dd7575a7f45..b5f56ff447d4 100644 --- a/usr.bin/nfsstat/nfsstat.1 +++ b/usr.bin/nfsstat/nfsstat.1 @@ -67,7 +67,8 @@ Extract the name list from the specified system instead of the default .It Fl s Only display server side statistics .It Fl W -Use wide format with interval short summary. This option is especially +Use wide format with interval short summary. +This option is especially useful when combined with -c or -s and a time delay. .It Fl w Display a shorter summary of diff --git a/usr.bin/nl/nl.1 b/usr.bin/nl/nl.1 index c67c12e55fb8..9e39486975ed 100644 --- a/usr.bin/nl/nl.1 +++ b/usr.bin/nl/nl.1 @@ -89,8 +89,10 @@ The .Nm utility treats the text it reads in terms of logical pages. Unless specified otherwise, line numbering is reset at the start of each -logical page. A logical page consists of a header, a body and a footer -section; empty sections are valid. Different line numbering options are +logical page. +A logical page consists of a header, a body and a footer +section; empty sections are valid. +Different line numbering options are independently available for header, body and footer sections. .Pp The starts of logical page sections are signalled by input lines containing @@ -132,7 +134,8 @@ for logical page body lines is .Cm t . .It Fl d Ar delim Specify the delimiter characters used to indicate the start of a logical -page section in the input file. At most two characters may be specified; +page section in the input file. +At most two characters may be specified; if only one character is specified, the first character is replaced and the second character remains unchanged. The default diff --git a/usr.bin/passwd/passwd.1 b/usr.bin/passwd/passwd.1 index cc61b41d7e96..1f0df7b1ffb6 100644 --- a/usr.bin/passwd/passwd.1 +++ b/usr.bin/passwd/passwd.1 @@ -76,10 +76,12 @@ The new password should contain a mixture of upper and lower case characters (which may be overridden using the .Xr login.conf 5 .Dq mixpasswordcase -setting for a user's login class). Allowing lower case passwords may +setting for a user's login class). +Allowing lower case passwords may be useful where the password file will be used in situations where only lower case passwords are permissible, such as when using Samba to -authenticate Windows clients. In all other situations, numbers, upper +authenticate Windows clients. +In all other situations, numbers, upper case letters and meta characters are encouraged. .Pp Once the password has been verified, diff --git a/usr.bin/printf/printf.1 b/usr.bin/printf/printf.1 index aa3aa201dbfa..3dfb0f2cc073 100644 --- a/usr.bin/printf/printf.1 +++ b/usr.bin/printf/printf.1 @@ -131,22 +131,26 @@ For .Cm c , d , and .Cm s , -formats, this option has no effect. For the +formats, this option has no effect. +For the .Cm o formats the precision of the number is increased to force the first -character of the output string to a zero. For the +character of the output string to a zero. +For the .Cm x .Pq Cm X format, a non-zero result has the string .Li 0x .Pq Li 0X -prepended to it. For +prepended to it. +For .Cm e , E , f , g , and .Cm G , formats, the result will always contain a decimal point, even if no digits follow the point (normally, a decimal point only appears in the -results of those formats if a digit follows the decimal point). For +results of those formats if a digit follows the decimal point). +For .Cm g and .Cm G @@ -161,10 +165,12 @@ A `+' character specifying that there should always be a sign placed before the number when using signed formats. .It Sq \&\ \& A space specifying that a blank should be left before a positive number -for a signed format. A `+' overrides a space if both are used; +for a signed format. +A `+' overrides a space if both are used; .It Cm \&0 A zero `0' character indicating that zero-padding should be used -rather than blank-padding. A `\-' overrides a `0' if both are used; +rather than blank-padding. +A `\-' overrides a `0' if both are used; .El .It "Field Width:" An optional digit string specifying a @@ -324,7 +330,8 @@ then back again, floating-point precision may be lost. .Tn ANSI hexadecimal character constants were deliberately not provided. .Pp -The escape sequence \e000 is the string terminator. When present in the +The escape sequence \e000 is the string terminator. +When present in the .Ar format , the .Ar format diff --git a/usr.bin/rlogin/rlogin.1 b/usr.bin/rlogin/rlogin.1 index 67fd8cc8ef10..6955339dc577 100644 --- a/usr.bin/rlogin/rlogin.1 +++ b/usr.bin/rlogin/rlogin.1 @@ -90,7 +90,8 @@ This specification may be as a literal character, or as an octal value in the form \ennn. .It Fl i Allow the caller to specify a different local name to be used -for authentication. This option is restricted to processes with uid 0. +for authentication. +This option is restricted to processes with uid 0. .It Fl l Specify a different .Ar username diff --git a/usr.bin/rpcgen/rpcgen.1 b/usr.bin/rpcgen/rpcgen.1 index 153a0fcb93d3..058124dd3da0 100644 --- a/usr.bin/rpcgen/rpcgen.1 +++ b/usr.bin/rpcgen/rpcgen.1 @@ -260,7 +260,8 @@ routines. .It Fl C Generate header and stub files which can be used with .Tn ANSI -C compilers. Headers generated with this flag can also be +C compilers. +Headers generated with this flag can also be used with C++ programs. .It Fl D Ns Ar name .It Fl D Ns Ar name=value @@ -294,7 +295,8 @@ Note: in order to provide backwards compatibility with the older on the .Fx platform, the default is actually 0 (which means -that inline code generation is disabled by default). You must specify +that inline code generation is disabled by default). +You must specify a non-zero value explicitly to override this default. .It Fl I Compile support for diff --git a/usr.bin/rsh/rsh.1 b/usr.bin/rsh/rsh.1 index ed02ea3c2144..85230f1ce6e6 100644 --- a/usr.bin/rsh/rsh.1 +++ b/usr.bin/rsh/rsh.1 @@ -106,7 +106,8 @@ This may introduce a significant delay in response time. .It Fl t Ar timeout Allow a .Ar timeout -to be specified (in seconds). If no +to be specified (in seconds). +If no data is sent or received in this time, .Nm will exit. diff --git a/usr.bin/rup/rup.1 b/usr.bin/rup/rup.1 index d543ba05288a..359676b96eb3 100644 --- a/usr.bin/rup/rup.1 +++ b/usr.bin/rup/rup.1 @@ -75,14 +75,16 @@ The .Xr rpc.rstatd 8 daemon has not been started on the remote host. .It rup: RPC: Timed out -A communication error occurred. Either the network is +A communication error occurred. +Either the network is excessively congested, or the .Xr rpc.rstatd 8 daemon has terminated on the remote host. .It rup: RPC: Port mapper failure - RPC: Timed out The remote host is not running the portmapper (see .Xr rpcbind 8 ) , -and cannot accommodate any RPC-based services. The host may be down. +and cannot accommodate any RPC-based services. +The host may be down. .El .Sh SEE ALSO .Xr rpc.rstatd 8 , diff --git a/usr.bin/ruptime/ruptime.1 b/usr.bin/ruptime/ruptime.1 index 4e9d83109a40..defe832aab44 100644 --- a/usr.bin/ruptime/ruptime.1 +++ b/usr.bin/ruptime/ruptime.1 @@ -64,7 +64,8 @@ report has been received for 4 days are not shown in the list at all. The options are as follows: .Bl -tag -width Ds .It Fl a -Include all users. By default, if a user hasn't typed to the system for +Include all users. +By default, if a user hasn't typed to the system for an hour or more, then the user will be omitted from the output. .It Fl l Sort by load average. diff --git a/usr.bin/rusers/rusers.1 b/usr.bin/rusers/rusers.1 index 64e0eba0acf6..e68c85082266 100644 --- a/usr.bin/rusers/rusers.1 +++ b/usr.bin/rusers/rusers.1 @@ -81,14 +81,16 @@ The .Xr rpc.rusersd 8 daemon has not been started on the remote host. .It rusers: RPC: Timed out -A communication error occurred. Either the network is +A communication error occurred. +Either the network is excessively congested, or the .Xr rpc.rusersd 8 daemon has terminated on the remote host. .It rusers: "RPC: Port mapper failure - RPC: Timed out" The remote host is not running the portmapper (see .Xr rpcbind 8 ) , -and cannot accommodate any RPC-based services. The host may be down. +and cannot accommodate any RPC-based services. +The host may be down. .El .Sh SEE ALSO .Xr rwho 1 , diff --git a/usr.bin/rwall/rwall.1 b/usr.bin/rwall/rwall.1 index 9eaf7c258842..ee1836101c3c 100644 --- a/usr.bin/rwall/rwall.1 +++ b/usr.bin/rwall/rwall.1 @@ -58,14 +58,16 @@ The .Xr rpc.rwalld 8 daemon has not been started on the remote host. .It rwall: RPC: Timed out -A communication error occurred. Either the network is +A communication error occurred. +Either the network is excessively congested, or the .Xr rpc.rwalld 8 daemon has terminated on the remote host. .It rwall: RPC: Port mapper failure - RPC: Timed out The remote host is not running the portmapper (see .Xr rpcbind 8 ) , -and cannot accomodate any RPC-based services. The host may be down. +and cannot accomodate any RPC-based services. +The host may be down. .El .Sh SEE ALSO .Xr who 1 , diff --git a/usr.bin/script/script.1 b/usr.bin/script/script.1 index ad5497df4860..64b0c4d9edba 100644 --- a/usr.bin/script/script.1 +++ b/usr.bin/script/script.1 @@ -81,10 +81,12 @@ Log keys sent to program as well as output. .It Fl q Run in quiet mode, omit the start and stop status messages. .It Fl t Ar time -Specify time interval between flushing script output file. A value of 0 +Specify time interval between flushing script output file. +A value of 0 causes .Nm -to flush for every character I/O event. The default interval is +to flush for every character I/O event. +The default interval is 30 seconds. .El .Pp @@ -150,6 +152,8 @@ because of argument parsing compatibility issues. .Pp When running in .Fl k -mode, echo cancelling is far from ideal. The slave terminal mode is checked -for ECHO mode to check when to avoid manual echo logging. This does not +mode, echo cancelling is far from ideal. +The slave terminal mode is checked +for ECHO mode to check when to avoid manual echo logging. +This does not work when in a raw mode where the program being run is doing manual echo. diff --git a/usr.bin/sed/sed.1 b/usr.bin/sed/sed.1 index 8d6ce4a186f4..cbb219e23d42 100644 --- a/usr.bin/sed/sed.1 +++ b/usr.bin/sed/sed.1 @@ -155,16 +155,21 @@ A command line with no addresses selects every pattern space. A command line with one address selects all of the pattern spaces that match the address. .Pp -A command line with two addresses selects an inclusive range. This +A command line with two addresses selects an inclusive range. +This range starts with the first pattern space that matches the first -address. The end of the range is the next following pattern space -that matches the second address. If the second address is a number +address. +The end of the range is the next following pattern space +that matches the second address. +If the second address is a number less than or equal to the line number first selected, only that -line is selected. In the case when the second address is a context +line is selected. +In the case when the second address is a context address, .Nm does not re-match the second address against the -pattern space that matched the first address. Starting at the +pattern space that matched the first address. +Starting at the first line following the selected range, .Nm starts looking again for the first address. @@ -212,7 +217,7 @@ One special feature of .Nm regular expressions is that they can default to the last regular expression used. -If a regular expression is empty, i.e. just the delimiter characters +If a regular expression is empty, i.e., just the delimiter characters are specified, the last regular expression encountered is used instead. The last regular expression is defined as the last regular expression used as part of an address or substitute command, and at run-time, not @@ -537,7 +542,9 @@ extension and may not be available on other operating systems. .Sh HISTORY A .Nm -command, written by L. E. McMahon, appeared in +command, written by +.An L. E. McMahon , +appeared in .At v7 . .Sh AUTHORS .An "Diomidis D. Spinellis" Aq dds@FreeBSD.org diff --git a/usr.bin/su/su.1 b/usr.bin/su/su.1 index bb8552d98a0f..216f75ba5bfe 100644 --- a/usr.bin/su/su.1 +++ b/usr.bin/su/su.1 @@ -204,7 +204,8 @@ You will be asked for man's password unless your real UID is 0. Same as above, but the target command consists of more than a single word and hence is quoted for use with the .Fl c -option being passed to the shell. (Most shells expect the argument to +option being passed to the shell. +(Most shells expect the argument to .Fl c to be a single word). .It Li "su -c staff man -c 'catman /usr/share/man /usr/local/man /usr/X11R6/man'" diff --git a/usr.bin/systat/systat.1 b/usr.bin/systat/systat.1 index ec550f1b32d5..ace79a25617a 100644 --- a/usr.bin/systat/systat.1 +++ b/usr.bin/systat/systat.1 @@ -52,16 +52,20 @@ using the curses screen display library, While .Nm is running the screen is usually divided into two windows (an exception -is the vmstat display which uses the entire screen). The -upper window depicts the current system load average. The +is the vmstat display which uses the entire screen). +The +upper window depicts the current system load average. +The information displayed in the lower window may vary, depending on -user commands. The last line on the screen is reserved for user +user commands. +The last line on the screen is reserved for user input and error messages. .Pp By default .Nm displays the processes getting the largest percentage of the processor -in the lower window. Other displays show swap space usage, disk +in the lower window. +Other displays show swap space usage, disk .Tn I/O statistics (a la .Xr iostat 8 ) , @@ -76,7 +80,8 @@ and network connections (a la Input is interpreted at two different levels. A ``global'' command interpreter processes all keyboard input. If this command interpreter fails to recognize a command, the -input line is passed to a per-display command interpreter. This +input line is passed to a per-display command interpreter. +This allows each display to have certain display-specific commands. .Pp Command line options: @@ -121,7 +126,8 @@ Print the name of the current ``display'' being shown in the lower window and the refresh interval. .It Ic \&: Move the cursor to the command line and interpret the input -line typed as a command. While entering a command the +line typed as a command. +While entering a command the current character erase, word erase, and line kill characters may be used. .El @@ -140,7 +146,8 @@ Stop refreshing the screen. .Op Ic start .Op Ar number .Xc -Start (continue) refreshing the screen. If a second, numeric, +Start (continue) refreshing the screen. +If a second, numeric, argument is provided it is interpreted as a refresh interval (in seconds). Supplying only a number will set the refresh interval to this @@ -194,7 +201,8 @@ The .Ic reset command resets the baseline for .Ic since -mode. The +mode. +The .Ic mode command with no argument will display the current mode in the command line. @@ -228,15 +236,19 @@ but with statistics. .It Ic iostat Display, in the lower window, statistics about processor use -and disk throughput. Statistics on processor use appear as +and disk throughput. +Statistics on processor use appear as bar graphs of the amount of time executing in user mode (``user''), in user mode running low priority processes (``nice''), in system mode (``system''), in interrupt mode (``interrupt''), -and idle (``idle''). Statistics +and idle (``idle''). +Statistics on disk throughput show, for each drive, megabytes per second, average number of disk transactions per second, and -average kilobytes of data per transaction. This information may be -displayed as bar graphs or as rows of numbers which scroll downward. Bar +average kilobytes of data per transaction. +This information may be +displayed as bar graphs or as rows of numbers which scroll downward. +Bar graphs are shown by default. .Pp The following commands are specific to the @@ -247,7 +259,8 @@ display; the minimum unambiguous prefix may be supplied. .It Cm numbers Show the disk .Tn I/O -statistics in numeric form. Values are +statistics in numeric form. +Values are displayed in numeric columns which scroll downward. .It Cm bars Show the disk @@ -272,7 +285,7 @@ a total line is also shown. Areas known to the kernel, but not in use are shown as not available. .It Ic mbufs Display, in the lower window, the number of mbufs allocated -for particular uses, i.e. data, socket structures, etc. +for particular uses, i.e., data, socket structures, etc. .It Ic vmstat Take over the entire display and show a (rather crowded) compendium of statistics related to virtual memory usage, process scheduling, @@ -325,9 +338,12 @@ It reports the number of kilobytes per transaction, transactions per second, megabytes per second and the percentage of the time the disk was busy averaged over the refresh period of the display (by default, five seconds). -The system keeps statistics on most every storage device. In general, up -to seven devices are displayed. The devices displayed by default are the -first devices in the kernel's device list. See +The system keeps statistics on most every storage device. +In general, up +to seven devices are displayed. +The devices displayed by default are the +first devices in the kernel's device list. +See .Xr devstat 3 and .Xr devstat 9 @@ -400,10 +416,13 @@ Toggle the display of fd devices in the disk usage display. Reset running statistics to zero. .El .It Ic netstat -Display, in the lower window, network connections. By default, -network servers awaiting requests are not displayed. Each address +Display, in the lower window, network connections. +By default, +network servers awaiting requests are not displayed. +Each address is displayed in the format ``host.port'', with each shown symbolically, -when possible. It is possible to have addresses displayed numerically, +when possible. +It is possible to have addresses displayed numerically, limit the display to a set of ports, hosts, and/or protocols (the minimum unambiguous prefix may be supplied): .Pp @@ -424,21 +443,27 @@ Display only network connections using the indicated Supported protocols are ``tcp'', ``udp'', and ``all''. .It Cm ignore Op Ar items Do not display information about connections associated with -the specified hosts or ports. Hosts and ports may be specified -by name (``vangogh'', ``ftp''), or numerically. Host addresses -use the Internet dot notation (``128.32.0.9''). Multiple items +the specified hosts or ports. +Hosts and ports may be specified +by name (``vangogh'', ``ftp''), or numerically. +Host addresses +use the Internet dot notation (``128.32.0.9''). +Multiple items may be specified with a single command by separating them with spaces. .It Cm display Op Ar items Display information about the connections associated with the -specified hosts or ports. As for +specified hosts or ports. +As for .Ar ignore , .Op Ar items may be names or numbers. .It Cm show Op Ar ports\&|hosts Show, on the command line, the currently selected protocols, -hosts, and ports. Hosts and ports which are being ignored -are prefixed with a `!'. If +hosts, and ports. +Hosts and ports which are being ignored +are prefixed with a `!'. +If .Ar ports or .Ar hosts @@ -451,15 +476,18 @@ Reset the port, host, and protocol matching mechanisms to the default .El .It Ic ifstat Display the network traffic going through active interfaces on the -system. Idle interfaces will not be displayed until they receive some +system. +Idle interfaces will not be displayed until they receive some traffic. .Pp For each interface being displayed, the current, peak and total -statistics are displayed for incoming and outgoing traffic. By default, +statistics are displayed for incoming and outgoing traffic. +By default, the .Ic ifstat display will automatically scale the units being used so that they are -in a human-readable format. The scaling units used for the current and +in a human-readable format. +The scaling units used for the current and peak traffic columns can be altered by the .Ic scale @@ -467,7 +495,8 @@ command. .Bl -tag -width ".Cm scale Op Ar units" .It Cm scale Op Ar units Modify the scale used to display the current and peak traffic over all -interfaces. The following units are recognised: kbit, kbyte, mbit, +interfaces. +The following units are recognised: kbit, kbyte, mbit, mbyte, gbit, gbyte and auto. .El .El @@ -475,28 +504,34 @@ mbyte, gbit, gbyte and auto. Commands to switch between displays may be abbreviated to the minimum unambiguous prefix; for example, ``io'' for ``iostat''. Certain information may be discarded when the screen size is -insufficient for display. For example, on a machine with 10 +insufficient for display. +For example, on a machine with 10 drives the .Ic iostat -bar graph displays only 3 drives on a 24 line terminal. When +bar graph displays only 3 drives on a 24 line terminal. +When a bar graph would overflow the allotted screen space it is truncated and the actual value is printed ``over top'' of the bar. .Pp The following commands are common to each display which shows -information about disk drives. These commands are used to +information about disk drives. +These commands are used to select a set of drives to report on, should your system have more drives configured than can normally be displayed on the screen. .Pp .Bl -tag -width Ar -compact .It Cm ignore Op Ar drives -Do not display information about the drives indicated. Multiple +Do not display information about the drives indicated. +Multiple drives may be specified, separated by spaces. .It Cm display Op Ar drives -Display information about the drives indicated. Multiple drives +Display information about the drives indicated. +Multiple drives may be specified, separated by spaces. .It Cm only Op Ar drives -Display only the specified drives. Multiple drives may be specified, +Display only the specified drives. +Multiple drives may be specified, separated by spaces. .It Cm drives Display a list of available devices. @@ -504,10 +539,12 @@ Display a list of available devices. .Ar type , Ns Ar if , Ns Ar pass .Op | Ar ... .Xc -Display devices matching the given pattern. The basic matching +Display devices matching the given pattern. +The basic matching expressions are the same as those used in .Xr iostat 8 -with one difference. Instead of specifying multiple +with one difference. +Instead of specifying multiple .Fl t arguments which are then ORed together, the user instead specifies multiple matching expressions joined by the pipe @@ -515,9 +552,11 @@ matching expressions joined by the pipe character. The comma separated arguments within each matching expression are ANDed together, and -then the pipe separated matching expressions are ORed together. Any +then the pipe separated matching expressions are ORed together. +Any device matching the combined expression will be displayed, if there is room -to display it. For example: +to display it. +For example: .Pp .Dl match da,scsi | cd,ide .Pp diff --git a/usr.bin/tail/tail.1 b/usr.bin/tail/tail.1 index 482f42075919..0791e74334ba 100644 --- a/usr.bin/tail/tail.1 +++ b/usr.bin/tail/tail.1 @@ -172,7 +172,7 @@ and .Fl n options modify the .Fl r -option, i.e. ``-r -c 4'' displays the last 4 characters of the last line +option, i.e., ``-r -c 4'' displays the last 4 characters of the last line of the input, while the historic tail (using the historic syntax ``-4cr'') would ignore the .Fl c diff --git a/usr.bin/tar/bsdtar.1 b/usr.bin/tar/bsdtar.1 index 055ee50c6837..962b3ca218a3 100644 --- a/usr.bin/tar/bsdtar.1 +++ b/usr.bin/tar/bsdtar.1 @@ -412,7 +412,8 @@ and .Cm f flags both require arguments, so there must be two additional items -on the command line. The +on the command line. +The .Ar 32 is the argument to the .Cm b diff --git a/usr.bin/tcopy/tcopy.1 b/usr.bin/tcopy/tcopy.1 index a995f45051d4..b305def0ea47 100644 --- a/usr.bin/tcopy/tcopy.1 +++ b/usr.bin/tcopy/tcopy.1 @@ -47,16 +47,20 @@ .Sh DESCRIPTION The .Nm -utility is designed to copy magnetic tapes. The only assumption made +utility is designed to copy magnetic tapes. +The only assumption made about the tape is that there are two tape marks at the end. The .Nm utility with only a source tape .Pf ( Ar /dev/sa0 by default) specified will print -information about the sizes of records and tape files. If a destination -is specified a copy will be made of the source tape. The blocking on the -destination tape will be identical to that used on the source tape. Copying +information about the sizes of records and tape files. +If a destination +is specified a copy will be made of the source tape. +The blocking on the +destination tape will be identical to that used on the source tape. +Copying a tape will yield the same output as if just printing the sizes. .Pp Options: diff --git a/usr.bin/tftp/tftp.1 b/usr.bin/tftp/tftp.1 index fd99415312c6..49af5979eca1 100644 --- a/usr.bin/tftp/tftp.1 +++ b/usr.bin/tftp/tftp.1 @@ -178,7 +178,8 @@ Because there is no user-login or validation within the .Tn TFTP protocol, the remote site will probably have some -sort of file-access restrictions in place. The +sort of file-access restrictions in place. +The exact methods are specific to each site and therefore difficult to document here. .Pp diff --git a/usr.bin/time/time.1 b/usr.bin/time/time.1 index 9f007712863c..0aea7045067c 100644 --- a/usr.bin/time/time.1 +++ b/usr.bin/time/time.1 @@ -71,8 +71,9 @@ flag is used, append to the specified file rather than overwriting it. Otherwise, this option has no effect. .It Fl h -Print times in a human friendly format. Times are printed in minutes, hours, -etc. as appropriate. +Print times in a human friendly format. +Times are printed in minutes, hours, +etc.\& as appropriate. .It Fl l The contents of the .Em rusage @@ -80,7 +81,8 @@ structure are printed as well. .It Fl o Ar file Write the output to .Ar file -instead of stderr. If +instead of stderr. +If .Ar file exists and the .Fl a diff --git a/usr.bin/tput/tput.1 b/usr.bin/tput/tput.1 index 4e3e28360145..6e5f41e4ab3a 100644 --- a/usr.bin/tput/tput.1 +++ b/usr.bin/tput/tput.1 @@ -48,7 +48,8 @@ The .Nm utility makes terminal-dependent information available to users or shell -applications. When invoked as the +applications. +When invoked as the .Nm clear utility, the screen will be cleared as if .Dl tput clear @@ -83,7 +84,7 @@ without further action. .Pp If an .Ar attribute -is of type string, and takes arguments (e.g. cursor movement, +is of type string, and takes arguments (e.g.\& cursor movement, the termcap .Dq cm sequence) the arguments are taken from the command line immediately @@ -150,6 +151,8 @@ Some termcap entries depend upon having a .Sq % in them that is just a .Sq % -and nothing more. Right now we just warn about them if they don't -have a valid type declaration. These warnings are sent to +and nothing more. +Right now we just warn about them if they don't +have a valid type declaration. +These warnings are sent to stderr. diff --git a/usr.bin/tr/tr.1 b/usr.bin/tr/tr.1 index 4d5316cc03f7..2a491fdcff1f 100644 --- a/usr.bin/tr/tr.1 +++ b/usr.bin/tr/tr.1 @@ -291,7 +291,7 @@ System V has historically implemented character ranges using the syntax implementations and standardized by POSIX. System V shell scripts should work under this implementation as long as -the range is intended to map in another range, i.e. the command +the range is intended to map in another range, i.e., the command ``tr [a-z] [A-Z]'' will work as it will map the ``['' character in .Ar string1 to the ``['' character in diff --git a/usr.bin/tset/tset.1 b/usr.bin/tset/tset.1 index 94528b6eb308..e1c727e09fe5 100644 --- a/usr.bin/tset/tset.1 +++ b/usr.bin/tset/tset.1 @@ -154,7 +154,7 @@ and .Fl k options may either be entered as actual characters or by using the .Dq hat -notation, i.e. control-h may be specified as +notation, i.e., control-h may be specified as .Dq Li ^H or .Dq Li ^h . diff --git a/usr.bin/tsort/tsort.1 b/usr.bin/tsort/tsort.1 index 30de00a71486..ab5b560b6238 100644 --- a/usr.bin/tsort/tsort.1 +++ b/usr.bin/tsort/tsort.1 @@ -74,7 +74,8 @@ Turn on debugging. Search for and display the longest cycle. Can take a very long time. .It Fl q -Do not display informational messages about cycles. This is primarily +Do not display informational messages about cycles. +This is primarily intended for building libraries, where optimal ordering is not critical, and cycles occur often. .El diff --git a/usr.bin/ul/ul.1 b/usr.bin/ul/ul.1 index 9a456e7ab5d6..939516eb1b75 100644 --- a/usr.bin/ul/ul.1 +++ b/usr.bin/ul/ul.1 @@ -101,7 +101,8 @@ file (see The .Xr nroff 1 command usually outputs a series of backspaces and underlines intermixed -with the text to indicate underlining. No attempt is made to optimize +with the text to indicate underlining. +No attempt is made to optimize the backward motion. .Sh HISTORY The diff --git a/usr.bin/uniq/uniq.1 b/usr.bin/uniq/uniq.1 index c7cb27574c41..3df43db46bb0 100644 --- a/usr.bin/uniq/uniq.1 +++ b/usr.bin/uniq/uniq.1 @@ -85,7 +85,7 @@ Ignore the first fields in each input line when doing comparisons. A field is a string of non-blank characters separated from adjacent fields by blanks. -Field numbers are one based, i.e. the first field is field one. +Field numbers are one based, i.e., the first field is field one. .It Fl s Ar chars Ignore the first .Ar chars @@ -97,7 +97,7 @@ option, the first characters after the first .Ar num fields will be ignored. -Character numbers are one based, i.e. the first character is character one. +Character numbers are one based, i.e., the first character is character one. .It Fl u Only output lines that are not repeated in the input. .It Fl i @@ -147,7 +147,7 @@ The .Nm utility conforms to .St -p1003.1-2001 -as amended by Cor. 1-2002. +as amended by Cor.\& 1-2002. .Sh HISTORY A .Nm diff --git a/usr.bin/units/units.1 b/usr.bin/units/units.1 index c811dac9ff41..13ed413b155a 100644 --- a/usr.bin/units/units.1 +++ b/usr.bin/units/units.1 @@ -22,18 +22,23 @@ about the number of units loaded. Print the version number. .It Ar from-unit to-unit Allow a single unit conversion to be done directly from the command -line. The program will not print prompts. It will print out the +line. +The program will not print prompts. +It will print out the result of the single specified conversion. .El .Sh DESCRIPTION The .Nm program converts quantities expressed in various scales to -their equivalents in other scales. The +their equivalents in other scales. +The .Nm program can only -handle multiplicative scale changes. It cannot convert Celsius -to Fahrenheit, for example. It works interactively by prompting +handle multiplicative scale changes. +It cannot convert Celsius +to Fahrenheit, for example. +It works interactively by prompting the user for input: .Bd -literal You have: meters @@ -60,11 +65,15 @@ the user for input: Powers of units can be specified using the '^' character as shown in the example, or by simple concatenation: 'cm3' is equivalent to 'cm^3'. Multiplication of units can be specified by using spaces, a dash or -an asterisk. Division of units is indicated by the slash ('/'). +an asterisk. +Division of units is indicated by the slash ('/'). Note that multiplication has a higher precedence than division, -so 'm/s/s' is the same as 'm/s^2' or 'm/s s'. Division of numbers -must be indicated using the vertical bar ('|'). To convert half a -meter, you would write '1|2 meter'. If you write '1/2 meter' then the +so 'm/s/s' is the same as 'm/s^2' or 'm/s s'. +Division of numbers +must be indicated using the vertical bar ('|'). +To convert half a +meter, you would write '1|2 meter'. +If you write '1/2 meter' then the units program would interpret that as equivalent to '0.5/meter'. If you enter incompatible unit types, the units program will print a message indicating that the units are not conformable and @@ -77,9 +86,11 @@ it will display the reduced form for each unit: 2.1166667e-05 kg^2 m / sec .Ed .Pp -The conversion information is read from a units data file. The default +The conversion information is read from a units data file. +The default file includes definitions for most familiar units, abbreviations and -metric prefixes. Some constants of nature included are: +metric prefixes. +Some constants of nature included are: .Pp .Bl -column -offset indent -compact "mercury" .It "pi ratio of circumference to diameter @@ -93,11 +104,16 @@ metric prefixes. Some constants of nature included are: .It "au astronomical unit .El .Pp -The unit 'pound' is a unit of mass. Compound names are run together -so 'pound force' is a unit of force. The unit 'ounce' is also a unit -of mass. The fluid ounce is 'floz'. British units that differ from +The unit 'pound' is a unit of mass. +Compound names are run together +so 'pound force' is a unit of force. +The unit 'ounce' is also a unit +of mass. +The fluid ounce is 'floz'. +British units that differ from their US counterparts are prefixed with 'br', and currency is prefixed -with its country name: 'belgiumfranc', 'britainpound'. When searching +with its country name: 'belgiumfranc', 'britainpound'. +When searching for a unit, if the specified string does not appear exactly as a unit name, then .Nm @@ -107,19 +123,23 @@ trailing 'es' and check again for a match. To find out what units are available read the standard units file. If you want to add your own units you can supply your own file. A unit is specified on a single line by -giving its name and an equivalence. Be careful to define +giving its name and an equivalence. +Be careful to define new units in terms of old ones so that a reduction leads to the primitive units which are marked with '!' characters. The .Nm program will not detect infinite loops that could be caused -by careless unit definitions. Comments in the unit definition file +by careless unit definitions. +Comments in the unit definition file begin with a '/' character at the beginning of a line. .Pp Prefixes are defined in the same was as standard units, but with -a trailing dash at the end of the prefix name. If a unit is not found +a trailing dash at the end of the prefix name. +If a unit is not found even after removing trailing 's' or 'es', then it will be checked -against the list of prefixes. Prefixes will be removed until a legal +against the list of prefixes. +Prefixes will be removed until a legal base unit is identified. .Pp Here is an example of a short units file that defines some basic @@ -142,7 +162,8 @@ Exponents entered by the user can be only one digit. You can work around this by multiplying several terms. .Pp The user must use | to indicate division of numbers and / to -indicate division of symbols. This distinction should not +indicate division of symbols. +This distinction should not be necessary. .Pp The program contains various arbitrary limits on the length diff --git a/usr.bin/vgrind/vgrind.1 b/usr.bin/vgrind/vgrind.1 index 6c0b43518c87..d509517338ee 100644 --- a/usr.bin/vgrind/vgrind.1 +++ b/usr.bin/vgrind/vgrind.1 @@ -66,7 +66,8 @@ The .Nm utility runs in two basic modes, filter mode (see the .Fl f -option) or regular mode. In filter mode +option) or regular mode. +In filter mode .Nm acts as a filter in a manner similar to .Xr tbl 1 . @@ -81,10 +82,12 @@ starts processing ends processing .El .Pp -These lines are formatted as described above. The output from this +These lines are formatted as described above. +The output from this filter can be passed to .Xr troff 1 -for output. There need be no particular ordering with +for output. +There need be no particular ordering with .Xr eqn 1 or .Xr tbl 1 . @@ -119,7 +122,8 @@ forces filter mode specifies a particular header to put on every output page (default is the file name) .It Fl l -specifies the language to use. Currently known are +specifies the language to use. +Currently known are .Tn PASCAL .Pq Fl l Ns Ar p , .Tn MODEL @@ -198,7 +202,8 @@ followed: For .Tn C \- function names can be preceded on a line only by spaces, tabs, or an -asterisk. The parenthesized arguments must also be on the same line. +asterisk. +The parenthesized arguments must also be on the same line. .Pp For .Tn PASCAL @@ -218,7 +223,8 @@ name comment mechanisms will fail. More generally, arbitrary formatting styles for programs mostly look bad. The use of spaces to align source code fails miserably; if you plan to .Nm -your program you should use tabs. This is somewhat inevitable since the +your program you should use tabs. +This is somewhat inevitable since the font used by .Nm is variable width. diff --git a/usr.bin/vgrind/vgrindefs.5 b/usr.bin/vgrind/vgrindefs.5 index 5ecbd7f85616..1bf73aecde4b 100644 --- a/usr.bin/vgrind/vgrindefs.5 +++ b/usr.bin/vgrind/vgrindefs.5 @@ -74,7 +74,8 @@ The following table names and describes each field. .Pp Non-comments are required to describe a certain context where a sequence that would normally start a comment loses its special -meaning. A typical example for this can be found in Perl, where +meaning. +A typical example for this can be found in Perl, where comments are normally starting with .Ql # , while the string @@ -95,7 +96,8 @@ if ifdef ifndef include undef: .Ed .Pp Note that the first field is just the language name (and any variants -of it). Thus the C language could be specified to +of it). +Thus the C language could be specified to .Xr vgrind 1 as "c" or "C". .Pp @@ -132,7 +134,8 @@ a delimiter (space, tab, newline, start of line) .It \ea matches any string of symbols (like .* in lex) .It \ep -matches any alphanumeric name. In a procedure definition (pb) the string +matches any alphanumeric name. +In a procedure definition (pb) the string that matches this symbol is used as the procedure name. .It () grouping @@ -148,11 +151,13 @@ string delimiter in a string by escaping it. .El .Pp Unlike other regular expressions in the system, these match words -and not characters. Hence something like "(tramp|steamer)flies?" +and not characters. +Hence something like "(tramp|steamer)flies?" would match "tramp", "steamer", "trampflies", or "steamerflies". .Sh KEYWORD LIST The keyword list is just a list of keywords in the language separated -by spaces. If the "oc" boolean is specified, indicating that upper +by spaces. +If the "oc" boolean is specified, indicating that upper and lower case are equivalent, then all the keywords should be specified in lower case. .Sh FILES diff --git a/usr.bin/vis/vis.1 b/usr.bin/vis/vis.1 index a1207800d0cb..704a8c758854 100644 --- a/usr.bin/vis/vis.1 +++ b/usr.bin/vis/vis.1 @@ -47,10 +47,12 @@ The .Nm utility is a filter for converting non-printable characters -into a visual representation. It differs from +into a visual representation. +It differs from .Ql cat -v in that -the form is unique and invertible. By default, all non-graphic +the form is unique and invertible. +By default, all non-graphic characters except space, tab, and newline are encoded. A detailed description of the various visual formats is given in @@ -60,9 +62,11 @@ The options are as follows: .Bl -tag -width Ds .It Fl b Turns off prepending of backslash before up-arrow control sequences -and meta characters, and disables the doubling of backslashes. This +and meta characters, and disables the doubling of backslashes. +This produces output which is neither invertible or precise, but does -represent a minimum of change to the input. It is similar to +represent a minimum of change to the input. +It is similar to .Dq Li cat -v . .It Fl c Request a format which displays a small subset of the @@ -94,14 +98,16 @@ still doubled and hidden newline sequences inserted if .Fl f or .Fl F -is selected. When combined with the +is selected. +When combined with the .Fl f flag, .Nm becomes like an invertible version of the .Xr fold 1 -utility. That is, the output +utility. +That is, the output can be unfolded by running the output through .Xr unvis 1 . .It Fl o diff --git a/usr.bin/vmstat/vmstat.8 b/usr.bin/vmstat/vmstat.8 index e3fe78e828e4..4fe175803423 100644 --- a/usr.bin/vmstat/vmstat.8 +++ b/usr.bin/vmstat/vmstat.8 @@ -114,7 +114,8 @@ allocation and then by type of usage. .It Fl n Change the maximum number of disks to display from the default of 2. .It Fl p -Specify which types of devices to display. There are three different +Specify which types of devices to display. +There are three different categories of devices: .Pp .Bl -tag -width indent -compact @@ -166,15 +167,18 @@ Passthrough devices .El .Pp The user must specify at least one device type, and may specify at most -one device type from each category. Multiple device types in a single +one device type from each category. +Multiple device types in a single device type statement must be separated by commas. .Pp Any number of .Fl p -arguments may be specified on the command line. All +arguments may be specified on the command line. +All .Fl p arguments are ORed together to form a matching expression against which -all devices in the system are compared. Any device that fully matches +all devices in the system are compared. +Any device that fully matches any .Fl p argument will be included in the @@ -262,7 +266,8 @@ If more than three disk drives are configured in the system, .Nm displays only the first three drives, unless the user specifies the .Fl n -argument to increase the number of drives displayed. This will probably +argument to increase the number of drives displayed. +This will probably cause the display to exceed 80 columns, however. To force .Nm @@ -272,7 +277,8 @@ The utility defaults to show disks first, and then various other random devices in the system to add up to three devices, if there are that many devices in the -system. If devices are specified on the command line, or if a device type +system. +If devices are specified on the command line, or if a device type matching pattern is specified (see above), .Nm will only display the given devices or the devices matching the pattern, diff --git a/usr.bin/wall/wall.1 b/usr.bin/wall/wall.1 index a170aba113fd..2f1225085bb7 100644 --- a/usr.bin/wall/wall.1 +++ b/usr.bin/wall/wall.1 @@ -56,7 +56,8 @@ to deny messages or are using a program which automatically denies messages. .Bl -tag -width indent .It Fl g -Send messages to users in this group. This option may be specified +Send messages to users in this group. +This option may be specified multiple times, and any user in any of the specified groups will receive the message. .El diff --git a/usr.bin/what/what.1 b/usr.bin/what/what.1 index 518473257072..027debf94e9b 100644 --- a/usr.bin/what/what.1 +++ b/usr.bin/what/what.1 @@ -50,7 +50,8 @@ utility searches each specified .Ar file for sequences of the form .Dq \&@(#) -as inserted by the source code control system. It prints the remainder +as inserted by the source code control system. +It prints the remainder of the string following this marker, up to a NUL character, newline, double quote, .Dq \&> diff --git a/usr.bin/whereis/whereis.1 b/usr.bin/whereis/whereis.1 index 5da6152be0af..c5378b9f2b91 100644 --- a/usr.bin/whereis/whereis.1 +++ b/usr.bin/whereis/whereis.1 @@ -51,7 +51,8 @@ The .Nm utility checks the standard binary, manual page, and source directories for the specified programs, printing out the paths of any -it finds. The supplied program names are first stripped of leading +it finds. +The supplied program names are first stripped of leading path name components, any single trailing extension added by .Xr gzip 1 , .Xr compress 1 , @@ -72,7 +73,8 @@ string, with .Pa /usr/games and the current user's .Ev $PATH -appended. Manual pages are searched by default along the +appended. +Manual pages are searched by default along the .Ev $MANPATH . Program sources are located in a list of known standard places, including all the subdirectories of @@ -83,15 +85,18 @@ and The following options are available: .Bl -tag -width indent .It Fl B -Specify directories to search for binaries. Requires the +Specify directories to search for binaries. +Requires the .Fl f option. .It Fl M -Specify directories to search for manual pages. Requires the +Specify directories to search for manual pages. +Requires the .Fl f option. .It Fl S -Specify directories to search for program sources. Requires the +Specify directories to search for program sources. +Requires the .Fl f option. .It Fl a @@ -121,7 +126,8 @@ Search for source directories. .It Fl u Search for .Dq unusual -entries. A file is said to be unusual if it does not have at least +entries. +A file is said to be unusual if it does not have at least one entry of each requested type. Only the name of the unusual entry is printed. .It Fl x diff --git a/usr.bin/who/who.1 b/usr.bin/who/who.1 index 30540e83fe63..ceb4f2ce1f6f 100644 --- a/usr.bin/who/who.1 +++ b/usr.bin/who/who.1 @@ -114,8 +114,10 @@ created. If .Pa /var/log/wtmp is being used as the file, the user name may be empty -or one of the special characters '|', '}' and '~'. Logouts produce -an output line without any user name. For more information on the +or one of the special characters '|', '}' and '~'. +Logouts produce +an output line without any user name. +For more information on the special characters, see .Xr utmp 5 . .Sh ENVIRONMENT diff --git a/usr.bin/window/window.1 b/usr.bin/window/window.1 index 64d414a30367..cc5f760f60e8 100644 --- a/usr.bin/window/window.1 +++ b/usr.bin/window/window.1 @@ -56,13 +56,17 @@ utility implements a window environment on terminals. .Pp A window is a rectangular portion of the physical terminal -screen associated with a set of processes. Its size and -position can be changed by the user at any time. Processes +screen associated with a set of processes. +Its size and +position can be changed by the user at any time. +Processes communicate with their window in the same way they normally interact with a terminal\-through their standard input, output, -and diagnostic file descriptors. The window program handles the +and diagnostic file descriptors. +The window program handles the details of redirecting input and output to and from the -windows. At any one time, only one window can receive +windows. +At any one time, only one window can receive input from the keyboard, but all windows can simultaneously send output to the display. .Pp @@ -72,7 +76,8 @@ starts up, the commands (see long commands below) contained in the file .Pa .windowrc in the user's home directory are -executed. If it does not exist, two equal sized windows spanning +executed. +If it does not exist, two equal sized windows spanning the terminal screen are created by default. .Pp The command line options are @@ -82,7 +87,8 @@ Turn on terse mode (see .Ic terse command below). .It Fl f -Fast. Don't perform any startup action. +Fast. +Don't perform any startup action. .It Fl d Ignore .Pa .windowrc @@ -105,30 +111,39 @@ as a long command (see below) before doing anything else. .El .Pp -Windows can overlap and are framed as necessary. Each window -is named by one of the digits ``1'' to ``9''. This one-character +Windows can overlap and are framed as necessary. +Each window +is named by one of the digits ``1'' to ``9''. +This one-character identifier, as well as a user definable label string, are displayed -with the window on the top edge of its frame. A window can be +with the window on the top edge of its frame. +A window can be designated to be in the .Ar foreground , in which case it will always be on top of all normal, non-foreground windows, and can be covered -only by other foreground windows. A window need not be completely -within the edges of the terminal screen. Thus a large window +only by other foreground windows. +A window need not be completely +within the edges of the terminal screen. +Thus a large window (possibly larger than the screen) may be positioned to show only a portion of its full size. .Pp -Each window has a cursor and a set of control functions. Most intelligent +Each window has a cursor and a set of control functions. +Most intelligent terminal operations such as line and -character deletion and insertion are supported. Display modes +character deletion and insertion are supported. +Display modes such as underlining and reverse video are available if they are -supported by the terminal. In addition, +supported by the terminal. +In addition, similar to terminals with multiple pages of memory, each window has a text buffer which can have more lines than the window itself. .Ss Process Environment With each newly created window, a shell program is spawned with its -process environment tailored to that window. Its standard input, +process environment tailored to that window. +Its standard input, output, and diagnostic file descriptors are bound to one end of either a pseudo-terminal (see .Xr pty 4 ) @@ -140,7 +155,8 @@ If a pseudo-terminal is used, then its special characters and modes (see .Xr stty 1 ) are copied from the physical -terminal. A +terminal. +A .Xr termcap 5 entry tailored to this window is created and passed as environment (see @@ -151,9 +167,11 @@ The termcap entry contains the window's size and characteristics as well as information from the physical terminal, such as the existence of underline, reverse video, and other display modes, and the codes produced by the terminal's function keys, -if any. In addition, the window size attributes of the pseudo-terminal +if any. +In addition, the window size attributes of the pseudo-terminal are set to reflect the size of this window, and updated whenever -it is changed by the user. In particular, the editor +it is changed by the user. +In particular, the editor .Xr vi 1 uses this information to redraw its display. @@ -161,11 +179,14 @@ this information to redraw its display. During normal execution, .Nm can be in one of two states: -conversation mode and command mode. In conversation mode, the +conversation mode and command mode. +In conversation mode, the terminal's real cursor is placed at the cursor position of a particular window--called the current window--and input from the keyboard is sent -to the process in that window. The current window is always -on top of all other windows, except those in foreground. In addition, +to the process in that window. +The current window is always +on top of all other windows, except those in foreground. +In addition, it is set apart by highlighting its identifier and label in reverse video. .Pp Typing @@ -173,7 +194,8 @@ Typing escape character (normally .Ic ^P ) in conversation -mode switches it into command mode. In command mode, the top line of +mode switches it into command mode. +In command mode, the top line of the terminal screen becomes the command prompt window, and .Nm interprets input from the keyboard as commands to manipulate windows. @@ -195,7 +217,8 @@ means .No control\- Ns Ar X , where .Ar X -is any character. In particular, +is any character. +In particular, .Ic ^^ is .Li control\-^ . @@ -214,17 +237,20 @@ Select window but stay in command mode. .It Ic ^^ Select the previous window and return to conversation -mode. This is useful for toggling between two windows. +mode. +This is useful for toggling between two windows. .It Ic escape Return to conversation mode. .It Ic ^P Return to conversation mode and write .Ic ^P to the -current window. Thus, typing two +current window. +Thus, typing two .Ic ^P Ns 's in conversation -mode sends one to the current window. If the +mode sends one to the current window. +If the .Nm escape is changed to some other character, that character takes the place of @@ -242,23 +268,30 @@ Confirmation is requested. Suspend .Nm . .It Ic w -Create a new window. The user is prompted for the positions +Create a new window. +The user is prompted for the positions of the upper left and lower right corners of the window. The cursor is placed on the screen and the keys ``h'', ``j'', ``k'', and ``l'' move the cursor left, down, up, and right, respectively. The keys ``H'', ``J'', ``K'', and ``L'' move the cursor to the respective -limits of the screen. Typing a number before the movement keys -repeats the movement that number of times. Return enters the cursor position -as the upper left corner of the window. The lower right corner -is entered in the same manner. During this process, +limits of the screen. +Typing a number before the movement keys +repeats the movement that number of times. +Return enters the cursor position +as the upper left corner of the window. +The lower right corner +is entered in the same manner. +During this process, the placement of the new window is indicated by a rectangular box drawn on the screen, corresponding to where the new window -will be framed. Typing escape at any point +will be framed. +Typing escape at any point cancels this command. .Pp This window becomes the current window, -and is given the first available ID. The default buffer size +and is given the first available ID. +The default buffer size is used (see .Ar default_nline command below). @@ -277,12 +310,14 @@ handle this signal correctly and cause no problems. .It Ic m Ns Ar # Move window .Ar # -to another location. A box in the shape +to another location. +A box in the shape of the window is drawn on the screen to indicate the new position of the window, and the same keys as those for the .Ic w -command are used to position the box. The +command are used to position the box. +The window can be moved partially off-screen. .It Ic M Ns Ar # Move window @@ -292,8 +327,10 @@ to its previous position. Change the size of window .Ar # . The user is prompted -to enter the new lower right corner of the window. A box -is drawn to indicate the new window size. The same +to enter the new lower right corner of the window. +A box +is drawn to indicate the new window size. +The same keys used in .Ic w and @@ -324,11 +361,14 @@ Move the cursor of the current window up by one line. .It Ic l Move the cursor of the current window right by one column. .It Ic y -Yank. The user is prompted to enter two points within the current -window. Then the content of the current window between those two points +Yank. +The user is prompted to enter two points within the current +window. +Then the content of the current window between those two points is saved in the yank buffer. .It Ic p -Put. The content of the yank buffer is written to the current +Put. +The content of the yank buffer is written to the current window as input. .It Ic ^S Stop output in the current window. @@ -343,30 +383,40 @@ are supported. .Ss Long Commands Long commands are a sequence of statements parsed much like a programming language, with a syntax -similar to that of C. Numeric and string expressions and variables +similar to that of C. +Numeric and string expressions and variables are supported, as well as conditional statements. .Pp -There are two data types: string and number. A string is a sequence -of letters or digits beginning with a letter. ``_'' and ``.'' are -considered letters. Alternately, non-alphanumeric characters can +There are two data types: string and number. +A string is a sequence +of letters or digits beginning with a letter. +``_'' and ``.'' are +considered letters. +Alternately, non-alphanumeric characters can be included in strings by quoting them in ``"'' or escaping them -with ``\\''. In addition, the ``\\'' sequences of C are supported, +with ``\\''. +In addition, the ``\\'' sequences of C are supported, both inside and outside quotes (e.g., ``\\n'' is a new line, -``\\r'' a carriage return). For example, these are legal strings: +``\\r'' a carriage return). +For example, these are legal strings: abcde01234, "&#$^*&#", ab"$#"cd, ab\\$\\#cd, "/usr/ucb/window". .Pp A number is an integer value in one of three forms: a decimal number, an octal number preceded by ``0'', -or a hexadecimal number preceded by ``0x'' or ``0X''. The natural +or a hexadecimal number preceded by ``0x'' or ``0X''. +The natural machine integer size is used (i.e., the signed integer type -of the C compiler). As in C, a non-zero number represents +of the C compiler). +As in C, a non-zero number represents a boolean true. .Pp The character ``#'' begins a comment which terminates at the end of the line. .Pp -A statement is either a conditional or an expression. Expression -statements are terminated with a new line or ``;''. To continue +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 The @@ -400,14 +450,18 @@ Expressions in .Nm are similar to those in the C language, with most C operators supported on numeric -operands. In addition, some are overloaded to operate on strings. +operands. +In addition, some are overloaded to operate on strings. .Pp When an expression is used as a statement, its value is discarded -after evaluation. Therefore, only expressions with side +after evaluation. +Therefore, only expressions with side effects (assignments and function calls) are useful as statements. .Pp Single valued (no arrays) variables are supported, of both -numeric and string values. Some variables are predefined. They +numeric and string values. +Some variables are predefined. +They are listed below. .Pp The operators in order of increasing precedence: @@ -417,7 +471,8 @@ The operators in order of increasing precedence: .Ic = .Aq Va expr2 .Xc -Assignment. The variable of name +Assignment. +The variable of name .Aq Va expr1 , which must be string valued, is assigned the result of @@ -438,7 +493,8 @@ if evaluates true (non-zero numeric value); returns the value of .Aq Va expr3 -otherwise. Only +otherwise. +Only one of .Aq Va expr2 and @@ -452,7 +508,9 @@ be numeric. .Ic \&|\&| .Aq Va expr2 .Xc -Logical or. Numeric values only. Short circuit evaluation is supported +Logical or. +Numeric values only. +Short circuit evaluation is supported (i.e., if .Aq Va expr1 evaluates true, then @@ -463,25 +521,29 @@ is not evaluated). .Ic \&&\&& .Aq Va expr2 .Xc -Logical and with short circuit evaluation. Numeric values only. +Logical and with short circuit evaluation. +Numeric values only. .It Xo .Aq Va expr1 .Ic \&| .Aq Va expr2 .Xc -Bitwise or. Numeric values only. +Bitwise or. +Numeric values only. .It Xo .Aq Va expr1 .Ic ^ .Aq Va expr2 .Xc -Bitwise exclusive or. Numeric values only. +Bitwise exclusive or. +Numeric values only. .It Xo .Aq Va expr1 .Ic \&& .Aq Va expr2 .Xc -Bitwise and. Numeric values only. +Bitwise and. +Numeric values only. .It Xo .Aq Va expr1 .Ic == @@ -490,9 +552,12 @@ Bitwise and. Numeric values only. .Ic != .Aq expr2 .Xc -Comparison (equal and not equal, respectively). The boolean -result (either 1 or 0) of the comparison is returned. The -operands can be numeric or string valued. One string operand +Comparison (equal and not equal, respectively). +The boolean +result (either 1 or 0) of the comparison is returned. +The +operands can be numeric or string valued. +One string operand forces the other to be converted to a string in necessary. .It Xo .Aq Va expr1 @@ -506,7 +571,8 @@ forces the other to be converted to a string in necessary. .Aq Va expr2 , .Xc Less than, greater than, less than or equal to, -greater than or equal to. Both numeric and string values, with +greater than or equal to. +Both numeric and string values, with automatic conversion as above. .It Xo .Aq Va expr1 @@ -521,7 +587,8 @@ If both operands are numbers, is bit shifted left (or right) by .Aq Va expr2 -bits. If +bits. +If .Aq Va expr1 is a string, then its first (or last) @@ -539,7 +606,8 @@ in place of its value). .Ic - .Aq Va expr2 .Xc -Addition and subtraction on numbers. For ``+'', if one +Addition and subtraction on numbers. +For ``+'', if one argument is a string, then the other is converted to a string, and the result is the concatenation of the two strings. .It Xo @@ -553,7 +621,8 @@ and the result is the concatenation of the two strings. .Ic \&% .Aq Va expr2 .Xc -Multiplication, division, modulo. Numbers only. +Multiplication, division, modulo. +Numbers only. .It Xo .Ic \- Ns Aq Va expr , .Ic ~ Ns Aq Va expr , @@ -562,16 +631,19 @@ Multiplication, division, modulo. Numbers only. .Ic \&$? Ns Aq Va expr .Xc The first three are unary minus, bitwise complement and logical complement -on numbers only. The operator, ``$'', takes +on numbers only. +The operator, ``$'', takes .Aq Va expr and returns -the value of the variable of that name. If +the value of the variable of that name. +If .Aq Va expr is numeric with value .Ar n and it appears within an alias macro (see below), -then it refers to the nth argument of the alias invocation. ``$?'' +then it refers to the nth argument of the alias invocation. +``$?'' tests for the existence of the variable .Aq Va expr , and returns 1 @@ -585,7 +657,8 @@ must be a string that is the unique prefix of the name of a builtin .Nm function -or the full name of a user defined alias macro. In the case of a builtin +or the full name of a user defined alias macro. +In the case of a builtin function, .Aq Ar arglist can be in one of two forms: @@ -595,28 +668,36 @@ argname1 = , argname2 = , ... .Ed .Pp The two forms can in fact be intermixed, but the result is -unpredictable. Most arguments can be omitted; default values will -be supplied for them. The +unpredictable. +Most arguments can be omitted; default values will +be supplied for them. +The .Ar argnames can be unique prefixes -of the argument names. The commas separating +of the argument names. +The commas separating arguments are used only to disambiguate, and can usually be omitted. .Pp -Only the first argument form is valid for user defined aliases. Aliases +Only the first argument form is valid for user defined aliases. +Aliases are defined using the .Ic alias -builtin function (see below). Arguments +builtin function (see below). +Arguments are accessed via a variant of the variable mechanism (see ``$'' operator above). .Pp Most functions return value, but some are used for side effect -only and so must be used as statements. When a function or an alias is used +only and so must be used as statements. +When a function or an alias is used as a statement, the parentheses surrounding -the argument list may be omitted. Aliases return no value. +the argument list may be omitted. +Aliases return no value. .El .Ss Builtin Functions The arguments are listed by name in their natural -order. Optional arguments are in square brackets +order. +Optional arguments are in square brackets .Sq Op . Arguments that have no names are in angle brackets @@ -640,14 +721,16 @@ in which case a non-zero value is true. .Bq Aq Ar string\-list .Pc If no argument is given, all currently defined alias macros are -listed. Otherwise, +listed. +Otherwise, .Aq Ar string is defined as an alias, with expansion .Aq Ar string\-list > . The previous definition of .Aq Ar string , -if any, is returned. Default for +if any, is returned. +Default for .Aq Ar string\-list is no change. .It Ic close Ns Pq Aq Ar window\-list @@ -657,7 +740,8 @@ If .Aq Ar window\-list is the word .Ar all , -than all windows are closed. No value is returned. +than all windows are closed. +No value is returned. .It Ic cursormodes Ns Pq Bq Ar modes Set the window cursor to .Ar modes . @@ -672,8 +756,10 @@ or of the mode bits defined as the variables (blinking), and .Ar m_grp -(graphics, terminal dependent). Return -value is the previous modes. Default is no change. +(graphics, terminal dependent). +Return +value is the previous modes. +Default is no change. For example, .Li cursor($m_rev$m_blk) sets the window cursors to blinking @@ -682,14 +768,19 @@ reverse video. Set the default buffer size to .Ar nline . Initially, it is -48 lines. Returns the old default buffer size. Default is -no change. Using a very large buffer can slow the program down +48 lines. +Returns the old default buffer size. +Default is +no change. +Using a very large buffer can slow the program down considerably. .It Ic default_shell Ns Pq Bq Aq Ar string\-list Set the default window shell program to .Aq Ar string\-list . Returns -the first string in the old shell setting. Default is no change. Initially, +the first string in the old shell setting. +Default is no change. +Initially, the default shell is taken from the environment variable .Ev SHELL . .It Ic default_smooth Ns Pq Bq Ar flag @@ -698,7 +789,8 @@ Set the default value of the argument to the command .Nm -(see below). The argument +(see below). +The argument is a boolean flag (one of .Ar on , .Ar off , @@ -707,7 +799,8 @@ is a boolean flag (one of .Ar true , .Ar false , or a number, -as described above). Default is no change. +as described above). +Default is no change. The old value (as a number) is returned. The initial value is 1 (true). .It Xo @@ -719,17 +812,21 @@ Write the list of strings, to .Nm , separated -by spaces and terminated with a new line. The strings are only +by spaces and terminated with a new line. +The strings are only displayed in the window, the processes in the window are not involved (see .Ic write -below). No value is returned. Default +below). +No value is returned. +Default is the current window. .It Ic escape Ns Pq Bq Ar escapec Set the escape character to .Ar escape-char . Returns the old -escape character as a one-character string. Default is no +escape character as a one-character string. +Default is no change. .Ar Escapec can be a string of a single character, or @@ -745,8 +842,10 @@ Move .Nm in or out of foreground. .Ar Flag -is a boolean value. The old foreground flag -is returned. Default for +is a boolean value. +The old foreground flag +is returned. +Default for .Nm is the current window, default for @@ -761,21 +860,27 @@ Set the label of to .Ar label . Returns the old -label as a string. Default for +label as a string. +Default for .Nm is the current window, default for .Ar label -is no change. To turn +is no change. +To turn off a label, set it to an empty string (""). .It Ic list Ns Pq -No arguments. List the identifiers and labels of all windows. No +No arguments. +List the identifiers and labels of all windows. +No value is returned. .It Ic select Ns Pq Bq Ar window Make .Nm -the current window. The previous current window -is returned. Default is no change. +the current window. +The previous current window +is returned. +Default is no change. .It Ic source Ns Pq Ar filename Read and execute the long commands in .Ar filename . @@ -790,7 +895,8 @@ sounding the terminal's bell. can take on the same values as in .Ar foreground -above. Returns the old terse flag. +above. +Returns the old terse flag. Default is no change. .It Ic unalias Ns Pq Ar alias Undefine @@ -807,7 +913,9 @@ Returns -1 if does not exist, 0 otherwise. .It Ic variables Ns Pq -No arguments. List all variables. No value is returned. +No arguments. +List all variables. +No value is returned. .It Xo .Ic window Ns ( Bq Ar row , .Bq Ar column , @@ -831,8 +939,10 @@ and size If .Ar nline is specified, -then that many lines are allocated for the text buffer. Otherwise, -the default buffer size is used. Default values for +then that many lines are allocated for the text buffer. +Otherwise, +the default buffer size is used. +Default values for .Ar row , .Ar column , .Ar nrow , @@ -856,10 +966,12 @@ allocate pseudo-terminal for this window rather than socketpair (default true), and map new line characters in this window to carriage return and line feed (default true if socketpair is used, false otherwise). Normally, a window is automatically closed when its process -exits. Setting +exits. +Setting .Ar keepopen to true (default false) prevents this -action. When +action. +When .Ar smooth is true, the screen is updated more frequently (for this window) to produce a more terminal-like behavior. @@ -873,7 +985,8 @@ is a list of strings that will be used as the shell program to place in the window (default is the program specified by .Ar default_shell , -see above). The created window's identifier +see above). +The created window's identifier is returned as a number. .It Xo .Ic write Ns ( Bq Ar window , @@ -884,12 +997,16 @@ Send the list of strings, to .Nm , separated -by spaces but not terminated with a new line. The strings are actually -given to the window as input. No value is returned. Default +by spaces but not terminated with a new line. +The strings are actually +given to the window as input. +No value is returned. +Default is the current window. .El .Ss Predefined Variables -These variables are for information only. Redefining them does +These variables are for information only. +Redefining them does not affect the internal operation of .Nm . .Bl -tag -width modes @@ -897,7 +1014,8 @@ not affect the internal operation of The baud rate as a number between 50 and 38400. .It Ar modes The display modes (reverse video, underline, blinking, graphics) -supported by the physical terminal. The value of +supported by the physical terminal. +The value of .Ar modes is the bitwise or of some of the one bit values, .Ar m_blk , @@ -923,7 +1041,8 @@ The number of columns on the physical screen. .It Ar nrow The number of rows on the physical screen. .It Ar term -The terminal type. The standard name, found in the second name +The terminal type. +The standard name, found in the second name field of the terminal's .Ev TERMCAP entry, is used. diff --git a/usr.bin/xinstall/install.1 b/usr.bin/xinstall/install.1 index 20ee4f12e817..e8033d0ffc97 100644 --- a/usr.bin/xinstall/install.1 +++ b/usr.bin/xinstall/install.1 @@ -237,7 +237,8 @@ exits abnormally. .Pp File flags cannot be set by .Xr fchflags 2 -over a NFS file system. Other file systems do not have a concept of flags. +over a NFS file system. +Other file systems do not have a concept of flags. The .Nm utility will only warn when flags could not be set on a file system diff --git a/usr.bin/yacc/yacc.1 b/usr.bin/yacc/yacc.1 index 00b50caa75a8..87466b5ca9ff 100644 --- a/usr.bin/yacc/yacc.1 +++ b/usr.bin/yacc/yacc.1 @@ -104,7 +104,8 @@ The default prefix is the string .It Fl r Cause .Nm -to produce separate files for code and tables. The code file +to produce separate files for code and tables. +The code file is named .Pa y.code.c , and the tables file is named diff --git a/usr.bin/ypwhich/ypwhich.1 b/usr.bin/ypwhich/ypwhich.1 index 47d4292d49e6..25eeb08fb0e3 100644 --- a/usr.bin/ypwhich/ypwhich.1 +++ b/usr.bin/ypwhich/ypwhich.1 @@ -73,13 +73,15 @@ to their corresponding map names. .It Fl m Op Ar mname Find the master .Tn YP -server for the named map. No +server for the named map. +No .Ar host may be specified with the .Fl m option. .Ar Mname -can be a map name or nickname. If +can be a map name or nickname. +If .Ar mname is omitted, .Nm