commit f769c2402f4f15c3d721bce6d1cf38fd891cace1
parent 4a920a5960a6c12b5c95c902c79a4e27fae921b4
Author: Hiltjo Posthuma <hiltjo@codemadness.org>
Date: Sat, 31 Jan 2015 14:43:27 +0100
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.
Diffstat:
23 files changed, 97 insertions(+), 83 deletions(-)
diff --git a/chgrp.1 b/chgrp.1
@@ -21,8 +21,8 @@ flag is specified, this process is recursively applied to
everything in
.Ar file .
.Sh SEE ALSO
-.Xr chown 1 ,
-.Xr chown 2 ,
.Xr chmod 1 ,
+.Xr chown 1 ,
.Xr chmod 2 ,
+.Xr chown 2 ,
.Xr getgrnam 3
diff --git a/cols.1 b/cols.1
@@ -10,21 +10,29 @@
.Op Ar file ...
.Sh DESCRIPTION
.Nm
-reads each file in sequence and writes them to stdout,
-in as many vertical columns as will fit in
+reads each file in sequence and writes them to stdout, in as many vertical
+columns as will fit in
.Ar chars
-character columns.
-If no file is given, cols reads from stdin.
+character columns. If no
+.Ar file
+is given,
+.Nm
+reads from stdin.
.Sh OPTIONS
.Bl -tag -width xxxxxxxx
.It Fl c Ar chars
Specifies the maximum number of character columns to use
(unless the input contains lines longer than
.Ar chars
-characters). By default cols tries to figure out the width
-of the output device, if that fails it defaults to 65
-chars.
+characters). By default cols tries to figure out the width of the output
+device, if that fails it defaults to 65 chars.
.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
This implementation of
.Nm
@@ -33,9 +41,3 @@ and thus mishandles TAB characters (among others).
.Pp
.Nm
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.
diff --git a/cp.1 b/cp.1
@@ -15,7 +15,7 @@
.Op Ar directory
.Sh DESCRIPTION
.Nm
-copies a given file, naming it the given name. If multiple files are listed
+copies a given file, naming it the given name. If multiple files are listed
they will be copied into the given directory.
.Sh OPTIONS
.Bl -tag -width Ds
@@ -34,8 +34,8 @@ if an existing destination file cannot be opened, remove it and try again.
.It Fl R
equivalent to -r.
.It Fl r
-copies directories recursively. If this flag is not specified, directories are
-not copied.
+copies directories recursively. If this flag is not specified, directories
+are not copied.
.It Fl v
print names of source and destination per file to stdout. In the format:
"source \-> destination".
diff --git a/cut.1 b/cut.1
@@ -67,5 +67,5 @@ utility is compliant with the
.St -p1003.1-2008
specification.
.Pp
-The possibility of separating numbers and ranges with a space
-and specifying multibyte delimiters of arbitrary length is an extension to that specification.
+The possibility of separating numbers and ranges with a space and specifying
+multibyte delimiters of arbitrary length is an extension to that specification.
diff --git a/du.1 b/du.1
@@ -15,9 +15,11 @@
.Nm
displays the file system block usage for each
.Ar file
-argument and for each directory in the file hierarchy rooted in directory argument.
-If no file is specified, the block usage of the hierarchy rooted in the current
-directory is displayed.
+argument and for each directory in the file hierarchy rooted in directory
+argument. If no
+.Ar file
+is specified, the block usage of the hierarchy rooted in the current directory
+is displayed.
.Sh OPTIONS
.Bl -tag -width Ds
.It Fl a
diff --git a/expand.1 b/expand.1
@@ -37,8 +37,8 @@ The default
is "8".
.El
.Sh SEE ALSO
-.Xr unexpand 1 ,
-.Xr fold 1
+.Xr fold 1 ,
+.Xr unexpand 1
.Sh STANDARDS
The
.Nm
diff --git a/expr.1 b/expr.1
@@ -76,7 +76,8 @@ against
is anchored with an implicit '^'.
.Pp
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
.Sh EXIT STATUS
.Bl -tag -width Ds
diff --git a/grep.1 b/grep.1
@@ -17,7 +17,7 @@ searches the input files for lines that match the
.Ar pattern ,
a regular expression as defined in
.Xr regex 7 .
-By default each matching line is printed to stdout. If no file is given
+By default each matching line is printed to stdout. If no file is given
.Nm
reads from stdin.
.Sh OPTIONS
@@ -25,8 +25,8 @@ reads from stdin.
.It Fl E
Match using extended regex.
.It Fl F
-Match using fixed strings. Treat each pattern specified as a string instead of a regular
-expression.
+Match using fixed strings. Treat each pattern specified as a string instead of
+a regular expression.
.It Fl H
Prefix each matching line with its filename in the output. This is the
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
Print nothing, only return status.
.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
Select lines which do
.Sy not
@@ -62,8 +63,9 @@ match the pattern.
.It Fl w
The expression is searched for as a word (as if surrounded by '\<' and '\>').
.It Fl x
-Consider only input lines that use all characters in the line excluding the terminating <newline> to
-match an entire fixed string or regular expression to be matching lines.
+Consider only input lines that use all characters in the line excluding the
+terminating <newline> to match an entire fixed string or regular expression to
+be matching lines.
.El
.Sh EXIT STATUS
.Bl -tag -width Ds
@@ -75,8 +77,8 @@ No lines were matched.
An error occurred.
.El
.Sh SEE ALSO
-.Xr regex 7 ,
-.Xr sed 1
+.Xr sed 1 ,
+.Xr regex 7
.Sh STANDARDS
The
.Nm
diff --git a/kill.1 b/kill.1
@@ -22,19 +22,18 @@ by default sends a TERM signal to the given processes.
.Sh OPTIONS
.Bl -tag -width Ds
.It Fl s Ar signal_name
-A symbolic signal name specifying the signal to be sent instead
-of the default SIGTERM.
-Sends the named signal.
+A symbolic signal name specifying the signal to be sent instead of the
+default SIGTERM. Sends the named signal.
.It Fl l Op Ar exit_status
-Lists available signals. If an
+Lists available signals. If an
.Ar exit_status
is given, only the corresponding signal name will be printed.
.It Fl signal_name
A symbolic signal name specifying the signal to be sent instead
of the default SIGTERM.
.It Fl signal_number
-A non-negative decimal integer specifying the signal to be sent
-instead of the default SIGTERM.
+A non-negative decimal integer specifying the signal to be sent instead of
+the default SIGTERM.
.El
.Sh SEE ALSO
.Xr kill 2 ,
diff --git a/ln.1 b/ln.1
@@ -41,8 +41,8 @@ exists, remove it to allow the link.
.It Fl L | Fl P
If
.Ar target
-is a symbolic link, create a hard link to the (referenced file) | (symbolic link itself).
-The former is the default.
+is a symbolic link, create a hard link to the (referenced file) |
+(symbolic link itself). The former is the default.
.It Fl s
Create symbolic links instead of hard links.
Disables
diff --git a/logger.1 b/logger.1
@@ -20,10 +20,10 @@ system log module.
.It Fl i
Log the process ID of the logger process with each line.
.It Fl p Ar priority
-Enter the message with the specified priority. They priority
-has to be specified symbolically as
+Enter the message with the specified priority. They priority has to be
+specified symbolically as
.Dq facility.level
-pair. The default is
+pair. The default is
.Dq user.notice .
.It Fl s
Log the message to standard error, as well as the system log.
@@ -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
.Ar tag .
.It Ar message
-Write the message to the log; if not specified, standard input
-is logged.
+Write the message to the log; if not specified, standard input is logged.
.El
.Sh SEE ALSO
-.Xr syslog 3 ,
-.Xr syslogd 1
+.Xr syslogd 1 ,
+.Xr syslog 3
.Sh STANDARDS
The
.Nm
diff --git a/ls.1 b/ls.1
@@ -10,7 +10,7 @@
.Op Ar file ...
.Sh DESCRIPTION
.Nm
-lists each given file, and the contents of each given directory. If no files
+lists each given file, and the contents of each given directory. If no files
are given the current directory is listed.
.Sh OPTIONS
.Bl -tag -width Ds
diff --git a/mktemp.1 b/mktemp.1
@@ -10,17 +10,17 @@
.Op Ar template
.Sh DESCRIPTION
.Nm
-takes the given filename template and overwrites a portion of it
-to create a unique filename. The template may be any filename with at least
-six `Xs' appended to it. If no template is specified a default of
-`tmp.XXXXXXXXXX' is used and the tmpdir is set to `/tmp' unless the
-TMPDIR envrionment variable has been set.
+takes the given filename template and overwrites a portion of it to create a
+unique filename. The template may be any filename with at least six `Xs'
+appended to it. If no template is specified a default of `tmp.XXXXXXXXXX' is
+used and the tmpdir is set to `/tmp' unless the TMPDIR envrionment variable
+has been set.
.Sh OPTIONS
.Bl -tag -width Ds
.It Fl d
Make a directory instead of a file
.It Fl q
-Fail silently if an error occurs. This is useful if a script
+Fail silently if an error occurs. This is useful if a script
does not want error output to go to standard error.
.El
.Sh SEE ALSO
diff --git a/nice.1 b/nice.1
@@ -30,8 +30,8 @@ to
Default is 10.
.El
.Sh SEE ALSO
-.Xr renice 2 ,
-.Xr nice 2
+.Xr nice 2 ,
+.Xr renice 2
.Sh STANDARDS
The
.Nm
diff --git a/nl.1 b/nl.1
@@ -14,8 +14,9 @@
.Nm
reads lines from the named
.Ar file
-and writes them to stdout with non-empty lines
-numbered. If no file is given
+and writes them to stdout with non-empty lines numbered. If no
+.Ar file
+is given
.Nm
reads from stdin.
.Sh OPTIONS
@@ -38,7 +39,7 @@ a regular expression as defined in
.It Fl i Ar incr
Defines the increment between numbered lines.
.It Fl s Ar sep
-Defines the string used to separate line numbers and lines. By default this is
+Defines the string used to separate line numbers and lines. By default this is
a tab.
.El
.Sh SEE ALSO
diff --git a/renice.1 b/renice.1
@@ -32,8 +32,8 @@ to
(lowest priority).
.El
.Sh SEE ALSO
-.Xr renice 2 ,
-.Xr nice 2
+.Xr nice 2 ,
+.Xr renice 2
.Sh STANDARDS
The
.Nm
diff --git a/rmdir.1 b/rmdir.1
@@ -22,8 +22,8 @@ and its parents in the pathname
.El
.Sh SEE ALSO
.Xr rm 1 ,
-.Xr rmdir 2 ,
.Xr unlink 1 ,
+.Xr rmdir 2 ,
.Xr unlink 2
.Sh STANDARDS
The
diff --git a/strings.1 b/strings.1
@@ -10,7 +10,11 @@
.Sh DESCRIPTION
.Nm
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
.Nm
mirrors the semantics of Plan9
diff --git a/tail.1 b/tail.1
@@ -10,12 +10,15 @@
.Op Ar file
.Sh DESCRIPTION
.Nm
-writes the last 10 lines of the file to stdout. If no file is given, tail reads
-from stdin.
+writes the last 10 lines of the file to stdout. If no
+.Ar file
+is given,
+.Nm
+reads from stdin.
.Sh OPTIONS
.Bl -tag -width Ds
.It Fl n Ar lines
-outputs the given number of lines. If
+outputs the given number of lines. If
.Ar lines
begins with '+' it is used as an offset from the beginning of the file.
.El
diff --git a/touch.1 b/touch.1
@@ -11,23 +11,21 @@
.Ar file ...
.Sh DESCRIPTION
.Nm
-sets the access and modification times of files to the current time of day. If the file
-doesn't exist, it is created with the default permissions.
+sets the access and modification times of files to the current time of day. If
+the file doesn't exist, it is created with the default permissions.
.Sh OPTIONS
.Bl -tag -width Ds
.It Fl a
Set the access time of the file.
.It Fl c
-Do not create the file it it does not exist. The exit
-status is not affected.
+Do not create the file it it does not exist. The exit status is not affected.
.It Fl m
Change the modification time of the file.
.It Fl t Ar stamp
Set the timestamp to be used with
.Op Fl am .
-The format of the timestamp is simply the number of seconds
-since Jan 1, 1970. This specification of time does not conform
-to POSIX.
+The format of the timestamp is simply the number of seconds since Jan 1, 1970.
+This specification of time does not conform to POSIX.
.El
.Sh SEE ALSO
.Xr date 1
diff --git a/tr.1 b/tr.1
@@ -71,8 +71,8 @@ Input processed successfully.
An error occurred.
.El
.Sh SEE ALSO
-.Xr sed 1 ,
.Xr awk 1 ,
+.Xr sed 1 ,
.Xr utf8 7
.Sh STANDARDS
The
diff --git a/uuencode.1 b/uuencode.1
@@ -10,10 +10,9 @@
.Ar name
.Sh DESCRIPTION
.Nm
-reads file (or by default, the standard input) and writes an encoded
-version to the standard output. The encoding uses only printing ASCII
-characters and includes the mode of the file and the operand name
-for use by uudecode.
+reads file (or by default, the standard input) and writes an encoded version
+to the standard output. The encoding uses only printing ASCII characters and
+includes the mode of the file and the operand name for use by uudecode.
.Sh IMPLEMENTATION NOTES
This version of uuencode does not currently support the base64
encoding algorithm.
diff --git a/wc.1 b/wc.1
@@ -10,9 +10,13 @@
.Op Ar file ...
.Sh DESCRIPTION
.Nm
-.Pp
-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
+prints the number of lines, words, and bytes in each file. If any flags are
+given,
+.Nm
+will print only the requested information. If no
+.Ar files
+are given,
+.Nm
reads stdin.
.Sh OPTIONS
.Bl -tag -width Ds
