README: overgrown

Makefile

@@ -31,8 +31,8 @@ RUSTLIBS = --extern getopt=build/o/libgetopt.rlib \
 	--extern strerror=build/o/libstrerror.rlib
 CFLAGS += -I$(SYSEXITS)
 
-.PHONY: all
+all: argued dj false fop hru intcmp mm npc pschdir retval rpn scrut simexec \
-all: dj false fop hru intcmp mm npc pschdir rpn scrut str strcmp swab true
+	str strcmp swab true
 
 # keep build/include until bindgen(1) has stdin support
 # https://github.com/rust-lang/rust-bindgen/issues/2703
@@ -87,6 +87,11 @@ build/o/libsysexits.rlib: build/include/sysexits.h
 build/include/sysexits.h: build $(SYSEXITS)sysexits.h
 	printf '\043define EXIT_FAILURE 1\n' | cat - $(SYSEXITS)sysexits.h > $@
 
+.PHONY: argued
+argued: build/bin/argued
+build/bin/argued: src/argued.rs build
+	$(RUSTC) $(RUSTFLAGS) -o $@ src/argued.rs
+
 .PHONY: dj
 dj: build/bin/dj
 build/bin/dj: src/dj.c build
@@ -127,6 +132,11 @@ pschdir: build/bin/pschdir
 build/bin/pschdir: src/pschdir.rs build
 	$(RUSTC) $(RUSTFLAGS) $(RUSTLIBS) -o $@ src/pschdir.rs
 
+.PHONY: retval
+retval: build/bin/retval
+build/bin/retval: src/retval.rs build rustlibs
+	$(RUSTC) $(RUSTFLAGS) $(RUSTLIBS) -o $@ src/retval.rs
+
 .PHONY: rpn
 rpn: build/bin/rpn
 build/bin/rpn: src/rpn.rs build rustlibs
@@ -137,6 +147,11 @@ scrut: build/bin/scrut
 build/bin/scrut: src/scrut.c build
 	$(CC) $(CFLAGS) -o $@ src/scrut.c
 
+.PHONY: simexec
+simexec: build/bin/simexec
+build/bin/simexec: src/simexec.c build
+	$(CC) $(CFLAGS) -o $@ src/simexec.c
+
 .PHONY: str
 str: build/bin/str
 build/bin/str: src/str.c build

README

@@ -1,61 +1,9 @@
-“Seek not to walk the path of the masters; seek what they sought.”
+overgrown - trinity's harakit workshop
-– Matsuo Basho
 
-The Bonsai harakit utilities are a replacement for standard POSIX utilities
+simple build, no dependencies except rust
-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. 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
-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
-
-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.
-
-To build and install:
 
+# pkg_add rust rust-bindgen
 $ make
-$ make PREFIX="/your/preferred/location" install
-
-To build with a different compiler than the default:
-
-$ make CC=clang
-$ make RUSTC=gccrs
-
-To test the utilities:
-
-$ make test
-
-To remove all build and distributable files:
-
-$ make clean
-
-Read More
-
-An Introduction to the Unix Shell
-<https://porkmail.org/era/unix/shell>
-
-Master Foo and the Ten Thousand Lines
-<http://www.catb.org/~esr/writings/unix-koans/ten-thousand.html>
-
-Master Foo Discourses on the Unix-Nature
-<http://www.catb.org/~esr/writings/unix-koans/unix-nature.html>
-
-Shell Programming!
-<https://tldp.org/LDP/abs/html/why-shell.html>
 
 --
 Copyright © 2023–2024 Emma Tebibyte <emma@tebibyte.media>

docs/argued.1

@@ -0,0 +1,28 @@
+.\" Copyright (c) 2022–2024 DTB <trinity@trinity.moe>
+.\"
+.\" 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 ARGUED 1 2024-07-23 "Harakit-overgrown X.X.X"
+.SH NAME
+argued \(en check for arguments
+.\"
+.SH DESCRIPTION
+
+.BR argued (1)
+exits successfully if any arguments are provided, and unsuccessfully
+otherwise.
+.\"
+.SH AUTHOR
+
+Written by DTB
+.MT trinity@trinity.moe
+.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 test (1)

docs/simexec.1

@@ -0,0 +1,79 @@
+.\" Copyright (c) 2022–2024 DTB <trinity@trinity.moe>
+.\"
+.\" 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 SIMEXEC 1 2024-07-23 "Harakit-overgrown X.X.X"
+.SH NAME
+simexec \(en execute a program with argv
+.\"
+.SH SYNOPSIS
+
+simexec
+.B binary argv...
+.SH DESCRIPTION
+Execute a binary with a certain argv.
+.SH CAVEATS
+
+Non-binary programs cannot be executed on their own. The PATH environment
+variable is not used and a valid pathname (relative or absolute) must be
+specified.
+
+.BR simexec (1)
+requires caution.
+.B argv
+are not just the operands for the binary but in fact the direct
+.B argv
+it will receive in runtime;
+the first argv entry is the program\(cqs name, and omitting this, though valid
+use of
+.BR simexec (1),
+can break false assumptions made by programmers.
+for example, the
+.BR true (1)
+implementation in the GNU coreutils project suffers a segmentation fault it is
+given no argv[0].
+
+While POSIX.1-2017 doesn't mandate there being an argv[0] per se, a Strictly
+Conforming POSIX Application must pass an argv[0]. It has also been said that
+those who do not pass an argv[0] are mean and nasty and smell of elderberries.
+
+.BR simexec (1)
+directly uses the
+.BR execv (3p)
+library function. It cannot execute shell scripts intelligently (via shebang).
+It is inadviseable to use
+.BR simexec (1)
+to simply execute a program when other methods would suffice.
+.\"
+.SH DIAGNOSTICS
+
+.BR simexec (1)
+exits with the returned value of
+.BR execv (3p),
+which will be 255 if an error occurs in execution, such as the binary not being
+found.
+This is indistinguishable from the executed binary exiting with the same
+status.
+
+Simexec will print a error message and return the proper
+.BR sysexits.h (3)
+value if invoked in an invalid manner.
+.\"
+.SH AUTHOR
+
+Written by DTB
+.MT trinity@trinity.moe
+.ME .
+.\"
+.SH COPYRIGHT
+.\"
+Copyright \(co 2022–2024 DTB. License AGPLv3+: GNU AGPL version 3 or later
+<https://gnu.org/licenses/gpl.html>.
+.\"
+.SH SEE ALSO
+.BR execv (3p)
+
+The C89 standard's draft, section 2.1.2.2: "Hosted environment".
+
+POSIX.1-2017 System Interfaces: execv. Particularly under the RATIONALE section header.

src/argued.rs

@@ -0,0 +1,28 @@
+/*
+ * Copyright (c) 2022_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 };
+
+ fn main() -> ExitCode {
+ 	let argv = args().collect::<Vec<String>>();
+
+ 	match argv.len() {
+ 		0 | 1 => ExitCode::FAILURE,
+ 		_ =>     ExitCode::SUCCESS
+ 	}
+ }

src/retval.rs

@@ -0,0 +1,39 @@
+/*
+ * 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 };
+
+extern crate sysexits;
+use sysexits::EX_USAGE;
+
+fn usage(s: &str) -> ExitCode {
+	eprintln!("Usage: {} status", s);
+	ExitCode::from(EX_USAGE)
+}
+
+fn main() -> ExitCode {
+	let argv = args().collect::<Vec<String>>();
+
+	match argv.len() {
+		2 => match argv[1].parse::<u8>() {
+				Ok(e) => ExitCode::from(e),
+				_ => usage(&argv[0])
+			},
+		_ => usage(&argv[0])
+	}
+}

src/simexec.c

@@ -0,0 +1,34 @@
+/*
+ * Copyright (c) 2022–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/.
+ */
+
+#include <stdio.h> /* fprintf(3), NULL */
+#include <unistd.h> /* execv(3), */
+#include <sysexits.h> /* EX_USAGE */
+
+char *program_name = "simexec";
+
+int main(int argc, char *argv[]){
+	if (argc < 2) {
+		fprintf(stderr, "Usage: %s binary argv...\n",
+			argv[0] == NULL ? program_name : argv[0]
+		);
+		return EX_USAGE;
+	}
+
+	execv(argv[1], &argv[2]);
+}