New core utilities for a new era.
Go to file
dtb 6132c9bf47
Merge branch 'main' into scrut-sysexits
2024-04-26 19:37:34 -06:00
docs Merge branch 'mm' 2024-03-18 20:56:06 -06:00
include GNUmakefile, intcmp(1), npc(1), scrut(1), str(1), strcmp(1), include/sysexits.h: added fallback header file for when systems don’t have sysexits.h(3) 2023-12-25 21:50:45 -07:00
src Merge branch 'main' into scrut-sysexits 2024-04-26 19:37:34 -06:00
tests Makefile, .gitignore, tests/cc-compat.sh: brought up-to-date 2024-02-07 20:13:45 -07:00
.editorconfig .editorconfig: remove stale configure config 2024-02-17 23:25:35 -07:00
.gitignore Makefile, .gitignore, tests/cc-compat.sh: brought up-to-date 2024-02-07 20:13:45 -07:00
CONTRIBUTING CONTRIBUTING: fixed random "utils" 2024-02-23 23:19:28 -07:00
COPYING initial commit 2023-07-23 19:49:57 -06:00
Makefile Merge branch 'strerror' 2024-03-29 19:23:27 -06:00
README README: changed dependency section and update copyright 2024-02-16 21:02:00 -07:00

README

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

“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 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 dont
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.

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
flag, a Rust compiler (rustc(1) by default), bindgen(1), and a POSIX-compliant
make(1) utility.

To build and install:

$ 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 untracked 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 © 20232024 Emma Tebibyte <emma@tebibyte.media>
Copyright © 2024 DTB <trinity@trinity.moe>

This work is licensed under CC BY-SA 4.0. To view a copy of this license, visit
<http://creativecommons.org/licenses/by-sa/4.0/>.