diff options
| author | Aaron Campbell <aaron@cvs.openbsd.org> | 1999-07-04 11:53:56 +0000 |
|---|---|---|
| committer | Aaron Campbell <aaron@cvs.openbsd.org> | 1999-07-04 11:53:56 +0000 |
| commit | f5558a2c81394fbddd25d59efa1c36d1e4c4e0e0 (patch) | |
| tree | c23144785810bbeda4c01b8a385873bfa83c8032 /usr.bin | |
| parent | 8e68b36a929e0ad1721fd7f9eee6d57ade5db145 (diff) | |
correct use of .Nm; some other formatting nits
Diffstat (limited to 'usr.bin')
42 files changed, 251 insertions, 237 deletions
diff --git a/usr.bin/apply/apply.1 b/usr.bin/apply/apply.1 index c9eac39e3d0..ce62f037ba3 100644 --- a/usr.bin/apply/apply.1 +++ b/usr.bin/apply/apply.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: apply.1,v 1.8 1999/06/05 01:21:16 aaron Exp $ +.\" $OpenBSD: apply.1,v 1.9 1999/07/04 11:53:50 aaron Exp $ .\" $NetBSD: apply.1,v 1.4 1996/03/18 23:16:57 jtc Exp $ .\" .\" Copyright (c) 1983, 1990, 1993 @@ -47,7 +47,7 @@ .Ar command argument .Op Ar ... .Sh DESCRIPTION -.Nm apply +.Nm runs the named .Ar command on each diff --git a/usr.bin/apropos/apropos.1 b/usr.bin/apropos/apropos.1 index ec4cd576379..94ee67e9d87 100644 --- a/usr.bin/apropos/apropos.1 +++ b/usr.bin/apropos/apropos.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: apropos.1,v 1.4 1998/09/23 04:32:34 aaron Exp $ +.\" $OpenBSD: apropos.1,v 1.5 1999/07/04 11:53:50 aaron Exp $ .\" $NetBSD: apropos.1,v 1.4 1995/09/04 20:46:17 tls Exp $ .\" .\" Copyright (c) 1989, 1990, 1993 @@ -47,19 +47,19 @@ .Ar keyword .Op Ar ... .Sh DESCRIPTION -.Nm apropos +.Nm shows which manual pages contain instances of any of the given .Ar keyword(s) in their title line. Each word is considered separately and case of letters is ignored. Words which are part of other words are considered; when looking for .Dq compile , -.Nm apropos +.Nm will also list all instances of .Dq compiler . .Pp If the line output by -.Nm apropos +.Nm starts .Dq Li name(section) ... you can enter @@ -71,7 +71,7 @@ The options are as follows: .Bl -tag -width flag .It Fl M Ar path Override the list of standard directories -.Nm apropos +.Nm searches for a database named .Pa whatis.db . The supplied @@ -83,7 +83,7 @@ This search path may also be set using the environment variable .Ev MANPATH . .It Fl m Ar path Augment the list of standard directories -.Nm apropos +.Nm searches for its database. The supplied .Ar path @@ -119,6 +119,6 @@ name of the apropos database .Xr whereis 1 .Sh HISTORY The -.Nm apropos +.Nm command appeared in .Bx 3.0 . diff --git a/usr.bin/arch/arch.1 b/usr.bin/arch/arch.1 index 6d5e4b62047..4e3e2b34490 100644 --- a/usr.bin/arch/arch.1 +++ b/usr.bin/arch/arch.1 @@ -26,7 +26,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: arch.1,v 1.2 1996/06/29 20:29:34 tholo Exp $ +.\" $OpenBSD: arch.1,v 1.3 1999/07/04 11:53:50 aaron Exp $ .\" .Dd June 22, 1996 .Dt ARCH 1 @@ -39,7 +39,7 @@ .Op Fl k .Sh DESCRIPTION The -.Nm arch +.Nm command displays the machine's architecture type. .Pp The following options are available: @@ -52,6 +52,6 @@ architecture. .Xr machine 1 .Sh HISTORY The -.Nm arch +.Nm command is .Ud . diff --git a/usr.bin/asa/asa.1 b/usr.bin/asa/asa.1 index a23e904e557..81266fe8531 100644 --- a/usr.bin/asa/asa.1 +++ b/usr.bin/asa/asa.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: asa.1,v 1.6 1998/11/04 22:36:39 aaron Exp $ +.\" $OpenBSD: asa.1,v 1.7 1999/07/04 11:53:50 aaron Exp $ .\" $NetBSD: asa.1,v 1.4 1995/03/26 02:25:05 glass Exp $ .\" .\" Copyright (c) 1993 Winning Strategies, Inc. @@ -88,7 +88,7 @@ utility exits 0 on success or >0 if an error occurred. .Xr f77 1 .Sh STANDARDS The -.Nm asa +.Nm utility conforms to .St -p1003.2-92 . The diff --git a/usr.bin/at/at.1 b/usr.bin/at/at.1 index 49d9c8609f1..06ea4d7833e 100644 --- a/usr.bin/at/at.1 +++ b/usr.bin/at/at.1 @@ -1,10 +1,13 @@ -.\" $OpenBSD: at.1,v 1.10 1999/06/05 01:21:17 aaron Exp $ +.\" $OpenBSD: at.1,v 1.11 1999/07/04 11:53:51 aaron Exp $ .\" $FreeBSD: at.man,v 1.6 1997/02/22 19:54:05 peter Exp $ .Dd April 12, 1995 .Dt AT 1 .Os .Sh NAME -.Nm at, atq, atrm, batch +.Nm at , +.Nm atq , +.Nm atrm , +.Nm batch .Nd queue, examine or delete jobs for later execution .Sh SYNOPSIS .Nm at @@ -31,7 +34,7 @@ .Op Fl mv .Op Ar time .Sh DESCRIPTION -.Nm at +.Nm and .Nm batch read commands from standard input or a specified file which @@ -51,7 +54,7 @@ the load average drops below 1.5, or the value specified in the invocation of .Nm atrun . .El .Pp -.Nm at +.Nm allows some moderately complex .Ar time specifications. It accepts times of the form @@ -98,7 +101,7 @@ where the time-units can be or .Nm weeks and you can tell -.Nm at +.Nm to run the job today by suffixing the time with .Nm today and to run the job tomorrow by suffixing the time with @@ -112,7 +115,7 @@ To run a job at 1am tomorrow, you would do .Nm at 1am tomorrow . .Pp For both -.Nm at +.Nm and .Nm batch , commands are read from standard input or the file specified @@ -129,7 +132,7 @@ and the .Ar umask are retained from the time of invocation. An -.Nm at +.Nm or .Nm batch command invoked from a @@ -139,7 +142,7 @@ The user will be mailed standard error and standard output from his commands, if any. Mail will be sent using the command .Xr sendmail 8 . If -.Nm at +.Nm is executed from a .Xr su 1 shell, the owner of the login shell will receive the mail. @@ -188,7 +191,7 @@ to The .Nm c queue is the default for -.Nm at +.Nm and the .Nm E queue for @@ -249,13 +252,13 @@ If the file .Pa /var/run/utmp is not available or corrupted, or if the user is not logged on at the time -.Nm at +.Nm is invoked, the mail is sent to the user ID found in the environment variable .Ev LOGNAME . If that is undefined or empty, the current user ID is assumed. .Pp -.Nm at +.Nm and .Nm batch as presently implemented are not suitable when users are competing for @@ -264,6 +267,6 @@ If this is the case for your site, you might want to consider another batch system, such as .Nm nqs . .Sh AUTHORS -.Nm at +.Nm was mostly written by Thomas Koenig <ig25@rz.uni-karlsruhe.de>. The time parsing routines are by David Parsons <orc@pell.chi.il.us>. diff --git a/usr.bin/aucat/aucat.1 b/usr.bin/aucat/aucat.1 index 692e831110d..bb54a2c3efe 100644 --- a/usr.bin/aucat/aucat.1 +++ b/usr.bin/aucat/aucat.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: aucat.1,v 1.6 1999/07/02 20:11:44 aaron Exp $ +.\" $OpenBSD: aucat.1,v 1.7 1999/07/04 11:53:51 aaron Exp $ .\" .\" Copyright (c) 1997 Kenneth Stailey. All rights reserved. .\" @@ -45,16 +45,20 @@ .Op Ar .Sh DESCRIPTION The -.Nm aucat -utility reads files sequentially, writing them to /dev/audio. +.Nm +utility reads files sequentially, writing them to +.Pa /dev/audio . The .Ar file operands are processed in command line order. If a Sun .au header is -detected it is skipped over and not copied to /dev/audio. Otherwise, the -entire file is copied to /dev/audio. +detected it is skipped over and not copied to +.Pa /dev/audio . +Otherwise, the +entire file is copied to +.Pa /dev/audio . .Pp The -.Nm aucat +.Nm utility exits 0 on success or >0 if an error occurred. .Sh SEE ALSO .Xr audio 4 diff --git a/usr.bin/biff/biff.1 b/usr.bin/biff/biff.1 index 5571064f58e..8136d1e5d8d 100644 --- a/usr.bin/biff/biff.1 +++ b/usr.bin/biff/biff.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: biff.1,v 1.5 1999/06/05 01:21:19 aaron Exp $ +.\" $OpenBSD: biff.1,v 1.6 1999/07/04 11:53:51 aaron Exp $ .\" $NetBSD: biff.1,v 1.3 1995/03/26 02:34:21 glass Exp $ .\" .\" Copyright (c) 1980, 1990, 1993 @@ -44,7 +44,7 @@ .Nm biff .Op Cm ny .Sh DESCRIPTION -.Nm biff +.Nm informs the system whether you want to be notified when mail arrives during the current terminal session. .Pp @@ -67,7 +67,7 @@ or .Pa \&.profile to be executed at each login. .Pp -.Nm biff +.Nm operates asynchronously. For synchronous notification use the .Ev MAIL @@ -87,5 +87,5 @@ The .Nm command appeared in .Bx 4.0 . -.Nm biff +.Nm was Heidi Stettner's dog. He died in August 1993, at 15. diff --git a/usr.bin/cal/cal.1 b/usr.bin/cal/cal.1 index 98cf08a451e..627fc52f89c 100644 --- a/usr.bin/cal/cal.1 +++ b/usr.bin/cal/cal.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: cal.1,v 1.7 1999/06/05 01:21:20 aaron Exp $ +.\" $OpenBSD: cal.1,v 1.8 1999/07/04 11:53:51 aaron Exp $ .\" $NetBSD: cal.1,v 1.6 1995/09/02 05:34:20 jtc Exp $ .\" .\" Copyright (c) 1989, 1990, 1993 @@ -51,7 +51,7 @@ .Ar year .Oc .Sh DESCRIPTION -.Nm cal +.Nm displays a simple calendar. If arguments are not specified, the current month is displayed. @@ -83,7 +83,7 @@ Eleven days following that date were eliminated by the reformation, so the calendar for that month is a bit unusual. .Sh STANDARDS The -.Nm cal +.Nm command offers a superset of .St -p1003.2 functionality. diff --git a/usr.bin/calendar/calendar.1 b/usr.bin/calendar/calendar.1 index 991814291b4..607681ac6dd 100644 --- a/usr.bin/calendar/calendar.1 +++ b/usr.bin/calendar/calendar.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: calendar.1,v 1.10 1998/12/16 02:38:49 aaron Exp $ +.\" $OpenBSD: calendar.1,v 1.11 1999/07/04 11:53:51 aaron Exp $ .\" .\" Copyright (c) 1989, 1990, 1993 .\" The Regents of the University of California. All rights reserved. @@ -207,7 +207,7 @@ Russian calendar .Xr cron 8 .Sh COMPATIBILITY The -.Nm calendar +.Nm program previously selected lines which had the correct date anywhere in the line. This is no longer true: the date is only recognized when it occurs diff --git a/usr.bin/checknr/checknr.1 b/usr.bin/checknr/checknr.1 index 68bbe619012..35e226818e4 100644 --- a/usr.bin/checknr/checknr.1 +++ b/usr.bin/checknr/checknr.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: checknr.1,v 1.5 1999/06/05 01:21:20 aaron Exp $ +.\" $OpenBSD: checknr.1,v 1.6 1999/07/04 11:53:51 aaron Exp $ .\" $NetBSD: checknr.1,v 1.5 1995/03/26 04:10:14 glass Exp $ .\" .\" Copyright (c) 1980, 1990, 1993 @@ -48,7 +48,7 @@ .Op Fl f .Ar file .Sh DESCRIPTION -.Nm checknr +.Nm checks a list of .Xr nroff 1 or @@ -57,7 +57,7 @@ input files for certain kinds of errors involving mismatched opening and closing delimiters and unknown commands. If no files are specified, -.Nm checknr +.Nm checks the standard input. .Pp Options: @@ -78,7 +78,7 @@ Define commands which would otherwise be complained about as undefined. .It Fl f Request -.Nm checknr +.Nm to ignore .Ql \ef font changes. @@ -99,9 +99,9 @@ Macros that come in open ... close forms, for example, the .TS and .TE macros which must always come in pairs. .El .Pp -.Nm checknr +.Nm is intended for use on documents that are prepared with -.Nm checknr +.Nm in mind, much the same as .Xr lint 1 . It expects a certain document writing style for @@ -131,7 +131,7 @@ forms anyway, you should think of this as a contribution to your document preparation style. .Pp -.Nm checknr +.Nm knows about the .Xr ms 7 and diff --git a/usr.bin/chflags/chflags.1 b/usr.bin/chflags/chflags.1 index d5e3911362c..359a2db20e8 100644 --- a/usr.bin/chflags/chflags.1 +++ b/usr.bin/chflags/chflags.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: chflags.1,v 1.4 1998/09/23 04:32:36 aaron Exp $ +.\" $OpenBSD: chflags.1,v 1.5 1999/07/04 11:53:51 aaron Exp $ .\" $NetBSD: chflags.1,v 1.4 1995/08/31 22:50:22 jtc Exp $ .\" .\" Copyright (c) 1989, 1990, 1993, 1994 @@ -53,7 +53,7 @@ .Ar file Op Ar ... .Sh DESCRIPTION The -.Nm chflags +.Nm utility modifies the file flags of the listed files as specified by the .Ar flags @@ -104,7 +104,7 @@ Symbolic links do not have flags, so unless the or .Fl L option is set, -.Nm chflags +.Nm on a symbolic link always succeeds and has no effect. The .Fl H , @@ -120,7 +120,7 @@ command's actions are determined by the last one specified. You can use "ls -lo" to see the flags of existing files. .Pp The -.Nm chflags +.Nm utility exits 0 on success or >0 if an error occurred. .Sh SEE ALSO .Xr ls 1 , diff --git a/usr.bin/chpass/chpass.1 b/usr.bin/chpass/chpass.1 index 461f346a6e7..c33f750ea42 100644 --- a/usr.bin/chpass/chpass.1 +++ b/usr.bin/chpass/chpass.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: chpass.1,v 1.11 1999/06/05 01:21:20 aaron Exp $ +.\" $OpenBSD: chpass.1,v 1.12 1999/07/04 11:53:51 aaron Exp $ .\" $NetBSD: chpass.1,v 1.7 1996/05/15 21:50:40 jtc Exp $ .\" .\" Copyright (c) 1988, 1990, 1993 @@ -46,7 +46,7 @@ .Op Fl s Ar newshell .Op Ar user .Sh DESCRIPTION -.Nm chpass +.Nm allows editing of the user database information associated with .Ar user , @@ -187,7 +187,7 @@ and numbers. .Pp Once the information has been verified, -.Nm chpass +.Nm uses .Xr pwd_mkdb 8 to update the user database. diff --git a/usr.bin/cksum/cksum.1 b/usr.bin/cksum/cksum.1 index 2cbacfa886e..9d81e03ef49 100644 --- a/usr.bin/cksum/cksum.1 +++ b/usr.bin/cksum/cksum.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: cksum.1,v 1.8 1999/06/05 01:21:21 aaron Exp $ +.\" $OpenBSD: cksum.1,v 1.9 1999/07/04 11:53:52 aaron Exp $ .\" $NetBSD: cksum.1,v 1.8 1995/09/02 05:45:15 jtc Exp $ .\" .\" Copyright (c) 1991, 1993 @@ -41,7 +41,8 @@ .Dt CKSUM 1 .Os .Sh NAME -.Nm cksum +.Nm cksum , +.Nm sum .Nd display file checksums and block counts .Sh SYNOPSIS .Nm cksum @@ -51,7 +52,7 @@ .Op Ar file ... .Sh DESCRIPTION The -.Nm cksum +.Nm utility writes to the standard output three whitespace separated fields for each input file. These fields are a checksum @@ -63,7 +64,7 @@ is written. The .Nm sum utility is identical to the -.Nm cksum +.Nm utility, except that it defaults to using historic algorithm 1, as described below. It is provided for compatibility only. @@ -153,7 +154,7 @@ The bit sequence is complemented and the result is the CRC. .Ed .Pp The -.Nm cksum +.Nm and .Nm sum utilities exit 0 on success or >0 if an error occurred. @@ -161,7 +162,7 @@ utilities exit 0 on success or >0 if an error occurred. Do not use .Nm sum or -.Nm cksum +.Nm to detect hostile binary modifications. An attacker can trivially produce backdoored daemons which have the same CRC as the standard versions. Use a cryptographic checksum (such as MD5) instead. @@ -182,13 +183,13 @@ article. .Re .Sh STANDARDS The -.Nm cksum +.Nm utility is compliant with the .St -p1003.2-92 specification. .Sh HISTORY The -.Nm cksum +.Nm utility appeared in .Bx 4.4 . .\" .Pp diff --git a/usr.bin/cmp/cmp.1 b/usr.bin/cmp/cmp.1 index 5def9c4ca45..72de16cf064 100644 --- a/usr.bin/cmp/cmp.1 +++ b/usr.bin/cmp/cmp.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: cmp.1,v 1.5 1999/06/05 01:21:21 aaron Exp $ +.\" $OpenBSD: cmp.1,v 1.6 1999/07/04 11:53:52 aaron Exp $ .\" $NetBSD: cmp.1,v 1.4 1995/09/08 03:22:55 tls Exp $ .\" .\" Copyright (c) 1987, 1990, 1993 @@ -50,7 +50,7 @@ .Op Ar skip1 Op Ar skip2 .Sh DESCRIPTION The -.Nm cmp +.Nm utility compares two files of any type and writes the results to the standard output. By default, @@ -83,7 +83,7 @@ The offset is decimal by default, but may be expressed as a hexadecimal or octal value by preceding it with a leading ``0x'' or ``0''. .Pp The -.Nm cmp +.Nm utility exits with one of the following values: .Bl -tag -width 4n .It 0 @@ -95,7 +95,7 @@ the other. In the latter case, if the .Fl s option has not been specified, -.Nm cmp +.Nm writes to standard error that EOF was reached in the shorter file (before any differences were found). .It >1 @@ -106,7 +106,7 @@ An error occurred. .Xr diff3 1 .Sh STANDARDS The -.Nm cmp +.Nm utility is expected to be .St -p1003.2 compatible. diff --git a/usr.bin/colcrt/colcrt.1 b/usr.bin/colcrt/colcrt.1 index 1f750a0907d..243f91b316a 100644 --- a/usr.bin/colcrt/colcrt.1 +++ b/usr.bin/colcrt/colcrt.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: colcrt.1,v 1.4 1999/06/05 01:21:21 aaron Exp $ +.\" $OpenBSD: colcrt.1,v 1.5 1999/07/04 11:53:52 aaron Exp $ .\" $NetBSD: colcrt.1,v 1.3 1995/03/26 05:30:59 glass Exp $ .\" .\" Copyright (c) 1980, 1990, 1993 @@ -46,7 +46,7 @@ .Op Fl \&2 .Op Ar .Sh DESCRIPTION -.Nm colcrt +.Nm provides virtual half-line and reverse line feed sequences for terminals without such capability, and on which overstriking is destructive. @@ -74,7 +74,7 @@ contains superscripts and subscripts which would otherwise be invisible. .El .Sh EXAMPLES A typical use of -.Nm colcrt +.Nm would be .Bd -literal tbl exum2.n \&| nroff \-ms \&| colcrt \- \&| more diff --git a/usr.bin/colrm/colrm.1 b/usr.bin/colrm/colrm.1 index 9d56dc4768b..3b44a3cc216 100644 --- a/usr.bin/colrm/colrm.1 +++ b/usr.bin/colrm/colrm.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: colrm.1,v 1.4 1999/06/05 01:21:21 aaron Exp $ +.\" $OpenBSD: colrm.1,v 1.5 1999/07/04 11:53:52 aaron Exp $ .\" $NetBSD: colrm.1,v 1.3 1995/03/26 09:04:01 glass Exp $ .\" .\" Copyright (c) 1980, 1990, 1993 @@ -44,7 +44,7 @@ .Nm colrm .Op Ar start Op Ar stop .Sh DESCRIPTION -.Nm colrm +.Nm removes selected columns from the lines of a file. A column is defined as a single character in a line. Input is read from the standard input. @@ -76,6 +76,6 @@ Backspace characters decrement the column count by one. .Xr paste 1 .Sh HISTORY The -.Nm colrm +.Nm command appeared in .Bx 3.0 . diff --git a/usr.bin/compile_et/compile_et.1 b/usr.bin/compile_et/compile_et.1 index a08df6996bc..85bb8cf5557 100644 --- a/usr.bin/compile_et/compile_et.1 +++ b/usr.bin/compile_et/compile_et.1 @@ -1,8 +1,8 @@ .\" Copyright (c) 1988 Massachusetts Institute of Technology, .\" Student Information Processing Board. All rights reserved. .\" -.\" $OpenBSD: compile_et.1,v 1.4 1998/09/23 04:32:38 aaron Exp $ -.\" $Header: /cvs/OpenBSD/src/usr.bin/compile_et/compile_et.1,v 1.4 1998/09/23 04:32:38 aaron Exp $ +.\" $OpenBSD: compile_et.1,v 1.5 1999/07/04 11:53:52 aaron Exp $ +.\" $Header: /cvs/OpenBSD/src/usr.bin/compile_et/compile_et.1,v 1.5 1999/07/04 11:53:52 aaron Exp $ .\" .Dd November 22, 1988 .Os @@ -14,7 +14,7 @@ .Nm compile_et .Ar file .Sh DESCRIPTION -.Nm compile_et +.Nm converts a table listing error-code names and associated messages into a C source file suitable for use with the .Xr com_err 3 @@ -65,7 +65,7 @@ A ``#'' in the source file is treated as a comment character, and all remaining text to the end of the source line will be ignored. .Sh BUGS Since -.Nm compile_et +.Nm uses a very simple parser based on .Xr yacc 1 , its error recovery leaves much to be desired. diff --git a/usr.bin/compress/compress.1 b/usr.bin/compress/compress.1 index 54d0a1f8aa7..4feb28ddfc3 100644 --- a/usr.bin/compress/compress.1 +++ b/usr.bin/compress/compress.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: compress.1,v 1.7 1999/06/05 01:21:22 aaron Exp $ +.\" $OpenBSD: compress.1,v 1.8 1999/07/04 11:53:52 aaron Exp $ .\" $NetBSD: compress.1,v 1.5 1995/03/26 09:44:34 glass Exp $ .\" .\" Copyright (c) 1986, 1990, 1993 @@ -43,9 +43,7 @@ .Os .Sh NAME .Nm compress , -.\".Nm uncompress , .Nm uncompress -.\".Nm zcat .Nd compress and expand data .Sh SYNOPSIS .Nm compress @@ -57,10 +55,8 @@ .Op Fl cftoqv .Op Fl o Ar filename .Op Ar -.\".Nm zcat -.\".Op Ar .Sh DESCRIPTION -.Nm compress +.Nm reduces the size of the named files using adaptive Lempel-Ziv coding. Each .Ar file @@ -78,10 +74,6 @@ restores the compressed files to their original form, renaming the files by deleting the .Dq .Z extension. -.\".Pp -.\".Nm Zcat -.\"is an alias for -.\".Dq "uncompress -c" . .Pp If renaming the files would cause files to be overwritten and the standard input device is a terminal, the user is prompted (on the standard error @@ -125,7 +117,7 @@ Be quiet, suppress any messages. Print the percentage reduction of each file. .El .Pp -.Nm compress +.Nm uses a modified Lempel-Ziv algorithm. Common substrings in the file are first replaced by 9-bit codes 257 and up. When code 512 is reached, the algorithm switches to 10-bit codes and @@ -139,15 +131,17 @@ must be between 9 and 16. After the .Ar bits limit is reached, -.Nm compress +.Nm periodically checks the compression ratio. If it is increasing, -.Nm compress +.Nm continues to use the existing code dictionary. However, if the compression ratio decreases, -.Nm compress +.Nm discards the table of substrings and rebuilds it from scratch. This allows -the algorithm to adapt to the next "block" of the file. +the algorithm to adapt to the next +.Dq block +of the file. .Pp The .Fl b @@ -172,7 +166,7 @@ coding (as used in the historical command compact), and takes less time to compute. .Pp The -.Nm compress +.Nm utility exits 0 on success, 1 if an error occurred, or 2 if one or more files were not compressed because they would have grown in size (and @@ -189,7 +183,7 @@ was not specifed). .Re .Sh STANDARDS The -.Nm compress +.Nm utility is compliant with the .St -p1003.2-92 specification. diff --git a/usr.bin/ctags/ctags.1 b/usr.bin/ctags/ctags.1 index cbd4fcdef7f..96b800c8d4e 100644 --- a/usr.bin/ctags/ctags.1 +++ b/usr.bin/ctags/ctags.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: ctags.1,v 1.5 1999/06/05 01:21:22 aaron Exp $ +.\" $OpenBSD: ctags.1,v 1.6 1999/07/04 11:53:52 aaron Exp $ .\" $NetBSD: ctags.1,v 1.4 1995/03/26 20:14:04 glass Exp $ .\" .\" Copyright (c) 1987, 1990, 1993 @@ -46,7 +46,7 @@ .Op Fl f Ar tagsfile .Ar name ... .Sh DESCRIPTION -.Nm ctags +.Nm makes a tags file for .Xr ex 1 from the specified C, @@ -116,7 +116,7 @@ vgrind \-x index .It Fl w Suppress warning diagnostics. .It Fl x -.Nm ctags +.Nm produces a list of object names, the line number and file name on which each is defined, as well as the text of that line and prints this on the standard output. This @@ -154,7 +154,7 @@ trailing .Nm \&.c and any leading pathname components removed. This makes use of -.Nm ctags +.Nm practical in directories with more than one program. .Pp @@ -171,7 +171,7 @@ the second section of the lex file. default output tags file .El .Sh DIAGNOSTICS -.Nm ctags +.Nm exits with a value of 1 if an error occurred, 0 otherwise. Duplicate objects are not considered errors. .Sh SEE ALSO @@ -179,7 +179,7 @@ Duplicate objects are not considered errors. .Xr vi 1 .Sh BUGS Recognition of -.Nm functions , +.Nm functions , .Nm subroutines and .Nm procedures @@ -188,7 +188,7 @@ for and Pascal is done in a very simple-minded way. No attempt is made to deal with block structure; if you have two Pascal procedures in different blocks with the same name you lose. -.Nm ctags +.Nm doesn't understand about Pascal types. .Pp @@ -196,7 +196,7 @@ The method of deciding whether to look for C, Pascal or .Tn FORTRAN functions is a hack. .Pp -.Nm ctags +.Nm relies on the input being well formed, and any syntactical errors will completely confuse it. It also finds some legal syntax confusing; for example, since it doesn't understand diff --git a/usr.bin/cut/cut.1 b/usr.bin/cut/cut.1 index 586dd2632bb..ff5ec4f12b7 100644 --- a/usr.bin/cut/cut.1 +++ b/usr.bin/cut/cut.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: cut.1,v 1.4 1999/06/05 01:21:22 aaron Exp $ +.\" $OpenBSD: cut.1,v 1.5 1999/07/04 11:53:52 aaron Exp $ .\" $NetBSD: cut.1,v 1.6 1995/10/02 20:19:26 jtc Exp $ .\" .\" Copyright (c) 1989, 1990, 1993 @@ -58,7 +58,7 @@ .Op Ar .Sh DESCRIPTION The -.Nm cut +.Nm utility selects portions of each line (as specified by .Ar list ) from each @@ -113,12 +113,12 @@ Unless specified, lines with no delimiters are passed through unmodified. .El .Pp The -.Nm cut +.Nm utility exits 0 on success or 1 if an error occurred. .Sh SEE ALSO .Xr paste 1 .Sh STANDARDS The -.Nm cut +.Nm utility conforms to .St -p1003.2-92 . diff --git a/usr.bin/du/du.1 b/usr.bin/du/du.1 index 0943077a5f4..325e9ac87b9 100644 --- a/usr.bin/du/du.1 +++ b/usr.bin/du/du.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: du.1,v 1.9 1999/06/05 01:21:22 aaron Exp $ +.\" $OpenBSD: du.1,v 1.10 1999/07/04 11:53:53 aaron Exp $ .\" $NetBSD: du.1,v 1.6 1996/10/18 07:20:31 thorpej Exp $ .\" .\" Copyright (c) 1990, 1993 @@ -48,7 +48,7 @@ .Op Ar file ... .Sh DESCRIPTION The -.Nm du +.Nm utility displays the file system block usage for each .Ar file argument @@ -71,9 +71,9 @@ No symbolic links are followed. Display an entry for each file in the file hierarchy. .It Fl k By default, -.Nm du +.Nm displays the number of blocks as returned by the -.Xr stat 2 +.Xr stat 2 system call, i.e. 512-byte blocks. If the .Fl k @@ -93,7 +93,7 @@ This option exists solely for conformance with Filesystem mount points are not traversed. .El .Pp -.Nm du +.Nm counts the storage used by symbolic links and not the files they reference unless the .Fl H @@ -116,7 +116,7 @@ by the last one specified. .Pp Files having multiple hard links are counted (and displayed) a single time per -.Nm du +.Nm execution. .Sh ENVIRONMENT .Bl -tag -width BLOCKSIZE @@ -135,6 +135,6 @@ size block. .Xr quot 8 .Sh HISTORY A -.Nm du +.Nm command appeared in .At v6 . diff --git a/usr.bin/elf2aout/elf2aout.1 b/usr.bin/elf2aout/elf2aout.1 index d9ce8823a4c..3125268f8b7 100644 --- a/usr.bin/elf2aout/elf2aout.1 +++ b/usr.bin/elf2aout/elf2aout.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: elf2aout.1,v 1.6 1999/07/02 20:11:44 aaron Exp $ +.\" $OpenBSD: elf2aout.1,v 1.7 1999/07/04 11:53:53 aaron Exp $ .\" .\" Copyright (c) 1996 Per Fogelstrom .\" @@ -43,7 +43,7 @@ .Ar aoutexec .Oc .Sh DESCRIPTION -.Nm elf2aout +.Nm reads and converts the file specified as .Ar elfexec to a.out format, into file diff --git a/usr.bin/elf2ecoff/elf2ecoff.1 b/usr.bin/elf2ecoff/elf2ecoff.1 index 11051fe9705..ab111a8198c 100644 --- a/usr.bin/elf2ecoff/elf2ecoff.1 +++ b/usr.bin/elf2ecoff/elf2ecoff.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: elf2ecoff.1,v 1.5 1999/07/02 20:11:45 aaron Exp $ +.\" $OpenBSD: elf2ecoff.1,v 1.6 1999/07/04 11:53:53 aaron Exp $ .\" .\" Copyright (c) 1996 Per Fogelstrom .\" @@ -41,7 +41,7 @@ .Ar elfexec .Ar ecoffexec .Sh DESCRIPTION -.Nm elf2ecoff +.Nm reads and converts the file specified as .Ar elfexec to ecoff format, into file diff --git a/usr.bin/elf2olf/elf2olf.1 b/usr.bin/elf2olf/elf2olf.1 index ce492c3539e..5c12483a0e1 100644 --- a/usr.bin/elf2olf/elf2olf.1 +++ b/usr.bin/elf2olf/elf2olf.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: elf2olf.1,v 1.6 1999/06/05 01:21:23 aaron Exp $ +.\" $OpenBSD: elf2olf.1,v 1.7 1999/07/04 11:53:53 aaron Exp $ .\" .\" Copyright (c) 1996, 1997 Erik Theisen. .\" All rights reserved. @@ -25,7 +25,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. .\" -.\" @(#)$Id: elf2olf.1,v 1.6 1999/06/05 01:21:23 aaron Exp $ +.\" @(#)$Id: elf2olf.1,v 1.7 1999/07/04 11:53:53 aaron Exp $ .\" .Dd May 5, 1997 .Dt ELF2OLF 1 @@ -44,7 +44,7 @@ .Ar file Op Ar ... .Sh DESCRIPTION The -.Nm elf2olf +.Nm utility reads the specified .Em ELF version 1 module operands and converts them to the default operating system's @@ -83,7 +83,7 @@ as follows: .El .Pp The -.Nm elf2olf +.Nm and .Nm olf2elf utilities exit 0 on success or >0 if an error occurred. @@ -94,7 +94,7 @@ version 1 object module format lacks any real method to determine the native operating system for any given binary thus mandating the existance of these tools. The converted binaries created by -.Nm elf2olf +.Nm will no longer execute on their native operating system, only on OLF enabled platforms, although .Nm olf2elf @@ -106,7 +106,7 @@ will undo the damage. Erik Theisen .Sh HISTORY The -.Nm elf2olf +.Nm and .Nm olf2elf utilities first appeared in diff --git a/usr.bin/encrypt/encrypt.1 b/usr.bin/encrypt/encrypt.1 index 48058ef2396..0d342cfe38d 100644 --- a/usr.bin/encrypt/encrypt.1 +++ b/usr.bin/encrypt/encrypt.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: encrypt.1,v 1.11 1999/06/05 01:21:23 aaron Exp $ +.\" $OpenBSD: encrypt.1,v 1.12 1999/07/04 11:53:53 aaron Exp $ .\" .\" Copyright (c) 1996, Jason Downs. All rights reserved. .\" @@ -38,7 +38,7 @@ .Op Fl p | Ar string .Nm makekey .Sh DESCRIPTION -.Nm encrypt +.Nm prints the encrypted form of .Ar string to the standard output. This is mostly useful for encrypting passwords @@ -67,7 +67,7 @@ Encrypt the string using DES, with the specified If no .Ar string is specified, -.Nm encrypt +.Nm reads one string per line from standard input, encrypting each one with the chosen algorithm from above. In case that no specific algorithm was given as a command line option, the default will be looked up from @@ -89,7 +89,7 @@ standard input is more secure. .Xr pw_getconf 3 , .Xr passwd.conf 5 .Sh HISTORY -.Nm encrypt +.Nm first appeared in .Ox 1.2 . .Pp diff --git a/usr.bin/error/error.1 b/usr.bin/error/error.1 index 941aa9341d7..40064d07c42 100644 --- a/usr.bin/error/error.1 +++ b/usr.bin/error/error.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: error.1,v 1.6 1999/06/05 01:21:24 aaron Exp $ +.\" $OpenBSD: error.1,v 1.7 1999/07/04 11:53:53 aaron Exp $ .\" $NetBSD: error.1,v 1.3 1995/09/02 06:15:20 jtc Exp $ .\" .\" Copyright (c) 1980, 1990, 1993 @@ -50,7 +50,7 @@ .Op Fl I Ar ignorefile .Op Ar name .Sh DESCRIPTION -.Nm error +.Nm analyzes and optionally disperses the diagnostic error messages produced by a number of compilers and language processors to the source file and line where the errors occurred. It can replace the painful, @@ -97,7 +97,7 @@ Thus the suffix list: .Dl ".c.y.foo*.h" .Pp allows -.Nm error +.Nm to touch files ending with ``.c'', ``.y'', ``.foo*'' and ``.h''. .It Fl s Print out @@ -106,7 +106,7 @@ regarding the error categorization. Not too useful. .El .Pp -.Nm error +.Nm looks at the error messages, either from the specified file .Ar name @@ -121,10 +121,10 @@ line the error message refers. Error messages which can't be categorized by language processor or content are not inserted into any file, but are sent to the standard output. -.Nm error +.Nm touches source files only after all input has been read. .Pp -.Nm error +.Nm is intended to be run with its standard input connected via a pipe to the error message source. @@ -143,7 +143,7 @@ by whatever programs .Xr make 1 runs when making lint. .Pp -.Nm error +.Nm knows about the error messages produced by: .Xr make 1 , .Xr \&cc 1 , @@ -157,7 +157,7 @@ knows about the error messages produced by: .Xr f77 1 , and .Em DEC Western Research Modula\-2 . -.Nm error +.Nm knows a standard format for error messages produced by the language processors, so is sensitive to changes in these formats. @@ -165,17 +165,17 @@ For all languages except Pascal, error messages are restricted to be on one line. Some error messages refer to more than one line in more than one file; -.Nm error +.Nm will duplicate the error message and insert it at all of the places referenced. .Pp -.Nm error +.Nm will do one of six things with error messages. .Bl -tag -width Em synchronize .It Em synchronize Some language processors produce short errors describing which file it is processing. -.Nm error +.Nm uses these to determine the file name for languages that don't include the file name in each error message. These synchronization messages are consumed entirely by @@ -228,9 +228,9 @@ insertion into the file to which they refer. Only true error messages are candidates for inserting into the file they refer to. Other error messages are consumed entirely by -.Nm error +.Nm or are written to the standard output. -.Nm error +.Nm inserts the error messages into the source file on the line preceding the line the language processor found in error. Each error message is turned into a one line comment for the @@ -254,7 +254,7 @@ To avoid this, programs with comments and source on the same line should be formatted so that language statements appear before comments. .Pp -.Nm error +.Nm catches interrupt and terminate signals, and if in the insertion phase, will orderly terminate what it is doing. @@ -269,7 +269,7 @@ user's teletype .El .Sh HISTORY The -.Nm error +.Nm command appeared in .Bx 4.0 . @@ -283,7 +283,7 @@ only one link to it. .Pp Changing a language processor's format of error messages may cause -.Nm error +.Nm to not understand the error message. .Pp .Nm error , @@ -297,7 +297,7 @@ Pascal error messages belong after the lines affected the point of error is also disturbed by .Nm error . .Pp -.Nm error +.Nm was designed for work on .Tn CRT Ns s at reasonably high speed. diff --git a/usr.bin/expand/expand.1 b/usr.bin/expand/expand.1 index ba1f4d12725..2597527e8e2 100644 --- a/usr.bin/expand/expand.1 +++ b/usr.bin/expand/expand.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: expand.1,v 1.5 1999/06/05 01:21:24 aaron Exp $ +.\" $OpenBSD: expand.1,v 1.6 1999/07/04 11:53:53 aaron Exp $ .\" $NetBSD: expand.1,v 1.3 1995/09/02 06:19:45 jtc Exp $ .\" .\" Copyright (c) 1980, 1990, 1993 @@ -50,12 +50,12 @@ .Op Fl a .Op Ar file Ar ... .Sh DESCRIPTION -.Nm expand +.Nm processes the named files or the standard input writing the standard output with tabs changed into blanks. Backspace characters are preserved into the output and decrement the column count for tab calculations. -.Nm expand +.Nm is useful for pre-processing character files (before sorting, looking at specific columns, etc.) that contain tabs. @@ -85,6 +85,6 @@ resultant file by replacing two or more characters. .El .Sh HISTORY The -.Nm expand +.Nm command appeared in .Bx 3.0 . diff --git a/usr.bin/file2c/file2c.1 b/usr.bin/file2c/file2c.1 index 0980ccda779..18e96e6cb5a 100644 --- a/usr.bin/file2c/file2c.1 +++ b/usr.bin/file2c/file2c.1 @@ -5,7 +5,7 @@ .\" this stuff is worth it, you can buy me a beer in return. Poul-Henning Kamp .\" --------------------------------------------------------------------------- .\" -.\" $Id: file2c.1,v 1.5 1999/07/02 20:11:45 aaron Exp $ +.\" $Id: file2c.1,v 1.6 1999/07/04 11:53:54 aaron Exp $ .\" .Dd January 28, 1995 .Dt FILE2C 1 @@ -19,7 +19,7 @@ .Op Ar string .Sh DESCRIPTION The -.Nm file2c +.Nm utility reads a file from stdin and writes it to stdout, converting each byte to its decimal representation on the fly. .Pp diff --git a/usr.bin/finger/finger.1 b/usr.bin/finger/finger.1 index 09900a19962..c11e4a9b422 100644 --- a/usr.bin/finger/finger.1 +++ b/usr.bin/finger/finger.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: finger.1,v 1.9 1999/06/05 01:21:25 aaron Exp $ +.\" $OpenBSD: finger.1,v 1.10 1999/07/04 11:53:54 aaron Exp $ .\" .\" Copyright (c) 1989, 1990 The Regents of the University of California. .\" All rights reserved. @@ -46,13 +46,13 @@ .Op Ar user@host ... .Sh DESCRIPTION The -.Nm finger +.Nm utility displays information about the system users. .Pp Options are: .Bl -tag -width flag .It Fl s -.Nm finger +.Nm displays the user's login name, real name, terminal name and write status (as a ``*'' before the terminal name if write permission is denied), idle time, login time, and either office location and office @@ -125,7 +125,7 @@ Prevents the .Fl l option of -.Nm finger +.Nm from displaying the contents of the .Dq Pa .plan and @@ -141,7 +141,7 @@ users' real names, unless the .Fl m option is supplied. All name matching performed by -.Nm finger +.Nm is case insensitive. .It Fl M Enable matching of @@ -150,7 +150,7 @@ names. This is disabled by default on systems running YP. .El .Pp If no options are specified, -.Nm finger +.Nm defaults to the .Fl l style output if operands are provided, otherwise to the @@ -160,10 +160,10 @@ Note that some fields may be missing, in either format, if information is not available for them. .Pp If no arguments are specified, -.Nm finger +.Nm will print an entry for each user currently logged into the system. .Pp -.Nm finger +.Nm may be used to look up users on a remote machine. The format is to specify a .Ar user @@ -187,6 +187,6 @@ option is the only option that may be passed to a remote machine. .Xr fingerd 8 .Sh HISTORY The -.Nm finger +.Nm command appeared in .Bx 3.0 . diff --git a/usr.bin/fmt/fmt.1 b/usr.bin/fmt/fmt.1 index 7b66537e528..5db67f12a6c 100644 --- a/usr.bin/fmt/fmt.1 +++ b/usr.bin/fmt/fmt.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: fmt.1,v 1.6 1998/12/16 02:38:49 aaron Exp $ +.\" $OpenBSD: fmt.1,v 1.7 1999/07/04 11:53:54 aaron Exp $ .\" .\" Copyright (c) 1980, 1990, 1993 .\" The Regents of the University of California. All rights reserved. @@ -53,7 +53,7 @@ .Oc .Op name ... .Sh DESCRIPTION -.Nm fmt +.Nm is a simple text formatter which reads the concatenation of input files (or standard input if none are given) and produces on standard output a version of its input with lines as close to the @@ -104,13 +104,13 @@ Assume that the input files' tabs assume spaces per tab stop. The default is 8. .El .Pp -.Nm fmt +.Nm is meant to format mail messages prior to sending, but may also be useful for other simple tasks. For instance, within visual mode of the .Xr ex 1 -editor (e.g. +editor (e.g., .Xr vi 1 ) the command .Pp diff --git a/usr.bin/from/from.1 b/usr.bin/from/from.1 index 1606dc89ffb..87f9f66b7e0 100644 --- a/usr.bin/from/from.1 +++ b/usr.bin/from/from.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: from.1,v 1.4 1999/06/05 01:21:25 aaron Exp $ +.\" $OpenBSD: from.1,v 1.5 1999/07/04 11:53:54 aaron Exp $ .\" $NetBSD: from.1,v 1.4 1995/09/01 01:39:09 jtc Exp $ .\" .\" Copyright (c) 1980, 1990, 1993 @@ -46,7 +46,7 @@ .Op Fl f Ar file .Op Ar user .Sh DESCRIPTION -.Nm from +.Nm prints out the mail header lines from the invoker's mailbox. .Pp @@ -81,6 +81,6 @@ mailbox, is examined instead of the invoker's own mailbox. .Xr mail 1 .Sh HISTORY The -.Nm from +.Nm command appeared in .Bx 3.0 . diff --git a/usr.bin/fsplit/fsplit.1 b/usr.bin/fsplit/fsplit.1 index 6de643720bb..8d881780ae0 100644 --- a/usr.bin/fsplit/fsplit.1 +++ b/usr.bin/fsplit/fsplit.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: fsplit.1,v 1.5 1999/06/05 01:21:25 aaron Exp $ +.\" $OpenBSD: fsplit.1,v 1.6 1999/07/04 11:53:54 aaron Exp $ .\" $NetBSD: fsplit.1,v 1.3 1995/09/28 05:15:06 perry Exp $ .\" .\" Copyright (c) 1983, 1990, 1993 @@ -47,7 +47,7 @@ .Op Fl e Ar efile Op Ar ... .Op Ar file .Sh DESCRIPTION -.Nm fsplit +.Nm takes as input either a file or standard input containing Fortran source code. It attempts to split the input into separate routine files of the form @@ -86,14 +86,14 @@ option are not found, a diagnostic is written to standard error. .Sh HISTORY The -.Nm fsplit +.Nm command appeared in .Bx 4.2 . .Sh AUTHORS Asa Romberger and Jerry Berkman .Sh BUGS -.Nm fsplit +.Nm assumes the subprogram name is on the first noncomment line of the subprogram unit. Nonstandard source formats may confuse .Nm fsplit . diff --git a/usr.bin/ftp/ftp.1 b/usr.bin/ftp/ftp.1 index 936fbb4491f..8a16dbc8a73 100644 --- a/usr.bin/ftp/ftp.1 +++ b/usr.bin/ftp/ftp.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: ftp.1,v 1.26 1999/06/10 22:38:02 pjanzen Exp $ +.\" $OpenBSD: ftp.1,v 1.27 1999/07/04 11:53:54 aaron Exp $ .\" $NetBSD: ftp.1,v 1.22 1997/08/18 10:20:22 lukem Exp $ .\" .\" Copyright (c) 1985, 1989, 1990, 1993 @@ -56,7 +56,7 @@ http://\fIhost\fR[:\fIport\fR]/\fIfile\fR .Nm ftp \fIhost\fR:[/\fIpath\fR/]\fIfile\fR[/] .Sh DESCRIPTION -.Nm ftp +.Nm is the user interface to the .Tn ARPANET standard File Transfer Protocol. diff --git a/usr.bin/getopt/getopt.1 b/usr.bin/getopt/getopt.1 index 0f8317ad6f4..556eed95d11 100644 --- a/usr.bin/getopt/getopt.1 +++ b/usr.bin/getopt/getopt.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: getopt.1,v 1.3 1998/09/26 19:54:50 aaron Exp $ -*- nroff -*- +.\" $OpenBSD: getopt.1,v 1.4 1999/07/04 11:53:54 aaron Exp $ -*- nroff -*- .Dd June 21, 1993 .Dt GETOPT 1 .Os @@ -8,10 +8,10 @@ .Sh SYNOPSIS .Nm set \-\- \`getopt optstring $*\` .Sh DESCRIPTION -.Nm getopt +.Nm is used to break up options in command lines for easy parsing by shell procedures, and to check for legal options. -.Op Optstring +.Op optstring is a string of recognized option letters (see .Xr getopt 3 ); @@ -21,7 +21,7 @@ separated from it by white space. The special option .Dq \-\- is used to delimit the end of the options. -.Nm getopt +.Nm will place .Dq \-\- in the arguments at the end of the options, @@ -75,7 +75,7 @@ cmd \-a \-oarg \-\- file file .Xr sh 1 , .Xr getopt 3 .Sh DIAGNOSTICS -.Nm getopt +.Nm prints an error message on the standard error output when it encounters an option letter not included in .Op optstring . @@ -92,7 +92,7 @@ generally will not survive intact; this looks easy to fix but isn't. .Pp The error message for an invalid option is identified as coming from -.Nm getopt +.Nm rather than from the shell procedure containing the invocation of .Nm getopt ; diff --git a/usr.bin/gprof/gprof.1 b/usr.bin/gprof/gprof.1 index b3b140de5ee..d0303092ab2 100644 --- a/usr.bin/gprof/gprof.1 +++ b/usr.bin/gprof/gprof.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: gprof.1,v 1.11 1999/06/05 01:21:27 aaron Exp $ +.\" $OpenBSD: gprof.1,v 1.12 1999/07/04 11:53:54 aaron Exp $ .\" $NetBSD: gprof.1,v 1.6 1995/11/21 22:24:55 jtc Exp $ .\" .\" Copyright (c) 1983, 1990, 1993 @@ -45,7 +45,7 @@ .Op options .Op Ar a.out Op Ar gmon.out ... .Sh DESCRIPTION -.Nm gprof +.Nm produces an execution profile of C, Pascal, or Fortran77 programs. The effect of called routines is incorporated in the profile of each caller. The profile data is taken from the call graph profile file @@ -62,7 +62,7 @@ The .Fl pg option also links in versions of the library routines that are compiled for profiling. -.Nm gprof +.Nm reads the given object file (the default is .Pa a.out) and establishes the relation between its symbol table @@ -70,10 +70,10 @@ and the call graph profile from .Pa gmon.out . If more than one profile file is specified, the -.Nm gprof +.Nm output shows the sum of the profile information in the given profile files. .Pp -.Nm gprof +.Nm calculates the amount of time spent in each routine. Next, these times are propagated along the edges of the call graph. Cycles are discovered, and calls into a cycle are made to share the time @@ -122,7 +122,7 @@ Find a minimal set of arcs that can be broken to eliminate all cycles with or more members. Caution: the algorithm used to break cycles is exponential, so using this option may cause -.Nm gprof +.Nm to run for a very long time. .It Fl e Ar name Suppresses the printing of the graph profile entry for routine @@ -204,7 +204,7 @@ is produced that represents the sum of the profile information in all the specified profile files. This summary profile file may be given to later executions of -.Nm gprof +.Nm (probably also with a .Fl s ) to accumulate profile data across several runs of an @@ -264,7 +264,7 @@ summarized dynamic call graph and profile .Re .Sh HISTORY The -.Nm gprof +.Nm profiler appeared in .Bx 4.2 . diff --git a/usr.bin/hexdump/hexdump.1 b/usr.bin/hexdump/hexdump.1 index 54e7a7fa850..e316f250bd8 100644 --- a/usr.bin/hexdump/hexdump.1 +++ b/usr.bin/hexdump/hexdump.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: hexdump.1,v 1.7 1999/06/05 01:21:26 aaron Exp $ +.\" $OpenBSD: hexdump.1,v 1.8 1999/07/04 11:53:55 aaron Exp $ .\" Copyright (c) 1989, 1990 The Regents of the University of California. .\" All rights reserved. .\" @@ -50,7 +50,7 @@ .Ar file Op Ar ... .Sh DESCRIPTION The -.Nm hexdump +.Nm utility is a filter which displays the specified files, or the standard input, if no files are specified, in a user-specified format. @@ -136,7 +136,7 @@ data, in hexadecimal, per line. .El .Pp For each input file, -.Nm hexdump +.Nm sequentially copies the input to standard output, transforming the data according to the format strings specified by the .Fl e @@ -198,7 +198,7 @@ described in the C standard are supported: .Ed .El .Pp -.Nm hexdump +.Nm also supports the following additional conversion strings: .Bl -tag -width Fl .It Cm \&_a Ns Op Cm dox @@ -309,7 +309,7 @@ to specifying the .Fl x option. .Pp -.Nm hexdump +.Nm exits 0 on success or >0 if an error occurred. .Sh EXAMPLES Display the input in perusal format: @@ -326,7 +326,7 @@ Implement the \-x option: .Ed .Sh STANDARDS The -.Nm hexdump +.Nm utility is expected to be .St -p1003.2 compatible. diff --git a/usr.bin/hexdump/od.1 b/usr.bin/hexdump/od.1 index fd77f9860c7..43a370a9923 100644 --- a/usr.bin/hexdump/od.1 +++ b/usr.bin/hexdump/od.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: od.1,v 1.4 1999/07/02 20:11:45 aaron Exp $ +.\" $OpenBSD: od.1,v 1.5 1999/07/04 11:53:55 aaron Exp $ .\" Copyright (c) 1990 The Regents of the University of California. .\" All rights reserved. .\" @@ -50,7 +50,7 @@ .Oc .Ar file .Sh DESCRIPTION -.Nm od +.Nm has been deprecated in favor of .Xr hexdump 1 . .Pp diff --git a/usr.bin/id/id.1 b/usr.bin/id/id.1 index 4c7b91df327..b9ed42fb45a 100644 --- a/usr.bin/id/id.1 +++ b/usr.bin/id/id.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: id.1,v 1.6 1999/07/02 20:11:45 aaron Exp $ +.\" $OpenBSD: id.1,v 1.7 1999/07/04 11:53:55 aaron Exp $ .\" $NetBSD: id.1,v 1.5 1995/09/28 08:05:40 perry Exp $ .\" .\" Copyright (c) 1991, 1993, 1994 @@ -59,7 +59,7 @@ .Op Ar user .Sh DESCRIPTION The -.Nm id +.Nm utility displays the user and group names and numeric IDs, of the calling process, to the standard output. If the real and effective IDs are different, both are displayed, @@ -114,13 +114,13 @@ Display the effective user ID as a number. .El .Pp The -.Nm id +.Nm utility exits 0 on success or >0 if an error occurred. .Sh SEE ALSO .Xr who 1 .Sh STANDARDS The -.Nm id +.Nm function is expected to conform to .St -p1003.2 . .Sh HISTORY @@ -137,6 +137,6 @@ command is equivalent to .Dq Nm id Fl un . .Pp The -.Nm id +.Nm command first appeared in .Bx 4.4 . diff --git a/usr.bin/indent/indent.1 b/usr.bin/indent/indent.1 index 0f4138f392b..4f360c23ca6 100644 --- a/usr.bin/indent/indent.1 +++ b/usr.bin/indent/indent.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: indent.1,v 1.6 1999/06/05 01:21:27 aaron Exp $ +.\" $OpenBSD: indent.1,v 1.7 1999/07/04 11:53:55 aaron Exp $ .\" Copyright (c) 1980, 1990 The Regents of the University of California. .\" Copyright (c) 1985 Sun Microsystems, Inc. .\" Copyright (c) 1976 Board of Trustees of the University of Illinois. @@ -80,7 +80,7 @@ .Op Fl troff .Op Fl v | Fl \&nv .Sh DESCRIPTION -.Nm indent +.Nm is a .Ar C program formatter. It reformats the @@ -109,9 +109,9 @@ the backup file is named If .Ar output-file is specified, -.Nm indent +.Nm checks to make sure it is different from -.Ar input-file . +.Ar input-file . .Pp The options listed below control the formatting style imposed by .Nm indent . @@ -315,7 +315,7 @@ get rid of blank lines after declarations. Default: .Fl nsob . .It Fl \&st Causes -.Nm indent +.Nm to take its input from stdin, and put its output to stdout. .It Fl T Ns Ar typename Adds @@ -332,13 +332,13 @@ a symptom of a problem in C: .Ic typedef causes a syntactic change in the language and -.Nm indent +.Nm can't find all instances of .Ic typedef . .It Fl troff Causes -.Nm indent +.Nm to format the program for processing by .Xr troff 1 . It will produce a fancy @@ -351,20 +351,20 @@ rather than formatting in place. turns on `verbose' mode; .Fl \&nv turns it off. When in verbose mode, -.Nm indent +.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 .Fl \&nv . .El .Pp You may set up your own `profile' of defaults to -.Nm indent +.Nm 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 -.Nm indent +.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. @@ -372,7 +372,7 @@ switches. The switches should be separated by spaces, tabs or newlines. .Ss Comments .Sq Em Box .Em comments . -.Nm indent +.Nm assumes that any comment with a dash, star, or newline immediately after the start of comment (that is, `/*\-', `/**' or `/*' followed immediately by a newline character) is a comment surrounded @@ -383,7 +383,7 @@ of the comment. .Pp .Em Straight text . All other comments are treated as straight text. -.Nm indent +.Nm fits as many words (separated by blanks, tabs, or newlines) on a line as possible. Blank lines break paragraphs. .Pp @@ -403,18 +403,18 @@ automatically extended in extreme cases. .Pp .Ss Preprocessor lines In general, -.Nm indent +.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 .Pq Ic #ifdef...#endif is recognized and -.Nm indent +.Nm attempts to correctly compensate for the syntactic peculiarities introduced. .Pp .Ss C syntax -.Nm indent +.Nm 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: @@ -423,7 +423,7 @@ incomplete and misformed syntax. In particular, the use of macros like: .Pp is handled properly. .Sh ENVIRONMENT -.Nm indent +.Nm uses the .Ev HOME environment variable. @@ -436,11 +436,11 @@ profile file .El .Sh HISTORY The -.Nm indent +.Nm command appeared in .Bx 4.2 . .Sh BUGS -.Nm indent +.Nm has even more switches than .Xr ls 1 . .Pp diff --git a/usr.bin/ipcrm/ipcrm.1 b/usr.bin/ipcrm/ipcrm.1 index c70bd448196..7b98f385e90 100644 --- a/usr.bin/ipcrm/ipcrm.1 +++ b/usr.bin/ipcrm/ipcrm.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: ipcrm.1,v 1.4 1999/06/05 01:21:27 aaron Exp $ +.\" $OpenBSD: ipcrm.1,v 1.5 1999/07/04 11:53:55 aaron Exp $ .\" Copyright (c) 1994 Adam Glass .\" All rights reserved. .\" @@ -40,7 +40,7 @@ segments .Op Fl S Ar semkey .Ar ... .Sh DESCRIPTION -.Nm ipcrm +.Nm removes the specified message queues, semaphores and shared memory segments. These System V IPC objects can be specified by their creation ID or any associated key. diff --git a/usr.bin/ipcs/ipcs.1 b/usr.bin/ipcs/ipcs.1 index 2291b3a912f..836af146698 100644 --- a/usr.bin/ipcs/ipcs.1 +++ b/usr.bin/ipcs/ipcs.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: ipcs.1,v 1.6 1999/03/18 11:13:01 aaron Exp $ +.\" $OpenBSD: ipcs.1,v 1.7 1999/07/04 11:53:55 aaron Exp $ .\" $NetBSD: ipcs.1,v 1.4 1995/04/15 02:31:16 cgd Exp $ .\" .\" Copyright (c) 1994 SigmaSoft, Th. Lockert @@ -42,7 +42,7 @@ .Op Fl N Ar core .Sh DESCRIPTION The -.Nm ipcs +.Nm program provides information on System V interprocess communication (IPC) facilities on the system. .Pp @@ -127,9 +127,9 @@ options are specified, information about all active IPC facilities is listed. .Sh RESTRICTIONS System data structures may change while -.Nm ipcs +.Nm is running; the output of -.Nm ipcs +.Nm is not guaranteed to be consistent. .Sh BUGS This manual page is woefully incomplete, because it does not diff --git a/usr.bin/join/join.1 b/usr.bin/join/join.1 index a41498fc0be..15bbb8ac652 100644 --- a/usr.bin/join/join.1 +++ b/usr.bin/join/join.1 @@ -56,9 +56,15 @@ .Ar file1 .Ar file2 .Sh DESCRIPTION -The join utility performs an ``equality join'' on the specified files +The +.Nm +utility performs an +.Dq equality join +on the specified files and writes the result to the standard output. -The ``join field'' is the field in each file by which the files are compared. +The +.Dq join field +is the field in each file by which the files are compared. The first field in each line is used by default. There is one line in the output for each pair of lines in .Ar file1 @@ -76,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 Fl @@ -104,7 +110,9 @@ where is a file number and .Ar field is a field number. -The elements of list must be either comma (``,'') or whitespace separated. +The elements of list must be either comma +.Pq Ql \&, +or whitespace separated. (The latter requires quoting to protect it from the shell, or, a simpler approach is to use multiple .Fl o @@ -141,7 +149,7 @@ should be ordered in the collating sequence of using the .Fl b option, on the fields on which they are to be joined, otherwise -.Nm join +.Nm may not report all field matches. When the field delimiter characters are specified by the .Fl t @@ -155,10 +163,12 @@ If one of the arguments .Ar file1 or .Ar file2 -is ``-'', the standard input is used. +is +.Ql \&- , +the standard input is used. .Pp The -.Nm join +.Nm utility exits 0 on success or >0 if an error occurred. .Sh COMPATIBILITY For compatibility with historic versions of @@ -170,7 +180,7 @@ In addition to the default output, produce a line for each unpairable line in both file 1 and file 2. (To distinguish between this and .Fl a Ar file_number , -.Nm join +.Nm currently requires that the latter not include any white space.) .It Fl j1 Ar field Join on the @@ -186,22 +196,24 @@ Join on the field of both file 1 and file 2. .It Fl o Ar list ... Historical implementations of -.Nm join +.Nm permitted multiple arguments to the .Fl o option. -These arguments were of the form ``file_number.field_number'' as described -for the current +These arguments were of the form +.Dq file_number.field_number +as described for the current .Fl o option. -This has obvious difficulties in the presence of files named ``1.2''. +This has obvious difficulties in the presence of files named +.Dq 1.2 . .El .Pp These options are available only so historic shell scripts don't require modification and should not be used. .Sh STANDARDS The -.Nm join +.Nm command is expected to be .St -p1003.2 compatible. |