From b9eb0233a9d257ce5311d0557ccb4432e836f088 Mon Sep 17 00:00:00 2001 From: Eric Andersen Date: Fri, 7 Jul 2000 05:04:24 +0000 Subject: Yet another busybox documentation update from Matt Kraai -Erik --- docs/busybox.sgml | 1077 +++++++++++++++++++++-------------------------------- 1 file changed, 415 insertions(+), 662 deletions(-) diff --git a/docs/busybox.sgml b/docs/busybox.sgml index 8ba31c0de..e0e023410 100644 --- a/docs/busybox.sgml +++ b/docs/busybox.sgml @@ -1841,765 +1841,518 @@ - -md5sum - - - - - -Usage: md5sum [OPTION] [file ...] - - - - - -Print or check MD5 checksums. - - - - - -Options: - - - - - - - -b read files in binary mode - -c check MD5 sums against given list - -t read files in text mode (default) - -g read a string - - - - - - -The following two options are useful only when verifying checksums: - - - - - - - -s don't output anything, status code shows success - -w warn about improperly formated MD5 checksum lines - - - - - - -Example: - - - - - - - $ md5sum busybox - 6fd11e98b98a58f64ff3398d7b324003 busybox - $ md5sum -c - - 6fd11e98b98a58f64ff3398d7b324003 busybox - busybox: OK - ^D - - - - - - -------------------------------- - - - - - -mkdir - - - - - -Usage: mkdir [OPTION] DIRECTORY... - - - - - -Create the DIRECTORY(ies), if they do not already exist - - - - - -Options: - - - - - - - -m set permission mode (as in chmod), not rwxrwxrwx - umask - -p no error if directory exists, make parent directories as needed - - - - - - -Example: - - - - - - - $ mkdir /tmp/foo - $ mkdir /tmp/foo - /tmp/foo: File exists - $ mkdir /tmp/foo/bar/baz - /tmp/foo/bar/baz: No such file or directory - $ mkdir -p /tmp/foo/bar/baz - - - - - - -------------------------------- - - - - - -mkfifo - - - - - -Usage: mkfifo [OPTIONS] name - - - - - -Creates a named pipe (identical to 'mknod name p') - - - - - -Options: - - - - - - - -m create the pipe using the specified mode (default a=rw) - - - - - - -------------------------------- - - - - - -mkfs.minix - - - - - -Usage: mkfs.minix [-c | -l filename] [-nXX] [-iXX] /dev/name [blocks] - - - - - -Make a MINIX filesystem. - - - - - -OPTIONS: - - - - - - - -c Check the device for bad blocks - -n [14|30] Specify the maximum length of filenames - -i Specify the number of inodes for the filesystem - -l FILENAME Read the bad blocks list from FILENAME - -v Make a Minix version 2 filesystem - - - - - - -------------------------------- - - - - - -mknod - - - - - -Usage: mknod [OPTIONS] NAME TYPE MAJOR MINOR - - - - - -Create a special file (block, character, or pipe). - - - - - -Options: - - - - - - - -m create the special file using the specified mode (default a=rw) - - - - - - -TYPEs include: b: Make a block (buffered) device. c or u: Make a character -(un-buffered) device. p: Make a named pipe. MAJOR and MINOR are ignored for -named pipes. - - - - - -Example: - - - - - - - $ mknod /dev/fd0 b 2 0 - $ mknod -m 644 /tmp/pipe p - - - - - - -------------------------------- - - - - - -mkswap - - - - - -Usage: mkswap [-c] [-v0|-v1] device [block-count] - - - - - -Prepare a disk partition to be used as a swap partition. - - - - - -Options: - - - - - - - -c Check for read-ability. - -v0 Make version 0 swap [max 128 Megs]. - -v1 Make version 1 swap [big!] (default for kernels > 2.1.117). - block-count Number of block to use (default is entire partition). - - - - - - -------------------------------- - - - - - -mktemp + + md5sum - - - - -Usage: mktemp [-q] TEMPLATE - - - - - -Creates a temporary file with its name based on TEMPLATE. TEMPLATE is any -name with six `Xs' (i.e. /tmp/temp.XXXXXX). - - - - - -Example: - - - - - - - $ mktemp /tmp/temp.XXXXXX - /tmp/temp.mWiLjM - $ ls -la /tmp/temp.mWiLjM - -rw------- 1 andersen andersen 0 Apr 25 17:10 /tmp/temp.mWiLjM - - - - - - -------------------------------- - - - - - -more - - - - - -Usage: more [file ...] - - - - - -More is a filter for paging through text one screenful at a time. - - - - - -Example: - - - - - - - $ dmesg | more - - - - - - -------------------------------- - - - - - -mount - - - - - -Usage: mount [flags] mount [flags] device directory [-o options,more-options] - - - - - -Flags: - - - - - - - -a: Mount all file systems in fstab. - -o option: One of many filesystem options, listed below. - -r: Mount the filesystem read-only. - -t fs-type: Specify the filesystem type. - -w: Mount for reading and writing (default). - - - - - - -Options for use with the ``-o'' flag: - - - - - - - async/sync: Writes are asynchronous / synchronous. - atime/noatime: Enable / disable updates to inode access times. - dev/nodev: Allow use of special device files / disallow them. - exec/noexec: Allow use of executable files / disallow them. - loop: Mounts a file via loop device. - suid/nosuid: Allow set-user-id-root programs / disallow them. - remount: Re-mount a currently-mounted filesystem, changing its flags. - ro/rw: Mount for read-only / read-write. - There are EVEN MORE flags that are specific to each filesystem. - You'll have to see the written documentation for those. - - - - - - -Example: - - - - - - - $ mount - /dev/hda3 on / type minix (rw) - proc on /proc type proc (rw) - devpts on /dev/pts type devpts (rw) - $ mount /dev/fd0 /mnt -t msdos -o ro - $ mount /tmp/diskimage /opt -t ext2 -o loop - - - - - - -------------------------------- - - - - - -mt - - - - - -Usage: mt [-f device] opcode value - - - - - -Control magnetic tape drive operation - - - - - -------------------------------- - - - - - -mv - - - - - -Usage: mv SOURCE DEST - - - - - - - or: mv SOURCE... DIRECTORY - - - - + + Usage: md5sum [OPTION]... FILE... + - -Rename SOURCE to DEST, or move SOURCE(s) to DIRECTORY. + + Print or check MD5 checksums. + + + Options: + - + + + -b Read files in binary mode + -c Check MD5 sums against given list + -t Read files in text mode (default) + -g Read a string + + - -Example: + + The following two options are useful only when verifying + checksums: + + + + -s Don't output anything, status code shows success + -w Warn about improperly formated MD5 checksum lines + + - + + Example: + - - - $ mv /tmp/foo /bin/bar - + + + $ md5sum busybox + 6fd11e98b98a58f64ff3398d7b324003 busybox + $ md5sum -c + 6fd11e98b98a58f64ff3398d7b324003 busybox + 6fd11e98b98a58f64ff3398d7b324002 busybox + md5sum: MD5 check failed for 'busybox' + ^D + + + + + mkdir - + + Usage: mkdir [OPTION]... DIRECTORY... + - -------------------------------- + + Create the DIRECTORY(s), if they do not already exist. + + + Options: + - + + + -m Set permission mode (as in chmod), not rwxrwxrwx - umask + -p No error if directory exists, make parent directories as needed + + - -nc + + Example: + - - + + + $ mkdir /tmp/foo + $ mkdir /tmp/foo + /tmp/foo: File exists + $ mkdir /tmp/foo/bar/baz + /tmp/foo/bar/baz: No such file or directory + $ mkdir -p /tmp/foo/bar/baz + + + - -Usage: nc [IP] [port] + + mkfifo + + Usage: mkfifo [OPTION] NAME + - + + Create a named pipe (identical to 'mknod NAME p'). + - -Netcat opens a pipe to IP:port + + Options: + + + + -m MODE Create the pipe using the specified mode (default a=rw) + + + - + + mkfs.minix - -Example: + + Usage: mkfs.minix [OPTION]... NAME [BLOCKS] + + + Make a MINIX filesystem. + - + + Options: + - - - $ nc foobar.somedomain.com 25 - 220 foobar ESMTP Exim 3.12 #1 Sat, 15 Apr 2000 00:03:02 -0600 - help - 214-Commands supported: - 214- HELO EHLO MAIL RCPT DATA AUTH - 214 NOOP QUIT RSET HELP - quit - 221 foobar closing connection - + + + -c Check the device for bad blocks + -n [14|30] Specify the maximum length of filenames + -i Specify the number of inodes for the filesystem + -l FILENAME Read the bad blocks list from FILENAME + -v Make a Minix version 2 filesystem + + + + + mknod - + + Usage: mknod [OPTION]... NAME TYPE MAJOR MINOR + - -------------------------------- + + Create a special file (block, character, or pipe). + + + Options: + - + + + -m Create the special file using the specified mode (default a=rw) + + - -nslookup + + TYPE may be: + - - + + + b Make a block (buffered) device + c or u Make a character (un-buffered) device + p Make a named pipe. MAJOR and MINOR are ignored for named pipes + + - -Usage: nslookup [HOST] + + Example: + + + + $ mknod /dev/fd0 b 2 0 + $ mknod -m 644 /tmp/pipe p + + + - + + mkswap - -Queries the nameserver for the IP address of the given HOST + + Usage: mkswap [OPTION]... DEVICE [BLOCKS] + + + Prepare a disk partition to be used as a swap partition. + - + + Options: + - -Example: + + + -c Check for read-ability. + -v0 Make version 0 swap [max 128 Megs]. + -v1 Make version 1 swap [big!] (default for kernels > 2.1.117). + BLOCKS Number of block to use (default is entire partition). + + + + + mktemp - + + Usage: mktemp TEMPLATE + - - - $ nslookup localhost - Server: default - Address: default - + + Creates a temporary file with its name based on + TEMPLATE. TEMPLATE is any name with six `Xs' (i.e. + /tmp/temp.XXXXXX). + + + Example: + - + + + $ mktemp /tmp/temp.XXXXXX + /tmp/temp.mWiLjM + $ ls -la /tmp/temp.mWiLjM + -rw------- 1 andersen andersen 0 Apr 25 17:10 /tmp/temp.mWiLjM + + + - - - Name: debian - Address: 127.0.0.1 - + + more + + Usage: more [FILE]... + - + + Page through text one screenful at a time. + - -------------------------------- + + Example: + + + + $ dmesg | more + + + - + + mount - -ping + + Usage: mount [OPTION]... + - - + + + or: mount [OPTION]... DEVICE DIRECTORY + + - -Usage: ping [OPTION]... host + + Mount filesystems. + + + Options: + - + + + -a Mount all filesystems in /etc/fstab + -o One of the many filesystem options listed below + -r Mount the filesystem read-only + -t TYPE Specify the filesystem type + -w Mount the filesystem read-write + + - -Send ICMP ECHO_REQUEST packets to network hosts. + + Options for use with the -o flag: + + + + async/sync Writes are asynchronous / synchronous + atime/noatime Enable / disable updates to inode access times + dev/nodev Allow / disallow use of special device files + exec/noexec Allow / disallow use of executable files + loop Mount a file via loop device + suid/nosuid Allow / disallow set-user-id-root programs + remount Remount a currently mounted filesystem + ro/rw Mount filesystem read-only / read-write + + - + + There are even more flags that are filesystem specific. + You'll have to see the written documentation for those. + - -Options: + + Example: + + + + $ mount + /dev/hda3 on / type minix (rw) + proc on /proc type proc (rw) + devpts on /dev/pts type devpts (rw) + $ mount /dev/fd0 /mnt -t msdos -o ro + $ mount /tmp/diskimage /opt -t ext2 -o loop + + + - + + mt - - - -c COUNT Send only COUNT pings. - -s SIZE Send SIZE data bytes in packets (default=56). - -q Quiet mode, only displays output at start - and when finished. -Example: - + + Usage: mt [OPTION] OPCODE VALUE + + + Control magnetic tape drive operation. + - + + Options: + - - - $ ping localhost - PING slag (127.0.0.1): 56 data bytes - 64 bytes from 127.0.0.1: icmp_seq=0 ttl=255 time=20.1 ms - + + + -f DEVICE Control DEVICE + + + + + mv - + + Usage: mv SOURCE DEST + - - - --- debian ping statistics --- - 1 packets transmitted, 1 packets received, 0% packet loss - round-trip min/avg/max = 20.1/20.1/20.1 ms - + + + or: mv SOURCE... DIRECTORY + + + + Rename SOURCE to DEST, or move SOURCE(s) to DIRECTORY. + - + + Example: + - -------------------------------- + + + $ mv /tmp/foo /bin/bar + + + + + nc - + + Usage: nc HOST PORT + - -poweroff + + Open a pipe to HOST:PORT. + - - + + Example: + - -Shuts down the system, and requests that the kernel turn off power upon -halting. + + + $ nc foobar.somedomain.com 25 + 220 foobar ESMTP Exim 3.12 #1 Sat, 15 Apr 2000 00:03:02 -0600 + help + 214-Commands supported: + 214- HELO EHLO MAIL RCPT DATA AUTH + 214 NOOP QUIT RSET HELP + quit + 221 foobar closing connection + + + + + nslookup - + + Usage: nslookup [HOST] + - -------------------------------- + + Query the nameserver for the IP address of the given + HOST. + + + Example: + - + + + $ nslookup localhost + Server: default + Address: default - -printf + Name: debian + Address: 127.0.0.1 + + + - - + + ping - -Usage: printf format [argument...] + + Usage: ping [OPTION]... HOST + + + Send ICMP ECHO_REQUEST packets to HOST. + - + + Options: + - -Formats and prints the given data in a manner similar to the C printf -command. + + + -c COUNT Send only COUNT pings + -s SIZE Send SIZE data bytes in packets (default=56) + -q Quiet mode, only displays output at start and when finished + + + + Example: + - + + + $ ping localhost + PING slag (127.0.0.1): 56 data bytes + 64 bytes from 127.0.0.1: icmp_seq=0 ttl=255 time=20.1 ms - -Example: + --- debian ping statistics --- + 1 packets transmitted, 1 packets received, 0% packet loss + round-trip min/avg/max = 20.1/20.1/20.1 ms + + + + + poweroff - + + Usage: poweroff + - - - $ printf "Val=%d\n" 5 - Val=5 - + + Shut down the system, and request that the kernel turn + off power upon halting. + + + + printf - + + Usage: printf FORMAT [ARGUMENT]... + - -------------------------------- + + Format and print the given data in a manner similar to + the C printf command. + + + Example: + - + + + $ printf "Val=%d\n" 5 + Val=5 + + + - + ps @@ -4386,9 +4139,9 @@ stdout. GNU Libc uses the Name Service Switch (NSS) to configure the behavior of the C library for the local environment, and to configure how it reads system data, such as passwords and group information. BusyBox has made it -Policy that it will never use NSS, and will never use and libc calls that +Policy that it will never use NSS, and will never use libc calls that make use of NSS. This allows you to run an embedded system without the need -for installing an /etc/nsswitch.conf file and without and /lib/libnss_* +for installing an /etc/nsswitch.conf file and without /lib/libnss_* libraries installed. -- cgit v1.2.3