summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPeter Hutterer <peter.hutterer@who-t.net>2022-03-10 09:28:35 +1000
committerPeter Hutterer <peter.hutterer@who-t.net>2022-03-10 22:28:47 +0000
commitc57678d333ca993afa50134d7b7beb252d02f35c (patch)
tree06a625a0b73e09cc45001901a1173ac5e7e0a834
parentdad6251572071089c680932f86ff62a703054202 (diff)
man: rename the options to commands and drop the double-dash
"xinput list" is much more modern than xinput --list, let's list it as such in the man page. --help already lists it without double-dash as well. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
-rw-r--r--man/xinput.man57
1 files changed, 28 insertions, 29 deletions
diff --git a/man/xinput.man b/man/xinput.man
index 922a044..a2ffd1c 100644
--- a/man/xinput.man
+++ b/man/xinput.man
@@ -4,20 +4,19 @@
xinput - utility to configure and test X input devices
.SH SYNOPSIS
-.B xinput [OPTIONS] [DEVICE]
+.B xinput [COMMAND] [OPTIONS] [DEVICE]
.SH DESCRIPTION
xinput is a utility to list available input devices, query information about
a device and change input device settings.
-.SH OPTIONS
+.SH COMMANDS
.TP 8
.B --version
Test if the X Input extension is available and return the version number
of the program and the version supported by the server. This option does not
require a device name.
-.PP
.TP 8
-.B --list [--short || --long || --name-only || --id-only] [\fIdevice\fP]
+.B list [--short || --long || --name-only || --id-only] [\fIdevice\fP]
If no argument is given list all the input devices. If an argument is given,
show all the features of \fIdevice\fP.
If --long is provided, the output includes detailed information about the
@@ -31,20 +30,20 @@ device ID is listed per line. Note that the order the devices are listed is
undefined.
.PP
.TP 8
-.B --get-feedbacks \fIdevice\fP
+.B get-feedbacks \fIdevice\fP
Display the feedbacks of \fIdevice\fP.
.PP
.TP 8
-.B --set-pointer \fIdevice\fP
+.B set-pointer \fIdevice\fP
Switch \fIdevice\fP in core pointer.
This option does nothing on X servers 1.5 and later.
.PP
.TP 8
-.B --set-mode \fIdevice\fP \fIABSOLUTE|RELATIVE\fP
+.B set-mode \fIdevice\fP \fIABSOLUTE|RELATIVE\fP
Change the mode of \fIdevice\fP.
.PP
.TP 8
-.B --set-ptr-feedback \fIdevice\fP \fIthreshold\fP \fInum\fP \fIdenom\fP
+.B set-ptr-feedback \fIdevice\fP \fIthreshold\fP \fInum\fP \fIdenom\fP
Change the pointer acceleration (or feedback) parameters of \fIdevice\fP.
The xset(__appmansuffix__) man page has more details. For X.Org Server 1.7
and above, there are additional device properties pertaining to pointer
@@ -52,66 +51,66 @@ acceleration. These do not replace, but complement the pointer feedback
setting.
.PP
.TP 8
-.B --set-integer-feedback \fIdevice\fP \fIindex\fP \fIvalue\fP
+.B set-integer-feedback \fIdevice\fP \fIindex\fP \fIvalue\fP
Change the value of an integer feedback of \fIdevice\fP.
.PP
.TP 8
-.B --set-button-map \fIdevice\fP \fImap_button_1\fP [\fImap_button_2\fP [\fI...\fP]]
+.B set-button-map \fIdevice\fP \fImap_button_1\fP [\fImap_button_2\fP [\fI...\fP]]
Change the button mapping of \fIdevice\fP. The buttons are specified in
physical order (starting with button 1) and are mapped to the logical button
provided. 0 disables a button. The default button mapping for a device is 1
2 3 4 5 6 etc.
.PP
.TP 8
-.B --query-state \fIdevice\fP
+.B query-state \fIdevice\fP
Query the device state.
.PP
.TP 8
-.B --list-props \fIdevice\fP [\fIdevice\fP [\fI...\fP]]
+.B list-props \fIdevice\fP [\fIdevice\fP [\fI...\fP]]
Lists properties that can be set for the given device(s).
.PP
.TP 8
-.B --set-int-prop \fIdevice\fP \fIproperty\fP \fIformat\fP \fIvalue\fP
+.B set-int-prop \fIdevice\fP \fIproperty\fP \fIformat\fP \fIvalue\fP
Sets an integer property for the device. Appropriate values for \fIformat\fP
are 8, 16, or 32, depending on the property. Deprecated, use
-.B --set-prop
+.B set-prop
instead.
.PP
.TP 8
-.B --set-float-prop \fIdevice\fP \fIproperty\fP \fIvalue\fP
+.B set-float-prop \fIdevice\fP \fIproperty\fP \fIvalue\fP
Sets a float property for the device. Deprecated, use
-.B --set-prop
+.B set-prop
instead.
.PP
.TP 8
-.B --set\-prop [\-\-type=\fIatom|float|int\fP] [\-\-format=\fI8|16|32\fP] \fIdevice\fP \fIproperty\fP \fIvalue\fP [...]
+.B set\-prop [\-\-type=\fIatom|float|int\fP] [\-\-format=\fI8|16|32\fP] \fIdevice\fP \fIproperty\fP \fIvalue\fP [...]
Set the property to the given value(s). If not specified, the format and type
of the property are left as-is. The arguments are interpreted according to the
property type. See Section \fICHANGING PROPERTIES\fP.
.PP
.TP 8
-.B --watch-props \fIdevice\fP
+.B watch-props \fIdevice\fP
Prints to standard out when property changes occur.
.PP
.TP 8
-.B --delete-prop \fIdevice\fP \fIproperty\fP
+.B delete-prop \fIdevice\fP \fIproperty\fP
Delete the property from the device.
.PP
.TP 8
-.B --test [-proximity] \fIdevice\fP
+.B test [-proximity] \fIdevice\fP
Register all extended events from \fIdevice\fP and enter an endless
loop displaying events received. If the -proximity is given, ProximityIn
and ProximityOut are registered.
.PP
.TP 8
-.B --test-xi2 [--root] [\fIdevice\fP]
+.B test-xi2 [--root] [\fIdevice\fP]
Register for a number of XI2 events and display them. If a device is given,
only events on this device are displayed. If --root is given, events are
selected on the root window only. Otherwise, a new client window is created
(similar to xev).
.PP
.TP 8
-.B --create-master \fIprefix\fP [sendCore] [enable]
+.B create-master \fIprefix\fP [sendCore] [enable]
Create a new pair of master devices on an XI2-enabled server with the given
\fIprefix\fP. The server will create one master pointer named "\fIprefix\fP
pointer" and one master keyboard named "\fIprefix\fP keyboard". If
@@ -120,7 +119,7 @@ pointer" and one master keyboard named "\fIprefix\fP keyboard". If
immediately (default).
.PP
.TP 8
-.B --remove-master \fImaster\fP [Floating|AttachToMaster] [returnPointer] [returnKeyboard]
+.B remove-master \fImaster\fP [Floating|AttachToMaster] [returnPointer] [returnKeyboard]
Remove \fImaster\fP and its paired master device. Attached slave devices
are set floating if \fIFloating\fP is specified or the argument is omitted.
If the second argument is \fIAttachToMaster\fP, \fIreturnPointer\fP
@@ -129,20 +128,20 @@ specifies the master pointer to attach all slave pointers to and
keyboards to.
.PP
.TP 8
-.B --reattach \fIslave\fP \fImaster\fP
+.B reattach \fIslave\fP \fImaster\fP
Reattach \fIslave\fP to \fImaster\fP.
.PP
.TP 8
-.B --float \fIslave\fP
+.B float \fIslave\fP
Remove \fIslave\fP from its current master device.
.PP
.TP 8
-.B --set-cp \fIwindow\fP \fImaster\fP
+.B set-cp \fIwindow\fP \fImaster\fP
Set the ClientPointer for the client owning \fIwindow\fP to \fImaster\fP.
\fImaster\fP must specify a master pointer.
.PP
.TP 8
-.B --map-to-output \fIdevice\fP \fIcrtc\fP
+.B map-to-output \fIdevice\fP \fIcrtc\fP
Restricts the movements of the absolute \fIdevice\fP to the RandR
\fIcrtc\fP. The output name must match a currently connected output (see
\fIxrandr(__appmansuffix__)\fP). If the NVIDIA binary driver is
@@ -152,12 +151,12 @@ has no effect on relative devices.
If crtc is set to "all", the default behavior is applied.
.PP
.TP 8
-.B --enable \fIdevice\fP
+.B enable \fIdevice\fP
Enable the \fIdevice\fP. This call is equivalent to
.B xinput --set-prop device \fI"Device Enabled"\fP 1
.PP
.TP 8
-.B --disable \fIdevice\fP
+.B disable \fIdevice\fP
Disable the \fIdevice\fP. This call is equivalent to
.B xinput --set-prop device \fI"Device Enabled"\fP 0
.PP