source: general/sysutils/gpm.xml@ 8459178

10.0 10.1 11.0 11.1 11.2 11.3 12.0 12.1 7.10 7.4 7.5 7.6 7.6-blfs 7.6-systemd 7.7 7.8 7.9 8.0 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind gnome kde5-13430 kde5-14269 kde5-14686 kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts krejzi/svn lazarus lxqt nosym perl-modules plabs/newcss plabs/python-mods python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition systemd-11177 systemd-13485 trunk upgradedb xry111/intltool xry111/llvm18 xry111/soup3 xry111/test-20220226 xry111/xf86-video-removal
Last change on this file since 8459178 was 8459178, checked in by Randy McMurchy <randy@…>, 11 years ago

Add a command to the GPM instructions to create the missing configure script

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

  • Property mode set to 100644
File size: 11.5 KB
RevLine 
[52d29f7]1<?xml version="1.0" encoding="ISO-8859-1"?>
[6732c094]2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
[52d29f7]4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
6
[93ab9d5]7 <!ENTITY gpm-download-http "http://www.nico.schottelius.org/software/gpm/archives/gpm-&gpm-version;.tar.bz2">
[9a9d63d4]8 <!ENTITY gpm-download-ftp " ">
[6d2cc23]9 <!ENTITY gpm-md5sum "bf84143905a6a903dbd4d4b911a2a2b8">
10 <!ENTITY gpm-size "820 KB">
11 <!ENTITY gpm-buildsize "7.4 MB">
[fada515]12 <!ENTITY gpm-time "0.1 SBU">
[52d29f7]13]>
14
[5db3785e]15<sect1 id="gpm" xreflabel="GPM-&gpm-version;">
[20e3223]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
[539ace5]32 <para>The <application>GPM</application> (General Purpose Mouse
33 daemon) package contains a mouse server for the console and
[20e3223]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
[539ace5]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
[20e3223]39 between two console windows than to type everything by hand!</para>
40
[6d2cc23]41 &lfs72_checked;
[aafcfb8]42
[20e3223]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
[9a9d63d4]65 <!-- <bridgehead renderas="sect3">Additional Downloads</bridgehead>
[20e3223]66 <itemizedlist spacing='compact'>
67 <listitem>
68 <para>Recommended Patch: <ulink
69 url="&patch-root;/gpm-&gpm-version;-segfault-1.patch"/></para>
70 </listitem>
71 <listitem>
72 <para>Recommended Patch: <ulink
73 url="&patch-root;/gpm-&gpm-version;-silent-1.patch"/></para>
74 </listitem>
[9a9d63d4]75 </itemizedlist> -->
[20e3223]76
[1039de3]77 <para condition="html" role="usernotes">User Notes:
[6c42d4e]78 <ulink url="&blfs-wiki;/GPM"/></para>
[1039de3]79
[20e3223]80 </sect2>
81
82 <sect2 role="installation">
83 <title>Installation of GPM</title>
84
[539ace5]85 <para>Install <application>GPM</application> by running
[20e3223]86 the following commands:</para>
87
[8459178]88<screen><userinput>./autogen.sh &amp;&amp;
89./configure --prefix=/usr --sysconfdir=/etc &amp;&amp;
[9a9d63d4]90make</userinput></screen>
91
92 <para>This package does not come with a test suite.</para>
[d260aaf4]93
[20e3223]94 <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
[d260aaf4]95
[8459178]96<screen role="root"><userinput>make install &amp;&amp;
[9a9d63d4]97
[8459178]98install-info --dir-file=/usr/share/info/dir \
99 /usr/share/info/gpm.info &amp;&amp;
[cb098fac]100
[8459178]101ln -v -sfn libgpm.so.2.1.0 /usr/lib/libgpm.so &amp;&amp;
102install -v -m644 conf/gpm-root.conf /etc &amp;&amp;
[d691f65]103
[8459178]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*} \
[d691f65]108 /usr/share/doc/gpm-&gpm-version;</userinput></screen>
[52d29f7]109
[20e3223]110 </sect2>
[014d11ad]111
[d691f65]112 <sect2 role="commands">
[20e3223]113 <title>Command Explanations</title>
114
[8459178]115 <para><command>./autogen.sh</command>: This command creates the missing
116 <command>configure</command> script.</para>
117
[6d2cc23]118 <para><command>install-info ...</command>: This package installs an
[d691f65]119 <filename class="extension">.info</filename> file, but does not update the
120 system <filename>dir</filename> file. This command makes the update.</para>
[014d11ad]121
[6d2cc23]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>
[d691f65]124 symlink to the library.</para>
[014d11ad]125
[d691f65]126 </sect2>
[20e3223]127
128 <sect2 role="configuration">
129 <title>Configuring GPM</title>
130
131 <sect3 id="gpm-init">
132 <title>Boot Script</title>
[52d29f7]133
[20e3223]134 <indexterm zone="gpm gpm-init">
135 <primary sortas="f-gpm-init">gpm</primary>
136 </indexterm>
[014d11ad]137
[539ace5]138 <para>Install the <filename>/etc/rc.d/init.d/gpm</filename> init script
[5254d12]139 included in the <xref linkend="bootscripts"/> package.</para>
[09f7011]140
[20e3223]141<screen role="root"><userinput>make install-gpm</userinput></screen>
[014d11ad]142
[20e3223]143 </sect3>
[014d11ad]144
[20e3223]145 <sect3 id="gpm-config">
146 <title>Config Files</title>
[34f86ab]147
[539ace5]148 <para><filename>/etc/gpm-root.conf</filename> and
149 <filename>~/.gpm-root</filename>: The default and individual user
[20e3223]150 <command>gpm-root</command> configuration files.</para>
[34f86ab]151
[539ace5]152 <para><filename>/etc/sysconfig/mouse</filename>:
[8459178]153 This file contains the name of your mouse device and the protocol
[539ace5]154 it uses. To create this file, run the following as the
[343bcdb]155 <systemitem class="username">root</systemitem> user:</para>
[014d11ad]156
[20e3223]157<screen role="root"><userinput>cat &gt; /etc/sysconfig/mouse &lt;&lt; "EOF"
158<literal># Begin /etc/sysconfig/mouse
[014d11ad]159
[1039de3]160MDEVICE="<replaceable>&lt;yourdevice&gt;</replaceable>"
161PROTOCOL="<replaceable>&lt;yourprotocol&gt;</replaceable>"
162GPMOPTS="<replaceable>&lt;additional options&gt;</replaceable>"
[014d11ad]163
[20e3223]164# End /etc/sysconfig/mouse</literal>
165EOF</userinput></screen>
166
167 <indexterm zone="gpm gpm-config">
168 <primary sortas="e-AA.gpm-root">~/.gpm-root</primary>
169 </indexterm>
170
171 <indexterm zone="gpm gpm-config">
172 <primary sortas="e-etc-gpm-root.conf">/etc/gpm-root.conf</primary>
173 </indexterm>
174
175 <indexterm zone="gpm gpm-config">
176 <primary sortas="e-etc-sysconfig-mouse">/etc/sysconfig/mouse</primary>
177 </indexterm>
[09f7011]178
[20e3223]179 </sect3>
[014d11ad]180
[20e3223]181 <sect3>
182 <title>Configuration Information</title>
[014d11ad]183
[20e3223]184 <para>Examples of values to set <envar>MDEVICE</envar>,
185 <envar>PROTOCOL</envar>, and <envar>GPMOPTS</envar> to are:</para>
[014d11ad]186
[20e3223]187<screen><literal>MDEVICE="/dev/psaux"
[004a8284]188PROTOCOL="imps2"
[20e3223]189GPMOPTS=""</literal></screen>
190
191 <para>A list of which protocol values are known can be found by running
[480b859]192 <command>gpm -m <replaceable>[device]</replaceable> -t -help</command>.
193 The <envar>MDEVICE</envar> setting depends on which type of mouse you
194 have. For example, <filename>/dev/ttyS0</filename> for a serial mouse
195 (on Windows this is COM1), <filename>/dev/input/mice</filename> is often
196 used for USB mice and <filename>/dev/psaux</filename> for PS2 mice.
197 <envar>GPMOPTS</envar> is the 'catch all' for any additional options that
198 are needed for your hardware.</para>
[20e3223]199
200 </sect3>
201
202 </sect2>
203
204 <sect2 role="content">
205 <title>Contents</title>
206
207 <segmentedlist>
208 <segtitle>Installed Programs</segtitle>
[d284bee]209 <segtitle>Installed Library</segtitle>
210 <segtitle>Installed Directory</segtitle>
[20e3223]211
212 <seglistitem>
[9a9d63d4]213 <seg>disable-paste, display-buttons, display-coords, get-versions, gpm,
214 gpm-root, hltest, mev, and mouse-test</seg>
[1039de3]215 <seg>libgpm.{so.a}</seg>
[d691f65]216 <seg>/usr/share/doc/gpm-&gpm-version;</seg>
[20e3223]217 </seglistitem>
218 </segmentedlist>
219
220 <variablelist>
221 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
222 <?dbfo list-presentation="list"?>
223 <?dbhtml list-presentation="table"?>
224
225 <varlistentry id="disable-paste">
226 <term><command>disable-paste</command></term>
227 <listitem>
228 <para>is a security mechanism used to disable the paste buffer.</para>
229 <indexterm zone="gpm disable-paste">
230 <primary sortas="b-disable-paste">disable-paste</primary>
231 </indexterm>
232 </listitem>
233 </varlistentry>
234
[9a9d63d4]235 <varlistentry id="display-buttons">
236 <term><command>display-buttons</command></term>
237 <listitem>
238 <para>is a simple program that reports the mouse buttons being
239 pressed and released.</para>
240 <indexterm zone="gpm display-buttons">
241 <primary sortas="b-display-buttons">display-buttons</primary>
242 </indexterm>
243 </listitem>
244 </varlistentry>
245
246 <varlistentry id="display-coords">
247 <term><command>display-coords</command></term>
248 <listitem>
249 <para>is a simple program that reports the mouse coordinates.</para>
250 <indexterm zone="gpm display-coords">
251 <primary sortas="b-display-coords">display-coords</primary>
252 </indexterm>
253 </listitem>
254 </varlistentry>
255
256 <varlistentry id="get-versions">
257 <term><command>get-versions</command></term>
258 <listitem>
259 <para>is used to report the <application>GPM</application> library
260 and server versions.</para>
261 <indexterm zone="gpm get-versions">
262 <primary sortas="b-get-versions">get-versions</primary>
263 </indexterm>
264 </listitem>
265 </varlistentry>
266
[20e3223]267 <varlistentry id="gpm-prog">
268 <term><command>gpm</command></term>
269 <listitem>
270 <para>is a cut and paste utility and mouse server for virtual consoles.</para>
271 <indexterm zone="gpm gpm-prog">
272 <primary sortas="b-gpm">gpm</primary>
273 </indexterm>
274 </listitem>
275 </varlistentry>
276
277 <varlistentry id="gpm-root">
278 <term><command>gpm-root</command></term>
279 <listitem>
[539ace5]280 <para>is a default handler for <command>gpm</command>. It is used to
[20e3223]281 draw menus on the root window.</para>
282 <indexterm zone="gpm gpm-root">
283 <primary sortas="b-gpm-root">gpm-root</primary>
284 </indexterm>
285 </listitem>
286 </varlistentry>
287
288 <varlistentry id="hltest">
289 <term><command>hltest</command></term>
290 <listitem>
[539ace5]291 <para>is a simple sample application using the high-level library,
[20e3223]292 meant to be read by programmers trying to use the high-level library.</para>
293 <indexterm zone="gpm hltest">
294 <primary sortas="b-hltest">hltest</primary>
295 </indexterm>
296 </listitem>
297 </varlistentry>
298
299 <varlistentry id="mev">
300 <term><command>mev</command></term>
301 <listitem>
302 <para>is a program to report mouse events.</para>
303 <indexterm zone="gpm mev">
304 <primary sortas="b-mev">mev</primary>
305 </indexterm>
306 </listitem>
307 </varlistentry>
308
309 <varlistentry id="mouse-test">
310 <term><command>mouse-test</command></term>
311 <listitem>
[539ace5]312 <para>is a tool for determining the mouse type and device it's
[20e3223]313 attached to.</para>
314 <indexterm zone="gpm mouse-test">
315 <primary sortas="b-mouse-test">mouse-test</primary>
316 </indexterm>
317 </listitem>
318 </varlistentry>
319
[2db2a0c4]320 <varlistentry id="libgpm">
[1039de3]321 <term><filename class='libraryfile'>libgpm.{so.a}</filename></term>
[2db2a0c4]322 <listitem>
323 <para>contains the API functions to access the
324 <application>GPM</application> daemon.</para>
325 <indexterm zone="gpm libgpm">
[1039de3]326 <primary sortas="c-libgpm">libgpm.{so,a}</primary>
[2db2a0c4]327 </indexterm>
328 </listitem>
329 </varlistentry>
330
[20e3223]331 </variablelist>
332
333 </sect2>
[f45b1953]334
335</sect1>
Note: See TracBrowser for help on using the repository browser.