added a little more content.
[oweals/busybox.git] / docs / busybox.pod
1 =head1 NAME
2
3 busybox - I am BusyBox of Borg.  Unix will be assimilated.
4
5 =head1 SYNOPSIS
6
7  busybox <function> [arguments...]  # or
8
9  <function> [arguments...]          # if symlinked
10
11 =head1 DESCRIPTION
12
13 BusyBox is a multi-call binary that combines many common Unix utilities into a
14 single executable.  Most people will create a symlink to busybox for each
15 function name, and BusyBox will act like whatever you invoke it as.
16
17 BusyBox has been written with size-optimization in mind.  It is very easy to
18 include or exclude the commands you want installed.  BusyBox tries to make
19 itself useful to small systems with limited resources.
20
21 =head1 COMMANDS
22
23 Currently defined functions:
24 busybox, cat, chmod, chown, chgrp, chroot, clear, chvt, cp, date,
25 dd, df, dmesg, du, fbset, find, free, deallocvt, fsck.minix, mkfs.minix,
26 grep, head, hostname, init, linuxrc, kill, ln, ls, lsmod, mkdir,
27 mknod, mkswap, more, mount, mv, ping, poweroff, ps, pwd, reboot,
28 rm, rmdir, sed, sleep, sort, sync, syslogd, swapon, swapoff, tail,
29 tar, tee, touch, true, false, uname, umount, uniq, update, zcat,
30 gunzip, gzip
31
32 Oh yes.  Unix will be mine.
33
34 =over 4
35
36 =item busybox
37
38 =item cat
39
40 =item chmod
41
42 =item chown
43
44 =item chgrp
45
46 =item chroot
47
48 =item clear
49
50 =item chvt
51
52 =item cp
53
54 =item date
55
56 =item dd
57
58 =item df
59
60 =item dmesg
61
62 =item du
63
64 =item fbset
65
66 =item find
67
68 =item free
69
70 =item deallocvt
71
72 =item fsck.minix
73
74 =item mkfs.minix
75
76 =item grep
77
78 =item head
79
80 =item hostname
81
82 =item init
83
84 =item linuxrc
85
86 =item kill
87
88 =item ln
89
90 =item ls
91
92 =item lsmod
93
94 =item mkdir
95
96 =item mknod
97
98 =item mkswap
99
100 =item more
101
102 =item mount
103
104 =item mv
105
106 =item ping
107
108 =item poweroff
109
110 =item ps
111
112 =item pwd
113
114 =item reboot
115
116 =item rm
117
118 =item rmdir
119
120 =item sed
121
122 =item sleep
123
124 =item sort
125
126 =item sync
127
128 =item syslogd
129
130 =item swapon
131
132 =item swapoff
133
134 =item tail
135
136 =item tar
137
138 =item tee
139
140 =item touch
141
142 =item true
143
144 =item false
145
146 =item uname
147
148 =item umount
149
150 =item uniq
151
152 =item update
153
154 =item zcat
155
156 =item gunzip
157
158 =item gzip
159
160 =back
161
162 =head1 SEE ALSO
163
164 textutils(1), shellutils(1), etc...
165
166 =head1 MAINTAINER
167
168 Erik Andersen <erik@lineo.com>
169
170 =head1 AUTHORS
171
172 The following people have contributed code to BusyBox whether
173 they know it or not.
174
175 Erik Andersen <erik@lineo.com>
176
177 =for html <br>
178
179 John Beppu <beppu@lineo.com>
180
181 =for html <br>
182
183 Brian Candler <B.Candler@pobox.com>
184
185 =for html <br>
186
187 Randolph Chung <tausq@debian.org>
188
189 =for html <br>
190
191 Dave Cinege <dcinege@psychosis.com>     
192
193 =for html <br>
194
195 Bruce Perens <bruce@perens.com>
196
197 =for html <br>
198
199 Linus Torvalds <torvalds@transmeta.com>
200
201 =for html <br>
202
203 Charles P. Wright <cpwright@villagenet.com>
204
205 =for html <br>
206
207 Enrique Zanardi <ezanardi@ull.es>
208
209 =for html <br>
210
211 =cut
212