forked from bonsai/harakit
fop.1: removes Unicode representation of RS; hru.1: removes erroneous line break; mm.1: formatting & grammar; npc.1: dollar sign, not currency sign; rpn.1: syntax error; scrut.1: move description to DESCRIPTION; str.1: comma; swab.1: wording & escape codes; true.1: formatting
This commit is contained in:
parent
526185c2c3
commit
8ce7890124
@ -24,7 +24,8 @@ Performs operations on specified fields in input data.
|
||||
|
||||
.IP \fB-d\fP
|
||||
Sets a delimiter by which the input data will be split into fields. The default
|
||||
is an ASCII record separator (␞).
|
||||
is an ASCII record separator.
|
||||
.\"
|
||||
.SH STANDARD INPUT
|
||||
|
||||
Data will be read from the standard input.
|
||||
|
@ -34,8 +34,8 @@ and print an error message.
|
||||
The GNU project\(cqs
|
||||
.BR ls (1)
|
||||
implementation contains a human-readable option (\fB-h\fP) that, when specified,
|
||||
makes the tool print size information in a format more immediately readable.
|
||||
This functionality is useful not only in the context of
|
||||
makes the tool print size information in a format more immediately
|
||||
readable. This functionality is useful not only in the context of
|
||||
.BR ls (1)
|
||||
so the decision was made to split it into a new tool. The original functionality
|
||||
in GNU\(cqs
|
||||
|
17
docs/mm.1
17
docs/mm.1
@ -27,13 +27,11 @@ Opens subsequent outputs for appending rather than updating.
|
||||
.IP \fB-e\fP
|
||||
Use the standard error as an output.
|
||||
.IP \fB-i\fP
|
||||
Opens a path as an input. Without any inputs specified mm will use the
|
||||
standard input. The standard input shall be used as an input if one or more of
|
||||
the input files is \(lq-\(rq.
|
||||
Opens a path as an input. If one or more of the input files is \(lq-\(rq or if
|
||||
no inputs are specified, the standard input shall be used.
|
||||
.IP \fB-o\fP
|
||||
Opens a path as an output. Without any outputs specified mm will use the
|
||||
standard output. The standard output shall be used as an output if one or more
|
||||
of the output files is \(lq-\(rq.
|
||||
Opens a path as an output. If one or more of the output files is \(lq-\(rq or if
|
||||
no outputs are specified, the standard output shall be used.
|
||||
.IP \fB-u\fP
|
||||
Ensures neither input or output will be buffered.
|
||||
.IP \fB-n\fP
|
||||
@ -41,11 +39,10 @@ Causes SIGINT signals to be ignored.
|
||||
.\"
|
||||
.SH DIAGNOSTICS
|
||||
|
||||
If an output can no longer be written mm prints a diagnostic message, ceases
|
||||
writing to that particular output, and if there are more outputs specified,
|
||||
continues, eventually exiting unsuccessfully.
|
||||
If an output cannot be written to, an error occurs. Additional outputs are not
|
||||
affected and writing to them continues.
|
||||
|
||||
When an error is encountered, diagnostic message is printed and the program
|
||||
When an error is encountered, a diagnostic message is printed and the program
|
||||
exits with the appropriate
|
||||
.BR sysexits.h (3)
|
||||
status.
|
||||
|
@ -28,7 +28,7 @@ high bit set.
|
||||
.SH USAGE
|
||||
|
||||
.IP \fB-e\fP
|
||||
Prints a currency sign ('$') before each line ending.
|
||||
Prints a dollar sign ('$') before each line ending.
|
||||
.IP \fB-t\fP
|
||||
Prints tab characters as '^I' rather than a literal horizontal tab.
|
||||
.\"
|
||||
|
@ -37,12 +37,11 @@ the standard input.
|
||||
.\"
|
||||
.SH DIAGNOSTICS
|
||||
|
||||
In the event of a syntax error, the program will print an
|
||||
|
||||
In the event of an error, a debug message will be printed and the program will
|
||||
exit with the appropriate
|
||||
.BR sysexits.h (3)
|
||||
error code.
|
||||
error code; however, in the event of a syntax error, the program will print an
|
||||
error message and continue accepting input.
|
||||
.\"
|
||||
.SH CAVEATS
|
||||
|
||||
|
@ -15,7 +15,9 @@ scrut
|
||||
.\"
|
||||
.SH DESCRIPTION
|
||||
|
||||
Determine if files comply with requirements.
|
||||
Determine if files comply with requirements. If the given files comply with the
|
||||
specified requirements, the program will exit successfully. Otherwise, it exits
|
||||
unsuccessfully.
|
||||
.\"
|
||||
.SH OPTIONS
|
||||
|
||||
@ -50,9 +52,6 @@ Requires the given files to exist and be executable.
|
||||
.\"
|
||||
.SH DIAGNOSTICS
|
||||
|
||||
If the given files comply with the specified requirements, the program will exit
|
||||
successfully. If not, it exits unsuccessfully.
|
||||
|
||||
When invoked incorrectly, a debug message will be printed and the program will
|
||||
exit with the appropriate
|
||||
.BR sysexits.h (3)
|
||||
|
@ -40,7 +40,7 @@ error code.
|
||||
There\(cqs no way of knowing which argument failed the test without re-testing
|
||||
arguments individually.
|
||||
|
||||
If a character in a string isn\(cqt valid ASCII the program will exit
|
||||
If a character in a string isn\(cqt valid ASCII, the program will exit
|
||||
unsuccessfully.
|
||||
.\"
|
||||
.SH AUTHOR
|
||||
|
@ -27,7 +27,7 @@ Swap the latter and former halves of a block of bytes.
|
||||
Ignore system call interruptions.
|
||||
.IP \fB-w\fP
|
||||
Configures the word size; that is, the size in bytes of the block size
|
||||
on which to operate. By default the word size is 2. The word size must be
|
||||
on which to operate. The default word size is 2. The word size must be
|
||||
cleanly divisible by 2, otherwise the block of bytes being processed can\(cqt be
|
||||
halved.
|
||||
.\"
|
||||
@ -38,7 +38,7 @@ The following
|
||||
line:
|
||||
|
||||
.RS
|
||||
.R printf 'hello world!\n' | swab
|
||||
.R printf 'hello world!\(rsn' | swab
|
||||
.RE
|
||||
|
||||
Produces the following output:
|
||||
|
@ -10,8 +10,8 @@ true \(en do nothing, successfully
|
||||
.\"
|
||||
.SH DESCRIPTION
|
||||
|
||||
Do nothing regardless of operands or standard input.
|
||||
An exit code of 0 will always be returned.
|
||||
Do nothing regardless of operands or standard input. An exit code of 0 will
|
||||
always be returned.
|
||||
.\"
|
||||
.SH RATIONALE
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user