sbase/README

sbase - suckless unix tools
===========================

sbase  is a  collection of  unix  tools that  are inherently  portable
across UNIX and UNIX-like systems.

The following tools are implemented ('*' == finished, '#' == UTF-8 support,
'=' == implicit UTF-8 support):

   UTILITY         POSIX 2008 COMPLIANT         MISSING OPTIONS
   -------         --------------------         ---------------
=* basename        yes                          none
=* cal             yes                          none
=* cat             yes                          none
=* chgrp           yes                          none
=* chmod           yes                          none
=* chown           yes                          none
=* chroot          non-posix                    none
=* cksum           yes                          none
=* cmp             yes                          none
#* cols            non-posix                    none
=* comm            yes                          none
=  cp              yes                          none (-i)
=* cron            non-posix                    none
#* cut             yes                          none
=* date            yes                          none
=* dirname         yes                          none
=  du              yes                          none (-x)
=* echo            yes                          none
=* env             yes                          none
#* expand          yes                          none
=* expr            yes                          none
=* false           yes                          none
#* fold            yes                          none
=* grep            yes                          none
=* head            yes                          none
=* hostname        non-posix                    none
=* kill            yes                          none
=* link            yes                          none
=* ln              yes                          none
=* logger          yes                          none
=* logname         yes                          none
=  ls              no                           -C, -R
=* md5sum          non-posix                    none
=* mkdir           yes                          none
=* mkfifo          yes                          none
=* mktemp          non-posix                    none
=* mv              yes                          none (-i)
=* nice            yes                          none
=  nl              no                           -d, -f, -h, -l, -n, -p, -v, -w
=* nohup           yes                          none
#* paste           yes                          none
=* printenv        non-posix                    none
#* printf          yes                          none
=* pwd             yes                          none
=  readlink        non-posix                    none
=* renice          yes                          none
=* rm              yes                          none (-i)
=* rmdir           yes                          none
#  sed
   seq             non-posix                    none
=* setsid          non-posix                    none
=  sha1sum         non-posix                    none
=  sha256sum       non-posix                    none
=  sha512sum       non-posix                    none
=* sleep           yes                          none
   sort            no                           -m, -o, -d, -f, -i
=* split           yes                          none
=* sponge          non-posix                    none
#* strings         yes                          none
=* sync            non-posix                    none
=* tail            yes                          none
=* tar             non-posix                    none
=* tee             yes                          none
#* test            yes                          none
=* touch           yes                          none
#* tr              yes                          none
=* true            yes                          none
=* tty             yes                          none
=* uname           yes                          none
#* unexpand        yes                          none
=* uniq            yes                          none
=* unlink          yes                          none
=* uudecode        yes                          none
=* uuencode        yes                          none
#* wc              yes                          none
=  xargs           no                           -I, -L, -p, -s, -t, -x
=* yes             non-posix                    none

The  complement of  sbase  is  ubase[1] which  is  Linux-specific  and
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/
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
Reformat README 2015-02-08 18:20:33 -05:00			`UTILITY POSIX 2008 COMPLIANT MISSING OPTIONS`
			`------- -------------------- ---------------`
			`=* basename yes none`
			`=* cal yes none`
			`=* cat yes none`
Update README for chown, chgrp -H -L -P 2015-02-15 10:41:30 -05:00			`=* chgrp yes none`
Reformat README 2015-02-08 18:20:33 -05:00			`=* chmod yes none`
Update README for chown, chgrp -H -L -P 2015-02-15 10:41:30 -05:00			`=* chown yes none`
Reformat README 2015-02-08 18:20:33 -05:00			`=* chroot non-posix none`
			`=* cksum yes none`
			`=* cmp yes none`
			`#* cols non-posix none`
			`=* comm yes none`
Update README reflecting recent changes to the codebase 2015-02-09 18:53:48 -05:00			`= cp yes none (-i)`
Reformat README 2015-02-08 18:20:33 -05:00			`=* cron non-posix none`
			`#* cut yes none`
			`=* date yes none`
			`=* dirname yes none`
Update README reflecting recent changes to the codebase 2015-02-09 18:53:48 -05:00			`= du yes none (-x)`
Reformat README 2015-02-08 18:20:33 -05:00			`=* echo yes none`
			`=* env yes none`
			`#* expand yes none`
			`=* expr yes none`
			`=* false yes none`
			`#* fold yes none`
			`=* grep yes none`
			`=* head yes none`
			`=* hostname non-posix none`
			`=* kill yes none`
			`=* link yes none`
			`=* ln yes none`
			`=* logger yes none`
			`=* logname yes none`
Implement -u support for ls(1) 2015-02-18 11:29:46 -05:00			`= ls no -C, -R`
Reformat README 2015-02-08 18:20:33 -05:00			`=* md5sum non-posix none`
			`=* mkdir yes none`
			`=* mkfifo yes none`
			`=* mktemp non-posix none`
			`=* mv yes none (-i)`
			`=* nice yes none`
			`= nl no -d, -f, -h, -l, -n, -p, -v, -w`
			`=* nohup yes none`
			`#* paste yes none`
			`=* printenv non-posix none`
Add printf(1) This is a particularly interesting program. I managed to implement everything according to POSIX except how octal escapes are specified in the standard, which is yet another format compared to the one demanded for tr(1). This not only confuses people, it also adds unnecessary cruft for no real gain. So in order to be able to use unescape() easily and for consistency, I used our initial format \o[oo] instead of \0[ooo]. Marked as optional is UTF-8 support for %c in the POSIX specification. Given how well-developed libutf has become, doing this here was more or less trivial, putting us yet again ahead of the competition. 2015-02-15 08:46:58 -05:00			`#* printf yes none`
Reformat README 2015-02-08 18:20:33 -05:00			`=* pwd yes none`
Update readlink in README 2015-02-11 06:54:58 -05:00			`= readlink non-posix none`
Reformat README 2015-02-08 18:20:33 -05:00			`=* renice yes none`
			`=* rm yes none (-i)`
			`=* rmdir yes none`
Fix alphabetical order in README 2015-02-10 06:11:21 -05:00			`# sed`
			`seq non-posix none`
Reformat README 2015-02-08 18:20:33 -05:00			`=* setsid non-posix none`
Fix alphabetical order in README 2015-02-10 06:11:21 -05:00			`= sha1sum non-posix none`
			`= sha256sum non-posix none`
			`= sha512sum non-posix none`
Reformat README 2015-02-08 18:20:33 -05:00			`=* sleep yes none`
			`sort no -m, -o, -d, -f, -i`
			`=* split yes none`
			`=* sponge non-posix none`
Add UTF-8-support to strings(1), add t-flag and refactor code Previously, the string-length was limited to BUFSIZ, which is an obvious deficiency. Now the buffer only needs to be as long as the user specifies the minimal string length. I added UTF-8-support, because that's how POSIX wants it and there are cases where you need this. It doesn't add ELF-barf compared to the previous implementation. The t-flag is also pretty important for POSIX-compliance, so I added it. The only trouble previously was the a-flag, but given that POSIX leaves undefined what the a-flag actually does, we set it as default and don't care about parsing ELF-headers, which has already turned out to be a security issue in GNU coreutils[0]. [0]: http://lcamtuf.blogspot.ro/2014/10/psa-dont-run-strings-on-untrusted-files.html 2015-02-17 11:04:36 -05:00			`#* strings yes none`
Reformat README 2015-02-08 18:20:33 -05:00			`=* sync non-posix none`
Add c-flag to tail(1) and refactor manpage and mark it as finished in README. 2015-02-09 12:38:41 -05:00			`=* tail yes none`
Reformat README 2015-02-08 18:20:33 -05:00			`=* tar non-posix none`
			`=* tee yes none`
Use strtonum and libutf in test(1), refactor code and manpage and mark it as finished in README. 2015-02-09 16:21:23 -05:00			`#* test yes none`
Add r-flag to touch(1), refactor manpage and code and mark it as finished in README. 2015-02-08 18:41:57 -05:00			`=* touch yes none`
Reformat README 2015-02-08 18:20:33 -05:00			`#* tr yes none`
			`=* true yes none`
			`=* tty yes none`
			`=* uname yes none`
			`#* unexpand yes none`
uniq: Add standards section to manpage and update README 2015-02-11 10:55:58 -05:00			`=* uniq yes none`
Reformat README 2015-02-08 18:20:33 -05:00			`=* unlink yes none`
Update uudecode manpage and mark as complete 2015-02-13 06:29:53 -05:00			`=* uudecode yes none`
Update uuencode manpage and mark as complete in README 2015-02-13 06:38:52 -05:00			`=* uuencode yes none`
Reformat README 2015-02-08 18:20:33 -05:00			`#* wc yes none`
			`= xargs no -I, -L, -p, -s, -t, -x`
			`=* 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/`