Package: xserver-xorg-input-evdev
Version: 1:2.10.6-2+b1
Severity: minor
Tags: patch

Dear Maintainer,

  here are some comments and editorial fixes for the man page.

-.-

The difference between the formatted outputs can be seen with:

  nroff -man <file1> > <out1>
  nroff -man <file2> > <out2>
  diff -u <out1> <out2>

and for groff, using

"printf '%s\n%s\n' '.kern 0' '.ss 12 0' | groff -man -Z - "

instead of "nroff -man"

  Read the output of "diff -u" with "less -R" or similar.

-.-.

  If "man" (man-db) is used to check the manual, the following
must be set:

  The option "-warnings=w"

  The environmental variable:

export MAN_KEEP_STDERR=yes (or any non-empty value)

  or

  (produce only warnings):

export MANROFFOPT="-ww -z"

export MAN_KEEP_STDERR=yes (or any non-empty value)

-.-.

Output from "mandoc -T lint evdev.4":

mandoc: evdev.4:19:10: STYLE: whitespace at end of input line
mandoc: evdev.4:26:4: STYLE: whitespace at end of input line
mandoc: evdev.4:40:2: WARNING: skipping paragraph macro: PP empty
mandoc: evdev.4:43:12: STYLE: whitespace at end of input line
mandoc: evdev.4:46:2: WARNING: skipping paragraph macro: PP empty
mandoc: evdev.4:52:21: STYLE: whitespace at end of input line
mandoc: evdev.4:67:74: STYLE: whitespace at end of input line
mandoc: evdev.4:84:2: WARNING: line scope broken: TP breaks TP

-.-.

Input file is evdev.4

Remove space characters at the end of lines.

Use "git apply ... --whitespace=fix" to fix extra space issues, or use
global configuration "core.whitespace".

19:.B evdev 
26:The 
43:through the 
52:The following driver 
67:Specifies the device through which the device can be accessed.  This will 

-.-.

Change '-' (\-) to '\(en' (en-dash) for a numeric range.
GNU gnulib has recently (2023-06-18) updated its
"build_aux/update-copyright" to recognize "\(en" in man pages.

evdev.4:282:8 bit. Either 1 value or pairs of values. Value range 0-32, 0 
disables a
evdev.4:292:1 8 bit value, allowed range 0-32, 0 disables the button.
evdev.4:301:1 8 bit value, allowed range 0-32, 0 disables the button.

-.-.

Use the correct macro for the font change of a single argument or
split the argument into two.

125:.BR EmulateWheel
149:.BR EmulateWheelButton
151:.BR EmulateWheelButton
242:.BI "Option \*qTypeName\*q \*q"type"\*q
271:.BI "Evdev Axis Calibration"
275:.BI "Evdev Axis Inversion"
278:.BI "Evdev Axes Swap"
281:.BI "Evdev Drag Lock Buttons"
285:.BI "Evdev Middle Button Emulation"
288:.BI "Evdev Middle Button Timeout"
291:.BI "Evdev Middle Button Button"
294:.BI "Evdev Wheel Emulation"
297:.BI "Evdev Wheel Emulation Axes"
300:.BI "Evdev Wheel Emulation Button"
303:.BI "Evdev Wheel Emulation Inertia"
306:.BI "Evdev Wheel Emulation Timeout"
309:.BI "Evdev Scrolling Distance"

-.-.

Wrong distance between sentences.

  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").

  The best procedure is to always start a new sentence on a new line,
at least, if you are typing on a computer.

Remember coding: Only one command ("sentence") on each (logical) line.

E-mail: Easier to quote exactly the relevant lines.

Generally: Easier to edit the sentence.

Patches: Less unaffected text.

Search for two adjacent words is easier, when they belong to the same line,
and the same phrase.

  The amount of space between sentences in the output can then be
controlled with the ".ss" request.

N.B

  The number of lines affected is too large to be in the patch.


28:driver can serve as both a pointer and a keyboard input device. Multiple
38:per-device configuration. Devices configured in the
57:Sets the button mapping for this device. The mapping is a space-separated 
list
59:device (i.e. the first number is the mapping for button 1, etc.). The default
60:mapping is "1 2 3 ... 32". A mapping of 0 deactivates the button. Multiple
63:mapping of "3 2 1 0 0". Invalid mappings are ignored and the default mapping
64:is used. Buttons not specified in the user's mapping use the default mapping.
69:The mapping from device node to hardware is system-dependent. Property:
75:same time they move a mouse cursor. Button numbers occur in pairs,
77:number that is the target of the lock button. Property: "Evdev
83:\*qdrag locked\*q. Property: "Evdev Drag Lock Buttons".
89:pressing both buttons simultaneously.  Default: off. Property: "Evdev Middle
95:enabled.  Default: 50. Property: "Evdev Middle Button Timeout".
115:options.  Default: off. Property "Evdev Wheel Emulation".
124:settings. If the button is 0 and
126:is on, any motion of the device is converted into wheel events. Default: 4.
131:press/release events in wheel emulation mode.  Default: 10. Property: "Evdev
139:the name \*qinertia\*q is a misnomer. This option defines the distance
144:options. It does not enable inertia in the
150:must be pressed before wheel emulation is started. If the
153:is sent.  Default: 200. Property: "Evdev Wheel Emulation Timeout".
156:Enable third button emulation. Third button emulation emits a right button
157:event (by default) by pressing and holding the first button. The first
159:than the configured threshold for the emulation to activate. Otherwise, the
160:first button event is posted as normal. Default: off.  Property: "Evdev
166:Default: 1000. Property: "Evdev Third Button Emulation Timeout".
175:emulation. If the device moves by more than this threshold before the third
178:Default: 20. Property: "Evdev Third Button Emulation Threshold".
181:Force a grab on the event device. Doing so will ensure that no other driver
183:events to /dev/kbd or /dev/input/mice. Events from this device will not be
184:sent to virtual devices (e.g. rfkill or the Macintosh mouse button 
emulation).
190:Invert the given axis. Default: off. Property: "Evdev Axis Inversion".
195:Ignore the specified type of axis. Default: unset. The X server cannot deal
196:with devices that have both relative and absolute axes. Evdev tries to guess
198:mice and relative axes for tablets, touchscreens and touchpad. These options
199:allow to forcibly disable an axis type. Mouse wheel axes are exempt and will
200:work even if relative axes are ignored. No property, this configuration must
204:axes regardless of the presence of other axes. This may trigger buggy
205:behavior and events from this axis are always forwarded. Users are
210:coordinate system than reported to the X server. This feature is required
212:originally reported by the kernel (e.g. touchscreens). The scaling to the
214:the transformation. Property: "Evdev Axis Calibration".
222:Swap x/y axes. Default: off. Property: "Evdev Axes Swap".
230:is mapped to the positive X axis motion.  Default: no mapping. Property:
239:is mapped to the positive Y axis motion.  Default: "4 5". Property:
245:based on the device's capabilities. This option is provided for devices that
261:Sets the resolution of the device in dots per inch. The resolution is used
262:to scale relative motion events from mouse devices to 1000 DPI resolution. 
This
264:acceleration. If set to 0 no scaling will be performed. Default: "0".
276:2 boolean values (8 bit, 0 or 1), order X, Y. 1 inverts the axis.
279:1 boolean value (8 bit, 0 or 1). 1 swaps x/y axes.
282:8-bit. Either 1 value or pairs of values. Value range 0-32, 0 disables a
298:4 8-bit values, order X up, X down, Y up, Y down. 0 disables a value.

-.-.

Rephrase the beginning of a sentence, if it starts with a digit (see
a style manual).

272:4 32-bit values, order min-x, max-x, min-y, max-y or 0 values to disable
276:2 boolean values (8 bit, 0 or 1), order X, Y. 1 inverts the axis.
279:1 boolean value (8 bit, 0 or 1). 1 swaps x/y axes.
282:8-bit. Either 1 value or pairs of values. Value range 0-32, 0 disables a
286:1 boolean value (8 bit, 0 or 1).
289:1 16-bit positive value.
292:1 8-bit value, allowed range 0-32, 0 disables the button.
295:1 boolean value (8 bit, 0 or 1).
298:4 8-bit values, order X up, X down, Y up, Y down. 0 disables a value.
301:1 8-bit value, allowed range 0-32, 0 disables the button.
304:1 16-bit positive value.
307:1 16-bit positive value.
310:3 32-bit values: vertical, horizontal and dial.

-.-.

The name of a man page is set in bold type and the section in roman (see
man-pages(7)).

37:directive (refer to xorg.conf(5)) instead of manual
39:xorg.conf(5) are not hot-plug capable.
48:Please refer to xorg.conf(5) for general configuration
243:Specify the X Input 1.x type (see XListInputDevices(3)).
315:Xorg(1), xorg.conf(5), Xserver(1), X(7)

-.-.

[ "test-groff" is a developmental version of "groff" ]

Input file is ./evdev.4

Output from "test-groff -b -mandoc -dAD=l -rF0 -rHY=0 -t -w w -z 
-rCHECKSTYLE=0":
troff: backtrace: file '<stdin>':26
troff:<stdin>:26: warning: trailing space in the line
troff: backtrace: file '<stdin>':43
troff:<stdin>:43: warning: trailing space in the line
troff: backtrace: file '<stdin>':52
troff:<stdin>:52: warning: trailing space in the line
troff: backtrace: file '<stdin>':67
troff:<stdin>:67: warning: trailing space in the line

-.-.

Additional changes:

Add information about the encoding of the file for "man" (from preconv(1)):
'\" -*- coding: utf-8 -*-

>From "codespell":

evdev.4:197: wich ==> which

-.-

-- System Information:
Debian Release: trixie/sid
  APT prefers testing
  APT policy: (990, 'testing')
Architecture: amd64 (x86_64)

Kernel: Linux 6.4.11-1 (SMP w/2 CPU threads; PREEMPT)
Locale: LANG=is_IS.iso88591, LC_CTYPE=is_IS.iso88591 (charmap=ISO-8859-1), 
LANGUAGE not set
Shell: /bin/sh linked to /usr/bin/dash
Init: sysvinit (via /sbin/init)

Versions of packages xserver-xorg-input-evdev depends on:
ii  libc6                                  2.37-7
ii  libevdev2                              1.13.1+dfsg-1
ii  libmtdev1                              1.1.6-1
ii  libudev1                               254.1-2
ii  xserver-xorg-core [xorg-input-abi-24]  2:21.1.8-1

xserver-xorg-input-evdev recommends no packages.

xserver-xorg-input-evdev suggests no packages.

-- no debconf information

Reply via email to