2 Commits

Author SHA1 Message Date
314254b32f docs: hotfix 2024-06-06 13:32:54 -06:00
51421b2128 dj.1, strcmp.1, swab.1: remove nonexistent roff macros 2024-06-06 00:14:55 -06:00
13 changed files with 33 additions and 45 deletions

View File

@@ -4,7 +4,7 @@
.\" 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/>.
.\"
.TH DJ 1
.TH DJ 1 2024-06-06 "Bonsai Core Utilites 0.13.8"
.SH NAME
dj \(en disk jockey
.\"
@@ -18,30 +18,18 @@ dj
.RB [ count ])
.RB ( -i
.R [
.B input file
.R ])
[\fBinput file\fP])
.RB ( -b
.R [
.B input block size
.R ])
[\fBinput block size\fP])
.RB ( -s
.R [
.B input offset
.R ])
[\fBinput offset\fP])
.RB ( -o
.R [
.B output file
.R ])
[\fBoutput file\fP])
.RB ( -B
.R [
.B output block size
.R ])
[\fBoutput block size\fP])
.RB ( -S
.R [
.B output offset
.R ])
[\fBoutput offset\fP])
.\"
.SH DESCRIPTION
@@ -118,10 +106,10 @@ By default, statistics are printed for input and output to the standard error in
the following format:
.RS
.R {records read} {ASCII unit separator} {partial records read}
.R {ASCII record separator} {records written} {ASCII unit separator}
.R {partial records written} {ASCII group separator} {bytes read}
.R {ASCII record separator} {bytes written} {ASCII file separator}
{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
@@ -130,9 +118,9 @@ convenience. For a more human-readable format, the
option may be specified. In this event, the following format is used instead:
.RS
.R {records read} '+' {partial records read} '>' {records written}
.R '+' {partial records written} ';' {bytes read} '>' {bytes written}
.R {ASCII line feed}
{records read} '+' {partial records read} '>' {records written}
'+' {partial records written} ';' {bytes read} '>' {bytes written}
{ASCII line feed}
.RE
If the
@@ -144,9 +132,9 @@ was invoked. The following example is the result of running the program with
as the only argument:
.RS
.R argv0=dj
.R in=<stdin> ibs=1024 skip=0 align=ff count=0
.R out=<stdout> obs=1024 seek=0 debug= 3 noerror=0
argv0=dj
in=<stdin> ibs=1024 skip=0 align=ff count=0
out=<stdout> obs=1024 seek=0 debug= 3 noerror=0
.RE
In non-recoverable errors that don\(cqt pertain to the read-write cycle, a

View File

@@ -4,7 +4,7 @@
.\" 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/>.
.\"
.TH FALSE 1
.TH FALSE 1 2024-06-06 "Bonsai Core Utilites 0.13.8"
.SH NAME
false \(en do nothing, unsuccessfully
.\"

View File

@@ -4,7 +4,7 @@
.\" 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/>.
.\"
.TH fop 1
.TH FOP 1 2024-06-06 "Bonsai Core Utilites 0.13.8"
.SH NAME
fop \(en field operator
.\"

View File

@@ -3,7 +3,7 @@
.\" 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/>.
.\"
.TH HRU 1
.TH HRU 1 2024-06-06 "Bonsai Core Utilites 0.13.8"
.SH NAME
hru \(en human readable units
.\"

View File

@@ -4,7 +4,7 @@
.\" 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/>.
.\"
.TH INTCMP 1
.TH INTCMP 1 2024-06-06 "Bonsai Core Utilites 0.13.8"
.SH NAME
intcmp \(en compare integers
.\"

View File

@@ -3,7 +3,7 @@
.\" 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/>.
.\"
.TH mm 1
.TH MM 1 2024-06-06 "Bonsai Core Utilites 0.13.8"
.SH NAME
mm \(en middleman
.\"

View File

@@ -4,7 +4,7 @@
.\" 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/>.
.\"
.TH NPC 1
.TH NPC 1 2024-06-06 "Bonsai Core Utilites 0.13.8"
.SH NAME
npc \(en show non-printing characters
.\"

View File

@@ -4,7 +4,7 @@
.\" 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/>.
.\"
.TH rpn 1
.TH RPN 1 2024-06-06 "Bonsai Core Utilites 0.13.8"
.SH NAME
rpn \(en reverse polish notation evaluation
.\"

View File

@@ -4,7 +4,7 @@
.\" 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/>.
.\"
.TH scrut 1
.TH SCRUT 1 2024-06-06 "Bonsai Core Utilites 0.13.8"
.SH NAME
scrut \(en scrutinize file properties
.SH SYNOPSIS

View File

@@ -4,7 +4,7 @@
.\" 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/>.
.\"
.TH STR 1
.TH STR 1 2024-06-06 "Bonsai Core Utilites 0.13.8"
.SH NAME
str \(en test the character types of string arguments
.\"

View File

@@ -4,7 +4,7 @@
.\" 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/>.
.\"
.TH STRCMP 1
.TH STRCMP 1 2024-06-06 "Bonsai Core Utilites 0.13.8"
.SH NAME
strcmp \(en compare strings
.\"
@@ -25,14 +25,14 @@ will exit with an error code of 1 if a string passed has a lesser byte value
than one of the prior strings:
.RS
.R strcmp b a
strcmp b a
.RE
and with an error code of 255 if it has a greater byte value than one of the
prior strings:
.RS
.R strcmp a b
strcmp a b
.RE
When invoked incorrectly, a debug message will be printed and the program will

View File

@@ -4,7 +4,7 @@
.\" 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/>.
.\"
.TH SWAB 1
.TH SWAB 1 2024-06-06 "Bonsai Core Utilites 0.13.8"
.SH NAME
swab \(en swap bytes
.\"
@@ -38,13 +38,13 @@ The following
line:
.RS
.R printf 'hello world!\(rsn' | swab
printf 'hello world!\(rsn' | swab
.RE
Produces the following output:
.RS
.R ehll oowlr!d
ehll oowlr!d
.RE
.\"
.SH DIAGNOSTICS

View File

@@ -4,7 +4,7 @@
.\" 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/>.
.\"
.TH TRUE 1
.TH TRUE 1 2024-06-06 "Bonsai Core Utilites 0.13.8"
.SH NAME
true \(en do nothing, successfully
.\"