]> git.ipfire.org Git - thirdparty/util-linux.git/commitdiff
docs: tweak the formatting and wording of some text-utils man pages
authorBenno Schulenberg <bensberg@justemail.net>
Thu, 25 Aug 2011 20:26:13 +0000 (22:26 +0200)
committerKarel Zak <kzak@redhat.com>
Mon, 29 Aug 2011 09:24:41 +0000 (11:24 +0200)
Highlight the program name, use proper lowercase, remove
unneeded commas and articles, and add helpful hyphenation.

Signed-off-by: Benno Schulenberg <bensberg@justemail.net>
text-utils/col.1
text-utils/colcrt.1
text-utils/colrm.1
text-utils/hexdump.1
text-utils/more.1
text-utils/rev.1
text-utils/ul.1

index 7f3e41344b2755b86271bc1ff91bd9a6ecf44373..bbec8feeee8743d26799ad1f61f448ce357c6f08 100644 (file)
 .Op Fl bfphx
 .Op Fl l Ar num
 .Sh DESCRIPTION
-.Nm Col
-filters out reverse (and half reverse) line feeds so the output is
-in the correct order with only forward and half forward line
+.Nm
+filters out reverse (and half-reverse) line feeds so the output is
+in the correct order with only forward and half-forward line
 feeds, and replaces white-space characters with tabs where possible.
 This can be useful in processing the output of
 .Xr nroff 1
 and
 .Xr tbl  1 .
 .Pp
-.Nm Col
+.Nm
 reads from standard input and writes to standard output.
 .Pp
 The options are as follows:
@@ -64,7 +64,7 @@ Do not output any backspaces, printing only the last character
 written to each column position.
 .It Fl f, Fl Fl fine
 Forward half line feeds are permitted (``fine'' mode).
-Normally characters printed on a half line boundary are printed
+Normally characters printed on a half-line boundary are printed
 on the following line.
 .It Fl p, Fl Fl pass
 Force unknown control sequences to be passed through unchanged.
@@ -120,7 +120,7 @@ reverse line feed (11)
 All unrecognized control characters and escape sequences are
 discarded.
 .Pp
-.Nm Col
+.Nm
 keeps track of the character set as characters are read and makes
 sure the character set is correct when they are output.
 .Pp
index b7650c6a75e20146e9ab5cd5387c4101640bedee..fb4535bf4b65c75a009fbb1b7dff042075cb25fa 100644 (file)
@@ -43,7 +43,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.
index f81e363d1a38e382cbca33b23351bb8de926a16e..3bc214da7cb8154db02c7b4832fbb6376739144c 100644 (file)
@@ -41,7 +41,7 @@
 .Nm colrm
 .Op Ar startcol Op Ar endcol
 .Sh DESCRIPTION
-.Nm Colrm
+.Nm
 removes selected columns from a file.  Input is taken from standard input.
 Output is sent to standard output.
 .Pp
index 4ae6565704a850c378db170a1da986c60dd41580..ce783c1c5ada8d6132eb8e49db3c699737b891f1 100644 (file)
@@ -36,7 +36,7 @@
 .Os util-linux
 .Sh NAME
 .Nm hexdump
-.Nd ascii, decimal, hexadecimal, octal dump
+.Nd display file contents in ascii, decimal, hexadecimal, or octal
 .Sh SYNOPSIS
 .Nm
 .Op Fl bcCdovx
 .Ek
 .Ar file ...
 .Sh DESCRIPTION
-The hexdump utility is a filter which displays the specified files, or
-the standard input, if no files are specified, in a user specified
+The
+.Nm
+utility is a filter which displays the specified files, or
+standard input if no files are specified, in a user-specified
 format.
 .Pp
 The options are as follows:
@@ -63,22 +65,22 @@ The options are as follows:
 .It Fl b
 .Em One-byte octal display .
 Display the input offset in hexadecimal, followed by sixteen
-space-separated, three column, zero-filled, bytes of input data,
+space-separated, three-column, zero-filled bytes of input data,
 in octal, per line.
 .It Fl c
 .Em One-byte character display .
 Display the input offset in hexadecimal, followed by sixteen
-space-separated, three column, space-filled, characters of input
+space-separated, three-column, space-filled characters of input
 data per line.
 .It Fl C
 .Em Canonical hex+ASCII display .
 Display the input offset in hexadecimal, followed by sixteen
-space-separated, two column, hexadecimal bytes, followed by the
+space-separated, two-column, hexadecimal bytes, followed by the
 same sixteen bytes in %_p format enclosed in ``|'' characters.
 .It Fl d
 .Em Two-byte decimal display .
 Display the input offset in hexadecimal, followed by eight
-space-separated, five column, zero-filled, two-byte units
+space-separated, five-column, zero-filled, two-byte units
 of input data, in unsigned decimal, per line.
 .It Fl e Ar format_string
 Specify a format string to be used for displaying data.
@@ -94,7 +96,7 @@ bytes of input.
 .It Fl o
 .Em Two-byte octal display .
 Display the input offset in hexadecimal, followed by eight
-space-separated, six column, zero-filled, two byte quantities of
+space-separated, six-column, zero-filled, two-byte quantities of
 input data, in octal, per line.
 .It Fl s Ar offset
 Skip
@@ -129,18 +131,20 @@ respectively.
 .It Fl v
 The
 .Fl v
-option causes hexdump to display all input data.
+option causes
+.Nm
+to display all input data.
 Without the
 .Fl v
-option, any number of groups of output lines, which would be
+option, any number of groups of output lines which would be
 identical to the immediately preceding group of output lines (except
 for the input offsets), are replaced with a line comprised of a
 single asterisk.
 .It Fl x
 .Em Two-byte hexadecimal display .
-Display the input offset in hexadecimal, followed by eight, space
-separated, four column, zero-filled, two-byte quantities of input
-data, in hexadecimal, per line.
+Display the input offset in hexadecimal, followed by eight
+space-separated, four-column, zero-filled, two-byte quantities of
+input data, in hexadecimal, per line.
 .El
 .Pp
 For each input file,
@@ -206,7 +210,9 @@ described in the C standard are supported:
 .Ed
 .El
 .Pp
-Hexdump also supports the following additional conversion strings:
+The
+.Nm
+utility also supports the following additional conversion strings:
 .Bl -tag -width Fl
 .It Cm \&_a Ns Op Cm dox
 Display the input offset, cumulative across input files, of the
@@ -225,10 +231,10 @@ conversion string except that it is only performed
 once, when all of the input data has been processed.
 .It Cm \&_c
 Output characters in the default character set.
-Nonprinting characters are displayed in three character, zero-padded
+Nonprinting characters are displayed in three-character, zero-padded
 octal, except for those representable by standard escape notation
 (see above),
-which are displayed as two character strings.
+which are displayed as two-character strings.
 .It Cm _p
 Output characters in the default character set.
 Nonprinting characters are displayed as a single
@@ -278,8 +284,9 @@ not have a specified iteration count, have the iteration count
 incremented until the entire input block has been processed or there
 is not enough data remaining in the block to satisfy the format string.
 .Pp
-If, either as a result of user specification or hexdump modifying
-the iteration count as described above, an iteration count is
+If, either as a result of user specification or
+.Nm
+modifying the iteration count as described above, an iteration count is
 greater than one, no trailing whitespace characters are output
 during the last iteration.
 .Pp
index 1ef71ec3a16b5693d8aa38a7f6ae661d6f6b3b8d..480b5580a018badb25c87a94c2a8bf5929b3ccb9 100644 (file)
 .Op +\fIlinenum\fP
 .Op Ar
 .Sh DESCRIPTION
-.Nm More
+.Nm
 is a filter for paging through text one screenful at a time.  This version
 is especially primitive.  Users should realize that
 .Xr less 1
 provides
 .Xr more 1
-emulation and extensive enhancements.
+emulation plus extensive enhancements.
 .Sh OPTIONS
-Command line options are described below.
+Command-line options are described below.
 Options are also taken from the environment variable
 .Ev MORE
 (make sure to precede them with a dash (``-'')) but command
@@ -88,7 +88,8 @@ folded).
 .It Fl p
 Do not scroll.  Instead, clear the whole screen and then display the text.
 .Pp
-Notice that this option is switched automatically on if executable is named to `page'.
+Notice that this option is switched on automatically if the executable is named
+.Nm page .
 .It Fl c
 Do not scroll.  Instead, paint each screen from the top, clearing the
 remainder of each line as it is displayed.
index 6ae4a86366c47c19b370764392be9ce887ce713d..f8850e0884ee8970f80073e093de4c12918596dd 100644 (file)
@@ -47,9 +47,9 @@
 .Sh DESCRIPTION
 The
 .Nm rev
-utility copies the specified files to the standard output, reversing the
+utility copies the specified files to standard output, reversing the
 order of characters in every line.
-If no files are specified, the standard input is read.
+If no files are specified, standard input is read.
 .Bl -tag -width Ds
 .It Fl V, Fl Fl version
 Output version information and exit.
index 5827bf746859918ae5a56dc0faa9b679ba9d4441..dd1764e1e0b90b003133f13a026fc954c112fd0b 100644 (file)
@@ -52,8 +52,8 @@ by the environment variable
 The
 .Pa terminfo
 database is read to determine the appropriate sequences for underlining.
-If the terminal is incapable of underlining, but is capable of
-a standout mode then that is used instead.
+If the terminal is incapable of underlining but is capable of
+a standout mode, then that is used instead.
 If the terminal can overstrike,
 or handles underlining automatically,
 .Nm ul