From b7f52902b6bde54876b5fd8efafa433e2cf0df9a Mon Sep 17 00:00:00 2001 From: emma Date: Fri, 24 May 2024 10:21:06 -0600 Subject: [PATCH] dj.1: grammar & formatting --- docs/dj.1 | 34 ++++++++++++++++++---------------- 1 file changed, 18 insertions(+), 16 deletions(-) diff --git a/docs/dj.1 b/docs/dj.1 index 7534b6e..7af1c00 100644 --- a/docs/dj.1 +++ b/docs/dj.1 @@ -138,9 +138,9 @@ On a partial or empty read, a diagnostic message is printed (unless the .B -q option is specified) and the program exits (unless the .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: .RS @@ -163,9 +163,9 @@ option may be specified. In this event, the following format is used instead: If the .B -d -option is specified, debug output will be printed at the beginning of execution. -This debug information contains information regarding how the program was -invoked. The following example is the result of running the program with +option is specified, debug output will be printed at the beginning of +execution. This debug information contains information regarding how the program +was invoked. The following example is the result of running the program with .B -d as the only argument: @@ -183,29 +183,31 @@ sysexits.h(3) status. If .B -n -is specified along with a specified count, actual byte output may be lower than -expected (the product of the count multiplied by the input block size). If the +is specified along with 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 or .B -A -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. +options are used, this could make data written nonsensical. .SH CAVEATS 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 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 -irrelevant to its modern use. Because of this, it eschews character conversion -and adds typical option formatting, allowing seeks to be specified in bytes -rather than in blocks, allowing arbitrary bytes as padding, and printing in a -format that’s easy to parse for machines. +irrelevant to its modern use. Because of this, this program eschews character +conversion and adds typical option formatting, allowing seeks to be specified +in bytes rather than in blocks, allowing arbitrary bytes as padding, and +printing in a format that’s easy for machines to parse. .SH COPYRIGHT