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

dj.1: fixes many clunky sentences

Browse Source
This commit is contained in:
Emma Tebibyte 2024-06-17 23:36:52 -06:00
parent e38dcc09b1
commit 6814111ad1
Signed by untrusted user: emma
GPG Key ID: 06FA419A1698C270
1 changed files with 25 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
docs/dj.1
View File

@ -4,7 +4,7 @@
.\" This work is licensed under CC BY-SA 4.0. To see a copy of this license, .\" This work is licensed under CC BY-SA 4.0. To see a copy of this license,
.\" visit <http://creativecommons.org/licenses/by-sa/4.0/>. .\" visit <http://creativecommons.org/licenses/by-sa/4.0/>.
.\" .\"
.TH DJ 1 2024-06-06 "Bonsai Core Utilites 0.13.8" .TH DJ 1 2024-06-17 "Bonsai Core Utilites 0.13.8"
.SH NAME .SH NAME
dj \(en disk jockey dj \(en disk jockey
.\" .\"
@ -34,13 +34,13 @@ dj
.SH DESCRIPTION .SH DESCRIPTION
Perform precise read and write operations on files. This utility is useful for Perform precise read and write operations on files. This utility is useful for
reading and writing binary data to and from disks, hence the name. reading and writing binary data to and from disks.
This manual page uses the terms \(lqskip\(rq and \(lqseek\(rq to refer to moving This manual page uses the terms \(lqskip\(rq and \(lqseek\(rq to refer to moving
to a specified byte by index in the input and output of the program to a specified byte by index in the input and output of the program
respectively. This language is inherited from the respectively. This language is inherited from the
.BR dd (1p) .BR dd (1p)
utility and is used here to decrease ambiguity. utility and used here to decrease ambiguity.
When seeking or skipping to a byte, writing or reading starts at the byte When seeking or skipping to a byte, writing or reading starts at the byte
immediately subsequent to the specified byte. immediately subsequent to the specified byte.
@ -50,8 +50,8 @@ immediately subsequent to the specified byte.
.IP \fB-i\fP .IP \fB-i\fP
Takes a file path as an argument and opens it for use as an input. Takes a file path as an argument and opens it for use as an input.
.IP \fB-b\fP .IP \fB-b\fP
Takes a numeric argument as the size in bytes of the input buffer, with the Takes a numeric argument as the size in bytes of the input buffer, the default
default being 1024. being 1024.
.IP \fB-s\fP .IP \fB-s\fP
Takes a numeric argument as the number of bytes to skip into the input Takes a numeric argument as the number of bytes to skip into the input
before starting to read. If the standard input is used, bytes read to this point before starting to read. If the standard input is used, bytes read to this point
@ -66,25 +66,25 @@ but for the output buffer.
Seeks a number of bytes through the output before starting to write from Seeks a number of bytes through the output before starting to write from
the input. If the output is a stream, null characters are printed. the input. If the output is a stream, null characters are printed.
.IP \fB-a\fP .IP \fB-a\fP
Accepts a single literal byte with which input buffer is padded in the event Accepts a single literal byte with which the input buffer is padded in the event
of an incomplete read from the input file. of an incomplete read from the input file.
.IP \fB-A\fP .IP \fB-A\fP
Specifying this option pads the input buffer with null bytes in the event of an Specifying this option pads the input buffer with null bytes in the event of an
incomplete read. Equivalent to specifying incomplete read. This is equivalent to specifying
.B -a .B -a
with a null byte instead of a character. with a null byte instead of a character.
.IP \fB-c\fP .IP \fB-c\fP
Specifies a number of reads to make. The default is zero, in which case the Specifies a number of reads to make. The default is 0, in which case the
input is read until a partial or empty read is made. input is read until a partial or empty read is made.
.IP \fB-d\fP .IP \fB-d\fP
Prints invocation information before program execution as described in the Prints invocation information before program execution as described in the
DIAGNOSTICS section below. Each invocation increments the debug level of the DIAGNOSTICS section. Each invocation increments the debug level of the
program. program.
.IP \fB-H\fP .IP \fB-H\fP
Prints diagnostics messages in a human-readable manner as described in the Prints diagnostics messages in a human-readable manner as described in the
DIAGNOSTICS section below. DIAGNOSTICS section.
.IP \fB-n\fP .IP \fB-n\fP
Retries failed reads once more before exiting. Retries failed reads once before exiting.
.IP \fB-q\fP .IP \fB-q\fP
Suppresses error messages which print when a read or write is partial or Suppresses error messages which print when a read or write is partial or
empty. Each invocation decrements the debug level of the program. empty. Each invocation decrements the debug level of the program.
@ -94,13 +94,18 @@ empty. Each invocation decrements the debug level of the program.
The standard input shall be used as an input if no inputs are specified or if 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. one or more of the input files is \(lq-\(rq.
.\" .\"
.SH STANDARD OUTPUT
The standard output shall be used as an output if no inputs are specified or if
one or more of the input files is \(lq-\(rq.
.\"
.SH DIAGNOSTICS .SH DIAGNOSTICS
On a partial or empty read, a diagnostic message is printed (unless the On a partial or empty read, unless the
.B -q .B -q
option is specified) and the program exits (unless the option is specified, a diagnostic message is printed. Then, 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:
@ -125,9 +130,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 option is specified, debug information will be printed at the beginning of
execution. This debug information contains information regarding how the program execution. This output contains information regarding how the program was
was invoked. The following example is the result of running the program with invoked. The following example is the result of running the program with
.B -d .B -d
as the only argument: as the only argument:
@ -148,12 +153,12 @@ If
.B -n .B -n
is specified along with the is specified along with the
.B -c .B -c
option and a count, actual byte output may be lower than expected (the product option and a count, actual byte output is the product of the count and the input
of the count and the input block size). If the block size and therefore may be lower than expected. If the
.B -a .B -a
or or
.B -A .B -A
options are used, this could make data written nonsensical. options are specified, this could make written data nonsensical.
.\" .\"
.SH CAVEATS .SH CAVEATS