Makefile, docs: programmatically generate version for docs (i got tired of doing it myself)

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
-.PRAGMA: posix_202x # future POSIX standard support à la pdpmake(1)
-.PRAGMA: command_comment # breaks without this?
+.POSIX:
 
 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
-	# https://github.com/rust-lang/rust-bindgen/issues/2703
-	mkdir -p build/bin build/include build/lib build/o build/test
+	mkdir -p build/bin build/docs 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 '#define EXIT_FAILURE 1\n' | cat - $(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 \
 		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
-current state of POSIX and Unix utilies. The Unix Philosophy, “do one thing and
-do it well” is its core but these tools do not cling to the names of the past.
+The Bonsai harakit utilities are a replacement for standard POSIX utilities
+which aim to fill its niche while expanding on their capabilities. These new
+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
-with the way certain tools work and how other projects that extend POSIX don’t
-make anything better.
+their flaws. This project originated from frustrations with the way certain
+tools work and how other projects that extend POSIX don’t 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
-purposes beyond its scope.
+harakit utilities will intentionally discourage use of the shell for purposes
+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
-compiler and preprocessor (cc(1) and cpp(1) by default), an edition 2023 Rust
+Harakit utilities require a POSIX-compliant environment to compile, including a
+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,7 +4,7 @@
 .\" This work is licensed under CC BY-SA 4.0. To see a copy of this license,
 .\" visit <http://creativecommons.org/licenses/by-sa/4.0/>.
 .\"
-.TH DJ 1 2024-06-17 "Bonsai Core Utilites 0.13.9"
+.TH DJ 1 2024-06-17 "Harakit X.X.X"
 .SH NAME
 dj \(en disk jockey
 .\"

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.9"
+.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-17 "Bonsai Core Utilites 0.13.9"
+.TH FOP 1 2024-06-17 "Harakit X.X.X"
 .SH NAME
 fop \(en field operator
 .\"

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-17 "Bonsai Core Utilites 0.13.9"
+.TH HRU 1 2024-06-17 "Harakit X.X.X"
 .SH NAME
 hru \(en human readable units
 .\"

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.9"
+.TH INTCMP 1 2024-06-06 "Harakit X.X.X"
 .SH NAME
 intcmp \(en compare integers
 .\"

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-17 "Bonsai Core Utilites 0.13.9"
+.TH MM 1 2024-06-17 "Harakit X.X.X"
 .SH NAME
 mm \(en middleman
 .\"

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-17 "Bonsai Core Utilites 0.13.9"
+.TH NPC 1 2024-06-17 "Harakit X.X.X"
 .SH NAME
 npc \(en show non-printing characters
 .\"

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-17 "Bonsai Core Utilites 0.13.9"
+.TH RPN 1 2024-06-17 "Harakit X.X.X"
 .SH NAME
 rpn \(en reverse polish notation evaluation
 .\"

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

docs/str.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 STR 1 2024-06-17 "Bonsai Core Utilites 0.13.9"
+.TH STR 1 2024-06-17 "Harakit X.X.X"
 .SH NAME
 str \(en test string arguments
 .\"

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-17 "Bonsai Core Utilites 0.13.9"
+.TH STRCMP 1 2024-06-17 "Harakit X.X.X"
 .SH NAME
 strcmp \(en compare strings
 .\"

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-17 "Bonsai Core Utilites 0.13.9"
+.TH SWAB 1 2024-06-17 "Harakit X.X.X"
 .SH NAME
 swab \(en swap bytes
 .\"

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

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() {