Makefile: eep: update recipe

CONDUCT

@@ -0,0 +1,83 @@
+Code of Conduct
+
+This Code of Conduct is derived from the 10 Pāramitās of Theravadin Buddhism.
+You can read more about them in Ṭhānissaro Bhikkhu’s Ten Perfections: A Study
+Guide [0].
+
+1. Generosity (Dāna)
+
+Give contributions freely and willingly under the terms of the GNU Affero
+General Public License, version 3 or later, or a compatible license.
+
+2. Ethics (Sīla)
+
+Do not use nonfree code or uncredited code in contributions. Do not contribute
+code of dubious origins, such as code generated by large language models or
+unlicensed snippets found online [1]. Do not take credit for others’
+contributions. Make sure to utilize the copyright header and license notice on
+source files to credit yourself and others for their work.
+
+3. Renunciation (Nekkhamma)
+
+Stay committed to the principles of simplicity and interoperability embodied by
+the project. Keep your personal will and desire out of the project, for it can
+only prove harmful to its success.
+
+4. Wisdom (Pañña)
+
+Look to established sources for standards, best practices, and important
+implementation details when setting new precedence. Follow the existing
+precedence where it applies.
+
+5. Energy (Viriya)
+
+Focus on the currently-open, currently-assigned, and currently-in-progress
+issues, pull requests, and other endeavors in order to keep yourself and others
+from being overwhelmed with responsibility, either from your zeal or your
+negligence.
+
+If you notice an issue, open an issue as soon as you can. If you see a neglected
+branch, open a pull request or comment on an existing one, if applicable. Be
+diligent in your commitment to making this project work.
+
+6. Patience (Khanti)
+
+Be patient with maintainers and other contributors. We all have our own lives
+going on and may need significant time to get to things.
+
+7. Truthfulness (Sacca)
+
+Communicate honestly and openly. Do not embellish facts to get your way. Make
+sure to let maintainers know about any issues along the way and keep ample
+communication channels open.
+
+8. Determination (Adhiṭṭhāna)
+
+Stay focused on long-term objectives and cultivate attainment to that
+achievement by utilizing to the fullest extent possible the tools available to
+you for managing the workload.
+
+9. Loving-Kindness (Mettā)
+
+Treat everyone with respect, even if they treat you poorly. This does not mean
+you have to put up with abuse, but make sure to respond with kindness and with
+love in your heart. Support and uplift maintainers and other contributors with
+your words and actions.
+
+Do not use angry or hateful language toward contributors, such as demeaning
+phrases and slurs. Make sure that if you do not know the pronouns of a
+contributor to ask for them and, in the meantime, use gender-neutral they/them
+or equivalent pronouns.
+
+10. Equanimity (Upekkhā)
+
+Keep a balanced perspective on all suggestions and contributions and make
+judgements not from a place of ego and personal preference but on their
+usefulness and suitability to the project. Make sure to keep an eye on the
+bigger picture as implementing individual features may seem intuitive at first
+but scale poorly in practical use. Keep a level head about your own work: it is
+not shameful to make a mistake in this vein, and fixing it usually leads to
+more insight.
+
+[0] <https://www.dhammatalks.org/books/#/books/TenPerfections/Section0001.html>
+[1] <https://www.fsf.org/news/publication-of-the-fsf-funded-white-papers-on-questions-around-copilot>

CONTRIBUTING

@@ -1,3 +1,5 @@
+Make sure to read our code of conduct in the CONDUCT file.
+
 When contributing a pull request to the main branch, please sign your commits
 with a PGP key and add your name and the year to the bottom of the list of
 copyright holders for the file. For example, an existing copyright header might

Makefile

@@ -1,61 +1,77 @@
 # Copyright (c) 2023–2024 Emma Tebibyte <emma@tebibyte.media>
 # Copyright (c) 2023–2024 DTB <trinity@trinity.moe>
 # Copyright (c) 2023 Sasha Koshka <sashakoshka@tebibyte.media>
+# Copyright (c) 2024 Aaditya Aryal <aryalaadi123@gmail.com>
 # SPDX-License-Identifier: FSFAP
 #
 # Copying and distribution of this file, with or without modification, are
 # permitted in any medium without royalty provided the copyright notice and this
 # notice are preserved.  This file is offered as-is, without any warranty.
 
+# The octal escape \043 is utilized twice in this file as make(1p) will
+# interpret a hash in a rule as an inline comment.
+
 .POSIX:
-.PRAGMA: posix_202x # future POSIX standard support à la pdpmake(1)
-.PRAGMA: command_comment # breaks without this?
 
-PREFIX=/usr/local
+DESTDIR ?= dist
+PREFIX ?= /usr/local
 
-CC=cc
+MANDIR != [ $(PREFIX) = / ] && printf '/usr/share/man\n' \
-RUSTC=rustc
+	|| printf '/share/man\n'
+SYSEXITS != printf '\043include <sysexits.h>\n' | cpp -M - | sed 's/ /\n/g' \
+	| sed -n 's/sysexits\.h//p' || printf 'include\n'
+
+CC ?= cc
+RUSTC ?= rustc
+RUSTLIBS = --extern getopt=build/o/libgetopt.rlib \
+	--extern sysexits=build/o/libsysexits.rlib \
+	--extern strerror=build/o/libstrerror.rlib
+CFLAGS += -I$(SYSEXITS)
 
 .PHONY: all
-all: dj false fop hru intcmp mm rpn scrut str strcmp swab true
+all: dj eep 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
-	# https://github.com/rust-lang/rust-bindgen/issues/2703
 	mkdir -p build/bin build/include build/lib build/o build/test
 
 .PHONY: clean
 clean:
-	rm -rf build/ dist/
+	rm -rf build dist
 
 dist: all
-	mkdir -p dist/bin dist/share/man/man1
+	mkdir -p $(DESTDIR)/$(PREFIX)/bin $(DESTDIR)/$(PREFIX)/share/man/man1
-	cp build/bin/* dist/bin/
+	cp build/bin/* $(DESTDIR)/$(PREFIX)/bin
-	cp docs/*.1 dist/share/man/man1/
+	cp docs/*.1 $(DESTDIR)/$(PREFIX)/$(MANDIR)/man1
 
 .PHONY: install
 install: dist
-	mkdir -p $(PREFIX)
+	cp -r $(DESTDIR)/* /
-	cp -r dist/* $(PREFIX)/
 
 .PHONY: test
 test: build
 	tests/posix-compat.sh
 	$(RUSTC) --test src/getopt-rs/lib.rs -o build/test/getopt
 
-build/o/libsysexits.rlib: build
+.PHONY: rustlibs
-	# bandage solution until bindgen(1) gets stdin support
+rustlibs: build/o/libsysexits.rlib build/o/libgetopt.rlib \
-	printf '#define EXIT_FAILURE 1\n' | cat - include/sysexits.h \
+	build/o/libstrerror.rlib
+
+build/o/libgetopt.rlib: build src/getopt-rs/lib.rs
+	$(RUSTC) $(RUSTFLAGS) --crate-type=lib --crate-name=getopt \
+		-o $@ src/getopt-rs/lib.rs
+
+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
+	printf '\043define EXIT_FAILURE 1\n' | cat - $(SYSEXITS)sysexits.h \
 		> build/include/sysexits.h 
 	bindgen --default-macro-constant-type signed --use-core --formatter=none \
-		"$$(printf '#include <sysexits.h>\n' \
+		build/include/sysexits.h | $(RUSTC) $(RUSTFLAGS) --crate-type lib -o $@ -
-			| cpp -M -idirafter "build/include" - \
-			| sed 's/ /\n/g' | grep sysexits.h)" \
-		| $(RUSTC) $(RUSTFLAGS) --crate-type lib -o build/o/libsysexits.rlib -
-
-build/o/libgetopt.rlib: src/getopt-rs/lib.rs
-	$(RUSTC) $(RUSTFLAGS) --crate-type=lib --crate-name=getopt \
-		-o build/o/libgetopt.rlib src/getopt-rs/lib.rs
 
 .PHONY: dj
 dj: build/bin/dj
@@ -69,17 +85,13 @@ build/bin/false: src/false.c build
 
 .PHONY: fop
 fop: build/bin/fop
-build/bin/fop: src/fop.rs build build/o/libgetopt.rlib build/o/libsysexits.rlib
+build/bin/fop: src/fop.rs build rustlibs
-	$(RUSTC) $(RUSTFLAGS) --extern getopt=build/o/libgetopt.rlib \
+	$(RUSTC) $(RUSTFLAGS) $(RUSTLIBS) -o $@ src/fop.rs
-		--extern sysexits=build/o/libsysexits.rlib \
-		-o $@ src/fop.rs
 
 .PHONY: hru
 hru: build/bin/hru
-build/bin/hru: src/hru.rs build build/o/libgetopt.rlib build/o/libsysexits.rlib
+build/bin/hru: src/hru.rs build rustlibs 
-	$(RUSTC) $(RUSTFLAGS) --extern getopt=build/o/libgetopt.rlib \
+	$(RUSTC) $(RUSTFLAGS) $(RUSTLIBS) -o $@ src/hru.rs
-		--extern sysexits=build/o/libsysexits.rlib \
-		-o $@ src/hru.rs
 
 .PHONY: intcmp
 intcmp: build/bin/intcmp
@@ -91,18 +103,26 @@ mm: build/bin/mm
 build/bin/mm: src/mm.c build
 	$(CC) $(CFLAGS) -o $@ src/mm.c
 
+.PHONY: npc
+npc: build/bin/npc
+build/bin/npc: src/npc.c build
+	$(CC) $(CFLAGAS) -o $@ src/npc.c
+
 .PHONY: rpn
 rpn: build/bin/rpn
-build/bin/rpn: src/rpn.rs build build/o/libsysexits.rlib
+build/bin/rpn: src/rpn.rs build rustlibs
-	$(RUSTC) $(RUSTFLAGS) \
+	$(RUSTC) $(RUSTFLAGS) $(RUSTLIBS) -o $@ src/rpn.rs
-		--extern sysexits=build/o/libsysexits.rlib \
-		-o $@ src/rpn.rs
 
 .PHONY: scrut
 scrut: build/bin/scrut
 build/bin/scrut: src/scrut.c build
 	$(CC) $(CFLAGS) -o $@ src/scrut.c
 
+.PHONY: eep
+eep: build/bin/eep
+build/bin/eep: src/eep.rs build rustlibs
+	$(RUSTC) $(RUSTFLAGS) -o $@ src/eep.rs
+
 .PHONY: str
 str: build/bin/str
 build/bin/str: src/str.c build

README

@@ -1,9 +1,11 @@
 “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 core utilities are a replacement for standard POSIX utilities which
-current state of POSIX and Unix utilies. The Unix Philosophy, “do one thing and
+aim to fill its niche while expanding on their capabilities. These new tools are
-do it well” is its core but these tools do not cling to the names of the past.
+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
@@ -20,9 +22,9 @@ See docs/ for more on the specific utilities currently implemented.
 Building
 
 The coreutils require a POSIX-compliant environment to compile, including a C
-compiler and preprocessor (cc(1) and cpp(1) by default) with the -idirafter
+compiler and preprocessor (cc(1) and cpp(1) by default), an edition 2023 Rust
-flag, a Rust compiler (rustc(1) by default), bindgen(1), and a POSIX-compliant
+compiler (rustc(1) by default), bindgen(1), and a POSIX-compliant make(1)
-make(1) utility.
+utility.
 
 To build and install:
 
@@ -38,7 +40,7 @@ To test the utilities:
 
 $ make test
 
-To remove all untracked files:
+To remove all build and distributable files:
 
 $ make clean
 

docs/dj.1

@@ -3,13 +3,11 @@
 .\"
 .\" 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-17 "Bonsai Core Utilites 0.13.11"
-
 .SH NAME
-
 dj \(en disk jockey
-
+.\"
 .SH SYNOPSIS
 
 dj
@@ -20,134 +18,103 @@ dj
 .RB [ count ])
 
 .RB ( -i
-.R [
+[\fBinput file\fP])
-.B input file
-.R ])
 .RB ( -b
-.R [
+[\fBinput block size\fP])
-.B input block size
-.R ])
 .RB ( -s
-.R [
+[\fBinput offset\fP])
-.B input offset
-.R ])
 
 .RB ( -o
-.R [
+[\fBoutput file\fP])
-.B output file
-.R ])
 .RB ( -B
-.R [
+[\fBoutput block size\fP])
-.B output block size
-.R ])
 .RB ( -S
-.R [
+[\fBoutput offset\fP])
-.B output offset
+.\"
-.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.
+
+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
 
-.B -i
+.IP \fB-i\fP
-.RS
+Takes a file path as an argument and opens it for use as an input.
-Takes a file path as an argument to open and use as an input.
+.IP \fB-b\fP
-.RE
+Takes a numeric argument as the size in bytes of the input buffer, the default
-
+being 1024.
-.B -b
+.IP \fB-s\fP
-.RS
-Takes a numeric argument as the size in bytes of the input buffer, with the
-default being 1024 bytes or one kibibyte (KiB).
-.RE
-
-.B -s
-.RS
 Takes a numeric argument as the number of bytes to skip into the input
 before starting to read. If the standard input is used, bytes read to this point
 are discarded.
-.RE
+.IP \fB-o\fP
-
+Takes a file path as an argument and opens it for use as an output.
-.B -o
+.IP \fB-B\fP
-.RS
-Takes a file path as an argument to open and use as an output.
-.RE
-
-.B -B
-.RS
 Does the same as
 .B -b
 but for the output buffer.
-.RE
+.IP \fB-S\fP
-
+Seeks a number of bytes through the output before starting to write from
-.B -S
-.RS
-Skips a number of bytes through the output before starting to write from
 the input. If the output is a stream, null characters are printed.
-.RE
+.IP \fB-a\fP
-
+Accepts a single literal byte with which the input buffer is padded in the event
-.B -a
-.RS
-Accepts a single literal byte with which input buffer is padded in the event
 of an incomplete read from the input file.
-.RE
+.IP \fB-A\fP
-
+Specifying this option pads the input buffer with null bytes in the event of an
-.B -c
+incomplete read. This is equivalent to specifying
-.RS
-Specifies a number of reads to make. If set to zero (the default), reading will
-continue until a partial or empty read is encountered.
-.RE
-
-.B -A
-.RS
-If the output is a stream, null bytes are printed. This option is equivalent to
-specifying
 .B -a
 with a null byte instead of a character.
-.RE
+.IP \fB-c\fP
-
+Specifies a number of reads to make. The default is 0, in which case the
-.B -d
+input is read until a partial or empty read is made.
-.RS
+.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
+DIAGNOSTICS section. Each invocation increments the debug level of the
 program.
-.RE
+.IP \fB-H\fP
-
-.B -H
-.RS
 Prints diagnostics messages in a human-readable manner as described in the
-DIAGNOSTICS section below.
+DIAGNOSTICS section.
-.RE
+.IP \fB-n\fP
-
+Retries failed reads once before exiting.
-.B -n
+.IP \fB-q\fP
-.RS
-Retries failed reads once more before exiting.
-.RE
-
-.B -q
-.RS
 Suppresses error messages which print when a read or write is partial or
 empty. Each invocation decrements the debug level of the program.
-.RE
+.\"
-
 .SH STANDARD INPUT
 
-The standard input shall be used as an input if no inputs are specified one or
+The standard input shall be used as an input if no inputs are specified or if
-more of the input files is “-”.
+one or more of the input files is \(lq-\(rq.
-
+.\"
+.SH STANDARD OUTPUT
+The standard output shall be used as an output if no inputs are specified or if
+one or more of the input files is \(lq-\(rq.
+.\"
 .SH DIAGNOSTICS
 
-On a partial or empty read, a diagnostic message is printed (unless the
+On a partial or empty read, unless the
 .B -q
-option is specified) and the program exits (unless the
+option is specified, 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
+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}
+{records read} {ASCII unit separator} {partial records read}
-.R {ASCII record separator} {records written} {ASCII unit separator}
+{ASCII record separator} {records written} {ASCII unit separator}
-.R {partial records written} {ASCII group separator} {bytes read}
+{partial records written} {ASCII group separator} {bytes read}
-.R {ASCII record separator} {bytes written} {ASCII file separator}
+{ASCII record separator} {bytes written} {ASCII file separator}
 .RE
 
 This format for diagnostic output is designed to be machine-parseable for
@@ -156,62 +123,67 @@ 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}
+{records read} '+' {partial records read} '>' {records written}
-.R '+' {partial records written} ';' {bytes read} '>' {bytes written}
+'+' {partial records written} ';' {bytes read} '>' {bytes written}
-.R {ASCII line feed}
+{ASCII line feed}
 .RE
 
 If the
 .B -d
-option is specified, debug output will be printed at the beginning of execution.
+option is specified, debug information will be printed at the beginning of
-This debug information contains information regarding how the program was
+execution. This output 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
-.R argv0=dj
+argv0=dj
-.R in=<stdin>      ibs=1024        skip=0  align=ff       count=0
+in=<stdin>      ibs=1024        skip=0  align=ff       count=0
-.R out=<stdout>    obs=1024        seek=0  debug= 3       noerror=0
+out=<stdout>    obs=1024        seek=0  debug= 3       noerror=0
 .RE
 
-In non-recoverable errors that don’t pertain to the read-write cycle, a
+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
-sysexits.h(3) status.
+.BR sysexits.h (3)
-
+status.
+.\"
 .SH BUGS
 
 If
 .B -n
-is specified along with a specified count, actual byte output may be lower than
+is specified along with the
-expected (the product of the count multiplied by the input block size). If 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
 or
 .B -A
-options are used this could make data written nonsensical.
+options are specified, this could make written data nonsensical.
-
+.\"
-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 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 dd(1p) utility as specified in POSIX. While
+This program was based on the
-character conversion may have been the original intent of dd(1p), it is
+.BR dd (1p)
-irrelevant to its modern use. Because of this, it eschews character conversion
+utility as specified in POSIX. While character conversion may have been the
-and adds typical option formatting, allowing seeks to be specified in bytes
+original intent of
-rather than in blocks, allowing arbitrary bytes as padding, and printing in a
+.BR dd (1p),
-format that’s easy to parse for machines.
+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 © 2023 DTB. License AGPLv3+: GNU AGPL version 3 or later
+Copyright \(co 2023 DTB. License AGPLv3+: GNU AGPL version 3 or later
 <https://gnu.org/licenses/agpl.html>.
-
+.\"
 .SH SEE ALSO
-
+.BR dd (1p)
-dd(1p)

docs/eep.1

@@ -0,0 +1,43 @@
+.\" Copyright (c) 2024 DTB <trinity@trinity.moe>
+.\" Copyright (c) 2024 Emma Tebibyte <emma@tebibyte.media>
+.\"
+.\" 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 EEP 1
+.SH NAME
+eep \(en wait a moment
+.\"
+.SH SYNOPSIS
+
+eep
+.RB [ seconds ]
+.\"
+.SH DESCRIPTION
+
+Wait a specified number of seconds before exiting.
+.\"
+.SH DIAGNOSTICS
+
+If the specified time fails to elapse or in the case of incorrect invocation,
+the program will exit unsuccessfully. In the latter scenario, a debug message
+will be printed.
+.\"
+.SH CAVEATS
+
+User may still be tired after invocation.
+.\"
+.SH AUTHOR
+
+Written by DTB
+.MT trinity@trinity.moe
+.ME .
+.\"
+.SH COPYRIGHT
+
+Copyright \(co 2024 DTB. License AGPLv3+: GNU AGPL version 3 or later
+<https://gnu.org/licenses/gpl.html>.
+.\"
+.SH SEE ALSO
+.BR sleep (3p)
+.BR sleep (1p)

docs/false.1

@@ -3,32 +3,33 @@
 .\"
 .\" 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.11"
-
 .SH NAME
-
 false \(en do nothing, unsuccessfully
-
+.\"
 .SH DESCRIPTION
 
-Do nothing regardless of operands or standard input.
+Do nothing regardless of operands or standard input. An exit code of 1 will
-An exit code of 1 will always be returned.
+always be returned.
-
+.\"
 .SH RATIONALE
 
-In POSIX.1-2017, false(1p) exists for the construction of control flow and loops
+In POSIX.1-2017,
-based on a failure. This implementation functions as described in that standard.
+.BR false (1p)
-
+exists for the construction of control flow and loops based on a failure. This
+implementation functions as described in that standard.
+.\"
 .SH AUTHOR
 
-Written by Emma Tebibyte <emma@tebibyte.media>.
+Written by Emma Tebibyte
-
+.MT emma@tebibyte.media
+.ME .
+.\"
 .SH COPYRIGHT
 
 This work is marked with CC0 1.0. To see a copy of this license, visit
 <http://creativecommons.org/publicdomain/zero/1.0>.
-
+.\"
 .SH SEE ALSO
-
+.BR true (1p)
-true(1p)

docs/fop.1

@@ -3,13 +3,11 @@
 .\"
 .\" 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-17 "Bonsai Core Utilites 0.13.11"
-
 .SH NAME
-
 fop \(en field operator
-
+.\"
 .SH SYNOPSIS
 
 fop
@@ -17,44 +15,48 @@ fop
 .RB [ delimiter ]
 .RB index 
 .RB program...
-
+.\"
 .SH DESCRIPTION
 
-Performs operations on specified fields in input data.
+Performs operations on specified fields in data read from the standard input.
-
+.\"
 .SH OPTIONS
 
-.B -d
+.IP \fB-d\fP
-.RS
 Sets a delimiter by which the input data will be split into fields. The default
-is an ASCII record separator (␞).
+is an ASCII record separator.
-.RE
+.\"
-
-.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.
-
+.\"
 .SH RATIONALE
 
 With the assumption that tools will output data separated with ASCII field
-separators, there is 
+separators, there is a need for the ability to modify select fields in this data
+easily and quickly.
 
-The idea for this utility originated in the fact that GNU ls(1) utility contains
+The idea for this utility originated in the fact that the GNU
-a
+.BR ls (1)
+utility contains a
 .B -h
 option which enables human-readable units in file size outputs. This
-functionality was broken out into hru(1), but there was no easy way to modify
+functionality was broken out into
-the field in the ouput of ls(1p) without a new tool.
+.BR hru (1),
+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 © 2024 Emma Tebibyte. License AGPLv3+: GNU AGPL version 3 or later
+Copyright \(co 2024 Emma Tebibyte. License AGPLv3+: GNU AGPL version 3 or later
 <https://gnu.org/licenses/agpl.html>.
-
+.\"
 .SH SEE ALSO
-
+.BR sed (1p)
-sed(1p)

docs/hru.1

@@ -2,58 +2,68 @@
 .\"
 .\" 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-17 "Bonsai Core Utilites 0.13.11"
-
 .SH NAME
-
 hru \(en human readable units
-
+.\"
 .SH SYNOPSIS
 
 hru
-
+.\"
 .SH DESCRIPTION
 
 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.
-
+.\"
 .SH DIAGNOSTICS
 
 If encountering non-integer characters in the standard input, the program will
-exit with the appropriate error code as defined by sysexits.h(3) and print an
+exit with the appropriate error code as defined by
-error message.
+.BR sysexits.h (3)
-
+and print an error message.
+.\"
 .SH RATIONALE
 
-The GNU project’s ls(1) implementation contains a human-readable option (-h)
+The GNU project\(cqs
-that, when specified, makes the tool print size information in a format more
+.BR ls (1)
-immediately readable. This functionality is useful not only in the context of
+implementation contains a human-readable option (\fB-h\fP) that, when specified,
-ls(1) so the decision was made to split it into a new tool. The original
+makes the tool print size information in a format more immediately
-functionality in GNU’s ls(1) can be emulated with fop(1) combined with this
+readable. This functionality is useful not only in this context, so the decision
-program.
+was made to split it into a new tool. The original functionality from GNU\(cqs
-
+.BR ls (1)
+can be emulated with
+.BR fop (1)
+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
+.I Bureau International des Poids et Mesures
-(SI) are utilized for the ouput of conversions.
+.RI ( BIPM )
-
+in the ninth edition of
+.I The International System of Units
+.RI ( SI )
+are utilized for the ouput of conversions.
+.\"
 .SH AUTHOR
 
-Written by Emma Tebibyte <emma@tebibyte.media>.
+Written by Emma Tebibyte
-
+.MT emma@tebibyte.media
+.ME .
+.\"
 .SH COPYRIGHT
 
-Copyright (c) 2024 Emma Tebibyte. License AGPLv3+: GNU AGPL version 3 or later
+Copyright \(co 2024 Emma Tebibyte. License AGPLv3+: GNU AGPL version 3 or later
 <https://gnu.org/licenses/agpl.html>.
-
+.\"
 .SH SEE ALSO
-
+GNU
-GNU ls(1), The International System of Units (SI) 9th Edition
+.BR ls (1),
+.I The International System of Units (SI) 9th Edition

docs/intcmp.1

@@ -3,90 +3,103 @@
 .\"
 .\" 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.11"
-
 .SH NAME
-
 intcmp \(en compare integers
-
+.\"
 .SH SYNOPSIS
 
 intcmp
 .RB ( -egl )
 .RB [ integer ]
 .RB [ integer... ]
-
 .SH DESCRIPTION
-
 Compare integers to each other.
+.\"
+.SH OPTIONS
 
-.SH USAGE
+.IP \fB-e\fP
-
-.B -e
-.RS
 Permits given integers to be equal to each other.
-.RE
+.IP \fB-g\fP
-
-.B -g
-.RS
 Permits a given integer to be greater than the following integer.
-.RE
+.IP \fB-l\fP
-
-.B -l
-.RS
 Permits a given integer to be less than the following integer.
-.RE
+.\"
-
 .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 “=”, “>”, and “<” operators respectively, with each option
+.BR -e ,
-putting its symbol between every given integer. The following example is
+.BR -g ,
-equivalent to evaluating “1 < 2 < 3”:
+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 sysexits.h(3) error code.
+exit with the appropriate
-
+.BR sysexits.h (3)
+error code.
+.\"
 .SH BUGS
 
-There are multiple ways to express compound comparisons; “less than or equal
+.BR -egl ,
-to” can be -le or -el, for example.
+\(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.
+.\"
+.SH CAVEATS
 
-The inequality comparison is -gl or -lg for “less than or greater than”; this
+There are multiple ways to express compound comparisons; \(lqless than or equal
-is elegant but unintuitive.
+to\(rq can be
-
+.B -le
--egl, “equal to or less than or greater than”, exits 0 no matter what for valid
+or
-program usage and may be abused to function as an integer validator.
+.BR -el ,
-Use str(1) instead.
+for example.
 
+The inequality comparison is
+.B -gl
+.B or
+.B -lg
+for \(lqless than or greater than\(rq;
+this is elegant but unintuitive.
+.\"
 .SH RATIONALE
 
 The traditional tool for integer comparisons in POSIX and other Unix shells has
-been test(1). This tool also handles string comparisons and file scrutiny.
+been
-These parts of its functionality have been broken out into multiple utilities.
+.BR test (1).
-
+This tool also handles string comparisons and file scrutiny. These parts of its
-This program’s functionality may be performed on a POSIX-compliant system with
+functionality have been broken out into multiple utilities.
-test(1p).
 
+This program\(cqs functionality may be performed on a POSIX-compliant system
+with
+.BR test (1p).
+.\"
 .SH AUTHOR
 
-Written by DTB <trinity@trinity.moe>.
+Written by DTB
-
+.MT trinity@trinity.moe
+.ME .
+.\"
 .SH COPYRIGHT
-
+.\"
-Copyright © 2023 DTB. License AGPLv3+: GNU AGPL version 3 or later
+Copyright \(co 2023 DTB. License AGPLv3+: GNU AGPL version 3 or later
 <https://gnu.org/licenses/gpl.html>.
-
+.\"
 .SH SEE ALSO
-
+.BR scrut (1),
-strcmp(1), scrut(1), str(1), test(1p)
+.BR strcmp (1),
+.BR str (1),
+.BR test (1p)

docs/mm.1

@@ -2,13 +2,11 @@
 .\"
 .\" 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-17 "Bonsai Core Utilites 0.13.11"
-
 .SH NAME
-
 mm \(en middleman
-
+.\"
 .SH SYNOPSIS
 
 mm
@@ -17,72 +15,59 @@ mm
 .RB [ input ])
 .RB ( -o
 .RB [ output ])
-
+.\"
 .SH DESCRIPTION
 
 Catenate input files and write them to the start of each output file or stream.
-
+.\"
 .SH OPTIONS
 
-.B -a
+.IP \fB-a\fP
-.RS
 Opens subsequent outputs for appending rather than updating.
-.RE
+.IP \fB-e\fP
-
-.B -e
-.RS
 Use the standard error as an output.
-.RE
+.IP \fB-i\fP
-
+Opens a path as an input. If one or more of the input files is \(lq-\(rq or if
-.B -i
+no inputs are specified, the standard input shall be used.
-.RS
+.IP \fB-o\fP
-Opens a path as an input. Without any inputs specified mm will use the
+Opens a path as an output. If one or more of the output files is \(lq-\(rq or if
-standard input. The standard input shall be used as an input if one or more of
+no outputs are specified, the standard output shall be used.
-the input files is “-”.
+.IP \fB-u\fP
-.RE
-
-.B -o
-.RS
-Opens a path as an output. Without any outputs specified mm will use the
-standard output. The standard output shall be used as an output if one or more
-of the output files is “-”.
-
-.RE
-
-.B -u
-.RS
 Ensures neither input or output will be buffered.
-.RE
+.IP \fB-n\fP
-
-.B -n
-.RS
 Causes SIGINT signals to be ignored.
-.RE
+.\"
-
 .SH DIAGNOSTICS
 
-If an output can no longer be written mm prints a diagnostic message, ceases
+If an output cannot be written to, an error occurs; however, exiting will be 
-writing to that particular output, and if there are more outputs specified,
+deferred until writing to any other specified outputs completes.
-continues, eventually exiting unsuccessfully.
-
-When an error is encountered, diagnostic message is printed and the program
-exits with the appropriate sysexits.h(3) status.
 
+When an error is encountered, a diagnostic message is printed and the program
+exits with the appropriate
+.BR sysexits.h (3)
+status.
+.\"
 .SH CAVEATS
 
 Existing files are not truncated on ouput and are instead overwritten.
-
+.\"
 .SH RATIONALE
 
-The cat(1p) and tee(1p) programs specified in POSIX together provide similar
+The
-functionality. The separation of the two sets of functionality into separate
+.BR cat (1p)
-APIs seemed unncessary.
+and
-
+.BR tee (1p)
+programs specified in POSIX together provide similar functionality. The
+separation of the two sets of functionality into separate APIs seemed
+unncessary.
+.\"
 .SH COPYRIGHT
 
-Copyright (c) 2024 DTB. License AGPLv3+: GNU AGPL version 3 or later
+Copyright \(co 2024 DTB. License AGPLv3+: GNU AGPL version 3 or later
 <https://gnu.org/licenses/agpl.html>.
-
+.\"
 .SH SEE ALSO
-
+.BR cat (1p),
-cat(1p), dd(1), dj(1), tee(1p)
+.BR dd (1),
+.BR dj (1),
+.BR tee (1p)

docs/npc.1

@@ -3,18 +3,16 @@
 .\"
 .\" 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-17 "Bonsai Core Utilites 0.13.11"
-
 .SH NAME
-
 npc \(en show non-printing characters
-
+.\"
 .SH SYNOPSIS
 
 npc
 .RB ( -et )
-
+.\"
 .SH DESCRIPTION
 
 Print normally non-printing characters.
@@ -26,50 +24,51 @@ character replaced (e.g. control-X becomes '^X'). The delete character (0x7F)
 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 OPTIONS
 
-.SH USAGE
+.IP \fB-e\fP
-
+Prints a dollar sign ('$') before each newline.
-.B -e
+.IP \fB-t\fP
-.RS
-Prints a currency sign ('$') before each line ending.
-.RE
-
-.B -t
-.RS
 Prints tab characters as '^I' rather than a literal horizontal tab.
-.RE
+.\"
-
 .SH DIAGNOSTICS
 
 In the event of an error, a debug message will be printed and the program will
-exit with the appropriate sysexits.h(3) error code.
+exit with the appropriate
-
+.BR sysexits.h (3)
+error code.
+.\"
 .SH BUGS
 
 The program operates in single-byte chunks regardless of intended encoding.
-
+.\"
 .SH RATIONALE
 
 POSIX currently lacks a way to display non-printing characters in the terminal
-using a standard tool. A popular extension to cat(1p), the
+using a standard tool. A popular extension to
+.BR cat (1p),
+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 cat(1p).
+beyond that of
-
+.BR cat (1p).
+.\"
 .SH AUTHOR
 
-Written by DTB <trinity@trinity.moe>.
+Written by DTB
-
+.MT trinity@trinity.moe
+.ME .
+.\"
 .SH COPYRIGHT
 
 Copyright © 2023 DTB. License AGPLv3+: GNU AGPL version 3 or later
 <https://gnu.org/licenses/agpl.html>.
-
+.\"
 .SH SEE ALSO
-
+.BR cat (1p),
-cat(1p), cat-v(1)
+.BR cat-v (1),
-
 .I UNIX Style, or cat -v Considered Harmful
 by Rob Pike

docs/rpn.1

@@ -3,73 +3,84 @@
 .\"
 .\" 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-17 "Bonsai Core Utilites 0.13.11"
-
 .SH NAME
-
 rpn \(en reverse polish notation evaluation
-
+.\"
 .SH SYNOPSIS
 
 rpn
-.RB [numbers...]\ [operators...]
+.RB [ numbers... ]
-
+.RB [ operators... ]
+.\"
 .SH DESCRIPTION
 
 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 rpn(7).
+For information on for reverse polish notation syntax, see
-
+.BR rpn (7).
+.\"
 .SH STANDARD INPUT
 
-If arguments are passed , they are interpreted as an expression to be evaluated.
+If arguments are specified, they are interpreted as an expression to be
-Otherwise, it reads whitespace-delimited numbers and operations from the
+evaluated. Otherwise, whitespace-delimited numbers and operations are read from
-standard input.
+the standard input.
-
+.\"
 .SH DIAGNOSTICS
 
-In the event of a syntax error, the program will print an
-
 In the event of an error, a debug message will be printed and the program will
-exit with the appropriate sysexits.h(3) error code.
+exit with the appropriate
-
+.BR sysexits.h (3)
+error code; however, in the event of a syntax error, the program will print an
+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 (IEEE 754), floating-point
+with the
-arithmetic has rounding errors. This is somewhat curbed by using the
+.I IEEE Standard for Floating Point Arithmetic
-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
 
-An infix notation calculation utility, bc(1p), is included in the POSIX
+An infix notation calculation utility,
-standard, but does not accept expressions as arguments; in scripts, any
+.BR bc (1p),
-predefined, non-interactive input must be piped into the program. A dc(1)
+is included in the POSIX standard, but does not accept expressions as arguments;
-pre-dates the standardized bc(1p), the latter originally being a preprocessor
+in scripts, any predefined, non-interactive input must be piped into the
-for the former, and was included in UNIX v2 onward. While it implements reverse
+program. A
-polish notation, it still suffers from being unable to accept an expression as
+.BR dc (1)
-an argument.
+pre-dates the standardized
-
+.BR bc (1p),
+the latter originally being a preprocessor for the former, and was included in
+Second Edition UNIX and onward. While it implements reverse polish notation, it
+still suffers from being unable to accept an expression as an argument.
+.\"
 .SH AUTHOR
 
-Written by Emma Tebibyte <emma@tebibyte.media>.
+Written by Emma Tebibyte
-
+.MT emma@tebibyte.media
+.ME .
+.\"
 .SH COPYRIGHT
 
 Copyright (c) 2024 Emma Tebibyte. License AGPLv3+: GNU AGPL version 3 or later
 <https://gnu.org/licenses/agpl.html>.
-
+.\"
 .SH SEE ALSO
-
+.BR bc (1p),
-bc(1p), dc(1), rpn(7), IEEE 754
+.BR dc (1),
+.BR rpn (7),
+.I IEEE 754

docs/scrut.1

@@ -3,122 +3,84 @@
 .\"
 .\" 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.11"
-
 .SH NAME
-
 scrut \(en scrutinize file properties
-
 .SH SYNOPSIS
 
 scrut
-.RB ( -bcdefgkprsuwxLS )
+.RB ( -LSbcdefgkprsuwx )
 .RB [ file... ]
-
+.\"
 .SH DESCRIPTION
 
-Determine if files comply with requirements.
+Determine if files comply with requirements. If the given files comply with the
-
+specified requirements, the program will exit successfully. Otherwise, it exits
+unsuccessfully.
+.\"
 .SH OPTIONS
 
-.B -L
+.IP \fB-L\fB
-.RS
 Requires the given files to exist and be symbolic links.
-.RE
+.IP \fB-S\fP
-
-.B -S
-.RS
 Requires the given files to exist and be sockets.
-.RE
+.IP \fB-b\fP
-
-.B -b
-.RS
 Requires the given files to exist and be block special files.
-.RE
+.IP \fB-c\fP
-
-.B -c
-.RS
 Requires the given files to exist and be character special files.
-.RE
+.IP \fB-d\fP
-
-.B -d
-.RS
 Requires the given files to exist and be directories.
-.RE
+.IP \fB-e\fP
-
-.B -e
-.RS
 Requires the given files to exist, and is redundant to any other option.
-.RE
+.IP \fB-f\fP
-
-.B -e
-.RS
 Requires the given files to exist and be regular files.
-.RE
+.IP \fB-g\fP
-
-.B -g
-.RS
 Requires the given files to exist and have their set group ID flags set.
-.RE
+.IP \fB-k\fP
-
-.B -k
-.RS
 Requires the given files to exist and have their sticky bit set.
-.RE
+.IP \fB-p\fP
-
-.B -p
-.RS
 Requires the given files to exist and be named pipes.
-.RE
+.IP \fB-r\fP
-
-.B -r
-.RS
 Requires the given files to exist and be readable.
-.RE
+.IP \fB-u\fP
-
-.B -u
-.RS
 Requires the given files to exist and have their set user ID flags set.
-.RE
+.IP \fB-w\fP
-
-.B -w
-.RS
 Requires the given files to exist and be writable.
-.RE
+.IP \fB-x\fP
-
-.B -x
-.RS
 Requires the given files to exist and be executable.
-.RE
+.\"
-
+.SH DIAGNOSTICS
-.SH EXIT STATUS
-
-If the given files comply with the specified requirements, the program will exit
-successfully. If not, it exits unsuccessfully.
 
 When invoked incorrectly, a debug message will be printed and the program will
-exit with the appropriate sysexits.h(3) error code.
+exit with the appropriate
+.BR sysexits.h (3)
+error code.
+.\"
+.SH RATIONALE 
 
-.SH STANDARDS
+The 
-
+.BR test (1p)
-The test(1p) utility contains functionality that was broken out into separate
+utility contains functionality that was broken out into separate programs. Thus,
-programs. Thus, the scope of this program is narrower than it. Notably, the
+the scope of this program is narrower than it. Notably, the
 .B -h
 option is now invalid and therefore shows usage information instead of being an
 alias to the modern
 .B -L
 option.
-
+.\"
 .SH AUTHOR
 
-Written by DTB <trinity@trinity.moe>.
+Written by DTB
-
+.MT trinity@trinity.moe
+.ME .
+.\"
 .SH COPYRIGHT
 
-Copyright © 2024 DTB. License AGPLv3+: GNU AGPL version 3 or later
+Copyright \(co 2024 DTB. License AGPLv3+: GNU AGPL version 3 or later
 <https://gnu.org/licenses/agpl.html>.
-
+.\"
 .SH SEE ALSO
-
+.BR access (3p),
-access(3p), lstat(3p), test(1p)
+.BR lstat (3p),
+.BR test (1p)

docs/str.1

@@ -3,53 +3,58 @@
 .\"
 .\" 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-17 "Bonsai Core Utilites 0.13.11"
-
 .SH NAME
-
+str \(en test string arguments
-str \(en test the character types of string arguments
+.\"
-
 .SH SYNOPSIS
 
 str
 .RB [ type ]
 .RB [ string... ]
-
+.\"
 .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
-ctype.h(0p) and are the methods by which string arguments are tested.
+.BR ctype.h (0p)
-
+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 sysexits.h(3) error code.
+exit with the appropriate
+.BR sysexits.h (3)
+error code.
+.\"
+.SH CAVEATS
 
-.SH BUGS
+None of an empty string\(cqs contents pass any of the tests, so the program will
+exit unsuccessfully if one is specified.
 
-There’s no way of knowing which argument failed the test without re-testing
+There\(cqs no way of knowing which argument failed the test without re-testing
 arguments individually.
 
-If a character in a string isn't valid ASCII str will exit unsuccessfully.
+If a character in a string isn\(cqt valid ASCII, the program will exit
-
+unsuccessfully.
+.\"
 .SH AUTHOR
 
-Written by DTB <trinity@trinity.moe>.
+Written by DTB
-
+.MT trinity@trinity.moe
+.ME .
+.\"
 .SH COPYRIGHT
 
-Copyright © 2023 DTB. License AGPLv3+: GNU AGPL version 3 or later
+Copyright \(co 2023 DTB. License AGPLv3+: GNU AGPL version 3 or later
 <https://gnu.org/licenses/gpl.html>.
-
+.\"
 .SH SEE ALSO
-
+.BR ctype (3p),
-ctype(3p), strcmp(1), ascii(7)
+.BR strcmp(1),
+.BR ascii(7)

docs/strcmp.1

@@ -3,61 +3,74 @@
 .\"
 .\" 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-17 "Bonsai Core Utilites 0.13.11"
-
 .SH NAME
-
 strcmp \(en compare strings
-
+.\"
 .SH SYNOPSIS
 
 strcmp
 .RM [ string ]
 .RB [ strings... ]
-
+.\"
 .SH DESCRIPTION
 
 Check whether string arguments are the same.
-
+.\"
 .SH DIAGNOSTICS
 
 The program will exit successfully if the strings are identical. Otherwise, it
-exits with the value 1 if an earlier string has a greater byte value than a
+will exit with an error code of 1 if a string passed has a lesser byte value
-later string (e.g.
+than one of the prior strings:
-.R strcmp b a
+
-)
+.RS
-and 255 if an earlier string has a lesser byte value (e.g.
+strcmp b a
-.R strcmp a b
+.RE
-).
+
+or with an error code of 255 if it has a greater byte value than one of the
+prior strings:
+
+.RS
+strcmp a b
+.RE
 
 When invoked incorrectly, a debug message will be printed and the program will
-exit with the appropriate sysexits.h(3) error code.
+exit with the appropriate
-
+.BR sysexits.h (3)
-.SH UNICODE
+error code.
+.\"
+.SH CAVEATS
 
 The program will exit unsuccessfully if the given strings are not identical;
 therefore, Unicode strings may need to be normalized if the intent is to check
 visual similarity and not byte similarity.
-
+.\"
 .SH RATIONALE
 
 The traditional tool for string comparisons in POSIX and other Unix shells has
-been test(1). This tool also handles integer comparisons and file scrutiny.
+been
-These parts of its functionality have been broken out into multiple utilities.
+.BR test (1).
-
+This tool also handles integer comparisons and file scrutiny. These parts of its
-This program’s functionality may be performed on a POSIX-compliant system with
+functionality have been broken out into multiple utilities.
-test(1p).
 
+This program\(cqs functionality may be performed on a POSIX-compliant system
+with
+.BR test (1p).
+.\"
 .SH AUTHOR
 
-Written by DTB <trinity@trinity.moe>.
+Written by DTB 
-
+.MT trinity@trinity.moe
+.ME .
+.\"
 .SH COPYRIGHT
 
-Copyright © 2023 DTB. License AGPLv3+: GNU AGPL version 3 or later
+Copyright \(co 2023 DTB. License AGPLv3+: GNU AGPL version 3 or later
 <https://gnu.org/licenses/gpl.html>.
-
+.\"
 .SH SEE ALSO
-
+.BR strcmp (3),
-strcmp(3), intcmp(1), scrut(1), test(1p)
+.BR intcmp (1),
+.BR scrut (1),
+.BR test (1p)

docs/swab.1

@@ -3,13 +3,11 @@
 .\"
 .\" 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-17 "Bonsai Core Utilites 0.13.11"
-
 .SH NAME
-
 swab \(en swap bytes
-
+.\"
 .SH SYNOPSIS
 
 swab
@@ -18,60 +16,66 @@ swab
 .R [
 .B word size
 .R ])
-
+.\"
-.SH USAGE
+.SH DESCRIPTION
 
 Swap the latter and former halves of a block of bytes.
-
+.\"
 .SH OPTIONS
 
-.B -f
+.IP \fB-f\fP
-.RS
+Ignore SIGINT signal.
-Ignore system call interruptions.
+.IP \fB-w\fP
-.RE
-
-.B -w
-.RS
 Configures the word size; that is, the size in bytes of the block size
-on which to operate. By default the word size is 2. The word size must be
+on which to operate. The default word size is 2. The word size must be
-cleanly divisible by 2, otherwise the block of bytes being processed can't be
+cleanly divisible by 2, otherwise the block of bytes being processed can\(cqt be
 halved.
-.RE
+.\"
-
 .SH EXAMPLES
 
-The following sh(1p) line:
+The following
+.BR sh (1p)
+line:
 
 .RS
-.R printf 'hello world!\n' | swab
+printf 'hello world!\(rsn' | swab
 .RE
 
 Produces the following output:
 
 .RS
-.R ehll oowlr!d
+ehll oowlr!d
 .RE
-
+.\"
 .SH DIAGNOSTICS
 
 In the event of an error, a debug message will be printed and the program will
-exit with the appropriate sysexits.h(3) error code.
+exit with the appropriate
-
+.BR sysexits.h (3)
+error code.
+.\"
 .SH RATIONALE
 
 This program was modeled and named after the
-.R conv=swab
+.B conv=swab
-functionality specified in the dd(1p) utility. It additionally allows the word
+functionality specified
-size to be configured.
+in the
+.BR dd (1p)
+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 (c) 2024 DTB. License AGPLv3+: GNU AGPL version 3 or later
+Copyright \(co 2024 DTB. License AGPLv3+: GNU AGPL version 3 or later
 <https://gnu.org/licenses/agpl.html>.
-
+.\"
 .SH SEE ALSO
-
+.BR dd (1p)
-dd(1p)

docs/true.1

@@ -3,32 +3,34 @@
 .\"
 .\" 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.11"
-
 .SH NAME
-
 true \(en do nothing, successfully
-
+.\"
 .SH DESCRIPTION
 
-Do nothing regardless of operands or standard input.
+Do nothing regardless of operands or standard input. An exit code of 0 will
-An exit code of 0 will always be returned.
+always be returned.
-
+.\"
 .SH RATIONALE
 
-In POSIX.1-2017, true(1p) exists for the construction of control flow and loops
+In \fIPOSIX.1-2017\fP,
-based on a success. This implementation functions as described in that standard.
+.BR true (1p)
-
+exists for the construction of control flow and loops based on a success. This
+implementation functions as described in that standard.
+.\"
 .SH AUTHOR
 
-Written by Emma Tebibyte <emma@tebibyte.media>.
+Written by Emma Tebibyte
-
+.MT emma@tebibyte.media
+.ME .
+.\"
 .SH COPYRIGHT
 
 This work is marked with CC0 1.0. To see a copy of this license, visit
 <http://creativecommons.org/publicdomain/zero/1.0>.
-
+.\"
 .SH SEE ALSO
-
+.BR false (1p),
-false(1p)
+.BR true (1p)

src/eep.rs

@@ -0,0 +1,47 @@
+/*
+ * Copyright (c) 2024 DTB <trinity@trinity.moe>
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ *
+ * This program is free software: you can redistribute it and/or modify it under
+ * the terms of the GNU Affero General Public License as published by the Free
+ * Software Foundation, either version 3 of the License, or (at your option) any
+ * later version.
+ *
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see https://www.gnu.org/licenses/.
+ */
+
+use std::{
+	env::args,
+	process::ExitCode,
+	thread::sleep,
+	time::Duration
+};
+
+extern crate sysexits;
+use sysexits::EX_USAGE;
+
+fn usage(s: &str) -> ExitCode {
+	eprintln!("Usage: {} [seconds]", s);
+	ExitCode::from(EX_USAGE as u8)
+}
+
+fn main() -> ExitCode {
+	let argv = args().collect::<Vec<String>>();
+
+	if argv.len() == 2 {
+		if let Ok(s) = argv[1].parse::<u64>() {
+			sleep(Duration::from_secs(s)); /* from_secs needs u64 */
+			ExitCode::SUCCESS
+		} else {
+			usage(&argv[0])
+		}
+	} else {
+		usage(&argv[0])
+	}
+}

src/fop.rs

@@ -22,26 +22,22 @@ use std::{
 	process::{ Command, exit, Stdio },
 };
 
-extern crate sysexits;
 extern crate getopt;
+extern crate strerror;
+extern crate sysexits;
 
 use getopt::{ Opt, Parser };
+use strerror::StrError;
 use sysexits::{ EX_DATAERR, EX_IOERR, EX_UNAVAILABLE, EX_USAGE };
 
 fn main() {
 	let argv = args().collect::<Vec<String>>();
-	let mut d = '␞';
+	let mut d = '\u{1E}'.to_string();
 	let mut arg_parser = Parser::new(&argv, "d:");
 
 	while let Some(opt) = arg_parser.next() {
 		match opt {
-			Ok(Opt('d', Some(arg))) => {
+			Ok(Opt('d', Some(arg))) => d = arg,
-				let arg_char = arg.chars().collect::<Vec<char>>();
-				if arg_char.len() > 1 {
-					eprintln!("{}: {}: Not a character.", argv[0], arg);
-					exit(EX_USAGE);
-				} else { d = arg_char[0]; }
-			},
 			_ => {},
 		};
 	}
@@ -55,13 +51,13 @@ fn main() {
 	});
 
 	let index = argv[index_arg].parse::<usize>().unwrap_or_else(|e| {
-		eprintln!("{}: {}: {}.", argv[0], argv[1], e);
+		eprintln!("{}: {}: {}", argv[0], argv[1], e);
 		exit(EX_DATAERR);
 	});
 
 	let mut buf = String::new();
 	let _ = stdin().read_to_string(&mut buf);
-	let mut fields = buf.split(d).collect::<Vec<&str>>();
+	let mut fields = buf.split(&d).collect::<Vec<&str>>();
 
 	let opts = argv
 		.iter()
@@ -75,13 +71,13 @@ fn main() {
 		.stdout(Stdio::piped())
 		.spawn()
 		.unwrap_or_else( |e| {
-			eprintln!("{}: {}: {}.", argv[0], argv[command_arg], e);
+			eprintln!("{}: {}: {}", argv[0], argv[command_arg], e.strerror());
 			exit(EX_UNAVAILABLE);
 		});
 
 	let field = fields.get(index).unwrap_or_else(|| {
 		eprintln!(
-			"{}: {}: No such index in input.",
+			"{}: {}: No such index in input",
 			argv[0],
 			index.to_string(),
 		);
@@ -94,7 +90,7 @@ fn main() {
 	}
 
 	let output = spawned.wait_with_output().unwrap_or_else(|e| {
-		eprintln!("{}: {}: {}.", argv[0], argv[command_arg], e);
+		eprintln!("{}: {}: {}", argv[0], argv[command_arg], e.strerror());
 		exit(EX_IOERR);
 	});
 
@@ -103,7 +99,7 @@ fn main() {
 	if replace.pop() != Some(b'\n') { replace = output.stdout; }
 
 	let new_field = String::from_utf8(replace).unwrap_or_else(|e| {
-		eprintln!("{}: {}: {}.", argv[0], argv[command_arg], e);
+		eprintln!("{}: {}: {}", argv[0], argv[command_arg], e);
 		exit(EX_IOERR);
 	});
 
@@ -111,8 +107,8 @@ fn main() {
 
 	stdout().write_all(
 		fields.join(&d.to_string()).as_bytes()
-	).unwrap_or_else(|e|{
+	).unwrap_or_else(|e| {
-		eprintln!("{}: {}.", argv[0], e);
+		eprintln!("{}: {}", argv[0], e.strerror());
 		exit(EX_IOERR);
 	});
 }

src/hru.rs

@@ -23,8 +23,10 @@ use std::{
 	process::{ ExitCode, exit },
 };
 
+extern crate strerror;
 extern crate sysexits;
 
+use strerror::StrError;
 use sysexits::{ EX_DATAERR, EX_IOERR, EX_SOFTWARE };
 
 const LIST: [(u32, &str); 10] = [
@@ -49,7 +51,7 @@ fn convert(input: u128) -> Result<(f64, (u32, &'static str)), String> {
 		let c = match 10_u128.checked_pow(n) {
 			Some(c) => c,
 			None => {
-				return Err(format!("10^{}: Integer overflow.", n.to_string()));
+				return Err(format!("10^{}: Integer overflow", n.to_string()));
 			},
 		};
 
@@ -79,7 +81,7 @@ fn main() -> ExitCode {
 				f
 			},
 			Err(err) => {
-				eprintln!("{}: {}.", argv[0], err);
+				eprintln!("{}: {}", argv[0], err);
 				return ExitCode::from(EX_DATAERR as u8);
 			},
 		};
@@ -87,7 +89,7 @@ fn main() -> ExitCode {
 		let (number, prefix) = match convert(n) {
 			Ok(x) => x,
 			Err(err) => {
-				eprintln!("{}: {}.", argv[0], err);
+				eprintln!("{}: {}", argv[0], err);
 				return ExitCode::from(EX_SOFTWARE as u8);
 			},
 		};
@@ -98,7 +100,7 @@ fn main() -> ExitCode {
 
 		stdout().write_all(format!("{} {}\n", out, si_prefix).as_bytes())
 			.unwrap_or_else(|e| {
-				eprintln!("{}: {}.", argv[0], e);
+				eprintln!("{}: {}", argv[0], e.strerror());
 				exit(EX_IOERR);
 			});
 	}

src/mm.c

@@ -106,6 +106,15 @@ oserr(char *s, char *r){
 	} \
 	return retval
 
+/* Prints a usage text, in which s is the program being run (i.e. argv[0]), and
+ * returns an exit status appropriate for a usage error. */
+int usage(char *s){
+
+	fprintf(stderr, "Usage: %s (-aenu) (-i [input])... (-o [output])...\n", s);
+
+	return EX_USAGE;
+}
+
 int main(int argc, char *argv[]){
 	int c;
 	struct Files files[2]; /* {read, write} */
@@ -178,12 +187,15 @@ int main(int argc, char *argv[]){
 				k = 1;
 				break;
 			default:
-				fprintf(stderr, "Usage: %s (-aenu) (-i [input])..."
+				retval = usage(argv[0]);
-					" (-o [output])...\n", argv[0]);
-				retval = EX_USAGE;
 				terminate;
 			}
 
+	if(optind != argc){
+		retval = usage(argv[0]);
+		terminate;
+	}
+
 	files[0].s += files[0].s == 0;
 	files[1].s += files[1].s == 0;
 	

src/rpn.rs

@@ -172,7 +172,7 @@ fn eval(
 					};
 				} else {
 					return Err(EvaluationError {
-						message: format!("{}: Unexpected operation.", op),
+						message: format!("{}: Unexpected operation", op),
 						code: EX_DATAERR,
 					})
 				}

src/scrut.c

@@ -1,5 +1,6 @@
 /*
- * Copyright (c) 2023 DTB <trinity@trinity.moe>
+ * Copyright (c) 2023–2024 DTB <trinity@trinity.moe>
+ * Copyright (c) 2024 Emma Tebibyte <emma@tebibyte.media>
  * SPDX-License-Identifier: AGPL-3.0-or-later
  *
  * This program is free software: you can redistribute it and/or modify it under
@@ -17,13 +18,15 @@
  */
 
 #include <stdio.h> /* fprintf(3), stderr, NULL */
-#include <stdlib.h> /* EXIT_FAILURE */
+#include <stdlib.h> /* EXIT_FAILURE, EXIT_SUCCESS */
 #include <string.h> /* memset(3), strchr(3) */
+#ifndef EX_USAGE
+#	include <sysexits.h>
+#endif
 #include <unistd.h> /* access(3), getopt(3), F_OK, R_OK, W_OK, X_OK */
 #include <sys/stat.h> /* lstat(3), stat struct, S_ISBLK, S_ISCHR, S_ISDIR,
                        * S_ISFIFO, S_ISGID, S_ISREG, S_ISLNK, S_ISSOCK,
                        * S_ISUID, S_ISVTX */
-#include <sysexits.h>
 
 static char args[] = "bcdefghkprsuwxLS";
 static char ops[(sizeof args) / (sizeof *args)];
@@ -57,7 +60,7 @@ int main(int argc, char *argv[]){
 
 	argv += optind;
 	do{	if(access(*argv, F_OK) != 0 || lstat(*argv, &buf) == -1)
-			return 1; /* doesn't exist or isn't stattable */
+			return EXIT_FAILURE; /* doesn't exist or isn't stattable */
 
 		for(i = 0; ops[i] != '\0'; ++i)
 			if(ops[i] == 'e')
@@ -97,8 +100,8 @@ usage:				fprintf(stderr, "Usage: %s (-%s) [file...]\n",
 						&& !S_ISLNK(buf.st_mode))
 					|| (ops[i] == 'S'
 						&& !S_ISSOCK(buf.st_mode)))
-				return 1;
+				return EXIT_FAILURE;
 	}while(*++argv != NULL);
 
-	return 0;
+	return EXIT_SUCCESS;
 }

src/strerror.rs

@@ -0,0 +1,31 @@
+/*
+ * Copyright (c) 2024 Emma Tebibyte <emma@tebibyte.media>
+ * SPDX-License-Identifier: FSFAP
+ *
+ * Copying and distribution of this file, with or without modification, are
+ * permitted in any medium without royalty provided the copyright notice and
+ * this notice are preserved.  This file is offered as-is, without any warranty.
+ */
+
+use std::ffi::{ c_int, c_char, CStr };
+
+pub trait StrError { fn strerror(&self) -> String; }
+
+impl StrError for std::io::Error {
+	/* wrapper function for use in Rust */
+	fn strerror(&self) -> String {
+		/* Get the raw OS error. If it’s None, what the hell is going on‽ */
+		let errno = self.raw_os_error().unwrap_or(0) as c_int;
+
+		/* Get a CStr from the error message so that it’s referenced and then
+		 * convert it to an owned value. If the string is not valid UTF-8,
+		 * return that error instead. */
+		match unsafe { CStr::from_ptr(strerror(errno)) }.to_str() {
+			Ok(s) => s.to_owned(), // yay!! :D
+			Err(e) => e.to_string(), // awww :(
+		}
+	}
+}
+
+/* binding to strerror(3p) */
+extern "C" { fn strerror(errnum: c_int) -> *mut c_char; }