.\" Copyright (c) 2024 DTB .\" Copyright (c) 2024 Emma Tebibyte .\" .\" This work is licensed under CC BY-SA 4.0. To see a copy of this license, .\" visit . .\" .TH DJ 1 2024-06-29 "Harakit X.X.X" .SH NAME dj \(en disk jockey .\" .SH SYNOPSIS dj .RB ( -Hn ) .RB ( -a .RB [ byte ]) .RB ( -c .RB [ count ]) .RB ( -i [\fBinput file\fP]) .RB ( -b [\fBinput block size\fP]) .RB ( -s [\fBinput offset\fP]) .RB ( -o [\fBoutput file\fP]) .RB ( -B [\fBoutput block size\fP]) .RB ( -S [\fBoutput offset\fP]) .\" .SH DESCRIPTION Perform precise read and write operations on files. This utility is useful for reading and writing binary data to and from disks. 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 used here to decrease ambiguity. When seeking or skipping to a byte, writing or reading starts at the byte immediately subsequent to the specified byte. .\" .SH OPTIONS .IP \fB-i\fP Takes a file path as an argument and opens it for use as an input. .IP \fB-b\fP Takes a numeric argument as the size in bytes of the input buffer, the default being 1024. .IP \fB-s\fP Takes a numeric argument as the index of the byte at which reading will commence; \(lqskips\(rq that number of bytes. If the standard input is used, 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 Does the same as .B -b but for the output buffer. .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, null characters are printed. .IP \fB-a\fP 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. .IP \fB-H\fP Prints diagnostic messages in a human-readable manner as described in the DIAGNOSTICS section. .IP \fB-n\fP Retries failed reads once before exiting. .\" .SH STANDARD INPUT The standard input shall be used as an input if no inputs are specified or if input file is \(lq-\(rq. .\" .SH STANDARD OUTPUT The standard output shall be used as an output if no inputs are specified or if the output file is \(lq-\(rq. .\" .SH DIAGNOSTICS On a partial or empty read, a diagnostic message is printed. Then, the program exits unless the .B -n option is specified. By default, statistics are printed for input and output to the standard error in the following format: .RS {records read} {ASCII unit separator} {partial records read} {ASCII record separator} {records written} {ASCII unit separator} {partial records written} {ASCII group separator} {bytes read} {ASCII record separator} {bytes written} {ASCII file separator} .RE This format for diagnostic output is designed to be machine-parseable for convenience. For a more human-readable format, the .B -H option may be specified. In this event, the following format is used instead: .RS {records read} '+' {partial records read} '>' {records written} '+' {partial records written} ';' {bytes read} '>' {bytes written} {ASCII line feed} .RE 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 .BR sysexits.h (3) status. .\" .SH BUGS If .B -n is specified along with the .B -c option and a count, actual byte output is the product of the count and the input block size and therefore may be lower than expected. If the .B -a option is specified, this could make written data nonsensical. .\" .SH CAVEATS Existing files are not truncated on ouput and are instead overwritten. Many lowercase options have capitalized variants and vice-versa which can be confusing. Capitalized options tend to affect output or are more intense versions of lowercase options. .\" .SH RATIONALE This program was based on the .BR dd (1p) utility as specified in POSIX. While character conversion may have been the original intent of .BR dd (1p), it is irrelevant to its modern use. Because of this, this program eschews character conversion and adds typical option formatting, allowing seeks to be specified in bytes rather than in blocks, allowing arbitrary bytes as padding, and printing in a format that\(cqs easy for machines to parse. .\" .SH COPYRIGHT Copyright \(co 2023 DTB. License AGPLv3+: GNU AGPL version 3 or later . .\" .SH SEE ALSO .BR dd (1p)