source: general/sysutils/gpm.xml@ 5c9e998

10.0 10.1 11.0 7.10 8.0 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind ken/refactor-virt lazarus nosym perl-modules qt5new trunk xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since 5c9e998 was 5c9e998, checked in by DJ Lucas <dj@…>, 6 years ago

Merge D-Bus changes frome systemd branch, some temporary fixes for bootscript related render errors.

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

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