diff options
| -rw-r--r-- | applets.h | 2 | ||||
| -rw-r--r-- | applets/usage.h | 533 | ||||
| -rwxr-xr-x | docs/autodocifier.pl | 8 | ||||
| -rw-r--r-- | docs/busybox.pod | 2067 | ||||
| -rw-r--r-- | fbset.c | 6 | ||||
| -rw-r--r-- | include/applets.h | 2 | ||||
| -rw-r--r-- | include/usage.h | 533 | ||||
| -rw-r--r-- | usage.h | 533 | ||||
| -rw-r--r-- | util-linux/fbset.c | 6 |
9 files changed, 2708 insertions, 982 deletions
@@ -135,7 +135,7 @@ APPLET(false, false_main, _BB_DIR_BIN) #endif #ifdef BB_FBSET - APPLET_NOUSAGE("fbset", fbset_main, _BB_DIR_USR_SBIN) + APPLET(fbset, fbset_main, _BB_DIR_USR_SBIN) #endif #ifdef BB_FDFLUSH APPLET(fdflush, fdflush_main, _BB_DIR_BIN) diff --git a/applets/usage.h b/applets/usage.h index b60f1f911..3d4752cd2 100644 --- a/applets/usage.h +++ b/applets/usage.h @@ -15,11 +15,21 @@ #define basename_full_usage \ "Strips directory path and suffixes from FILE.\n" \ "If specified, also removes any trailing SUFFIX." +#define basename_example_usage \ + "$ basename /usr/local/bin/foo\n" \ + "foo\n" \ + "$ basename /usr/local/bin/\n" \ + "bin\n" \ + "$ basename /foo/bar.txt .txt\n" \ + "bar" #define cat_trivial_usage \ "[FILE]..." #define cat_full_usage \ "Concatenates FILE(s) and prints them to stdout." +#define cat_example_usage \ + "$ cat /proc/uptime\n" \ + "110716.72 17.67" #define chgrp_trivial_usage \ "[OPTION]... GROUP FILE..." @@ -27,6 +37,12 @@ "Change the group membership of each FILE to GROUP.\n" \ "\nOptions:\n" \ "\t-R\tChanges files and directories recursively." +#define chgrp_example_usage \ + "$ ls -l /tmp/foo\n" \ + "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \ + "$ chgrp root /tmp/foo\n" \ + "$ ls -l /tmp/foo\n" \ + "-r--r--r-- 1 andersen root 0 Apr 12 18:25 /tmp/foo\n" #define chmod_trivial_usage \ "[-R] MODE[,MODE]... FILE..." @@ -35,6 +51,15 @@ "symbols +-= and one or more of the letters rwxst.\n\n" \ "Options:\n" \ "\t-R\tChanges files and directories recursively." +#define chmod_example_usage \ + "$ ls -l /tmp/foo\n" \ + "-rw-rw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n" \ + "$ chmod u+x /tmp/foo\n" \ + "$ ls -l /tmp/foo\n" \ + "-rwxrw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo*\n" \ + "$ chmod 444 /tmp/foo\n" \ + "$ ls -l /tmp/foo\n" \ + "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n" #define chown_trivial_usage \ "[OPTION]... OWNER[<.|:>[GROUP] FILE..." @@ -42,11 +67,27 @@ "Change the owner and/or group of each FILE to OWNER and/or GROUP.\n" \ "\nOptions:\n" \ "\t-R\tChanges files and directories recursively." +#define chown_example_usage \ + "$ ls -l /tmp/foo\n" \ + "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \ + "$ chown root /tmp/foo\n" \ + "$ ls -l /tmp/foo\n" \ + "-r--r--r-- 1 root andersen 0 Apr 12 18:25 /tmp/foo\n" \ + "$ chown root.root /tmp/foo\n" \ + "ls -l /tmp/foo\n" \ + "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n" #define chroot_trivial_usage \ "NEWROOT [COMMAND...]" #define chroot_full_usage \ "Run COMMAND with root directory set to NEWROOT." +#define chroot_example_usage \ + "$ ls -l /bin/ls\n" \ + "lrwxrwxrwx 1 root root 12 Apr 13 00:46 /bin/ls -> /BusyBox\n" \ + "$ mount /dev/hdc1 /mnt -t minix\n" \ + "$ chroot /mnt\n" \ + "$ ls -l /bin/ls\n" \ + "-rwxr-xr-x 1 root root 40816 Feb 5 07:45 /bin/ls*\n" #define chvt_trivial_usage \ "N" @@ -85,6 +126,11 @@ "\t-s\t\tOutput only the lines containing delimiter\n" \ "\t-f N\t\tPrint only these fields\n" \ "\t-n\t\tIgnored" +#define cut_example_usage \ + "$ echo "Hello world" | cut -f 1 -d ' '\n" \ + "Hello\n" \ + "$ echo "Hello world" | cut -f 2 -d ' '\n" \ + "world\n" #define date_trivial_usage \ "[OPTION]... [+FORMAT]" @@ -95,6 +141,9 @@ "\t-d STRING\tdisplay time described by STRING, not `now'\n" \ "\t-s\t\tSets time described by STRING\n" \ "\t-u\t\tPrints or sets Coordinated Universal Time" +#define date_example_usage \ + "$ date\n" \ + "Wed Apr 12 18:52:41 MDT 2000\n" #define dc_trivial_usage \ "expression ..." @@ -102,6 +151,17 @@ "This is a Tiny RPN calculator that understands the\n" \ "following operations: +, -, /, *, and, or, not, eor.\n" \ "i.e. 'dc 2 2 add' -> 4, and 'dc 8 8 \\* 2 2 + /' -> 16" +#define dc_example_usage \ + "$ dc 2 2 +\n" \ + "4\n" \ + "$ dc 8 8 \* 2 2 + /\n" \ + "16\n" \ + "$ dc 0 1 and\n" \ + "0\n" \ + "$ dc 0 1 or\n" \ + "1\n" \ + "$ echo 72 9 div 8 mul | dc\n" \ + "64\n" #define dd_trivial_usage \ "[if=FILE] [of=FILE] [bs=N] [count=N] [skip=N]\n" \ @@ -119,6 +179,10 @@ "\n" \ "Numbers may be suffixed by c (x1), w (x2), b (x512), kD (x1000), k (x1024),\n" \ "MD (x1000000), M (x1048576), GD (x1000000000) or G (x1073741824)." +#define dd_example_usage \ + "$ dd if=/dev/zero of=/dev/ram1 bs=1M count=4\n" \ + "4+0 records in\n" \ + "4+0 records out\n" #define deallocvt_trivial_usage \ "N" @@ -143,11 +207,24 @@ "\t-m\tprint sizes in megabytes\n" \ "\t-k\tprint sizes in kilobytes(default)") USAGE_NOT_HUMAN_READABLE( \ "\n\t-k\tprint sizes in kilobytes(compatability)") +#define df_example_usage \ + "$ df\n" \ + "Filesystem 1k-blocks Used Available Use% Mounted on\n" \ + "/dev/sda3 8690864 8553540 137324 98% /\n" \ + "/dev/sda1 64216 36364 27852 57% /boot\n" \ + "$ df /dev/sda3\n" \ + "Filesystem 1k-blocks Used Available Use% Mounted on\n" \ + "/dev/sda3 8690864 8553540 137324 98% /\n" #define dirname_trivial_usage \ "[FILENAME ...]" #define dirname_full_usage \ "Strips non-directory suffix from FILENAME" +#define dirname_example_usage \ + "$ dirname /tmp/foo\n" \ + "/tmp\n" \ + "$ dirname /tmp/foo/\n" \ + "/tmp\n" #define dmesg_trivial_usage \ "[-c] [-n LEVEL] [-s SIZE]" @@ -184,6 +261,8 @@ "\t-e\tExtract control files to directory\n" \ "\t-x\tExctract packages filesystem tree to directory\n" \ "\t-X\tVerbose extract" +#define dpkg_deb_example_usage \ + "$ dpkg-deb -X ./busybox_0.48-1_i386.deb /tmp\n" #define du_trivial_usage \ "[-ls" USAGE_HUMAN_READABLE("hm") USAGE_NOT_HUMAN_READABLE("") "k] [FILE]..." @@ -198,17 +277,40 @@ "\t-m\tprint sizes in megabytes\n" \ "\t-k\tprint sizes in kilobytes(default)") USAGE_NOT_HUMAN_READABLE( \ "\n\t-k\tprint sizes in kilobytes(compatability)") +#define du_example_usage \ + "$ du\n" \ + "16 ./CVS\n" \ + "12 ./kernel-patches/CVS\n" \ + "80 ./kernel-patches\n" \ + "12 ./tests/CVS\n" \ + "36 ./tests\n" \ + "12 ./scripts/CVS\n" \ + "16 ./scripts\n" \ + "12 ./docs/CVS\n" \ + "104 ./docs\n" \ + "2417 .\n" #define dumpkmap_trivial_usage \ "> keymap" #define dumpkmap_full_usage \ "Prints out a binary keyboard translation table to standard output." +#define dumpkmap_example_usage \ + "$ dumpkmap > keymap\n" #define dutmp_trivial_usage \ "[FILE]" #define dutmp_full_usage \ "Dump utmp file format (pipe delimited) from FILE\n" \ "or stdin to stdout. (i.e. 'dutmp /var/run/utmp')" +#define dutmp_example_usage \ + "$ dutmp /var/run/utmp\n" \ + "8|7||si|||0|0|0|955637625|760097|0\n" \ + "2|0|~|~~|reboot||0|0|0|955637625|782235|0\n" \ + "1|20020|~|~~|runlevel||0|0|0|955637625|800089|0\n" \ + "8|125||l4|||0|0|0|955637629|998367|0\n" \ + "6|245|tty1|1|LOGIN||0|0|0|955637630|998974|0\n" \ + "6|246|tty2|2|LOGIN||0|0|0|955637630|999498|0\n" \ + "7|336|pts/0|vt00andersen|andersen|:0.0|0|0|0|955637763|0|0\n" #define echo_trivial_usage \ "[-neE] [ARG ...]" @@ -218,6 +320,15 @@ "\t-n\tsuppress trailing newline\n" \ "\t-e\tinterpret backslash-escaped characters (i.e. \\t=tab etc)\n" \ "\t-E\tdisable interpretation of backslash-escaped characters" +#define echo_example_usage \ + "$ echo "Erik is cool"\n" \ + "Erik is cool\n" \ + "$ echo -e "Erik\nis\ncool"\n" \ + "Erik\n" \ + "is\n" \ + "cool\n" \ + "$ echo "Erik\nis\ncool"\n" \ + "Erik\nis\ncool\n" #define expr_trivial_usage \ "EXPRESSION" @@ -257,6 +368,24 @@ "" #define false_full_usage \ "Return an exit code of FALSE (1)." +#define false_example_usage \ + "$ false\n" \ + "$ echo $?\n" \ + "1\n" + +#define fbset_trivial_usage \ + "[options] [mode]" +#define fbset_full_usage \ + "Show and modify frame buffer settings" +#define fbset_example_usage \ + "$ fbset\n" \ + "mode "1024x768-76"\n" \ + "\t# D: 78.653 MHz, H: 59.949 kHz, V: 75.694 Hz\n" \ + "\tgeometry 1024 768 1024 768 16\n" \ + "\ttimings 12714 128 32 16 4 128 4\n" \ + "\taccel false\n" \ + "\trgba 5/11,6/5,5/0,0/0\n" \ + "endmode\n" #define fdflush_trivial_usage \ "DEVICE" @@ -293,16 +422,27 @@ "\n\t-perm PERMS\tPermissions match any of (+NNN); all of (-NNN);\n\t\t\tor exactly (NNN)" \ ) USAGE_FIND_MTIME( \ "\n\t-mtime TIME\tModified time is greater than (+N); less than (-N);\n\t\t\tor exactly (N) days") +#define find_example_usage \ + "$ find / -name /etc/passwd\n" \ + "/etc/passwd\n" #define free_trivial_usage \ "" #define free_full_usage \ "Displays the amount of free and used system memory" +#define free_example_usage \ + "$ free\n" \ + " total used free shared buffers\n" \ + " Mem: 257628 248724 8904 59644 93124\n" \ + " Swap: 128516 8404 120112\n" \ + "Total: 386144 257128 129016\n" \ #define freeramdisk_trivial_usage \ "DEVICE" #define freeramdisk_full_usage \ "Frees all memory used by the specified ramdisk." +#define freeramdisk_example_usage \ + "$ freeramdisk /dev/ram2\n" #define fsck_minix_trivial_usage \ "[-larvsmf] /dev/name" @@ -330,6 +470,26 @@ "\t-s, --shell=shell Set shell quoting conventions\n" \ "\t-T, --test Test for getopt(1) version\n" \ "\t-u, --unqote Do not quote the output" +#define getopt_example_usage \ + "$ cat getopt.test\n" \ + "#!/bin/sh\n" \ + "GETOPT=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \\\n" \ + " -n 'example.busybox' -- "$@"`\n" \ + "if [ $? != 0 ] ; then exit 1 ; fi\n" \ + "eval set -- "$GETOPT"\n" \ + "while true ; do\n" \ + " case $1 in\n" \ + " -a|--a-long) echo \"Option a\" ; shift ;;\n" \ + " -b|--b-long) echo \"Option b, argument \`$2'\" ; shift 2 ;;\n" \ + " -c|--c-long)\n" \ + " case "$2" in\n" \ + " \"\") echo \"Option c, no argument\"; shift 2 ;;\n" \ + " *) echo \"Option c, argument \`$2'\" ; shift 2 ;;\n" \ + " esac ;;\n" \ + " --) shift ; break ;;\n" \ + " *) echo \"Internal error!\" ; exit 1 ;;\n" \ + " esac\n" \ + "done\n" #define grep_trivial_usage \ "[-ihHnqvs] pattern [files...]" @@ -343,9 +503,11 @@ "\t-q\tbe quiet. Returns 0 if result was found, 1 otherwise\n" \ "\t-v\tselect non-matching lines\n" \ "\t-s\tsuppress file open/read error messages" - -#define egrep_trivial_usage grep_trivial_usage -#define egrep_full_usage grep_full_usage +#define grep_example_usage \ + "$ grep root /etc/passwd\n" \ + "root:x:0:0:root:/root:/bin/bash\n" \ + "$ grep ^[rR]oo. /etc/passwd\n" \ + "root:x:0:0:root:/root:/bin/bash\n" #define gunzip_trivial_usage \ "[OPTION]... FILE" @@ -354,6 +516,12 @@ "Options:\n" \ "\t-c\tWrite output to standard output\n" \ "\t-t\tTest compressed file integrity" +#define gunzip_example_usage \ + "$ ls -la /tmp/BusyBox*\n" \ + "-rw-rw-r-- 1 andersen andersen 557009 Apr 11 10:55 /tmp/BusyBox-0.43.tar.gz\n" \ + "$ gunzip /tmp/BusyBox-0.43.tar.gz\n" \ + "$ ls -la /tmp/BusyBox*\n" \ + "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar\n" #define gzip_trivial_usage \ "[OPTION]... FILE" @@ -363,6 +531,12 @@ "Options:\n" \ "\t-c\tWrite output to standard output instead of FILE.gz\n" \ "\t-d\tdecompress" +#define gzip_example_usage \ + "$ ls -la /tmp/BusyBox*\n" \ + "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar\n" \ + "$ gzip /tmp/BusyBox-0.43.tar\n" \ + "$ ls -la /tmp/BusyBox*\n" \ + "-rw-rw-r-- 1 andersen andersen 554058 Apr 14 17:49 /tmp/BusyBox-0.43.tar.gz\n" #define halt_trivial_usage \ "" @@ -377,6 +551,10 @@ "file name. With no FILE, or when FILE is -, read standard input.\n\n" \ "Options:\n" \ "\t-n NUM\t\tPrint first NUM lines instead of first 10" +#define head_example_usage \ + "$ head -n 2 /etc/passwd\n" \ + "root:x:0:0:root:/root:/bin/bash\n" \ + "daemon:x:1:1:daemon:/usr/sbin:/bin/sh\n" #define hostid_trivial_usage \ "" @@ -393,6 +571,9 @@ "\t-i\t\tAddresses for the hostname\n" \ "\t-d\t\tDNS domain name\n" \ "\t-F, --file FILE\tUse the contents of FILE to specify the hostname" +#define hostname_example_usage \ + "$ hostname\n" \ + "slag \n" #define id_trivial_usage \ "[OPTIONS]... [USERNAME]" @@ -403,6 +584,9 @@ "\t-u\tprints only the user ID\n" \ "\t-n\tprint a name instead of a number (with for -ug)\n" \ "\t-r\tprints the real user ID instead of the effective ID (with -ug)" +#define id_example_usage \ + "$ id\n" \ + "uid=1000(andersen) gid=1000(andersen)\n" #ifdef BB_FEATURE_IFCONFIG_SLIP #define USAGE_SIOCSKEEPALIVE(a) a @@ -443,8 +627,116 @@ #define init_trivial_usage \ "" #define init_full_usage \ - "Init is the parent of all processes.\n\n" \ - "This version of init is designed to be run only by the kernel." + "Init is the parent of all processes." +#define init_notes_usage \ +"This version of init is designed to be run only by the kernel.\n" \ +"\n" \ +"BusyBox init doesn't support multiple runlevels. The runlevels field of\n" \ +"the /etc/inittab file is completely ignored by BusyBox init. If you want \n" \ +"runlevels, use sysvinit.\n" \ +"\n" \ +"BusyBox init works just fine without an inittab. If no inittab is found, \n" \ +"it has the following default behavior:\n" \ +"\n" \ +" ::sysinit:/etc/init.d/rcS\n" \ +" ::askfirst:/bin/sh\n" \ +"\n" \ +"if it detects that /dev/console is _not_ a serial console, it will also run:\n" \ +"\n" \ +" tty2::askfirst:/bin/sh\n" \ +"\n" \ +"If you choose to use an /etc/inittab file, the inittab entry format is as follows:\n" \ +"\n" \ +" <id>:<runlevels>:<action>:<process>\n" \ +"\n" \ +" <id>: \n" \ +"\n" \ +" WARNING: This field has a non-traditional meaning for BusyBox init!\n" \ +" The id field is used by BusyBox init to specify the controlling tty for\n" \ +" the specified process to run on. The contents of this field are\n" \ +" appended to "/dev/" and used as-is. There is no need for this field to\n" \ +" be unique, although if it isn't you may have strange results. If this\n" \ +" field is left blank, the controlling tty is set to the console. Also\n" \ +" note that if BusyBox detects that a serial console is in use, then only\n" \ +" entries whose controlling tty is either the serial console or /dev/null\n" \ +" will be run. BusyBox init does nothing with utmp. We don't need no\n" \ +" stinkin' utmp.\n" \ +"\n" \ +" <runlevels>: \n" \ +"\n" \ +" The runlevels field is completely ignored.\n" \ +"\n" \ +" <action>: \n" \ +"\n" \ +" Valid actions include: sysinit, respawn, askfirst, wait, \n" \ +" once, and ctrlaltdel.\n" \ +"\n" \ +" The available actions can be classified into two groups: actions\n" \ +" that are run only once, and actions that are re-run when the specified\n" \ +" process exits.\n" \ +"\n" \ +" Run only-once actions:\n" \ +"\n" \ +" 'sysinit' is the first item run on boot. init waits until all\n" \ +" sysinit actions are completed before continuing. Following the\n" \ +" completion of all sysinit actions, all 'wait' actions are run.\n" \ +" 'wait' actions, like 'sysinit' actions, cause init to wait until\n" \ +" the specified task completes. 'once' actions are asyncronous,\n" \ +" therefore, init does not wait for them to complete. 'ctrlaltdel'\n" \ +" actions are run immediately before init causes the system to reboot\n" \ +" (unmounting filesystems with a 'ctrlaltdel' action is a very good\n" \ +" idea).\n" \ +"\n" \ +" Run repeatedly actions:\n" \ +"\n" \ +" 'respawn' actions are run after the 'once' actions. When a process\n" \ +" started with a 'respawn' action exits, init automatically restarts\n" \ +" it. Unlike sysvinit, BusyBox init does not stop processes from\n" \ +" respawning out of control. The 'askfirst' actions acts just like\n" \ +" respawn, except that before running the specified process it\n" \ +" displays the line "Please press Enter to activate this console."\n" \ +" and then waits for the user to press enter before starting the\n" \ +" specified process. \n" \ +"\n" \ +" Unrecognized actions (like initdefault) will cause init to emit an\n" \ +" error message, and then go along with its business. All actions are\n" \ +" run in the reverse order from how they appear in /etc/inittab.\n" \ +"\n" \ +" <process>: \n" \ +"\n" \ +" Specifies the process to be executed and it's command line.\n" \ +"\n" \ +"Example /etc/inittab file:\n" \ +" # This is run first except when booting in single-user mode.\n" \ +" #\n" \ +" ::sysinit:/etc/init.d/rcS\n" \ +" \n" \ +" # /bin/sh invocations on selected ttys\n" \ +" #\n" \ +" # Start an "askfirst" shell on the console (whatever that may be)\n" \ +" ::askfirst:-/bin/sh\n" \ +" # Start an "askfirst" shell on /dev/tty2-4\n" \ +" tty2::askfirst:-/bin/sh\n" \ +" tty3::askfirst:-/bin/sh\n" \ +" tty4::askfirst:-/bin/sh\n" \ +" \n" \ +" # /sbin/getty invocations for selected ttys\n" \ +" #\n" \ +" tty4::respawn:/sbin/getty 38400 tty5\n" \ +" tty5::respawn:/sbin/getty 38400 tty6\n" \ +" \n" \ +" \n" \ +" # Example of how to put a getty on a serial line (for a terminal)\n" \ +" #\n" \ +" #::respawn:/sbin/getty -L ttyS0 9600 vt100\n" \ +" #::respawn:/sbin/getty -L ttyS1 9600 vt100\n" \ +" #\n" \ +" # Example how to put a getty on a modem line.\n" \ +" #::respawn:/sbin/getty 57600 ttyS2\n" \ +" \n" \ +" # Stuff to do before rebooting\n" \ +" ::ctrlaltdel:/bin/umount -a -r\n" \ +" ::ctrlaltdel:/sbin/swapoff -a\n" #define insmod_trivial_usage \ "[OPTION]... MODULE [symbol=value]..." @@ -463,6 +755,15 @@ "Send a signal (default is SIGTERM) to the specified process(es).\n\n"\ "Options:\n" \ "\t-l\tList all signal names and numbers." +#define kill_example_usage \ + "$ ps | grep apache\n" \ + "252 root root S [apache]\n" \ + "263 www-data www-data S [apache]\n" \ + "264 www-data www-data S [apache]\n" \ + "265 www-data www-data S [apache]\n" \ + "266 www-data www-data S [apache]\n" \ + "267 www-data www-data S [apache]\n" \ + "$ kill 252\n" #define killall_trivial_usage \ "[-signal] process-name [process-name ...]" @@ -470,6 +771,8 @@ "Send a signal (default is SIGTERM) to the specified process(es).\n\n"\ "Options:\n" \ "\t-l\tList all signal names and numbers." +#define killall_example_usage \ + "$ killall apache\n" #define klogd_trivial_usage \ "-n" @@ -482,6 +785,9 @@ "STRING" #define length_full_usage \ "Prints out the length of the specified STRING." +#define length_example_usage \ + "$ length "Hello"\n" \ + "5\n" #define ln_trivial_usage \ "[OPTION] TARGET... LINK_NAME|DIRECTORY" @@ -492,21 +798,31 @@ "\t-s\tmake symbolic links instead of hard links\n" \ "\t-f\tremove existing destination files\n" \ "\t-n\tno dereference symlinks - treat like normal file" +#define ln_example_usage \ + "$ ln -s BusyBox /tmp/ls\n" \ + "$ ls -l /tmp/ls\n" \ + "lrwxrwxrwx 1 root root 7 Apr 12 18:39 ls -> BusyBox*\n" #define loadacm_trivial_usage \ "< mapfile" #define loadacm_full_usage \ "Loads an acm from standard input." +#define loadacm_example_usage \ + "$ loadacm < /etc/i18n/acmname\n" #define loadfont_trivial_usage \ "< font" #define loadfont_full_usage \ "Loads a console font from standard input." +#define loadfont_example_usage \ + "$ loadfont < /etc/i18n/fontname\n" #define loadkmap_trivial_usage \ "< keymap" #define loadkmap_full_usage \ "Loads a binary keyboard translation table from standard input." +#define loadkmap_example_usage \ + "$ loadkmap < /etc/i18n/lang-keymap\n" #define logger_trivial_usage \ "[OPTION]... [MESSAGE]" @@ -517,11 +833,16 @@ "\t-t\tLog using the specified tag (defaults to user name).\n" \ "\t-p\tEnter the message with the specified priority.\n" \ "\t\tThis may be numerical or a ``facility.level'' pair." +#define logger_example_usage \ + "$ logger "hello"\n" #define logname_trivial_usage \ "" #define logname_full_usage \ "Print the name of the current user." +#define logname_example_usage \ + "$ logname\n" \ + "root\n" #define logread_trivial_usage \ "" @@ -612,6 +933,11 @@ "For example:\n" \ "\tmakedevs /dev/ttyS c 4 66 2 63 -> ttyS2-ttyS63\n" \ "\tmakedevs /dev/hda b 3 0 0 8 s -> hda,hda1-hda8" +#define makedevs_example_usage \ + "$ makedevs /dev/ttyS c 4 66 2 63\n" \ + "[creates ttyS2-ttyS63]\n" \ + "$ makedevs /dev/hda b 3 0 0 8 s\n" \ + "[creates hda,hda1-hda8]\n" #define md5sum_trivial_usage \ "[OPTION] [FILE]...\n" \ @@ -627,6 +953,15 @@ "\nThe following two options are useful only when verifying checksums:\n" \ "\t-s\tdon't output anything, status code shows success\n" \ "\t-w\twarn about improperly formated MD5 checksum lines" +#define md5sum_example_usage \ + "$ md5sum < busybox\n" \ + "6fd11e98b98a58f64ff3398d7b324003\n" \ + "$ md5sum busybox\n" \ + "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \ + "$ md5sum -c -\n" \ + "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \ + "busybox: OK\n" \ + "^D\n" #define mkdir_trivial_usage \ "[OPTION] DIRECTORY..." @@ -635,6 +970,13 @@ "Options:\n" \ "\t-m\tset permission mode (as in chmod), not rwxrwxrwx - umask\n" \ "\t-p\tno error if existing, make parent directories as needed" +#define mkdir_example_usage \ + "$ mkdir /tmp/foo\n" \ + "$ mkdir /tmp/foo\n" \ + "/tmp/foo: File exists\n" \ + "$ mkdir /tmp/foo/bar/baz\n" \ + "/tmp/foo/bar/baz: No such file or directory\n" \ + "$ mkdir -p /tmp/foo/bar/baz\n" #define mkfifo_trivial_usage \ "[OPTIONS] name" @@ -664,6 +1006,9 @@ "\tb:\tMake a block (buffered) device.\n" \ "\tc or u:\tMake a character (un-buffered) device.\n" \ "\tp:\tMake a named pipe. MAJOR and MINOR are ignored for named pipes." +#define mknod_example_usage \ + "$ mknod /dev/fd0 b 2 0 \n" \ + "$ mknod -m 644 /tmp/pipe p\n" #define mkswap_trivial_usage \ "[-c] [-v0|-v1] device [block-count]" @@ -680,11 +1025,18 @@ #define mktemp_full_usage \ "Creates a temporary file with its name based on TEMPLATE.\n" \ "TEMPLATE is any name with six `Xs' (i.e. /tmp/temp.XXXXXX)." +#define mktemp_example_usage \ + "$ mktemp /tmp/temp.XXXXXX\n" \ + "/tmp/temp.mWiLjM\n" \ + "$ ls -la /tmp/temp.mWiLjM\n" \ + "-rw------- 1 andersen andersen 0 Apr 25 17:10 /tmp/temp.mWiLjM\n" #define more_trivial_usage \ "[FILE ...]" #define more_full_usage \ "More is a filter for viewing FILE one screenful at a time." +#define more_example_usage \ + "$ dmesg | more\n" #ifdef BB_FEATURE_MOUNT_LOOP #define USAGE_MOUNT_LOOP(a) a @@ -724,6 +1076,13 @@ "\tro/rw:\t\tMount for read-only / read-write.\n" \ "\nThere are EVEN MORE flags that are specific to each filesystem.\n" \ "You'll have to see the written documentation for those." +#define mount_example_usage \ + "$ mount\n" \ + "/dev/hda3 on / type minix (rw)\n" \ + "proc on /proc type proc (rw)\n" \ + "devpts on /dev/pts type devpts (rw)\n" \ + "$ mount /dev/fd0 /mnt -t msdos -o ro\n" \ + "$ mount /tmp/diskimage /opt -t ext2 -o loop\n" #define mt_trivial_usage \ "[-f device] opcode value" @@ -740,16 +1099,34 @@ "or: mv SOURCE... DIRECTORY" #define mv_full_usage \ "Rename SOURCE to DEST, or move SOURCE(s) to DIRECTORY." +#define mv_example_usage \ + "$ mv /tmp/foo /bin/bar\n" #define nc_trivial_usage \ "[IP] [port]" #define nc_full_usage \ "Netcat opens a pipe to IP:port" +#define nc_example_usage \ + "$ nc foobar.somedomain.com 25\n" \ + "220 foobar ESMTP Exim 3.12 #1 Sat, 15 Apr 2000 00:03:02 -0600\n" \ + "help\n" \ + "214-Commands supported:\n" \ + "214- HELO EHLO MAIL RCPT DATA AUTH\n" \ + "214 NOOP QUIT RSET HELP\n" \ + "quit\n" \ + "221 foobar closing connection\n" #define nslookup_trivial_usage \ "[HOST]" #define nslookup_full_usage \ "Queries the nameserver for the IP address of the given HOST" +#define nslookup_example_usage \ + "$ nslookup localhost\n" \ + "Server: default\n" \ + "Address: default\n" \ + "\n" \ + "Name: debian\n" \ + "Address: 127.0.0.1\n" #ifdef BB_FEATURE_SIMPLE_PING #define ping_trivial_usage "host" @@ -765,6 +1142,14 @@ "\t-q\t\tQuiet mode, only displays output at start\n" \ "\t\t\tand when finished." #endif +#define ping_example_usage \ + "$ ping localhost\n" \ + "PING slag (127.0.0.1): 56 data bytes\n" \ + "64 bytes from 127.0.0.1: icmp_seq=0 ttl=255 time=20.1 ms\n" \ + "\n" \ + "--- debian ping statistics ---\n" \ + "1 packets transmitted, 1 packets received, 0% packet loss\n" \ + "round-trip min/avg/max = 20.1/20.1/20.1 ms\n" #define pivot_root_trivial_usage \ "new_root put_old" @@ -782,17 +1167,35 @@ #define printf_full_usage \ "Formats and prints ARGUMENT(s) according to FORMAT,\n" \ "Where FORMAT controls the output exactly as in C printf." +#define printf_example_usage \ + "$ printf "Val=%d\n" 5\n" \ + "Val=5\n" #define ps_trivial_usage \ "" #define ps_full_usage \ "Report process status\n" \ "\nThis version of ps accepts no options." +#define ps_example_usage \ + "$ ps\n" \ + " PID Uid Gid State Command\n" \ + " 1 root root S init\n" \ + " 2 root root S [kflushd]\n" \ + " 3 root root S [kupdate]\n" \ + " 4 root root S [kpiod]\n" \ + " 5 root root S [kswapd]\n" \ + " 742 andersen andersen S [bash]\n" \ + " 743 andersen andersen S -bash\n" \ + " 745 root root S [getty]\n" \ + " 2990 andersen andersen R ps\n" #define pwd_trivial_usage \ "" #define pwd_full_usage \ "Print the full filename of the current working directory." +#define pwd_example_usage \ + "$ pwd\n" \ + "/root\n" #define rdate_trivial_usage \ "[OPTION] HOST" @@ -838,11 +1241,15 @@ USAGE_RM_INTERACTIVE("\t-i\t\talways prompt before removing each destinations\n") \ "\t-f\t\tremove existing destinations, never prompt\n" \ "\t-r or -R\tremove the contents of directories recursively" +#define rm_example_usage \ + "$ rm -rf /tmp/foo\n" #define rmdir_trivial_usage \ "[OPTION]... DIRECTORY..." #define rmdir_full_usage \ "Remove the DIRECTORY(ies), if they are empty." +#define rmdir_example_usage \ + "# rmdir /tmp/foo\n" #define rmmod_trivial_usage \ "[OPTION]... [MODULE]..." @@ -850,6 +1257,8 @@ "Unloads the specified kernel modules from the kernel.\n\n" \ "Options:\n" \ "\t-a\tTry to remove all unused kernel modules." +#define rmmod_example_usage \ + "$ rmmod tulip\n" #define route_trivial_usage \ "[{add|del|flush}]" @@ -873,6 +1282,9 @@ "If no -e or -f is given, the first non-option argument is taken as the\n" \ "sed script to interpret. All remaining arguments are names of input\n" \ "files; if no input files are specified, then the standard input is read." +#define sed_example_usage \ + "$ echo "foo" | sed -e 's/f[a-zA-Z]o/bar/g'\n" \ + "bar\n" #define setkeycodes_trivial_usage \ "SCANCODE KEYCODE ..." @@ -881,17 +1293,31 @@ "allowing unusual keyboards to generate usable keycodes.\n\n" \ "SCANCODE may be either xx or e0xx (hexadecimal),\n" \ "and KEYCODE is given in decimal" +#define setkeycodes_example_usage \ + "$ setkeycodes e030 127\n" #define sh_trivial_usage \ "[FILE]...\n" \ "or: sh -c command [args]..." #define sh_full_usage \ - "lash: The BusyBox command interpreter (shell)." + "lash: The BusyBox LAme SHell (command interpreter)" +#define sh_notes_usage \ +"This command does not yet have proper documentation.\n" \ +"\n" \ +"Use lash just as you would use any other shell. It properly handles pipes,\n" \ +"redirects, job control, can be used as the shell for scripts, and has a\n" \ +"sufficient set of builtins to do what is needed. It does not (yet) support\n" \ +"Bourne Shell syntax. If you need things like "if-then-else", "while", and such\n" \ +"use ash or bash. If you just need a very simple and extremely small shell,\n" \ +"this will do the job." #define sleep_trivial_usage \ "N" #define sleep_full_usage \ "Pause for N seconds." +#define sleep_example_usage \ + "$ sleep 2\n" \ + "[2 second delay results]\n" #ifdef BB_FEATURE_SORT_REVERSE @@ -903,6 +1329,14 @@ "[-n]" USAGE_SORT_REVERSE(" [-r]") " [FILE]..." #define sort_full_usage \ "Sorts lines of text in the specified files" +#define sort_example_usage \ + "$ echo -e "e\nf\nb\nd\nc\na" | sort\n" \ + "a\n" \ + "b\n" \ + "c\n" \ + "d\n" \ + "e\n" \ + "f\n" #define stty_trivial_usage \ "[-a|g] [-F device] [SETTING]..." @@ -952,6 +1386,9 @@ USAGE_REMOTE_LOG( \ "\n\t-R HOST[:PORT]\tLog to IP or hostname on PORT (default PORT=514/UDP)\n" \ "\t-L\t\tLog locally and via network logging (default is network only)") +#define syslogd_example_usage \ + "$ syslogd -R masterlog:514\n" \ + "$ syslogd -R 192.168.1.1:601\n" #ifdef BB_FEATURE_SIMPLE_TAIL @@ -969,14 +1406,15 @@ USAGE_UNSIMPLE_TAIL("\t-c N[kbm]\toutput the last N bytes\n") \ "\t-n N[kbm]\tprint last N lines instead of last 10\n" \ "\t-f\t\toutput data as the file grows" \ - USAGE_UNSIMPLE_TAIL( \ - "\n\t-q\t\tnever output headers giving file names\n" \ + USAGE_UNSIMPLE_TAIL( "\n\t-q\t\tnever output headers giving file names\n" \ "\t-s SEC\t\twait SEC seconds between reads with -f\n" \ "\t-v\t\talways output headers giving file names\n\n" \ - "If the first character of N (bytes or lines) is a `+', output begins with \n" \ + "If the first character of N (bytes or lines) is a '+', output begins with \n" \ "the Nth item from the start of each file, otherwise, print the last N items\n" \ - "in the file. N bytes may be suffixed by k (x1024), b (x512), or m (1024^2)." \ - ) + "in the file. N bytes may be suffixed by k (x1024), b (x512), or m (1024^2)." ) +#define tail_example_usage \ + "$ tail -n 1 /etc/resolv.conf\n" \ + "nameserver 10.0.0.1\n" #ifdef BB_FEATURE_TAR_CREATE #define USAGE_TAR_CREATE(a) a @@ -1007,6 +1445,9 @@ ) \ "\nInformative output:\n" \ "\tv\t\tverbosely list files processed" +#define tar_example_usage \ + "$ zcat /tmp/tarball.tar.gz | tar -xf -\n" \ + "$ tar -cf /tmp/tarball.tar /usr/local\n" #define tee_trivial_usage \ "[OPTION]... [FILE]..." @@ -1014,6 +1455,10 @@ "Copy standard input to each FILE, and also to standard output.\n\n" \ "Options:\n" \ "\t-a\tappend to the given FILEs, do not overwrite" +#define tee_example_usage \ + "$ echo "Hello" | tee /tmp/foo\n" \ + "$ cat /tmp/foo\n" \ + "Hello\n" #define telnet_trivial_usage \ "host [port]" @@ -1026,6 +1471,19 @@ #define test_full_usage \ "Checks file types and compares values returning an exit\n" \ "code determined by the value of EXPRESSION." +#define test_example_usage \ + "$ test 1 -eq 2\n" \ + "$ echo $?\n" \ + "1\n" \ + "$ test 1 -eq 1\n" \ + "$ echo $? \n" \ + "0\n" \ + "$ [ -d /etc ]\n" \ + "$ echo $?\n" \ + "0\n" \ + "$ [ -d /junk ]\n" \ + "$ echo $?\n" \ + "1\n" #ifdef BB_FEATURE_TFTP_GET #define USAGE_TFTP_GET(a) a @@ -1057,6 +1515,12 @@ "Update the last-modified date on the given file[s].\n\n" \ "Options:\n" \ "\t-c\tDo not create any files" +#define touch_example_usage \ + "$ ls -l /tmp/foo\n" \ + "/bin/ls: /tmp/foo: No such file or directory\n" \ + "$ touch /tmp/foo\n" \ + "$ ls -l /tmp/foo\n" \ + "-rw-rw-r-- 1 andersen andersen 0 Apr 15 01:11 /tmp/foo\n" #define tr_trivial_usage \ "[-cds] STRING1 [STRING2]" @@ -1067,11 +1531,18 @@ "\t-c\ttake complement of STRING1\n" \ "\t-d\tdelete input characters coded STRING1\n" \ "\t-s\tsqueeze multiple output characters of STRING2 into one character" +#define tr_example_usage \ + "$ echo "gdkkn vnqkc" | tr [a-y] [b-z]\n" \ + "hello world\n" #define true_trivial_usage \ "" #define true_full_usage \ "Return an exit code of TRUE (0)." +#define true_example_usage \ + "$ true\n" \ + "$ echo $?\n" \ + "0\n" #define tty_trivial_usage \ "" @@ -1079,6 +1550,9 @@ "Print the file name of the terminal connected to standard input.\n\n"\ "Options:\n" \ "\t-s\tprint nothing, only return an exit status" +#define tty_example_usage \ + "$ tty\n" \ + "/dev/tty2\n" #ifdef BB_FEATURE_MOUNT_FORCE #define USAGE_MOUNT_FORCE(a) a @@ -1094,6 +1568,8 @@ "\n\t-r:\tTry to remount devices as read-only if mount is busy" \ USAGE_MOUNT_FORCE("\n\t-f:\tForce filesystem umount (i.e. unreachable NFS server)") \ USAGE_MOUNT_LOOP("\n\t-l:\tDo not free loop device (if a loop device has been used)") +#define umount_example_usage \ + "$ umount /dev/hdc1 \n" #define uname_trivial_usage \ "[OPTION]..." @@ -1107,6 +1583,9 @@ "\t-s\tprint the operating system name\n" \ "\t-p\tprint the host processor type\n" \ "\t-v\tprint the operating system version" +#define uname_example_usage \ + "$ uname -a\n" \ + "Linux debian 2.2.15pre13 #5 Tue Mar 14 16:03:50 MST 2000 i686 unknown\n" #define uniq_trivial_usage \ "[OPTION]... [INPUT [OUTPUT]]" @@ -1117,6 +1596,11 @@ "\t-c\tprefix lines by the number of occurrences\n" \ "\t-d\tonly print duplicate lines\n" \ "\t-u\tonly print unique lines" +#define uniq_example_usage \ + "$ echo -e "a\na\nb\nc\nc\na" | sort | uniq\n" \ + "a\n" \ + "b\n" \ + "c\n" #define unix2dos_trivial_usage \ "[option] [file]" @@ -1136,11 +1620,17 @@ "" #define uptime_full_usage \ "Display the time since the last boot." +#define uptime_example_usage \ + "$ uptime\n" \ + " 1:55pm up 2:30, load average: 0.09, 0.04, 0.00\n" #define usleep_trivial_usage \ "N" #define usleep_full_usage \ "Pause for N microseconds." +#define usleep_example_usage \ + "$ usleep 1000000\n" \ + "[pauses for 1 second]\n" #define uudecode_trivial_usage \ "[FILE]..." @@ -1148,6 +1638,10 @@ "Uudecode a file that is uuencoded.\n\n" \ "Options:\n" \ "\t-o FILE\tdirect output to FILE" \ +#define uudecode_example_usage \ + "$ uudecode -o busybox busybox.uu\n" \ + "$ ls -l busybox\n" \ + "-rwxr-xr-x 1 ams ams 245264 Jun 7 21:35 busybox\n" #define uuencode_trivial_usage \ "[OPTION] [INFILE] REMOTEFILE" @@ -1155,6 +1649,12 @@ "Uuencode a file.\n\n" \ "Options:\n" \ "\t-m\tuse base64 encoding as of RFC1521" +#define uuencode_example_usage \ + "$ uuencode busybox busybox\n" \ + "begin 755 busybox\n" \ + "<encoded file snipped>\n" \ + "$ uudecode busybox busybox > busybox.uu\n" \ + "$\n" #define watchdog_trivial_usage \ "DEV" @@ -1171,6 +1671,9 @@ "\t-l\tprint the newline counts\n" \ "\t-L\tprint the length of the longest line\n" \ "\t-w\tprint the word counts" +#define wc_example_usage \ + "$ wc /etc/passwd\n" \ + " 31 46 1365 /etc/passwd\n" #define wget_trivial_usage \ "[-c] [-O file] url" @@ -1184,6 +1687,9 @@ "[COMMAND ...]" #define which_full_usage \ "Locates a COMMAND." +#define which_example_usage \ + "$ which login\n" \ + "/bin/login\n" #define whoami_trivial_usage \ "" @@ -1194,11 +1700,14 @@ "[COMMAND] [ARGS...]" #define xargs_full_usage \ "Executes COMMAND on every item given by standard input." +#define xargs_example_usage \ + "$ ls | xargs gzip\n" \ + "$ find . -name '*.c' -print | xargs rm\n" #define yes_trivial_usage \ "[OPTION]... [STRING]..." #define yes_full_usage \ - "Repeatedly outputs a line with all specified STRING(s), or `y'." + "Repeatedly outputs a line with all specified STRING(s), or 'y'." #define zcat_trivial_usage \ "FILE" diff --git a/docs/autodocifier.pl b/docs/autodocifier.pl index 9e18dc3c8..e967568e1 100755 --- a/docs/autodocifier.pl +++ b/docs/autodocifier.pl @@ -62,6 +62,11 @@ sub pod_for_usage { } my $full = join("\n", @f1); + # prepare notes if they exists + my $notes = (defined $usage->{notes}) + ? "$usage->{notes}\n\n" + : ""; + # prepare example if one exists my $example = (defined $usage->{example}) ? "Example:\n\n$usage->{example}\n\n" @@ -74,6 +79,7 @@ sub pod_for_usage { "\n\n" . $full . "\n\n" . + $notes . $example. "-------------------------------". "\n\n" @@ -216,4 +222,4 @@ John BEPPU <beppu@lineo.com> =cut -# $Id: autodocifier.pl,v 1.14 2001/03/06 19:25:25 beppu Exp $ +# $Id: autodocifier.pl,v 1.15 2001/03/15 18:14:25 andersen Exp $ diff --git a/docs/busybox.pod b/docs/busybox.pod index 4c0810234..d7786dd22 100644 --- a/docs/busybox.pod +++ b/docs/busybox.pod @@ -55,766 +55,789 @@ terse runtime description of their behavior. Currently defined functions include: -ar, basename, cat, chgrp, chmod, chown, chroot, chvt, clear, cp, cut, date, dc, -dd, deallocvt, df, dirname, dmesg, dos2unix, dpkg-deb, du, dumpkmap, dutmp, -echo, false, fbset, fdflush, find, free, freeramdisk, fsck.minix, getopt, grep, -gunzip, gzip, halt, head, hostid, hostname, id, init, insmod, kill, killall, -length, ln, loadacm, loadfont, loadkmap, logger, logname, ls, lsmod, makedevs, -mkdir, mkfifo, mkfs.minix, mknod, mkswap, mktemp, more, mount, mt, mv, nc, -nslookup, ping, poweroff, printf, ps, pwd, rdate, reboot, renice, reset, rm, -rmdir, rmmod, sed, setkeycodes, sh, sleep, sort, swapoff, swapon, sync, -syslogd, tail, tar, tee, telnet, test, touch, tr, true, tty, umount, uname, -uniq, unix2dos, unrpm, update, uptime, usleep, uudecode, uuencode, watchdog, -wc, which, whoami, xargs, yes, zcat, [ +ar, basename, busybox, cat, chgrp, chmod, chown, chroot, chvt, clear, cmp, cp, +cut, date, dc, dd, deallocvt, df, dirname, dmesg, dos2unix, dpkg, dpkg-deb, du, +dumpkmap, dutmp, echo, expr, false, fbset, fdflush, find, free, freeramdisk, +fsck.minix, getopt, grep, gunzip, gzip, halt, head, hostid, hostname, id, +ifconfig, init, insmod, kill, killall, klogd, length, ln, loadacm, loadfont, +loadkmap, logger, logname, ls, lsmod, makedevs, md5sum, mkdir, mkfifo, +mkfs.minix, mknod, mkswap, mktemp, more, mount, mt, mv, nc, nslookup, ping, +pivot_root, poweroff, printf, ps, pwd, rdate, readlink, reboot, renice, reset, +rm, rmdir, rmmod, route, rpmunpack, sed, setkeycodes, sh, sleep, sort, stty, +swapoff, swapon, sync, syslogd, tail, tar, tee, telnet, test, tftp, touch, tr, +true, tty, umount, uname, uniq, unix2dos, update, uptime, usleep, uudecode, +uuencode, watchdog, wc, wget, which, whoami, xargs, yes, zcat, [ ------------------------------- =over 4 -=item ar -Usage: ar [optxvV] archive [filenames] +=item I<ar> + +ar -[ovR]{ptx} archive filenames Extract or list files from an ar archive. Options: - o preserve original dates - p extract to stdout - t list - x extract - v verbosely list files processed + -o preserve original dates + -p extract to stdout + -t list + -x extract + -v verbosely list files processed + -R recursive action ------------------------------- -=item basename +=item I<basename> -Usage: basename FILE [SUFFIX] +basename FILE [SUFFIX] Strips directory path and suffixes from FILE. If specified, also removes any trailing SUFFIX. Example: - $ basename /usr/local/bin/foo - foo - $ basename /usr/local/bin/ - bin - $ basename /foo/bar.txt .txt - bar +$ basename /usr/local/bin/foo +foo +$ basename /usr/local/bin/ +bin +$ basename /foo/bar.txt .txt +bar ------------------------------- -=item cat +=item I<cat> -Usage: cat [FILE ...] +cat [FILE]... -Concatenates FILE(s) and prints them to the standard output. +Concatenates FILE(s) and prints them to stdout. Example: - $ cat /proc/uptime - 110716.72 17.67 +$ cat /proc/uptime +110716.72 17.67 ------------------------------- -=item chgrp +=item I<chgrp> -Usage: chgrp [OPTION]... GROUP FILE... +chgrp [OPTION]... GROUP FILE... Change the group membership of each FILE to GROUP. Options: - -R change files and directories recursively + -R Changes files and directories recursively. Example: - $ ls -l /tmp/foo - -r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo - $ chgrp root /tmp/foo - $ ls -l /tmp/foo - -r--r--r-- 1 andersen root 0 Apr 12 18:25 /tmp/foo - -------------------------------- - -=item chmod - -Usage: chmod [B<-R>] MODE[,MODE]... FILE... - -Changes file access permissions for the specified FILE(s) (or directories). -Each MODE is defined by combining the letters for WHO has access to the file, -an OPERATOR for selecting how the permissions should be changed, and a -PERMISSION for FILE(s) (or directories). - -WHO may be chosen from - - u User who owns the file - g Users in the file's Group - o Other users not in the file's group - a All users +$ ls -l /tmp/foo +-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo +$ chgrp root /tmp/foo +$ ls -l /tmp/foo +-r--r--r-- 1 andersen root 0 Apr 12 18:25 /tmp/foo -OPERATOR may be chosen from - + Add a permission - - Remove a permission - = Assign a permission - -PERMISSION may be chosen from - - r Read - w Write - x Execute (or access for directories) - s Set user (or group) ID bit - t Sticky bit (for directories prevents removing files by non-owners) - -Alternately, permissions can be set numerically where the first three -numbers are calculated by adding the octal values, such as +------------------------------- - 4 Read - 2 Write - 1 Execute +=item I<chmod> -An optional fourth digit can also be used to specify +chmod [B<-R>] MODE[,MODE]... FILE... - 4 Set user ID - 2 Set group ID - 1 Sticky bit +Each MODE is one or more of the letters ugoa, one of the +symbols +-= and one or more of the letters rwxst. Options: - -R Change files and directories recursively. + -R Changes files and directories recursively. Example: - $ ls -l /tmp/foo - -rw-rw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo - $ chmod u+x /tmp/foo - $ ls -l /tmp/foo - -rwxrw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo* - $ chmod 444 /tmp/foo - $ ls -l /tmp/foo - -r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo +$ ls -l /tmp/foo +-rw-rw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo +$ chmod u+x /tmp/foo +$ ls -l /tmp/foo +-rwxrw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo* +$ chmod 444 /tmp/foo +$ ls -l /tmp/foo +-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo + ------------------------------- -=item chown +=item I<chown> -Usage: chown [OPTION]... OWNER[<.|:>[GROUP] FILE... +chown [OPTION]... OWNER[<.|:>[GROUP] FILE... -Changes the owner and/or group of each FILE to OWNER and/or GROUP. +Change the owner and/or group of each FILE to OWNER and/or GROUP. Options: - -R Changes files and directories recursively + -R Changes files and directories recursively. Example: - $ ls -l /tmp/foo - -r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo - $ chown root /tmp/foo - $ ls -l /tmp/foo - -r--r--r-- 1 root andersen 0 Apr 12 18:25 /tmp/foo - $ chown root.root /tmp/foo - ls -l /tmp/foo - -r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo +$ ls -l /tmp/foo +-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo +$ chown root /tmp/foo +$ ls -l /tmp/foo +-r--r--r-- 1 root andersen 0 Apr 12 18:25 /tmp/foo +$ chown root.root /tmp/foo +ls -l /tmp/foo +-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo + ------------------------------- -=item chroot +=item I<chroot> -Usage: chroot NEWROOT [COMMAND...] +chroot NEWROOT [COMMAND...] Run COMMAND with root directory set to NEWROOT. Example: - $ ls -l /bin/ls - lrwxrwxrwx 1 root root 12 Apr 13 00:46 /bin/ls -> /BusyBox - $ mount /dev/hdc1 /mnt -t minix - $ chroot /mnt - $ ls -l /bin/ls - -rwxr-xr-x 1 root root 40816 Feb 5 07:45 /bin/ls* +$ ls -l /bin/ls +lrwxrwxrwx 1 root root 12 Apr 13 00:46 /bin/ls -> /BusyBox +$ mount /dev/hdc1 /mnt -t minix +$ chroot /mnt +$ ls -l /bin/ls +-rwxr-xr-x 1 root root 40816 Feb 5 07:45 /bin/ls* + ------------------------------- -=item chvt +=item I<chvt> -Usage: chvt N +chvt N Changes the foreground virtual terminal to /dev/ttyN ------------------------------- -=item clear +=item I<clear> + +clear -Clears the screen. +Clear screen. ------------------------------- -=item cp +=item I<cmp> -Usage: cp [OPTION]... SOURCE DEST +cmp FILE1 [FILE2] - or: cp [OPTION]... SOURCE... DIRECTORY +Compare files. -Copies SOURCE to DEST, or multiple SOURCE(s) to DIRECTORY. +------------------------------- -Options: +=item I<cp> + +cp [OPTION]... SOURCE DEST - -a Same as -dpR - -d Preserves links - -p Preserves file attributes if possible - -R Copies directories recursively +Copies SOURCE to DEST, or multiple SOURCE(s) to DIRECTORY. + + -a Same as -dpR + -d Preserves links + -p Preserves file attributes if possible + -f force (implied; ignored) - always set + -R Copies directories recursively ------------------------------- -=item cut +=item I<cut> -Usage: cut [OPTION]... [FILE]... +cut [OPTION]... [FILE]... Prints selected fields from each input FILE to standard output. Options: - -b LIST Output only bytes from LIST - -c LIST Output only characters from LIST - -d CHAR Use CHAR instead of tab as the field delimiter - -s Output only the lines containing delimiter - -f N Print only these fields - -n Ignored + -b LIST Output only bytes from LIST + -c LIST Output only characters from LIST + -d CHAR Use CHAR instead of tab as the field delimiter + -s Output only the lines containing delimiter + -f N Print only these fields + -n Ignored Example: - $ echo "Hello world" | cut -f 1 -d ' ' - Hello - $ echo "Hello world" | cut -f 2 -d ' ' - world +$ echo Hello world | cut -f 1 -d ' ' +Hello +$ echo Hello world | cut -f 2 -d ' ' +world ------------------------------- -=item date +=item I<date> -Usage: date [OPTION]... [+FORMAT] - - or: date [OPTION] [MMDDhhmm[[CC]YY][.ss]] +date [OPTION]... [+FORMAT] Displays the current time in the given FORMAT, or sets the system date. Options: - -R Outputs RFC-822 compliant date string - -s Sets time described by STRING - -u Prints or sets Coordinated Universal Time + -R Outputs RFC-822 compliant date string + -d STRING display time described by STRING, not `now' + -s Sets time described by STRING + -u Prints or sets Coordinated Universal Time Example: - $ date - Wed Apr 12 18:52:41 MDT 2000 +$ date +Wed Apr 12 18:52:41 MDT 2000 + ------------------------------- -=item dc +=item I<dc> -Usage: dc expression ... +dc expression ... This is a Tiny RPN calculator that understands the following operations: +, -, /, *, and, or, not, eor. -If no arguments are given, dc will process input from STDIN. - -The behaviour of BusyBox/dc deviates (just a little ;-) from -GNU/dc, but this will be remedied in the future. +i.e. 'dc 2 2 add' -> 4, and 'dc 8 8 \* 2 2 + /' -> 16 Example: - $ dc 2 2 + - 4 - $ dc 8 8 \* 2 2 + / - 16 - $ dc 0 1 and - 0 - $ dc 0 1 or - 1 - $ echo 72 9 div 8 mul | dc - 64 +$ dc 2 2 + +4 +$ dc 8 8 * 2 2 + / +16 +$ dc 0 1 and +0 +$ dc 0 1 or +1 +$ echo 72 9 div 8 mul | dc +64 + ------------------------------- -=item dd +=item I<dd> -Usage: dd [if=name] [of=name] [bs=n] [count=n] [skip=n] [seek=n] +dd [if=FILE] [of=FILE] [bs=N] [count=N] [skip=N] + [seek=N] [conv=notrunc|sync] Copy a file, converting and formatting according to options - if=FILE read from FILE instead of stdin - of=FILE write to FILE instead of stdout - bs=n read and write n bytes at a time - count=n copy only n input blocks - skip=n skip n input blocks - seek=n skip n output blocks + if=FILE read from FILE instead of stdin + of=FILE write to FILE instead of stdout + bs=N read and write N bytes at a time + count=N copy only N input blocks + skip=N skip N input blocks + seek=N skip N output blocks + conv=notrunc don't truncate output file + conv=sync pad blocks with zeros -Numbers may be suffixed by w (x2), k (x1024), b (x512), or M (x1024^2) +Numbers may be suffixed by c (x1), w (x2), b (x512), kD (x1000), k (x1024), +MD (x1000000), M (x1048576), GD (x1000000000) or G (x1073741824). Example: - $ dd if=/dev/zero of=/dev/ram1 bs=1M count=4 - 4+0 records in - 4+0 records out +$ dd if=/dev/zero of=/dev/ram1 bs=1M count=4 +4+0 records in +4+0 records out + ------------------------------- -=item deallocvt +=item I<deallocvt> -Usage: deallocvt N +deallocvt N -Deallocates unused virtual terminal /dev/ttyN +Deallocate unused virtual terminal /dev/ttyN ------------------------------- -=item df +=item I<df> -Usage: df [filesystem ...] +df [B<-hmk>] [filesystem ...] -Prints the filesystem space used and space available. +Print the filesystem space used and space available. + +Options: + + -h print sizes in human readable format (e.g., 1K 243M 2G ) + -m print sizes in megabytes + -k print sizes in kilobytes(default) Example: - $ df - Filesystem 1k-blocks Used Available Use% Mounted on - /dev/sda3 8690864 8553540 137324 98% / - /dev/sda1 64216 36364 27852 57% /boot - $ df /dev/sda3 - Filesystem 1k-blocks Used Available Use% Mounted on - /dev/sda3 8690864 8553540 137324 98% / +$ df +Filesystem 1k-blocks Used Available Use% Mounted on +/dev/sda3 8690864 8553540 137324 98% / +/dev/sda1 64216 36364 27852 57% /boot +$ df /dev/sda3 +Filesystem 1k-blocks Used Available Use% Mounted on +/dev/sda3 8690864 8553540 137324 98% / + ------------------------------- -=item dirname +=item I<dirname> -Usage: dirname NAME +dirname [FILENAME ...] -Strip non-directory suffix from file name +Strips non-directory suffix from FILENAME Example: - $ dirname /tmp/foo - /tmp - $ dirname /tmp/foo/ - /tmp +$ dirname /tmp/foo +/tmp +$ dirname /tmp/foo/ +/tmp + ------------------------------- -=item dmesg +=item I<dmesg> + +dmesg [B<-c>] [B<-n> LEVEL] [B<-s> SIZE] -Usage: dmesg [B<-c>] [B<-n> level] [B<-s> bufsize] +Prints or controls the kernel ring buffer + +Options: -Print or controls the kernel ring buffer. + -c Clears the ring buffer's contents after printing + -n LEVEL Sets console logging level + -s SIZE Use a buffer of size SIZE ------------------------------- -=item dos2unix +=item I<dos2unix> + +dos2unix [option] [file] + +Converts a text file to/from dos format to unix format. + +Options: -Usage: dos2unix < dosfile > unixfile + -u output will be in UNIX format + -d output will be in DOS format -Converts a text file from dos format to unix format. +- when no option is given then input format will be automaticaly detected + + and converted to the oposite format on output +- when no file is given, then stdin is used as input and stdout as output ------------------------------- -=item dpkg-deb +=item I<dpkg> -Usage: dpkg-deb [-cexX] archive-file [directory] +dpkg [B<-i>|B<-r>|-B<-unpack>|-B<-configure>] my.deb -Debian package archive (.deb) manipulation tool +WORK IN PROGRESS, only usefull for debian-installer -Options: +------------------------------- - -c Lists the contents of the filesystem tree archive - portion of the package archive. +=item I<dpkg_deb> - -e Extracts the control information files from a package - archive into the specified directory. - - -x Silently extracts the filesystem tree from a package - archive into the specified directory. - - -X Extracts the filesystem tree from a package archive - into the specified directory, list files as it goes. +dpkg_deb [B<-cexX>] file directory + +Perform actions on debian packages (.debs) + +Options: + + -c List contents of filesystem tree (verbose) + -l List contents of filesystem tree (.list format) + -e Extract control files to directory + -x Exctract packages filesystem tree to directory + -X Verbose extract Example: - dpkg-deb -X ./busybox_0.48-1_i386.deb /tmp +$ dpkg-deb -X ./busybox_0.48-1_i386.deb /tmp + ------------------------------- -=item du +=item I<du> -Usage: du [OPTION]... [FILE]... +du [B<-lshmk>] [FILE]... -Summarize disk space used for each FILE and/or directory. -Disk space is printed in units of 1k (i.e. 1024 bytes). +Summarizes disk space used for each FILE and/or directory. +Disk space is printed in units of 1024 bytes. Options: - -l count sizes many times if hard linked - -s display only a total for each argument + -l count sizes many times if hard linked + -s display only a total for each argument + -h print sizes in human readable format (e.g., 1K 243M 2G ) + -m print sizes in megabytes + -k print sizes in kilobytes(default) Example: - $ ./BusyBox du - 16 ./CVS - 12 ./kernel-patches/CVS - 80 ./kernel-patches - 12 ./tests/CVS - 36 ./tests - 12 ./scripts/CVS - 16 ./scripts - 12 ./docs/CVS - 104 ./docs - 2417 . +$ du +16 ./CVS +12 ./kernel-patches/CVS +80 ./kernel-patches +12 ./tests/CVS +36 ./tests +12 ./scripts/CVS +16 ./scripts +12 ./docs/CVS +104 ./docs +2417 . + ------------------------------- -=item dumpkmap +=item I<dumpkmap> -Usage: dumpkmap +dumpkmap > keymap Prints out a binary keyboard translation table to standard output. Example: - $ dumpkmap > keymap +$ dumpkmap > keymap + ------------------------------- -=item dutmp +=item I<dutmp> -Usage: dutmp [FILE] +dutmp [FILE] Dump utmp file format (pipe delimited) from FILE -or stdin to stdout. +or stdin to stdout. (i.e. 'dutmp /var/run/utmp') Example: - $ dutmp /var/run/utmp - 8|7||si|||0|0|0|955637625|760097|0 - 2|0|~|~~|reboot||0|0|0|955637625|782235|0 - 1|20020|~|~~|runlevel||0|0|0|955637625|800089|0 - 8|125||l4|||0|0|0|955637629|998367|0 - 6|245|tty1|1|LOGIN||0|0|0|955637630|998974|0 - 6|246|tty2|2|LOGIN||0|0|0|955637630|999498|0 - 7|336|pts/0|vt00andersen|andersen|:0.0|0|0|0|955637763|0|0 +$ dutmp /var/run/utmp +8|7||si|||0|0|0|955637625|760097|0 +2|0|~|~~|reboot||0|0|0|955637625|782235|0 +1|20020|~|~~|runlevel||0|0|0|955637625|800089|0 +8|125||l4|||0|0|0|955637629|998367|0 +6|245|tty1|1|LOGIN||0|0|0|955637630|998974|0 +6|246|tty2|2|LOGIN||0|0|0|955637630|999498|0 +7|336|pts/0|vt00andersen|andersen|:0.0|0|0|0|955637763|0|0 + ------------------------------- -=item echo +=item I<echo> -Usage: echo [-neE] [ARG ...] +echo [B<-neE>] [ARG ...] Prints the specified ARGs to stdout Options: - -n suppress trailing newline - -e interpret backslash-escaped characters (i.e. \t=tab etc) - -E disable interpretation of backslash-escaped characters + -n suppress trailing newline + -e interpret backslash-escaped characters (i.e. \t=tab etc) + -E disable interpretation of backslash-escaped characters Example: - $ echo "Erik is cool" - Erik is cool - $ echo -e "Erik\nis\ncool" - Erik - is - cool - $ echo "Erik\nis\ncool" - Erik\nis\ncool +$ echo Erik is cool +Erik is cool +$ echo -e Erik +is +cool +Erik +is +cool +$ echo Erik +is +cool +Erik +is +cool + ------------------------------- -=item expr +=item I<egrep> + +egrep -Usage: expr EXPRESSION + +------------------------------- + +=item I<expr> + +expr EXPRESSION Prints the value of EXPRESSION to standard output. EXPRESSION may be: - ARG1 | ARG2 ARG1 if it is neither null nor 0, otherwise ARG2 - ARG1 & ARG2 ARG1 if neither argument is null or 0, otherwise 0 - ARG1 < ARG2 ARG1 is less than ARG2 - ARG1 <= ARG2 ARG1 is less than or equal to ARG2 - ARG1 = ARG2 ARG1 is equal to ARG2 - ARG1 != ARG2 ARG1 is unequal to ARG2 - ARG1 >= ARG2 ARG1 is greater than or equal to ARG2 - ARG1 > ARG2 ARG1 is greater than ARG2 - ARG1 + ARG2 arithmetic sum of ARG1 and ARG2 - ARG1 - ARG2 arithmetic difference of ARG1 and ARG2 - ARG1 * ARG2 arithmetic product of ARG1 and ARG2 - ARG1 / ARG2 arithmetic quotient of ARG1 divided by ARG2 - ARG1 % ARG2 arithmetic remainder of ARG1 divided by ARG2 + ARG1 | ARG2 ARG1 if it is neither null nor 0, otherwise ARG2 + ARG1 & ARG2 ARG1 if neither argument is null or 0, otherwise 0 + ARG1 < ARG2 ARG1 is less than ARG2 + ARG1 <= ARG2 ARG1 is less than or equal to ARG2 + ARG1 = ARG2 ARG1 is equal to ARG2 + ARG1 != ARG2 ARG1 is unequal to ARG2 + ARG1 >= ARG2 ARG1 is greater than or equal to ARG2 + ARG1 > ARG2 ARG1 is greater than ARG2 + ARG1 + ARG2 arithmetic sum of ARG1 and ARG2 + ARG1 - ARG2 arithmetic difference of ARG1 and ARG2 + ARG1 * ARG2 arithmetic product of ARG1 and ARG2 + ARG1 / ARG2 arithmetic quotient of ARG1 divided by ARG2 + ARG1 % ARG2 arithmetic remainder of ARG1 divided by ARG2 STRING : REGEXP anchored pattern match of REGEXP in STRING match STRING REGEXP same as STRING : REGEXP substr STRING POS LENGTH substring of STRING, POS counted from 1 - index STRING CHARS index in STRING where any CHARS is found, or 0 + index STRING CHARS index in STRING where any CHARS is found, + or 0 length STRING length of STRING - quote TOKEN interpret TOKEN as a string, even if it is a - keyword like `match' or an operator like `/' + quote TOKEN interpret TOKEN as a string, even if + it is a keyword like `match' or an + operator like `/' ( EXPRESSION ) value of EXPRESSION Beware that many operators need to be escaped or quoted for shells. Comparisons are arithmetic if both ARGs are numbers, else -lexicographical. Pattern matches return the string matched between -\( and \) or null; if \( and \) are not used, they return the number +lexicographical. Pattern matches return the string matched between +\( and \) or null; if \( and \) are not used, they return the number of characters matched or 0. ------------------------------- -=item false +=item I<false> -Returns an exit code of FALSE (1) +false -Example: +Return an exit code of FALSE (1). - $ false - $ echo $? - 1 +Example: -------------------------------- +$ false +$ echo $? +1 -=item fbset -Usage: fbset [options] [mode] +------------------------------- -Show and modify frame buffer device settings +=item I<fbset> -Options: +fbset [options] [mode] - -h - -fb - -db - -a - -i - -g - -t - -accel - -hsync - -vsync - -laced - -double +Show and modify frame buffer settings Example: - $ fbset - mode "1024x768-76" - # D: 78.653 MHz, H: 59.949 kHz, V: 75.694 Hz - geometry 1024 768 1024 768 16 - timings 12714 128 32 16 4 128 4 - accel false - rgba 5/11,6/5,5/0,0/0 - endmode +$ fbset +mode 1024x768-76 + geometry 1024 768 1024 768 16 + timings 12714 128 32 16 4 128 4 + accel false + rgba 5/11,6/5,5/0,0/0 +endmode + ------------------------------- -=item fdflush +=item I<fdflush> -Usage: fdflush device +fdflush DEVICE -Force floppy disk drive to detect disk change +Forces floppy disk drive to detect disk change ------------------------------- -=item find +=item I<find> -Usage: find [PATH...] [EXPRESSION] +find [PATH...] [EXPRESSION] Search for files in a directory hierarchy. The default PATH is -the current directory; default EXPRESSION is '-print' - +the current directory; default EXPRESSION is 'B<-print>' EXPRESSION may consist of: - -follow Dereference symbolic links. + -follow Dereference symbolic links. -name PATTERN File name (leading directories removed) matches PATTERN. - -print print the full file name followed by a newline to stdout. + -type X Filetype matches X (where X is one of: f,d,l,b,c,...) + -perm PERMS Permissions match any of (+NNN); all of (-NNN); + or exactly (NNN) + -mtime TIME Modified time is greater than (+N); less than (-N); + or exactly (N) days Example: - $ find / -name /etc/passwd - /etc/passwd +$ find / -name /etc/passwd +/etc/passwd + ------------------------------- -=item free +=item I<free> -Usage: free +free -Displays the amount of free and used system memory. +Displays the amount of free and used system memory Example: - $ free - total used free shared buffers - Mem: 257628 248724 8904 59644 93124 - Swap: 128516 8404 120112 - Total: 386144 257128 129016 +$ free + total used free shared buffers + Mem: 257628 248724 8904 59644 93124 + Swap: 128516 8404 120112 +Total: 386144 257128 129016 + ------------------------------- -=item freeramdisk +=item I<freeramdisk> -Usage: freeramdisk DEVICE +freeramdisk DEVICE Frees all memory used by the specified ramdisk. Example: - $ freeramdisk /dev/ram2 +$ freeramdisk /dev/ram2 + ------------------------------- -=item fsck.minix +=item I<fsck_minix> -Usage: fsck.minix [B<-larvsmf>] /dev/name +fsck_minix [B<-larvsmf>] /dev/name Performs a consistency check for MINIX filesystems. Options: - -l Lists all filenames - -r Perform interactive repairs - -a Perform automatic repairs - -v verbose - -s Outputs super-block information - -m Activates MINIX-like "mode not cleared" warnings - -f Force file system check. + -l Lists all filenames + -r Perform interactive repairs + -a Perform automatic repairs + -v verbose + -s Outputs super-block information + -m Activates MINIX-like mode not cleared warnings + -f Force file system check. ------------------------------- -=item getopt +=item I<getopt> -Usage: getopt [OPTIONS]... +getopt [OPTIONS]... Parse command options -Options: - - -a, --alternative Allow long options starting with single -\n" - -l, --longoptions=longopts Long options to be recognized\n" - -n, --name=progname The name under which errors are reported\n" - -o, --options=optstring Short options to be recognized\n" - -q, --quiet Disable error reporting by getopt(3)\n" - -Q, --quiet-output No normal output\n" - -s, --shell=shell Set shell quoting conventions\n" - -T, --test Test for getopt(1) version\n" - -u, --unqote Do not quote the output\n" + -a, --alternative Allow long options starting with single - + -l, --longoptions=longopts Long options to be recognized + -n, --name=progname The name under which errors are reported + -o, --options=optstring Short options to be recognized + -q, --quiet Disable error reporting by getopt(3) + -Q, --quiet-output No normal output + -s, --shell=shell Set shell quoting conventions + -T, --test Test for getopt(1) version + -u, --unqote Do not quote the output Example: - $ cat getopt.test - #!/bin/sh - GETOPT=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \ - -n 'example.busybox' -- "$@"` - if [ $? != 0 ] ; then exit 1 ; fi - eval set -- "$GETOPT" - while true ; do - case $1 in - -a|--a-long) echo "Option a" ; shift ;; - -b|--b-long) echo "Option b, argument \`$2'" ; shift 2 ;; - -c|--c-long) - case "$2" in - "") echo "Option c, no argument"; shift 2 ;; - *) echo "Option c, argument \`$2'" ; shift 2 ;; - esac ;; - --) shift ; break ;; - *) echo "Internal error!" ; exit 1 ;; - esac - done +$ cat getopt.test +GETOPT=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \ + -n 'example.busybox' -- $@` +if [ $? != 0 ] ; then exit 1 ; fi +eval set -- $GETOPT +while true ; do + case $1 in + -a|--a-long) echo Option a ; shift ;; + -b|--b-long) echo Option b, argument `$2' ; shift 2 ;; + -c|--c-long) + case $2 in + \) echo Option c, no argument; shift 2 ;; + *) echo Option c, argument `$2' ; shift 2 ;; + esac ;; + --) shift ; break ;; + *) echo Internal error! ; exit 1 ;; + esac +done ------------------------------- -=item grep +=item I<grep> -Usage: grep [OPTIONS]... PATTERN [FILE]... +grep [B<-ihHnqvs>] pattern [files...] Search for PATTERN in each FILE or standard input. Options: - -h suppress the prefixing filename on output - -i ignore case distinctions - -n print line number with output lines - -q be quiet. Returns 0 if result was found, 1 otherwise - -v select non-matching lines - -This version of grep matches full regular expressions. + -H prefix output lines with filename where match was found + -h suppress the prefixing filename on output + -i ignore case distinctions + -n print line number with output lines + -q be quiet. Returns 0 if result was found, 1 otherwise + -v select non-matching lines + -s suppress file open/read error messages Example: - $ grep root /etc/passwd - root:x:0:0:root:/root:/bin/bash - $ grep ^[rR]oo. /etc/passwd - root:x:0:0:root:/root:/bin/bash +$ grep root /etc/passwd +root:x:0:0:root:/root:/bin/bash +$ grep ^[rR]oo. /etc/passwd +root:x:0:0:root:/root:/bin/bash + ------------------------------- -=item gunzip +=item I<gunzip> -Usage: gunzip [OPTION]... FILE +gunzip [OPTION]... FILE Uncompress FILE (or standard input if FILE is '-'). Options: - -c Write output to standard output - -t Test compressed file integrity + -c Write output to standard output + -t Test compressed file integrity Example: - $ ls -la /tmp/BusyBox* - -rw-rw-r-- 1 andersen andersen 557009 Apr 11 10:55 /tmp/BusyBox-0.43.tar.gz - $ gunzip /tmp/BusyBox-0.43.tar.gz - $ ls -la /tmp/BusyBox* - -rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar +$ ls -la /tmp/BusyBox* +-rw-rw-r-- 1 andersen andersen 557009 Apr 11 10:55 /tmp/BusyBox-0.43.tar.gz +$ gunzip /tmp/BusyBox-0.43.tar.gz +$ ls -la /tmp/BusyBox* +-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar + ------------------------------- -=item gzip +=item I<gzip> -Usage: gzip [OPTION]... FILE +gzip [OPTION]... FILE Compress FILE with maximum compression. When FILE is '-', reads standard input. Implies B<-c>. Options: - -c Write output to standard output instead of FILE.gz - -d decompress + -c Write output to standard output instead of FILE.gz + -d decompress Example: - $ ls -la /tmp/BusyBox* - -rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar - $ gzip /tmp/BusyBox-0.43.tar - $ ls -la /tmp/BusyBox* - -rw-rw-r-- 1 andersen andersen 554058 Apr 14 17:49 /tmp/BusyBox-0.43.tar.gz +$ ls -la /tmp/BusyBox* +-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar +$ gzip /tmp/BusyBox-0.43.tar +$ ls -la /tmp/BusyBox* +-rw-rw-r-- 1 andersen andersen 554058 Apr 14 17:49 /tmp/BusyBox-0.43.tar.gz ------------------------------- -=item halt +=item I<halt> -Usage: halt +halt -This command halts the system. +Halt the system. ------------------------------- -=item head +=item I<head> -Usage: head [OPTION] [FILE]... +head [OPTION] [FILE]... Print first 10 lines of each FILE to standard output. With more than one FILE, precede each with a header giving the @@ -822,68 +845,90 @@ file name. With no FILE, or when FILE is -, read standard input. Options: - -n NUM Print first NUM lines instead of first 10 + -n NUM Print first NUM lines instead of first 10 Example: - $ head -n 2 /etc/passwd - root:x:0:0:root:/root:/bin/bash - daemon:x:1:1:daemon:/usr/sbin:/bin/sh +$ head -n 2 /etc/passwd +root:x:0:0:root:/root:/bin/bash +daemon:x:1:1:daemon:/usr/sbin:/bin/sh + ------------------------------- -=item hostid +=item I<hostid> -Usage: hostid +hostid -Prints out a unique 32-bit identifier for the current -machine. The 32-bit identifier is intended to be unique -among all UNIX systems in existence. +Print out a unique 32-bit identifier for the machine. ------------------------------- -=item hostname +=item I<hostname> -Usage: hostname [OPTION] {hostname | B<-F> file} +hostname [OPTION] {hostname | B<-F> file} Get or set the hostname or DNS domain name. If a hostname is given (or a file with the B<-F> parameter), the host name will be set. Options: - -s Short - -i Addresses for the hostname - -d DNS domain name - -F, --file FILE Use the contents of FILE to specify the hostname + -s Short + -i Addresses for the hostname + -d DNS domain name + -F, --file FILE Use the contents of FILE to specify the hostname Example: - $ hostname - slag +$ hostname +slag + ------------------------------- -=item id +=item I<id> + +id [OPTIONS]... [USERNAME] Print information for USERNAME or the current user Options: - -g prints only the group ID - -u prints only the user ID - -n print a name instead of a number (with for -ug) - -r prints the real user ID instead of the effective ID (with -ug) + -g prints only the group ID + -u prints only the user ID + -n print a name instead of a number (with for -ug) + -r prints the real user ID instead of the effective ID (with -ug) Example: - $ id - uid=1000(andersen) gid=1000(andersen) +$ id +uid=1000(andersen) gid=1000(andersen) + ------------------------------- -=item init +=item I<ifconfig> + +ifconfig [B<-a>] <interface> [<address>] + +configure a network interface + +Options: + + [[-]broadcast [<address>]] [[-]pointopoint [<address>]] + [netmask <address>] [dstaddr <address>] + [outfill <NN>] [keepalive <NN>] + [hw ether <address>] [metric <NN>] [mtu <NN>] + [[-]trailers] [[-]arp] [[-]allmulti] + [multicast] [[-]promisc] [txqueuelen <NN>] [[-]dynamic] + [mem_start <NN>] [io_addr <NN>] [irq <NN>] + [up|down] ... + +------------------------------- -Usage: init +=item I<init> + +init Init is the parent of all processes. @@ -912,7 +957,7 @@ If you choose to use an /etc/inittab file, the inittab entry format is as follow WARNING: This field has a non-traditional meaning for BusyBox init! The id field is used by BusyBox init to specify the controlling tty for the specified process to run on. The contents of this field are - appended to "/dev/" and used as-is. There is no need for this field to + appended to /dev/ and used as-is. There is no need for this field to be unique, although if it isn't you may have strange results. If this field is left blank, the controlling tty is set to the console. Also note that if BusyBox detects that a serial console is in use, then only @@ -929,7 +974,6 @@ If you choose to use an /etc/inittab file, the inittab entry format is as follow Valid actions include: sysinit, respawn, askfirst, wait, once, and ctrlaltdel. - The available actions can be classified into two groups: actions that are run only once, and actions that are re-run when the specified process exits. @@ -953,7 +997,7 @@ If you choose to use an /etc/inittab file, the inittab entry format is as follow it. Unlike sysvinit, BusyBox init does not stop processes from respawning out of control. The 'askfirst' actions acts just like respawn, except that before running the specified process it - displays the line "Please press Enter to activate this console." + displays the line Please press Enter to activate this console. and then waits for the user to press enter before starting the specified process. @@ -965,541 +1009,612 @@ If you choose to use an /etc/inittab file, the inittab entry format is as follow Specifies the process to be executed and it's command line. - Example /etc/inittab file: - - # This is run first except when booting in single-user mode. - # ::sysinit:/etc/init.d/rcS - - # /bin/sh invocations on selected ttys - # - # Start an "askfirst" shell on the console (whatever that may be) - ::askfirst:-/bin/sh - # Start an "askfirst" shell on /dev/tty2-4 - tty2::askfirst:-/bin/sh + + ::askfirst:-/bin/sh + tty2::askfirst:-/bin/sh tty3::askfirst:-/bin/sh tty4::askfirst:-/bin/sh - - # /sbin/getty invocations for selected ttys - # + tty4::respawn:/sbin/getty 38400 tty5 tty5::respawn:/sbin/getty 38400 tty6 - - - # Example of how to put a getty on a serial line (for a terminal) - # - #::respawn:/sbin/getty -L ttyS0 9600 vt100 - #::respawn:/sbin/getty -L ttyS1 9600 vt100 - # - # Example how to put a getty on a modem line. - #::respawn:/sbin/getty 57600 ttyS2 - - # Stuff to do before rebooting - ::ctrlaltdel:/bin/umount -a -r + + + + ::ctrlaltdel:/bin/umount -a -r ::ctrlaltdel:/sbin/swapoff -a + ------------------------------- -=item insmod +=item I<insmod> -Usage: insmod [OPTION]... MODULE [symbol=value]... +insmod [OPTION]... MODULE [symbol=value]... Loads the specified kernel modules into the kernel. Options: - -f Force module to load into the wrong kernel version. - -k Make module autoclean-able. - -v verbose output - -x do not export externs - -L Prevent simultaneous loads of the same module + -f Force module to load into the wrong kernel version. + -k Make module autoclean-able. + -v verbose output + -L Lock to prevent simultaneous loads of a module + -x do not export externs ------------------------------- -=item kill +=item I<kill> -Usage: kill [B<-signal>] process-id [process-id ...] +kill [B<-signal>] process-id [process-id ...] Send a signal (default is SIGTERM) to the specified process(es). Options: - -l List all signal names and numbers. + -l List all signal names and numbers. Example: - $ ps | grep apache - 252 root root S [apache] - 263 www-data www-data S [apache] - 264 www-data www-data S [apache] - 265 www-data www-data S [apache] - 266 www-data www-data S [apache] - 267 www-data www-data S [apache] - $ kill 252 +$ ps | grep apache +252 root root S [apache] +263 www-data www-data S [apache] +264 www-data www-data S [apache] +265 www-data www-data S [apache] +266 www-data www-data S [apache] +267 www-data www-data S [apache] +$ kill 252 + ------------------------------- -=item killall +=item I<killall> -Usage: killall [B<-signal>] process-name [process-name ...] +killall [B<-signal>] process-name [process-name ...] Send a signal (default is SIGTERM) to the specified process(es). Options: - -l List all signal names and numbers. + -l List all signal names and numbers. Example: - $ killall apache +$ killall apache + + +------------------------------- + +=item I<klogd> + +klogd B<-n> + +Kernel logger. +Options: + + -n Run as a foreground process. ------------------------------- -=item length +=item I<length> -Usage: length STRING +length STRING Prints out the length of the specified STRING. Example: - $ length "Hello" - 5 +$ length Hello +5 + ------------------------------- -=item ln +=item I<ln> -Usage: ln [OPTION] TARGET... LINK_NAME|DIRECTORY +ln [OPTION] TARGET... LINK_NAME|DIRECTORY Create a link named LINK_NAME or DIRECTORY to the specified TARGET + You may use '--' to indicate that all following arguments are non-options. Options: -s make symbolic links instead of hard links -f remove existing destination files + -n no dereference symlinks - treat like normal file Example: - $ ln -s BusyBox /tmp/ls - $ ls -l /tmp/ls - lrwxrwxrwx 1 root root 7 Apr 12 18:39 ls -> BusyBox* +$ ln -s BusyBox /tmp/ls +$ ls -l /tmp/ls +lrwxrwxrwx 1 root root 7 Apr 12 18:39 ls -> BusyBox* + ------------------------------- -=item loadacm +=item I<loadacm> -Usage: loadacm +loadacm < mapfile Loads an acm from standard input. Example: - $ loadacm < /etc/i18n/acmname +$ loadacm < /etc/i18n/acmname + ------------------------------- -=item loadfont +=item I<loadfont> -Usage: loadfont +loadfont < font Loads a console font from standard input. Example: - $ loadfont < /etc/i18n/fontname +$ loadfont < /etc/i18n/fontname + ------------------------------- -=item loadkmap +=item I<loadkmap> -Usage: loadkmap +loadkmap < keymap Loads a binary keyboard translation table from standard input. Example: - $ loadkmap < /etc/i18n/lang-keymap +$ loadkmap < /etc/i18n/lang-keymap + ------------------------------- -=item logger +=item I<logger> -Usage: logger [OPTION]... [MESSAGE] +logger [OPTION]... [MESSAGE] Write MESSAGE to the system log. If MESSAGE is omitted, log stdin. Options: - -s Log to stderr as well as the system log. - -t Log using the specified tag (defaults to user name). - -p Enter the message with the specified priority. - This may be numerical or a ``facility.level'' pair. + -s Log to stderr as well as the system log. + -t Log using the specified tag (defaults to user name). + -p Enter the message with the specified priority. + This may be numerical or a ``facility.level'' pair. Example: - $ logger "hello" +$ logger hello + ------------------------------- -=item logname +=item I<logname> -Usage: logname +logname Print the name of the current user. Example: - $ logname - root +$ logname +root + ------------------------------- -=item ls +=item I<logread> + +logread + +Shows the messages from syslogd (using circular buffer). + +------------------------------- + +=item I<ls> + +ls [B<-1AacCdeFilnpLRrSsTtuvwxXhk>] [filenames...] -Usage: ls [B<-1acdelnpuxACFLR>] [filenames...] +List directory contents Options: + -1 list files in a single column + -A do not list implied . and .. -a do not hide entries starting with . - -c with -l: show ctime (the time of last - modification of file status information) + -C list entries by columns + -c with -l: show ctime -d list directory entries instead of contents -e list both full date and full time + -F append indicator (one of */=@|) to entries + -i list the i-node for each file -l use a long listing format -n list numeric UIDs and GIDs instead of names -p append indicator (one of /=@|) to entries - -u with -l: show access time (the time of last - access of the file) + -L list entries pointed to by symbolic links + -R list subdirectories recursively + -r sort the listing in reverse order + -S sort the listing by file size + -s list the size of each file, in blocks + -T NUM assume Tabstop every NUM columns + -t with -l: show modification time + -u with -l: show access time + -v sort the listing by version + -w NUM assume the terminal is NUM columns wide -x list entries by lines instead of by columns - -A do not list implied . and .. - -C list entries by columns - -F append indicator (one of */=@|) to entries - -R list subdirectories recursively - -L list entries pointed to by symbolic links + -X sort the listing by extension + -h print sizes in human readable format (e.g., 1K 243M 2G ) + -k print sizes in kilobytes(default) ------------------------------- -=item lsmod +=item I<lsmod> -Usage: lsmod +lsmod -Shows a list of all currently loaded kernel modules. +List the currently loaded kernel modules. ------------------------------- -=item makedevs +=item I<makedevs> -Usage: makedevs NAME TYPE MAJOR MINOR FIRST LAST [s] +makedevs NAME TYPE MAJOR MINOR FIRST LAST [s] Creates a range of block or character special files TYPEs include: - b: Make a block (buffered) device. - c or u: Make a character (un-buffered) device. - p: Make a named pipe. MAJOR and MINOR are ignored for named pipes. + b: Make a block (buffered) device. + c or u: Make a character (un-buffered) device. + p: Make a named pipe. MAJOR and MINOR are ignored for named pipes. FIRST specifies the number appended to NAME to create the first device. LAST specifies the number of the last item that should be created. If 's' is the last argument, the base device is created as well. +For example: + + makedevs /dev/ttyS c 4 66 2 63 -> ttyS2-ttyS63 + makedevs /dev/hda b 3 0 0 8 s -> hda,hda1-hda8 + Example: - $ makedevs /dev/ttyS c 4 66 2 63 - [creates ttyS2-ttyS63] - $ makedevs /dev/hda b 3 0 0 8 s - [creates hda,hda1-hda8] +$ makedevs /dev/ttyS c 4 66 2 63 +[creates ttyS2-ttyS63] +$ makedevs /dev/hda b 3 0 0 8 s +[creates hda,hda1-hda8] + ------------------------------- -=item md5sum +=item I<md5sum> -Usage: md5sum [OPTION] [file ...] +md5sum [OPTION] [FILE]... +or: md5sum [OPTION] B<-c> [FILE] Print or check MD5 checksums. Options: +With no FILE, or when FILE is -, read standard input. - -b read files in binary mode - -c check MD5 sums against given list - -t read files in text mode (default) - -g read a string + -b read files in binary mode + -c check MD5 sums against given list + -t read files in text mode (default) + -g read a string The following two options are useful only when verifying checksums: - -s don't output anything, status code shows success - -w warn about improperly formated MD5 checksum lines + -s don't output anything, status code shows success + -w warn about improperly formated MD5 checksum lines Example: - $ md5sum busybox - 6fd11e98b98a58f64ff3398d7b324003 busybox - $ md5sum -c - - 6fd11e98b98a58f64ff3398d7b324003 busybox - busybox: OK - ^D +$ md5sum < busybox +6fd11e98b98a58f64ff3398d7b324003 +$ md5sum busybox +6fd11e98b98a58f64ff3398d7b324003 busybox +$ md5sum -c - +6fd11e98b98a58f64ff3398d7b324003 busybox +busybox: OK +^D + ------------------------------- -=item mkdir +=item I<mkdir> -Usage: mkdir [OPTION] DIRECTORY... +mkdir [OPTION] DIRECTORY... Create the DIRECTORY(ies), if they do not already exist Options: - -m set permission mode (as in chmod), not rwxrwxrwx - umask - -p no error if directory exists, make parent directories as needed + -m set permission mode (as in chmod), not rwxrwxrwx - umask + -p no error if existing, make parent directories as needed Example: - $ mkdir /tmp/foo - $ mkdir /tmp/foo - /tmp/foo: File exists - $ mkdir /tmp/foo/bar/baz - /tmp/foo/bar/baz: No such file or directory - $ mkdir -p /tmp/foo/bar/baz +$ mkdir /tmp/foo +$ mkdir /tmp/foo +/tmp/foo: File exists +$ mkdir /tmp/foo/bar/baz +/tmp/foo/bar/baz: No such file or directory +$ mkdir -p /tmp/foo/bar/baz + ------------------------------- -=item mkfifo +=item I<mkfifo> -Usage: mkfifo [OPTIONS] name +mkfifo [OPTIONS] name Creates a named pipe (identical to 'mknod name p') Options: - -m create the pipe using the specified mode (default a=rw) + -m create the pipe using the specified mode (default a=rw) ------------------------------- -=item mkfs.minix +=item I<mkfs_minix> -Usage: mkfs.minix [B<-c> | B<-l> filename] [B<-nXX>] [B<-iXX>] /dev/name [blocks] +mkfs_minix [B<-c> | B<-l> filename] [B<-nXX>] [B<-iXX>] /dev/name [blocks] Make a MINIX filesystem. Options: - -c Check the device for bad blocks - -n [14|30] Specify the maximum length of filenames - -i Specify the number of inodes for the filesystem - -l FILENAME Read the bad blocks list from FILENAME - -v Make a Minix version 2 filesystem + -c Check the device for bad blocks + -n [14|30] Specify the maximum length of filenames + -i INODES Specify the number of inodes for the filesystem + -l FILENAME Read the bad blocks list from FILENAME + -v Make a Minix version 2 filesystem ------------------------------- -=item mknod +=item I<mknod> -Usage: mknod [OPTIONS] NAME TYPE MAJOR MINOR +mknod [OPTIONS] NAME TYPE MAJOR MINOR Create a special file (block, character, or pipe). Options: - -m create the special file using the specified mode (default a=rw) + -m create the special file using the specified mode (default a=rw) TYPEs include: - b: Make a block (buffered) device. - c or u: Make a character (un-buffered) device. - p: Make a named pipe. MAJOR and MINOR are ignored for named pipes. + + b: Make a block (buffered) device. + c or u: Make a character (un-buffered) device. + p: Make a named pipe. MAJOR and MINOR are ignored for named pipes. Example: - $ mknod /dev/fd0 b 2 0 - $ mknod -m 644 /tmp/pipe p +$ mknod /dev/fd0 b 2 0 +$ mknod -m 644 /tmp/pipe p + ------------------------------- -=item mkswap +=item I<mkswap> -Usage: mkswap [B<-c>] [B<-v0>|B<-v1>] device [block-count] +mkswap [B<-c>] [B<-v0>|B<-v1>] device [block-count] Prepare a disk partition to be used as a swap partition. Options: - -c Check for read-ability. - -v0 Make version 0 swap [max 128 Megs]. - -v1 Make version 1 swap [big!] (default for kernels > 2.1.117). - block-count Number of block to use (default is entire partition). + -c Check for read-ability. + -v0 Make version 0 swap [max 128 Megs]. + -v1 Make version 1 swap [big!] (default for kernels > + 2.1.117). + block-count Number of block to use (default is entire partition). ------------------------------- -=item mktemp +=item I<mktemp> -Usage: mktemp [B<-q>] TEMPLATE +mktemp [B<-q>] TEMPLATE Creates a temporary file with its name based on TEMPLATE. TEMPLATE is any name with six `Xs' (i.e. /tmp/temp.XXXXXX). Example: - $ mktemp /tmp/temp.XXXXXX - /tmp/temp.mWiLjM - $ ls -la /tmp/temp.mWiLjM - -rw------- 1 andersen andersen 0 Apr 25 17:10 /tmp/temp.mWiLjM +$ mktemp /tmp/temp.XXXXXX +/tmp/temp.mWiLjM +$ ls -la /tmp/temp.mWiLjM +-rw------- 1 andersen andersen 0 Apr 25 17:10 /tmp/temp.mWiLjM + ------------------------------- -=item more +=item I<more> -Usage: more [file ...] +more [FILE ...] -More is a filter for paging through text one screenful at a time. +More is a filter for viewing FILE one screenful at a time. Example: - $ dmesg | more +$ dmesg | more + ------------------------------- -=item mount +=item I<mount> + +mount [flags] device directory [B<-o> options,more-options] -Usage: mount [flags] - mount [flags] device directory [B<-o> options,more-options] +Mount a filesystem Flags: - -a: Mount all file systems in fstab. - -o option: One of many filesystem options, listed below. - -r: Mount the filesystem read-only. - -t fs-type: Specify the filesystem type. - -w: Mount for reading and writing (default). + -a: Mount all filesystems in fstab. + -f: Fake Add entry to mount table but don't mount it. + -n: Don't write a mount table entry. + -o option: One of many filesystem options, listed below. + -r: Mount the filesystem read-only. + -t fs-type: Specify the filesystem type. + -w: Mount for reading and writing (default). -Options for use with the "B<-o>" flag: +Options for use with the B<-o> flag: - async/sync: Writes are asynchronous / synchronous. - atime/noatime: Enable / disable updates to inode access times. - dev/nodev: Allow use of special device files / disallow them. - exec/noexec: Allow use of executable files / disallow them. - loop: Mounts a file via loop device. - suid/nosuid: Allow set-user-id-root programs / disallow them. - remount: Re-mount a currently-mounted filesystem, changing its flags. - ro/rw: Mount for read-only / read-write. - There are EVEN MORE flags that are specific to each filesystem. - You'll have to see the written documentation for those. + async/sync: Writes are asynchronous / synchronous. + atime/noatime: Enable / disable updates to inode access times. + dev/nodev: Allow use of special device files / disallow them. + exec/noexec: Allow use of executable files / disallow them. + loop: Mounts a file via loop device. + suid/nosuid: Allow set-user-id-root programs / disallow them. + remount: Re-mount a mounted filesystem, changing its flags. + ro/rw: Mount for read-only / read-write. + +There are EVEN MORE flags that are specific to each filesystem. +You'll have to see the written documentation for those. Example: - $ mount - /dev/hda3 on / type minix (rw) - proc on /proc type proc (rw) - devpts on /dev/pts type devpts (rw) - $ mount /dev/fd0 /mnt -t msdos -o ro - $ mount /tmp/diskimage /opt -t ext2 -o loop +$ mount +/dev/hda3 on / type minix (rw) +proc on /proc type proc (rw) +devpts on /dev/pts type devpts (rw) +$ mount /dev/fd0 /mnt -t msdos -o ro +$ mount /tmp/diskimage /opt -t ext2 -o loop + ------------------------------- -=item mt +=item I<mt> -Usage: mt [B<-f> device] opcode value +mt [B<-f> device] opcode value Control magnetic tape drive operation -------------------------------- +Available Opcodes: + +bsf bsfm bsr bss datacompression drvbuffer eof eom erase +fsf fsfm fsr fss load lock mkpart nop offline ras1 ras2 +ras3 reset retension rew rewoffline seek setblk setdensity +setpart tell unload unlock weof wset -=item mv +------------------------------- -Usage: mv SOURCE DEST +=item I<mv> - or: mv SOURCE... DIRECTORY +mv SOURCE DEST +or: mv SOURCE... DIRECTORY Rename SOURCE to DEST, or move SOURCE(s) to DIRECTORY. Example: - $ mv /tmp/foo /bin/bar +$ mv /tmp/foo /bin/bar + ------------------------------- -=item nc +=item I<nc> -Usage: nc [IP] [port] +nc [IP] [port] Netcat opens a pipe to IP:port Example: - $ nc foobar.somedomain.com 25 - 220 foobar ESMTP Exim 3.12 #1 Sat, 15 Apr 2000 00:03:02 -0600 - help - 214-Commands supported: - 214- HELO EHLO MAIL RCPT DATA AUTH - 214 NOOP QUIT RSET HELP - quit - 221 foobar closing connection +$ nc foobar.somedomain.com 25 +220 foobar ESMTP Exim 3.12 help +214-Commands supported: +214- HELO EHLO MAIL RCPT DATA AUTH +214 NOOP QUIT RSET HELP +quit +221 foobar closing connection + ------------------------------- -=item nslookup +=item I<nslookup> -Usage: nslookup [HOST] +nslookup [HOST] Queries the nameserver for the IP address of the given HOST Example: - $ nslookup localhost - Server: default - Address: default +$ nslookup localhost +Server: default +Address: default - Name: debian - Address: 127.0.0.1 +Name: debian +Address: 127.0.0.1 + ------------------------------- -=item ping +=item I<ping> -Usage: ping [OPTION]... host +ping [OPTION]... host Send ICMP ECHO_REQUEST packets to network hosts. Options: - -c COUNT Send only COUNT pings. + -c COUNT Send only COUNT pings. -s SIZE Send SIZE data bytes in packets (default=56). - -q Quiet mode, only displays output at start - and when finished. + -q Quiet mode, only displays output at start + and when finished. + Example: - $ ping localhost - PING slag (127.0.0.1): 56 data bytes - 64 bytes from 127.0.0.1: icmp_seq=0 ttl=255 time=20.1 ms +$ ping localhost +PING slag (127.0.0.1): 56 data bytes +64 bytes from 127.0.0.1: icmp_seq=0 ttl=255 time=20.1 ms - --- debian ping statistics --- - 1 packets transmitted, 1 packets received, 0% packet loss - round-trip min/avg/max = 20.1/20.1/20.1 ms +--- debian ping statistics --- +1 packets transmitted, 1 packets received, 0% packet loss +round-trip min/avg/max = 20.1/20.1/20.1 ms + ------------------------------- -=item poweroff +=item I<pivot_root> -Shuts down the system, and requests that the kernel turn off power upon halting. +pivot_root new_root put_old + +Move the current root file system to put_old and make new_root +the new root file system. ------------------------------- -=item printf +=item I<poweroff> + +poweroff + +Halt the system and request that the kernel shut off the power. + +------------------------------- -Usage: printf format [argument...] +=item I<printf> -Formats and prints the given data in a manner similar to the C printf command. +printf FORMAT [ARGUMENT...] + +Formats and prints ARGUMENT(s) according to FORMAT, +Where FORMAT controls the output exactly as in C printf. Example: - $ printf "Val=%d\n" 5 - Val=5 +$ printf Val=%d + 5 +Val=5 + ------------------------------- -=item ps +=item I<ps> -Usage: ps +ps Report process status @@ -1507,7 +1622,7 @@ This version of ps accepts no options. Example: - $ ps +$ ps PID Uid Gid State Command 1 root root S init 2 root root S [kflushd] @@ -1519,141 +1634,161 @@ Example: 745 root root S [getty] 2990 andersen andersen R ps + ------------------------------- -=item pwd +=item I<pwd> + +pwd -Prints the full filename of the current working directory. +Print the full filename of the current working directory. Example: - $ pwd - /root +$ pwd +/root + ------------------------------- -=item rdate +=item I<rdate> -Usage: rdate [OPTION] HOST +rdate [OPTION] HOST Get and possibly set the system date and time from a remote HOST. Options: - -s Set the system date and time (default). - -p Print the date and time. + -s Set the system date and time (default). + -p Print the date and time. ------------------------------- -=item reboot +=item I<readlink> + +readlink -Instructs the kernel to reboot the system. +Read a symbolic link. ------------------------------- -=item renice +=item I<reboot> -Usage: renice priority pid [pid ...] +reboot + +Reboot the system. + +------------------------------- + +=item I<renice> + +renice priority pid [pid ...] Changes priority of running processes. Allowed priorities range from 20 (the process runs only when nothing else is running) to 0 -(default priority) to -20 (almost nothing else ever gets to run). +(default priority) to B<-20> (almost nothing else ever gets to run). ------------------------------- -=item reset +=item I<reset> -Usage: reset +reset Resets the screen. ------------------------------- -=item rm +=item I<rm> -Usage: rm [OPTION]... FILE... +rm [OPTION]... FILE... -Remove (unlink) the FILE(s). You may use '--' to +Remove (unlink) the FILE(s). You may use '--' to indicate that all following arguments are non-options. Options: - -f remove existing destinations, never prompt - -r or -R remove the contents of directories recursively + -i always prompt before removing each destinations + -f remove existing destinations, never prompt + -r or -R remove the contents of directories recursively Example: - $ rm -rf /tmp/foo +$ rm -rf /tmp/foo + ------------------------------- -=item rmdir +=item I<rmdir> -Usage: rmdir [OPTION]... DIRECTORY... +rmdir [OPTION]... DIRECTORY... Remove the DIRECTORY(ies), if they are empty. Example: - # rmdir /tmp/foo + ------------------------------- -=item rmmod +=item I<rmmod> -Usage: rmmod [OPTION]... [MODULE]... +rmmod [OPTION]... [MODULE]... Unloads the specified kernel modules from the kernel. Options: - -a Try to remove all unused kernel modules. + -a Try to remove all unused kernel modules. Example: - $ rmmod tulip +$ rmmod tulip + ------------------------------- -=item sed +=item I<route> + +route [{add|del|flush}] -Usage: sed [B<-n>] B<-e> script [file...] +Edit the kernel's routing tables -Allowed sed scripts come in the following form: +------------------------------- + +=item I<rpmunpack> - 'ADDR [!] COMMAND' +rpmunpack < package.rpm | gunzip | cpio B<-idmuv> + +Extracts an rpm archive. - where address ADDR can be: - NUMBER Match specified line number - $ Match last line - /REGEXP/ Match specified regexp - (! inverts the meaning of the match) +------------------------------- - and COMMAND can be: - s/regexp/replacement/[igp] - which attempt to match regexp against the pattern space - and if successful replaces the matched portion with replacement. +=item I<sed> - aTEXT - which appends TEXT after the pattern space +sed [B<-Vhnef>] pattern [files...] Options: - -e add the script to the commands to be executed - -n suppress automatic printing of pattern space + -n suppress automatic printing of pattern space + -e script add the script to the commands to be executed + -f scriptfile add the contents of script-file to the commands to be executed + -h display this help message -This version of sed matches full regular expressions. +If no B<-e> or B<-f> is given, the first non-option argument is taken as the +sed script to interpret. All remaining arguments are names of input +files; if no input files are specified, then the standard input is read. Example: - $ echo "foo" | sed -e 's/f[a-zA-Z]o/bar/g' - bar +$ echo foo | sed -e 's/f[a-zA-Z]o/bar/g' +bar + ------------------------------- -=item setkeycodes +=item I<setkeycodes> -Usage: setkeycodes SCANCODE KEYCODE ... +setkeycodes SCANCODE KEYCODE ... Set entries into the kernel's scancode-to-keycode map, allowing unusual keyboards to generate usable keycodes. @@ -1663,116 +1798,141 @@ and KEYCODE is given in decimal Example: - # setkeycodes e030 127 +$ setkeycodes e030 127 + ------------------------------- -=item sh +=item I<sh> -Usage: sh +sh [FILE]... +or: sh B<-c> command [args]... -lash -- the BusyBox LAme SHell (command interpreter) +lash: The BusyBox LAme SHell (command interpreter) -This command does not yet have proper documentation. +This command does not yet have proper documentation. Use lash just as you would use any other shell. It properly handles pipes, -redirects, job control, can be used as the shell for scripts (#!/bin/sh), and -has a sufficient set of builtins to do what is needed. It does not (yet) -support Bourne Shell syntax. If you need things like "if-then-else", "while", -and such, use ash or bash. If you just need a very simple and extremely small -shell, this will do the job. +redirects, job control, can be used as the shell for scripts, and has a +sufficient set of builtins to do what is needed. It does not (yet) support +Bourne Shell syntax. If you need things like if-then-else, while, and such +use ash or bash. If you just need a very simple and extremely small shell, +this will do the job. ------------------------------- -=item sleep +=item I<sleep> -Usage: sleep N +sleep N Pause for N seconds. Example: - $ sleep 2 - [2 second delay results] +$ sleep 2 +[2 second delay results] + ------------------------------- -=item sort +=item I<sort> -Usage: sort [B<-n>] [B<-r>] [FILE]... +sort [B<-n>] [B<-r>] [FILE]... Sorts lines of text in the specified files Example: - $ echo -e "e\nf\nb\nd\nc\na" | sort - a - b - c - d - e - f +$ echo -e e +f +b +d +c +a | sort +a +b +c +d +e +f + ------------------------------- -=item swapoff +=item I<stty> + +stty [B<-a>|g] [B<-F> device] [SETTING]... -Usage: swapoff [OPTION] [device] +Without arguments, prints baud rate, line discipline, +and deviations from stty sane. + +Options: + + -F device open device instead of stdin + -a print all current settings in human-readable form + -g print in stty-readable form + [SETTING] see documentation + +------------------------------- + +=item I<swapoff> + +swapoff [OPTION] [device] Stop swapping virtual memory pages on the given device. Options: - -a Stop swapping on all swap devices + -a Stop swapping on all swap devices ------------------------------- -=item swapon +=item I<swapon> -Usage: swapon [OPTION] [device] +swapon [OPTION] [device] Start swapping virtual memory pages on the given device. Options: - -a Start swapping on all swap devices + -a Start swapping on all swap devices ------------------------------- -=item sync +=item I<sync> -Usage: sync +sync Write all buffered filesystem blocks to disk. ------------------------------- -=item syslogd +=item I<syslogd> -Usage: syslogd [OPTION]... +syslogd [OPTION]... -Linux system and kernel (provides klogd) logging utility. -Note that this version of syslogd/klogd ignores /etc/syslog.conf. +Linux system and kernel logging utility. +Note that this version of syslogd ignores /etc/syslog.conf. Options: - -m NUM Interval between MARK lines (default=20min, 0=off) + -m NUM Interval between MARK lines (default=20min, 0=off) -n Run as a foreground process - -K Do not start up the klogd process - -O FILE Use an alternate log file (default=/var/log/messages) - -R HOST[:PORT] Log remotely to IP or hostname on PORT (default PORT=514/UDP) - -L Log locally as well as network logging (default is network only) + -O FILE Use an alternate log file (default=/var/log/messages) + -R HOST[:PORT] Log to IP or hostname on PORT (default PORT=514/UDP) + -L Log locally and via network logging (default is network only) Example: - $ syslogd -R masterlog:514 - $ syslogd -R 192.168.1.1:601 +$ syslogd -R masterlog:514 +$ syslogd -R 192.168.1.1:601 + ------------------------------- -=item tail +=item I<tail> -Usage: tail [OPTION] [FILE]... +tail [OPTION]... [FILE]... Print last 10 lines of each FILE to standard output. With more than one FILE, precede each with a header giving the @@ -1780,405 +1940,450 @@ file name. With no FILE, or when FILE is -, read standard input. Options: - -n NUM Print last NUM lines instead of first 10 - -f Output data as the file grows. This version - of 'tail -f' supports only one file at a time. + -c N[kbm] output the last N bytes + -n N[kbm] print last N lines instead of last 10 + -f output data as the file grows + -q never output headers giving file names + -s SEC wait SEC seconds between reads with -f + -v always output headers giving file names + +If the first character of N (bytes or lines) is a `+', output begins with +the Nth item from the start of each file, otherwise, print the last N items +in the file. N bytes may be suffixed by k (x1024), b (x512), or m (1024^2). Example: - $ tail -n 1 /etc/resolv.conf - nameserver 10.0.0.1 +$ tail -n 1 /etc/resolv.conf +nameserver 10.0.0.1 + ------------------------------- -=item tar +=item I<tar> -Usage: tar -[cxtvO] [B<--exclude> File] [B<-f> tarFile] [FILE] ... +tar -[cxtvO] [-B<-exclude> File] [B<-X> File][B<-f> tarFile] [FILE(s)] ... -Create, extract, or list files from a tar file. Note that -this version of tar treats hard links as separate files. +Create, extract, or list files from a tar file. Main operation mode: - c create - x extract - t list + c create + x extract + t list File selection: - f name of tarfile or "-" for stdin - O extract to stdout - exclude file to exclude + f name of tarfile or - for stdin + O extract to stdout + exclude file to exclude + X file with names to exclude Informative output: - v verbosely list files processed + v verbosely list files processed Example: - $ zcat /tmp/tarball.tar.gz | tar -xf - - $ tar -cf /tmp/tarball.tar /usr/local +$ zcat /tmp/tarball.tar.gz | tar -xf - +$ tar -cf /tmp/tarball.tar /usr/local + ------------------------------- -=item tee +=item I<tee> -Usage: tee [OPTION]... [FILE]... +tee [OPTION]... [FILE]... Copy standard input to each FILE, and also to standard output. Options: - -a append to the given FILEs, do not overwrite + -a append to the given FILEs, do not overwrite Example: - $ echo "Hello" | tee /tmp/foo - $ cat /tmp/foo - Hello +$ echo Hello | tee /tmp/foo +$ cat /tmp/foo +Hello + ------------------------------- -=item telnet +=item I<telnet> -Usage: telnet host [port] +telnet host [port] Telnet is used to establish interactive communication with another computer over a network using the TELNET protocol. ------------------------------- -=item test, [ +=item I<test> -Usage: test EXPRESSION -or [ EXPRESSION ] +test EXPRESSION + or [ EXPRESSION ] Checks file types and compares values returning an exit code determined by the value of EXPRESSION. Example: - $ test 1 -eq 2 - $ echo $? - 1 - $ test 1 -eq 1 - $ echo $? - 0 - $ [ -d /etc ] - $ echo $? - 0 - $ [ -d /junk ] - $ echo $? - 1 +$ test 1 -eq 2 +$ echo $? +1 +$ test 1 -eq 1 +$ echo $? +0 +$ [ -d /etc ] +$ echo $? +0 +$ [ -d /junk ] +$ echo $? +1 + + +------------------------------- + +=item I<tftp> + +tftp command SOURCE DEST + +Transfers a file from/to a tftp server using octet mode. + +Commands: + + get Get file from server SOURCE and store to local DEST. + put Put local file SOURCE to server DEST. + +When nameing a server, use the syntax server:file. ------------------------------- -=item touch +=item I<touch> + +touch [B<-c>] file [file ...] -Usage: touch [B<-c>] file [file ...] +Update the last-modified date on the given file[s]. + +Options: -Update the last-modified date on (or create) the selected file[s]. + -c Do not create any files Example: - $ ls -l /tmp/foo - /bin/ls: /tmp/foo: No such file or directory - $ touch /tmp/foo - $ ls -l /tmp/foo - -rw-rw-r-- 1 andersen andersen 0 Apr 15 01:11 /tmp/foo +$ ls -l /tmp/foo +/bin/ls: /tmp/foo: No such file or directory +$ touch /tmp/foo +$ ls -l /tmp/foo +-rw-rw-r-- 1 andersen andersen 0 Apr 15 01:11 /tmp/foo + ------------------------------- -=item tr +=item I<tr> -Usage: tr [-cds] STRING1 [STRING2] +tr [B<-cds>] STRING1 [STRING2] Translate, squeeze, and/or delete characters from standard input, writing to standard output. Options: - -c take complement of STRING1 - -d delete input characters coded STRING1 - -s squeeze multiple output characters of STRING2 into one character + -c take complement of STRING1 + -d delete input characters coded STRING1 + -s squeeze multiple output characters of STRING2 into one character Example: - $ echo "gdkkn vnqkc" | tr [a-y] [b-z] - hello world +$ echo gdkkn vnqkc | tr [a-y] [b-z] +hello world + ------------------------------- -=item true +=item I<true> -Returns an exit code of TRUE (0) +true + +Return an exit code of TRUE (0). Example: - $ true - $ echo $? - 0 +$ true +$ echo $? +0 + ------------------------------- -=item tty +=item I<tty> -Usage: tty +tty Print the file name of the terminal connected to standard input. Options: - -s print nothing, only return an exit status + -s print nothing, only return an exit status Example: - $ tty - /dev/tty2 +$ tty +/dev/tty2 + ------------------------------- -=item umount +=item I<umount> + +umount [flags] filesystem|directory -Usage: umount [flags] filesystem|directory +Unmount file systems Flags: - -a: Unmount all file systems - -r: Try to remount devices as read-only if mount is busy - -f: Force filesystem umount (i.e. unreachable NFS server) - -l: Do not free loop device (if a loop device has been used) + -a: Unmount all file systems in /etc/mtab + -n: Don't erase /etc/mtab entries + -r: Try to remount devices as read-only if mount is busy + -f: Force filesystem umount (i.e. unreachable NFS server) + -l: Do not free loop device (if a loop device has been used) Example: - $ umount /dev/hdc1 +$ umount /dev/hdc1 + ------------------------------- -=item uname +=item I<uname> -Usage: uname [OPTION]... +uname [OPTION]... Print certain system information. With no OPTION, same as B<-s>. Options: - -a print all information - -m the machine (hardware) type - -n print the machine's network node hostname - -r print the operating system release - -s print the operating system name - -p print the host processor type - -v print the operating system version + -a print all information + -m the machine (hardware) type + -n print the machine's network node hostname + -r print the operating system release + -s print the operating system name + -p print the host processor type + -v print the operating system version Example: - $ uname -a - Linux debian 2.2.15pre13 #5 Tue Mar 14 16:03:50 MST 2000 i686 unknown +$ uname -a +Linux debian 2.2.15pre13 ------------------------------- -=item uniq +=item I<uniq> -Usage: uniq [OPTION]... [INPUT [OUTPUT]] +uniq [OPTION]... [INPUT [OUTPUT]] Discard all but one of successive identical lines from INPUT (or standard input), writing to OUTPUT (or standard output). - + Options: - -c prefix lines by the number of occurrences - -d only print duplicate lines - -u only print unique lines + -c prefix lines by the number of occurrences + -d only print duplicate lines + -u only print unique lines Example: - $ echo -e "a\na\nb\nc\nc\na" | sort | uniq - a - b - c - -------------------------------- - -=item unix2dos - -Usage: unix2dos < unixfile > dosfile +$ echo -e a +a +b +c +c +a | sort | uniq +a +b +c -Converts a text file from unix format to dos format. ------------------------------- -=item unrpm +=item I<unix2dos> -Usage: unrpm < package.rpm | gzip B<-d> | cpio -idmuv +unix2dos [option] [file] -Extracts an rpm archive. +See 'dos2unix -B<-help>' for help! ------------------------------- -=item update +=item I<update> -Usage: update [options] +update [options] Periodically flushes filesystem buffers. Options: - -S force use of sync(2) instead of flushing - -s SECS call sync this often (default 30) - -f SECS flush some buffers this often (default 5) + -S force use of sync(2) instead of flushing + -s SECS call sync this often (default 30) + -f SECS flush some buffers this often (default 5) ------------------------------- -=item uptime +=item I<uptime> -Usage: uptime +uptime -Tells how long the system has been running since boot. +Display the time since the last boot. Example: - $ uptime - 1:55pm up 2:30, load average: 0.09, 0.04, 0.00 +$ uptime + 1:55pm up 2:30, load average: 0.09, 0.04, 0.00 + ------------------------------- -=item usleep +=item I<usleep> -Usage: usleep N +usleep N -Pauses for N microseconds. +Pause for N microseconds. Example: - $ usleep 1000000 - [pauses for 1 second] +$ usleep 1000000 +[pauses for 1 second] + ------------------------------- -=item uuencode +=item I<uudecode> -Usage: uuencode [OPTION] [INFILE] REMOTEFILE +uudecode [FILE]... -Uuencode a file. +Uudecode a file that is uuencoded. Options: - -m use base64 encoding as of RFC1521 - -Example: - - $ uuencode busybox busybox - begin 755 busybox - M?T5,1@$!`0````````````(``P`!````L+@$"#0```!0N@,``````#0`(``& - ..... - $ uudecode busybox busybox > busybox.uu - $ + -o FILE direct output to FILE$ uudecode -o busybox busybox.uu +$ ls B<-l> busybox +B<-rwxr>-xr-x 1 ams ams 245264 Jun 7 21:35 busybox + ------------------------------- -=item uudecode +=item I<uuencode> -Usage: uudecode [OPTION] [FILE] +uuencode [OPTION] [INFILE] REMOTEFILE -Uudecode a uuencoded file +Uuencode a file. Options: - -o FILE direct output to FILE + -m use base64 encoding as of RFC1521 Example: - $ uudecode -o busybox busybox.uu - $ ls -l busybox - -rwxr-xr-x 1 ams ams 245264 Jun 7 21:35 busybox +$ uuencode busybox busybox +begin 755 busybox +M?T5,1@$!`0````````````(``P`!````L+@$..... +$ uudecode busybox busybox > busybox.uu +$ + ------------------------------- -=item watchdog +=item I<watchdog> -Usage: watchdog device +watchdog DEV -Periodically writes to watchdog device B<device>. +Periodically write to watchdog device DEV ------------------------------- -=item wc +=item I<wc> -Usage: wc [OPTION]... [FILE]... +wc [OPTION]... [FILE]... Print line, word, and byte counts for each FILE, and a total line if more than one FILE is specified. With no FILE, read standard input. Options: - -c print the byte counts - -l print the newline counts - -L print the length of the longest line - -w print the word counts + -c print the byte counts + -l print the newline counts + -L print the length of the longest line + -w print the word counts Example: - $ wc /etc/passwd - 31 46 1365 /etc/passwd +$ wc /etc/passwd + 31 46 1365 /etc/passwd + ------------------------------- -=item which +=item I<wget> -Usage: which [COMMAND ...] +wget [B<-c>] [B<-O> file] url -Locates a COMMAND. +wget retrieves files via HTTP -Example: +Options: - $ which login - /bin/login + -c continue retrieval of aborted transfers + -O save to filename ('-' for stdout) ------------------------------- -=item whoami +=item I<which> -Usage: whoami +which [COMMAND ...] -Prints the user name associated with the current effective user id. +Locates a COMMAND. Example: - $ whoami - andersen +$ which login +/bin/login + ------------------------------- -=item xargs +=item I<whoami> -Usage: xargs [OPTIONS] [COMMAND] [ARGS...] +whoami -Executes COMMAND on every item given by standard input. +Prints the user name associated with the current effective user id. -Options: +------------------------------- + +=item I<xargs> + +xargs [COMMAND] [ARGS...] + +Executes COMMAND on every item given by standard input. - -t Print the command just before it is run - Example: - $ ls | xargs gzip - $ find . -name '*.c' -print | xargs rm +$ ls | xargs gzip +$ find . -name '*.c' -print | xargs rm + ------------------------------- -=item yes +=item I<yes> -Usage: yes [OPTION]... [STRING]... +yes [OPTION]... [STRING]... Repeatedly outputs a line with all specified STRING(s), or `y'. ------------------------------- -=item zcat +=item I<zcat> + +zcat FILE -This is essentially an alias for invoking "gunzip B<-c>", where -it decompresses the file in question and send the output to stdout. +Uncompress to stdout. ------------------------------- @@ -2330,4 +2535,4 @@ Enrique Zanardi <ezanardi@ull.es> =cut -# $Id: busybox.pod,v 1.89 2001/01/25 23:40:32 andersen Exp $ +# $Id: busybox.pod,v 1.90 2001/03/15 18:14:25 andersen Exp $ @@ -42,7 +42,6 @@ static const int OPT_INFO = (1 << 1); static const int OPT_READMODE = (1 << 2); enum { - CMD_HELP = 0, CMD_FB = 1, CMD_DB = 2, CMD_GEOMETRY = 3, @@ -138,7 +137,6 @@ static struct cmdoptions_t { unsigned char code; } g_cmdoptions[] = { { - "-h", 0, CMD_HELP}, { "-fb", 1, CMD_FB}, { "-db", 1, CMD_DB}, { "-a", 0, CMD_ALL}, { @@ -150,10 +148,8 @@ static struct cmdoptions_t { "-vsync", 1, CMD_VSYNC}, { "-laced", 1, CMD_LACED}, { "-double", 1, CMD_DOUBLE}, { - "-help", 0, CMD_HELP}, { "-n", 0, CMD_CHANGE}, { #ifdef BB_FEATURE_FBSET_FANCY - "-help", 0, CMD_HELP}, { "-all", 0, CMD_ALL}, { "-xres", 1, CMD_XRES}, { "-yres", 1, CMD_YRES}, { @@ -356,8 +352,6 @@ extern int fbset_main(int argc, char **argv) if (argc - 1 < g_cmdoptions[i].param_count) show_usage(); switch (g_cmdoptions[i].code) { - case CMD_HELP: - show_usage(); case CMD_FB: fbdev = argv[1]; break; diff --git a/include/applets.h b/include/applets.h index f85f45720..c8005f830 100644 --- a/include/applets.h +++ b/include/applets.h @@ -135,7 +135,7 @@ APPLET(false, false_main, _BB_DIR_BIN) #endif #ifdef BB_FBSET - APPLET_NOUSAGE("fbset", fbset_main, _BB_DIR_USR_SBIN) + APPLET(fbset, fbset_main, _BB_DIR_USR_SBIN) #endif #ifdef BB_FDFLUSH APPLET(fdflush, fdflush_main, _BB_DIR_BIN) diff --git a/include/usage.h b/include/usage.h index b60f1f911..3d4752cd2 100644 --- a/include/usage.h +++ b/include/usage.h @@ -15,11 +15,21 @@ #define basename_full_usage \ "Strips directory path and suffixes from FILE.\n" \ "If specified, also removes any trailing SUFFIX." +#define basename_example_usage \ + "$ basename /usr/local/bin/foo\n" \ + "foo\n" \ + "$ basename /usr/local/bin/\n" \ + "bin\n" \ + "$ basename /foo/bar.txt .txt\n" \ + "bar" #define cat_trivial_usage \ "[FILE]..." #define cat_full_usage \ "Concatenates FILE(s) and prints them to stdout." +#define cat_example_usage \ + "$ cat /proc/uptime\n" \ + "110716.72 17.67" #define chgrp_trivial_usage \ "[OPTION]... GROUP FILE..." @@ -27,6 +37,12 @@ "Change the group membership of each FILE to GROUP.\n" \ "\nOptions:\n" \ "\t-R\tChanges files and directories recursively." +#define chgrp_example_usage \ + "$ ls -l /tmp/foo\n" \ + "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \ + "$ chgrp root /tmp/foo\n" \ + "$ ls -l /tmp/foo\n" \ + "-r--r--r-- 1 andersen root 0 Apr 12 18:25 /tmp/foo\n" #define chmod_trivial_usage \ "[-R] MODE[,MODE]... FILE..." @@ -35,6 +51,15 @@ "symbols +-= and one or more of the letters rwxst.\n\n" \ "Options:\n" \ "\t-R\tChanges files and directories recursively." +#define chmod_example_usage \ + "$ ls -l /tmp/foo\n" \ + "-rw-rw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n" \ + "$ chmod u+x /tmp/foo\n" \ + "$ ls -l /tmp/foo\n" \ + "-rwxrw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo*\n" \ + "$ chmod 444 /tmp/foo\n" \ + "$ ls -l /tmp/foo\n" \ + "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n" #define chown_trivial_usage \ "[OPTION]... OWNER[<.|:>[GROUP] FILE..." @@ -42,11 +67,27 @@ "Change the owner and/or group of each FILE to OWNER and/or GROUP.\n" \ "\nOptions:\n" \ "\t-R\tChanges files and directories recursively." +#define chown_example_usage \ + "$ ls -l /tmp/foo\n" \ + "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \ + "$ chown root /tmp/foo\n" \ + "$ ls -l /tmp/foo\n" \ + "-r--r--r-- 1 root andersen 0 Apr 12 18:25 /tmp/foo\n" \ + "$ chown root.root /tmp/foo\n" \ + "ls -l /tmp/foo\n" \ + "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n" #define chroot_trivial_usage \ "NEWROOT [COMMAND...]" #define chroot_full_usage \ "Run COMMAND with root directory set to NEWROOT." +#define chroot_example_usage \ + "$ ls -l /bin/ls\n" \ + "lrwxrwxrwx 1 root root 12 Apr 13 00:46 /bin/ls -> /BusyBox\n" \ + "$ mount /dev/hdc1 /mnt -t minix\n" \ + "$ chroot /mnt\n" \ + "$ ls -l /bin/ls\n" \ + "-rwxr-xr-x 1 root root 40816 Feb 5 07:45 /bin/ls*\n" #define chvt_trivial_usage \ "N" @@ -85,6 +126,11 @@ "\t-s\t\tOutput only the lines containing delimiter\n" \ "\t-f N\t\tPrint only these fields\n" \ "\t-n\t\tIgnored" +#define cut_example_usage \ + "$ echo "Hello world" | cut -f 1 -d ' '\n" \ + "Hello\n" \ + "$ echo "Hello world" | cut -f 2 -d ' '\n" \ + "world\n" #define date_trivial_usage \ "[OPTION]... [+FORMAT]" @@ -95,6 +141,9 @@ "\t-d STRING\tdisplay time described by STRING, not `now'\n" \ "\t-s\t\tSets time described by STRING\n" \ "\t-u\t\tPrints or sets Coordinated Universal Time" +#define date_example_usage \ + "$ date\n" \ + "Wed Apr 12 18:52:41 MDT 2000\n" #define dc_trivial_usage \ "expression ..." @@ -102,6 +151,17 @@ "This is a Tiny RPN calculator that understands the\n" \ "following operations: +, -, /, *, and, or, not, eor.\n" \ "i.e. 'dc 2 2 add' -> 4, and 'dc 8 8 \\* 2 2 + /' -> 16" +#define dc_example_usage \ + "$ dc 2 2 +\n" \ + "4\n" \ + "$ dc 8 8 \* 2 2 + /\n" \ + "16\n" \ + "$ dc 0 1 and\n" \ + "0\n" \ + "$ dc 0 1 or\n" \ + "1\n" \ + "$ echo 72 9 div 8 mul | dc\n" \ + "64\n" #define dd_trivial_usage \ "[if=FILE] [of=FILE] [bs=N] [count=N] [skip=N]\n" \ @@ -119,6 +179,10 @@ "\n" \ "Numbers may be suffixed by c (x1), w (x2), b (x512), kD (x1000), k (x1024),\n" \ "MD (x1000000), M (x1048576), GD (x1000000000) or G (x1073741824)." +#define dd_example_usage \ + "$ dd if=/dev/zero of=/dev/ram1 bs=1M count=4\n" \ + "4+0 records in\n" \ + "4+0 records out\n" #define deallocvt_trivial_usage \ "N" @@ -143,11 +207,24 @@ "\t-m\tprint sizes in megabytes\n" \ "\t-k\tprint sizes in kilobytes(default)") USAGE_NOT_HUMAN_READABLE( \ "\n\t-k\tprint sizes in kilobytes(compatability)") +#define df_example_usage \ + "$ df\n" \ + "Filesystem 1k-blocks Used Available Use% Mounted on\n" \ + "/dev/sda3 8690864 8553540 137324 98% /\n" \ + "/dev/sda1 64216 36364 27852 57% /boot\n" \ + "$ df /dev/sda3\n" \ + "Filesystem 1k-blocks Used Available Use% Mounted on\n" \ + "/dev/sda3 8690864 8553540 137324 98% /\n" #define dirname_trivial_usage \ "[FILENAME ...]" #define dirname_full_usage \ "Strips non-directory suffix from FILENAME" +#define dirname_example_usage \ + "$ dirname /tmp/foo\n" \ + "/tmp\n" \ + "$ dirname /tmp/foo/\n" \ + "/tmp\n" #define dmesg_trivial_usage \ "[-c] [-n LEVEL] [-s SIZE]" @@ -184,6 +261,8 @@ "\t-e\tExtract control files to directory\n" \ "\t-x\tExctract packages filesystem tree to directory\n" \ "\t-X\tVerbose extract" +#define dpkg_deb_example_usage \ + "$ dpkg-deb -X ./busybox_0.48-1_i386.deb /tmp\n" #define du_trivial_usage \ "[-ls" USAGE_HUMAN_READABLE("hm") USAGE_NOT_HUMAN_READABLE("") "k] [FILE]..." @@ -198,17 +277,40 @@ "\t-m\tprint sizes in megabytes\n" \ "\t-k\tprint sizes in kilobytes(default)") USAGE_NOT_HUMAN_READABLE( \ "\n\t-k\tprint sizes in kilobytes(compatability)") +#define du_example_usage \ + "$ du\n" \ + "16 ./CVS\n" \ + "12 ./kernel-patches/CVS\n" \ + "80 ./kernel-patches\n" \ + "12 ./tests/CVS\n" \ + "36 ./tests\n" \ + "12 ./scripts/CVS\n" \ + "16 ./scripts\n" \ + "12 ./docs/CVS\n" \ + "104 ./docs\n" \ + "2417 .\n" #define dumpkmap_trivial_usage \ "> keymap" #define dumpkmap_full_usage \ "Prints out a binary keyboard translation table to standard output." +#define dumpkmap_example_usage \ + "$ dumpkmap > keymap\n" #define dutmp_trivial_usage \ "[FILE]" #define dutmp_full_usage \ "Dump utmp file format (pipe delimited) from FILE\n" \ "or stdin to stdout. (i.e. 'dutmp /var/run/utmp')" +#define dutmp_example_usage \ + "$ dutmp /var/run/utmp\n" \ + "8|7||si|||0|0|0|955637625|760097|0\n" \ + "2|0|~|~~|reboot||0|0|0|955637625|782235|0\n" \ + "1|20020|~|~~|runlevel||0|0|0|955637625|800089|0\n" \ + "8|125||l4|||0|0|0|955637629|998367|0\n" \ + "6|245|tty1|1|LOGIN||0|0|0|955637630|998974|0\n" \ + "6|246|tty2|2|LOGIN||0|0|0|955637630|999498|0\n" \ + "7|336|pts/0|vt00andersen|andersen|:0.0|0|0|0|955637763|0|0\n" #define echo_trivial_usage \ "[-neE] [ARG ...]" @@ -218,6 +320,15 @@ "\t-n\tsuppress trailing newline\n" \ "\t-e\tinterpret backslash-escaped characters (i.e. \\t=tab etc)\n" \ "\t-E\tdisable interpretation of backslash-escaped characters" +#define echo_example_usage \ + "$ echo "Erik is cool"\n" \ + "Erik is cool\n" \ + "$ echo -e "Erik\nis\ncool"\n" \ + "Erik\n" \ + "is\n" \ + "cool\n" \ + "$ echo "Erik\nis\ncool"\n" \ + "Erik\nis\ncool\n" #define expr_trivial_usage \ "EXPRESSION" @@ -257,6 +368,24 @@ "" #define false_full_usage \ "Return an exit code of FALSE (1)." +#define false_example_usage \ + "$ false\n" \ + "$ echo $?\n" \ + "1\n" + +#define fbset_trivial_usage \ + "[options] [mode]" +#define fbset_full_usage \ + "Show and modify frame buffer settings" +#define fbset_example_usage \ + "$ fbset\n" \ + "mode "1024x768-76"\n" \ + "\t# D: 78.653 MHz, H: 59.949 kHz, V: 75.694 Hz\n" \ + "\tgeometry 1024 768 1024 768 16\n" \ + "\ttimings 12714 128 32 16 4 128 4\n" \ + "\taccel false\n" \ + "\trgba 5/11,6/5,5/0,0/0\n" \ + "endmode\n" #define fdflush_trivial_usage \ "DEVICE" @@ -293,16 +422,27 @@ "\n\t-perm PERMS\tPermissions match any of (+NNN); all of (-NNN);\n\t\t\tor exactly (NNN)" \ ) USAGE_FIND_MTIME( \ "\n\t-mtime TIME\tModified time is greater than (+N); less than (-N);\n\t\t\tor exactly (N) days") +#define find_example_usage \ + "$ find / -name /etc/passwd\n" \ + "/etc/passwd\n" #define free_trivial_usage \ "" #define free_full_usage \ "Displays the amount of free and used system memory" +#define free_example_usage \ + "$ free\n" \ + " total used free shared buffers\n" \ + " Mem: 257628 248724 8904 59644 93124\n" \ + " Swap: 128516 8404 120112\n" \ + "Total: 386144 257128 129016\n" \ #define freeramdisk_trivial_usage \ "DEVICE" #define freeramdisk_full_usage \ "Frees all memory used by the specified ramdisk." +#define freeramdisk_example_usage \ + "$ freeramdisk /dev/ram2\n" #define fsck_minix_trivial_usage \ "[-larvsmf] /dev/name" @@ -330,6 +470,26 @@ "\t-s, --shell=shell Set shell quoting conventions\n" \ "\t-T, --test Test for getopt(1) version\n" \ "\t-u, --unqote Do not quote the output" +#define getopt_example_usage \ + "$ cat getopt.test\n" \ + "#!/bin/sh\n" \ + "GETOPT=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \\\n" \ + " -n 'example.busybox' -- "$@"`\n" \ + "if [ $? != 0 ] ; then exit 1 ; fi\n" \ + "eval set -- "$GETOPT"\n" \ + "while true ; do\n" \ + " case $1 in\n" \ + " -a|--a-long) echo \"Option a\" ; shift ;;\n" \ + " -b|--b-long) echo \"Option b, argument \`$2'\" ; shift 2 ;;\n" \ + " -c|--c-long)\n" \ + " case "$2" in\n" \ + " \"\") echo \"Option c, no argument\"; shift 2 ;;\n" \ + " *) echo \"Option c, argument \`$2'\" ; shift 2 ;;\n" \ + " esac ;;\n" \ + " --) shift ; break ;;\n" \ + " *) echo \"Internal error!\" ; exit 1 ;;\n" \ + " esac\n" \ + "done\n" #define grep_trivial_usage \ "[-ihHnqvs] pattern [files...]" @@ -343,9 +503,11 @@ "\t-q\tbe quiet. Returns 0 if result was found, 1 otherwise\n" \ "\t-v\tselect non-matching lines\n" \ "\t-s\tsuppress file open/read error messages" - -#define egrep_trivial_usage grep_trivial_usage -#define egrep_full_usage grep_full_usage +#define grep_example_usage \ + "$ grep root /etc/passwd\n" \ + "root:x:0:0:root:/root:/bin/bash\n" \ + "$ grep ^[rR]oo. /etc/passwd\n" \ + "root:x:0:0:root:/root:/bin/bash\n" #define gunzip_trivial_usage \ "[OPTION]... FILE" @@ -354,6 +516,12 @@ "Options:\n" \ "\t-c\tWrite output to standard output\n" \ "\t-t\tTest compressed file integrity" +#define gunzip_example_usage \ + "$ ls -la /tmp/BusyBox*\n" \ + "-rw-rw-r-- 1 andersen andersen 557009 Apr 11 10:55 /tmp/BusyBox-0.43.tar.gz\n" \ + "$ gunzip /tmp/BusyBox-0.43.tar.gz\n" \ + "$ ls -la /tmp/BusyBox*\n" \ + "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar\n" #define gzip_trivial_usage \ "[OPTION]... FILE" @@ -363,6 +531,12 @@ "Options:\n" \ "\t-c\tWrite output to standard output instead of FILE.gz\n" \ "\t-d\tdecompress" +#define gzip_example_usage \ + "$ ls -la /tmp/BusyBox*\n" \ + "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar\n" \ + "$ gzip /tmp/BusyBox-0.43.tar\n" \ + "$ ls -la /tmp/BusyBox*\n" \ + "-rw-rw-r-- 1 andersen andersen 554058 Apr 14 17:49 /tmp/BusyBox-0.43.tar.gz\n" #define halt_trivial_usage \ "" @@ -377,6 +551,10 @@ "file name. With no FILE, or when FILE is -, read standard input.\n\n" \ "Options:\n" \ "\t-n NUM\t\tPrint first NUM lines instead of first 10" +#define head_example_usage \ + "$ head -n 2 /etc/passwd\n" \ + "root:x:0:0:root:/root:/bin/bash\n" \ + "daemon:x:1:1:daemon:/usr/sbin:/bin/sh\n" #define hostid_trivial_usage \ "" @@ -393,6 +571,9 @@ "\t-i\t\tAddresses for the hostname\n" \ "\t-d\t\tDNS domain name\n" \ "\t-F, --file FILE\tUse the contents of FILE to specify the hostname" +#define hostname_example_usage \ + "$ hostname\n" \ + "slag \n" #define id_trivial_usage \ "[OPTIONS]... [USERNAME]" @@ -403,6 +584,9 @@ "\t-u\tprints only the user ID\n" \ "\t-n\tprint a name instead of a number (with for -ug)\n" \ "\t-r\tprints the real user ID instead of the effective ID (with -ug)" +#define id_example_usage \ + "$ id\n" \ + "uid=1000(andersen) gid=1000(andersen)\n" #ifdef BB_FEATURE_IFCONFIG_SLIP #define USAGE_SIOCSKEEPALIVE(a) a @@ -443,8 +627,116 @@ #define init_trivial_usage \ "" #define init_full_usage \ - "Init is the parent of all processes.\n\n" \ - "This version of init is designed to be run only by the kernel." + "Init is the parent of all processes." +#define init_notes_usage \ +"This version of init is designed to be run only by the kernel.\n" \ +"\n" \ +"BusyBox init doesn't support multiple runlevels. The runlevels field of\n" \ +"the /etc/inittab file is completely ignored by BusyBox init. If you want \n" \ +"runlevels, use sysvinit.\n" \ +"\n" \ +"BusyBox init works just fine without an inittab. If no inittab is found, \n" \ +"it has the following default behavior:\n" \ +"\n" \ +" ::sysinit:/etc/init.d/rcS\n" \ +" ::askfirst:/bin/sh\n" \ +"\n" \ +"if it detects that /dev/console is _not_ a serial console, it will also run:\n" \ +"\n" \ +" tty2::askfirst:/bin/sh\n" \ +"\n" \ +"If you choose to use an /etc/inittab file, the inittab entry format is as follows:\n" \ +"\n" \ +" <id>:<runlevels>:<action>:<process>\n" \ +"\n" \ +" <id>: \n" \ +"\n" \ +" WARNING: This field has a non-traditional meaning for BusyBox init!\n" \ +" The id field is used by BusyBox init to specify the controlling tty for\n" \ +" the specified process to run on. The contents of this field are\n" \ +" appended to "/dev/" and used as-is. There is no need for this field to\n" \ +" be unique, although if it isn't you may have strange results. If this\n" \ +" field is left blank, the controlling tty is set to the console. Also\n" \ +" note that if BusyBox detects that a serial console is in use, then only\n" \ +" entries whose controlling tty is either the serial console or /dev/null\n" \ +" will be run. BusyBox init does nothing with utmp. We don't need no\n" \ +" stinkin' utmp.\n" \ +"\n" \ +" <runlevels>: \n" \ +"\n" \ +" The runlevels field is completely ignored.\n" \ +"\n" \ +" <action>: \n" \ +"\n" \ +" Valid actions include: sysinit, respawn, askfirst, wait, \n" \ +" once, and ctrlaltdel.\n" \ +"\n" \ +" The available actions can be classified into two groups: actions\n" \ +" that are run only once, and actions that are re-run when the specified\n" \ +" process exits.\n" \ +"\n" \ +" Run only-once actions:\n" \ +"\n" \ +" 'sysinit' is the first item run on boot. init waits until all\n" \ +" sysinit actions are completed before continuing. Following the\n" \ +" completion of all sysinit actions, all 'wait' actions are run.\n" \ +" 'wait' actions, like 'sysinit' actions, cause init to wait until\n" \ +" the specified task completes. 'once' actions are asyncronous,\n" \ +" therefore, init does not wait for them to complete. 'ctrlaltdel'\n" \ +" actions are run immediately before init causes the system to reboot\n" \ +" (unmounting filesystems with a 'ctrlaltdel' action is a very good\n" \ +" idea).\n" \ +"\n" \ +" Run repeatedly actions:\n" \ +"\n" \ +" 'respawn' actions are run after the 'once' actions. When a process\n" \ +" started with a 'respawn' action exits, init automatically restarts\n" \ +" it. Unlike sysvinit, BusyBox init does not stop processes from\n" \ +" respawning out of control. The 'askfirst' actions acts just like\n" \ +" respawn, except that before running the specified process it\n" \ +" displays the line "Please press Enter to activate this console."\n" \ +" and then waits for the user to press enter before starting the\n" \ +" specified process. \n" \ +"\n" \ +" Unrecognized actions (like initdefault) will cause init to emit an\n" \ +" error message, and then go along with its business. All actions are\n" \ +" run in the reverse order from how they appear in /etc/inittab.\n" \ +"\n" \ +" <process>: \n" \ +"\n" \ +" Specifies the process to be executed and it's command line.\n" \ +"\n" \ +"Example /etc/inittab file:\n" \ +" # This is run first except when booting in single-user mode.\n" \ +" #\n" \ +" ::sysinit:/etc/init.d/rcS\n" \ +" \n" \ +" # /bin/sh invocations on selected ttys\n" \ +" #\n" \ +" # Start an "askfirst" shell on the console (whatever that may be)\n" \ +" ::askfirst:-/bin/sh\n" \ +" # Start an "askfirst" shell on /dev/tty2-4\n" \ +" tty2::askfirst:-/bin/sh\n" \ +" tty3::askfirst:-/bin/sh\n" \ +" tty4::askfirst:-/bin/sh\n" \ +" \n" \ +" # /sbin/getty invocations for selected ttys\n" \ +" #\n" \ +" tty4::respawn:/sbin/getty 38400 tty5\n" \ +" tty5::respawn:/sbin/getty 38400 tty6\n" \ +" \n" \ +" \n" \ +" # Example of how to put a getty on a serial line (for a terminal)\n" \ +" #\n" \ +" #::respawn:/sbin/getty -L ttyS0 9600 vt100\n" \ +" #::respawn:/sbin/getty -L ttyS1 9600 vt100\n" \ +" #\n" \ +" # Example how to put a getty on a modem line.\n" \ +" #::respawn:/sbin/getty 57600 ttyS2\n" \ +" \n" \ +" # Stuff to do before rebooting\n" \ +" ::ctrlaltdel:/bin/umount -a -r\n" \ +" ::ctrlaltdel:/sbin/swapoff -a\n" #define insmod_trivial_usage \ "[OPTION]... MODULE [symbol=value]..." @@ -463,6 +755,15 @@ "Send a signal (default is SIGTERM) to the specified process(es).\n\n"\ "Options:\n" \ "\t-l\tList all signal names and numbers." +#define kill_example_usage \ + "$ ps | grep apache\n" \ + "252 root root S [apache]\n" \ + "263 www-data www-data S [apache]\n" \ + "264 www-data www-data S [apache]\n" \ + "265 www-data www-data S [apache]\n" \ + "266 www-data www-data S [apache]\n" \ + "267 www-data www-data S [apache]\n" \ + "$ kill 252\n" #define killall_trivial_usage \ "[-signal] process-name [process-name ...]" @@ -470,6 +771,8 @@ "Send a signal (default is SIGTERM) to the specified process(es).\n\n"\ "Options:\n" \ "\t-l\tList all signal names and numbers." +#define killall_example_usage \ + "$ killall apache\n" #define klogd_trivial_usage \ "-n" @@ -482,6 +785,9 @@ "STRING" #define length_full_usage \ "Prints out the length of the specified STRING." +#define length_example_usage \ + "$ length "Hello"\n" \ + "5\n" #define ln_trivial_usage \ "[OPTION] TARGET... LINK_NAME|DIRECTORY" @@ -492,21 +798,31 @@ "\t-s\tmake symbolic links instead of hard links\n" \ "\t-f\tremove existing destination files\n" \ "\t-n\tno dereference symlinks - treat like normal file" +#define ln_example_usage \ + "$ ln -s BusyBox /tmp/ls\n" \ + "$ ls -l /tmp/ls\n" \ + "lrwxrwxrwx 1 root root 7 Apr 12 18:39 ls -> BusyBox*\n" #define loadacm_trivial_usage \ "< mapfile" #define loadacm_full_usage \ "Loads an acm from standard input." +#define loadacm_example_usage \ + "$ loadacm < /etc/i18n/acmname\n" #define loadfont_trivial_usage \ "< font" #define loadfont_full_usage \ "Loads a console font from standard input." +#define loadfont_example_usage \ + "$ loadfont < /etc/i18n/fontname\n" #define loadkmap_trivial_usage \ "< keymap" #define loadkmap_full_usage \ "Loads a binary keyboard translation table from standard input." +#define loadkmap_example_usage \ + "$ loadkmap < /etc/i18n/lang-keymap\n" #define logger_trivial_usage \ "[OPTION]... [MESSAGE]" @@ -517,11 +833,16 @@ "\t-t\tLog using the specified tag (defaults to user name).\n" \ "\t-p\tEnter the message with the specified priority.\n" \ "\t\tThis may be numerical or a ``facility.level'' pair." +#define logger_example_usage \ + "$ logger "hello"\n" #define logname_trivial_usage \ "" #define logname_full_usage \ "Print the name of the current user." +#define logname_example_usage \ + "$ logname\n" \ + "root\n" #define logread_trivial_usage \ "" @@ -612,6 +933,11 @@ "For example:\n" \ "\tmakedevs /dev/ttyS c 4 66 2 63 -> ttyS2-ttyS63\n" \ "\tmakedevs /dev/hda b 3 0 0 8 s -> hda,hda1-hda8" +#define makedevs_example_usage \ + "$ makedevs /dev/ttyS c 4 66 2 63\n" \ + "[creates ttyS2-ttyS63]\n" \ + "$ makedevs /dev/hda b 3 0 0 8 s\n" \ + "[creates hda,hda1-hda8]\n" #define md5sum_trivial_usage \ "[OPTION] [FILE]...\n" \ @@ -627,6 +953,15 @@ "\nThe following two options are useful only when verifying checksums:\n" \ "\t-s\tdon't output anything, status code shows success\n" \ "\t-w\twarn about improperly formated MD5 checksum lines" +#define md5sum_example_usage \ + "$ md5sum < busybox\n" \ + "6fd11e98b98a58f64ff3398d7b324003\n" \ + "$ md5sum busybox\n" \ + "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \ + "$ md5sum -c -\n" \ + "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \ + "busybox: OK\n" \ + "^D\n" #define mkdir_trivial_usage \ "[OPTION] DIRECTORY..." @@ -635,6 +970,13 @@ "Options:\n" \ "\t-m\tset permission mode (as in chmod), not rwxrwxrwx - umask\n" \ "\t-p\tno error if existing, make parent directories as needed" +#define mkdir_example_usage \ + "$ mkdir /tmp/foo\n" \ + "$ mkdir /tmp/foo\n" \ + "/tmp/foo: File exists\n" \ + "$ mkdir /tmp/foo/bar/baz\n" \ + "/tmp/foo/bar/baz: No such file or directory\n" \ + "$ mkdir -p /tmp/foo/bar/baz\n" #define mkfifo_trivial_usage \ "[OPTIONS] name" @@ -664,6 +1006,9 @@ "\tb:\tMake a block (buffered) device.\n" \ "\tc or u:\tMake a character (un-buffered) device.\n" \ "\tp:\tMake a named pipe. MAJOR and MINOR are ignored for named pipes." +#define mknod_example_usage \ + "$ mknod /dev/fd0 b 2 0 \n" \ + "$ mknod -m 644 /tmp/pipe p\n" #define mkswap_trivial_usage \ "[-c] [-v0|-v1] device [block-count]" @@ -680,11 +1025,18 @@ #define mktemp_full_usage \ "Creates a temporary file with its name based on TEMPLATE.\n" \ "TEMPLATE is any name with six `Xs' (i.e. /tmp/temp.XXXXXX)." +#define mktemp_example_usage \ + "$ mktemp /tmp/temp.XXXXXX\n" \ + "/tmp/temp.mWiLjM\n" \ + "$ ls -la /tmp/temp.mWiLjM\n" \ + "-rw------- 1 andersen andersen 0 Apr 25 17:10 /tmp/temp.mWiLjM\n" #define more_trivial_usage \ "[FILE ...]" #define more_full_usage \ "More is a filter for viewing FILE one screenful at a time." +#define more_example_usage \ + "$ dmesg | more\n" #ifdef BB_FEATURE_MOUNT_LOOP #define USAGE_MOUNT_LOOP(a) a @@ -724,6 +1076,13 @@ "\tro/rw:\t\tMount for read-only / read-write.\n" \ "\nThere are EVEN MORE flags that are specific to each filesystem.\n" \ "You'll have to see the written documentation for those." +#define mount_example_usage \ + "$ mount\n" \ + "/dev/hda3 on / type minix (rw)\n" \ + "proc on /proc type proc (rw)\n" \ + "devpts on /dev/pts type devpts (rw)\n" \ + "$ mount /dev/fd0 /mnt -t msdos -o ro\n" \ + "$ mount /tmp/diskimage /opt -t ext2 -o loop\n" #define mt_trivial_usage \ "[-f device] opcode value" @@ -740,16 +1099,34 @@ "or: mv SOURCE... DIRECTORY" #define mv_full_usage \ "Rename SOURCE to DEST, or move SOURCE(s) to DIRECTORY." +#define mv_example_usage \ + "$ mv /tmp/foo /bin/bar\n" #define nc_trivial_usage \ "[IP] [port]" #define nc_full_usage \ "Netcat opens a pipe to IP:port" +#define nc_example_usage \ + "$ nc foobar.somedomain.com 25\n" \ + "220 foobar ESMTP Exim 3.12 #1 Sat, 15 Apr 2000 00:03:02 -0600\n" \ + "help\n" \ + "214-Commands supported:\n" \ + "214- HELO EHLO MAIL RCPT DATA AUTH\n" \ + "214 NOOP QUIT RSET HELP\n" \ + "quit\n" \ + "221 foobar closing connection\n" #define nslookup_trivial_usage \ "[HOST]" #define nslookup_full_usage \ "Queries the nameserver for the IP address of the given HOST" +#define nslookup_example_usage \ + "$ nslookup localhost\n" \ + "Server: default\n" \ + "Address: default\n" \ + "\n" \ + "Name: debian\n" \ + "Address: 127.0.0.1\n" #ifdef BB_FEATURE_SIMPLE_PING #define ping_trivial_usage "host" @@ -765,6 +1142,14 @@ "\t-q\t\tQuiet mode, only displays output at start\n" \ "\t\t\tand when finished." #endif +#define ping_example_usage \ + "$ ping localhost\n" \ + "PING slag (127.0.0.1): 56 data bytes\n" \ + "64 bytes from 127.0.0.1: icmp_seq=0 ttl=255 time=20.1 ms\n" \ + "\n" \ + "--- debian ping statistics ---\n" \ + "1 packets transmitted, 1 packets received, 0% packet loss\n" \ + "round-trip min/avg/max = 20.1/20.1/20.1 ms\n" #define pivot_root_trivial_usage \ "new_root put_old" @@ -782,17 +1167,35 @@ #define printf_full_usage \ "Formats and prints ARGUMENT(s) according to FORMAT,\n" \ "Where FORMAT controls the output exactly as in C printf." +#define printf_example_usage \ + "$ printf "Val=%d\n" 5\n" \ + "Val=5\n" #define ps_trivial_usage \ "" #define ps_full_usage \ "Report process status\n" \ "\nThis version of ps accepts no options." +#define ps_example_usage \ + "$ ps\n" \ + " PID Uid Gid State Command\n" \ + " 1 root root S init\n" \ + " 2 root root S [kflushd]\n" \ + " 3 root root S [kupdate]\n" \ + " 4 root root S [kpiod]\n" \ + " 5 root root S [kswapd]\n" \ + " 742 andersen andersen S [bash]\n" \ + " 743 andersen andersen S -bash\n" \ + " 745 root root S [getty]\n" \ + " 2990 andersen andersen R ps\n" #define pwd_trivial_usage \ "" #define pwd_full_usage \ "Print the full filename of the current working directory." +#define pwd_example_usage \ + "$ pwd\n" \ + "/root\n" #define rdate_trivial_usage \ "[OPTION] HOST" @@ -838,11 +1241,15 @@ USAGE_RM_INTERACTIVE("\t-i\t\talways prompt before removing each destinations\n") \ "\t-f\t\tremove existing destinations, never prompt\n" \ "\t-r or -R\tremove the contents of directories recursively" +#define rm_example_usage \ + "$ rm -rf /tmp/foo\n" #define rmdir_trivial_usage \ "[OPTION]... DIRECTORY..." #define rmdir_full_usage \ "Remove the DIRECTORY(ies), if they are empty." +#define rmdir_example_usage \ + "# rmdir /tmp/foo\n" #define rmmod_trivial_usage \ "[OPTION]... [MODULE]..." @@ -850,6 +1257,8 @@ "Unloads the specified kernel modules from the kernel.\n\n" \ "Options:\n" \ "\t-a\tTry to remove all unused kernel modules." +#define rmmod_example_usage \ + "$ rmmod tulip\n" #define route_trivial_usage \ "[{add|del|flush}]" @@ -873,6 +1282,9 @@ "If no -e or -f is given, the first non-option argument is taken as the\n" \ "sed script to interpret. All remaining arguments are names of input\n" \ "files; if no input files are specified, then the standard input is read." +#define sed_example_usage \ + "$ echo "foo" | sed -e 's/f[a-zA-Z]o/bar/g'\n" \ + "bar\n" #define setkeycodes_trivial_usage \ "SCANCODE KEYCODE ..." @@ -881,17 +1293,31 @@ "allowing unusual keyboards to generate usable keycodes.\n\n" \ "SCANCODE may be either xx or e0xx (hexadecimal),\n" \ "and KEYCODE is given in decimal" +#define setkeycodes_example_usage \ + "$ setkeycodes e030 127\n" #define sh_trivial_usage \ "[FILE]...\n" \ "or: sh -c command [args]..." #define sh_full_usage \ - "lash: The BusyBox command interpreter (shell)." + "lash: The BusyBox LAme SHell (command interpreter)" +#define sh_notes_usage \ +"This command does not yet have proper documentation.\n" \ +"\n" \ +"Use lash just as you would use any other shell. It properly handles pipes,\n" \ +"redirects, job control, can be used as the shell for scripts, and has a\n" \ +"sufficient set of builtins to do what is needed. It does not (yet) support\n" \ +"Bourne Shell syntax. If you need things like "if-then-else", "while", and such\n" \ +"use ash or bash. If you just need a very simple and extremely small shell,\n" \ +"this will do the job." #define sleep_trivial_usage \ "N" #define sleep_full_usage \ "Pause for N seconds." +#define sleep_example_usage \ + "$ sleep 2\n" \ + "[2 second delay results]\n" #ifdef BB_FEATURE_SORT_REVERSE @@ -903,6 +1329,14 @@ "[-n]" USAGE_SORT_REVERSE(" [-r]") " [FILE]..." #define sort_full_usage \ "Sorts lines of text in the specified files" +#define sort_example_usage \ + "$ echo -e "e\nf\nb\nd\nc\na" | sort\n" \ + "a\n" \ + "b\n" \ + "c\n" \ + "d\n" \ + "e\n" \ + "f\n" #define stty_trivial_usage \ "[-a|g] [-F device] [SETTING]..." @@ -952,6 +1386,9 @@ USAGE_REMOTE_LOG( \ "\n\t-R HOST[:PORT]\tLog to IP or hostname on PORT (default PORT=514/UDP)\n" \ "\t-L\t\tLog locally and via network logging (default is network only)") +#define syslogd_example_usage \ + "$ syslogd -R masterlog:514\n" \ + "$ syslogd -R 192.168.1.1:601\n" #ifdef BB_FEATURE_SIMPLE_TAIL @@ -969,14 +1406,15 @@ USAGE_UNSIMPLE_TAIL("\t-c N[kbm]\toutput the last N bytes\n") \ "\t-n N[kbm]\tprint last N lines instead of last 10\n" \ "\t-f\t\toutput data as the file grows" \ - USAGE_UNSIMPLE_TAIL( \ - "\n\t-q\t\tnever output headers giving file names\n" \ + USAGE_UNSIMPLE_TAIL( "\n\t-q\t\tnever output headers giving file names\n" \ "\t-s SEC\t\twait SEC seconds between reads with -f\n" \ "\t-v\t\talways output headers giving file names\n\n" \ - "If the first character of N (bytes or lines) is a `+', output begins with \n" \ + "If the first character of N (bytes or lines) is a '+', output begins with \n" \ "the Nth item from the start of each file, otherwise, print the last N items\n" \ - "in the file. N bytes may be suffixed by k (x1024), b (x512), or m (1024^2)." \ - ) + "in the file. N bytes may be suffixed by k (x1024), b (x512), or m (1024^2)." ) +#define tail_example_usage \ + "$ tail -n 1 /etc/resolv.conf\n" \ + "nameserver 10.0.0.1\n" #ifdef BB_FEATURE_TAR_CREATE #define USAGE_TAR_CREATE(a) a @@ -1007,6 +1445,9 @@ ) \ "\nInformative output:\n" \ "\tv\t\tverbosely list files processed" +#define tar_example_usage \ + "$ zcat /tmp/tarball.tar.gz | tar -xf -\n" \ + "$ tar -cf /tmp/tarball.tar /usr/local\n" #define tee_trivial_usage \ "[OPTION]... [FILE]..." @@ -1014,6 +1455,10 @@ "Copy standard input to each FILE, and also to standard output.\n\n" \ "Options:\n" \ "\t-a\tappend to the given FILEs, do not overwrite" +#define tee_example_usage \ + "$ echo "Hello" | tee /tmp/foo\n" \ + "$ cat /tmp/foo\n" \ + "Hello\n" #define telnet_trivial_usage \ "host [port]" @@ -1026,6 +1471,19 @@ #define test_full_usage \ "Checks file types and compares values returning an exit\n" \ "code determined by the value of EXPRESSION." +#define test_example_usage \ + "$ test 1 -eq 2\n" \ + "$ echo $?\n" \ + "1\n" \ + "$ test 1 -eq 1\n" \ + "$ echo $? \n" \ + "0\n" \ + "$ [ -d /etc ]\n" \ + "$ echo $?\n" \ + "0\n" \ + "$ [ -d /junk ]\n" \ + "$ echo $?\n" \ + "1\n" #ifdef BB_FEATURE_TFTP_GET #define USAGE_TFTP_GET(a) a @@ -1057,6 +1515,12 @@ "Update the last-modified date on the given file[s].\n\n" \ "Options:\n" \ "\t-c\tDo not create any files" +#define touch_example_usage \ + "$ ls -l /tmp/foo\n" \ + "/bin/ls: /tmp/foo: No such file or directory\n" \ + "$ touch /tmp/foo\n" \ + "$ ls -l /tmp/foo\n" \ + "-rw-rw-r-- 1 andersen andersen 0 Apr 15 01:11 /tmp/foo\n" #define tr_trivial_usage \ "[-cds] STRING1 [STRING2]" @@ -1067,11 +1531,18 @@ "\t-c\ttake complement of STRING1\n" \ "\t-d\tdelete input characters coded STRING1\n" \ "\t-s\tsqueeze multiple output characters of STRING2 into one character" +#define tr_example_usage \ + "$ echo "gdkkn vnqkc" | tr [a-y] [b-z]\n" \ + "hello world\n" #define true_trivial_usage \ "" #define true_full_usage \ "Return an exit code of TRUE (0)." +#define true_example_usage \ + "$ true\n" \ + "$ echo $?\n" \ + "0\n" #define tty_trivial_usage \ "" @@ -1079,6 +1550,9 @@ "Print the file name of the terminal connected to standard input.\n\n"\ "Options:\n" \ "\t-s\tprint nothing, only return an exit status" +#define tty_example_usage \ + "$ tty\n" \ + "/dev/tty2\n" #ifdef BB_FEATURE_MOUNT_FORCE #define USAGE_MOUNT_FORCE(a) a @@ -1094,6 +1568,8 @@ "\n\t-r:\tTry to remount devices as read-only if mount is busy" \ USAGE_MOUNT_FORCE("\n\t-f:\tForce filesystem umount (i.e. unreachable NFS server)") \ USAGE_MOUNT_LOOP("\n\t-l:\tDo not free loop device (if a loop device has been used)") +#define umount_example_usage \ + "$ umount /dev/hdc1 \n" #define uname_trivial_usage \ "[OPTION]..." @@ -1107,6 +1583,9 @@ "\t-s\tprint the operating system name\n" \ "\t-p\tprint the host processor type\n" \ "\t-v\tprint the operating system version" +#define uname_example_usage \ + "$ uname -a\n" \ + "Linux debian 2.2.15pre13 #5 Tue Mar 14 16:03:50 MST 2000 i686 unknown\n" #define uniq_trivial_usage \ "[OPTION]... [INPUT [OUTPUT]]" @@ -1117,6 +1596,11 @@ "\t-c\tprefix lines by the number of occurrences\n" \ "\t-d\tonly print duplicate lines\n" \ "\t-u\tonly print unique lines" +#define uniq_example_usage \ + "$ echo -e "a\na\nb\nc\nc\na" | sort | uniq\n" \ + "a\n" \ + "b\n" \ + "c\n" #define unix2dos_trivial_usage \ "[option] [file]" @@ -1136,11 +1620,17 @@ "" #define uptime_full_usage \ "Display the time since the last boot." +#define uptime_example_usage \ + "$ uptime\n" \ + " 1:55pm up 2:30, load average: 0.09, 0.04, 0.00\n" #define usleep_trivial_usage \ "N" #define usleep_full_usage \ "Pause for N microseconds." +#define usleep_example_usage \ + "$ usleep 1000000\n" \ + "[pauses for 1 second]\n" #define uudecode_trivial_usage \ "[FILE]..." @@ -1148,6 +1638,10 @@ "Uudecode a file that is uuencoded.\n\n" \ "Options:\n" \ "\t-o FILE\tdirect output to FILE" \ +#define uudecode_example_usage \ + "$ uudecode -o busybox busybox.uu\n" \ + "$ ls -l busybox\n" \ + "-rwxr-xr-x 1 ams ams 245264 Jun 7 21:35 busybox\n" #define uuencode_trivial_usage \ "[OPTION] [INFILE] REMOTEFILE" @@ -1155,6 +1649,12 @@ "Uuencode a file.\n\n" \ "Options:\n" \ "\t-m\tuse base64 encoding as of RFC1521" +#define uuencode_example_usage \ + "$ uuencode busybox busybox\n" \ + "begin 755 busybox\n" \ + "<encoded file snipped>\n" \ + "$ uudecode busybox busybox > busybox.uu\n" \ + "$\n" #define watchdog_trivial_usage \ "DEV" @@ -1171,6 +1671,9 @@ "\t-l\tprint the newline counts\n" \ "\t-L\tprint the length of the longest line\n" \ "\t-w\tprint the word counts" +#define wc_example_usage \ + "$ wc /etc/passwd\n" \ + " 31 46 1365 /etc/passwd\n" #define wget_trivial_usage \ "[-c] [-O file] url" @@ -1184,6 +1687,9 @@ "[COMMAND ...]" #define which_full_usage \ "Locates a COMMAND." +#define which_example_usage \ + "$ which login\n" \ + "/bin/login\n" #define whoami_trivial_usage \ "" @@ -1194,11 +1700,14 @@ "[COMMAND] [ARGS...]" #define xargs_full_usage \ "Executes COMMAND on every item given by standard input." +#define xargs_example_usage \ + "$ ls | xargs gzip\n" \ + "$ find . -name '*.c' -print | xargs rm\n" #define yes_trivial_usage \ "[OPTION]... [STRING]..." #define yes_full_usage \ - "Repeatedly outputs a line with all specified STRING(s), or `y'." + "Repeatedly outputs a line with all specified STRING(s), or 'y'." #define zcat_trivial_usage \ "FILE" @@ -15,11 +15,21 @@ #define basename_full_usage \ "Strips directory path and suffixes from FILE.\n" \ "If specified, also removes any trailing SUFFIX." +#define basename_example_usage \ + "$ basename /usr/local/bin/foo\n" \ + "foo\n" \ + "$ basename /usr/local/bin/\n" \ + "bin\n" \ + "$ basename /foo/bar.txt .txt\n" \ + "bar" #define cat_trivial_usage \ "[FILE]..." #define cat_full_usage \ "Concatenates FILE(s) and prints them to stdout." +#define cat_example_usage \ + "$ cat /proc/uptime\n" \ + "110716.72 17.67" #define chgrp_trivial_usage \ "[OPTION]... GROUP FILE..." @@ -27,6 +37,12 @@ "Change the group membership of each FILE to GROUP.\n" \ "\nOptions:\n" \ "\t-R\tChanges files and directories recursively." +#define chgrp_example_usage \ + "$ ls -l /tmp/foo\n" \ + "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \ + "$ chgrp root /tmp/foo\n" \ + "$ ls -l /tmp/foo\n" \ + "-r--r--r-- 1 andersen root 0 Apr 12 18:25 /tmp/foo\n" #define chmod_trivial_usage \ "[-R] MODE[,MODE]... FILE..." @@ -35,6 +51,15 @@ "symbols +-= and one or more of the letters rwxst.\n\n" \ "Options:\n" \ "\t-R\tChanges files and directories recursively." +#define chmod_example_usage \ + "$ ls -l /tmp/foo\n" \ + "-rw-rw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n" \ + "$ chmod u+x /tmp/foo\n" \ + "$ ls -l /tmp/foo\n" \ + "-rwxrw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo*\n" \ + "$ chmod 444 /tmp/foo\n" \ + "$ ls -l /tmp/foo\n" \ + "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n" #define chown_trivial_usage \ "[OPTION]... OWNER[<.|:>[GROUP] FILE..." @@ -42,11 +67,27 @@ "Change the owner and/or group of each FILE to OWNER and/or GROUP.\n" \ "\nOptions:\n" \ "\t-R\tChanges files and directories recursively." +#define chown_example_usage \ + "$ ls -l /tmp/foo\n" \ + "-r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo\n" \ + "$ chown root /tmp/foo\n" \ + "$ ls -l /tmp/foo\n" \ + "-r--r--r-- 1 root andersen 0 Apr 12 18:25 /tmp/foo\n" \ + "$ chown root.root /tmp/foo\n" \ + "ls -l /tmp/foo\n" \ + "-r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo\n" #define chroot_trivial_usage \ "NEWROOT [COMMAND...]" #define chroot_full_usage \ "Run COMMAND with root directory set to NEWROOT." +#define chroot_example_usage \ + "$ ls -l /bin/ls\n" \ + "lrwxrwxrwx 1 root root 12 Apr 13 00:46 /bin/ls -> /BusyBox\n" \ + "$ mount /dev/hdc1 /mnt -t minix\n" \ + "$ chroot /mnt\n" \ + "$ ls -l /bin/ls\n" \ + "-rwxr-xr-x 1 root root 40816 Feb 5 07:45 /bin/ls*\n" #define chvt_trivial_usage \ "N" @@ -85,6 +126,11 @@ "\t-s\t\tOutput only the lines containing delimiter\n" \ "\t-f N\t\tPrint only these fields\n" \ "\t-n\t\tIgnored" +#define cut_example_usage \ + "$ echo "Hello world" | cut -f 1 -d ' '\n" \ + "Hello\n" \ + "$ echo "Hello world" | cut -f 2 -d ' '\n" \ + "world\n" #define date_trivial_usage \ "[OPTION]... [+FORMAT]" @@ -95,6 +141,9 @@ "\t-d STRING\tdisplay time described by STRING, not `now'\n" \ "\t-s\t\tSets time described by STRING\n" \ "\t-u\t\tPrints or sets Coordinated Universal Time" +#define date_example_usage \ + "$ date\n" \ + "Wed Apr 12 18:52:41 MDT 2000\n" #define dc_trivial_usage \ "expression ..." @@ -102,6 +151,17 @@ "This is a Tiny RPN calculator that understands the\n" \ "following operations: +, -, /, *, and, or, not, eor.\n" \ "i.e. 'dc 2 2 add' -> 4, and 'dc 8 8 \\* 2 2 + /' -> 16" +#define dc_example_usage \ + "$ dc 2 2 +\n" \ + "4\n" \ + "$ dc 8 8 \* 2 2 + /\n" \ + "16\n" \ + "$ dc 0 1 and\n" \ + "0\n" \ + "$ dc 0 1 or\n" \ + "1\n" \ + "$ echo 72 9 div 8 mul | dc\n" \ + "64\n" #define dd_trivial_usage \ "[if=FILE] [of=FILE] [bs=N] [count=N] [skip=N]\n" \ @@ -119,6 +179,10 @@ "\n" \ "Numbers may be suffixed by c (x1), w (x2), b (x512), kD (x1000), k (x1024),\n" \ "MD (x1000000), M (x1048576), GD (x1000000000) or G (x1073741824)." +#define dd_example_usage \ + "$ dd if=/dev/zero of=/dev/ram1 bs=1M count=4\n" \ + "4+0 records in\n" \ + "4+0 records out\n" #define deallocvt_trivial_usage \ "N" @@ -143,11 +207,24 @@ "\t-m\tprint sizes in megabytes\n" \ "\t-k\tprint sizes in kilobytes(default)") USAGE_NOT_HUMAN_READABLE( \ "\n\t-k\tprint sizes in kilobytes(compatability)") +#define df_example_usage \ + "$ df\n" \ + "Filesystem 1k-blocks Used Available Use% Mounted on\n" \ + "/dev/sda3 8690864 8553540 137324 98% /\n" \ + "/dev/sda1 64216 36364 27852 57% /boot\n" \ + "$ df /dev/sda3\n" \ + "Filesystem 1k-blocks Used Available Use% Mounted on\n" \ + "/dev/sda3 8690864 8553540 137324 98% /\n" #define dirname_trivial_usage \ "[FILENAME ...]" #define dirname_full_usage \ "Strips non-directory suffix from FILENAME" +#define dirname_example_usage \ + "$ dirname /tmp/foo\n" \ + "/tmp\n" \ + "$ dirname /tmp/foo/\n" \ + "/tmp\n" #define dmesg_trivial_usage \ "[-c] [-n LEVEL] [-s SIZE]" @@ -184,6 +261,8 @@ "\t-e\tExtract control files to directory\n" \ "\t-x\tExctract packages filesystem tree to directory\n" \ "\t-X\tVerbose extract" +#define dpkg_deb_example_usage \ + "$ dpkg-deb -X ./busybox_0.48-1_i386.deb /tmp\n" #define du_trivial_usage \ "[-ls" USAGE_HUMAN_READABLE("hm") USAGE_NOT_HUMAN_READABLE("") "k] [FILE]..." @@ -198,17 +277,40 @@ "\t-m\tprint sizes in megabytes\n" \ "\t-k\tprint sizes in kilobytes(default)") USAGE_NOT_HUMAN_READABLE( \ "\n\t-k\tprint sizes in kilobytes(compatability)") +#define du_example_usage \ + "$ du\n" \ + "16 ./CVS\n" \ + "12 ./kernel-patches/CVS\n" \ + "80 ./kernel-patches\n" \ + "12 ./tests/CVS\n" \ + "36 ./tests\n" \ + "12 ./scripts/CVS\n" \ + "16 ./scripts\n" \ + "12 ./docs/CVS\n" \ + "104 ./docs\n" \ + "2417 .\n" #define dumpkmap_trivial_usage \ "> keymap" #define dumpkmap_full_usage \ "Prints out a binary keyboard translation table to standard output." +#define dumpkmap_example_usage \ + "$ dumpkmap > keymap\n" #define dutmp_trivial_usage \ "[FILE]" #define dutmp_full_usage \ "Dump utmp file format (pipe delimited) from FILE\n" \ "or stdin to stdout. (i.e. 'dutmp /var/run/utmp')" +#define dutmp_example_usage \ + "$ dutmp /var/run/utmp\n" \ + "8|7||si|||0|0|0|955637625|760097|0\n" \ + "2|0|~|~~|reboot||0|0|0|955637625|782235|0\n" \ + "1|20020|~|~~|runlevel||0|0|0|955637625|800089|0\n" \ + "8|125||l4|||0|0|0|955637629|998367|0\n" \ + "6|245|tty1|1|LOGIN||0|0|0|955637630|998974|0\n" \ + "6|246|tty2|2|LOGIN||0|0|0|955637630|999498|0\n" \ + "7|336|pts/0|vt00andersen|andersen|:0.0|0|0|0|955637763|0|0\n" #define echo_trivial_usage \ "[-neE] [ARG ...]" @@ -218,6 +320,15 @@ "\t-n\tsuppress trailing newline\n" \ "\t-e\tinterpret backslash-escaped characters (i.e. \\t=tab etc)\n" \ "\t-E\tdisable interpretation of backslash-escaped characters" +#define echo_example_usage \ + "$ echo "Erik is cool"\n" \ + "Erik is cool\n" \ + "$ echo -e "Erik\nis\ncool"\n" \ + "Erik\n" \ + "is\n" \ + "cool\n" \ + "$ echo "Erik\nis\ncool"\n" \ + "Erik\nis\ncool\n" #define expr_trivial_usage \ "EXPRESSION" @@ -257,6 +368,24 @@ "" #define false_full_usage \ "Return an exit code of FALSE (1)." +#define false_example_usage \ + "$ false\n" \ + "$ echo $?\n" \ + "1\n" + +#define fbset_trivial_usage \ + "[options] [mode]" +#define fbset_full_usage \ + "Show and modify frame buffer settings" +#define fbset_example_usage \ + "$ fbset\n" \ + "mode "1024x768-76"\n" \ + "\t# D: 78.653 MHz, H: 59.949 kHz, V: 75.694 Hz\n" \ + "\tgeometry 1024 768 1024 768 16\n" \ + "\ttimings 12714 128 32 16 4 128 4\n" \ + "\taccel false\n" \ + "\trgba 5/11,6/5,5/0,0/0\n" \ + "endmode\n" #define fdflush_trivial_usage \ "DEVICE" @@ -293,16 +422,27 @@ "\n\t-perm PERMS\tPermissions match any of (+NNN); all of (-NNN);\n\t\t\tor exactly (NNN)" \ ) USAGE_FIND_MTIME( \ "\n\t-mtime TIME\tModified time is greater than (+N); less than (-N);\n\t\t\tor exactly (N) days") +#define find_example_usage \ + "$ find / -name /etc/passwd\n" \ + "/etc/passwd\n" #define free_trivial_usage \ "" #define free_full_usage \ "Displays the amount of free and used system memory" +#define free_example_usage \ + "$ free\n" \ + " total used free shared buffers\n" \ + " Mem: 257628 248724 8904 59644 93124\n" \ + " Swap: 128516 8404 120112\n" \ + "Total: 386144 257128 129016\n" \ #define freeramdisk_trivial_usage \ "DEVICE" #define freeramdisk_full_usage \ "Frees all memory used by the specified ramdisk." +#define freeramdisk_example_usage \ + "$ freeramdisk /dev/ram2\n" #define fsck_minix_trivial_usage \ "[-larvsmf] /dev/name" @@ -330,6 +470,26 @@ "\t-s, --shell=shell Set shell quoting conventions\n" \ "\t-T, --test Test for getopt(1) version\n" \ "\t-u, --unqote Do not quote the output" +#define getopt_example_usage \ + "$ cat getopt.test\n" \ + "#!/bin/sh\n" \ + "GETOPT=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \\\n" \ + " -n 'example.busybox' -- "$@"`\n" \ + "if [ $? != 0 ] ; then exit 1 ; fi\n" \ + "eval set -- "$GETOPT"\n" \ + "while true ; do\n" \ + " case $1 in\n" \ + " -a|--a-long) echo \"Option a\" ; shift ;;\n" \ + " -b|--b-long) echo \"Option b, argument \`$2'\" ; shift 2 ;;\n" \ + " -c|--c-long)\n" \ + " case "$2" in\n" \ + " \"\") echo \"Option c, no argument\"; shift 2 ;;\n" \ + " *) echo \"Option c, argument \`$2'\" ; shift 2 ;;\n" \ + " esac ;;\n" \ + " --) shift ; break ;;\n" \ + " *) echo \"Internal error!\" ; exit 1 ;;\n" \ + " esac\n" \ + "done\n" #define grep_trivial_usage \ "[-ihHnqvs] pattern [files...]" @@ -343,9 +503,11 @@ "\t-q\tbe quiet. Returns 0 if result was found, 1 otherwise\n" \ "\t-v\tselect non-matching lines\n" \ "\t-s\tsuppress file open/read error messages" - -#define egrep_trivial_usage grep_trivial_usage -#define egrep_full_usage grep_full_usage +#define grep_example_usage \ + "$ grep root /etc/passwd\n" \ + "root:x:0:0:root:/root:/bin/bash\n" \ + "$ grep ^[rR]oo. /etc/passwd\n" \ + "root:x:0:0:root:/root:/bin/bash\n" #define gunzip_trivial_usage \ "[OPTION]... FILE" @@ -354,6 +516,12 @@ "Options:\n" \ "\t-c\tWrite output to standard output\n" \ "\t-t\tTest compressed file integrity" +#define gunzip_example_usage \ + "$ ls -la /tmp/BusyBox*\n" \ + "-rw-rw-r-- 1 andersen andersen 557009 Apr 11 10:55 /tmp/BusyBox-0.43.tar.gz\n" \ + "$ gunzip /tmp/BusyBox-0.43.tar.gz\n" \ + "$ ls -la /tmp/BusyBox*\n" \ + "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar\n" #define gzip_trivial_usage \ "[OPTION]... FILE" @@ -363,6 +531,12 @@ "Options:\n" \ "\t-c\tWrite output to standard output instead of FILE.gz\n" \ "\t-d\tdecompress" +#define gzip_example_usage \ + "$ ls -la /tmp/BusyBox*\n" \ + "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar\n" \ + "$ gzip /tmp/BusyBox-0.43.tar\n" \ + "$ ls -la /tmp/BusyBox*\n" \ + "-rw-rw-r-- 1 andersen andersen 554058 Apr 14 17:49 /tmp/BusyBox-0.43.tar.gz\n" #define halt_trivial_usage \ "" @@ -377,6 +551,10 @@ "file name. With no FILE, or when FILE is -, read standard input.\n\n" \ "Options:\n" \ "\t-n NUM\t\tPrint first NUM lines instead of first 10" +#define head_example_usage \ + "$ head -n 2 /etc/passwd\n" \ + "root:x:0:0:root:/root:/bin/bash\n" \ + "daemon:x:1:1:daemon:/usr/sbin:/bin/sh\n" #define hostid_trivial_usage \ "" @@ -393,6 +571,9 @@ "\t-i\t\tAddresses for the hostname\n" \ "\t-d\t\tDNS domain name\n" \ "\t-F, --file FILE\tUse the contents of FILE to specify the hostname" +#define hostname_example_usage \ + "$ hostname\n" \ + "slag \n" #define id_trivial_usage \ "[OPTIONS]... [USERNAME]" @@ -403,6 +584,9 @@ "\t-u\tprints only the user ID\n" \ "\t-n\tprint a name instead of a number (with for -ug)\n" \ "\t-r\tprints the real user ID instead of the effective ID (with -ug)" +#define id_example_usage \ + "$ id\n" \ + "uid=1000(andersen) gid=1000(andersen)\n" #ifdef BB_FEATURE_IFCONFIG_SLIP #define USAGE_SIOCSKEEPALIVE(a) a @@ -443,8 +627,116 @@ #define init_trivial_usage \ "" #define init_full_usage \ - "Init is the parent of all processes.\n\n" \ - "This version of init is designed to be run only by the kernel." + "Init is the parent of all processes." +#define init_notes_usage \ +"This version of init is designed to be run only by the kernel.\n" \ +"\n" \ +"BusyBox init doesn't support multiple runlevels. The runlevels field of\n" \ +"the /etc/inittab file is completely ignored by BusyBox init. If you want \n" \ +"runlevels, use sysvinit.\n" \ +"\n" \ +"BusyBox init works just fine without an inittab. If no inittab is found, \n" \ +"it has the following default behavior:\n" \ +"\n" \ +" ::sysinit:/etc/init.d/rcS\n" \ +" ::askfirst:/bin/sh\n" \ +"\n" \ +"if it detects that /dev/console is _not_ a serial console, it will also run:\n" \ +"\n" \ +" tty2::askfirst:/bin/sh\n" \ +"\n" \ +"If you choose to use an /etc/inittab file, the inittab entry format is as follows:\n" \ +"\n" \ +" <id>:<runlevels>:<action>:<process>\n" \ +"\n" \ +" <id>: \n" \ +"\n" \ +" WARNING: This field has a non-traditional meaning for BusyBox init!\n" \ +" The id field is used by BusyBox init to specify the controlling tty for\n" \ +" the specified process to run on. The contents of this field are\n" \ +" appended to "/dev/" and used as-is. There is no need for this field to\n" \ +" be unique, although if it isn't you may have strange results. If this\n" \ +" field is left blank, the controlling tty is set to the console. Also\n" \ +" note that if BusyBox detects that a serial console is in use, then only\n" \ +" entries whose controlling tty is either the serial console or /dev/null\n" \ +" will be run. BusyBox init does nothing with utmp. We don't need no\n" \ +" stinkin' utmp.\n" \ +"\n" \ +" <runlevels>: \n" \ +"\n" \ +" The runlevels field is completely ignored.\n" \ +"\n" \ +" <action>: \n" \ +"\n" \ +" Valid actions include: sysinit, respawn, askfirst, wait, \n" \ +" once, and ctrlaltdel.\n" \ +"\n" \ +" The available actions can be classified into two groups: actions\n" \ +" that are run only once, and actions that are re-run when the specified\n" \ +" process exits.\n" \ +"\n" \ +" Run only-once actions:\n" \ +"\n" \ +" 'sysinit' is the first item run on boot. init waits until all\n" \ +" sysinit actions are completed before continuing. Following the\n" \ +" completion of all sysinit actions, all 'wait' actions are run.\n" \ +" 'wait' actions, like 'sysinit' actions, cause init to wait until\n" \ +" the specified task completes. 'once' actions are asyncronous,\n" \ +" therefore, init does not wait for them to complete. 'ctrlaltdel'\n" \ +" actions are run immediately before init causes the system to reboot\n" \ +" (unmounting filesystems with a 'ctrlaltdel' action is a very good\n" \ +" idea).\n" \ +"\n" \ +" Run repeatedly actions:\n" \ +"\n" \ +" 'respawn' actions are run after the 'once' actions. When a process\n" \ +" started with a 'respawn' action exits, init automatically restarts\n" \ +" it. Unlike sysvinit, BusyBox init does not stop processes from\n" \ +" respawning out of control. The 'askfirst' actions acts just like\n" \ +" respawn, except that before running the specified process it\n" \ +" displays the line "Please press Enter to activate this console."\n" \ +" and then waits for the user to press enter before starting the\n" \ +" specified process. \n" \ +"\n" \ +" Unrecognized actions (like initdefault) will cause init to emit an\n" \ +" error message, and then go along with its business. All actions are\n" \ +" run in the reverse order from how they appear in /etc/inittab.\n" \ +"\n" \ +" <process>: \n" \ +"\n" \ +" Specifies the process to be executed and it's command line.\n" \ +"\n" \ +"Example /etc/inittab file:\n" \ +" # This is run first except when booting in single-user mode.\n" \ +" #\n" \ +" ::sysinit:/etc/init.d/rcS\n" \ +" \n" \ +" # /bin/sh invocations on selected ttys\n" \ +" #\n" \ +" # Start an "askfirst" shell on the console (whatever that may be)\n" \ +" ::askfirst:-/bin/sh\n" \ +" # Start an "askfirst" shell on /dev/tty2-4\n" \ +" tty2::askfirst:-/bin/sh\n" \ +" tty3::askfirst:-/bin/sh\n" \ +" tty4::askfirst:-/bin/sh\n" \ +" \n" \ +" # /sbin/getty invocations for selected ttys\n" \ +" #\n" \ +" tty4::respawn:/sbin/getty 38400 tty5\n" \ +" tty5::respawn:/sbin/getty 38400 tty6\n" \ +" \n" \ +" \n" \ +" # Example of how to put a getty on a serial line (for a terminal)\n" \ +" #\n" \ +" #::respawn:/sbin/getty -L ttyS0 9600 vt100\n" \ +" #::respawn:/sbin/getty -L ttyS1 9600 vt100\n" \ +" #\n" \ +" # Example how to put a getty on a modem line.\n" \ +" #::respawn:/sbin/getty 57600 ttyS2\n" \ +" \n" \ +" # Stuff to do before rebooting\n" \ +" ::ctrlaltdel:/bin/umount -a -r\n" \ +" ::ctrlaltdel:/sbin/swapoff -a\n" #define insmod_trivial_usage \ "[OPTION]... MODULE [symbol=value]..." @@ -463,6 +755,15 @@ "Send a signal (default is SIGTERM) to the specified process(es).\n\n"\ "Options:\n" \ "\t-l\tList all signal names and numbers." +#define kill_example_usage \ + "$ ps | grep apache\n" \ + "252 root root S [apache]\n" \ + "263 www-data www-data S [apache]\n" \ + "264 www-data www-data S [apache]\n" \ + "265 www-data www-data S [apache]\n" \ + "266 www-data www-data S [apache]\n" \ + "267 www-data www-data S [apache]\n" \ + "$ kill 252\n" #define killall_trivial_usage \ "[-signal] process-name [process-name ...]" @@ -470,6 +771,8 @@ "Send a signal (default is SIGTERM) to the specified process(es).\n\n"\ "Options:\n" \ "\t-l\tList all signal names and numbers." +#define killall_example_usage \ + "$ killall apache\n" #define klogd_trivial_usage \ "-n" @@ -482,6 +785,9 @@ "STRING" #define length_full_usage \ "Prints out the length of the specified STRING." +#define length_example_usage \ + "$ length "Hello"\n" \ + "5\n" #define ln_trivial_usage \ "[OPTION] TARGET... LINK_NAME|DIRECTORY" @@ -492,21 +798,31 @@ "\t-s\tmake symbolic links instead of hard links\n" \ "\t-f\tremove existing destination files\n" \ "\t-n\tno dereference symlinks - treat like normal file" +#define ln_example_usage \ + "$ ln -s BusyBox /tmp/ls\n" \ + "$ ls -l /tmp/ls\n" \ + "lrwxrwxrwx 1 root root 7 Apr 12 18:39 ls -> BusyBox*\n" #define loadacm_trivial_usage \ "< mapfile" #define loadacm_full_usage \ "Loads an acm from standard input." +#define loadacm_example_usage \ + "$ loadacm < /etc/i18n/acmname\n" #define loadfont_trivial_usage \ "< font" #define loadfont_full_usage \ "Loads a console font from standard input." +#define loadfont_example_usage \ + "$ loadfont < /etc/i18n/fontname\n" #define loadkmap_trivial_usage \ "< keymap" #define loadkmap_full_usage \ "Loads a binary keyboard translation table from standard input." +#define loadkmap_example_usage \ + "$ loadkmap < /etc/i18n/lang-keymap\n" #define logger_trivial_usage \ "[OPTION]... [MESSAGE]" @@ -517,11 +833,16 @@ "\t-t\tLog using the specified tag (defaults to user name).\n" \ "\t-p\tEnter the message with the specified priority.\n" \ "\t\tThis may be numerical or a ``facility.level'' pair." +#define logger_example_usage \ + "$ logger "hello"\n" #define logname_trivial_usage \ "" #define logname_full_usage \ "Print the name of the current user." +#define logname_example_usage \ + "$ logname\n" \ + "root\n" #define logread_trivial_usage \ "" @@ -612,6 +933,11 @@ "For example:\n" \ "\tmakedevs /dev/ttyS c 4 66 2 63 -> ttyS2-ttyS63\n" \ "\tmakedevs /dev/hda b 3 0 0 8 s -> hda,hda1-hda8" +#define makedevs_example_usage \ + "$ makedevs /dev/ttyS c 4 66 2 63\n" \ + "[creates ttyS2-ttyS63]\n" \ + "$ makedevs /dev/hda b 3 0 0 8 s\n" \ + "[creates hda,hda1-hda8]\n" #define md5sum_trivial_usage \ "[OPTION] [FILE]...\n" \ @@ -627,6 +953,15 @@ "\nThe following two options are useful only when verifying checksums:\n" \ "\t-s\tdon't output anything, status code shows success\n" \ "\t-w\twarn about improperly formated MD5 checksum lines" +#define md5sum_example_usage \ + "$ md5sum < busybox\n" \ + "6fd11e98b98a58f64ff3398d7b324003\n" \ + "$ md5sum busybox\n" \ + "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \ + "$ md5sum -c -\n" \ + "6fd11e98b98a58f64ff3398d7b324003 busybox\n" \ + "busybox: OK\n" \ + "^D\n" #define mkdir_trivial_usage \ "[OPTION] DIRECTORY..." @@ -635,6 +970,13 @@ "Options:\n" \ "\t-m\tset permission mode (as in chmod), not rwxrwxrwx - umask\n" \ "\t-p\tno error if existing, make parent directories as needed" +#define mkdir_example_usage \ + "$ mkdir /tmp/foo\n" \ + "$ mkdir /tmp/foo\n" \ + "/tmp/foo: File exists\n" \ + "$ mkdir /tmp/foo/bar/baz\n" \ + "/tmp/foo/bar/baz: No such file or directory\n" \ + "$ mkdir -p /tmp/foo/bar/baz\n" #define mkfifo_trivial_usage \ "[OPTIONS] name" @@ -664,6 +1006,9 @@ "\tb:\tMake a block (buffered) device.\n" \ "\tc or u:\tMake a character (un-buffered) device.\n" \ "\tp:\tMake a named pipe. MAJOR and MINOR are ignored for named pipes." +#define mknod_example_usage \ + "$ mknod /dev/fd0 b 2 0 \n" \ + "$ mknod -m 644 /tmp/pipe p\n" #define mkswap_trivial_usage \ "[-c] [-v0|-v1] device [block-count]" @@ -680,11 +1025,18 @@ #define mktemp_full_usage \ "Creates a temporary file with its name based on TEMPLATE.\n" \ "TEMPLATE is any name with six `Xs' (i.e. /tmp/temp.XXXXXX)." +#define mktemp_example_usage \ + "$ mktemp /tmp/temp.XXXXXX\n" \ + "/tmp/temp.mWiLjM\n" \ + "$ ls -la /tmp/temp.mWiLjM\n" \ + "-rw------- 1 andersen andersen 0 Apr 25 17:10 /tmp/temp.mWiLjM\n" #define more_trivial_usage \ "[FILE ...]" #define more_full_usage \ "More is a filter for viewing FILE one screenful at a time." +#define more_example_usage \ + "$ dmesg | more\n" #ifdef BB_FEATURE_MOUNT_LOOP #define USAGE_MOUNT_LOOP(a) a @@ -724,6 +1076,13 @@ "\tro/rw:\t\tMount for read-only / read-write.\n" \ "\nThere are EVEN MORE flags that are specific to each filesystem.\n" \ "You'll have to see the written documentation for those." +#define mount_example_usage \ + "$ mount\n" \ + "/dev/hda3 on / type minix (rw)\n" \ + "proc on /proc type proc (rw)\n" \ + "devpts on /dev/pts type devpts (rw)\n" \ + "$ mount /dev/fd0 /mnt -t msdos -o ro\n" \ + "$ mount /tmp/diskimage /opt -t ext2 -o loop\n" #define mt_trivial_usage \ "[-f device] opcode value" @@ -740,16 +1099,34 @@ "or: mv SOURCE... DIRECTORY" #define mv_full_usage \ "Rename SOURCE to DEST, or move SOURCE(s) to DIRECTORY." +#define mv_example_usage \ + "$ mv /tmp/foo /bin/bar\n" #define nc_trivial_usage \ "[IP] [port]" #define nc_full_usage \ "Netcat opens a pipe to IP:port" +#define nc_example_usage \ + "$ nc foobar.somedomain.com 25\n" \ + "220 foobar ESMTP Exim 3.12 #1 Sat, 15 Apr 2000 00:03:02 -0600\n" \ + "help\n" \ + "214-Commands supported:\n" \ + "214- HELO EHLO MAIL RCPT DATA AUTH\n" \ + "214 NOOP QUIT RSET HELP\n" \ + "quit\n" \ + "221 foobar closing connection\n" #define nslookup_trivial_usage \ "[HOST]" #define nslookup_full_usage \ "Queries the nameserver for the IP address of the given HOST" +#define nslookup_example_usage \ + "$ nslookup localhost\n" \ + "Server: default\n" \ + "Address: default\n" \ + "\n" \ + "Name: debian\n" \ + "Address: 127.0.0.1\n" #ifdef BB_FEATURE_SIMPLE_PING #define ping_trivial_usage "host" @@ -765,6 +1142,14 @@ "\t-q\t\tQuiet mode, only displays output at start\n" \ "\t\t\tand when finished." #endif +#define ping_example_usage \ + "$ ping localhost\n" \ + "PING slag (127.0.0.1): 56 data bytes\n" \ + "64 bytes from 127.0.0.1: icmp_seq=0 ttl=255 time=20.1 ms\n" \ + "\n" \ + "--- debian ping statistics ---\n" \ + "1 packets transmitted, 1 packets received, 0% packet loss\n" \ + "round-trip min/avg/max = 20.1/20.1/20.1 ms\n" #define pivot_root_trivial_usage \ "new_root put_old" @@ -782,17 +1167,35 @@ #define printf_full_usage \ "Formats and prints ARGUMENT(s) according to FORMAT,\n" \ "Where FORMAT controls the output exactly as in C printf." +#define printf_example_usage \ + "$ printf "Val=%d\n" 5\n" \ + "Val=5\n" #define ps_trivial_usage \ "" #define ps_full_usage \ "Report process status\n" \ "\nThis version of ps accepts no options." +#define ps_example_usage \ + "$ ps\n" \ + " PID Uid Gid State Command\n" \ + " 1 root root S init\n" \ + " 2 root root S [kflushd]\n" \ + " 3 root root S [kupdate]\n" \ + " 4 root root S [kpiod]\n" \ + " 5 root root S [kswapd]\n" \ + " 742 andersen andersen S [bash]\n" \ + " 743 andersen andersen S -bash\n" \ + " 745 root root S [getty]\n" \ + " 2990 andersen andersen R ps\n" #define pwd_trivial_usage \ "" #define pwd_full_usage \ "Print the full filename of the current working directory." +#define pwd_example_usage \ + "$ pwd\n" \ + "/root\n" #define rdate_trivial_usage \ "[OPTION] HOST" @@ -838,11 +1241,15 @@ USAGE_RM_INTERACTIVE("\t-i\t\talways prompt before removing each destinations\n") \ "\t-f\t\tremove existing destinations, never prompt\n" \ "\t-r or -R\tremove the contents of directories recursively" +#define rm_example_usage \ + "$ rm -rf /tmp/foo\n" #define rmdir_trivial_usage \ "[OPTION]... DIRECTORY..." #define rmdir_full_usage \ "Remove the DIRECTORY(ies), if they are empty." +#define rmdir_example_usage \ + "# rmdir /tmp/foo\n" #define rmmod_trivial_usage \ "[OPTION]... [MODULE]..." @@ -850,6 +1257,8 @@ "Unloads the specified kernel modules from the kernel.\n\n" \ "Options:\n" \ "\t-a\tTry to remove all unused kernel modules." +#define rmmod_example_usage \ + "$ rmmod tulip\n" #define route_trivial_usage \ "[{add|del|flush}]" @@ -873,6 +1282,9 @@ "If no -e or -f is given, the first non-option argument is taken as the\n" \ "sed script to interpret. All remaining arguments are names of input\n" \ "files; if no input files are specified, then the standard input is read." +#define sed_example_usage \ + "$ echo "foo" | sed -e 's/f[a-zA-Z]o/bar/g'\n" \ + "bar\n" #define setkeycodes_trivial_usage \ "SCANCODE KEYCODE ..." @@ -881,17 +1293,31 @@ "allowing unusual keyboards to generate usable keycodes.\n\n" \ "SCANCODE may be either xx or e0xx (hexadecimal),\n" \ "and KEYCODE is given in decimal" +#define setkeycodes_example_usage \ + "$ setkeycodes e030 127\n" #define sh_trivial_usage \ "[FILE]...\n" \ "or: sh -c command [args]..." #define sh_full_usage \ - "lash: The BusyBox command interpreter (shell)." + "lash: The BusyBox LAme SHell (command interpreter)" +#define sh_notes_usage \ +"This command does not yet have proper documentation.\n" \ +"\n" \ +"Use lash just as you would use any other shell. It properly handles pipes,\n" \ +"redirects, job control, can be used as the shell for scripts, and has a\n" \ +"sufficient set of builtins to do what is needed. It does not (yet) support\n" \ +"Bourne Shell syntax. If you need things like "if-then-else", "while", and such\n" \ +"use ash or bash. If you just need a very simple and extremely small shell,\n" \ +"this will do the job." #define sleep_trivial_usage \ "N" #define sleep_full_usage \ "Pause for N seconds." +#define sleep_example_usage \ + "$ sleep 2\n" \ + "[2 second delay results]\n" #ifdef BB_FEATURE_SORT_REVERSE @@ -903,6 +1329,14 @@ "[-n]" USAGE_SORT_REVERSE(" [-r]") " [FILE]..." #define sort_full_usage \ "Sorts lines of text in the specified files" +#define sort_example_usage \ + "$ echo -e "e\nf\nb\nd\nc\na" | sort\n" \ + "a\n" \ + "b\n" \ + "c\n" \ + "d\n" \ + "e\n" \ + "f\n" #define stty_trivial_usage \ "[-a|g] [-F device] [SETTING]..." @@ -952,6 +1386,9 @@ USAGE_REMOTE_LOG( \ "\n\t-R HOST[:PORT]\tLog to IP or hostname on PORT (default PORT=514/UDP)\n" \ "\t-L\t\tLog locally and via network logging (default is network only)") +#define syslogd_example_usage \ + "$ syslogd -R masterlog:514\n" \ + "$ syslogd -R 192.168.1.1:601\n" #ifdef BB_FEATURE_SIMPLE_TAIL @@ -969,14 +1406,15 @@ USAGE_UNSIMPLE_TAIL("\t-c N[kbm]\toutput the last N bytes\n") \ "\t-n N[kbm]\tprint last N lines instead of last 10\n" \ "\t-f\t\toutput data as the file grows" \ - USAGE_UNSIMPLE_TAIL( \ - "\n\t-q\t\tnever output headers giving file names\n" \ + USAGE_UNSIMPLE_TAIL( "\n\t-q\t\tnever output headers giving file names\n" \ "\t-s SEC\t\twait SEC seconds between reads with -f\n" \ "\t-v\t\talways output headers giving file names\n\n" \ - "If the first character of N (bytes or lines) is a `+', output begins with \n" \ + "If the first character of N (bytes or lines) is a '+', output begins with \n" \ "the Nth item from the start of each file, otherwise, print the last N items\n" \ - "in the file. N bytes may be suffixed by k (x1024), b (x512), or m (1024^2)." \ - ) + "in the file. N bytes may be suffixed by k (x1024), b (x512), or m (1024^2)." ) +#define tail_example_usage \ + "$ tail -n 1 /etc/resolv.conf\n" \ + "nameserver 10.0.0.1\n" #ifdef BB_FEATURE_TAR_CREATE #define USAGE_TAR_CREATE(a) a @@ -1007,6 +1445,9 @@ ) \ "\nInformative output:\n" \ "\tv\t\tverbosely list files processed" +#define tar_example_usage \ + "$ zcat /tmp/tarball.tar.gz | tar -xf -\n" \ + "$ tar -cf /tmp/tarball.tar /usr/local\n" #define tee_trivial_usage \ "[OPTION]... [FILE]..." @@ -1014,6 +1455,10 @@ "Copy standard input to each FILE, and also to standard output.\n\n" \ "Options:\n" \ "\t-a\tappend to the given FILEs, do not overwrite" +#define tee_example_usage \ + "$ echo "Hello" | tee /tmp/foo\n" \ + "$ cat /tmp/foo\n" \ + "Hello\n" #define telnet_trivial_usage \ "host [port]" @@ -1026,6 +1471,19 @@ #define test_full_usage \ "Checks file types and compares values returning an exit\n" \ "code determined by the value of EXPRESSION." +#define test_example_usage \ + "$ test 1 -eq 2\n" \ + "$ echo $?\n" \ + "1\n" \ + "$ test 1 -eq 1\n" \ + "$ echo $? \n" \ + "0\n" \ + "$ [ -d /etc ]\n" \ + "$ echo $?\n" \ + "0\n" \ + "$ [ -d /junk ]\n" \ + "$ echo $?\n" \ + "1\n" #ifdef BB_FEATURE_TFTP_GET #define USAGE_TFTP_GET(a) a @@ -1057,6 +1515,12 @@ "Update the last-modified date on the given file[s].\n\n" \ "Options:\n" \ "\t-c\tDo not create any files" +#define touch_example_usage \ + "$ ls -l /tmp/foo\n" \ + "/bin/ls: /tmp/foo: No such file or directory\n" \ + "$ touch /tmp/foo\n" \ + "$ ls -l /tmp/foo\n" \ + "-rw-rw-r-- 1 andersen andersen 0 Apr 15 01:11 /tmp/foo\n" #define tr_trivial_usage \ "[-cds] STRING1 [STRING2]" @@ -1067,11 +1531,18 @@ "\t-c\ttake complement of STRING1\n" \ "\t-d\tdelete input characters coded STRING1\n" \ "\t-s\tsqueeze multiple output characters of STRING2 into one character" +#define tr_example_usage \ + "$ echo "gdkkn vnqkc" | tr [a-y] [b-z]\n" \ + "hello world\n" #define true_trivial_usage \ "" #define true_full_usage \ "Return an exit code of TRUE (0)." +#define true_example_usage \ + "$ true\n" \ + "$ echo $?\n" \ + "0\n" #define tty_trivial_usage \ "" @@ -1079,6 +1550,9 @@ "Print the file name of the terminal connected to standard input.\n\n"\ "Options:\n" \ "\t-s\tprint nothing, only return an exit status" +#define tty_example_usage \ + "$ tty\n" \ + "/dev/tty2\n" #ifdef BB_FEATURE_MOUNT_FORCE #define USAGE_MOUNT_FORCE(a) a @@ -1094,6 +1568,8 @@ "\n\t-r:\tTry to remount devices as read-only if mount is busy" \ USAGE_MOUNT_FORCE("\n\t-f:\tForce filesystem umount (i.e. unreachable NFS server)") \ USAGE_MOUNT_LOOP("\n\t-l:\tDo not free loop device (if a loop device has been used)") +#define umount_example_usage \ + "$ umount /dev/hdc1 \n" #define uname_trivial_usage \ "[OPTION]..." @@ -1107,6 +1583,9 @@ "\t-s\tprint the operating system name\n" \ "\t-p\tprint the host processor type\n" \ "\t-v\tprint the operating system version" +#define uname_example_usage \ + "$ uname -a\n" \ + "Linux debian 2.2.15pre13 #5 Tue Mar 14 16:03:50 MST 2000 i686 unknown\n" #define uniq_trivial_usage \ "[OPTION]... [INPUT [OUTPUT]]" @@ -1117,6 +1596,11 @@ "\t-c\tprefix lines by the number of occurrences\n" \ "\t-d\tonly print duplicate lines\n" \ "\t-u\tonly print unique lines" +#define uniq_example_usage \ + "$ echo -e "a\na\nb\nc\nc\na" | sort | uniq\n" \ + "a\n" \ + "b\n" \ + "c\n" #define unix2dos_trivial_usage \ "[option] [file]" @@ -1136,11 +1620,17 @@ "" #define uptime_full_usage \ "Display the time since the last boot." +#define uptime_example_usage \ + "$ uptime\n" \ + " 1:55pm up 2:30, load average: 0.09, 0.04, 0.00\n" #define usleep_trivial_usage \ "N" #define usleep_full_usage \ "Pause for N microseconds." +#define usleep_example_usage \ + "$ usleep 1000000\n" \ + "[pauses for 1 second]\n" #define uudecode_trivial_usage \ "[FILE]..." @@ -1148,6 +1638,10 @@ "Uudecode a file that is uuencoded.\n\n" \ "Options:\n" \ "\t-o FILE\tdirect output to FILE" \ +#define uudecode_example_usage \ + "$ uudecode -o busybox busybox.uu\n" \ + "$ ls -l busybox\n" \ + "-rwxr-xr-x 1 ams ams 245264 Jun 7 21:35 busybox\n" #define uuencode_trivial_usage \ "[OPTION] [INFILE] REMOTEFILE" @@ -1155,6 +1649,12 @@ "Uuencode a file.\n\n" \ "Options:\n" \ "\t-m\tuse base64 encoding as of RFC1521" +#define uuencode_example_usage \ + "$ uuencode busybox busybox\n" \ + "begin 755 busybox\n" \ + "<encoded file snipped>\n" \ + "$ uudecode busybox busybox > busybox.uu\n" \ + "$\n" #define watchdog_trivial_usage \ "DEV" @@ -1171,6 +1671,9 @@ "\t-l\tprint the newline counts\n" \ "\t-L\tprint the length of the longest line\n" \ "\t-w\tprint the word counts" +#define wc_example_usage \ + "$ wc /etc/passwd\n" \ + " 31 46 1365 /etc/passwd\n" #define wget_trivial_usage \ "[-c] [-O file] url" @@ -1184,6 +1687,9 @@ "[COMMAND ...]" #define which_full_usage \ "Locates a COMMAND." +#define which_example_usage \ + "$ which login\n" \ + "/bin/login\n" #define whoami_trivial_usage \ "" @@ -1194,11 +1700,14 @@ "[COMMAND] [ARGS...]" #define xargs_full_usage \ "Executes COMMAND on every item given by standard input." +#define xargs_example_usage \ + "$ ls | xargs gzip\n" \ + "$ find . -name '*.c' -print | xargs rm\n" #define yes_trivial_usage \ "[OPTION]... [STRING]..." #define yes_full_usage \ - "Repeatedly outputs a line with all specified STRING(s), or `y'." + "Repeatedly outputs a line with all specified STRING(s), or 'y'." #define zcat_trivial_usage \ "FILE" diff --git a/util-linux/fbset.c b/util-linux/fbset.c index 80711ec9f..41c7f9796 100644 --- a/util-linux/fbset.c +++ b/util-linux/fbset.c @@ -42,7 +42,6 @@ static const int OPT_INFO = (1 << 1); static const int OPT_READMODE = (1 << 2); enum { - CMD_HELP = 0, CMD_FB = 1, CMD_DB = 2, CMD_GEOMETRY = 3, @@ -138,7 +137,6 @@ static struct cmdoptions_t { unsigned char code; } g_cmdoptions[] = { { - "-h", 0, CMD_HELP}, { "-fb", 1, CMD_FB}, { "-db", 1, CMD_DB}, { "-a", 0, CMD_ALL}, { @@ -150,10 +148,8 @@ static struct cmdoptions_t { "-vsync", 1, CMD_VSYNC}, { "-laced", 1, CMD_LACED}, { "-double", 1, CMD_DOUBLE}, { - "-help", 0, CMD_HELP}, { "-n", 0, CMD_CHANGE}, { #ifdef BB_FEATURE_FBSET_FANCY - "-help", 0, CMD_HELP}, { "-all", 0, CMD_ALL}, { "-xres", 1, CMD_XRES}, { "-yres", 1, CMD_YRES}, { @@ -356,8 +352,6 @@ extern int fbset_main(int argc, char **argv) if (argc - 1 < g_cmdoptions[i].param_count) show_usage(); switch (g_cmdoptions[i].code) { - case CMD_HELP: - show_usage(); case CMD_FB: fbdev = argv[1]; break; |