e8b5a9ed95f8cb4b8d7f228bfd68766a27acb230
[platform/upstream/busybox.git] / docs / busybox.pod
1 # vi: set sw=4 ts=4:
2
3 =head1 NAME
4
5 BusyBox - The Swiss Army Knife of Embedded Linux
6
7 =head1 SYNTAX
8
9  BusyBox <function> [arguments...]  # or
10
11  <function> [arguments...]          # if symlinked
12
13 =head1 DESCRIPTION
14
15 BusyBox combines tiny versions of many common UNIX utilities into a single
16 small executable. It provides minimalist replacements for most of the utilities
17 you usually find in fileutils, shellutils, findutils, textutils, grep, gzip,
18 tar, etc.  BusyBox provides a fairly complete POSIX environment for any small
19 or emdedded system.  The utilities in BusyBox generally have fewer options then
20 their full featured GNU cousins; however, the options that are included provide
21 the expected functionality and behave very much like their GNU counterparts.  
22
23 BusyBox has been written with size-optimization and limited resources in mind.
24 It is also extremely modular so you can easily include or exclude commands (or
25 features) at compile time.  This makes it easy to customize your embedded
26 systems.  To create a working system, just add a kernel, a shell (such as ash),
27 and an editor (such as elvis-tiny or ae).
28
29 =head1 USAGE
30
31 When you create a link to BusyBox for the function you wish to use, when BusyBox
32 is called using that link it will behave as if the command itself has been invoked.
33
34 For example, entering
35
36         ln -s ./BusyBox ls
37         ./ls
38
39 will cause BusyBox to behave as 'ls' (if the 'ls' command has been compiled
40 into BusyBox).  
41
42 You can also invoke BusyBox by issuing the command as an argument on the
43 command line.  For example, entering
44
45         ./BusyBox ls
46
47 will also cause BusyBox to behave as 'ls'. 
48
49 =head1 COMMON OPTIONS
50
51 Most BusyBox commands support the B<--help> option to provide a
52 terse runtime description of their behavior. 
53
54 =head1 COMMANDS
55
56 Currently defined functions include:
57
58 basename, cat, chgrp, chmod, chown, chroot, clear, chvt, cp, cut, date, dd, df,
59 dirname, dmesg, du, dutmp, echo, false, fbset, fdflush, find, free,
60 freeramdisk, deallocvt, fsck.minix, grep, gunzip, gzip, halt, head, hostid,
61 hostname, id, init, kill, killall, length, ln, loadacm, loadfont, loadkmap,
62 logger, logname, ls, lsmod, makedevs, math, mkdir, mkfifo, mkfs.minix, mknod,
63 mkswap, mktemp, nc, more, mount, mt, mv, nslookup, ping, poweroff, printf, ps,
64 pwd, reboot, rm, rmdir, rmmod, sed, setkeycodes, sh, sfdisk, sleep, sort, sync,
65 syslogd, swapon, swapoff, tail, tar, test, tee, touch, tr, true, tty, umount,
66 uname, uniq, update, uptime, usleep, wc, whoami, yes, zcat, [
67
68 -------------------------------
69
70 =over 4
71
72 =item basename
73
74 Usage: basename FILE [SUFFIX]
75
76 Strips directory path and suffixes from FILE.
77 If specified, also removes any trailing SUFFIX.
78
79 Example: 
80
81         $ basename /usr/local/bin/foo
82         foo
83         $ basename /usr/local/bin/
84         bin
85         $ basename /foo/bar.txt .txt
86         bar
87
88 -------------------------------
89
90 =item cat  
91
92 Usage: cat [FILE ...]
93
94 Concatenates FILE(s) and prints them to the standard output.
95
96 Example:
97
98         $ cat /proc/uptime
99         110716.72 17.67
100
101 -------------------------------
102
103 =item chgrp
104
105 Usage: chgrp [OPTION]... GROUP FILE...
106
107 Change the group membership of each FILE to GROUP.
108
109 Options:
110
111         -R      change files and directories recursively
112
113 Example:
114
115         $ ls -l /tmp/foo
116         -r--r--r--    1 andersen andersen        0 Apr 12 18:25 /tmp/foo
117         $ chgrp root /tmp/foo
118         $ ls -l /tmp/foo
119         -r--r--r--    1 andersen root            0 Apr 12 18:25 /tmp/foo
120
121 -------------------------------
122
123 =item chmod
124
125 Usage: chmod [B<-R>] MODE[,MODE]... FILE...
126
127 Changes file access permissions for the specified FILE(s) (or directories).
128 Each MODE is defined by combining the letters for WHO has access to the file,
129 an OPERATOR for selecting how the permissions should be changed, and a
130 PERISSION for FILE(s) (or directories).
131
132 WHO may be chosen from
133
134         u       User who owns the file
135         g       Users in the file's Group
136         o       Other users not in the file's group
137         a       All users
138
139 OPERATOR may be chosen from
140
141         +       Add a permission
142         -       Remove a permission
143         =       Assign a permission
144  
145 PERMISSION may be chosen from
146
147         r       Read
148         w       Write
149         x       Execute (or access for directories)
150         s       Set user (or group) ID bit
151         t       Stickey bit (for directories prevents removing files by non-owners)
152
153 Alternately, permissions can be set numerically where the first three
154 numbers are calculated by adding the octal values, such as
155
156         4       Read
157         2       Write
158         1       Execute
159
160 An optional fourth digit can also be used to specify
161
162         4       Set user ID
163         2       Set group ID
164         1       Stickey bit
165
166 Options:
167
168         -R      Change files and directories recursively.
169  
170 Example:
171
172         $ ls -l /tmp/foo
173         -rw-rw-r--    1 root     root            0 Apr 12 18:25 /tmp/foo
174         $ chmod u+x /tmp/foo
175         $ ls -l /tmp/foo
176         -rwxrw-r--    1 root     root            0 Apr 12 18:25 /tmp/foo*
177         $ chmod 444 /tmp/foo
178         $ ls -l /tmp/foo
179         -r--r--r--    1 root     root            0 Apr 12 18:25 /tmp/foo
180
181 -------------------------------
182
183 =item chown
184
185 Usage: chown [OPTION]...  OWNER[<.|:>[GROUP] FILE...
186
187 Changes the owner and/or group of each FILE to OWNER and/or GROUP.
188
189 Options:
190
191         -R      Changes files and directories recursively
192
193 Example:
194
195         $ ls -l /tmp/foo
196         -r--r--r--    1 andersen andersen        0 Apr 12 18:25 /tmp/foo
197         $ chown root /tmp/foo
198         $ ls -l /tmp/foo
199         -r--r--r--    1 root     andersen        0 Apr 12 18:25 /tmp/foo
200         $ chown root.root /tmp/foo
201         ls -l /tmp/foo
202         -r--r--r--    1 root     root            0 Apr 12 18:25 /tmp/foo
203
204 -------------------------------
205
206 =item chroot
207
208 Usage: chroot NEWROOT [COMMAND...]
209
210 Run COMMAND with root directory set to NEWROOT.
211  
212 Example:
213
214         $ ls -l /bin/ls
215         lrwxrwxrwx    1 root     root          12 Apr 13 00:46 /bin/ls -> /BusyBox
216         $ mount /dev/hdc1 /mnt -t minix
217         $ chroot /mnt
218         $ ls -l /bin/ls
219         -rwxr-xr-x    1 root     root        40816 Feb  5 07:45 /bin/ls*
220
221 -------------------------------
222
223 =item clear
224
225 Clears the screen.
226
227 -------------------------------
228
229 =item chvt
230
231 Usage: chvt N
232
233 Changes the foreground virtual terminal to /dev/ttyN
234
235 -------------------------------
236
237 =item cp
238
239 Usage: cp [OPTION]... SOURCE DEST
240
241    or: cp [OPTION]... SOURCE... DIRECTORY
242
243 Copies SOURCE to DEST, or multiple SOURCE(s) to DIRECTORY.
244
245 Options:
246
247         -a      Same as -dpR
248         -d      Preserves links
249         -p      Preserves file attributes if possable
250         -R      Copies directories recursively
251
252 -------------------------------
253
254 =item cut
255
256 Usage: cut [OPTION]... [FILE]...
257
258 Prints selected fields from each input FILE to standard output.
259
260 Options:
261
262         -b LIST Output only bytes from LIST
263         -c LIST Output only characters from LIST
264         -d DELIM        Use DELIM instead of tab as the field delimiter
265         -f N    Print only these fields
266         -n      Ignored
267
268 Example:
269
270         $ echo "Hello world" | cut -f 1 -d ' '
271         Hello
272         $ echo "Hello world" | cut -f 2 -d ' '
273         world
274
275
276 -------------------------------
277
278 =item date
279
280 Usage: date [OPTION]... [+FORMAT]
281
282   or:  date [OPTION] [MMDDhhmm[[CC]YY][.ss]]
283
284 Displays the current time in the given FORMAT, or sets the system date.
285
286 Options:
287
288         -R      Outputs RFC-822 compliant date string
289         -s      Sets time described by STRING
290         -u      Prints or sets Coordinated Universal Time
291
292 Example:
293
294         $ date
295         Wed Apr 12 18:52:41 MDT 2000
296
297 -------------------------------
298
299 =item dd
300
301 Usage: dd [if=name] [of=name] [bs=n] [count=n] [skip=n] [seek=n]
302
303 Copy a file, converting and formatting according to options
304
305         if=FILE read from FILE instead of stdin
306         of=FILE write to FILE instead of stdout
307         bs=n    read and write n bytes at a time
308         count=n copy only n input blocks
309         skip=n  skip n input blocks
310         seek=n  skip n output blocks
311
312 Numbers may be suffixed by w (x2), k (x1024), b (x512), or M (x1024^2)
313  
314 Example:
315
316         $ dd if=/dev/zero of=/dev/ram1 bs=1M count=4
317         4+0 records in
318         4+0 records out
319
320 -------------------------------
321
322 =item df
323
324 Usage: df [filesystem ...]
325
326 Prints the filesystem space used and space available.
327
328 Example:
329
330         $ df
331         Filesystem           1k-blocks      Used Available Use% Mounted on
332         /dev/sda3              8690864   8553540    137324  98% /
333         /dev/sda1                64216     36364     27852  57% /boot
334         $ df /dev/sda3
335         Filesystem           1k-blocks      Used Available Use% Mounted on
336         /dev/sda3              8690864   8553540    137324  98% /
337
338 -------------------------------
339
340 =item dirname
341
342 Usage: dirname NAME
343
344 Strip non-directory suffix from file name
345
346 Example:
347
348         $ dirname /tmp/foo
349         /tmp
350         $ dirname /tmp/foo/
351         /tmp
352
353 -------------------------------
354
355 =item dmesg
356
357 Usage: dmesg [B<-c>] [B<-n> level] [B<-s> bufsize]
358  
359 Print or controls the kernel ring buffer.
360
361 -------------------------------
362
363 =item du
364
365 Usage: du [OPTION]... [FILE]...
366
367 Summarize disk space used for each FILE and/or directory.
368 Disk space is printed in units of 1k (i.e. 1024 bytes).
369
370 Options:
371
372         -l      count sizes many times if hard linked
373         -s      display only a total for each argument
374
375 Example:
376
377         $ ./BusyBox du
378         16      ./CVS
379         12      ./kernel-patches/CVS
380         80      ./kernel-patches
381         12      ./tests/CVS
382         36      ./tests
383         12      ./scripts/CVS
384         16      ./scripts
385         12      ./docs/CVS
386         104     ./docs
387         2417    .
388          
389 -------------------------------
390
391 =item dutmp
392
393 Usage: dutmp [FILE]
394
395 Dump utmp file format (pipe delimited) from FILE
396 or stdin to stdout.
397
398 Example:
399
400         $ dutmp /var/run/utmp
401         8|7||si|||0|0|0|955637625|760097|0
402         2|0|~|~~|reboot||0|0|0|955637625|782235|0
403         1|20020|~|~~|runlevel||0|0|0|955637625|800089|0
404         8|125||l4|||0|0|0|955637629|998367|0
405         6|245|tty1|1|LOGIN||0|0|0|955637630|998974|0
406         6|246|tty2|2|LOGIN||0|0|0|955637630|999498|0
407         7|336|pts/0|vt00andersen|andersen|:0.0|0|0|0|955637763|0|0
408          
409 -------------------------------
410
411 =item echo
412
413 Usage: echo [-neE] [ARG ...]
414
415 Prints the specified ARGs to stdout
416
417 Options:
418
419         -n      suppress trailing newline
420         -e      interpret backslash-escaped characters (i.e. \t=tab etc)
421         -E      disable interpretation of backslash-escaped characters
422
423 Example:
424
425         $ echo "Erik is cool"
426         Erik is cool
427         $  echo -e "Erik\nis\ncool"
428         Erik
429         is
430         cool
431         $ echo "Erik\nis\ncool"
432         Erik\nis\ncool
433          
434 -------------------------------
435
436 =item false
437
438 Returns an exit code of FALSE (1)
439
440 Example:
441
442         $ false
443         $ echo $?
444         1
445
446 -------------------------------
447
448 =item fbset
449
450 Usage: fbset [options] [mode]
451
452 Show and modify frame buffer device settings
453
454 Options:
455
456         -h
457         -fb
458         -db
459         -a
460         -i
461         -g
462         -t
463         -accel
464         -hsync
465         -vsync
466         -laced
467         -double
468
469 Example:
470
471         $ fbset
472         mode "1024x768-76"
473                         # D: 78.653 MHz, H: 59.949 kHz, V: 75.694 Hz
474                         geometry 1024 768 1024 768 16
475                         timings 12714 128 32 16 4 128 4
476                         accel false
477                         rgba 5/11,6/5,5/0,0/0
478         endmode
479
480 -------------------------------
481
482 =item fdflush
483
484 Usage: fdflush device
485
486 Force floppy disk drive to detect disk change
487
488 -------------------------------
489
490 =item find
491
492 Usage: find [PATH...] [EXPRESSION]
493
494 Search for files in a directory hierarchy.  The default PATH is
495 the current directory; default EXPRESSION is '-print'
496
497
498 EXPRESSION may consist of:
499
500         -follow                 Dereference symbolic links.
501         -name PATTERN   File name (leading directories removed) matches PATTERN.
502         -print                  print the full file name followed by a newline to stdout.
503
504 Example:
505
506         $ find / -name /etc/passwd
507         /etc/passwd
508
509 -------------------------------
510
511 =item free
512
513 Usage: free
514
515 Displays the amount of free and used system memory.
516
517 Example:
518
519         $ free
520                                   total         used         free       shared      buffers
521           Mem:       257628       248724         8904        59644        93124
522          Swap:       128516         8404       120112
523         Total:       386144       257128       129016
524
525 -------------------------------
526
527 =item freeramdisk
528
529 Usage: freeramdisk DEVICE
530
531 Frees all memory used by the specified ramdisk.
532
533 Example:
534
535         $ freeramdisk /dev/ram2
536
537 -------------------------------
538
539 =item deallocvt
540
541 Usage: deallocvt N
542
543 Deallocates unused virtual terminal /dev/ttyN
544
545 -------------------------------
546
547 =item fsck.minix
548
549 Usage: fsck.minix [B<-larvsmf>] /dev/name
550
551 Performs a consistency check for MINIX filesystems.
552
553 OPTIONS:
554
555         -l      Lists all filenames
556         -r      Perform interactive repairs
557         -a      Perform automatic repairs
558         -v      verbose
559         -s      Outputs super-block information
560         -m      Activates MINIX-like "mode not cleared" warnings
561         -f      Force file system check.
562
563 -------------------------------
564
565 =item grep
566
567 Usage: grep [OPTIONS]... PATTERN [FILE]...
568
569 Search for PATTERN in each FILE or standard input.
570
571 OPTIONS:
572
573         -h      suppress the prefixing filename on output
574         -i      ignore case distinctions
575         -n      print line number with output lines
576         -q      be quiet. Returns 0 if result was found, 1 otherwise
577         -v      select non-matching lines
578
579 This version of grep matches full regular expresions.
580
581 Example:
582
583         $ grep root /etc/passwd
584         root:x:0:0:root:/root:/bin/bash
585         $ grep ^[rR]oo. /etc/passwd
586         root:x:0:0:root:/root:/bin/bash
587
588 -------------------------------
589
590 =item gunzip
591
592 Usage: gunzip [OPTION]... FILE
593
594 Uncompress FILE (or standard input if FILE is '-').
595
596 Options:
597
598         -c      Write output to standard output
599         -t      Test compressed file integrity
600
601 Example:
602
603         $ ls -la /tmp/BusyBox*
604         -rw-rw-r--    1 andersen andersen   557009 Apr 11 10:55 /tmp/BusyBox-0.43.tar.gz
605         $ gunzip /tmp/BusyBox-0.43.tar.gz
606         $ ls -la /tmp/BusyBox*
607         -rw-rw-r--    1 andersen andersen  1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar
608
609 -------------------------------
610
611 =item gzip
612
613 Usage: gzip [OPTION]... FILE
614
615 Compress FILE with maximum compression.
616 When FILE is '-', reads standard input.  Implies B<-c>.
617
618 Options:
619
620         -c      Write output to standard output instead of FILE.gz
621
622 Example:
623
624         $ ls -la /tmp/BusyBox*
625         -rw-rw-r--    1 andersen andersen  1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar
626         $ gzip /tmp/BusyBox-0.43.tar
627         $ ls -la /tmp/BusyBox*
628         -rw-rw-r--    1 andersen andersen   554058 Apr 14 17:49 /tmp/BusyBox-0.43.tar.gz
629
630
631 -------------------------------
632
633 =item halt
634
635 Usage: halt
636
637 This comand halts the system.
638
639 -------------------------------
640
641 =item head
642
643 Usage: head [OPTION] [FILE]...
644
645 Print first 10 lines of each FILE to standard output.
646 With more than one FILE, precede each with a header giving the
647 file name. With no FILE, or when FILE is -, read standard input.
648
649 Options:
650
651         -n NUM          Print first NUM lines instead of first 10
652
653 Example:
654
655         $ head -n 2 /etc/passwd
656         root:x:0:0:root:/root:/bin/bash
657         daemon:x:1:1:daemon:/usr/sbin:/bin/sh
658
659 -------------------------------
660
661 =item hostid
662
663 Usage: hostid
664
665 Prints out a unique  32-bit  identifier  for  the  current
666 machine.   The  32-bit identifier is intended to be unique
667 among all UNIX systems in existence. 
668
669 -------------------------------
670
671 =item hostname
672
673 Usage: hostname [OPTION] {hostname | B<-F> file}
674
675 Get or set the hostname or DNS domain name. If a hostname is given
676 (or a file with the B<-F> parameter), the host name will be set.
677
678 Options:
679
680         -s              Short
681         -i              Addresses for the hostname
682         -d              DNS domain name
683         -F FILE         Use the contents of FILE to specify the hostname
684
685 Example:
686
687         $ hostname
688         slag 
689
690 -------------------------------
691
692 =item id
693
694 Print information for USERNAME or the current user
695
696 Options:
697
698         -g      prints only the group ID
699         -u      prints only the user ID
700         -r      prints the real user ID instead of the effective ID (with -ug)
701
702 Example:
703
704         $ id
705         uid=1000(andersen) gid=1000(andersen)
706
707 -------------------------------
708
709 =item init
710
711 Usage: init
712
713 Init is the parent of all processes.
714
715 This version of init is designed to be run only by the kernel.
716
717 BusyBox init doesn't support multiple runlevels.  The runlevels field of
718 the /etc/inittab file is completely ignored by BusyBox init. If you want 
719 runlevels, use sysvinit.
720
721 BusyBox init works just fine without an inittab.  If no inittab is found, 
722 it has the following default behavior:
723
724         ::sysinit:/etc/init.d/rcS
725         ::askfirst:/bin/sh
726
727 if it detects that /dev/console is _not_ a serial console, it will also run:
728
729         tty2::askfirst:/bin/sh
730
731 If you choose to use an /etc/inittab file, the inittab entry format is as follows:
732
733         <id>:<runlevels>:<action>:<process>
734
735         <id>: 
736
737                 WARNING: This field has a non-traditional meaning for BusyBox init!
738                 The id field is used by BusyBox init to specify the controlling tty for
739                 the specified process to run on.  The contents of this field are
740                 appended to "/dev/" and used as-is.  There is no need for this field to
741                 be unique, although if it isn't you may have strange results.  If this
742                 field is left blank, it is completely ignored.  Also note that if
743                 BusyBox detects that a serial console is in use, then all entries
744                 containing non-empty id fields will _not_ be run.  BusyBox init does
745                 nothing with utmp.  We don't need no stinkin' utmp.
746
747         <runlevels>: 
748
749                 The runlevels field is completely ignored.
750
751         <action>: 
752
753                 Valid actions include: sysinit, respawn, askfirst, wait, 
754                 once, and ctrlaltdel.
755
756                 askfirst acts just like respawn, but before running the specified
757                 process it displays the line "Please press Enter to activate this
758                 console." and then waits for the user to press enter before starting
759                 the specified process.
760
761                 Unrecognised actions (like initdefault) will cause init to emit
762                 an error message, and then go along with its business.
763
764         <process>: 
765
766                 Specifies the process to be executed and it's command line.
767
768
769 Example /etc/inittab file:
770
771         # This is run first except when booting in single-user mode.
772         #
773         ::sysinit:/etc/init.d/rcS
774
775         # /bin/sh invocations on selected ttys
776         #
777         # Start an "askfirst" shell on the console (whatever that may be)
778         ::askfirst:/bin/sh
779         # Start an "askfirst" shell on /dev/tty2
780         tty2::askfirst:/bin/sh
781
782         # /sbin/getty invocations for selected ttys
783         #
784         tty4::respawn:/sbin/getty 38400 tty4
785         tty5::respawn:/sbin/getty 38400 tty5
786
787
788         # Example of how to put a getty on a serial line (for a terminal)
789         #
790         #ttyS0::respawn:/sbin/getty -L ttyS0 9600 vt100
791         #ttyS1::respawn:/sbin/getty -L ttyS1 9600 vt100
792         #
793         # Example how to put a getty on a modem line.
794         #ttyS2::respawn:/sbin/getty -x0 -s 57600 ttyS2
795
796         # Stuff to do before rebooting
797         ::ctrlaltdel:/bin/umount -a -r > /dev/null 2>&1
798         ::ctrlaltdel:/sbin/swapoff -a > /dev/null 2>&1
799
800 -------------------------------
801
802 =item kill
803
804 Usage: kill [B<-signal>] process-id [process-id ...]
805
806 Send a signal (default is SIGTERM) to the specified process(es).
807
808 Options:
809
810         -l      List all signal names and numbers.
811
812 Example:
813
814         $ ps | grep apache
815         252 root     root     S [apache]
816         263 www-data www-data S [apache]
817         264 www-data www-data S [apache]
818         265 www-data www-data S [apache]
819         266 www-data www-data S [apache]
820         267 www-data www-data S [apache]
821         $ kill 252
822
823 -------------------------------
824
825 =item killall
826
827 Usage: killall [B<-signal>] process-name [process-name ...]
828
829 Send a signal (default is SIGTERM) to the specified process(es).
830
831 Options:
832
833         -l      List all signal names and numbers.
834
835 Example:
836
837         $ killall apache
838
839 -------------------------------
840
841 =item length
842
843 Usage: length STRING
844
845 Prints out the length of the specified STRING.
846
847 Example:
848
849         $ length "Hello"
850         5
851
852 -------------------------------
853
854 =item ln
855
856 Usage: ln [OPTION] TARGET... LINK_NAME|DIRECTORY
857
858 Create a link named LINK_NAME or DIRECTORY to the specified TARGET
859  
860 Options:
861
862         -s      make symbolic links instead of hard links
863         -f      remove existing destination files
864  
865 Example:
866
867     $ ln -s BusyBox /tmp/ls
868     $ ls -l /tmp/ls
869     lrwxrwxrwx    1 root     root            7 Apr 12 18:39 ls -> BusyBox*
870
871 -------------------------------
872
873 =item loadacm
874
875 Usage: loadacm
876
877 Loads an acm from standard input.
878
879 Example:
880
881         $ loadacm < /etc/i18n/acmname
882
883 -------------------------------
884
885 =item loadfont
886
887 Usage: loadfont
888
889 Loads a console font from standard input.
890
891 Example:
892
893         $ loadfont < /etc/i18n/fontname
894
895 -------------------------------
896
897 =item loadkmap
898
899 Usage: loadkmap
900
901 Loads a binary keyboard translation table from standard input.
902
903 Example:
904
905         $ loadkmap < /etc/i18n/lang-keymap
906
907 -------------------------------
908
909 =item logger
910
911 Usage: logger [OPTION]... [MESSAGE]
912
913 Write MESSAGE to the system log.  If MESSAGE is '-', log stdin.
914
915 Options:
916
917         -s      Log to stderr as well as the system log.
918         -t      Log using the specified tag (defaults to user name).
919         -p      Enter the message with the specified priority.
920                 This may be numerical or a ``facility.level'' pair.
921
922 Example:
923
924                 $ logger "hello"
925
926 -------------------------------
927
928 =item logname
929
930 Usage: logname
931
932 Print the name of the current user.
933
934 Example:
935
936         $ logname
937         root
938
939 -------------------------------
940
941 =item ls
942
943 Usage: ls [B<-1acdelnpuxACF>] [filenames...]
944
945 Options:
946
947         -a      do not hide entries starting with .
948         -c      with  -l:  show ctime (the time of last
949                 modification of file status information)
950         -d      list directory entries instead of contents
951         -e      list both full date and full time
952         -l      use a long listing format
953         -n      list numeric UIDs and GIDs instead of names
954         -p      append indicator (one of /=@|) to entries
955         -u      with -l: show access time (the time of last
956                 access of the file)
957         -x      list entries by lines instead of by columns
958         -A      do not list implied . and ..
959         -C      list entries by columns
960         -F      append indicator (one of */=@|) to entries
961
962 -------------------------------
963
964 =item lsmod
965
966 Usage: lsmod
967
968 Shows a list of all currently loaded kernel modules.
969
970 -------------------------------
971
972 =item makedevs
973
974 Usage: makedevs NAME TYPE MAJOR MINOR FIRST LAST [s]
975
976 Creates a range of block or character special files
977
978 TYPEs include:
979
980         b:      Make a block (buffered) device.
981         c or u: Make a character (un-buffered) device.
982         p:      Make a named pipe. MAJOR and MINOR are ignored for named pipes.
983
984 FIRST specifies the number appended to NAME to create the first device.
985 LAST specifies the number of the last item that should be created.
986 If 's' is the last argument, the base device is created as well.
987
988 Example:
989
990         $ makedevs /dev/ttyS c 4 66 2 63
991         [creates ttyS2-ttyS63]
992         $ makedevs /dev/hda b 3 0 0 8 s
993         [creates hda,hda1-hda8]
994
995 -------------------------------
996
997 =item math
998
999 Usage: math expression ...
1000
1001 This is a Tiny RPN calculator that understands the
1002 following operations: +, -, /, *, and, or, not, eor.
1003
1004 Example:
1005
1006         $ math 2 2 add
1007         4
1008         $ math 8 8 \* 2 2 + /
1009         16
1010         $ math 0 1 and
1011         0
1012         $ math 0 1 or
1013         1
1014
1015 -------------------------------
1016
1017 =item mkdir
1018
1019 Usage: mkdir [OPTION] DIRECTORY...
1020
1021 Create the DIRECTORY(ies), if they do not already exist
1022
1023 Options:
1024
1025         -m      set permission mode (as in chmod), not rwxrwxrwx - umask
1026         -p      no error if dir exists, make parent directories as needed
1027
1028 Example:
1029
1030         $ mkdir /tmp/foo
1031         $ mkdir /tmp/foo
1032         /tmp/foo: File exists
1033         $ mkdir /tmp/foo/bar/baz
1034         /tmp/foo/bar/baz: No such file or directory
1035         $ mkdir -p /tmp/foo/bar/baz
1036
1037 -------------------------------
1038
1039 =item mkfifo
1040
1041 Usage: mkfifo [OPTIONS] name
1042
1043 Creates a named pipe (identical to 'mknod name p')
1044
1045 Options:
1046
1047         -m      create the pipe using the specified mode (default a=rw)
1048
1049 -------------------------------
1050
1051 =item mkfs.minix
1052
1053 Usage: mkfs.minix [B<-c> | B<-l> filename] [B<-nXX>] [B<-iXX>] /dev/name [blocks]
1054
1055 Make a MINIX filesystem.
1056
1057 OPTIONS:
1058
1059         -c              Check the device for bad blocks
1060         -n [14|30]      Specify the maximum length of filenames
1061         -i              Specify the number of inodes for the filesystem
1062         -l FILENAME     Read the bad blocks list from FILENAME
1063         -v              Make a Minix version 2 filesystem
1064
1065 -------------------------------
1066
1067 =item mknod
1068
1069 Usage: mknod [OPTIONS] NAME TYPE MAJOR MINOR
1070
1071 Create a special file (block, character, or pipe).
1072
1073 Options:
1074
1075         -m      create the special file using the specified mode (default a=rw)
1076
1077 TYPEs include:
1078         b:      Make a block (buffered) device.
1079         c or u: Make a character (un-buffered) device.
1080         p:      Make a named pipe. MAJOR and MINOR are ignored for named pipes.
1081
1082 Example:
1083
1084         $ mknod /dev/fd0 b 2 0 
1085         $ mknod -m 644 /tmp/pipe p
1086
1087 -------------------------------
1088
1089 =item mkswap
1090
1091 Usage: mkswap [B<-c>] [B<-v0>|B<-v1>] device [block-count]
1092
1093 Prepare a disk partition to be used as a swap partition.
1094
1095 Options:
1096
1097         -c              Check for read-ability.
1098         -v0             Make version 0 swap [max 128 Megs].
1099         -v1             Make version 1 swap [big!] (default for kernels > 2.1.117).
1100         block-count     Number of block to use (default is entire partition).
1101
1102 -------------------------------
1103
1104 =item mktemp
1105
1106 Usage: mktemp [B<-q>] TEMPLATE
1107
1108 Creates a temporary file with its name based on TEMPLATE.
1109 TEMPLATE is any name with six `Xs' (i.e. /tmp/temp.XXXXXX).
1110
1111 Example:
1112
1113         $ mktemp /tmp/temp.XXXXXX
1114         /tmp/temp.mWiLjM
1115         $ ls -la /tmp/temp.mWiLjM
1116         -rw-------    1 andersen andersen        0 Apr 25 17:10 /tmp/temp.mWiLjM
1117
1118 -------------------------------
1119
1120 =item nc
1121
1122 Usage: nc [IP] [port]
1123
1124 Netcat opens a pipe to IP:port
1125
1126 Example:
1127
1128         $ nc foobar.somedomain.com 25
1129         220 foobar ESMTP Exim 3.12 #1 Sat, 15 Apr 2000 00:03:02 -0600
1130         help
1131         214-Commands supported:
1132         214-    HELO EHLO MAIL RCPT DATA AUTH
1133         214     NOOP QUIT RSET HELP
1134         quit
1135         221 foobar closing connection
1136  
1137 -------------------------------
1138
1139 =item more
1140
1141 Usage: more [file ...]
1142
1143 More is a filter for paging through text one screenful at a time.
1144
1145 Example:
1146
1147         $ dmesg | more
1148
1149 -------------------------------
1150
1151 =item mount
1152
1153 Usage:  mount [flags]
1154         mount [flags] device directory [B<-o> options,more-options]
1155
1156 Flags:
1157
1158         -a:             Mount all file systems in fstab.
1159         -o option:      One of many filesystem options, listed below.
1160         -r:             Mount the filesystem read-only.
1161         -t fs-type:     Specify the filesystem type.
1162         -w:             Mount for reading and writing (default).
1163
1164 Options for use with the "B<-o>" flag:
1165
1166         async/sync:     Writes are asynchronous / synchronous.
1167         atime/noatime:  Enable / disable updates to inode access times.
1168         dev/nodev:      Allow use of special device files / disallow them.
1169         exec/noexec:    Allow use of executable files / disallow them.
1170         loop:           Mounts a file via loop device.
1171         suid/nosuid:    Allow set-user-id-root programs / disallow them.
1172         remount:        Re-mount a currently-mounted filesystem, changing its flags.
1173         ro/rw:          Mount for read-only / read-write.
1174         There are EVEN MORE flags that are specific to each filesystem.
1175         You'll have to see the written documentation for those.
1176
1177 Example:
1178
1179         $ mount
1180         /dev/hda3 on / type minix (rw)
1181         proc on /proc type proc (rw)
1182         devpts on /dev/pts type devpts (rw)
1183         $ mount /dev/fd0 /mnt -t msdos -o ro
1184         $ mount /tmp/diskimage /opt -t ext2 -o loop
1185
1186 -------------------------------
1187
1188 =item mt
1189
1190 Usage: mt [B<-f> device] opcode value
1191
1192 Control magnetic tape drive operation
1193
1194 -------------------------------
1195
1196 =item mv
1197
1198 Usage: mv SOURCE DEST
1199
1200    or: mv SOURCE... DIRECTORY
1201
1202 Rename SOURCE to DEST, or move SOURCE(s) to DIRECTORY.
1203
1204 Example:
1205
1206         $ mv /tmp/foo /bin/bar
1207
1208 -------------------------------
1209
1210 =item nslookup
1211
1212 Usage: nslookup [HOST]
1213
1214 Queries the nameserver for the IP address of the given HOST
1215
1216 Example:
1217
1218         $ nslookup localhost
1219         Server:     default
1220         Address:    default
1221
1222         Name:       debian
1223         Address:    127.0.0.1
1224
1225 -------------------------------
1226
1227 =item ping
1228
1229 Usage: ping [OPTION]... host
1230
1231 Send ICMP ECHO_REQUEST packets to network hosts.
1232
1233 Options:
1234
1235         -c COUNT        Send only COUNT pings.
1236         -q              Quiet mode, only displays output at start
1237                         and when finished.
1238 Example:
1239
1240         $ ping localhost
1241         PING slag (127.0.0.1): 56 data bytes
1242         64 bytes from 127.0.0.1: icmp_seq=0 ttl=255 time=20.1 ms
1243
1244         --- debian ping statistics ---
1245         1 packets transmitted, 1 packets received, 0% packet loss
1246         round-trip min/avg/max = 20.1/20.1/20.1 ms
1247
1248 -------------------------------
1249
1250 =item poweroff
1251
1252 Shuts down the system, and requests that the kernel turn off power upon halting.
1253
1254 -------------------------------
1255
1256 =item printf
1257
1258 Usage: printf format [argument...]
1259
1260 Formats and prints the given data in a manner similar to the C printf command.
1261
1262 Example:
1263
1264         $ printf "Val=%d\n" 5
1265         Val=5
1266
1267 -------------------------------
1268
1269 =item ps
1270
1271 Usage: ps
1272
1273 Report process status
1274
1275 This version of ps accepts no options.
1276
1277 Example:
1278
1279         $ ps
1280   PID  Uid      Gid State Command
1281     1 root     root     S init
1282     2 root     root     S [kflushd]
1283     3 root     root     S [kupdate]
1284     4 root     root     S [kpiod]
1285     5 root     root     S [kswapd]
1286   742 andersen andersen S [bash]
1287   743 andersen andersen S -bash
1288   745 root     root     S [getty]
1289  2990 andersen andersen R ps
1290
1291 -------------------------------
1292
1293 =item pwd
1294
1295 Prints the full filename of the current working directory.
1296
1297 Example:
1298
1299         $ pwd
1300         /root
1301
1302 -------------------------------
1303
1304 =item reboot
1305
1306 Instructs the kernel to reboot the system.
1307
1308 -------------------------------
1309
1310 =item rm
1311
1312 Usage: rm [OPTION]... FILE...
1313
1314 Remove (unlink) the FILE(s).
1315
1316 Options:
1317
1318         -f              remove existing destinations, never prompt
1319         -r or -R        remove the contents of directories recursively
1320
1321 Example:
1322
1323         $ rm -rf /tmp/foo
1324
1325 -------------------------------
1326
1327 =item rmdir
1328
1329 Usage: rmdir [OPTION]... DIRECTORY...
1330
1331 Remove the DIRECTORY(ies), if they are empty.
1332
1333 Example:
1334
1335         # rmdir /tmp/foo
1336
1337 -------------------------------
1338
1339 =item rmmod
1340
1341 Usage: rmmod [OPTION]... [MODULE]...
1342
1343 Unloads the specified kernel modules from the kernel.
1344
1345 Options:
1346
1347         -a      Try to remove all unused kernel modules.
1348
1349 Example:
1350
1351         $ rmmod tulip
1352
1353 -------------------------------
1354
1355 =item sed
1356
1357 Usage: sed [B<-n>] B<-e> script [file...]
1358
1359 Allowed sed scripts come in the following form:
1360
1361         'ADDR [!] COMMAND'
1362
1363         where address ADDR can be:
1364           NUMBER    Match specified line number
1365           $         Match last line
1366           /REGEXP/  Match specified regexp
1367           (! inverts the meaning of the match)
1368
1369         and COMMAND can be:
1370           s/regexp/replacement/[igp]
1371                  which attempt to match regexp against the pattern space
1372                  and if successful replaces the matched portion with replacement.
1373
1374           aTEXT
1375                  which appends TEXT after the pattern space
1376
1377 Options:
1378
1379         -e      add the script to the commands to be executed
1380         -n      suppress automatic printing of pattern space
1381
1382 This version of sed matches full regular expresions.
1383
1384 Example:
1385
1386         $ echo "foo" | sed -e 's/f[a-zA-Z]o/bar/g'
1387         bar
1388
1389 -------------------------------
1390
1391 =item setkeycodes
1392
1393 Usage: setkeycodes SCANCODE KEYCODE ...
1394
1395 Set entries into the kernel's scancode-to-keycode map,
1396 allowing unusual keyboards to generate usable keycodes.
1397
1398 SCANCODE may be either xx or e0xx (hexadecimal),
1399 and KEYCODE is given in decimal
1400
1401 Example:
1402
1403         # setkeycodes e030 127
1404
1405 -------------------------------
1406
1407 =item sh
1408
1409 Usage: sh
1410
1411 lash -- the BusyBox LAme SHell (command interpreter)
1412
1413 This command does not yet have proper documentation.  
1414
1415 Use lash just as you would use any other shell.  It properly handles pipes,
1416 redirects, job control, can be used as the shell for scripts (#!/bin/sh), and
1417 has a sufficient set of builtins to do what is needed.  It does not (yet)
1418 support Bourne Shell syntax.  If you need things like "if-then-else", "while",
1419 and such, use ash or bash.  If you just need a very simple and extremely small
1420 shell, this will do the job.
1421
1422 -------------------------------
1423
1424 =item sfdisk
1425
1426 Usage: sfdisk [options] device ...
1427
1428 device: something like /dev/hda or /dev/sda
1429
1430 useful options:
1431
1432     -s [or --show-size]: list size of a partition
1433     -c [or --id]:        print or change partition Id
1434     -l [or --list]:      list partitions of each device
1435     -d [or --dump]:      idem, but in a format suitable for later input
1436     -i [or --increment]: number cylinders etc. from 1 instead of from 0
1437     -uS, -uB, -uC, -uM:  accept/report in units of sectors/blocks/cylinders/MB
1438     -T [or --list-types]:list the known partition types
1439     -D [or --DOS]:       for DOS-compatibility: waste a little space
1440     -R [or --re-read]:   make kernel reread partition table
1441     -N# :                change only the partition with number #
1442     -n :                 do not actually write to disk
1443     -O file :            save the sectors that will be overwritten to file
1444     -I file :            restore these sectors again
1445     -v [or --version]:   print version
1446     -? [or --help]:      print this message
1447
1448 dangerous options:
1449
1450     -g [or --show-geometry]: print the kernel's idea of the geometry
1451     -x [or --show-extended]: also list extended partitions on output
1452
1453                              or expect descriptors for them on input
1454     -L  [or --Linux]:      do not complain about things irrelevant for Linux
1455     -q  [or --quiet]:      suppress warning messages
1456     You can override the detected geometry using:
1457     -C# [or --cylinders #]:set the number of cylinders to use
1458     -H# [or --heads #]:    set the number of heads to use
1459     -S# [or --sectors #]:  set the number of sectors to use
1460
1461 You can disable all consistency checking with:
1462
1463     -f  [or --force]:      do what I say, even if it is stupid
1464
1465 -------------------------------
1466
1467 =item sleep
1468
1469 Usage: sleep N
1470
1471 Pause for N seconds.
1472
1473 Example:
1474
1475         $ sleep 2
1476         [2 second delay results]
1477
1478 -------------------------------
1479
1480 =item sort
1481
1482 Usage: sort [B<-n>] [B<-r>] [FILE]...
1483
1484 Sorts lines of text in the specified files
1485
1486 Example:
1487
1488         $ echo -e "e\nf\nb\nd\nc\na" | sort
1489         a
1490         b
1491         c
1492         d
1493         e
1494         f
1495
1496 -------------------------------
1497
1498 =item sync
1499
1500 Usage: sync
1501
1502 Write all buffered filesystem blocks to disk.
1503
1504 -------------------------------
1505
1506 =item syslogd
1507
1508 Usage: syslogd [OPTION]...
1509
1510 Linux system and kernel (provides klogd) logging utility.
1511 Note that this version of syslogd/klogd ignores /etc/syslog.conf.
1512
1513 Options:
1514
1515         -m      Change the mark timestamp interval. default=20min. 0=off
1516         -n      Do not fork into the background (for when run by init)
1517         -K      Do not start up the klogd process (by default syslogd spawns klogd).
1518         -O      Specify an alternate log file.  default=/var/log/messages
1519
1520 -------------------------------
1521
1522 =item swapon
1523
1524 Usage: swapon [OPTION] [device]
1525
1526 Start swapping virtual memory pages on the given device.
1527
1528 Options:
1529
1530         -a      Start swapping on all swap devices
1531
1532 -------------------------------
1533
1534 =item swapoff
1535
1536 Usage: swapoff [OPTION] [device]
1537
1538 Stop swapping virtual memory pages on the given device.
1539
1540 Options:
1541
1542         -a      Stop swapping on all swap devices
1543
1544 -------------------------------
1545
1546 =item tail
1547
1548 Usage: tail [OPTION] [FILE]...
1549
1550 Print last 10 lines of each FILE to standard output.
1551 With more than one FILE, precede each with a header giving the
1552 file name. With no FILE, or when FILE is -, read standard input.
1553
1554 Options:
1555
1556         -n NUM          Print last NUM lines instead of first 10
1557         -f              Output data as the file grows.  This version
1558                         of 'tail -f' supports only one file at a time.
1559
1560 Example:
1561
1562         $ tail -n 1 /etc/resolv.conf
1563         nameserver 10.0.0.1
1564
1565 -------------------------------
1566
1567 =item tar
1568
1569 Usage: tar -[cxtvO] [B<--exclude> File] [B<-f> tarFile] [FILE] ...
1570
1571 Create, extract, or list files from a tar file.  Note that
1572 this version of tar treats hard links as separate files.
1573
1574 Main operation mode:
1575
1576         c               create
1577         x               extract
1578         t               list
1579
1580 File selection:
1581
1582         f               name of tarfile or "-" for stdin
1583         O               extract to stdout
1584         --exclude       file to exclude
1585
1586 Informative output:
1587
1588         v               verbosely list files processed
1589
1590 Example:
1591
1592         $ zcat /tmp/tarball.tar.gz | tar -xf -
1593         $ tar -cf /tmp/tarball.tar /usr/local
1594
1595 -------------------------------
1596
1597 =item test, [
1598
1599 Usage: test EXPRESSION
1600 or   [ EXPRESSION ]
1601
1602 Checks file types and compares values returning an exit
1603 code determined by the value of EXPRESSION.
1604
1605 Example:
1606
1607         $ test 1 -eq 2
1608         $ echo $?
1609         1
1610         $ test 1 -eq 1
1611         $ echo $?
1612         0
1613         $ [ -d /etc ]
1614         $ echo $?
1615         0
1616         $ [ -d /junk ]
1617         $ echo $?
1618         1
1619
1620 -------------------------------
1621
1622 =item tee
1623
1624 Usage: tee [OPTION]... [FILE]...
1625
1626 Copy standard input to each FILE, and also to standard output.
1627
1628 Options:
1629
1630         -a      append to the given FILEs, do not overwrite
1631
1632 Example:
1633
1634         $ echo "Hello" | tee /tmp/foo
1635         $ cat /tmp/foo
1636         Hello
1637
1638 -------------------------------
1639
1640 =item touch
1641
1642 Usage: touch [B<-c>] file [file ...]
1643
1644 Update the last-modified date on (or create) the selected file[s].
1645
1646 Example:
1647
1648         $ ls -l /tmp/foo
1649         /bin/ls: /tmp/foo: No such file or directory
1650         $ touch /tmp/foo
1651         $ ls -l /tmp/foo
1652         -rw-rw-r--    1 andersen andersen        0 Apr 15 01:11 /tmp/foo
1653
1654 -------------------------------
1655
1656 =item tr
1657
1658 Usage: tr [-cds] STRING1 [STRING2]
1659
1660 Translate, squeeze, and/or delete characters from
1661 standard input, writing to standard output.
1662
1663 Options:
1664
1665         -c      take complement of STRING1
1666         -d      delete input characters coded STRING1
1667         -s      squeeze multiple output characters of STRING2 into one character
1668
1669 Example:
1670
1671         $ echo "gdkkn vnqkc" | tr [a-y] [b-z]
1672         hello world
1673
1674 -------------------------------
1675
1676 =item true
1677
1678 Returns an exit code of TRUE (0)
1679
1680 Example:
1681
1682         $ true
1683         $ echo $?
1684         0
1685
1686 -------------------------------
1687
1688 =item tty
1689
1690 Usage: tty
1691
1692 Print the file name of the terminal connected to standard input.
1693
1694 Options:
1695
1696         -s      print nothing, only return an exit status
1697
1698 Example:
1699
1700         $ tty
1701         /dev/tty2
1702
1703 -------------------------------
1704
1705 =item umount
1706
1707 Usage: umount [flags] filesystem|directory
1708
1709 Flags:
1710
1711                 -a:     Unmount all file systems
1712                 -r:     Try to remount devices as read-only if mount is busy
1713                 -f:     Force filesystem umount (i.e. unreachable NFS server)
1714                 -l:     Do not free loop device (if a loop device has been used)
1715
1716 Example:
1717
1718         $ umount /dev/hdc1 
1719
1720 -------------------------------
1721
1722 =item uname
1723
1724 Usage: uname [OPTION]...
1725
1726 Print certain system information.  With no OPTION, same as B<-s>.
1727
1728 Options:
1729
1730         -a      print all information
1731         -m      the machine (hardware) type
1732         -n      print the machine's network node hostname
1733         -r      print the operating system release
1734         -s      print the operating system name
1735         -p      print the host processor type
1736         -v      print the operating system version
1737
1738 Example:
1739
1740         $ uname -a
1741         Linux debian 2.2.15pre13 #5 Tue Mar 14 16:03:50 MST 2000 i686 unknown
1742
1743 -------------------------------
1744
1745 =item uniq
1746
1747 Usage: uniq [OPTION]... [INPUT [OUTPUT]]
1748
1749 Discard all but one of successive identical lines from INPUT
1750 (or standard input), writing to OUTPUT (or standard output).
1751
1752 Example:
1753
1754         $ echo -e "a\na\nb\nc\nc\na" | sort | uniq
1755         a
1756         b
1757         c
1758
1759 -------------------------------
1760
1761 =item update
1762
1763 Usage: update [options]
1764
1765 Periodically flushes filesystem buffers.
1766
1767 Options:
1768
1769         -S      force use of sync(2) instead of flushing
1770         -s SECS call sync this often (default 30)
1771         -f SECS flush some buffers this often (default 5)
1772
1773 -------------------------------
1774
1775 =item uptime
1776
1777 Usage: uptime
1778
1779 Tells how long the system has been running since boot.
1780
1781 Example:
1782
1783         $ uptime
1784           1:55pm  up  2:30, load average: 0.09, 0.04, 0.00
1785
1786 -------------------------------
1787
1788 =item usleep
1789
1790 Usage: usleep N
1791
1792 Pauses for N microseconds.
1793
1794 Example:
1795
1796         $ usleep 1000000
1797         [pauses for 1 second]
1798
1799 -------------------------------
1800
1801 =item wc
1802
1803 Usage: wc [OPTION]... [FILE]...
1804
1805 Print line, word, and byte counts for each FILE, and a total line if
1806 more than one FILE is specified.  With no FILE, read standard input.
1807
1808 Options:
1809
1810         -c      print the byte counts
1811         -l      print the newline counts
1812         -L      print the length of the longest line
1813         -w      print the word counts
1814
1815 Example:
1816
1817         $ wc /etc/passwd
1818              31      46    1365 /etc/passwd
1819
1820 -------------------------------
1821
1822 =item whoami
1823
1824 Usage: whoami
1825
1826 Prints the user name associated with the current effective user id.
1827
1828 Example:
1829
1830         $ whoami
1831         andersen
1832
1833 -------------------------------
1834
1835 =item yes
1836
1837 Usage: yes [OPTION]... [STRING]...
1838
1839 Repeatedly outputs a line with all specified STRING(s), or `y'.
1840
1841 -------------------------------
1842
1843 =item zcat
1844
1845 This is essentially an alias for invoking "gunzip B<-c>", where 
1846 it decompresses the file inquestion and send the output to stdout. 
1847
1848 -------------------------------
1849
1850 =back
1851
1852 =head1 LIBC NSS
1853
1854 GNU Libc uses the Name Service Switch (NSS) to configure the behavior of the C
1855 library for the local environment, and to configure how it reads system data,
1856 such as passwords and group information.  BusyBox has made it Policy that it
1857 will never use NSS, and will never use and libc calls that make use of NSS.
1858 This allows you to run an embedded system without the need for installing an
1859 /etc/nsswitch.conf file and without and /lib/libnss_* libraries installed.
1860
1861 If you are using a system that is using a remote LDAP server for authentication
1862 via GNU libc NSS, and you want to use BusyBox, then you will need to adjust the
1863 BusyBox source.  Chances are though, that if you have enough space to install
1864 of that stuff on your system, then you probably want the full GNU utilities.
1865
1866 =head1 SEE ALSO
1867
1868 textutils(1), shellutils(1), etc...
1869
1870 =head1 MAINTAINER
1871
1872 Erik Andersen <andersee@debian.org> <andersen@lineo.com>
1873
1874 =head1 AUTHORS
1875
1876 The following people have contributed code to BusyBox whether
1877 they know it or not.
1878
1879 Erik Andersen <andersee@debian.org>
1880
1881 =for html <br>
1882
1883 John Beppu <beppu@lineo.com>
1884
1885 =for html <br>
1886
1887 Brian Candler <B.Candler@pobox.com>
1888
1889 =for html <br>
1890
1891 Randolph Chung <tausq@debian.org>
1892
1893 =for html <br>
1894
1895 Dave Cinege <dcinege@psychosis.com>     
1896
1897 =for html <br>
1898
1899 Karl M. Hegbloom <karlheg@debian.org>
1900
1901 =for html <br>
1902
1903 John Lombardo <john@deltanet.com>       
1904
1905 =for html <br>
1906
1907 Bruce Perens <bruce@perens.com>
1908
1909 =for html <br>
1910
1911 Pavel Roskin <pavel_roskin@geocities.com>
1912
1913 =for html <br>
1914
1915 Linus Torvalds <torvalds@transmeta.com>
1916
1917 =for html <br>
1918
1919 Charles P. Wright <cpwright@villagenet.com>
1920
1921 =for html <br>
1922
1923 Enrique Zanardi <ezanardi@ull.es>
1924
1925 =for html <br>
1926
1927 =cut
1928
1929 # $Id: busybox.pod,v 1.32 2000/06/02 03:30:50 andersen Exp $