1
0
forked from bonsai/harakit

docs, src: fixing man page and usage text readability

This commit is contained in:
2024-06-29 05:28:23 -06:00
parent e341c38cd6
commit 07a12ba81c
5 changed files with 20 additions and 20 deletions

View File

@@ -15,13 +15,13 @@ dj
.RB [ -a\ byte ]
.RB [ -c\ count ]
.RB [ -i\ input_file ]
.RB [ -b\ input_block_size ]
.RB [ -s\ input_offset ]
.RB [ -i\ file ]
.RB [ -b\ block_size ]
.RB [ -s\ offset ]
.RB [ -o\ output_file ]
.RB [ -B\ output_block_size ]
.RB [ -S\ output_offset ]
.RB [ -o\ file ]
.RB [ -B\ block_size ]
.RB [ -S\ offset ]
.\"
.SH DESCRIPTION
@@ -39,25 +39,25 @@ immediately subsequent to the specified byte.
.\"
.SH OPTIONS
.IP \fB-i\fP
.IP \fB-i\fP\ \fIfile\fP
Takes a file path as an argument and opens it for use as an input.
.IP \fB-b\fP
.IP \fB-b\fP\ \fIblock_size\fP
Takes a numeric argument as the size in bytes of the input buffer, the default
being 1024.
.IP \fB-s\fP
.IP \fB-s\fP\ \fIoffset\fP
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
are discarded.
.IP \fB-o\fP
.IP \fB-o\fP\ \fIfile\fP
Takes a file path as an argument and opens it for use as an output.
.IP \fB-B\fP
.IP \fB-B\fP\ \fIblock_size\fP
Does the same as
.B -b
but for the output buffer.
.IP \fB-S\fP
.IP \fB-S\fP\ \fIoffset\fP
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.
.IP \fB-a\fP
.IP \fB-a\fP\ \fIbyte\fP
Accepts a single literal byte with which the input buffer is padded in the event
of an incomplete read from the input file.
.IP \fB-A\fP
@@ -65,7 +65,7 @@ Specifying this option pads the input buffer with null bytes in the event of an
incomplete read. This is equivalent to specifying
.B -a
with a null byte instead of a character.
.IP \fB-c\fP
.IP \fB-c\fP\ \fIcount\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.
.IP \fB-d\fP