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