dj.1: last minute changes

Makefile

@@ -8,11 +8,10 @@
 # permitted in any medium without royalty provided the copyright notice and this
 # notice are preserved.  This file is offered as-is, without any warranty.
 
-.POSIX:
+# The octal escape \043 is utilized twice in this file as make(1p) will
+# interpret a hash in a rule as an inline comment.
 
-# if using BSD make(1), remove these pragmas because they break it
+.POSIX:
-.PRAGMA: posix_202x # future POSIX standard support à la pdpmake(1)
-.PRAGMA: command_comment # breaks without this?
 
 DESTDIR ?= dist
 PREFIX ?= /usr/local
@@ -30,12 +29,12 @@ RUSTLIBS = --extern getopt=build/o/libgetopt.rlib \
 CFLAGS += -I$(SYSEXITS)
 
 .PHONY: all
-all: dj false fop hru intcmp mm npc rpn scrut str strcmp swab true
+all: docs dj false fop hru intcmp mm npc rpn scrut str strcmp swab true
 
+# keep build/include until bindgen(1) has stdin support
+# https://github.com/rust-lang/rust-bindgen/issues/2703
 build:
-	# keep build/include until bindgen(1) has stdin support
+	mkdir -p build/bin build/docs build/include build/lib build/o build/test
-	# https://github.com/rust-lang/rust-bindgen/issues/2703
-	mkdir -p build/bin build/include build/lib build/o build/test
 
 .PHONY: clean
 clean:
@@ -44,7 +43,7 @@ clean:
 dist: all
 	mkdir -p $(DESTDIR)/$(PREFIX)/bin $(DESTDIR)/$(PREFIX)/share/man/man1
 	cp build/bin/* $(DESTDIR)/$(PREFIX)/bin
-	cp docs/*.1 $(DESTDIR)/$(PREFIX)/$(MANDIR)/man1
+	cp build/docs/*.1 $(DESTDIR)/$(PREFIX)/$(MANDIR)/man1
 
 .PHONY: install
 install: dist
@@ -55,6 +54,13 @@ test: build
 	tests/posix-compat.sh
 	$(RUSTC) --test src/getopt-rs/lib.rs -o build/test/getopt
 
+.PHONY: docs
+docs: docs/ build
+	for file in docs/*; do original="$$(sed -n '/^\.TH/p' <"$$file")"; \
+		title="$$(printf '%s\n' "$$original" | sed \
+		"s/X\.X\.X/$$(git describe --tags --long | cut -d'-' -f1)/g")"; \
+		sed "s/$$original/$$title/g" <"$$file" >"build/$$file"; done
+
 .PHONY: rustlibs
 rustlibs: build/o/libsysexits.rlib build/o/libgetopt.rlib \
 	build/o/libstrerror.rlib
@@ -67,9 +73,9 @@ build/o/libstrerror.rlib: build src/strerror.rs
 	$(RUSTC) $(RUSTFLAGS) --crate-type=lib -o $@ \
 		src/strerror.rs
 
+# bandage solution until bindgen(1) gets stdin support
 build/o/libsysexits.rlib: build $(SYSEXITS)sysexits.h
-	# bandage solution until bindgen(1) gets stdin support
+	printf '\043define EXIT_FAILURE 1\n' | cat - $(SYSEXITS)sysexits.h \
-	printf '#define EXIT_FAILURE 1\n' | cat - $(SYSEXITS)sysexits.h \
 		> build/include/sysexits.h 
 	bindgen --default-macro-constant-type signed --use-core --formatter=none \
 		build/include/sysexits.h | $(RUSTC) $(RUSTFLAGS) --crate-type lib -o $@ -

README

@@ -1,26 +1,27 @@
 “Seek not to walk the path of the masters; seek what they sought.”
 – Matsuo Basho
 
-The Bonsai core utilities are the result of the careful examination of the
+The Bonsai harakit utilities are a replacement for standard POSIX utilities
-current state of POSIX and Unix utilies. The Unix Philosophy, “do one thing and
+which aim to fill its niche while expanding on their capabilities. These new
-do it well” is its core but these tools do not cling to the names of the past.
+tools are the result of the careful examination of the current state of POSIX
+and Unix utilies. The Unix Philosophy of “do one thing and do it well” are their
+core but they avoid clinging to the past.
 
 The era of the original Unix tools has been long and fruitful, but they have
-their flaws. The new, non-POSIX era of this project started with frustration
+their flaws. This project originated from frustrations with the way certain
-with the way certain tools work and how other projects that extend POSIX don’t
+tools work and how other projects that extend POSIX don’t make anything better.
-make anything better.
 
 This project will not follow in the footsteps of GNU; extensions of POSIX will
 not be found here. GNU extensions are a gateway to the misuse of the shell. The
-Bonsai core utilities will intentionally discourage use of the shell for
+harakit utilities will intentionally discourage use of the shell for purposes
-purposes beyond its scope.
+beyond its scope.
 
 See docs/ for more on the specific utilities currently implemented.
 
 Building
 
-The coreutils require a POSIX-compliant environment to compile, including a C
+Harakit utilities require a POSIX-compliant environment to compile, including a
-compiler and preprocessor (cc(1) and cpp(1) by default), an edition 2023 Rust
+C compiler and preprocessor (cc(1) and cpp(1) by default), an edition 2023 Rust
 compiler (rustc(1) by default), bindgen(1), and a POSIX-compliant make(1)
 utility.
 
@@ -38,7 +39,7 @@ To test the utilities:
 
 $ make test
 
-To remove all untracked files:
+To remove all build and distributable files:
 
 $ make clean
 

docs/dj.1

@@ -4,14 +4,14 @@
 .\" 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 2024-06-06 "Bonsai Core Utilites 0.13.8"
+.TH DJ 1 2024-06-29 "Harakit X.X.X"
 .SH NAME
 dj \(en disk jockey
 .\"
 .SH SYNOPSIS
 
 dj
-.RB ( -AdHnq )
+.RB ( -Hn )
 .RB ( -a
 .RB [ byte ])
 .RB ( -c
@@ -34,13 +34,13 @@ dj
 .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.
+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 is used here to decrease ambiguity.
+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.
@@ -50,12 +50,12 @@ immediately subsequent to the specified byte.
 .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, with the
+Takes a numeric argument as the size in bytes of the input buffer, the default
-default being 1024.
+being 1024.
 .IP \fB-s\fP
-Takes a numeric argument as the number of bytes to skip into the input
+Takes a numeric argument as the index of the byte at which reading will
-before starting to read. If the standard input is used, bytes read to this point
+commence; \(lqskips\(rq that number of bytes. If the standard input is used,
-are discarded.
+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
@@ -63,44 +63,37 @@ Does the same as
 .B -b
 but for the output buffer.
 .IP \fB-S\fP
-Seeks a number of bytes through the output before starting to write from
+Takes a numeric argument as the index of the byte at which writing will
-the input. If the output is a stream, null characters are printed.
+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 input buffer is padded in the event
+Accepts a single literal byte with which the input buffer is padded in the event
-of an incomplete read from the input file.
+of an incomplete read from the input file. If the option argument is empty, the
-.IP \fB-A\fP
+null byte is used.
-Specifying this option pads the input buffer with null bytes in the event of an
-incomplete read. Equivalent to specifying
-.B -a
-with a null byte instead of a character.
 .IP \fB-c\fP
-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 0, in which case the
 input is read until a partial or empty read is made.
-.IP \fB-d\fP
-Prints invocation information before program execution as described in the
-DIAGNOSTICS section below. Each invocation increments the debug level of the
-program.
 .IP \fB-H\fP
-Prints diagnostics messages in a human-readable manner as described in the
+Prints diagnostic messages in a human-readable manner as described in the
-DIAGNOSTICS section below.
+DIAGNOSTICS section.
 .IP \fB-n\fP
-Retries failed reads once more before exiting.
+Retries failed reads once before exiting.
-.IP \fB-q\fP
-Suppresses error messages which print when a read or write is partial or
-empty. Each invocation decrements the debug level of the program.
 .\"
 .SH STANDARD INPUT
 
 The standard input shall be used as an input if no inputs are specified or if
-one or more of the input files is \(lq-\(rq.
+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 (unless the
+On a partial or empty read, a diagnostic message is printed. Then, the program
-.B -q
+exits unless the
-option is specified) and the program exits (unless the
 .B -n
-option is specified).
+option is specified.
 
 By default, statistics are printed for input and output to the standard error in
 the following format:
@@ -123,20 +116,6 @@ option may be specified. In this event, the following format is used instead:
 {ASCII line feed}
 .RE
 
-If the
-.B -d
-option is specified, debug output will be printed at the beginning of
-execution. This debug information contains information regarding how the program
-was invoked. The following example is the result of running the program with
-.B -d
-as the only argument:
-
-.RS
-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
 diagnostic message is printed and the program exits with the appropriate
 .BR sysexits.h (3)
@@ -148,12 +127,10 @@ If
 .B -n
 is specified along with the
 .B -c
-option and a count, actual byte output may be lower than expected (the product
+option and a count, actual byte output is the product of the count and the input
-of the count and the input block size). If the
+block size and therefore may be lower than expected. If the
 .B -a
-or
+option is specified, this could make written data nonsensical.
-.B -A
-options are used, this could make data written nonsensical.
 .\"
 .SH CAVEATS
 

docs/false.1

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

docs/fop.1

@@ -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 2024-06-06 "Bonsai Core Utilites 0.13.8"
+.TH FOP 1 2024-06-17 "Harakit X.X.X"
 .SH NAME
 fop \(en field operator
 .\"
@@ -18,7 +18,7 @@ fop
 .\"
 .SH DESCRIPTION
 
-Performs operations on specified fields in input data.
+Performs operations on specified fields in data read from the standard input.
 .\"
 .SH OPTIONS
 
@@ -26,10 +26,6 @@ Performs operations on specified fields in input data.
 Sets a delimiter by which the input data will be split into fields. The default
 is an ASCII record separator.
 .\"
-.SH STANDARD INPUT
-
-Data will be read from the standard input.
-.\"
 .SH CAVEATS
 
 Field indices are zero-indexed, which may be unexpected behavior for some users.
@@ -51,6 +47,12 @@ but there was no easy way to modify the field in the ouput of
 .BR ls (1p)
 without creating a new tool.
 .\"
+.SH AUTHOR
+
+Written by Emma Tebibyte
+.MT emma@tebibyte.media
+.ME .
+.\"
 .SH COPYRIGHT
 
 Copyright \(co 2024 Emma Tebibyte. License AGPLv3+: GNU AGPL version 3 or later

docs/hru.1

@@ -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 2024-06-06 "Bonsai Core Utilites 0.13.8"
+.TH HRU 1 2024-06-17 "Harakit X.X.X"
 .SH NAME
 hru \(en human readable units
 .\"
@@ -15,9 +15,9 @@ hru
 
 Convert counts to higher units.
 
-The program will read byte counts in the form of whole numbers from the standard
+Byte counts will be read in the form of whole numbers from the standard input
-input and write to the standard output the same number converted to a higher
+and be written to the standard output the same number converted to a higher unit
-unit of data as defined by the International System of Units.
+of data as defined by the \fIInternational System of Units\fP.
 
 The program will convert the byte count to the highest unit possible where the
 value is greater than one.
@@ -35,10 +35,8 @@ The GNU project\(cqs
 .BR ls (1)
 implementation contains a human-readable option (\fB-h\fP) that, when specified,
 makes the tool print size information in a format more immediately
-readable. This functionality is useful not only in the context of
+readable. This functionality is useful not only in this context, so the decision
-.BR ls (1)
+was made to split it into a new tool. The original functionality from GNU\(cqs
-so the decision was made to split it into a new tool. The original functionality
-in GNU\(cqs
 .BR ls (1)
 can be emulated with
 .BR fop (1)
@@ -46,8 +44,12 @@ combined with this program.
 .\"
 .SH STANDARDS
 
-The standard unit prefixes as specified by the Bureau International des Poids
+The standard unit prefixes as specified by the
-et Mesures (BIPM) in the ninth edition of The International System of Units (SI)
+.I Bureau International des Poids et Mesures
+.RI ( BIPM )
+in the ninth edition of
+.I The International System of Units
+.RI ( SI )
 are utilized for the ouput of conversions.
 .\"
 .SH AUTHOR
@@ -64,4 +66,4 @@ Copyright \(co 2024 Emma Tebibyte. License AGPLv3+: GNU AGPL version 3 or later
 .SH SEE ALSO
 GNU
 .BR ls (1),
-The International System of Units (SI) 9th Edition
+.I The International System of Units (SI) 9th Edition

docs/intcmp.1

@@ -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 2024-06-06 "Bonsai Core Utilites 0.13.8"
+.TH INTCMP 1 2024-06-06 "Harakit X.X.X"
 .SH NAME
 intcmp \(en compare integers
 .\"
@@ -28,19 +28,23 @@ Permits a given integer to be less than the following integer.
 .\"
 .SH EXAMPLES
 
-It may help to think of the -e, -g, and -l options as equivalent to the
+It may help to think of the
-infix algebraic \(lq=\(rq, \(lq>\(rq, and \(lq<\(rq operators respectively, with
+.BR -e ,
-each option putting its symbol between every given integer. The following
+.BR -g ,
-example is equivalent to evaluating \(lq1 < 2 < 3\(rq:
+and
+.B -l
+options as equivalent to the infix algebraic \(lq=\(rq, \(lq>\(rq, and \(lq<\(rq
+operators respectively, with each option putting its symbol between every given
+integer. The following example is equivalent to evaluating \(lq1 < 2 < 3\(rq:
 \"
 .RS
-.R intcmp -l 1 2 3
+intcmp -l 1 2 3
 .RE
 .\"
 .SH DIAGNOSTICS
 
-The program will exit with a status code of 0 for a valid expression and with a
+The program will exit with a successfully for a valid expression and with an
-code of 1 for an invalid expression.
+error code of 1 for an invalid expression.
 
 In the event of an error, a debug message will be printed and the program will
 exit with the appropriate
@@ -49,7 +53,8 @@ error code.
 .\"
 .SH BUGS
 
--egl, \(lqequal to or less than or greater than\(rq, exits 0 no matter what for
+.BR -egl ,
+\(lqequal to or less than or greater than\(rq, always exits successfully for
 valid program usage and may be abused to function as an integer validator. Use
 .BR str (1)
 instead.
@@ -57,9 +62,17 @@ instead.
 .SH CAVEATS
 
 There are multiple ways to express compound comparisons; \(lqless than or equal
-to\(rq can be -le or -el, for example.
+to\(rq can be
+.B -le
+or
+.BR -el ,
+for example.
 
-The inequality comparison is -gl or -lg for \(lqless than or greater than\(rq;
+The inequality comparison is
+.B -gl
+.B or
+.B -lg
+for \(lqless than or greater than\(rq;
 this is elegant but unintuitive.
 .\"
 .SH RATIONALE

docs/mm.1

@@ -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 2024-06-06 "Bonsai Core Utilites 0.13.8"
+.TH MM 1 2024-06-17 "Harakit X.X.X"
 .SH NAME
 mm \(en middleman
 .\"
@@ -39,8 +39,8 @@ Causes SIGINT signals to be ignored.
 .\"
 .SH DIAGNOSTICS
 
-If an output cannot be written to, an error occurs. Additional outputs are not
+If an output cannot be written to, an error occurs; however, exiting will be 
-affected and writing to them continues.
+deferred until writing to any other specified outputs completes.
 
 When an error is encountered, a diagnostic message is printed and the program
 exits with the appropriate

docs/npc.1

@@ -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 2024-06-06 "Bonsai Core Utilites 0.13.8"
+.TH NPC 1 2024-06-17 "Harakit X.X.X"
 .SH NAME
 npc \(en show non-printing characters
 .\"
@@ -25,10 +25,10 @@ becomes '^?'. Characters with the high bit set (>127) are printed as 'M-'
 followed by the graphical representation for the same character without the
 high bit set.
 .\"
-.SH USAGE
+.SH OPTIONS
 
 .IP \fB-e\fP
-Prints a dollar sign ('$') before each line ending.
+Prints a dollar sign ('$') before each newline.
 .IP \fB-t\fP
 Prints tab characters as '^I' rather than a literal horizontal tab.
 .\"
@@ -52,8 +52,8 @@ the
 .B -v
 option, is the bandage solution GNU and other software suites use.
 
-This functionality is a separate tool because its usefulness extends beyond that
+This functionality is included in a separate tool because its usefulness extends
-of
+beyond that of
 .BR cat (1p).
 .\"
 .SH AUTHOR

docs/rpn.1

@@ -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 2024-06-06 "Bonsai Core Utilites 0.13.8"
+.TH RPN 1 2024-06-17 "Harakit X.X.X"
 .SH NAME
 rpn \(en reverse polish notation evaluation
 .\"
@@ -18,12 +18,12 @@ rpn
 
 Evaluate reverse polish notation.
 
-The program evaluates reverse polish notation expressions either read from the
+The program evaluates reverse polish notation expressions read either from the
 standard input or parsed from provided arguments. See the STANDARD INPUT
 section.
 
-Upon evaluation, the program will print the resulting number on the stack to the
+Upon evaluation, the resulting number on the stack will be printed to the
-standard output. Any further specified numbers will be placed at the end of the
+standard output. Any further numbers specified will be placed at the end of the
 stack.
 
 For information on for reverse polish notation syntax, see
@@ -31,8 +31,8 @@ For information on for reverse polish notation syntax, see
 .\"
 .SH STANDARD INPUT
 
-If arguments are passed, they are interpreted as an expression to be
+If arguments are specified, they are interpreted as an expression to be
-evaluated. Otherwise, it reads whitespace-delimited numbers and operations from
+evaluated. Otherwise, whitespace-delimited numbers and operations are read from
 the standard input.
 .\"
 .SH DIAGNOSTICS
@@ -46,11 +46,13 @@ error message and continue accepting input.
 .SH CAVEATS
 
 Due to precision constraints and the way floats are represented in accordance
-with the IEEE Standard for Floating Point Arithmetic (\fIIEEE 754\fP),
+with the
-floating-point arithmetic has rounding errors. This is somewhat curbed by using
+.I IEEE Standard for Floating Point Arithmetic
-the machine epsilon as provided by the Rust standard library to which to round
+(\fIIEEE 754\fP), floating-point arithmetic has rounding errors. This is
-numbers. Because of this, variation is expected in the number of decimal places 
+somewhat curbed by using the machine epsilon as provided by the Rust standard
-the program can handle based on the platform and hardware of any given machine.
+library to which numbers are rounded. Because of this, variation is expected in
+the number of decimal places the program can handle based on the platform and
+hardware of any given machine.
 .\"
 .SH RATIONALE
 
@@ -63,8 +65,8 @@ program. A
 pre-dates the standardized
 .BR bc (1p),
 the latter originally being a preprocessor for the former, and was included in
-UNIX v2 onward. While it implements reverse polish notation, it still suffers
+Second Edition UNIX and onward. While it implements reverse polish notation, it
-from being unable to accept an expression as an argument.
+still suffers from being unable to accept an expression as an argument.
 .\"
 .SH AUTHOR
 

docs/scrut.1

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

docs/str.1

@@ -4,9 +4,9 @@
 .\" 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 2024-06-06 "Bonsai Core Utilites 0.13.8"
+.TH STR 1 2024-06-17 "Harakit X.X.X"
 .SH NAME
-str \(en test the character types of string arguments
+str \(en test string arguments
 .\"
 .SH SYNOPSIS
 
@@ -16,7 +16,7 @@ str
 .\"
 .SH DESCRIPTION
 
-Test string arguments.
+Test the character types of string arguments.
 
 The tests in this program are equivalent to the functions with the same names in
 .BR ctype.h (0p)
@@ -24,11 +24,8 @@ and are the methods by which string arguments are tested.
 .\"
 .SH DIAGNOSTICS
 
-If all tests pass, the program will exit with an exit code of 0. If any of the
+If all tests pass, the program will exit successfully. If any of the tests fail,
-tests fail, the program will exit unsuccessfully with an error code of 1.
+the program will exit unsuccessfully with an error code of 1.
-
-An empty string will cause an unsuccessful exit as none of its contents pass any
-tests.
 
 When invoked incorrectly, a debug message will be printed and the program will
 exit with the appropriate
@@ -37,6 +34,9 @@ error code.
 .\"
 .SH CAVEATS
 
+None of an empty string\(cqs contents pass any of the tests, so the program will
+exit unsuccessfully if one is specified.
+
 There\(cqs no way of knowing which argument failed the test without re-testing
 arguments individually.
 

docs/strcmp.1

@@ -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 2024-06-06 "Bonsai Core Utilites 0.13.8"
+.TH STRCMP 1 2024-06-17 "Harakit X.X.X"
 .SH NAME
 strcmp \(en compare strings
 .\"
@@ -28,7 +28,7 @@ than one of the prior strings:
 strcmp b a
 .RE
 
-and with an error code of 255 if it has a greater byte value than one of the
+or with an error code of 255 if it has a greater byte value than one of the
 prior strings:
 
 .RS
@@ -54,7 +54,8 @@ been
 This tool also handles integer comparisons and file scrutiny. These parts of its
 functionality have been broken out into multiple utilities.
 
-This program\(cqs functionality may be performed on a POSIX-compliant system with
+This program\(cqs functionality may be performed on a POSIX-compliant system
+with
 .BR test (1p).
 .\"
 .SH AUTHOR

docs/swab.1

@@ -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 2024-06-06 "Bonsai Core Utilites 0.13.8"
+.TH SWAB 1 2024-06-17 "Harakit X.X.X"
 .SH NAME
 swab \(en swap bytes
 .\"
@@ -56,7 +56,9 @@ error code.
 .\"
 .SH RATIONALE
 
-This program was modeled and named after the conv=swab functionality specified
+This program was modeled and named after the
+.B conv=swab
+functionality specified
 in the
 .BR dd (1p)
 utility. It additionally allows the word size to be configured.
@@ -64,6 +66,12 @@ utility. It additionally allows the word size to be configured.
 This functionality is useful for fixing the endianness of binary files produced
 on other machines.
 .\"
+.SH AUTHOR
+
+Written by DTB
+.MT trinity@trinity.moe
+.ME .
+.\"
 .SH COPYRIGHT
 
 Copyright \(co 2024 DTB. License AGPLv3+: GNU AGPL version 3 or later

docs/true.1

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

src/dj.c

@@ -16,7 +16,6 @@
  * along with this program. If not, see https://www.gnu.org/licenses/.
  */
 
-#include <ctype.h> /* isupper(3), tolower(3) */
 #include <errno.h> /* errno */
 #include <fcntl.h> /* open(2) */
 #include <stdio.h> /* fprintf(3), stderr */
@@ -25,8 +24,12 @@
 #include <sysexits.h> /* EX_OK, EX_USAGE */
 #include <unistd.h> /* close(2), getopt(3), lseek(2), read(2), write(2),
                      * optarg, optind, STDIN_FILENO, STDOUT_FILENO */
+#include <sys/stat.h> /* S_IRGRP, S_IROTH, S_IRUSR, S_IWGRP, S_IWOTH,
+                         S_IWUSR */
 extern int errno;
 
+char *program_name = "dj";
+
 /* dj uses two structures that respectively correspond to the reading and
  * writing ends of its jockeyed "pipe". User-configurable members are noted
  * with their relevant options. */
@@ -41,56 +44,17 @@ struct Io{
 	int prec;		/* partial records processed */
 	int rec;		/* records processed */
 	long seek;		/* bytes to seek/skip (will be 0 after skippage) (-sS) */
-} ep[2]; /* "engineered pipe"; also "extended play", for the deejay */
+}; 
 
-/* Additionally, the following global variables are used to store user options.
+/* To be assigned to main:fmt_output and used with output(). */
- */
+static char *fmt_asv   = "%d\037%d\036%d\037%d\035%d\036%d\034";
+static char *fmt_human = "%d+%d > %d+%d; %d > %d\n";
 
-/* (-a)  */ static int align; /* Only the lower 8b are used but align is
-                               * negative if no alignment is being done. */
-
-/* (-c)  */ static int count; /* 0 if dj(1) runs until no more reads are
-                               * possible. */
-
-/* ASCII field separator delimited statistics */
-            static char *fmt_asv   = "%d\037%d\036%d\037%d\035%d\036%d\034";
-/* human-readable statistics */
-            static char *fmt_human = "%d+%d > %d+%d; %d > %d\n";
-/* pointer to chosen formatting */
-/* (-H)  */ static char *fmt_output; /* fmt_asv (default) or fmt_human (-H) */
-
-/* (-dq) */ static char debug;       /*
- *  -d  increments             dj -qq | 0 - no diagnostic output whatsoever
- *   -q decrements             dj -q  | 1 - typical output without
- *                                    |     notifications on partial reads or
- *                                    |     writes
- *                             dj     | 2 - typical output (default)
- *                             dj -d  | 3 - verbose status messages */
-
-/* (-n)  */ static char noerror;     /* 0 - exits on partial reads or writes
-                                      *     (default)
-                                      * 1 - retries on partial reads/writes
-                                      *     (-n) */
-
-/* Non-configurable defaults. */
-#define bs_default 1024 /* GNU dd(1) default; twice POSIX but a neat 2^10 */
-static char *program_name = "<no argv[0]>";
 static char *stdin_name = "<stdin>";
 static char *stdout_name = "<stdout>";
-static int read_flags = O_RDONLY; /* These flags are consistent with Busybox */
-static int write_flags = O_WRONLY | O_CREAT; /* dd(1). */
 
-/* Macro to set defaults for user-configurable options. */
+static int read_flags = O_RDONLY; /* Consistent with Busybox dd(1). */
-#define setdefaults do{ \
+static int write_flags = O_WRONLY | O_CREAT;
-	align = -1; \
-	count = 0; \
-	debug = 2; \
-	fmt_output = fmt_asv; \
-	noerror = 0; \
-	ep[0].fl = read_flags; \
-	Io_setdefaults(&ep[0]); \
-	ep[1].fl = write_flags; \
-	Io_setdefaults(&ep[1]); }while(0)
 
 #define MIN(a, b) (((a) < (b)) ? (a) : (b))
 
@@ -104,8 +68,8 @@ static int write_flags = O_WRONLY | O_CREAT; /* dd(1). */
  * particular io[2] used in main. Error conditions are not checked because this
  * is only used when the program is about to terminate (hence its name). */
 #define terminate(io) do{ \
-	Io_buffree(&(io)[0]); \
+	free((io[0]).buf); \
-	Io_buffree(&(io)[1]); \
+	free((io[1]).buf); \
 	Io_fdclose(&(io)[0]); \
 	Io_fdclose(&(io)[1]); }while(0)
 
@@ -116,15 +80,6 @@ Io_bufalloc(struct Io *io){
 	return (io->buf = malloc(io->bs * (sizeof *io->buf)));
 }
 
-/* Frees *io's buffer. Returns io. */
-static struct Io *
-Io_buffree(struct Io *io){
-
-	free(io->buf);
-
-	return io;
-}
-
 /* Fills the unused portion of io's buffer with padding, updating io->bufuse.
  * Returns io. */
 static struct Io *
@@ -193,18 +148,18 @@ Io_fdopen(struct Io *io, char *fn){
 	return fd;
 }
 
-/* Seeks io->seek bytes through *io's file descriptor, (counter-intuitively)
+/* Seeks io->seek bytes through *io's file descriptor, subtracting the number
- * returning -1 if successful and a sysexits.h exit code if an unrecoverable
+ * of sought bytes from io->seek. This procedure leaves garbage in io->buf. */
- * error occurred. io->buf will be cleared of useful bytes and io->seek will
+static void
- * be set to zero to indicate the seek occurred. */
-static int
 Io_fdseek(struct Io *io){
-	int (*op)(int, void *, size_t);
 	
-	if(!fdisstd(io->fd) && lseek(io->fd, io->seek, SEEK_SET) != -1)
+	if(io->seek != 0
-		return -1;
+			|| (!fdisstd(io->fd) && lseek(io->fd, io->seek, SEEK_SET) != -1))
+		return;
+
+	if(io->fl == write_flags)
+		memset(io->buf, '\0', io->bs);
 
-	/* repeated code to get the condition out of the loop */
 	if(io->fl == write_flags){
 		memset(io->buf, '\0', io->bs);
 		/* We're going to cheat and use bufuse as the retval for write(2),
@@ -223,12 +178,11 @@ Io_fdseek(struct Io *io){
 				/* second chance */
 				io->bufuse = read(io->fd, io->buf, MIN(io->bs, io->seek));
 		}while((io->seek -= io->bufuse) > 0 && io->bufuse != 0);
-	}else
+	}
-		return EX_SOFTWARE;
 
 	io->bufuse = 0;
 
-	return -1;
+	return;
 }
 
 /* Reads io->bs bytes from *io's file descriptor into io->buf, storing the
@@ -242,23 +196,6 @@ Io_read(struct Io *io){
 	return io;
 }
 
-/* Sets the variables in a struct *io to the defaults. Identifies the read/
- * write ends of the "pipe" by checking io->fl. Returns io. */
-static struct Io *
-Io_setdefaults(struct Io *io){
-
-	io->bs = bs_default;
-	io->buf = NULL;
-	io->bytes = 0;
-	io->fd = (io->fl == read_flags) ? STDIN_FILENO : STDOUT_FILENO;
-	io->fn = (io->fl == read_flags) ? stdin_name   : stdout_name;
-	io->prec = 0;
-	io->rec = 0;
-	io->seek = 0;
-
-	return io;
-}
-
 /* Writes io->bufuse units from io->buf to io->fd, permuting any unwritten
  * bytes to the start of io->buf and updating io->bufuse. If io->bufuse doesn't
  * change, errno will probably be set. Returns io. */
@@ -284,14 +221,13 @@ oserr(char *s){
 }
 
 /* Prints statistics regarding the use of dj, particularly partially and
- * completely read and written records, accessing debug, ep, and fmt_output. */
+ * completely read and written records. */
 static void
-output(void){
+output(struct Io io[2], char *fmt){
 
-	if(debug >= 1)
+	fprintf(stderr, fmt,
-		fprintf(stderr, fmt_output,
+		io[0].rec, io[0].prec, io[1].rec, io[1].prec,
-			ep[0].rec, ep[0].prec, ep[1].rec, ep[1].prec,
+		io[0].bytes, io[1].bytes);
-			ep[0].bytes, ep[1].bytes);
 
 	return;
 }
@@ -311,142 +247,147 @@ parse(char *s){
 }
 
 static int
-usage(void){
+usage(char *s){
 
-	fprintf(stderr, "Usage: %s (-AdfHqQ) (-a [byte]) (-c [count])\n"
+	fprintf(stderr, "Usage: %s (-Hn) (-a [byte]) (-c [count])\n"
 		"\t(-i [input file]) (-b [input block size]) (-s [input offset])\n"
 		"\t(-o [output file]) (-B [output block size]) (-S [output offset])\n",
-		program_name);
+		s);
 
 	return EX_USAGE;
 }
 
 int main(int argc, char *argv[]){
-	int c;
+	int align; /* low 8b used, negative if no alignment is being done */
-	int i;
+	int count; /* 0 if dj(1) runs until no more reads are possible */
+	char *fmt_output; /* == fmt_asv (default) or fmt_human (-H) */
+	size_t i; /* side of io being modified */
+	struct Io io[2];
+	char noerror; /* 0=exits (default) 1=retries on partial reads or writes */
 
-	setdefaults;
+	/* Set defaults. */
+	align = -1;
+	count = 0;
+	fmt_output = fmt_asv;
+	noerror = 0;
+	for(i = 0; i < 2; ++i){
+		io[i].bs = 1024 /* 1 KiB */; /* GNU dd(1) default; POSIX says 512B */
+		io[i].bytes = 0;
+		io[i].fd = i ? STDIN_FILENO : STDOUT_FILENO;
+		io[i].fn = i ? stdin_name   : stdout_name;
+		io[i].fl = i ? read_flags   : write_flags;
+		io[i].prec = 0;
+		io[i].rec = 0;
+		io[i].seek = 0;
+	}
 
 	if(argc > 0){
+		int c;
+
 		program_name = argv[0];
-		while((c = getopt(argc, argv, "a:Ab:B:c:di:hHnqs:S:o:")) != -1)
+		while((c = getopt(argc, argv, "a:b:B:c:i:hHns:S:o:")) != -1)
 			switch(c){
-			case 'i': case 'o':
+			case 'i': case 'o': i = (c == 'o');
-				i = (c == 'o');
 				if(optarg[0] == '-' && optarg[1] == '\0'){ /* optarg == "-" */
-					ep[i].fd = (i == 0) ? STDIN_FILENO : STDOUT_FILENO;
+					io[i].fd = i ? STDIN_FILENO : STDOUT_FILENO;
-					ep[i].fn = (i == 0) ? stdin_name   : stdout_name;
+					io[i].fn = i ? stdin_name   : stdout_name;
 					break;
-				}else if(Io_fdopen(&ep[i], optarg) != -1)
+				}else if(Io_fdopen(&io[i], optarg) != -1)
 					break;
-				terminate(ep);
+				terminate(io);
 				return oserr(optarg);
-			case 'A': align = '\0'; break;
-			case 'd': ++debug; break;
 			case 'n': noerror = 1; break;
 			case 'H': fmt_output = fmt_human; break;
-			case 'q': --debug; break;
 			case 'a':
-				if(optarg[0] != '\0' && optarg[1] == '\0'){
+				if(optarg[0] == '\0' || optarg[1] == '\0'){
 					align = optarg[0];
 					break;
 				}
 				/* FALLTHROUGH */
-			case 'c': case 'b': case 's': case 'B': case 'S':
+			case 'c': case 'b': case 's': case 'B': case 'S': /* numbers */
 				if(c == 'c' && (count = parse(optarg)) >= 0)
 					break;
-				i = isupper(c);
+				i = (c >= 'A' && c <= 'Z'); /* uppercase changes output */
-				c = tolower(c);
+				c &= 0x20 /* 0b 0010 0000 */; /* (ASCII) make lowercase */
-				if((c == 'b' && (ep[i].bs = parse(optarg)) > 0)
+				if((c == 'b' && (io[i].bs = parse(optarg)) > 0)
-						|| (c == 's' && (ep[i].seek = parse(optarg)) >= 0))
+						|| (c == 's' && (io[i].seek = parse(optarg)) >= 0))
 					break;
 				/* FALLTHROUGH */
 			default:
-				terminate(ep);
+				terminate(io);
-				return usage();
+				return usage(program_name);
 			}
 	}
 
-	if(debug >= 3)
-		fprintf(stderr,
-			"argv0=%s\n"
-			"in=%s\tibs=%d\tskip=%ld\talign=%hhx\tcount=%d\n"
-			"out=%s\tobs=%d\tseek=%ld\tdebug=%2d\tnoerror=%d\n",
-			program_name,
-			ep[0].fn, ep[0].bs, ep[0].seek, align, count,
-			ep[1].fn, ep[1].bs, ep[1].seek, debug, noerror);
-
 	if(argc > optind){
-		terminate(ep);
+		terminate(io);
-		return usage();
+		return usage(program_name);
 	}
 
-	for(i = 0; i <= 1; ++i){
+	for(i = 0; i < 2; ++i){
-		if(Io_bufalloc(&ep[i]) == NULL){
+		if(Io_bufalloc(&io[i]) == NULL){
 			fprintf(stderr, "%s: Failed to allocate %d bytes\n",
-				program_name, ep[i].bs);
+				program_name, io[i].bs);
-			terminate(ep);
+			terminate(io);
 			return EX_OSERR;
-		}else if(ep[i].seek > 0)
+		}else if(io[i].seek > 0)
-			switch(Io_fdseek(&ep[i])){
+			Io_fdseek(&io[i]);
-			case EX_OK:
+			if(io[i].seek > 0){
-				output();
+				terminate(io);
-				terminate(ep);
+				return oserr(io[i].fn);
-				return EX_OK;
 			}
 	}
 
 	do{	/* read */
-		Io_read(&ep[0]);
+		Io_read(&io[0]);
-		if(!noerror && ep[0].bufuse == 0)
+		if(!noerror && io[0].bufuse == 0)
-			Io_read(&ep[0]); /* second chance */
+			Io_read(&io[0]); /* second chance */
-		if(ep[0].bufuse == 0) /* that's all she wrote */
+		if(io[0].bufuse == 0) /* that's all she wrote */
 			break;
-		else if(ep[0].bufuse < ep[0].bs){
+		else if(io[0].bufuse < io[0].bs){
-			++ep[0].prec;
+			++io[0].prec;
-			if(debug >= 2){
+			fprintf(stderr, "%s: Partial read:\n\t", program_name);
-				fprintf(stderr, "%s: Partial read:\n\t", program_name);
+			output(io, fmt_output);
-				output();
-			}
 			if(!noerror)
 				count = 1;
 			if(align >= 0)
-				Io_bufrpad(&ep[0], align);
+				Io_bufrpad(&io[0], align);
 		}else
-			++ep[0].rec;
+			++io[0].rec;
 
 		/* write */
-		do{	if(ep[1].bs > ep[0].bs){ /* io[1].bs > io[0].bs */
+		do{
-				Io_bufxapp(&ep[1], &ep[0]);
+			int t;
-				if(ep[0].bs + ep[1].bufuse <= ep[1].bs && count != 1)
+
+			if(io[1].bs > io[0].bs){
+				Io_bufxapp(&io[1], &io[0]);
+				if(io[0].bs + io[1].bufuse <= io[1].bs && count != 1)
 					continue; /* we could write more */
 			}else
-				Io_bufxfer(&ep[1], &ep[0], MIN(ep[0].bufuse, ep[1].bs));
+				Io_bufxfer(&io[1], &io[0], MIN(io[0].bufuse, io[1].bs));
 
-			c = ep[1].bufuse;
+			t = io[1].bufuse;
-			Io_write(&ep[1]);
+			Io_write(&io[1]);
-			if(!noerror && ep[1].bufuse == c)
+			if(!noerror && io[1].bufuse == t)
-				Io_write(&ep[1]); /* second chance */
+				Io_write(&io[1]); /* second chance */
-			if(c == ep[1].bufuse){ /* no more love */
+			if(t == io[1].bufuse){ /* no more love */
 				count = 1;
 				break;
-			}else if(c > ep[1].bufuse && ep[1].bufuse > 0){
+			}else if(t > io[1].bufuse && io[1].bufuse > 0){
-				ep[1].prec += 1;
+				io[1].prec += 1;
-				if(debug >= 2){
+				fprintf(stderr, "%s: Partial write:\n\t", program_name);
-					fprintf(stderr, "%s: Partial write:\n\t", program_name);
+				output(io, fmt_output);
-					output();
-				}
 				if(!noerror)
 					count = 1;
-			}else if(ep[1].bufuse == 0 && c < ep[1].bs)
+			}else if(io[1].bufuse == 0 && t < io[1].bs)
-				++ep[1].prec;
+				++io[1].prec;
 			else
-				++ep[1].rec;
+				++io[1].rec;
-		}while(ep[0].bufuse > 0);
+		}while(io[0].bufuse > 0);
 	}while(count == 0 || --count > 0);
 
-	output();
+	output(io, fmt_output);
-	terminate(ep);
+	terminate(io);
 
 	return EX_OK;
 }

src/fop.rs

@@ -32,7 +32,7 @@ use sysexits::{ EX_DATAERR, EX_IOERR, EX_UNAVAILABLE, EX_USAGE };
 
 fn main() {
 	let argv = args().collect::<Vec<String>>();
-	let mut d = 0x1E.to_string();
+	let mut d = '\u{1E}'.to_string();
 	let mut arg_parser = Parser::new(&argv, "d:");
 
 	while let Some(opt) = arg_parser.next() {