diff options
Diffstat (limited to 'docs/busybox.pod')
| -rw-r--r-- | docs/busybox.pod | 711 |
1 files changed, 443 insertions, 268 deletions
diff --git a/docs/busybox.pod b/docs/busybox.pod index 3aecf3cff..127cf89b5 100644 --- a/docs/busybox.pod +++ b/docs/busybox.pod @@ -1,4 +1,4 @@ -# pod2man --center=Lineo --release="version 0.43" busybox.pod > busybox.1 +# vi: set sw=4 ts=4: =head1 NAME @@ -36,20 +36,18 @@ tries to make itself useful to small systems with limited resources. Currently defined functions include: -basename, cat, chmod, chown, chgrp, chroot, clear, chvt, cp, mv, date, -dd, df, dirname, dmesg, du, dutmp, echo, fbset, fdflush, find, free, +basename, cat, chmod, chown, chgrp, chroot, clear, chvt, cp, date, +dd, df, dirname, dmesg, du, dutmp, echo, false, fbset, fdflush, find, free, freeramdisk, deallocvt, fsck.minix, mkfs.minix, grep, gunzip, gzip, halt, head, hostid, hostname, init, kill, killall, length, ln, loadacm, loadfont, loadkmap, ls, lsmod, makedevs, math, mkdir, mkfifo, mknod, -mkswap, mnc, more, mount, mt, nslookup, poweroff, ping, printf, ps, +mkswap, mnc, more, mount, mt, mv, nslookup, poweroff, ping, printf, ps, pwd, reboot, rm, rmdir, rmmod, sed, sh, fdisk, sfdisk, sleep, sort, sync, syslogd, logger, logname, swapon, swapoff, tail, tar, [, test, -tee, touch, tr, true, false, tty, umount, uname, uptime, uniq, update, +tee, touch, tr, true, tty, umount, uname, uptime, uniq, update, usleep, wc, whoami, yes, zcat -=head1 OPTIONS - -Common Options: +=head1 COMMON OPTIONS Most BusyBox commands support the B<--help> option to provide a terse runtime description of their behavior. @@ -69,6 +67,8 @@ Example: $ basename /usr/local/bin/ bin +------------------------------- + =item cat Usage: cat [file ...] @@ -80,6 +80,8 @@ Example: $ cat /proc/uptime 110716.72 17.67 +------------------------------- + =item chmod Usage: chmod [B<-R>] MODE[,MODE]... FILE... @@ -112,20 +114,20 @@ PERMISSION may be chosen from: Alternately, permissions may be set numerically where the first three numbers are calculated by adding the octal values: - + 4 Read 2 Write 1 eXecute An optional fourth digit may also be used to specify - + 4 Set user ID 2 Set group ID 1 sTickey bit Options: - -R change files and directories recursively. + -R change files and directories recursively. Example: @@ -138,6 +140,8 @@ Example: $ ls -l /tmp/foo -r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo +------------------------------- + =item chown Usage: chown [OPTION]... OWNER[.[GROUP] FILE... @@ -146,7 +150,7 @@ Changes the owner and/or group of each FILE to OWNER and/or GROUP. Options: - -R change files and directories recursively + -R change files and directories recursively Example: @@ -159,6 +163,8 @@ Example: ls -l /tmp/foo -r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo +------------------------------- + =item chgrp Usage: chgrp [OPTION]... GROUP FILE... @@ -167,7 +173,7 @@ Change the group membership of each FILE to GROUP. Options: - -R change files and directories recursively + -R change files and directories recursively Example: @@ -177,31 +183,38 @@ Example: $ ls -l /tmp/foo -r--r--r-- 1 andersen root 0 Apr 12 18:25 /tmp/foo +------------------------------- + =item chroot Usage: chroot NEWROOT [COMMAND...] Run COMMAND with root directory set to NEWROOT. -Exmaple: +Example: $ ls -l /bin/ls - lrwxrwxrwx 1 root root 12 Apr 13 00:46 /bin/ls -> /bin/busybox + 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 clear Clears the screen. +------------------------------- + =item chvt Usage: chvt N Change foreground virtual terminal to /dev/ttyN +------------------------------- =item cp @@ -216,6 +229,8 @@ Copy SOURCE to DEST, or multiple SOURCE(s) to DIRECTORY. -p preserve file attributes if possable -R copy directories recursively +------------------------------- + =item date Usage: date [OPTION]... [+FORMAT] @@ -226,44 +241,47 @@ Display the current time in the given FORMAT, or set the system date. Options: - -R output RFC-822 compliant date string - -s set time described by STRING - -u print or set Coordinated Universal Time + -R output RFC-822 compliant date string + -s set time described by STRING + -u print or set Coordinated Universal Time Example: $ date Wed Apr 12 18:52:41 MDT 2000 +------------------------------- + =item dd Usage: dd [if=name] [of=name] [bs=n] [count=n] [skip=n] [seek=n] 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 Numbers may be suffixed by w (x2), k (x1024), b (x512), or M (x1024^2) - Example: $ dd if=/dev/zero of=/dev/ram1 bs=1M count=4 4+0 records in 4+0 records out +------------------------------- + =item df Usage: df [filesystem ...] Prints the filesystem space used and space available. -Exmaple: +Example: $ df Filesystem 1k-blocks Used Available Use% Mounted on @@ -273,12 +291,31 @@ Exmaple: Filesystem 1k-blocks Used Available Use% Mounted on /dev/sda3 8690864 8553540 137324 98% / +------------------------------- + +=item dirname + +Usage: dirname NAME + +Strip non-directory suffix from file name + +Example: + + $ dirname /tmp/foo + /tmp + $ dirname /tmp/foo/ + /tmp + +------------------------------- + =item dmesg Usage: dmesg [B<-c>] [B<-n> level] [B<-s> bufsize] Print or controls the kernel ring buffer. +------------------------------- + =item du Usage: du [OPTION]... [FILE]... @@ -288,8 +325,8 @@ Disk space is printed in units of 1k (i.e. 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 Example: @@ -305,6 +342,56 @@ Example: 104 ./docs 2417 . +------------------------------- + +=item dutmp + +Usage: dutmp [FILE] + +Dump utmp file format (pipe delimited) from FILE +or stdin to stdout. + +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 + +------------------------------- + +=item echo + +Usage: echo [-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 + +Example: + + $ echo "Erik is cool" + Erik is cool + $ echo -e "Erik\nis\ncool" + Erik + is + cool + $ echo "Erik\nis\ncool" + Erik\nis\ncool + +------------------------------- + +=item false + +------------------------------- =item fbset @@ -314,19 +401,39 @@ Show and modify frame buffer device settings Options: - -h - -fb - -db - -a - -i - -g - -t - -accel - -hsync - -vsync - -laced - -double + -h + -fb + -db + -a + -i + -g + -t + -accel + -hsync + -vsync + -laced + -double + +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 + +------------------------------- +=item fdflush + +Usage: fdflush device + +Force floppy disk drive to detect disk change + +------------------------------- =item find @@ -337,18 +444,18 @@ the current directory; default EXPRESSION is '-print' EXPRESSION may consist of: - -follow - Dereference symbolic links. - -name PATTERN - File name (with leading directories removed) matches PATTERN. - -print - print the full file name followed by a newline to stdout. + + -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. Example: $ find / -name /etc/passwd /etc/passwd +------------------------------- + =item free Usage: free @@ -363,6 +470,19 @@ Example: Swap: 128516 8404 120112 Total: 386144 257128 129016 +------------------------------- + +=item freeramdisk + +Usage: freeramdisk DEVICE + +Free all memory used by the specified ramdisk. + +Example: + + $ freeramdisk /dev/ram2 + +------------------------------- =item deallocvt @@ -370,6 +490,7 @@ Usage: deallocvt N Deallocates unused virtual terminal /dev/ttyN +------------------------------- =item fsck.minix @@ -379,14 +500,15 @@ 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 mkfs.minix @@ -396,12 +518,13 @@ 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 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 grep @@ -411,14 +534,13 @@ 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 + -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 This version of grep matches full regular expresions. - Example: $ grep root /etc/passwd @@ -426,6 +548,23 @@ Example: $ grep ^[rR]oo. /etc/passwd root:x:0:0:root:/root:/bin/bash +------------------------------- + +=item gunzip + + +------------------------------- + +=item gzip + + +------------------------------- + +=item halt + + +------------------------------- + =item head Usage: head [OPTION] [FILE]... @@ -436,7 +575,7 @@ 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: @@ -444,6 +583,13 @@ Example: root:x:0:0:root:/root:/bin/bash daemon:x:1:1:daemon:/usr/sbin:/bin/sh +------------------------------- + +=item hostid + + +------------------------------- + =item hostname Usage: hostname [OPTION] {hostname | B<-F> file} @@ -453,16 +599,23 @@ Get or set the hostname or DNS domain name. If a hostname is given Options: - -s Short - -i Addresses for the hostname - -d DNS domain name - -F FILE Use the contents of FILE to specify the hostname + -s Short + -i Addresses for the hostname + -d DNS domain name + -F FILE Use the contents of FILE to specify the hostname Example: $ hostname slag +------------------------------- + +=item init + + +------------------------------- + =item kill Usage: kill [B<-signal>] process-id [process-id ...] @@ -471,7 +624,7 @@ 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: @@ -484,6 +637,17 @@ Example: 267 www-data www-data S [apache] $ kill 252 +------------------------------- + +=item killall + +------------------------------- + +=item length + + +------------------------------- + =item ln Usage: ln [OPTION] TARGET... LINK_NAME|DIRECTORY @@ -491,332 +655,339 @@ Create a link named LINK_NAME or DIRECTORY to the specified TARGET Options: - -s make symbolic links instead of hard links - -f remove existing destination files + -s make symbolic links instead of hard links + -f remove existing destination files +Example: + + $ ln -s busybox /tmp/ls + [andersen@debian busybox]$ ls -l /tmp/ls + lrwxrwxrwx 1 root root 7 Apr 12 18:39 ls -> busybox* + +------------------------------- + +=item loadacm + +------------------------------- + +=item loadfont + +------------------------------- + +=item loadkmap + +------------------------------- =item ls Usage: ls [B<-1acdelnpuxACF>] [filenames...] + +Options: + + -a do not hide entries starting with . + -c with -l: show ctime (the time of last + modification of file status information) + -d list directory entries instead of contents + -e list both full date and full time + -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) + -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 +------------------------------- =item lsmod +Usage: lsmod + +Shows information about all loaded modules. + +------------------------------- + +=item makedevs +------------------------------- + +=item math + +------------------------------- =item mkdir -Usage: Usage: mkdir [OPTION] DIRECTORY... +Usage: 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 existing, make parent directories as needed - + -m set permission mode (as in chmod), not rwxrwxrwx - umask + -p no error if dir exists, 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 + +------------------------------- + +=item mkfifo + +------------------------------- =item mknod Usage: mknod NAME TYPE MAJOR MINOR + Make 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. + +Example: + + $ mknod /dev/fd0 b 2 0 + +------------------------------- =item mkswap -Usage: mkswap [B<-c>] [-v0|-v1] device [block-count] +Usage: 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 mnc + +------------------------------- =item more Usage: more [file ...] + +More is a filter for paging through text one screenful at a time. + +Example: + + $ dmesg | more +------------------------------- =item mount -Usage: mount [flags] - -mount [flags] device directory [B<-o> options,more-options] - - Flags: - -a: Mount all file systems in fstab. - -o option: One of many filesystem options, listed below. - -r: Mount the filesystem read-only. - -t filesystem-type: Specify the filesystem type. - -w: Mount for reading and writing (default). - Options for use with the "-o" flag: - async / sync: Writes are asynchronous / synchronous. - 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. - +Usage: mount [flags] + mount [flags] device directory [B<-o> options,more-options] -=item mv +Flags: -Usage: mv SOURCE DEST + -a: Mount all file systems in fstab. + -o option: One of many filesystem options, listed below. + -r: Mount the filesystem read-only. + -t filesystem-type: Specify the filesystem type. + -w: Mount for reading and writing (default). -or: mv SOURCE... DIRECTORY +Options for use with the "B<-o>" flag: -Rename SOURCE to DEST, or move SOURCE(s) to DIRECTORY. - + async / sync: Writes are asynchronous / synchronous. + 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. -=item ping +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 + +------------------------------- +=item mt -=item poweroff +------------------------------- +=item mv +Usage: mv SOURCE DEST -=item ps + or: mv SOURCE... DIRECTORY + +Rename SOURCE to DEST, or move SOURCE(s) to DIRECTORY. -Usage: ps +Example: -Report process status. -This version of ps accepts no options. + $ mv /tmp/foo /bin/bar +------------------------------- -=item pwd +=item nslookup +------------------------------- +=item poweroff -=item reboot +------------------------------- +=item ping +Usage: ping [OPTION]... host -=item rm +Send ICMP ECHO_REQUEST packets to network hosts. -Usage: rm [OPTION]... FILE... -Remove (unlink) the FILE(s). - Options: - -f remove existing destinations, never prompt - -r or -R remove the contents of directories recursively - + -c COUNT Send only COUNT pings. + -q Quiet mode, only displays output at start + and when finished. +Example: -=item rmdir + $ 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 -Usage: rmdir [OPTION]... DIRECTORY... -Remove the DIRECTORY(ies), if they are empty. - + --- 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 sed +------------------------------- -Usage: sed [B<-n>] B<-e> script [file...] -Allowed sed scripts come in the following form: +=item printf - 'ADDR [!] COMMAND' - 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. - aTEXT - which appends TEXT after the pattern space +------------------------------- -Options: +=item ps - -e add the script to the commands to be executed - -n suppress automatic printing of pattern space +------------------------------- -This version of sed matches full regular expresions. - - -=item sleep +=item pwd -Usage: sleep N +------------------------------- -Pause for N seconds. - +=item reboot -=item sort +------------------------------- -Usage: Usage: sort [OPTION]... [FILE]... - +=item rm -=item sync +------------------------------- -Usage: sync +=item syslogd -Write all buffered filesystem blocks to disk. - +------------------------------- -=item syslogd +=item logger -Usage: syslogd [OPTION]... +------------------------------- -Linux system and kernel (provides klogd) logging utility. -Note that this version of syslogd/klogd ignores /etc/syslog.conf. - -Options: +=item logname - -m Change the mark timestamp interval. default=20min. 0=off - -n Do not fork into the background (for when run by init) - -K Do not start up the klogd process (by default syslogd spawns klogd). - -O Specify an alternate log file. default=/var/log/messages - +------------------------------- =item swapon -Usage: swapon device - -Start swapping virtual memory pages on the given device. - +------------------------------- =item swapoff -Usage: swapoff device - -Stop swapping virtual memory pages on the given device. - +------------------------------- =item tail -Usage: 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 file name. -With no FILE, or when FILE is -, read standard input. - - -c=N[kbm] output the last N bytes - -f output appended data as the file grows - -n=N output the last N lines, instead of last 10 - -q never output headers giving file names - -v always output headers giving file names - --help display this help and exit - -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). - +------------------------------- =item tar +------------------------------- +=item test, [ + +------------------------------- =item tee -Usage: tee [OPTION]... [FILE]... -Copy standard input to each FILE, and also to standard output. - -Options: - - -a append to the given FILEs, do not overwrite - +------------------------------- =item touch -Usage: touch [B<-c>] file [file ...] - Update the last-modified date on the given file[s]. - - -=item true +------------------------------- +=item tr +------------------------------- -=item false +=item true +------------------------------- +=item tty -=item uname +------------------------------- -Usage: uname [OPTION]... - -Print certain system information. With no OPTION, same as B<-s>. - -Options: +=item umount - -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 - +------------------------------- -=item umount +=item uname -Usage: Usage: umount [flags] filesystem|directory +------------------------------- -Flags: +=item uptime - -a: Unmount all file systems - +------------------------------- =item uniq -Usage: Usage: uniq [OPTION]... [INPUT [OUTPUT]] +------------------------------- -Discard all but one of successive identical lines from INPUT (or -standard input), writing to OUTPUT (or standard output). +=item update - -h display this help and exit +------------------------------- -A field is a run of whitespace, then non-whitespace characters. -Fields are skipped before chars. - +=item usleep -=item zcat +------------------------------- -Usage: gunzip [OPTION]... FILE +=item wc -Uncompress FILE (or standard input if FILE is '-'). - -Options: +------------------------------- - -c Write output to standard output - -t Test compressed file integrity - +=item whoami -=item gunzip +------------------------------- -Usage: gunzip [OPTION]... FILE +=item yes -Uncompress FILE (or standard input if FILE is '-'). - -Options: +------------------------------- - -c Write output to standard output - -t Test compressed file integrity - - -=item gzip - -Usage: 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 - +=item zcat +------------------------------- =back @@ -869,5 +1040,9 @@ Enrique Zanardi <ezanardi@ull.es> =for html <br> +Karl M. Hegbloom <karlheg@debian.org> + +=for html <br> + =cut |