midfavila/sbase
1
0
Fork 0
Code Issues Pull Requests Projects Releases 1 Wiki Activity
1b4ba2b303
sbase/README

119 lines
5.6 KiB
Plaintext
Raw Normal View History

Add initial README
2014-02-12 09:34:09 -05:00
sbase - suckless unix tools
===========================
sbase is a collection of unix tools that are inherently portable
across UNIX and UNIX-like systems.
Add column to mark UTF-8 support One major milestone is to have the sbase-tools supporting UTF-8. Tools like cut(1) with the -n flag don't make sense otherwise. And while the gnu coreutils cut(1) blatantly ignores such an important aspect, we will not tolerate this madness and mark it as a TODO in the main README. Since most tools inherently support UTF-8 anyway, this just concerns tools which mangle with text or search in it in special ways.
2015-01-18 13:36:13 -05:00
The following tools are implemented ('*' == finished, '#' == UTF-8 support,
'=' == implicit UTF-8 support):
Add an easier to edit "table" of tools in README We need to go through the tools and update this table to reflect current state.
2014-11-20 18:01:56 -05:00
Also indent the headings
2015-01-18 13:41:14 -05:00
UTILITY POSIX 2008 COMPLIANT MISSING OPTIONS
------- -------------------- ---------------
Add column to mark UTF-8 support One major milestone is to have the sbase-tools supporting UTF-8. Tools like cut(1) with the -n flag don't make sense otherwise. And while the gnu coreutils cut(1) blatantly ignores such an important aspect, we will not tolerate this madness and mark it as a TODO in the main README. Since most tools inherently support UTF-8 anyway, this just concerns tools which mangle with text or search in it in special ways.
2015-01-18 13:36:13 -05:00
=* basename yes none
=* cal yes none
=* cat yes none
= chgrp no -h, -H, -L, -P
=* chmod yes none
= chown no -h, -H, -L, -P
Finish up chroot(1) and md5sum(1)
2015-01-31 17:54:23 -05:00
=* chroot non-posix none
Add column to mark UTF-8 support One major milestone is to have the sbase-tools supporting UTF-8. Tools like cut(1) with the -n flag don't make sense otherwise. And while the gnu coreutils cut(1) blatantly ignores such an important aspect, we will not tolerate this madness and mark it as a TODO in the main README. Since most tools inherently support UTF-8 anyway, this just concerns tools which mangle with text or search in it in special ways.
2015-01-18 13:36:13 -05:00
=* cksum yes none
Refactor cmp(1) code and manpage The algorithm had some areas which had potential for improvement. This should make cmp(1) faster. There have been changes to behaviour as well: 1) If argv[0] and argv[1] are the same, cmp(1) returns Same. 2) POSIX specifies the format of the difference-message to be: "%s %s differ: char %d, line %d\n", file1, file2, <byte number>, <line number> However, as cmp(1) operates on bytes, not characters, I changed it to "%s %s differ: byte %d, line %d\n", file1, file2, <byte number>, <line number> This is one example where the standard just keeps the old format for backwards-compatibility. As this is harmful, this change makes sense in the sense of consistentcy (and because we take the difference of char and byte very seriously in sbase, as opposed to GNU coreutils). The manpage has been annotated, reflecting the second change, and sections shortened where possible. Thus I marked cmp(1) as finished in README.
2015-02-07 15:05:33 -05:00
=* cmp yes none
Finish up cols(1)
2015-01-31 18:55:22 -05:00
#* cols non-posix none
Add column to mark UTF-8 support One major milestone is to have the sbase-tools supporting UTF-8. Tools like cut(1) with the -n flag don't make sense otherwise. And while the gnu coreutils cut(1) blatantly ignores such an important aspect, we will not tolerate this madness and mark it as a TODO in the main README. Since most tools inherently support UTF-8 anyway, this just concerns tools which mangle with text or search in it in special ways.
2015-01-18 13:36:13 -05:00
=* comm yes none
Mark insane POSIX flags which we are not planning to include into sbase. What's left to discuss is how we're going to handle them in the tools (dump usage() or silently ignore them).
2015-01-23 17:31:46 -05:00
= cp no -H, (-i), -L
Add column to mark UTF-8 support One major milestone is to have the sbase-tools supporting UTF-8. Tools like cut(1) with the -n flag don't make sense otherwise. And while the gnu coreutils cut(1) blatantly ignores such an important aspect, we will not tolerate this madness and mark it as a TODO in the main README. Since most tools inherently support UTF-8 anyway, this just concerns tools which mangle with text or search in it in special ways.
2015-01-18 13:36:13 -05:00
=* cron non-posix none
Add UTF-8-delimiter-support to cut(1) Now you can specify a multibyte-delimiter to cut, which should definitely be possible for the end-user (Fuck POSIX). Looking at GNU/coreutils' cut(1)[0], which basically ignores the difference between characters and bytes, the -n-option and which is bloated as hell, one has to wonder why they are still default. This is insane! Things like this personally keep me motivated to make sbase better every day. [0]: http://git.savannah.gnu.org/gitweb/?p=coreutils.git;a=blob;f=src/cut.c;hb=HEAD NSFW! You have been warned.
2015-01-22 06:32:50 -05:00
#* cut yes none
Add mandoc-manpage for date(1) and clean up code and mark it as finished in README.
2015-01-23 16:54:25 -05:00
=* date yes none
Add mandoc-manpage for dirname(1) and mark it as finished in the README.
2015-01-23 17:17:54 -05:00
=* dirname yes none
Mark insane POSIX flags which we are not planning to include into sbase. What's left to discuss is how we're going to handle them in the tools (dump usage() or silently ignore them).
2015-01-23 17:31:46 -05:00
= du no -H, -L, (-x)
Add mandoc-manpage for echo(1) and mark it as finished in the README.
2015-01-23 17:49:24 -05:00
=* echo yes none
Add mandoc-manpage for env(1) and mark it as finished in the README.
2015-01-23 18:22:06 -05:00
=* env yes none
Add tablist support and a mandoc-manpage to expand(1) and mark it as finished in the README. This is another example showing how broken the GNU coreutils are: $ echo -e "äää\tüüü\tööö" | gnu-expand -t "5,10,20" äää üüü ööö $ echo -e "äää\tüüü\tööö" | sbase-expand -t "5,10,20" äää üüü ööö This is due to the fact that they are still not UTF8-aware and actually see "ä" as two single characters, expanding the "äää" with 4 spaces to a tab of length 10. The correct way however is to expand the "äää" with 2 spaces to a tab of length 5. One can only imagine how this silently breaks a lot of code around the world. WHAT WERE THEY THINKING?
2015-01-25 08:31:02 -05:00
#* expand yes none
Add mandoc-manpage for expr(1) and mark it as finished in README. Upon further checking, expr(1) turns out to be implicitly UTF-8 compliant.
2015-01-25 10:49:46 -05:00
=* expr yes none
Add column to mark UTF-8 support One major milestone is to have the sbase-tools supporting UTF-8. Tools like cut(1) with the -n flag don't make sense otherwise. And while the gnu coreutils cut(1) blatantly ignores such an important aspect, we will not tolerate this madness and mark it as a TODO in the main README. Since most tools inherently support UTF-8 anyway, this just concerns tools which mangle with text or search in it in special ways.
2015-01-18 13:36:13 -05:00
=* false yes none
Mark fold(1) and grep(1) as finished in the README
2015-01-25 15:33:28 -05:00
#* fold yes none
=* grep yes none
Add mandoc-manpage for head(1) and clean up code and mark it as finished in the README.
2015-01-25 16:01:26 -05:00
=* head yes none
Finish up hostname(1)
2015-01-31 18:03:03 -05:00
=* hostname non-posix none
Add column to mark UTF-8 support One major milestone is to have the sbase-tools supporting UTF-8. Tools like cut(1) with the -n flag don't make sense otherwise. And while the gnu coreutils cut(1) blatantly ignores such an important aspect, we will not tolerate this madness and mark it as a TODO in the main README. Since most tools inherently support UTF-8 anyway, this just concerns tools which mangle with text or search in it in special ways.
2015-01-18 13:36:13 -05:00
=* kill yes none
Add mandoc-manpage for link(1) and mark it as finished in the README.
2015-01-25 16:44:47 -05:00
=* link yes none
Add mandoc-manpage for ln(1) and mark it as finished in the README.
2015-01-26 08:54:22 -05:00
=* ln yes none
Add column to mark UTF-8 support One major milestone is to have the sbase-tools supporting UTF-8. Tools like cut(1) with the -n flag don't make sense otherwise. And while the gnu coreutils cut(1) blatantly ignores such an important aspect, we will not tolerate this madness and mark it as a TODO in the main README. Since most tools inherently support UTF-8 anyway, this just concerns tools which mangle with text or search in it in special ways.
2015-01-18 13:36:13 -05:00
=* logger yes none
Add mandoc-manpage for logname(1) and mark it as finished in README.
2015-01-26 09:06:50 -05:00
=* logname yes none
ls: Implement -c and update manpage Update usage + README as well. Apparently some of the options ( -H and -L) had already been implemented but not reflected in the program usage line.
2015-01-20 11:50:37 -05:00
= ls no -C, -R, -q, -u
Finish up chroot(1) and md5sum(1)
2015-01-31 17:54:23 -05:00
=* md5sum non-posix none
Add mandoc-manpage for mkdir(1) and clean up code and mark it as finished in the README.
2015-01-26 09:30:56 -05:00
=* mkdir yes none
Add mandoc-manpage for mkfifo(1) and add full mode support and mark it as finished in the README. Previously, it would only parse octal mode strings. Given we have the parsemode()-function in util.h anyway, why not also use it?
2015-01-28 14:55:50 -05:00
=* mkfifo yes none
Finish up mktemp(1)
2015-01-31 18:14:19 -05:00
=* mktemp non-posix none
Add mandoc-manpage for mv(1) and mark it as finished in README. Make it clear that -i has not been implemented yet and drop the flag in the code instead of erroring out.
2015-01-28 16:06:50 -05:00
=* mv yes (-i)
Add mandoc-manpage for nice(1) and mark it as finished in README.
2015-01-28 16:40:40 -05:00
=* nice yes none
Add column to mark UTF-8 support One major milestone is to have the sbase-tools supporting UTF-8. Tools like cut(1) with the -n flag don't make sense otherwise. And while the gnu coreutils cut(1) blatantly ignores such an important aspect, we will not tolerate this madness and mark it as a TODO in the main README. Since most tools inherently support UTF-8 anyway, this just concerns tools which mangle with text or search in it in special ways.
2015-01-18 13:36:13 -05:00
= nl no -d, -f, -h, -l, -n, -p, -v, -w
Add mandoc-manpage for nohup(1) and mark it as finished in README.
2015-01-28 17:55:57 -05:00
=* nohup yes none
Add mandoc-manpage for paste(1) and mark it as finished in README.
2015-01-29 15:26:09 -05:00
#* paste yes none
Finish up printenv(1)
2015-01-31 18:23:38 -05:00
=* printenv non-posix none
Add column to mark UTF-8 support One major milestone is to have the sbase-tools supporting UTF-8. Tools like cut(1) with the -n flag don't make sense otherwise. And while the gnu coreutils cut(1) blatantly ignores such an important aspect, we will not tolerate this madness and mark it as a TODO in the main README. Since most tools inherently support UTF-8 anyway, this just concerns tools which mangle with text or search in it in special ways.
2015-01-18 13:36:13 -05:00
printf stolen stolen
=* pwd yes none
Edit readlink.1 and document missing flags
2015-01-31 18:43:43 -05:00
= readlink non-posix -e, -m
Mark renice(1) as finished in README
2015-01-29 17:58:44 -05:00
=* renice yes none
Add mandoc-manpage for rm(1) and mark it as finished in README.
2015-01-30 05:34:05 -05:00
=* rm yes (-i)
Add mandoc-manpage for rmdir(1) and mark it as finished in README.
2015-01-30 07:30:03 -05:00
=* rmdir yes none
Finish up setsid(1)
2015-01-31 18:47:32 -05:00
=* setsid non-posix none
Add mandoc-manpage for sleep(1) and refactor the code a bit and mark it as finished in README.
2015-01-30 07:41:36 -05:00
=* sleep yes none
Add column to mark UTF-8 support One major milestone is to have the sbase-tools supporting UTF-8. Tools like cut(1) with the -n flag don't make sense otherwise. And while the gnu coreutils cut(1) blatantly ignores such an important aspect, we will not tolerate this madness and mark it as a TODO in the main README. Since most tools inherently support UTF-8 anyway, this just concerns tools which mangle with text or search in it in special ways.
2015-01-18 13:36:13 -05:00
sort no -m, -o, -d, -f, -i
split: fixes - -b argument required, don't allow -b <= 0. - -l argument required, don't allow -l <= 0. - usage() and argument parsing: sort flags. - don't write 0 size file, get rid of goto reproducable with: printf 'a' | split -b 1. - close FILE *in if != stdin. - mark split as finished in README. - codestyle fixes.
2015-02-01 08:00:47 -05:00
=* split yes none
Refactor sponge(1) code and manpage and mark it as finished in README.
2015-02-08 16:17:21 -05:00
=* sponge non-posix none
Add column to mark UTF-8 support One major milestone is to have the sbase-tools supporting UTF-8. Tools like cut(1) with the -n flag don't make sense otherwise. And while the gnu coreutils cut(1) blatantly ignores such an important aspect, we will not tolerate this madness and mark it as a TODO in the main README. Since most tools inherently support UTF-8 anyway, this just concerns tools which mangle with text or search in it in special ways.
2015-01-18 13:36:13 -05:00
strings no -a, -n, -t
Refactor sync(1) code and manpage and mark it as finished in README.
2015-02-08 16:08:14 -05:00
=* sync non-posix none
Add column to mark UTF-8 support One major milestone is to have the sbase-tools supporting UTF-8. Tools like cut(1) with the -n flag don't make sense otherwise. And while the gnu coreutils cut(1) blatantly ignores such an important aspect, we will not tolerate this madness and mark it as a TODO in the main README. Since most tools inherently support UTF-8 anyway, this just concerns tools which mangle with text or search in it in special ways.
2015-01-18 13:36:13 -05:00
= tail no -c, -f
Refactor tar(1) manpage and mark it as finished in the README. Specifically, add a small section on the compression flags, which are basically an infected GNU limb which should be removed from the face of the earth as soon as possible.
2015-02-08 17:16:27 -05:00
=* tar non-posix none
Mark tee(1) as finished in the README
2015-01-23 16:04:19 -05:00
=* tee yes none
Add column to mark UTF-8 support One major milestone is to have the sbase-tools supporting UTF-8. Tools like cut(1) with the -n flag don't make sense otherwise. And while the gnu coreutils cut(1) blatantly ignores such an important aspect, we will not tolerate this madness and mark it as a TODO in the main README. Since most tools inherently support UTF-8 anyway, this just concerns tools which mangle with text or search in it in special ways.
2015-01-18 13:36:13 -05:00
test yes none
Update README for touch
2015-01-20 06:22:09 -05:00
= touch no -r
Add column to mark UTF-8 support One major milestone is to have the sbase-tools supporting UTF-8. Tools like cut(1) with the -n flag don't make sense otherwise. And while the gnu coreutils cut(1) blatantly ignores such an important aspect, we will not tolerate this madness and mark it as a TODO in the main README. Since most tools inherently support UTF-8 anyway, this just concerns tools which mangle with text or search in it in special ways.
2015-01-18 13:36:13 -05:00
#* tr yes none
=* true yes none
Refactor tty(1) code and manpage
2015-02-07 16:00:28 -05:00
=* tty yes none
Refactor uname(1) code and manpage remove stdlib.h-include which was there for no reason and clear up the manpage.
2015-02-07 16:15:56 -05:00
=* uname yes none
Refactor unexpand(1) code and manpage, adding tablist support as already seen for expand(1), only twice as complicated.
2015-02-08 15:24:22 -05:00
#* unexpand yes none
Add column to mark UTF-8 support One major milestone is to have the sbase-tools supporting UTF-8. Tools like cut(1) with the -n flag don't make sense otherwise. And while the gnu coreutils cut(1) blatantly ignores such an important aspect, we will not tolerate this madness and mark it as a TODO in the main README. Since most tools inherently support UTF-8 anyway, this just concerns tools which mangle with text or search in it in special ways.
2015-01-18 13:36:13 -05:00
= uniq no -f, -s
Refactor unlink(1) code and manpage Remove superfluous stdlib.h-include.
2015-02-08 15:59:27 -05:00
=* unlink yes none
Fix alphabetical order in README
2015-01-26 07:12:44 -05:00
= uudecode no -o
= uuencode no -m
Add column to mark UTF-8 support One major milestone is to have the sbase-tools supporting UTF-8. Tools like cut(1) with the -n flag don't make sense otherwise. And while the gnu coreutils cut(1) blatantly ignores such an important aspect, we will not tolerate this madness and mark it as a TODO in the main README. Since most tools inherently support UTF-8 anyway, this just concerns tools which mangle with text or search in it in special ways.
2015-01-18 13:36:13 -05:00
seq non-posix none
= sha1sum non-posix none
= sha256sum non-posix none
= sha512sum non-posix none
Finish up wc(1) Use size_t for all counts, fix the manpage and refactor the code. Here's yet another place where GNU coreutils fail: sbase: $ echo "GNU/Turd sucks" | wc -cm 15 coreutils: $ echo "GNU/Turd sucks" | wc -cm 15 15 Take a bloody guess which behaviour is correct[0]. [0]: http://pubs.opengroup.org/onlinepubs/009604499/utilities/wc.html
2015-01-31 21:01:11 -05:00
#* wc yes none
Add column to mark UTF-8 support One major milestone is to have the sbase-tools supporting UTF-8. Tools like cut(1) with the -n flag don't make sense otherwise. And while the gnu coreutils cut(1) blatantly ignores such an important aspect, we will not tolerate this madness and mark it as a TODO in the main README. Since most tools inherently support UTF-8 anyway, this just concerns tools which mangle with text or search in it in special ways.
2015-01-18 13:36:13 -05:00
= xargs no -I, -L, -p, -s, -t, -x
POSIX doesn't specify yes(1) so mark it as such in README
2015-01-31 20:27:44 -05:00
=* yes non-posix none
Add an easier to edit "table" of tools in README We need to go through the tools and update this table to reflect current state.
2014-11-20 18:01:56 -05:00
Minor fix for README
2014-02-12 13:39:13 -05:00
The complement of sbase is ubase[1] which is Linux-specific and
Add initial README
2014-02-12 09:34:09 -05:00
provides all the non-portable tools. Together they are intended to
form a base system similar to busybox but much smaller and suckless.
Building
--------
To build sbase, simply type make. You may have to fiddle with
config.mk depending on your system.
You can also build sbase-box, which generates a single binary
containing all the required tools. You can then symlink the
individual tools to sbase-box.
Ideally you will want to statically link sbase. If you are on Linux
we recommend using musl-libc[2].
Portability
-----------
sbase has been compiled on a variety of different operating systems,
including Linux, *BSD, OSX, Haiku, Solaris, SCO OpenServer and others.
Various combinations of operating systems and architectures have also
been built.
You can build sbase with gcc, clang, tcc, nwcc and pcc.
[1] http://git.suckless.org/ubase/
[2] http://www.musl-libc.org/
Reference in New Issue Copy Permalink