source: general/sysutils/gpm.xml@ 65caf34

12.1 ken/TL2024 ken/tuningfonts lazarus plabs/newcss python3.11 rahul/power-profiles-daemon renodr/vulkan-addition trunk xry111/llvm18
Last change on this file since 65caf34 was 7ffcdc1, checked in by Xi Ruoyao <xry111@…>, 10 months ago

gpm: Add ac_cv_path_emacs=no, and add texlive as optional dependency for doc

  • Property mode set to 100644
File size: 15.0 KB
Line 
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
19 <title>GPM-&gpm-version;</title>
20
21 <indexterm zone="gpm">
22 <primary sortas="a-GPM">GPM</primary>
23 </indexterm>
24
25 <sect2 role="package">
26 <title>Introduction to GPM</title>
27
28 <para>
29 The <application>GPM</application> (General Purpose Mouse daemon)
30 package contains a mouse server for the console and
31 <command>xterm</command>. It not only provides cut and paste support
32 generally, but its library component is used by various software such as
33 <application>Links</application> to provide mouse support to the
34 application. It is useful on desktops, especially if following (Beyond)
35 Linux From Scratch instructions; it's often much easier (and less error
36 prone) to cut and paste between two console windows than to type
37 everything by hand!
38 </para>
39
40 &lfs120_checked;
41
42 <bridgehead renderas="sect3">Package Information</bridgehead>
43 <itemizedlist spacing="compact">
44 <listitem>
45 <para>
46 Download (HTTP): <ulink url="&gpm-download-http;"/>
47 </para>
48 </listitem>
49 <listitem>
50 <para>
51 Download (FTP): <ulink url="&gpm-download-ftp;"/>
52 </para>
53 </listitem>
54 <listitem>
55 <para>
56 Download MD5 sum: &gpm-md5sum;
57 </para>
58 </listitem>
59 <listitem>
60 <para>
61 Download size: &gpm-size;
62 </para>
63 </listitem>
64 <listitem>
65 <para>
66 Estimated disk space required: &gpm-buildsize;
67 </para>
68 </listitem>
69 <listitem>
70 <para>
71 Estimated build time: &gpm-time;
72 </para>
73 </listitem>
74 </itemizedlist>
75
76 <bridgehead renderas="sect3">Additional Downloads</bridgehead>
77 <itemizedlist spacing="compact">
78 <listitem>
79 <para>
80 Required patch:
81 <ulink url="&patch-root;/gpm-&gpm-version;-consolidated-1.patch"/>
82 </para>
83 </listitem>
84 </itemizedlist>
85
86 <para condition="html" role="usernotes">Editor Notes:
87 <ulink url="&blfs-wiki;/GPM"/></para>
88
89 <bridgehead renderas="sect3">GPM Dependencies</bridgehead>
90
91 <bridgehead renderas="sect4">Optional</bridgehead>
92 <para role="optional">
93 <xref linkend="texlive"/> (for documentation)
94 </para>
95 </sect2>
96
97 <sect2 role="kernel" id='gpm-kernel'>
98 <title>Kernel Configuration</title>
99
100 <para>
101 Enable the following option in the kernel configuration and recompile the
102 kernel if necessary:
103 </para>
104
105 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
106 href="gpm-kernel.xml"/>
107
108 <indexterm zone="gpm gpm-kernel">
109 <primary sortas="d-gpm">gpm</primary>
110 </indexterm>
111
112 </sect2>
113
114 <sect2 role="installation">
115 <title>Installation of GPM</title>
116
117 <para>
118 Install <application>GPM</application> by running
119 the following commands:
120 </para>
121
122<screen><userinput>patch -Np1 -i ../gpm-&gpm-version;-consolidated-1.patch &amp;&amp;
123./autogen.sh &amp;&amp;
124./configure --prefix=/usr --sysconfdir=/etc ac_cv_path_emacs=no &amp;&amp;
125make</userinput></screen>
126
127 <para>
128 If <xref linkend='texlive'/> is installed, build the GPM manual as
129 dvi, ps, and pdf formats:
130 </para>
131
132<screen remap='doc'><userinput>make -C doc gpm.{dvi,ps} &amp;&amp;
133dvipdfm doc/gpm.dvi -o doc/gpm.pdf</userinput></screen>
134
135 <para>
136 This package does not come with a test suite.
137 </para>
138
139 <para>
140 Now, as the <systemitem class="username">root</systemitem> user:
141 </para>
142
143<screen role="root"><userinput>make install &amp;&amp;
144
145install-info --dir-file=/usr/share/info/dir \
146 /usr/share/info/gpm.info &amp;&amp;
147
148rm -fv /usr/lib/libgpm.a &amp;&amp;
149ln -sfv libgpm.so.2.1.0 /usr/lib/libgpm.so &amp;&amp;
150install -v -m644 conf/gpm-root.conf /etc &amp;&amp;
151
152install -v -m755 -d /usr/share/doc/gpm-&gpm-version;/support &amp;&amp;
153install -v -m644 doc/support/* \
154 /usr/share/doc/gpm-&gpm-version;/support &amp;&amp;
155install -v -m644 doc/{FAQ,HACK_GPM,README*} \
156 /usr/share/doc/gpm-&gpm-version;</userinput></screen>
157
158 <para>
159 If <xref linkend='texlive'/> is installed and you've built GPM
160 manual as dvi, ps, and pdf formats, install them as the &root; user:
161 </para>
162
163<screen role='root' remap='doc'><userinput>install -vm644 doc/gpm.{dvi,ps,pdf} /usr/share/doc/gpm-&gpm-version;</userinput></screen>
164
165 </sect2>
166
167 <sect2 role="commands">
168 <title>Command Explanations</title>
169
170 <para>
171 <command>./autogen.sh</command>: This command creates the missing
172 <command>configure</command> script.
173 </para>
174
175 <para>
176 <parameter>ac_cv_path_emacs=no</parameter>: This variable works around
177 an issue causing the package fail to build with
178 <xref linkend='emacs'/> installed. It also suppresses the
179 installations of some <quote>Emacs support files</quote> shipped with
180 GPM. These files are quite outdated and they should be superseded
181 with <xref linkend='emacs'/> built-in GPM support. If you need to use
182 <xref linkend='emacs'/> in Linux console with mouse support, you
183 should install (or reinstall) <xref linkend='emacs'/>
184 <emphasis role='bold'>after</emphasis> GPM.
185 </para>
186
187 <para>
188 <command>install-info ...</command>: This package installs a
189 <filename class="extension">.info</filename> file, but does not update
190 the system <filename>dir</filename> file. This command makes the update.
191 </para>
192
193 <para>
194 <command>ln -v -sfn libgpm.so.2.1.0 /usr/lib/libgpm.so</command>: This
195 command is used to create (or update) the <filename
196 class="extension">.so</filename> symlink to the library.
197 </para>
198
199 </sect2>
200
201 <sect2 role="configuration">
202 <title>Configuring GPM</title>
203
204 <sect3 id="gpm-init">
205 <title><phrase revision="sysv">Boot Script</phrase>
206 <phrase revision="systemd">Systemd Unit</phrase></title>
207
208 <indexterm zone="gpm gpm-init">
209 <primary sortas="f-gpm-init">gpm</primary>
210 </indexterm>
211
212 <para revision="sysv">
213 Install the
214 <filename>/etc/rc.d/init.d/gpm</filename> init script included in the
215 <xref linkend="bootscripts"/> package.
216 </para>
217
218 <para revision="systemd">
219 To start the <command>gpm</command> daemon at boot,
220 install the systemd unit from the <xref linkend="systemd-units"/>
221 package by running the following command as the
222 <systemitem class="username">root</systemitem> user:
223 </para>
224
225<screen role="root"><userinput>make install-gpm</userinput></screen>
226
227 </sect3>
228
229 <sect3 id="gpm-config">
230 <title>Config Files</title>
231
232 <para>
233 <filename>/etc/gpm-root.conf</filename> and
234 <filename>~/.gpm-root</filename>: The default and individual user
235 <command>gpm-root</command> configuration files.
236 </para>
237
238 <para revision="sysv">
239 <filename>/etc/sysconfig/mouse</filename>:
240 This file contains the name of your mouse device and the protocol
241 it uses. To create this file, run the following as the
242 <systemitem class="username">root</systemitem> user:
243 </para>
244
245<screen role="root" revision="sysv"><userinput>cat &gt; /etc/sysconfig/mouse &lt;&lt; "EOF"
246<literal># Begin /etc/sysconfig/mouse
247
248MDEVICE="<replaceable>&lt;yourdevice&gt;</replaceable>"
249PROTOCOL="<replaceable>&lt;yourprotocol&gt;</replaceable>"
250GPMOPTS="<replaceable>&lt;additional options&gt;</replaceable>"
251
252# End /etc/sysconfig/mouse</literal>
253EOF</userinput></screen>
254
255 <indexterm zone="gpm gpm-config">
256 <primary sortas="e-AA.gpm-root">~/.gpm-root</primary>
257 </indexterm>
258
259 <indexterm zone="gpm gpm-config">
260 <primary sortas="e-etc-gpm-root.conf">/etc/gpm-root.conf</primary>
261 </indexterm>
262
263 <indexterm zone="gpm gpm-config" revision="sysv">
264 <primary sortas="e-etc-sysconfig-mouse">/etc/sysconfig/mouse</primary>
265 </indexterm>
266
267 </sect3>
268
269 <sect3>
270 <title>Configuration Information</title>
271
272 <para revision="sysv">
273 Examples of values to set <envar>MDEVICE</envar>,
274 <envar>PROTOCOL</envar>, and <envar>GPMOPTS</envar> to are:
275 </para>
276
277<screen revision="sysv"><literal>MDEVICE="/dev/input/mice"
278PROTOCOL="imps2"
279GPMOPTS=""</literal></screen>
280
281 <para revision="sysv">
282 A list of which protocol values are known can be found by running
283 <command>gpm -m <replaceable>[device]</replaceable> -t -help</command>.
284 The <envar>MDEVICE</envar> setting depends on which type of mouse you
285 have. For example, <filename>/dev/ttyS0</filename> for a serial mouse
286 (on Windows this is COM1), <filename>/dev/input/mice</filename> is
287 often used for USB mice and <filename>/dev/psaux</filename> for PS2
288 mice. <envar>GPMOPTS</envar> is the 'catch all' for any additional
289 options that are needed for your hardware.
290 </para>
291
292 <para revision="systemd">
293 <application>GPM</application> is by default started with
294 the following parameters:
295 <parameter>-m /dev/input/mice -t imps2</parameter>. If the
296 mentioned parameters don't suit your needs, you can override
297 them by running the following commands as
298 the <systemitem class="username">root</systemitem> user:
299 </para>
300
301<screen role="nodump" revision="systemd"><userinput>install -v -dm755 /etc/systemd/system/gpm.service.d &amp;&amp;
302cat &gt; /etc/systemd/system/gpm.service.d/99-user.conf &lt;&lt; EOF
303<literal>[Service]
304ExecStart=/usr/sbin/gpm <replaceable>&lt;list of parameters&gt;</replaceable>
305</literal>EOF</userinput></screen>
306
307 </sect3>
308
309 </sect2>
310
311 <sect2 role="content">
312 <title>Contents</title>
313
314 <segmentedlist>
315 <segtitle>Installed Programs</segtitle>
316 <segtitle>Installed Library</segtitle>
317 <segtitle>Installed Directory</segtitle>
318
319 <seglistitem>
320 <seg>disable-paste, display-buttons, display-coords, get-versions, gpm,
321 gpm-root, hltest, mev, and mouse-test</seg>
322 <seg>libgpm.so</seg>
323 <seg>/usr/share/doc/gpm-&gpm-version;</seg>
324 </seglistitem>
325 </segmentedlist>
326
327 <variablelist>
328 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
329 <?dbfo list-presentation="list"?>
330 <?dbhtml list-presentation="table"?>
331
332 <varlistentry id="disable-paste">
333 <term><command>disable-paste</command></term>
334 <listitem>
335 <para>
336 is a security mechanism used to disable the paste buffer
337 </para>
338 <indexterm zone="gpm disable-paste">
339 <primary sortas="b-disable-paste">disable-paste</primary>
340 </indexterm>
341 </listitem>
342 </varlistentry>
343
344 <varlistentry id="display-buttons">
345 <term><command>display-buttons</command></term>
346 <listitem>
347 <para>
348 is a simple program that reports the mouse buttons being
349 pressed and released
350 </para>
351 <indexterm zone="gpm display-buttons">
352 <primary sortas="b-display-buttons">display-buttons</primary>
353 </indexterm>
354 </listitem>
355 </varlistentry>
356
357 <varlistentry id="display-coords">
358 <term><command>display-coords</command></term>
359 <listitem>
360 <para>
361 is a simple program that reports the mouse coordinates
362 </para>
363 <indexterm zone="gpm display-coords">
364 <primary sortas="b-display-coords">display-coords</primary>
365 </indexterm>
366 </listitem>
367 </varlistentry>
368
369 <varlistentry id="get-versions">
370 <term><command>get-versions</command></term>
371 <listitem>
372 <para>
373 is used to report the <application>GPM</application> library
374 and server versions
375 </para>
376 <indexterm zone="gpm get-versions">
377 <primary sortas="b-get-versions">get-versions</primary>
378 </indexterm>
379 </listitem>
380 </varlistentry>
381
382 <varlistentry id="gpm-prog">
383 <term><command>gpm</command></term>
384 <listitem>
385 <para>
386 is a cut and paste utility and mouse server for virtual consoles
387 </para>
388 <indexterm zone="gpm gpm-prog">
389 <primary sortas="b-gpm">gpm</primary>
390 </indexterm>
391 </listitem>
392 </varlistentry>
393
394 <varlistentry id="gpm-root">
395 <term><command>gpm-root</command></term>
396 <listitem>
397 <para>
398 is a default handler for <command>gpm</command>. It is used to
399 draw menus on the root window
400 </para>
401 <indexterm zone="gpm gpm-root">
402 <primary sortas="b-gpm-root">gpm-root</primary>
403 </indexterm>
404 </listitem>
405 </varlistentry>
406
407 <varlistentry id="hltest">
408 <term><command>hltest</command></term>
409 <listitem>
410 <para>
411 is a simple sample application using the high-level library, meant
412 to be read by programmers trying to use the high-level library
413 </para>
414 <indexterm zone="gpm hltest">
415 <primary sortas="b-hltest">hltest</primary>
416 </indexterm>
417 </listitem>
418 </varlistentry>
419
420 <varlistentry id="mev">
421 <term><command>mev</command></term>
422 <listitem>
423 <para>
424 is a program to report mouse events
425 </para>
426 <indexterm zone="gpm mev">
427 <primary sortas="b-mev">mev</primary>
428 </indexterm>
429 </listitem>
430 </varlistentry>
431
432 <varlistentry id="mouse-test">
433 <term><command>mouse-test</command></term>
434 <listitem>
435 <para>
436 is a tool for determining the mouse type and device it's
437 attached to
438 </para>
439 <indexterm zone="gpm mouse-test">
440 <primary sortas="b-mouse-test">mouse-test</primary>
441 </indexterm>
442 </listitem>
443 </varlistentry>
444
445 <varlistentry id="libgpm">
446 <term><filename class="libraryfile">libgpm.so</filename></term>
447 <listitem>
448 <para>
449 contains the API functions to access the
450 <application>GPM</application> daemon
451 </para>
452 <indexterm zone="gpm libgpm">
453 <primary sortas="c-libgpm">libgpm.so</primary>
454 </indexterm>
455 </listitem>
456 </varlistentry>
457
458 </variablelist>
459
460 </sect2>
461
462</sect1>
Note: See TracBrowser for help on using the repository browser.