Debian Codegraph @

upstream/debian-unstable/man5/gpm.conf.5

raw
1 .\" gpm.conf.5
2 .\" Written in 2005 by Peter Samuelson for the Debian Project.
3 .\"
4 .\" No rights are reserved; anyone may copy, modify and distribute this
5 .\" file in any way and for any purpose, exactly as though it were in
6 .\" the public domain.
7 .\"
8 .Dd January 5, 2005
9 .Dt GPM.CONF 5
10 .Os Debian 3.0
11 .\"
12 .Sh NAME
13 .Nm gpm.conf
14 .Nd startup configuration file for gpm
15 .\"
16 .Sh DESCRIPTION
17 .Pp
18 .Nm
19 specifies options to be passed to the
20 .Nm gpm
21 daemon at start time. It is parsed by the init script, rather than by
22 .Nm gpm
23 itself. It comprises variable assignments in Bourne shell syntax:
24 \fIvariable\fR=\fIvalue\fR (with no extra spaces; to embed spaces or
25 other shell metacharacters in values, use quotes as in shell
26 scripting). Blank lines and lines beginning with a hash ("\fB#\fR")
27 are ignored.
28 .Pp
29 Settings are implemented by setting flags on the
30 .Nm gpm
31 command line; these are documented in
32 .Xr gpm 8 .
33 The following variable names are specified:
34 .Bl -tag
35 .It device
36 Specifies the device file for your primary mouse. This sets
37 .Fl m .
38 .It type
39 Specifies the protocol for your primary mouse. This sets
40 .Fl t .
41 .It device2, type2
42 The same as
43 .Va device
44 and
45 .Va type ,
46 but for your secondary mouse. These set
47 .Fl m
48 and
49 .Fl t
50 after passing
51 .Fl M .
52 If either of these are defined, both must be.
53 .It responsiveness
54 Specifies the responsiveness for your primary mouse. This sets
55 .Fl r .
56 .It sample_rate
57 Specifies the sample rate for your primary mouse. This sets
58 .Fl s .
59 .It repeat_type
60 Enables the
61 .Nm gpm
62 repeater and sets the repeater protocol, using the
63 .Fl R
64 flag. Repeat type
65 .Va none
66 or an empty value will disable the repeater.
67 .It append
68 Any options specified here are appended to the
69 .Nm gpm
70 command line. If you use multiple options, you will need to enclose
71 the value in quotes ("").
72 .El
73 .\"
74 .Sh EXAMPLES
75 .Pp
76 A simple
77 .Nm
78 file for a PS/2 mouse whose protocol should be autodetected, and which
79 should be repeated in
80 .Pa /dev/gpmdata
81 as a serial Microsoft Intellimouse:
82 .Bd -literal -offset indent
83 # Sample gpm.conf
84
85 device=/dev/psaux
86 type=autops2
87 repeat_type=ms3
88 .Ed
89 .Pp
90 This will cause the daemon to be started as
91 .Nm gpm Fl m Ar /dev/psaux Fl t Ar autops2 Fl Rms3 .
92 .\"
93 .Sh FILES
94 .Pa /etc/gpm.conf
95 .\"
96 .Sh SEE ALSO
97 .Xr gpm 8 ,
98 .Xr dpkg\-reconfigure 8 .
99 .Nm dpkg\-reconfigure Ar gpm
100 can be used to generate and update the
101 .Nm
102 file automatically.