source: general/sysutils/gpm.xml@ 84cbff3

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 84cbff3 was 84cbff3, checked in by Pierre Labastie <pieere@…>, 5 years ago

My first set of tags for LFS-7.10

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

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