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

docs: updates to use man(7) macros to fix formatting

Browse Source
This commit is contained in:
Emma Tebibyte 2024-06-02 18:47:14 -06:00
parent b7f52902b6
commit 70cbc52c93
Signed by untrusted user: emma
GPG Key ID: 06FA419A1698C270
13 changed files with 406 additions and 495 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

119
docs/dj.1
View File

@ -3,15 +3,13 @@
.\" .\"
.\" 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 .TH DJ 1
.SH NAME .SH NAME
dj \(en disk jockey dj \(en disk jockey
.\"
.SH SYNOPSIS .SH SYNOPSIS
.\"
dj dj
.RB ( -AdHnq ) .RB ( -AdHnq )
.RB ( -a .RB ( -a
@ -44,102 +42,63 @@ dj
.R [ .R [
.B output offset .B output offset
.R ]) .R ])
.\"
.SH OPTIONS .SH OPTIONS
.\"
.B -i .IP \fB-i\fP
.RS
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.
.RE .IP \fB-b\fP
.B -b
.RS
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, with the
default being 1024. default being 1024.
.RE .IP \fB-s\fP
.B -s
.RS
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
are discarded. are discarded.
.RE .IP \fB-o\fP
.B -o
.RS
Takes a file path as an argument and opens it for use as an output. Takes a file path as an argument and opens it for use as an output.
.RE .IP \fB-B\fP
.B -B
.RS
Does the same as Does the same as
.B -b .B -b
but for the output buffer. but for the output buffer.
.RE .IP \fB-S\fP
.B -S
.RS
Skips a number of bytes through the output before starting to write from Skips 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.
.RE .IP \fB-a\fP
.B -a
.RS
Accepts a single literal byte with which input buffer is padded in the event Accepts a single literal byte with which input buffer is padded in the event
of an incomplete read from the input file. of an incomplete read from the input file.
.RE .IP \fB-A\fP
.B -A
.RS
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. Equivalent to specifying
.B -a .B -a
with a null byte instead of a character. with a null byte instead of a character.
.RE .IP \fB-c\fP
.B -c
.RS
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 zero, 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.
.RE .IP \fB-d\fP
.B -d
.RS
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 below. Each invocation increments the debug level of the
program. program.
.RE .IP \fB-H\fP
.B -H
.RS
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 below.
.RE .IP \fB-n\fP
.B -n
.RS
Retries failed reads once more before exiting. Retries failed reads once more before exiting.
.RE .IP \fB-q\fP
.B -q
.RS
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.
.RE
.SH STANDARD INPUT .SH STANDARD INPUT
.\"
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 “-”. 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, a diagnostic message is printed (unless the
.B -q .B -q
option is specified) and the program exits (unless the option is specified) and 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:
@ -175,12 +134,12 @@ as the only argument:
.R out=<stdout> obs=1024 seek=0 debug= 3 noerror=0 .R out=<stdout> obs=1024 seek=0 debug= 3 noerror=0
.RE .RE
In non-recoverable errors that don’t pertain to the read-write cycle, a In non-recoverable errors that don\(cqt pertain to the read-write cycle, a
diagnostic message is printed and the program exits with the appropriate diagnostic message is printed and the program exits with the appropriate
sysexits.h(3) status. sysexits.h(3) status.
.\"
.SH BUGS .SH BUGS
.\"
If If
.B -n .B -n
is specified along with the is specified along with the