Tools: Improve xkbcli help messages and manual pages

Add missing `--help` and `--short` entries.
xkbcommon · Oct 3, 2023 · e329b3f · e329b3f
1 parent 87dcf30
commit e329b3f
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 0 deletions.
diff --git a/tools/interactive-evdev.c b/tools/interactive-evdev.c
@@ -391,6 +391,8 @@ usage(FILE *fp, char *progname)
                         "          --enable-compose (enable Compose)\n"
                         "          --consumed-mode={xkb|gtk} (select the consumed modifiers mode, default: xkb)\n"
                         "          --without-x11-offset (don't add X11 keycode offset)\n"
+                    "Other:\n"
+                        "          --help (display this help and exit)\n"
         );
 }
 

diff --git a/tools/registry-list.c b/tools/registry-list.c
@@ -40,6 +40,7 @@ usage(const char *progname, FILE *fp)
             "  --ruleset=foo .......... Load the 'foo' ruleset\n"
             "  --skip-default-paths ... Do not load the default XKB paths\n"
             "  --load-exotic .......... Load the exotic (extra) rulesets\n"
+            "  --help ................. Print this help and exit\n"
             "\n"
             "Trailing arguments are treated as XKB base directory installations.\n",
             progname);

diff --git a/tools/xkbcli-how-to-type.1 b/tools/xkbcli-how-to-type.1
@@ -34,6 +34,9 @@ The XKB layout variant
 .
 .It Fl \-options Ar options
 The XKB options
+.
+.It Fl \-help
+Print a help message and exit.
 .El
 .
 .Sh SEE ALSO

diff --git a/tools/xkbcli-interactive-evdev.1 b/tools/xkbcli-interactive-evdev.1
@@ -68,6 +68,9 @@ The XKB options
 Specify a keymap path.
 This option is mutually exclusive with the RMLVO options.
 .
+.It Fl \-short
+Do not print layout nor Unicode keysym translation.
+.
 .It Fl \-report\-state\-changes
 Report changes to the keyboard state
 .