[git commit master 1/1] move help text from include/usage.src.h to console-tools/*.c

Denys Vlasenko vda.linux at googlemail.com
Mon Mar 28 00:51:01 UTC 2011


commit: http://git.busybox.net/busybox/commit/?id=55068c478ee8e8c058b0c9e37ce0ca57612c95b1
branch: http://git.busybox.net/busybox/commit/?id=refs/heads/master

Signed-off-by: Pere Orga <gotrunks at gmail.com>
Signed-off-by: Denys Vlasenko <vda.linux at googlemail.com>
---
 console-tools/chvt.c        |    6 ++
 console-tools/clear.c       |    6 ++
 console-tools/deallocvt.c   |    5 ++
 console-tools/dumpkmap.c    |    8 +++
 console-tools/fgconsole.c   |    5 ++
 console-tools/kbd_mode.c    |   12 +++++
 console-tools/loadfont.c    |   10 ++++
 console-tools/loadkmap.c    |   10 ++++
 console-tools/openvt.c      |   13 +++++
 console-tools/reset.c       |    5 ++
 console-tools/resize.c      |    6 ++
 console-tools/setconsole.c  |    7 +++
 console-tools/setkeycodes.c |   12 +++++
 console-tools/setlogcons.c  |    5 ++
 console-tools/showkey.c     |    9 ++++
 include/usage.src.h         |  111 -------------------------------------------
 16 files changed, 119 insertions(+), 111 deletions(-)

diff --git a/console-tools/chvt.c b/console-tools/chvt.c
index 07e58c3..b9c974f 100644
--- a/console-tools/chvt.c
+++ b/console-tools/chvt.c
@@ -6,6 +6,12 @@
  *
  * Licensed under GPLv2 or later, see file LICENSE in this source tree.
  */
+
+//usage:#define chvt_trivial_usage
+//usage:       "N"
+//usage:#define chvt_full_usage "\n\n"
+//usage:       "Change the foreground virtual terminal to /dev/ttyN"
+
 #include "libbb.h"
 
 int chvt_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
diff --git a/console-tools/clear.c b/console-tools/clear.c
index dcb9bfb..ac22b78 100644
--- a/console-tools/clear.c
+++ b/console-tools/clear.c
@@ -6,6 +6,12 @@
  *
  * Licensed under GPLv2 or later, see file LICENSE in this source tree.
  */
+
+//usage:#define clear_trivial_usage
+//usage:       ""
+//usage:#define clear_full_usage "\n\n"
+//usage:       "Clear screen"
+
 #include "libbb.h"
 
 int clear_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
diff --git a/console-tools/deallocvt.c b/console-tools/deallocvt.c
index 6a1d13d..b131c0a 100644
--- a/console-tools/deallocvt.c
+++ b/console-tools/deallocvt.c
@@ -10,6 +10,11 @@
 
 /* no options, no getopt */
 
+//usage:#define deallocvt_trivial_usage
+//usage:       "[N]"
+//usage:#define deallocvt_full_usage "\n\n"
+//usage:       "Deallocate unused virtual terminal /dev/ttyN"
+
 #include "libbb.h"
 
 /* From <linux/vt.h> */
diff --git a/console-tools/dumpkmap.c b/console-tools/dumpkmap.c
index 301a906..6b923d2 100644
--- a/console-tools/dumpkmap.c
+++ b/console-tools/dumpkmap.c
@@ -9,6 +9,14 @@
  */
 /* no options, no getopt */
 
+//usage:#define dumpkmap_trivial_usage
+//usage:       "> keymap"
+//usage:#define dumpkmap_full_usage "\n\n"
+//usage:       "Print a binary keyboard translation table to stdout"
+//usage:
+//usage:#define dumpkmap_example_usage
+//usage:       "$ dumpkmap > keymap\n"
+
 #include "libbb.h"
 
 /* From <linux/kd.h> */
diff --git a/console-tools/fgconsole.c b/console-tools/fgconsole.c
index e2dba48..54355be 100644
--- a/console-tools/fgconsole.c
+++ b/console-tools/fgconsole.c
@@ -7,6 +7,11 @@
  * Licensed under GPLv2 or later, see file LICENSE in this source tree.
  */
 
+//usage:#define fgconsole_trivial_usage
+//usage:	""
+//usage:#define fgconsole_full_usage "\n\n"
+//usage:	"Get active console"
+
 #include "libbb.h"
 
 /* From <linux/vt.h> */
diff --git a/console-tools/kbd_mode.c b/console-tools/kbd_mode.c
index 1481d0d..221a9f7 100644
--- a/console-tools/kbd_mode.c
+++ b/console-tools/kbd_mode.c
@@ -8,6 +8,18 @@
  *
  * Licensed under GPLv2 or later, see file LICENSE in this source tree.
  */
+
+//usage:#define kbd_mode_trivial_usage
+//usage:       "[-a|k|s|u] [-C TTY]"
+//usage:#define kbd_mode_full_usage "\n\n"
+//usage:       "Report or set the keyboard mode\n"
+//usage:     "\nOptions:"
+//usage:     "\n	-a	Default (ASCII)"
+//usage:     "\n	-k	Medium-raw (keyboard)"
+//usage:     "\n	-s	Raw (scancode)"
+//usage:     "\n	-u	Unicode (utf-8)"
+//usage:     "\n	-C TTY	Affect TTY instead of /dev/tty"
+
 #include "libbb.h"
 #include <linux/kd.h>
 
diff --git a/console-tools/loadfont.c b/console-tools/loadfont.c
index 079626c..588322b 100644
--- a/console-tools/loadfont.c
+++ b/console-tools/loadfont.c
@@ -9,6 +9,16 @@
  *
  * Licensed under GPLv2, see file LICENSE in this source tree.
  */
+
+//usage:#define loadfont_trivial_usage
+//usage:       "< font"
+//usage:#define loadfont_full_usage "\n\n"
+//usage:       "Load a console font from stdin"
+/* //usage:     "\n	-C TTY	Affect TTY instead of /dev/tty" */
+//usage:
+//usage:#define loadfont_example_usage
+//usage:       "$ loadfont < /etc/i18n/fontname\n"
+
 #include "libbb.h"
 #include <sys/kd.h>
 
diff --git a/console-tools/loadkmap.c b/console-tools/loadkmap.c
index 2d1c9e2..bcffe16 100644
--- a/console-tools/loadkmap.c
+++ b/console-tools/loadkmap.c
@@ -6,6 +6,16 @@
  *
  * Licensed under GPLv2 or later, see file LICENSE in this source tree.
  */
+
+//usage:#define loadkmap_trivial_usage
+//usage:       "< keymap"
+//usage:#define loadkmap_full_usage "\n\n"
+//usage:       "Load a binary keyboard translation table from stdin\n"
+/* //usage:     "\n	-C TTY	Affect TTY instead of /dev/tty" */
+//usage:
+//usage:#define loadkmap_example_usage
+//usage:       "$ loadkmap < /etc/i18n/lang-keymap\n"
+
 #include "libbb.h"
 
 #define BINARY_KEYMAP_MAGIC "bkeymap"
diff --git a/console-tools/openvt.c b/console-tools/openvt.c
index 56f50c6..de5cf93 100644
--- a/console-tools/openvt.c
+++ b/console-tools/openvt.c
@@ -8,6 +8,19 @@
  * Licensed under GPLv2 or later, see file LICENSE in this source tree.
  */
 
+//usage:#define openvt_trivial_usage
+//usage:       "[-c N] [-sw] [PROG ARGS]"
+//usage:#define openvt_full_usage "\n\n"
+//usage:       "Start PROG on a new virtual terminal\n"
+//usage:     "\nOptions:"
+//usage:     "\n	-c N	Use specified VT"
+//usage:     "\n	-s	Switch to the VT"
+/* //usage:     "\n	-l	Run PROG as login shell (by prepending '-')" */
+//usage:     "\n	-w	Wait for PROG to exit"
+//usage:
+//usage:#define openvt_example_usage
+//usage:       "openvt 2 /bin/ash\n"
+
 #include <linux/vt.h>
 #include "libbb.h"
 
diff --git a/console-tools/reset.c b/console-tools/reset.c
index a23e4f4..65940bd 100644
--- a/console-tools/reset.c
+++ b/console-tools/reset.c
@@ -11,6 +11,11 @@
 /* BTW, which "standard" package has this utility? It doesn't seem
  * to be ncurses, coreutils, console-tools... then what? */
 
+//usage:#define reset_trivial_usage
+//usage:       ""
+//usage:#define reset_full_usage "\n\n"
+//usage:       "Reset the screen"
+
 #include "libbb.h"
 
 #define ESC "\033"
diff --git a/console-tools/resize.c b/console-tools/resize.c
index ee0728b..4b0d63a 100644
--- a/console-tools/resize.c
+++ b/console-tools/resize.c
@@ -7,6 +7,12 @@
  * Licensed under GPLv2 or later, see file LICENSE in this source tree.
  */
 /* no options, no getopt */
+
+//usage:#define resize_trivial_usage
+//usage:       ""
+//usage:#define resize_full_usage "\n\n"
+//usage:       "Resize the screen"
+
 #include "libbb.h"
 
 #define ESC "\033"
diff --git a/console-tools/setconsole.c b/console-tools/setconsole.c
index 87265ba..59c8336 100644
--- a/console-tools/setconsole.c
+++ b/console-tools/setconsole.c
@@ -8,6 +8,13 @@
  * Licensed under GPLv2 or later, see file LICENSE in this source tree.
  */
 
+//usage:#define setconsole_trivial_usage
+//usage:       "[-r" IF_FEATURE_SETCONSOLE_LONG_OPTIONS("|--reset") "] [DEVICE]"
+//usage:#define setconsole_full_usage "\n\n"
+//usage:       "Redirect system console output to DEVICE (default: /dev/tty)\n"
+//usage:     "\nOptions:"
+//usage:     "\n	-r	Reset output to /dev/console"
+
 #include "libbb.h"
 
 int setconsole_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
diff --git a/console-tools/setkeycodes.c b/console-tools/setkeycodes.c
index ca8cd21..a6a7c23 100644
--- a/console-tools/setkeycodes.c
+++ b/console-tools/setkeycodes.c
@@ -8,6 +8,18 @@
  *
  * Licensed under GPLv2 or later, see file LICENSE in this source tree.
  */
+
+//usage:#define setkeycodes_trivial_usage
+//usage:       "SCANCODE KEYCODE..."
+//usage:#define setkeycodes_full_usage "\n\n"
+//usage:       "Set entries into the kernel's scancode-to-keycode map,\n"
+//usage:       "allowing unusual keyboards to generate usable keycodes.\n\n"
+//usage:       "SCANCODE may be either xx or e0xx (hexadecimal),\n"
+//usage:       "and KEYCODE is given in decimal."
+//usage:
+//usage:#define setkeycodes_example_usage
+//usage:       "$ setkeycodes e030 127\n"
+
 #include "libbb.h"
 
 /* From <linux/kd.h> */
diff --git a/console-tools/setlogcons.c b/console-tools/setlogcons.c
index 52d2608..83a8954 100644
--- a/console-tools/setlogcons.c
+++ b/console-tools/setlogcons.c
@@ -9,6 +9,11 @@
  * Licensed under GPLv2 or later, see file LICENSE in this source tree.
  */
 
+//usage:#define setlogcons_trivial_usage
+//usage:       "N"
+//usage:#define setlogcons_full_usage "\n\n"
+//usage:       "Redirect the kernel output to console N (0 for current)"
+
 #include "libbb.h"
 
 int setlogcons_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
diff --git a/console-tools/showkey.c b/console-tools/showkey.c
index 06df68b..2c832c9 100644
--- a/console-tools/showkey.c
+++ b/console-tools/showkey.c
@@ -7,6 +7,15 @@
  * Licensed under GPLv2, see file LICENSE in this source tree.
  */
 
+//usage:#define showkey_trivial_usage
+//usage:       "[-a | -k | -s]"
+//usage:#define showkey_full_usage "\n\n"
+//usage:       "Show keys pressed\n"
+//usage:     "\nOptions:"
+//usage:     "\n	-a	Display decimal/octal/hex values of the keys"
+//usage:     "\n	-k	Display interpreted keycodes (default)"
+//usage:     "\n	-s	Display raw scan-codes"
+
 #include "libbb.h"
 #include <linux/kd.h>
 
diff --git a/include/usage.src.h b/include/usage.src.h
index 69b8da2..c1720b5 100644
--- a/include/usage.src.h
+++ b/include/usage.src.h
@@ -403,21 +403,11 @@ INSERT
        "# ls -l /bin/ls\n" \
        "-rwxr-xr-x    1 root     root        40816 Feb  5 07:45 /bin/ls*\n"
 
-#define chvt_trivial_usage \
-       "N"
-#define chvt_full_usage "\n\n" \
-       "Change the foreground virtual terminal to /dev/ttyN"
-
 #define cksum_trivial_usage \
        "FILES..."
 #define cksum_full_usage "\n\n" \
        "Calculate the CRC32 checksums of FILES"
 
-#define clear_trivial_usage \
-       ""
-#define clear_full_usage "\n\n" \
-       "Clear screen"
-
 #define cmp_trivial_usage \
        "[-l] [-s] FILE1 [FILE2" IF_DESKTOP(" [SKIP1 [SKIP2]]") "]"
 #define cmp_full_usage "\n\n" \
@@ -614,11 +604,6 @@ INSERT
        "4+0 records in\n" \
        "4+0 records out\n"
 
-#define deallocvt_trivial_usage \
-       "[N]"
-#define deallocvt_full_usage "\n\n" \
-       "Deallocate unused virtual terminal /dev/ttyN"
-
 #define delgroup_trivial_usage \
 	IF_FEATURE_DEL_USER_FROM_GROUP("[USER] ")"GROUP"
 #define delgroup_full_usage "\n\n" \
@@ -806,13 +791,6 @@ INSERT
        "104     ./docs\n" \
        "2417    .\n"
 
-#define dumpkmap_trivial_usage \
-       "> keymap"
-#define dumpkmap_full_usage "\n\n" \
-       "Print a binary keyboard translation table to stdout"
-#define dumpkmap_example_usage \
-       "$ dumpkmap > keymap\n"
-
 #define dumpleases_trivial_usage \
        "[-r|-a] [-f LEASEFILE]"
 #define dumpleases_full_usage "\n\n" \
@@ -1037,11 +1015,6 @@ INSERT
      "\n	-H HEADS" \
      "\n	-S SECTORS" \
 
-#define fgconsole_trivial_usage \
-	""
-#define fgconsole_full_usage "\n\n" \
-	"Get active console"
-
 #define findfs_trivial_usage \
        "LABEL=label or UUID=uuid"
 #define findfs_full_usage "\n\n" \
@@ -1712,17 +1685,6 @@ INSERT
        "	[[i|o]seq] [[i|o]key KEY] [[i|o]csum]\n" \
        "	[ttl TTL] [tos TOS] [[no]pmtudisc] [dev PHYS_DEV]" \
 
-#define kbd_mode_trivial_usage \
-       "[-a|k|s|u] [-C TTY]"
-#define kbd_mode_full_usage "\n\n" \
-       "Report or set the keyboard mode\n" \
-     "\nOptions:" \
-     "\n	-a	Default (ASCII)" \
-     "\n	-k	Medium-raw (keyboard)" \
-     "\n	-s	Raw (scancode)" \
-     "\n	-u	Unicode (utf-8)" \
-     "\n	-C TTY	Affect TTY instead of /dev/tty" \
-
 #define kill_trivial_usage \
        "[-l] [-SIG] PID..."
 #define kill_full_usage "\n\n" \
@@ -1822,24 +1784,6 @@ INSERT
 #define load_policy_trivial_usage NOUSAGE_STR
 #define load_policy_full_usage ""
 
-#define loadfont_trivial_usage \
-       "< font"
-#define loadfont_full_usage "\n\n" \
-       "Load a console font from stdin" \
-/*   "\n	-C TTY	Affect TTY instead of /dev/tty" */ \
-
-#define loadfont_example_usage \
-       "$ loadfont < /etc/i18n/fontname\n"
-
-#define loadkmap_trivial_usage \
-       "< keymap"
-#define loadkmap_full_usage "\n\n" \
-       "Load a binary keyboard translation table from stdin\n" \
-/*   "\n	-C TTY	Affect TTY instead of /dev/tty" */ \
-
-#define loadkmap_example_usage \
-       "$ loadkmap < /etc/i18n/lang-keymap\n"
-
 #define logger_trivial_usage \
        "[OPTIONS] [MESSAGE]"
 #define logger_full_usage "\n\n" \
@@ -2405,19 +2349,6 @@ INSERT
        "Write an unambiguous representation, octal bytes by default, of FILE\n" \
        "(or stdin) to stdout"
 
-#define openvt_trivial_usage \
-       "[-c N] [-sw] [PROG ARGS]"
-#define openvt_full_usage "\n\n" \
-       "Start PROG on a new virtual terminal\n" \
-     "\nOptions:" \
-     "\n	-c N	Use specified VT" \
-     "\n	-s	Switch to the VT" \
-/*   "\n	-l	Run PROG as login shell (by prepending '-')" */ \
-     "\n	-w	Wait for PROG to exit" \
-
-#define openvt_example_usage \
-       "openvt 2 /bin/ash\n"
-
 /*
 #define parse_trivial_usage \
        "[-n MAXTOKENS] [-m MINTOKENS] [-d DELIMS] [-f FLAGS] FILE..."
@@ -2704,16 +2635,6 @@ INSERT
 #define scriptreplay_full_usage "\n\n" \
        "Play back typescripts, using timing information"
 
-#define reset_trivial_usage \
-       ""
-#define reset_full_usage "\n\n" \
-       "Reset the screen"
-
-#define resize_trivial_usage \
-       ""
-#define resize_full_usage "\n\n" \
-       "Resize the screen"
-
 #define restorecon_trivial_usage \
        "[-iFnRv] [-e EXCLUDEDIR]... [-o FILE] [-f FILE]"
 #define restorecon_full_usage "\n\n" \
@@ -2926,13 +2847,6 @@ INSERT
        "	-v	Verbose" \
      "\n	-b	Display current state of booleans" \
 
-#define setconsole_trivial_usage \
-       "[-r" IF_FEATURE_SETCONSOLE_LONG_OPTIONS("|--reset") "] [DEVICE]"
-#define setconsole_full_usage "\n\n" \
-       "Redirect system console output to DEVICE (default: /dev/tty)\n" \
-     "\nOptions:" \
-     "\n	-r	Reset output to /dev/console" \
-
 #define setenforce_trivial_usage \
        "[Enforcing | Permissive | 1 | 0]"
 #define setenforce_full_usage ""
@@ -2972,22 +2886,6 @@ INSERT
 #define setfont_example_usage \
        "$ setfont -m koi8-r /etc/i18n/fontname\n"
 
-#define setkeycodes_trivial_usage \
-       "SCANCODE KEYCODE..."
-#define setkeycodes_full_usage "\n\n" \
-       "Set entries into the kernel's scancode-to-keycode map,\n" \
-       "allowing unusual keyboards to generate usable keycodes.\n\n" \
-       "SCANCODE may be either xx or e0xx (hexadecimal),\n" \
-       "and KEYCODE is given in decimal." \
-
-#define setkeycodes_example_usage \
-       "$ setkeycodes e030 127\n"
-
-#define setlogcons_trivial_usage \
-       "N"
-#define setlogcons_full_usage "\n\n" \
-       "Redirect the kernel output to console N (0 for current)"
-
 #define setsebool_trivial_usage \
        "boolean value"
 
@@ -3012,15 +2910,6 @@ INSERT
      "\n	-f FILE Read from FILE instead of /var/log/wtmp" \
 	)
 
-#define showkey_trivial_usage \
-       "[-a | -k | -s]"
-#define showkey_full_usage "\n\n" \
-       "Show keys pressed\n" \
-     "\nOptions:" \
-     "\n	-a	Display decimal/octal/hex values of the keys" \
-     "\n	-k	Display interpreted keycodes (default)" \
-     "\n	-s	Display raw scan-codes" \
-
 #define slattach_trivial_usage \
        "[-cehmLF] [-s SPEED] [-p PROTOCOL] DEVICE"
 #define slattach_full_usage "\n\n" \
-- 
1.7.3.4



More information about the busybox-cvs mailing list