mandoc: convert uname.1, uniq.1 and xargs.1

This commit is contained in:
Hiltjo Posthuma 2015-01-30 21:51:23 +01:00
parent a7e0f6b4f1
commit 9d12daf179
3 changed files with 102 additions and 97 deletions

52
uname.1
View File

@ -1,32 +1,32 @@
.TH UNAME 1 sbase\-VERSION
.SH NAME
uname \- print system information
.SH SYNOPSIS
.B uname
.RB [ \-amnrsv ]
.SH DESCRIPTION
.B uname
prints system information. If no flags are given, uname will print only the
name of the operating system
.RB ( \-s ).
.SH OPTIONS
.TP
.B \-a
.Dd January 30, 2015
.Dt UNAME 1 sbase\-VERSION
.Os
.Sh NAME
.Nm uname
.Nd print system information
.Sh SYNOPSIS
.Nm
.Op Fl amnrsv
.Sh DESCRIPTION
.Nm
prints system information. If no flags are given, uname will print only the
name of the operating system as
.Fl s
would.
.Sh OPTIONS
.Bl -tag -width Ds
.It Fl a
print all the information below.
.TP
.B \-m
.It Fl m
print the machine's architecture.
.TP
.B \-n
.It Fl n
print the system's network name.
.TP
.B \-r
.It Fl r
print the operating system's release name.
.TP
.B \-s
.It Fl s
print the name of the operating system.
.TP
.B \-v
.It Fl v
print the operating system's version name.
.SH SEE ALSO
.IR uname (2)
.El
.Sh SEE ALSO
.Xr uname 2

76
uniq.1
View File

@ -1,39 +1,39 @@
.TH UNIQ 1 sbase\-VERSION
.SH NAME
uniq \- multi-column
.SH SYNOPSIS
.B uniq
.RB [ \-cdu ]
.RI [ file ]
.SH DESCRIPTION
.B uniq
reads file and writes one copy of a line
from each group of consecutive duplicate lines
to stdout.
If no file is given, uniq reads from stdin.
.SH OPTIONS
.TP
.B \-c
prefixes each line with a count
of its consecutive occurrences in the input.
.TP
.B \-d
suppresses non-duplicate lines
(thus 'uniq -d' prints only duplicates).
.TP
.B \-u
suppresses non-unique lines
(thus 'uniq -u' prints only uniques).
.SH BUGS
.Dd January 30, 2015
.Dt UNIQ 1 sbase\-VERSION
.Os
.Sh NAME
.Nm uniq
.Nd report or filter out repeated lines in a file
.Sh SYNOPSIS
.Nm
.Op Fl cdu
.Op Ar file
.Sh DESCRIPTION
.Nm
reads file and writes one copy of a line from each group of consecutive
duplicate lines to stdout. If no file is given, uniq reads from stdin.
.Sh OPTIONS
.Bl -tag -width Ds
.It Fl c
prefixes each line with a count of its consecutive occurrences in the input.
.It Fl d
suppresses non-duplicate lines (thus 'uniq -d' prints only duplicates).
.It Fl u
suppresses non-unique lines (thus 'uniq -u' prints only uniques).
.El
.Sh BUGS
The original sbase implementation of
.B uniq
supported multiple input-file arguments,
as e.g. cat and grep do.
Unfortunately, POSIX uniq treats its second argument (if present)
as an output filename and clobbers it.
Since users and scripts which rely on uniq
supporting multiple input-file arguments
would be at risk of data loss
if they ever ran into a POSIX-compatible uniq,
support for multiple input-file arguments
was removed from this implementation.
.Nm
supported multiple input-file arguments as e.g.
.Xr cat 1
and
.Xr grep 1
do.
Unfortunately, POSIX uniq treats its second argument (if present) as an
output filename and clobbers it. Since users and scripts which rely on
.Nm
supporting multiple input-file arguments would be at risk of data loss
if they ever ran into a POSIX-compatible
.Nm
, support for multiple input-file arguments was removed from this
implementation.

71
xargs.1
View File

@ -1,50 +1,55 @@
.TH XARGS 1 sbase\-VERSION
.SH NAME
xargs \- constuct argument list(s) and execute command
.SH SYNOPSIS
.B xargs
.RB [\-n
.IR maxargs ]
.RB [ \-r ]
.RB [ \-E
.IR eofstr ]
.RI [ cmd
.IR [arg... ] ]
.SH DESCRIPTION
.Dd January 30, 2015
.Dt XARGS 1 sbase\-VERSION
.Os
.Sh NAME
.Nm xargs
.Nd constuct argument list(s) and execute command
.Sh SYNOPSIS
.Nm
.Op Fl n Ar maxargs
.Op Fl r
.Op Fl E Ar eofstr
.Op Ar cmd Op Ar arg...
.Sh DESCRIPTION
xargs reads space, tab, newline and EOF delimited strings from stdin
and executes the specified cmd with the strings as arguments.
.Pp
Any arguments specified on the command line are given to the command upon
each invocation, followed by some number of the arguments read from
stdin. The command is repeatedly executed one or more times until stdin
is exhausted.
.Pp
Spaces, tabs and newlines may be embedded in arguments using single (`'')
or double (`"') quotes or backslashes ('\\'). Single quotes escape all
non-single quote characters, excluding newlines, up to the matching single
quote. Double quotes escape all non-double quote characters, excluding
newlines, up to the matching double quote. Any single character, including
newlines, may be escaped by a backslash.
.SH OPTIONS
.TP
.B \-n maxargs
.Sh OPTIONS
.Bl -tag -width Ds
.It Fl n Ar maxargs
Use at most maxargs arguments per command line.
.TP
.BI \-r
.It Fl r
Do not run the command if there are no arguments. Normally the command is
executed at least once even if there are no arguments.
.TP
.B \-E eofstr
.It Fl E Ar eofstr
Use eofstr as a logical EOF marker.
.SH EXIT STATUS
.El
.Sh EXIT STATUS
xargs exits with one of the following values:
0 All invocations of command returned a zero exit
status.
123 One or more invocations of command returned a
nonzero exit status.
124 The command exited with a 255 exit status.
125 The command was killed or stopped by a signal.
126 The command was found but could not be executed.
127 The command could not be found.
1 Some other error occurred.
.Bl -tag -width Ds
.It 0
All invocations of command returned a zero exit status.
.It 123
One or more invocations of command returned a nonzero exit status.
.It 124
The command exited with a 255 exit status.
.It 125
The command was killed or stopped by a signal.
.It 126
The command was found but could not be executed.
.It 127
The command could not be found.
.It 1
Some other error occurred.
.El