summaryrefslogtreecommitdiff
path: root/man/syndaemon.man
blob: 30ea20b8bd4bbcc2326dd66c7c6f2907258b05a0 (plain)
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
.\" shorthand for double quote that works everywhere.
.ds q \N'34'
.TH syndaemon __appmansuffix__ __vendorversion__
.SH NAME
.LP
syndaemon \- a program that monitors keyboard activity and disables
the touchpad when the keyboard is being used.
.SH "SYNOPSIS"
.LP
syndaemon [\fI\-i idle\-time\fP] [\fI\-m poll-inverval\fP] [\fI\-d\fP] [\fI\-p pid\-file\fP]
[\fI\-t\fP] [\fI\-k\fP] [\fI\-K\fP] [\fI\-R\fP]
.SH "DESCRIPTION"
.LP
Disabling the touchpad while typing avoids unwanted movements of the
pointer that could lead to giving focus to the wrong window.
.
.SH "OPTIONS"
.LP
.TP
\fB\-i\fR <\fIidle\-time\fP>
How many seconds to wait after the last key press before enabling the
touchpad.
.
(default is 2.0s). 
.LP
.TP
\fB\-m\fR <\fIpoll\-interval\fP>
How many milliseconds to wait between two polling intervals. If this value is
too low, it will cause unnecessary wake-ups. If this value is too high,
some key presses (press and release happen between two intervals) may not
be noticed. This switch has no effect when running with
\fB-R\fP.
.
Default is 200ms.
.LP
.TP
\fB\-d\fP
Start as a daemon, ie in the background.
.LP
.TP
\fB\-p\fR <\fIpid\-file\fP>
Create a pid file with the specified filename.
.
A pid file will only be created if the program is started in daemon
mode.
.LP
.TP
\fB\-t\fP [off|tapping|click-only]
 Disable state. "off" for disabling the touchpad entirely, "tapping" for
 disabling tapping and scrolling only, "click-only" for disabling
 everything but physical clicks. The default if this option is missing is
 "off". If this option is given without a mode it defaults to "tapping".
.LP
.TP
\fB\-k\fP
Ignore modifier keys when monitoring keyboard activity.
.LP
.TP
\fB\-K\fP
Like \-k but also ignore Modifier+Key combos.
.LP
.TP
\fB\-R\fP
Use the XRecord extension for detecting keyboard activity instead of polling
the keyboard state.
.LP
.TP
\fB\-?\fP
Show the help message.
.SH "ENVIRONMENT VARIABLES"
.LP
.TP
\fBDISPLAY\fP
Specifies the X server to contact.
.SH EXIT CODES
If syndaemon exists with a return code other than 0, the error encountered
is as below.
.LP
.TP
\fBExit code 1
Invalid commandline argument.
.LP
.TP
\fBExit code 2
The connection to the X sever could not be established or no touchpad device
could be found.
.LP
.TP
\fBExit code 3
The fork into daemon mode failed or the pid file could not be created.
.LP
.TP
\fBExit code 4
XRECORD requested but not available or usable on the server.
.SH "CAVEATS"
.LP
It doesn't make much sense to connect to a remote X server, because
the daemon will then monitor the remote server for keyboard activity,
but will disable the touchpad on the local machine.
.SH "AUTHORS"
.LP
Peter Osterlund <petero2@telia.com>.
.TP
This man page was written by Mattia Dongili <malattia@debian.org>
.SH "SEE ALSO"
.LP
__xservername__(__appmansuffix__), synclient(__appmansuffix__), synaptics(__drivermansuffix__)