StreetLight
/
libxkbcommon
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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>
master
Ran Benita 2020-07-27 11:24:06 +03:00
parent 5649e4ae72
commit d5c6b58152
7 changed files with 225 additions and 236 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

74
tools/xkbcli-compile-keymap.1
View File

@ -1,70 +1,62 @@
.TH "XKBCLI\-COMPILE\-KEYMAP" "1" "" "" "libxkbcommon manual" .Dd July 27, 2020
.Dt XKBCLI\-COMPILE\-KEYMAP 1
.Os
. .
.SH "NAME" .Sh NAME
\fBxkbcli\-compile\-keymap\fR \- compile an XKB keymap .Nm "xkbcli compile\-keymap"
.Nd compile an XKB keymap
. .
.SH "SYNOPSIS" .Sh SYNOPSIS
\fBxkbcli\fR compile\-keymap [\-\-help] [OPTIONS] .Nm
.Op Ar options
. .
.SH "DESCRIPTION" .Sh DESCRIPTION
\fBxkbcli compile\-keymap\fR compiles and prints a keymap based on the given options. .Nm
compiles and prints a keymap based on the given options.
. .
.SH "OPTIONS" .Bl -tag -width Ds
. .It Fl \-help
.TP
\fB\-\-help\fR
Print help and exit Print help and exit
. .
.TP .It Fl \-verbose
.B \-\-verbose
Enable verbose debugging output Enable verbose debugging output
. .
.TP .It Fl \-rmlvo
.B \-\-rmlvo
Print the full RMLVO with the defaults filled in for missing elements Print the full RMLVO with the defaults filled in for missing elements
. .
.TP .It Fl \-from\-xkb
.B \-\-from\-xkb
Load the XKB file from stdin, ignore RMLVO options. Load the XKB file from stdin, ignore RMLVO options.
This option must not be used with \fB\-\-kccgst\fR. This option must not be used with
.Fl \-kccgst .
. .
.TP .It Fl \-include Ar PATH
.B \-\-include=PATH
Add the given path to the include path list. Add the given path to the include path list.
This option is order\-dependent, include paths given first are searched first. 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. 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. Use
.Fl -\-include\-defaults
to add the default include paths.
. .
.TP .It Fl \-include\-defaults
.B \-\-include\-defaults
Add the default set of include directories. Add the default set of include directories.
This option is order-dependent, include paths given first are searched first. This option is order-dependent, include paths given first are searched first.
. .
.TP .It Fl \-rules Ar rules
.B \-\-rules=<rules>
The XKB ruleset The XKB ruleset
. .
.TP .It Fl \-model Ar model
.B \-\-model=<model>
The XKB model The XKB model
. .
.TP .It Fl \-layout Ar layout
.B \-\-layout=<layout>
The XKB layout The XKB layout
. .
.TP .It Fl \-variant Ar variant
.B \-\-variant=<variant>
The XKB layout variant The XKB layout variant
. .
.TP .It Fl \-options Ar options
.B \-\-options=<options>
The XKB options The XKB options
.El
. .
.SH "SEE ALSO" .Sh SEE ALSO
\fBxkbcli\fR(1) .Xr xkbcli 1 ,
. .Lk https://xkbcommon.org "The libxkbcommon online documentation"
.P
The
.UR https://xkbcommon.org
libxkbcommon online documentation
.UE

57
tools/xkbcli-how-to-type.1
View File

@ -1,44 +1,41 @@
.TH "XKBCLI\-HOW\-TO\-TYPE" "1" "" "" "libxkbcommon manual" .Dd July 27, 2020
.Dt XKBCLI\-HOW\-TO\-TYPE 1
.Os
. .
.SH "NAME" .Sh NAME
\fBxkbcli\-how\-to\-type\fR \- query how to type a given Unicode codepoint .Nm "xkbcli how\-to\-type"
.Nd query how to type a given Unicode codepoint
. .
.SH "SYNOPSIS" .Sh SYNOPSIS
\fBxkbcli\fR how\-to\-type [OPTIONS] <codepoint> .Nm
.Op options
.Ar codepoint
. .
.SH "DESCRIPTION" .Sh DESCRIPTION
\fBxkbcli how\-to\-type\fR prints key sequences to type the given Unicode codepoint. .Nm
prints key sequences to type the given Unicode codepoint.
.Pp
Pipe into
.Dq "column \-ts $\'\e\et\'"
for nicely aligned output.
. .
.P .Bl -tag -width Ds
Pipe into \fBcolumn \-ts $\'\e\et\'\fR for nicely aligned output. .It Fl \-rules Ar rules
.
.SH "OPTIONS"
.
.TP
.B \-\-rules=<rules>
The XKB ruleset The XKB ruleset
. .
.TP .It Fl \-model Ar model
.B \-\-model=<model>
The XKB model The XKB model
. .
.TP .It Fl \-layout Ar layout
.B \-\-layout=<layout>
The XKB layout The XKB layout
. .
.TP .It Fl \-variant Ar variant
.B \-\-variant=<variant>
The XKB layout variant The XKB layout variant
. .
.TP .It Fl \-options Ar options
.B \-\-options=<options>
The XKB options The XKB options
.El
. .
.SH "SEE ALSO" .Sh SEE ALSO
\fBxkbcli\fR(1) .Xr xkbcli 1 ,
. .Lk https://xkbcommon.org "The libxkbcommon online documentation"
.P
The
.UR https://xkbcommon.org
libxkbcommon online documentation
.UE

89
tools/xkbcli-interactive-evdev.1
View File

@ -1,78 +1,77 @@
.TH "XKBCLI\-INTERACTIVE\-EVDEV" "1" "" "" "libxkbcommon manual" .Dd July 27, 2020
.Dt XKBCLI\-INTERACTIVE\-EVDEV 1
.Os
. .
.SH "NAME" .Sh NAME
\fBxkbcli\-interactive\-evdev\fR \- interactive debugger for XKB keymaps .Nm "xkbcli interactive\-evdev"
.Nd interactive debugger for XKB keymaps
. .
.SH "SYNOPSIS" .Sh SYNOPSIS
\fBxkbcli\fR interactive\-evdev [\-\-help] [OPTIONS] .Nm
.Op Ar options
. .
.SH "DESCRIPTION" .Sh DESCRIPTION
\fBxkbcli interactive\-evdev\fR is a commandline tool to interactively debug XKB keymaps by listening to \fB/dev/input/eventX\fR evdev devices (Linux). .Nm
is a commandline tool to interactively debug XKB keymaps by listening to
.Pa /dev/input/eventX
evdev devices (Linux).
. .
.P .Pp
.B xkbcli interactive\-evdev .Nm
requires permission to open the evdev device nodes. requires permission to open the evdev device nodes.
This usually requires being the \fBroot\fR user or belonging to the \fBinput\fR group. This usually requires being the
.Dq root
user or belonging to the
.Dq input
group.
. .
.P .Pp
Press the Escape key to exit. Press the
.Aq Escape
key to exit.
. .
.P .Pp
This is a debugging tool, its behavior or output is not guaranteed to be stable. This is a debugging tool, its behavior or output is not guaranteed to be stable.
. .
.SH "OPTIONS" .Bl -tag -width Ds
. .It Fl \-help
.TP
.B \-\-help
Print help and exit Print help and exit
. .
.TP .It Fl \-rules Ar rules
.B \-\-rules=<rules>
The XKB ruleset The XKB ruleset
. .
.TP .It Fl \-model Ar model
.B \-\-model=<model>
The XKB model The XKB model
. .
.TP .It Fl \-layout Ar layout
.B \-\-layout=<layout>
The XKB layout The XKB layout
. .
.TP .It Fl \-variant Ar variant
.B \-\-variant=<variant>
The XKB layout variant The XKB layout variant
. .
.TP .It Fl \-option Ar options
.B \-\-options=<options>
The XKB options The XKB options
. .
.TP .It Fl \-keymap Ar file
.B \-\-keymap=PATH
Specify a keymap path. Specify a keymap path.
This option is mutually exclusive with the RMLVO options. This option is mutually exclusive with the RMLVO options.
. .
.TP .It Fl \-report\-state\-changes
.B \-\-report\-state\-changes
Report changes to the keyboard state Report changes to the keyboard state
. .
.TP .It Fl \-enable\-compose
.B \-\-enable\-compose
Enable Compose functionality Enable Compose functionality
. .
.TP .It Fl \-consumed\-mode Brq xkb|gtk
.B \-\-consumed\-mode={xkb|gtk}
Set the consumed modifiers mode (default: xkb) Set the consumed modifiers mode (default: xkb)
. .
.TP .It Fl \-without\-x11\-offset
.B \-\-without\-x11\-offset
Don't add an offset of 8 when converting an evdev keycode to an XKB keycode. Don't add an offset of 8 when converting an evdev keycode to an XKB keycode.
You probably don't want this option. You probably don't want this option.
.El
. .
.SH "SEE ALSO" .Sh SEE ALSO
\fBxkbcli\fR(1), \fBxkbcli\-interactive\-wayland\fR(1), \fBxkbcli\-interactive\-x11\fR(1) .Xr xkbcli 1 ,
. .Xr xkbcli\-interactive\-wayland 1 ,
.P .Xr xkbcli\-interactive\-x11 1 ,
The .Lk https://xkbcommon.org "The libxkbcommon online documentation"
.UR https://xkbcommon.org
libxkbcommon online documentation
.UE

49
tools/xkbcli-interactive-wayland.1
View File

@ -1,34 +1,37 @@
.TH "XKBCLI\-INTERACTIVE\-WAYLAND" "1" "" "" "libxkbcommon manual" .Dd July 27, 2020
.Dt XKBCLI\-INTERACTIVE\-WAYLAND 1
.Os
. .
.SH "NAME" .Sh NAME
\fBxkbcli\-interactive\-wayland\fR \- interactive debugger for XKB keymaps .Nm "xkbcli interactive\-wayland"
.Nd interactive debugger for XKB keymaps
. .
.SH "SYNOPSIS" .Sh SYNOPSIS
\fBxkbcli\fR interactive\-wayland [\-\-help] [OPTIONS] .Nm
.Op Ar options
. .
.SH "DESCRIPTION" .Sh DESCRIPTION
\fBxkbcli interactive\-wayland\fR is a commandline tool to interactively debug XKB keymaps by listening to wayland events. .Nm
is a commandline tool to interactively debug XKB keymaps by listening to Wayland events.
. .
.P .Pp
This requires a Wayland compositor to be running. This requires a Wayland compositor to be running.
. .
.P .Pp
Press the Escape key to exit. Press the
.Aq Escape
key to exit.
. .
.P .Pp
This is a debugging tool, its behavior or output is not guaranteed to be stable. This is a debugging tool, its behavior or output is not guaranteed to be stable.
. .
.SH "OPTIONS" .Bl -tag -width Ds
. .It Fl \-help
.TP
.B \-\-help
Print help and exit Print help and exit
.El
. .
.SH "SEE ALSO" .Sh SEE ALSO
\fBxkbcli\fR(1), \fBxkbcli\-interactive\-evdev\fR(1), \fBxkbcli\-interactive\-x11\fR(1) .Xr xkbcli 1 ,
. .Xr xkbcli\-interactive\-evdev 1 ,
.P .Xr xkbcli\-interactive\-x11 1 ,
The .Lk https://xkbcommon.org "The libxkbcommon online documentation"
.UR https://xkbcommon.org
libxkbcommon online documentation
.UE

49
tools/xkbcli-interactive-x11.1
View File

@ -1,34 +1,37 @@
.TH "XKBCLI\-INTERACTIVE\-X11" "1" "" "" "libxkbcommon manual" .Dd July 27, 2020
.Dt XKBCLI\-INTERACTIVE\-X11 1
.Os
. .
.SH "NAME" .Sh NAME
\fBxkbcli\-interactive\-x11\fR \- interactive debugger for XKB keymaps .Nm "xkbcli interactive\-x11"
.Nd interactive debugger for XKB keymaps
. .
.SH "SYNOPSIS" .Sh SYNOPSIS
\fBxkbcli\fR interactive\-x11 [\-\-help] [OPTIONS] .Nm
.Op Ar options
. .
.SH "DESCRIPTION" .Sh DESCRIPTION
\fBxkbcli interactive\-x11\fR is a commandline tool to interactively debug XKB keymaps by listening to X11 events. .Nm
is a commandline tool to interactively debug XKB keymaps by listening to X11 events.
. .
.P .Pp
This requires an X server to be running. This requires an X server to be running.
. .
.P .Pp
Press the Escape key to exit. Press the
.Aq Escape
key to exit.
. .
.P .Pp
This is a debugging tool, its behavior or output is not guaranteed to be stable. This is a debugging tool, its behavior or output is not guaranteed to be stable.
. .
.SH "OPTIONS" .Bl -tag -width Ds
. .It Fl \-help
.TP
.B \-\-help
Print help and exit Print help and exit
.El
. .
.SH "SEE ALSO" .Sh SEE ALSO
\fBxkbcli\fR(1), \fBxkbcli\-interactive\-evdev\fR(1), \fBxkbcli\-interactive\-wayland\fR(1) .Xr xkbcli 1 ,
. .Xr xkbcli\-interactive\-evdev 1 ,
.P .Xr xkbcli\-interactive\-wayland 1 ,
The .Lk https://xkbcommon.org "The libxkbcommon online documentation"
.UR https://xkbcommon.org
libxkbcommon online documentation
.UE

53
tools/xkbcli-list.1
View File

@ -1,44 +1,39 @@
.TH "XKBCLI\-LIST" "1" "" "" "libxkbcommon manual" .Dd July 27, 2020
.Dt XKBCLI\-LIST 1
.Os
. .
.SH "NAME" .Sh NAME
\fBxkbcli\-list\fR \- list available XKB models, layouts, variants and options .Nm "xkbcli list"
.Nd list available XKB models, layouts, variants and options
. .
.SH "SYNOPSIS" .Sh SYNOPSIS
\fBxkbcli\fR list [\-\-help] [/path/to/xkbbase [/path/to/xkbbase] ...] .Nm
.Op Pa /path/to/xkbbase Oo Pa /path/to/xkbbase Oc ...
. .
.SH "DESCRIPTION" .Sh DESCRIPTION
\fBxkbcli list\fR is a commandline tool to list available model, layout, variant and option (MLVO) values from the XKB registry. .Nm
is a commandline tool to list available model, layout, variant and option (MLVO) values from the XKB registry.
. .
.P .Pp
Arguments provided on the commandline are treated as XKB base directory installations. Positional arguments provided on the commandline are treated as XKB base directory installations.
. .
.SH "OPTIONS" .Bl -tag -width Ds
. .It Fl \-help
.TP
.B \-\-help
Print help and exit Print help and exit
. .
.TP .It Fl \-verbose
.B \-v, \-\-verbose
Increase verbosity, use multiple times for debugging output Increase verbosity, use multiple times for debugging output
. .
.TP .It Fl \-ruleset Ar name
.B \-\-ruleset=<name>
Load the ruleset with the given name Load the ruleset with the given name
. .
.TP .It Fl \-skip\-default\-paths
.B \-\-skip\-default\-paths
Do not load the default XKB include paths Do not load the default XKB include paths
. .
.TP .It Fl \-load\-exotic
.B \-\-load\-exotic
Load exotic (extra) layouts Load exotic (extra) layouts
.El
. .
.SH "SEE ALSO" .Sh SEE ALSO
\fBxkbcli\fR(1) .Xr xkbcli 1 ,
. .Lk https://xkbcommon.org "The libxkbcommon online documentation"
.P
The
.UR https://xkbcommon.org
libxkbcommon online documentation
.UE

90
tools/xkbcli.1
View File

@ -1,65 +1,65 @@
.TH "XKBCLI" "1" "" "" "libxkbcommon manual" .Dd July 27, 2020
.Dt XKBCLI 1
.Os
. .
.SH "NAME" .Sh NAME
\fBxkbcli\fR \- tool to interact with XKB keymaps .Nm xkbcli
.Nd tool to interact with XKB keymaps
. .
.SH "SYNOPSIS" .Sh SYNOPSIS
\fBxkbcli\fR [\-\-help|\-\-version] <command> [\fIargs\fR] .Nm
.Ar command Bo arguments Bc
. .
.SH "DESCRIPTION" .Nm
\fBxkbcli\fR is a commandline tool to query, compile and test XKB keymaps, layouts and other elements. .Op Fl \-help | Fl \-version
. .
.SH "OPTIONS" .Sh DESCRIPTION
.Nm
is a commandline tool to query, compile and test XKB keymaps, layouts and other elements.
. .
.TP .Bl -tag -width Ds
.B \-\-help .It Fl \-help
Print help and exit Print help and exit
. .
.TP .It Fl \-version
.B \-\-version
Print the version and exit Print the version and exit
.El
. .
.SH "COMMANDS" .Ss COMMANDS
.Bl -tag -width Ds
.It Ic how\-to\-type
Show how to type a given Unicode codepoint, see
.Xr xkbcli\-how\-to\-type 1
. .
.TP .It Ic interactive\-x11
.B how\-to\-type Interactive debugger for XKB keymaps for X11, see
Show how to type a given Unicode codepoint, see \fBxkbcli\-how\-to\-type\fR(1) .Xr xkbcli\-interactive\-x11 1
. .
.TP .It Ic interactive\-wayland
.B interactive\-x11 Interactive debugger for XKB keymaps for Wayland, see
Interactive debugger for XKB keymaps for X11, see \fBxbkcli\-interactive\-x11\fR(1) .Xr xkbcli\-interactive\-wayland 1
. .
.TP .It Ic interactive\-evdev
.B interactive\-wayland Interactive debugger for XKB keymaps for evdev (Linux), see
Interactive debugger for XKB keymaps for Wayland, see \fBxkbcli\-interactive\-wayland\fR(1) .Xr xkbcli\-interactive\-evdev 1
. .
.TP .It Ic list
.B interactive\-evdev List available layouts and more, see
Interactive debugger for XKB keymaps for evdev (Linux), see \fBxkbcli\-interactive\-evdev\fR .Xr xkbcli\-list 1
.El
. .
.TP .Pp
.B list
List available layouts and more, see \fBxkbcli\-list\fR(1)
.
.P
Note that not all tools may be available on your system. Note that not all tools may be available on your system.
. .
.SH "EXIT STATUS" .Sh EXIT STATUS
. .Bl -tag -compact -width Ds
.TP .It 0
0
exited successfully exited successfully
. .It 1
.TP
1
an error occured an error occured
. .It 2
.TP
2
program was called with invalid arguments program was called with invalid arguments
.El
. .
.SH "SEE ALSO" .Sh SEE ALSO
The .Lk https://xkbcommon.org "The libxkbcommon online documentation"
.UR https://xkbcommon.org
libxkbcommon online documentation
.UE