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

dj.1: adds DESCRIPTION and removes seek/skip confusion

Browse Source
This commit is contained in:
Emma Tebibyte 2024-06-05 17:15:42 -06:00
parent f4cad598c4
commit 3c0725f137
Signed by untrusted user: emma
GPG Key ID: 06FA419A1698C270
1 changed files with 13 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/dj.1
View File

@ -43,6 +43,17 @@ dj
.B output offset .B output offset
.R ]) .R ])
.\" .\"
.SH DESCRIPTION
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.
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
respectively. This language is inherited from the
.BR dd (1p)
utility and is used here to decrease ambiguity.
.\"
.SH OPTIONS .SH OPTIONS
.IP \fB-i\fP .IP \fB-i\fP
@ -61,7 +72,7 @@ Does the same as
.B -b .B -b
but for the output buffer. but for the output buffer.
.IP \fB-S\fP .IP \fB-S\fP
Skips 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 input buffer is padded in the event
@ -86,6 +97,7 @@ Retries failed reads once more 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.
.\"
.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