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