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 "&sources-anduin-http;/gpm/gpm-&gpm-version;.tar.bz2">
|
---|
8 | <!ENTITY gpm-download-ftp "&sources-anduin-ftp;/gpm/gpm-&gpm-version;.tar.bz2">
|
---|
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 | &lfs83_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 | <bridgehead renderas="sect3">Additional Downloads</bridgehead>
|
---|
66 | <itemizedlist spacing="compact">
|
---|
67 | <listitem>
|
---|
68 | <para>
|
---|
69 | Required patch:
|
---|
70 | <ulink url="&patch-root;/gpm-&gpm-version;-glibc_2.26-1.patch"/>
|
---|
71 | </para>
|
---|
72 | </listitem>
|
---|
73 | </itemizedlist>
|
---|
74 |
|
---|
75 | <para condition="html" role="usernotes">User Notes:
|
---|
76 | <ulink url="&blfs-wiki;/GPM"/></para>
|
---|
77 |
|
---|
78 | </sect2>
|
---|
79 |
|
---|
80 | <sect2 role="kernel" id='gpm-kernel'>
|
---|
81 | <title>Kernel Configuration</title>
|
---|
82 |
|
---|
83 | <para>
|
---|
84 | Enable the following option in the kernel configuration and recompile the
|
---|
85 | kernel if necessary:
|
---|
86 | </para>
|
---|
87 |
|
---|
88 | <screen><literal>Device Drivers --->
|
---|
89 | Input device support ---> [CONFIG_INPUT]
|
---|
90 | <*/M> Mouse interface [CONFIG_INPUT_MOUSEDEV]</literal></screen>
|
---|
91 |
|
---|
92 | <indexterm zone="gpm gpm-kernel">
|
---|
93 | <primary sortas="d-gpm">gpm</primary>
|
---|
94 | </indexterm>
|
---|
95 |
|
---|
96 | </sect2>
|
---|
97 |
|
---|
98 | <sect2 role="installation">
|
---|
99 | <title>Installation of GPM</title>
|
---|
100 |
|
---|
101 |
|
---|
102 | <para>Install <application>GPM</application> by running
|
---|
103 | the following commands:</para>
|
---|
104 |
|
---|
105 | <screen><userinput>sed -i -e 's:<gpm.h>:"headers/gpm.h":' src/prog/{display-buttons,display-coords,get-versions}.c &&
|
---|
106 | patch -Np1 -i ../gpm-&gpm-version;-glibc_2.26-1.patch &&
|
---|
107 | ./autogen.sh &&
|
---|
108 | ./configure --prefix=/usr --sysconfdir=/etc &&
|
---|
109 | make</userinput></screen>
|
---|
110 |
|
---|
111 | <para>This package does not come with a test suite.</para>
|
---|
112 |
|
---|
113 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
114 |
|
---|
115 | <screen role="root"><userinput>make install &&
|
---|
116 |
|
---|
117 | install-info --dir-file=/usr/share/info/dir \
|
---|
118 | /usr/share/info/gpm.info &&
|
---|
119 |
|
---|
120 | ln -sfv libgpm.so.2.1.0 /usr/lib/libgpm.so &&
|
---|
121 | install -v -m644 conf/gpm-root.conf /etc &&
|
---|
122 |
|
---|
123 | install -v -m755 -d /usr/share/doc/gpm-&gpm-version;/support &&
|
---|
124 | install -v -m644 doc/support/* \
|
---|
125 | /usr/share/doc/gpm-&gpm-version;/support &&
|
---|
126 | install -v -m644 doc/{FAQ,HACK_GPM,README*} \
|
---|
127 | /usr/share/doc/gpm-&gpm-version;</userinput></screen>
|
---|
128 |
|
---|
129 | </sect2>
|
---|
130 |
|
---|
131 | <sect2 role="commands">
|
---|
132 | <title>Command Explanations</title>
|
---|
133 |
|
---|
134 | <para><command>./autogen.sh</command>: This command creates the missing
|
---|
135 | <command>configure</command> script.</para>
|
---|
136 |
|
---|
137 | <para><command>install-info ...</command>: This package installs an
|
---|
138 | <filename class="extension">.info</filename> file, but does not update the
|
---|
139 | system <filename>dir</filename> file. This command makes the update.</para>
|
---|
140 |
|
---|
141 | <para><command>ln -v -sfn libgpm.so.2.1.0 /usr/lib/libgpm.so</command>: This
|
---|
142 | command is used to create (or update) the <filename class="extension">.so</filename>
|
---|
143 | symlink to the library.</para>
|
---|
144 |
|
---|
145 | </sect2>
|
---|
146 |
|
---|
147 | <sect2 role="configuration">
|
---|
148 | <title>Configuring GPM</title>
|
---|
149 |
|
---|
150 | <sect3 id="gpm-init">
|
---|
151 | <title><phrase revision="sysv">Boot Script</phrase>
|
---|
152 | <phrase revision="systemd">Systemd Unit</phrase></title>
|
---|
153 |
|
---|
154 | <indexterm zone="gpm gpm-init">
|
---|
155 | <primary sortas="f-gpm-init">gpm</primary>
|
---|
156 | </indexterm>
|
---|
157 |
|
---|
158 | <para revision="sysv">Install the
|
---|
159 | <filename>/etc/rc.d/init.d/gpm</filename> init script included in the
|
---|
160 | <xref linkend="bootscripts"/> package.</para>
|
---|
161 |
|
---|
162 | <para revision="systemd">
|
---|
163 | To start the <command>gpm</command> daemon at boot,
|
---|
164 | install the systemd unit from the <xref linkend="systemd-units"/>
|
---|
165 | package by running the following command as the
|
---|
166 | <systemitem class="username">root</systemitem> user:
|
---|
167 | </para>
|
---|
168 |
|
---|
169 | <screen role="root"><userinput>make install-gpm</userinput></screen>
|
---|
170 |
|
---|
171 | </sect3>
|
---|
172 |
|
---|
173 | <sect3 id="gpm-config">
|
---|
174 | <title>Config Files</title>
|
---|
175 |
|
---|
176 | <para><filename>/etc/gpm-root.conf</filename> and
|
---|
177 | <filename>~/.gpm-root</filename>: The default and individual user
|
---|
178 | <command>gpm-root</command> configuration files.</para>
|
---|
179 |
|
---|
180 | <para revision="sysv"><filename>/etc/sysconfig/mouse</filename>:
|
---|
181 | This file contains the name of your mouse device and the protocol
|
---|
182 | it uses. To create this file, run the following as the
|
---|
183 | <systemitem class="username">root</systemitem> user:</para>
|
---|
184 |
|
---|
185 | <screen role="root" revision="sysv"><userinput>cat > /etc/sysconfig/mouse << "EOF"
|
---|
186 | <literal># Begin /etc/sysconfig/mouse
|
---|
187 |
|
---|
188 | MDEVICE="<replaceable><yourdevice></replaceable>"
|
---|
189 | PROTOCOL="<replaceable><yourprotocol></replaceable>"
|
---|
190 | GPMOPTS="<replaceable><additional options></replaceable>"
|
---|
191 |
|
---|
192 | # End /etc/sysconfig/mouse</literal>
|
---|
193 | EOF</userinput></screen>
|
---|
194 |
|
---|
195 | <indexterm zone="gpm gpm-config">
|
---|
196 | <primary sortas="e-AA.gpm-root">~/.gpm-root</primary>
|
---|
197 | </indexterm>
|
---|
198 |
|
---|
199 | <indexterm zone="gpm gpm-config">
|
---|
200 | <primary sortas="e-etc-gpm-root.conf">/etc/gpm-root.conf</primary>
|
---|
201 | </indexterm>
|
---|
202 |
|
---|
203 | <indexterm zone="gpm gpm-config" revision="sysv">
|
---|
204 | <primary sortas="e-etc-sysconfig-mouse">/etc/sysconfig/mouse</primary>
|
---|
205 | </indexterm>
|
---|
206 |
|
---|
207 | </sect3>
|
---|
208 |
|
---|
209 | <sect3>
|
---|
210 | <title>Configuration Information</title>
|
---|
211 |
|
---|
212 | <para revision="sysv">Examples of values to set <envar>MDEVICE</envar>,
|
---|
213 | <envar>PROTOCOL</envar>, and <envar>GPMOPTS</envar> to are:</para>
|
---|
214 |
|
---|
215 | <screen revision="sysv"><literal>MDEVICE="/dev/input/mice"
|
---|
216 | PROTOCOL="imps2"
|
---|
217 | GPMOPTS=""</literal></screen>
|
---|
218 |
|
---|
219 | <para revision="sysv">A list of which protocol values are known can be
|
---|
220 | found by running
|
---|
221 | <command>gpm -m <replaceable>[device]</replaceable> -t -help</command>.
|
---|
222 | The <envar>MDEVICE</envar> setting depends on which type of mouse you
|
---|
223 | have. For example, <filename>/dev/ttyS0</filename> for a serial mouse
|
---|
224 | (on Windows this is COM1), <filename>/dev/input/mice</filename> is often
|
---|
225 | used for USB mice and <filename>/dev/psaux</filename> for PS2 mice.
|
---|
226 | <envar>GPMOPTS</envar> is the 'catch all' for any additional options that
|
---|
227 | are needed for your hardware.</para>
|
---|
228 |
|
---|
229 | <para revision="systemd">
|
---|
230 | <application>GPM</application> is by default started with
|
---|
231 | the following parameters:
|
---|
232 | <parameter>-m /dev/input/mice -t imps2</parameter>. If the
|
---|
233 | mentioned parameters don't suit your needs, you can override
|
---|
234 | them by running the following commands as
|
---|
235 | the <systemitem class="username">root</systemitem> user:
|
---|
236 | </para>
|
---|
237 |
|
---|
238 | <screen role="root" revision="systemd"><userinput>install -v -dm755 /etc/systemd/system/gpm.service.d
|
---|
239 | echo "ExecStart=/usr/sbin/gpm <list of parameters>" > /etc/systemd/system/gpm.service.d/99-user.conf</userinput></screen>
|
---|
240 |
|
---|
241 | </sect3>
|
---|
242 |
|
---|
243 | </sect2>
|
---|
244 |
|
---|
245 | <sect2 role="content">
|
---|
246 | <title>Contents</title>
|
---|
247 |
|
---|
248 | <segmentedlist>
|
---|
249 | <segtitle>Installed Programs</segtitle>
|
---|
250 | <segtitle>Installed Library</segtitle>
|
---|
251 | <segtitle>Installed Directory</segtitle>
|
---|
252 |
|
---|
253 | <seglistitem>
|
---|
254 | <seg>disable-paste, display-buttons, display-coords, get-versions, gpm,
|
---|
255 | gpm-root, hltest, mev, and mouse-test</seg>
|
---|
256 | <seg>libgpm.{so.a}</seg>
|
---|
257 | <seg>/usr/share/doc/gpm-&gpm-version;</seg>
|
---|
258 | </seglistitem>
|
---|
259 | </segmentedlist>
|
---|
260 |
|
---|
261 | <variablelist>
|
---|
262 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
263 | <?dbfo list-presentation="list"?>
|
---|
264 | <?dbhtml list-presentation="table"?>
|
---|
265 |
|
---|
266 | <varlistentry id="disable-paste">
|
---|
267 | <term><command>disable-paste</command></term>
|
---|
268 | <listitem>
|
---|
269 | <para>is a security mechanism used to disable the paste buffer.</para>
|
---|
270 | <indexterm zone="gpm disable-paste">
|
---|
271 | <primary sortas="b-disable-paste">disable-paste</primary>
|
---|
272 | </indexterm>
|
---|
273 | </listitem>
|
---|
274 | </varlistentry>
|
---|
275 |
|
---|
276 | <varlistentry id="display-buttons">
|
---|
277 | <term><command>display-buttons</command></term>
|
---|
278 | <listitem>
|
---|
279 | <para>is a simple program that reports the mouse buttons being
|
---|
280 | pressed and released.</para>
|
---|
281 | <indexterm zone="gpm display-buttons">
|
---|
282 | <primary sortas="b-display-buttons">display-buttons</primary>
|
---|
283 | </indexterm>
|
---|
284 | </listitem>
|
---|
285 | </varlistentry>
|
---|
286 |
|
---|
287 | <varlistentry id="display-coords">
|
---|
288 | <term><command>display-coords</command></term>
|
---|
289 | <listitem>
|
---|
290 | <para>is a simple program that reports the mouse coordinates.</para>
|
---|
291 | <indexterm zone="gpm display-coords">
|
---|
292 | <primary sortas="b-display-coords">display-coords</primary>
|
---|
293 | </indexterm>
|
---|
294 | </listitem>
|
---|
295 | </varlistentry>
|
---|
296 |
|
---|
297 | <varlistentry id="get-versions">
|
---|
298 | <term><command>get-versions</command></term>
|
---|
299 | <listitem>
|
---|
300 | <para>is used to report the <application>GPM</application> library
|
---|
301 | and server versions.</para>
|
---|
302 | <indexterm zone="gpm get-versions">
|
---|
303 | <primary sortas="b-get-versions">get-versions</primary>
|
---|
304 | </indexterm>
|
---|
305 | </listitem>
|
---|
306 | </varlistentry>
|
---|
307 |
|
---|
308 | <varlistentry id="gpm-prog">
|
---|
309 | <term><command>gpm</command></term>
|
---|
310 | <listitem>
|
---|
311 | <para>is a cut and paste utility and mouse server for virtual consoles.</para>
|
---|
312 | <indexterm zone="gpm gpm-prog">
|
---|
313 | <primary sortas="b-gpm">gpm</primary>
|
---|
314 | </indexterm>
|
---|
315 | </listitem>
|
---|
316 | </varlistentry>
|
---|
317 |
|
---|
318 | <varlistentry id="gpm-root">
|
---|
319 | <term><command>gpm-root</command></term>
|
---|
320 | <listitem>
|
---|
321 | <para>is a default handler for <command>gpm</command>. It is used to
|
---|
322 | draw menus on the root window.</para>
|
---|
323 | <indexterm zone="gpm gpm-root">
|
---|
324 | <primary sortas="b-gpm-root">gpm-root</primary>
|
---|
325 | </indexterm>
|
---|
326 | </listitem>
|
---|
327 | </varlistentry>
|
---|
328 |
|
---|
329 | <varlistentry id="hltest">
|
---|
330 | <term><command>hltest</command></term>
|
---|
331 | <listitem>
|
---|
332 | <para>is a simple sample application using the high-level library,
|
---|
333 | meant to be read by programmers trying to use the high-level library.</para>
|
---|
334 | <indexterm zone="gpm hltest">
|
---|
335 | <primary sortas="b-hltest">hltest</primary>
|
---|
336 | </indexterm>
|
---|
337 | </listitem>
|
---|
338 | </varlistentry>
|
---|
339 |
|
---|
340 | <varlistentry id="mev">
|
---|
341 | <term><command>mev</command></term>
|
---|
342 | <listitem>
|
---|
343 | <para>is a program to report mouse events.</para>
|
---|
344 | <indexterm zone="gpm mev">
|
---|
345 | <primary sortas="b-mev">mev</primary>
|
---|
346 | </indexterm>
|
---|
347 | </listitem>
|
---|
348 | </varlistentry>
|
---|
349 |
|
---|
350 | <varlistentry id="mouse-test">
|
---|
351 | <term><command>mouse-test</command></term>
|
---|
352 | <listitem>
|
---|
353 | <para>is a tool for determining the mouse type and device it's
|
---|
354 | attached to.</para>
|
---|
355 | <indexterm zone="gpm mouse-test">
|
---|
356 | <primary sortas="b-mouse-test">mouse-test</primary>
|
---|
357 | </indexterm>
|
---|
358 | </listitem>
|
---|
359 | </varlistentry>
|
---|
360 |
|
---|
361 | <varlistentry id="libgpm">
|
---|
362 | <term><filename class='libraryfile'>libgpm.{so.a}</filename></term>
|
---|
363 | <listitem>
|
---|
364 | <para>contains the API functions to access the
|
---|
365 | <application>GPM</application> daemon.</para>
|
---|
366 | <indexterm zone="gpm libgpm">
|
---|
367 | <primary sortas="c-libgpm">libgpm.{so,a}</primary>
|
---|
368 | </indexterm>
|
---|
369 | </listitem>
|
---|
370 | </varlistentry>
|
---|
371 |
|
---|
372 | </variablelist>
|
---|
373 |
|
---|
374 | </sect2>
|
---|
375 |
|
---|
376 | </sect1>
|
---|