fleshed out a bit more... just wanted to put the current
[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
14 a single executable.  This is a size optimization.  Most people will create
15 a symlink to busybox for each function name, and BusyBox will act like
16 whatever you invoke it as.
17
18 =head1 COMMANDS
19
20 Currently defined functions:
21 busybox, cat, chmod, chown, chgrp, chroot, clear, chvt, cp, date,
22 dd, df, dmesg, du, fbset, find, free, deallocvt, fsck.minix, mkfs.minix,
23 grep, head, hostname, init, linuxrc, kill, ln, ls, lsmod, mkdir,
24 mknod, mkswap, more, mount, mv, ping, poweroff, ps, pwd, reboot,
25 rm, rmdir, sed, sleep, sort, sync, syslogd, swapon, swapoff, tail,
26 tar, tee, touch, true, false, uname, umount, uniq, update, zcat,
27 gunzip, gzip
28
29 Oh yes.  Unix will be mine.
30
31 =over 4
32
33 =item busybox
34
35 =item cat
36
37 =item chmod
38
39 =item chown
40
41 =item chgrp
42
43 =item chroot
44
45 =item clear
46
47 =item chvt
48
49 =item cp
50
51 =item date
52
53 =item dd
54
55 =item df
56
57 =item dmesg
58
59 =item du
60
61 =item fbset
62
63 =item find
64
65 =item free
66
67 =item deallocvt
68
69 =item fsck.minix
70
71 =item mkfs.minix
72
73 =item grep
74
75 =item head
76
77 =item hostname
78
79 =item init
80
81 =item linuxrc
82
83 =item kill
84
85 =item ln
86
87 =item ls
88
89 =item lsmod
90
91 =item mkdir
92
93 =item mknod
94
95 =item mkswap
96
97 =item more
98
99 =item mount
100
101 =item mv
102
103 =item ping
104
105 =item poweroff
106
107 =item ps
108
109 =item pwd
110
111 =item reboot
112
113 =item rm
114
115 =item rmdir
116
117 =item sed
118
119 =item sleep
120
121 =item sort
122
123 =item sync
124
125 =item syslogd
126
127 =item swapon
128
129 =item swapoff
130
131 =item tail
132
133 =item tar
134
135 =item tee
136
137 =item touch
138
139 =item true
140
141 =item false
142
143 =item uname
144
145 =item umount
146
147 =item uniq
148
149 =item update
150
151 =item zcat
152
153 =item gunzip
154
155 =item gzip
156
157 =back
158
159 =head1 SEE ALSO
160
161 textutils(1), shellutils(1), etc...
162
163 =head1 MAINTAINER
164
165 Erik Andersen <erik@lineo.com>
166
167 =head1 AUTHORS
168
169 =over 4
170
171 =item Bruce Perens <perens@technocrat.net>
172
173 The original author.
174
175 =item Erik Andersen <erik@lineo.com>
176
177 He's thrashed around in the code enough to be considered the maintainer.
178
179 =item Randolph Chung <rchung@debian.org>
180
181 ping, fbset, mkfifo, etc.
182
183 =item John Beppu <beppu@lineo.com>
184
185 sort, head, du, uniq, tee.
186
187 =back
188
189 =cut