Skip to content

Commit

Permalink
doc (manuals): clean and expand apropos results
Browse files Browse the repository at this point in the history
Previously on FreeBSD/mandoc (probably affecting others), everything
except xkbcli was being listed twice and wrapping on standard console
in apropos because mdoc(7) names should not have spaces or be different
than the title.

Further, xkb is already parsed in search results by being in the name,
so expand xkb to "X keyboard" so that they match for apropos keyboard.
We did this already in xkbutils, which matches setxkbmap.

These don't need to be quoted literals, and - doesn't need to be escaped,
but I left them because there may be environments which are not to spec,
but I'm happy to ammend this commit if that cleanup seems desirable.

Co-authored-by: Ran Benita <ran@unusedvar.com>
  • Loading branch information
concussious and bluetech committed Jun 4, 2024
1 parent 11f7ef2 commit a4f62fc
Show file tree
Hide file tree
Showing 8 changed files with 22 additions and 22 deletions.
6 changes: 3 additions & 3 deletions tools/xkbcli-compile-compose.1
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
.Dd November 7, 2023
.Dd June 4, 2024
.Dt XKBCLI\-COMPILE\-COMPOSE 1
.Os
.
.Sh NAME
.Nm "xkbcli compile-compose"
.Nd compile a Compose file
.Nm "xkbcli\-compile\-compose"
.Nd compile an X Keyboard Compose file
.
.Sh SYNOPSIS
.Nm
Expand Down
6 changes: 3 additions & 3 deletions tools/xkbcli-compile-keymap.1
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
.Dd July 27, 2020
.Dd June 4, 2024
.Dt XKBCLI\-COMPILE\-KEYMAP 1
.Os
.
.Sh NAME
.Nm "xkbcli compile\-keymap"
.Nd compile an XKB keymap
.Nm "xkbcli\-compile\-keymap"
.Nd compile an X Keyboard keymap
.
.Sh SYNOPSIS
.Nm
Expand Down
4 changes: 2 additions & 2 deletions tools/xkbcli-how-to-type.1
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
.Dd July 27, 2020
.Dd June 4, 2024
.Dt XKBCLI\-HOW\-TO\-TYPE 1
.Os
.
.Sh NAME
.Nm "xkbcli how\-to\-type"
.Nm "xkbcli\-how\-to\-type"
.Nd query how to type a given Unicode codepoint
.
.Sh SYNOPSIS
Expand Down
6 changes: 3 additions & 3 deletions tools/xkbcli-interactive-evdev.1
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
.Dd July 27, 2020
.Dd June 4, 2024
.Dt XKBCLI\-INTERACTIVE\-EVDEV 1
.Os
.
.Sh NAME
.Nm "xkbcli interactive\-evdev"
.Nd interactive debugger for XKB keymaps
.Nm "xkbcli\-interactive\-evdev"
.Nd interactive debugger for X Keyboard keymaps
.
.Sh SYNOPSIS
.Nm
Expand Down
6 changes: 3 additions & 3 deletions tools/xkbcli-interactive-wayland.1
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
.Dd July 27, 2020
.Dd June 4, 2024
.Dt XKBCLI\-INTERACTIVE\-WAYLAND 1
.Os
.
.Sh NAME
.Nm "xkbcli interactive\-wayland"
.Nd interactive debugger for XKB keymaps
.Nm "xkbcli\-interactive\-wayland"
.Nd interactive debugger for X Keyboard keymaps
.
.Sh SYNOPSIS
.Nm
Expand Down
6 changes: 3 additions & 3 deletions tools/xkbcli-interactive-x11.1
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
.Dd July 27, 2020
.Dd June 4, 2024
.Dt XKBCLI\-INTERACTIVE\-X11 1
.Os
.
.Sh NAME
.Nm "xkbcli interactive\-x11"
.Nd interactive debugger for XKB keymaps
.Nm "xkbcli\-interactive\-x11"
.Nd interactive debugger for X Keyboard keymaps
.
.Sh SYNOPSIS
.Nm
Expand Down
6 changes: 3 additions & 3 deletions tools/xkbcli-list.1
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
.Dd November 1, 2021
.Dd June 04, 2024
.Dt XKBCLI\-LIST 1
.Os
.
.Sh NAME
.Nm "xkbcli list"
.Nd list available XKB models, layouts, variants and options
.Nm "xkbcli\-list"
.Nd list available X Keyboard models, layouts, variants and options
.
.Sh SYNOPSIS
.Nm
Expand Down
4 changes: 2 additions & 2 deletions tools/xkbcli.1
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
.Dd July 27, 2020
.Dd June 4, 2024
.Dt XKBCLI 1
.Os
.
.Sh NAME
.Nm xkbcli
.Nd tool to interact with XKB keymaps
.Nd tool to interact with X Keyboard keymaps
.
.Sh SYNOPSIS
.Nm
Expand Down

0 comments on commit a4f62fc

Please sign in to comment.