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>
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639
diff --git a/tools/xkbcli-compile-keymap.1 b/tools/xkbcli-compile-keymap.1
index 98498f7..4246512 100644
--- a/tools/xkbcli-compile-keymap.1
+++ b/tools/xkbcli-compile-keymap.1
@@ -1,70 +1,62 @@
-.TH "XKBCLI\-COMPILE\-KEYMAP" "1" "" "" "libxkbcommon manual"
+.Dd July 27, 2020
+.Dt XKBCLI\-COMPILE\-KEYMAP 1
+.Os
.
-.SH "NAME"
-\fBxkbcli\-compile\-keymap\fR \- compile an XKB keymap
+.Sh NAME
+.Nm "xkbcli compile\-keymap"
+.Nd compile an XKB keymap
.
-.SH "SYNOPSIS"
-\fBxkbcli\fR compile\-keymap [\-\-help] [OPTIONS]
+.Sh SYNOPSIS
+.Nm
+.Op Ar options
.
-.SH "DESCRIPTION"
-\fBxkbcli compile\-keymap\fR compiles and prints a keymap based on the given options.
+.Sh DESCRIPTION
+.Nm
+compiles and prints a keymap based on the given options.
.
-.SH "OPTIONS"
-.
-.TP
-\fB\-\-help\fR
+.Bl -tag -width Ds
+.It Fl \-help
Print help and exit
.
-.TP
-.B \-\-verbose
+.It Fl \-verbose
Enable verbose debugging output
.
-.TP
-.B \-\-rmlvo
+.It Fl \-rmlvo
Print the full RMLVO with the defaults filled in for missing elements
.
-.TP
-.B \-\-from\-xkb
+.It Fl \-from\-xkb
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
-.B \-\-include=PATH
+.It Fl \-include Ar PATH
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.
+Use
+.Fl -\-include\-defaults
+to add the default include paths.
.
-.TP
-.B \-\-include\-defaults
+.It Fl \-include\-defaults
Add the default set of include directories.
This option is order-dependent, include paths given first are searched first.
.
-.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 \-options Ar options
The XKB options
+.El
.
-.SH "SEE ALSO"
-\fBxkbcli\fR(1)
-.
-.P
-The
-.UR https://xkbcommon.org
-libxkbcommon online documentation
-.UE
+.Sh SEE ALSO
+.Xr xkbcli 1 ,
+.Lk https://xkbcommon.org "The libxkbcommon online documentation"
diff --git a/tools/xkbcli-how-to-type.1 b/tools/xkbcli-how-to-type.1
index aca5280..a697e20 100644
--- a/tools/xkbcli-how-to-type.1
+++ b/tools/xkbcli-how-to-type.1
@@ -1,44 +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] <codepoint>
-.
-.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
-.B \-\-rules=<rules>
+.Dd July 27, 2020
+.Dt XKBCLI\-HOW\-TO\-TYPE 1
+.Os
+.
+.Sh NAME
+.Nm "xkbcli how\-to\-type"
+.Nd query how to type a given Unicode codepoint
+.
+.Sh SYNOPSIS
+.Nm
+.Op options
+.Ar codepoint
+.
+.Sh DESCRIPTION
+.Nm
+prints key sequences to type the given Unicode codepoint.
+.Pp
+Pipe into
+.Dq "column \-ts $\'\e\et\'"
+for nicely aligned output.
+.
+.Bl -tag -width Ds
+.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 \-options Ar options
The XKB options
+.El
.
-.SH "SEE ALSO"
-\fBxkbcli\fR(1)
-.
-.P
-The
-.UR https://xkbcommon.org
-libxkbcommon online documentation
-.UE
+.Sh SEE ALSO
+.Xr xkbcli 1 ,
+.Lk https://xkbcommon.org "The libxkbcommon online documentation"
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"
diff --git a/tools/xkbcli-interactive-wayland.1 b/tools/xkbcli-interactive-wayland.1
index 4c534ad..d9ba1de 100644
--- a/tools/xkbcli-interactive-wayland.1
+++ b/tools/xkbcli-interactive-wayland.1
@@ -1,34 +1,37 @@
-.TH "XKBCLI\-INTERACTIVE\-WAYLAND" "1" "" "" "libxkbcommon manual"
+.Dd July 27, 2020
+.Dt XKBCLI\-INTERACTIVE\-WAYLAND 1
+.Os
.
-.SH "NAME"
-\fBxkbcli\-interactive\-wayland\fR \- interactive debugger for XKB keymaps
+.Sh NAME
+.Nm "xkbcli interactive\-wayland"
+.Nd interactive debugger for XKB keymaps
.
-.SH "SYNOPSIS"
-\fBxkbcli\fR interactive\-wayland [\-\-help] [OPTIONS]
+.Sh SYNOPSIS
+.Nm
+.Op Ar options
.
-.SH "DESCRIPTION"
-\fBxkbcli interactive\-wayland\fR is a commandline tool to interactively debug XKB keymaps by listening to wayland events.
+.Sh DESCRIPTION
+.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.
.
-.P
-Press the Escape key to exit.
+.Pp
+Press the
+.Aq Escape
+key to exit.
.
-.P
+.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
+.El
.
-.SH "SEE ALSO"
-\fBxkbcli\fR(1), \fBxkbcli\-interactive\-evdev\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\-evdev 1 ,
+.Xr xkbcli\-interactive\-x11 1 ,
+.Lk https://xkbcommon.org "The libxkbcommon online documentation"
diff --git a/tools/xkbcli-interactive-x11.1 b/tools/xkbcli-interactive-x11.1
index 72007c0..0f16f3f 100644
--- a/tools/xkbcli-interactive-x11.1
+++ b/tools/xkbcli-interactive-x11.1
@@ -1,34 +1,37 @@
-.TH "XKBCLI\-INTERACTIVE\-X11" "1" "" "" "libxkbcommon manual"
+.Dd July 27, 2020
+.Dt XKBCLI\-INTERACTIVE\-X11 1
+.Os
.
-.SH "NAME"
-\fBxkbcli\-interactive\-x11\fR \- interactive debugger for XKB keymaps
+.Sh NAME
+.Nm "xkbcli interactive\-x11"
+.Nd interactive debugger for XKB keymaps
.
-.SH "SYNOPSIS"
-\fBxkbcli\fR interactive\-x11 [\-\-help] [OPTIONS]
+.Sh SYNOPSIS
+.Nm
+.Op Ar options
.
-.SH "DESCRIPTION"
-\fBxkbcli interactive\-x11\fR is a commandline tool to interactively debug XKB keymaps by listening to X11 events.
+.Sh DESCRIPTION
+.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.
.
-.P
-Press the Escape key to exit.
+.Pp
+Press the
+.Aq Escape
+key to exit.
.
-.P
+.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
+.El
.
-.SH "SEE ALSO"
-\fBxkbcli\fR(1), \fBxkbcli\-interactive\-evdev\fR(1), \fBxkbcli\-interactive\-wayland\fR(1)
-.
-.P
-The
-.UR https://xkbcommon.org
-libxkbcommon online documentation
-.UE
+.Sh SEE ALSO
+.Xr xkbcli 1 ,
+.Xr xkbcli\-interactive\-evdev 1 ,
+.Xr xkbcli\-interactive\-wayland 1 ,
+.Lk https://xkbcommon.org "The libxkbcommon online documentation"
diff --git a/tools/xkbcli-list.1 b/tools/xkbcli-list.1
index 6f20cc1..a72477b 100644
--- a/tools/xkbcli-list.1
+++ b/tools/xkbcli-list.1
@@ -1,44 +1,39 @@
-.TH "XKBCLI\-LIST" "1" "" "" "libxkbcommon manual"
+.Dd July 27, 2020
+.Dt XKBCLI\-LIST 1
+.Os
.
-.SH "NAME"
-\fBxkbcli\-list\fR \- list available XKB models, layouts, variants and options
+.Sh NAME
+.Nm "xkbcli list"
+.Nd list available XKB models, layouts, variants and options
.
-.SH "SYNOPSIS"
-\fBxkbcli\fR list [\-\-help] [/path/to/xkbbase [/path/to/xkbbase] ...]
+.Sh SYNOPSIS
+.Nm
+.Op Pa /path/to/xkbbase Oo Pa /path/to/xkbbase Oc ...
.
-.SH "DESCRIPTION"
-\fBxkbcli list\fR is a commandline tool to list available model, layout, variant and option (MLVO) values from the XKB registry.
+.Sh DESCRIPTION
+.Nm
+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.
+.Pp
+Positional arguments provided on the commandline are treated as XKB base directory installations.
.
-.SH "OPTIONS"
-.
-.TP
-.B \-\-help
+.Bl -tag -width Ds
+.It Fl \-help
Print help and exit
.
-.TP
-.B \-v, \-\-verbose
+.It Fl \-verbose
Increase verbosity, use multiple times for debugging output
.
-.TP
-.B \-\-ruleset=<name>
+.It Fl \-ruleset Ar name
Load the ruleset with the given name
.
-.TP
-.B \-\-skip\-default\-paths
+.It Fl \-skip\-default\-paths
Do not load the default XKB include paths
.
-.TP
-.B \-\-load\-exotic
+.It Fl \-load\-exotic
Load exotic (extra) layouts
+.El
.
-.SH "SEE ALSO"
-\fBxkbcli\fR(1)
-.
-.P
-The
-.UR https://xkbcommon.org
-libxkbcommon online documentation
-.UE
+.Sh SEE ALSO
+.Xr xkbcli 1 ,
+.Lk https://xkbcommon.org "The libxkbcommon online documentation"
diff --git a/tools/xkbcli.1 b/tools/xkbcli.1
index 6250291..9ea0416 100644
--- a/tools/xkbcli.1
+++ b/tools/xkbcli.1
@@ -1,65 +1,65 @@
-.TH "XKBCLI" "1" "" "" "libxkbcommon manual"
+.Dd July 27, 2020
+.Dt XKBCLI 1
+.Os
.
-.SH "NAME"
-\fBxkbcli\fR \- tool to interact with XKB keymaps
+.Sh NAME
+.Nm xkbcli
+.Nd tool to interact with XKB keymaps
.
-.SH "SYNOPSIS"
-\fBxkbcli\fR [\-\-help|\-\-version] <command> [\fIargs\fR]
+.Sh SYNOPSIS
+.Nm
+.Ar command Bo arguments Bc
.
-.SH "DESCRIPTION"
-\fBxkbcli\fR is a commandline tool to query, compile and test XKB keymaps, layouts and other elements.
+.Nm
+.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
-.B \-\-help
+.Bl -tag -width Ds
+.It Fl \-help
Print help and exit
.
-.TP
-.B \-\-version
+.It Fl \-version
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
-.B how\-to\-type
-Show how to type a given Unicode codepoint, see \fBxkbcli\-how\-to\-type\fR(1)
+.It Ic interactive\-x11
+Interactive debugger for XKB keymaps for X11, see
+.Xr xkbcli\-interactive\-x11 1
.
-.TP
-.B interactive\-x11
-Interactive debugger for XKB keymaps for X11, see \fBxbkcli\-interactive\-x11\fR(1)
+.It Ic interactive\-wayland
+Interactive debugger for XKB keymaps for Wayland, see
+.Xr xkbcli\-interactive\-wayland 1
.
-.TP
-.B interactive\-wayland
-Interactive debugger for XKB keymaps for Wayland, see \fBxkbcli\-interactive\-wayland\fR(1)
+.It Ic interactive\-evdev
+Interactive debugger for XKB keymaps for evdev (Linux), see
+.Xr xkbcli\-interactive\-evdev 1
.
-.TP
-.B interactive\-evdev
-Interactive debugger for XKB keymaps for evdev (Linux), see \fBxkbcli\-interactive\-evdev\fR
+.It Ic list
+List available layouts and more, see
+.Xr xkbcli\-list 1
+.El
.
-.TP
-.B list
-List available layouts and more, see \fBxkbcli\-list\fR(1)
-.
-.P
+.Pp
Note that not all tools may be available on your system.
.
-.SH "EXIT STATUS"
-.
-.TP
-0
+.Sh EXIT STATUS
+.Bl -tag -compact -width Ds
+.It 0
exited successfully
-.
-.TP
-1
+.It 1
an error occured
-.
-.TP
-2
+.It 2
program was called with invalid arguments
+.El
.
-.SH "SEE ALSO"
-The
-.UR https://xkbcommon.org
-libxkbcommon online documentation
-.UE
+.Sh SEE ALSO
+.Lk https://xkbcommon.org "The libxkbcommon online documentation"