Input: appletouch - convert documentation into ReST format
authorMauro Carvalho Chehab <mchehab@s-opensource.com>
Wed, 5 Apr 2017 00:32:22 +0000 (17:32 -0700)
committerDmitry Torokhov <dmitry.torokhov@gmail.com>
Wed, 5 Apr 2017 22:44:07 +0000 (15:44 -0700)
This file require minimum adjustments to be a valid ReST file.  Do it, in
order to be able to parse it with Sphinx.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Signed-off-by: Dmitry Torokhov <dmitry.torokhov@gmail.com>
Documentation/input/appletouch.txt

index b13de3f89108df1e7b9cd585c97aa81b458261d9..c94470e66533e91ce8de0b52c2dfe28fe04aac58 100644 (file)
@@ -1,12 +1,17 @@
+.. include:: <isonum.txt>
+
+----------------------------------
 Apple Touchpad Driver (appletouch)
 ----------------------------------
-       Copyright (C) 2005 Stelian Pop <stelian@popies.net>
+
+:Copyright: |copy| 2005 Stelian Pop <stelian@popies.net>
 
 appletouch is a Linux kernel driver for the USB touchpad found on post
 February 2005 and October 2005 Apple Aluminium Powerbooks.
 
-This driver is derived from Johannes Berg's appletrackpad driver[1], but it has
-been improved in some areas:
+This driver is derived from Johannes Berg's appletrackpad driver [#f1]_,
+but it has been improved in some areas:
+
        * appletouch is a full kernel driver, no userspace program is necessary
        * appletouch can be interfaced with the synaptics X11 driver, in order
          to have touchpad acceleration, scrolling, etc.
@@ -16,8 +21,8 @@ Frank Arnold for further improvements, and Alex Harper for some additional
 information about the inner workings of the touchpad sensors. Michael
 Hanselmann added support for the October 2005 models.
 
-Usage:
-------
+Usage
+-----
 
 In order to use the touchpad in the basic mode, compile the driver and load
 the module. A new input device will be detected and you will be able to read
@@ -27,13 +32,13 @@ In X11, you can configure the touchpad to use the synaptics X11 driver, which
 will give additional functionalities, like acceleration, scrolling, 2 finger
 tap for middle button mouse emulation, 3 finger tap for right button mouse
 emulation, etc. In order to do this, make sure you're using a recent version of
-the synaptics driver (tested with 0.14.2, available from [2]), and configure a
-new input device in your X11 configuration file (take a look below for an
-example). For additional configuration, see the synaptics driver documentation.
+the synaptics driver (tested with 0.14.2, available from [#f2]_), and configure
+new input device in your X11 configuration file (take a look below for an
+example). For additional configuration, see the synaptics driver documentation::
 
        Section "InputDevice"
-               Identifier      "Synaptics Touchpad"
-               Driver          "synaptics"
+               Identifier      "Synaptics Touchpad"
+               Driver          "synaptics"
                Option          "SendCoreEvents"        "true"
                Option          "Device"                "/dev/input/mice"
                Option          "Protocol"              "auto-dev"
@@ -60,8 +65,8 @@ example). For additional configuration, see the synaptics driver documentation.
        ...
        EndSection
 
-Fuzz problems:
---------------
+Fuzz problems
+-------------
 
 The touchpad sensors are very sensitive to heat, and will generate a lot of
 noise when the temperature changes. This is especially true when you power-on
@@ -73,13 +78,17 @@ the driver.
 
 You can activate debugging using the 'debug' module parameter. A value of 0
 deactivates any debugging, 1 activates tracing of invalid samples, 2 activates
-full tracing (each sample is being traced):
+full tracing (each sample is being traced)::
+
        modprobe appletouch debug=1
-               or
+
+or::
+
        echo "1" > /sys/module/appletouch/parameters/debug
 
-Links:
-------
 
-[1]: http://johannes.sipsolutions.net/PowerBook/touchpad/
-[2]: http://web.archive.org/web/*/http://web.telia.com/~u89404340/touchpad/index.html
+.. Links:
+
+.. [#f1] http://johannes.sipsolutions.net/PowerBook/touchpad/
+
+.. [#f2] `<http://web.archive.org/web/*/http://web.telia.com/~u89404340/touchpad/index.html>`_