source: general/sysutils/gpm.xml@ 895d2af9

10.0 10.1 11.0 11.1 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind lazarus perl-modules qt5new trunk upgradedb xry111/intltool xry111/test-20220226
Last change on this file since 895d2af9 was 895d2af9, checked in by Pierre Labastie <pieere@…>, 5 years ago

Fix gpm build with glibc 2.26 (patch from Nutyx) and tag gpm

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@19035 af4574ff-66df-0310-9fd7-8a98e5e911e0

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