1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
|
---|
3 | "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
|
---|
4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
5 | %general-entities;
|
---|
6 |
|
---|
7 | <!ENTITY gpm-download-http " ">
|
---|
8 | <!ENTITY gpm-download-ftp "ftp://arcana.linux.it/pub/gpm/gpm-&gpm-version;.tar.bz2">
|
---|
9 | <!ENTITY gpm-size "556 KB">
|
---|
10 | <!ENTITY gpm-buildsize "6.7 MB">
|
---|
11 | <!ENTITY gpm-time "0.09 SBU">
|
---|
12 | ]>
|
---|
13 |
|
---|
14 | <sect1 id="gpm-package" xreflabel="GPM-&gpm-version;">
|
---|
15 | <sect1info>
|
---|
16 | <othername>$LastChangedBy$</othername>
|
---|
17 | <date>$Date$</date>
|
---|
18 | </sect1info>
|
---|
19 | <?dbhtml filename="gpm.html"?>
|
---|
20 | <title><acronym>GPM</acronym>-&gpm-version;</title>
|
---|
21 | <indexterm zone="gpm-package">
|
---|
22 | <primary sortas="a-GPM-package">GPM</primary></indexterm>
|
---|
23 |
|
---|
24 | <sect2>
|
---|
25 | <title>Introduction to <application><acronym>GPM</acronym></application></title>
|
---|
26 |
|
---|
27 | <para>The <application><acronym>GPM</acronym></application> (General
|
---|
28 | Purpose Mouse daemon) package contains a mouse server for the console
|
---|
29 | and <command>xterm</command>. It not only provides cut and paste support
|
---|
30 | generally, but its library component is used by various software such as
|
---|
31 | <application>Links</application> to provide mouse support to the
|
---|
32 | application. It is useful on desktops, especially if following
|
---|
33 | (Beyond) Linux From Scratch instructions; it's often much easier (and
|
---|
34 | less error prone) to cut and paste between two console windows than to
|
---|
35 | type everything by hand!</para>
|
---|
36 |
|
---|
37 | <sect3><title>Package information</title>
|
---|
38 | <itemizedlist spacing='compact'>
|
---|
39 | <listitem><para>Download (HTTP): <ulink
|
---|
40 | url="&gpm-download-http;"/></para></listitem>
|
---|
41 | <listitem><para>Download (FTP): <ulink
|
---|
42 | url="&gpm-download-ftp;"/></para></listitem>
|
---|
43 | <listitem><para>Download size: &gpm-size;</para></listitem>
|
---|
44 | <listitem><para>Estimated disk space required:
|
---|
45 | &gpm-buildsize;</para></listitem>
|
---|
46 | <listitem><para>Estimated build time:
|
---|
47 | &gpm-time;</para></listitem></itemizedlist>
|
---|
48 | </sect3>
|
---|
49 |
|
---|
50 | <sect3><title>Additional downloads</title>
|
---|
51 | <itemizedlist spacing='compact'>
|
---|
52 | <listitem><para>Recommended Patch: <ulink
|
---|
53 | url="&patch-root;/gpm-&gpm-version;-segfault-1.patch"/></para></listitem>
|
---|
54 | <listitem><para>Recommended Patch: <ulink
|
---|
55 | url="&patch-root;/gpm-&gpm-version;-silent-1.patch"/></para></listitem>
|
---|
56 | </itemizedlist>
|
---|
57 | </sect3>
|
---|
58 |
|
---|
59 | </sect2>
|
---|
60 |
|
---|
61 | <sect2>
|
---|
62 | <title>Installation of <application><acronym>GPM</acronym></application></title>
|
---|
63 |
|
---|
64 | <para>Install <application><acronym>GPM</acronym></application> by running
|
---|
65 | the following commands:
|
---|
66 | </para>
|
---|
67 |
|
---|
68 | <screen><userinput><command>patch -Np1 -i ../gpm-&gpm-version;-segfault-1.patch &&
|
---|
69 | patch -Np1 -i ../gpm-&gpm-version;-silent-1.patch &&
|
---|
70 | LDFLAGS="-lm" ./configure --prefix=/usr --sysconfdir=/etc &&
|
---|
71 | make &&
|
---|
72 | make install &&
|
---|
73 | cp conf/gpm-root.conf /etc &&
|
---|
74 | ldconfig</command></userinput></screen>
|
---|
75 | </sect2>
|
---|
76 |
|
---|
77 | <sect2>
|
---|
78 | <title>Command explanations</title>
|
---|
79 |
|
---|
80 | <para><command>LDFLAGS="-lm"</command>: The math library
|
---|
81 | must be linked with <command>gpm</command>, as ceil() is used in some cursor
|
---|
82 | scrolling logic.</para>
|
---|
83 |
|
---|
84 | <!-- <para><command>ldconfig -n -l </command>: During installation, gpm outputs a
|
---|
85 | message to run the above command to create the proper library links.</para> -->
|
---|
86 |
|
---|
87 | </sect2>
|
---|
88 |
|
---|
89 | <sect2>
|
---|
90 | <title>Configuring <application><acronym>GPM</acronym></application></title>
|
---|
91 |
|
---|
92 | <sect3 id="gpm-init"><title>gpm init.d script</title>
|
---|
93 | <indexterm zone="gpm-package gpm-init">
|
---|
94 | <primary sortas="f-gpm-init">gpm</primary></indexterm>
|
---|
95 |
|
---|
96 | <para>Install the <filename>/etc/rc.d/init.d/gpm</filename>
|
---|
97 | init script included in the
|
---|
98 | <xref linkend="intro-important-bootscripts"/> package.</para>
|
---|
99 |
|
---|
100 | <screen><userinput><command>make install-gpm</command></userinput></screen>
|
---|
101 | </sect3>
|
---|
102 |
|
---|
103 | <sect3 id="gpm-config"><title>Config files</title>
|
---|
104 |
|
---|
105 | <para><filename>/etc/gpm-root.conf</filename> and
|
---|
106 | <filename>~/.gpm-root</filename>: The default and individual user
|
---|
107 | <command>gpm-root</command> configuration files.</para>
|
---|
108 |
|
---|
109 | <para><filename>/etc/sysconfig/mouse</filename>:
|
---|
110 | This file contains the name of your mouse device and the protocol which
|
---|
111 | it uses. To create this file, run the following:</para>
|
---|
112 |
|
---|
113 | <screen><userinput><command>cat > /etc/sysconfig/mouse << "EOF"</command>
|
---|
114 | # Begin /etc/sysconfig/mouse
|
---|
115 |
|
---|
116 | MDEVICE="<replaceable>[yourdevice]</replaceable>"
|
---|
117 | PROTOCOL="<replaceable>[yourprotocol]</replaceable>"
|
---|
118 | GPMOPTS="<replaceable>[additional options]</replaceable>"
|
---|
119 |
|
---|
120 | # End /etc/sysconfig/mouse
|
---|
121 | <command>EOF</command></userinput></screen>
|
---|
122 |
|
---|
123 | <indexterm zone="gpm-package gpm-config">
|
---|
124 | <primary sortas="e-AA.gpm-root">~/.gpm-root</primary></indexterm>
|
---|
125 | <indexterm zone="gpm-package gpm-config">
|
---|
126 | <primary sortas="e-etc-gpm-root.conf">/etc/gpm-root.conf</primary></indexterm>
|
---|
127 | <indexterm zone="gpm-package gpm-config">
|
---|
128 | <primary sortas="e-etc-sysconfig-mouse">/etc/sysconfig/mouse</primary>
|
---|
129 | </indexterm>
|
---|
130 | </sect3>
|
---|
131 |
|
---|
132 | <sect3><title>Configuration Information</title>
|
---|
133 |
|
---|
134 | <para>Examples of values to set <envar>MDEVICE</envar>,
|
---|
135 | <envar>PROTOCOL</envar>, and <envar>GPMOPTS</envar> to are:</para>
|
---|
136 |
|
---|
137 | <screen><userinput>MDEVICE="/dev/psaux"
|
---|
138 | PROTOCOL="imps2"
|
---|
139 | GPMOPTS=""</userinput></screen>
|
---|
140 |
|
---|
141 | <para>A list of which protocol values are known can be found by running
|
---|
142 | <command>gpm -t -help</command>. The <envar>MDEVICE</envar> setting
|
---|
143 | depends on which type of mouse you have. For example,
|
---|
144 | <filename>/dev/ttyS0</filename> for a serial mouse (on Windows this is
|
---|
145 | COM1), <filename>/dev/input/mice</filename> is often used for
|
---|
146 | <acronym>USB</acronym> mice and <filename>/dev/psaux</filename> for PS2
|
---|
147 | mice. <envar>GPMOPTS</envar> is the 'catch all' for any
|
---|
148 | additional options that are needed for your hardware.</para>
|
---|
149 | </sect3>
|
---|
150 |
|
---|
151 | </sect2>
|
---|
152 |
|
---|
153 | <sect2>
|
---|
154 | <title>Contents</title>
|
---|
155 |
|
---|
156 | <segmentedlist>
|
---|
157 | <segtitle>Installed Programs</segtitle>
|
---|
158 | <seglistitem>
|
---|
159 | <seg>disable-paste, gpm, gpm-root, hltest, mev and mouse-test</seg>
|
---|
160 | </seglistitem>
|
---|
161 | </segmentedlist>
|
---|
162 |
|
---|
163 | <variablelist>
|
---|
164 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
165 | <?dbfo list-presentation="list"?>
|
---|
166 |
|
---|
167 | <varlistentry id="disable-paste">
|
---|
168 | <term><command>disable-paste</command></term>
|
---|
169 | <listitem><para>is a security mechanism used to disable the paste buffer.</para>
|
---|
170 | <indexterm zone="gpm-package disable-paste">
|
---|
171 | <primary sortas="b-disable-paste">disable-paste</primary></indexterm>
|
---|
172 | </listitem>
|
---|
173 | </varlistentry>
|
---|
174 |
|
---|
175 | <varlistentry id="gpm">
|
---|
176 | <term><command>gpm</command></term>
|
---|
177 | <listitem><para>is a cut and paste utility and mouse server for virtual
|
---|
178 | consoles.</para>
|
---|
179 | <indexterm zone="gpm-package gpm">
|
---|
180 | <primary sortas="b-gpm">gpm</primary></indexterm>
|
---|
181 | </listitem>
|
---|
182 | </varlistentry>
|
---|
183 |
|
---|
184 | <varlistentry id="gpm-root">
|
---|
185 | <term><command>gpm-root</command></term>
|
---|
186 | <listitem><para>is a default handler for <command>gpm</command>. It is used to
|
---|
187 | draw menus on the root window.</para>
|
---|
188 | <indexterm zone="gpm-package gpm-root">
|
---|
189 | <primary sortas="b-gpm-root">gpm-root</primary></indexterm>
|
---|
190 | </listitem>
|
---|
191 | </varlistentry>
|
---|
192 |
|
---|
193 | <varlistentry id="hltest">
|
---|
194 | <term><command>hltest</command></term>
|
---|
195 | <listitem><para>is a simple sample application using the high-level library,
|
---|
196 | meant to be read by programmers trying to use the high-level library.</para>
|
---|
197 | <indexterm zone="gpm-package hltest">
|
---|
198 | <primary sortas="b-hltest">hltest</primary></indexterm>
|
---|
199 | </listitem>
|
---|
200 | </varlistentry>
|
---|
201 |
|
---|
202 | <varlistentry id="mev">
|
---|
203 | <term><command>mev</command></term>
|
---|
204 | <listitem><para>is a program to report mouse events.</para>
|
---|
205 | <indexterm zone="gpm-package mev">
|
---|
206 | <primary sortas="b-mev">mev</primary></indexterm>
|
---|
207 | </listitem>
|
---|
208 | </varlistentry>
|
---|
209 |
|
---|
210 | <varlistentry id="mouse-test">
|
---|
211 | <term><command>mouse-test</command></term>
|
---|
212 | <listitem><para>is a tool for determining the mouse type and device it's
|
---|
213 | attached to.</para>
|
---|
214 | <indexterm zone="gpm-package mouse-test">
|
---|
215 | <primary sortas="b-mouse-test">mouse-test</primary></indexterm>
|
---|
216 | </listitem>
|
---|
217 | </varlistentry>
|
---|
218 | </variablelist>
|
---|
219 |
|
---|
220 | </sect2>
|
---|
221 |
|
---|
222 | </sect1>
|
---|