xsf-docs: Changes to 'master'
Makefile | 3
howtos/configure-input.mdwn | 162 ++++++++++++++++++++++++++++++++++++++++++++
index.mdwn | 1
xsf.css | 4 +
4 files changed, 169 insertions(+), 1 deletion(-)
New commits:
commit 2752cbe66aefb944dd09aa69b0cedbc047f256b2
Author: Cyril Brulebois <kibi@debian.org>
Date: Wed Jan 19 04:57:49 2011 +0100
configure-input: Mention gpointing-device-settings and syndaemon.
diff --git a/howtos/configure-input.mdwn b/howtos/configure-input.mdwn
index 9afde8c..e655026 100644
--- a/howtos/configure-input.mdwn
+++ b/howtos/configure-input.mdwn
@@ -148,3 +148,15 @@ Line by line walkthrough:
* 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).
+
+Settings can also be changed by various settings manager, like
+Gnome’s, or KDE’s. An example of a graphical user interface making it
+possible to set options in a clicky way: `gpointing-device-settings`.
+
+There’s a palm detection setting but that relies hardware/firmware
+support for the touchpad. The other tool shipped with the `synaptics`
+driver is `syndaemon`, which makes it trivial to disable the touchpad
+temporarily, when the keyboard is being used. Here’s an example:
+`syndaemon -d -i 0.5` makes `syndaemon` start in background (`-d` for
+daemon mode), waiting 0.5 second before enabling the touchpad again
+after the last keypress.
commit 46b76a70995e505751f7aa247843bfff8250911b
Author: Cyril Brulebois <kibi@debian.org>
Date: Wed Jan 19 04:48:00 2011 +0100
configure-input: Mention synaptics configuration.
diff --git a/howtos/configure-input.mdwn b/howtos/configure-input.mdwn
index 9a6cf72..9afde8c 100644
--- a/howtos/configure-input.mdwn
+++ b/howtos/configure-input.mdwn
@@ -109,3 +109,42 @@ Line by line walkthrough:
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.
+
+
+### synaptics configuration
+
+The `synaptics` driver comes with two tools. The more interesting one
+is `synclient`, which can be used to list available options and
+current settings: `synclient -l`. The documentation for each option
+can be found in the `synaptics` manpage.
+
+`synclient` 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): `synclient TapButton1=1`; one can also
+disable the touchpad temporarily: `synclient TouchpadOff=1` to
+disable, `synclient TouchpadOff=0` to enable it again.
+
+Let’s check what a configuration snippet (mentioned in **General
+considerations**) would look like. Here is a fictional
+`/etc/X11/xorg.conf.d/42-synaptics.conf`:
+
+ Section "InputClass"
+ Identifier "touchpad tweaked catchall"
+ MatchIsTouchpad "on"
+ Driver "synaptics"
+ Option "TapButton1" "1"
+ Option "HorizEdgeScroll" "1"
+ EndSection
+
+Line by line walkthrough:
+
+ * To avoid specifying any device under `/dev/input` (`event$N` might
+ change, remember it’s about hotplug support!), we use an
+ `InputClass`.
+ * We need an identifier, the actual name doesn‘t matter.
+ * We match everything that looks like a touchpad. Meaning no generic
+ pointer, keyboard, or tablet.
+ * We specify the driver we want to use for the matched device(s).
+ * 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).
commit d23d7ed275334585adccef0928c7b6b65ddcb541
Author: Cyril Brulebois <kibi@debian.org>
Date: Wed Jan 19 04:25:33 2011 +0100
configure-input: Mention evdev configuration.
diff --git a/howtos/configure-input.mdwn b/howtos/configure-input.mdwn
index 07a2359..9a6cf72 100644
--- a/howtos/configure-input.mdwn
+++ b/howtos/configure-input.mdwn
@@ -24,9 +24,14 @@ configure a few settings for this or that driver. Starting with
`/etc/X11/xorg.conf.d`, with a `.conf` suffix, as documented in the
`xorg.conf` manpage.
+Some packages ship a default configuration file under
+`/usr/share/X11/xorg.conf.d` with general rules to match appropriate
+hardware. The files under `/etc/X11/xorg.conf.d` takes precedence, as
+documented in the `xorg.conf` manpage.
+
It’s probably mostly useful in the `synaptics` case, in case one wants
-to change default settings on a system-wide fashion. See the mouse
-section below for an example.
+to change default settings on a system-wide fashion. See the **Pointer
+configuration** section below for an example.
## Basic keyboard configuration
@@ -73,3 +78,34 @@ How does it propagate to X?
`invoke-rc.d udev restart` changes nothing, one has to use
`udevadm`. Properties can be inspected through:
`/sbin/udevadm info --export-db`
+
+
+## Pointer configuration
+
+### evdev configuration
+
+Available options are documented in the `evdev` manpage. Let’s check
+what a configuration snippet (mentioned in **General considerations**)
+would look like. Here is a fictional `/etc/X11/xorg.conf.d/42-evdev.conf`:
+
+ Section "InputClass"
+ Identifier "evdev pointer tweaked catchall"
+ MatchIsTouchpad "on"
+ Driver "evdev"
+ Option "Emulate3Buttons" "False"
+ Option "SwapAxes" "True"
+ EndSection
+
+Line by line walkthrough:
+
+ * To avoid specifying any device under `/dev/input` (`event$N` might
+ change, remember it’s about hotplug support!), we use an
+ `InputClass`.
+ * We need an identifier, the actual name doesn‘t matter.
+ * We match everything that looks like a touchpad. Meaning no generic
+ pointer, keyboard, or tablet.
+ * We specify the driver we want to use for the matched device(s).
+ * Finally the options we want to set. Here we disable 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.
commit ed32c67e56e0da449c982d9ff60b74c68a2b2a77
Author: Cyril Brulebois <kibi@debian.org>
Date: Wed Jan 19 03:56:33 2011 +0100
configure-input: Mention configuration snippets.
diff --git a/howtos/configure-input.mdwn b/howtos/configure-input.mdwn
index 88ce73f..07a2359 100644
--- a/howtos/configure-input.mdwn
+++ b/howtos/configure-input.mdwn
@@ -1,6 +1,8 @@
# How to configure input
-## Rules of thumb
+## General considerations
+
+### Rules of thumb
In this documentation, only the last part of the driver’s name will be
mentioned, all of them are under the `xserver-xorg-input-*` namespace.
@@ -14,6 +16,19 @@ mentioned, all of them are under the `xserver-xorg-input-*` namespace.
`mouse` handles mice, unsurprisingly.
+### Configuration snippets
+
+X can now be run without `xorg.conf`, but sometimes one has to
+configure a few settings for this or that driver. Starting with
+`squeeze`, that can be done by adding a file under
+`/etc/X11/xorg.conf.d`, with a `.conf` suffix, as documented in the
+`xorg.conf` manpage.
+
+It’s probably mostly useful in the `synaptics` case, in case one wants
+to change default settings on a system-wide fashion. See the mouse
+section below for an example.
+
+
## Basic keyboard configuration
The `keyboard-configuration` package ships `/etc/default/keyboard`
commit 6ac38003254635bc5d3e5783fbb1dfc63c480494
Author: Cyril Brulebois <kibi@debian.org>
Date: Wed Jan 19 03:46:01 2011 +0100
configure-input: Mention --export-db as well.
diff --git a/howtos/configure-input.mdwn b/howtos/configure-input.mdwn
index d0bceb0..88ce73f 100644
--- a/howtos/configure-input.mdwn
+++ b/howtos/configure-input.mdwn
@@ -56,4 +56,5 @@ How does it propagate to X?
and X uses those properties when it starts, as can be seen by
searching for `xkb_` in the X log. Please note that trying
`invoke-rc.d udev restart` changes nothing, one has to use
- `udevadm`.
+ `udevadm`. Properties can be inspected through:
+ `/sbin/udevadm info --export-db`
commit 810269efb1be0f58387b4c006012ec1cedfe706d
Author: Cyril Brulebois <kibi@debian.org>
Date: Wed Jan 19 03:39:46 2011 +0100
configure-input: Mention udev restart does not work.
diff --git a/howtos/configure-input.mdwn b/howtos/configure-input.mdwn
index 3e8b8bc..d0bceb0 100644
--- a/howtos/configure-input.mdwn
+++ b/howtos/configure-input.mdwn
@@ -49,9 +49,11 @@ How does it propagate to X?
* When HAL is used (that is: on GNU/kFreeBSD and GNU/Hurd), one has
to restart it: `invoke-rc.d hal restart`
* When udev is used (on GNU/Linux, starting with `squeeze`), one has
- to tell udev to reload input-related configuration
+ to tell udev to reload input-related configuration:
`udevadm trigger --subsystem-match=input --action=change`
(that can be found in `keyboard-configuration`’s `README.Debian`
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 `xkb_` in the X log.
+ searching for `xkb_` in the X log. Please note that trying
+ `invoke-rc.d udev restart` changes nothing, one has to use
+ `udevadm`.
commit 6efab154d5e8e3ebb6918752a629505eb660e375
Author: Cyril Brulebois <kibi@debian.org>
Date: Wed Jan 19 03:23:15 2011 +0100
configure-input: Make synaptics an extra bullet.
diff --git a/howtos/configure-input.mdwn b/howtos/configure-input.mdwn
index 1f30751..3e8b8bc 100644
--- a/howtos/configure-input.mdwn
+++ b/howtos/configure-input.mdwn
@@ -6,8 +6,10 @@ In this documentation, only the last part of the driver’s name will be
mentioned, all of them are under the `xserver-xorg-input-*` namespace.
* On Linux, `evdev` is used for both keyboard and mouse
- input. `synaptics` can be used to benefit from extra features; it
- takes precedence over `evdev` automatically if both are installed.
+ input.
+ * On Linux as well, `synaptics` can be used to benefit from extra
+ features; it takes precedence over `evdev` automatically if both
+ are installed.
* On GNU/kFreeBSD and GNU/Hurd, `kbd` handles the keyboard and
`mouse` handles mice, unsurprisingly.
commit 1cd1057e31703b7e5c8bf74c6e08a9d6a328d352
Author: Cyril Brulebois <kibi@debian.org>
Date: Wed Jan 19 03:21:54 2011 +0100
makefile: Make pdf file generation depend on the css.
diff --git a/Makefile b/Makefile
index 3ab3881..055d62e 100644
--- a/Makefile
+++ b/Makefile
@@ -8,6 +8,7 @@ pdf_files = $(patsubst %.mdwn,%.pdf,$(mdwn_pages))
MDWN_TO_HTML = ./mdwn2html
HTML_TO_PDF = wkhtmltopdf
+CSS_FILE = xsf.css
all: html pdf
@@ -18,7 +19,7 @@ pdf: $(pdf_files)
%.html: %.mdwn $(MDWN_TO_HTML)
$(MDWN_TO_HTML) $< $@
-%.pdf: %.html
+%.pdf: %.html $(CSS_FILE)
$(HTML_TO_PDF) $< $@
clean:
commit 91b9e786992088e0193c59ad17f9be1efbf27344
Author: Cyril Brulebois <kibi@debian.org>
Date: Wed Jan 19 03:19:52 2011 +0100
css: Improve lists.
Justify text, and add a margin on the right.
diff --git a/xsf.css b/xsf.css
index 7a74d4e..3a6bf74 100644
--- a/xsf.css
+++ b/xsf.css
@@ -36,10 +36,14 @@ p {
ul {
margin-left: 40px;
+ margin-right: 40px;
+ text-align: justify;
}
ol {
margin-left: 40px;
+ margin-right: 40px;
+ text-align: justify;
}
pre {
commit 0dfeb1513ba6b827fc5a7b1208eb0a51e69ce8b2
Author: Cyril Brulebois <kibi@debian.org>
Date: Wed Jan 19 03:17:46 2011 +0100
configure-input: Mention keyboard configuration.
diff --git a/howtos/configure-input.mdwn b/howtos/configure-input.mdwn
index 6ae5e38..1f30751 100644
--- a/howtos/configure-input.mdwn
+++ b/howtos/configure-input.mdwn
@@ -10,3 +10,46 @@ mentioned, all of them are under the `xserver-xorg-input-*` namespace.
takes precedence over `evdev` automatically if both are installed.
* On GNU/kFreeBSD and GNU/Hurd, `kbd` handles the keyboard and
`mouse` handles mice, unsurprisingly.
+
+
+## Basic keyboard configuration
+
+The `keyboard-configuration` package ships `/etc/default/keyboard`
+which can be used to set the following `xkb` items: model, layout,
+variant, and options. Here’s an example:
+
+ XKBMODEL="pc105"
+ XKBLAYOUT="fr"
+ XKBVARIANT="oss"
+ XKBOPTIONS="compose:menu,terminate:ctrl_alt_bksp"
+
+Quick words about the options:
+
+ * They are comma-separated.
+ * The list of options and a short description for each can be found
+ in the `/usr/share/X11/xkb/rules/base.lst` file (from the
+ `xkb-data` package).
+ * First option: `compose:menu`. This sets the `menu` key as the
+ Compose key. More information about it can be found in the
+ `Compose` manpage.
+ * Second option: `terminate:ctrl_alt_bksp`. By default, the X server
+ is no longer killed through `Ctrl+Alt+Backspace`. This option
+ restores the old behaviour.
+
+Two ways to change the configuration:
+
+ * `dpkg-reconfigure keyboard-configuration` is going to ask questions
+ through debconf prompts.
+ * Manually editing `/etc/default/keyboard` also works.
+
+How does it propagate to X?
+
+ * When HAL is used (that is: on GNU/kFreeBSD and GNU/Hurd), one has
+ to restart it: `invoke-rc.d hal restart`
+ * When udev is used (on GNU/Linux, starting with `squeeze`), one has
+ to tell udev to reload input-related configuration
+ `udevadm trigger --subsystem-match=input --action=change`
+ (that can be found in `keyboard-configuration`’s `README.Debian`
+ 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 `xkb_` in the X log.
commit a6dcde129c229a039729583ae8a4216c9c07f6fc
Author: Cyril Brulebois <kibi@debian.org>
Date: Wed Jan 19 02:52:32 2011 +0100
configure-input: New documentation.
diff --git a/howtos/configure-input.mdwn b/howtos/configure-input.mdwn
new file mode 100644
index 0000000..6ae5e38
--- /dev/null
+++ b/howtos/configure-input.mdwn
@@ -0,0 +1,12 @@
+# How to configure input
+
+## Rules of thumb
+
+In this documentation, only the last part of the driver’s name will be
+mentioned, all of them are under the `xserver-xorg-input-*` namespace.
+
+ * On Linux, `evdev` is used for both keyboard and mouse
+ input. `synaptics` can be used to benefit from extra features; it
+ takes precedence over `evdev` automatically if both are installed.
+ * On GNU/kFreeBSD and GNU/Hurd, `kbd` handles the keyboard and
+ `mouse` handles mice, unsurprisingly.
diff --git a/index.mdwn b/index.mdwn
index 0b77258..8f907a2 100644
--- a/index.mdwn
+++ b/index.mdwn
@@ -6,6 +6,7 @@
* [How to triage bugs](howtos/triage-bugs.html)
* [How to use GDB](howtos/use-gdb.html)
* [How to configure outputs](howtos/use-xrandr.html)
+ * [How to configure intput](howtos/configure-input.html)
## Other documentation
Reply to: