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