From bcf743f356ae8fbfc31f6e9699879f2788493abb Mon Sep 17 00:00:00 2001 From: Bjarni Ingi Gislason Date: Sat, 8 Feb 2025 02:19:19 +0000 Subject: [PATCH] inputtestdrv.4: editorial changes for this man page Use the correct macro for the font change of a single argument or split the argument into two. 43:.BI Keyboard 46:.BI Pointer 52:.BI PointerAbsolute 58:.BI PointerAbsoluteProximity 62:.BI Touch 103:.BI xf86ITEventWaitForSync -.-. Wrong distance between sentences in the input file. Separate the sentences and subordinate clauses; each begins on a new line. See man-pages(7) ("Conventions for source file layout") and "info groff" ("Input Conventions"). 19:server as input events. It supports the full set of the xf86 driver APIs 20:exposed by Xorg. The primary use cases of this input driver are various 29:is created after the driver is initialized. The paths to the socket is passed 37:Sets the path where the driver will create a named socket. Any existing file 47:Initializes a relative-mode pointer device. It will have four valuators - 53:Initializes an absolute-mode pointer device. It will have four valuators - 87:specifies the protocol version supported by it. If this version is lower than 91:to the driver. Each event is an instance of one of the 93:structs. The length field defines the full length of the struct in bytes and 96:The responses from the server follow the same structure. Each response is an 99:structs. The length field defines the full length of the struct in bytes and 104:event. After sending such event, the client must read of a 106:events. The completion of the read operation indicates that Xorg has fully -.-. The name of a man page is typeset in bold and the section in roman (see man-pages(7)). 24:Please refer to xorg.conf(5) for general configuration 112:Xorg(1), xorg.conf(5), Xserver(1), X(7) -.- Additionally: "read of a xf86... event" -> "read an xf86... event" Originally from: https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=1095449 Signed-off-by: Alan Coopersmith Part-of: --- hw/xfree86/drivers/inputtest/inputtestdrv.man | 118 +++++++++++------- 1 file changed, 71 insertions(+), 47 deletions(-) diff --git a/hw/xfree86/drivers/inputtest/inputtestdrv.man b/hw/xfree86/drivers/inputtest/inputtestdrv.man index b0aa76dd3..0fd3431d9 100644 --- a/hw/xfree86/drivers/inputtest/inputtestdrv.man +++ b/hw/xfree86/drivers/inputtest/inputtestdrv.man @@ -15,57 +15,67 @@ inputtest \- An X.Org input driver for testing .SH DESCRIPTION .B inputtest -is an Xorg input driver that passes events received over a socket on to the -server as input events. It supports the full set of the xf86 driver APIs -exposed by Xorg. The primary use cases of this input driver are various -integration tests that need to interface with the input subsystem. +is an Xorg input driver +that passes events received over a socket on to the server as input events. +It supports the full set of the xf86 driver APIs exposed by Xorg. +The primary use cases of this input driver are various integration tests +that need to interface with the input subsystem. .SH CONFIGURATION DETAILS -Please refer to @xconfigfile@(@filemansuffix@) for general configuration -details and for options that can be used with all input drivers. This -section only covers configuration details specific to this driver. +Please refer to +.BR @xconfigfile@ (@filemansuffix@) +for general configuration details +and for options +that can be used with all input drivers. +This section only covers configuration details specific to this driver. .PP -External process can communicate with the input driver via a named socket that -is created after the driver is initialized. The paths to the socket is passed -via input driver options. +External process can communicate with the input driver via a named socket +that is created after the driver is initialized. +The paths to the socket is passed via input driver options. .PP The following driver .B Options are supported: .TP 7 .BI "Option \*qSocketPath\*q \*q" string \*q -Sets the path where the driver will create a named socket. Any existing file -at that location will be removed. +Sets the path where the driver will create a named socket. +Any existing file at that location will be removed. .TP 7 .BI "Option \*qDeviceType\*q \*q" string \*q Sets the type of the device to be emulated. .IP -.BI Keyboard +.B Keyboard Initializes a keyboard device. .IP -.BI Pointer -Initializes a relative-mode pointer device. It will have four valuators - -a "Rel X" valuator at axis 0 and a "Rel Y" valuator at axis 1. +.B Pointer +Initializes a relative-mode pointer device. +It will have four valuators \(en +a "Rel X" valuator at axis 0 +and a "Rel Y" valuator at axis 1. A horizontal scroll valuator will be set up at axis 2. A vertical scroll valuator will be set up at axis 3. .IP -.BI PointerAbsolute -Initializes an absolute-mode pointer device. It will have four valuators - -an "Abs X" valuator at axis 0 and an "Abs Y" valuator at axis 1. +.B PointerAbsolute +Initializes an absolute-mode pointer device. +It will have four valuators \(en +an "Abs X" valuator at axis 0 +and an "Abs Y" valuator at axis 1. A horizontal scroll valuator will be set up at axis 2. A vertical scroll valuator will be set up at axis 3. .IP -.BI PointerAbsoluteProximity +.B PointerAbsoluteProximity Initializes an absolute-mode pointer device with proximity support. -The valuators are initialized in the same way as for \fBPointerAbsolute\fR type. +The valuators are initialized in the same way +as for \fBPointerAbsolute\fR type. .IP -.BI Touch +.B Touch Initializes a touch device. -It will have 5 valuators: an "Abs MT Position X" at axis 0, +It will have 5 valuators: +an "Abs MT Position X" at axis 0, an "Abs MT Position Y" valuator at axis 1, a horizontal scroll valuator on axis 2, -a vertical scroll valuator on axis 3 and an "Abs MT Pressure" valuator -at axis 4. +a vertical scroll valuator on axis 3 +and an "Abs MT Pressure" valuator at axis 4. .TP 7 .BI "Option \*qTouchCount\*q \*q" int \*q Sets the maximum number of simultaneous touches for touch devices. @@ -80,33 +90,47 @@ Selects whether "Abs Pressure" is available at the axis 4 in pointer devices. The communication with the driver is a binary protocol defined in include/xf86-input-inputtest-protocol.h .PP -At the beginning, the client process that communicates with the driver must -connect to the socket that is created by the driver at SocketPath. -Once the connection is established, it must write a xf86ITEventClientVersion -event and read a xf86ITResponseServerVersion response where the driver -specifies the protocol version supported by it. If this version is lower than -requested by the client, then the driver will disconnect. +At the beginning, +the client process +that communicates with the driver must connect to the socket +that is created by the driver at SocketPath. +Once the connection is established, +it must write a xf86ITEventClientVersion event +and read a xf86ITResponseServerVersion response +where the driver specifies the protocol version supported by it. +If this version is lower than requested by the client, +then the driver will disconnect. .PP After receiving xf86ITResponseServerVersion message the client may send events -to the driver. Each event is an instance of one of the -.BI xf86ITEvent* -structs. The length field defines the full length of the struct in bytes and -the event field defines the type of the struct. +to the driver. +Each event is an instance of one of the +.BI xf86ITEvent * +structs. +The length field defines the full length of the struct in bytes +and the event field defines the type of the struct. .PP -The responses from the server follow the same structure. Each response is an -instance of one of the -.BI xf86ITResponse* -structs. The length field defines the full length of the struct in bytes and -the event field defines the type of the struct. +The responses from the server follow the same structure. +Each response is an instance of one of the +.BI xf86ITResponse * +structs. +The length field defines the full length of the struct in bytes +and the event field defines the type of the struct. .PP The synchronization with Xorg is performed via -.BI xf86ITEventWaitForSync -event. After sending such event, the client must read of a -.BI xf86ITResponseSyncFinished event from the socket without sending additional -events. The completion of the read operation indicates that Xorg has fully -processed all input events sent to it so far. +.B xf86ITEventWaitForSync +event. +After sending such event, +the client must read a +.B xf86ITResponseSyncFinished +event from the socket +without sending additional events. +The completion of the read operation indicates +that Xorg has fully processed all input events sent to it so far. .SH AUTHORS Povilas Kanapickas -.SH "SEE ALSO" -@xservername@(@appmansuffix@), @xconfigfile@(@filemansuffix@), Xserver(@appmansuffix@), X(@miscmansuffix@) +.SH SEE ALSO +.BR @xservername@ (@appmansuffix@), +.BR @xconfigfile@ (@filemansuffix@), +.BR Xserver (@appmansuffix@), +.BR X (@miscmansuffix@)