aboutsummaryrefslogtreecommitdiff
path: root/usage.h
diff options
context:
space:
mode:
Diffstat (limited to 'usage.h')
-rw-r--r--usage.h84
1 files changed, 44 insertions, 40 deletions
diff --git a/usage.h b/usage.h
index dd100332c..b10d927af 100644
--- a/usage.h
+++ b/usage.h
@@ -12,9 +12,9 @@
12 "\t-p timeconstant\n" 12 "\t-p timeconstant\n"
13 13
14#define ar_trivial_usage \ 14#define ar_trivial_usage \
15 "-[ovR]{ptx} archive filenames" 15 "-[ovR]{ptx} ARCHIVE FILES"
16#define ar_full_usage \ 16#define ar_full_usage \
17 "Extract or list files from an ar archive.\n\n" \ 17 "Extract or list FILES from an ar archive.\n\n" \
18 "Options:\n" \ 18 "Options:\n" \
19 "\t-o\t\tpreserve original dates\n" \ 19 "\t-o\t\tpreserve original dates\n" \
20 "\t-p\t\textract to stdout\n" \ 20 "\t-p\t\textract to stdout\n" \
@@ -213,7 +213,7 @@
213 #define USAGE_NOT_HUMAN_READABLE(a) a 213 #define USAGE_NOT_HUMAN_READABLE(a) a
214#endif 214#endif
215#define df_trivial_usage \ 215#define df_trivial_usage \
216 "[-" USAGE_HUMAN_READABLE("hm") USAGE_NOT_HUMAN_READABLE("") "k] [filesystem ...]" 216 "[-" USAGE_HUMAN_READABLE("hm") USAGE_NOT_HUMAN_READABLE("") "k] [FILESYSTEM ...]"
217#define df_full_usage \ 217#define df_full_usage \
218 "Print the filesystem space used and space available.\n\n" \ 218 "Print the filesystem space used and space available.\n\n" \
219 "Options:\n" \ 219 "Options:\n" \
@@ -251,23 +251,22 @@
251 "\t-s SIZE\t\tUse a buffer of size SIZE" 251 "\t-s SIZE\t\tUse a buffer of size SIZE"
252 252
253#define dos2unix_trivial_usage \ 253#define dos2unix_trivial_usage \
254 "[option] [file]" 254 "[option] [FILE]"
255#define dos2unix_full_usage \ 255#define dos2unix_full_usage \
256 "Converts a text file to/from dos format to unix format.\n\n" \ 256 "Converts FILE from dos format to unix format. When no option\n" \
257 "is given, the input is converted to the opposite output format.\n" \
258 "When no file is given, uses stdin for input and stdout for output." \
257 "Options:\n" \ 259 "Options:\n" \
258 "\t-u\toutput will be in UNIX format\n" \ 260 "\t-u\toutput will be in UNIX format\n" \
259 "\t-d\toutput will be in DOS format\n\n" \ 261 "\t-d\toutput will be in DOS format\n\n" \
260 "- when no option is given then input format will be automaticaly detected\n" \
261 " and converted to the oposite format on output\n" \
262 "- when no file is given, then stdin is used as input and stdout as output"
263 262
264#define dpkg_trivial_usage \ 263#define dpkg_trivial_usage \
265 "[-i|-r|--unpack|--configure] my.deb" 264 "[-i|-r|--unpack|--configure] my.deb"
266#define dpkg_full_usage \ 265#define dpkg_full_usage \
267 "WORK IN PROGRESS, only usefull for debian-installer" 266 "WORK IN PROGRESS, only useful for debian-installer"
268 267
269#define dpkg_deb_trivial_usage \ 268#define dpkg_deb_trivial_usage \
270 "[-cefItxX] file [argument]" 269 "[-cefItxX] FILE [argument]"
271#define dpkg_deb_full_usage \ 270#define dpkg_deb_full_usage \
272 "Perform actions on debian packages (.debs)\n\n" \ 271 "Perform actions on debian packages (.debs)\n\n" \
273 "Options:\n" \ 272 "Options:\n" \
@@ -519,7 +518,7 @@
519 "done\n" 518 "done\n"
520 519
521#define grep_trivial_usage \ 520#define grep_trivial_usage \
522 "[-ihHnqvs] pattern [files...]" 521 "[-ihHnqvs] PATTERN [FILEs...]"
523#define grep_full_usage \ 522#define grep_full_usage \
524 "Search for PATTERN in each FILE or standard input.\n\n" \ 523 "Search for PATTERN in each FILE or standard input.\n\n" \
525 "Options:\n" \ 524 "Options:\n" \
@@ -560,11 +559,11 @@
560 "\t-c\tWrite output to standard output instead of FILE.gz\n" \ 559 "\t-c\tWrite output to standard output instead of FILE.gz\n" \
561 "\t-d\tdecompress" 560 "\t-d\tdecompress"
562#define gzip_example_usage \ 561#define gzip_example_usage \
563 "$ ls -la /tmp/BusyBox*\n" \ 562 "$ ls -la /tmp/busybox*\n" \
564 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/BusyBox-0.43.tar\n" \ 563 "-rw-rw-r-- 1 andersen andersen 1761280 Apr 14 17:47 /tmp/busybox.tar\n" \
565 "$ gzip /tmp/BusyBox-0.43.tar\n" \ 564 "$ gzip /tmp/busybox.tar\n" \
566 "$ ls -la /tmp/BusyBox*\n" \ 565 "$ ls -la /tmp/busybox*\n" \
567 "-rw-rw-r-- 1 andersen andersen 554058 Apr 14 17:49 /tmp/BusyBox-0.43.tar.gz\n" 566 "-rw-rw-r-- 1 andersen andersen 554058 Apr 14 17:49 /tmp/busybox.tar.gz\n"
568 567
569#define halt_trivial_usage \ 568#define halt_trivial_usage \
570 "" 569 ""
@@ -590,10 +589,10 @@
590 "Print out a unique 32-bit identifier for the machine." 589 "Print out a unique 32-bit identifier for the machine."
591 590
592#define hostname_trivial_usage \ 591#define hostname_trivial_usage \
593 "[OPTION] {hostname | -F file}" 592 "[OPTION] {hostname | -F FILE}"
594#define hostname_full_usage \ 593#define hostname_full_usage \
595 "Get or set the hostname or DNS domain name. If a hostname is given\n" \ 594 "Get or set the hostname or DNS domain name. If a hostname is given\n" \
596 "(or a file with the -F parameter), the host name will be set.\n\n" \ 595 "(or FILE with the -F parameter), the host name will be set.\n\n" \
597 "Options:\n" \ 596 "Options:\n" \
598 "\t-s\t\tShort\n" \ 597 "\t-s\t\tShort\n" \
599 "\t-i\t\tAddresses for the hostname\n" \ 598 "\t-i\t\tAddresses for the hostname\n" \
@@ -601,7 +600,7 @@
601 "\t-F, --file FILE\tUse the contents of FILE to specify the hostname" 600 "\t-F, --file FILE\tUse the contents of FILE to specify the hostname"
602#define hostname_example_usage \ 601#define hostname_example_usage \
603 "$ hostname\n" \ 602 "$ hostname\n" \
604 "slag \n" 603 "sage \n"
605 604
606#define id_trivial_usage \ 605#define id_trivial_usage \
607 "[OPTIONS]... [USERNAME]" 606 "[OPTIONS]... [USERNAME]"
@@ -1004,7 +1003,7 @@
1004#define mkdir_trivial_usage \ 1003#define mkdir_trivial_usage \
1005 "[OPTION] DIRECTORY..." 1004 "[OPTION] DIRECTORY..."
1006#define mkdir_full_usage \ 1005#define mkdir_full_usage \
1007 "Create the DIRECTORY(ies), if they do not already exist\n\n" \ 1006 "Create the DIRECTORY(ies) if they do not already exist\n\n" \
1008 "Options:\n" \ 1007 "Options:\n" \
1009 "\t-m\tset permission mode (as in chmod), not rwxrwxrwx - umask\n" \ 1008 "\t-m\tset permission mode (as in chmod), not rwxrwxrwx - umask\n" \
1010 "\t-p\tno error if existing, make parent directories as needed" 1009 "\t-p\tno error if existing, make parent directories as needed"
@@ -1087,7 +1086,7 @@
1087 #define USAGE_MTAB(a) 1086 #define USAGE_MTAB(a)
1088#endif 1087#endif
1089#define mount_trivial_usage \ 1088#define mount_trivial_usage \
1090 "[flags] device node [-o options,more-options]" 1089 "[flags] DEVICE NODE [-o options,more-options]"
1091#define mount_full_usage \ 1090#define mount_full_usage \
1092 "Mount a filesystem\n\n" \ 1091 "Mount a filesystem\n\n" \
1093 "Flags:\n" \ 1092 "Flags:\n" \
@@ -1114,7 +1113,7 @@
1114 "\tro/rw:\t\tMount for read-only / read-write.\n" \ 1113 "\tro/rw:\t\tMount for read-only / read-write.\n" \
1115 "\tbind:\t\tUse the linux 2.4.x \"bind\" feature.\n" \ 1114 "\tbind:\t\tUse the linux 2.4.x \"bind\" feature.\n" \
1116 "\nThere are EVEN MORE flags that are specific to each filesystem.\n" \ 1115 "\nThere are EVEN MORE flags that are specific to each filesystem.\n" \
1117 "You'll have to see the written documentation for those." 1116 "You'll have to see the written documentation for those filesystems."
1118#define mount_example_usage \ 1117#define mount_example_usage \
1119 "$ mount\n" \ 1118 "$ mount\n" \
1120 "/dev/hda3 on / type minix (rw)\n" \ 1119 "/dev/hda3 on / type minix (rw)\n" \
@@ -1191,9 +1190,9 @@
1191 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n" 1190 "round-trip min/avg/max = 20.1/20.1/20.1 ms\n"
1192 1191
1193#define pivot_root_trivial_usage \ 1192#define pivot_root_trivial_usage \
1194 "new_root put_old" 1193 "NEW_ROOT PUT_OLD"
1195#define pivot_root_full_usage \ 1194#define pivot_root_full_usage \
1196 "Move the current root file system to put_old and make new_root\n" \ 1195 "Move the current root file system to PUT_OLD and make NEW_ROOT\n" \
1197 "the new root file system." 1196 "the new root file system."
1198 1197
1199#define poweroff_trivial_usage \ 1198#define poweroff_trivial_usage \
@@ -1382,27 +1381,27 @@
1382 "f\n" 1381 "f\n"
1383 1382
1384#define stty_trivial_usage \ 1383#define stty_trivial_usage \
1385 "[-a|g] [-F device] [SETTING]..." 1384 "[-a|g] [-F DEVICE] [SETTING]..."
1386#define stty_full_usage \ 1385#define stty_full_usage \
1387 "Without arguments, prints baud rate, line discipline," \ 1386 "Without arguments, prints baud rate, line discipline," \
1388 "\nand deviations from stty sane." \ 1387 "\nand deviations from stty sane." \
1389 "\n\nOptions:" \ 1388 "\n\nOptions:" \
1390 "\n\t-F device\topen device instead of stdin" \ 1389 "\n\t-F DEVICE\topen device instead of stdin" \
1391 "\n\t-a\t\tprint all current settings in human-readable form" \ 1390 "\n\t-a\t\tprint all current settings in human-readable form" \
1392 "\n\t-g\t\tprint in stty-readable form" \ 1391 "\n\t-g\t\tprint in stty-readable form" \
1393 "\n\t[SETTING]\tsee documentation" 1392 "\n\t[SETTING]\tsee documentation"
1394 1393
1395#define swapoff_trivial_usage \ 1394#define swapoff_trivial_usage \
1396 "[OPTION] [device]" 1395 "[OPTION] [DEVICE]"
1397#define swapoff_full_usage \ 1396#define swapoff_full_usage \
1398 "Stop swapping virtual memory pages on the given device.\n\n" \ 1397 "Stop swapping virtual memory pages on DEVICE.\n\n" \
1399 "Options:\n" \ 1398 "Options:\n" \
1400 "\t-a\tStop swapping on all swap devices" 1399 "\t-a\tStop swapping on all swap devices"
1401 1400
1402#define swapon_trivial_usage \ 1401#define swapon_trivial_usage \
1403 "[OPTION] [device]" 1402 "[OPTION] [DEVICE]"
1404#define swapon_full_usage \ 1403#define swapon_full_usage \
1405 "Start swapping virtual memory pages on the given device.\n\n" \ 1404 "Start swapping virtual memory pages on DEVICE.\n\n" \
1406 "Options:\n" \ 1405 "Options:\n" \
1407 "\t-a\tStart swapping on all swap devices" 1406 "\t-a\tStart swapping on all swap devices"
1408 1407
@@ -1471,8 +1470,8 @@
1471#endif 1470#endif
1472#define tar_trivial_usage \ 1471#define tar_trivial_usage \
1473 "-[" USAGE_TAR_CREATE("c") "xtvO] " \ 1472 "-[" USAGE_TAR_CREATE("c") "xtvO] " \
1474 USAGE_TAR_EXCLUDE("[--exclude File] [-X File]") \ 1473 USAGE_TAR_EXCLUDE("[--exclude FILE] [-X FILE]") \
1475 "[-f tarFile] [FILE(s)] ..." 1474 "[-f TARFILE] [FILE(s)] ..."
1476#define tar_full_usage \ 1475#define tar_full_usage \
1477 "Create, extract, or list files from a tar file.\n\n" \ 1476 "Create, extract, or list files from a tar file.\n\n" \
1478 "Main operation mode:\n" \ 1477 "Main operation mode:\n" \
@@ -1480,7 +1479,7 @@
1480 "\tx\t\textract\n" \ 1479 "\tx\t\textract\n" \
1481 "\tt\t\tlist\n" \ 1480 "\tt\t\tlist\n" \
1482 "\nFile selection:\n" \ 1481 "\nFile selection:\n" \
1483 "\tf\t\tname of tarfile or \"-\" for stdin\n" \ 1482 "\tf\t\tname of TARFILE or \"-\" for stdin\n" \
1484 "\tO\t\textract to stdout\n" \ 1483 "\tO\t\textract to stdout\n" \
1485 USAGE_TAR_EXCLUDE( \ 1484 USAGE_TAR_EXCLUDE( \
1486 "\texclude\t\tfile to exclude\n" \ 1485 "\texclude\t\tfile to exclude\n" \
@@ -1504,7 +1503,7 @@
1504 "Hello\n" 1503 "Hello\n"
1505 1504
1506#define telnet_trivial_usage \ 1505#define telnet_trivial_usage \
1507 "host [port]" 1506 "HOST [PORT]"
1508#define telnet_full_usage \ 1507#define telnet_full_usage \
1509 "Telnet is used to establish interactive communication with another\n"\ 1508 "Telnet is used to establish interactive communication with another\n"\
1510 "computer over a network using the TELNET protocol." 1509 "computer over a network using the TELNET protocol."
@@ -1553,9 +1552,9 @@
1553 "\nWhen naming a server, use the syntax \"server:file\"." 1552 "\nWhen naming a server, use the syntax \"server:file\"."
1554 1553
1555#define touch_trivial_usage \ 1554#define touch_trivial_usage \
1556 "[-c] file [file ...]" 1555 "[-c] FILE [FILE ...]"
1557#define touch_full_usage \ 1556#define touch_full_usage \
1558 "Update the last-modified date on the given file[s].\n\n" \ 1557 "Update the last-modified date on the given FILE[s].\n\n" \
1559 "Options:\n" \ 1558 "Options:\n" \
1560 "\t-c\tDo not create any files" 1559 "\t-c\tDo not create any files"
1561#define touch_example_usage \ 1560#define touch_example_usage \
@@ -1603,13 +1602,13 @@
1603 #define USAGE_MOUNT_FORCE(a) 1602 #define USAGE_MOUNT_FORCE(a)
1604#endif 1603#endif
1605#define umount_trivial_usage \ 1604#define umount_trivial_usage \
1606 "[flags] filesystem|directory" 1605 "[flags] FILESYSTEM|DIRECTORY"
1607#define umount_full_usage \ 1606#define umount_full_usage \
1608 "Unmount file systems\n" \ 1607 "Unmount file systems\n" \
1609 "\nFlags:\n" "\t-a\tUnmount all file systems" \ 1608 "\nFlags:\n" "\t-a\tUnmount all file systems" \
1610 USAGE_MTAB(" in /etc/mtab\n\t-n\tDon't erase /etc/mtab entries") \ 1609 USAGE_MTAB(" in /etc/mtab\n\t-n\tDon't erase /etc/mtab entries") \
1611 "\n\t-r\tTry to remount devices as read-only if mount is busy" \ 1610 "\n\t-r\tTry to remount devices as read-only if mount is busy" \
1612 USAGE_MOUNT_FORCE("\n\t-f\tForce filesystem umount (i.e. unreachable NFS server)") \ 1611 USAGE_MOUNT_FORCE("\n\t-f\tForce umount (i.e. unreachable NFS server)") \
1613 USAGE_MOUNT_LOOP("\n\t-l\tDo not free loop device (if a loop device has been used)") 1612 USAGE_MOUNT_LOOP("\n\t-l\tDo not free loop device (if a loop device has been used)")
1614#define umount_example_usage \ 1613#define umount_example_usage \
1615 "$ umount /dev/hdc1 \n" 1614 "$ umount /dev/hdc1 \n"
@@ -1646,9 +1645,14 @@
1646 "c\n" 1645 "c\n"
1647 1646
1648#define unix2dos_trivial_usage \ 1647#define unix2dos_trivial_usage \
1649 "[option] [file]" 1648 "[option] [FILE]"
1650#define unix2dos_full_usage \ 1649#define unix2dos_full_usage \
1651 "See 'dos2unix --help' for help!" 1650 "Converts FILE from unix format to dos format. When no option\n" \
1651 "is given, the input is converted to the opposite output format.\n" \
1652 "When no file is given, uses stdin for input and stdout for output." \
1653 "Options:\n" \
1654 "\t-u\toutput will be in UNIX format\n" \
1655 "\t-d\toutput will be in DOS format\n\n" \
1652 1656
1653#define update_trivial_usage \ 1657#define update_trivial_usage \
1654 "[options]" 1658 "[options]"