diff options
author | Jim Meyering <jim@meyering.net> | 2000-11-11 14:18:08 +0000 |
---|---|---|
committer | Jim Meyering <jim@meyering.net> | 2000-11-11 14:18:08 +0000 |
commit | 4f9389cf1ed7c4ad7b8da31707d0852ee1832680 (patch) | |
tree | 05dd66bf83917100d3ef4a03665b57a6736fb06a /doc | |
parent | 3ac192dc188e670b50bdc38370257e3c208b9331 (diff) | |
download | coreutils-4f9389cf1ed7c4ad7b8da31707d0852ee1832680.tar.xz |
More minor rewording and grammar correction.
From Brian Youmans.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/textutils.texi | 139 |
1 files changed, 73 insertions, 66 deletions
diff --git a/doc/textutils.texi b/doc/textutils.texi index e676fbdd1..8e1f845bb 100644 --- a/doc/textutils.texi +++ b/doc/textutils.texi @@ -692,19 +692,19 @@ to the output line generated by the type specification. @table @samp @item a -named character, +named character @item c @sc{ascii} character or backslash escape, @item d -signed decimal, +signed decimal @item f -floating point, +floating point @item o -octal, +octal @item u -unsigned decimal, +unsigned decimal @item x -hexadecimal. +hexadecimal @end table The type @code{a} outputs things like @samp{sp} for space, @samp{nl} for @@ -722,24 +722,24 @@ one of the following characters. For integers (@samp{d}, @samp{o}, @table @samp @item C -char, +char @item S -short, +short @item I -int, +int @item L -long. +long @end table For floating point (@code{f}): @table @asis @item F -float, +float @item D -double, +double @item L -long double. +long double @end table @item -v @@ -983,27 +983,35 @@ is @samp{space}). For multicolumn output, lines will always be truncated to column output no line truncation occurs by default. Use @samp{-W} option to truncate lines in that case. -@c FIXME:??? Should this be something like "Starting with version 1.22i,..." - Including version 1.22i: - +The following changes were made in version 1.22i and apply to later +versions of @command{pr}: @c FIXME: this whole section here sounds very awkward to me. I @c made a few small changes, but really it all needs to be redone. - Brian -Some small @var{letter options} (@samp{-s}, @samp{-w}) have been redefined -with the object of a better @sc{posix} compliance. The output of some -further cases has been adapted to other Unix systems. These changes are -not compatible with earlier versions of the program. +@c OK, I fixed another sentence or two, but some of it I just don't understand. +@ - Brian +@itemize @bullet + +@item +Some small @var{letter options} (@samp{-s}, @samp{-w}) have been +redefined for better @sc{posix} compliance. The output of some further +cases has been adapted to other Unix systems. These changes are not +compatible with earlier versions of the program. +@item Some @var{new capital letter} options (@samp{-J}, @samp{-S}, @samp{-W}) have been introduced to turn off unexpected interferences of small letter options. The @samp{-N} option and the second argument @var{last_page} of @samp{+FIRST_PAGE} offer more flexibility. The detailed handling of form feeds set in the input files requires the @samp{-T} option. +@item Capital letter options override small letter ones. +@item Some of the option-arguments (compare @samp{-s}, @samp{-S}, @samp{-e}, @samp{-i}, @samp{-n}) cannot be specified as separate arguments from the preceding option letter (already stated in the @sc{posix} specification). +@end itemize The program accepts the following options. Also see @ref{Common options}. @@ -1194,12 +1202,12 @@ opened. (The exit status will still be nonzero, however.) @itemx --separator[=@var{char}] @opindex -s @opindex --separator -Separate columns by a single character @var{char}. Default for @var{char} -is the TAB character without @samp{-w} and @samp{no character} with -@samp{-w}. Without @samp{-s} default separator @samp{space} is set. -@samp{-s[char]} turns off line truncation of all three column options -(@samp{-COLUMN}|@samp{-a -COLUMN}|@samp{-m}) except @samp{-w} is set. -That is a @sc{posix}-compliant formulation. +Separate columns by a single character @var{char}. The default for +@var{char} is the TAB character without @samp{-w} and @samp{no +character} with @samp{-w}. Without @samp{-s} the default separator +@samp{space} is set. @samp{-s[char]} turns off line truncation of all +three column options (@samp{-COLUMN}|@samp{-a -COLUMN}|@samp{-m}) unless +@samp{-w} is set. This is a @sc{posix}-compliant formulation. @item -S[@var{string}] @@ -1702,9 +1710,9 @@ exhausted. The output files' names consist of a prefix (@samp{xx} by default) followed by a suffix. By default, the suffix is an ascending sequence -of two-digit decimal numbers from @samp{00} and up to @samp{99}. In any -case, concatenating the output files in sorted order by filename -produces the original input file. +of two-digit decimal numbers from @samp{00} to @samp{99}. In any case, +concatenating the output files in sorted order by filename produces the +original input file. By default, if @code{csplit} encounters an error or receives a hangup, interrupt, quit, or terminate signal, it removes any output files @@ -1821,9 +1829,9 @@ in columns. However, @sc{posix} requires that there be exactly one space separating columns. You can make @code{wc} use the @sc{posix}-mandated output format by setting the @env{POSIXLY_CORRECT} environment variable. -By default, @code{wc} prints three counts: the newline, words, byte counts. -Options can specify that only certain counts be printed. Options do not -undo others previously given, so +By default, @code{wc} prints three counts: the newline, words, and byte +counts. Options can specify that only certain counts be printed. +Options do not undo others previously given, so @example wc --bytes --words @@ -1890,7 +1898,7 @@ sum [@var{option}]@dots{} [@var{file}]@dots{} @code{sum} prints the checksum for each @var{file} followed by the number of blocks in the file (rounded up). If more than one @var{file} is given, file names are also printed (by default). (With the -@samp{--sysv} option, corresponding file name are printed when there is +@samp{--sysv} option, corresponding file names are printed when there is at least one file argument.) By default, GNU @code{sum} computes checksums using an algorithm @@ -2389,7 +2397,7 @@ sort -t : -k 2,2n -k 5.3,5.4 @end example Note that if you had written @samp{-k 2} instead of @samp{-k 2,2} -@samp{sort} would have used all characters beginning in the second field +@command{sort} would have used all characters beginning in the second field and extending to the end of the line as the primary @emph{numeric} key. For the large majority of applications, treating keys spanning more than one field as numeric will not do what you expect. @@ -2799,8 +2807,8 @@ is ignored. The file is called the @dfn{Only file}. The file contains exactly one word in each line; the end of line separation of words is not subject to the value of the @samp{-S} option. -There is no default for the Only file. In the case there are both an -Only file and an Ignore file, a word can be a keyword only if it is +There is no default for the Only file. In the case where there are both +an Only file and an Ignore file, a word can be a keyword only if it is given in the Only file and not given in the Ignore file. @item -r @@ -2915,13 +2923,13 @@ output line. @item -w @var{number} @itemx --width=@var{number} -Select the output maximum width of each final line. If references are -used, they are included or excluded from the output maximum width +Select the maximum output width of each final line. If references are +used, they are included or excluded from the maximum output width depending on the value of option @samp{-R}. If this option is not selected, that is, when references are output before the left context, -the output maximum width takes into account the maximum length of all +the maximum output width takes into account the maximum length of all references. If this option is selected, that is, when references are -output after the right context, the output maximum width does not take +output after the right context, the maximum output width does not take into account the space taken by references, nor the gap that precedes them. @@ -2938,15 +2946,14 @@ reference is used at output time, overriding the input reference. @item -R @itemx --right-side-refs -In default output format, when option @samp{-R} is not used, any -reference produced by the effect of options @samp{-r} or @samp{-A} are -given to the far right of output lines, after the right context. In -default output format, when option @samp{-R} is specified, references -are rather given to the beginning of each output line, before the left -context. For any other output format, option @samp{-R} is almost -ignored, except for the fact that the width of references is @emph{not} -taken into account in total output width given by @samp{-w} whenever -@samp{-R} is selected. +In the default output format, when option @samp{-R} is not used, any +references produced by the effect of options @samp{-r} or @samp{-A} are +placed to the far right of output lines, after the right context. With +default output format, when the @samp{-R} option is specified, references +are rather placed at the beginning of each output line, before the left +context. For any other output format, option @samp{-R} is +ignored, with one exception: with @samp{-R} the width of references +is @emph{not} taken into account in total output width given by @samp{-w}. This option is automatically selected whenever GNU extensions are disabled. @@ -2991,7 +2998,7 @@ processing. Each output line will look like: so it will be possible to write a @samp{.xx} roff macro to take care of the output typesetting. This is the default output format when GNU -extensions are disabled. Option @samp{-M} might be used to change +extensions are disabled. Option @samp{-M} can be used to change @samp{xx} to another macro name. In this output format, each non-graphical character, like newline and @@ -3014,22 +3021,22 @@ so it will be possible to write a @code{\xx} definition to take care of the output typesetting. Note that when references are not being produced, that is, neither option @samp{-A} nor option @samp{-r} is selected, the last parameter of each @code{\xx} call is inhibited. -Option @samp{-M} might be used to change @samp{xx} to another macro +Option @samp{-M} can be used to change @samp{xx} to another macro name. In this output format, some special characters, like @kbd{$}, @kbd{%}, @kbd{&}, @kbd{#} and @kbd{_} are automatically protected with a -backslash. Curly brackets @kbd{@{}, @kbd{@}} are also protected with a -backslash, but also enclosed in a pair of dollar signs to force -mathematical mode. The backslash itself produces the sequence -@code{\backslash@{@}}. Circumflex and tilde diacritics produce the -sequence @code{^\@{ @}} and @code{~\@{ @}} respectively. Other -diacriticized characters of the underlying character set produce an -appropriate @TeX{} sequence as far as possible. The other non-graphical -characters, like newline and tab, and all others characters which are -not part of @sc{ascii}, are merely changed to exactly one space, with no -special attempt to compress consecutive spaces. Let me know how to -improve this special character processing for @TeX{}. +backslash. Curly brackets @kbd{@{}, @kbd{@}} are protected with a +backslash and a pair of dollar signs (to force mathematical mode). The +backslash itself produces the sequence @code{\backslash@{@}}. +Circumflex and tilde diacritics produce the sequence @code{^\@{ @}} and +@code{~\@{ @}} respectively. Other diacriticized characters of the +underlying character set produce an appropriate @TeX{} sequence as far +as possible. The other non-graphical characters, like newline and tab, +and all other characters which are not part of @sc{ascii}, are merely +changed to exactly one space, with no special attempt to compress +consecutive spaces. Let me know how to improve this special character +processing for @TeX{}. @end table @@ -3048,12 +3055,12 @@ Here are the differences between this program and System V @code{ptx}. @item This program can read many input files at once, it always writes the -resulting concordance on standard output. On the other end, System V -@code{ptx} reads only one file and produce the result on standard output +resulting concordance on standard output. On the other hand, System V +@code{ptx} reads only one file and sends the result to standard output or, if a second @var{file} parameter is given on the command, to that @var{file}. -Having output parameters not introduced by options is a quite dangerous +Having output parameters not introduced by options is a dangerous practice which GNU avoids as far as possible. So, for using @code{ptx} portably between GNU and System V, you should always use it with a single input file, and always expect the result on standard output. You @@ -3134,7 +3141,7 @@ cut [@var{option}]@dots{} [@var{file}]@dots{} In the table which follows, the @var{byte-list}, @var{character-list}, and @var{field-list} are one or more numbers or ranges (two numbers separated by a dash) separated by commas. Bytes, characters, and -fields are numbered from starting at 1. Incomplete ranges may be +fields are numbered starting at 1. Incomplete ranges may be given: @samp{-@var{m}} means @samp{1-@var{m}}; @samp{@var{n}-} means @samp{@var{n}} through end of line or last field. |