diff options
| author | Pere Orga <gotrunks@gmail.com> | 2011-04-11 03:29:49 +0200 |
|---|---|---|
| committer | Denys Vlasenko <vda.linux@googlemail.com> | 2011-04-11 03:29:49 +0200 |
| commit | 5bc8c005a8e15c43285bc595a8d404de67a482ac (patch) | |
| tree | 98f2d35d1db26f4d8cba5f095ff63bf8e2e8d980 | |
| parent | 73ef15cf3894716c1393ed21dee6e6bb2cdbc90f (diff) | |
| download | busybox-5bc8c005a8e15c43285bc595a8d404de67a482ac.tar.gz | |
move remaining help text from include/usage.src.h
Signed-off-by: Pere Orga <gotrunks@gmail.com>
Signed-off-by: Denys Vlasenko <vda.linux@googlemail.com>
142 files changed, 2369 insertions, 2312 deletions
diff --git a/console-tools/loadfont.c b/console-tools/loadfont.c index 588322b05..597519f91 100644 --- a/console-tools/loadfont.c +++ b/console-tools/loadfont.c @@ -18,6 +18,17 @@ //usage: //usage:#define loadfont_example_usage //usage: "$ loadfont < /etc/i18n/fontname\n" +//usage: +//usage:#define setfont_trivial_usage +//usage: "FONT [-m MAPFILE] [-C TTY]" +//usage:#define setfont_full_usage "\n\n" +//usage: "Load a console font\n" +//usage: "\nOptions:" +//usage: "\n -m MAPFILE Load console screen map" +//usage: "\n -C TTY Affect TTY instead of /dev/tty" +//usage: +//usage:#define setfont_example_usage +//usage: "$ setfont -m koi8-r /etc/i18n/fontname\n" #include "libbb.h" #include <sys/kd.h> diff --git a/e2fsprogs/old_e2fsprogs/e2fsck.c b/e2fsprogs/old_e2fsprogs/e2fsck.c index d73665988..1f990b303 100644 --- a/e2fsprogs/old_e2fsprogs/e2fsck.c +++ b/e2fsprogs/old_e2fsprogs/e2fsck.c @@ -29,6 +29,28 @@ * Licensed under GPLv2 or later, see file LICENSE in this source tree. */ +/* +//usage:#define e2fsck_trivial_usage +//usage: "[-panyrcdfvstDFSV] [-b superblock] [-B blocksize] " +//usage: "[-I inode_buffer_blocks] [-P process_inode_size] " +//usage: "[-l|-L bad_blocks_file] [-C fd] [-j external_journal] " +//usage: "[-E extended-options] device" +//usage:#define e2fsck_full_usage "\n\n" +//usage: "Check ext2/ext3 file system\n" +//usage: "\nOptions:" +//usage: "\n -p Automatic repair (no questions)" +//usage: "\n -n Make no changes to the filesystem" +//usage: "\n -y Assume 'yes' to all questions" +//usage: "\n -c Check for bad blocks and add them to the badblock list" +//usage: "\n -f Force checking even if filesystem is marked clean" +//usage: "\n -v Verbose" +//usage: "\n -b superblock Use alternative superblock" +//usage: "\n -B blocksize Force blocksize when looking for superblock" +//usage: "\n -j journal Set location of the external journal" +//usage: "\n -l file Add to badblocks list" +//usage: "\n -L file Set badblocks list" +*/ + #include "e2fsck.h" /*Put all of our defines here to clean things up*/ #define _(x) x diff --git a/include/usage.src.h b/include/usage.src.h index 2c88c46a1..78beccf4d 100644 --- a/include/usage.src.h +++ b/include/usage.src.h @@ -12,2322 +12,11 @@ #ifndef BB_USAGE_H #define BB_USAGE_H 1 - #define NOUSAGE_STR "\b" INSERT -#define acpid_trivial_usage \ - "[-d] [-c CONFDIR] [-l LOGFILE] [-a ACTIONFILE] [-M MAPFILE] [-e PROC_EVENT_FILE] [-p PIDFILE]" -#define acpid_full_usage "\n\n" \ - "Listen to ACPI events and spawn specific helpers on event arrival\n" \ - "\nOptions:" \ - "\n -c DIR Config directory [/etc/acpi]" \ - "\n -d Don't daemonize, (implies -f)" \ - "\n -e FILE /proc event file [/proc/acpi/event]" \ - "\n -f Run in foreground" \ - "\n -l FILE Log file [/var/log/acpid.log]" \ - "\n -p FILE Pid file [/var/run/acpid.pid]" \ - "\n -a FILE Action file [/etc/acpid.conf]" \ - "\n -M FILE Map file [/etc/acpi.map]" \ - IF_FEATURE_ACPID_COMPAT( \ - "\n\nAccept and ignore compatibility options -g -m -s -S -v" \ - ) - -#define acpid_example_usage \ - "Without -e option, acpid uses all /dev/input/event* files\n" \ - "# acpid\n" \ - "# acpid -l /var/log/my-acpi-log\n" \ - "# acpid -e /proc/acpi/event\n" - -#define adjtimex_trivial_usage \ - "[-q] [-o OFF] [-f FREQ] [-p TCONST] [-t TICK]" -#define adjtimex_full_usage "\n\n" \ - "Read and optionally set system timebase parameters. See adjtimex(2)\n" \ - "\nOptions:" \ - "\n -q Quiet" \ - "\n -o OFF Time offset, microseconds" \ - "\n -f FREQ Frequency adjust, integer kernel units (65536 is 1ppm)" \ - "\n (positive values make clock run faster)" \ - "\n -t TICK Microseconds per tick, usually 10000" \ - "\n -p TCONST" \ - -#define arp_trivial_usage \ - "\n[-vn] [-H HWTYPE] [-i IF] -a [HOSTNAME]" \ - "\n[-v] [-i IF] -d HOSTNAME [pub]" \ - "\n[-v] [-H HWTYPE] [-i IF] -s HOSTNAME HWADDR [temp]" \ - "\n[-v] [-H HWTYPE] [-i IF] -s HOSTNAME HWADDR [netmask MASK] pub" \ - "\n[-v] [-H HWTYPE] [-i IF] -Ds HOSTNAME IFACE [netmask MASK] pub" -#define arp_full_usage "\n\n" \ - "Manipulate ARP cache\n" \ - "\nOptions:" \ - "\n -a Display (all) hosts" \ - "\n -s Set new ARP entry" \ - "\n -d Delete a specified entry" \ - "\n -v Verbose" \ - "\n -n Don't resolve names" \ - "\n -i IF Network interface" \ - "\n -D Read <hwaddr> from given device" \ - "\n -A,-p AF Protocol family" \ - "\n -H HWTYPE Hardware address type" \ - -#define arping_trivial_usage \ - "[-fqbDUA] [-c CNT] [-w TIMEOUT] [-I IFACE] [-s SRC_IP] DST_IP" -#define arping_full_usage "\n\n" \ - "Send ARP requests/replies\n" \ - "\nOptions:" \ - "\n -f Quit on first ARP reply" \ - "\n -q Quiet" \ - "\n -b Keep broadcasting, don't go unicast" \ - "\n -D Duplicated address detection mode" \ - "\n -U Unsolicited ARP mode, update your neighbors" \ - "\n -A ARP answer mode, update your neighbors" \ - "\n -c N Stop after sending N ARP requests" \ - "\n -w TIMEOUT Time to wait for ARP reply, seconds" \ - "\n -I IFACE Interface to use (default eth0)" \ - "\n -s SRC_IP Sender IP address" \ - "\n DST_IP Target IP address" \ - -#define beep_trivial_usage \ - "-f FREQ -l LEN -d DELAY -r COUNT -n" -#define beep_full_usage "\n\n" \ - "Options:" \ - "\n -f Frequency in Hz" \ - "\n -l Length in ms" \ - "\n -d Delay in ms" \ - "\n -r Repetitions" \ - "\n -n Start new tone" \ - -#define blkid_trivial_usage \ - "" -#define blkid_full_usage "\n\n" \ - "Print UUIDs of all filesystems" - -#define brctl_trivial_usage \ - "COMMAND [BRIDGE [INTERFACE]]" -#define brctl_full_usage "\n\n" \ - "Manage ethernet bridges\n" \ - "\nCommands:" \ - IF_FEATURE_BRCTL_SHOW( \ - "\n show Show a list of bridges" \ - ) \ - "\n addbr BRIDGE Create BRIDGE" \ - "\n delbr BRIDGE Delete BRIDGE" \ - "\n addif BRIDGE IFACE Add IFACE to BRIDGE" \ - "\n delif BRIDGE IFACE Delete IFACE from BRIDGE" \ - IF_FEATURE_BRCTL_FANCY( \ - "\n setageing BRIDGE TIME Set ageing time" \ - "\n setfd BRIDGE TIME Set bridge forward delay" \ - "\n sethello BRIDGE TIME Set hello time" \ - "\n setmaxage BRIDGE TIME Set max message age" \ - "\n setpathcost BRIDGE COST Set path cost" \ - "\n setportprio BRIDGE PRIO Set port priority" \ - "\n setbridgeprio BRIDGE PRIO Set bridge priority" \ - "\n stp BRIDGE [1/yes/on|0/no/off] STP on/off" \ - ) \ - #define busybox_notes_usage \ "Hello world!\n" -#define chat_trivial_usage \ - "EXPECT [SEND [EXPECT [SEND...]]]" -#define chat_full_usage "\n\n" \ - "Useful for interacting with a modem connected to stdin/stdout.\n" \ - "A script consists of one or more \"expect-send\" pairs of strings,\n" \ - "each pair is a pair of arguments. Example:\n" \ - "chat '' ATZ OK ATD123456 CONNECT '' ogin: pppuser word: ppppass '~'" \ - -#define chcon_trivial_usage \ - "[OPTIONS] CONTEXT FILE..." \ - "\n chcon [OPTIONS] [-u USER] [-r ROLE] [-l RANGE] [-t TYPE] FILE..." \ - IF_FEATURE_CHCON_LONG_OPTIONS( \ - "\n chcon [OPTIONS] --reference=RFILE FILE..." \ - ) -#define chcon_full_usage "\n\n" \ - "Change the security context of each FILE to CONTEXT\n" \ - IF_FEATURE_CHCON_LONG_OPTIONS( \ - "\n -v,--verbose Verbose" \ - "\n -c,--changes Report changes made" \ - "\n -h,--no-dereference Affect symlinks instead of their targets" \ - "\n -f,--silent,--quiet Suppress most error messages" \ - "\n --reference=RFILE Use RFILE's group instead of using a CONTEXT value" \ - "\n -u,--user=USER Set user/role/type/range in the target" \ - "\n -r,--role=ROLE security context" \ - "\n -t,--type=TYPE" \ - "\n -l,--range=RANGE" \ - "\n -R,--recursive Recurse" \ - ) \ - IF_NOT_FEATURE_CHCON_LONG_OPTIONS( \ - "\n -v Verbose" \ - "\n -c Report changes made" \ - "\n -h Affect symlinks instead of their targets" \ - "\n -f Suppress most error messages" \ - "\n -u USER Set user/role/type/range in the target security context" \ - "\n -r ROLE" \ - "\n -t TYPE" \ - "\n -l RNG" \ - "\n -R Recurse" \ - ) - -#define chpst_trivial_usage \ - "[-vP012] [-u USER[:GRP]] [-U USER[:GRP]] [-e DIR]\n" \ - " [-/ DIR] [-n NICE] [-m BYTES] [-d BYTES] [-o N]\n" \ - " [-p N] [-f BYTES] [-c BYTES] PROG ARGS" -#define chpst_full_usage "\n\n" \ - "Change the process state, run PROG\n" \ - "\nOptions:" \ - "\n -u USER[:GRP] Set uid and gid" \ - "\n -U USER[:GRP] Set $UID and $GID in environment" \ - "\n -e DIR Set environment variables as specified by files" \ - "\n in DIR: file=1st_line_of_file" \ - "\n -/ DIR Chroot to DIR" \ - "\n -n NICE Add NICE to nice value" \ - "\n -m BYTES Same as -d BYTES -s BYTES -l BYTES" \ - "\n -d BYTES Limit data segment" \ - "\n -o N Limit number of open files per process" \ - "\n -p N Limit number of processes per uid" \ - "\n -f BYTES Limit output file sizes" \ - "\n -c BYTES Limit core file size" \ - "\n -v Verbose" \ - "\n -P Create new process group" \ - "\n -0 Close stdin" \ - "\n -1 Close stdout" \ - "\n -2 Close stderr" \ - -#define setuidgid_trivial_usage \ - "USER PROG ARGS" -#define setuidgid_full_usage "\n\n" \ - "Set uid and gid to USER's uid and gid, drop supplementary group ids,\n" \ - "run PROG" -#define envuidgid_trivial_usage \ - "USER PROG ARGS" -#define envuidgid_full_usage "\n\n" \ - "Set $UID to USER's uid and $GID to USER's gid, run PROG" -#define envdir_trivial_usage \ - "DIR PROG ARGS" -#define envdir_full_usage "\n\n" \ - "Set various environment variables as specified by files\n" \ - "in the directory DIR, run PROG" -#define softlimit_trivial_usage \ - "[-a BYTES] [-m BYTES] [-d BYTES] [-s BYTES] [-l BYTES]\n" \ - " [-f BYTES] [-c BYTES] [-r BYTES] [-o N] [-p N] [-t N]\n" \ - " PROG ARGS" -#define softlimit_full_usage "\n\n" \ - "Set soft resource limits, then run PROG\n" \ - "\nOptions:" \ - "\n -a BYTES Limit total size of all segments" \ - "\n -m BYTES Same as -d BYTES -s BYTES -l BYTES -a BYTES" \ - "\n -d BYTES Limit data segment" \ - "\n -s BYTES Limit stack segment" \ - "\n -l BYTES Limit locked memory size" \ - "\n -o N Limit number of open files per process" \ - "\n -p N Limit number of processes per uid" \ - "\nOptions controlling file sizes:" \ - "\n -f BYTES Limit output file sizes" \ - "\n -c BYTES Limit core file size" \ - "\nEfficiency opts:" \ - "\n -r BYTES Limit resident set size" \ - "\n -t N Limit CPU time, process receives" \ - "\n a SIGXCPU after N seconds" \ - -#define bbconfig_trivial_usage \ - "" -#define bbconfig_full_usage "\n\n" \ - "Print the config file used by busybox build" - -#define chrt_trivial_usage \ - "[-prfom] [PRIO] [PID | PROG ARGS]" -#define chrt_full_usage "\n\n" \ - "Change scheduling priority and class for a process\n" \ - "\nOptions:" \ - "\n -p Operate on PID" \ - "\n -r Set SCHED_RR class" \ - "\n -f Set SCHED_FIFO class" \ - "\n -o Set SCHED_OTHER class" \ - "\n -m Show min/max priorities" \ - -#define chrt_example_usage \ - "$ chrt -r 4 sleep 900; x=$!\n" \ - "$ chrt -f -p 3 $x\n" \ - "You need CAP_SYS_NICE privileges to set scheduling attributes of a process" - -#define renice_trivial_usage \ - "{{-n INCREMENT} | PRIORITY} [[-p | -g | -u] ID...]" -#define renice_full_usage "\n\n" \ - "Change scheduling priority for a running process\n" \ - "\nOptions:" \ - "\n -n Adjust current nice value (smaller is faster)" \ - "\n -p Process id(s) (default)" \ - "\n -g Process group id(s)" \ - "\n -u Process user name(s) and/or id(s)" \ - -#define ionice_trivial_usage \ - "[-c 1-3] [-n 0-7] [-p PID] [PROG]" -#define ionice_full_usage "\n\n" \ - "Change I/O priority and class\n" \ - "\nOptions:" \ - "\n -c Class. 1:realtime 2:best-effort 3:idle" \ - "\n -n Priority" \ - -#define crond_trivial_usage \ - "-fbS -l N " IF_FEATURE_CROND_D("-d N ") "-L LOGFILE -c DIR" -#define crond_full_usage "\n\n" \ - " -f Foreground" \ - "\n -b Background (default)" \ - "\n -S Log to syslog (default)" \ - "\n -l Set log level. 0 is the most verbose, default 8" \ - IF_FEATURE_CROND_D( \ - "\n -d Set log level, log to stderr" \ - ) \ - "\n -L Log to file" \ - "\n -c Working dir" \ - -#define crontab_trivial_usage \ - "[-c DIR] [-u USER] [-ler]|[FILE]" -#define crontab_full_usage "\n\n" \ - " -c Crontab directory" \ - "\n -u User" \ - "\n -l List crontab" \ - "\n -e Edit crontab" \ - "\n -r Delete crontab" \ - "\n FILE Replace crontab by FILE ('-': stdin)" \ - -#define devmem_trivial_usage \ - "ADDRESS [WIDTH [VALUE]]" - -#define devmem_full_usage "\n\n" \ - "Read/write from physical address\n" \ - "\n ADDRESS Address to act upon" \ - "\n WIDTH Width (8/16/...)" \ - "\n VALUE Data to be written" \ - -#define devfsd_trivial_usage \ - "mntpnt [-v]" IF_DEVFSD_FG_NP("[-fg][-np]") -#define devfsd_full_usage "\n\n" \ - "Manage devfs permissions and old device name symlinks\n" \ - "\nOptions:" \ - "\n mntpnt The mount point where devfs is mounted" \ - "\n -v Print the protocol version numbers for devfsd" \ - "\n and the kernel-side protocol version and exit" \ - IF_DEVFSD_FG_NP( \ - "\n -fg Run in foreground" \ - "\n -np Exit after parsing the configuration file" \ - "\n and processing synthetic REGISTER events," \ - "\n don't poll for events" \ - ) - -#define dhcprelay_trivial_usage \ - "CLIENT_IFACE[,CLIENT_IFACE2]... SERVER_IFACE [SERVER_IP]" -#define dhcprelay_full_usage "\n\n" \ - "Relay DHCP requests between clients and server" \ - -#define dmesg_trivial_usage \ - "[-c] [-n LEVEL] [-s SIZE]" -#define dmesg_full_usage "\n\n" \ - "Print or control the kernel ring buffer\n" \ - "\nOptions:" \ - "\n -c Clear ring buffer after printing" \ - "\n -n LEVEL Set console logging level" \ - "\n -s SIZE Buffer size" \ - -#define dnsd_trivial_usage \ - "[-dvs] [-c CONFFILE] [-t TTL_SEC] [-p PORT] [-i ADDR]" -#define dnsd_full_usage "\n\n" \ - "Small static DNS server daemon\n" \ - "\nOptions:" \ - "\n -c FILE Config file" \ - "\n -t SEC TTL" \ - "\n -p PORT Listen on PORT" \ - "\n -i ADDR Listen on ADDR" \ - "\n -d Daemonize" \ - "\n -v Verbose" \ - "\n -s Send successful replies only. Use this if you want" \ - "\n to use /etc/resolv.conf with two nameserver lines:" \ - "\n nameserver DNSD_SERVER" \ - "\n nameserver NORNAL_DNS_SERVER" \ - -#define dumpleases_trivial_usage \ - "[-r|-a] [-f LEASEFILE]" -#define dumpleases_full_usage "\n\n" \ - "Display DHCP leases granted by udhcpd\n" \ - "\nOptions:" \ - IF_LONG_OPTS( \ - "\n -f,--file=FILE Lease file" \ - "\n -r,--remaining Show remaining time" \ - "\n -a,--absolute Show expiration time" \ - ) \ - IF_NOT_LONG_OPTS( \ - "\n -f FILE Lease file" \ - "\n -r Show remaining time" \ - "\n -a Show expiration time" \ - ) - -/* -#define e2fsck_trivial_usage \ - "[-panyrcdfvstDFSV] [-b superblock] [-B blocksize] " \ - "[-I inode_buffer_blocks] [-P process_inode_size] " \ - "[-l|-L bad_blocks_file] [-C fd] [-j external_journal] " \ - "[-E extended-options] device" -#define e2fsck_full_usage "\n\n" \ - "Check ext2/ext3 file system\n" \ - "\nOptions:" \ - "\n -p Automatic repair (no questions)" \ - "\n -n Make no changes to the filesystem" \ - "\n -y Assume 'yes' to all questions" \ - "\n -c Check for bad blocks and add them to the badblock list" \ - "\n -f Force checking even if filesystem is marked clean" \ - "\n -v Verbose" \ - "\n -b superblock Use alternative superblock" \ - "\n -B blocksize Force blocksize when looking for superblock" \ - "\n -j journal Set location of the external journal" \ - "\n -l file Add to badblocks list" \ - "\n -L file Set badblocks list" \ -*/ - -#define eject_trivial_usage \ - "[-t] [-T] [DEVICE]" -#define eject_full_usage "\n\n" \ - "Eject DEVICE or default /dev/cdrom\n" \ - "\nOptions:" \ - IF_FEATURE_EJECT_SCSI( \ - "\n -s SCSI device" \ - ) \ - "\n -t Close tray" \ - "\n -T Open/close tray (toggle)" \ - -#define ether_wake_trivial_usage \ - "[-b] [-i iface] [-p aa:bb:cc:dd[:ee:ff]] MAC" -#define ether_wake_full_usage "\n\n" \ - "Send a magic packet to wake up sleeping machines.\n" \ - "MAC must be a station address (00:11:22:33:44:55) or\n" \ - "a hostname with a known 'ethers' entry.\n" \ - "\nOptions:" \ - "\n -b Send wake-up packet to the broadcast address" \ - "\n -i iface Interface to use (default eth0)" \ - "\n -p pass Append four or six byte password PW to the packet" \ - -#define fakeidentd_trivial_usage \ - "[-fiw] [-b ADDR] [STRING]" -#define fakeidentd_full_usage "\n\n" \ - "Provide fake ident (auth) service\n" \ - "\nOptions:" \ - "\n -f Run in foreground" \ - "\n -i Inetd mode" \ - "\n -w Inetd 'wait' mode" \ - "\n -b ADDR Bind to specified address" \ - "\n STRING Ident answer string (default: nobody)" \ - -#define fbsplash_trivial_usage \ - "-s IMGFILE [-c] [-d DEV] [-i INIFILE] [-f CMD]" -#define fbsplash_full_usage "\n\n" \ - "Options:" \ - "\n -s Image" \ - "\n -c Hide cursor" \ - "\n -d Framebuffer device (default /dev/fb0)" \ - "\n -i Config file (var=value):" \ - "\n BAR_LEFT,BAR_TOP,BAR_WIDTH,BAR_HEIGHT" \ - "\n BAR_R,BAR_G,BAR_B" \ - "\n -f Control pipe (else exit after drawing image)" \ - "\n commands: 'NN' (% for progress bar) or 'exit'" \ - -#define fbset_trivial_usage \ - "[OPTIONS] [MODE]" -#define fbset_full_usage "\n\n" \ - "Show and modify frame buffer settings" - -#define fbset_example_usage \ - "$ fbset\n" \ - "mode \"1024x768-76\"\n" \ - " # D: 78.653 MHz, H: 59.949 kHz, V: 75.694 Hz\n" \ - " geometry 1024 768 1024 768 16\n" \ - " timings 12714 128 32 16 4 128 4\n" \ - " accel false\n" \ - " rgba 5/11,6/5,5/0,0/0\n" \ - "endmode\n" - -#define fdflush_trivial_usage \ - "DEVICE" -#define fdflush_full_usage "\n\n" \ - "Force floppy disk drive to detect disk change" - -#define fdformat_trivial_usage \ - "[-n] DEVICE" -#define fdformat_full_usage "\n\n" \ - "Format floppy disk\n" \ - "\nOptions:" \ - "\n -n Don't verify after format" \ - -/* Looks like someone forgot to add this to config system */ -#ifndef ENABLE_FEATURE_FDISK_BLKSIZE -# define ENABLE_FEATURE_FDISK_BLKSIZE 0 -# define IF_FEATURE_FDISK_BLKSIZE(a) -#endif - -#define fdisk_trivial_usage \ - "[-ul" IF_FEATURE_FDISK_BLKSIZE("s") "] " \ - "[-C CYLINDERS] [-H HEADS] [-S SECTORS] [-b SSZ] DISK" -#define fdisk_full_usage "\n\n" \ - "Change partition table\n" \ - "\nOptions:" \ - "\n -u Start and End are in sectors (instead of cylinders)" \ - "\n -l Show partition table for each DISK, then exit" \ - IF_FEATURE_FDISK_BLKSIZE( \ - "\n -s Show partition sizes in kb for each DISK, then exit" \ - ) \ - "\n -b 2048 (for certain MO disks) use 2048-byte sectors" \ - "\n -C CYLINDERS Set number of cylinders/heads/sectors" \ - "\n -H HEADS" \ - "\n -S SECTORS" \ - -#define findfs_trivial_usage \ - "LABEL=label or UUID=uuid" -#define findfs_full_usage "\n\n" \ - "Find a filesystem device based on a label or UUID" -#define findfs_example_usage \ - "$ findfs LABEL=MyDevice" - -#define flash_lock_trivial_usage \ - "MTD_DEVICE OFFSET SECTORS" -#define flash_lock_full_usage "\n\n" \ - "Lock part or all of an MTD device. If SECTORS is -1, then all sectors\n" \ - "will be locked, regardless of the value of OFFSET" - -#define flash_unlock_trivial_usage \ - "MTD_DEVICE" -#define flash_unlock_full_usage "\n\n" \ - "Unlock an MTD device" - -#define flash_eraseall_trivial_usage \ - "[-jq] MTD_DEVICE" -#define flash_eraseall_full_usage "\n\n" \ - "Erase an MTD device\n" \ - "\nOptions:" \ - "\n -j Format the device for jffs2" \ - "\n -q Don't display progress messages" \ - -#define flashcp_trivial_usage \ - "-v FILE MTD_DEVICE" -#define flashcp_full_usage "\n\n" \ - "Copy an image to MTD device\n" \ - "\nOptions:" \ - "\n -v Verbose" \ - -#define flock_trivial_usage \ - "[-sxun] FD|{FILE [-c] PROG ARGS}" -#define flock_full_usage "\n\n" \ - "[Un]lock file descriptor, or lock FILE, run PROG\n" \ - "\nOptions:" \ - "\n -s Shared lock" \ - "\n -x Exclusive lock (default)" \ - "\n -u Unlock FD" \ - "\n -n Fail rather than wait" \ - -#define free_trivial_usage \ - "" IF_DESKTOP("[-b/k/m/g]") -#define free_full_usage "\n\n" \ - "Display the amount of free and used system memory" -#define free_example_usage \ - "$ free\n" \ - " total used free shared buffers\n" \ - " Mem: 257628 248724 8904 59644 93124\n" \ - " Swap: 128516 8404 120112\n" \ - "Total: 386144 257128 129016\n" \ - -#define freeramdisk_trivial_usage \ - "DEVICE" -#define freeramdisk_full_usage "\n\n" \ - "Free all memory used by the specified ramdisk" -#define freeramdisk_example_usage \ - "$ freeramdisk /dev/ram2\n" - -#define fsck_minix_trivial_usage \ - "[-larvsmf] BLOCKDEV" -#define fsck_minix_full_usage "\n\n" \ - "Check MINIX filesystem\n" \ - "\nOptions:" \ - "\n -l List all filenames" \ - "\n -r Perform interactive repairs" \ - "\n -a Perform automatic repairs" \ - "\n -v Verbose" \ - "\n -s Output superblock information" \ - "\n -m Show \"mode not cleared\" warnings" \ - "\n -f Force file system check" \ - -#define ftpget_trivial_usage \ - "[OPTIONS] HOST [LOCAL_FILE] REMOTE_FILE" -#define ftpget_full_usage "\n\n" \ - "Retrieve a remote file via FTP\n" \ - "\nOptions:" \ - IF_FEATURE_FTPGETPUT_LONG_OPTIONS( \ - "\n -c,--continue Continue previous transfer" \ - "\n -v,--verbose Verbose" \ - "\n -u,--username Username" \ - "\n -p,--password Password" \ - "\n -P,--port Port number" \ - ) \ - IF_NOT_FEATURE_FTPGETPUT_LONG_OPTIONS( \ - "\n -c Continue previous transfer" \ - "\n -v Verbose" \ - "\n -u Username" \ - "\n -p Password" \ - "\n -P Port number" \ - ) - -#define ftpput_trivial_usage \ - "[OPTIONS] HOST [REMOTE_FILE] LOCAL_FILE" -#define ftpput_full_usage "\n\n" \ - "Store a local file on a remote machine via FTP\n" \ - "\nOptions:" \ - IF_FEATURE_FTPGETPUT_LONG_OPTIONS( \ - "\n -v,--verbose Verbose" \ - "\n -u,--username Username" \ - "\n -p,--password Password" \ - "\n -P,--port Port number" \ - ) \ - IF_NOT_FEATURE_FTPGETPUT_LONG_OPTIONS( \ - "\n -v Verbose" \ - "\n -u Username" \ - "\n -p Password" \ - "\n -P Port number" \ - ) - -#define fuser_trivial_usage \ - "[OPTIONS] FILE or PORT/PROTO" -#define fuser_full_usage "\n\n" \ - "Find processes which use FILEs or PORTs\n" \ - "\nOptions:" \ - "\n -m Find processes which use same fs as FILEs" \ - "\n -4,-6 Search only IPv4/IPv6 space" \ - "\n -s Don't display PIDs" \ - "\n -k Kill found processes" \ - "\n -SIGNAL Signal to send (default: KILL)" \ - -#define getenforce_trivial_usage NOUSAGE_STR -#define getenforce_full_usage "" - -#define getopt_trivial_usage \ - "[OPTIONS]" -#define getopt_full_usage "\n\n" \ - "Options:" \ - IF_LONG_OPTS( \ - "\n -a,--alternative Allow long options starting with single -" \ - "\n -l,--longoptions=longopts Long options to be recognized" \ - "\n -n,--name=progname The name under which errors are reported" \ - "\n -o,--options=optstring Short options to be recognized" \ - "\n -q,--quiet Disable error reporting by getopt(3)" \ - "\n -Q,--quiet-output No normal output" \ - "\n -s,--shell=shell Set shell quoting conventions" \ - "\n -T,--test Test for getopt(1) version" \ - "\n -u,--unquoted Don't quote the output" \ - ) \ - IF_NOT_LONG_OPTS( \ - "\n -a Allow long options starting with single -" \ - "\n -l longopts Long options to be recognized" \ - "\n -n progname The name under which errors are reported" \ - "\n -o optstring Short options to be recognized" \ - "\n -q Disable error reporting by getopt(3)" \ - "\n -Q No normal output" \ - "\n -s shell Set shell quoting conventions" \ - "\n -T Test for getopt(1) version" \ - "\n -u Don't quote the output" \ - ) -#define getopt_example_usage \ - "$ cat getopt.test\n" \ - "#!/bin/sh\n" \ - "GETOPT=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \\\n" \ - " -n 'example.busybox' -- \"$@\"`\n" \ - "if [ $? != 0 ]; then exit 1; fi\n" \ - "eval set -- \"$GETOPT\"\n" \ - "while true; do\n" \ - " case $1 in\n" \ - " -a|--a-long) echo \"Option a\"; shift;;\n" \ - " -b|--b-long) echo \"Option b, argument '$2'\"; shift 2;;\n" \ - " -c|--c-long)\n" \ - " case \"$2\" in\n" \ - " \"\") echo \"Option c, no argument\"; shift 2;;\n" \ - " *) echo \"Option c, argument '$2'\"; shift 2;;\n" \ - " esac;;\n" \ - " --) shift; break;;\n" \ - " *) echo \"Internal error!\"; exit 1;;\n" \ - " esac\n" \ - "done\n" - -#define getsebool_trivial_usage \ - "-a or getsebool boolean..." -#define getsebool_full_usage "\n\n" \ - " -a Show all selinux booleans" - -#define hdparm_trivial_usage \ - "[OPTIONS] [DEVICE]" -#define hdparm_full_usage "\n\n" \ - "Options:" \ - "\n -a Get/set fs readahead" \ - "\n -A Set drive read-lookahead flag (0/1)" \ - "\n -b Get/set bus state (0 == off, 1 == on, 2 == tristate)" \ - "\n -B Set Advanced Power Management setting (1-255)" \ - "\n -c Get/set IDE 32-bit IO setting" \ - "\n -C Check IDE power mode status" \ - IF_FEATURE_HDPARM_HDIO_GETSET_DMA( \ - "\n -d Get/set using_dma flag") \ - "\n -D Enable/disable drive defect-mgmt" \ - "\n -f Flush buffer cache for device on exit" \ - "\n -g Display drive geometry" \ - "\n -h Display terse usage information" \ - IF_FEATURE_HDPARM_GET_IDENTITY( \ - "\n -i Display drive identification") \ - IF_FEATURE_HDPARM_GET_IDENTITY( \ - "\n -I Detailed/current information directly from drive") \ - "\n -k Get/set keep_settings_over_reset flag (0/1)" \ - "\n -K Set drive keep_features_over_reset flag (0/1)" \ - "\n -L Set drive doorlock (0/1) (removable harddisks only)" \ - "\n -m Get/set multiple sector count" \ - "\n -n Get/set ignore-write-errors flag (0/1)" \ - "\n -p Set PIO mode on IDE interface chipset (0,1,2,3,4,...)" \ - "\n -P Set drive prefetch count" \ -/* "\n -q Change next setting quietly" - not supported ib bbox */ \ - "\n -Q Get/set DMA tagged-queuing depth (if supported)" \ - "\n -r Get/set readonly flag (DANGEROUS to set)" \ - IF_FEATURE_HDPARM_HDIO_SCAN_HWIF( \ - "\n -R Register an IDE interface (DANGEROUS)") \ - "\n -S Set standby (spindown) timeout" \ - "\n -t Perform device read timings" \ - "\n -T Perform cache read timings" \ - "\n -u Get/set unmaskirq flag (0/1)" \ - IF_FEATURE_HDPARM_HDIO_UNREGISTER_HWIF( \ - "\n -U Unregister an IDE interface (DANGEROUS)") \ - "\n -v Defaults; same as -mcudkrag for IDE drives" \ - "\n -V Display program version and exit immediately" \ - IF_FEATURE_HDPARM_HDIO_DRIVE_RESET( \ - "\n -w Perform device reset (DANGEROUS)") \ - "\n -W Set drive write-caching flag (0/1) (DANGEROUS)" \ - IF_FEATURE_HDPARM_HDIO_TRISTATE_HWIF( \ - "\n -x Tristate device for hotswap (0/1) (DANGEROUS)") \ - "\n -X Set IDE xfer mode (DANGEROUS)" \ - "\n -y Put IDE drive in standby mode" \ - "\n -Y Put IDE drive to sleep" \ - "\n -Z Disable Seagate auto-powersaving mode" \ - "\n -z Reread partition table" \ - -#define hexdump_trivial_usage \ - "[-bcCdefnosvx" IF_FEATURE_HEXDUMP_REVERSE("R") "] [FILE]..." -#define hexdump_full_usage "\n\n" \ - "Display FILEs (or stdin) in a user specified format\n" \ - "\nOptions:" \ - "\n -b One-byte octal display" \ - "\n -c One-byte character display" \ - "\n -C Canonical hex+ASCII, 16 bytes per line" \ - "\n -d Two-byte decimal display" \ - "\n -e FORMAT_STRING" \ - "\n -f FORMAT_FILE" \ - "\n -n LENGTH Interpret only LENGTH bytes of input" \ - "\n -o Two-byte octal display" \ - "\n -s OFFSET Skip OFFSET bytes" \ - "\n -v Display all input data" \ - "\n -x Two-byte hexadecimal display" \ - IF_FEATURE_HEXDUMP_REVERSE( \ - "\n -R Reverse of 'hexdump -Cv'") \ - -#define hd_trivial_usage \ - "FILE..." -#define hd_full_usage "\n\n" \ - "hd is an alias for hexdump -C" - -#define hostname_trivial_usage \ - "[OPTIONS] [HOSTNAME | -F FILE]" -#define hostname_full_usage "\n\n" \ - "Get or set hostname or DNS domain name\n" \ - "\nOptions:" \ - "\n -s Short" \ - "\n -i Addresses for the hostname" \ - "\n -d DNS domain name" \ - "\n -f Fully qualified domain name" \ - "\n -F FILE Use FILE's content as hostname" \ - -#define hostname_example_usage \ - "$ hostname\n" \ - "sage\n" - -#define dnsdomainname_trivial_usage NOUSAGE_STR -#define dnsdomainname_full_usage "" - -#define httpd_trivial_usage \ - "[-ifv[v]]" \ - " [-c CONFFILE]" \ - " [-p [IP:]PORT]" \ - IF_FEATURE_HTTPD_SETUID(" [-u USER[:GRP]]") \ - IF_FEATURE_HTTPD_BASIC_AUTH(" [-r REALM]") \ - " [-h HOME]\n" \ - "or httpd -d/-e" IF_FEATURE_HTTPD_AUTH_MD5("/-m") " STRING" -#define httpd_full_usage "\n\n" \ - "Listen for incoming HTTP requests\n" \ - "\nOptions:" \ - "\n -i Inetd mode" \ - "\n -f Don't daemonize" \ - "\n -v[v] Verbose" \ - "\n -p [IP:]PORT Bind to IP:PORT (default *:80)" \ - IF_FEATURE_HTTPD_SETUID( \ - "\n -u USER[:GRP] Set uid/gid after binding to port") \ - IF_FEATURE_HTTPD_BASIC_AUTH( \ - "\n -r REALM Authentication Realm for Basic Authentication") \ - "\n -h HOME Home directory (default .)" \ - "\n -c FILE Configuration file (default {/etc,HOME}/httpd.conf)" \ - IF_FEATURE_HTTPD_AUTH_MD5( \ - "\n -m STRING MD5 crypt STRING") \ - "\n -e STRING HTML encode STRING" \ - "\n -d STRING URL decode STRING" \ - -#define ifconfig_trivial_usage \ - IF_FEATURE_IFCONFIG_STATUS("[-a]") " interface [address]" -#define ifconfig_full_usage "\n\n" \ - "Configure a network interface\n" \ - "\nOptions:" \ - "\n" \ - IF_FEATURE_IPV6( \ - " [add ADDRESS[/PREFIXLEN]]\n") \ - IF_FEATURE_IPV6( \ - " [del ADDRESS[/PREFIXLEN]]\n") \ - " [[-]broadcast [ADDRESS]] [[-]pointopoint [ADDRESS]]\n" \ - " [netmask ADDRESS] [dstaddr ADDRESS]\n" \ - IF_FEATURE_IFCONFIG_SLIP( \ - " [outfill NN] [keepalive NN]\n") \ - " " IF_FEATURE_IFCONFIG_HW("[hw ether" IF_FEATURE_HWIB("|infiniband")" ADDRESS] ") "[metric NN] [mtu NN]\n" \ - " [[-]trailers] [[-]arp] [[-]allmulti]\n" \ - " [multicast] [[-]promisc] [txqueuelen NN] [[-]dynamic]\n" \ - IF_FEATURE_IFCONFIG_MEMSTART_IOADDR_IRQ( \ - " [mem_start NN] [io_addr NN] [irq NN]\n") \ - " [up|down] ..." - -#define ifenslave_trivial_usage \ - "[-cdf] MASTER_IFACE SLAVE_IFACE..." -#define ifenslave_full_usage "\n\n" \ - "Configure network interfaces for parallel routing\n" \ - "\nOptions:" \ - "\n -c,--change-active Change active slave" \ - "\n -d,--detach Remove slave interface from bonding device" \ - "\n -f,--force Force, even if interface is not Ethernet" \ -/* "\n -r,--receive-slave Create a receive-only slave" */ - -#define ifenslave_example_usage \ - "To create a bond device, simply follow these three steps:\n" \ - "- ensure that the required drivers are properly loaded:\n" \ - " # modprobe bonding ; modprobe <3c59x|eepro100|pcnet32|tulip|...>\n" \ - "- assign an IP address to the bond device:\n" \ - " # ifconfig bond0 <addr> netmask <mask> broadcast <bcast>\n" \ - "- attach all the interfaces you need to the bond device:\n" \ - " # ifenslave bond0 eth0 eth1 eth2\n" \ - " If bond0 didn't have a MAC address, it will take eth0's. Then, all\n" \ - " interfaces attached AFTER this assignment will get the same MAC addr.\n\n" \ - " To detach a dead interface without setting the bond device down:\n" \ - " # ifenslave -d bond0 eth1\n\n" \ - " To set the bond device down and automatically release all the slaves:\n" \ - " # ifconfig bond0 down\n\n" \ - " To change active slave:\n" \ - " # ifenslave -c bond0 eth0\n" \ - -#define ifplugd_trivial_usage \ - "[OPTIONS]" -#define ifplugd_full_usage "\n\n" \ - "Network interface plug detection daemon\n" \ - "\nOptions:" \ - "\n -n Don't daemonize" \ - "\n -s Don't log to syslog" \ - "\n -i IFACE Interface" \ - "\n -f/-F Treat link detection error as link down/link up" \ - "\n (otherwise exit on error)" \ - "\n -a Don't up interface at each link probe" \ - "\n -M Monitor creation/destruction of interface" \ - "\n (otherwise it must exist)" \ - "\n -r PROG Script to run" \ - "\n -x ARG Extra argument for script" \ - "\n -I Don't exit on nonzero exit code from script" \ - "\n -p Don't run script on daemon startup" \ - "\n -q Don't run script on daemon quit" \ - "\n -l Run script on startup even if no cable is detected" \ - "\n -t SECS Poll time in seconds" \ - "\n -u SECS Delay before running script after link up" \ - "\n -d SECS Delay after link down" \ - "\n -m MODE API mode (mii, priv, ethtool, wlan, iff, auto)" \ - "\n -k Kill running daemon" \ - -#define ifup_trivial_usage \ - "[-an"IF_FEATURE_IFUPDOWN_MAPPING("m")"vf] [-i FILE] IFACE..." -#define ifup_full_usage "\n\n" \ - "Options:" \ - "\n -a De/configure all interfaces automatically" \ - "\n -i FILE Use FILE for interface definitions" \ - "\n -n Print out what would happen, but don't do it" \ - IF_FEATURE_IFUPDOWN_MAPPING( \ - "\n (note: doesn't disable mappings)" \ - "\n -m Don't run any mappings" \ - ) \ - "\n -v Print out what would happen before doing it" \ - "\n -f Force de/configuration" \ - -#define ifdown_trivial_usage \ - "[-an"IF_FEATURE_IFUPDOWN_MAPPING("m")"vf] [-i FILE] IFACE..." -#define ifdown_full_usage "\n\n" \ - "Options:" \ - "\n -a De/configure all interfaces automatically" \ - "\n -i FILE Use FILE for interface definitions" \ - "\n -n Print out what would happen, but don't do it" \ - IF_FEATURE_IFUPDOWN_MAPPING( \ - "\n (note: doesn't disable mappings)" \ - "\n -m Don't run any mappings" \ - ) \ - "\n -v Print out what would happen before doing it" \ - "\n -f Force de/configuration" \ - -#define inetd_trivial_usage \ - "[-fe] [-q N] [-R N] [CONFFILE]" -#define inetd_full_usage "\n\n" \ - "Listen for network connections and launch programs\n" \ - "\nOptions:" \ - "\n -f Run in foreground" \ - "\n -e Log to stderr" \ - "\n -q N Socket listen queue (default: 128)" \ - "\n -R N Pause services after N connects/min" \ - "\n (default: 0 - disabled)" \ - -#define inotifyd_trivial_usage \ - "PROG FILE1[:MASK]..." -#define inotifyd_full_usage "\n\n" \ - "Run PROG on filesystem changes." \ - "\nWhen a filesystem event matching MASK occurs on FILEn," \ - "\nPROG ACTUAL_EVENTS FILEn [SUBFILE] is run." \ - "\nEvents:" \ - "\n a File is accessed" \ - "\n c File is modified" \ - "\n e Metadata changed" \ - "\n w Writable file is closed" \ - "\n 0 Unwritable file is closed" \ - "\n r File is opened" \ - "\n D File is deleted" \ - "\n M File is moved" \ - "\n u Backing fs is unmounted" \ - "\n o Event queue overflowed" \ - "\n x File can't be watched anymore" \ - "\nIf watching a directory:" \ - "\n m Subfile is moved into dir" \ - "\n y Subfile is moved out of dir" \ - "\n n Subfile is created" \ - "\n d Subfile is deleted" \ - "\n" \ - "\ninotifyd waits for PROG to exit." \ - "\nWhen x event happens for all FILEs, inotifyd exits." \ - -/* would need to make the " | " optional depending on more than one selected: */ -#define ip_trivial_usage \ - "[OPTIONS] {" \ - IF_FEATURE_IP_ADDRESS("address | ") \ - IF_FEATURE_IP_ROUTE("route | ") \ - IF_FEATURE_IP_LINK("link | ") \ - IF_FEATURE_IP_TUNNEL("tunnel | ") \ - IF_FEATURE_IP_RULE("rule") \ - "} {COMMAND}" -#define ip_full_usage "\n\n" \ - "ip [OPTIONS] OBJECT {COMMAND}\n" \ - "where OBJECT := {" \ - IF_FEATURE_IP_ADDRESS("address | ") \ - IF_FEATURE_IP_ROUTE("route | ") \ - IF_FEATURE_IP_LINK("link | ") \ - IF_FEATURE_IP_TUNNEL("tunnel | ") \ - IF_FEATURE_IP_RULE("rule") \ - "}\n" \ - "OPTIONS := { -f[amily] { inet | inet6 | link } | -o[neline] }" \ - -#define ipaddr_trivial_usage \ - "{ {add|del} IFADDR dev STRING | {show|flush}\n" \ - " [dev STRING] [to PREFIX] }" -#define ipaddr_full_usage "\n\n" \ - "ipaddr {add|delete} IFADDR dev STRING\n" \ - "ipaddr {show|flush} [dev STRING] [scope SCOPE-ID]\n" \ - " [to PREFIX] [label PATTERN]\n" \ - " IFADDR := PREFIX | ADDR peer PREFIX\n" \ - " [broadcast ADDR] [anycast ADDR]\n" \ - " [label STRING] [scope SCOPE-ID]\n" \ - " SCOPE-ID := [host | link | global | NUMBER]" \ - -#define ipcalc_trivial_usage \ - "[OPTIONS] ADDRESS[[/]NETMASK] [NETMASK]" -#define ipcalc_full_usage "\n\n" \ - "Calculate IP network settings from a IP address\n" \ - "\nOptions:" \ - IF_FEATURE_IPCALC_LONG_OPTIONS( \ - "\n -b,--broadcast Display calculated broadcast address" \ - "\n -n,--network Display calculated network address" \ - "\n -m,--netmask Display default netmask for IP" \ - IF_FEATURE_IPCALC_FANCY( \ - "\n -p,--prefix Display the prefix for IP/NETMASK" \ - "\n -h,--hostname Display first resolved host name" \ - "\n -s,--silent Don't ever display error messages" \ - ) \ - ) \ - IF_NOT_FEATURE_IPCALC_LONG_OPTIONS( \ - "\n -b Display calculated broadcast address" \ - "\n -n Display calculated network address" \ - "\n -m Display default netmask for IP" \ - IF_FEATURE_IPCALC_FANCY( \ - "\n -p Display the prefix for IP/NETMASK" \ - "\n -h Display first resolved host name" \ - "\n -s Don't ever display error messages" \ - ) \ - ) - -#define ipcrm_trivial_usage \ - "[-MQS key] [-mqs id]" -#define ipcrm_full_usage "\n\n" \ - "Upper-case options MQS remove an object by shmkey value.\n" \ - "Lower-case options remove an object by shmid value.\n" \ - "\nOptions:" \ - "\n -mM Remove memory segment after last detach" \ - "\n -qQ Remove message queue" \ - "\n -sS Remove semaphore" \ - -#define ipcs_trivial_usage \ - "[[-smq] -i shmid] | [[-asmq] [-tcplu]]" -#define ipcs_full_usage "\n\n" \ - " -i Show specific resource" \ - "\nResource specification:" \ - "\n -m Shared memory segments" \ - "\n -q Message queues" \ - "\n -s Semaphore arrays" \ - "\n -a All (default)" \ - "\nOutput format:" \ - "\n -t Time" \ - "\n -c Creator" \ - "\n -p Pid" \ - "\n -l Limits" \ - "\n -u Summary" \ - -#define iplink_trivial_usage \ - "{ set DEVICE { up | down | arp { on | off } | show [DEVICE] }" -#define iplink_full_usage "\n\n" \ - "iplink set DEVICE { up | down | arp | multicast { on | off } |\n" \ - " dynamic { on | off } |\n" \ - " mtu MTU }\n" \ - "iplink show [DEVICE]" \ - -#define iproute_trivial_usage \ - "{ list | flush | { add | del | change | append |\n" \ - " replace | monitor } ROUTE }" -#define iproute_full_usage "\n\n" \ - "iproute { list | flush } SELECTOR\n" \ - "iproute get ADDRESS [from ADDRESS iif STRING]\n" \ - " [oif STRING] [tos TOS]\n" \ - "iproute { add | del | change | append | replace | monitor } ROUTE\n" \ - " SELECTOR := [root PREFIX] [match PREFIX] [proto RTPROTO]\n" \ - " ROUTE := [TYPE] PREFIX [tos TOS] [proto RTPROTO]\n" \ - " [metric METRIC]" \ - -#define iprule_trivial_usage \ - "{[list | add | del] RULE}" -#define iprule_full_usage "\n\n" \ - "iprule [list | add | del] SELECTOR ACTION\n" \ - " SELECTOR := [from PREFIX] [to PREFIX] [tos TOS] [fwmark FWMARK]\n" \ - " [dev STRING] [pref NUMBER]\n" \ - " ACTION := [table TABLE_ID] [nat ADDRESS]\n" \ - " [prohibit | reject | unreachable]\n" \ - " [realms [SRCREALM/]DSTREALM]\n" \ - " TABLE_ID := [local | main | default | NUMBER]" \ - -#define iptunnel_trivial_usage \ - "{ add | change | del | show } [NAME]\n" \ - " [mode { ipip | gre | sit }]\n" \ - " [remote ADDR] [local ADDR] [ttl TTL]" -#define iptunnel_full_usage "\n\n" \ - "iptunnel { add | change | del | show } [NAME]\n" \ - " [mode { ipip | gre | sit }] [remote ADDR] [local ADDR]\n" \ - " [[i|o]seq] [[i|o]key KEY] [[i|o]csum]\n" \ - " [ttl TTL] [tos TOS] [[no]pmtudisc] [dev PHYS_DEV]" \ - -#define kill_trivial_usage \ - "[-l] [-SIG] PID..." -#define kill_full_usage "\n\n" \ - "Send a signal (default: TERM) to given PIDs\n" \ - "\nOptions:" \ - "\n -l List all signal names and numbers" \ -/* "\n -s SIG Yet another way of specifying SIG" */ \ - -#define kill_example_usage \ - "$ ps | grep apache\n" \ - "252 root root S [apache]\n" \ - "263 www-data www-data S [apache]\n" \ - "264 www-data www-data S [apache]\n" \ - "265 www-data www-data S [apache]\n" \ - "266 www-data www-data S [apache]\n" \ - "267 www-data www-data S [apache]\n" \ - "$ kill 252\n" - -#define killall_trivial_usage \ - "[-l] [-q] [-SIG] PROCESS_NAME..." -#define killall_full_usage "\n\n" \ - "Send a signal (default: TERM) to given processes\n" \ - "\nOptions:" \ - "\n -l List all signal names and numbers" \ -/* "\n -s SIG Yet another way of specifying SIG" */ \ - "\n -q Don't complain if no processes were killed" \ - -#define killall_example_usage \ - "$ killall apache\n" - -#define killall5_trivial_usage \ - "[-l] [-SIG] [-o PID]..." -#define killall5_full_usage "\n\n" \ - "Send a signal (default: TERM) to all processes outside current session\n" \ - "\nOptions:" \ - "\n -l List all signal names and numbers" \ - "\n -o PID Don't signal this PID" \ -/* "\n -s SIG Yet another way of specifying SIG" */ \ - -#define klogd_trivial_usage \ - "[-c N] [-n]" -#define klogd_full_usage "\n\n" \ - "Kernel logger\n" \ - "\nOptions:" \ - "\n -c N Only messages with level < N are printed to console" \ - "\n -n Run in foreground" \ - -#define less_trivial_usage \ - "[-EMNmh~I?] [FILE]..." -#define less_full_usage "\n\n" \ - "View FILE (or stdin) one screenful at a time\n" \ - "\nOptions:" \ - "\n -E Quit once the end of a file is reached" \ - "\n -M,-m Display status line with line numbers" \ - "\n and percentage through the file" \ - "\n -N Prefix line number to each line" \ - "\n -I Ignore case in all searches" \ - "\n -~ Suppress ~s displayed past the end of the file" \ - -#define linux32_trivial_usage NOUSAGE_STR -#define linux32_full_usage "" -#define linux64_trivial_usage NOUSAGE_STR -#define linux64_full_usage "" - -#define setarch_trivial_usage \ - "personality PROG ARGS" -#define setarch_full_usage "\n\n" \ - "Personality may be:\n" \ - " linux32 Set 32bit uname emulation\n" \ - " linux64 Set 64bit uname emulation" \ - -#define load_policy_trivial_usage NOUSAGE_STR -#define load_policy_full_usage "" - -#define logger_trivial_usage \ - "[OPTIONS] [MESSAGE]" -#define logger_full_usage "\n\n" \ - "Write MESSAGE (or stdin) to syslog\n" \ - "\nOptions:" \ - "\n -s Log to stderr as well as the system log" \ - "\n -t TAG Log using the specified tag (defaults to user name)" \ - "\n -p PRIO Priority (numeric or facility.level pair)" \ - -#define logger_example_usage \ - "$ logger \"hello\"\n" - -#define logread_trivial_usage \ - "[-f]" -#define logread_full_usage "\n\n" \ - "Show messages in syslogd's circular buffer\n" \ - "\nOptions:" \ - "\n -f Output data as log grows" \ - -#define losetup_trivial_usage \ - "[-o OFS] LOOPDEV FILE - associate loop devices\n" \ - " losetup -d LOOPDEV - disassociate\n" \ - " losetup [-f] - show" -#define losetup_full_usage "\n\n" \ - "Options:" \ - "\n -o OFS Start OFS bytes into FILE" \ - "\n -f Show first free loop device" \ - -#define losetup_notes_usage \ - "No arguments will display all current associations.\n" \ - "One argument (losetup /dev/loop1) will display the current association\n" \ - "(if any), or disassociate it (with -d). The display shows the offset\n" \ - "and filename of the file the loop device is currently bound to.\n\n" \ - "Two arguments (losetup /dev/loop1 file.img) create a new association,\n" \ - "with an optional offset (-o 12345). Encryption is not yet supported.\n" \ - "losetup -f will show the first loop free loop device\n\n" - -#define lpd_trivial_usage \ - "SPOOLDIR [HELPER [ARGS]]" -#define lpd_full_usage "\n\n" \ - "SPOOLDIR must contain (symlinks to) device nodes or directories" \ - "\nwith names matching print queue names. In the first case, jobs are" \ - "\nsent directly to the device. Otherwise each job is stored in queue" \ - "\ndirectory and HELPER program is called. Name of file to print" \ - "\nis passed in $DATAFILE variable." \ - "\nExample:" \ - "\n tcpsvd -E 0 515 softlimit -m 999999 lpd /var/spool ./print" \ - -#define lpq_trivial_usage \ - "[-P queue[@host[:port]]] [-U USERNAME] [-d JOBID]... [-fs]" -#define lpq_full_usage "\n\n" \ - "Options:" \ - "\n -P lp service to connect to (else uses $PRINTER)" \ - "\n -d Delete jobs" \ - "\n -f Force any waiting job to be printed" \ - "\n -s Short display" \ - -#define lpr_trivial_usage \ - "-P queue[@host[:port]] -U USERNAME -J TITLE -Vmh [FILE]..." -/* -C CLASS exists too, not shown. - * CLASS is supposed to be printed on banner page, if one is requested */ -#define lpr_full_usage "\n\n" \ - "Options:" \ - "\n -P lp service to connect to (else uses $PRINTER)"\ - "\n -m Send mail on completion" \ - "\n -h Print banner page too" \ - "\n -V Verbose" \ - -#define lspci_trivial_usage \ - "[-mk]" -#define lspci_full_usage "\n\n" \ - "List all PCI devices" \ - "\n" \ - "\n -m Parseable output" \ - "\n -k Show driver" \ - -#define lsusb_trivial_usage NOUSAGE_STR -#define lsusb_full_usage "" - -#if ENABLE_FEATURE_MAKEDEVS_LEAF -#define makedevs_trivial_usage \ - "NAME TYPE MAJOR MINOR FIRST LAST [s]" -#define makedevs_full_usage "\n\n" \ - "Create a range of block or character special files" \ - "\n" \ - "\nTYPE is:" \ - "\n b Block device" \ - "\n c Character device" \ - "\n f FIFO, MAJOR and MINOR are ignored" \ - "\n" \ - "\nFIRST..LAST specify numbers appended to NAME." \ - "\nIf 's' is the last argument, the base device is created as well." \ - "\n" \ - "\nExamples:" \ - "\n makedevs /dev/ttyS c 4 66 2 63 -> ttyS2-ttyS63" \ - "\n makedevs /dev/hda b 3 0 0 8 s -> hda,hda1-hda8" -#define makedevs_example_usage \ - "# makedevs /dev/ttyS c 4 66 2 63\n" \ - "[creates ttyS2-ttyS63]\n" \ - "# makedevs /dev/hda b 3 0 0 8 s\n" \ - "[creates hda,hda1-hda8]\n" -#endif - -#if ENABLE_FEATURE_MAKEDEVS_TABLE -#define makedevs_trivial_usage \ - "[-d device_table] rootdir" -#define makedevs_full_usage "\n\n" \ - "Create a range of special files as specified in a device table.\n" \ - "Device table entries take the form of:\n" \ - "<type> <mode> <uid> <gid> <major> <minor> <start> <inc> <count>\n" \ - "Where name is the file name, type can be one of:\n" \ - " f Regular file\n" \ - " d Directory\n" \ - " c Character device\n" \ - " b Block device\n" \ - " p Fifo (named pipe)\n" \ - "uid is the user id for the target file, gid is the group id for the\n" \ - "target file. The rest of the entries (major, minor, etc) apply to\n" \ - "to device special files. A '-' may be used for blank entries." -#define makedevs_example_usage \ - "For example:\n" \ - "<name> <type> <mode><uid><gid><major><minor><start><inc><count>\n" \ - "/dev d 755 0 0 - - - - -\n" \ - "/dev/console c 666 0 0 5 1 - - -\n" \ - "/dev/null c 666 0 0 1 3 0 0 -\n" \ - "/dev/zero c 666 0 0 1 5 0 0 -\n" \ - "/dev/hda b 640 0 0 3 0 0 0 -\n" \ - "/dev/hda b 640 0 0 3 1 1 1 15\n\n" \ - "Will Produce:\n" \ - "/dev\n" \ - "/dev/console\n" \ - "/dev/null\n" \ - "/dev/zero\n" \ - "/dev/hda\n" \ - "/dev/hda[0-15]\n" -#endif - -#define man_trivial_usage \ - "[-aw] [MANPAGE]..." -#define man_full_usage "\n\n" \ - "Format and display manual page\n" \ - "\nOptions:" \ - "\n -a Display all pages" \ - "\n -w Show page locations" \ - -#define matchpathcon_trivial_usage \ - "[-n] [-N] [-f file_contexts_file] [-p prefix] [-V]" -#define matchpathcon_full_usage "\n\n" \ - " -n Don't display path" \ - "\n -N Don't use translations" \ - "\n -f Use alternate file_context file" \ - "\n -p Use prefix to speed translations" \ - "\n -V Verify file context on disk matches defaults" \ - -#define mdev_trivial_usage \ - "[-s]" -#define mdev_full_usage "\n\n" \ - " -s Scan /sys and populate /dev during system boot\n" \ - "\n" \ - "It can be run by kernel as a hotplug helper. To activate it:\n" \ - " echo /sbin/mdev > /proc/sys/kernel/hotplug\n" \ - IF_FEATURE_MDEV_CONF( \ - "It uses /etc/mdev.conf with lines\n" \ - "[-]DEVNAME UID:GID PERM" \ - IF_FEATURE_MDEV_RENAME(" [>|=PATH]") \ - IF_FEATURE_MDEV_EXEC(" [@|$|*PROG]") \ - ) \ - -#define mdev_notes_usage "" \ - IF_FEATURE_MDEV_CONFIG( \ - "The mdev config file contains lines that look like:\n" \ - " hd[a-z][0-9]* 0:3 660\n\n" \ - "That's device name (with regex match), uid:gid, and permissions.\n\n" \ - IF_FEATURE_MDEV_EXEC( \ - "Optionally, that can be followed (on the same line) by a special character\n" \ - "and a command line to run after creating/before deleting the corresponding\n" \ - "device(s). The environment variable $MDEV indicates the active device node\n" \ - "(which is useful if it's a regex match). For example:\n\n" \ - " hdc root:cdrom 660 *ln -s $MDEV cdrom\n\n" \ - "The special characters are @ (run after creating), $ (run before deleting),\n" \ - "and * (run both after creating and before deleting). The commands run in\n" \ - "the /dev directory, and use system() which calls /bin/sh.\n\n" \ - ) \ - "Config file parsing stops on the first matching line. If no config\n" \ - "entry is matched, devices are created with default 0:0 660. (Make\n" \ - "the last line match .* to override this.)\n\n" \ - ) - -#define microcom_trivial_usage \ - "[-d DELAY] [-t TIMEOUT] [-s SPEED] [-X] TTY" -#define microcom_full_usage "\n\n" \ - "Copy bytes for stdin to TTY and from TTY to stdout\n" \ - "\nOptions:" \ - "\n -d Wait up to DELAY ms for TTY output before sending every" \ - "\n next byte to it" \ - "\n -t Exit if both stdin and TTY are silent for TIMEOUT ms" \ - "\n -s Set serial line to SPEED" \ - "\n -X Disable special meaning of NUL and Ctrl-X from stdin" \ - -#define mkfs_ext2_trivial_usage \ - "[-Fn] " \ - /* "[-c|-l filename] " */ \ - "[-b BLK_SIZE] " \ - /* "[-f fragment-size] [-g blocks-per-group] " */ \ - "[-i INODE_RATIO] [-I INODE_SIZE] " \ - /* "[-j] [-J journal-options] [-N number-of-inodes] " */ \ - "[-m RESERVED_PERCENT] " \ - /* "[-o creator-os] [-O feature[,...]] [-q] " */ \ - /* "[r fs-revision-level] [-E extended-options] [-v] [-F] " */ \ - "[-L LABEL] " \ - /* "[-M last-mounted-directory] [-S] [-T filesystem-type] " */ \ - "BLOCKDEV [KBYTES]" -#define mkfs_ext2_full_usage "\n\n" \ - " -b BLK_SIZE Block size, bytes" \ -/* "\n -c Check device for bad blocks" */ \ -/* "\n -E opts Set extended options" */ \ -/* "\n -f size Fragment size in bytes" */ \ - "\n -F Force" \ -/* "\n -g N Number of blocks in a block group" */ \ - "\n -i RATIO Max number of files is filesystem_size / RATIO" \ - "\n -I BYTES Inode size (min 128)" \ -/* "\n -j Create a journal (ext3)" */ \ -/* "\n -J opts Set journal options (size/device)" */ \ -/* "\n -l file Read bad blocks list from file" */ \ - "\n -L LBL Volume label" \ - "\n -m PERCENT Percent of blocks to reserve for admin" \ -/* "\n -M dir Set last mounted directory" */ \ - "\n -n Dry run" \ -/* "\n -N N Number of inodes to create" */ \ -/* "\n -o os Set the 'creator os' field" */ \ -/* "\n -O features Dir_index/filetype/has_journal/journal_dev/sparse_super" */ \ -/* "\n -q Quiet" */ \ -/* "\n -r rev Set filesystem revision" */ \ -/* "\n -S Write superblock and group descriptors only" */ \ -/* "\n -T fs-type Set usage type (news/largefile/largefile4)" */ \ -/* "\n -v Verbose" */ \ - -#define mkfs_minix_trivial_usage \ - "[-c | -l FILE] [-nXX] [-iXX] BLOCKDEV [KBYTES]" -#define mkfs_minix_full_usage "\n\n" \ - "Make a MINIX filesystem\n" \ - "\nOptions:" \ - "\n -c Check device for bad blocks" \ - "\n -n [14|30] Maximum length of filenames" \ - "\n -i INODES Number of inodes for the filesystem" \ - "\n -l FILE Read bad blocks list from FILE" \ - "\n -v Make version 2 filesystem" \ - -#define mkfs_reiser_trivial_usage \ - "[-f] [-l LABEL] BLOCKDEV [4K-BLOCKS]" - -#define mkfs_reiser_full_usage "\n\n" \ - "Make a ReiserFS V3 filesystem\n" \ - "\nOptions:" \ - "\n -f Force" \ - "\n -l LBL Volume label" \ - -#define mkfs_vfat_trivial_usage \ - "[-v] [-n LABEL] BLOCKDEV [KBYTES]" -/* Accepted but ignored: - "[-c] [-C] [-I] [-l bad-block-file] [-b backup-boot-sector] " - "[-m boot-msg-file] [-i volume-id] " - "[-s sectors-per-cluster] [-S logical-sector-size] [-f number-of-FATs] " - "[-h hidden-sectors] [-F fat-size] [-r root-dir-entries] [-R reserved-sectors] " -*/ -#define mkfs_vfat_full_usage "\n\n" \ - "Make a FAT32 filesystem\n" \ - "\nOptions:" \ -/* "\n -c Check device for bad blocks" */ \ - "\n -v Verbose" \ -/* "\n -I Allow to use entire disk device (e.g. /dev/hda)" */ \ - "\n -n LBL Volume label" \ - -#define mkswap_trivial_usage \ - "[-L LBL] BLOCKDEV [KBYTES]" -#define mkswap_full_usage "\n\n" \ - "Prepare BLOCKDEV to be used as swap partition\n" \ - "\nOptions:" \ - "\n -L LBL Label" \ - -#define more_trivial_usage \ - "[FILE]..." -#define more_full_usage "\n\n" \ - "View FILE (or stdin) one screenful at a time" - -#define more_example_usage \ - "$ dmesg | more\n" - -#define mount_trivial_usage \ - "[OPTIONS] [-o OPTS] DEVICE NODE" -#define mount_full_usage "\n\n" \ - "Mount a filesystem. Filesystem autodetection requires /proc.\n" \ - "\nOptions:" \ - "\n -a Mount all filesystems in fstab" \ - IF_FEATURE_MOUNT_FAKE( \ - IF_FEATURE_MTAB_SUPPORT( \ - "\n -f Update /etc/mtab, but don't mount" \ - ) \ - IF_NOT_FEATURE_MTAB_SUPPORT( \ - "\n -f Dry run" \ - ) \ - ) \ - IF_FEATURE_MOUNT_HELPERS( \ - "\n -i Don't run mount helper" \ - ) \ - IF_FEATURE_MTAB_SUPPORT( \ - "\n -n Don't update /etc/mtab" \ - ) \ - "\n -r Read-only mount" \ - "\n -w Read-write mount (default)" \ - "\n -t FSTYPE Filesystem type" \ - "\n -O OPT Mount only filesystems with option OPT (-a only)" \ - "\n-o OPT:" \ - IF_FEATURE_MOUNT_LOOP( \ - "\n loop Ignored (loop devices are autodetected)" \ - ) \ - IF_FEATURE_MOUNT_FLAGS( \ - "\n [a]sync Writes are [a]synchronous" \ - "\n [no]atime Disable/enable updates to inode access times" \ - "\n [no]diratime Disable/enable atime updates to directories" \ - "\n [no]relatime Disable/enable atime updates relative to modification time" \ - "\n [no]dev (Dis)allow use of special device files" \ - "\n [no]exec (Dis)allow use of executable files" \ - "\n [no]suid (Dis)allow set-user-id-root programs" \ - "\n [r]shared Convert [recursively] to a shared subtree" \ - "\n [r]slave Convert [recursively] to a slave subtree" \ - "\n [r]private Convert [recursively] to a private subtree" \ - "\n [un]bindable Make mount point [un]able to be bind mounted" \ - "\n [r]bind Bind a file or directory [recursively] to another location" \ - "\n move Relocate an existing mount point" \ - ) \ - "\n remount Remount a mounted filesystem, changing flags" \ - "\n ro/rw Same as -r/-w" \ - "\n" \ - "\nThere are filesystem-specific -o flags." \ - -#define mount_example_usage \ - "$ mount\n" \ - "/dev/hda3 on / type minix (rw)\n" \ - "proc on /proc type proc (rw)\n" \ - "devpts on /dev/pts type devpts (rw)\n" \ - "$ mount /dev/fd0 /mnt -t msdos -o ro\n" \ - "$ mount /tmp/diskimage /opt -t ext2 -o loop\n" \ - "$ mount cd_image.iso mydir\n" -#define mount_notes_usage \ - "Returns 0 for success, number of failed mounts for -a, or errno for one mount." - -#define mountpoint_trivial_usage \ - "[-q] <[-dn] DIR | -x DEVICE>" -#define mountpoint_full_usage "\n\n" \ - "Check if the directory is a mountpoint\n" \ - "\nOptions:" \ - "\n -q Quiet" \ - "\n -d Print major/minor device number of the filesystem" \ - "\n -n Print device name of the filesystem" \ - "\n -x Print major/minor device number of the blockdevice" \ - -#define mountpoint_example_usage \ - "$ mountpoint /proc\n" \ - "/proc is not a mountpoint\n" \ - "$ mountpoint /sys\n" \ - "/sys is a mountpoint\n" - -#define mt_trivial_usage \ - "[-f device] opcode value" -#define mt_full_usage "\n\n" \ - "Control magnetic tape drive operation\n" \ - "\n" \ - "Available Opcodes:\n" \ - "\n" \ - "bsf bsfm bsr bss datacompression drvbuffer eof eom erase\n" \ - "fsf fsfm fsr fss load lock mkpart nop offline ras1 ras2\n" \ - "ras3 reset retension rewind rewoffline seek setblk setdensity\n" \ - "setpart tell unload unlock weof wset" \ - -#define nslookup_trivial_usage \ - "[HOST] [SERVER]" -#define nslookup_full_usage "\n\n" \ - "Query the nameserver for the IP address of the given HOST\n" \ - "optionally using a specified DNS server" -#define nslookup_example_usage \ - "$ nslookup localhost\n" \ - "Server: default\n" \ - "Address: default\n" \ - "\n" \ - "Name: debian\n" \ - "Address: 127.0.0.1\n" - -#define ntpd_trivial_usage \ - "[-dnqNw"IF_FEATURE_NTPD_SERVER("l")"] [-S PROG] [-p PEER]..." -#define ntpd_full_usage "\n\n" \ - "NTP client/server\n" \ - "\nOptions:" \ - "\n -d Verbose" \ - "\n -n Do not daemonize" \ - "\n -q Quit after clock is set" \ - "\n -N Run at high priority" \ - "\n -w Do not set time (only query peers), implies -n" \ - IF_FEATURE_NTPD_SERVER( \ - "\n -l Run as server on port 123" \ - ) \ - "\n -S PROG Run PROG after stepping time, stratum change, and every 11 mins" \ - "\n -p PEER Obtain time from PEER (may be repeated)" \ - -/* -#define parse_trivial_usage \ - "[-n MAXTOKENS] [-m MINTOKENS] [-d DELIMS] [-f FLAGS] FILE..." -#define parse_full_usage "" -*/ - -#define pgrep_trivial_usage \ - "[-flnovx] [-s SID|-P PPID|PATTERN]" -#define pgrep_full_usage "\n\n" \ - "Display process(es) selected by regex PATTERN\n" \ - "\nOptions:" \ - "\n -l Show command name too" \ - "\n -f Match against entire command line" \ - "\n -n Show the newest process only" \ - "\n -o Show the oldest process only" \ - "\n -v Negate the match" \ - "\n -x Match whole name (not substring)" \ - "\n -s Match session ID (0 for current)" \ - "\n -P Match parent process ID" \ - -#if (ENABLE_FEATURE_PIDOF_SINGLE || ENABLE_FEATURE_PIDOF_OMIT) -#define pidof_trivial_usage \ - "[OPTIONS] [NAME]..." -#define USAGE_PIDOF "\n\nOptions:" -#else -#define pidof_trivial_usage \ - "[NAME]..." -#define USAGE_PIDOF /* none */ -#endif -#define pidof_full_usage "\n\n" \ - "List PIDs of all processes with names that match NAMEs" \ - USAGE_PIDOF \ - IF_FEATURE_PIDOF_SINGLE( \ - "\n -s Show only one PID" \ - ) \ - IF_FEATURE_PIDOF_OMIT( \ - "\n -o PID Omit given pid" \ - "\n Use %PPID to omit pid of pidof's parent" \ - ) \ - -#define pidof_example_usage \ - "$ pidof init\n" \ - "1\n" \ - IF_FEATURE_PIDOF_OMIT( \ - "$ pidof /bin/sh\n20351 5973 5950\n") \ - IF_FEATURE_PIDOF_OMIT( \ - "$ pidof /bin/sh -o %PPID\n20351 5950") - -#define pivot_root_trivial_usage \ - "NEW_ROOT PUT_OLD" -#define pivot_root_full_usage "\n\n" \ - "Move the current root file system to PUT_OLD and make NEW_ROOT\n" \ - "the new root file system" - -#define pkill_trivial_usage \ - "[-l|-SIGNAL] [-fnovx] [-s SID|-P PPID|PATTERN]" -#define pkill_full_usage "\n\n" \ - "Send a signal to process(es) selected by regex PATTERN\n" \ - "\nOptions:" \ - "\n -l List all signals" \ - "\n -f Match against entire command line" \ - "\n -n Signal the newest process only" \ - "\n -o Signal the oldest process only" \ - "\n -v Negate the match" \ - "\n -x Match whole name (not substring)" \ - "\n -s Match session ID (0 for current)" \ - "\n -P Match parent process ID" \ - - -#if ENABLE_DESKTOP - -#define ps_trivial_usage \ - "[-o COL1,COL2=HEADER]" IF_FEATURE_SHOW_THREADS(" [-T]") -#define ps_full_usage "\n\n" \ - "Show list of processes\n" \ - "\nOptions:" \ - "\n -o COL1,COL2=HEADER Select columns for display" \ - IF_FEATURE_SHOW_THREADS( \ - "\n -T Show threads" \ - ) - -#else /* !ENABLE_DESKTOP */ - -#if !ENABLE_SELINUX && !ENABLE_FEATURE_PS_WIDE -#define USAGE_PS "\nThis version of ps accepts no options" -#else -#define USAGE_PS "\nOptions:" -#endif - -#define ps_trivial_usage \ - "" -#define ps_full_usage "\n\n" \ - "Show list of processes\n" \ - USAGE_PS \ - IF_SELINUX( \ - "\n -Z Show selinux context" \ - ) \ - IF_FEATURE_PS_WIDE( \ - "\n w Wide output" \ - ) - -#endif /* ENABLE_DESKTOP */ - -#define ps_example_usage \ - "$ ps\n" \ - " PID Uid Gid State Command\n" \ - " 1 root root S init\n" \ - " 2 root root S [kflushd]\n" \ - " 3 root root S [kupdate]\n" \ - " 4 root root S [kpiod]\n" \ - " 5 root root S [kswapd]\n" \ - " 742 andersen andersen S [bash]\n" \ - " 743 andersen andersen S -bash\n" \ - " 745 root root S [getty]\n" \ - " 2990 andersen andersen R ps\n" \ - -#define pscan_trivial_usage \ - "[-cb] [-p MIN_PORT] [-P MAX_PORT] [-t TIMEOUT] [-T MIN_RTT] HOST" -#define pscan_full_usage "\n\n" \ - "Scan a host, print all open ports\n" \ - "\nOptions:" \ - "\n -c Show closed ports too" \ - "\n -b Show blocked ports too" \ - "\n -p Scan from this port (default 1)" \ - "\n -P Scan up to this port (default 1024)" \ - "\n -t Timeout (default 5000 ms)" \ - "\n -T Minimum rtt (default 5 ms, increase for congested hosts)" \ - -#define raidautorun_trivial_usage \ - "DEVICE" -#define raidautorun_full_usage "\n\n" \ - "Tell the kernel to automatically search and start RAID arrays" -#define raidautorun_example_usage \ - "$ raidautorun /dev/md0" - -#define rdate_trivial_usage \ - "[-sp] HOST" -#define rdate_full_usage "\n\n" \ - "Get and possibly set the system date and time from a remote HOST\n" \ - "\nOptions:" \ - "\n -s Set the system date and time (default)" \ - "\n -p Print the date and time" \ - -#define rdev_trivial_usage \ - "" -#define rdev_full_usage "\n\n" \ - "Print the device node associated with the filesystem mounted at '/'" -#define rdev_example_usage \ - "$ rdev\n" \ - "/dev/mtdblock9 /\n" - -#define readahead_trivial_usage \ - "[FILE]..." -#define readahead_full_usage "\n\n" \ - "Preload FILEs to RAM" - -#define readprofile_trivial_usage \ - "[OPTIONS]" -#define readprofile_full_usage "\n\n" \ - "Options:" \ - "\n -m mapfile (Default: /boot/System.map)" \ - "\n -p profile (Default: /proc/profile)" \ - "\n -M NUM Set the profiling multiplier to NUM" \ - "\n -i Print only info about the sampling step" \ - "\n -v Verbose" \ - "\n -a Print all symbols, even if count is 0" \ - "\n -b Print individual histogram-bin counts" \ - "\n -s Print individual counters within functions" \ - "\n -r Reset all the counters (root only)" \ - "\n -n Disable byte order auto-detection" \ - -#define scriptreplay_trivial_usage \ - "timingfile [typescript [divisor]]" -#define scriptreplay_full_usage "\n\n" \ - "Play back typescripts, using timing information" - -#define restorecon_trivial_usage \ - "[-iFnRv] [-e EXCLUDEDIR]... [-o FILE] [-f FILE]" -#define restorecon_full_usage "\n\n" \ - "Reset security contexts of files in pathname\n" \ - "\n -i Ignore files that don't exist" \ - "\n -f FILE File with list of files to process" \ - "\n -e DIR Directory to exclude" \ - "\n -R,-r Recurse" \ - "\n -n Don't change any file labels" \ - "\n -o FILE Save list of files with incorrect context" \ - "\n -v Verbose" \ - "\n -vv Show changed labels" \ - "\n -F Force reset of context to match file_context" \ - "\n for customizable files, or the user section," \ - "\n if it has changed" \ - -#define rfkill_trivial_usage \ - "COMMAND [INDEX|TYPE]" -#define rfkill_full_usage "\n\n" \ - "Enable/disable wireless devices\n" \ - "\nCommands:" \ - "\n list [INDEX|TYPE] List current state" \ - "\n block INDEX|TYPE Disable device" \ - "\n unblock INDEX|TYPE Enable device" \ - "\n" \ - "\n TYPE: all, wlan(wifi), bluetooth, uwb(ultrawideband)," \ - "\n wimax, wwan, gps, fm" \ - -#define route_trivial_usage \ - "[{add|del|delete}]" -#define route_full_usage "\n\n" \ - "Edit kernel routing tables\n" \ - "\nOptions:" \ - "\n -n Don't resolve names" \ - "\n -e Display other/more information" \ - "\n -A inet" IF_FEATURE_IPV6("{6}") " Select address family" \ - -#define rtcwake_trivial_usage \ - "[-a | -l | -u] [-d DEV] [-m MODE] [-s SEC | -t TIME]" -#define rtcwake_full_usage "\n\n" \ - "Enter a system sleep state until specified wakeup time\n" \ - IF_LONG_OPTS( \ - "\n -a,--auto Read clock mode from adjtime" \ - "\n -l,--local Clock is set to local time" \ - "\n -u,--utc Clock is set to UTC time" \ - "\n -d,--device=DEV Specify the RTC device" \ - "\n -m,--mode=MODE Set the sleep state (default: standby)" \ - "\n -s,--seconds=SEC Set the timeout in SEC seconds from now" \ - "\n -t,--time=TIME Set the timeout to TIME seconds from epoch" \ - ) \ - IF_NOT_LONG_OPTS( \ - "\n -a Read clock mode from adjtime" \ - "\n -l Clock is set to local time" \ - "\n -u Clock is set to UTC time" \ - "\n -d DEV Specify the RTC device" \ - "\n -m MODE Set the sleep state (default: standby)" \ - "\n -s SEC Set the timeout in SEC seconds from now" \ - "\n -t TIME Set the timeout to TIME seconds from epoch" \ - ) - -#define runcon_trivial_usage \ - "[-c] [-u USER] [-r ROLE] [-t TYPE] [-l RANGE] PROG ARGS\n" \ - "runcon CONTEXT PROG ARGS" -#define runcon_full_usage "\n\n" \ - "Run PROG in a different security context\n" \ - "\n CONTEXT Complete security context\n" \ - IF_FEATURE_RUNCON_LONG_OPTIONS( \ - "\n -c,--compute Compute process transition context before modifying" \ - "\n -t,--type=TYPE Type (for same role as parent)" \ - "\n -u,--user=USER User identity" \ - "\n -r,--role=ROLE Role" \ - "\n -l,--range=RNG Levelrange" \ - ) \ - IF_NOT_FEATURE_RUNCON_LONG_OPTIONS( \ - "\n -c Compute process transition context before modifying" \ - "\n -t TYPE Type (for same role as parent)" \ - "\n -u USER User identity" \ - "\n -r ROLE Role" \ - "\n -l RNG Levelrange" \ - ) - -#define runlevel_trivial_usage \ - "[FILE]" -#define runlevel_full_usage "\n\n" \ - "Find the current and previous system runlevel\n" \ - "\n" \ - "If no utmp FILE exists or if no runlevel record can be found,\n" \ - "print \"unknown\"" -#define runlevel_example_usage \ - "$ runlevel /var/run/utmp\n" \ - "N 2" - -#define runsv_trivial_usage \ - "DIR" -#define runsv_full_usage "\n\n" \ - "Start and monitor a service and optionally an appendant log service" - -#define runsvdir_trivial_usage \ - "[-P] [-s SCRIPT] DIR" -#define runsvdir_full_usage "\n\n" \ - "Start a runsv process for each subdirectory. If it exits, restart it.\n" \ - "\n -P Put each runsv in a new session" \ - "\n -s SCRIPT Run SCRIPT <signo> after signal is processed" \ - -#define rx_trivial_usage \ - "FILE" -#define rx_full_usage "\n\n" \ - "Receive a file using the xmodem protocol" -#define rx_example_usage \ - "$ rx /tmp/foo\n" - -#define script_trivial_usage \ - "[-afq" IF_SCRIPTREPLAY("t") "] [-c PROG] [OUTFILE]" -#define script_full_usage "\n\n" \ - "Options:" \ - "\n -a Append output" \ - "\n -c PROG Run PROG, not shell" \ - "\n -f Flush output after each write" \ - "\n -q Quiet" \ - IF_SCRIPTREPLAY( \ - "\n -t Send timing to stderr" \ - ) - -#define selinuxenabled_trivial_usage NOUSAGE_STR -#define selinuxenabled_full_usage "" - -#define sestatus_trivial_usage \ - "[-vb]" -#define sestatus_full_usage "\n\n" \ - " -v Verbose" \ - "\n -b Display current state of booleans" \ - -#define setenforce_trivial_usage \ - "[Enforcing | Permissive | 1 | 0]" -#define setenforce_full_usage "" - -#define setfiles_trivial_usage \ - "[-dnpqsvW] [-e DIR]... [-o FILE] [-r alt_root_path]" \ - IF_FEATURE_SETFILES_CHECK_OPTION( \ - " [-c policyfile] spec_file" \ - ) \ - " pathname" -#define setfiles_full_usage "\n\n" \ - "Reset file contexts under pathname according to spec_file\n" \ - IF_FEATURE_SETFILES_CHECK_OPTION( \ - "\n -c FILE Check the validity of the contexts against the specified binary policy" \ - ) \ - "\n -d Show which specification matched each file" \ - "\n -l Log changes in file labels to syslog" \ - "\n -n Don't change any file labels" \ - "\n -q Suppress warnings" \ - "\n -r DIR Use an alternate root path" \ - "\n -e DIR Exclude DIR" \ - "\n -F Force reset of context to match file_context for customizable files" \ - "\n -o FILE Save list of files with incorrect context" \ - "\n -s Take a list of files from stdin (instead of command line)" \ - "\n -v Show changes in file labels, if type or role are changing" \ - "\n -vv Show changes in file labels, if type, role, or user are changing" \ - "\n -W Display warnings about entries that had no matching files" \ - -#define setfont_trivial_usage \ - "FONT [-m MAPFILE] [-C TTY]" -#define setfont_full_usage "\n\n" \ - "Load a console font\n" \ - "\nOptions:" \ - "\n -m MAPFILE Load console screen map" \ - "\n -C TTY Affect TTY instead of /dev/tty" \ - -#define setfont_example_usage \ - "$ setfont -m koi8-r /etc/i18n/fontname\n" - -#define setsebool_trivial_usage \ - "boolean value" - -#define setsebool_full_usage "\n\n" \ - "Change boolean setting" - -#define setsid_trivial_usage \ - "PROG ARGS" -#define setsid_full_usage "\n\n" \ - "Run PROG in a new session. PROG will have no controlling terminal\n" \ - "and will not be affected by keyboard signals (Ctrl-C etc).\n" \ - "See setsid(2) for details." \ - -#define last_trivial_usage \ - ""IF_FEATURE_LAST_FANCY("[-HW] [-f FILE]") -#define last_full_usage "\n\n" \ - "Show listing of the last users that logged into the system" \ - IF_FEATURE_LAST_FANCY( "\n" \ - "\nOptions:" \ -/* "\n -H Show header line" */ \ - "\n -W Display with no host column truncation" \ - "\n -f FILE Read from FILE instead of /var/log/wtmp" \ - ) - -#define slattach_trivial_usage \ - "[-cehmLF] [-s SPEED] [-p PROTOCOL] DEVICE" -#define slattach_full_usage "\n\n" \ - "Attach network interface(s) to serial line(s)\n" \ - "\nOptions:" \ - "\n -p PROT Set protocol (slip, cslip, slip6, clisp6 or adaptive)" \ - "\n -s SPD Set line speed" \ - "\n -e Exit after initializing device" \ - "\n -h Exit when the carrier is lost" \ - "\n -c PROG Run PROG when the line is hung up" \ - "\n -m Do NOT initialize the line in raw 8 bits mode" \ - "\n -L Enable 3-wire operation" \ - "\n -F Disable RTS/CTS flow control" \ - -#define strings_trivial_usage \ - "[-afo] [-n LEN] [FILE]..." -#define strings_full_usage "\n\n" \ - "Display printable strings in a binary file\n" \ - "\nOptions:" \ - "\n -a Scan whole file (default)" \ - "\n -f Precede strings with filenames" \ - "\n -n LEN At least LEN characters form a string (default 4)" \ - "\n -o Precede strings with decimal offsets" \ - -#define sv_trivial_usage \ - "[-v] [-w SEC] CMD SERVICE_DIR..." -#define sv_full_usage "\n\n" \ - "Control services monitored by runsv supervisor.\n" \ - "Commands (only first character is enough):\n" \ - "\n" \ - "status: query service status\n" \ - "up: if service isn't running, start it. If service stops, restart it\n" \ - "once: like 'up', but if service stops, don't restart it\n" \ - "down: send TERM and CONT signals. If ./run exits, start ./finish\n" \ - " if it exists. After it stops, don't restart service\n" \ - "exit: send TERM and CONT signals to service and log service. If they exit,\n" \ - " runsv exits too\n" \ - "pause, cont, hup, alarm, interrupt, quit, 1, 2, term, kill: send\n" \ - "STOP, CONT, HUP, ALRM, INT, QUIT, USR1, USR2, TERM, KILL signal to service" \ - -#define swapoff_trivial_usage \ - "[-a] [DEVICE]" -#define swapoff_full_usage "\n\n" \ - "Stop swapping on DEVICE\n" \ - "\nOptions:" \ - "\n -a Stop swapping on all swap devices" \ - -#define swapon_trivial_usage \ - "[-a]" IF_FEATURE_SWAPON_PRI(" [-p PRI]") " [DEVICE]" -#define swapon_full_usage "\n\n" \ - "Start swapping on DEVICE\n" \ - "\nOptions:" \ - "\n -a Start swapping on all swap devices" \ - IF_FEATURE_SWAPON_PRI( \ - "\n -p PRI Set swap device priority" \ - ) \ - -#define switch_root_trivial_usage \ - "[-c /dev/console] NEW_ROOT NEW_INIT [ARGS]" -#define switch_root_full_usage "\n\n" \ - "Free initramfs and switch to another root fs:\n" \ - "chroot to NEW_ROOT, delete all in /, move NEW_ROOT to /,\n" \ - "execute NEW_INIT. PID must be 1. NEW_ROOT must be a mountpoint.\n" \ - "\nOptions:" \ - "\n -c DEV Reopen stdio to DEV after switch" \ - -#define sysctl_trivial_usage \ - "[OPTIONS] [VALUE]..." -#define sysctl_full_usage "\n\n" \ - "Configure kernel parameters at runtime\n" \ - "\nOptions:" \ - "\n -n Don't print key names" \ - "\n -e Don't warn about unknown keys" \ - "\n -w Change sysctl setting" \ - "\n -p FILE Load sysctl settings from FILE (default /etc/sysctl.conf)" \ - "\n -a Display all values" \ - "\n -A Display all values in table form" \ - -#define sysctl_example_usage \ - "sysctl [-n] [-e] variable...\n" \ - "sysctl [-n] [-e] -w variable=value...\n" \ - "sysctl [-n] [-e] -a\n" \ - "sysctl [-n] [-e] -p file (default /etc/sysctl.conf)\n" \ - "sysctl [-n] [-e] -A\n" - -#define syslogd_trivial_usage \ - "[OPTIONS]" -#define syslogd_full_usage "\n\n" \ - "System logging utility.\n" \ - "This version of syslogd ignores /etc/syslog.conf\n" \ - "\nOptions:" \ - "\n -n Run in foreground" \ - "\n -O FILE Log to given file (default:/var/log/messages)" \ - "\n -l N Set local log level" \ - "\n -S Smaller logging output" \ - IF_FEATURE_ROTATE_LOGFILE( \ - "\n -s SIZE Max size (KB) before rotate (default:200KB, 0=off)" \ - "\n -b N N rotated logs to keep (default:1, max=99, 0=purge)") \ - IF_FEATURE_REMOTE_LOG( \ - "\n -R HOST[:PORT] Log to IP or hostname on PORT (default PORT=514/UDP)" \ - "\n -L Log locally and via network (default is network only if -R)") \ - IF_FEATURE_SYSLOGD_DUP( \ - "\n -D Drop duplicates") \ - IF_FEATURE_IPC_SYSLOG( \ - "\n -C[size(KiB)] Log to shared mem buffer (read it using logread)") \ - /* NB: -Csize shouldn't have space (because size is optional) */ -/* "\n -m MIN Minutes between MARK lines (default:20, 0=off)" */ - -#define syslogd_example_usage \ - "$ syslogd -R masterlog:514\n" \ - "$ syslogd -R 192.168.1.1:601\n" - -#define taskset_trivial_usage \ - "[-p] [MASK] [PID | PROG ARGS]" -#define taskset_full_usage "\n\n" \ - "Set or get CPU affinity\n" \ - "\nOptions:" \ - "\n -p Operate on an existing PID" \ - -#define taskset_example_usage \ - "$ taskset 0x7 ./dgemm_test&\n" \ - "$ taskset -p 0x1 $!\n" \ - "pid 4790's current affinity mask: 7\n" \ - "pid 4790's new affinity mask: 1\n" \ - "$ taskset 0x7 /bin/sh -c './taskset -p 0x1 $$'\n" \ - "pid 6671's current affinity mask: 1\n" \ - "pid 6671's new affinity mask: 1\n" \ - "$ taskset -p 1\n" \ - "pid 1's current affinity mask: 3\n" - -#if ENABLE_FEATURE_TELNET_AUTOLOGIN -#define telnet_trivial_usage \ - "[-a] [-l USER] HOST [PORT]" -#define telnet_full_usage "\n\n" \ - "Connect to telnet server\n" \ - "\nOptions:" \ - "\n -a Automatic login with $USER variable" \ - "\n -l USER Automatic login as USER" \ - -#else -#define telnet_trivial_usage \ - "HOST [PORT]" -#define telnet_full_usage "\n\n" \ - "Connect to telnet server" -#endif - -#define telnetd_trivial_usage \ - "[OPTIONS]" -#define telnetd_full_usage "\n\n" \ - "Handle incoming telnet connections" \ - IF_NOT_FEATURE_TELNETD_STANDALONE(" via inetd") "\n" \ - "\nOptions:" \ - "\n -l LOGIN Exec LOGIN on connect" \ - "\n -f ISSUE_FILE Display ISSUE_FILE instead of /etc/issue" \ - "\n -K Close connection as soon as login exits" \ - "\n (normally wait until all programs close slave pty)" \ - IF_FEATURE_TELNETD_STANDALONE( \ - "\n -p PORT Port to listen on" \ - "\n -b ADDR[:PORT] Address to bind to" \ - "\n -F Run in foreground" \ - "\n -i Inetd mode" \ - IF_FEATURE_TELNETD_INETD_WAIT( \ - "\n -w SEC Inetd 'wait' mode, linger time SEC" \ - "\n -S Log to syslog (implied by -i or without -F and -w)" \ - ) \ - ) - -#define tc_trivial_usage \ - /*"[OPTIONS] "*/"OBJECT CMD [dev STRING]" -#define tc_full_usage "\n\n" \ - "OBJECT: {qdisc|class|filter}\n" \ - "CMD: {add|del|change|replace|show}\n" \ - "\n" \ - "qdisc [ handle QHANDLE ] [ root |"IF_FEATURE_TC_INGRESS(" ingress |")" parent CLASSID ]\n" \ - /* "[ estimator INTERVAL TIME_CONSTANT ]\n" */ \ - " [ [ QDISC_KIND ] [ help | OPTIONS ] ]\n" \ - " QDISC_KIND := { [p|b]fifo | tbf | prio | cbq | red | etc. }\n" \ - "qdisc show [ dev STRING ]"IF_FEATURE_TC_INGRESS(" [ingress]")"\n" \ - "class [ classid CLASSID ] [ root | parent CLASSID ]\n" \ - " [ [ QDISC_KIND ] [ help | OPTIONS ] ]\n" \ - "class show [ dev STRING ] [ root | parent CLASSID ]\n" \ - "filter [ pref PRIO ] [ protocol PROTO ]\n" \ - /* "\t[ estimator INTERVAL TIME_CONSTANT ]\n" */ \ - " [ root | classid CLASSID ] [ handle FILTERID ]\n" \ - " [ [ FILTER_TYPE ] [ help | OPTIONS ] ]\n" \ - "filter show [ dev STRING ] [ root | parent CLASSID ]" - -#define tcpsvd_trivial_usage \ - "[-hEv] [-c N] [-C N[:MSG]] [-b N] [-u USER] [-l NAME] IP PORT PROG" -/* with not-implemented options: */ -/* "[-hpEvv] [-c N] [-C N[:MSG]] [-b N] [-u USER] [-l NAME] [-i DIR|-x CDB] [-t SEC] IP PORT PROG" */ -#define tcpsvd_full_usage "\n\n" \ - "Create TCP socket, bind to IP:PORT and listen\n" \ - "for incoming connection. Run PROG for each connection.\n" \ - "\n IP IP to listen on. '0' = all" \ - "\n PORT Port to listen on" \ - "\n PROG ARGS Program to run" \ - "\n -l NAME Local hostname (else looks up local hostname in DNS)" \ - "\n -u USER[:GRP] Change to user/group after bind" \ - "\n -c N Handle up to N connections simultaneously" \ - "\n -b N Allow a backlog of approximately N TCP SYNs" \ - "\n -C N[:MSG] Allow only up to N connections from the same IP." \ - "\n New connections from this IP address are closed" \ - "\n immediately. MSG is written to the peer before close" \ - "\n -h Look up peer's hostname" \ - "\n -E Don't set up environment variables" \ - "\n -v Verbose" \ - -#define udpsvd_trivial_usage \ - "[-hEv] [-c N] [-u USER] [-l NAME] IP PORT PROG" -#define udpsvd_full_usage "\n\n" \ - "Create UDP socket, bind to IP:PORT and wait\n" \ - "for incoming packets. Run PROG for each packet,\n" \ - "redirecting all further packets with same peer ip:port to it.\n" \ - "\n IP IP to listen on. '0' = all" \ - "\n PORT Port to listen on" \ - "\n PROG ARGS Program to run" \ - "\n -l NAME Local hostname (else looks up local hostname in DNS)" \ - "\n -u USER[:GRP] Change to user/group after bind" \ - "\n -c N Handle up to N connections simultaneously" \ - "\n -h Look up peer's hostname" \ - "\n -E Don't set up environment variables" \ - "\n -v Verbose" \ - -#define tftp_trivial_usage \ - "[OPTIONS] HOST [PORT]" -#define tftp_full_usage "\n\n" \ - "Transfer a file from/to tftp server\n" \ - "\nOptions:" \ - "\n -l FILE Local FILE" \ - "\n -r FILE Remote FILE" \ - IF_FEATURE_TFTP_GET( \ - "\n -g Get file" \ - ) \ - IF_FEATURE_TFTP_PUT( \ - "\n -p Put file" \ - ) \ - IF_FEATURE_TFTP_BLOCKSIZE( \ - "\n -b SIZE Transfer blocks of SIZE octets" \ - ) - -#define tftpd_trivial_usage \ - "[-cr] [-u USER] [DIR]" -#define tftpd_full_usage "\n\n" \ - "Transfer a file on tftp client's request\n" \ - "\n" \ - "tftpd should be used as an inetd service.\n" \ - "tftpd's line for inetd.conf:\n" \ - " 69 dgram udp nowait root tftpd tftpd /files/to/serve\n" \ - "It also can be ran from udpsvd:\n" \ - " udpsvd -vE 0.0.0.0 69 tftpd /files/to/serve\n" \ - "\nOptions:" \ - "\n -r Prohibit upload" \ - "\n -c Allow file creation via upload" \ - "\n -u Access files as USER" \ - -#define time_trivial_usage \ - "[-v] PROG ARGS" -#define time_full_usage "\n\n" \ - "Run PROG, display resource usage when it exits\n" \ - "\nOptions:" \ - "\n -v Verbose" \ - -#define timeout_trivial_usage \ - "[-t SECS] [-s SIG] PROG ARGS" -#define timeout_full_usage "\n\n" \ - "Runs PROG. Sends SIG to it if it is not gone in SECS seconds.\n" \ - "Defaults: SECS: 10, SIG: TERM." \ - -#define traceroute_trivial_usage \ - "[-"IF_TRACEROUTE6("46")"FIldnrv] [-f 1ST_TTL] [-m MAXTTL] [-p PORT] [-q PROBES]\n" \ - " [-s SRC_IP] [-t TOS] [-w WAIT_SEC] [-g GATEWAY] [-i IFACE]\n" \ - " [-z PAUSE_MSEC] HOST [BYTES]" -#define traceroute_full_usage "\n\n" \ - "Trace the route to HOST\n" \ - "\nOptions:" \ - IF_TRACEROUTE6( \ - "\n -4,-6 Force IP or IPv6 name resolution" \ - ) \ - "\n -F Set the don't fragment bit" \ - "\n -I Use ICMP ECHO instead of UDP datagrams" \ - "\n -l Display the TTL value of the returned packet" \ - "\n -d Set SO_DEBUG options to socket" \ - "\n -n Print numeric addresses" \ - "\n -r Bypass routing tables, send directly to HOST" \ - "\n -v Verbose" \ - "\n -m Max time-to-live (max number of hops)" \ - "\n -p Base UDP port number used in probes" \ - "\n (default 33434)" \ - "\n -q Number of probes per TTL (default 3)" \ - "\n -s IP address to use as the source address" \ - "\n -t Type-of-service in probe packets (default 0)" \ - "\n -w Time in seconds to wait for a response (default 3)" \ - "\n -g Loose source route gateway (8 max)" \ - -#define traceroute6_trivial_usage \ - "[-dnrv] [-m MAXTTL] [-p PORT] [-q PROBES]\n" \ - " [-s SRC_IP] [-t TOS] [-w WAIT_SEC] [-i IFACE]\n" \ - " HOST [BYTES]" -#define traceroute6_full_usage "\n\n" \ - "Trace the route to HOST\n" \ - "\nOptions:" \ - "\n -d Set SO_DEBUG options to socket" \ - "\n -n Print numeric addresses" \ - "\n -r Bypass routing tables, send directly to HOST" \ - "\n -v Verbose" \ - "\n -m Max time-to-live (max number of hops)" \ - "\n -p Base UDP port number used in probes" \ - "\n (default is 33434)" \ - "\n -q Number of probes per TTL (default 3)" \ - "\n -s IP address to use as the source address" \ - "\n -t Type-of-service in probe packets (default 0)" \ - "\n -w Time in seconds to wait for a response (default 3)" \ - -#define ttysize_trivial_usage \ - "[w] [h]" -#define ttysize_full_usage "\n\n" \ - "Print dimension(s) of stdin's terminal, on error return 80x25" - -#define tunctl_trivial_usage \ - "[-f device] ([-t name] | -d name)" IF_FEATURE_TUNCTL_UG(" [-u owner] [-g group] [-b]") -#define tunctl_full_usage "\n\n" \ - "Create or delete tun interfaces\n" \ - "\nOptions:" \ - "\n -f name tun device (/dev/net/tun)" \ - "\n -t name Create iface 'name'" \ - "\n -d name Delete iface 'name'" \ - IF_FEATURE_TUNCTL_UG( \ - "\n -u owner Set iface owner" \ - "\n -g group Set iface group" \ - "\n -b Brief output" \ - ) -#define tunctl_example_usage \ - "# tunctl\n" \ - "# tunctl -d tun0\n" - -#define udhcpd_trivial_usage \ - "[-fS]" IF_FEATURE_UDHCP_PORT(" [-P N]") " [CONFFILE]" \ - -#define udhcpd_full_usage "\n\n" \ - "DHCP server\n" \ - "\n -f Run in foreground" \ - "\n -S Log to syslog too" \ - IF_FEATURE_UDHCP_PORT( \ - "\n -P N Use port N (default 67)" \ - ) - -#define umount_trivial_usage \ - "[OPTIONS] FILESYSTEM|DIRECTORY" -#define umount_full_usage "\n\n" \ - "Unmount file systems\n" \ - "\nOptions:" \ - IF_FEATURE_UMOUNT_ALL( \ - "\n -a Unmount all file systems" IF_FEATURE_MTAB_SUPPORT(" in /etc/mtab") \ - ) \ - IF_FEATURE_MTAB_SUPPORT( \ - "\n -n Don't erase /etc/mtab entries" \ - ) \ - "\n -r Try to remount devices as read-only if mount is busy" \ - "\n -l Lazy umount (detach filesystem)" \ - "\n -f Force umount (i.e., unreachable NFS server)" \ - IF_FEATURE_MOUNT_LOOP( \ - "\n -d Free loop device if it has been used" \ - ) - -#define umount_example_usage \ - "$ umount /dev/hdc1\n" - -#define uptime_trivial_usage \ - "" -#define uptime_full_usage "\n\n" \ - "Display the time since the last boot" - -#define uptime_example_usage \ - "$ uptime\n" \ - " 1:55pm up 2:30, load average: 0.09, 0.04, 0.00\n" - -#define vconfig_trivial_usage \ - "COMMAND [OPTIONS]" -#define vconfig_full_usage "\n\n" \ - "Create and remove virtual ethernet devices\n" \ - "\nOptions:" \ - "\n add [interface-name] [vlan_id]" \ - "\n rem [vlan-name]" \ - "\n set_flag [interface-name] [flag-num] [0 | 1]" \ - "\n set_egress_map [vlan-name] [skb_priority] [vlan_qos]" \ - "\n set_ingress_map [vlan-name] [skb_priority] [vlan_qos]" \ - "\n set_name_type [name-type]" \ - -#define volname_trivial_usage \ - "[DEVICE]" -#define volname_full_usage "\n\n" \ - "Show CD volume name of the DEVICE (default /dev/cdrom)" - -#define wall_trivial_usage \ - "[FILE]" -#define wall_full_usage "\n\n" \ - "Write content of FILE or stdin to all logged-in users" -#define wall_sample_usage \ - "echo foo | wall\n" \ - "wall ./mymessage" - -#define watch_trivial_usage \ - "[-n SEC] [-t] PROG ARGS" -#define watch_full_usage "\n\n" \ - "Run PROG periodically\n" \ - "\nOptions:" \ - "\n -n Loop period in seconds (default 2)" \ - "\n -t Don't print header" \ - -#define watch_example_usage \ - "$ watch date\n" \ - "Mon Dec 17 10:31:40 GMT 2000\n" \ - "Mon Dec 17 10:31:42 GMT 2000\n" \ - "Mon Dec 17 10:31:44 GMT 2000" - -#define watchdog_trivial_usage \ - "[-t N[ms]] [-T N[ms]] [-F] DEV" -#define watchdog_full_usage "\n\n" \ - "Periodically write to watchdog device DEV\n" \ - "\nOptions:" \ - "\n -T N Reboot after N seconds if not reset (default 60)" \ - "\n -t N Reset every N seconds (default 30)" \ - "\n -F Run in foreground" \ - "\n" \ - "\nUse 500ms to specify period in milliseconds" \ - -#define zcip_trivial_usage \ - "[OPTIONS] IFACE SCRIPT" -#define zcip_full_usage "\n\n" \ - "Manage a ZeroConf IPv4 link-local address\n" \ - "\nOptions:" \ - "\n -f Run in foreground" \ - "\n -q Quit after obtaining address" \ - "\n -r 169.254.x.x Request this address first" \ - "\n -v Verbose" \ - "\n" \ - "\nWith no -q, runs continuously monitoring for ARP conflicts," \ - "\nexits only on I/O errors (link down etc)" \ - - #endif diff --git a/libbb/parse_config.c b/libbb/parse_config.c index d471edbee..4b0236028 100644 --- a/libbb/parse_config.c +++ b/libbb/parse_config.c @@ -8,6 +8,12 @@ * Also for use in uClibc (http://uclibc.org/) licensed under LGPLv2.1 or later. */ +/* +//usage:#define parse_trivial_usage +//usage: "[-n MAXTOKENS] [-m MINTOKENS] [-d DELIMS] [-f FLAGS] FILE..." +//usage:#define parse_full_usage "" +*/ + #include "libbb.h" #if defined ENABLE_PARSE && ENABLE_PARSE diff --git a/miscutils/adjtimex.c b/miscutils/adjtimex.c index 8e8ff8c0a..e1edbbebc 100644 --- a/miscutils/adjtimex.c +++ b/miscutils/adjtimex.c @@ -11,6 +11,18 @@ * Licensed under GPLv2 or later, see file LICENSE in this source tree. */ +//usage:#define adjtimex_trivial_usage +//usage: "[-q] [-o OFF] [-f FREQ] [-p TCONST] [-t TICK]" +//usage:#define adjtimex_full_usage "\n\n" +//usage: "Read and optionally set system timebase parameters. See adjtimex(2)\n" +//usage: "\nOptions:" +//usage: "\n -q Quiet" +//usage: "\n -o OFF Time offset, microseconds" +//usage: "\n -f FREQ Frequency adjust, integer kernel units (65536 is 1ppm)" +//usage: "\n (positive values make clock run faster)" +//usage: "\n -t TICK Microseconds per tick, usually 10000" +//usage: "\n -p TCONST" + #include "libbb.h" #include <sys/timex.h> diff --git a/miscutils/bbconfig.c b/miscutils/bbconfig.c index 7c30669a3..e8be81352 100644 --- a/miscutils/bbconfig.c +++ b/miscutils/bbconfig.c @@ -1,6 +1,12 @@ /* vi: set sw=4 ts=4: */ /* This file was released into the public domain by Paul Fox. */ + +//usage:#define bbconfig_trivial_usage +//usage: "" +//usage:#define bbconfig_full_usage "\n\n" +//usage: "Print the config file used by busybox build" + #include "libbb.h" #include "bbconfigopts.h" #if ENABLE_FEATURE_COMPRESS_BBCONFIG diff --git a/miscutils/beep.c b/miscutils/beep.c index 013a72543..c7699ffe1 100644 --- a/miscutils/beep.c +++ b/miscutils/beep.c @@ -7,6 +7,17 @@ * Licensed under GPLv2 or later, see file LICENSE in this source tree. * */ + +//usage:#define beep_trivial_usage +//usage: "-f FREQ -l LEN -d DELAY -r COUNT -n" +//usage:#define beep_full_usage "\n\n" +//usage: "Options:" +//usage: "\n -f Frequency in Hz" +//usage: "\n -l Length in ms" +//usage: "\n -d Delay in ms" +//usage: "\n -r Repetitions" +//usage: "\n -n Start new tone" + #include "libbb.h" #include <linux/kd.h> diff --git a/miscutils/chat.c b/miscutils/chat.c index d8370a963..ce994f870 100644 --- a/miscutils/chat.c +++ b/miscutils/chat.c @@ -7,6 +7,15 @@ * * Licensed under GPLv2, see file LICENSE in this source tree. */ + +//usage:#define chat_trivial_usage +//usage: "EXPECT [SEND [EXPECT [SEND...]]]" +//usage:#define chat_full_usage "\n\n" +//usage: "Useful for interacting with a modem connected to stdin/stdout.\n" +//usage: "A script consists of one or more \"expect-send\" pairs of strings,\n" +//usage: "each pair is a pair of arguments. Example:\n" +//usage: "chat '' ATZ OK ATD123456 CONNECT '' ogin: pppuser word: ppppass '~'" + #include "libbb.h" // default timeout: 45 sec diff --git a/miscutils/chrt.c b/miscutils/chrt.c index 1c6737a3c..7e40b9f13 100644 --- a/miscutils/chrt.c +++ b/miscutils/chrt.c @@ -5,6 +5,23 @@ * * Licensed under GPLv2 or later, see file LICENSE in this source tree. */ + +//usage:#define chrt_trivial_usage +//usage: "[-prfom] [PRIO] [PID | PROG ARGS]" +//usage:#define chrt_full_usage "\n\n" +//usage: "Change scheduling priority and class for a process\n" +//usage: "\nOptions:" +//usage: "\n -p Operate on PID" +//usage: "\n -r Set SCHED_RR class" +//usage: "\n -f Set SCHED_FIFO class" +//usage: "\n -o Set SCHED_OTHER class" +//usage: "\n -m Show min/max priorities" +//usage: +//usage:#define chrt_example_usage +//usage: "$ chrt -r 4 sleep 900; x=$!\n" +//usage: "$ chrt -f -p 3 $x\n" +//usage: "You need CAP_SYS_NICE privileges to set scheduling attributes of a process" + #include <sched.h> #include "libbb.h" #ifndef _POSIX_PRIORITY_SCHEDULING diff --git a/miscutils/crond.c b/miscutils/crond.c index 5bf053609..014016fb6 100644 --- a/miscutils/crond.c +++ b/miscutils/crond.c @@ -11,6 +11,19 @@ * Licensed under GPLv2 or later, see file LICENSE in this source tree. */ +//usage:#define crond_trivial_usage +//usage: "-fbS -l N " IF_FEATURE_CROND_D("-d N ") "-L LOGFILE -c DIR" +//usage:#define crond_full_usage "\n\n" +//usage: " -f Foreground" +//usage: "\n -b Background (default)" +//usage: "\n -S Log to syslog (default)" +//usage: "\n -l Set log level. 0 is the most verbose, default 8" +//usage: IF_FEATURE_CROND_D( +//usage: "\n -d Set log level, log to stderr" +//usage: ) +//usage: "\n -L Log to file" +//usage: "\n -c Working dir" + #include "libbb.h" #include <syslog.h> diff --git a/miscutils/crontab.c b/miscutils/crontab.c index 16d7fdf69..4731d8da6 100644 --- a/miscutils/crontab.c +++ b/miscutils/crontab.c @@ -10,6 +10,16 @@ * Licensed under GPLv2 or later, see file LICENSE in this source tree. */ +//usage:#define crontab_trivial_usage +//usage: "[-c DIR] [-u USER] [-ler]|[FILE]" +//usage:#define crontab_full_usage "\n\n" +//usage: " -c Crontab directory" +//usage: "\n -u User" +//usage: "\n -l List crontab" +//usage: "\n -e Edit crontab" +//usage: "\n -r Delete crontab" +//usage: "\n FILE Replace crontab by FILE ('-': stdin)" + #include "libbb.h" #define CRONTABS CONFIG_FEATURE_CROND_DIR "/crontabs" diff --git a/miscutils/devfsd.c b/miscutils/devfsd.c index 35e431951..706276015 100644 --- a/miscutils/devfsd.c +++ b/miscutils/devfsd.c @@ -53,6 +53,22 @@ The postal address is: Richard Gooch, c/o ATNF, P. O. Box 76, Epping, N.S.W., 2121, Australia. */ + +//usage:#define devfsd_trivial_usage +//usage: "mntpnt [-v]" IF_DEVFSD_FG_NP("[-fg][-np]") +//usage:#define devfsd_full_usage "\n\n" +//usage: "Manage devfs permissions and old device name symlinks\n" +//usage: "\nOptions:" +//usage: "\n mntpnt The mount point where devfs is mounted" +//usage: "\n -v Print the protocol version numbers for devfsd" +//usage: "\n and the kernel-side protocol version and exit" +//usage: IF_DEVFSD_FG_NP( +//usage: "\n -fg Run in foreground" +//usage: "\n -np Exit after parsing the configuration file" +//usage: "\n and processing synthetic REGISTER events," +//usage: "\n don't poll for events" +//usage: ) + #include "libbb.h" #include "xregex.h" #include <syslog.h> diff --git a/miscutils/devmem.c b/miscutils/devmem.c index 7a9f533af..786a21bee 100644 --- a/miscutils/devmem.c +++ b/miscutils/devmem.c @@ -4,6 +4,14 @@ * Copyright (C) 2008, BusyBox Team. -solar 4/26/08 */ +//usage:#define devmem_trivial_usage +//usage: "ADDRESS [WIDTH [VALUE]]" +//usage:#define devmem_full_usage "\n\n" +//usage: "Read/write from physical address\n" +//usage: "\n ADDRESS Address to act upon" +//usage: "\n WIDTH Width (8/16/...)" +//usage: "\n VALUE Data to be written" + #include "libbb.h" int devmem_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE; diff --git a/miscutils/eject.c b/miscutils/eject.c index 63d20d3ad..184ccc5d7 100644 --- a/miscutils/eject.c +++ b/miscutils/eject.c @@ -13,6 +13,17 @@ * Most of the dirty work blatantly ripped off from cat.c =) */ +//usage:#define eject_trivial_usage +//usage: "[-t] [-T] [DEVICE]" +//usage:#define eject_full_usage "\n\n" +//usage: "Eject DEVICE or default /dev/cdrom\n" +//usage: "\nOptions:" +//usage: IF_FEATURE_EJECT_SCSI( +//usage: "\n -s SCSI device" +//usage: ) +//usage: "\n -t Close tray" +//usage: "\n -T Open/close tray (toggle)" + #include <sys/mount.h> #include "libbb.h" /* Must be after libbb.h: they need size_t */ diff --git a/miscutils/fbsplash.c b/miscutils/fbsplash.c index 770e70026..c761a88ca 100644 --- a/miscutils/fbsplash.c +++ b/miscutils/fbsplash.c @@ -21,6 +21,19 @@ * "exit" (or just close fifo) - well you guessed it. */ +//usage:#define fbsplash_trivial_usage +//usage: "-s IMGFILE [-c] [-d DEV] [-i INIFILE] [-f CMD]" +//usage:#define fbsplash_full_usage "\n\n" +//usage: "Options:" +//usage: "\n -s Image" +//usage: "\n -c Hide cursor" +//usage: "\n -d Framebuffer device (default /dev/fb0)" +//usage: "\n -i Config file (var=value):" +//usage: "\n BAR_LEFT,BAR_TOP,BAR_WIDTH,BAR_HEIGHT" +//usage: "\n BAR_R,BAR_G,BAR_B" +//usage: "\n -f Control pipe (else exit after drawing image)" +//usage: "\n commands: 'NN' (% for progress bar) or 'exit'" + #include "libbb.h" #include <linux/fb.h> diff --git a/miscutils/flash_eraseall.c b/miscutils/flash_eraseall.c index 68596e11b..33803f87d 100644 --- a/miscutils/flash_eraseall.c +++ b/miscutils/flash_eraseall.c @@ -10,6 +10,14 @@ * Licensed under GPLv2 or later, see file LICENSE in this source tree. */ +//usage:#define flash_eraseall_trivial_usage +//usage: "[-jq] MTD_DEVICE" +//usage:#define flash_eraseall_full_usage "\n\n" +//usage: "Erase an MTD device\n" +//usage: "\nOptions:" +//usage: "\n -j Format the device for jffs2" +//usage: "\n -q Don't display progress messages" + #include "libbb.h" #include <mtd/mtd-user.h> #include <linux/jffs2.h> diff --git a/miscutils/flash_lock_unlock.c b/miscutils/flash_lock_unlock.c index fcb836b07..1fefd95f9 100644 --- a/miscutils/flash_lock_unlock.c +++ b/miscutils/flash_lock_unlock.c @@ -3,6 +3,18 @@ * * Licensed under GPLv2, see file LICENSE in this source tree. */ + +//usage:#define flash_lock_trivial_usage +//usage: "MTD_DEVICE OFFSET SECTORS" +//usage:#define flash_lock_full_usage "\n\n" +//usage: "Lock part or all of an MTD device. If SECTORS is -1, then all sectors\n" +//usage: "will be locked, regardless of the value of OFFSET" +//usage: +//usage:#define flash_unlock_trivial_usage +//usage: "MTD_DEVICE" +//usage:#define flash_unlock_full_usage "\n\n" +//usage: "Unlock an MTD device" + #include "libbb.h" #include <mtd/mtd-user.h> diff --git a/miscutils/flashcp.c b/miscutils/flashcp.c index fe37c3913..e4bb3a902 100644 --- a/miscutils/flashcp.c +++ b/miscutils/flashcp.c @@ -7,6 +7,13 @@ * Licensed under GPLv2, see file LICENSE in this source tree. */ +//usage:#define flashcp_trivial_usage +//usage: "-v FILE MTD_DEVICE" +//usage:#define flashcp_full_usage "\n\n" +//usage: "Copy an image to MTD device\n" +//usage: "\nOptions:" +//usage: "\n -v Verbose" + #include "libbb.h" #include <mtd/mtd-user.h> diff --git a/miscutils/hdparm.c b/miscutils/hdparm.c index 38b265d60..7608408dd 100644 --- a/miscutils/hdparm.c +++ b/miscutils/hdparm.c @@ -11,6 +11,58 @@ * hdparm.c - Command line interface to get/set hard disk parameters * - by Mark Lord (C) 1994-2002 -- freely distributable */ + +//usage:#define hdparm_trivial_usage +//usage: "[OPTIONS] [DEVICE]" +//usage:#define hdparm_full_usage "\n\n" +//usage: "Options:" +//usage: "\n -a Get/set fs readahead" +//usage: "\n -A Set drive read-lookahead flag (0/1)" +//usage: "\n -b Get/set bus state (0 == off, 1 == on, 2 == tristate)" +//usage: "\n -B Set Advanced Power Management setting (1-255)" +//usage: "\n -c Get/set IDE 32-bit IO setting" +//usage: "\n -C Check IDE power mode status" +//usage: IF_FEATURE_HDPARM_HDIO_GETSET_DMA( +//usage: "\n -d Get/set using_dma flag") +//usage: "\n -D Enable/disable drive defect-mgmt" +//usage: "\n -f Flush buffer cache for device on exit" +//usage: "\n -g Display drive geometry" +//usage: "\n -h Display terse usage information" +//usage: IF_FEATURE_HDPARM_GET_IDENTITY( +//usage: "\n -i Display drive identification") +//usage: IF_FEATURE_HDPARM_GET_IDENTITY( +//usage: "\n -I Detailed/current information directly from drive") +//usage: "\n -k Get/set keep_settings_over_reset flag (0/1)" +//usage: "\n -K Set drive keep_features_over_reset flag (0/1)" +//usage: "\n -L Set drive doorlock (0/1) (removable harddisks only)" +//usage: "\n -m Get/set multiple sector count" +//usage: "\n -n Get/set ignore-write-errors flag (0/1)" +//usage: "\n -p Set PIO mode on IDE interface chipset (0,1,2,3,4,...)" +//usage: "\n -P Set drive prefetch count" +/* //usage: "\n -q Change next setting quietly" - not supported ib bbox */ +//usage: "\n -Q Get/set DMA tagged-queuing depth (if supported)" +//usage: "\n -r Get/set readonly flag (DANGEROUS to set)" +//usage: IF_FEATURE_HDPARM_HDIO_SCAN_HWIF( +//usage: "\n -R Register an IDE interface (DANGEROUS)") +//usage: "\n -S Set standby (spindown) timeout" +//usage: "\n -t Perform device read timings" +//usage: "\n -T Perform cache read timings" +//usage: "\n -u Get/set unmaskirq flag (0/1)" +//usage: IF_FEATURE_HDPARM_HDIO_UNREGISTER_HWIF( +//usage: "\n -U Unregister an IDE interface (DANGEROUS)") +//usage: "\n -v Defaults; same as -mcudkrag for IDE drives" +//usage: "\n -V Display program version and exit immediately" +//usage: IF_FEATURE_HDPARM_HDIO_DRIVE_RESET( +//usage: "\n -w Perform device reset (DANGEROUS)") +//usage: "\n -W Set drive write-caching flag (0/1) (DANGEROUS)" +//usage: IF_FEATURE_HDPARM_HDIO_TRISTATE_HWIF( +//usage: "\n -x Tristate device for hotswap (0/1) (DANGEROUS)") +//usage: "\n -X Set IDE xfer mode (DANGEROUS)" +//usage: "\n -y Put IDE drive in standby mode" +//usage: "\n -Y Put IDE drive to sleep" +//usage: "\n -Z Disable Seagate auto-powersaving mode" +//usage: "\n -z Reread partition table" + #include "libbb.h" /* must be _after_ libbb.h: */ #include <linux/hdreg.h> diff --git a/miscutils/inotifyd.c b/miscutils/inotifyd.c index fe429b636..b64e0abb9 100644 --- a/miscutils/inotifyd.c +++ b/miscutils/inotifyd.c @@ -27,6 +27,33 @@ * See below for mask names explanation. */ +//usage:#define inotifyd_trivial_usage +//usage: "PROG FILE1[:MASK]..." +//usage:#define inotifyd_full_usage "\n\n" +//usage: "Run PROG on filesystem changes." +//usage: "\nWhen a filesystem event matching MASK occurs on FILEn," +//usage: "\nPROG ACTUAL_EVENTS FILEn [SUBFILE] is run." +//usage: "\nEvents:" +//usage: "\n a File is accessed" +//usage: "\n c File is modified" +//usage: "\n e Metadata changed" +//usage: "\n w Writable file is closed" +//usage: "\n 0 Unwritable file is closed" +//usage: "\n r File is opened" +//usage: "\n D File is deleted" +//usage: "\n M File is moved" +//usage: "\n u Backing fs is unmounted" +//usage: "\n o Event queue overflowed" +//usage: "\n x File can't be watched anymore" +//usage: "\nIf watching a directory:" +//usage: "\n m Subfile is moved into dir" +//usage: "\n y Subfile is moved out of dir" +//usage: "\n n Subfile is created" +//usage: "\n d Subfile is deleted" +//usage: "\n" +//usage: "\ninotifyd waits for PROG to exit." +//usage: "\nWhen x event happens for all FILEs, inotifyd exits." + #include "libbb.h" #include <sys/inotify.h> diff --git a/miscutils/ionice.c b/miscutils/ionice.c index 481a738ee..2bc83c5eb 100644 --- a/miscutils/ionice.c +++ b/miscutils/ionice.c @@ -7,6 +7,14 @@ * Licensed under GPLv2 or later, see file LICENSE in this source tree. */ +//usage:#define ionice_trivial_usage +//usage: "[-c 1-3] [-n 0-7] [-p PID] [PROG]" +//usage:#define ionice_full_usage "\n\n" +//usage: "Change I/O priority and class\n" +//usage: "\nOptions:" +//usage: "\n -c Class. 1:realtime 2:best-effort 3:idle" +//usage: "\n -n Priority" + #include <sys/syscall.h> #include <asm/unistd.h> #include "libbb.h" diff --git a/miscutils/last.c b/miscutils/last.c index 12457b157..27f5a35ce 100644 --- a/miscutils/last.c +++ b/miscutils/last.c @@ -7,6 +7,17 @@ * Licensed under GPLv2, see file LICENSE in this source tree. */ +//usage:#define last_trivial_usage +//usage: ""IF_FEATURE_LAST_FANCY("[-HW] [-f FILE]") +//usage:#define last_full_usage "\n\n" +//usage: "Show listing of the last users that logged into the system" +//usage: IF_FEATURE_LAST_FANCY( "\n" +//usage: "\nOptions:" +/* //usage: "\n -H Show header line" */ +//usage: "\n -W Display with no host column truncation" +//usage: "\n -f FILE Read from FILE instead of /var/log/wtmp" +//usage: ) + #include "libbb.h" /* NB: ut_name and ut_user are the same field, use only one name (ut_user) diff --git a/miscutils/less.c b/miscutils/less.c index 9e12c11a7..77fd5a8de 100644 --- a/miscutils/less.c +++ b/miscutils/less.c @@ -21,6 +21,18 @@ * redirected input has been read from stdin */ +//usage:#define less_trivial_usage +//usage: "[-EMNmh~I?] [FILE]..." +//usage:#define less_full_usage "\n\n" +//usage: "View FILE (or stdin) one screenful at a time\n" +//usage: "\nOptions:" +//usage: "\n -E Quit once the end of a file is reached" +//usage: "\n -M,-m Display status line with line numbers" +//usage: "\n and percentage through the file" +//usage: "\n -N Prefix line number to each line" +//usage: "\n -I Ignore case in all searches" +//usage: "\n -~ Suppress ~s displayed past the end of the file" + #include <sched.h> /* sched_yield() */ #include "libbb.h" diff --git a/miscutils/makedevs.c b/miscutils/makedevs.c index e74c47c35..8cca83882 100644 --- a/miscutils/makedevs.c +++ b/miscutils/makedevs.c @@ -7,6 +7,66 @@ * known bugs: can't deal with alpha ranges */ +//usage:#if ENABLE_FEATURE_MAKEDEVS_LEAF +//usage:#define makedevs_trivial_usage +//usage: "NAME TYPE MAJOR MINOR FIRST LAST [s]" +//usage:#define makedevs_full_usage "\n\n" +//usage: "Create a range of block or character special files" +//usage: "\n" +//usage: "\nTYPE is:" +//usage: "\n b Block device" +//usage: "\n c Character device" +//usage: "\n f FIFO, MAJOR and MINOR are ignored" +//usage: "\n" +//usage: "\nFIRST..LAST specify numbers appended to NAME." +//usage: "\nIf 's' is the last argument, the base device is created as well." +//usage: "\n" +//usage: "\nExamples:" +//usage: "\n makedevs /dev/ttyS c 4 66 2 63 -> ttyS2-ttyS63" +//usage: "\n makedevs /dev/hda b 3 0 0 8 s -> hda,hda1-hda8" +//usage: +//usage:#define makedevs_example_usage +//usage: "# makedevs /dev/ttyS c 4 66 2 63\n" +//usage: "[creates ttyS2-ttyS63]\n" +//usage: "# makedevs /dev/hda b 3 0 0 8 s\n" +//usage: "[creates hda,hda1-hda8]\n" +//usage:#endif +//usage: +//usage:#if ENABLE_FEATURE_MAKEDEVS_TABLE +//usage:#define makedevs_trivial_usage +//usage: "[-d device_table] rootdir" +//usage:#define makedevs_full_usage "\n\n" +//usage: "Create a range of special files as specified in a device table.\n" +//usage: "Device table entries take the form of:\n" +//usage: "<type> <mode> <uid> <gid> <major> <minor> <start> <inc> <count>\n" +//usage: "Where name is the file name, type can be one of:\n" +//usage: " f Regular file\n" +//usage: " d Directory\n" +//usage: " c Character device\n" +//usage: " b Block device\n" +//usage: " p Fifo (named pipe)\n" +//usage: "uid is the user id for the target file, gid is the group id for the\n" +//usage: "target file. The rest of the entries (major, minor, etc) apply to\n" +//usage: "to device special files. A '-' may be used for blank entries." +//usage: +//usage:#define makedevs_example_usage +//usage: "For example:\n" +//usage: "<name> <type> <mode><uid><gid><major><minor><start><inc><count>\n" +//usage: "/dev d 755 0 0 - - - - -\n" +//usage: "/dev/console c 666 0 0 5 1 - - -\n" +//usage: "/dev/null c 666 0 0 1 3 0 0 -\n" +//usage: "/dev/zero c 666 0 0 1 5 0 0 -\n" +//usage: "/dev/hda b 640 0 0 3 0 0 0 -\n" +//usage: "/dev/hda b 640 0 0 3 1 1 1 15\n\n" +//usage: "Will Produce:\n" +//usage: "/dev\n" +//usage: "/dev/console\n" +//usage: "/dev/null\n" +//usage: "/dev/zero\n" +//usage: "/dev/hda\n" +//usage: "/dev/hda[0-15]\n" +//usage:#endif + #include "libbb.h" #if ENABLE_FEATURE_MAKEDEVS_LEAF diff --git a/miscutils/man.c b/miscutils/man.c index b356e726f..2c6b25ceb 100644 --- a/miscutils/man.c +++ b/miscutils/man.c @@ -3,6 +3,14 @@ * Licensed under GPLv2, see file LICENSE in this source tree. */ +//usage:#define man_trivial_usage +//usage: "[-aw] [MANPAGE]..." +//usage:#define man_full_usage "\n\n" +//usage: "Format and display manual page\n" +//usage: "\nOptions:" +//usage: "\n -a Display all pages" +//usage: "\n -w Show page locations" + #include "libbb.h" enum { diff --git a/miscutils/microcom.c b/miscutils/microcom.c index 3acbe3023..edaeb6fa5 100644 --- a/miscutils/microcom.c +++ b/miscutils/microcom.c @@ -7,6 +7,18 @@ * * Licensed under GPLv2, see file LICENSE in this source tree. */ + +//usage:#define microcom_trivial_usage +//usage: "[-d DELAY] [-t TIMEOUT] [-s SPEED] [-X] TTY" +//usage:#define microcom_full_usage "\n\n" +//usage: "Copy bytes for stdin to TTY and from TTY to stdout\n" +//usage: "\nOptions:" +//usage: "\n -d Wait up to DELAY ms for TTY output before sending every" +//usage: "\n next byte to it" +//usage: "\n -t Exit if both stdin and TTY are silent for TIMEOUT ms" +//usage: "\n -s Set serial line to SPEED" +//usage: "\n -X Disable special meaning of NUL and Ctrl-X from stdin" + #include "libbb.h" // set raw tty mode diff --git a/miscutils/mountpoint.c b/miscutils/mountpoint.c index 784c3cbfc..a1a5b396a 100644 --- a/miscutils/mountpoint.c +++ b/miscutils/mountpoint.c @@ -9,6 +9,22 @@ * Based on sysvinit's mountpoint */ +//usage:#define mountpoint_trivial_usage +//usage: "[-q] <[-dn] DIR | -x DEVICE>" +//usage:#define mountpoint_full_usage "\n\n" +//usage: "Check if the directory is a mountpoint\n" +//usage: "\nOptions:" +//usage: "\n -q Quiet" +//usage: "\n -d Print major/minor device number of the filesystem" +//usage: "\n -n Print device name of the filesystem" +//usage: "\n -x Print major/minor device number of the blockdevice" +//usage: +//usage:#define mountpoint_example_usage +//usage: "$ mountpoint /proc\n" +//usage: "/proc is not a mountpoint\n" +//usage: "$ mountpoint /sys\n" +//usage: "/sys is a mountpoint\n" + #include "libbb.h" int mountpoint_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE; diff --git a/miscutils/mt.c b/miscutils/mt.c index 142901bb0..20afd3a50 100644 --- a/miscutils/mt.c +++ b/miscutils/mt.c @@ -3,6 +3,18 @@ * Licensed under GPLv2 or later, see file LICENSE in this source tree. */ +//usage:#define mt_trivial_usage +//usage: "[-f device] opcode value" +//usage:#define mt_full_usage "\n\n" +//usage: "Control magnetic tape drive operation\n" +//usage: "\n" +//usage: "Available Opcodes:\n" +//usage: "\n" +//usage: "bsf bsfm bsr bss datacompression drvbuffer eof eom erase\n" +//usage: "fsf fsfm fsr fss load lock mkpart nop offline ras1 ras2\n" +//usage: "ras3 reset retension rewind rewoffline seek setblk setdensity\n" +//usage: "setpart tell unload unlock weof wset" + #include "libbb.h" #include <sys/mtio.h> diff --git a/miscutils/raidautorun.c b/miscutils/raidautorun.c index bbfa8577c..b72d89058 100644 --- a/miscutils/raidautorun.c +++ b/miscutils/raidautorun.c @@ -8,6 +8,14 @@ * */ +//usage:#define raidautorun_trivial_usage +//usage: "DEVICE" +//usage:#define raidautorun_full_usage "\n\n" +//usage: "Tell the kernel to automatically search and start RAID arrays" +//usage: +//usage:#define raidautorun_example_usage +//usage: "$ raidautorun /dev/md0" + #include "libbb.h" #include <linux/major.h> diff --git a/miscutils/readahead.c b/miscutils/readahead.c index dd6de7c45..e22aaa468 100644 --- a/miscutils/readahead.c +++ b/miscutils/readahead.c @@ -10,6 +10,11 @@ * Licensed under GPLv2 or later, see file LICENSE in this source tree. */ +//usage:#define readahead_trivial_usage +//usage: "[FILE]..." +//usage:#define readahead_full_usage "\n\n" +//usage: "Preload FILEs to RAM" + #include "libbb.h" int readahead_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE; diff --git a/miscutils/rfkill.c b/miscutils/rfkill.c index b150b2cae..467197371 100644 --- a/miscutils/rfkill.c +++ b/miscutils/rfkill.c @@ -6,6 +6,19 @@ * * Licensed under GPLv2 or later, see file LICENSE in this source tree. */ + +//usage:#define rfkill_trivial_usage +//usage: "COMMAND [INDEX|TYPE]" +//usage:#define rfkill_full_usage "\n\n" +//usage: "Enable/disable wireless devices\n" +//usage: "\nCommands:" +//usage: "\n list [INDEX|TYPE] List current state" +//usage: "\n block INDEX|TYPE Disable device" +//usage: "\n unblock INDEX|TYPE Enable device" +//usage: "\n" +//usage: "\n TYPE: all, wlan(wifi), bluetooth, uwb(ultrawideband)," +//usage: "\n wimax, wwan, gps, fm" + #include "libbb.h" #include <linux/rfkill.h> diff --git a/miscutils/runlevel.c b/miscutils/runlevel.c index 7024361e7..9d38b791f 100644 --- a/miscutils/runlevel.c +++ b/miscutils/runlevel.c @@ -11,6 +11,19 @@ * * initially busyboxified by Bernhard Reutner-Fischer */ + +//usage:#define runlevel_trivial_usage +//usage: "[FILE]" +//usage:#define runlevel_full_usage "\n\n" +//usage: "Find the current and previous system runlevel\n" +//usage: "\n" +//usage: "If no utmp FILE exists or if no runlevel record can be found,\n" +//usage: "print \"unknown\"" +//usage: +//usage:#define runlevel_example_usage +//usage: "$ runlevel /var/run/utmp\n" +//usage: "N 2" + #include "libbb.h" int runlevel_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE; diff --git a/miscutils/rx.c b/miscutils/rx.c index de785d53c..e1225779e 100644 --- a/miscutils/rx.c +++ b/miscutils/rx.c @@ -15,6 +15,14 @@ * This was originally written for blob and then adapted for busybox. */ +//usage:#define rx_trivial_usage +//usage: "FILE" +//usage:#define rx_full_usage "\n\n" +//usage: "Receive a file using the xmodem protocol" +//usage: +//usage:#define rx_example_usage +//usage: "$ rx /tmp/foo\n" + #include "libbb.h" #define SOH 0x01 diff --git a/miscutils/setsid.c b/miscutils/setsid.c index c573fae34..ad2c8a4de 100644 --- a/miscutils/setsid.c +++ b/miscutils/setsid.c @@ -14,6 +14,13 @@ * - busyboxed */ +//usage:#define setsid_trivial_usage +//usage: "PROG ARGS" +//usage:#define setsid_full_usage "\n\n" +//usage: "Run PROG in a new session. PROG will have no controlling terminal\n" +//usage: "and will not be affected by keyboard signals (Ctrl-C etc).\n" +//usage: "See setsid(2) for details." + #include "libbb.h" int setsid_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE; diff --git a/miscutils/strings.c b/miscutils/strings.c index 7ab0e227c..6e8b9aefc 100644 --- a/miscutils/strings.c +++ b/miscutils/strings.c @@ -7,6 +7,16 @@ * Licensed under GPLv2 or later, see file LICENSE in this source tree. */ +//usage:#define strings_trivial_usage +//usage: "[-afo] [-n LEN] [FILE]..." +//usage:#define strings_full_usage "\n\n" +//usage: "Display printable strings in a binary file\n" +//usage: "\nOptions:" +//usage: "\n -a Scan whole file (default)" +//usage: "\n -f Precede strings with filenames" +//usage: "\n -n LEN At least LEN characters form a string (default 4)" +//usage: "\n -o Precede strings with decimal offsets" + #include "libbb.h" #define WHOLE_FILE 1 diff --git a/miscutils/taskset.c b/miscutils/taskset.c index 389ef43e4..77fc8643d 100644 --- a/miscutils/taskset.c +++ b/miscutils/taskset.c @@ -6,6 +6,24 @@ * Licensed under GPLv2 or later, see file LICENSE in this source tree. */ +//usage:#define taskset_trivial_usage +//usage: "[-p] [MASK] [PID | PROG ARGS]" +//usage:#define taskset_full_usage "\n\n" +//usage: "Set or get CPU affinity\n" +//usage: "\nOptions:" +//usage: "\n -p Operate on an existing PID" +//usage: +//usage:#define taskset_example_usage +//usage: "$ taskset 0x7 ./dgemm_test&\n" +//usage: "$ taskset -p 0x1 $!\n" +//usage: "pid 4790's current affinity mask: 7\n" +//usage: "pid 4790's new affinity mask: 1\n" +//usage: "$ taskset 0x7 /bin/sh -c './taskset -p 0x1 $$'\n" +//usage: "pid 6671's current affinity mask: 1\n" +//usage: "pid 6671's new affinity mask: 1\n" +//usage: "$ taskset -p 1\n" +//usage: "pid 1's current affinity mask: 3\n" + #include <sched.h> #include "libbb.h" diff --git a/miscutils/time.c b/miscutils/time.c index 6b1c3c42c..dcd89f8fc 100644 --- a/miscutils/time.c +++ b/miscutils/time.c @@ -9,6 +9,13 @@ Heavily modified for busybox by Erik Andersen <andersen@codepoet.org> */ +//usage:#define time_trivial_usage +//usage: "[-v] PROG ARGS" +//usage:#define time_full_usage "\n\n" +//usage: "Run PROG, display resource usage when it exits\n" +//usage: "\nOptions:" +//usage: "\n -v Verbose" + #include "libbb.h" /* Information on the resources used by a child process. */ diff --git a/miscutils/timeout.c b/miscutils/timeout.c index 841669416..9d56593ba 100644 --- a/miscutils/timeout.c +++ b/miscutils/timeout.c @@ -28,6 +28,12 @@ * rewrite 14-11-2008 vda */ +//usage:#define timeout_trivial_usage +//usage: "[-t SECS] [-s SIG] PROG ARGS" +//usage:#define timeout_full_usage "\n\n" +//usage: "Runs PROG. Sends SIG to it if it is not gone in SECS seconds.\n" +//usage: "Defaults: SECS: 10, SIG: TERM." + #include "libbb.h" int timeout_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE; diff --git a/miscutils/ttysize.c b/miscutils/ttysize.c index f93a506a2..d2d48d0a9 100644 --- a/miscutils/ttysize.c +++ b/miscutils/ttysize.c @@ -9,6 +9,12 @@ * * Licensed under GPLv2, see file LICENSE in this source tree. */ + +//usage:#define ttysize_trivial_usage +//usage: "[w] [h]" +//usage:#define ttysize_full_usage "\n\n" +//usage: "Print dimension(s) of stdin's terminal, on error return 80x25" + #include "libbb.h" int ttysize_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE; diff --git a/miscutils/volname.c b/miscutils/volname.c index 6e8615617..b50e79573 100644 --- a/miscutils/volname.c +++ b/miscutils/volname.c @@ -27,6 +27,12 @@ * mods from distributed source (eject-2.0.13) are by * Matthew Stoltenberg <d3matt@gmail.com> */ + +//usage:#define volname_trivial_usage +//usage: "[DEVICE]" +//usage:#define volname_full_usage "\n\n" +//usage: "Show CD volume name of the DEVICE (default /dev/cdrom)" + #include "libbb.h" int volname_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE; diff --git a/miscutils/wall.c b/miscutils/wall.c index 0a2b89e5e..762f53b72 100644 --- a/miscutils/wall.c +++ b/miscutils/wall.c @@ -6,6 +6,15 @@ * Licensed under GPLv2 or later, see file LICENSE in this source tree. */ +//usage:#define wall_trivial_usage +//usage: "[FILE]" +//usage:#define wall_full_usage "\n\n" +//usage: "Write content of FILE or stdin to all logged-in users" +//usage: +//usage:#define wall_sample_usage +//usage: "echo foo | wall\n" +//usage: "wall ./mymessage" + #include "libbb.h" int wall_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE; diff --git a/miscutils/watchdog.c b/miscutils/watchdog.c index 630782660..b24dd4b82 100644 --- a/miscutils/watchdog.c +++ b/miscutils/watchdog.c @@ -9,6 +9,17 @@ * Licensed under GPLv2 or later, see file LICENSE in this source tree. */ +//usage:#define watchdog_trivial_usage +//usage: "[-t N[ms]] [-T N[ms]] [-F] DEV" +//usage:#define watchdog_full_usage "\n\n" +//usage: "Periodically write to watchdog device DEV\n" +//usage: "\nOptions:" +//usage: "\n -T N Reboot after N seconds if not reset (default 60)" +//usage: "\n -t N Reset every N seconds (default 30)" +//usage: "\n -F Run in foreground" +//usage: "\n" +//usage: "\nUse 500ms to specify period in milliseconds" + #include "libbb.h" #include "linux/types.h" /* for __u32 */ #include "linux/watchdog.h" diff --git a/networking/arp.c b/networking/arp.c index 0ef267a35..3f68f5cf7 100644 --- a/networking/arp.c +++ b/networking/arp.c @@ -13,6 +13,25 @@ * modified for getopt32 by Arne Bernin <arne [at] alamut.de> */ +//usage:#define arp_trivial_usage +//usage: "\n[-vn] [-H HWTYPE] [-i IF] -a [HOSTNAME]" +//usage: "\n[-v] [-i IF] -d HOSTNAME [pub]" +//usage: "\n[-v] [-H HWTYPE] [-i IF] -s HOSTNAME HWADDR [temp]" +//usage: "\n[-v] [-H HWTYPE] [-i IF] -s HOSTNAME HWADDR [netmask MASK] pub" +//usage: "\n[-v] [-H HWTYPE] [-i IF] -Ds HOSTNAME IFACE [netmask MASK] pub" +//usage:#define arp_full_usage "\n\n" +//usage: "Manipulate ARP cache\n" +//usage: "\nOptions:" +//usage: "\n -a Display (all) hosts" +//usage: "\n -s Set new ARP entry" +//usage: "\n -d Delete a specified entry" +//usage: "\n -v Verbose" +//usage: "\n -n Don't resolve names" +//usage: "\n -i IF Network interface" +//usage: "\n -D Read <hwaddr> from given device" +//usage: "\n -A,-p AF Protocol family" +//usage: "\n -H HWTYPE Hardware address type" + #include "libbb.h" #include "inet_common.h" diff --git a/networking/arping.c b/networking/arping.c index 6f6b59cfb..357dcaaf0 100644 --- a/networking/arping.c +++ b/networking/arping.c @@ -6,6 +6,23 @@ * Busybox port: Nick Fedchik <nick@fedchik.org.ua> */ +//usage:#define arping_trivial_usage +//usage: "[-fqbDUA] [-c CNT] [-w TIMEOUT] [-I IFACE] [-s SRC_IP] DST_IP" +//usage:#define arping_full_usage "\n\n" +//usage: "Send ARP requests/replies\n" +//usage: "\nOptions:" +//usage: "\n -f Quit on first ARP reply" +//usage: "\n -q Quiet" +//usage: "\n -b Keep broadcasting, don't go unicast" +//usage: "\n -D Duplicated address detection mode" +//usage: "\n -U Unsolicited ARP mode, update your neighbors" +//usage: "\n -A ARP answer mode, update your neighbors" +//usage: "\n -c N Stop after sending N ARP requests" +//usage: "\n -w TIMEOUT Time to wait for ARP reply, seconds" +//usage: "\n -I IFACE Interface to use (default eth0)" +//usage: "\n -s SRC_IP Sender IP address" +//usage: "\n DST_IP Target IP address" + #include <arpa/inet.h> #include <net/if.h> #include <netinet/ether.h> diff --git a/networking/brctl.c b/networking/brctl.c index c0b094eba..19f474fce 100644 --- a/networking/brctl.c +++ b/networking/brctl.c @@ -12,6 +12,30 @@ /* This applet currently uses only the ioctl interface and no sysfs at all. * At the time of this writing this was considered a feature. */ + +//usage:#define brctl_trivial_usage +//usage: "COMMAND [BRIDGE [INTERFACE]]" +//usage:#define brctl_full_usage "\n\n" +//usage: "Manage ethernet bridges\n" +//usage: "\nCommands:" +//usage: IF_FEATURE_BRCTL_SHOW( +//usage: "\n show Show a list of bridges" +//usage: ) +//usage: "\n addbr BRIDGE Create BRIDGE" +//usage: "\n delbr BRIDGE Delete BRIDGE" +//usage: "\n addif BRIDGE IFACE Add IFACE to BRIDGE" +//usage: "\n delif BRIDGE IFACE Delete IFACE from BRIDGE" +//usage: IF_FEATURE_BRCTL_FANCY( +//usage: "\n setageing BRIDGE TIME Set ageing time" +//usage: "\n setfd BRIDGE TIME Set bridge forward delay" +//usage: "\n sethello BRIDGE TIME Set hello time" +//usage: "\n setmaxage BRIDGE TIME Set max message age" +//usage: "\n setpathcost BRIDGE COST Set path cost" +//usage: "\n setportprio BRIDGE PRIO Set port priority" +//usage: "\n setbridgeprio BRIDGE PRIO Set bridge priority" +//usage: "\n stp BRIDGE [1/yes/on|0/no/off] STP on/off" +//usage: ) + #include "libbb.h" #include <linux/sockios.h> #include <net/if.h> diff --git a/networking/dnsd.c b/networking/dnsd.c index 8ed31cea2..65eae9670 100644 --- a/networking/dnsd.c +++ b/networking/dnsd.c @@ -17,6 +17,22 @@ * the first porting of oao' scdns to busybox also. */ +//usage:#define dnsd_trivial_usage +//usage: "[-dvs] [-c CONFFILE] [-t TTL_SEC] [-p PORT] [-i ADDR]" +//usage:#define dnsd_full_usage "\n\n" +//usage: "Small static DNS server daemon\n" +//usage: "\nOptions:" +//usage: "\n -c FILE Config file" +//usage: "\n -t SEC TTL" +//usage: "\n -p PORT Listen on PORT" +//usage: "\n -i ADDR Listen on ADDR" +//usage: "\n -d Daemonize" +//usage: "\n -v Verbose" +//usage: "\n -s Send successful replies only. Use this if you want" +//usage: "\n to use /etc/resolv.conf with two nameserver lines:" +//usage: "\n nameserver DNSD_SERVER" +//usage: "\n nameserver NORNAL_DNS_SERVER" + #include "libbb.h" #include <syslog.h> diff --git a/networking/ether-wake.c b/networking/ether-wake.c index 8f1479c02..7bb9aa5a7 100644 --- a/networking/ether-wake.c +++ b/networking/ether-wake.c @@ -64,6 +64,16 @@ * filter. That configuration consumes more power. */ +//usage:#define ether_wake_trivial_usage +//usage: "[-b] [-i iface] [-p aa:bb:cc:dd[:ee:ff]] MAC" +//usage:#define ether_wake_full_usage "\n\n" +//usage: "Send a magic packet to wake up sleeping machines.\n" +//usage: "MAC must be a station address (00:11:22:33:44:55) or\n" +//usage: "a hostname with a known 'ethers' entry.\n" +//usage: "\nOptions:" +//usage: "\n -b Send wake-up packet to the broadcast address" +//usage: "\n -i iface Interface to use (default eth0)" +//usage: "\n -p pass Append four or six byte password PW to the packet" #include <netpacket/packet.h> #include <net/ethernet.h> diff --git a/networking/ftpgetput.c b/networking/ftpgetput.c index 09c5ff30f..66316e21f 100644 --- a/networking/ftpgetput.c +++ b/networking/ftpgetput.c @@ -13,6 +13,44 @@ * Licensed under GPLv2 or later, see file LICENSE in this source tree. */ +//usage:#define ftpget_trivial_usage +//usage: "[OPTIONS] HOST [LOCAL_FILE] REMOTE_FILE" +//usage:#define ftpget_full_usage "\n\n" +//usage: "Retrieve a remote file via FTP\n" +//usage: "\nOptions:" +//usage: IF_FEATURE_FTPGETPUT_LONG_OPTIONS( +//usage: "\n -c,--continue Continue previous transfer" +//usage: "\n -v,--verbose Verbose" +//usage: "\n -u,--username Username" +//usage: "\n -p,--password Password" +//usage: "\n -P,--port Port number" +//usage: ) +//usage: IF_NOT_FEATURE_FTPGETPUT_LONG_OPTIONS( +//usage: "\n -c Continue previous transfer" +//usage: "\n -v Verbose" +//usage: "\n -u Username" +//usage: "\n -p Password" +//usage: "\n -P Port number" +//usage: ) +//usage: +//usage:#define ftpput_trivial_usage +//usage: "[OPTIONS] HOST [REMOTE_FILE] LOCAL_FILE" +//usage:#define ftpput_full_usage "\n\n" +//usage: "Store a local file on a remote machine via FTP\n" +//usage: "\nOptions:" +//usage: IF_FEATURE_FTPGETPUT_LONG_OPTIONS( +//usage: "\n -v,--verbose Verbose" +//usage: "\n -u,--username Username" +//usage: "\n -p,--password Password" +//usage: "\n -P,--port Port number" +//usage: ) +//usage: IF_NOT_FEATURE_FTPGETPUT_LONG_OPTIONS( +//usage: "\n -v Verbose" +//usage: "\n -u Username" +//usage: "\n -p Password" +//usage: "\n -P Port number" +//usage: ) + #include "libbb.h" struct globals { diff --git a/networking/hostname.c b/networking/hostname.c index 66b52dd90..49a3e89bb 100644 --- a/networking/hostname.c +++ b/networking/hostname.c @@ -9,6 +9,25 @@ * * Licensed under GPLv2 or later, see file LICENSE in this source tree. */ + +//usage:#define hostname_trivial_usage +//usage: "[OPTIONS] [HOSTNAME | -F FILE]" +//usage:#define hostname_full_usage "\n\n" +//usage: "Get or set hostname or DNS domain name\n" +//usage: "\nOptions:" +//usage: "\n -s Short" +//usage: "\n -i Addresses for the hostname" +//usage: "\n -d DNS domain name" +//usage: "\n -f Fully qualified domain name" +//usage: "\n -F FILE Use FILE's content as hostname" +//usage: +//usage:#define hostname_example_usage +//usage: "$ hostname\n" +//usage: "sage\n" +//usage: +//usage:#define dnsdomainname_trivial_usage NOUSAGE_STR +//usage:#define dnsdomainname_full_usage "" + #include "libbb.h" static void do_sethostname(char *s, int isfile) diff --git a/networking/httpd.c b/networking/httpd.c index eded7b63f..d6157aca2 100644 --- a/networking/httpd.c +++ b/networking/httpd.c @@ -97,6 +97,32 @@ */ /* TODO: use TCP_CORK, parse_config() */ +//usage:#define httpd_trivial_usage +//usage: "[-ifv[v]]" +//usage: " [-c CONFFILE]" +//usage: " [-p [IP:]PORT]" +//usage: IF_FEATURE_HTTPD_SETUID(" [-u USER[:GRP]]") +//usage: IF_FEATURE_HTTPD_BASIC_AUTH(" [-r REALM]") +//usage: " [-h HOME]\n" +//usage: "or httpd -d/-e" IF_FEATURE_HTTPD_AUTH_MD5("/-m") " STRING" +//usage:#define httpd_full_usage "\n\n" +//usage: "Listen for incoming HTTP requests\n" +//usage: "\nOptions:" +//usage: "\n -i Inetd mode" +//usage: "\n -f Don't daemonize" +//usage: "\n -v[v] Verbose" +//usage: "\n -p [IP:]PORT Bind to IP:PORT (default *:80)" +//usage: IF_FEATURE_HTTPD_SETUID( +//usage: "\n -u USER[:GRP] Set uid/gid after binding to port") +//usage: IF_FEATURE_HTTPD_BASIC_AUTH( +//usage: "\n -r REALM Authentication Realm for Basic Authentication") +//usage: "\n -h HOME Home directory (default .)" +//usage: "\n -c FILE Configuration file (default {/etc,HOME}/httpd.conf)" +//usage: IF_FEATURE_HTTPD_AUTH_MD5( +//usage: "\n -m STRING MD5 crypt STRING") +//usage: "\n -e STRING HTML encode STRING" +//usage: "\n -d STRING URL decode STRING" + #include "libbb.h" #if ENABLE_FEATURE_HTTPD_USE_SENDFILE # include <sys/sendfile.h> diff --git a/networking/ifconfig.c b/networking/ifconfig.c index da2635ce0..220b02126 100644 --- a/networking/ifconfig.c +++ b/networking/ifconfig.c @@ -26,6 +26,27 @@ * IPV6 support added by Bart Visscher <magick@linux-fan.com> */ +//usage:#define ifconfig_trivial_usage +//usage: IF_FEATURE_IFCONFIG_STATUS("[-a]") " interface [address]" +//usage:#define ifconfig_full_usage "\n\n" +//usage: "Configure a network interface\n" +//usage: "\nOptions:" +//usage: "\n" +//usage: IF_FEATURE_IPV6( +//usage: " [add ADDRESS[/PREFIXLEN]]\n") +//usage: IF_FEATURE_IPV6( +//usage: " [del ADDRESS[/PREFIXLEN]]\n") +//usage: " [[-]broadcast [ADDRESS]] [[-]pointopoint [ADDRESS]]\n" +//usage: " [netmask ADDRESS] [dstaddr ADDRESS]\n" +//usage: IF_FEATURE_IFCONFIG_SLIP( +//usage: " [outfill NN] [keepalive NN]\n") +//usage: " " IF_FEATURE_IFCONFIG_HW("[hw ether" IF_FEATURE_HWIB("|infiniband")" ADDRESS] ") "[metric NN] [mtu NN]\n" +//usage: " [[-]trailers] [[-]arp] [[-]allmulti]\n" +//usage: " [multicast] [[-]promisc] [txqueuelen NN] [[-]dynamic]\n" +//usage: IF_FEATURE_IFCONFIG_MEMSTART_IOADDR_IRQ( +//usage: " [mem_start NN] [io_addr NN] [irq NN]\n") +//usage: " [up|down] ..." + #include <net/if.h> #include <net/if_arp.h> #include <netinet/in.h> diff --git a/networking/ifenslave.c b/networking/ifenslave.c index 0b3ebf72a..208623e7d 100644 --- a/networking/ifenslave.c +++ b/networking/ifenslave.c @@ -98,6 +98,33 @@ * set version to 1.1.0 */ +//usage:#define ifenslave_trivial_usage +//usage: "[-cdf] MASTER_IFACE SLAVE_IFACE..." +//usage:#define ifenslave_full_usage "\n\n" +//usage: "Configure network interfaces for parallel routing\n" +//usage: "\nOptions:" +//usage: "\n -c,--change-active Change active slave" +//usage: "\n -d,--detach Remove slave interface from bonding device" +//usage: "\n -f,--force Force, even if interface is not Ethernet" +/* //usage: "\n -r,--receive-slave Create a receive-only slave" */ +//usage: +//usage:#define ifenslave_example_usage +//usage: "To create a bond device, simply follow these three steps:\n" +//usage: "- ensure that the required drivers are properly loaded:\n" +//usage: " # modprobe bonding ; modprobe <3c59x|eepro100|pcnet32|tulip|...>\n" +//usage: "- assign an IP address to the bond device:\n" +//usage: " # ifconfig bond0 <addr> netmask <mask> broadcast <bcast>\n" +//usage: "- attach all the interfaces you need to the bond device:\n" +//usage: " # ifenslave bond0 eth0 eth1 eth2\n" +//usage: " If bond0 didn't have a MAC address, it will take eth0's. Then, all\n" +//usage: " interfaces attached AFTER this assignment will get the same MAC addr.\n\n" +//usage: " To detach a dead interface without setting the bond device down:\n" +//usage: " # ifenslave -d bond0 eth1\n\n" +//usage: " To set the bond device down and automatically release all the slaves:\n" +//usage: " # ifconfig bond0 down\n\n" +//usage: " To change active slave:\n" +//usage: " # ifenslave -c bond0 eth0\n" + #include "libbb.h" /* #include <net/if.h> - no. linux/if_bonding.h pulls in linux/if.h */ diff --git a/networking/ifplugd.c b/networking/ifplugd.c index 8dd0a5bd8..421611aae 100644 --- a/networking/ifplugd.c +++ b/networking/ifplugd.c @@ -6,6 +6,32 @@ * * Licensed under GPLv2 or later, see file LICENSE in this source tree. */ + +//usage:#define ifplugd_trivial_usage +//usage: "[OPTIONS]" +//usage:#define ifplugd_full_usage "\n\n" +//usage: "Network interface plug detection daemon\n" +//usage: "\nOptions:" +//usage: "\n -n Don't daemonize" +//usage: "\n -s Don't log to syslog" +//usage: "\n -i IFACE Interface" +//usage: "\n -f/-F Treat link detection error as link down/link up" +//usage: "\n (otherwise exit on error)" +//usage: "\n -a Don't up interface at each link probe" +//usage: "\n -M Monitor creation/destruction of interface" +//usage: "\n (otherwise it must exist)" +//usage: "\n -r PROG Script to run" +//usage: "\n -x ARG Extra argument for script" +//usage: "\n -I Don't exit on nonzero exit code from script" +//usage: "\n -p Don't run script on daemon startup" +//usage: "\n -q Don't run script on daemon quit" +//usage: "\n -l Run script on startup even if no cable is detected" +//usage: "\n -t SECS Poll time in seconds" +//usage: "\n -u SECS Delay before running script after link up" +//usage: "\n -d SECS Delay after link down" +//usage: "\n -m MODE API mode (mii, priv, ethtool, wlan, iff, auto)" +//usage: "\n -k Kill running daemon" + #include "libbb.h" #include "fix_u32.h" diff --git a/networking/ifupdown.c b/networking/ifupdown.c index 7706a84b7..b48abb7dc 100644 --- a/networking/ifupdown.c +++ b/networking/ifupdown.c @@ -17,6 +17,34 @@ * Licensed under GPLv2 or later, see file LICENSE in this source tree. */ +//usage:#define ifup_trivial_usage +//usage: "[-an"IF_FEATURE_IFUPDOWN_MAPPING("m")"vf] [-i FILE] IFACE..." +//usage:#define ifup_full_usage "\n\n" +//usage: "Options:" +//usage: "\n -a De/configure all interfaces automatically" +//usage: "\n -i FILE Use FILE for interface definitions" +//usage: "\n -n Print out what would happen, but don't do it" +//usage: IF_FEATURE_IFUPDOWN_MAPPING( +//usage: "\n (note: doesn't disable mappings)" +//usage: "\n -m Don't run any mappings" +//usage: ) +//usage: "\n -v Print out what would happen before doing it" +//usage: "\n -f Force de/configuration" +//usage: +//usage:#define ifdown_trivial_usage +//usage: "[-an"IF_FEATURE_IFUPDOWN_MAPPING("m")"vf] [-i FILE] IFACE..." +//usage:#define ifdown_full_usage "\n\n" +//usage: "Options:" +//usage: "\n -a De/configure all interfaces automatically" +//usage: "\n -i FILE Use FILE for interface definitions" +//usage: "\n -n Print out what would happen, but don't do it" +//usage: IF_FEATURE_IFUPDOWN_MAPPING( +//usage: "\n (note: doesn't disable mappings)" +//usage: "\n -m Don't run any mappings" +//usage: ) +//usage: "\n -v Print out what would happen before doing it" +//usage: "\n -f Force de/configuration" + #include "libbb.h" /* After libbb.h, since it needs sys/types.h on some systems */ #include <sys/utsname.h> diff --git a/networking/inetd.c b/networking/inetd.c index 6018665ef..226a6491c 100644 --- a/networking/inetd.c +++ b/networking/inetd.c @@ -154,6 +154,17 @@ * setuid() */ +//usage:#define inetd_trivial_usage +//usage: "[-fe] [-q N] [-R N] [CONFFILE]" +//usage:#define inetd_full_usage "\n\n" +//usage: "Listen for network connections and launch programs\n" +//usage: "\nOptions:" +//usage: "\n -f Run in foreground" +//usage: "\n -e Log to stderr" +//usage: "\n -q N Socket listen queue (default: 128)" +//usage: "\n -R N Pause services after N connects/min" +//usage: "\n (default: 0 - disabled)" + #include <syslog.h> #include <sys/un.h> diff --git a/networking/ip.c b/networking/ip.c index 350656cef..98d583325 100644 --- a/networking/ip.c +++ b/networking/ip.c @@ -9,6 +9,79 @@ * Bernhard Reutner-Fischer rewrote to use index_in_substr_array */ +/* would need to make the " | " optional depending on more than one selected: */ +//usage:#define ip_trivial_usage +//usage: "[OPTIONS] {" +//usage: IF_FEATURE_IP_ADDRESS("address | ") +//usage: IF_FEATURE_IP_ROUTE("route | ") +//usage: IF_FEATURE_IP_LINK("link | ") +//usage: IF_FEATURE_IP_TUNNEL("tunnel | ") +//usage: IF_FEATURE_IP_RULE("rule") +//usage: "} {COMMAND}" +//usage:#define ip_full_usage "\n\n" +//usage: "ip [OPTIONS] OBJECT {COMMAND}\n" +//usage: "where OBJECT := {" +//usage: IF_FEATURE_IP_ADDRESS("address | ") +//usage: IF_FEATURE_IP_ROUTE("route | ") +//usage: IF_FEATURE_IP_LINK("link | ") +//usage: IF_FEATURE_IP_TUNNEL("tunnel | ") +//usage: IF_FEATURE_IP_RULE("rule") +//usage: "}\n" +//usage: "OPTIONS := { -f[amily] { inet | inet6 | link } | -o[neline] }" +//usage: +//usage:#define ipaddr_trivial_usage +//usage: "{ {add|del} IFADDR dev STRING | {show|flush}\n" +//usage: " [dev STRING] [to PREFIX] }" +//usage:#define ipaddr_full_usage "\n\n" +//usage: "ipaddr {add|delete} IFADDR dev STRING\n" +//usage: "ipaddr {show|flush} [dev STRING] [scope SCOPE-ID]\n" +//usage: " [to PREFIX] [label PATTERN]\n" +//usage: " IFADDR := PREFIX | ADDR peer PREFIX\n" +//usage: " [broadcast ADDR] [anycast ADDR]\n" +//usage: " [label STRING] [scope SCOPE-ID]\n" +//usage: " SCOPE-ID := [host | link | global | NUMBER]" +//usage: +//usage:#define iplink_trivial_usage +//usage: "{ set DEVICE { up | down | arp { on | off } | show [DEVICE] }" +//usage:#define iplink_full_usage "\n\n" +//usage: "iplink set DEVICE { up | down | arp | multicast { on | off } |\n" +//usage: " dynamic { on | off } |\n" +//usage: " mtu MTU }\n" +//usage: "iplink show [DEVICE]" +//usage: +//usage:#define iproute_trivial_usage +//usage: "{ list | flush | { add | del | change | append |\n" +//usage: " replace | monitor } ROUTE }" +//usage:#define iproute_full_usage "\n\n" +//usage: "iproute { list | flush } SELECTOR\n" +//usage: "iproute get ADDRESS [from ADDRESS iif STRING]\n" +//usage: " [oif STRING] [tos TOS]\n" +//usage: "iproute { add | del | change | append | replace | monitor } ROUTE\n" +//usage: " SELECTOR := [root PREFIX] [match PREFIX] [proto RTPROTO]\n" +//usage: " ROUTE := [TYPE] PREFIX [tos TOS] [proto RTPROTO]\n" +//usage: " [metric METRIC]" +//usage: +//usage:#define iprule_trivial_usage +//usage: "{[list | add | del] RULE}" +//usage:#define iprule_full_usage "\n\n" +//usage: "iprule [list | add | del] SELECTOR ACTION\n" +//usage: " SELECTOR := [from PREFIX] [to PREFIX] [tos TOS] [fwmark FWMARK]\n" +//usage: " [dev STRING] [pref NUMBER]\n" +//usage: " ACTION := [table TABLE_ID] [nat ADDRESS]\n" +//usage: " [prohibit | reject | unreachable]\n" +//usage: " [realms [SRCREALM/]DSTREALM]\n" +//usage: " TABLE_ID := [local | main | default | NUMBER]" +//usage: +//usage:#define iptunnel_trivial_usage +//usage: "{ add | change | del | show } [NAME]\n" +//usage: " [mode { ipip | gre | sit }]\n" +//usage: " [remote ADDR] [local ADDR] [ttl TTL]" +//usage:#define iptunnel_full_usage "\n\n" +//usage: "iptunnel { add | change | del | show } [NAME]\n" +//usage: " [mode { ipip | gre | sit }] [remote ADDR] [local ADDR]\n" +//usage: " [[i|o]seq] [[i|o]key KEY] [[i|o]csum]\n" +//usage: " [ttl TTL] [tos TOS] [[no]pmtudisc] [dev PHYS_DEV]" + #include "libbb.h" #include "libiproute/utils.h" diff --git a/networking/ipcalc.c b/networking/ipcalc.c index acbaa4ac5..f96c73912 100644 --- a/networking/ipcalc.c +++ b/networking/ipcalc.c @@ -11,6 +11,33 @@ * * Licensed under GPLv2 or later, see file LICENSE in this source tree. */ + +//usage:#define ipcalc_trivial_usage +//usage: "[OPTIONS] ADDRESS[[/]NETMASK] [NETMASK]" +//usage:#define ipcalc_full_usage "\n\n" +//usage: "Calculate IP network settings from a IP address\n" +//usage: "\nOptions:" +//usage: IF_FEATURE_IPCALC_LONG_OPTIONS( +//usage: "\n -b,--broadcast Display calculated broadcast address" +//usage: "\n -n,--network Display calculated network address" +//usage: "\n -m,--netmask Display default netmask for IP" +//usage: IF_FEATURE_IPCALC_FANCY( +//usage: "\n -p,--prefix Display the prefix for IP/NETMASK" +//usage: "\n -h,--hostname Display first resolved host name" +//usage: "\n -s,--silent Don't ever display error messages" +//usage: ) +//usage: ) +//usage: IF_NOT_FEATURE_IPCALC_LONG_OPTIONS( +//usage: "\n -b Display calculated broadcast address" +//usage: "\n -n Display calculated network address" +//usage: "\n -m Display default netmask for IP" +//usage: IF_FEATURE_IPCALC_FANCY( +//usage: "\n -p Display the prefix for IP/NETMASK" +//usage: "\n -h Display first resolved host name" +//usage: "\n -s Don't ever display error messages" +//usage: ) +//usage: ) + #include "libbb.h" /* After libbb.h, because on some systems it needs other includes */ #include <arpa/inet.h> diff --git a/networking/isrv_identd.c b/networking/isrv_identd.c index 18ce59aaf..199e11225 100644 --- a/networking/isrv_identd.c +++ b/networking/isrv_identd.c @@ -7,6 +7,17 @@ * Licensed under GPLv2, see file LICENSE in this source tree. */ +//usage:#define fakeidentd_trivial_usage +//usage: "[-fiw] [-b ADDR] [STRING]" +//usage:#define fakeidentd_full_usage "\n\n" +//usage: "Provide fake ident (auth) service\n" +//usage: "\nOptions:" +//usage: "\n -f Run in foreground" +//usage: "\n -i Inetd mode" +//usage: "\n -w Inetd 'wait' mode" +//usage: "\n -b ADDR Bind to specified address" +//usage: "\n STRING Ident answer string (default: nobody)" + #include "libbb.h" #include <syslog.h> #include "isrv.h" diff --git a/networking/nslookup.c b/networking/nslookup.c index 67fc01547..f4fd407dd 100644 --- a/networking/nslookup.c +++ b/networking/nslookup.c @@ -11,6 +11,20 @@ * Licensed under GPLv2 or later, see file LICENSE in this source tree. */ +//usage:#define nslookup_trivial_usage +//usage: "[HOST] [SERVER]" +//usage:#define nslookup_full_usage "\n\n" +//usage: "Query the nameserver for the IP address of the given HOST\n" +//usage: "optionally using a specified DNS server" +//usage: +//usage:#define nslookup_example_usage +//usage: "$ nslookup localhost\n" +//usage: "Server: default\n" +//usage: "Address: default\n" +//usage: "\n" +//usage: "Name: debian\n" +//usage: "Address: 127.0.0.1\n" + #include <resolv.h> #include "libbb.h" diff --git a/networking/ntpd.c b/networking/ntpd.c index ba2950d8f..e27dbaa6b 100644 --- a/networking/ntpd.c +++ b/networking/ntpd.c @@ -27,6 +27,23 @@ * * *********************************************************************** */ + +//usage:#define ntpd_trivial_usage +//usage: "[-dnqNw"IF_FEATURE_NTPD_SERVER("l")"] [-S PROG] [-p PEER]..." +//usage:#define ntpd_full_usage "\n\n" +//usage: "NTP client/server\n" +//usage: "\nOptions:" +//usage: "\n -d Verbose" +//usage: "\n -n Do not daemonize" +//usage: "\n -q Quit after clock is set" +//usage: "\n -N Run at high priority" +//usage: "\n -w Do not set time (only query peers), implies -n" +//usage: IF_FEATURE_NTPD_SERVER( +//usage: "\n -l Run as server on port 123" +//usage: ) +//usage: "\n -S PROG Run PROG after stepping time, stratum change, and every 11 mins" +//usage: "\n -p PEER Obtain time from PEER (may be repeated)" + #include "libbb.h" #include <math.h> #include <netinet/ip.h> /* For IPTOS_LOWDELAY definition */ diff --git a/networking/pscan.c b/networking/pscan.c index a9e5d5c29..5595148fc 100644 --- a/networking/pscan.c +++ b/networking/pscan.c @@ -6,6 +6,18 @@ * Licensed under GPLv2 or later, see file LICENSE in this source tree. */ +//usage:#define pscan_trivial_usage +//usage: "[-cb] [-p MIN_PORT] [-P MAX_PORT] [-t TIMEOUT] [-T MIN_RTT] HOST" +//usage:#define pscan_full_usage "\n\n" +//usage: "Scan a host, print all open ports\n" +//usage: "\nOptions:" +//usage: "\n -c Show closed ports too" +//usage: "\n -b Show blocked ports too" +//usage: "\n -p Scan from this port (default 1)" +//usage: "\n -P Scan up to this port (default 1024)" +//usage: "\n -t Timeout (default 5000 ms)" +//usage: "\n -T Minimum rtt (default 5 ms, increase for congested hosts)" + #include "libbb.h" /* debugging */ diff --git a/networking/route.c b/networking/route.c index 98a03ded7..6699a1c32 100644 --- a/networking/route.c +++ b/networking/route.c @@ -25,6 +25,15 @@ * remove ridiculous amounts of bloat. */ +//usage:#define route_trivial_usage +//usage: "[{add|del|delete}]" +//usage:#define route_full_usage "\n\n" +//usage: "Edit kernel routing tables\n" +//usage: "\nOptions:" +//usage: "\n -n Don't resolve names" +//usage: "\n -e Display other/more information" +//usage: "\n -A inet" IF_FEATURE_IPV6("{6}") " Select address family" + #include <net/route.h> #include <net/if.h> diff --git a/networking/slattach.c b/networking/slattach.c index 71edd2f27..d1221b11a 100644 --- a/networking/slattach.c +++ b/networking/slattach.c @@ -13,6 +13,20 @@ * - The -F options allows disabling of RTS/CTS flow control. */ +//usage:#define slattach_trivial_usage +//usage: "[-cehmLF] [-s SPEED] [-p PROTOCOL] DEVICE" +//usage:#define slattach_full_usage "\n\n" +//usage: "Attach network interface(s) to serial line(s)\n" +//usage: "\nOptions:" +//usage: "\n -p PROT Set protocol (slip, cslip, slip6, clisp6 or adaptive)" +//usage: "\n -s SPD Set line speed" +//usage: "\n -e Exit after initializing device" +//usage: "\n -h Exit when the carrier is lost" +//usage: "\n -c PROG Run PROG when the line is hung up" +//usage: "\n -m Do NOT initialize the line in raw 8 bits mode" +//usage: "\n -L Enable 3-wire operation" +//usage: "\n -F Disable RTS/CTS flow control" + #include "libbb.h" #include "libiproute/utils.h" /* invarg() */ diff --git a/networking/tc.c b/networking/tc.c index 9b3245546..e9848a86b 100644 --- a/networking/tc.c +++ b/networking/tc.c @@ -7,6 +7,27 @@ * Bernhard Reutner-Fischer adjusted for busybox */ +//usage:#define tc_trivial_usage +/* //usage: "[OPTIONS] OBJECT CMD [dev STRING]" */ +//usage: "OBJECT CMD [dev STRING]" +//usage:#define tc_full_usage "\n\n" +//usage: "OBJECT: {qdisc|class|filter}\n" +//usage: "CMD: {add|del|change|replace|show}\n" +//usage: "\n" +//usage: "qdisc [ handle QHANDLE ] [ root |"IF_FEATURE_TC_INGRESS(" ingress |")" parent CLASSID ]\n" +/* //usage: "[ estimator INTERVAL TIME_CONSTANT ]\n" */ +//usage: " [ [ QDISC_KIND ] [ help | OPTIONS ] ]\n" +//usage: " QDISC_KIND := { [p|b]fifo | tbf | prio | cbq | red | etc. }\n" +//usage: "qdisc show [ dev STRING ]"IF_FEATURE_TC_INGRESS(" [ingress]")"\n" +//usage: "class [ classid CLASSID ] [ root | parent CLASSID ]\n" +//usage: " [ [ QDISC_KIND ] [ help | OPTIONS ] ]\n" +//usage: "class show [ dev STRING ] [ root | parent CLASSID ]\n" +//usage: "filter [ pref PRIO ] [ protocol PROTO ]\n" +/* //usage: "\t[ estimator INTERVAL TIME_CONSTANT ]\n" */ +//usage: " [ root | classid CLASSID ] [ handle FILTERID ]\n" +//usage: " [ [ FILTER_TYPE ] [ help | OPTIONS ] ]\n" +//usage: "filter show [ dev STRING ] [ root | parent CLASSID ]" + #include "libbb.h" #include "libiproute/utils.h" diff --git a/networking/tcpudp.c b/networking/tcpudp.c index 3ff2acbf8..a2b8c958c 100644 --- a/networking/tcpudp.c +++ b/networking/tcpudp.c @@ -29,6 +29,43 @@ * - don't know how to retrieve ORIGDST for udp. */ +//usage:#define tcpsvd_trivial_usage +//usage: "[-hEv] [-c N] [-C N[:MSG]] [-b N] [-u USER] [-l NAME] IP PORT PROG" +/* with not-implemented options: */ +/* //usage: "[-hpEvv] [-c N] [-C N[:MSG]] [-b N] [-u USER] [-l NAME] [-i DIR|-x CDB] [-t SEC] IP PORT PROG" */ +//usage:#define tcpsvd_full_usage "\n\n" +//usage: "Create TCP socket, bind to IP:PORT and listen\n" +//usage: "for incoming connection. Run PROG for each connection.\n" +//usage: "\n IP IP to listen on. '0' = all" +//usage: "\n PORT Port to listen on" +//usage: "\n PROG ARGS Program to run" +//usage: "\n -l NAME Local hostname (else looks up local hostname in DNS)" +//usage: "\n -u USER[:GRP] Change to user/group after bind" +//usage: "\n -c N Handle up to N connections simultaneously" +//usage: "\n -b N Allow a backlog of approximately N TCP SYNs" +//usage: "\n -C N[:MSG] Allow only up to N connections from the same IP." +//usage: "\n New connections from this IP address are closed" +//usage: "\n immediately. MSG is written to the peer before close" +//usage: "\n -h Look up peer's hostname" +//usage: "\n -E Don't set up environment variables" +//usage: "\n -v Verbose" +//usage: +//usage:#define udpsvd_trivial_usage +//usage: "[-hEv] [-c N] [-u USER] [-l NAME] IP PORT PROG" +//usage:#define udpsvd_full_usage "\n\n" +//usage: "Create UDP socket, bind to IP:PORT and wait\n" +//usage: "for incoming packets. Run PROG for each packet,\n" +//usage: "redirecting all further packets with same peer ip:port to it.\n" +//usage: "\n IP IP to listen on. '0' = all" +//usage: "\n PORT Port to listen on" +//usage: "\n PROG ARGS Program to run" +//usage: "\n -l NAME Local hostname (else looks up local hostname in DNS)" +//usage: "\n -u USER[:GRP] Change to user/group after bind" +//usage: "\n -c N Handle up to N connections simultaneously" +//usage: "\n -h Look up peer's hostname" +//usage: "\n -E Don't set up environment variables" +//usage: "\n -v Verbose" + #include "libbb.h" /* Wants <limits.h> etc, thus included after libbb.h: */ diff --git a/networking/telnet.c b/networking/telnet.c index f6fad684c..1f0d85107 100644 --- a/networking/telnet.c +++ b/networking/telnet.c @@ -21,6 +21,22 @@ * */ +//usage:#if ENABLE_FEATURE_TELNET_AUTOLOGIN +//usage:#define telnet_trivial_usage +//usage: "[-a] [-l USER] HOST [PORT]" +//usage:#define telnet_full_usage "\n\n" +//usage: "Connect to telnet server\n" +//usage: "\nOptions:" +//usage: "\n -a Automatic login with $USER variable" +//usage: "\n -l USER Automatic login as USER" +//usage: +//usage:#else +//usage:#define telnet_trivial_usage +//usage: "HOST [PORT]" +//usage:#define telnet_full_usage "\n\n" +//usage: "Connect to telnet server" +//usage:#endif + #include <arpa/telnet.h> #include <netinet/in.h> #include "libbb.h" diff --git a/networking/telnetd.c b/networking/telnetd.c index eec4417ca..4404064fc 100644 --- a/networking/telnetd.c +++ b/networking/telnetd.c @@ -20,6 +20,28 @@ * Vladimir Oleynik <dzo@simtreas.ru> 2001 * Set process group corrections, initial busybox port */ + +//usage:#define telnetd_trivial_usage +//usage: "[OPTIONS]" +//usage:#define telnetd_full_usage "\n\n" +//usage: "Handle incoming telnet connections" +//usage: IF_NOT_FEATURE_TELNETD_STANDALONE(" via inetd") "\n" +//usage: "\nOptions:" +//usage: "\n -l LOGIN Exec LOGIN on connect" +//usage: "\n -f ISSUE_FILE Display ISSUE_FILE instead of /etc/issue" +//usage: "\n -K Close connection as soon as login exits" +//usage: "\n (normally wait until all programs close slave pty)" +//usage: IF_FEATURE_TELNETD_STANDALONE( +//usage: "\n -p PORT Port to listen on" +//usage: "\n -b ADDR[:PORT] Address to bind to" +//usage: "\n -F Run in foreground" +//usage: "\n -i Inetd mode" +//usage: IF_FEATURE_TELNETD_INETD_WAIT( +//usage: "\n -w SEC Inetd 'wait' mode, linger time SEC" +//usage: "\n -S Log to syslog (implied by -i or without -F and -w)" +//usage: ) +//usage: ) + #define DEBUG 0 #include "libbb.h" diff --git a/networking/tftp.c b/networking/tftp.c index 35cf0dbd9..f52e49d51 100644 --- a/networking/tftp.c +++ b/networking/tftp.c @@ -18,6 +18,39 @@ * * Licensed under GPLv2 or later, see file LICENSE in this source tree. */ + +//usage:#define tftp_trivial_usage +//usage: "[OPTIONS] HOST [PORT]" +//usage:#define tftp_full_usage "\n\n" +//usage: "Transfer a file from/to tftp server\n" +//usage: "\nOptions:" +//usage: "\n -l FILE Local FILE" +//usage: "\n -r FILE Remote FILE" +//usage: IF_FEATURE_TFTP_GET( +//usage: "\n -g Get file" +//usage: ) +//usage: IF_FEATURE_TFTP_PUT( +//usage: "\n -p Put file" +//usage: ) +//usage: IF_FEATURE_TFTP_BLOCKSIZE( +//usage: "\n -b SIZE Transfer blocks of SIZE octets" +//usage: ) +//usage: +//usage:#define tftpd_trivial_usage +//usage: "[-cr] [-u USER] [DIR]" +//usage:#define tftpd_full_usage "\n\n" +//usage: "Transfer a file on tftp client's request\n" +//usage: "\n" +//usage: "tftpd should be used as an inetd service.\n" +//usage: "tftpd's line for inetd.conf:\n" +//usage: " 69 dgram udp nowait root tftpd tftpd /files/to/serve\n" +//usage: "It also can be ran from udpsvd:\n" +//usage: " udpsvd -vE 0.0.0.0 69 tftpd /files/to/serve\n" +//usage: "\nOptions:" +//usage: "\n -r Prohibit upload" +//usage: "\n -c Allow file creation via upload" +//usage: "\n -u Access files as USER" + #include "libbb.h" #if ENABLE_FEATURE_TFTP_GET || ENABLE_FEATURE_TFTP_PUT diff --git a/networking/traceroute.c b/networking/traceroute.c index 55dc15b66..96f9d3472 100644 --- a/networking/traceroute.c +++ b/networking/traceroute.c @@ -210,6 +210,51 @@ * Tue Dec 20 03:50:13 PST 1988 */ +//usage:#define traceroute_trivial_usage +//usage: "[-"IF_TRACEROUTE6("46")"FIldnrv] [-f 1ST_TTL] [-m MAXTTL] [-p PORT] [-q PROBES]\n" +//usage: " [-s SRC_IP] [-t TOS] [-w WAIT_SEC] [-g GATEWAY] [-i IFACE]\n" +//usage: " [-z PAUSE_MSEC] HOST [BYTES]" +//usage:#define traceroute_full_usage "\n\n" +//usage: "Trace the route to HOST\n" +//usage: "\nOptions:" +//usage: IF_TRACEROUTE6( +//usage: "\n -4,-6 Force IP or IPv6 name resolution" +//usage: ) +//usage: "\n -F Set the don't fragment bit" +//usage: "\n -I Use ICMP ECHO instead of UDP datagrams" +//usage: "\n -l Display the TTL value of the returned packet" +//usage: "\n -d Set SO_DEBUG options to socket" +//usage: "\n -n Print numeric addresses" +//usage: "\n -r Bypass routing tables, send directly to HOST" +//usage: "\n -v Verbose" +//usage: "\n -m Max time-to-live (max number of hops)" +//usage: "\n -p Base UDP port number used in probes" +//usage: "\n (default 33434)" +//usage: "\n -q Number of probes per TTL (default 3)" +//usage: "\n -s IP address to use as the source address" +//usage: "\n -t Type-of-service in probe packets (default 0)" +//usage: "\n -w Time in seconds to wait for a response (default 3)" +//usage: "\n -g Loose source route gateway (8 max)" +//usage: +//usage:#define traceroute6_trivial_usage +//usage: "[-dnrv] [-m MAXTTL] [-p PORT] [-q PROBES]\n" +//usage: " [-s SRC_IP] [-t TOS] [-w WAIT_SEC] [-i IFACE]\n" +//usage: " HOST [BYTES]" +//usage:#define traceroute6_full_usage "\n\n" +//usage: "Trace the route to HOST\n" +//usage: "\nOptions:" +//usage: "\n -d Set SO_DEBUG options to socket" +//usage: "\n -n Print numeric addresses" +//usage: "\n -r Bypass routing tables, send directly to HOST" +//usage: "\n -v Verbose" +//usage: "\n -m Max time-to-live (max number of hops)" +//usage: "\n -p Base UDP port number used in probes" +//usage: "\n (default is 33434)" +//usage: "\n -q Number of probes per TTL (default 3)" +//usage: "\n -s IP address to use as the source address" +//usage: "\n -t Type-of-service in probe packets (default 0)" +//usage: "\n -w Time in seconds to wait for a response (default 3)" + #define TRACEROUTE_SO_DEBUG 0 /* TODO: undefs were uncommented - ??! we have config system for that! */ diff --git a/networking/tunctl.c b/networking/tunctl.c index e17a9db64..8cb733b68 100644 --- a/networking/tunctl.c +++ b/networking/tunctl.c @@ -9,6 +9,25 @@ * * Licensed under GPLv2, see file LICENSE in this source tree. */ + +//usage:#define tunctl_trivial_usage +//usage: "[-f device] ([-t name] | -d name)" IF_FEATURE_TUNCTL_UG(" [-u owner] [-g group] [-b]") +//usage:#define tunctl_full_usage "\n\n" +//usage: "Create or delete tun interfaces\n" +//usage: "\nOptions:" +//usage: "\n -f name tun device (/dev/net/tun)" +//usage: "\n -t name Create iface 'name'" +//usage: "\n -d name Delete iface 'name'" +//usage: IF_FEATURE_TUNCTL_UG( +//usage: "\n -u owner Set iface owner" +//usage: "\n -g group Set iface group" +//usage: "\n -b Brief output" +//usage: ) +//usage: +//usage:#define tunctl_example_usage +//usage: "# tunctl\n" +//usage: "# tunctl -d tun0\n" + #include <netinet/in.h> #include <net/if.h> #include <linux/if_tun.h> diff --git a/networking/udhcp/dhcpd.c b/networking/udhcp/dhcpd.c index 6fb48a19a..747472d0c 100644 --- a/networking/udhcp/dhcpd.c +++ b/networking/udhcp/dhcpd.c @@ -20,6 +20,17 @@ * along with this program; if not, write to the Free Software * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */ + +//usage:#define udhcpd_trivial_usage +//usage: "[-fS]" IF_FEATURE_UDHCP_PORT(" [-P N]") " [CONFFILE]" +//usage:#define udhcpd_full_usage "\n\n" +//usage: "DHCP server\n" +//usage: "\n -f Run in foreground" +//usage: "\n -S Log to syslog too" +//usage: IF_FEATURE_UDHCP_PORT( +//usage: "\n -P N Use port N (default 67)" +//usage: ) + #include <syslog.h> #include "common.h" #include "dhcpc.h" diff --git a/networking/udhcp/dhcprelay.c b/networking/udhcp/dhcprelay.c index 86ef04a62..f82ac05b4 100644 --- a/networking/udhcp/dhcprelay.c +++ b/networking/udhcp/dhcprelay.c @@ -9,6 +9,12 @@ * Netbeat AG * Upstream has GPL v2 or later */ + +//usage:#define dhcprelay_trivial_usage +//usage: "CLIENT_IFACE[,CLIENT_IFACE2]... SERVER_IFACE [SERVER_IP]" +//usage:#define dhcprelay_full_usage "\n\n" +//usage: "Relay DHCP requests between clients and server" + #include "common.h" #define SERVER_PORT 67 diff --git a/networking/udhcp/dumpleases.c b/networking/udhcp/dumpleases.c index 21d62a2d2..ec07192c1 100644 --- a/networking/udhcp/dumpleases.c +++ b/networking/udhcp/dumpleases.c @@ -2,6 +2,23 @@ /* * Licensed under GPLv2 or later, see file LICENSE in this source tree. */ + +//usage:#define dumpleases_trivial_usage +//usage: "[-r|-a] [-f LEASEFILE]" +//usage:#define dumpleases_full_usage "\n\n" +//usage: "Display DHCP leases granted by udhcpd\n" +//usage: "\nOptions:" +//usage: IF_LONG_OPTS( +//usage: "\n -f,--file=FILE Lease file" +//usage: "\n -r,--remaining Show remaining time" +//usage: "\n -a,--absolute Show expiration time" +//usage: ) +//usage: IF_NOT_LONG_OPTS( +//usage: "\n -f FILE Lease file" +//usage: "\n -r Show remaining time" +//usage: "\n -a Show expiration time" +//usage: ) + #include "common.h" #include "dhcpd.h" #include "unicode.h" diff --git a/networking/vconfig.c b/networking/vconfig.c index 13c65ad78..4fa341ac3 100644 --- a/networking/vconfig.c +++ b/networking/vconfig.c @@ -9,6 +9,18 @@ /* BB_AUDIT SUSv3 N/A */ +//usage:#define vconfig_trivial_usage +//usage: "COMMAND [OPTIONS]" +//usage:#define vconfig_full_usage "\n\n" +//usage: "Create and remove virtual ethernet devices\n" +//usage: "\nOptions:" +//usage: "\n add [interface-name] [vlan_id]" +//usage: "\n rem [vlan-name]" +//usage: "\n set_flag [interface-name] [flag-num] [0 | 1]" +//usage: "\n set_egress_map [vlan-name] [skb_priority] [vlan_qos]" +//usage: "\n set_ingress_map [vlan-name] [skb_priority] [vlan_qos]" +//usage: "\n set_name_type [name-type]" + #include "libbb.h" #include <net/if.h> diff --git a/networking/zcip.c b/networking/zcip.c index 6fa265ad4..7250fb2fd 100644 --- a/networking/zcip.c +++ b/networking/zcip.c @@ -23,6 +23,19 @@ // - avoid silent script failures, especially under load... // - link status monitoring (restart on link-up; stop on link-down) +//usage:#define zcip_trivial_usage +//usage: "[OPTIONS] IFACE SCRIPT" +//usage:#define zcip_full_usage "\n\n" +//usage: "Manage a ZeroConf IPv4 link-local address\n" +//usage: "\nOptions:" +//usage: "\n -f Run in foreground" +//usage: "\n -q Quit after obtaining address" +//usage: "\n -r 169.254.x.x Request this address first" +//usage: "\n -v Verbose" +//usage: "\n" +//usage: "\nWith no -q, runs continuously monitoring for ARP conflicts," +//usage: "\nexits only on I/O errors (link down etc)" + #include <netinet/ether.h> #include <net/ethernet.h> #include <net/if.h> diff --git a/printutils/lpd.c b/printutils/lpd.c index 157cbe8ae..115552e0b 100644 --- a/printutils/lpd.c +++ b/printutils/lpd.c @@ -70,6 +70,17 @@ * mv -f ./"$DATAFILE" save/ */ +//usage:#define lpd_trivial_usage +//usage: "SPOOLDIR [HELPER [ARGS]]" +//usage:#define lpd_full_usage "\n\n" +//usage: "SPOOLDIR must contain (symlinks to) device nodes or directories" +//usage: "\nwith names matching print queue names. In the first case, jobs are" +//usage: "\nsent directly to the device. Otherwise each job is stored in queue" +//usage: "\ndirectory and HELPER program is called. Name of file to print" +//usage: "\nis passed in $DATAFILE variable." +//usage: "\nExample:" +//usage: "\n tcpsvd -E 0 515 softlimit -m 999999 lpd /var/spool ./print" + #include "libbb.h" // strip argument of bad chars diff --git a/printutils/lpr.c b/printutils/lpr.c index 284917926..f8ee9a11b 100644 --- a/printutils/lpr.c +++ b/printutils/lpr.c @@ -11,6 +11,27 @@ * * See RFC 1179 for protocol description. */ + +//usage:#define lpr_trivial_usage +//usage: "-P queue[@host[:port]] -U USERNAME -J TITLE -Vmh [FILE]..." +/* -C CLASS exists too, not shown. + * CLASS is supposed to be printed on banner page, if one is requested */ +//usage:#define lpr_full_usage "\n\n" +//usage: "Options:" +//usage: "\n -P lp service to connect to (else uses $PRINTER)" +//usage: "\n -m Send mail on completion" +//usage: "\n -h Print banner page too" +//usage: "\n -V Verbose" +//usage: +//usage:#define lpq_trivial_usage +//usage: "[-P queue[@host[:port]]] [-U USERNAME] [-d JOBID]... [-fs]" +//usage:#define lpq_full_usage "\n\n" +//usage: "Options:" +//usage: "\n -P lp service to connect to (else uses $PRINTER)" +//usage: "\n -d Delete jobs" +//usage: "\n -f Force any waiting job to be printed" +//usage: "\n -s Short display" + #include "libbb.h" /* diff --git a/procps/free.c b/procps/free.c index ad8711f8a..ca753134c 100644 --- a/procps/free.c +++ b/procps/free.c @@ -9,6 +9,18 @@ /* getopt not needed */ +//usage:#define free_trivial_usage +//usage: "" IF_DESKTOP("[-b/k/m/g]") +//usage:#define free_full_usage "\n\n" +//usage: "Display the amount of free and used system memory" +//usage: +//usage:#define free_example_usage +//usage: "$ free\n" +//usage: " total used free shared buffers\n" +//usage: " Mem: 257628 248724 8904 59644 93124\n" +//usage: " Swap: 128516 8404 120112\n" +//usage: "Total: 386144 257128 129016\n" + #include "libbb.h" struct globals { diff --git a/procps/fuser.c b/procps/fuser.c index a1b93d77f..7837ff883 100644 --- a/procps/fuser.c +++ b/procps/fuser.c @@ -7,6 +7,17 @@ * Licensed under GPLv2, see file LICENSE in this source tree. */ +//usage:#define fuser_trivial_usage +//usage: "[OPTIONS] FILE or PORT/PROTO" +//usage:#define fuser_full_usage "\n\n" +//usage: "Find processes which use FILEs or PORTs\n" +//usage: "\nOptions:" +//usage: "\n -m Find processes which use same fs as FILEs" +//usage: "\n -4,-6 Search only IPv4/IPv6 space" +//usage: "\n -s Don't display PIDs" +//usage: "\n -k Kill found processes" +//usage: "\n -SIGNAL Signal to send (default: KILL)" + #include "libbb.h" #define MAX_LINE 255 diff --git a/procps/kill.c b/procps/kill.c index 695d266c5..6776d9546 100644 --- a/procps/kill.c +++ b/procps/kill.c @@ -8,6 +8,45 @@ * Licensed under GPLv2 or later, see file LICENSE in this source tree. */ +//usage:#define kill_trivial_usage +//usage: "[-l] [-SIG] PID..." +//usage:#define kill_full_usage "\n\n" +//usage: "Send a signal (default: TERM) to given PIDs\n" +//usage: "\nOptions:" +//usage: "\n -l List all signal names and numbers" +/* //usage: "\n -s SIG Yet another way of specifying SIG" */ +//usage: +//usage:#define kill_example_usage +//usage: "$ ps | grep apache\n" +//usage: "252 root root S [apache]\n" +//usage: "263 www-data www-data S [apache]\n" +//usage: "264 www-data www-data S [apache]\n" +//usage: "265 www-data www-data S [apache]\n" +//usage: "266 www-data www-data S [apache]\n" +//usage: "267 www-data www-data S [apache]\n" +//usage: "$ kill 252\n" +//usage: +//usage:#define killall_trivial_usage +//usage: "[-l] [-q] [-SIG] PROCESS_NAME..." +//usage:#define killall_full_usage "\n\n" +//usage: "Send a signal (default: TERM) to given processes\n" +//usage: "\nOptions:" +//usage: "\n -l List all signal names and numbers" +/* //usage: "\n -s SIG Yet another way of specifying SIG" */ +//usage: "\n -q Don't complain if no processes were killed" +//usage: +//usage:#define killall_example_usage +//usage: "$ killall apache\n" +//usage: +//usage:#define killall5_trivial_usage +//usage: "[-l] [-SIG] [-o PID]..." +//usage:#define killall5_full_usage "\n\n" +//usage: "Send a signal (default: TERM) to all processes outside current session\n" +//usage: "\nOptions:" +//usage: "\n -l List all signal names and numbers" +//usage: "\n -o PID Don't signal this PID" +/* //usage: "\n -s SIG Yet another way of specifying SIG" */ + #include "libbb.h" /* Note: kill_main is directly called from shell in order to implement diff --git a/procps/pgrep.c b/procps/pgrep.c index 5d388a87d..902a3a75e 100644 --- a/procps/pgrep.c +++ b/procps/pgrep.c @@ -6,6 +6,35 @@ * * Licensed under GPLv2 or later, see file LICENSE in this source tree. */ + +//usage:#define pgrep_trivial_usage +//usage: "[-flnovx] [-s SID|-P PPID|PATTERN]" +//usage:#define pgrep_full_usage "\n\n" +//usage: "Display process(es) selected by regex PATTERN\n" +//usage: "\nOptions:" +//usage: "\n -l Show command name too" +//usage: "\n -f Match against entire command line" +//usage: "\n -n Show the newest process only" +//usage: "\n -o Show the oldest process only" +//usage: "\n -v Negate the match" +//usage: "\n -x Match whole name (not substring)" +//usage: "\n -s Match session ID (0 for current)" +//usage: "\n -P Match parent process ID" +//usage: +//usage:#define pkill_trivial_usage +//usage: "[-l|-SIGNAL] [-fnovx] [-s SID|-P PPID|PATTERN]" +//usage:#define pkill_full_usage "\n\n" +//usage: "Send a signal to process(es) selected by regex PATTERN\n" +//usage: "\nOptions:" +//usage: "\n -l List all signals" +//usage: "\n -f Match against entire command line" +//usage: "\n -n Signal the newest process only" +//usage: "\n -o Signal the oldest process only" +//usage: "\n -v Negate the match" +//usage: "\n -x Match whole name (not substring)" +//usage: "\n -s Match session ID (0 for current)" +//usage: "\n -P Match parent process ID" + #include "libbb.h" #include "xregex.h" diff --git a/procps/pidof.c b/procps/pidof.c index 49e469ca5..e102a31c6 100644 --- a/procps/pidof.c +++ b/procps/pidof.c @@ -7,6 +7,34 @@ * Licensed under GPLv2, see file LICENSE in this source tree. */ +//usage:#if (ENABLE_FEATURE_PIDOF_SINGLE || ENABLE_FEATURE_PIDOF_OMIT) +//usage:#define pidof_trivial_usage +//usage: "[OPTIONS] [NAME]..." +//usage:#define USAGE_PIDOF "\n\nOptions:" +//usage:#else +//usage:#define pidof_trivial_usage +//usage: "[NAME]..." +//usage:#define USAGE_PIDOF /* none */ +//usage:#endif +//usage:#define pidof_full_usage "\n\n" +//usage: "List PIDs of all processes with names that match NAMEs" +//usage: USAGE_PIDOF +//usage: IF_FEATURE_PIDOF_SINGLE( +//usage: "\n -s Show only one PID" +//usage: ) +//usage: IF_FEATURE_PIDOF_OMIT( +//usage: "\n -o PID Omit given pid" +//usage: "\n Use %PPID to omit pid of pidof's parent" +//usage: ) +//usage: +//usage:#define pidof_example_usage +//usage: "$ pidof init\n" +//usage: "1\n" +//usage: IF_FEATURE_PIDOF_OMIT( +//usage: "$ pidof /bin/sh\n20351 5973 5950\n") +//usage: IF_FEATURE_PIDOF_OMIT( +//usage: "$ pidof /bin/sh -o %PPID\n20351 5950") + #include "libbb.h" enum { diff --git a/procps/ps.c b/procps/ps.c index 6945780ec..7f273d0a6 100644 --- a/procps/ps.c +++ b/procps/ps.c @@ -9,6 +9,53 @@ * Licensed under GPLv2, see file LICENSE in this source tree. */ +//usage:#if ENABLE_DESKTOP +//usage: +//usage:#define ps_trivial_usage +//usage: "[-o COL1,COL2=HEADER]" IF_FEATURE_SHOW_THREADS(" [-T]") +//usage:#define ps_full_usage "\n\n" +//usage: "Show list of processes\n" +//usage: "\nOptions:" +//usage: "\n -o COL1,COL2=HEADER Select columns for display" +//usage: IF_FEATURE_SHOW_THREADS( +//usage: "\n -T Show threads" +//usage: ) +//usage: +//usage:#else /* !ENABLE_DESKTOP */ +//usage: +//usage:#if !ENABLE_SELINUX && !ENABLE_FEATURE_PS_WIDE +//usage:#define USAGE_PS "\nThis version of ps accepts no options" +//usage:#else +//usage:#define USAGE_PS "\nOptions:" +//usage:#endif +//usage: +//usage:#define ps_trivial_usage +//usage: "" +//usage:#define ps_full_usage "\n\n" +//usage: "Show list of processes\n" +//usage: USAGE_PS +//usage: IF_SELINUX( +//usage: "\n -Z Show selinux context" +//usage: ) +//usage: IF_FEATURE_PS_WIDE( +//usage: "\n w Wide output" +//usage: ) +//usage: +//usage:#endif /* ENABLE_DESKTOP */ +//usage: +//usage:#define ps_example_usage +//usage: "$ ps\n" +//usage: " PID Uid Gid State Command\n" +//usage: " 1 root root S init\n" +//usage: " 2 root root S [kflushd]\n" +//usage: " 3 root root S [kupdate]\n" +//usage: " 4 root root S [kpiod]\n" +//usage: " 5 root root S [kswapd]\n" +//usage: " 742 andersen andersen S [bash]\n" +//usage: " 743 andersen andersen S -bash\n" +//usage: " 745 root root S [getty]\n" +//usage: " 2990 andersen andersen R ps\n" + #include "libbb.h" /* Absolute maximum on output line length */ diff --git a/procps/renice.c b/procps/renice.c index 59194b5f4..067c8f75a 100644 --- a/procps/renice.c +++ b/procps/renice.c @@ -19,6 +19,16 @@ * following IDs (if any). Multiple switches are allowed. */ +//usage:#define renice_trivial_usage +//usage: "{{-n INCREMENT} | PRIORITY} [[-p | -g | -u] ID...]" +//usage:#define renice_full_usage "\n\n" +//usage: "Change scheduling priority for a running process\n" +//usage: "\nOptions:" +//usage: "\n -n Adjust current nice value (smaller is faster)" +//usage: "\n -p Process id(s) (default)" +//usage: "\n -g Process group id(s)" +//usage: "\n -u Process user name(s) and/or id(s)" + #include "libbb.h" #include <sys/resource.h> diff --git a/procps/sysctl.c b/procps/sysctl.c index aba966e7f..f36548f87 100644 --- a/procps/sysctl.c +++ b/procps/sysctl.c @@ -11,6 +11,25 @@ * v1.01.1 - busybox applet aware by <solar@gentoo.org> */ +//usage:#define sysctl_trivial_usage +//usage: "[OPTIONS] [VALUE]..." +//usage:#define sysctl_full_usage "\n\n" +//usage: "Configure kernel parameters at runtime\n" +//usage: "\nOptions:" +//usage: "\n -n Don't print key names" +//usage: "\n -e Don't warn about unknown keys" +//usage: "\n -w Change sysctl setting" +//usage: "\n -p FILE Load sysctl settings from FILE (default /etc/sysctl.conf)" +//usage: "\n -a Display all values" +//usage: "\n -A Display all values in table form" +//usage: +//usage:#define sysctl_example_usage +//usage: "sysctl [-n] [-e] variable...\n" +//usage: "sysctl [-n] [-e] -w variable=value...\n" +//usage: "sysctl [-n] [-e] -a\n" +//usage: "sysctl [-n] [-e] -p file (default /etc/sysctl.conf)\n" +//usage: "sysctl [-n] [-e] -A\n" + #include "libbb.h" enum { diff --git a/procps/uptime.c b/procps/uptime.c index 5c48795bf..1a7da46a3 100644 --- a/procps/uptime.c +++ b/procps/uptime.c @@ -15,6 +15,15 @@ /* getopt not needed */ +//usage:#define uptime_trivial_usage +//usage: "" +//usage:#define uptime_full_usage "\n\n" +//usage: "Display the time since the last boot" +//usage: +//usage:#define uptime_example_usage +//usage: "$ uptime\n" +//usage: " 1:55pm up 2:30, load average: 0.09, 0.04, 0.00\n" + #include "libbb.h" #ifndef FSHIFT diff --git a/procps/watch.c b/procps/watch.c index 36f71c469..e289bf8cb 100644 --- a/procps/watch.c +++ b/procps/watch.c @@ -11,6 +11,20 @@ /* BB_AUDIT SUSv3 N/A */ /* BB_AUDIT GNU defects -- only option -n is supported. */ +//usage:#define watch_trivial_usage +//usage: "[-n SEC] [-t] PROG ARGS" +//usage:#define watch_full_usage "\n\n" +//usage: "Run PROG periodically\n" +//usage: "\nOptions:" +//usage: "\n -n Loop period in seconds (default 2)" +//usage: "\n -t Don't print header" +//usage: +//usage:#define watch_example_usage +//usage: "$ watch date\n" +//usage: "Mon Dec 17 10:31:40 GMT 2000\n" +//usage: "Mon Dec 17 10:31:42 GMT 2000\n" +//usage: "Mon Dec 17 10:31:44 GMT 2000" + #include "libbb.h" // procps 2.0.18: diff --git a/runit/chpst.c b/runit/chpst.c index dc8a26aeb..63da4797f 100644 --- a/runit/chpst.c +++ b/runit/chpst.c @@ -28,6 +28,70 @@ ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. /* Busyboxed by Denys Vlasenko <vda.linux@googlemail.com> */ /* Dependencies on runit_lib.c removed */ +//usage:#define chpst_trivial_usage +//usage: "[-vP012] [-u USER[:GRP]] [-U USER[:GRP]] [-e DIR]\n" +//usage: " [-/ DIR] [-n NICE] [-m BYTES] [-d BYTES] [-o N]\n" +//usage: " [-p N] [-f BYTES] [-c BYTES] PROG ARGS" +//usage:#define chpst_full_usage "\n\n" +//usage: "Change the process state, run PROG\n" +//usage: "\nOptions:" +//usage: "\n -u USER[:GRP] Set uid and gid" +//usage: "\n -U USER[:GRP] Set $UID and $GID in environment" +//usage: "\n -e DIR Set environment variables as specified by files" +//usage: "\n in DIR: file=1st_line_of_file" +//usage: "\n -/ DIR Chroot to DIR" +//usage: "\n -n NICE Add NICE to nice value" +//usage: "\n -m BYTES Same as -d BYTES -s BYTES -l BYTES" +//usage: "\n -d BYTES Limit data segment" +//usage: "\n -o N Limit number of open files per process" +//usage: "\n -p N Limit number of processes per uid" +//usage: "\n -f BYTES Limit output file sizes" +//usage: "\n -c BYTES Limit core file size" +//usage: "\n -v Verbose" +//usage: "\n -P Create new process group" +//usage: "\n -0 Close stdin" +//usage: "\n -1 Close stdout" +//usage: "\n -2 Close stderr" +//usage: +//usage:#define envdir_trivial_usage +//usage: "DIR PROG ARGS" +//usage:#define envdir_full_usage "\n\n" +//usage: "Set various environment variables as specified by files\n" +//usage: "in the directory DIR, run PROG" +//usage: +//usage:#define envuidgid_trivial_usage +//usage: "USER PROG ARGS" +//usage:#define envuidgid_full_usage "\n\n" +//usage: "Set $UID to USER's uid and $GID to USER's gid, run PROG" +//usage: +//usage:#define setuidgid_trivial_usage +//usage: "USER PROG ARGS" +//usage:#define setuidgid_full_usage "\n\n" +//usage: "Set uid and gid to USER's uid and gid, drop supplementary group ids,\n" +//usage: "run PROG" +//usage: +//usage:#define softlimit_trivial_usage +//usage: "[-a BYTES] [-m BYTES] [-d BYTES] [-s BYTES] [-l BYTES]\n" +//usage: " [-f BYTES] [-c BYTES] [-r BYTES] [-o N] [-p N] [-t N]\n" +//usage: " PROG ARGS" +//usage:#define softlimit_full_usage "\n\n" +//usage: "Set soft resource limits, then run PROG\n" +//usage: "\nOptions:" +//usage: "\n -a BYTES Limit total size of all segments" +//usage: "\n -m BYTES Same as -d BYTES -s BYTES -l BYTES -a BYTES" +//usage: "\n -d BYTES Limit data segment" +//usage: "\n -s BYTES Limit stack segment" +//usage: "\n -l BYTES Limit locked memory size" +//usage: "\n -o N Limit number of open files per process" +//usage: "\n -p N Limit number of processes per uid" +//usage: "\nOptions controlling file sizes:" +//usage: "\n -f BYTES Limit output file sizes" +//usage: "\n -c BYTES Limit core file size" +//usage: "\nEfficiency opts:" +//usage: "\n -r BYTES Limit resident set size" +//usage: "\n -t N Limit CPU time, process receives" +//usage: "\n a SIGXCPU after N seconds" + #include "libbb.h" /* diff --git a/runit/runsv.c b/runit/runsv.c index e76572daa..ad8d84f74 100644 --- a/runit/runsv.c +++ b/runit/runsv.c @@ -28,6 +28,11 @@ ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. /* Busyboxed by Denys Vlasenko <vda.linux@googlemail.com> */ /* TODO: depends on runit_lib.c - review and reduce/eliminate */ +//usage:#define runsv_trivial_usage +//usage: "DIR" +//usage:#define runsv_full_usage "\n\n" +//usage: "Start and monitor a service and optionally an appendant log service" + #include <sys/poll.h> #include <sys/file.h> #include "libbb.h" diff --git a/runit/runsvdir.c b/runit/runsvdir.c index 166664237..9495a2a4f 100644 --- a/runit/runsvdir.c +++ b/runit/runsvdir.c @@ -28,6 +28,13 @@ ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. /* Busyboxed by Denys Vlasenko <vda.linux@googlemail.com> */ /* TODO: depends on runit_lib.c - review and reduce/eliminate */ +//usage:#define runsvdir_trivial_usage +//usage: "[-P] [-s SCRIPT] DIR" +//usage:#define runsvdir_full_usage "\n\n" +//usage: "Start a runsv process for each subdirectory. If it exits, restart it.\n" +//usage: "\n -P Put each runsv in a new session" +//usage: "\n -s SCRIPT Run SCRIPT <signo> after signal is processed" + #include <sys/poll.h> #include <sys/file.h> #include "libbb.h" diff --git a/runit/sv.c b/runit/sv.c index c420a91a6..322688a36 100644 --- a/runit/sv.c +++ b/runit/sv.c @@ -153,6 +153,22 @@ Exit Codes /* Busyboxed by Denys Vlasenko <vda.linux@googlemail.com> */ /* TODO: depends on runit_lib.c - review and reduce/eliminate */ +//usage:#define sv_trivial_usage +//usage: "[-v] [-w SEC] CMD SERVICE_DIR..." +//usage:#define sv_full_usage "\n\n" +//usage: "Control services monitored by runsv supervisor.\n" +//usage: "Commands (only first character is enough):\n" +//usage: "\n" +//usage: "status: query service status\n" +//usage: "up: if service isn't running, start it. If service stops, restart it\n" +//usage: "once: like 'up', but if service stops, don't restart it\n" +//usage: "down: send TERM and CONT signals. If ./run exits, start ./finish\n" +//usage: " if it exists. After it stops, don't restart service\n" +//usage: "exit: send TERM and CONT signals to service and log service. If they exit,\n" +//usage: " runsv exits too\n" +//usage: "pause, cont, hup, alarm, interrupt, quit, 1, 2, term, kill: send\n" +//usage: "STOP, CONT, HUP, ALRM, INT, QUIT, USR1, USR2, TERM, KILL signal to service" + #include <sys/poll.h> #include <sys/file.h> #include "libbb.h" diff --git a/selinux/chcon.c b/selinux/chcon.c index e00cdda1b..8644502b5 100644 --- a/selinux/chcon.c +++ b/selinux/chcon.c @@ -7,6 +7,39 @@ * * Licensed under GPLv2, see file LICENSE in this source tree. */ + +//usage:#define chcon_trivial_usage +//usage: "[OPTIONS] CONTEXT FILE..." +//usage: "\n chcon [OPTIONS] [-u USER] [-r ROLE] [-l RANGE] [-t TYPE] FILE..." +//usage: IF_FEATURE_CHCON_LONG_OPTIONS( +//usage: "\n chcon [OPTIONS] --reference=RFILE FILE..." +//usage: ) +//usage:#define chcon_full_usage "\n\n" +//usage: "Change the security context of each FILE to CONTEXT\n" +//usage: IF_FEATURE_CHCON_LONG_OPTIONS( +//usage: "\n -v,--verbose Verbose" +//usage: "\n -c,--changes Report changes made" +//usage: "\n -h,--no-dereference Affect symlinks instead of their targets" +//usage: "\n -f,--silent,--quiet Suppress most error messages" +//usage: "\n --reference=RFILE Use RFILE's group instead of using a CONTEXT value" +//usage: "\n -u,--user=USER Set user/role/type/range in the target" +//usage: "\n -r,--role=ROLE security context" +//usage: "\n -t,--type=TYPE" +//usage: "\n -l,--range=RANGE" +//usage: "\n -R,--recursive Recurse" +//usage: ) +//usage: IF_NOT_FEATURE_CHCON_LONG_OPTIONS( +//usage: "\n -v Verbose" +//usage: "\n -c Report changes made" +//usage: "\n -h Affect symlinks instead of their targets" +//usage: "\n -f Suppress most error messages" +//usage: "\n -u USER Set user/role/type/range in the target security context" +//usage: "\n -r ROLE" +//usage: "\n -t TYPE" +//usage: "\n -l RNG" +//usage: "\n -R Recurse" +//usage: ) + #include <getopt.h> #include <selinux/context.h> diff --git a/selinux/getenforce.c b/selinux/getenforce.c index d9d9d0f65..56611d693 100644 --- a/selinux/getenforce.c +++ b/selinux/getenforce.c @@ -7,6 +7,9 @@ * Licensed under GPLv2, see file LICENSE in this source tree. */ +//usage:#define getenforce_trivial_usage NOUSAGE_STR +//usage:#define getenforce_full_usage "" + #include "libbb.h" int getenforce_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE; diff --git a/selinux/getsebool.c b/selinux/getsebool.c index 924356cae..e8f0fefb0 100644 --- a/selinux/getsebool.c +++ b/selinux/getsebool.c @@ -7,6 +7,11 @@ * Licensed under GPLv2, see file LICENSE in this source tree. */ +//usage:#define getsebool_trivial_usage +//usage: "-a or getsebool boolean..." +//usage:#define getsebool_full_usage "\n\n" +//usage: " -a Show all selinux booleans" + #include "libbb.h" int getsebool_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE; diff --git a/selinux/load_policy.c b/selinux/load_policy.c index 8fc92dbf3..ce139dbf2 100644 --- a/selinux/load_policy.c +++ b/selinux/load_policy.c @@ -4,6 +4,10 @@ * * Licensed under GPLv2, see file LICENSE in this source tree. */ + +//usage:#define load_policy_trivial_usage NOUSAGE_STR +//usage:#define load_policy_full_usage "" + #include "libbb.h" int load_policy_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE; diff --git a/selinux/matchpathcon.c b/selinux/matchpathcon.c index ec49077c8..9e5728eb3 100644 --- a/selinux/matchpathcon.c +++ b/selinux/matchpathcon.c @@ -5,6 +5,16 @@ * * Licensed under GPLv2, see file LICENSE in this source tree. */ + +//usage:#define matchpathcon_trivial_usage +//usage: "[-n] [-N] [-f file_contexts_file] [-p prefix] [-V]" +//usage:#define matchpathcon_full_usage "\n\n" +//usage: " -n Don't display path" +//usage: "\n -N Don't use translations" +//usage: "\n -f Use alternate file_context file" +//usage: "\n -p Use prefix to speed translations" +//usage: "\n -V Verify file context on disk matches defaults" + #include "libbb.h" static int print_matchpathcon(char *path, int noprint) diff --git a/selinux/runcon.c b/selinux/runcon.c index 54349b25c..f0b21269f 100644 --- a/selinux/runcon.c +++ b/selinux/runcon.c @@ -28,6 +28,28 @@ * * Licensed under GPLv2, see file LICENSE in this source tree. */ + +//usage:#define runcon_trivial_usage +//usage: "[-c] [-u USER] [-r ROLE] [-t TYPE] [-l RANGE] PROG ARGS\n" +//usage: "runcon CONTEXT PROG ARGS" +//usage:#define runcon_full_usage "\n\n" +//usage: "Run PROG in a different security context\n" +//usage: "\n CONTEXT Complete security context\n" +//usage: IF_FEATURE_RUNCON_LONG_OPTIONS( +//usage: "\n -c,--compute Compute process transition context before modifying" +//usage: "\n -t,--type=TYPE Type (for same role as parent)" +//usage: "\n -u,--user=USER User identity" +//usage: "\n -r,--role=ROLE Role" +//usage: "\n -l,--range=RNG Levelrange" +//usage: ) +//usage: IF_NOT_FEATURE_RUNCON_LONG_OPTIONS( +//usage: "\n -c Compute process transition context before modifying" +//usage: "\n -t TYPE Type (for same role as parent)" +//usage: "\n -u USER User identity" +//usage: "\n -r ROLE Role" +//usage: "\n -l RNG Levelrange" +//usage: ) + #include <getopt.h> #include <selinux/context.h> #include <selinux/flask.h> diff --git a/selinux/selinuxenabled.c b/selinux/selinuxenabled.c index aa4e63f74..ce830dc22 100644 --- a/selinux/selinuxenabled.c +++ b/selinux/selinuxenabled.c @@ -6,6 +6,10 @@ * * Licensed under GPLv2, see file LICENSE in this source tree. */ + +//usage:#define selinuxenabled_trivial_usage NOUSAGE_STR +//usage:#define selinuxenabled_full_usage "" + #include "libbb.h" int selinuxenabled_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE; diff --git a/selinux/sestatus.c b/selinux/sestatus.c index aa12e806c..0bd1a0dda 100644 --- a/selinux/sestatus.c +++ b/selinux/sestatus.c @@ -8,6 +8,12 @@ * Licensed under GPLv2, see file LICENSE in this source tree. */ +//usage:#define sestatus_trivial_usage +//usage: "[-vb]" +//usage:#define sestatus_full_usage "\n\n" +//usage: " -v Verbose" +//usage: "\n -b Display current state of booleans" + #include "libbb.h" extern char *selinux_mnt; diff --git a/selinux/setenforce.c b/selinux/setenforce.c index be5432147..c5bc0a5a6 100644 --- a/selinux/setenforce.c +++ b/selinux/setenforce.c @@ -7,6 +7,10 @@ * Licensed under GPLv2, see file LICENSE in this source tree. */ +//usage:#define setenforce_trivial_usage +//usage: "[Enforcing | Permissive | 1 | 0]" +//usage:#define setenforce_full_usage "" + #include "libbb.h" /* These strings are arranged so that odd ones diff --git a/selinux/setfiles.c b/selinux/setfiles.c index 989510e3d..ca3fd9361 100644 --- a/selinux/setfiles.c +++ b/selinux/setfiles.c @@ -4,6 +4,46 @@ Port to BusyBox (c) 2007 by Yuichi Nakamura <ynakam@hitachisoft.jp> */ +//usage:#define setfiles_trivial_usage +//usage: "[-dnpqsvW] [-e DIR]... [-o FILE] [-r alt_root_path]" +//usage: IF_FEATURE_SETFILES_CHECK_OPTION( +//usage: " [-c policyfile] spec_file" +//usage: ) +//usage: " pathname" +//usage:#define setfiles_full_usage "\n\n" +//usage: "Reset file contexts under pathname according to spec_file\n" +//usage: IF_FEATURE_SETFILES_CHECK_OPTION( +//usage: "\n -c FILE Check the validity of the contexts against the specified binary policy" +//usage: ) +//usage: "\n -d Show which specification matched each file" +//usage: "\n -l Log changes in file labels to syslog" +//usage: "\n -n Don't change any file labels" +//usage: "\n -q Suppress warnings" +//usage: "\n -r DIR Use an alternate root path" +//usage: "\n -e DIR Exclude DIR" +//usage: "\n -F Force reset of context to match file_context for customizable files" +//usage: "\n -o FILE Save list of files with incorrect context" +//usage: "\n -s Take a list of files from stdin (instead of command line)" +//usage: "\n -v Show changes in file labels, if type or role are changing" +//usage: "\n -vv Show changes in file labels, if type, role, or user are changing" +//usage: "\n -W Display warnings about entries that had no matching files" +//usage: +//usage:#define restorecon_trivial_usage +//usage: "[-iFnRv] [-e EXCLUDEDIR]... [-o FILE] [-f FILE]" +//usage:#define restorecon_full_usage "\n\n" +//usage: "Reset security contexts of files in pathname\n" +//usage: "\n -i Ignore files that don't exist" +//usage: "\n -f FILE File with list of files to process" +//usage: "\n -e DIR Directory to exclude" +//usage: "\n -R,-r Recurse" +//usage: "\n -n Don't change any file labels" +//usage: "\n -o FILE Save list of files with incorrect context" +//usage: "\n -v Verbose" +//usage: "\n -vv Show changed labels" +//usage: "\n -F Force reset of context to match file_context" +//usage: "\n for customizable files, or the user section," +//usage: "\n if it has changed" + #include "libbb.h" #if ENABLE_FEATURE_SETFILES_CHECK_OPTION #include <sepol/sepol.h> diff --git a/selinux/setsebool.c b/selinux/setsebool.c index a8cc00407..ec682e5c5 100644 --- a/selinux/setsebool.c +++ b/selinux/setsebool.c @@ -8,6 +8,11 @@ * Licensed under GPLv2, see file LICENSE in this source tree. */ +//usage:#define setsebool_trivial_usage +//usage: "boolean value" +//usage:#define setsebool_full_usage "\n\n" +//usage: "Change boolean setting" + #include "libbb.h" int setsebool_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE; diff --git a/sysklogd/klogd.c b/sysklogd/klogd.c index db32065fb..3992081ca 100644 --- a/sysklogd/klogd.c +++ b/sysklogd/klogd.c @@ -17,6 +17,14 @@ * Licensed under GPLv2 or later, see file LICENSE in this source tree. */ +//usage:#define klogd_trivial_usage +//usage: "[-c N] [-n]" +//usage:#define klogd_full_usage "\n\n" +//usage: "Kernel logger\n" +//usage: "\nOptions:" +//usage: "\n -c N Only messages with level < N are printed to console" +//usage: "\n -n Run in foreground" + #include "libbb.h" #include <syslog.h> diff --git a/sysklogd/logger.c b/sysklogd/logger.c index 120f6a718..0fabd97ca 100644 --- a/sysklogd/logger.c +++ b/sysklogd/logger.c @@ -7,6 +7,18 @@ * Licensed under GPLv2 or later, see file LICENSE in this source tree. */ +//usage:#define logger_trivial_usage +//usage: "[OPTIONS] [MESSAGE]" +//usage:#define logger_full_usage "\n\n" +//usage: "Write MESSAGE (or stdin) to syslog\n" +//usage: "\nOptions:" +//usage: "\n -s Log to stderr as well as the system log" +//usage: "\n -t TAG Log using the specified tag (defaults to user name)" +//usage: "\n -p PRIO Priority (numeric or facility.level pair)" +//usage: +//usage:#define logger_example_usage +//usage: "$ logger \"hello\"\n" + /* * Done in syslogd_and_logger.c: #include "libbb.h" diff --git a/sysklogd/logread.c b/sysklogd/logread.c index 52c97aa77..ae0b2194b 100644 --- a/sysklogd/logread.c +++ b/sysklogd/logread.c @@ -9,6 +9,13 @@ * Licensed under GPLv2 or later, see file LICENSE in this source tree. */ +//usage:#define logread_trivial_usage +//usage: "[-f]" +//usage:#define logread_full_usage "\n\n" +//usage: "Show messages in syslogd's circular buffer\n" +//usage: "\nOptions:" +//usage: "\n -f Output data as log grows" + #include "libbb.h" #include <sys/ipc.h> #include <sys/sem.h> diff --git a/sysklogd/syslogd.c b/sysklogd/syslogd.c index f179dc5ac..7ddd3e4c3 100644 --- a/sysklogd/syslogd.c +++ b/sysklogd/syslogd.c @@ -13,6 +13,33 @@ * Licensed under GPLv2 or later, see file LICENSE in this source tree. */ +//usage:#define syslogd_trivial_usage +//usage: "[OPTIONS]" +//usage:#define syslogd_full_usage "\n\n" +//usage: "System logging utility.\n" +//usage: "This version of syslogd ignores /etc/syslog.conf\n" +//usage: "\nOptions:" +//usage: "\n -n Run in foreground" +//usage: "\n -O FILE Log to given file (default:/var/log/messages)" +//usage: "\n -l N Set local log level" +//usage: "\n -S Smaller logging output" +//usage: IF_FEATURE_ROTATE_LOGFILE( +//usage: "\n -s SIZE Max size (KB) before rotate (default:200KB, 0=off)" +//usage: "\n -b N N rotated logs to keep (default:1, max=99, 0=purge)") +//usage: IF_FEATURE_REMOTE_LOG( +//usage: "\n -R HOST[:PORT] Log to IP or hostname on PORT (default PORT=514/UDP)" +//usage: "\n -L Log locally and via network (default is network only if -R)") +//usage: IF_FEATURE_SYSLOGD_DUP( +//usage: "\n -D Drop duplicates") +//usage: IF_FEATURE_IPC_SYSLOG( +//usage: "\n -C[size(KiB)] Log to shared mem buffer (read it using logread)") +/* NB: -Csize shouldn't have space (because size is optional) */ +/* //usage: "\n -m MIN Minutes between MARK lines (default:20, 0=off)" */ +//usage: +//usage:#define syslogd_example_usage +//usage: "$ syslogd -R masterlog:514\n" +//usage: "$ syslogd -R 192.168.1.1:601\n" + /* * Done in syslogd_and_logger.c: #include "libbb.h" diff --git a/util-linux/acpid.c b/util-linux/acpid.c index ce4c98ebe..c9eed2a7f 100644 --- a/util-linux/acpid.c +++ b/util-linux/acpid.c @@ -6,6 +6,30 @@ * * Licensed under GPLv2, see file LICENSE in this source tree. */ + +//usage:#define acpid_trivial_usage +//usage: "[-d] [-c CONFDIR] [-l LOGFILE] [-a ACTIONFILE] [-M MAPFILE] [-e PROC_EVENT_FILE] [-p PIDFILE]" +//usage:#define acpid_full_usage "\n\n" +//usage: "Listen to ACPI events and spawn specific helpers on event arrival\n" +//usage: "\nOptions:" +//usage: "\n -c DIR Config directory [/etc/acpi]" +//usage: "\n -d Don't daemonize, (implies -f)" +//usage: "\n -e FILE /proc event file [/proc/acpi/event]" +//usage: "\n -f Run in foreground" +//usage: "\n -l FILE Log file [/var/log/acpid.log]" +//usage: "\n -p FILE Pid file [/var/run/acpid.pid]" +//usage: "\n -a FILE Action file [/etc/acpid.conf]" +//usage: "\n -M FILE Map file [/etc/acpi.map]" +//usage: IF_FEATURE_ACPID_COMPAT( +//usage: "\n\nAccept and ignore compatibility options -g -m -s -S -v" +//usage: ) +//usage: +//usage:#define acpid_example_usage +//usage: "Without -e option, acpid uses all /dev/input/event* files\n" +//usage: "# acpid\n" +//usage: "# acpid -l /var/log/my-acpi-log\n" +//usage: "# acpid -e /proc/acpi/event\n" + #include "libbb.h" #include <syslog.h> #include <linux/input.h> diff --git a/util-linux/blkid.c b/util-linux/blkid.c index fe88fb31d..c30360c65 100644 --- a/util-linux/blkid.c +++ b/util-linux/blkid.c @@ -7,6 +7,11 @@ * Licensed under GPLv2, see file LICENSE in this source tree. */ +//usage:#define blkid_trivial_usage +//usage: "" +//usage:#define blkid_full_usage "\n\n" +//usage: "Print UUIDs of all filesystems" + #include "libbb.h" #include "volume_id.h" diff --git a/util-linux/dmesg.c b/util-linux/dmesg.c index 6e43a22f5..412bf024b 100644 --- a/util-linux/dmesg.c +++ b/util-linux/dmesg.c @@ -8,6 +8,16 @@ * * Licensed under GPLv2, see file LICENSE in this source tree. */ + +//usage:#define dmesg_trivial_usage +//usage: "[-c] [-n LEVEL] [-s SIZE]" +//usage:#define dmesg_full_usage "\n\n" +//usage: "Print or control the kernel ring buffer\n" +//usage: "\nOptions:" +//usage: "\n -c Clear ring buffer after printing" +//usage: "\n -n LEVEL Set console logging level" +//usage: "\n -s SIZE Buffer size" + #include <sys/klog.h> #include "libbb.h" diff --git a/util-linux/fbset.c b/util-linux/fbset.c index 77cc1fc12..75d41b882 100644 --- a/util-linux/fbset.c +++ b/util-linux/fbset.c @@ -12,6 +12,21 @@ * Geert Uytterhoeven (Geert.Uytterhoeven@cs.kuleuven.ac.be) */ +//usage:#define fbset_trivial_usage +//usage: "[OPTIONS] [MODE]" +//usage:#define fbset_full_usage "\n\n" +//usage: "Show and modify frame buffer settings" +//usage: +//usage:#define fbset_example_usage +//usage: "$ fbset\n" +//usage: "mode \"1024x768-76\"\n" +//usage: " # D: 78.653 MHz, H: 59.949 kHz, V: 75.694 Hz\n" +//usage: " geometry 1024 768 1024 768 16\n" +//usage: " timings 12714 128 32 16 4 128 4\n" +//usage: " accel false\n" +//usage: " rgba 5/11,6/5,5/0,0/0\n" +//usage: "endmode\n" + #include "libbb.h" #define DEFAULTFBDEV FB_0 diff --git a/util-linux/fdformat.c b/util-linux/fdformat.c index 57e9c26f8..bf7098e71 100644 --- a/util-linux/fdformat.c +++ b/util-linux/fdformat.c @@ -5,6 +5,13 @@ * Licensed under GPLv2, see file LICENSE in this source tree. */ +//usage:#define fdformat_trivial_usage +//usage: "[-n] DEVICE" +//usage:#define fdformat_full_usage "\n\n" +//usage: "Format floppy disk\n" +//usage: "\nOptions:" +//usage: "\n -n Don't verify after format" + #include "libbb.h" diff --git a/util-linux/fdisk.c b/util-linux/fdisk.c index 0b93c22cc..da03e683e 100644 --- a/util-linux/fdisk.c +++ b/util-linux/fdisk.c @@ -7,6 +7,28 @@ * Licensed under GPLv2 or later, see file LICENSE in this source tree. */ +/* Looks like someone forgot to add this to config system */ +//usage:#ifndef ENABLE_FEATURE_FDISK_BLKSIZE +//usage:# define ENABLE_FEATURE_FDISK_BLKSIZE 0 +//usage:# define IF_FEATURE_FDISK_BLKSIZE(a) +//usage:#endif +//usage: +//usage:#define fdisk_trivial_usage +//usage: "[-ul" IF_FEATURE_FDISK_BLKSIZE("s") "] " +//usage: "[-C CYLINDERS] [-H HEADS] [-S SECTORS] [-b SSZ] DISK" +//usage:#define fdisk_full_usage "\n\n" +//usage: "Change partition table\n" +//usage: "\nOptions:" +//usage: "\n -u Start and End are in sectors (instead of cylinders)" +//usage: "\n -l Show partition table for each DISK, then exit" +//usage: IF_FEATURE_FDISK_BLKSIZE( +//usage: "\n -s Show partition sizes in kb for each DISK, then exit" +//usage: ) +//usage: "\n -b 2048 (for certain MO disks) use 2048-byte sectors" +//usage: "\n -C CYLINDERS Set number of cylinders/heads/sectors" +//usage: "\n -H HEADS" +//usage: "\n -S SECTORS" + #ifndef _LARGEFILE64_SOURCE /* For lseek64 */ # define _LARGEFILE64_SOURCE diff --git a/util-linux/findfs.c b/util-linux/findfs.c index e1ec41f1b..49e8979ac 100644 --- a/util-linux/findfs.c +++ b/util-linux/findfs.c @@ -8,6 +8,14 @@ * Licensed under GPLv2 or later, see file LICENSE in this source tree. */ +//usage:#define findfs_trivial_usage +//usage: "LABEL=label or UUID=uuid" +//usage:#define findfs_full_usage "\n\n" +//usage: "Find a filesystem device based on a label or UUID" +//usage: +//usage:#define findfs_example_usage +//usage: "$ findfs LABEL=MyDevice" + #include "libbb.h" #include "volume_id.h" diff --git a/util-linux/flock.c b/util-linux/flock.c index 77fe1f809..8fecb54d4 100644 --- a/util-linux/flock.c +++ b/util-linux/flock.c @@ -3,6 +3,17 @@ * * This is free software, licensed under the GNU General Public License v2. */ + +//usage:#define flock_trivial_usage +//usage: "[-sxun] FD|{FILE [-c] PROG ARGS}" +//usage:#define flock_full_usage "\n\n" +//usage: "[Un]lock file descriptor, or lock FILE, run PROG\n" +//usage: "\nOptions:" +//usage: "\n -s Shared lock" +//usage: "\n -x Exclusive lock (default)" +//usage: "\n -u Unlock FD" +//usage: "\n -n Fail rather than wait" + #include <sys/file.h> #include "libbb.h" diff --git a/util-linux/freeramdisk.c b/util-linux/freeramdisk.c index 7ad443086..a89ae1a39 100644 --- a/util-linux/freeramdisk.c +++ b/util-linux/freeramdisk.c @@ -8,6 +8,20 @@ * * Licensed under GPLv2, see file LICENSE in this source tree. */ + +//usage:#define freeramdisk_trivial_usage +//usage: "DEVICE" +//usage:#define freeramdisk_full_usage "\n\n" +//usage: "Free all memory used by the specified ramdisk" +//usage: +//usage:#define freeramdisk_example_usage +//usage: "$ freeramdisk /dev/ram2\n" +//usage: +//usage:#define fdflush_trivial_usage +//usage: "DEVICE" +//usage:#define fdflush_full_usage "\n\n" +//usage: "Force floppy disk drive to detect disk change" + #include <sys/mount.h> #include "libbb.h" diff --git a/util-linux/fsck_minix.c b/util-linux/fsck_minix.c index e02e05fa4..b53c97248 100644 --- a/util-linux/fsck_minix.c +++ b/util-linux/fsck_minix.c @@ -87,6 +87,19 @@ * enforced (but it's not much fun on a character device :-). */ +//usage:#define fsck_minix_trivial_usage +//usage: "[-larvsmf] BLOCKDEV" +//usage:#define fsck_minix_full_usage "\n\n" +//usage: "Check MINIX filesystem\n" +//usage: "\nOptions:" +//usage: "\n -l List all filenames" +//usage: "\n -r Perform interactive repairs" +//usage: "\n -a Perform automatic repairs" +//usage: "\n -v Verbose" +//usage: "\n -s Output superblock information" +//usage: "\n -m Show \"mode not cleared\" warnings" +//usage: "\n -f Force file system check" + #include <mntent.h> #include "libbb.h" #include "minix.h" diff --git a/util-linux/getopt.c b/util-linux/getopt.c index 7c498538f..10e1dc49b 100644 --- a/util-linux/getopt.c +++ b/util-linux/getopt.c @@ -31,6 +31,54 @@ * */ +//usage:#define getopt_trivial_usage +//usage: "[OPTIONS]" +//usage:#define getopt_full_usage "\n\n" +//usage: "Options:" +//usage: IF_LONG_OPTS( +//usage: "\n -a,--alternative Allow long options starting with single -" +//usage: "\n -l,--longoptions=longopts Long options to be recognized" +//usage: "\n -n,--name=progname The name under which errors are reported" +//usage: "\n -o,--options=optstring Short options to be recognized" +//usage: "\n -q,--quiet Disable error reporting by getopt(3)" +//usage: "\n -Q,--quiet-output No normal output" +//usage: "\n -s,--shell=shell Set shell quoting conventions" +//usage: "\n -T,--test Test for getopt(1) version" +//usage: "\n -u,--unquoted Don't quote the output" +//usage: ) +//usage: IF_NOT_LONG_OPTS( +//usage: "\n -a Allow long options starting with single -" +//usage: "\n -l longopts Long options to be recognized" +//usage: "\n -n progname The name under which errors are reported" +//usage: "\n -o optstring Short options to be recognized" +//usage: "\n -q Disable error reporting by getopt(3)" +//usage: "\n -Q No normal output" +//usage: "\n -s shell Set shell quoting conventions" +//usage: "\n -T Test for getopt(1) version" +//usage: "\n -u Don't quote the output" +//usage: ) +//usage: +//usage:#define getopt_example_usage +//usage: "$ cat getopt.test\n" +//usage: "#!/bin/sh\n" +//usage: "GETOPT=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \\\n" +//usage: " -n 'example.busybox' -- \"$@\"`\n" +//usage: "if [ $? != 0 ]; then exit 1; fi\n" +//usage: "eval set -- \"$GETOPT\"\n" +//usage: "while true; do\n" +//usage: " case $1 in\n" +//usage: " -a|--a-long) echo \"Option a\"; shift;;\n" +//usage: " -b|--b-long) echo \"Option b, argument '$2'\"; shift 2;;\n" +//usage: " -c|--c-long)\n" +//usage: " case \"$2\" in\n" +//usage: " \"\") echo \"Option c, no argument\"; shift 2;;\n" +//usage: " *) echo \"Option c, argument '$2'\"; shift 2;;\n" +//usage: " esac;;\n" +//usage: " --) shift; break;;\n" +//usage: " *) echo \"Internal error!\"; exit 1;;\n" +//usage: " esac\n" +//usage: "done\n" + #include <getopt.h> #include "libbb.h" diff --git a/util-linux/hexdump.c b/util-linux/hexdump.c index a38fe05e7..1f5d57d74 100644 --- a/util-linux/hexdump.c +++ b/util-linux/hexdump.c @@ -9,6 +9,30 @@ * Licensed under GPLv2 or later, see file LICENSE in this source tree. */ +//usage:#define hexdump_trivial_usage +//usage: "[-bcCdefnosvx" IF_FEATURE_HEXDUMP_REVERSE("R") "] [FILE]..." +//usage:#define hexdump_full_usage "\n\n" +//usage: "Display FILEs (or stdin) in a user specified format\n" +//usage: "\nOptions:" +//usage: "\n -b One-byte octal display" +//usage: "\n -c One-byte character display" +//usage: "\n -C Canonical hex+ASCII, 16 bytes per line" +//usage: "\n -d Two-byte decimal display" +//usage: "\n -e FORMAT_STRING" +//usage: "\n -f FORMAT_FILE" +//usage: "\n -n LENGTH Interpret only LENGTH bytes of input" +//usage: "\n -o Two-byte octal display" +//usage: "\n -s OFFSET Skip OFFSET bytes" +//usage: "\n -v Display all input data" +//usage: "\n -x Two-byte hexadecimal display" +//usage: IF_FEATURE_HEXDUMP_REVERSE( +//usage: "\n -R Reverse of 'hexdump -Cv'") +//usage: +//usage:#define hd_trivial_usage +//usage: "FILE..." +//usage:#define hd_full_usage "\n\n" +//usage: "hd is an alias for hexdump -C" + #include "libbb.h" #include "dump.h" diff --git a/util-linux/ipcrm.c b/util-linux/ipcrm.c index e597ed637..bdd019f6f 100644 --- a/util-linux/ipcrm.c +++ b/util-linux/ipcrm.c @@ -8,6 +8,16 @@ * Licensed under GPLv2 or later, see file LICENSE in this source tree. */ +//usage:#define ipcrm_trivial_usage +//usage: "[-MQS key] [-mqs id]" +//usage:#define ipcrm_full_usage "\n\n" +//usage: "Upper-case options MQS remove an object by shmkey value.\n" +//usage: "Lower-case options remove an object by shmid value.\n" +//usage: "\nOptions:" +//usage: "\n -mM Remove memory segment after last detach" +//usage: "\n -qQ Remove message queue" +//usage: "\n -sS Remove semaphore" + #include "libbb.h" /* X/OPEN tells us to use <sys/{types,ipc,sem}.h> for semctl() */ diff --git a/util-linux/ipcs.c b/util-linux/ipcs.c index 14df65280..33035c62e 100644 --- a/util-linux/ipcs.c +++ b/util-linux/ipcs.c @@ -8,6 +8,22 @@ * Licensed under GPLv2 or later, see file LICENSE in this source tree. */ +//usage:#define ipcs_trivial_usage +//usage: "[[-smq] -i shmid] | [[-asmq] [-tcplu]]" +//usage:#define ipcs_full_usage "\n\n" +//usage: " -i Show specific resource" +//usage: "\nResource specification:" +//usage: "\n -m Shared memory segments" +//usage: "\n -q Message queues" +//usage: "\n -s Semaphore arrays" +//usage: "\n -a All (default)" +//usage: "\nOutput format:" +//usage: "\n -t Time" +//usage: "\n -c Creator" +//usage: "\n -p Pid" +//usage: "\n -l Limits" +//usage: "\n -u Summary" + /* X/OPEN tells us to use <sys/{types,ipc,sem}.h> for semctl() */ /* X/OPEN tells us to use <sys/{types,ipc,msg}.h> for msgctl() */ /* X/OPEN tells us to use <sys/{types,ipc,shm}.h> for shmctl() */ diff --git a/util-linux/losetup.c b/util-linux/losetup.c index 776f784f5..7e11e292d 100644 --- a/util-linux/losetup.c +++ b/util-linux/losetup.c @@ -7,6 +7,24 @@ * Licensed under GPLv2 or later, see file LICENSE in this source tree. */ +//usage:#define losetup_trivial_usage +//usage: "[-o OFS] LOOPDEV FILE - associate loop devices\n" +//usage: " losetup -d LOOPDEV - disassociate\n" +//usage: " losetup [-f] - show" +//usage:#define losetup_full_usage "\n\n" +//usage: "Options:" +//usage: "\n -o OFS Start OFS bytes into FILE" +//usage: "\n -f Show first free loop device" +//usage: +//usage:#define losetup_notes_usage +//usage: "No arguments will display all current associations.\n" +//usage: "One argument (losetup /dev/loop1) will display the current association\n" +//usage: "(if any), or disassociate it (with -d). The display shows the offset\n" +//usage: "and filename of the file the loop device is currently bound to.\n\n" +//usage: "Two arguments (losetup /dev/loop1 file.img) create a new association,\n" +//usage: "with an optional offset (-o 12345). Encryption is not yet supported.\n" +//usage: "losetup -f will show the first loop free loop device\n\n" + #include "libbb.h" int losetup_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE; diff --git a/util-linux/lspci.c b/util-linux/lspci.c index 46e93b04d..f59aec8a5 100644 --- a/util-linux/lspci.c +++ b/util-linux/lspci.c @@ -6,6 +6,15 @@ * * Licensed under GPLv2 or later, see file LICENSE in this source tree. */ + +//usage:#define lspci_trivial_usage +//usage: "[-mk]" +//usage:#define lspci_full_usage "\n\n" +//usage: "List all PCI devices" +//usage: "\n" +//usage: "\n -m Parseable output" +//usage: "\n -k Show driver" + #include "libbb.h" enum { diff --git a/util-linux/lsusb.c b/util-linux/lsusb.c index 6f9b54daa..540f21ec6 100644 --- a/util-linux/lsusb.c +++ b/util-linux/lsusb.c @@ -6,6 +6,10 @@ * * Licensed under GPLv2 or later, see file LICENSE in this source tree. */ + +//usage:#define lsusb_trivial_usage NOUSAGE_STR +//usage:#define lsusb_full_usage "" + #include "libbb.h" static int FAST_FUNC fileAction( diff --git a/util-linux/mdev.c b/util-linux/mdev.c index a970f91f2..2f225ac0b 100644 --- a/util-linux/mdev.c +++ b/util-linux/mdev.c @@ -7,6 +7,41 @@ * * Licensed under GPLv2, see file LICENSE in this source tree. */ + +//usage:#define mdev_trivial_usage +//usage: "[-s]" +//usage:#define mdev_full_usage "\n\n" +//usage: " -s Scan /sys and populate /dev during system boot\n" +//usage: "\n" +//usage: "It can be run by kernel as a hotplug helper. To activate it:\n" +//usage: " echo /sbin/mdev > /proc/sys/kernel/hotplug\n" +//usage: IF_FEATURE_MDEV_CONF( +//usage: "It uses /etc/mdev.conf with lines\n" +//usage: "[-]DEVNAME UID:GID PERM" +//usage: IF_FEATURE_MDEV_RENAME(" [>|=PATH]") +//usage: IF_FEATURE_MDEV_EXEC(" [@|$|*PROG]") +//usage: ) +//usage: +//usage:#define mdev_notes_usage "" +//usage: IF_FEATURE_MDEV_CONFIG( +//usage: "The mdev config file contains lines that look like:\n" +//usage: " hd[a-z][0-9]* 0:3 660\n\n" +//usage: "That's device name (with regex match), uid:gid, and permissions.\n\n" +//usage: IF_FEATURE_MDEV_EXEC( +//usage: "Optionally, that can be followed (on the same line) by a special character\n" +//usage: "and a command line to run after creating/before deleting the corresponding\n" +//usage: "device(s). The environment variable $MDEV indicates the active device node\n" +//usage: "(which is useful if it's a regex match). For example:\n\n" +//usage: " hdc root:cdrom 660 *ln -s $MDEV cdrom\n\n" +//usage: "The special characters are @ (run after creating), $ (run before deleting),\n" +//usage: "and * (run both after creating and before deleting). The commands run in\n" +//usage: "the /dev directory, and use system() which calls /bin/sh.\n\n" +//usage: ) +//usage: "Config file parsing stops on the first matching line. If no config\n" +//usage: "entry is matched, devices are created with default 0:0 660. (Make\n" +//usage: "the last line match .* to override this.)\n\n" +//usage: ) + #include "libbb.h" #include "xregex.h" diff --git a/util-linux/mkfs_ext2.c b/util-linux/mkfs_ext2.c index 871ec835e..f6ccc9c9e 100644 --- a/util-linux/mkfs_ext2.c +++ b/util-linux/mkfs_ext2.c @@ -7,6 +7,45 @@ * * Licensed under GPLv2, see file LICENSE in this source tree. */ + +//usage:#define mkfs_ext2_trivial_usage +//usage: "[-Fn] " +/* //usage: "[-c|-l filename] " */ +//usage: "[-b BLK_SIZE] " +/* //usage: "[-f fragment-size] [-g blocks-per-group] " */ +//usage: "[-i INODE_RATIO] [-I INODE_SIZE] " +/* //usage: "[-j] [-J journal-options] [-N number-of-inodes] " */ +//usage: "[-m RESERVED_PERCENT] " +/* //usage: "[-o creator-os] [-O feature[,...]] [-q] " */ +/* //usage: "[r fs-revision-level] [-E extended-options] [-v] [-F] " */ +//usage: "[-L LABEL] " +/* //usage: "[-M last-mounted-directory] [-S] [-T filesystem-type] " */ +//usage: "BLOCKDEV [KBYTES]" +//usage:#define mkfs_ext2_full_usage "\n\n" +//usage: " -b BLK_SIZE Block size, bytes" +/* //usage: "\n -c Check device for bad blocks" */ +/* //usage: "\n -E opts Set extended options" */ +/* //usage: "\n -f size Fragment size in bytes" */ +//usage: "\n -F Force" +/* //usage: "\n -g N Number of blocks in a block group" */ +//usage: "\n -i RATIO Max number of files is filesystem_size / RATIO" +//usage: "\n -I BYTES Inode size (min 128)" +/* //usage: "\n -j Create a journal (ext3)" */ +/* //usage: "\n -J opts Set journal options (size/device)" */ +/* //usage: "\n -l file Read bad blocks list from file" */ +//usage: "\n -L LBL Volume label" +//usage: "\n -m PERCENT Percent of blocks to reserve for admin" +/* //usage: "\n -M dir Set last mounted directory" */ +//usage: "\n -n Dry run" +/* //usage: "\n -N N Number of inodes to create" */ +/* //usage: "\n -o os Set the 'creator os' field" */ +/* //usage: "\n -O features Dir_index/filetype/has_journal/journal_dev/sparse_super" */ +/* //usage: "\n -q Quiet" */ +/* //usage: "\n -r rev Set filesystem revision" */ +/* //usage: "\n -S Write superblock and group descriptors only" */ +/* //usage: "\n -T fs-type Set usage type (news/largefile/largefile4)" */ +/* //usage: "\n -v Verbose" */ + #include "libbb.h" #include <linux/fs.h> #include <linux/ext2_fs.h> diff --git a/util-linux/mkfs_minix.c b/util-linux/mkfs_minix.c index 95499ba17..a8bc4b80d 100644 --- a/util-linux/mkfs_minix.c +++ b/util-linux/mkfs_minix.c @@ -63,6 +63,17 @@ * removed getopt based parser and added a hand rolled one. */ +//usage:#define mkfs_minix_trivial_usage +//usage: "[-c | -l FILE] [-nXX] [-iXX] BLOCKDEV [KBYTES]" +//usage:#define mkfs_minix_full_usage "\n\n" +//usage: "Make a MINIX filesystem\n" +//usage: "\nOptions:" +//usage: "\n -c Check device for bad blocks" +//usage: "\n -n [14|30] Maximum length of filenames" +//usage: "\n -i INODES Number of inodes for the filesystem" +//usage: "\n -l FILE Read bad blocks list from FILE" +//usage: "\n -v Make version 2 filesystem" + #include "libbb.h" #include <mntent.h> diff --git a/util-linux/mkfs_reiser.c b/util-linux/mkfs_reiser.c index 00ce8f1d1..463ae1e2a 100644 --- a/util-linux/mkfs_reiser.c +++ b/util-linux/mkfs_reiser.c @@ -6,6 +6,15 @@ * * Licensed under GPLv2, see file LICENSE in this source tree. */ + +//usage:#define mkfs_reiser_trivial_usage +//usage: "[-f] [-l LABEL] BLOCKDEV [4K-BLOCKS]" +//usage:#define mkfs_reiser_full_usage "\n\n" +//usage: "Make a ReiserFS V3 filesystem\n" +//usage: "\nOptions:" +//usage: "\n -f Force" +//usage: "\n -l LBL Volume label" + #include "libbb.h" #include <linux/fs.h> diff --git a/util-linux/mkfs_vfat.c b/util-linux/mkfs_vfat.c index bb5b59c66..e83ae7510 100644 --- a/util-linux/mkfs_vfat.c +++ b/util-linux/mkfs_vfat.c @@ -7,6 +7,23 @@ * * Licensed under GPLv2, see file LICENSE in this source tree. */ + +//usage:#define mkfs_vfat_trivial_usage +//usage: "[-v] [-n LABEL] BLOCKDEV [KBYTES]" +/* Accepted but ignored: + "[-c] [-C] [-I] [-l bad-block-file] [-b backup-boot-sector] " + "[-m boot-msg-file] [-i volume-id] " + "[-s sectors-per-cluster] [-S logical-sector-size] [-f number-of-FATs] " + "[-h hidden-sectors] [-F fat-size] [-r root-dir-entries] [-R reserved-sectors] " +*/ +//usage:#define mkfs_vfat_full_usage "\n\n" +//usage: "Make a FAT32 filesystem\n" +//usage: "\nOptions:" +/* //usage: "\n -c Check device for bad blocks" */ +//usage: "\n -v Verbose" +/* //usage: "\n -I Allow to use entire disk device (e.g. /dev/hda)" */ +//usage: "\n -n LBL Volume label" + #include "libbb.h" #include <linux/hdreg.h> /* HDIO_GETGEO */ diff --git a/util-linux/mkswap.c b/util-linux/mkswap.c index 2e9662b2b..ef6932c6c 100644 --- a/util-linux/mkswap.c +++ b/util-linux/mkswap.c @@ -5,6 +5,14 @@ * * Licensed under GPLv2, see file LICENSE in this source tree. */ + +//usage:#define mkswap_trivial_usage +//usage: "[-L LBL] BLOCKDEV [KBYTES]" +//usage:#define mkswap_full_usage "\n\n" +//usage: "Prepare BLOCKDEV to be used as swap partition\n" +//usage: "\nOptions:" +//usage: "\n -L LBL Label" + #include "libbb.h" #if ENABLE_SELINUX diff --git a/util-linux/more.c b/util-linux/more.c index 7160b8b00..efceb71ec 100644 --- a/util-linux/more.c +++ b/util-linux/more.c @@ -14,6 +14,14 @@ * Licensed under GPLv2 or later, see file LICENSE in this source tree. */ +//usage:#define more_trivial_usage +//usage: "[FILE]..." +//usage:#define more_full_usage "\n\n" +//usage: "View FILE (or stdin) one screenful at a time" +//usage: +//usage:#define more_example_usage +//usage: "$ dmesg | more\n" + #include "libbb.h" /* Support for FEATURE_USE_TERMIOS */ diff --git a/util-linux/mount.c b/util-linux/mount.c index 722d0be92..3e2ba1fab 100644 --- a/util-linux/mount.c +++ b/util-linux/mount.c @@ -16,6 +16,66 @@ // singlemount() can loop through /etc/filesystems for fstype detection. // mount_it_now() does the actual mount. // + +//usage:#define mount_trivial_usage +//usage: "[OPTIONS] [-o OPTS] DEVICE NODE" +//usage:#define mount_full_usage "\n\n" +//usage: "Mount a filesystem. Filesystem autodetection requires /proc.\n" +//usage: "\nOptions:" +//usage: "\n -a Mount all filesystems in fstab" +//usage: IF_FEATURE_MOUNT_FAKE( +//usage: IF_FEATURE_MTAB_SUPPORT( +//usage: "\n -f Update /etc/mtab, but don't mount" +//usage: ) +//usage: IF_NOT_FEATURE_MTAB_SUPPORT( +//usage: "\n -f Dry run" +//usage: ) +//usage: ) +//usage: IF_FEATURE_MOUNT_HELPERS( +//usage: "\n -i Don't run mount helper" +//usage: ) +//usage: IF_FEATURE_MTAB_SUPPORT( +//usage: "\n -n Don't update /etc/mtab" +//usage: ) +//usage: "\n -r Read-only mount" +//usage: "\n -w Read-write mount (default)" +//usage: "\n -t FSTYPE Filesystem type" +//usage: "\n -O OPT Mount only filesystems with option OPT (-a only)" +//usage: "\n-o OPT:" +//usage: IF_FEATURE_MOUNT_LOOP( +//usage: "\n loop Ignored (loop devices are autodetected)" +//usage: ) +//usage: IF_FEATURE_MOUNT_FLAGS( +//usage: "\n [a]sync Writes are [a]synchronous" +//usage: "\n [no]atime Disable/enable updates to inode access times" +//usage: "\n [no]diratime Disable/enable atime updates to directories" +//usage: "\n [no]relatime Disable/enable atime updates relative to modification time" +//usage: "\n [no]dev (Dis)allow use of special device files" +//usage: "\n [no]exec (Dis)allow use of executable files" +//usage: "\n [no]suid (Dis)allow set-user-id-root programs" +//usage: "\n [r]shared Convert [recursively] to a shared subtree" +//usage: "\n [r]slave Convert [recursively] to a slave subtree" +//usage: "\n [r]private Convert [recursively] to a private subtree" +//usage: "\n [un]bindable Make mount point [un]able to be bind mounted" +//usage: "\n [r]bind Bind a file or directory [recursively] to another location" +//usage: "\n move Relocate an existing mount point" +//usage: ) +//usage: "\n remount Remount a mounted filesystem, changing flags" +//usage: "\n ro/rw Same as -r/-w" +//usage: "\n" +//usage: "\nThere are filesystem-specific -o flags." +//usage: +//usage:#define mount_example_usage +//usage: "$ mount\n" +//usage: "/dev/hda3 on / type minix (rw)\n" +//usage: "proc on /proc type proc (rw)\n" +//usage: "devpts on /dev/pts type devpts (rw)\n" +//usage: "$ mount /dev/fd0 /mnt -t msdos -o ro\n" +//usage: "$ mount /tmp/diskimage /opt -t ext2 -o loop\n" +//usage: "$ mount cd_image.iso mydir\n" +//usage:#define mount_notes_usage +//usage: "Returns 0 for success, number of failed mounts for -a, or errno for one mount." + #include <mntent.h> #include <syslog.h> #include <sys/mount.h> diff --git a/util-linux/pivot_root.c b/util-linux/pivot_root.c index ac52a7aed..83f01fabd 100644 --- a/util-linux/pivot_root.c +++ b/util-linux/pivot_root.c @@ -8,6 +8,13 @@ * * Licensed under GPLv2, see file LICENSE in this source tree. */ + +//usage:#define pivot_root_trivial_usage +//usage: "NEW_ROOT PUT_OLD" +//usage:#define pivot_root_full_usage "\n\n" +//usage: "Move the current root file system to PUT_OLD and make NEW_ROOT\n" +//usage: "the new root file system" + #include "libbb.h" extern int pivot_root(const char * new_root,const char * put_old); diff --git a/util-linux/rdate.c b/util-linux/rdate.c index 2c3de74bc..628df0da7 100644 --- a/util-linux/rdate.c +++ b/util-linux/rdate.c @@ -8,6 +8,14 @@ * Licensed under GPLv2 or later, see file LICENSE in this source tree. */ +//usage:#define rdate_trivial_usage +//usage: "[-sp] HOST" +//usage:#define rdate_full_usage "\n\n" +//usage: "Get and possibly set the system date and time from a remote HOST\n" +//usage: "\nOptions:" +//usage: "\n -s Set the system date and time (default)" +//usage: "\n -p Print the date and time" + #include "libbb.h" enum { RFC_868_BIAS = 2208988800UL }; diff --git a/util-linux/rdev.c b/util-linux/rdev.c index 2fbb4d377..1212f841e 100644 --- a/util-linux/rdev.c +++ b/util-linux/rdev.c @@ -9,6 +9,15 @@ * */ +//usage:#define rdev_trivial_usage +//usage: "" +//usage:#define rdev_full_usage "\n\n" +//usage: "Print the device node associated with the filesystem mounted at '/'" +//usage: +//usage:#define rdev_example_usage +//usage: "$ rdev\n" +//usage: "/dev/mtdblock9 /\n" + #include "libbb.h" int rdev_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE; diff --git a/util-linux/readprofile.c b/util-linux/readprofile.c index f8a6e0cd0..7b7aa7c9f 100644 --- a/util-linux/readprofile.c +++ b/util-linux/readprofile.c @@ -32,6 +32,21 @@ * Paul Mundt <lethal@linux-sh.org>. */ +//usage:#define readprofile_trivial_usage +//usage: "[OPTIONS]" +//usage:#define readprofile_full_usage "\n\n" +//usage: "Options:" +//usage: "\n -m mapfile (Default: /boot/System.map)" +//usage: "\n -p profile (Default: /proc/profile)" +//usage: "\n -M NUM Set the profiling multiplier to NUM" +//usage: "\n -i Print only info about the sampling step" +//usage: "\n -v Verbose" +//usage: "\n -a Print all symbols, even if count is 0" +//usage: "\n -b Print individual histogram-bin counts" +//usage: "\n -s Print individual counters within functions" +//usage: "\n -r Reset all the counters (root only)" +//usage: "\n -n Disable byte order auto-detection" + #include "libbb.h" #include <sys/utsname.h> diff --git a/util-linux/rtcwake.c b/util-linux/rtcwake.c index 06ed7eafc..735a29822 100644 --- a/util-linux/rtcwake.c +++ b/util-linux/rtcwake.c @@ -23,6 +23,29 @@ * That flag should not be needed on systems with adjtime support. */ +//usage:#define rtcwake_trivial_usage +//usage: "[-a | -l | -u] [-d DEV] [-m MODE] [-s SEC | -t TIME]" +//usage:#define rtcwake_full_usage "\n\n" +//usage: "Enter a system sleep state until specified wakeup time\n" +//usage: IF_LONG_OPTS( +//usage: "\n -a,--auto Read clock mode from adjtime" +//usage: "\n -l,--local Clock is set to local time" +//usage: "\n -u,--utc Clock is set to UTC time" +//usage: "\n -d,--device=DEV Specify the RTC device" +//usage: "\n -m,--mode=MODE Set the sleep state (default: standby)" +//usage: "\n -s,--seconds=SEC Set the timeout in SEC seconds from now" +//usage: "\n -t,--time=TIME Set the timeout to TIME seconds from epoch" +//usage: ) +//usage: IF_NOT_LONG_OPTS( +//usage: "\n -a Read clock mode from adjtime" +//usage: "\n -l Clock is set to local time" +//usage: "\n -u Clock is set to UTC time" +//usage: "\n -d DEV Specify the RTC device" +//usage: "\n -m MODE Set the sleep state (default: standby)" +//usage: "\n -s SEC Set the timeout in SEC seconds from now" +//usage: "\n -t TIME Set the timeout to TIME seconds from epoch" +//usage: ) + #include "libbb.h" #include "rtc_.h" diff --git a/util-linux/script.c b/util-linux/script.c index 47efc4526..26f16ebf5 100644 --- a/util-linux/script.c +++ b/util-linux/script.c @@ -10,6 +10,19 @@ * * Licensed under GPLv2 or later, see file LICENSE in this source tree. */ + +//usage:#define script_trivial_usage +//usage: "[-afq" IF_SCRIPTREPLAY("t") "] [-c PROG] [OUTFILE]" +//usage:#define script_full_usage "\n\n" +//usage: "Options:" +//usage: "\n -a Append output" +//usage: "\n -c PROG Run PROG, not shell" +//usage: "\n -f Flush output after each write" +//usage: "\n -q Quiet" +//usage: IF_SCRIPTREPLAY( +//usage: "\n -t Send timing to stderr" +//usage: ) + #include "libbb.h" int script_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE; diff --git a/util-linux/scriptreplay.c b/util-linux/scriptreplay.c index 6eaba43fa..382f56d9a 100644 --- a/util-linux/scriptreplay.c +++ b/util-linux/scriptreplay.c @@ -7,6 +7,12 @@ * Licensed under GPLv2 or later, see file LICENSE in this source tree. * */ + +//usage:#define scriptreplay_trivial_usage +//usage: "timingfile [typescript [divisor]]" +//usage:#define scriptreplay_full_usage "\n\n" +//usage: "Play back typescripts, using timing information" + #include "libbb.h" int scriptreplay_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE; diff --git a/util-linux/setarch.c b/util-linux/setarch.c index 7d5dc247c..7b9421af1 100644 --- a/util-linux/setarch.c +++ b/util-linux/setarch.c @@ -5,7 +5,20 @@ * Copyright 2002 Andi Kleen, SuSE Labs. * * Licensed under GPLv2 or later, see file LICENSE in this source tree. -*/ + */ + +//usage:#define setarch_trivial_usage +//usage: "personality PROG ARGS" +//usage:#define setarch_full_usage "\n\n" +//usage: "Personality may be:\n" +//usage: " linux32 Set 32bit uname emulation\n" +//usage: " linux64 Set 64bit uname emulation" +//usage: +//usage:#define linux32_trivial_usage NOUSAGE_STR +//usage:#define linux32_full_usage "" +//usage: +//usage:#define linux64_trivial_usage NOUSAGE_STR +//usage:#define linux64_full_usage "" #include <sys/personality.h> diff --git a/util-linux/swaponoff.c b/util-linux/swaponoff.c index e2c060f30..b7cf69833 100644 --- a/util-linux/swaponoff.c +++ b/util-linux/swaponoff.c @@ -7,6 +7,23 @@ * Licensed under GPLv2, see file LICENSE in this source tree. */ +//usage:#define swapon_trivial_usage +//usage: "[-a]" IF_FEATURE_SWAPON_PRI(" [-p PRI]") " [DEVICE]" +//usage:#define swapon_full_usage "\n\n" +//usage: "Start swapping on DEVICE\n" +//usage: "\nOptions:" +//usage: "\n -a Start swapping on all swap devices" +//usage: IF_FEATURE_SWAPON_PRI( +//usage: "\n -p PRI Set swap device priority" +//usage: ) +//usage: +//usage:#define swapoff_trivial_usage +//usage: "[-a] [DEVICE]" +//usage:#define swapoff_full_usage "\n\n" +//usage: "Stop swapping on DEVICE\n" +//usage: "\nOptions:" +//usage: "\n -a Stop swapping on all swap devices" + #include "libbb.h" #include <mntent.h> #include <sys/swap.h> diff --git a/util-linux/switch_root.c b/util-linux/switch_root.c index d471437fd..7794de18d 100644 --- a/util-linux/switch_root.c +++ b/util-linux/switch_root.c @@ -5,6 +5,16 @@ * * Licensed under GPLv2, see file LICENSE in this source tree. */ + +//usage:#define switch_root_trivial_usage +//usage: "[-c /dev/console] NEW_ROOT NEW_INIT [ARGS]" +//usage:#define switch_root_full_usage "\n\n" +//usage: "Free initramfs and switch to another root fs:\n" +//usage: "chroot to NEW_ROOT, delete all in /, move NEW_ROOT to /,\n" +//usage: "execute NEW_INIT. PID must be 1. NEW_ROOT must be a mountpoint.\n" +//usage: "\nOptions:" +//usage: "\n -c DEV Reopen stdio to DEV after switch" + #include <sys/vfs.h> #include <sys/mount.h> #include "libbb.h" diff --git a/util-linux/umount.c b/util-linux/umount.c index 5597d9eba..1e576ca4e 100644 --- a/util-linux/umount.c +++ b/util-linux/umount.c @@ -7,6 +7,28 @@ * * Licensed under GPLv2, see file LICENSE in this source tree. */ + +//usage:#define umount_trivial_usage +//usage: "[OPTIONS] FILESYSTEM|DIRECTORY" +//usage:#define umount_full_usage "\n\n" +//usage: "Unmount file systems\n" +//usage: "\nOptions:" +//usage: IF_FEATURE_UMOUNT_ALL( +//usage: "\n -a Unmount all file systems" IF_FEATURE_MTAB_SUPPORT(" in /etc/mtab") +//usage: ) +//usage: IF_FEATURE_MTAB_SUPPORT( +//usage: "\n -n Don't erase /etc/mtab entries" +//usage: ) +//usage: "\n -r Try to remount devices as read-only if mount is busy" +//usage: "\n -l Lazy umount (detach filesystem)" +//usage: "\n -f Force umount (i.e., unreachable NFS server)" +//usage: IF_FEATURE_MOUNT_LOOP( +//usage: "\n -d Free loop device if it has been used" +//usage: ) +//usage: +//usage:#define umount_example_usage +//usage: "$ umount /dev/hdc1\n" + #include <mntent.h> #include <sys/mount.h> #include "libbb.h" |