/usr/share/doc/xorg/howto/configure-input.html is in xserver-xorg 1:7.6+12ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 8.6.6" />
<title>How to configure input</title>
<link rel="stylesheet" href="../xsf.css" type="text/css" />
<script type="text/javascript" src="../asciidoc-xhtml11.js"></script>
<script type="text/javascript">
/*<![CDATA[*/
asciidoc.install(2);
/*]]>*/
</script>
</head>
<body class="article">
<div id="header">
<h1><a href="../index.html">XSF</a> / How to configure input</h1>
<span id="author">Cyril Brulebois</span><br />
<span id="email"><tt><<a href="mailto:kibi@debian.org">kibi@debian.org</a>></tt></span><br />
<div id="toc">
<div id="toctitle">Table of Contents</div>
<noscript><p><b>JavaScript must be enabled in your browser to display the table of contents.</b></p></noscript>
</div>
</div>
<div id="content">
<div class="sect1">
<h2 id="_general_considerations">General considerations</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_foreword">Foreword</h3>
<div class="paragraph"><p>The Debian wiki also contains an
<a href="http://wiki.debian.org/XStrikeForce/InputHotplugGuide">input hotplug guide</a>
which contains some context around X’s input subsystem. The present
document is meant to be an executive summary, and might miss some
bits. (<strong>FIXME:</strong> Merge those bits.)</p></div>
</div>
<div class="sect2">
<h3 id="_rules_of_thumb">Rules of thumb</h3>
<div class="paragraph"><p>In this documentation, only the last part of the driver’s name will be
mentioned, all of them are under the <tt>xserver-xorg-input-*</tt> namespace.</p></div>
<div class="ulist"><ul>
<li>
<p>
On Linux, <tt>evdev</tt> is used for both keyboard and mouse
input.
</p>
</li>
<li>
<p>
On Linux as well, <tt>synaptics</tt> can be used to benefit from extra
features; it takes precedence over <tt>evdev</tt> automatically if both
are installed.
</p>
</li>
<li>
<p>
On GNU/kFreeBSD and GNU/Hurd, <tt>kbd</tt> handles the keyboard and
<tt>mouse</tt> handles mice, unsurprisingly.
</p>
</li>
</ul></div>
</div>
<div class="sect2">
<h3 id="_configuration_snippets">Configuration snippets</h3>
<div class="paragraph"><p>X can now be run without <tt>xorg.conf</tt>, but sometimes one has to
configure a few settings for this or that driver. Starting with
<tt>squeeze</tt>, that can be done by adding a file under
<tt>/etc/X11/xorg.conf.d</tt>, with a <tt>.conf</tt> suffix, as documented in the
<tt>xorg.conf</tt> manpage.</p></div>
<div class="paragraph"><p>Some packages ship a default configuration file under
<tt>/usr/share/X11/xorg.conf.d</tt> with general rules to match appropriate
hardware. The files under <tt>/etc/X11/xorg.conf.d</tt> take precedence, as
documented in the <tt>xorg.conf</tt> manpage.</p></div>
<div class="paragraph"><p>It’s probably mostly useful in the <tt>synaptics</tt> case, in case one wants
to change default settings on a system-wide fashion. See the <em>Pointer
configuration</em> section below for an example.</p></div>
<div style="page-break-after:always"></div>
</div>
</div>
</div>
<div class="sect1">
<h2 id="_basic_keyboard_configuration">Basic keyboard configuration</h2>
<div class="sectionbody">
<div class="paragraph"><p>The <tt>keyboard-configuration</tt> package ships <tt>/etc/default/keyboard</tt>
which can be used to set the following <tt>xkb</tt> items: model, layout,
variant, and options. Here’s an example:</p></div>
<div class="listingblock">
<div class="content">
<pre><tt>XKBMODEL="pc105"
XKBLAYOUT="fr"
XKBVARIANT="oss"
XKBOPTIONS="compose:menu,terminate:ctrl_alt_bksp"</tt></pre>
</div></div>
<div class="paragraph"><p>Quick words about the options:</p></div>
<div class="ulist"><ul>
<li>
<p>
They are comma-separated.
</p>
</li>
<li>
<p>
The list of options and a short description for each can be found
in the <tt>/usr/share/X11/xkb/rules/base.lst</tt> file (shipped by the
<tt>xkb-data</tt> package).
</p>
</li>
<li>
<p>
First option: <tt>compose:menu</tt>. This sets the <tt>menu</tt> key as the
Compose key. More information about it can be found in the
<tt>Compose</tt> manpage.
</p>
</li>
<li>
<p>
Second option: <tt>terminate:ctrl_alt_bksp</tt>. By default, the X server
is no longer killed through <tt>Ctrl+Alt+Backspace</tt>. This option
restores the old behaviour.
</p>
</li>
</ul></div>
<div class="paragraph"><p>Two ways to change the configuration:</p></div>
<div class="ulist"><ul>
<li>
<p>
<tt>dpkg-reconfigure keyboard-configuration</tt> is going to ask questions
through debconf prompts.
</p>
</li>
<li>
<p>
Manually editing <tt>/etc/default/keyboard</tt> also works.
</p>
</li>
</ul></div>
<div class="paragraph"><p>How does it propagate to X?</p></div>
<div class="ulist"><ul>
<li>
<p>
When HAL is used (that is: on GNU/kFreeBSD and GNU/Hurd), one has
to restart it: <tt>invoke-rc.d hal restart</tt>
</p>
</li>
<li>
<p>
When udev is used (on GNU/Linux, starting with <tt>squeeze</tt>), one has
to tell udev to reload input-related configuration:
<tt>udevadm trigger --subsystem-match=input --action=change</tt>
(that can be found in <tt>keyboard-configuration</tt>’s <tt>README.Debian</tt>
file). Properties attached to the input devices are then updated,
and X uses those properties when it starts, as can be seen by
searching for <tt>xkb_</tt> in the X log. Please note that trying
<tt>invoke-rc.d udev restart</tt> changes nothing, one has to use
<tt>udevadm</tt>. Properties can be inspected through:
<tt>/sbin/udevadm info --export-db</tt>
</p>
</li>
</ul></div>
<div style="page-break-after:always"></div>
</div>
</div>
<div class="sect1">
<h2 id="_pointer_configuration">Pointer configuration</h2>
<div class="sectionbody">
<div class="sect2">
<h3 id="_evdev_configuration">evdev configuration</h3>
<div class="paragraph"><p>Available options are documented in the <tt>evdev</tt> manpage. Let’s check
what a configuration snippet (mentioned in <em>General considerations</em>)
would look like. Here is a fictional <tt>/etc/X11/xorg.conf.d/42-evdev.conf</tt>:</p></div>
<div class="listingblock">
<div class="content">
<pre><tt>Section "InputClass"
Identifier "evdev pointer tweaked catchall"
MatchIsPointer "on"
Driver "evdev"
Option "Emulate3Buttons" True"
Option "SwapAxes" "True"
EndSection</tt></pre>
</div></div>
<div class="paragraph"><p>Line by line walkthrough:</p></div>
<div class="ulist"><ul>
<li>
<p>
To avoid specifying any device under <tt>/dev/input</tt> (<tt>event$N</tt> might
change, remember it’s about hotplug support!), we use an
<tt>InputClass</tt>.
</p>
</li>
<li>
<p>
We need an identifier, the actual name doesn’t matter.
</p>
</li>
<li>
<p>
We match everything that looks like a touchpad. Meaning no generic
pointer, keyboard, or tablet.
</p>
</li>
<li>
<p>
We specify the driver we want to use for the matched device(s).
</p>
</li>
<li>
<p>
Finally the options we want to set. Here we enable the 3rd button
emulation (clicking left and right buttons at the same time then no
longer acts as if the middle button was clicked). Then we swap x
and y axes, just for the fun of it.
</p>
</li>
</ul></div>
</div>
<div class="sect2">
<h3 id="_synaptics_configuration">synaptics configuration</h3>
<div class="paragraph"><p>The <tt>synaptics</tt> driver comes with two tools. The more interesting one
is <tt>synclient</tt>, which can be used to list available options and
current settings: <tt>synclient -l</tt>. The documentation for each option
can be found in the <tt>synaptics</tt> manpage.</p></div>
<div class="paragraph"><p><tt>synclient</tt> can also be used to set options. A common example is
enabling tapping (upstream kept it disabled by default, Debian won’t
deviate, no need to file bugs): <tt>synclient TapButton1=1</tt>; one can also
disable the touchpad temporarily: <tt>synclient TouchpadOff=1</tt> to
disable it, <tt>synclient TouchpadOff=0</tt> to enable it again.</p></div>
<div class="paragraph"><p>Let’s check what a configuration snippet (mentioned in <em>General
considerations</em>) would look like. Here is a fictional
<tt>/etc/X11/xorg.conf.d/42-synaptics.conf</tt>:</p></div>
<div class="listingblock">
<div class="content">
<pre><tt>Section "InputClass"
Identifier "touchpad tweaked catchall"
MatchIsTouchpad "on"
Driver "synaptics"
Option "TapButton1" "1"
Option "HorizEdgeScroll" "1"
EndSection</tt></pre>
</div></div>
<div class="paragraph"><p>Line by line walkthrough:</p></div>
<div class="ulist"><ul>
<li>
<p>
To avoid specifying any device under <tt>/dev/input</tt> (<tt>event$N</tt> might
change, remember it’s about hotplug support!), we use an
<tt>InputClass</tt>.
</p>
</li>
<li>
<p>
We need an identifier, the actual name doesn’t matter.
</p>
</li>
<li>
<p>
We match everything that looks like a touchpad. Meaning no generic
pointer, keyboard, or tablet.
</p>
</li>
<li>
<p>
We specify the driver we want to use for the matched device(s).
</p>
</li>
<li>
<p>
Finally the options we want to set. We enable tapping for the first
button. And we enable horizontal scrolling (by default, only
vertical scrolling is enabled).
</p>
</li>
</ul></div>
<div class="paragraph"><p>Settings can also be changed by various settings managers, like
Gnome’s or KDE’s. An example of a graphical user interface making it
possible to set options in a clicky way: <tt>gpointing-device-settings</tt>.</p></div>
<div class="paragraph"><p>There’s a palm detection setting but that relies on hardware/firmware
support for the touchpad. The other tool shipped with the <tt>synaptics</tt>
driver is <tt>syndaemon</tt>, which makes it trivial to disable the touchpad
temporarily, when the keyboard is being used. Here’s an example:
<tt>syndaemon -d -i 0.5</tt> makes <tt>syndaemon</tt> start in background (<tt>-d</tt> for
daemon mode), waiting 0.5 second before enabling the touchpad again
after the last keypress. Warning: it becomes quite difficult to use
things like <tt>Ctrl+click</tt> in a browser, or <tt>Alt+drag</tt> to move
windows.</p></div>
</div>
</div>
</div>
</div>
<div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
Last updated 2011-06-06 07:22:56 UTC
</div>
</div>
</body>
</html>
|