Commit: 1c715824334c5d33085dba02f195c9720c2883b5 - xinput_calibrator (git)

A generic touchscreen calibration program for X.Org

Commit MetaInfo

• Revision: 1c715824334c5d33085dba02f195c9720c2883b5 (tree)
• Time: 2010-01-26 08:00:15
• Author: Tias Guns <tias@ulys...>
• Commiter: Tias Guns

Log Message

Add a manpage

Change Summary

• modified: Makefile.am
• modified: configure.ac
• add: man/Makefile.am
• add: man/xinput_calibrator.1

Incremental Difference

--- a/Makefile.am
+++ b/Makefile.am
@@ -25,6 +25,6 @@
 #
 
 AUTOMAKE_OPTIONS = foreign
-SUBDIRS = src
+SUBDIRS = src man
 
 EXTRA_DIST = autogen.sh

--- a/configure.ac
+++ b/configure.ac
@@ -68,4 +68,5 @@ AM_CONDITIONAL([BUILD_GTKMM], [test "x$enable_gtkmm" = "xyes"])
 AC_SUBST(VERSION)
 
 AC_OUTPUT([Makefile
-           src/Makefile])
+           src/Makefile
+           man/Makefile])

--- /dev/null
+++ b/man/Makefile.am
@@ -0,0 +1,26 @@
+#
+# Copyright (c) 2010 Tias Guns <[e-mail]>
+#
+# Permission is hereby granted, free of charge, to any person
+# obtaining a copy of this software and associated documentation
+# files (the "Software"), to deal in the Software without
+# restriction, including without limitation the rights to use,
+# copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the
+# Software is furnished to do so, subject to the following
+# conditions:
+# 
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+# OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+# OTHER DEALINGS IN THE SOFTWARE.
+#
+
+man_MANS = xinput_calibrator.1

--- /dev/null
+++ b/man/xinput_calibrator.1
@@ -0,0 +1,52 @@
+.\" 
+.TH "xinput_calibrator" "1" "" "Tias Guns" ""
+.SH "NAME"
+xinput_calibrator \- A generic touchscreen calibration program for X.Org
+
+.SH "SYNOPSIS"
+.B xinput_calibrator_x11 [OPTIONS]
+.br 
+.B xinput_calibrator_gtkmm [OPTIONS]
+.SH "DESCRIPTION"
+xinput_calibrator is a program for calibrating your touchscreen, when using the X Window System.
+.PP 
+It currently features:
+.br 
+\- a minimalistic and intuitive GUI (X11 or gtkmm)
+.br 
+\- works for any standard Xorg touchscreen driver (uses Xinput to get axis valuators)
+.br 
+\- can output the calibration in xorg.conf and FDI format
+.br 
+\- can dynamically recalibrate the evdev driver
+.br 
+\- and more
+.PP 
+see http://www.freedesktop.org/wiki/Software/xinput_calibrator
+
+.SH "OPTIONS"
+.TP 8
+.B \-h, \-\-help
+Print a help message listing the version and available options.
+.PP 
+.TP 8
+.B \-v, \-\-verbose
+Print debug messages during the process.
+.PP 
+.TP 8
+.B \-\-precalib \fImin_x\fP \fImax_x\fP \fImin_y\fP \fImax_y\fP
+Manually provide the current calibration setting.
+.br 
+This is usefull if the calibration values are stored in your xorg.conf, but the driver does not export them to xinput (eg, the calibrator can not find these values)
+.PP 
+.TP 8
+.B \-\-fake
+Emulate a fake driver (for testing purposes)
+.br 
+Usefull to test the calibrator without applying the values, and possibly even without having a touchscreen.
+.SH "SEE ALSO"
+xinput(1)
+.SH "AUTHORS"
+.nf 
+Tias Guns <[e-mail]>
+.fi