Thread: [Linuxconsole-commit] SF.net SVN: linuxconsole:[2401] trunk/docs

SourceForge Headquarters 225 Broadway Suite 1600 San Diego, CA 92101 +1 (858) 422-6466

Revision: 2401
          http://linuxconsole.svn.sourceforge.net/linuxconsole/?rev=2401&view=rev
Author:   skitt
Date:     2010-12-28 22:17:35 +0000 (Tue, 28 Dec 2010)

Log Message:
-----------
Import Debian manpages.

Added Paths:
-----------
    trunk/docs/evtest.1
    trunk/docs/ffcfstress.1
    trunk/docs/ffmvforce.1
    trunk/docs/ffset.1
    trunk/docs/fftest.1
    trunk/docs/inputattach.1
    trunk/docs/jscal.1
    trunk/docs/jskeepalive.1
    trunk/docs/jstest.1

Added: trunk/docs/evtest.1
===================================================================

--- trunk/docs/evtest.1	                        (rev 0)
+++ trunk/docs/evtest.1	2010-12-28 22:17:35 UTC (rev 2401)
@@ -0,0 +1,25 @@
+.TH evtest 1 "July 23, 2008" evtest
+.SH NAME
+evtest \- Input device event monitor
+.SH SYNOPSIS
+.B evtest 
+.I /dev/input/eventX
+.SH DESCRIPTION
+evtest displays information on the input device specified on the
+command line, including all the events supported by the device.
+It then monitors the  device and displays all the events layer events
+generated.
+.PP
+evtest needs to be able to read from the device; in most cases this
+means it must be run as root.
+.SH AUTHOR
+.B evtest
+was written by Vojtech Pavlik <vo...@su...>.
+.PP
+This manual page was written by Stephen Kitt <st...@sk...>, based on
+that present in the
+.B lineakd
+package, for the Debian GNU/Linux system (but may be used by others).
+It was last modified for
+.B evtest
+version 1.23, dated February 6, 2005.

Added: trunk/docs/ffcfstress.1
===================================================================
--- trunk/docs/ffcfstress.1	                        (rev 0)
+++ trunk/docs/ffcfstress.1	2010-12-28 22:17:35 UTC (rev 2401)
@@ -0,0 +1,46 @@
+.TH ffcfstress 1 "March 8, 2009" ffcfstress
+.SH NAME
+ffcfstress \- constant force stress test for force-feedback devices
+.SH SYNOPSIS
+.B ffcfstress
+.RB "[" \-d " <\fIdevice\fP>] [" \-u " <\fIupdate rate\fP>] [" \-f " <\fIfrequency\fP>] [" \-a " <\fIamplitude\fP>] [" \-s " <\fIstrength\fP>] [" \-o "]"
+.SH "DESCRIPTION"
+ffcfstress stress tests constant non-enveloped forces on a force
+feedback device.
+It simulates a moving spring force by applying a frequently updated
+constant force effect.
+.PP
+.B Beware, the stress test may damage your device!
+.SH OPTIONS
+At least one option is required.
+.TP
+.BR \-d " <\fIdevice\fP>"
+The device to test (by default \fI/dev/input/event0\fR).
+.TP
+.BR \-u " <\fIupdate rate\fP>"
+The update rate in Hz (25 by default).
+.TP
+.BR \-f " <\fIfrequency\fP>"
+The spring center motion frequency in Hz (0.1 by default).
+.TP
+.BR \-a " <\fIamplitude\fP>"
+The spring center motion amplitude, between 0.0 and 1.0 (1.0 by
+default).
+.TP
+.BR \-s " <\fIstrength\fP>"
+The spring strength factor (1.0 by default).
+.TP
+.B \-o
+Dummy option, useful when all defaults should be used.
+.SH SEE ALSO
+\fBffmvforce\fP(1), \fBfftest\fP(1), \fBjstest\fP(1).
+.SH AUTHOR
+.B ffcfstress
+was written by Oliver Hamann.
+.PP
+This manual page was written by Stephen Kitt <st...@sk...>, for the Debian
+GNU/Linux system (but may be used by others).
+It was last modified for
+.B ffcfstress
+dated February 15, 2002.
+

Added: trunk/docs/ffmvforce.1
===================================================================
--- trunk/docs/ffmvforce.1	                        (rev 0)
+++ trunk/docs/ffmvforce.1	2010-12-28 22:17:35 UTC (rev 2401)
@@ -0,0 +1,30 @@
+.TH ffmvforce 1 "March 8, 2009" ffmvforce
+.SH NAME
+ffmvforce \- force orientation test for force-feedback devices
+.SH SYNOPSIS
+.B ffmvforce
+.RI "<" device "> [\fB-u\fP <" "update rate" ">]"
+.SH "DESCRIPTION"
+ffmvforce generates a force in a given direction, indicated by the
+position of the mouse pointer in relation to the center of the tool's
+window.
+.PP
+.B Beware, the stress test may damage your device!
+.SH OPTIONS
+.TP
+.RI "<" device ">"
+The device to test.
+.TP
+.BR \-u " <\fIupdate rate\fP>"
+The update rate in Hz (5 by default).
+.SH SEE ALSO
+\fBffcfstress\fP(1), \fBfftest\fP(1), \fBjstest\fP(1).
+.SH AUTHOR
+.B ffmvforce
+was written by Oliver Hamann.
+.PP
+This manual page was written by Stephen Kitt <st...@sk...>, for the Debian
+GNU/Linux system (but may be used by others).
+It was last modified for
+.B ffmvforce
+dated February 15, 2002.

Added: trunk/docs/ffset.1
===================================================================
--- trunk/docs/ffset.1	                        (rev 0)
+++ trunk/docs/ffset.1	2010-12-28 22:17:35 UTC (rev 2401)
@@ -0,0 +1,30 @@
+.TH ffset 1 "March 8, 2009" ffset
+.SH NAME
+ffset \- set force-feedback device parameters
+.SH SYNOPSIS
+.B ffset
+.RI "<" device "> [\fB\-g\fP <" gain ">] [\fB\-a\fP <" "autocenter strength" ">]"
+.SH "DESCRIPTION"
+ffset sets the gain and autocenter strength of a force-feedback
+device.
+.SH OPTIONS
+.TP
+.RI "<" device ">"
+The device to configure.
+.TP
+.BR \-g " <\fIgain\fP>"
+The gain (0-100).
+.TP
+.BR \-a " <\fIautocenter strength\fP>"
+The autocenter strength (0-100).
+.SH SEE ALSO
+\fBffcfstress\fP(1), \fBffmvforce\fP(1), \fBfftest\fP(1), \fBjscal\fP(1), \fBjstest\fP(1).
+.SH AUTHOR
+.B ffset
+was written by Johann Deneux.
+.PP
+This manual page was written by Stephen Kitt <st...@sk...>, for the
+Debian GNU/Linux system (but may be used by others).
+It was last modified for
+.B ffmvforce
+dated May 30, 2001.

Added: trunk/docs/fftest.1
===================================================================
--- trunk/docs/fftest.1	                        (rev 0)
+++ trunk/docs/fftest.1	2010-12-28 22:17:35 UTC (rev 2401)
@@ -0,0 +1,25 @@
+.TH fftest 1 "March 8, 2009" fftest
+.SH NAME
+fftest \- tests force-feedback devices.
+.SH SYNOPSIS
+.B fftest
+.RI "<" device ">"
+.SH "DESCRIPTION"
+fftest provides a variety of tests which can be applied to
+force-feedback devices.
+.B Beware, the tests may damage your device!
+.SH OPTIONS
+.TP
+.RI "<" device ">"
+The device to test.
+.SH SEE ALSO
+\fBffcfstress\fP(1), \fBffmvforce\fP(1), \fBjstest\fP(1).
+.SH AUTHOR
+.B fftest
+was written by Johann Deneux.
+.PP
+This manual page was written by Stephen Kitt <st...@sk...>, for the Debian
+GNU/Linux system (but may be used by others).
+It was last modified for
+.B fftest
+dated October 19, 2004.

Added: trunk/docs/inputattach.1
===================================================================
--- trunk/docs/inputattach.1	                        (rev 0)
+++ trunk/docs/inputattach.1	2010-12-28 22:17:35 UTC (rev 2401)
@@ -0,0 +1,134 @@
+.TH inputattach 1 "June 16, 2009" inputattach
+.SH NAME
+inputattach \- attach a serial line to an input-layer device
+.SH SYNOPSIS
+.BR inputattach " [" \-\-daemon "] [" \-\-always "] [" \-\-noinit "]"
+.RI "<" mode "> <" device ">"
+.SH DESCRIPTION
+.B inputattach
+attaches a serial line to an input-layer device via a line
+discipline.
+.PP
+Exactly one of the available modes must be specified on the command
+line.
+.SH OPTIONS
+.TP
+.B \-\-daemon
+Forks into the background.
+.TP
+.B \-\-always
+Ignore initialization failures when attaching the device.
+.TP
+.B \-\-noinit
+Skip device initialization.
+.SS Modes
+.TP
+.BR \-dump ", " \-\-dump
+Just enable device 
+.TP
+.BR \-elo3b ", " \-\-elo261-280
+ELO Touchscreen, 3-byte mode 
+.TP
+.BR \-elo4b ", " \-\-elo271-140
+ELO touchscreen, 4-byte mode 
+.TP
+.BR \-elo6b ", " \-\-elo4002
+ELO touchscreen, 6-byte mode 
+.TP
+.BR \-elo ", " \-\-elotouch
+ELO touchscreen, 10-byte mode 
+.TP
+.BR \-fjt ", " \-\-fujitsu
+Fujitsu serial touchscreen 
+.TP
+.BR \-ipaq ", " \-\-h3600ts
+Ipaq h3600 touchscreen 
+.TP
+.BR \-ifor ", " \-\-iforce
+I-Force joystick or wheel 
+.TP
+.BR \-ms3 ", " \-\-intellimouse
+Microsoft IntelliMouse 
+.TP
+.BR \-lk ", " \-\-lkkbd
+DEC LK201 / LK401 keyboards 
+.TP
+.BR \-mag ", " \-\-magellan
+Magellan / SpaceMouse 
+.TP
+.BR \-bare ", " \-\-microsoft
+2-button Microsoft mouse 
+.TP
+.BR \-mmw ", " \-\-mmwheel
+Logitech mouse with 4-5 buttons or a wheel 
+.TP
+.BR \-mman ", " \-\-mouseman
+3-button Logitech / Genius mouse 
+.TP
+.BR \-msc ", " \-\-mousesystems
+3-button Mouse Systems mouse 
+.TP
+.BR \-ms ", " \-\-mshack
+3-button mouse in Microsoft mode 
+.TP
+.BR \-mtouch ", " \-\-mtouch
+MicroTouch (3M) touchscreen 
+.TP
+.BR \-newt ", " \-\-newtonkbd
+Newton keyboard 
+.TP
+.BR \-pm ", " \-\-penmount
+Penmount touchscreen 
+.TP
+.BR \-ps2ser ", " \-\-ps2serkbd
+PS/2 via serial keyboard 
+.TP
+.BR \-sbl ", " \-\-spaceball
+SpaceBall 2003 / 3003 / 4000 FLX 
+.TP
+.BR \-orb ", " \-\-spaceorb
+SpaceOrb 360 / SpaceBall Avenger 
+.TP
+.BR \-sting ", " \-\-stinger
+Gravis Stinger 
+.TP
+.BR \-ipaqkbd ", " \-\-stowawaykbd
+Stowaway keyboard 
+.TP
+.BR \-skb ", " \-\-sunkbd
+Sun Type 4 and Type 5 keyboards 
+.TP
+.BR \-sun ", " \-\-sunmouse
+3-button Sun mouse 
+.TP
+.BR \-t213 ", " \-\-touchit213
+Sahara Touch-iT213 Tablet PC 
+.TP
+.BR \-tr ", " \-\-touchright
+Touchright serial touchscreen 
+.TP
+.BR \-tw ", " \-\-touchwin
+Touchwindow serial touchscreen 
+.TP
+.BR \-twidjoy ", " \-\-twiddler-joy
+Handykey Twiddler used as a joystick 
+.TP
+.BR \-twid ", " \-\-twiddler
+Handykey Twiddler chording keyboard 
+.TP
+.BR \-vs ", " \-\-vsxxx-aa
+DEC VSXXX-AA / VSXXX-GA mouse and VSXXX-A tablet 
+.TP
+.BR \-war ", " \-\-warrior
+WingMan Warrior 
+.SH AUTHORS
+.B inputattach
+was written by Vojtech Pavlik and Arndt Schoenewald.
+The version packaged for Debian includes updates by Dmitry Torokhov
+and Sahara Touch-iT213 support by Claudio Nieder.
+.PP
+This manual page was written by Stephen Kitt <st...@sk...>, for the Debian
+GNU/Linux system (but may be used by others).
+It was last modified for
+.B inputattach
+version 1.24, dated April 4, 2007.

Added: trunk/docs/jscal.1
===================================================================
--- trunk/docs/jscal.1	                        (rev 0)
+++ trunk/docs/jscal.1	2010-12-28 22:17:35 UTC (rev 2401)
@@ -0,0 +1,84 @@
+.TH jscal 1 "Jul 11, 2010" jscal
+.SH NAME
+jscal \- joystick calibration and remapping program
+.SH SYNOPSIS
+.BR jscal
+.RI "[" options "] <" device\(hyname ">"
+.SH DESCRIPTION
+.B jscal
+calibrates joysticks and maps joystick axes and buttons.
+Calibrating a joystick ensures the positions on the various axes are
+correctly interpreted.
+Mapping axes and buttons allows the meanings of the joystick's axes
+and buttons to be redefined.
+.PP
+On Debian systems the calibration settings can be stored and later
+applied automatically using the
+.B jscal-store
+command.
+.SH OPTIONS
+.TP
+.BR \-c ", " \-\-calibrate
+Calibrate the joystick.
+.TP
+.BR \-h ", " \-\-help
+Print out a summary of available options.
+.TP
+.BR \-s ", " \-\-set\-correction " <\fInb_axes\fP,\fItype\fP,\fIprecision\fP,\fIcoefficients\fP,...>"
+Sets correction to specified values.
+For each axis, specify the correction type (0 for none, 1 for "broken
+line"), the precision, and if necessary the correction coefficients
+("broken line" corrections take four coefficients).
+.TP
+.BR \-u ", " \-\-set\-mappings " <\fInb_axes\fP,\fIaxmap1\fP,\fIaxmap2\fP,...,\fInb_buttons\fP,\fIbtnmap1\fP,\fIbtnmap2\fP,...>"
+Sets axis and button mappings.
+\fIn_of_buttons\fP can be set to 0 to remap axes only.
+.IP "\fB\-t\fR, \fB\-\-test\-center\fR"
+Tests if the joystick is correctly calibrated.
+Returns 2 if the axes are not calibrated, 3 if buttons were pressed, 1
+if there was any other error, and 0 on success.
+.IP "\fB\-V\fR, \fB\-\-version\fR"
+Prints the version numbers of the running joystick driver and that
+which jscal was compiled for.
+.IP "\fB\-p\fR, \fB\-\-print\-correction\fR"
+Prints the current correction settings.
+The format of the output is a jscal command line.
+.IP "\fB\-q\fR, \fB\-\-print\-mappings\fR"
+Prints the current axis and button mappings.
+The format of the output is a jscal command line.
+.SH CALIBRATION
+Using the Linux input system, joysticks are expected to produce values
+between \-32767 and 32767 for axes, with 0 meaning the joystick is
+centred.
+Thus, full\(hyleft should produce \-32767 on the X axis, full\(hyright
+32767 on the X axis, full\(hyforward \-32767 on the Y axis, and so on.
+.PP
+Many joysticks and gamepads (especially older ones) are slightly
+mis\(hyaligned; as a result they may not use the full range of values
+(for the extremes of the axes), or more annoyingly they may not give 0
+when centred.
+Calibrating a joystick provides the kernel with information on a
+joystick's real behaviour, which allows the kernel to correct various
+joysticks' deficiencies and produce consistent output as far as
+joystick\(hyusing software is concerned.
+.PP
+\fBjstest\fP(1) is useful to determine whether a joystick is
+calibrated: when run, it should produce all 0s when the joystick is at
+rest, and each axis should be able to produce the values \-32767 and
+32767.
+Analog joysticks should produce values in between 0 and the extremes,
+but this is not necessary; digital directional pads work fine with
+only the three values.
+.SH SEE ALSO
+\fBffset\fP(1), \fBjstest\fP(1), \fBjscal\-store\fP(1).
+.SH AUTHORS
+.B jscal
+was written by Vojtech Pavlik.
+The version packaged for Debian includes patches by Dr. László Kaján,
+Johann Walles and Krzysztof A. Sobiecki.
+.PP
+This manual page was written by Stephen Kitt <st...@sk...>, for the Debian
+GNU/Linux system (but may be used by others).
+It was last modified for
+.B jscal
+version 1.2 dated October 19, 2004.

Added: trunk/docs/jskeepalive.1
===================================================================
--- trunk/docs/jskeepalive.1	                        (rev 0)
+++ trunk/docs/jskeepalive.1	2010-12-28 22:17:35 UTC (rev 2401)
@@ -0,0 +1,16 @@
+.TH jskeepalive 1 "April 7, 2010" jskeepalive
+.SH NAME
+jskeepalive \- keeps a joystick alive
+.SH SYNOPSIS
+.BR jskeepalive
+.RI "<" device-name ">"
+.SH DESCRIPTION
+.B jskeepalive
+continuously reads from the given joystick device. (This doesn't
+prevent other programs from accessing the same joystick device.) This
+is necessary for certains joysticks which disappear if they are not
+accessed during a given interval (see
+https://bugs.launchpad.net/ubuntu/+source/joystick/+bug/448446).
+.SH AUTHOR
+.B jskeepalive
+was written by Stephen Kitt.

Added: trunk/docs/jstest.1
===================================================================
--- trunk/docs/jstest.1	                        (rev 0)
+++ trunk/docs/jstest.1	2010-12-28 22:17:35 UTC (rev 2401)
@@ -0,0 +1,39 @@
+.TH jstest 1 "April 21, 2009" jstest
+.SH NAME
+jstest \- joystick test program
+.SH SYNOPSIS
+.BR jstest " [" \-\-normal "] [" \-\-old "] [" \-\-event "] [" \-\-nonblock "] [" \-\-select "] <\fIdevice-name\fP>"
+.SH DESCRIPTION
+\fBjstest\fP can be used to test all the features of the Linux
+joystick API, including non-blocking and \fBselect\fP(2) access, as
+well as version 0.x compatibility mode.
+.PP
+It is also intended to serve as an example implementation for those
+who wish to learn how to write their own joystick using applications.
+.SH OPTIONS
+.TP
+.B \-\-normal
+One-line mode showing immediate status.
+.TP
+.B \-\-old
+Same as \-\-normal, using 0.x interface.
+.TP
+.B \-\-event
+Prints events as they come in.
+.TP
+.B \-\-nonblock
+Same as \-\-event, in nonblocking mode.
+.TP
+.B \-\-select
+Same as \--event, using \fBselect\fP(2) call.
+.SH SEE ALSO
+\fBfftest\fP(1), \fBjscal\fP(1).
+.SH AUTHOR
+.B jstest
+was written by Vojtech Pavlik.
+.PP
+This manual page was written by Stephen Kitt <st...@sk...>, for the Debian
+GNU/Linux system (but may be used by others).
+It was last modified for
+.B jstest
+version 1.2, dated March 22, 2005.


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.




Thread: [Linuxconsole-commit] SF.net SVN: linuxconsole:[2401] trunk/docs

linuxconsole-commit