sbase/README

123 lines
5.7 KiB
Plaintext
Raw Normal View History

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.
The following tools are implemented ('*' == finished, '#' == UTF-8 support,
'=' == implicit UTF-8 support, '|' == audited, () == petty flag):
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
col yes none
2015-03-11 08:47:33 -04:00
=*| comm yes none
=*| cp yes none (-i)
=*| cron non-posix none
#*| cut yes none
=*| date yes none
=*| dirname yes none
2015-03-11 18:31:26 -04:00
=*| 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
2015-02-28 13:42:26 -05:00
=*| link yes none
=*| ln yes none
=*| logger yes none
=*| logname yes none
#* ls no none (-C, -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 yes none
=*| 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 yes none
=*| 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
Audit tar(1), add DIRFIRST-flag to recurse() I've been wanting to do this for a while now, as tar(1) used to be one of messiest and cruftiest tools. First off, before walking through the audit, I'll talk about what the DIRFIRST-flag for recurse() does. It basically calls fn() on the first-level-dir before calling it's subentries. It's necessary here, because else the order of the tar-files would've been wrong (it would try to create dir/file before creating dir/). Now, to the audit: 1) Update manpage, fix mistake that compression is also available for compressing. It's only available for extracting. 2) Define the major, minor and makedev macros from glibc by ourselves. No need to rely on them, as they are common sense. decomp() 3) Simple refactorization. putoctal() 4) Add a truncation check for snprintf(). archive() 5) BUGFIX: Add checks to any checkable function, don't blindly call them, this is harmful and there are 100 ways to exploit that. 6) Use estrlcpy() instead of snprintf() wherever possible, fix alignment. 7) BUGFIX: Terminate the result-buffer of readlink(), check if it even succeeded. 8) Fix sizeof()-formatting. unarchive() 9) BUGFIX: Add checks to any checkable function, don't blindly call them, this is harmful and there are 100 ways to exploit that. 10) BUGFIX: strtoul can happily return negative numbers. Add checks for that and also if the full string has been processed. 11) Remove calls to perror(). We have eprintf, use it. 12) BUGFIX: "minor = strtoul(h->mode, 0, 8);". We need h->minor of course. 13) Fix typo "usupported", remove fprintf-call. print() 14) Check fread(). xt() 15) Get rid of snprintf-magic. Use estrlcat(). 16) BUGFIX: check for ferror() on the tarfile. usage() 17) Update it. The old usage() was like 1000 years old. main() 18) Add DIRFIRST-flag to the recursor. 19) Don't print usage() when a mode is re-set. We allow this in general. 20) Add function checks and fix error messages. 21) Add tarfilename-global for proper error-messages.
2015-03-20 20:03:35 -04:00
=*| 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
2015-02-28 15:12:27 -05:00
=*| yes non-posix none
2014-02-12 13:39:13 -05:00
The complement of sbase is ubase[1] which is Linux-specific and
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 or run: make sbase-box-install
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/