fix mandoc warnings

- sort references in SEE ALSO section to section number, name.
- cols.1: proper order of sections.
- wrap lines to max 79 column length.
This commit is contained in:
Hiltjo Posthuma 2015-01-31 14:43:27 +01:00
parent 4a920a5960
commit f769c2402f
23 changed files with 97 additions and 83 deletions

View File

@ -21,8 +21,8 @@ flag is specified, this process is recursively applied to
everything in everything in
.Ar file . .Ar file .
.Sh SEE ALSO .Sh SEE ALSO
.Xr chown 1 ,
.Xr chown 2 ,
.Xr chmod 1 , .Xr chmod 1 ,
.Xr chown 1 ,
.Xr chmod 2 , .Xr chmod 2 ,
.Xr chown 2 ,
.Xr getgrnam 3 .Xr getgrnam 3

28
cols.1
View File

@ -10,21 +10,29 @@
.Op Ar file ... .Op Ar file ...
.Sh DESCRIPTION .Sh DESCRIPTION
.Nm .Nm
reads each file in sequence and writes them to stdout, reads each file in sequence and writes them to stdout, in as many vertical
in as many vertical columns as will fit in columns as will fit in
.Ar chars .Ar chars
character columns. character columns. If no
If no file is given, cols reads from stdin. .Ar file
is given,
.Nm
reads from stdin.
.Sh OPTIONS .Sh OPTIONS
.Bl -tag -width xxxxxxxx .Bl -tag -width xxxxxxxx
.It Fl c Ar chars .It Fl c Ar chars
Specifies the maximum number of character columns to use Specifies the maximum number of character columns to use
(unless the input contains lines longer than (unless the input contains lines longer than
.Ar chars .Ar chars
characters). By default cols tries to figure out the width characters). By default cols tries to figure out the width of the output
of the output device, if that fails it defaults to 65 device, if that fails it defaults to 65 chars.
chars.
.El .El
.Sh HISTORY
.Nm
is similar to the mc(1) command on Plan 9. It was renamed to
.Nm
to avoid the name collision with the popular file manager
Midnight Commander.
.Sh BUGS .Sh BUGS
This implementation of This implementation of
.Nm .Nm
@ -33,9 +41,3 @@ and thus mishandles TAB characters (among others).
.Pp .Pp
.Nm .Nm
currently mangles files which contain embedded NULs. currently mangles files which contain embedded NULs.
.Sh HISTORY
.Nm
is similar to the mc(1) command on Plan 9. It was renamed to
.Nm
to avoid the name collision with the popular file manager
Midnight Commander.

4
cp.1
View File

@ -34,8 +34,8 @@ if an existing destination file cannot be opened, remove it and try again.
.It Fl R .It Fl R
equivalent to -r. equivalent to -r.
.It Fl r .It Fl r
copies directories recursively. If this flag is not specified, directories are copies directories recursively. If this flag is not specified, directories
not copied. are not copied.
.It Fl v .It Fl v
print names of source and destination per file to stdout. In the format: print names of source and destination per file to stdout. In the format:
"source \-> destination". "source \-> destination".

4
cut.1
View File

@ -67,5 +67,5 @@ utility is compliant with the
.St -p1003.1-2008 .St -p1003.1-2008
specification. specification.
.Pp .Pp
The possibility of separating numbers and ranges with a space The possibility of separating numbers and ranges with a space and specifying
and specifying multibyte delimiters of arbitrary length is an extension to that specification. multibyte delimiters of arbitrary length is an extension to that specification.

8
du.1
View File

@ -15,9 +15,11 @@
.Nm .Nm
displays the file system block usage for each displays the file system block usage for each
.Ar file .Ar file
argument and for each directory in the file hierarchy rooted in directory argument. argument and for each directory in the file hierarchy rooted in directory
If no file is specified, the block usage of the hierarchy rooted in the current argument. If no
directory is displayed. .Ar file
is specified, the block usage of the hierarchy rooted in the current directory
is displayed.
.Sh OPTIONS .Sh OPTIONS
.Bl -tag -width Ds .Bl -tag -width Ds
.It Fl a .It Fl a

View File

@ -37,8 +37,8 @@ The default
is "8". is "8".
.El .El
.Sh SEE ALSO .Sh SEE ALSO
.Xr unexpand 1 , .Xr fold 1 ,
.Xr fold 1 .Xr unexpand 1
.Sh STANDARDS .Sh STANDARDS
The The
.Nm .Nm

3
expr.1
View File

@ -76,7 +76,8 @@ against
is anchored with an implicit '^'. is anchored with an implicit '^'.
.Pp .Pp
You can't directly match the empty string, since zero matched characters You can't directly match the empty string, since zero matched characters
resolve equally to a failed match. To work around this limitation, use "expr X'' : 'X$' instead of "expr '' : '$'" resolve equally to a failed match. To work around this limitation, use
"expr X'' : 'X$' instead of "expr '' : '$'"
.El .El
.Sh EXIT STATUS .Sh EXIT STATUS
.Bl -tag -width Ds .Bl -tag -width Ds

16
grep.1
View File

@ -25,8 +25,8 @@ reads from stdin.
.It Fl E .It Fl E
Match using extended regex. Match using extended regex.
.It Fl F .It Fl F
Match using fixed strings. Treat each pattern specified as a string instead of a regular Match using fixed strings. Treat each pattern specified as a string instead of
expression. a regular expression.
.It Fl H .It Fl H
Prefix each matching line with its filename in the output. This is the Prefix each matching line with its filename in the output. This is the
default when there is more than one file specified. default when there is more than one file specified.
@ -54,7 +54,8 @@ Prefix each matching line with its line number in the input.
.It Fl q .It Fl q
Print nothing, only return status. Print nothing, only return status.
.It Fl s .It Fl s
Suppress the error messages ordinarily written for nonexistent or unreadable files. Suppress the error messages ordinarily written for nonexistent or unreadable
files.
.It Fl v .It Fl v
Select lines which do Select lines which do
.Sy not .Sy not
@ -62,8 +63,9 @@ match the pattern.
.It Fl w .It Fl w
The expression is searched for as a word (as if surrounded by '\<' and '\>'). The expression is searched for as a word (as if surrounded by '\<' and '\>').
.It Fl x .It Fl x
Consider only input lines that use all characters in the line excluding the terminating <newline> to Consider only input lines that use all characters in the line excluding the
match an entire fixed string or regular expression to be matching lines. terminating <newline> to match an entire fixed string or regular expression to
be matching lines.
.El .El
.Sh EXIT STATUS .Sh EXIT STATUS
.Bl -tag -width Ds .Bl -tag -width Ds
@ -75,8 +77,8 @@ No lines were matched.
An error occurred. An error occurred.
.El .El
.Sh SEE ALSO .Sh SEE ALSO
.Xr regex 7 , .Xr sed 1 ,
.Xr sed 1 .Xr regex 7
.Sh STANDARDS .Sh STANDARDS
The The
.Nm .Nm

9
kill.1
View File

@ -22,9 +22,8 @@ by default sends a TERM signal to the given processes.
.Sh OPTIONS .Sh OPTIONS
.Bl -tag -width Ds .Bl -tag -width Ds
.It Fl s Ar signal_name .It Fl s Ar signal_name
A symbolic signal name specifying the signal to be sent instead A symbolic signal name specifying the signal to be sent instead of the
of the default SIGTERM. default SIGTERM. Sends the named signal.
Sends the named signal.
.It Fl l Op Ar exit_status .It Fl l Op Ar exit_status
Lists available signals. If an Lists available signals. If an
.Ar exit_status .Ar exit_status
@ -33,8 +32,8 @@ is given, only the corresponding signal name will be printed.
A symbolic signal name specifying the signal to be sent instead A symbolic signal name specifying the signal to be sent instead
of the default SIGTERM. of the default SIGTERM.
.It Fl signal_number .It Fl signal_number
A non-negative decimal integer specifying the signal to be sent A non-negative decimal integer specifying the signal to be sent instead of
instead of the default SIGTERM. the default SIGTERM.
.El .El
.Sh SEE ALSO .Sh SEE ALSO
.Xr kill 2 , .Xr kill 2 ,

4
ln.1
View File

@ -41,8 +41,8 @@ exists, remove it to allow the link.
.It Fl L | Fl P .It Fl L | Fl P
If If
.Ar target .Ar target
is a symbolic link, create a hard link to the (referenced file) | (symbolic link itself). is a symbolic link, create a hard link to the (referenced file) |
The former is the default. (symbolic link itself). The former is the default.
.It Fl s .It Fl s
Create symbolic links instead of hard links. Create symbolic links instead of hard links.
Disables Disables

View File

@ -20,8 +20,8 @@ system log module.
.It Fl i .It Fl i
Log the process ID of the logger process with each line. Log the process ID of the logger process with each line.
.It Fl p Ar priority .It Fl p Ar priority
Enter the message with the specified priority. They priority Enter the message with the specified priority. They priority has to be
has to be specified symbolically as specified symbolically as
.Dq facility.level .Dq facility.level
pair. The default is pair. The default is
.Dq user.notice . .Dq user.notice .
@ -31,12 +31,11 @@ Log the message to standard error, as well as the system log.
Mark every line in the log with the specified Mark every line in the log with the specified
.Ar tag . .Ar tag .
.It Ar message .It Ar message
Write the message to the log; if not specified, standard input Write the message to the log; if not specified, standard input is logged.
is logged.
.El .El
.Sh SEE ALSO .Sh SEE ALSO
.Xr syslog 3 , .Xr syslogd 1 ,
.Xr syslogd 1 .Xr syslog 3
.Sh STANDARDS .Sh STANDARDS
The The
.Nm .Nm

View File

@ -10,11 +10,11 @@
.Op Ar template .Op Ar template
.Sh DESCRIPTION .Sh DESCRIPTION
.Nm .Nm
takes the given filename template and overwrites a portion of it takes the given filename template and overwrites a portion of it to create a
to create a unique filename. The template may be any filename with at least unique filename. The template may be any filename with at least six `Xs'
six `Xs' appended to it. If no template is specified a default of appended to it. If no template is specified a default of `tmp.XXXXXXXXXX' is
`tmp.XXXXXXXXXX' is used and the tmpdir is set to `/tmp' unless the used and the tmpdir is set to `/tmp' unless the TMPDIR envrionment variable
TMPDIR envrionment variable has been set. has been set.
.Sh OPTIONS .Sh OPTIONS
.Bl -tag -width Ds .Bl -tag -width Ds
.It Fl d .It Fl d

4
nice.1
View File

@ -30,8 +30,8 @@ to
Default is 10. Default is 10.
.El .El
.Sh SEE ALSO .Sh SEE ALSO
.Xr renice 2 , .Xr nice 2 ,
.Xr nice 2 .Xr renice 2
.Sh STANDARDS .Sh STANDARDS
The The
.Nm .Nm

5
nl.1
View File

@ -14,8 +14,9 @@
.Nm .Nm
reads lines from the named reads lines from the named
.Ar file .Ar file
and writes them to stdout with non-empty lines and writes them to stdout with non-empty lines numbered. If no
numbered. If no file is given .Ar file
is given
.Nm .Nm
reads from stdin. reads from stdin.
.Sh OPTIONS .Sh OPTIONS

View File

@ -32,8 +32,8 @@ to
(lowest priority). (lowest priority).
.El .El
.Sh SEE ALSO .Sh SEE ALSO
.Xr renice 2 , .Xr nice 2 ,
.Xr nice 2 .Xr renice 2
.Sh STANDARDS .Sh STANDARDS
The The
.Nm .Nm

View File

@ -22,8 +22,8 @@ and its parents in the pathname
.El .El
.Sh SEE ALSO .Sh SEE ALSO
.Xr rm 1 , .Xr rm 1 ,
.Xr rmdir 2 ,
.Xr unlink 1 , .Xr unlink 1 ,
.Xr rmdir 2 ,
.Xr unlink 2 .Xr unlink 2
.Sh STANDARDS .Sh STANDARDS
The The

View File

@ -10,7 +10,11 @@
.Sh DESCRIPTION .Sh DESCRIPTION
.Nm .Nm
prints the printable character sequences that are at least 6 characters prints the printable character sequences that are at least 6 characters
long. If no files are given then it uses stdin. long. If no
.Ar files
are given,
.Nm
reads from stdin.
.Sh STANDARDS .Sh STANDARDS
.Nm .Nm
mirrors the semantics of Plan9 mirrors the semantics of Plan9

7
tail.1
View File

@ -10,8 +10,11 @@
.Op Ar file .Op Ar file
.Sh DESCRIPTION .Sh DESCRIPTION
.Nm .Nm
writes the last 10 lines of the file to stdout. If no file is given, tail reads writes the last 10 lines of the file to stdout. If no
from stdin. .Ar file
is given,
.Nm
reads from stdin.
.Sh OPTIONS .Sh OPTIONS
.Bl -tag -width Ds .Bl -tag -width Ds
.It Fl n Ar lines .It Fl n Ar lines

12
touch.1
View File

@ -11,23 +11,21 @@
.Ar file ... .Ar file ...
.Sh DESCRIPTION .Sh DESCRIPTION
.Nm .Nm
sets the access and modification times of files to the current time of day. If the file sets the access and modification times of files to the current time of day. If
doesn't exist, it is created with the default permissions. the file doesn't exist, it is created with the default permissions.
.Sh OPTIONS .Sh OPTIONS
.Bl -tag -width Ds .Bl -tag -width Ds
.It Fl a .It Fl a
Set the access time of the file. Set the access time of the file.
.It Fl c .It Fl c
Do not create the file it it does not exist. The exit Do not create the file it it does not exist. The exit status is not affected.
status is not affected.
.It Fl m .It Fl m
Change the modification time of the file. Change the modification time of the file.
.It Fl t Ar stamp .It Fl t Ar stamp
Set the timestamp to be used with Set the timestamp to be used with
.Op Fl am . .Op Fl am .
The format of the timestamp is simply the number of seconds The format of the timestamp is simply the number of seconds since Jan 1, 1970.
since Jan 1, 1970. This specification of time does not conform This specification of time does not conform to POSIX.
to POSIX.
.El .El
.Sh SEE ALSO .Sh SEE ALSO
.Xr date 1 .Xr date 1

2
tr.1
View File

@ -71,8 +71,8 @@ Input processed successfully.
An error occurred. An error occurred.
.El .El
.Sh SEE ALSO .Sh SEE ALSO
.Xr sed 1 ,
.Xr awk 1 , .Xr awk 1 ,
.Xr sed 1 ,
.Xr utf8 7 .Xr utf8 7
.Sh STANDARDS .Sh STANDARDS
The The

View File

@ -10,10 +10,9 @@
.Ar name .Ar name
.Sh DESCRIPTION .Sh DESCRIPTION
.Nm .Nm
reads file (or by default, the standard input) and writes an encoded reads file (or by default, the standard input) and writes an encoded version
version to the standard output. The encoding uses only printing ASCII to the standard output. The encoding uses only printing ASCII characters and
characters and includes the mode of the file and the operand name includes the mode of the file and the operand name for use by uudecode.
for use by uudecode.
.Sh IMPLEMENTATION NOTES .Sh IMPLEMENTATION NOTES
This version of uuencode does not currently support the base64 This version of uuencode does not currently support the base64
encoding algorithm. encoding algorithm.

8
wc.1
View File

@ -10,9 +10,13 @@
.Op Ar file ... .Op Ar file ...
.Sh DESCRIPTION .Sh DESCRIPTION
.Nm .Nm
.Pp
prints the number of lines, words, and bytes in each file. If any flags are prints the number of lines, words, and bytes in each file. If any flags are
given, wc will print only the requested information. If no files are given, wc given,
.Nm
will print only the requested information. If no
.Ar files
are given,
.Nm
reads stdin. reads stdin.
.Sh OPTIONS .Sh OPTIONS
.Bl -tag -width Ds .Bl -tag -width Ds