StreetLight
/
libxkbcommon
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
libxkbcommon/tools/xkbcli-compile-keymap.1

63 lines
1.3 KiB
Groff
Raw Normal View History

tools: convert man pages from man format to mdoc format The mdoc is more semantic and consistent. Signed-off-by: Ran Benita <ran@unusedvar.com>
2020-07-27 02:24:06 -06:00
.Dd July 27, 2020
.Dt XKBCLI\-COMPILE\-KEYMAP 1
.Os
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 <peter.hutterer@who-t.net>
2020-07-22 17:37:15 -06:00
.
tools: convert man pages from man format to mdoc format The mdoc is more semantic and consistent. Signed-off-by: Ran Benita <ran@unusedvar.com>
2020-07-27 02:24:06 -06:00
.Sh NAME
.Nm "xkbcli compile\-keymap"
.Nd compile an XKB keymap
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 <peter.hutterer@who-t.net>
2020-07-22 17:37:15 -06:00
.
tools: convert man pages from man format to mdoc format The mdoc is more semantic and consistent. Signed-off-by: Ran Benita <ran@unusedvar.com>
2020-07-27 02:24:06 -06:00
.Sh SYNOPSIS
.Nm
.Op Ar options
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 <peter.hutterer@who-t.net>
2020-07-22 17:37:15 -06:00
.
tools: convert man pages from man format to mdoc format The mdoc is more semantic and consistent. Signed-off-by: Ran Benita <ran@unusedvar.com>
2020-07-27 02:24:06 -06:00
.Sh DESCRIPTION
.Nm
compiles and prints a keymap based on the given options.
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 <peter.hutterer@who-t.net>
2020-07-22 17:37:15 -06:00
.
tools: convert man pages from man format to mdoc format The mdoc is more semantic and consistent. Signed-off-by: Ran Benita <ran@unusedvar.com>
2020-07-27 02:24:06 -06:00
.Bl -tag -width Ds
.It Fl \-help
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 <peter.hutterer@who-t.net>
2020-07-22 17:37:15 -06:00
Print help and exit
.
tools: convert man pages from man format to mdoc format The mdoc is more semantic and consistent. Signed-off-by: Ran Benita <ran@unusedvar.com>
2020-07-27 02:24:06 -06:00
.It Fl \-verbose
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 <peter.hutterer@who-t.net>
2020-07-22 17:37:15 -06:00
Enable verbose debugging output
.
tools: convert man pages from man format to mdoc format The mdoc is more semantic and consistent. Signed-off-by: Ran Benita <ran@unusedvar.com>
2020-07-27 02:24:06 -06:00
.It Fl \-rmlvo
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 <peter.hutterer@who-t.net>
2020-07-22 17:37:15 -06:00
Print the full RMLVO with the defaults filled in for missing elements
.
tools: convert man pages from man format to mdoc format The mdoc is more semantic and consistent. Signed-off-by: Ran Benita <ran@unusedvar.com>
2020-07-27 02:24:06 -06:00
.It Fl \-from\-xkb
tools: some minor changes to xkbcli Signed-off-by: Ran Benita <ran@unusedvar.com>
2020-07-25 02:17:11 -06:00
Load the XKB file from stdin, ignore RMLVO options.
tools: convert man pages from man format to mdoc format The mdoc is more semantic and consistent. Signed-off-by: Ran Benita <ran@unusedvar.com>
2020-07-27 02:24:06 -06:00
This option must not be used with
.Fl \-kccgst .
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 <peter.hutterer@who-t.net>
2020-07-22 17:37:15 -06:00
.
tools: convert man pages from man format to mdoc format The mdoc is more semantic and consistent. Signed-off-by: Ran Benita <ran@unusedvar.com>
2020-07-27 02:24:06 -06:00
.It Fl \-include Ar PATH
tools: some minor changes to xkbcli Signed-off-by: Ran Benita <ran@unusedvar.com>
2020-07-25 02:17:11 -06:00
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.
tools: convert man pages from man format to mdoc format The mdoc is more semantic and consistent. Signed-off-by: Ran Benita <ran@unusedvar.com>
2020-07-27 02:24:06 -06:00
Use
.Fl -\-include\-defaults
to add the default include paths.
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 <peter.hutterer@who-t.net>
2020-07-22 17:37:15 -06:00
.
tools: convert man pages from man format to mdoc format The mdoc is more semantic and consistent. Signed-off-by: Ran Benita <ran@unusedvar.com>
2020-07-27 02:24:06 -06:00
.It Fl \-include\-defaults
tools: some minor changes to xkbcli Signed-off-by: Ran Benita <ran@unusedvar.com>
2020-07-25 02:17:11 -06:00
Add the default set of include directories.
This option is order-dependent, include paths given first are searched first.
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 <peter.hutterer@who-t.net>
2020-07-22 17:37:15 -06:00
.
tools: convert man pages from man format to mdoc format The mdoc is more semantic and consistent. Signed-off-by: Ran Benita <ran@unusedvar.com>
2020-07-27 02:24:06 -06:00
.It Fl \-rules Ar rules
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 <peter.hutterer@who-t.net>
2020-07-22 17:37:15 -06:00
The XKB ruleset
.
tools: convert man pages from man format to mdoc format The mdoc is more semantic and consistent. Signed-off-by: Ran Benita <ran@unusedvar.com>
2020-07-27 02:24:06 -06:00
.It Fl \-model Ar model
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 <peter.hutterer@who-t.net>
2020-07-22 17:37:15 -06:00
The XKB model
.
tools: convert man pages from man format to mdoc format The mdoc is more semantic and consistent. Signed-off-by: Ran Benita <ran@unusedvar.com>
2020-07-27 02:24:06 -06:00
.It Fl \-layout Ar layout
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 <peter.hutterer@who-t.net>
2020-07-22 17:37:15 -06:00
The XKB layout
.
tools: convert man pages from man format to mdoc format The mdoc is more semantic and consistent. Signed-off-by: Ran Benita <ran@unusedvar.com>
2020-07-27 02:24:06 -06:00
.It Fl \-variant Ar variant
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 <peter.hutterer@who-t.net>
2020-07-22 17:37:15 -06:00
The XKB layout variant
.
tools: convert man pages from man format to mdoc format The mdoc is more semantic and consistent. Signed-off-by: Ran Benita <ran@unusedvar.com>
2020-07-27 02:24:06 -06:00
.It Fl \-options Ar options
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 <peter.hutterer@who-t.net>
2020-07-22 17:37:15 -06:00
The XKB options
tools: convert man pages from man format to mdoc format The mdoc is more semantic and consistent. Signed-off-by: Ran Benita <ran@unusedvar.com>
2020-07-27 02:24:06 -06:00
.El
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 <peter.hutterer@who-t.net>
2020-07-22 17:37:15 -06:00
.
tools: convert man pages from man format to mdoc format The mdoc is more semantic and consistent. Signed-off-by: Ran Benita <ran@unusedvar.com>
2020-07-27 02:24:06 -06:00
.Sh SEE ALSO
.Xr xkbcli 1 ,
.Lk https://xkbcommon.org "The libxkbcommon online documentation"