From: Eric Andersen Date: Thu, 6 Jul 2000 16:58:45 +0000 (-0000) Subject: DocBook documentation update from Matt Kraai X-Git-Tag: 0_46~59 X-Git-Url: https://git.librecmc.org/?a=commitdiff_plain;h=6f5e281479193fb2cf76a18017f3df9d9f1b8941;p=oweals%2Fbusybox.git DocBook documentation update from Matt Kraai -Erik --- diff --git a/docs/busybox.sgml b/docs/busybox.sgml index 49b82c37d..01c407a17 100644 --- a/docs/busybox.sgml +++ b/docs/busybox.sgml @@ -57,7 +57,6 @@ - How to use BusyBox @@ -76,7 +75,6 @@ - When you create a link to BusyBox for the function you wish to use, when @@ -147,12 +145,11 @@ - ar - Usage: ar [optxvV] archive [filenames] + Usage: ar [OPTION] archive [FILENAME]... @@ -165,18 +162,15 @@ - o preserve original dates - p extract to stdout - t list - x extract - v verbosely list files processed + o Preserve original dates + p Extract to stdout + t List + x Extract + v Verbosely list files processed - - - basename @@ -184,7 +178,7 @@ - Strips directory path and suffixes from FILE. If specified, also removes + Strip directory path and suffixes from FILE. If specified, also removes any trailing SUFFIX. @@ -204,16 +198,15 @@ - cat - Usage: cat [FILE ...] + Usage: cat [FILE]... - Concatenates FILE(s) and prints them to the standard + Concatenate FILE(s) and prints them to the standard output. @@ -227,157 +220,150 @@ 110716.72 17.67 - - - chgrp - - Usage: chgrp [OPTION]... GROUP FILE... - + + Usage: chgrp [OPTION]... GROUP FILE... + - - Change the group membership of each FILE to GROUP. - + + Change the group membership of each FILE to GROUP. + - - Options: - + + Options: + - - - -R change files and directories recursively - - + + + -R Change files and directories recursively + + - - Example: - + + Example: + - - - $ ls -l /tmp/foo - -r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo - $ chgrp root /tmp/foo - $ ls -l /tmp/foo - -r--r--r-- 1 andersen root 0 Apr 12 18:25 /tmp/foo - - + + + $ ls -l /tmp/foo + -r--r--r-- 1 andersen andersen 0 Apr 12 18:25 /tmp/foo + $ chgrp root /tmp/foo + $ ls -l /tmp/foo + -r--r--r-- 1 andersen root 0 Apr 12 18:25 /tmp/foo + + - - chmod - - Usage: chmod [-R] MODE[,MODE]... FILE... - + + Usage: chmod [-R] MODE[,MODE]... FILE... + - - Changes file access permissions for the specified - FILE(s) (or directories). Each MODE is defined by - combining the letters for WHO has access to the file, an OPERATOR for - selecting how the permissions should be changed, and a PERMISSION for - FILE(s) (or directories). - + + Change file access permissions for the specified + FILE(s) (or directories). Each MODE is defined by + combining the letters for WHO has access to the file, an OPERATOR for + selecting how the permissions should be changed, and a PERMISSION for + FILE(s) (or directories). + - - WHO may be chosen from - + + WHO may be chosen from + - - - u User who owns the file - g Users in the file's Group - o Other users not in the file's group - a All users - - + + + u User who owns the file + g Users in the file's Group + o Other users not in the file's group + a All users + + - - OPERATOR may be chosen from - + + OPERATOR may be chosen from + - - - + Add a permission - - Remove a permission - = Assign a permission - - + + + + Add a permission + - Remove a permission + = Assign a permission + + - - PERMISSION may be chosen from - + + PERMISSION may be chosen from + - - - r Read - w Write - x Execute (or access for directories) - s Set user (or group) ID bit - t Sticky bit (for directories prevents removing files by non-owners) - - + + + r Read + w Write + x Execute (or access for directories) + s Set user (or group) ID bit + t Sticky bit (for directories prevents removing files by non-owners) + + - - Alternately, permissions can be set numerically where the first three - numbers are calculated by adding the octal values, such as - + + Alternately, permissions can be set numerically where the first three + numbers are calculated by adding the octal values, such as + - - - 4 Read - 2 Write - 1 Execute - - + + + 4 Read + 2 Write + 1 Execute + + - - An optional fourth digit can also be used to specify - + + An optional fourth digit can also be used to specify + - - - 4 Set user ID - 2 Set group ID - 1 Sticky bit - - + + + 4 Set user ID + 2 Set group ID + 1 Sticky bit + + - - Options: - + + Options: + - - - -R Change files and directories recursively. - - + + + -R Change files and directories recursively. + + - - Example: - + + Example: + - - - $ ls -l /tmp/foo - -rw-rw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo - $ chmod u+x /tmp/foo - $ ls -l /tmp/foo - -rwxrw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo* - $ chmod 444 /tmp/foo - $ ls -l /tmp/foo - -r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo - - + + + $ ls -l /tmp/foo + -rw-rw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo + $ chmod u+x /tmp/foo + $ ls -l /tmp/foo + -rwxrw-r-- 1 root root 0 Apr 12 18:25 /tmp/foo* + $ chmod 444 /tmp/foo + $ ls -l /tmp/foo + -r--r--r-- 1 root root 0 Apr 12 18:25 /tmp/foo + + - - chown @@ -386,7 +372,7 @@ - Changes the owner and/or group of each FILE to OWNER and/or GROUP. + Change the owner and/or group of each FILE to OWNER and/or GROUP. @@ -395,7 +381,7 @@ - -R Changes files and directories recursively + -R Change files and directories recursively @@ -417,8 +403,6 @@ - - chroot @@ -445,7 +429,6 @@ - chvt @@ -453,13 +436,10 @@ - Changes the foreground virtual terminal to /dev/ttyN + Change the foreground virtual terminal to /dev/ttyN - - - clear @@ -468,11 +448,10 @@ - Clears the screen. + Clear the screen. - cp @@ -487,7 +466,7 @@ - Copies SOURCE to DEST, or multiple SOURCE(s) to + Copy SOURCE to DEST, or multiple SOURCE(s) to DIRECTORY. @@ -498,14 +477,13 @@ -a Same as -dpR - -d Preserves links - -p Preserves file attributes if possible - -R Copies directories recursively + -d Preserve links + -p Preserve file attributes if possible + -R Copy directories recursively - cut @@ -514,7 +492,7 @@ - Prints selected fields from each input FILE to standard output. + Print selected fields from each input FILE to standard output. @@ -546,8 +524,6 @@ - - date @@ -562,7 +538,7 @@ - Displays the current time in the given FORMAT, or sets the system date. + Display the current time in the given FORMAT, or set the system date. @@ -571,9 +547,9 @@ - -R Outputs RFC-822 compliant date string - -s Sets time described by STRING - -u Prints or sets Coordinated Universal Time + -R Output RFC-822 compliant date string + -s Set time described by STRING + -u Print or set Coordinated Universal Time @@ -589,464 +565,320 @@ + + dc + + Usage: dc [EXPRESSION] + - + + This is a Tiny RPN calculator that understands the + following operations: +, -, /, *, and, or, not, eor. If + no arguments are given, dc will process input from + stdin. + + + The behaviour of BusyBox/dc deviates (just a little ;-) + from GNU/dc, but this will be remedied in the future. + - -dc + + Example: + - - + + + $ dc 2 2 + + 4 + $ dc 8 8 \* 2 2 + / + 16 + $ dc 0 1 and + 0 + $ dc 0 1 or + 1 + $ echo 72 9 div 8 mul | dc + 64 + + + - -Usage: dc expression ... + + dd + + Usage: dd [OPTION]... + - + + Copy a file, converting and formatting according to + options. + - -This is a Tiny RPN calculator that understands the following operations: +, --, /, *, and, or, not, eor. If no arguments are given, dc will process -input from STDIN. + + Options: + + + + if=FILE Read from FILE instead of stdin + of=FILE Write to FILE instead of stdout + bs=N Read and write N bytes at a time + count=N Copy only N input blocks + skip=N Skip N input blocks + seek=N Skip N output blocks + + - + + Numbers may be suffixed by w (x2), k (x1024), b (x512), + or M (x1024^2). + - -The behaviour of BusyBox/dc deviates (just a little ;-) from GNU/dc, but -this will be remedied in the future. + + Example: + + + + $ dd if=/dev/zero of=/dev/ram1 bs=1M count=4 + 4+0 records in + 4+0 records out + + + - + + deallocvt - -Example: + + Usage: deallocvt N + + + Deallocate unused virtual terminal /dev/ttyN. + + - + + df - - - $ dc 2 2 + - 4 - $ dc 8 8 \* 2 2 + / - 16 - $ dc 0 1 and - 0 - $ dc 0 1 or - 1 - $ echo 72 9 div 8 mul | dc - 64 - + + Usage: df [FILE]... + + + Print the filesystem space used and space available. + - + + Example: + - -------------------------------- + + + $ df + Filesystem 1k-blocks Used Available Use% Mounted on + /dev/sda3 8690864 8553540 137324 98% / + /dev/sda1 64216 36364 27852 57% /boot + $ df /dev/sda3 + Filesystem 1k-blocks Used Available Use% Mounted on + /dev/sda3 8690864 8553540 137324 98% / + + + + + + dirname + + Usage: dirname NAME + - + + Strip non-directory suffix from NAME. + - -dd + + Example: + - - + + + $ dirname /tmp/foo + /tmp + $ dirname /tmp/foo/ + /tmp + + + - -Usage: dd [if=name] [of=name] [bs=n] [count=n] [skip=n] [seek=n] + + dmesg + + Usage: dmesg [OPTION]... + - + + Print or control the kernel ring buffer. + - -Copy a file, converting and formatting according to options - - - - - - - if=FILE read from FILE instead of stdin - of=FILE write to FILE instead of stdout - bs=n read and write n bytes at a time - count=n copy only n input blocks - skip=n skip n input blocks - seek=n skip n output blocks - - - - - - -Numbers may be suffixed by w (x2), k (x1024), b (x512), or M (x1024^2) - - - - - -Example: - - - - - - - $ dd if=/dev/zero of=/dev/ram1 bs=1M count=4 - 4+0 records in - 4+0 records out - - - - - - -------------------------------- - - - - -deallocvt - - - - - -Usage: deallocvt N - - - - - -Deallocates unused virtual terminal /dev/ttyN - - - - - -------------------------------- - - - - - - -df - - - - - -Usage: df [filesystem ...] - - - - - -Prints the filesystem space used and space available. - - - - - -Example: - - - - - - - $ df - Filesystem 1k-blocks Used Available Use% Mounted on - /dev/sda3 8690864 8553540 137324 98% / - /dev/sda1 64216 36364 27852 57% /boot - $ df /dev/sda3 - Filesystem 1k-blocks Used Available Use% Mounted on - /dev/sda3 8690864 8553540 137324 98% / - - - - - - -------------------------------- - - - - - -dirname - - - - - -Usage: dirname NAME - - - - - -Strip non-directory suffix from file name - - - - - -Example: - - - - - - - $ dirname /tmp/foo - /tmp - $ dirname /tmp/foo/ - /tmp - - - - - - -------------------------------- - - - - - -dmesg - - - - - -Usage: dmesg [-c] [-n level] [-s bufsize] - - - - - -Print or controls the kernel ring buffer. - - - - - -------------------------------- - - - - - -du - - - - - -Usage: du [OPTION]... [FILE]... - - - - - -Summarize disk space used for each FILE and/or directory. Disk space is -printed in units of 1k (i.e. 1024 bytes). - - - - - -Options: - - - - - - - -l count sizes many times if hard linked - -s display only a total for each argument - - - - - - -Example: - - - - - - - $ ./BusyBox du - 16 ./CVS - 12 ./kernel-patches/CVS - 80 ./kernel-patches - 12 ./tests/CVS - 36 ./tests - 12 ./scripts/CVS - 16 ./scripts - 12 ./docs/CVS - 104 ./docs - 2417 . - - - - - - -------------------------------- - - - - - -dutmp - - - - - -Usage: dutmp [FILE] - - - - - -Dump utmp file format (pipe delimited) from FILE or stdin to stdout. - - - - - -Example: - - - - - - - $ dutmp /var/run/utmp - 8|7||si|||0|0|0|955637625|760097|0 - 2|0|~|~~|reboot||0|0|0|955637625|782235|0 - 1|20020|~|~~|runlevel||0|0|0|955637625|800089|0 - 8|125||l4|||0|0|0|955637629|998367|0 - 6|245|tty1|1|LOGIN||0|0|0|955637630|998974|0 - 6|246|tty2|2|LOGIN||0|0|0|955637630|999498|0 - 7|336|pts/0|vt00andersen|andersen|:0.0|0|0|0|955637763|0|0 - - - - - - -------------------------------- - - - - - -echo - - - - - -Usage: echo [-neE] [ARG ...] - - - - - -Prints the specified ARGs to stdout - - - - - -Options: - - - - - - - -n suppress trailing newline - -e interpret backslash-escaped characters (i.e. \t=tab etc) - -E disable interpretation of backslash-escaped characters - + + Options: + + + + -c Clear the ring buffer after printing + -n LEVEL Set the console logging level to LEVEL + -s BUFSIZE Query ring buffer using a buffer of BUFSIZE + + + - + + du - -Example: + + Usage: du [OPTION]... [FILE]... + + + Summarize the disk space used for each FILE or current + directory. Disk space printed in units of 1k (i.e. + 1024 bytes). + - + + Options: + - - - $ echo "Erik is cool" - Erik is cool - $ echo -e "Erik\nis\ncool" - Erik - is - cool - $ echo "Erik\nis\ncool" - Erik\nis\ncool - + + + -l Count sizes many times if hard linked + -s Display only a total for each argument + + + + Example: + - + + + $ du + 16 ./CVS + 12 ./kernel-patches/CVS + 80 ./kernel-patches + 12 ./tests/CVS + 36 ./tests + 12 ./scripts/CVS + 16 ./scripts + 12 ./docs/CVS + 104 ./docs + 2417 . + + + - -------------------------------- + + dutmp + + Usage: dutmp [FILE] + - + + Dump utmp file format (pipe delimited) from FILE or + stdin to stdout. + - -false + + Example: + - - + + + $ dutmp /var/run/utmp + 8|7||si|||0|0|0|955637625|760097|0 + 2|0|~|~~|reboot||0|0|0|955637625|782235|0 + 1|20020|~|~~|runlevel||0|0|0|955637625|800089|0 + 8|125||l4|||0|0|0|955637629|998367|0 + 6|245|tty1|1|LOGIN||0|0|0|955637630|998974|0 + 6|246|tty2|2|LOGIN||0|0|0|955637630|999498|0 + 7|336|pts/0|vt00andersen|andersen|:0.0|0|0|0|955637763|0|0 + + + - -Returns an exit code of FALSE (1) + + echo + + Usage: echo [OPTION]... [ARG]... + - + + Print ARGs to stdout. + - -Example: + + Options: + + + + -n Suppress trailing newline + -e Enable interpretation of escaped characters + -E Disable interpretation of escaped characters + + - + + Example: + - - - $ false - $ echo $? - 1 - + + + $ echo "Erik is cool" + Erik is cool + $ echo -e "Erik\nis\ncool" + Erik + is + cool + $ echo "Erik\nis\ncool" + Erik\nis\ncool + + + + + false - + + Usage: false + - -------------------------------- + + Returns an exit code of FALSE (1). + + + Example: + - + + + $ false + $ echo $? + 1 + + + - + fbset