bonsai/harakit
5
4
Fork 3
Code Issues 41 Pull Requests 7 Projects 1 Releases 30 Activity

dj.1: fixes ambiguity in block size options

Browse Source
This commit is contained in:
Emma Tebibyte 2024-07-14 02:37:37 -06:00
parent b22ded9e98
commit aa074ad9b6
Signed by: emma
GPG Key ID: 06FA419A1698C270
1 changed files with 20 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
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,
.\" visit <http://creativecommons.org/licenses/by-sa/4.0/>.
.\"
.TH DJ 1 2024-07-03 "Harakit X.X.X"
.TH DJ 1 2024-07-14 "Harakit X.X.X"
.SH NAME
dj \(en disk jockey
.\"
@ -56,9 +56,9 @@ bytes read to this point are discarded.
.IP \fB-o\fP
Takes a file path as an argument and opens it for use as an output.
.IP \fB-B\fP\ \fIblock_size\fP
Does the same as
.B -b
but for the output buffer.
Takes a numeric argument as the size in bytes of the output buffer, the default
being 1024. Note that this option only affects the size of output writes and not
the amount of output data itself. See the CAVEATS section.
.IP \fB-S\fP
Takes a numeric argument as the index of the byte at which writing will
commence; \(lqseeks\(rq that number of bytes. If the standard output is used,
@ -68,8 +68,8 @@ Accepts a single literal byte with which the input buffer is padded in the event
of an incomplete read from the input file. If the option argument is empty, the
null byte is used.
.IP \fB-c\fP
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.
Specifies a number of blocks to read. The default is 0, in which case the input
is read until a partial or empty read is made.
.IP \fB-H\fP
Prints diagnostic messages in a human-readable manner as described in the
DIAGNOSTICS section.
@ -181,15 +181,22 @@ option is specified, this could make written data nonsensical.
Existing files are not truncated on ouput and are instead overwritten.
The options
.B -b
and
Option variants that have uppercase and lowercase forms could be confused for
each other. The former affects input and the latter affects output.
The
.B -B
could be confused for each other, and so could
.B -s
option could be mistaken for write size, meaning the count in bytes of data
placed in the output. This conception is intuitive but incorrect; the amount of
data read and output is controlled by the
.B -c
and
.BR -S .
The lowercase option affects input and the capitalized option affects output.
.B -b
options. The latter sets the size of blocks to be read and the former sets the
number of blocks to be read. The
.B -B
option is similar to the latter but sets the size of blocks to be written,
regardless of the amount of data that will actually be written.
The skipped or sought bytes while processing irregular files, such as streams,
are reported in the diagnostic output, because they were actually read or