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, '|' == audited):

    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                          -u
=*| dirname         yes                          none
=*  du              yes                          none
=*  echo            yes                          none
=*  env             yes                          none
#*  expand          yes                          none
#*  expr            yes                          none
=*| false           yes                          none
=   find            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), -S, -f, -m, -s, -x
=*  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, -p
=*  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
=   time            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 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/
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,`
Add audit-section to README Okay, so why another section? The finished-section applies to general feature-completeness and manual status. It somehow is not an indicator for general code- clarity, so the audited-column reflects a thorough audit of the underlying code and optimization. Take a look at the upcoming basename(1)-patch for an example on how this goes. 2015-02-28 08:42:26 -05:00			`'=' == implicit UTF-8 support, '\|' == audited):`
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
Audit basename(1) 1) be stricter which number of arguments is accepted (1 or 2) 2) basename already returns a pointer to "." is argv[0] is "" 3) No need to check for *p != '/', because basename() only returns a string beginning with '/' which has length 1, so if strlen(p) == 1, the only way for suffix to be "evaluated" is for off to be > 0, being equal to suffix being "", but "" != "/". 4) don't calculate strlen twice for each string. Store it in a ssize_t and check if it's > 0. 2015-02-28 08:48:44 -05:00			`UTILITY POSIX 2008 COMPLIANT MISSING OPTIONS`
			`------- -------------------- ---------------`
			`=*\| basename yes none`
Add audit-section to README Okay, so why another section? The finished-section applies to general feature-completeness and manual status. It somehow is not an indicator for general code- clarity, so the audited-column reflects a thorough audit of the underlying code and optimization. Take a look at the upcoming basename(1)-patch for an example on how this goes. 2015-02-28 08:42:26 -05:00			`=* 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 -u`
Audit dirname(1) Be stricter about the number of arguments passed to it. 2015-02-28 13:50:12 -05:00			`=*\| dirname yes none`
Add audit-section to README Okay, so why another section? The finished-section applies to general feature-completeness and manual status. It somehow is not an indicator for general code- clarity, so the audited-column reflects a thorough audit of the underlying code and optimization. Take a look at the upcoming basename(1)-patch for an example on how this goes. 2015-02-28 08:42:26 -05:00			`=* du yes none`
			`=* echo yes none`
			`=* env yes none`
			`#* expand yes none`
			`#* expr yes none`
Mark false(1) and true(1) as audited Nothing to be done there. 2015-02-28 09:12:19 -05:00			`=*\| false yes none`
Add audit-section to README Okay, so why another section? The finished-section applies to general feature-completeness and manual status. It somehow is not an indicator for general code- clarity, so the audited-column reflects a thorough audit of the underlying code and optimization. Take a look at the upcoming basename(1)-patch for an example on how this goes. 2015-02-28 08:42:26 -05:00			`= find yes none`
			`#* fold yes none`
			`=* grep yes none`
			`=* head yes none`
			`=* hostname non-posix none`
			`=* kill yes none`
Audit link(1) 2015-02-28 13:42:26 -05:00			`=*\| link yes none`
Add audit-section to README Okay, so why another section? The finished-section applies to general feature-completeness and manual status. It somehow is not an indicator for general code- clarity, so the audited-column reflects a thorough audit of the underlying code and optimization. Take a look at the upcoming basename(1)-patch for an example on how this goes. 2015-02-28 08:42:26 -05:00			`=* ln yes none`
			`=* logger yes none`
			`=* logname yes none`
			`= ls no (-C), -S, -f, -m, -s, -x`
			`=* 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, -p`
			`=* 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`
Audit sleep(1) 1) Be strict about argc 2) Use "unsigned" instead of "unsigned int" 2015-02-28 14:10:25 -05:00			`=*\| sleep yes none`
Add audit-section to README Okay, so why another section? The finished-section applies to general feature-completeness and manual status. It somehow is not an indicator for general code- clarity, so the audited-column reflects a thorough audit of the underlying code and optimization. Take a look at the upcoming basename(1)-patch for an example on how this goes. 2015-02-28 08:42:26 -05:00			`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`
Update README for time(1) 2015-02-28 09:42:11 -05:00			`= time yes none`
Add audit-section to README Okay, so why another section? The finished-section applies to general feature-completeness and manual status. It somehow is not an indicator for general code- clarity, so the audited-column reflects a thorough audit of the underlying code and optimization. Take a look at the upcoming basename(1)-patch for an example on how this goes. 2015-02-28 08:42:26 -05:00			`=* touch yes none`
			`#* tr yes none`
Mark false(1) and true(1) as audited Nothing to be done there. 2015-02-28 09:12:19 -05:00			`=*\| true yes none`
Audit tty(1) 1) Be strict about number of arguments passed 2) Use a simpler logic while returning 2015-02-28 13:59:34 -05:00			`=*\| tty yes none`
Add audit-section to README Okay, so why another section? The finished-section applies to general feature-completeness and manual status. It somehow is not an indicator for general code- clarity, so the audited-column reflects a thorough audit of the underlying code and optimization. Take a look at the upcoming basename(1)-patch for an example on how this goes. 2015-02-28 08:42:26 -05:00			`=* uname yes none`
			`#* unexpand yes none`
			`=* uniq yes none`
Audit unlink(1) One small thing, use argv0 in usage. Also, add a blank line in link.c which I forgot earlier. 2015-02-28 14:05:22 -05:00			`=*\| unlink yes none`
Add audit-section to README Okay, so why another section? The finished-section applies to general feature-completeness and manual status. It somehow is not an indicator for general code- clarity, so the audited-column reflects a thorough audit of the underlying code and optimization. Take a look at the upcoming basename(1)-patch for an example on how this goes. 2015-02-28 08:42:26 -05:00			`=* uudecode yes none`
			`=* uuencode yes none`
			`#* 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`
README: document sbase-box-install rule 2015-02-28 09:40:16 -05:00			`individual tools to sbase-box or run: make sbase-box-install`
Add initial README 2014-02-12 09:34:09 -05:00
			`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/`