sbase/README

130 lines
3.0 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:
'#' -> UTF-8 support, '=' -> Implicit UTF-8 support, '*' -> Finished,
'|' -> Audited, 'o' -> POSIX 2013 compliant, 'x' -> Non-POSIX,
'()' -> Petty flag
UTILITY MISSING
------- -------
=*|o basename .
=*|o cal .
=*|o cat .
=*|o chgrp .
=*|o chmod .
=*|o chown .
=*|x chroot .
=*|o cksum .
=*|o cmp .
#*|x cols .
=*|o comm .
=*|o cp (-i)
=*|x cron .
#*|o cut .
=*|o date .
=*|o dirname .
=*|o du .
=*|o echo .
=*|o env .
#*|o expand .
#*|o expr .
=*|o false .
= find .
#*|o fold .
=* o getconf (-v)
=* o grep .
=*|o head .
=*|x hostname .
2015-04-20 06:23:20 -04:00
=* o join .
=*|o kill .
=*|o link .
=*|o ln .
=*|o logger .
=*|o logname .
#* o ls (-C, -k, -m, -p, -s, -x)
=*|x md5sum .
=*|o mkdir .
=*|o mkfifo .
=*|x mktemp .
=*|o mv (-i)
=*|o nice .
#*|o nl .
=*|o nohup .
Implement od(1) v-flag If this flag is not given, od(1) automatically replaces duplicate adjacent lines with an '*' for each reoccurence. If this flag is set, thus, no such filtering occurs. In this case this would mean having to somehow keep the last printed line in some backbuffer, building the next line and then doing the necessary comparisons. This basically means that we duplicate the functionality provided with uniq(1). So instead of $ od -t a > dump you'd rather do $ od -t a | uniq -f 1 -c > dump Skipping the first field is necessary, as the addresses obviously differ. Now, I was thinking hard why this flag even exists. If POSIX mandated to add the address before the asterisk, so we know the offset of duplicate occurrences, this would make sense. However, this is not the case. Using uniq(1) also gives nicer output: ~ $ echo "111111111111111111111111111111111111111111111111" | od -t a -v | uniq -f 1 -c 3 0000000 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 0000060 nl 1 0000061 in comparison to $ echo "111111111111111111111111111111111111111111111111" | od -t a 0000000 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1 * 0000060 nl 0000061 Before working on od(1), I didn't even know it would filter out duplicate adjacent lines like that. This is also a matter of predictability. Concluding, the v-flag is implicitly set and users urged to just use the existing tools provided by the system. I don't think we would break scripts either. Firstly, it's rather unlikely to have duplicate lines exactly matching the line-length of od(1). Secondly, even if a script did that specifically, in the worst case there would be a counting error or something. Given od(1) is mostly used interactively, we can safely assume this feature is for the benefit of the users. Ditch this legacy POSIX crap! Please enter the commit message for your changes. Lines starting
2015-09-30 06:54:24 -04:00
od -t
#*|o paste .
=*|x printenv .
#*|o printf .
=*|o pwd .
=*|x readlink .
=*|o renice .
=*|o rm (-i)
=*|o rmdir .
# sed .
=*|x seq .
=*|x setsid .
=*|x sha1sum .
=*|x sha256sum .
=*|x sha512sum .
=*|o sleep .
#*|o sort (-d, -f, -i)
=*|o split .
=*|x sponge .
#*|o strings .
=*|x sync .
=*|o tail .
=*|x tar .
=*|o tee .
=*|o test .
=* x tftp .
=*|o time .
=*|o touch .
#*|o tr .
=*|o true .
=*|o tty .
=*|o uname .
#*|o unexpand .
=*|o uniq .
=*|o unlink .
=*|o uudecode .
=*|o uuencode .
#*|o wc .
=*|x which .
=*|o xargs (-p)
=*|x yes .
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/