summaryrefslogtreecommitdiff
path: root/docs/busybox.sgml
diff options
context:
space:
mode:
authorEric Andersen <andersen@codepoet.org>2000-07-04 19:42:23 +0000
committerEric Andersen <andersen@codepoet.org>2000-07-04 19:42:23 +0000
commit5331025f796d1defe90c8dda1fe1481de95850e5 (patch)
treee91f81403dd802cef97d474ce4e2a00aa7d83748 /docs/busybox.sgml
parentb02c54ebeef845480a09690fe092071d823c1f0f (diff)
downloadbusybox-w32-5331025f796d1defe90c8dda1fe1481de95850e5.tar.gz
busybox-w32-5331025f796d1defe90c8dda1fe1481de95850e5.tar.bz2
busybox-w32-5331025f796d1defe90c8dda1fe1481de95850e5.zip
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
Diffstat (limited to '')
-rw-r--r--docs/busybox.sgml553
1 files changed, 231 insertions, 322 deletions
diff --git a/docs/busybox.sgml b/docs/busybox.sgml
index cf7161a23..ac3e7e749 100644
--- a/docs/busybox.sgml
+++ b/docs/busybox.sgml
@@ -1,326 +1,235 @@
1<!DOCTYPE book PUBLIC "-//Davenport//DTD DocBook V2.4.1//EN" "/opt/texmf/gmat/sgml/Davenport/dtds/2.4.1/docbook.dtd"> 1<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [...]>
2<!-- --> 2<book id="BusyBoxDocumentation">
3<!-- $Id: busybox.sgml,v 1.1 2000/06/26 13:31:53 markw Exp $ --> 3 <bookinfo>
4<!-- --> 4 <title>BusyBox - The Swiss Army Knife of Embedded Linux</title>
5<!-- $Log: busybox.sgml,v $ 5
6<!-- Revision 1.1 2000/06/26 13:31:53 markw 6 <legalnotice>
7<!-- Just converted busybox.pod to busybox.sgml using the Pod::DocBook Perl module. 7 <para>
8<!-- The resulting file needs some massaging and once it gets presentable, I'll 8 This documentation is free software; you can redistribute
9<!-- edit the Makefile to use the SGML file as the "authoritative" file; the plan 9 it and/or modify it under the terms of the GNU General Public
10<!-- here is to generate other file formats from the SGML. 10 License as published by the Free Software Foundation; either
11<!-- --> 11 version 2 of the License, or (at your option) any later
12<!-- --> 12 version.
13<!-- General reminders: --> 13 </para>
14 14
15<book> 15 <para>
16 16 This program is distributed in the hope that it will be
17<chapter id="pod2docbook-ch-1"><title>BusyBox - The Swiss Army Knife of Embedded Linux 17 useful, but WITHOUT ANY WARRANTY; without even the implied
18 warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
19 See the GNU General Public License for more details.
20 </para>
21
22 <para>
23 You should have received a copy of the GNU General Public
24 License along with this program; if not, write to the Free
25 Software Foundation, Inc., 59 Temple Place, Suite 330, Boston,
26 MA 02111-1307 USA
27 </para>
28
29 <para>
30 For more details see the file COPYING in the source
31 distribution of Linux.
32 </para>
33 </legalnotice>
34 </bookinfo>
35
36<toc></toc>
37 <chapter id="Introduction">
38 <title>Introduction</title>
39
40 <para>
41 BusyBox combines tiny versions of many common UNIX utilities into a single
42 small executable. It provides minimalist replacements for most of the
43 utilities you usually find in fileutils, shellutils, findutils, textutils,
44 grep, gzip, tar, etc. BusyBox provides a fairly complete POSIX environment
45 for any small or embedded system. The utilities in BusyBox generally have
46 fewer options than their full-featured GNU cousins; however, the options
47 that are included provide the expected functionality and behave very much
48 like their GNU counterparts.
49 </para>
50
51 <para>
52 BusyBox has been written with size-optimization and limited resources in
53 mind. It is also extremely modular so you can easily include or exclude
54 commands (or features) at compile time. This makes it easy to customize
55 your embedded systems. To create a working system, just add a kernel, a
56 shell (such as ash), and an editor (such as elvis-tiny or ae).
57 </para>
58 </chapter>
59
60
61 <chapter id="Syntax">
62 <title>How to use BusyBox</title>
63 <sect1 id="How to use BusyBox">
64 <title>Syntax</title
65
66 <para>
67 <screen>
68 BusyBox &lt;function&gt; [arguments...] # or
69 </screen>
70 </para>
71
72 <para>
73 <screen>
74 &lt;function&gt; [arguments...] # if symlinked
75 </screen>
76 </para>
77 </sect1>
78
79
80 <sect1 id="Invoking BusyBox">
81 <para>
82 When you create a link to BusyBox for the function you wish to use, when
83 BusyBox is called using that link it will behave as if the command itself
84 has been invoked.
85 </para>
86
87 <para>
88 For example, entering
89 </para>
90
91 <para>
92 <screen>
93 ln -s ./BusyBox ls
94 ./ls
95 </screen>
96 </para>
97
98 <para>
99 will cause BusyBox to behave as 'ls' (if the 'ls' command has been compiled
100 into BusyBox).
101 </para>
102
103 <para>
104 You can also invoke BusyBox by issuing the command as an argument on the
105 command line. For example, entering
106 </para>
107
108 <para>
109 <screen>
110 ./BusyBox ls
111 </screen>
112 </para>
113
114 <para>
115 will also cause BusyBox to behave as 'ls'.
116 </para>
117
118 </sect1>
119
120 <sect1 id="Common options">
121 <para>
122 Most BusyBox commands support the <emphasis>--help</emphasis> option to provide
123 a terse runtime description of their behavior.
124 </para>
125 </sect1>
126 </chapter>
127
128 <chapter id="Commands">
129 <title>BusyBox Commands</title>
130 <sect1 id="Available BusyBox Commands">
131 <title>Available BusyBox Commands</title>
132 <para>
133 Currently defined functions include:
134 </para>
135
136 <para>
137 ar, basename, cat, chgrp, chmod, chown, chroot, chvt, clear, cp, cut, date,
138 dc, dd, deallocvt, df, dirname, dmesg, du, dutmp, echo, false, fbset,
139 fdflush, find, free, freeramdisk, fsck.minix, grep, gunzip, gzip, halt,
140 head, hostid, hostname, id, init, insmod, kill, killall, length, ln,
141 loadacm, loadfont, loadkmap, logger, logname, ls, lsmod, makedevs, mkdir,
142 mkfifo, mkfs.minix, mknod, mkswap, mktemp, more, mount, mt, mv, nc,
143 nslookup, ping, poweroff, printf, ps, pwd, reboot, rm, rmdir, rmmod, sed,
144 setkeycodes, sfdisk, sh, sleep, sort, swapoff, swapon, sync, syslogd, tail,
145 tar, tee, telnet, test, touch, tr, true, tty, umount, uname, uniq, update,
146 uptime, usleep, uudecode, uuencode, wc, which, whoami, yes, zcat, [
147 </para>
148 </sect1>
149
150
151 <sect1 id="ar">
152 <title>ar</title>
153
154 <para>
155 Usage: ar [optxvV] archive [filenames]
156 </para>
157
158 <para>
159 Extract or list files from an ar archive.
160 </para>
161
162 <para>
163 Options:
164 </para>
165
166 <para>
167 <screen>
168 o preserve original dates
169 p extract to stdout
170 t list
171 x extract
172 v verbosely list files processed
173 </screen>
174 </para>
175 </sect1>
176
177
178
179
180 <sect1 id="basename">
181 <title>basename</title>
182 <para>
183 Usage: basename FILE [SUFFIX]
184 </para>
185
186 <para>
187 Strips directory path and suffixes from FILE. If specified, also removes
188 any trailing SUFFIX.
189 </para>
190
191 <para>
192 Example:
193 </para>
194
195 <para>
196 <screen>
197 $ basename /usr/local/bin/foo
198 foo
199 $ basename /usr/local/bin/
200 bin
201 $ basename /foo/bar.txt .txt
202 bar
203 </screen>
204 </para>
205 </sect1>
206
207
208 <sect1 id="cat">
209 <title>cat</title>
210
211 <para>
212 Usage: cat [FILE ...]
213 </para>
214
215 <para>
216 Concatenates <literal>FILE(s)</literal> and prints them to the standard
217 output.
218 </para>
219
220 <para>
221 Example:
222 </para>
223
224 <para>
225 <screen>
226 $ cat /proc/uptime
227 110716.72 17.67
228 </screen>
229 </para>
230
231 </sect1>
18 232
19</title>
20<chapter id="pod2docbook-ch-1"><title>NAME
21
22</title>
23<!-- Bogus hack to ensure that each sect has a paragraph in it -->
24<para>
25</para>
26
27
28<para>
29BusyBox - The Swiss Army Knife of Embedded Linux
30
31
32</para>
33
34<sect1 id="pod2docbook-ch-1-sect-1"><title>SYNTAX
35
36</title>
37<!-- Bogus hack to ensure that each sect has a paragraph in it -->
38<para>
39</para>
40
41
42<para>
43<screen>
44 BusyBox &lt;function&gt; [arguments...] # or
45</screen>
46
47
48</para>
49
50<para>
51<screen>
52 &lt;function&gt; [arguments...] # if symlinked
53</screen>
54
55
56</para>
57
58</sect1>
59
60<sect1 id="pod2docbook-ch-1-sect-2"><title>DESCRIPTION
61
62</title>
63<!-- Bogus hack to ensure that each sect has a paragraph in it -->
64<para>
65</para>
66
67
68<para>
69BusyBox combines tiny versions of many common UNIX utilities into a single
70small executable. It provides minimalist replacements for most of the
71utilities you usually find in fileutils, shellutils, findutils, textutils,
72grep, gzip, tar, etc. BusyBox provides a fairly complete POSIX environment
73for any small or embedded system. The utilities in BusyBox generally have
74fewer options than their full-featured GNU cousins; however, the options
75that are included provide the expected functionality and behave very much
76like their GNU counterparts.
77
78
79</para>
80
81<para>
82BusyBox has been written with size-optimization and limited resources in
83mind. It is also extremely modular so you can easily include or exclude
84commands (or features) at compile time. This makes it easy to customize
85your embedded systems. To create a working system, just add a kernel, a
86shell (such as ash), and an editor (such as elvis-tiny or ae).
87
88
89</para>
90
91</sect1>
92
93<sect1 id="pod2docbook-ch-1-sect-3"><title>USAGE
94
95</title>
96<!-- Bogus hack to ensure that each sect has a paragraph in it -->
97<para>
98</para>
99
100
101<para>
102When you create a link to BusyBox for the function you wish to use, when
103BusyBox is called using that link it will behave as if the command itself
104has been invoked.
105
106
107</para>
108
109<para>
110For example, entering
111
112
113</para>
114
115<para>
116<screen>
117 ln -s ./BusyBox ls
118 ./ls
119</screen>
120
121
122</para>
123
124<para>
125will cause BusyBox to behave as 'ls' (if the 'ls' command has been compiled
126into BusyBox).
127
128
129</para>
130
131<para>
132You can also invoke BusyBox by issuing the command as an argument on the
133command line. For example, entering
134
135
136</para>
137
138<para>
139<screen>
140 ./BusyBox ls
141</screen>
142
143
144</para>
145
146<para>
147will also cause BusyBox to behave as 'ls'.
148
149
150</para>
151
152</sect1>
153
154<sect1 id="pod2docbook-ch-1-sect-4"><title>COMMON OPTIONS
155
156</title>
157<!-- Bogus hack to ensure that each sect has a paragraph in it -->
158<para>
159</para>
160
161
162<para>
163Most BusyBox commands support the <emphasis>--help</emphasis> option to provide a terse runtime description of their behavior.
164
165
166</para>
167
168</sect1>
169
170<sect1 id="pod2docbook-ch-1-sect-5"><title>COMMANDS
171
172</title>
173<!-- Bogus hack to ensure that each sect has a paragraph in it -->
174<para>
175</para>
176
177
178<para>
179Currently defined functions include:
180
181
182</para>
183
184<para>
185ar, basename, cat, chgrp, chmod, chown, chroot, chvt, clear, cp, cut, date,
186dc, dd, deallocvt, df, dirname, dmesg, du, dutmp, echo, false, fbset,
187fdflush, find, free, freeramdisk, fsck.minix, grep, gunzip, gzip, halt,
188head, hostid, hostname, id, init, insmod, kill, killall, length, ln,
189loadacm, loadfont, loadkmap, logger, logname, ls, lsmod, makedevs, mkdir,
190mkfifo, mkfs.minix, mknod, mkswap, mktemp, more, mount, mt, mv, nc,
191nslookup, ping, poweroff, printf, ps, pwd, reboot, rm, rmdir, rmmod, sed,
192setkeycodes, sfdisk, sh, sleep, sort, swapoff, swapon, sync, syslogd, tail,
193tar, tee, telnet, test, touch, tr, true, tty, umount, uname, uniq, update,
194uptime, usleep, uudecode, uuencode, wc, which, whoami, yes, zcat, [
195
196
197</para>
198
199<para>
200-------------------------------
201
202
203</para>
204
205<variableList>
206<varlistentry><term><emphasis>ar
207
208</emphasis></term>
209<listitem><para></para>
210
211<para>
212Usage: ar [optxvV] archive [filenames]
213
214
215</para>
216
217<para>
218Extract or list files from an ar archive.
219
220
221</para>
222
223<para>
224Options:
225
226
227</para>
228
229<para>
230<screen>
231 o preserve original dates
232 p extract to stdout
233 t list
234 x extract
235 v verbosely list files processed
236</screen>
237
238
239</para>
240
241<para>
242-------------------------------
243
244
245</para>
246
247</listitem></varlistentry>
248<varlistentry><term><emphasis>basename
249
250</emphasis></term>
251<listitem><para></para>
252
253<para>
254Usage: basename FILE [SUFFIX]
255
256
257</para>
258
259<para>
260Strips directory path and suffixes from FILE. If specified, also removes
261any trailing SUFFIX.
262
263
264</para>
265
266<para>
267Example:
268
269
270</para>
271
272<para>
273<screen>
274 $ basename /usr/local/bin/foo
275 foo
276 $ basename /usr/local/bin/
277 bin
278 $ basename /foo/bar.txt .txt
279 bar
280</screen>
281
282
283</para>
284
285<para>
286-------------------------------
287
288
289</para>
290
291</listitem></varlistentry>
292<varlistentry><term><emphasis>cat
293
294</emphasis></term>
295<listitem><para></para>
296
297<para>
298Usage: cat [FILE ...]
299
300
301</para>
302
303<para>
304Concatenates <literal>FILE(s)</literal> and prints them to the standard
305output.
306
307
308</para>
309
310<para>
311Example:
312
313
314</para>
315
316<para>
317<screen>
318 $ cat /proc/uptime
319 110716.72 17.67
320</screen>
321
322
323</para>
324 233
325<para> 234<para>
326------------------------------- 235-------------------------------
generated by cgit v1.2.3-55-g6feb (git 2.39.1) at 2025-03-17 23:58:28 +0000