1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
5 | %general-entities;
|
---|
6 |
|
---|
7 | <!ENTITY gpm-download-http "http://www.nico.schottelius.org/software/gpm/archives/gpm-&gpm-version;.tar.bz2">
|
---|
8 | <!ENTITY gpm-download-ftp " ">
|
---|
9 | <!ENTITY gpm-md5sum "bf84143905a6a903dbd4d4b911a2a2b8">
|
---|
10 | <!ENTITY gpm-size "820 KB">
|
---|
11 | <!ENTITY gpm-buildsize "7.4 MB">
|
---|
12 | <!ENTITY gpm-time "0.1 SBU">
|
---|
13 | ]>
|
---|
14 |
|
---|
15 | <sect1 id="gpm" xreflabel="GPM-&gpm-version;">
|
---|
16 | <?dbhtml filename="gpm.html"?>
|
---|
17 |
|
---|
18 | <sect1info>
|
---|
19 | <othername>$LastChangedBy$</othername>
|
---|
20 | <date>$Date$</date>
|
---|
21 | </sect1info>
|
---|
22 |
|
---|
23 | <title>GPM-&gpm-version;</title>
|
---|
24 |
|
---|
25 | <indexterm zone="gpm">
|
---|
26 | <primary sortas="a-GPM">GPM</primary>
|
---|
27 | </indexterm>
|
---|
28 |
|
---|
29 | <sect2 role="package">
|
---|
30 | <title>Introduction to GPM</title>
|
---|
31 |
|
---|
32 | <para>The <application>GPM</application> (General Purpose Mouse
|
---|
33 | daemon) package contains a mouse server for the console and
|
---|
34 | <command>xterm</command>. It not only provides cut and paste support
|
---|
35 | generally, but its library component is used by various software such as
|
---|
36 | <application>Links</application> to provide mouse support to the application.
|
---|
37 | It is useful on desktops, especially if following (Beyond) Linux From Scratch
|
---|
38 | instructions; it's often much easier (and less error prone) to cut and paste
|
---|
39 | between two console windows than to type everything by hand!</para>
|
---|
40 |
|
---|
41 | &lfs80_checked;
|
---|
42 |
|
---|
43 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
44 | <itemizedlist spacing="compact">
|
---|
45 | <listitem>
|
---|
46 | <para>Download (HTTP): <ulink url="&gpm-download-http;"/></para>
|
---|
47 | </listitem>
|
---|
48 | <listitem>
|
---|
49 | <para>Download (FTP): <ulink url="&gpm-download-ftp;"/></para>
|
---|
50 | </listitem>
|
---|
51 | <listitem>
|
---|
52 | <para>Download MD5 sum: &gpm-md5sum;</para>
|
---|
53 | </listitem>
|
---|
54 | <listitem>
|
---|
55 | <para>Download size: &gpm-size;</para>
|
---|
56 | </listitem>
|
---|
57 | <listitem>
|
---|
58 | <para>Estimated disk space required: &gpm-buildsize;</para>
|
---|
59 | </listitem>
|
---|
60 | <listitem>
|
---|
61 | <para>Estimated build time: &gpm-time;</para>
|
---|
62 | </listitem>
|
---|
63 | </itemizedlist>
|
---|
64 |
|
---|
65 | <!--
|
---|
66 | <bridgehead renderas="sect3">Additional Downloads</bridgehead>
|
---|
67 | <itemizedlist spacing="compact">
|
---|
68 | <listitem>
|
---|
69 | <para>
|
---|
70 | Required patch:
|
---|
71 | <ulink url="&patch-root;/gpm-&gpm-version;-fix_build_failures-1.patch"/>
|
---|
72 | </para>
|
---|
73 | </listitem>
|
---|
74 | </itemizedlist>
|
---|
75 | -->
|
---|
76 |
|
---|
77 | <para condition="html" role="usernotes">User Notes:
|
---|
78 | <ulink url="&blfs-wiki;/GPM"/></para>
|
---|
79 |
|
---|
80 | </sect2>
|
---|
81 |
|
---|
82 | <sect2 role="installation">
|
---|
83 | <title>Installation of GPM</title>
|
---|
84 |
|
---|
85 | <para>Install <application>GPM</application> by running
|
---|
86 | the following commands:</para>
|
---|
87 |
|
---|
88 | <screen><userinput>sed -i -e 's:<gpm.h>:"headers/gpm.h":' src/prog/{display-buttons,display-coords,get-versions}.c &&
|
---|
89 | ./autogen.sh &&
|
---|
90 | ./configure --prefix=/usr --sysconfdir=/etc &&
|
---|
91 | make</userinput></screen>
|
---|
92 |
|
---|
93 | <para>This package does not come with a test suite.</para>
|
---|
94 |
|
---|
95 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
96 |
|
---|
97 | <screen role="root"><userinput>make install &&
|
---|
98 |
|
---|
99 | install-info --dir-file=/usr/share/info/dir \
|
---|
100 | /usr/share/info/gpm.info &&
|
---|
101 |
|
---|
102 | ln -sfv libgpm.so.2.1.0 /usr/lib/libgpm.so &&
|
---|
103 | install -v -m644 conf/gpm-root.conf /etc &&
|
---|
104 |
|
---|
105 | install -v -m755 -d /usr/share/doc/gpm-&gpm-version;/support &&
|
---|
106 | install -v -m644 doc/support/* \
|
---|
107 | /usr/share/doc/gpm-&gpm-version;/support &&
|
---|
108 | install -v -m644 doc/{FAQ,HACK_GPM,README*} \
|
---|
109 | /usr/share/doc/gpm-&gpm-version;</userinput></screen>
|
---|
110 |
|
---|
111 | </sect2>
|
---|
112 |
|
---|
113 | <sect2 role="commands">
|
---|
114 | <title>Command Explanations</title>
|
---|
115 |
|
---|
116 | <para><command>./autogen.sh</command>: This command creates the missing
|
---|
117 | <command>configure</command> script.</para>
|
---|
118 |
|
---|
119 | <para><command>install-info ...</command>: This package installs an
|
---|
120 | <filename class="extension">.info</filename> file, but does not update the
|
---|
121 | system <filename>dir</filename> file. This command makes the update.</para>
|
---|
122 |
|
---|
123 | <para><command>ln -v -sfn libgpm.so.2.1.0 /usr/lib/libgpm.so</command>: This
|
---|
124 | command is used to create (or update) the <filename class="extension">.so</filename>
|
---|
125 | symlink to the library.</para>
|
---|
126 |
|
---|
127 | </sect2>
|
---|
128 |
|
---|
129 | <sect2 role="configuration">
|
---|
130 | <title>Configuring GPM</title>
|
---|
131 |
|
---|
132 | <sect3 id="gpm-init">
|
---|
133 | <title><phrase revision="sysv">Boot Script</phrase>
|
---|
134 | <phrase revision="systemd">Systemd Unit</phrase></title>
|
---|
135 |
|
---|
136 | <indexterm zone="gpm gpm-init">
|
---|
137 | <primary sortas="f-gpm-init">gpm</primary>
|
---|
138 | </indexterm>
|
---|
139 |
|
---|
140 | <para revision="sysv">Install the
|
---|
141 | <filename>/etc/rc.d/init.d/gpm</filename> init script included in the
|
---|
142 | <xref linkend="bootscripts"/> package.</para>
|
---|
143 |
|
---|
144 | <para revision="systemd">
|
---|
145 | To start the <command>gpm</command> daemon at boot,
|
---|
146 | install the systemd unit from the <xref linkend="systemd-units"/>
|
---|
147 | package by running the following command as the
|
---|
148 | <systemitem class="username">root</systemitem> user:
|
---|
149 | </para>
|
---|
150 |
|
---|
151 | <screen role="root"><userinput>make install-gpm</userinput></screen>
|
---|
152 |
|
---|
153 | </sect3>
|
---|
154 |
|
---|
155 | <sect3 id="gpm-config">
|
---|
156 | <title>Config Files</title>
|
---|
157 |
|
---|
158 | <para><filename>/etc/gpm-root.conf</filename> and
|
---|
159 | <filename>~/.gpm-root</filename>: The default and individual user
|
---|
160 | <command>gpm-root</command> configuration files.</para>
|
---|
161 |
|
---|
162 | <para revision="sysv"><filename>/etc/sysconfig/mouse</filename>:
|
---|
163 | This file contains the name of your mouse device and the protocol
|
---|
164 | it uses. To create this file, run the following as the
|
---|
165 | <systemitem class="username">root</systemitem> user:</para>
|
---|
166 |
|
---|
167 | <screen role="root" revision="sysv"><userinput>cat > /etc/sysconfig/mouse << "EOF"
|
---|
168 | <literal># Begin /etc/sysconfig/mouse
|
---|
169 |
|
---|
170 | MDEVICE="<replaceable><yourdevice></replaceable>"
|
---|
171 | PROTOCOL="<replaceable><yourprotocol></replaceable>"
|
---|
172 | GPMOPTS="<replaceable><additional options></replaceable>"
|
---|
173 |
|
---|
174 | # End /etc/sysconfig/mouse</literal>
|
---|
175 | EOF</userinput></screen>
|
---|
176 |
|
---|
177 | <indexterm zone="gpm gpm-config">
|
---|
178 | <primary sortas="e-AA.gpm-root">~/.gpm-root</primary>
|
---|
179 | </indexterm>
|
---|
180 |
|
---|
181 | <indexterm zone="gpm gpm-config">
|
---|
182 | <primary sortas="e-etc-gpm-root.conf">/etc/gpm-root.conf</primary>
|
---|
183 | </indexterm>
|
---|
184 |
|
---|
185 | <indexterm zone="gpm gpm-config" revision="sysv">
|
---|
186 | <primary sortas="e-etc-sysconfig-mouse">/etc/sysconfig/mouse</primary>
|
---|
187 | </indexterm>
|
---|
188 |
|
---|
189 | </sect3>
|
---|
190 |
|
---|
191 | <sect3>
|
---|
192 | <title>Configuration Information</title>
|
---|
193 |
|
---|
194 | <para revision="sysv">Examples of values to set <envar>MDEVICE</envar>,
|
---|
195 | <envar>PROTOCOL</envar>, and <envar>GPMOPTS</envar> to are:</para>
|
---|
196 |
|
---|
197 | <screen revision="sysv"><literal>MDEVICE="/dev/input/mice"
|
---|
198 | PROTOCOL="imps2"
|
---|
199 | GPMOPTS=""</literal></screen>
|
---|
200 |
|
---|
201 | <para revision="sysv">A list of which protocol values are known can be
|
---|
202 | found by running
|
---|
203 | <command>gpm -m <replaceable>[device]</replaceable> -t -help</command>.
|
---|
204 | The <envar>MDEVICE</envar> setting depends on which type of mouse you
|
---|
205 | have. For example, <filename>/dev/ttyS0</filename> for a serial mouse
|
---|
206 | (on Windows this is COM1), <filename>/dev/input/mice</filename> is often
|
---|
207 | used for USB mice and <filename>/dev/psaux</filename> for PS2 mice.
|
---|
208 | <envar>GPMOPTS</envar> is the 'catch all' for any additional options that
|
---|
209 | are needed for your hardware.</para>
|
---|
210 |
|
---|
211 | <para revision="systemd">
|
---|
212 | <application>GPM</application> is by default started with
|
---|
213 | the following parameters:
|
---|
214 | <parameter>-m /dev/input/mice -t imps2</parameter>. If the
|
---|
215 | mentioned parameters don't suit your needs, you can override
|
---|
216 | them by running the following commands as
|
---|
217 | the <systemitem class="username">root</systemitem> user:
|
---|
218 | </para>
|
---|
219 |
|
---|
220 | <screen role="root" revision="systemd"><userinput>install -v -dm755 /etc/systemd/system/gpm.service.d
|
---|
221 | echo "ExecStart=/usr/sbin/gpm <list of parameters>" > /etc/systemd/system/gpm.service.d/99-user.conf</userinput></screen>
|
---|
222 |
|
---|
223 | </sect3>
|
---|
224 |
|
---|
225 | </sect2>
|
---|
226 |
|
---|
227 | <sect2 role="content">
|
---|
228 | <title>Contents</title>
|
---|
229 |
|
---|
230 | <segmentedlist>
|
---|
231 | <segtitle>Installed Programs</segtitle>
|
---|
232 | <segtitle>Installed Library</segtitle>
|
---|
233 | <segtitle>Installed Directory</segtitle>
|
---|
234 |
|
---|
235 | <seglistitem>
|
---|
236 | <seg>disable-paste, display-buttons, display-coords, get-versions, gpm,
|
---|
237 | gpm-root, hltest, mev, and mouse-test</seg>
|
---|
238 | <seg>libgpm.{so.a}</seg>
|
---|
239 | <seg>/usr/share/doc/gpm-&gpm-version;</seg>
|
---|
240 | </seglistitem>
|
---|
241 | </segmentedlist>
|
---|
242 |
|
---|
243 | <variablelist>
|
---|
244 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
245 | <?dbfo list-presentation="list"?>
|
---|
246 | <?dbhtml list-presentation="table"?>
|
---|
247 |
|
---|
248 | <varlistentry id="disable-paste">
|
---|
249 | <term><command>disable-paste</command></term>
|
---|
250 | <listitem>
|
---|
251 | <para>is a security mechanism used to disable the paste buffer.</para>
|
---|
252 | <indexterm zone="gpm disable-paste">
|
---|
253 | <primary sortas="b-disable-paste">disable-paste</primary>
|
---|
254 | </indexterm>
|
---|
255 | </listitem>
|
---|
256 | </varlistentry>
|
---|
257 |
|
---|
258 | <varlistentry id="display-buttons">
|
---|
259 | <term><command>display-buttons</command></term>
|
---|
260 | <listitem>
|
---|
261 | <para>is a simple program that reports the mouse buttons being
|
---|
262 | pressed and released.</para>
|
---|
263 | <indexterm zone="gpm display-buttons">
|
---|
264 | <primary sortas="b-display-buttons">display-buttons</primary>
|
---|
265 | </indexterm>
|
---|
266 | </listitem>
|
---|
267 | </varlistentry>
|
---|
268 |
|
---|
269 | <varlistentry id="display-coords">
|
---|
270 | <term><command>display-coords</command></term>
|
---|
271 | <listitem>
|
---|
272 | <para>is a simple program that reports the mouse coordinates.</para>
|
---|
273 | <indexterm zone="gpm display-coords">
|
---|
274 | <primary sortas="b-display-coords">display-coords</primary>
|
---|
275 | </indexterm>
|
---|
276 | </listitem>
|
---|
277 | </varlistentry>
|
---|
278 |
|
---|
279 | <varlistentry id="get-versions">
|
---|
280 | <term><command>get-versions</command></term>
|
---|
281 | <listitem>
|
---|
282 | <para>is used to report the <application>GPM</application> library
|
---|
283 | and server versions.</para>
|
---|
284 | <indexterm zone="gpm get-versions">
|
---|
285 | <primary sortas="b-get-versions">get-versions</primary>
|
---|
286 | </indexterm>
|
---|
287 | </listitem>
|
---|
288 | </varlistentry>
|
---|
289 |
|
---|
290 | <varlistentry id="gpm-prog">
|
---|
291 | <term><command>gpm</command></term>
|
---|
292 | <listitem>
|
---|
293 | <para>is a cut and paste utility and mouse server for virtual consoles.</para>
|
---|
294 | <indexterm zone="gpm gpm-prog">
|
---|
295 | <primary sortas="b-gpm">gpm</primary>
|
---|
296 | </indexterm>
|
---|
297 | </listitem>
|
---|
298 | </varlistentry>
|
---|
299 |
|
---|
300 | <varlistentry id="gpm-root">
|
---|
301 | <term><command>gpm-root</command></term>
|
---|
302 | <listitem>
|
---|
303 | <para>is a default handler for <command>gpm</command>. It is used to
|
---|
304 | draw menus on the root window.</para>
|
---|
305 | <indexterm zone="gpm gpm-root">
|
---|
306 | <primary sortas="b-gpm-root">gpm-root</primary>
|
---|
307 | </indexterm>
|
---|
308 | </listitem>
|
---|
309 | </varlistentry>
|
---|
310 |
|
---|
311 | <varlistentry id="hltest">
|
---|
312 | <term><command>hltest</command></term>
|
---|
313 | <listitem>
|
---|
314 | <para>is a simple sample application using the high-level library,
|
---|
315 | meant to be read by programmers trying to use the high-level library.</para>
|
---|
316 | <indexterm zone="gpm hltest">
|
---|
317 | <primary sortas="b-hltest">hltest</primary>
|
---|
318 | </indexterm>
|
---|
319 | </listitem>
|
---|
320 | </varlistentry>
|
---|
321 |
|
---|
322 | <varlistentry id="mev">
|
---|
323 | <term><command>mev</command></term>
|
---|
324 | <listitem>
|
---|
325 | <para>is a program to report mouse events.</para>
|
---|
326 | <indexterm zone="gpm mev">
|
---|
327 | <primary sortas="b-mev">mev</primary>
|
---|
328 | </indexterm>
|
---|
329 | </listitem>
|
---|
330 | </varlistentry>
|
---|
331 |
|
---|
332 | <varlistentry id="mouse-test">
|
---|
333 | <term><command>mouse-test</command></term>
|
---|
334 | <listitem>
|
---|
335 | <para>is a tool for determining the mouse type and device it's
|
---|
336 | attached to.</para>
|
---|
337 | <indexterm zone="gpm mouse-test">
|
---|
338 | <primary sortas="b-mouse-test">mouse-test</primary>
|
---|
339 | </indexterm>
|
---|
340 | </listitem>
|
---|
341 | </varlistentry>
|
---|
342 |
|
---|
343 | <varlistentry id="libgpm">
|
---|
344 | <term><filename class='libraryfile'>libgpm.{so.a}</filename></term>
|
---|
345 | <listitem>
|
---|
346 | <para>contains the API functions to access the
|
---|
347 | <application>GPM</application> daemon.</para>
|
---|
348 | <indexterm zone="gpm libgpm">
|
---|
349 | <primary sortas="c-libgpm">libgpm.{so,a}</primary>
|
---|
350 | </indexterm>
|
---|
351 | </listitem>
|
---|
352 | </varlistentry>
|
---|
353 |
|
---|
354 | </variablelist>
|
---|
355 |
|
---|
356 | </sect2>
|
---|
357 |
|
---|
358 | </sect1>
|
---|