1<html><head><title>toybox roadmap</title>
2<!--#include file="header.html" -->
3<title>Toybox Roadmap</title>
4
5<h2>Goals and use cases</h2>
6
7<p>We have several potential use cases for a new set of command line
8utilities, and are using those to determine which commands to implement
9for Toybox's 1.0 release.</p>
10
11<p>The most interesting standards are POSIX-2008 (also known as the Single
12Unix Specification version 4) and the Linux Standard Base (version 4.1).
13The main test harness including toybox in Aboriginal Linux and if that can
14build itself using the result to build Linux From Scratch (version 6.8).
15We also aim to replace Android's Toolbox.</p>
16
17<p>At a secondary level we'd like to meet other use cases. We've analyzed
18the commands provided by similar projects (klibc, sash, sbase, s6, embutils,
19nash, and beastiebox), along with various vendor configurations of busybox,
20and some end user requests.</p>
21
22<p>Finally, we'd like to provide a good replacement for the Bash shell,
23which was the first program Linux ever ran and remains the standard shell
24of Linux no matter what Ubuntu says. This doesn't mean including the full
25set of Bash 4.x functionality, but does involve {various,features} beyond
26posix.</p>
27
28<p>See the <a href=status.html>status page</a> for the combined list
29and progress towards implementing it.</p>
30
31<ul>
32<li><a href=#susv4>POSIX-2008/SUSv4</a></li>
33<li><a href=#sigh>Linux "Standard" Base</a></li>
34<li><a href=#dev_env>Development Environment</a></li>
35<li><a href=#android>Android Toolbox</a></li>
36<li><a href=#tizen>Tizen Core</a></li>
37<li>Miscelaneous: <a href=#klibc>klibc</a>, <a href=#glibc>glibc</a>,
38<a href=#sash>sash</a>, <a href=#sbase>sbase</a>, <a href=#s6>s6</a>,
39<a href=#uclinux>uclinux</a>...</li>
40</ul>
41
42<hr />
43<a name="standards">
44<h2>Use case: standards compliance.</h2>
45
46<h3><a name=susv4 /><a href="#susv4">POSIX-2008/SUSv4</a></h3>
47<p>The best standards are the kind that describe reality, rather than
48attempting to impose a new one.  (I.E. a good standard should document, not
49legislate.)</p>
50
51<p>The kind of standards which describe existing reality tend to be approved by
52more than one standards body, such ANSI and ISO both approving C.  That's why
53the IEEE POSIX committee's 2008 standard, the Single Unix Specification version
544, and the Open Group Base Specification edition 7 are all the same standard
55from three sources.</p>
56
57<p>The <a href="http://pubs.opengroup.org/onlinepubs/9699919799/idx/utilities.html">"utilities"
58section</a>
59of these standards is devoted to the unix command line, and are the best such
60standard for our purposes.  (My earlier work on BusyBox was implemented with
61regard to SUSv3, an earlier version of this standard.)</p>
62
63<h3>Problems with the standard</h3>
64
65<p>Unfortunately, these standards describe a subset of reality, lacking any
66mention of commands such as init, login, or mount required to actually boot a
67system. It provides ipcrm and ipcs, but not ipcmk, so you can use System V IPC
68resources but not create them.</p>
69
70<p>These standards also contain a large number of commands that are
71inappropriate for toybox to implement in its 1.0 release.  (Perhaps some of
72these could be reintroduced in later releases, but not now.)</p>
73
74<p>Starting with the full "utilities" list, we first remove generally obsolete
75commands (compess ed ex pr uncompress uccp uustat uux), commands for the
76pre-CVS "SCCS" source control system (admin delta get prs rmdel sact sccs unget
77val what), fortran support (asa fort77), and batch processing support (batch
78qalter qdel qhold qmove qmsg qrerun qrls qselect qsig qstat qsub).</p>
79
80<p>Some commands are for a compiler toolchain (ar c99 cflow ctags cxref gencat
81iconv lex m4 make nm strings strip tsort yacc), which is outside of toybox's
82mandate and should be supplied externally.  (Again, some of these may be
83revisited later, but not for toybox 1.0.)</p>
84
85<p>Some commands are part of a command shell, and cannot be implemented as
86separate executables (alias bg cd command fc fg getopts hash jobs kill read
87type ulimit umask unalias wait).  These may be revisited as part of a built-in
88toybox shell, but are not exported into $PATH via symlinks.  (If you fork a
89child process and have it "cd" then exit, you've accomplished nothing.
90This is not a complete list, a shell also needs exit, if, while, for, case,
91export, set, unset, trap, exec... And for bash compatability, function and
92source.)</p>
93
94<blockquote><b>
95<span id=shell>
96alias bg cd command fc fg getopts hash jobs kill read type ulimit umask
97unalias wait exit if while for case export set unset trap exec function source
98</span>
99<b></blockquote>
100
101<p>A few other commands are judgement calls, providing command-line
102internationalization support (iconv locale localedef), System V inter-process
103communication (ipcrm ipcs), and cross-tty communication from the minicomputer
104days (talk mesg write).  The "pax" utility was supplanted by tar, "mailx" is
105a command line email client, and "lp" submits files for printing to... what
106exactly?  (cups?)  The standard defines crontab but not crond.</p>
107
108<p>Removing all of that leaves the following commands, which toybox should
109implement:</p>
110
111<blockquote><b>
112<span id=posix>
113at awk basename bc cal cat chgrp chmod chown cksum cmp comm cp
114csplit cut date dd df diff dirname du echo env expand expr false file find
115fold fuser getconf grep head id join kill link ln logger logname ls man
116mkdir mkfifo more mv newgrp nice nl nohup od paste patch pathchk printf ps
117pwd renice rm rmdir sed sh sleep sort split stty tabs tail tee test time
118touch tput tr true tty uname unexpand uniq unlink uudecode uuencode vi wc
119who xargs zcat
120</span>
121</b></blockquote>
122
123<h3><a name=sigh /><a href="#sigh">Linux Standard Base</a></h3>
124
125<p>One attempt to supplement POSIX towards an actual usable system was the
126Linux Standard Base. Unfortunately, the quality of this "standard" is
127fairly low.</p>
128
129<p>POSIX allowed its standards process to be compromised
130by leaving things out, thus allowing IBM mainframes and Windows NT to drive
131a truck through the holes and declare themselves compilant. But it means what
132they DID standardize tends to be respected (if sometimes obsolete).</p>
133
134<p>The Linux Standard Base's failure mode is different, they respond to
135pressure by including special-case crap, such as allowing Red Hat to shoehorn
136RPM into the standard even though all sorts of distros (Debian, Slackware, Arch,
137Gentoo) don't use it and probably never will. This means anything in the LSB is
138at best a suggestion: arbitrary portions of this standard are widely
139ignored.</p>
140
141<p>The community perception seems to be that the Linux Standard Base is
142the best standard money can buy, I.E. the Linux Foundation is supported by
143financial donations form large companies and the LSB represents the interests
144of those donors more than technical merit. Debian officially
145<a href=http://lwn.net/Articles/658809>washed its hands of LSB</a> when 5.0
146came out in 2015, and no longer even pretends to support it (which may affect
147Debian derivatives like Ubuntu and Knoppix). Toybox hasn't moved to 5.0 for
148similar reasons.</p>
149
150<p>That said, Posix by itself isn't enough, and this is the next most
151comprehensive standards effort for Linux so far.</p>
152
153<p>The LSB specifies a <a href=http://refspecs.linuxfoundation.org/LSB_4.1.0/LSB-Core-generic/LSB-Core-generic/cmdbehav.html>list of command line
154utilities</a>:</p>
155
156<blockquote><b>
157ar at awk batch bc chfn chsh col cpio crontab df dmesg du echo egrep
158fgrep file fuser gettext grep groupadd groupdel groupmod groups
159gunzip gzip hostname install install_initd ipcrm ipcs killall lpr ls
160lsb_release m4 md5sum mknod mktemp more mount msgfmt newgrp od passwd
161patch pidof remove_initd renice sed sendmail seq sh shutdown su sync
162tar umount useradd userdel usermod xargs zcat
163</b></blockquote>
164
165<p>Where posix specifies one of those commands, LSB's deltas tend to be
166accomodations for broken tool versions which aren't up to date with the
167standard yet. (See <a href=http://refspecs.linuxfoundation.org/LSB_4.1.0/LSB-Core-generic/LSB-Core-generic/more.html>more</a> and <a href=http://refspecs.linuxfoundation.org/LSB_4.1.0/LSB-Core-generic/LSB-Core-generic/xargs.html>xargs</a>
168for examples.)</p>
169
170<p>Since we've already committed to using our own judgement to skip bits of
171POSIX, and LSB's "judgement" in this regard is purely bug workarounds to declare
172various legacy tool implementations "compliant", this means we're mostly
173interested in the set of tools that aren't specified in posix at all.</p>
174
175<p>Of these, gettext and msgfmt are internationalization, install_initd and
176remove_initd aren't present on ubuntu 10.04, lpr is out of scope, and
177lsb_release is a distro issue (it's a nice command, but the output of
178lsb_release -a is the name and version number of the linux distro you're
179running, which toybox doesn't know).</p>
180
181<p>This leaves:</p>
182
183<blockquote><b>
184<span id=lsb>
185chfn chsh dmesg egrep fgrep groupadd groupdel groupmod groups
186gunzip gzip hostname install killall md5sum
187mknod mktemp mount passwd pidof sendmail seq shutdown
188su sync tar umount useradd userdel usermod zcat
189</span>
190</b></blockquote>
191
192<hr />
193<a name="dev_env">
194<h2><a href="#dev_env">Use case: provide a self-hosting development environment</a></h2>
195
196<p>The following commands are enough to build the Aboriginal Linux development
197environment, boot it to a shell prompt, and build Linux From Scratch 6.8 under
198it. (Aboriginal Linux currently uses BusyBox for this, thus provides a
199drop-in test environment for toybox. We install both implementations side
200by side, redirecting the symlinks a command at a time until the older
201package is no longer used, and can be removed.)</p>
202
203<p>This use case includes running init scripts and other shell scripts, running
204configure, make, and install in each package, and providing basic command line
205facilities such as a text editor. (It does not include a compiler toolchain or
206C library, those are outside the scope of this project.)</p>
207
208<blockquote><b>
209<span id=development>
210bzcat cat cp dirname echo env patch rmdir sha1sum sleep sort sync
211true uname wc which yes zcat
212awk basename chmod chown cmp cut date dd diff
213egrep expr fdisk find grep gzip head hostname id install ln ls
214mkdir mktemp mv od readlink rm sed sh tail tar touch tr uniq
215wget whoami xargs chgrp comm gunzip less logname split
216tee test time bunzip2 chgrp chroot comm cpio dmesg
217dnsdomainname ftpd ftpget ftpput gunzip ifconfig init less
218logname losetup mdev mount mountpoint nc pgrep pkill
219pwd route split stat switch_root tac umount vi
220resize2fs tune2fs fsck.ext2 genext2fs mke2fs xzcat
221</span>
222</b></blockquote>
223
224<p>Note: Aboriginal Linux installs bash 2.05b as #!/bin/sh and its scripts
225require bash extensions not present in shells such as busybox ash.
226This means that toysh needs to supply several bash extensions _and_ work
227when called under the name "bash".</p>
228
229<p>The <a href=http://landley.net/aboriginal>Aboriginal Linux</a>
230self-bootstrapping build still uses the following busybox commands,
231not yet supplied by toybox:</p>
232
233<blockquote><p>
234awk bunzip2 bzcat dd diff expr fdisk ftpd ftpget
235ftpput gunzip gzip less ping route sh
236sha512sum tar test tr unxz vi wget xzcat zcat
237</p></blockquote>
238
239<p>Many of those are in "pending". The remaining "difficult"
240commands are vi, awk, and sh.</p>
241
242<p>Building Linux From Scratch is not the same as building the
243<a href=https://source.android.com>Android Open Source Project</a>,
244but after toybox 1.0 focus may shift to <a href=http://landley.net/aboriginal/about.html#hairball>modifying the AOSP build</a>
245to reduce dependencies. (It's fairly likely we'll have to add at least
246a read-only git utility so repo can download the build's source code,
247but that's actually <a href=https://www.youtube.com/watch?v=P7n6G2IL6eo>not
248that hard</a>. We'll probably also need our own "make" at some point after
2491.0.)</p>
250
251<hr />
252<h2><a name=android /><a href="#android">Use case: Replacing Android Toolbox</a></h2>
253
254<p>Android has a policy against GPL in userspace, so even though BusyBox
255predates Android by many years, they couldn't use it. Instead they grabbed
256an old version of ash and implemented their own command line utility set
257called "toolbox". ash was later replaced by
258<a href="https://www.mirbsd.org/mksh.htm">mksh</a>; toolbox is being
259replaced by toybox.</p>
260
261<p>Toolbox doesn't have its own repository, instead it's part of Android's
262<a href=https://android.googlesource.com/platform/system/core>system/core
263git repository</a>.</p>
264
265<h3>Toolbox commands:</h3>
266
267<p>According to <a href=https://android.googlesource.com/platform/system/core/+/master/toolbox/Android.mk>
268system/core/toolbox/Android.mk</a> the toolbox directory builds the
269following commands:</p>
270
271<blockquote><b>
272dd getevent iftop ioctl log
273nandread newfs_msdos ps prlimit
274sendevent start stop top
275</b></blockquote>
276
277<h3>Other Android core commands</h3>
278
279<p>Other than the toolbox directory, the currently interesting
280subdirectories in the core repository are init,
281logcat, logwrapper, reboot, and run-as.</p>
282
283<ul>
284<li><b>init</b> - Android's PID 1</li>
285<li><b>logcat</b> - read android log format</li>
286<li><b>logwrapper</b> - redirect stdio to android log</li>
287<li><b>reboot</b> - Android's reboot(1)</li>
288<li><b>run-as</b> - subset of sudo</li>
289</ul>
290
291<p>Almost all of these reinvent an existing wheel with less functionality and a
292different user interface. We may want to provide that interface, but
293implementing the full commands (fdisk, init, and sudo) come first.</p>
294
295<h3>Analysis</h3>
296
297<p>For reference, combining everything listed above, we get:</p>
298
299<blockquote><b>
300dd getevent iftop init ioctl
301log logcat logwrapper nandread
302newfs_msdos ps prlimit reboot run-as
303sendevent start stop top
304</b></blockquote>
305
306<p>We may eventually implement all of that, but for toybox 1.0 we need to
307focus a bit. For our first pass, let's grab just logcat and logwrapper
308from the "core" commands (since the rest have some full/standard version
309providing that functionality, which we can implement a shim interface
310for later).</p>
311
312<p>This means toybox should implement (or finish implementing):</p>
313<blockquote><b>
314<span id=toolbox>
315dd getevent iftop ioctl log logcat logwrapper
316nandread newfs_msdos ps prlimit sendevent
317start stop top
318</span>
319</b></blockquote>
320
321<p>Update: Android.mk is currently building the following toybox files out
322of "pending". These should be a priority for cleanup:</p>
323
324<blockquote><b>
325dd expr lsof more netstat route tar tr traceroute
326</b></blockquote>
327
328<hr />
329<h2><a name=tizen /><a href="#tizen">Use case: Tizen Core</a></h2>
330
331<p>The Tizen project has expressed a desire to eliminate GPLv3 software
332from its core system, and is installing toybox as
333<a href=https://wiki.tizen.org/wiki/Toybox>part of this process</a>.</p>
334
335<p>They have a fairly long list of new commands they'd like to see in toybox:</p>
336
337<blockquote><b>
338<span id=tizen>
339arch base64 users dir vdir unexpand shred join csplit
340hostid nproc runcon sha224sum sha256sum sha384sum sha512sum sha3sum mkfs.vfat fsck.vfat
341dosfslabel uname stdbuf pinky diff3 sdiff zcmp zdiff zegrep zfgrep zless zmore
342</span>
343</b></blockquote>
344
345<p>In addition, they'd like to use several commands currently in pending:</p>
346
347<blockquote><b>
348<span id=tizen>
349tar diff printf wget rsync fdisk vi less tr test stty fold expr dd
350</span>
351</b></blockquote>
352
353<p>Also, tizen uses a different Linux Security Module called SMACK, so
354many of the SELinux options ala ls -Z need smack alternatives in an
355if/else setup.</p>
356
357<hr /><a name=klibc />
358<h2>klibc:</h2>
359
360<p>Long ago some kernel developers came up with a project called
361<a href=http://en.wikipedia.org/wiki/Klibc>klibc</a>.
362After a decade of development it still has no web page or HOWTO,
363and nobody's quite sure if the license is BSD or GPL. It inexplicably
364<a href=http://www.infoworld.com/d/data-center/perl-isnt-going-anywhere-better-or-worse-211580>requires perl to build</a>, and seems like an ideal candidate for
365replacement.</p>
366
367<p>In addition to a C library even less capable than bionic (obsoleted by
368musl), klibc builds a random assortment of executables to run init scripts
369with. There's no multiplexer command, these are individual executables:</p>
370
371<blockquote><p><b>
372cat chroot cpio dd dmesg false fixdep fstype gunzip gzip halt ipconfig kill
373kinit ln losetup ls minips mkdir mkfifo mknodes
374mksyntax mount mv nfsmount nuke pivot_root poweroff readlink reboot resume
375run-init sh sha1hash sleep sync true umount uname zcat
376</b></p></blockquote>
377
378<p>To get that list, build klibc according to the instructions (I
379<a href=http://landley.net/notes-2013.html#23-01-2013>looked at</a> version
3802.0.2 and did cd klibc-*; ln -s /output/of/kernel/make/headers_install
381linux; make) then <b>echo $(for i in $(find . -type f); do file $i | grep -q
382executable && basename $i; done | grep -v '[.]g$' | sort -u)</b> to find
383executables, then eliminate the *.so files and *.shared duplicates.</p>
384
385<p>Some of those binaries are build-time tools that don't get installed,
386which removes mknodes, mksyntax, sha1hash, and fixdep from the list.
387(And sha1hash is just an unpolished sha1sum anyway.)</p>
388
389<p>The run-init command is more commonly called switch_root, nuke is just
390"rm -rf -- $@", and minips is more commonly called "ps". I'm not doing aliases
391for the oddball names.</p>
392
393<p>Yet more stale forks of dash and gzip sucked in here (see "dubious
394license terms" above), adding nothing to the other projects we've looked at.
395But we still need sh, gunzip, gzip, and zcat to replace this package.</p>
396
397<p>At the time I did the initial analysis toybox already had cat, chroot, dmesg, false,
398kill, ln, losetup, ls, mkdir, mkfifo, readlink, rm, switch_root, sleep, sync,
399true, and uname.</p>
400
401<p>The low hanging fruit is cpio, dd, ps, mv, and pivot_root.</p>
402
403<p>The "kinit" command is another gratuitous rename, it's init running as PID 1.
404The halt, poweroff, and reboot commands work with it.</p>
405
406<p>I've got mount and umount queued up already, fstype and nfsmount go with
407those. (And probably smbmount and p9mount, but this hasn't got one. Those
408are all about querying for login credentials, probably workable into the
409base mount command.)</p>
410
411<p>The ipconfig command here has a built in dhcp client, so it's ifconfig
412and dhcpcd and maybe some other stuff.</p>
413
414<p>The resume command is... weird. It finds a swap partition and reads data
415from it into a /proc file, something the kernel is capable of doing itself.
416(Even though the klibc author
417<a href=http://www.zytor.com/pipermail/klibc/2006-June/001748.html>attempted
418to remove</a> that capability from the kernel, current kernel/power/hibernate.c
419still parses "resume=" on the command line). And yet various distros seem to
420make use of klibc for this.
421Given the history of swsusp/hibernate (and
422<a href=http://lwn.net/Articles/333007>TuxOnIce</a>
423and <a href=http://lwn.net/Articles/242107>kexec jump</a>) I've lost track
424of the current state of the art here. Ah, Documentation/power/userland-swsusp.txt
425has the API docs, and <a href=http://suspend.sf.net>here's a better
426tool</a>...</p>
427
428<p>So the list of things actually in klibc are:</p>
429
430<blockquote><b>
431<span id=klibc_cmd>
432cat chroot dmesg false kill ln losetup ls mkdir mkfifo readlink rm switch_root
433sleep sync true uname
434
435cpio dd ps mv pivot_root
436mount nfsmount fstype umount
437sh gunzip gzip zcat
438kinit halt poweroff reboot
439ipconfig
440resume
441</span>
442</b></blockquote>
443
444<hr />
445<a name=glibc />
446<h2>glibc</h2>
447
448<p>Rather a lot of command line utilities come bundled with glibc:</p>
449
450<blockquote><b>
451catchsegv getconf getent iconv iconvconfig ldconfig ldd locale localedef
452mtrace nscd rpcent rpcinfo tzselect zdump zic
453</b></blockquote>
454
455<p>Of those, musl libc only implements ldd.</p>
456
457<p>catchsegv is a rudimentary debugger, probably out of scope for toybox.</p>
458
459<p>iconv has been <a href="#susv4">previously discussed</a>.</p>
460
461<p>iconvconfig is only relevant if iconv is user-configurable; musl uses a
462non-configurable iconv.</p>
463
464<p>getconf is a posix utility which displays several variables from
465unistd.h; it probably belongs in the development toolchain.</p>
466
467<p>getent handles retrieving entries from passwd-style databases
468(in a rather lame way) and is trivially replacable by grep.</p>
469
470<p>locale was discussed under <a href=#susv4>posix</a>.
471localedef compiles locale definitions, which musl currently does not use.</p>
472
473<p>mtrace is a perl script to use the malloc debugging that glibc has built-in;
474this is not relevant for musl, and would necessarily vary with libc. </p>
475
476<p>nscd is a name service caching daemon, which is not yet relevant for musl.
477rpcinfo and rpcent are related to rpc, which musl does not include.</p>
478
479<p>The remaining commands involve glibc's bundled timezone database,
480which seems to be derived from the <a href=http://www.iana.org/time-zones>IANA
481timezone database</a>. Unless we want to maintain our own fork of the
482standards body's database like glibc does, these are of no interest,
483but for completeness:</p>
484
485<p>tzselect outputs a TZ variable correponding to user input.
486The documentation does not indicate how to use it in a script, but it seems
487that Debian may have done so.
488zdump prints current time in each of several timezones, optionally
489outputting a great deal of extra information about each timezone.
490zic converts a description of a timezone to a file in tz format.</p>
491
492<p>None of glibc's bundled commands are currently of interest to toybox.</p>
493
494</b></blockquote>
495
496<hr />
497<a name=sash />
498<h2>Stand-Alone Shell</h2>
499
500<p>Wikipedia has <a href=http://en.wikipedia.org/wiki/Stand-alone_shell>a good
501summary of sash</a>, with links. The original Stand-Alone Shell project reached
502a stopping point, and then <a href=http://www.baiti.net/sash>"sash plus
503patches"</a> extended it a bit further. The result is a megabyte executable
504that provides 40 commands.</p>
505
506<p>Sash is a shell with built-in commands. It doesn't have a multiplexer
507command, meaning "sash ls -l" doesn't work (you have to go "sash -c 'ls -l'").
508</p>
509
510<p>The list of commands can be obtained via building it and doing
511"echo help | ./sash | awk '{print $1}' | sed 's/^-//' | xargs echo", which
512gives us:</p>
513
514<blockquote><b>
515alias aliasall ar cd chattr chgrp chmod chown cmp cp chroot dd echo ed exec
516exit file find grep gunzip gzip help kill losetup losetup ln ls lsattr mkdir
517mknod more mount mv pivot_root printenv prompt pwd quit rm rmdir setenv source
518sum sync tar touch umask umount unalias where
519</b></blockquote>
520
521<p>Plus sh because it's a shell. A dozen or so commands can only sanely be
522implemented as shell builtins (alias aliasall cd exec exit prompt quit setenv
523source umask unalias), where is an alias for which, and at triage time toybox
524already has chgrp, chmod, chown, cmp, cp, chroot, echo, help, kill, losetup,
525ln, ls, mkdir, mknod, printenv, pwd, rm, rmdir, sync, and touch.</p>
526
527<p>This leaves:</p>
528
529<blockquote><b>
530<span id=sash_cmd>
531ar chattr dd ed file find grep gunzip gzip lsattr more mount mv pivot_root
532sh sum tar umount
533</span>
534</b></blockquote>
535
536<p>(For once, this project doesn't include a fork of gzip, instead
537it sucks in -lz from the host.)</p>
538
539<hr />
540<a name=sbase />
541<h2>sbase:</h2>
542
543<p>It's <a href=http://git.suckless.org/sbase>on suckless</a> in
544<a href=http://git.suckless.org/ubase>two parts</a>. As of November 2015 it's
545implemented the following (renaming "cron" to "crond" for
546consistency, and yanking "sponge", "mesg", "pagesize", "respawn", and
547"vtallow"):</p>
548
549<blockquote><p>
550<span id=sbase_cmd>
551basename cal cat chgrp chmod chown chroot cksum cmp cols comm cp crond cut date
552dirname du echo env expand expr false find flock fold getconf grep head
553hostname join kill link ln logger logname ls md5sum mkdir mkfifo mktemp mv
554nice nl nohup od paste printenv printf pwd readlink renice rm rmdir sed seq
555setsid sha1sum sha256sum sha512sum sleep sort split strings sync tail
556tar tee test tftp time touch tr true tty uname unexpand uniq unlink uudecode
557uuencode wc which xargs yes
558</span>
559</p></blockquote>
560
561<p>and<p>
562
563<blockquote><p>
564<span id=sbase_cmd>
565chvt clear dd df dmesg eject fallocate free id login mknod mountpoint
566passwd pidof ps stat su truncate unshare uptime watch
567who
568</span>
569</p></blockquote>
570
571<hr />
572<a name=s6 />
573<h2>s6</h2>
574
575<p>The website <a href=http://skarnet.org/software/>skarnet</a> has a bunch
576of small utilities as part of something called "s6". This includes the
577<a href=http://skarnet.org/software/s6-portable-utils>s6-portabile-utils</a>
578and the <a href=http://skarnet.org/software/s6-linux-utils>s6-linux-utils</a>.
579</p>
580
581<p>Both packages rely on multiple bespoke external libraries without which
582they can't compile. The source is completely uncommented and doesn't wrap at
58380 characters. Doing a find for *.c files brings up the following commands:</p>
584
585<blockquote><b>
586<span id=s6>
587basename cat chmod chown chroot clock cut devd dirname echo env expr false
588format-filter freeramdisk grep halt head hiercopy hostname linkname ln
589logwatch ls maximumtime memoryhog mkdir mkfifo mount nice nuke pause
590pivotchroot poweroff printenv quote quote-filter reboot rename rmrf sleep
591sort swapoff swapon sync tail test touch true umount uniquename unquote
592unquote-filter update-symlinks
593</span>
594</b></blockquote>
595
596<p>Triage: memoryhog isn't even listed on the website nor does it have
597a documentation file, clock seems like a subset
598of date, devd is some sort of netlink wrapper that spawns its command line
599every time it gets a message (maybe this is meant to implement part of
600udev/mdev?), format-filter is sort of awk's '{print $2}' function split out
601into its own command, hiercopy a subset of "cp -r", maximumtime is something
602I implemented as a shell script (more/timeout.sh in Aboriginal Linux),
603nuke isn't the same as klibc (this one's "kill SIG -1" only with hardwared
604SIG options), pause is a program that literally waits to be killed (I
605generally sleep 999999999 which is a little over 30 years),
606pivotchroot is a subset of switch_root, rmrf is rm -rf...</p>
607
608<p>I see "nuke" resurface, and if "rmrf" wasn't also here I might think
609klibc had a point.</b>
610
611<blockquote>
612basename cat chmod chown chroot cut dirname echo env expr false
613freeramdisk grep halt head hostname linkname ln
614logwatch ls mkdir mkfifo mount nice
615pivotchroot poweroff printenv quote quote-filter reboot rename sleep
616sort swapoff swapon sync tail test touch true umount uniquename unquote
617unquote-filter update-symlinks
618</blockquote>
619
620
621<hr />
622<a name=nash />
623<h2>nash:</h2>
624
625<p>Red Hat's nash was part of its "mkinitrd" package, replacement for a shell
626and utilities on the boot floppy back in the 1990's (the same general idea
627as BusyBox, developed independently). Red Hat discontinued nash development
628in 2010, replacing it with dracut (which collects together existing packages,
629including busybox).</p>
630
631<p>I couldn't figure out how to beat source code out of
632<a href=http://pkgs.fedoraproject.org/git/mkinitrd>Fedora's current git</a>
633repository. The last release version that used it was Fedora Core 12
634which has <a href=http://archive.fedoraproject.org/pub/archive/fedora/linux/releases/12/Fedora/source/SRPMS/mkinitrd-6.0.93-1.fc12.src.rpm>a source rpm</a>
635that can be unwound with "rpm2cpio mkinitrd.src.rpm | cpio -i -d -H newc
636--no-absolute-filenames" and in there is a mkinitrd-6.0.93.tar.bz2 which
637has the source.</p>
638
639<p>In addition to being a bit like a command shell, the nash man page lists the
640following commands:</p>
641
642<blockquote><p>
643access echo find losetup mkdevices mkdir mknod mkdmnod mkrootdev mount
644pivot_root readlink raidautorun setquiet showlabels sleep switchroot umount
645</p></blockquote>
646
647<p>Oddly, the only occurrence of the string pivot_root in the nash source code
648is in the man page, the command isn't there. (It seems to have been removed
649when the underscoreless switchroot went in.)</p>
650
651<p>A more complete list seems to be the handlers[] array in nash.c:</p>
652
653<blockquote><p>
654access buildEnv cat cond cp daemonize dm echo exec exit find kernelopt
655loadDrivers loadpolicy mkchardevs mkblktab mkblkdevs mkdir mkdmnod mknod
656mkrootdev mount netname network null plymouth hotplug killplug losetup
657ln ls raidautorun readlink resume resolveDevice rmparts setDeviceEnv
658setquiet setuproot showelfinterp showlabels sleep stabilized status switchroot
659umount waitdev
660</p></blockquote>
661
662<p>This list is nuts: "plymouth" is an alias for "null" which is basically
663"true" (which thie above list doesn't have). Things like buildEnv and
664loadDrivers are bespoke Red Hat behavior that might as well be hardwired in
665to nash's main() without being called.</p>
666
667<p>Instead of eliminating items
668from the list with an explanation for each, I'm just going to cherry pick
669a few: the device mapper (dm, raidautorun) is probably interesting,
670hotplug (may be obsolete due to kernel changes that now load firmware
671directly), and another "resume" ala klibc.</p>
672
673<p>But mostly: I don't care about this one. And neither does Red Hat anymore.</p>
674
675<p>Verdict: ignore</p>
676
677<hr />
678<a name=beastiebox />
679<h2>Beastiebox</h2>
680
681<p>Back in 2008, the BSD guys vented some busybox-envy
682<a href=http://beastiebox.sourceforge.net>on sourceforge</a>. Then stopped.
683Their repository is still in CVS, hasn't been touched in years, it's a giant
684hairball of existing code sucked together. (The web page says the author
685is aware of crunchgen, but decided to do this by hand anyway. This is not
686a collection of new code, it's a katamari of existing code rolled up in a
687ball.)</p>
688
689<p>Combining the set of commands listed on the web page with the set of
690man pages in the source gives us:</P>
691
692<blockquote><p>
693[ cat chmod cp csh date df disklabel dmesg echo ex fdisk fsck fsck_ffs getty
694halt hostname ifconfig init kill less lesskey ln login ls lv mksh more mount
695mount_ffs mv pfctl ping poweroff ps reboot rm route sed sh stty sysctl tar test
696traceroute umount vi wiconfig
697</p></blockquote>
698
699<p>Apparently lv is the missing link between ed and vi, copyright 1982-1997 (do
700not want), ex is another obsolete vi mode, lesskey is "used to
701specify a set of key bindings to be used with less", and csh is a shell they
702sucked in (even though they have mksh?), [ is an alias for test. Several more bsd-isms that don't have Linux
703equivalents (even in the ubuntu "install this package" search) are
704disklabel, fsck_ffs, mount_ffs, and pfctl. And wiconfig is a
705wavelan interface network card driver utility. Subtracting all that and the
706commands toybox already implements at triage time, we get:</p>
707
708<blockquote><p>
709<span id=beastiebox_cmd>
710fdisk fsck getty halt ifconfig init kill less more mount mv ping poweroff
711ps reboot route sed sh stty sysctl tar test traceroute umount vi
712</span>
713</p></blockquote>
714
715<p>Not a hugely interesting list, but eh.</p>
716
717<p>Verdict: ignore</p>
718
719<hr />
720<a name=BsdBox />
721<h2>BsdBox</h2>
722
723<p>Somebody decided to do a <a href=https://wiki.freebsd.org/AdrianChadd/BsdBox>multicall binary for freebsd</a>.</p>
724
725<p>They based it on crunchgen, a tool that glues existing programs together
726into an archive and uses the name to execute the right one. It has no
727simplification or code sharing benefits whatsoever, it's basically an
728archiver that produces executables.</p>
729
730<p>That's about where I stopped reading.</p>
731
732<p>Verdict: ignore.</p>
733
734<hr />
735<a name=slowaris />
736<h2>OpenSolaris Busybox</h2>
737
738<p>Somebody <a href=http://hub.opensolaris.org/bin/view/Project+busybox/>wrote
739a wiki page</a> saying that Busybox for OpenSolaris would be a good idea.</p>
740
741<p>The corresponding "files" tab is an auto-generated stub. The project never
742even got as far as suggesting commands to include before Oracle discontinued
743OpenSolaris.</p>
744
745<p>Verdict: ignore.</p>
746
747<hr />
748<a name=uclinux />
749<h2>uClinux</h2>
750
751<p>Long ago a hardware developer named Jeff Dionne put together a
752nommu Linux distribution, which involved rewriting a lot of command line
753utilities that relied on <a href=http://nommu.org/memory-faq.txt>features
754unavailable on nommu</a> hardware.</p>
755
756<p>In 2003 Jeff moved to Japan and handed
757the project off to people who allowed it to roll to a stop. The website
758turned into a mess of 404 links, the navigation indexes stopped being
759updated over a decade ago, and the project's CVS repository suffered a
760hard drive failure for which there were no backups. The project continued
761to put out "releases" through 2014 (you have to scroll down in the "news"
762section to find them, the "HTTP download" section in the nav bar on the
763left hasn't been updated in over a decade), which were hand-updated tarball
764snapshots mostly consisting of software from the 1990's. For example the
7652014 release still contained ipfwadm, the package which predated ipchains,
766which predated iptables, which is in the process of being replaced by
767nftables.</p>
768
769<p>Nevertheless, people still try to use this because (at least until the
770launch of <a href=http://nommu.org>nommu.org</a>) the project was viewed
771as the place to discuss, develop, and learn about nommu Linux.
772The role of uclinux.org as an educational resource kept people coming
773to it long after it had collapsed as a Linux distro.</p>
774
775<p>Starting around 0.6.0 toybox began to address nommu support with the goal
776of putting uClinux out of its misery.</p>
777
778<p>An analysis of <a href=http://www.uclinux.org/pub/uClinux/dist/uClinux-dist-20140504.tar.bz2>uClinux-dist-20140504</a> found 312 package
779subdirectories under "user".</p>
780
781<h3>Taking out the trash</h3>
782
783<p>A bunch of packages (<b>inotify-tools, input-event-demon, ipsec-tools, netifd,
784keepalived, mobile-broadband-provider-info, nuttp, readline, snort,
785snort-barnyard, socat, sqlite, sysklogd, sysstat, tcl, ubus, uci, udev,
786unionfs, uqmi, usb_modeswitch, usbutils, util-linux</b>)
787are hard to evaluate because
788uclinux has directories for them, but their source isn't actually in the
789uclinux tree. In some of these the makefiles download a git repo during
790the build, so I'm assuming you can build the external package if you really
791care. (Even when I know what these packages do, I'm skipping them
792because uclinux doesn't actually contain them, and any given snapshot
793of the build system will bitrot as external web links change over time.)</p>
794
795<p>Other packages are orphaned, meaning they're not mentioned from any Kconfig
796or Makefiles outside of their directory, so uclinux can't actually build
797them: <b>mbus</b> is an orphaned i2c test program expecting to run in some sort
798of hardwired hardware context, <b>mkeccbin</b> is an orphaned "ECC annotated
799binary file" generator (meaning it's half of a flash writer),
800<b>wsc_upnp</b> is a "Ralink WPS" driver (some sort of stale wifi chip)...</p>
801
802<p>The majority of the remaining packages are probably not of interest to
803toybox due to being so obsolete or special purpose they may not actually be
804of interest to anybody anymore. (This list also includes a lot of
805special-purpose network back-end stuff that's hard for anybody but
806datacenter admins to evaluate the current relevance of.)</p>
807
808<blockquote><b><p>
809arj asterisk boottools bpalogin br2684ctl camserv can4linux cgi_generic
810cgihtml clamav clamsmtp conntrack-tools cramfs crypto-tools cxxtest
811ddns3-client de2ts-cal debug demo diald discard dnsmasq dnsmasq2
812ethattach expat-examples ez-ipupdate fakeidentd
813fconfig ferret flatfs flthdr freeradius freeswan frob-led frox fswcert
814game gettyd gnugk haserl horch
815hostap hping httptunnel ifattach ipchains
816ipfwadm ipmasqadm ipportfw ipredir ipset iso_client
817jamvm jffs-tools jpegview jquery-ui kendin-config kismet klaxon kmod
818l2tpd lcd ledcmd ledcon lha lilo lirc lissa load loattach
819lpr lrpstat lrzsz mail mbus mgetty microwin ModemManager msntp musicbox
820nooom null openswan openvpn palmbot pam_* pcmcia-cs playrt plugdaemon pop3proxy
821potrace qspitest quagga radauth
822ramimage readprofile rdate readprofile routed rrdtool rtc-ds1302
823sendip ser sethdlc setmac setserial sgutool sigs siproxd slattach
824smtpclient snmpd net-snmp snortrules speedtouch squashfs scep sslwrap stp
825stunnel tcpblast tcpdump tcpwrappers threaddemos tinylogin tinyproxy
826tpt tripwire unrar unzoo version vpnled w3cam xl2tpd zebra
827</p></b></blockquote>
828
829<p>This stuff is all over the place: arj, lha, rar, and zoo are DOS archivers,
830ethattach describes itself as just "a network tool",
831mail is a textmode smtp mailer literally described as "Some kind of mail
832proggy" in uclinux's kconfig (as opposed to clamsmtp and smtpclient and
833so on), this gettyd isn't a generic version but specifically a
834hardwired ppp dialin utility, mgetty isn't a generic version but is combined
835with "sendfax", hostap is an intersil prism driver, wlan-ng is also an
836intersil prism dirver, null is a program to intentionally dereference a
837null pointer (in case you needed one), iso_client is a
838"Demo Application for the USB Device Driver", kendin-config is
839"for configuring the Micrel Kendin KS8995M over QSPI", speedtouch configures
840a specific brand of asdl modem, portmap is part of Anfs,
841ferret, linux-igd, and miniupnp are all upnp packages,
842lanbypass "can be used to control the LAN
843bypass switches on the Advantech x86 based hardware platforms", lcd is
844"test of lcddma device driver" (an out-of-tree Coldfire driver apparently
845lost to history, the uclinux linux-2.4.x directory has a config symbol for
846it, but nothing in the code actually _uses_ it...), qspitest is another
847coldfire thing, mii-tool-fec is
848"strictly for the FEC Ethernet driver as implemented (and modified) for
849the uCdimm5272", rtc-ds1302 and rtc-m41t11 are usermode drivers for specific
850clock chips, stunnel is basically "openssl s_client -quiet -connect",
851potrace is a bitmap to vector graphic converter, radauth performs command line
852authentication against a radius server,
853clamav, klaxon, ferret, l7-protocols, and nessus are very old network security
854software (it's got a stale snapshot of nmap too), xl2tpd is a PPP over UDP
855tunnel (rfc 2661), zebra is the package quagga replaced,
856lilo is the x86-only bootloader that predated grub (and recently discontinued
857development), lissa is a "framebuffer graphics demo" from
8581998, the squashfs package here is the out of tree patches for 2.4 kernels
859and such before the filesystem was merged upstream (as opposed to the
860squashfs-new package which is a snapshot of the userspace tool from 2011),
861load is basically "dd file /dev/spi", version is basically "cat /proc/version",
862microwin is a port of the WinCE graphics API to Linux, scep is a 2003
863implementation of an IETF draft abandoned in 2010, tpt depends on
864Andrew Morton's 15 year old unmerged "timepegs" kernel patch using the pentium
865cycle counter, vpnled controls a light that reboots systems (what?),
866w3cam is a video4linux 1.0 client (v4l2 showed up during 2.5 and support for
867the old v4l1 was removed in 2.6.38 back in 2011), busybox ate tinylogin
868over a decade ago, lrpstat is a java network monitor
869from 2001, lrzsz is zmodem/ymodem/zmodem, msntp and stp implement rfc2030
870meaning it overflows in 2036 (the package was last updated in 2000), rdate
871is rfc 868 meaning it also overflows in 2036 (which is why ntp was invented
872a few decades back), reiserfsprogs development stopped abruptly after
873Hans Reiser was convicted of murdering his wife Nina (denying it on the
874stand and then leading them to the body as part of his plea bargain during
875sentencing)...
876</p>
877
878<p>Seriously, there's a lot of crap in there. It's hard to analyze most
879of it far enough to prove it _doesn't_ do anything.</p>
880
881<h3>Non-toybox programs</h3>
882
883<p>The following software may actually still do something intelligible
884(although the package versions tend to be years out of date), but
885it's not a direction toybox has chosen to go in.</p>
886
887<p>There are several programming languages (<b>bash, lua, jamvm, tinytcl,
888perl, python</b>) in there. Maybe someone somewhere wants a 2008 release of a
889java virtual machine tested to work on nommu systems (jamvm), but it's out
890of scope for toybox.</p>
891
892<p>A bunch of benchmark programs: <b>cpu, dhrystone, mathtest, nbench, netperf,
893netpipe, and whetstone</b>.</p>
894
895<p>A bunch of web servers: <b>appWeb, boa, fnord (via tcpserver), goahead, httpd,
896mini_httpd, and thttpd</b>.</p>
897
898<p>A bunch of shells: <b>msh</b> is a clever (I.E. obfuscated) little shell,
899<b>nwsh</b> is "new shell" (that's what it called itself in 1999 anyway),
900<b>sash</b> is another shell with a bunch of builtins (ls, ps, df, cp, date, reboot,
901and shutdown, this roadmap analyzes it <a href="#sash">elsewhere</a>),
902<b>sh</b> is a very old minix shell fork, and <b>tcsh</b> is also a shell.</p>
903
904<p>Also in this category, we have:</p>
905
906<blockquote><b><p>
907dropbear jffs-tools jpegview kexec-tools bind ctorrent
908iperf iproute2 ip-sentinel iptables kexec
909nmap oggplay openssl oprofile p7zip pppd pptp play vplay
910hdparm mp3play at clock
911mtd-utils mysql logrotate brcfg bridge-utils flashw
912ebtables etherwake ethtool expect gdb gdbserver hostapd
913lm_sensors load netflash netstat-nat
914radvd recover rootloader resolveip rp-pppoe
915rsyslog rsyslogd samba smbmount squashfs-new squid ssh strace tip
916uboot-envtools ulogd usbhubctrl vconfig vixie-cron watchdogd
917wireless_tools wpa_supplicant
918</p></b></blockquote>
919
920<p>An awful lot of those are borderline: play and vplay are wav file
921audio players, there's oprofile _and_ readprofile (which just reads kernel
922profiling data from /proc/profile),
923radvd is a "routr advertisement daemon" (ipv6 stateless autoconf),
924ctorrent is a bittorent client,
925lm_sensors is hardware (heat?) monitoring,
926resolveip is dig only less so,
927rp-pppoe is ppp over ethernet,
928ebtables is an ethernet version of iptables (for bridging),
929their dropbear is from 2012, and that ssh version is from 2011
930(which means it's about nine months too _old_ to have the heartbleed bug).
931There's both ulogd and ulogd2 (no idea why), and pppd is version 2.4 but
932there's a ppd-2.3 directory also.</p>
933
934<p>Lots of flash stuff:
935flashw is a flash writer, load is an spi flash loader, netflash writes
936to flash via tftp,
937recover is also a reflash daemon intended to come up when the system can't boot,
938rootloader seems to be another reflash daemon but without dhcp.</p>
939
940<h3>Already in roadmap</h3>
941
942<p>The following packages contain commands already in the toybox roadmap:</p>
943
944<blockquote><b><p>
945agetty cal cksum cron dhcpcd dhcpcd-new dhcpd dhcp-isc dosfstools e2fsprogs
946elvis-tiny levee fdisk fileutils ftp ftpd grep hd hwclock inetd init ntp
947iputils login module-init-tools netcat shutils ntpdate lspci ping procps
948proftpd rsync shadow shutils stty sysutils telnet telnetd tftp tftpd traceroute
949unzip wget mawk net-tools
950</p></b></blockquote>
951
952<p>There are some duplicates in there, levee is a tiny vi implementation
953like elvis-tiny, ntp and ntpdate overlap, etc.</p>
954
955<p>Verdict: We don't really need to do a whole lot special for nommu
956systems, just get the existing toybox roadmap working on nommu and
957we're good. The uClinux project can rest in peace.</p>
958
959<hr />
960<h2>Requests:</h2>
961
962<p>The following additional commands have been requested (and often submitted)
963by various users. I _really_ need to clean up this section.</p>
964
965<p>Also:</p>
966<blockquote><b>
967<span id=request>
968dig freeramdisk getty halt hexdump hwclock klogd modprobe ping ping6 pivot_root
969poweroff readahead rev sfdisk sudo syslogd taskset telnet telnetd tracepath
970traceroute unzip usleep vconfig zip free login modinfo unshare netcat help w
971ntpd iwconfig iwlist rdate
972dos2unix unix2dos catv clear
973pmap realpath setsid timeout truncate
974mkswap swapon swapoff
975count oneit fstype
976acpi blkid eject pwdx
977sulogin rfkill bootchartd
978arp makedevs sysctl killall5 crond crontab deluser last mkpasswd watch
979blockdev rpm2cpio arping brctl dumpleases fsck
980tcpsvd tftpd
981factor fallocate fsfreeze inotifyd lspci nbd-client partprobe strings
982base64 mix
983reset hexedit nsenter shred
984fsync insmod ionice lsmod lsusb rmmod vmstat xxd iotop
985lsof ionice compress dhcp dhcpd addgroup delgroup host iconv ip
986ipcrm ipcs netstat openvt
987deallocvt iorenice
988udpsvd adduser
989</span>
990</b></blockquote>
991
992<!-- #include "footer.html" -->
993
994