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