1
0
forked from bonsai/harakit

docs: removed unnecessary comments

This commit is contained in:
2024-06-03 23:07:19 -06:00
parent 70cbc52c93
commit c32c554e03
13 changed files with 96 additions and 98 deletions

View File

@@ -9,7 +9,7 @@
dj \(en disk jockey
.\"
.SH SYNOPSIS
.\"
dj
.RB ( -AdHnq )
.RB ( -a
@@ -44,7 +44,7 @@ dj
.R ])
.\"
.SH OPTIONS
.\"
.IP \fB-i\fP
Takes a file path as an argument and opens it for use as an input.
.IP \fB-b\fP
@@ -87,18 +87,18 @@ Retries failed reads once more before exiting.
Suppresses error messages which print when a read or write is partial or
empty. Each invocation decrements the debug level of the program.
.SH STANDARD INPUT
.\"
The standard input shall be used as an input if no inputs are specified or if
one or more of the input files is \(lq-\(rq.
.\"
.SH DIAGNOSTICS
.\"
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).
.\"
By default, statistics are printed for input and output to the standard error in
the following format:
@@ -139,7 +139,7 @@ diagnostic message is printed and the program exits with the appropriate
sysexits.h(3) status.
.\"
.SH BUGS
.\"
If
.B -n
is specified along with the
@@ -152,7 +152,7 @@ or
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
@@ -160,7 +160,7 @@ 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, this program eschews character
@@ -169,10 +169,9 @@ in bytes rather than in blocks, allowing arbitrary bytes as padding, and
printing in a format that\(cqs easy for machines to parse.
.\"
.SH COPYRIGHT
.\"
Copyright \(co 2023 DTB. License AGPLv3+: GNU AGPL version 3 or later
<https://gnu.org/licenses/agpl.html>.
.\"
.SH SEE ALSO
.\"
.BR dd (1p)