[Pkg-gpm-devel] Bug#288606: gpm: /etc/gpm.conf better documented

[Peter Samuelson]

--1sNVjLsmu1MXqwQ/
Content-Type: multipart/mixed; boundary="2JFBq9zoW8cOFH7v"
Content-Disposition: inline


--2JFBq9zoW8cOFH7v
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline


package gpm
tags 288606 pending
thanks

[Jari]
> The current values in /etc/gpm.conf are not documented in the manual
> page, but looking at the /etc/init.d/gpm will reveal the uses.

Attached is a new gpm.conf(5) manpage.  Suggestions welcome - does it
look adequate, or do you think I should copy some details in from the
gpm(8) manpage?

(To view an arbitrary file as a manpage, use "man ./filename".)

Peter

--2JFBq9zoW8cOFH7v
Content-Type: text/plain; charset=us-ascii
Content-Disposition: attachment; filename="gpm.conf.5"
Content-Transfer-Encoding: quoted-printable

=2E\" gpm.conf.5
=2E\" Written in 2005 by Peter Samuelson for the Debian Project.
=2E\"
=2E\" No rights are reserved; anyone may copy, modify and distribute this
=2E\" file in any way and for any purpose, exactly as though it were in
=2E\" the public domain.

=2EDd January 5, 2005
=2EDt GPM.CONF 5
=2EOs Debian

=2ESh NAME
=2ENm gpm.conf
=2ENd startup configuration file for gpm

=2ESh DESCRIPTION
=2EPp
=2ENm
specifies options to be passed to the
=2ENm gpm
daemon at start time.  It is parsed by the init script, rather than by
=2ENm gpm
itself.  It comprises variable assignments in Bourne shell syntax:
\fIvariable\fR=3D\fIvalue\fR (with no extra spaces; to embed spaces or
other shell metacharacters in values, use quotes as in shell
scripting).  Blank lines and lines beginning with a hash ("\fB#\fR")
are ignored.
=2EPp
Settings are implemented by setting flags on the
=2ENm gpm
command line; these are documented in
=2EXr gpm 8 .
The following variable names are specified:
=2EBl -tag
=2EIt device
Specifies the device file for your primary mouse.  This sets
=2EFl m .
=2EIt type
Specifies the protocol for your primary mouse.  This sets
=2EFl t .
=2EIt device2, type2
The same as
=2EVa device
and
=2EVa type ,
but for your secondary mouse.  These set
=2EFl m
and
=2EFl t
after passing
=2EFl M .
If either of these are defined, both must be.
=2EIt responsiveness
Specifies the responsiveness for your primary mouse.  This sets
=2EFl r .
=2EIt sample_rate
Specifies the sample rate for your primary mouse.  This sets
=2EFl s .
=2EIt repeat_type
Enables the
=2ENm gpm
repeater and sets the repeater protocol, using the
=2EFl R
flag.  Repeat type
=2EVa none
or an empty value will disable the repeater.
=2EIt append
Any options specified here are appended to the
=2ENm gpm
command line.  If you use multiple options, you will need to enclose
the value in quotes ("").
=2EEl

=2ESh EXAMPLES
=2EPp
A simple
=2ENm
file for a PS/2 mouse whose protocol should be autodetected, and which
should be repeated in
=2EPa /dev/gpmdata
as a serial Microsoft Intellimouse:
=2EBd -literal -offset indent
# Sample gpm.conf

device=3D/dev/psaux
type=3Dautops2
repeat_type=3Dms3
=2EEd
=2EPp
This will cause the daemon to be started as
=2ENm gpm Fl m Ar /dev/psaux Fl t Ar autops2 Fl Rms3 .

=2ESh FILES
=2EPa /etc/gpm.conf

=2ESh SEE ALSO
=2EXr gpm 8 ,
=2EXr dpkg-reconfigure 8 .
=2ENm dpkg-reconfigure Ar gpm=20
can be used to generate and update the
=2ENm
file automatically.

--2JFBq9zoW8cOFH7v--

--1sNVjLsmu1MXqwQ/
Content-Type: application/pgp-signature; name="signature.asc"
Content-Description: Digital signature
Content-Disposition: inline

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.2.5 (GNU/Linux)

iD8DBQFB28NlXk7sIRPQRh0RAub7AJkB2CST5E9vWMoHlJ9Eoh294yp37wCghLIr
qvLgrHmdPnf1wyn8f8Ad9vU=
=70E6
-----END PGP SIGNATURE-----

--1sNVjLsmu1MXqwQ/--