From d7b87853ad02031845dedc2e4eb43470f70629b2 Mon Sep 17 00:00:00 2001 From: Aaron Campbell Date: Mon, 14 Sep 1998 22:14:01 +0000 Subject: First complete sweep of man pages, bin/. Command/function names previously (incorrectly) capatilized are fixed. Comma splices, hyphenations, SYNOPSIS cleanups, other miscellaneous typos. --- bin/cat/cat.1 | 14 ++++--- bin/chio/chio.1 | 18 +++++---- bin/chmod/chmod.1 | 26 +++++++------ bin/cp/cp.1 | 33 +++++++++-------- bin/csh/csh.1 | 5 ++- bin/date/date.1 | 27 +++++++------- bin/dd/dd.1 | 10 ++--- bin/df/df.1 | 8 ++-- bin/domainname/domainname.1 | 6 +-- bin/echo/echo.1 | 6 +-- bin/ed/ed.1 | 57 +++++++++++++++------------- bin/expr/expr.1 | 13 ++++--- bin/hostname/hostname.1 | 4 +- bin/kill/kill.1 | 32 +++++++++------- bin/ln/ln.1 | 10 ++--- bin/ls/ls.1 | 33 +++++++++-------- bin/md5/md5.1 | 12 +++--- bin/mkdir/mkdir.1 | 9 +++-- bin/mt/mt.1 | 35 +++++++++--------- bin/mv/mv.1 | 6 +-- bin/pax/cpio.1 | 26 ++++++------- bin/pax/pax.1 | 90 ++++++++++++++++++++++----------------------- bin/pax/tar.1 | 18 ++++----- bin/ps/ps.1 | 22 +++++------ bin/pwd/pwd.1 | 8 ++-- bin/rcp/rcp.1 | 24 ++++-------- bin/rmail/rmail.8 | 8 ++-- bin/rmdir/rmdir.1 | 6 ++- bin/sleep/sleep.1 | 6 +-- bin/stty/stty.1 | 18 +++++---- bin/sync/sync.8 | 8 ++-- bin/test/test.1 | 20 +++++----- 32 files changed, 320 insertions(+), 298 deletions(-) diff --git a/bin/cat/cat.1 b/bin/cat/cat.1 index 9072cfd8259..7067af21c94 100644 --- a/bin/cat/cat.1 +++ b/bin/cat/cat.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: cat.1,v 1.4 1997/11/08 10:20:31 todd Exp $ +.\" $OpenBSD: cat.1,v 1.5 1998/09/14 22:13:34 aaron Exp $ .\" $NetBSD: cat.1,v 1.12 1995/09/27 05:38:55 cgd Exp $ .\" .\" Copyright (c) 1989, 1990, 1993 @@ -89,22 +89,24 @@ option guarantees that the output is unbuffered. Displays non-printing characters so they are visible. Control characters print as .Ql ^X -for control-X; the delete +for control-X. The DEL character (octal 0177) prints as -.Ql ^? -Non-ascii characters (with the high bit set) are printed as +.Ql ^? . +Non-ASCII characters (with the high bit set) are printed as .Ql M- (for meta) followed by the character for the low 7 bits. .El .Pp The .Nm cat -utility exits 0 on success, and >0 if an error occurs. +utility exits 0 on success or >0 if an error occurred. .Sh BUGS Because of the shell language mechanism used to perform output redirection, the command .Dq Li cat file1 file2 > file1 -will cause the original data in file1 to be destroyed! +will cause the original data in +.Ar file1 +to be destroyed! .Sh SEE ALSO .Xr head 1 , .Xr more 1 , diff --git a/bin/chio/chio.1 b/bin/chio/chio.1 index 10c25df6107..e8bbd2aa8ee 100644 --- a/bin/chio/chio.1 +++ b/bin/chio/chio.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: chio.1,v 1.6 1997/11/08 23:22:40 todd Exp $ +.\" $OpenBSD: chio.1,v 1.7 1998/09/14 22:13:37 aaron Exp $ .\" $NetBSD: chio.1,v 1.1.1.1 1996/04/03 00:34:38 thorpej Exp $ .\" .\" Copyright (c) 1996 Jason R. Thorpe @@ -44,11 +44,11 @@ .Ar arg1 .Ar arg2 .Oo -.Ar arg3 Oo ... +.Ar arg3 Oo Ar ... .Oc .Oc .Sh DESCRIPTION -.Nm Chio +.Nm chio is used to control the operation of medium changers, such as those found in tape and optical disk jukeboxes. .Pp @@ -62,7 +62,7 @@ rather than the default device .El .Pp The default changer may be overridden by setting the environment variable -.Nm CHANGER +.Ev CHANGER to the desired changer device. .Pp A medium changer apparatus is made up of @@ -189,16 +189,20 @@ Element supports receiving media (importing) from an outside human operator. Moves the media in slot 3 (fourth slot) to drive 0 (first drive). .Pp .Nm chio setpicker 2 +.Pp Configures the changer to use picker 2 (third picker) for operations. .Pp .Sh FILES -/dev/ch0 - default changer device +.Bl -tag -width /dev/ch0 -compact +.It Pa /dev/ch0 +default changer device +.El .Sh SEE ALSO .Xr mt 1 , .Xr ch 4 , -.Xr mount 8 . +.Xr mount 8 .Sh AUTHOR The .Nm chio program and SCSI changer driver were written by Jason R. Thorpe - for And Communications, http://www.and.com/ + for And Communications (http://www.and.com/). diff --git a/bin/chmod/chmod.1 b/bin/chmod/chmod.1 index 5c198d2187d..278326b5280 100644 --- a/bin/chmod/chmod.1 +++ b/bin/chmod/chmod.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: chmod.1,v 1.4 1997/11/17 06:54:59 deraadt Exp $ +.\" $OpenBSD: chmod.1,v 1.5 1998/09/14 22:13:38 aaron Exp $ .\" $NetBSD: chmod.1,v 1.8 1995/03/21 09:02:07 cgd Exp $ .\" .\" Copyright (c) 1989, 1990, 1993, 1994 @@ -50,7 +50,7 @@ .Op Fl H | Fl L | Fl P .Oc .Ar mode -.Ar file ... +.Ar file Op Ar ... .Sh DESCRIPTION The .Nm chmod @@ -102,7 +102,7 @@ the mode of a file. .Pp The .Nm chmod -utility exits 0 on success, and >0 if an error occurs. +utility exits 0 on success or >0 if an error occurred. .Sh MODES Modes may be absolute or symbolic. An absolute mode is an octal number constructed by @@ -186,7 +186,7 @@ The other permission bits in the mode of the original file. The .Ar op symbols represent the operation performed, as follows: -.Bl -tag -width 4n +.Bl -tag -width 4n -offset indent .It + If no value is supplied for .Ar perm , @@ -220,7 +220,9 @@ values are cleared. .It = The mode bits specified by the .Ar who -value are cleared, or, if no who value is specified, the owner, group +value are cleared, or, if no +.Ar who +value is specified, the owner, group and other mode bits are cleared. Then, if no value is supplied for .Ar who , @@ -248,29 +250,29 @@ symbols ``s'' or ``t'', are ignored. .Sh EXAMPLES .Bl -tag -width "u=rwx,go=u-w" -compact .It Li 644 -make a file readable by anyone and writable by the owner only. +Make a file readable by anyone and writable by the owner only. .Pp .It Li go-w -deny write permission to group and others. +Deny write permission to group and others. .Pp .It Li =rw,+X -set the read and write permissions to the usual defaults, but +Set the read and write permissions to the usual defaults, but retain any execute permissions that are currently set. .Pp .It Li +X -make a directory or file searchable/executable by everyone if it is +Make a directory or file searchable/executable by everyone if it is already searchable/executable by anyone. .Pp .It Li 755 .It Li u=rwx,go=rx .It Li u=rwx,go=u-w -make a file readable/executable by everyone and writable by the owner only. +Make a file readable/executable by everyone and writable by the owner only. .Pp .It Li go= -clear all mode bits for group and others. +Clear all mode bits for group and others. .Pp .It Li g=u-w -set the group bits equal to the user bits, but clear the group write bit. +Set the group bits equal to the user bits, but clear the group write bit. .El .Sh BUGS There's no diff --git a/bin/cp/cp.1 b/bin/cp/cp.1 index cdafd425fbb..2d4b3a2a09f 100644 --- a/bin/cp/cp.1 +++ b/bin/cp/cp.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: cp.1,v 1.3 1997/11/08 23:07:25 todd Exp $ +.\" $OpenBSD: cp.1,v 1.4 1998/09/14 22:13:37 aaron Exp $ .\" $NetBSD: cp.1,v 1.9 1995/07/25 19:36:45 jtc Exp $ .\" .\" Copyright (c) 1989, 1990, 1993, 1994 @@ -68,7 +68,7 @@ to the In the second synopsis form, the contents of each named .Ar source_file -is copied to the destination +are copied to the destination .Ar target_directory . The names of the files themselves are not changed. If @@ -101,10 +101,10 @@ indirected through, and for .Nm cp to create special files rather than copying them as normal files. Created directories have the same mode as the corresponding source -directory, unmodified by the process' umask. +directory, unmodified by the process's umask. .It Fl f For each existing destination pathname, remove it and -create a new file, without prompting for confirmation +create a new file, without prompting for confirmation, regardless of its permissions. (The .Fl i @@ -128,15 +128,15 @@ file flags, file mode, user ID, and group ID as allowed by permissions. If the user ID and group ID cannot be preserved, no error message is displayed and the exit value is not altered. .Pp -If the source file has its set user ID bit on and the user ID cannot -be preserved, the set user ID bit is not preserved +If the source file has its set-user-ID bit on and the user ID cannot +be preserved, the set-user-ID bit is not preserved in the copy's permissions. -If the source file has its set group ID bit on and the group ID cannot -be preserved, the set group ID bit is not preserved +If the source file has its set-group-ID bit on and the group ID cannot +be preserved, the set-group-ID bit is not preserved in the copy's permissions. -If the source file has both its set user ID and set group ID bits on, +If the source file has both its set-user-ID and set-group-ID bits on, and either the user ID or group ID cannot be preserved, neither -the set user ID or set group ID bits are preserved in the copy's +the set-user-ID nor set-group-ID bits are preserved in the copy's permissions. .El .Pp @@ -157,13 +157,13 @@ used as modified by the file mode creation mask .Pf ( Ic umask , see .Xr csh 1 ) . -If the source file has its set user ID bit on, that bit is removed +If the source file has its set-user-ID bit on, that bit is removed unless both the source file and the destination file are owned by the same user. -If the source file has its set group ID bit on, that bit is removed +If the source file has its set-group-ID bit on, that bit is removed unless both the source file and the destination file are in the same group and the user is a member of that group. -If both the set user ID and set group ID bits are set, all of the above +If both the set-user-ID and set-group-ID bits are set, all of the above conditions must be fulfilled or both bits are removed. .Pp Appropriate permissions are required for file creation or overwriting. @@ -189,8 +189,9 @@ option is specified. In addition, these options override each other and the command's actions are determined by the last one specified. .Pp -.Nm Cp -exits 0 on success, >0 if an error occurred. +The +.Nm cp +utility exits 0 on success or >0 if an error occurred. .Sh COMPATIBILITY Historic versions of the .Nm cp @@ -199,7 +200,7 @@ utility had a option. This implementation supports that option, however, its use is strongly discouraged, as it does not correctly copy special files, symbolic links -or fifo's. +or FIFOs. .Sh SEE ALSO .Xr mv 1 , .Xr rcp 1 , diff --git a/bin/csh/csh.1 b/bin/csh/csh.1 index f792848d7f8..0f29b3e5488 100644 --- a/bin/csh/csh.1 +++ b/bin/csh/csh.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: csh.1,v 1.13 1998/08/31 19:52:48 deraadt Exp $ +.\" $OpenBSD: csh.1,v 1.14 1998/09/14 22:13:39 aaron Exp $ .\" $NetBSD: csh.1,v 1.10 1995/03/21 09:02:35 cgd Exp $ .\" .\" Copyright (c) 1980, 1990, 1993 @@ -1261,7 +1261,8 @@ instead of oldest first. The .Fl h option causes the history list to be printed without leading numbers. -This format produces files suitable for sourcing using the \-h +This format produces files suitable for sourcing using the +.Fl h option to .Ic source . .Pp diff --git a/bin/date/date.1 b/bin/date/date.1 index d7ca4034284..e0b087e9ea2 100644 --- a/bin/date/date.1 +++ b/bin/date/date.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: date.1,v 1.12 1998/09/01 03:39:35 pjanzen Exp $ +.\" $OpenBSD: date.1,v 1.13 1998/09/14 22:13:42 aaron Exp $ .\" $NetBSD: date.1,v 1.12 1996/03/12 04:32:37 phil Exp $ .\" .\" Copyright (c) 1980, 1990, 1993 @@ -52,7 +52,7 @@ .Op Cm + Ns Ar format .Op [[[[[cc]yy]mm]dd]HH]MM[\&.SS] .Sh DESCRIPTION -.Nm Date +.Nm date displays the current date and time when invoked without arguments. Providing arguments will format the date and time in a user-defined way or set the date. @@ -68,7 +68,7 @@ is non-zero, future calls to .Xr gettimeofday 2 will return a non-zero -.Ql tz_dsttime . +.Ql tz_dsttime . .It Fl n The utility .Xr timed 8 @@ -90,7 +90,7 @@ from the Epoch. .It Fl t Set the kernel's value for minutes west of .Tn GMT . -.Ar Minutes_west +.Ar minutes_west specifies the number of minutes returned in .Ql tz_minuteswest by future calls to @@ -120,27 +120,26 @@ The canonical representation for setting the date and time is: .Pp .Bl -tag -width Ds -compact -offset indent .It Ar yy -Year in abbreviated form (.e.g 89 for 1989, 06 for 2006). +Year in abbreviated form (e.g. 89 for 1989, 06 for 2006). The format .Ar ccyymmddHHMM is also permitted, for non-ambiguous years beyond 1999. .It Ar mm -Numeric month. -A number from 1 to 12. +Numeric month, a number from 1 to 12. .It Ar dd Day, a number from 1 to 31. .It Ar HH Hour, a number from 0 to 23. .It Ar MM -Minutes, a number from 0 to 59. +Minute, a number from 0 to 59. .It Ar .SS -Seconds, a number from 0 to 61 (59 plus a maximum of two leap seconds). +Second, a number from 0 to 61 (59 plus a maximum of two leap seconds). .El .Pp -Everything but the minutes is optional. +Everything but the minute is optional. .Pp -Time changes for Daylight Saving and Standard time and leap seconds -and years are handled automatically. +Time changes for daylight savings, standard time, leap seconds, +and leap years are handled automatically. .Sh EXAMPLES The command: .Bd -literal -offset indent @@ -182,9 +181,9 @@ for more information. .Sh FILES .Bl -tag -width /var/log/messages -compact .It Pa /var/log/wtmp -A record of date resets and time changes. +record of date resets and time changes .It Pa /var/log/messages -A record of the user setting the time. +record of the user setting the time .El .Sh SEE ALSO .Xr gettimeofday 2 , diff --git a/bin/dd/dd.1 b/bin/dd/dd.1 index 5537881a44a..0d264ac4538 100644 --- a/bin/dd/dd.1 +++ b/bin/dd/dd.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: dd.1,v 1.3 1997/04/17 10:14:36 deraadt Exp $ +.\" $OpenBSD: dd.1,v 1.4 1998/09/14 22:13:43 aaron Exp $ .\" $NetBSD: dd.1,v 1.5 1995/03/21 09:04:04 cgd Exp $ .\" .\" Copyright (c) 1990, 1993 @@ -111,13 +111,13 @@ Any regular output file is truncated unless the conversion value is specified. If an initial portion of the output file is skipped (see the .Cm seek -operand) +operand), the output file is truncated at that point. .It Cm seek= Ns Ar n Seek .Va n blocks from the beginning of the output before copying. -On non-tape devices, a +On non-tape devices, an .Xr lseek 2 operation is used. Otherwise, existing blocks are read and the data discarded. @@ -133,7 +133,7 @@ bytes. Skip .Va n blocks from the beginning of the input before copying. -On input which supports seeks, a +On input which supports seeks, an .Xr lseek 2 operation is used. Otherwise, input data is read and discarded. @@ -327,7 +327,7 @@ will exit. .Pp The .Nm dd -utility exits 0 on success and >0 if an error occurred. +utility exits 0 on success or >0 if an error occurred. .Sh SEE ALSO .Xr cp 1 , .Xr mt 1 , diff --git a/bin/df/df.1 b/bin/df/df.1 index b7529bd2dfe..dd6fbc6cb7e 100644 --- a/bin/df/df.1 +++ b/bin/df/df.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: df.1,v 1.9 1998/08/25 18:39:18 kstailey Exp $ +.\" $OpenBSD: df.1,v 1.10 1998/09/14 22:13:44 aaron Exp $ .\" $NetBSD: df.1,v 1.12 1995/12/05 02:42:45 jtc Exp $ .\" .\" Copyright (c) 1989, 1990, 1993 @@ -46,14 +46,14 @@ .Op Fl t Ar type .Op Ar file | Ar file_system ... .Sh DESCRIPTION -.Nm Df +.Nm df displays statistics about the amount of free disk space on the specified .Ar file_system or on the file system of which .Ar file is a part. Values are displayed in 512-byte per block block counts. -If neither a file or a +If neither a file nor a .Ar file_system operand is specified, statistics for all mounted file systems are displayed @@ -93,7 +93,7 @@ with the possibly stale statistics that were previously obtained. Print out information in a stricter format designed to be parsed by portable scripts. .It Fl t Ar type -Is used to indicate the actions should only be taken on +Used to indicate the actions should only be taken on filesystems of the specified type. More than one type may be specified in a comma separated list. The list of filesystem types can be prefixed with diff --git a/bin/domainname/domainname.1 b/bin/domainname/domainname.1 index 6375bf12950..969c761e4c6 100644 --- a/bin/domainname/domainname.1 +++ b/bin/domainname/domainname.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: domainname.1,v 1.3 1997/05/30 09:12:51 deraadt Exp $ +.\" $OpenBSD: domainname.1,v 1.4 1998/09/14 22:13:45 aaron Exp $ .\" $NetBSD: domainname.1,v 1.7 1995/07/25 19:36:57 jtc Exp $ .\" .\" Copyright (c) 1983, 1988, 1990, 1993 @@ -44,7 +44,7 @@ .Nm domainname .Op Ar name-of-domain .Sh DESCRIPTION -.Nm Domainname +.Nm domainname prints the YP domain name of the current host. The super-user can set the domain name by supplying an argument; this is usually done in the network initialization script @@ -60,7 +60,7 @@ The .Nm domainname utility is derived from the .Nm hostname -utility , which appeared in +utility, which appeared in .Bx 4.2 . The .Nm domainname diff --git a/bin/echo/echo.1 b/bin/echo/echo.1 index 60b67da8129..694e575bb2f 100644 --- a/bin/echo/echo.1 +++ b/bin/echo/echo.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: echo.1,v 1.2 1996/06/23 14:19:55 deraadt Exp $ +.\" $OpenBSD: echo.1,v 1.3 1998/09/14 22:13:45 aaron Exp $ .\" $NetBSD: echo.1,v 1.7 1995/03/21 09:04:26 cgd Exp $ .\" .\" Copyright (c) 1990, 1993 @@ -46,7 +46,7 @@ .Sh SYNOPSIS .Nm echo .Op Fl n -.Op "string ..." +.Op Ar string ... .Sh DESCRIPTION The .Nm echo @@ -62,7 +62,7 @@ Do not print the trailing newline character. .Pp The .Nm echo -utility exits 0 on success, and >0 if an error occurs. +utility exits 0 on success or >0 if an error occurred. .Sh SEE ALSO .Xr printf 1 .Sh STANDARDS diff --git a/bin/ed/ed.1 b/bin/ed/ed.1 index 9d67dae607d..b2c5a8f5386 100644 --- a/bin/ed/ed.1 +++ b/bin/ed/ed.1 @@ -1,6 +1,6 @@ -.\" $OpenBSD: ed.1,v 1.11 1998/09/01 16:38:14 deraadt Exp $ +.\" $OpenBSD: ed.1,v 1.12 1998/09/14 22:13:46 aaron Exp $ .\" -.Dd May 2 1993 +.Dd May 2, 1993 .Dt ED 1 .Os BSD 4 .Sh NAME @@ -32,13 +32,13 @@ any changes not explicitly saved with a command are lost. .Pp Editing is done in two distinct modes: -.Pa command +.Em command and -.Pa input No . +.Em input . When first invoked, .Nm is in command mode. -In this mode commands are read from the standard input and +In this mode, commands are read from the standard input and executed to manipulate the contents of the editor buffer. .Pp A typical command might look like: @@ -49,14 +49,14 @@ A typical command might look like: which replaces all occurrences of the string .Pa old with -.Pa new No . +.Pa new . .Pp When an input command, such as .Em a (append), .Em i (insert) or -.em c +.Em c (change), is given, .Nm enters input mode. This is the primary means @@ -69,7 +69,7 @@ including a character. Input mode is terminated by entering a single period -.No ( Em \&. Ns No ) +.Pq Ql \&. on a line. .Pp All @@ -81,7 +81,7 @@ command deletes lines; the .Em m command moves lines, and so on. It is possible to modify only a portion of a line by means of replacement, -as in the example above. However even here, the +as in the example above. However, even here, the .Em s command is applied to whole lines at a time. .Pp @@ -117,16 +117,17 @@ command. Specifies the name of a file to read. If .Ar file is prefixed with a -bang (!), then it is interpreted as a shell command. In this case, +bang +.Pq Ql \&! , +then it is interpreted as a shell command. In this case, what is read is the standard output of .Ar file executed via .Xr sh 1 . To read a file whose name begins with a bang, prefix the -name with a -.Em \e -(backslash). +name with a backslash +.Pq Ql \e . The default filename is set to .Ar file only if it is not prefixed with a bang. @@ -440,9 +441,8 @@ All commands are single characters, though some require additional parameters. If a command's parameters extend over several lines, then each line except for the last -must be terminated with a -.Em \e -(backslash). +must be terminated with a backslash +.Pq Ql \e . .Pp In general, at most one command is allowed per line. However, most commands accept a print suffix, which is any of @@ -565,7 +565,9 @@ repeats the last non-null command list. .It Em H Toggles the printing of error explanations. By default, explanations are not printed. -It is recommended that ed scripts begin with this command to +It is recommended that +.Nm +scripts begin with this command to aid in debugging. .It Em h Prints an explanation of the last error. @@ -617,9 +619,12 @@ Unless a prompt was specified by with command-line option .Fl p Ar string Ns No , the command prompt is by default turned off. .It Em q -Quits ed. +Quits +.Nm ed . .It Em Q -Quits ed unconditionally. +Quits +.Nm +unconditionally. This is similar to the .Em q command, @@ -841,20 +846,20 @@ is printed to the standard output. The current line is unchanged. .El .Sh FILES -.Bl -tag -width /etc/passwd -compact +.Bl -tag -width /tmp/ed.* -compact .It Pa /tmp/ed.* -Buffer file +buffer file .It Pa ed.hup -The file to which +file to which .Nm -attempts to write the buffer if the terminal hangs up. +attempts to write the buffer if the terminal hangs uo .El .Sh SEE ALSO .Xr vi 1 , .Xr sed 1 , .Xr regex 3 , .Xr bdes 1 , -.Xr sh 1 . +.Xr sh 1 .Pp USD:12-13 .Pp @@ -866,7 +871,9 @@ Addison-Wesley, 1981. processes .Em file arguments for backslash escapes, i.e., in a filename, -any characters preceded by a backslash (\\) are +any characters preceded by a backslash +.Pq Ql \e +are interpreted literally. .Pp If a text (non-binary) file is not terminated by a newline character, diff --git a/bin/expr/expr.1 b/bin/expr/expr.1 index 5def49de951..0337cbd1dd6 100644 --- a/bin/expr/expr.1 +++ b/bin/expr/expr.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: expr.1,v 1.3 1997/08/19 06:36:30 denny Exp $ +.\" $OpenBSD: expr.1,v 1.4 1998/09/14 22:13:47 aaron Exp $ .\" $NetBSD: expr.1,v 1.9 1995/04/28 23:27:13 jtc Exp $ .\" .\" Written by J.T. Conklin . @@ -57,7 +57,7 @@ operator matches against .Ar expr2 , which must be a regular expression. The regular expression is anchored -to the beginning of the string with an implicit +to the beginning of the string with an implicit .Dq ^ . .Pp If the match succeeds and the pattern contains at least one regular @@ -91,15 +91,16 @@ The following example returns the number of characters in variable a. The .Nm expr utility exits with one of the following values: +.Pp .Bl -tag -width Ds -compact .It 0 -the expression is neither an empty string nor 0. +The expression is neither an empty string nor 0. .It 1 -the expression is an empty string or 0. +The expression is an empty string or 0. .It 2 -the expression is invalid. +The expression is invalid. .It >2 -an error occurred (such as memory allocation failure). +An error occurred (such as memory allocation failure). .El .Sh STANDARDS The diff --git a/bin/hostname/hostname.1 b/bin/hostname/hostname.1 index 916fe2f4f11..3c2229d2cd8 100644 --- a/bin/hostname/hostname.1 +++ b/bin/hostname/hostname.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: hostname.1,v 1.3 1997/05/30 09:12:52 deraadt Exp $ +.\" $OpenBSD: hostname.1,v 1.4 1998/09/14 22:13:48 aaron Exp $ .\" $NetBSD: hostname.1,v 1.11 1995/09/07 06:28:39 jtc Exp $ .\" .\" Copyright (c) 1983, 1988, 1990, 1993 @@ -45,7 +45,7 @@ .Op Fl s .Op Ar name-of-host .Sh DESCRIPTION -.Nm Hostname +.Nm hostname prints the name of the current host. The super-user can set the host name by supplying an argument; this is usually done in the network initialization script diff --git a/bin/kill/kill.1 b/bin/kill/kill.1 index 739fdc7658a..3e8e75af5d0 100644 --- a/bin/kill/kill.1 +++ b/bin/kill/kill.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: kill.1,v 1.3 1996/12/24 19:17:10 deraadt Exp $ +.\" $OpenBSD: kill.1,v 1.4 1998/09/14 22:13:48 aaron Exp $ .\" $NetBSD: kill.1,v 1.8 1995/09/07 06:30:26 jtc Exp $ .\" .\" Copyright (c) 1980, 1990, 1993 @@ -46,22 +46,24 @@ .Sh SYNOPSIS .Nm kill .Op Fl s Ar signal_name -.Ar pid -\&... +.Ar PID +.Ar \&... .Nm kill .Fl l .Op Ar exit_status .Nm kill .Fl signal_name -.Ar pid -\&... +.Ar PID +.Ar \&... .Nm kill .Fl signal_number -.Ar pid -\&... +.Ar PID +.Ar \&... .Sh DESCRIPTION -The kill utility sends a signal to the processes specified -by the pid operand(s). +The +.Nm kill +utility sends a signal to the processes specified +by the PID operand(s). .Pp Only the super-user may send signals to other users' processes. .Pp @@ -86,7 +88,8 @@ of the default .Dv TERM . .El .Pp -The following pids have special meanings: +The following PIDs have special meanings: +.Pp .Bl -tag -width Ds -compact .It -1 If superuser, broadcast the signal to all processes; otherwise broadcast @@ -94,6 +97,7 @@ to all processes belonging to the user. .El .Pp Some of the more commonly used signals: +.Pp .Bl -tag -width Ds -compact .It 1 HUP (hang up) @@ -111,11 +115,11 @@ ALRM (alarm clock) TERM (software termination signal) .El .Pp -.Nm Kill -is a built-in to -.Xr csh 1 ; +.Nm kill +is built-in to +.Xr csh 1 ; it allows job specifiers of the form ``%...'' as arguments -so process id's are not as often used as +so process IDs are not as often used as .Nm kill arguments. See diff --git a/bin/ln/ln.1 b/bin/ln/ln.1 index 925a7c7cb82..3f1d6c491e7 100644 --- a/bin/ln/ln.1 +++ b/bin/ln/ln.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: ln.1,v 1.2 1996/06/23 14:20:15 deraadt Exp $ +.\" $OpenBSD: ln.1,v 1.3 1998/09/14 22:13:49 aaron Exp $ .\" $NetBSD: ln.1,v 1.10 1995/07/25 19:37:04 jtc Exp $ .\" .\" Copyright (c) 1980, 1990, 1993 @@ -66,7 +66,7 @@ to the original copy. There are two types of links; hard links and symbolic links. How a link .Dq points -to a file is one of the differences between a hard or symbolic link. +to a file is one of the differences between a hard and symbolic link. .Pp The options are as follows: .Bl -tag -width flag @@ -76,13 +76,13 @@ Unlink any already existing file, permitting the link to occur. Create a symbolic link. .El .Pp -By default +By default, .Nm ln makes .Em hard links. A hard link to a file is indistinguishable from the original directory entry; -any changes to a file are effective independent of the name used to reference +any changes to a file are effectively independent of the name used to reference the file. Hard links may not normally refer to directories and may not span file systems. .Pp @@ -128,7 +128,7 @@ The links made will have the same name as the files being linked to. .Xr symlink 2 , .Xr symlink 7 .Sh HISTORY -A +An .Nm ln utility appeared in .At v6 . diff --git a/bin/ls/ls.1 b/bin/ls/ls.1 index 3bcbcc05b4e..af82995a268 100644 --- a/bin/ls/ls.1 +++ b/bin/ls/ls.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: ls.1,v 1.8 1998/08/07 19:44:53 deraadt Exp $ +.\" $OpenBSD: ls.1,v 1.9 1998/09/14 22:13:49 aaron Exp $ .\" $NetBSD: ls.1,v 1.14 1995/12/05 02:44:01 jtc Exp $ .\" .\" Copyright (c) 1980, 1990, 1991, 1993, 1994 @@ -170,7 +170,7 @@ options all override each other; the last one specified determines the format used. .Pp The -.Fl c , +.Fl c and .Fl u options override each other; the last one specified determines @@ -212,11 +212,11 @@ directory. If the owner or group names are not a known user or group name, or the .Fl n -option is given, the numeric ID's are displayed. +option is given, the numeric IDs are displayed. .Pp If the file is a character special or block special file, the major and minor device numbers for the file are displayed -in the size field. If the file is a symbolic link the pathname of the +in the size field. If the file is a symbolic link, the pathname of the linked-to file is preceded by .Dq \-> . .Pp @@ -230,21 +230,21 @@ follows: .Pp .Bl -tag -width 4n -offset indent -compact .It Sy b -Block special file. +block special file .It Sy c -Character special file. +character special file .It Sy d -Directory. +directory .It Sy l -Symbolic link. +symbolic link .It Sy s -Socket link. +socket link .\" .It Sy p .\" .Tn FIFO . .It Sy w -Whiteout. +whiteout .It Sy \- -Regular file. +regular file .El .Pp The next three fields @@ -294,7 +294,7 @@ These next two apply only to the third character in the last group The sticky bit is set (mode .Li 1000 ) , -but not execute or search permission. (See +but neither executable nor searchable. (See .Xr chmod 1 or .Xr sticky 8 . ) @@ -311,10 +311,11 @@ or .Pp In addition, if the .Fl o -option was specified, the file flags (See -.Xr chflags 1 . ) +option was specified, the file flags (see +.Xr chflags 1 ) are displayed as comma-separated strings in front of the file name, -abbreviated as follows +abbreviated as follows: +.Pp .Bl -tag -width 8n -offset indent -compact .It Sy - no flags @@ -336,7 +337,7 @@ system immutable .Pp The .Nm ls -utility exits 0 on success, and >0 if an error occurs. +utility exits 0 on success or >0 if an error occurred. .Sh ENVIRONMENT The following environment variables affect the execution of .Nm ls : diff --git a/bin/md5/md5.1 b/bin/md5/md5.1 index 7f21d8c8c37..fe17d6cb094 100644 --- a/bin/md5/md5.1 +++ b/bin/md5/md5.1 @@ -1,11 +1,11 @@ -.\" $OpenBSD: md5.1,v 1.4 1998/01/02 07:04:23 deraadt Exp $ +.\" $OpenBSD: md5.1,v 1.5 1998/09/14 22:13:50 aaron Exp $ .\" .Dd February 14, 1994 .Dt MD5 1 .Os .Sh NAME .Nm md5 -.Nd "calculate a message-digest fingerprint (checksum) for a file" +.Nd calculate a message-digest fingerprint (checksum) for a file .Sh SYNOPSIS .Nm .Op Fl ptx @@ -32,16 +32,16 @@ sum of each file listed on the command line is printed after the options are processed. .Bl -tag -width Fl .It Fl s Ar string -prints a checksum of the given +Prints a checksum of the given .Ar string . .It Fl p -echos stdin to stdout and appends the +Echos stdin to stdout and appends the .Em MD5 sum to stdout. .It Fl t -runs a built-in time trial. +Runs a built-in time trial. .It Fl x -runs a built-in test script. +Runs a built-in test script. .El .Sh SEE ALSO .Xr cksum 1 , diff --git a/bin/mkdir/mkdir.1 b/bin/mkdir/mkdir.1 index f9dee8d0124..042ea00d73b 100644 --- a/bin/mkdir/mkdir.1 +++ b/bin/mkdir/mkdir.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: mkdir.1,v 1.2 1996/06/23 14:20:23 deraadt Exp $ +.\" $OpenBSD: mkdir.1,v 1.3 1998/09/14 22:13:50 aaron Exp $ .\" $NetBSD: mkdir.1,v 1.9 1995/07/25 19:37:13 jtc Exp $ .\" .\" Copyright (c) 1989, 1990, 1993 @@ -49,7 +49,7 @@ .Op Fl m Ar mode .Ar directory_name ... .Sh DESCRIPTION -.Nm Mkdir +.Nm mkdir creates the directories named as operands, in the order specified, using mode .Li rwxrwxrwx (\&0777) @@ -84,8 +84,9 @@ argument directory already exists. .Pp The user must have write permission in the parent directory. .Pp -.Nm Mkdir -exits 0 if successful, and >0 if an error occurred. +The +.Nm mkdir +utility exits 0 on success or >0 if an error occurred. .Sh SEE ALSO .Xr chmod 1 , .Xr rmdir 1 , diff --git a/bin/mt/mt.1 b/bin/mt/mt.1 index dcc893ac8e6..8860e921614 100644 --- a/bin/mt/mt.1 +++ b/bin/mt/mt.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: mt.1,v 1.7 1998/07/03 07:02:20 deraadt Exp $ +.\" $OpenBSD: mt.1,v 1.8 1998/09/14 22:13:51 aaron Exp $ .\" $NetBSD: mt.1,v 1.8 1996/05/21 10:23:55 mrg Exp $ .\" .\" Copyright (c) 1981, 1990, 1993 @@ -50,13 +50,13 @@ .Op Fl f .Ar tapename .Sh DESCRIPTION -.Nm Mt +.Nm mt is used to give commands to a magnetic tape drive. -By default +By default, .Nm mt performs the requested operation once. Operations may be performed multiple times by specifying -.Ar count . +.Ar count . Note that .Ar tapename @@ -64,7 +64,7 @@ must reference a raw (not block) tape device. If .Ar tapename is of the form -.Dq host:tapename , +.Dq host:tapename or .Dq user@host:tapename , .Nm mt @@ -97,19 +97,20 @@ Back space records. .It Cm rewind Rewind the tape -(Count is ignored). +.Pq Ar count Li is ignored . .It Cm offline , rewoffl Rewind the tape and place the tape unit off-line -(Count is ignored). On non-tape removable media, the +.Pq Ar count Li is ignored . +On non-tape removable media, the .Cm offline command causes the media to be ejected when the last operation on it closes (i.e., the filesystem is unmounted). .It Cm status Print status information about the tape unit. .It Cm retension -Retensions the tape (if this operation is supported by the tape unit). +Retension the tape (if this operation is supported by the tape unit). .It Cm erase -Erases the tape (if this operation is supported by the tape unit). +Erase the tape (if this operation is supported by the tape unit). .It Cm eom Forward space to the end of the media. .It Cm blocksize @@ -122,7 +123,7 @@ Set the tape density code to as specified in the SCSI2 specification. .El .Pp -.Nm Eject +.Nm eject is simply an alias for .Nm mt , with the @@ -131,12 +132,12 @@ command specified. .Pp If a tape name is not specified, and the environment variable .Ev TAPE -does not exist; +does not exist, .Nm mt uses the device .Pa /dev/rst0 . .Pp -.Nm Mt +.Nm mt returns a 0 exit status when the operation(s) were successful, 1 if the command was unrecognized, and 2 if an operation failed. .Sh ENVIRONMENT @@ -144,7 +145,7 @@ If the following environment variable exists, it is utilized by .Nm mt . .Bl -tag -width Fl .It Ev TAPE -.Nm Mt +.Nm mt checks the .Ev TAPE environment variable if the @@ -152,13 +153,13 @@ argument .Ar tapename is not given. .Sh FILES -.Bl -tag -width /dev/rst* -compact +.Bl -tag -width /usr/src/sys/scsi/scsi_tape.h -compact .It Pa /dev/rst* -Raw SCSI tape interface +raw SCSI tape interface .It Pa /dev/rmt* -Raw magnetic tape interface +raw magnetic tape interface .It Pa /usr/src/sys/scsi/scsi_tape.h -List of SCSI2 density codes +list of SCSI2 density codes .El .Sh SEE ALSO .Xr mtio 4 , diff --git a/bin/mv/mv.1 b/bin/mv/mv.1 index 60dcd8da872..e5b3f0e17d7 100644 --- a/bin/mv/mv.1 +++ b/bin/mv/mv.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: mv.1,v 1.3 1997/08/27 17:11:49 deraadt Exp $ +.\" $OpenBSD: mv.1,v 1.4 1998/09/14 22:13:51 aaron Exp $ .\" $NetBSD: mv.1,v 1.8 1995/03/21 09:06:51 cgd Exp $ .\" .\" Copyright (c) 1989, 1990, 1993 @@ -51,7 +51,6 @@ .Op Fl fi .Ar source ... directory .Sh DESCRIPTION -.Pp In its first form, the .Nm mv utility renames the file named by the @@ -86,6 +85,7 @@ overwrite an existing file. If the response from the standard input begins with the character ``y'', the move is attempted. .El +.Pp The last of any .Fl f or @@ -122,7 +122,7 @@ rm -f destination_path && \e .Pp The .Nm mv -utility exits 0 on success, and >0 if an error occurs. +utility exits 0 on success or >0 if an error occurred. .Sh SEE ALSO .Xr cp 1 , .Xr symlink 7 diff --git a/bin/pax/cpio.1 b/bin/pax/cpio.1 index 2e5347750be..bbc4ab9f1c2 100644 --- a/bin/pax/cpio.1 +++ b/bin/pax/cpio.1 @@ -27,7 +27,7 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.\" $OpenBSD: cpio.1,v 1.4 1998/07/20 00:45:31 espie Exp $ +.\" $OpenBSD: cpio.1,v 1.5 1998/09/14 22:13:52 aaron Exp $ .\" .Dd February 16, 1997 .Dt CPIO 1 @@ -36,7 +36,7 @@ .Nm cpio .Nd copy file archives in and out .Sh SYNOPSIS -.Nm +.Nm cpio .Fl o .Op Fl aABcLvzZ .Op Fl C Ar bytes @@ -45,7 +45,7 @@ .Op Fl O Ar archive .Ar "< name-list" .Op Ar "> archive" -.Nm +.Nm cpio .Fl i .Op Fl bBcdfmrsStuvzZ6 .Op Fl C Ar bytes @@ -55,7 +55,7 @@ .Op Fl I Ar archive .Op Ar "pattern ..." .Op Ar "< archive" -.Nm +.Nm cpio .Fl p .Op Fl adlLmuv .Ar destination-directory @@ -75,7 +75,7 @@ archive from standard input, and writes the archive on standard output. .Bl -tag -width Fl .It Fl a -Reset the access times on files that has been copied to the +Reset the access times on files that have been copied to the archive. .It Fl A Append to the specified archive. @@ -127,15 +127,15 @@ standard input and extracts files matching the that were specified on the command line. .Bl -tag -width Fl .It Fl b -Do byte- and word swapping after reading in data from the +Do byte and word swapping after reading in data from the archive, for restoring archives created on systems with -different byte order. +a different byte order. .It Fl B Set the block size of the archive being read to 5120 bytes. .It Fl c Expect the archive headers to be in ASCII format. .It Fl C Ar bytes -Read archive written with a blocksize of +Read archive written with a block size of .Ar bytes . .It Fl d Create any intermediate directories as needed during @@ -195,13 +195,13 @@ Process old-style \*Qcpio\*U format archives. .El .It Fl p Copy files from one location to another in a single pass. -The list of files to copy are read from standard in and +The list of files to copy are read from standard input and written out to a directory relative to the specified .Ar directory argument. .Bl -tag -width Fl .It Fl a -Reset the access times on files that has been copied. +Reset the access times on files that have been copied. .It Fl d Create any intermediate directories as needed to write the files at the new location. @@ -227,7 +227,7 @@ will exit with one of the following values: .It 0 All files were processed successfully. .It 1 -An error occured. +An error occurred. .El .Pp Whenever @@ -236,7 +236,7 @@ cannot create a file or a link when extracting an archive or cannot find a file while writing an archive, or cannot preserve the user ID, group ID, file mode or access and modification times when the .Fl p -options is specified, a diagnostic message is written to standard +option is specified, a diagnostic message is written to standard error and a non-zero exit value will be returned, but processing will continue. In the case where .Nm @@ -267,4 +267,4 @@ and .Fl S options are currently not implemented. .Sh AUTHOR -Keith Muller at the University of California, San Diego +Keith Muller at the University of California, San Diego. diff --git a/bin/pax/pax.1 b/bin/pax/pax.1 index 590c9dfdd7a..72e200e1bbd 100644 --- a/bin/pax/pax.1 +++ b/bin/pax/pax.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: pax.1,v 1.5 1997/04/06 06:11:13 millert Exp $ +.\" $OpenBSD: pax.1,v 1.6 1998/09/14 22:13:52 aaron Exp $ .\" $NetBSD: pax.1,v 1.3 1995/03/21 09:07:37 cgd Exp $ .\" .\" Copyright (c) 1992 Keith Muller. @@ -181,10 +181,10 @@ .Op Ar file ... .Ar directory .Sh DESCRIPTION -.Nm Pax +.Nm pax will read, write, and list the members of an archive file, and will copy directory hierarchies. -.Nm Pax +.Nm pax operation is independent of the specific archive format, and supports a wide variety of different archive formats. A list of supported archive formats can be found under the description of the @@ -200,26 +200,26 @@ options specifies which of the following functional modes will operate under: .Em list , read , write , and -.Em copy. +.Em copy . .Bl -tag -width 6n .It .Em List . -.Nm Pax +.Nm pax will write to .Dv standard output a table of contents of the members of the archive file read from .Dv standard input , whose pathnames match the specified -.Ar patterns. +.Ar patterns . The table of contents contains one filename per line and is written using single line buffering. .It Fl r .Em Read . -.Nm Pax +.Nm pax extracts the members of the archive file read from the .Dv standard input , with pathnames matching the specified -.Ar patterns. +.Ar patterns . The archive format and blocking is automatically determined on input. When an extracted file is a directory, the entire file hierarchy rooted at that directory is extracted. @@ -230,7 +230,7 @@ the extracted files are discussed in more detail under the option. .It Fl w .Em Write . -.Nm Pax +.Nm pax writes an archive containing the .Ar file operands to @@ -246,7 +246,7 @@ operand is also a directory, the entire file hierarchy rooted at that directory will be included. .It Fl r Fl w .Em Copy . -.Nm Pax +.Nm pax copies the .Ar file operands to the destination @@ -292,7 +292,6 @@ to locate and process the largest number of archive members possible (see the .Fl E option for more details on error handling). .Sh OPERANDS -.Pp The .Ar directory operand specifies a destination directory pathname. @@ -300,7 +299,7 @@ If the .Ar directory operand does not exist, or it is not writable by the user, or it is not of type directory, -.Nm Pax +.Nm pax will exit with a non-zero exit status. .Pp The @@ -339,7 +338,6 @@ operand pathnames in a diagnostic message to .Dv standard error and then exit with a non-zero exit status. .Sh OPTIONS -.Pp The following options are supported: .Bl -tag -width 4n .It Fl r @@ -412,14 +410,14 @@ standard and will not be portable to all systems. A .Ar blocksize can end with -.Li k +.Sq Li k or -.Li b +.Sq Li b to specify multiplication by 1024 (1K) or 512, respectively. A pair of .Ar blocksizes can be separated by -.Li x +.Sq Li x to indicate a product. A specific archive device may impose additional restrictions on the size of blocking it will support. @@ -469,14 +467,14 @@ operand, will prompt to .Pa /dev/tty giving the name of the file, its file mode and its modification time. -.Nm Pax +.Nm pax will then read a line from .Pa /dev/tty . If this line is blank, the file or archive member is skipped. If this line consists of a single period, the file or archive member is processed with no modification to its name. Otherwise, its name is replaced with the contents of the line. -.Nm Pax +.Nm pax will immediately exit with a non-zero exit status if .Dv is encountered when reading a response or if @@ -485,12 +483,11 @@ cannot be opened for reading and writing. .It Fl k Do not overwrite existing files. .It Fl l -Link files. (The letter ell). +(The lowercase letter ``ell.'') Link files. In the .Em copy -mode ( -.Fl r -.Fl w ) , +mode +.Pq Fl r Fl w , hard links are made between the source and destination file hierarchies whenever possible. .It Fl n @@ -510,7 +507,7 @@ which is specific to the archive format specified by In general, .Ar options take the form: -.Cm name=value +.Cm name=value . .It Fl p Ar string Specify one or more file characteristic options (privileges). The @@ -678,10 +675,9 @@ Where is the output format specified by the utility when used with the .Fl l option. -Otherwise for all the other operational modes ( -.Em read , write , -and -.Em copy ) , +Otherwise for all the other operational modes +.Po Em read , write , Li and Em copy +.Pc , pathnames are written and flushed to .Dv standard error without a trailing @@ -694,7 +690,7 @@ is not buffered, and is written only after the file has been read or written. .It Fl x Ar format Specify the output archive format, with the default format being .Ar ustar . -.Nm Pax +.Nm pax currently supports the following formats: .Bl -tag -width "sv4cpio" .It Ar cpio @@ -753,27 +749,28 @@ The default blocksize for this format is 10240 bytes. Pathnames stored by this format must be 250 characters or less in length. .El .Pp -.Nm Pax +.Nm pax will detect and report any file that it is unable to store or extract as the result of any specific archive format restrictions. The individual archive formats may impose additional restrictions on use. Typical archive format restrictions include (but are not limited to): -file pathname length, file size, link pathname length and the type of the file. +file pathname length, file size, link pathname length, and the type of the +file. .It Fl B Ar bytes Limit the number of bytes written to a single archive volume to .Ar bytes . The .Ar bytes limit can end with -.Li m , -.Li k , +.Sq Li m , +.Sq Li k , or -.Li b +.Sq Li b to specify multiplication by 1048576 (1M), 1024 (1K) or 512, respectively. A pair of .Ar bytes limits can be separated by -.Li x +.Sq Li x to indicate a product. .Pp .Em Warning : @@ -787,11 +784,11 @@ This option is the same as the option, except that the file inode change time is checked instead of the file modification time. The file inode change time can be used to select files whose inode information -(e.g. uid, gid, etc.) is newer than a copy of the file in the destination +(e.g. UID, GID, etc.) is newer than a copy of the file in the destination .Ar directory . .It Fl E Ar limit Limit the number of consecutive read faults while trying to read a flawed -archives to +archive to .Ar limit . With a positive .Ar limit , @@ -936,7 +933,7 @@ Select a file based on its .Ar user name, or when starting with a .Cm # , -a numeric uid. +a numeric UID. A '\\' can be used to escape the .Cm # . Multiple @@ -949,7 +946,7 @@ See the .Li st_dev field as described in .Xr stat 2 -for more information about device ID's. +for more information about device IDs. .It Fl Y This option is the same as the .Fl D @@ -962,8 +959,8 @@ option, except that the modification time is checked using the pathname created after all the file name modifications have completed. .El .Pp -The options that operate on the names of files or archive members ( -.Fl c , +The options that operate on the names of files or archive members +.Po Fl c , .Fl i , .Fl n , .Fl s , @@ -975,7 +972,8 @@ The options that operate on the names of files or archive members ( .Fl U , .Fl Y , and -.Fl Z ) +.Fl Z +.Pc interact as follows. .Pp When extracting files during a @@ -1001,7 +999,7 @@ Then the and .Fl Z options will be applied based on the final pathname. -Finally the +Finally, the .Fl v option will write the names resulting from these modifications. .Pp @@ -1034,7 +1032,7 @@ operation the and the .Fl Z options will be applied based on the final pathname. -Finally the +Finally, the .Fl v option will write the names resulting from these modifications. .Pp @@ -1130,7 +1128,7 @@ standard. .Xr tar 1 , .Xr cpio 1 .Sh AUTHOR -Keith Muller at the University of California, San Diego +Keith Muller at the University of California, San Diego. .Sh ERRORS .Nm pax will exit with one of the following values: @@ -1150,7 +1148,9 @@ group ID, or file mode when the option is specified, a diagnostic message is written to .Dv standard error and a non-zero exit status will be returned, but processing will continue. -In the case where pax cannot create a link to a file, +In the case where +.Nm pax +cannot create a link to a file, .Nm pax will not create a second copy of the file. .Pp diff --git a/bin/pax/tar.1 b/bin/pax/tar.1 index 8dd7d3046c3..a58e87298de 100644 --- a/bin/pax/tar.1 +++ b/bin/pax/tar.1 @@ -27,7 +27,7 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.\" $OpenBSD: tar.1,v 1.15 1998/03/31 17:14:23 millert Exp $ +.\" $OpenBSD: tar.1,v 1.16 1998/09/14 22:13:53 aaron Exp $ .\" .Dd June 11, 1996 .Dt TAR 1 @@ -48,7 +48,7 @@ .Ar replstr .No ] .Ar file1 -.Op Ar file2... +.Op Ar file2 ... .Sh DESCRIPTION The .Nm @@ -71,7 +71,7 @@ List contents of archive. If any files are named on the command line, only those files will be listed. .It Fl u Alias for -.Fl r +.Fl r . .It Fl x Extract files from archive. If any files are named on the command line, only those files will be extracted from the @@ -86,7 +86,7 @@ In addition to the flags mentioned above, any of the following flags may be used: .Bl -tag -width Ar .It Fl b Ar "blocking factor" -Set blocking factor to use for the archive, +Set blocking factor to use for the archive. .Nm uses 512 byte blocks. The default is 20, the maximum is 126. Archives with a blocking factor larger 63 violate the @@ -96,7 +96,7 @@ standard and will not be portable to all systems. Stop after first error. .It Fl f Ar archive Filename where the archive is stored. Defaults to -.Pa /dev/rst0 +.Pa /dev/rst0 . .It Fl h Follow symbolic links as if they were normal files or directories. @@ -112,7 +112,7 @@ This implies the .Fl O flag. .It Fl p -Preserve user and group id as well as file mode regardless of +Preserve user and group ID as well as file mode regardless of the current .Xr umask 2 . The setuid and setgid bits are only preserved if the user is @@ -198,13 +198,13 @@ can be used to select one of the compiled-in backup devices, .Sh FILES .Bl -tag -width "/dev/rst0" .It Pa /dev/rst0 -The default archive name +default archive name .El .Sh SEE ALSO .Xr pax 1 , .Xr cpio 1 .Sh AUTHOR -Keith Muller at the University of California, San Diego +Keith Muller at the University of California, San Diego. .Sh ERRORS .Nm will exit with one of the following values: @@ -221,7 +221,7 @@ cannot create a file or a link when extracting an archive or cannot find a file while writing an archive, or cannot preserve the user ID, group ID, file mode or access and modification times when the .Fl p -options is specified, a diagnostic message is written to standard +option is specified, a diagnostic message is written to standard error and a non-zero exit value will be returned, but processing will continue. In the case where .Nm diff --git a/bin/ps/ps.1 b/bin/ps/ps.1 index a8d3882c2f5..515afddcea7 100644 --- a/bin/ps/ps.1 +++ b/bin/ps/ps.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: ps.1,v 1.11 1998/04/28 18:58:49 deraadt Exp $ +.\" $OpenBSD: ps.1,v 1.12 1998/09/14 22:13:53 aaron Exp $ .\" $NetBSD: ps.1,v 1.16 1996/03/21 01:36:28 jtc Exp $ .\" .\" Copyright (c) 1980, 1990, 1991, 1993, 1994 @@ -53,20 +53,20 @@ .Nm ps .Op Fl L .Sh DESCRIPTION -.Nm \&Ps +.Nm ps displays a header line followed by lines containing information about your processes that have controlling terminals. This information is sorted by process .Tn ID . .Pp The information displayed is selected based on a set of keywords (and for -even more control see the +even more control, see the .Fl L , .Fl O , and .Fl o options). -The default output format includes, for each process, the process' +The default output format includes, for each process, the process's .Tn ID , controlling terminal, cpu time (including both user and system time), state, and associated command. @@ -162,7 +162,7 @@ Extract swap information from the specified file instead of the default .Dq Pa /dev/drum . .It Fl w -Use 132 columns to display information, instead of the default which +Use 132 columns to display information, instead of the default, which is your window size. If the .Fl w @@ -173,7 +173,7 @@ will use as many columns as necessary without regard for your window size. Display information about processes without controlling terminals. .El .Pp -A complete list of the available keywords are listed below. +A complete list of available keywords is listed below. Some of these keywords are further specified as follows: .Bl -tag -width indent .It %cpu @@ -223,7 +223,7 @@ The exact time the command started, using the ``%C'' format described in The process scheduling increment (see .Xr setpriority 2 ) . .It rss -the real memory (resident set) size of the process (in 1024 byte units). +The real memory (resident set) size of the process (in 1024 byte units). .It start The time the command started. If the command started less than 24 hours ago, the start time is @@ -321,7 +321,7 @@ When printing using the command keyword, a process that has exited and has a parent that has not yet waited for the process (in other words, a zombie) is listed as ``'', and a process which is blocked while trying to exit is listed as ``''. -.Nm \&Ps +.Nm ps makes an educated guess as to the file name and arguments given when the process was created by examining memory or the swap area. The method is inherently somewhat unreliable and in any event a process @@ -345,7 +345,7 @@ command and arguments (alias args) .It cpu short-term cpu usage factor (for scheduling) .It emul -name of system call emulation environment. +name of system call emulation environment .It flags the process flags, in hexadecimal (alias f) .It gid @@ -445,9 +445,9 @@ time started (alias etime) .It state symbolic process state (alias stat) .It svgid -saved gid from a setgid executable +saved GID from a setgid executable .It svuid -saved uid from a setuid executable +saved UID from a setuid executable .It tdev control terminal device number .It time diff --git a/bin/pwd/pwd.1 b/bin/pwd/pwd.1 index 8633eabb469..5b345c5f9e0 100644 --- a/bin/pwd/pwd.1 +++ b/bin/pwd/pwd.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: pwd.1,v 1.3 1997/03/25 20:20:51 deraadt Exp $ +.\" $OpenBSD: pwd.1,v 1.4 1998/09/14 22:13:54 aaron Exp $ .\" $NetBSD: pwd.1,v 1.10 1995/09/07 06:47:30 jtc Exp $ .\" .\" Copyright (c) 1990, 1993 @@ -46,11 +46,11 @@ .Sh SYNOPSIS .Nm pwd .Sh DESCRIPTION -.Nm Pwd +.Nm pwd writes the absolute pathname of the current working directory to the standard output. .Pp -The pwd utility exits 0 on success, and >0 if an error occurs. +The pwd utility exits 0 on success or >0 if an error occurred. .Sh STANDARDS The .Nm pwd @@ -63,7 +63,7 @@ compatible. .Xr getcwd 3 .Sh BUGS In -.Xr csh 1 +.Xr csh 1 , the command .Ic dirs is always faster (although it can give a different answer in the rare case diff --git a/bin/rcp/rcp.1 b/bin/rcp/rcp.1 index 5ff750bc0ef..1ccea4326ab 100644 --- a/bin/rcp/rcp.1 +++ b/bin/rcp/rcp.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: rcp.1,v 1.2 1996/06/23 14:20:56 deraadt Exp $ +.\" $OpenBSD: rcp.1,v 1.3 1998/09/14 22:13:55 aaron Exp $ .\" $NetBSD: rcp.1,v 1.6 1995/07/25 19:37:25 jtc Exp $ .\" .\" Copyright (c) 1983, 1990, 1993 @@ -51,7 +51,7 @@ .Ar file ... .Ar directory .Sh DESCRIPTION -.Nm Rcp +.Nm rcp copies files between machines. Each .Ar file or @@ -62,13 +62,9 @@ or a `/' before any `:'s). .Pp .Bl -tag -width flag .It Fl K -The -.Fl K -option turns off all Kerberos authentication. +Turns off all Kerberos authentication. .It Fl k -The -.Fl k -option requests +Requests .Nm rcp to obtain tickets for the remote host in realm @@ -76,9 +72,7 @@ for the remote host in realm instead of the remote host's realm as determined by .Xr krb_realmofhost 3 . .It Fl p -The -.Fl p -option causes +Causes .Nm rcp to attempt to preserve (duplicate) in its copies the modification times and modes of the source files, ignoring the @@ -95,9 +89,7 @@ If any of the source files are directories, copies each subtree rooted at that name; in this case the destination must be a directory. .It Fl x -The -.Fl x -option turns on +Turns on .Tn DES encryption for all data passed by .Nm rcp . @@ -120,13 +112,13 @@ A on a remote host may be quoted (using \e, ", or \(aa) so that the metacharacters are interpreted remotely. .Pp -.Nm Rcp +.Nm rcp does not prompt for passwords; it performs remote execution via .Xr rsh 1 , and requires the same authorization. .Pp -.Nm Rcp +.Nm rcp handles third party copies, where neither source nor target files are on the current machine. .Sh SEE ALSO diff --git a/bin/rmail/rmail.8 b/bin/rmail/rmail.8 index 17be42be637..0dc255941f0 100644 --- a/bin/rmail/rmail.8 +++ b/bin/rmail/rmail.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: rmail.8,v 1.3 1997/05/30 09:12:54 deraadt Exp $ +.\" $OpenBSD: rmail.8,v 1.4 1998/09/14 22:13:55 aaron Exp $ .\" $NetBSD: rmail.8,v 1.8 1995/03/21 07:08:21 cgd Exp $ .\" .\" Copyright (c) 1983, 1990 The Regents of the University of California. @@ -44,7 +44,7 @@ .Nm rmail .Ar user ... .Sh DESCRIPTION -.Nm Rmail +.Nm rmail interprets incoming mail received via .Xr uucp 1 , collapsing ``From'' lines in the form generated @@ -54,7 +54,7 @@ into a single line of the form ``return-path!sender'', and passing the processed mail on to .Xr sendmail 8 . .Pp -.Nm Rmail +.Nm rmail is explicitly designed for use with .Xr uucp and @@ -69,6 +69,6 @@ The program appeared in .Bx 4.2 . .Sh BUGS -.Nm Rmail +.Nm rmail should not reside in .Pa /bin . diff --git a/bin/rmdir/rmdir.1 b/bin/rmdir/rmdir.1 index 0169365c700..21354323e60 100644 --- a/bin/rmdir/rmdir.1 +++ b/bin/rmdir/rmdir.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: rmdir.1,v 1.2 1996/06/23 14:21:03 deraadt Exp $ +.\" $OpenBSD: rmdir.1,v 1.3 1998/09/14 22:13:56 aaron Exp $ .\" $NetBSD: rmdir.1,v 1.10 1995/07/25 19:37:35 jtc Exp $ .\" .\" Copyright (c) 1990, 1993 @@ -48,7 +48,9 @@ .Op Fl p .Ar directory ... .Sh DESCRIPTION -The rmdir utility removes the directory entry specified by +The +.Nm rmdir +utility removes the directory entry specified by each .Ar directory argument, provided it is empty. diff --git a/bin/sleep/sleep.1 b/bin/sleep/sleep.1 index 46a01dcb41d..8cb8ce9500d 100644 --- a/bin/sleep/sleep.1 +++ b/bin/sleep/sleep.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: sleep.1,v 1.3 1997/08/19 06:28:20 denny Exp $ +.\" $OpenBSD: sleep.1,v 1.4 1998/09/14 22:13:58 aaron Exp $ .\" $NetBSD: sleep.1,v 1.9 1995/07/25 19:37:43 jtc Exp $ .\" .\" Copyright (c) 1990, 1993, 1994 @@ -52,13 +52,13 @@ The utility suspends execution for a minimum of .Ar seconds . -.Nm Sleep +.Nm sleep is used to schedule the execution of other commands (see .Sx EXAMPLES below). .Pp The -.Nm Sleep +.Nm sleep utility exits with one of the following values: .Bl -tag -width flag .It Li \&0 diff --git a/bin/stty/stty.1 b/bin/stty/stty.1 index d6a1633ff29..caa98ec8d3a 100644 --- a/bin/stty/stty.1 +++ b/bin/stty/stty.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: stty.1,v 1.7 1998/06/03 05:57:47 deraadt Exp $ +.\" $OpenBSD: stty.1,v 1.8 1998/09/14 22:13:59 aaron Exp $ .\" $NetBSD: stty.1,v 1.10 1995/09/07 06:57:14 jtc Exp $ .\" .\" Copyright (c) 1990, 1993, 1994 @@ -152,6 +152,7 @@ control. Enable (disable) RTS/CTS flow control. .El .Ss Input Modes: +.Pp This corresponds to the c_iflag in the termios structure. .Bl -tag -width Fl .It Cm ignbrk Pq Fl ignbrk @@ -232,6 +233,7 @@ is unset and the input queue is full, the next input character causes the entire input and output queues to be discarded. .El .Ss Output Modes: +.Pp This corresponds to the c_oflag of the termios structure. .Bl -tag -width Fl .It Cm opost Pq Fl opost @@ -349,13 +351,13 @@ It also skips the first preceding character in its classification (as a convenience since the one preceding character could have been erased with simply an .Dv ERASE -character.) +character). .It Cm mdmbuf Pq Fl mdmbuf If set, flow control output based on condition of Carrier Detect. Otherwise writes return an error if Carrier Detect is low (and Carrier is not being ignored with the .Dv CLOCAL -flag.) +flag). .It Cm flusho Pq Fl flusho Indicates output is (is not) being discarded. .It Cm pendin Pq Fl pendin @@ -416,7 +418,7 @@ number. and .Dv TIME are used in -Non-Canonical mode input processing +non-canonical mode input processing (-icanon). .El .Ss Combination Modes: @@ -460,7 +462,7 @@ processing a character (usually set to ^T). The status line consists of the system load average, the current command name, its process ID, the event the process is waiting on (or the status of the process), the user -and system times, percent cpu, and current memory usage. +and system times, percent CPU, and current memory usage. .It Cm columns Ar number The terminal size is recorded as having .Ar number @@ -483,7 +485,7 @@ characters are set to ^?, ^U, and ^C; .Dv ixany is disabled, and .Dv crt -is enabled.) +is enabled). .It Cm extproc Pq Fl extproc If set, this flag indicates that some amount of terminal processing is being performed by either the terminal hardware or by the remote side connected @@ -592,7 +594,7 @@ Same as the control character Same as the control character .Cm reprint . .El -.Ss Control operations: +.Ss Control Operations: .Pp These operations are not modes, but rather commands to be performed by the tty layer. @@ -611,7 +613,7 @@ is set. .Pp The .Nm stty -utility exits with a value of 0 if successful, and >0 if an error occurs. +utility exits 0 on success or >0 if an error occurred. .Sh SEE ALSO .Xr termios 4 .Sh STANDARDS diff --git a/bin/sync/sync.8 b/bin/sync/sync.8 index 1f5c63ee105..5165eea331f 100644 --- a/bin/sync/sync.8 +++ b/bin/sync/sync.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: sync.8,v 1.3 1997/05/30 09:12:55 deraadt Exp $ +.\" $OpenBSD: sync.8,v 1.4 1998/09/14 22:14:00 aaron Exp $ .\" $NetBSD: sync.8,v 1.6 1995/03/21 09:11:35 cgd Exp $ .\" .\" Copyright (c) 1980, 1991, 1993 @@ -43,8 +43,8 @@ .Sh SYNOPSIS .Nm sync .Sh DESCRIPTION -.Nm Sync -can be called to insure that all disk writes have been completed before the +.Nm sync +can be called to ensure that all disk writes have been completed before the processor is halted in a way not suitably done by .Xr reboot 8 or @@ -59,7 +59,7 @@ such as resynchronizing the hardware clock and flushing internal caches before performing a final .Nm sync . .Pp -.Nm Sync +.Nm sync utilizes the .Xr sync 2 function call. diff --git a/bin/test/test.1 b/bin/test/test.1 index e8448148591..9a29a257bb6 100644 --- a/bin/test/test.1 +++ b/bin/test/test.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: test.1,v 1.6 1998/09/07 16:44:32 aaron Exp $ +.\" $OpenBSD: test.1,v 1.7 1998/09/14 22:14:00 aaron Exp $ .\" $NetBSD: test.1,v 1.6 1995/03/21 07:04:03 cgd Exp $ .\" .\" Copyright (c) 1991, 1993 @@ -55,7 +55,9 @@ The utility evaluates the expression and, if it evaluates to true, returns a zero (true) exit status; otherwise it returns 1 (false). -If there is no expression, test also +If there is no expression, +.Nm +also returns 1 (false). .Pp All operators and flags are separate arguments to the @@ -89,7 +91,7 @@ exists and is a regular file. .It Fl g Ar file True if .Ar file -exists and its set group ID flag +exists and its set-group-ID flag is set. .It Fl h Ar file True if @@ -129,7 +131,7 @@ is .It Fl u Ar file True if .Ar file -exists and its set user ID flag +exists and its set-user-ID flag is set. .It Fl w Ar file True if @@ -161,11 +163,11 @@ exists and is a symbolic link. .It Fl O Ar file True if .Ar file -exists and its owner matches the effective user id of this process. +exists and its owner matches the effective user ID of this process. .It Fl G Ar file True if .Ar file -exists and its group matches the effective group id of this process. +exists and its group matches the effective group ID of this process. .It Fl S Ar file True if .Ar file @@ -293,7 +295,7 @@ The grammar is inherently ambiguous. In order to assure a degree of consistency, the cases described in .St -p1003.2 -section D11.2/4.62.4, +section D11.2/4.62.4 are evaluated consistently according to the rules specified in the standards document. All other cases are subject to the ambiguity in the command semantics. @@ -303,9 +305,9 @@ The utility exits with one of the following values: .Bl -tag -width Ds .It 0 -expression evaluated to true. +Expression evaluated to true. .It 1 -expression evaluated to false or expression was +Expression evaluated to false or expression was missing. .It >1 An error occurred. -- cgit v1.2.3