From 5331025f796d1defe90c8dda1fe1481de95850e5 Mon Sep 17 00:00:00 2001 From: Eric Andersen Date: Tue, 4 Jul 2000 19:42:23 +0000 Subject: A first pass at integrating the SGML docs into the Makefile. A first pass a cleaning up the current SGML (lots more cleanup is needed though). -Erik --- docs/busybox.net/index.html | 1 + docs/busybox.sgml | 553 ++++++++++++++++++-------------------------- 2 files changed, 232 insertions(+), 322 deletions(-) (limited to 'docs') diff --git a/docs/busybox.net/index.html b/docs/busybox.net/index.html index 806f2f0..f98f6ea 100644 --- a/docs/busybox.net/index.html +++ b/docs/busybox.net/index.html @@ -170,6 +170,7 @@ I know of the following projects that use BusyBox
  • tomsrtbt
  • Stormix Installer
  • EMAC Linux 2.0 SBC +
  • Trinux Do you use BusyBox? I'd love to know about it and I'd be happy to link to you. diff --git a/docs/busybox.sgml b/docs/busybox.sgml index cf7161a..ac3e7e7 100644 --- a/docs/busybox.sgml +++ b/docs/busybox.sgml @@ -1,326 +1,235 @@ - - - - - - - - - - -BusyBox - The Swiss Army Knife of Embedded Linux +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [...]> +<book id="BusyBoxDocumentation"> + <bookinfo> + <title>BusyBox - The Swiss Army Knife of Embedded Linux + + + + This documentation is free software; you can redistribute + it and/or modify it under the terms of the GNU General Public + License as published by the Free Software Foundation; either + version 2 of the License, or (at your option) any later + version. + + + + This program is distributed in the hope that it will be + useful, but WITHOUT ANY WARRANTY; without even the implied + warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. + See the GNU General Public License for more details. + + + + You should have received a copy of the GNU General Public + License along with this program; if not, write to the Free + Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, + MA 02111-1307 USA + + + + For more details see the file COPYING in the source + distribution of Linux. + + + + + + + Introduction + + + BusyBox combines tiny versions of many common UNIX utilities into a single + small executable. It provides minimalist replacements for most of the + utilities you usually find in fileutils, shellutils, findutils, textutils, + grep, gzip, tar, etc. BusyBox provides a fairly complete POSIX environment + for any small or embedded system. The utilities in BusyBox generally have + fewer options than their full-featured GNU cousins; however, the options + that are included provide the expected functionality and behave very much + like their GNU counterparts. + + + + BusyBox has been written with size-optimization and limited resources in + mind. It is also extremely modular so you can easily include or exclude + commands (or features) at compile time. This makes it easy to customize + your embedded systems. To create a working system, just add a kernel, a + shell (such as ash), and an editor (such as elvis-tiny or ae). + + + + + + How to use BusyBox + + Syntax + + BusyBox <function> [arguments...] # or + + + + + + <function> [arguments...] # if symlinked + + + + + + + + When you create a link to BusyBox for the function you wish to use, when + BusyBox is called using that link it will behave as if the command itself + has been invoked. + + + + For example, entering + + + + + ln -s ./BusyBox ls + ./ls + + + + + will cause BusyBox to behave as 'ls' (if the 'ls' command has been compiled + into BusyBox). + + + + You can also invoke BusyBox by issuing the command as an argument on the + command line. For example, entering + + + + + ./BusyBox ls + + + + + will also cause BusyBox to behave as 'ls'. + + + + + + + Most BusyBox commands support the --help option to provide + a terse runtime description of their behavior. + + + + + + BusyBox Commands + + Available BusyBox Commands + + Currently defined functions include: + + + + ar, basename, cat, chgrp, chmod, chown, chroot, chvt, clear, cp, cut, date, + dc, dd, deallocvt, df, dirname, dmesg, du, dutmp, echo, false, fbset, + fdflush, find, free, freeramdisk, fsck.minix, 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, reboot, rm, rmdir, rmmod, sed, + setkeycodes, sfdisk, sh, sleep, sort, swapoff, swapon, sync, syslogd, tail, + tar, tee, telnet, test, touch, tr, true, tty, umount, uname, uniq, update, + uptime, usleep, uudecode, uuencode, wc, which, whoami, yes, zcat, [ + + + + + + ar + + + Usage: ar [optxvV] 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 + + + + + + + + + basename + + Usage: 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 + + + + + + + cat + + + Usage: cat [FILE ...] + + + + Concatenates FILE(s) and prints them to the standard + output. + + + + Example: + + + + + $ cat /proc/uptime + 110716.72 17.67 + + + + - -NAME - - - - - - - - -BusyBox - The Swiss Army Knife of Embedded Linux - - - - -SYNTAX - - - - - - - - - - BusyBox <function> [arguments...] # or - - - - - - - - <function> [arguments...] # if symlinked - - - - - - - -DESCRIPTION - - - - - - - - -BusyBox combines tiny versions of many common UNIX utilities into a single -small executable. It provides minimalist replacements for most of the -utilities you usually find in fileutils, shellutils, findutils, textutils, -grep, gzip, tar, etc. BusyBox provides a fairly complete POSIX environment -for any small or embedded system. The utilities in BusyBox generally have -fewer options than their full-featured GNU cousins; however, the options -that are included provide the expected functionality and behave very much -like their GNU counterparts. - - - - - -BusyBox has been written with size-optimization and limited resources in -mind. It is also extremely modular so you can easily include or exclude -commands (or features) at compile time. This makes it easy to customize -your embedded systems. To create a working system, just add a kernel, a -shell (such as ash), and an editor (such as elvis-tiny or ae). - - - - - - -USAGE - - - - - - - - -When you create a link to BusyBox for the function you wish to use, when -BusyBox is called using that link it will behave as if the command itself -has been invoked. - - - - - -For example, entering - - - - - - - ln -s ./BusyBox ls - ./ls - - - - - - -will cause BusyBox to behave as 'ls' (if the 'ls' command has been compiled -into BusyBox). - - - - - -You can also invoke BusyBox by issuing the command as an argument on the -command line. For example, entering - - - - - - - ./BusyBox ls - - - - - - -will also cause BusyBox to behave as 'ls'. - - - - - - -COMMON OPTIONS - - - - - - - - -Most BusyBox commands support the --help option to provide a terse runtime description of their behavior. - - - - - - -COMMANDS - - - - - - - - -Currently defined functions include: - - - - - -ar, basename, cat, chgrp, chmod, chown, chroot, chvt, clear, cp, cut, date, -dc, dd, deallocvt, df, dirname, dmesg, du, dutmp, echo, false, fbset, -fdflush, find, free, freeramdisk, fsck.minix, 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, reboot, rm, rmdir, rmmod, sed, -setkeycodes, sfdisk, sh, sleep, sort, swapoff, swapon, sync, syslogd, tail, -tar, tee, telnet, test, touch, tr, true, tty, umount, uname, uniq, update, -uptime, usleep, uudecode, uuencode, wc, which, whoami, yes, zcat, [ - - - - - -------------------------------- - - - - - -ar - - - - - -Usage: ar [optxvV] 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 - - - - - - -------------------------------- - - - - - -basename - - - - - -Usage: 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 - - - - - - -------------------------------- - - - - - -cat - - - - - -Usage: cat [FILE ...] - - - - - -Concatenates FILE(s) and prints them to the standard -output. - - - - - -Example: - - - - - - - $ cat /proc/uptime - 110716.72 17.67 - - - - ------------------------------- -- cgit v1.1