summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPeter Osterlund <petero2@telia.com>2004-02-08 21:35:36 +0100
committerPeter Osterlund <petero2@telia.com>2006-04-09 04:01:44 +0200
commit005a0943854fc72d54b4e50452e8bf6071671bbd (patch)
treea80fa975c2bb18afc8b1d2b63b34f44c5b964980
parentd5b4060aba07b87425ed798526b5f7342b3b8767 (diff)
Added manpages for synclient and syndaemon. Contributed by
Mattia Dongili <dongili@supereva.it>.
-rw-r--r--Makefile11
-rw-r--r--manpages/synclient.153
-rw-r--r--manpages/syndaemon.128
3 files changed, 91 insertions, 1 deletions
diff --git a/Makefile b/Makefile
index 63587c1..77641aa 100644
--- a/Makefile
+++ b/Makefile
@@ -11,6 +11,7 @@ TOP_INCLUDES = -I$(TOP) $(TOP_X_INCLUDES)
INSTALLED_X = /usr/X11R6
BINDIR = /usr/local/bin
+MANDIR = /usr/local/man/man1
XF86SRC = $(SERVERSRC)/hw/xfree86
XF86COMSRC = $(XF86SRC)/common
@@ -50,7 +51,15 @@ DRIVER = synaptics
all:: $(DRIVER)_drv.o synclient syndaemon
-install: $(BINDIR)/synclient $(BINDIR)/syndaemon $(INSTALLED_X)/lib/modules/input/$(DRIVER)_drv.o
+install: $(BINDIR)/synclient $(BINDIR)/syndaemon $(INSTALLED_X)/lib/modules/input/$(DRIVER)_drv.o install-man
+
+install-man: $(MANDIR)/synclient.1 $(MANDIR)/syndaemon.1
+
+$(MANDIR)/synclient.1:
+ install -D manpages/synclient.1 $(DESTDIR)/$@
+
+$(MANDIR)/syndaemon.1:
+ install -D manpages/syndaemon.1 $(DESTDIR)/$@
$(BINDIR)/synclient : synclient
cp $< $@
diff --git a/manpages/synclient.1 b/manpages/synclient.1
new file mode 100644
index 0000000..23d9918
--- /dev/null
+++ b/manpages/synclient.1
@@ -0,0 +1,53 @@
+.TH "synclient" "1" "0.12.3" "" ""
+.SH "NAME"
+.LP
+synclient \- query and modify Synaptic TouchPad driver for XFree86 server parameters on the fly.
+.SH "SYNTAX"
+.LP
+synclient [\fI\-m interval\fP]
+.br
+synclient [\fI\-hl?\fP] [var1=value1 [var2=value2] ...]
+.SH "DESCRIPTION"
+.LP
+This program let you change your Synaptic TouchPad driver for XFree86 server parameters while X is running if you enabled SHMConfig "on" in your XFree86 configuration.
+.TP
+WARNING: This is not secure if you are in an untrusted multiuser environment. All local users can change the parameters at any time.
+.SH "OPTIONS"
+.LP
+.TP
+\fB\-m interval\fR
+monitor changes to the touchpad state. Interval specifies how often (in ms) to poll the touchpad state.
+.TP
+\fB\-h\fR
+Show detected hardware properties.
+.TP
+\fB\-l\fR
+List current user settings.
+.TP
+\fB\-?\fR
+Show the help message.
+.TP
+\fBvar=value\fR
+Set user parameter \fIvar\fR to \fIvalue\fR.
+
+
+.SH "FILES"
+.LP
+\fI/etc/X11/XF86Config\-4\fP
+.SH "EXAMPLES"
+.LP
+To disable EdgeMotionSpeed:
+.LP
+synclient EdgeMotionSpeed=0
+.LP
+To monitor touchpad events:
+.LP
+synclient \-m 100
+.SH "AUTHORS"
+.LP
+Peter Osterlund <petero2@telia.com> and many others.
+.TP
+This man page was written by Mattia Dongili <dongili@supereva.it>
+.SH "SEE ALSO"
+.LP
+syndaemon(1)
diff --git a/manpages/syndaemon.1 b/manpages/syndaemon.1
new file mode 100644
index 0000000..9342ed3
--- /dev/null
+++ b/manpages/syndaemon.1
@@ -0,0 +1,28 @@
+.TH "syndaemon" "1" "0.12.3" "" ""
+.SH "NAME"
+.LP
+syndaemon \- a program that monitors keyboard activity and disables the touchpad when the keyboard is being used.
+.SH "SYNTAX"
+.LP
+syndaemon [\fI\-i idle\-time\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 2s).
+.SH "ENVIRONMENT VARIABLES"
+.LP
+.TP
+\fBDISPLAY\fP
+Specifies the X server to contact.
+.SH "AUTHORS"
+.LP
+Peter Osterlund <petero2@telia.com> and many others.
+.TP
+This man page was written by Mattia Dongili <dongili@supereva.it>
+.SH "SEE ALSO"
+.LP
+synclient(1)