source: general/sysutils/gpm.xml@ fb2e525

10.0 10.1 11.0 6.3 6.3-rc1 6.3-rc2 6.3-rc3 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 ken/refactor-virt krejzi/svn lazarus nosym perl-modules qt5new systemd-11177 systemd-13485 trunk upgradedb xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since fb2e525 was fb2e525, checked in by Randy McMurchy <randy@…>, 15 years ago

Modified a heavily used (bookwise) FTP download repo to use an entity and created the entity with a known good FTP repo

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

  • Property mode set to 100644
File size: 10.2 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 <!-- Inserted as a reminder to do this. The mention of a test suite
8 is usually right before the root user installation commands. Please
9 delete these 12 (including one blank) lines after you are done.-->
10
11 <!-- Use one of the two mentions below about a test suite,
12 delete the line that is not applicable. Of course, if the
13 test suite uses syntax other than "make check", revise the
14 line to reflect the actual syntax to run the test suite -->
15
16 <!-- <para>This package does not come with a test suite.</para> -->
17 <!-- <para>To test the results, issue: <command>make check</command>.</para> -->
18
19 <!ENTITY gpm-download-http "http://ftp.schottelius.org/pub/linux/gpm/gpm-&gpm-version;.tar.bz2">
20 <!ENTITY gpm-download-ftp "&gentoo-ftp-repo;/gpm-&gpm-version;.tar.bz2">
21 <!ENTITY gpm-md5sum "2c63e827d755527950d9d13fe3d87692">
22 <!ENTITY gpm-size "556 KB">
23 <!ENTITY gpm-buildsize "6.7 MB">
24 <!ENTITY gpm-time "0.1 SBU">
25]>
26
27<sect1 id="gpm" xreflabel="GPM-&gpm-version;">
28 <?dbhtml filename="gpm.html"?>
29
30 <sect1info>
31 <othername>$LastChangedBy$</othername>
32 <date>$Date$</date>
33 </sect1info>
34
35 <title>GPM-&gpm-version;</title>
36
37 <indexterm zone="gpm">
38 <primary sortas="a-GPM">GPM</primary>
39 </indexterm>
40
41 <sect2 role="package">
42 <title>Introduction to GPM</title>
43
44 <para>The <application>GPM</application> (General Purpose Mouse
45 daemon) package contains a mouse server for the console and
46 <command>xterm</command>. It not only provides cut and paste support
47 generally, but its library component is used by various software such as
48 <application>Links</application> to provide mouse support to the application.
49 It is useful on desktops, especially if following (Beyond) Linux From Scratch
50 instructions; it's often much easier (and less error prone) to cut and paste
51 between two console windows than to type everything by hand!</para>
52
53 <bridgehead renderas="sect3">Package Information</bridgehead>
54 <itemizedlist spacing="compact">
55 <listitem>
56 <para>Download (HTTP): <ulink url="&gpm-download-http;"/></para>
57 </listitem>
58 <listitem>
59 <para>Download (FTP): <ulink url="&gpm-download-ftp;"/></para>
60 </listitem>
61 <listitem>
62 <para>Download MD5 sum: &gpm-md5sum;</para>
63 </listitem>
64 <listitem>
65 <para>Download size: &gpm-size;</para>
66 </listitem>
67 <listitem>
68 <para>Estimated disk space required: &gpm-buildsize;</para>
69 </listitem>
70 <listitem>
71 <para>Estimated build time: &gpm-time;</para>
72 </listitem>
73 </itemizedlist>
74
75 <bridgehead renderas="sect3">Additional Downloads</bridgehead>
76 <itemizedlist spacing='compact'>
77 <listitem>
78 <para>Recommended Patch: <ulink
79 url="&patch-root;/gpm-&gpm-version;-segfault-1.patch"/></para>
80 </listitem>
81 <listitem>
82 <para>Recommended Patch: <ulink
83 url="&patch-root;/gpm-&gpm-version;-silent-1.patch"/></para>
84 </listitem>
85 </itemizedlist>
86
87 <para condition="html" role="usernotes">User Notes:
88 <ulink url="&blfs-wiki;/GPM"/></para>
89
90 </sect2>
91
92 <sect2 role="installation">
93 <title>Installation of GPM</title>
94
95 <para>Install <application>GPM</application> by running
96 the following commands:</para>
97
98<screen><userinput>patch -Np1 -i ../gpm-&gpm-version;-segfault-1.patch &amp;&amp;
99patch -Np1 -i ../gpm-&gpm-version;-silent-1.patch &amp;&amp;
100./configure --prefix=/usr --sysconfdir=/etc &amp;&amp;
101LDFLAGS="-lm" make</userinput></screen>
102
103 <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
104
105<screen role="root"><userinput>make install &amp;&amp;
106cp -v conf/gpm-root.conf /etc &amp;&amp;
107ldconfig</userinput></screen>
108
109 </sect2>
110
111 <sect2 role="commands">
112 <title>Command Explanations</title>
113
114 <para><command>LDFLAGS="-lm"</command>: The math library
115 must be linked with <command>gpm</command>, as ceil() is used in
116 some cursor scrolling logic.</para>
117
118<!-- <para><command>ldconfig -n -l </command>: During installation, gpm outputs a
119message to run the above command to create the proper library links.</para> -->
120
121 </sect2>
122
123 <sect2 role="configuration">
124 <title>Configuring GPM</title>
125
126 <sect3 id="gpm-init">
127 <title>Boot Script</title>
128
129 <indexterm zone="gpm gpm-init">
130 <primary sortas="f-gpm-init">gpm</primary>
131 </indexterm>
132
133 <para>Install the <filename>/etc/rc.d/init.d/gpm</filename> init script
134 included in the <xref linkend="bootscripts"/> package.</para>
135
136<screen role="root"><userinput>make install-gpm</userinput></screen>
137
138 </sect3>
139
140 <sect3 id="gpm-config">
141 <title>Config Files</title>
142
143 <para><filename>/etc/gpm-root.conf</filename> and
144 <filename>~/.gpm-root</filename>: The default and individual user
145 <command>gpm-root</command> configuration files.</para>
146
147 <para><filename>/etc/sysconfig/mouse</filename>:
148 This file contains the name of your mouse device and the protocol which
149 it uses. To create this file, run the following as the
150 <systemitem class="username">root</systemitem> user:</para>
151
152<screen role="root"><userinput>cat &gt; /etc/sysconfig/mouse &lt;&lt; "EOF"
153<literal># Begin /etc/sysconfig/mouse
154
155MDEVICE="<replaceable>&lt;yourdevice&gt;</replaceable>"
156PROTOCOL="<replaceable>&lt;yourprotocol&gt;</replaceable>"
157GPMOPTS="<replaceable>&lt;additional options&gt;</replaceable>"
158
159# End /etc/sysconfig/mouse</literal>
160EOF</userinput></screen>
161
162 <indexterm zone="gpm gpm-config">
163 <primary sortas="e-AA.gpm-root">~/.gpm-root</primary>
164 </indexterm>
165
166 <indexterm zone="gpm gpm-config">
167 <primary sortas="e-etc-gpm-root.conf">/etc/gpm-root.conf</primary>
168 </indexterm>
169
170 <indexterm zone="gpm gpm-config">
171 <primary sortas="e-etc-sysconfig-mouse">/etc/sysconfig/mouse</primary>
172 </indexterm>
173
174 </sect3>
175
176 <sect3>
177 <title>Configuration Information</title>
178
179 <para>Examples of values to set <envar>MDEVICE</envar>,
180 <envar>PROTOCOL</envar>, and <envar>GPMOPTS</envar> to are:</para>
181
182<screen><literal>MDEVICE="/dev/psaux"
183PROTOCOL="imps2"
184GPMOPTS=""</literal></screen>
185
186 <para>A list of which protocol values are known can be found by running
187 <command>gpm -m <replaceable>[device]</replaceable> -t -help</command>.
188 The <envar>MDEVICE</envar> setting depends on which type of mouse you
189 have. For example, <filename>/dev/ttyS0</filename> for a serial mouse
190 (on Windows this is COM1), <filename>/dev/input/mice</filename> is often
191 used for USB mice and <filename>/dev/psaux</filename> for PS2 mice.
192 <envar>GPMOPTS</envar> is the 'catch all' for any additional options that
193 are needed for your hardware.</para>
194
195 </sect3>
196
197 </sect2>
198
199 <sect2 role="content">
200 <title>Contents</title>
201
202 <segmentedlist>
203 <segtitle>Installed Programs</segtitle>
204 <segtitle>Installed Libraries</segtitle>
205 <segtitle>Installed Directories</segtitle>
206
207 <seglistitem>
208 <seg>disable-paste, gpm, gpm-root, hltest, mev, and mouse-test</seg>
209 <seg>libgpm.{so.a}</seg>
210 <seg>None</seg>
211 </seglistitem>
212 </segmentedlist>
213
214 <variablelist>
215 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
216 <?dbfo list-presentation="list"?>
217 <?dbhtml list-presentation="table"?>
218
219 <varlistentry id="disable-paste">
220 <term><command>disable-paste</command></term>
221 <listitem>
222 <para>is a security mechanism used to disable the paste buffer.</para>
223 <indexterm zone="gpm disable-paste">
224 <primary sortas="b-disable-paste">disable-paste</primary>
225 </indexterm>
226 </listitem>
227 </varlistentry>
228
229 <varlistentry id="gpm-prog">
230 <term><command>gpm</command></term>
231 <listitem>
232 <para>is a cut and paste utility and mouse server for virtual consoles.</para>
233 <indexterm zone="gpm gpm-prog">
234 <primary sortas="b-gpm">gpm</primary>
235 </indexterm>
236 </listitem>
237 </varlistentry>
238
239 <varlistentry id="gpm-root">
240 <term><command>gpm-root</command></term>
241 <listitem>
242 <para>is a default handler for <command>gpm</command>. It is used to
243 draw menus on the root window.</para>
244 <indexterm zone="gpm gpm-root">
245 <primary sortas="b-gpm-root">gpm-root</primary>
246 </indexterm>
247 </listitem>
248 </varlistentry>
249
250 <varlistentry id="hltest">
251 <term><command>hltest</command></term>
252 <listitem>
253 <para>is a simple sample application using the high-level library,
254 meant to be read by programmers trying to use the high-level library.</para>
255 <indexterm zone="gpm hltest">
256 <primary sortas="b-hltest">hltest</primary>
257 </indexterm>
258 </listitem>
259 </varlistentry>
260
261 <varlistentry id="mev">
262 <term><command>mev</command></term>
263 <listitem>
264 <para>is a program to report mouse events.</para>
265 <indexterm zone="gpm mev">
266 <primary sortas="b-mev">mev</primary>
267 </indexterm>
268 </listitem>
269 </varlistentry>
270
271 <varlistentry id="mouse-test">
272 <term><command>mouse-test</command></term>
273 <listitem>
274 <para>is a tool for determining the mouse type and device it's
275 attached to.</para>
276 <indexterm zone="gpm mouse-test">
277 <primary sortas="b-mouse-test">mouse-test</primary>
278 </indexterm>
279 </listitem>
280 </varlistentry>
281
282 <varlistentry id="libgpm">
283 <term><filename class='libraryfile'>libgpm.{so.a}</filename></term>
284 <listitem>
285 <para>contains the API functions to access the
286 <application>GPM</application> daemon.</para>
287 <indexterm zone="gpm libgpm">
288 <primary sortas="c-libgpm">libgpm.{so,a}</primary>
289 </indexterm>
290 </listitem>
291 </varlistentry>
292
293 </variablelist>
294
295 </sect2>
296
297</sect1>
Note: See TracBrowser for help on using the repository browser.