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

dj.1: -d, -i, -o, fixed descriptions

Browse Source
This commit is contained in:
Emma Tebibyte 2024-03-27 00:08:43 -06:00
parent bb43533a37
commit 49e2022e52
Signed by untrusted user: emma
GPG Key ID: 06FA419A1698C270
1 changed files with 16 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
docs/dj.1
View File

@ -95,41 +95,42 @@ continue reading until a partial or empty read.
.B -d .B -d
.RS .RS
Prints all debug information, user-specified or otherwise, before program Prints all debug information, user-specified or otherwise, before program
execution. execution. Each invocation increments the debug level of the program.
.RE .RE
.B -i .B -i
.RS .RS
Takes a path as an argument to open and use in place of standard input. Takes a file path as an argument to open and use as an input.
.RE .RE
.B -n .B -n
.RS .RS
Causes dj to exit on two consecutive empty reads instead of one. Retries failed reads once more before exiting.
.RE .RE
.B -o .B -o
.RS .RS
Does the same as Takes a file path as an argument to open and use as an output.
.B -i
but in place of standard output. Dj does not truncate output
files and instead writes over the bytes in the existing file.
.RE .RE
.B -s .B -s
.RS .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. before starting to read. If the standard input is used, bytes read to this point
are discarded.
.RE .RE
.B -q .B -q
.RS .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. When empty. Each invocation decrements the debug level of the program.
.B -q
is specified twice suppresses diagnostic output entirely.
.RE .RE
.SH STANDARD INPUT
The standard input shall be used as an input if one or more of the input files
is “-”.
.SH DIAGNOSTICS .SH DIAGNOSTICS
On a partial or empty read, dj prints a diagnostic message (unless the On a partial or empty read, dj prints a diagnostic message (unless the
@ -177,6 +178,10 @@ Many lowercase options have capitalized variants and vice-versa which can be
confusing. Capitalized options tend to affect output or are more intense confusing. Capitalized options tend to affect output or are more intense
versions of lowercase options. versions of lowercase options.
.SH CAVEATS
Output files are not truncated on ouput and are instead overwritten.
.SH RATIONALE .SH RATIONALE
This program was based on the dd(1p) utility as specified in POSIX. While This program was based on the dd(1p) utility as specified in POSIX. While