source: general/sysutils/gpm.xml@ fabf04f7

10.0 10.1 11.0 8.0 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind ken/refactor-virt lazarus perl-modules qt5new trunk upgradedb xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since fabf04f7 was fabf04f7, checked in by Douglas R. Reno <renodr@…>, 5 years ago

Update to wget-1.19.1
Add GPM patch. Thanks to Hazel Russman for reporting

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

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