diff options
author | Peter Hutterer <peter.hutterer@who-t.net> | 2017-06-02 12:15:50 +1000 |
---|---|---|
committer | Peter Hutterer <peter.hutterer@who-t.net> | 2017-06-02 12:21:35 +1000 |
commit | 5d2959aef9100da4f57d910e5c423ccc9b950c20 (patch) | |
tree | ad2fbd9f1c6e8d281769bf104f0f69a048b19e8f /tools | |
parent | 6511154705ce2df80062b8aff4983b8524871d22 (diff) |
tools: escape all dashes in man pages (for commands and options)
Apparently the rule is that if a dash may end up being copy/pasted, it needs
to be escaped.
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Diffstat (limited to 'tools')
-rw-r--r-- | tools/libinput-debug-events.1 | 14 | ||||
-rw-r--r-- | tools/libinput-debug-gui.1 | 10 | ||||
-rw-r--r-- | tools/libinput-list-devices.1 | 10 | ||||
-rw-r--r-- | tools/libinput-measure-touchpad-tap.1 | 20 | ||||
-rw-r--r-- | tools/libinput-measure.1 | 8 | ||||
-rw-r--r-- | tools/libinput.1 | 22 |
6 files changed, 42 insertions, 42 deletions
diff --git a/tools/libinput-debug-events.1 b/tools/libinput-debug-events.1 index 6f23988..ab95fc3 100644 --- a/tools/libinput-debug-events.1 +++ b/tools/libinput-debug-events.1 @@ -1,12 +1,12 @@ .TH libinput-debug-events "1" .SH NAME -libinput-debug-events \- debug helper for libinput +libinput\-debug\-events \- debug helper for libinput .SH SYNOPSIS -.B libinput debug-events [--help] [--show-keycodes] +.B libinput debug\-events [\-\-help] [\-\-show\-keycodes] .SH DESCRIPTION .PP The -.B "libinput debug-events" +.B "libinput debug\-events" tool creates a libinput context and prints all events from these devices. .PP This is a debugging tool only, its output may change at any time. Do not @@ -16,16 +16,16 @@ This tool usually needs to be run as root to have access to the /dev/input/eventX nodes. .SH OPTIONS .TP 8 -.B --help +.B \-\-help Print help .TP 8 -.B --show-keycodes +.B \-\-show\-keycodes Key events shown by this tool are partially obfuscated to avoid passwords and other sensitive information showing up in the output. Use the -.B --show-keycodes +.B \-\-show\-keycodes argument to make all keycodes visible. .PP -For all other options, see the output from --help. Options may be added or +For all other options, see the output from \-\-help. Options may be added or removed at any time. .SH NOTES .PP diff --git a/tools/libinput-debug-gui.1 b/tools/libinput-debug-gui.1 index f5db17d..1d289fd 100644 --- a/tools/libinput-debug-gui.1 +++ b/tools/libinput-debug-gui.1 @@ -1,12 +1,12 @@ .TH libinput-debug-gui "1" .SH NAME -libinput-debug-gui \- visual debug helper for libinput +libinput\-debug\-gui \- visual debug helper for libinput .SH SYNOPSIS -.B libinput debug-gui [--help] +.B libinput debug\-gui [\-\-help] .SH DESCRIPTION .PP The -.B "libinput debug-gui" +.B "libinput debug\-gui" tool creates a libinput context and a full-screen GTK window to visualize events processed by libinput. .PP @@ -17,10 +17,10 @@ This tool usually needs to be run as root to have access to the /dev/input/eventX nodes. .SH OPTIONS .TP 8 -.B --help +.B \-\-help Print help .PP -For all other options, see the output from --help. Options may be added or +For all other options, see the output from \-\-help. Options may be added or removed at any time. .SH NOTES .PP diff --git a/tools/libinput-list-devices.1 b/tools/libinput-list-devices.1 index 386d79c..1d68a67 100644 --- a/tools/libinput-list-devices.1 +++ b/tools/libinput-list-devices.1 @@ -1,12 +1,12 @@ .TH libinput-list-devices "1" .SH NAME -libinput-list-devices \- list local devices as recognized by libinput +libinput\-list\-devices \- list local devices as recognized by libinput .SH SYNOPSIS -.B libinput list-devices [--help] +.B libinput list\-devices [\-\-help] .SH DESCRIPTION .PP The -.B "libinput list-devices" +.B "libinput list\-devices" tool creates a libinput context on the default seat "seat0" and lists all devices recognized by libinput. Each device shows available configurations the respective default configuration setting. @@ -19,7 +19,7 @@ This tool usually needs to be run as root to have access to the /dev/input/eventX nodes. .SH OPTIONS .TP 8 -.B --help +.B \-\-help Print help .SH NOTES .PP @@ -32,7 +32,7 @@ driver or the Wayland compositor. .PP An xorg.conf(5) configuration entry or Wayland compositor setting may have changed configurations on a device. The -.B "libinput list-devices" +.B "libinput list\-devices" tool only shows the device's default configuration, not the current configuration. .SH LIBINPUT diff --git a/tools/libinput-measure-touchpad-tap.1 b/tools/libinput-measure-touchpad-tap.1 index 529f899..da89c93 100644 --- a/tools/libinput-measure-touchpad-tap.1 +++ b/tools/libinput-measure-touchpad-tap.1 @@ -1,16 +1,16 @@ .TH libinput-measure-touchpad-tap "1" .SH NAME -libinput-measure-touchpad-tap \- measure tap-to-click properities of devices +libinput\-measure\-touchpad\-tap \- measure tap-to-click properities of devices .SH SYNOPSIS -.B libinput measure touchpad-tap [--help] [--format=<format>] [/dev/input/event0] +.B libinput measure touchpad\-tap [\-\-help] [\-\-format=<format>] [/dev/input/event0] .SH DESCRIPTION .PP The -.B "libinput measure touchpad-tap" -tool measures properties of the tap-to-click behavior of the user. This is +.B "libinput measure touchpad\-tap" +tool measures properties of the tap\-to\-click behavior of the user. This is an interactive tool. When executed, the tool will prompt the user to interact with the touchpad. On termination, the tool prints a summary of the -tap interactions seen. This data should be attached to any tap-related bug +tap interactions seen. This data should be attached to any tap\-related bug report. .PP For a full description on how libinput's tap-to-click behavior works, see @@ -24,18 +24,18 @@ This tool usually needs to be run as root to have access to the /dev/input/eventX nodes. .SH OPTIONS .TP 8 -.B --help +.B \-\-help Print help .TP 8 -.B --format=summary|dat +.B \-\-format=summary|dat Specify the data format to be printed. The default (or if -.B --format +.B \-\-format is omitted) is "summary". See section .B DATA FORMATS .SH DATA FORMATS This section describes the data formats printed with the -.B --format +.B \-\-format commandline argument. Note that any of the output may change at any time. .RE .PP @@ -57,7 +57,7 @@ format, suitable for processing by other tools such as .B gnuplot(1). The data is aligned in one row per touch with each column containing a separate data entry. -.B libinput-measure-touchpad-tap +.B libinput\-measure\-touchpad\-tap prints comments at the top of the file to describe each column. .PP .B WARNING: diff --git a/tools/libinput-measure.1 b/tools/libinput-measure.1 index 1369d4a..754ed40 100644 --- a/tools/libinput-measure.1 +++ b/tools/libinput-measure.1 @@ -1,8 +1,8 @@ .TH libinput-measure "1" .SH NAME -libinput-measure \- measure properties of devices +libinput\-measure \- measure properties of devices .SH SYNOPSIS -.B libinput measure [--help] <feature> [<args>] +.B libinput measure [\-\-help] <feature> [<args>] .SH DESCRIPTION .PP The @@ -17,12 +17,12 @@ This tool usually needs to be run as root to have access to the /dev/input/eventX nodes. .SH OPTIONS .TP 8 -.B --help +.B \-\-help Print help .SH FEATURES Features that can be measured include .TP 8 -.B libinput-measure-touchpad-tap-time(1) +.B libinput\-measure\-touchpad\-tap\-time(1) Measure tap-to-click time. .SH LIBINPUT Part of the diff --git a/tools/libinput.1 b/tools/libinput.1 index 9832d8b..cb28937 100644 --- a/tools/libinput.1 +++ b/tools/libinput.1 @@ -2,7 +2,7 @@ .SH NAME libinput \- tool to interface with libinput .SH SYNOPSIS -.B libinput [--help] [--version] <command> [<args>] +.B libinput [\-\-help] [\-\-version] <command> [<args>] .SH DESCRIPTION .PP The @@ -23,32 +23,32 @@ Note that a device may be recognized by this tool but not handled by the X.Org libinput driver or the Wayland compositor. .SH OPTIONS .TP 8 -.B --help +.B \-\-help Print help and exit .TP 8 -.B --version +.B \-\-version Print the version and exit .SH COMMANDS All commands support a -.B --help -argument that prints command-specific usage +.B \-\-help +argument that prints command\-specific usage information, e.g. -.B "libinput debug-events --help". +.B "libinput debug\-events \-\-help". .TP 8 -.B libinput-debug-events(1) +.B libinput\-debug\-events(1) Print all events as seen by libinput. .TP 8 -.B libinput-debug-gui(1) +.B libinput\-debug\-gui(1) Show a GUI to visualize libinput's events. .TP 8 -.B libinput-list-devices(1) +.B libinput\-list\-devices(1) List all devices recognized by libinput. .TP 8 -.B libinput-measure(1) +.B libinput\-measure(1) Measure various properties of devices. .TP 8 -.B libinput-measure-touchpad-tap(1) +.B libinput\-measure\-touchpad\-tap(1) Measure tap-to-click time. .SH LIBINPUT Part of the |