sbase/README
FRIGN 4750b233ce Prepare POSIX 2013 audit
I can't believe we've come this far! The idea is to look at the
2013 POSIX corrigendum for each tool and deep-test features before
making the first 0.1 release.
To keep the noise low, I'll do this in batches, not on a per-tool-
basis (as many of these are trivial to test).
In the meantime, I'll also think of a fitting STANDARDS section
for the non-POSIX tools. Now that the audits are pretty much done,
I can also have a more relaxed view on standards compliance instead
of having to dig through some uncleaned mess.

To mark this "new beginning", the README has gotten a liftover.
The POSIX 2008-column was more or less useless and as I expect the
checks to go along pretty quickly, I "reset" the compliance state
of all but the non-POSIX tools and will then go along and check every
single one of them in the next few days.

Apart from the few missing flags and audits, sbase should then be
ready to hit the world with the first release after 4 years of work.
2015-03-23 16:22:00 +01:00

126 lines
2.9 KiB
Plaintext

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:
'#' -> UTF-8 support, '=' -> Implicit UTF-8 support, '*' -> Finished,
'|' -> Audited, 'o' -> POSIX 2013 compliant, 'x' -> Non-POSIX,
'()' -> Petty flag
UTILITY MISSING FLAGS
------- -------------
=*| basename .
=*| cal .
=*| cat .
=*| chgrp .
=*| chmod .
=*| chown .
=*|x chroot .
=*| cksum .
=*| cmp .
#*|x cols .
#*|x col .
=*| comm .
=*| cp (-i)
=*|x cron .
#*| cut .
=*| date .
=*| dirname .
=*| du .
=*| echo .
=*| env .
#*| expand .
#*| expr .
=*| false .
= find .
#*| fold .
=* grep .
=*| head .
=*|x hostname .
=*| kill .
=*| link .
=*| ln .
=*| logger .
=*| logname .
#* ls (-C, -m, -s, -x)
=*|x md5sum .
=*| mkdir .
=*| mkfifo .
=*|x mktemp .
=*| mv (-i)
=*| nice .
#*| nl .
=*| nohup .
#*| paste .
=*|x printenv .
#*| printf .
=*| pwd .
=*|x readlink .
=*| renice .
=*| rm (-i)
=*| rmdir .
# sed .
=*|x seq .
=*|x setsid .
=*|x sha1sum .
=*|x sha256sum .
=*|x sha512sum .
=*| sleep .
sort -d, -f, -i
=*| split .
=*|x sponge .
#*| strings .
=*|x sync .
=*| tail .
=*|x tar .
=*| tee .
=*| test .
=*| time .
=*| touch .
#*| tr .
=*| true .
=*| tty .
=*| uname .
#*| unexpand .
=*| uniq .
=*| unlink .
=*| uudecode .
=*| uuencode .
#*| wc .
=*| xargs (-p)
=*|x yes .
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 or run: make sbase-box-install
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/