trinity/overgrown
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

dj.1: grammar & formatting

Browse Source
This commit is contained in:
Emma Tebibyte 2024-05-24 10:21:06 -06:00
parent 922ee71283
commit b7f52902b6
Signed by untrusted user: emma
GPG Key ID: 06FA419A1698C270
1 changed files with 18 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
docs/dj.1
View File

@ -138,9 +138,9 @@ On a partial or empty read, a diagnostic message is printed (unless the
.B -q .B -q
option is specified) and the program exits (unless the option is specified) and the program exits (unless the
.B -n .B -n
option is specified. option is specified).
By default statistics are printed for input and output to the standard error in By default, statistics are printed for input and output to the standard error in
the following format: the following format:
.RS .RS
@ -163,9 +163,9 @@ option may be specified. In this event, the following format is used instead:
If the If the
.B -d .B -d
option is specified, debug output will be printed at the beginning of execution. option is specified, debug output will be printed at the beginning of
This debug information contains information regarding how the program was execution. This debug information contains information regarding how the program
invoked. The following example is the result of running the program with was invoked. The following example is the result of running the program with
.B -d .B -d
as the only argument: as the only argument:
@ -183,29 +183,31 @@ sysexits.h(3) status.
If If
.B -n .B -n
is specified along with a specified count, actual byte output may be lower than is specified along with the
expected (the product of the count multiplied by the input block size). If the .B -c
option and a count, actual byte output may be lower than expected (the product
of the count and the input block size). If the
.B -a .B -a
or or
.B -A .B -A
options are used this could make data written nonsensical. options are used, this could make data written nonsensical.
Many lowercase options have capitalized variants and vice-versa which can be
confusing. Capitalized options tend to affect output or are more intense
versions of lowercase options.
.SH CAVEATS .SH CAVEATS
Existing files are not truncated on ouput and are instead overwritten. Existing files are not truncated on ouput and are instead overwritten.
Many lowercase options have capitalized variants and vice-versa which can be
confusing. Capitalized options tend to affect output or are more intense
versions of lowercase options.
.SH RATIONALE .SH RATIONALE
This program was based on the dd(1p) utility as specified in POSIX. While This program was based on the dd(1p) utility as specified in POSIX. While
character conversion may have been the original intent of dd(1p), it is character conversion may have been the original intent of dd(1p), it is
irrelevant to its modern use. Because of this, it eschews character conversion irrelevant to its modern use. Because of this, this program eschews character
and adds typical option formatting, allowing seeks to be specified in bytes conversion and adds typical option formatting, allowing seeks to be specified
rather than in blocks, allowing arbitrary bytes as padding, and printing in a in bytes rather than in blocks, allowing arbitrary bytes as padding, and
format that’s easy to parse for machines. printing in a format that’s easy for machines to parse.
.SH COPYRIGHT .SH COPYRIGHT