From cd119a2824910cdc82a0186d90f105f48e1539d5 Mon Sep 17 00:00:00 2001 From: Peter Hutterer Date: Thu, 23 Jul 2020 09:37:15 +1000 Subject: Drop use of ronn, switch to raw roff instead Drop the ronn source files, check in the generated files instead. This gets rid of the ruby+gem+ronn toolchain requirement at the cost of having to edit raw man pages. ronn files are as-generated but with the preamble and generation date removed. The latter isn't important enough to keep, it'll just go stale for manually maintained files and it's not worth setting up a configure_file() just for that date. Signed-off-by: Peter Hutterer --- tools/tools-common.c | 8 +--- tools/xkbcli-compile-keymap.1 | 70 +++++++++++++++++++++++++++++++++ tools/xkbcli-compile-keymap.1.ronn | 63 ----------------------------- tools/xkbcli-how-to-type.1 | 41 +++++++++++++++++++ tools/xkbcli-how-to-type.1.ronn | 36 ----------------- tools/xkbcli-interactive-evdev.1 | 61 ++++++++++++++++++++++++++++ tools/xkbcli-interactive-evdev.1.ronn | 56 -------------------------- tools/xkbcli-interactive-wayland.1 | 25 ++++++++++++ tools/xkbcli-interactive-wayland.1.ronn | 28 ------------- tools/xkbcli-interactive-x11.1 | 25 ++++++++++++ tools/xkbcli-interactive-x11.1.ronn | 28 ------------- tools/xkbcli-list.1 | 41 +++++++++++++++++++ tools/xkbcli-list.1.ronn | 36 ----------------- tools/xkbcli.1 | 62 +++++++++++++++++++++++++++++ tools/xkbcli.1.ronn | 53 ------------------------- 15 files changed, 326 insertions(+), 307 deletions(-) create mode 100644 tools/xkbcli-compile-keymap.1 delete mode 100644 tools/xkbcli-compile-keymap.1.ronn create mode 100644 tools/xkbcli-how-to-type.1 delete mode 100644 tools/xkbcli-how-to-type.1.ronn create mode 100644 tools/xkbcli-interactive-evdev.1 delete mode 100644 tools/xkbcli-interactive-evdev.1.ronn create mode 100644 tools/xkbcli-interactive-wayland.1 delete mode 100644 tools/xkbcli-interactive-wayland.1.ronn create mode 100644 tools/xkbcli-interactive-x11.1 delete mode 100644 tools/xkbcli-interactive-x11.1.ronn create mode 100644 tools/xkbcli-list.1 delete mode 100644 tools/xkbcli-list.1.ronn create mode 100644 tools/xkbcli.1 delete mode 100644 tools/xkbcli.1.ronn (limited to 'tools') diff --git a/tools/tools-common.c b/tools/tools-common.c index a78bc9a..db17880 100644 --- a/tools/tools-common.c +++ b/tools/tools-common.c @@ -219,15 +219,9 @@ tools_exec_command(const char *prefix, int real_argc, char **real_argv) } command = real_argv[0]; -#ifdef _MSC_VER -#define PATH_SEP '\\' -#else -#define PATH_SEP '/' -#endif if (!snprintf_safe(executable, sizeof(executable), - "%s%c%s-%s", LIBXKBCOMMON_TOOL_PATH, PATH_SEP, - prefix, command)) { + "%s/%s-%s", LIBXKBCOMMON_TOOL_PATH, prefix, command)) { fprintf(stderr, "Failed to assemble command\n"); return EXIT_FAILURE; } diff --git a/tools/xkbcli-compile-keymap.1 b/tools/xkbcli-compile-keymap.1 new file mode 100644 index 0000000..eb4b0d3 --- /dev/null +++ b/tools/xkbcli-compile-keymap.1 @@ -0,0 +1,70 @@ +.TH "XKBCLI\-COMPILE\-KEYMAP" "1" "" "" "libxkbcommon manual" +. +.SH "NAME" +\fBxkbcli\-compile\-keymap\fR \- compile an XKB keymap +. +.SH "SYNOPSIS" +\fBxkbcli\fR compile\-keymap [\-\-help] [OPTIONS] +. +.SH "DESCRIPTION" +\fBxkbcli compile\-keymap\fR compiles and prints a keymap based on the given options\. +. +.SH "OPTIONS" +. +.TP +\fB\-\-help\fR +Print help and exit +. +.TP +\fB\-\-verbose\fR +Enable verbose debugging output +. +.TP +\fB\-\-kccgst\fR +Print a keymap which only includes the KcCGST component names instead of the full keymap +. +.TP +\fB\-\-rmlvo\fR +Print the full RMLVO with the defaults filled in for missing elements +. +.TP +\fB\-\-from\-xkb\fR +Load the XKB file from stdin, ignore RMLVO options\. This option must not be used with \fB\-\-kccgst\fR\. +. +.TP +\fB\-\-include\fR +Add the given path to the include path list\. This option is order\-dependent, include paths given first are searched first\. If an include path is given, the default include path list is not used\. Use \fB\-\-include\-defaults\fR to add the default include paths +. +.TP +\fB\-\-include\-defaults\fR +Add the default set of include directories\. This option is order\-dependent, include paths given first are searched first\. +. +.TP +\fB\-\-rules \fR +The XKB ruleset +. +.TP +\fB\-\-model \fR +The XKB model +. +.TP +\fB\-\-layout \fR: +. +.IP +The XKB layout +. +.TP +\fB\-\-variant \fR: +. +.IP +The XKB layout variant +. +.TP +\fB\-\-options \fR +The XKB options +. +.SH "SEE ALSO" +\fBxkbcli\fR(1) +. +.P +The libxkbcommon online documentation at \fIhttps://xkbcommon\.org\fR diff --git a/tools/xkbcli-compile-keymap.1.ronn b/tools/xkbcli-compile-keymap.1.ronn deleted file mode 100644 index 8b0c74a..0000000 --- a/tools/xkbcli-compile-keymap.1.ronn +++ /dev/null @@ -1,63 +0,0 @@ -# xkbcli-compile-keymap(1) - compile an XKB keymap - -## SYNOPSIS - -**xkbcli** compile-keymap \[--help\] \[OPTIONS\] - -## DESCRIPTION - -**xkbcli compile-keymap** compiles and prints a keymap based on the given -options. - -## OPTIONS - - * `--help`: - Print help and exit - - * `--verbose`: - Enable verbose debugging output - - * `--kccgst`: - Print a keymap which only includes the KcCGST component names instead of - the full keymap - - * ` --rmlvo`: - Print the full RMLVO with the defaults filled in for missing elements - - * ` --from-xkb`: - Load the XKB file from stdin, ignore RMLVO options. This option must not - be used with `--kccgst`. - - * ` --include`: - Add the given path to the include path list. This option is - order-dependent, include paths given first are searched first. - If an include path is given, the default include path list is - not used. Use `--include-defaults` to add the default include - paths - - * ` --include-defaults`: - Add the default set of include directories. - This option is order-dependent, include paths given first - are searched first. - - * ` --rules `: - The XKB ruleset - - * ` --model `: - The XKB model - * ` --layout `: - - The XKB layout - * ` --variant `: - - The XKB layout variant - - * ` --options `: - The XKB options - -## SEE ALSO - -**xkbcli**(1) - -The libxkbcommon online documentation at - diff --git a/tools/xkbcli-how-to-type.1 b/tools/xkbcli-how-to-type.1 new file mode 100644 index 0000000..60d42ff --- /dev/null +++ b/tools/xkbcli-how-to-type.1 @@ -0,0 +1,41 @@ +.TH "XKBCLI\-HOW\-TO\-TYPE" "1" "" "" "libxkbcommon manual" +. +.SH "NAME" +\fBxkbcli\-how\-to\-type\fR \- query how to type a given Unicode codepoint +. +.SH "SYNOPSIS" +\fBxkbcli\fR how\-to\-type [OPTIONS] +. +.SH "DESCRIPTION" +\fBxkbcli how\-to\-type\fR prints key sequences to type the given Unicode codepoint\. +. +.P +Pipe into \fBcolumn \-ts $\'\e\et\'\fR for nicely aligned output\. +. +.SH "OPTIONS" +. +.TP +\fB\-\-rules \fR +The XKB ruleset +. +.TP +\fB\-\-model \fR +The XKB model +. +.TP +\fB\-\-layout \fR +The XKB layout +. +.TP +\fB\-\-variant \fR +The XKB layout variant +. +.TP +\fB\-\-options \fR +The XKB options +. +.SH "SEE ALSO" +\fBxkbcli\fR(1) +. +.P +The libxkbcommon online documentation at \fIhttps://xkbcommon\.org\fR diff --git a/tools/xkbcli-how-to-type.1.ronn b/tools/xkbcli-how-to-type.1.ronn deleted file mode 100644 index fc3faa4..0000000 --- a/tools/xkbcli-how-to-type.1.ronn +++ /dev/null @@ -1,36 +0,0 @@ -# xkbcli-how-to-type(1) - query how to type a given Unicode codepoint - -## SYNOPSIS - -**xkbcli** how-to-type \[OPTIONS\] <codepoint> - -## DESCRIPTION - -**xkbcli how-to-type** prints key sequences to type the given Unicode -codepoint. - -Pipe into `column -ts $'\\t'` for nicely aligned output. - -## OPTIONS - - * `--rules `: - The XKB ruleset - - * `--model `: - The XKB model - - * `--layout `: - The XKB layout - - * `--variant `: - The XKB layout variant - - * `--options `: - The XKB options - -## SEE ALSO - -**xkbcli**(1) - -The libxkbcommon online documentation at - diff --git a/tools/xkbcli-interactive-evdev.1 b/tools/xkbcli-interactive-evdev.1 new file mode 100644 index 0000000..8b76dc7 --- /dev/null +++ b/tools/xkbcli-interactive-evdev.1 @@ -0,0 +1,61 @@ +.TH "XKBCLI\-INTERACTIVE\-EVDEV" "1" "" "" "libxkbcommon manual" +. +.SH "NAME" +\fBxkbcli\-interactive\-evdev\fR \- interactive debugger for XKB maps +. +.SH "SYNOPSIS" +\fBxkbcli\fR interactive\-evdev [\-\-help] [OPTIONS] +. +.SH "DESCRIPTION" +\fBxkbcli interactive\-evdev\fR is a commandline tool to interactively debug XKB maps by listening to \fB/dev/input/eventX\fR evdev devices\. +. +.P +This is a debugging tool, its behavior or output is not guaranteed to be stable\. +. +.SH "OPTIONS" +. +.TP +\fB\-\-help\fR +Print help and exit +. +.TP +\fB\-\-rules \fR +The XKB ruleset +. +.TP +\fB\-\-model \fR +The XKB model +. +.TP +\fB\-\-layout \fR +The XKB layout +. +.TP +\fB\-\-variant \fR +The XKB layout variant +. +.TP +\fB\-\-options \fR +The XKB options +. +.TP +\fB\-\-keymap\fR +Specify a keymap path\. This option is mutually exclusive with the rmlvo options\. +. +.TP +\fB\-\-report\-state\-changes\fR +Report changes to the keyboard state +. +.TP +\fB\-\-enable\-compose\fR +Enable compose functionality +. +.TP +\fB\-\-consumed\-mode={gtk|xkb}\fR +Set the consumed modifiers mode (default: xkb) +. +.SH "SEE ALSO" +\fBxkbcli\fR(1), \fBxkbcli\-interactive\-wayland\fR(1), \fBxkbcli\-interactive\-x11\fR(1) +. +.P +The libxkbcommon online documentation at \fIhttps://xkbcommon\.org\fR diff --git a/tools/xkbcli-interactive-evdev.1.ronn b/tools/xkbcli-interactive-evdev.1.ronn deleted file mode 100644 index 6b81837..0000000 --- a/tools/xkbcli-interactive-evdev.1.ronn +++ /dev/null @@ -1,56 +0,0 @@ -# xkbcli-interactive-evdev(1) - interactive debugger for XKB maps - -## SYNOPSIS - -**xkbcli** interactive-evdev \[--help\] \[OPTIONS\] - -## DESCRIPTION - -**xkbcli interactive-evdev** is a commandline tool to interactively -debug XKB maps by listening to `/dev/input/eventX` evdev devices. - -This is a debugging tool, its behavior or output is not guaranteed to be -stable. - -## OPTIONS - - * `--help`: - Print help and exit - - * `--rules `: - The XKB ruleset - - * `--model `: - The XKB model - - * `--layout `: - The XKB layout - - * `--variant `: - The XKB layout variant - - * `--options `: - The XKB options - - * `--keymap`: - Specify a keymap path. This option is mutually exclusive with the rmlvo - options. - - * `--report-state-changes`: - Report changes to the keyboard state - - * `--enable-compose`: - Enable compose functionality - - * `--consumed-mode={gtk|xkb}`: - Set the consumed modifiers mode (default: xkb) - - -## SEE ALSO - -**xkbcli**(1), -**xkbcli-interactive-wayland**(1), **xkbcli-interactive-x11**(1) - -The libxkbcommon online documentation at - - diff --git a/tools/xkbcli-interactive-wayland.1 b/tools/xkbcli-interactive-wayland.1 new file mode 100644 index 0000000..3d1aec3 --- /dev/null +++ b/tools/xkbcli-interactive-wayland.1 @@ -0,0 +1,25 @@ +.TH "XKBCLI\-INTERACTIVE\-WAYLAND" "1" "" "" "libxkbcommon manual" +. +.SH "NAME" +\fBxkbcli\-interactive\-wayland\fR \- interactive debugger for XKB maps +. +.SH "SYNOPSIS" +\fBxkbcli\fR interactive\-wayland [\-\-help] [OPTIONS] +. +.SH "DESCRIPTION" +\fBxkbcli interactive\-wayland\fR is a commandline tool to interactively debug XKB maps by listening to wayland events\. This requires a Wayland compositor to be running\. +. +.P +This is a debugging tool, its behavior or output is not guaranteed to be stable\. +. +.SH "OPTIONS" +. +.TP +\fB\-\-help\fR +Print help and exit +. +.SH "SEE ALSO" +\fBxkbcli\fR(1), \fBxkbcli\-interactive\-evdev\fR(1), \fBxkbcli\-interactive\-x11\fR(1) +. +.P +The libxkbcommon online documentation at \fIhttps://xkbcommon\.org\fR diff --git a/tools/xkbcli-interactive-wayland.1.ronn b/tools/xkbcli-interactive-wayland.1.ronn deleted file mode 100644 index 929f766..0000000 --- a/tools/xkbcli-interactive-wayland.1.ronn +++ /dev/null @@ -1,28 +0,0 @@ -# xkbcli-interactive-wayland(1) - interactive debugger for XKB maps - -## SYNOPSIS - -**xkbcli** interactive-wayland \[--help\] \[OPTIONS\] - -## DESCRIPTION - -**xkbcli interactive-wayland** is a commandline tool to interactively -debug XKB maps by listening to wayland events. This requires a Wayland -compositor to be running. - -This is a debugging tool, its behavior or output is not guaranteed to be -stable. - -## OPTIONS - - * `--help`: - Print help and exit - -## SEE ALSO - -**xkbcli**(1), **xkbcli-interactive-evdev**(1), -**xkbcli-interactive-x11**(1) - -The libxkbcommon online documentation at - - diff --git a/tools/xkbcli-interactive-x11.1 b/tools/xkbcli-interactive-x11.1 new file mode 100644 index 0000000..36e58e1 --- /dev/null +++ b/tools/xkbcli-interactive-x11.1 @@ -0,0 +1,25 @@ +.TH "XKBCLI\-INTERACTIVE\-X11" "1" "" "" "libxkbcommon manual" +. +.SH "NAME" +\fBxkbcli\-interactive\-x11\fR \- interactive debugger for XKB maps +. +.SH "SYNOPSIS" +\fBxkbcli\fR interactive\-x11 [\-\-help] [OPTIONS] +. +.SH "DESCRIPTION" +\fBxkbcli interactive\-x11\fR is a commandline tool to interactively debug XKB maps by listening to X11 events\. This requires an X server to be running\. +. +.P +This is a debugging tool, its behavior or output is not guaranteed to be stable\. +. +.SH "OPTIONS" +. +.TP +\fB\-\-help\fR +Print help and exit +. +.SH "SEE ALSO" +\fBxkbcli\fR(1), \fBxkbcli\-interactive\-evdev\fR(1), \fBxkbcli\-interactive\-wayland\fR(1) +. +.P +The libxkbcommon online documentation at \fIhttps://xkbcommon\.org\fR diff --git a/tools/xkbcli-interactive-x11.1.ronn b/tools/xkbcli-interactive-x11.1.ronn deleted file mode 100644 index f7b27f0..0000000 --- a/tools/xkbcli-interactive-x11.1.ronn +++ /dev/null @@ -1,28 +0,0 @@ -# xkbcli-interactive-x11(1) - interactive debugger for XKB maps - -## SYNOPSIS - -**xkbcli** interactive-x11 \[--help\] \[OPTIONS\] - -## DESCRIPTION - -**xkbcli interactive-x11** is a commandline tool to interactively -debug XKB maps by listening to X11 events. This requires an X server to be -running. - -This is a debugging tool, its behavior or output is not guaranteed to be -stable. - -## OPTIONS - - * `--help`: - Print help and exit - -## SEE ALSO - -**xkbcli**(1), **xkbcli-interactive-evdev**(1), -**xkbcli-interactive-wayland**(1) - -The libxkbcommon online documentation at - - diff --git a/tools/xkbcli-list.1 b/tools/xkbcli-list.1 new file mode 100644 index 0000000..3211efb --- /dev/null +++ b/tools/xkbcli-list.1 @@ -0,0 +1,41 @@ +.TH "XKBCLI\-LIST" "1" "" "" "libxkbcommon manual" +. +.SH "NAME" +\fBxkbcli\-list\fR \- list available XKB rules, models, layouts, variants and options +. +.SH "SYNOPSIS" +\fBxkbcli\fR list [\-\-help] [/path/to/xkbbase [/path/to/xkbbase] \.\.\.] +. +.SH "DESCRIPTION" +\fBxkbcli list\fR is a commandline tool to list available model, layout, variant and option (MLVO) values from the XKB registry\. +. +.P +Arguments provided on the commandline are treated as XKB base directory installations\. +. +.SH "OPTIONS" +. +.TP +\fB\-\-help\fR +Print help and exit +. +.TP +\fB\-v, \-\-verbose\fR +Increase verbosity, use multiple times for debugging output +. +.TP +\fB\-\-ruleset \fR +Load the ruleset with the given name +. +.TP +\fB\-\-skip\-default\-paths\fR +Do not load the default XKB include paths +. +.TP +\fB\-\-load\-exotic\fR +Load exotic (extra) layouts +. +.SH "SEE ALSO" +\fBxkbcli\fR(1) +. +.P +The libxkbcommon online documentation at \fIhttps://xkbcommon\.org\fR diff --git a/tools/xkbcli-list.1.ronn b/tools/xkbcli-list.1.ronn deleted file mode 100644 index 7681df0..0000000 --- a/tools/xkbcli-list.1.ronn +++ /dev/null @@ -1,36 +0,0 @@ -# xkbcli-list(1) - list available XKB rules, models, layouts, variants and options - -## SYNOPSIS - -**xkbcli** list [--help] [/path/to/xkbbase [/path/to/xkbbase] ...] - -## DESCRIPTION - -**xkbcli list** is a commandline tool to list available model, layout, variant -and option (MLVO) values from the XKB registry. - -Arguments provided on the commandline are treated as XKB base directory -installations. - -## OPTIONS - - * `--help`: - Print help and exit - - * `-v, --verbose`: - Increase verbosity, use multiple times for debugging output - - * `--ruleset `: - Load the ruleset with the given name - - * `--skip-default-paths`: - Do not load the default XKB include paths - - * `--load-exotic`: - Load exotic (extra) layouts - -## SEE ALSO - -**xkbcli**(1) - -The libxkbcommon online documentation at diff --git a/tools/xkbcli.1 b/tools/xkbcli.1 new file mode 100644 index 0000000..6cfe4a4 --- /dev/null +++ b/tools/xkbcli.1 @@ -0,0 +1,62 @@ +.TH "XKBCLI" "1" "" "" "libxkbcommon manual" +. +.SH "NAME" +\fBxkbcli\fR \- tool to interact with XKB keymaps +. +.SH "SYNOPSIS" +\fBxkbcli\fR [\-\-help|\-\-version] [\fIargs\fR] +. +.SH "DESCRIPTION" +\fBxkbcli\fR is a commandline tool to query, compile and test XKB keymaps, layouts and other elements\. +. +.SH "OPTIONS" +. +.TP +\fB\-\-help\fR +Print help and exit +. +.TP +\fB\-\-version\fR +Print the version and exit +. +.SH "COMMANDS" +. +.TP +\fBhow\-to\-type\fR +Show how to type a given unicode codepoint, see \fBxkbcli\-how\-to\-type\fR(1) +. +.TP +\fBinteractive\-x11\fR +Interactive debugger for XKB maps for X11, see \fBxbkcli\-interactive\-x11\fR(1) +. +.TP +\fBinteractive\-wayland\fR +Interactive debugger for XKB maps for Wayland, see \fBxkbcli\-interactive\-wayland\fR(1) +. +.TP +\fBinteractive\-evdev\fR +Interactive debugger for XKB maps for evdev, see \fBxkbcli\-interactive\-evdev\fR +. +.TP +\fBlist\fR +List available layouts and more, see \fBxkbcli\-list\fR(1) +. +.P +Note that not all tools may be available on your system\. +. +.SH "EXIT STATUS" +. +.TP +0 +exited successfully +. +.TP +1 +an error occured +. +.TP +2 +program was called with invalid arguments +. +.SH "SEE ALSO" +The libxkbcommon online documentation at \fIhttps://xkbcommon\.org\fR diff --git a/tools/xkbcli.1.ronn b/tools/xkbcli.1.ronn deleted file mode 100644 index b6a98f0..0000000 --- a/tools/xkbcli.1.ronn +++ /dev/null @@ -1,53 +0,0 @@ -# xkbcli(1) - tool to interact with XKB keymaps - -## SYNOPSIS - -**xkbcli** [--help|--version] <command> [] - -## DESCRIPTION - -**xkbcli** is a commandline tool to query, compile and test XKB keymaps, -layouts and other elements. - -## OPTIONS - - * `--help`: - Print help and exit - - * `--version`: - Print the version and exit - -## COMMANDS - - * `how-to-type`: - Show how to type a given unicode codepoint, see - `xkbcli-how-to-type`(1) - - * `interactive-x11`: - Interactive debugger for XKB maps for X11, see `xbkcli-interactive-x11`(1) - - * `interactive-wayland`: - Interactive debugger for XKB maps for Wayland, see - `xkbcli-interactive-wayland`(1) - - * `interactive-evdev`: - Interactive debugger for XKB maps for evdev, see - `xkbcli-interactive-evdev` - - * `list`: - List available layouts and more, see `xkbcli-list`(1) - -Note that not all tools may be available on your system. - -## EXIT STATUS - - * 0: - exited successfully - * 1: - an error occured - * 2: - program was called with invalid arguments - -## SEE ALSO - -The libxkbcommon online documentation at -- cgit v1.2.1