suckless unix tools
Go to file
Michael Forney 9a3b12525b Don't use buffered IO (fread) when not appropriate
fread reads the entire requested size (BUFSIZ), which causes tools to
block if only small amounts of data are available at a time. At best,
this causes unnecessary copies and inefficiency, at worst, tools like
tee and cat are almost unusable in some cases since they only display
large chunks of data at a time.
2017-07-03 21:04:14 +02:00
libutf Add mkrunetype.awk 2015-02-23 20:36:47 +01:00
libutil Don't use buffered IO (fread) when not appropriate 2017-07-03 21:04:14 +02:00
LICENSE ed: Don't match against line 0 in search() 2016-12-27 12:28:36 +01:00
Makefile libutil: Add writeall utility function 2017-07-03 21:04:12 +02:00
README Add rev(1) 2016-12-27 11:35:27 +01:00
TODO Add a TODO-note about crypt.c 2016-12-27 14:30:51 +01:00
arg.h arg.h: fixed argv checks order 2016-02-20 08:23:57 +00:00
basename.1 Use ISO-date-format in manpages 2015-10-08 17:15:08 +02:00
basename.c Do not use arg.h for tools which take no flags 2015-04-25 11:43:14 +01:00
cal.1 Use ISO-date-format in manpages 2015-10-08 17:15:08 +02:00
cal.c cal: Highlight current day 2015-11-21 10:20:07 +00:00
cat.1 Use ISO-date-format in manpages 2015-10-08 17:15:08 +02:00
cat.c cat: fix u flag 2016-03-01 11:14:42 +00:00
chgrp.1 Use ISO-date-format in manpages 2015-10-08 17:15:08 +02:00
chgrp.c Remove st != NULL checks from recursor functions 2017-07-03 21:03:02 +02:00
chmod.1 Use ISO-date-format in manpages 2015-10-08 17:15:08 +02:00
chmod.c Remove st != NULL checks from recursor functions 2017-07-03 21:03:02 +02:00
chown.1 chown: fix user:group option parsing 2015-12-21 19:07:51 +00:00
chown.c Remove st != NULL checks from recursor functions 2017-07-03 21:03:02 +02:00
chroot.1 Use ISO-date-format in manpages 2015-10-08 17:15:08 +02:00
chroot.c Do not use arg.h for tools which take no flags 2015-04-25 11:43:14 +01:00
cksum.1 Use ISO-date-format in manpages 2015-10-08 17:15:08 +02:00
cksum.c Don't use buffered IO (fread) when not appropriate 2017-07-03 21:04:14 +02:00
cmp.1 Use ISO-date-format in manpages 2015-10-08 17:15:08 +02:00
cmp.c No need for semicolon after ARGEND 2015-11-01 10:18:55 +00:00
cols.1 Use ISO-date-format in manpages 2015-10-08 17:15:08 +02:00
cols.c Use the UTF8_POINT macro in cols(1) 2016-03-10 08:48:09 +00:00
comm.1 Use ISO-date-format in manpages 2015-10-08 17:15:08 +02:00
comm.c Rename struct linebufline to struct line and add linecmp() 2016-03-10 08:48:09 +00:00
compat.h Add compat.h 2014-11-17 15:46:28 +00:00
config.mk Use -D_FILE_OFFSET_BITS=64 by default 2015-11-13 11:01:00 +00:00
cp.1 cp.1: source and dest are not optional 2017-01-31 10:32:30 -08:00
cp.c No need for semicolon after ARGEND 2015-11-01 10:18:55 +00:00
cron.1 Use ISO-date-format in manpages 2015-10-08 17:15:08 +02:00
cron.c Sync cron with latest scron 2015-11-06 11:01:00 +00:00
crypt.h Don't use buffered IO (fread) when not appropriate 2017-07-03 21:04:14 +02:00
cut.1 Use ISO-date-format in manpages 2015-10-08 17:15:08 +02:00
cut.c Support NUL containing lines in cut(1) 2016-03-10 08:48:09 +00:00
date.1 Use ISO-date-format in manpages 2015-10-08 17:15:08 +02:00
date.c No need for semicolon after ARGEND 2015-11-01 10:18:55 +00:00
dirname.1 Use ISO-date-format in manpages 2015-10-08 17:15:08 +02:00
dirname.c Do not use arg.h for tools which take no flags 2015-04-25 11:43:14 +01:00
du.1 Use ISO-date-format in manpages 2015-10-08 17:15:08 +02:00
du.c du: Don't print 0 entry if stat of named file fails 2017-07-03 21:03:04 +02:00
echo.1 Use ISO-date-format in manpages 2015-10-08 17:15:08 +02:00
echo.c Do not use arg.h for tools which take no flags 2015-04-25 11:43:14 +01:00
ed.1 ed: add manpage 2016-12-27 12:53:30 +01:00
ed.c ed: fix commit 2ccc1e8 2017-01-10 11:30:34 +01:00
env.1 Use ISO-date-format in manpages 2015-10-08 17:15:08 +02:00
env.c env: Check unsetenv() return value 2015-11-06 10:52:49 +00:00
expand.1 Use ISO-date-format in manpages 2015-10-08 17:15:08 +02:00
expand.c No need for semicolon after ARGEND 2015-11-01 10:18:55 +00:00
expr.1 Use ISO-date-format in manpages 2015-10-08 17:15:08 +02:00
expr.c Simplify return & fshut() logic 2015-05-26 16:41:43 +01:00
false.1 Use ISO-date-format in manpages 2015-10-08 17:15:08 +02:00
false.c Simplify true(1) and false(1) 2014-10-03 00:03:08 +01:00
find.1 Use ISO-date-format in manpages 2015-10-08 17:15:08 +02:00
find.c find: remove VLAs 2016-12-27 12:46:06 +01:00
flock.1 Implement -o for flock(1) to close fd before exec 2015-10-26 11:55:41 +00:00
flock.c flock: Check for waitpid() error 2015-12-21 14:13:36 +00:00
fold.1 Use ISO-date-format in manpages 2015-10-08 17:15:08 +02:00
fold.c Support NUL containing lines in fold(1) and reuse the line-buffer(!) 2016-03-10 08:48:09 +00:00
fs.h Add SILENT flag to recurse() 2015-04-20 11:12:40 +01:00
getconf.1 getconf.1: fix: end list (El) 2015-10-10 01:18:24 +02:00
getconf.c getconf: fail if any other flag than -v is used 2017-01-31 10:27:59 -08:00
getconf.sh getconf.sh: Be more explicit we are using a heredoc here 2016-10-05 18:48:10 +02:00
grep.1 Use ISO-date-format in manpages 2015-10-08 17:15:08 +02:00
grep.c grep: Fix -v output and exit status 2016-05-14 12:58:38 +01:00
head.1 Use ISO-date-format in manpages 2015-10-08 17:15:08 +02:00
head.c Support NUL containing lines in head(1) 2016-03-10 08:48:09 +00:00
hostname.1 Use ISO-date-format in manpages 2015-10-08 17:15:08 +02:00
hostname.c Do not use arg.h for tools which take no flags 2015-04-25 11:43:14 +01:00
join.1 Use ISO-date-format in manpages 2015-10-08 17:15:08 +02:00
join.c Support NUL containing lines in join(1) 2016-03-10 08:48:09 +00:00
kill.1 Use ISO-date-format in manpages 2015-10-08 17:15:08 +02:00
kill.c kill: Include strings.h for strcasecmp() 2015-04-29 16:42:49 +01:00
link.1 Use ISO-date-format in manpages 2015-10-08 17:15:08 +02:00
link.c Do not use arg.h for tools which take no flags 2015-04-25 11:43:14 +01:00
ln.1 Use ISO-date-format in manpages 2015-10-08 17:15:08 +02:00
ln.c ln: Only fail if same inode without -f flag 2016-07-09 10:17:16 +01:00
logger.1 Use ISO-date-format in manpages 2015-10-08 17:15:08 +02:00
logger.c No need for semicolon after ARGEND 2015-11-01 10:18:55 +00:00
logname.1 Use ISO-date-format in manpages 2015-10-08 17:15:08 +02:00
logname.c Add *fshut() functions to properly flush file streams 2015-04-05 09:13:56 +01:00
ls.1 Use ISO-date-format in manpages 2015-10-08 17:15:08 +02:00
ls.c ls: print filenames on the fly rather than in a buffer 2016-12-28 12:23:03 -08:00
md5.h Add crypt.[ch] and update md5sum and sha1sum 2013-07-18 09:51:17 -04:00
md5sum.1 Use ISO-date-format in manpages 2015-10-08 17:15:08 +02:00
md5sum.c No need for semicolon after ARGEND 2015-11-01 10:18:55 +00:00
mkdir.1 Use ISO-date-format in manpages 2015-10-08 17:15:08 +02:00
mkdir.c mkdir: Fix created directory permissions 2017-07-03 21:03:11 +02:00
mkfifo.1 Use ISO-date-format in manpages 2015-10-08 17:15:08 +02:00
mkfifo.c No need for semicolon after ARGEND 2015-11-01 10:18:55 +00:00
mktemp.1 Use ISO-date-format in manpages 2015-10-08 17:15:08 +02:00
mktemp.c No need for semicolon after ARGEND 2015-11-01 10:18:55 +00:00
mv.1 Use ISO-date-format in manpages 2015-10-08 17:15:08 +02:00
mv.c mv: Ensure stat is initialized when we prune a tree 2015-11-13 14:21:07 +00:00
nice.1 Use ISO-date-format in manpages 2015-10-08 17:15:08 +02:00
nice.c Check if PRIO_MIN and PRIO_MAX are defined 2015-12-15 17:05:21 +00:00
nl.1 Use ISO-date-format in manpages 2015-10-08 17:15:08 +02:00
nl.c Support NUL containing lines in nl(1) and reuse the line-buffer(!) 2016-03-10 08:48:09 +00:00
nohup.1 Use ISO-date-format in manpages 2015-10-08 17:15:08 +02:00
nohup.c Do not use arg.h for tools which take no flags 2015-04-25 11:43:14 +01:00
od.1 od: Add some missing type flags 2016-07-09 10:17:16 +01:00
od.c Don't use buffered IO (fread) when not appropriate 2017-07-03 21:04:14 +02:00
paste.1 Use ISO-date-format in manpages 2015-10-08 17:15:08 +02:00
paste.c paste: fix warning on indentation in parallel() 2016-12-27 15:02:15 +01:00
pathchk.1 Fix pathchk manpage regarding exit status 2016-02-11 10:09:38 +00:00
pathchk.c pathchk: fixes and cleanup 2016-10-05 18:48:10 +02:00
printenv.1 printenv: exit status is 2 on failure 2016-04-20 22:57:40 +01:00
printenv.c printenv: exit status is 2 on failure 2016-04-20 22:57:40 +01:00
printf.1 Change the note in printf.1 on octal escapes 2016-02-21 08:52:48 +00:00
printf.c printf: handle \0 in %b arguments 2016-12-27 13:25:38 +01:00
pwd.1 Use ISO-date-format in manpages 2015-10-08 17:15:08 +02:00
pwd.c No need for semicolon after ARGEND 2015-11-01 10:18:55 +00:00
queue.h Use queue.h in grep(1) 2014-11-16 12:39:15 +00:00
readlink.1 readlink: Remove broken support for -m and -e 2015-11-16 16:30:19 +00:00
readlink.c readlink: Remove broken support for -m and -e 2015-11-16 16:30:19 +00:00
renice.1 Use ISO-date-format in manpages 2015-10-08 17:15:08 +02:00
renice.c Cleanup usage() across sbase 2015-12-21 18:07:25 +00:00
rev.1 Add rev(1) 2016-12-27 11:35:27 +01:00
rev.c Add rev(1) 2016-12-27 11:35:27 +01:00
rm.1 Use ISO-date-format in manpages 2015-10-08 17:15:08 +02:00
rm.c No need for semicolon after ARGEND 2015-11-01 10:18:55 +00:00
rmdir.1 Use ISO-date-format in manpages 2015-10-08 17:15:08 +02:00
rmdir.c No need for semicolon after ARGEND 2015-11-01 10:18:55 +00:00
sed.1 Use ISO-date-format in manpages 2015-10-08 17:15:08 +02:00
sed.c Revert "fix length after '\' getline string termination" 2016-03-01 15:24:32 +00:00
seq.1 Use ISO-date-format in manpages 2015-10-08 17:15:08 +02:00
seq.c Cleanup usage() across sbase 2015-12-21 18:07:25 +00:00
setsid.1 Use ISO-date-format in manpages 2015-10-08 17:15:08 +02:00
setsid.c Do not use arg.h for tools which take no flags 2015-04-25 11:43:14 +01:00
sha1.h Add crypt.[ch] and update md5sum and sha1sum 2013-07-18 09:51:17 -04:00
sha1sum.1 Use ISO-date-format in manpages 2015-10-08 17:15:08 +02:00
sha1sum.c No need for semicolon after ARGEND 2015-11-01 10:18:55 +00:00
sha224.h add sha224sum and sha384sum 2016-02-24 10:15:16 +00:00
sha224sum.1 add sha224sum and sha384sum 2016-02-24 10:15:16 +00:00
sha224sum.c add sha224sum and sha384sum 2016-02-24 10:15:16 +00:00
sha256.h Add sha256sum(1) 2013-07-20 13:20:16 -04:00
sha256sum.1 Use ISO-date-format in manpages 2015-10-08 17:15:08 +02:00
sha256sum.c No need for semicolon after ARGEND 2015-11-01 10:18:55 +00:00
sha384.h add sha224sum and sha384sum 2016-02-24 10:15:16 +00:00
sha384sum.1 add sha224sum and sha384sum 2016-02-24 10:15:16 +00:00
sha384sum.c add sha224sum and sha384sum 2016-02-24 10:15:16 +00:00
sha512-224.h add sha512-224sum (SHA512/224) and sha512-256sum (SHA512/256) 2016-02-24 10:40:57 +00:00
sha512-224sum.1 add sha512-224sum (SHA512/224) and sha512-256sum (SHA512/256) 2016-02-24 10:40:57 +00:00
sha512-224sum.c add sha512-224sum (SHA512/224) and sha512-256sum (SHA512/256) 2016-02-24 10:40:57 +00:00
sha512-256.h add sha512-224sum (SHA512/224) and sha512-256sum (SHA512/256) 2016-02-24 10:40:57 +00:00
sha512-256sum.1 add sha512-224sum (SHA512/224) and sha512-256sum (SHA512/256) 2016-02-24 10:40:57 +00:00
sha512-256sum.c add sha512-224sum (SHA512/224) and sha512-256sum (SHA512/256) 2016-02-24 10:40:57 +00:00
sha512.h Add sha512sum(1) 2013-08-04 11:00:34 -04:00
sha512sum.1 Use ISO-date-format in manpages 2015-10-08 17:15:08 +02:00
sha512sum.c No need for semicolon after ARGEND 2015-11-01 10:18:55 +00:00
sleep.1 Use ISO-date-format in manpages 2015-10-08 17:15:08 +02:00
sleep.c Do not use arg.h for tools which take no flags 2015-04-25 11:43:14 +01:00
sort.1 Forgot to bump date for sort(1) manpage 2016-02-17 08:43:15 +00:00
sort.c sort: Fix line comparison when col buffer contains data from longer line 2016-07-09 10:09:50 +01:00
split.1 Use ISO-date-format in manpages 2015-10-08 17:15:08 +02:00
split.c Fix type mismatch in split(1) 2015-11-26 10:35:46 +00:00
sponge.1 Use ISO-date-format in manpages 2015-10-08 17:15:08 +02:00
sponge.c Simplify return & fshut() logic 2015-05-26 16:41:43 +01:00
strings.1 Use ISO-date-format in manpages 2015-10-08 17:15:08 +02:00
strings.c No need for semicolon after ARGEND 2015-11-01 10:18:55 +00:00
sync.1 Use ISO-date-format in manpages 2015-10-08 17:15:08 +02:00
sync.c Do not use arg.h for tools which take no flags 2015-04-25 11:43:14 +01:00
tail.1 Use ISO-date-format in manpages 2015-10-08 17:15:08 +02:00
tail.c Support NUL containing lines in tail(1) 2016-03-10 08:48:09 +00:00
tar.1 tar: support -f - for stdin/out 2016-02-15 10:20:12 +00:00
tar.c mkdir: Fix created directory permissions 2017-07-03 21:03:11 +02:00
tee.1 Use ISO-date-format in manpages 2015-10-08 17:15:08 +02:00
tee.c Don't use buffered IO (fread) when not appropriate 2017-07-03 21:04:14 +02:00
test.1 Update test.1: 2016-04-20 22:57:40 +01:00
test.c test: Use complete prototypes in func field of struct test 2017-03-24 10:39:19 +01:00
text.h Rename struct linebufline to struct line and add linecmp() 2016-03-10 08:48:09 +00:00
tftp.1 Use ISO-date-format in manpages 2015-10-08 17:15:08 +02:00
tftp.c Include sys/time.h for timeval structure 2015-11-13 11:32:11 +00:00
time.1 Use ISO-date-format in manpages 2015-10-08 17:15:08 +02:00
time.c Fix type mismatches 2015-11-26 10:35:46 +00:00
touch.1 Use ISO-date-format in manpages 2015-10-08 17:15:08 +02:00
touch.c touch: Avoid unnecessary call to stat 2016-07-09 10:17:16 +01:00
tr.1 tr.1: Make note of some changes in the utility 2016-10-05 21:42:24 +02:00
tr.c tr: Fix multiple ranges with different lengths (Michael Forney) 2016-11-18 12:45:59 +01:00
true.1 Use ISO-date-format in manpages 2015-10-08 17:15:08 +02:00
true.c Simplify true(1) and false(1) 2014-10-03 00:03:08 +01:00
tsort.1 tsort.1: use mandoc literal block for example 2016-02-26 09:54:46 +00:00
tsort.c tsort style fixes 2016-02-24 15:57:33 +00:00
tty.1 Use ISO-date-format in manpages 2015-10-08 17:15:08 +02:00
tty.c Do not use arg.h for tools which take no flags 2015-04-25 11:43:14 +01:00
uname.1 Use ISO-date-format in manpages 2015-10-08 17:15:08 +02:00
uname.c No need for semicolon after ARGEND 2015-11-01 10:18:55 +00:00
unexpand.1 Use ISO-date-format in manpages 2015-10-08 17:15:08 +02:00
unexpand.c No need for semicolon after ARGEND 2015-11-01 10:18:55 +00:00
uniq.1 Use ISO-date-format in manpages 2015-10-08 17:15:08 +02:00
uniq.c uniq: always store previous line length 2016-03-11 15:38:36 +00:00
unlink.1 Use ISO-date-format in manpages 2015-10-08 17:15:08 +02:00
unlink.c Do not use arg.h for tools which take no flags 2015-04-25 11:43:14 +01:00
utf.h Scrap chartorunearr(), introducing utftorunestr() 2015-02-11 21:32:09 +01:00
util.h libutil: Add writeall utility function 2017-07-03 21:04:12 +02:00
uudecode.1 Use ISO-date-format in manpages 2015-10-08 17:15:08 +02:00
uudecode.c Revert "fix length after '\' getline string termination" 2016-03-01 15:24:32 +00:00
uuencode.1 Use ISO-date-format in manpages 2015-10-08 17:15:08 +02:00
uuencode.c uuencode: style: just use pointer *b 2016-03-01 15:24:32 +00:00
wc.1 Use ISO-date-format in manpages 2015-10-08 17:15:08 +02:00
wc.c Fix wc(1) output for large files 2016-02-24 14:45:20 +00:00
which.1 Use ISO-date-format in manpages 2015-10-08 17:15:08 +02:00
which.c Cleanup usage() across sbase 2015-12-21 18:07:25 +00:00
whoami.1 Add whoami(1) 2015-12-14 10:14:07 +00:00
whoami.c Fix style issue in whoami which broke the sbase-box target 2015-12-14 11:59:48 +00:00
xargs.1 Use ISO-date-format in manpages 2015-10-08 17:15:08 +02:00
xargs.c Cleanup usage() across sbase 2015-12-21 18:07:25 +00:00
xinstall.1 install: ignore -s 2016-12-27 13:56:27 +01:00
xinstall.c xinstall: Check result of fchmod 2016-12-27 14:37:20 +01:00
yes.1 Use ISO-date-format in manpages 2015-10-08 17:15:08 +02:00
yes.c Do not use arg.h for tools which take no flags 2015-04-25 11:43:14 +01:00

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:

'#'  -> UTF-8 support, '=' -> Implicit UTF-8 support, '*' -> Finished,
'|'  -> Audited,       'o' -> POSIX 2013 compliant,   'x' -> Non-POSIX,
'0'  -> NUL handling,  '()' -> Petty flag

      UTILITY         MISSING
      -------         -------
0=*|o basename        .
0=*|o cal             .
0=*|o cat             .
0=*|o chgrp           .
0=*|o chmod           .
0=*|o chown           .
0=*|x chroot          .
0=*|o cksum           .
0=*|o cmp             .
0#*|x cols            .
0=*|o comm            .
0=*|o cp              (-i)
0=*|x cron            .
0#*|o cut             .
0=*|o date            .
0=*|o dirname         .
0=*|o du              .
0=*|o echo            .
    o ed              .
0=*|o env             .
0#*|o expand          .
0#*|o expr            .
0=*|o false           .
0=    find            .
0=* x flock           .
0#*|o fold            .
0=*|o getconf         (-v)
 =*|o grep            .
0=*|o head            .
0=*|x hostname        .
0=*|x install         .
0=* o join            .
0=*|o kill            .
0=*|o link            .
0=*|o ln              .
0=*|o logger          .
0=*|o logname         .
0#* o ls              (-C, -k, -m, -p, -s, -x)
0=*|x md5sum          .
0=*|o mkdir           .
0=*|o mkfifo          .
0=*|x mktemp          .
0=*|o mv              (-i)
0=*|o nice            .
0#*|o nl              .
0=*|o nohup           .
0=*|o od              .
0#* o pathchk         .
 #*|o paste           .
0=*|x printenv        .
0#*|o printf          .
0=*|o pwd             .
0=*|x readlink        .
0=*|o renice          .
0#* x rev             .
0=*|o rm              (-i)
0=*|o rmdir           .
 #    sed             .
0=*|x seq             .
0=*|x setsid          .
0=*|x sha1sum         .
0=* x sha224sum       .
0=*|x sha256sum       .
0=* x sha238sum       .
0=*|x sha512sum       .
0=* x sha512-224sum   .
0=* x sha512-256sum   .
0=*|o sleep           .
0#*|o sort            .
0=*|o split           .
0=*|x sponge          .
0#*|o strings         .
0=*|x sync            .
0=*|o tail            .
0=*|x tar             .
0=*|o tee             .
0=*|o test            .
0=*|x tftp            .
0=*|o time            .
0=*|o touch           .
0#*|o tr              .
0=*|o true            .
0=* o tsort           .
0=*|o tty             .
0=*|o uname           .
0#*|o unexpand        .
0=*|o uniq            .
0=*|o unlink          .
0=*|o uudecode        .
0=*|o uuencode        .
0#*|o wc              .
0=*|x which           .
0=*|x whoami          .
0=*|o xargs           (-p)
0=*|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/