source: general/sysutils/gpm.xml@ 02912d44

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
   "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

<!ENTITY gpm-download-http " ">
<!ENTITY gpm-download-ftp "ftp://arcana.linux.it/pub/gpm/gpm-&gpm-version;.tar.bz2">
<!ENTITY gpm-size "556 KB">
<!ENTITY gpm-buildsize "6.7 MB">
<!ENTITY gpm-time "0.09 SBU">

]>

<sect1 id="gpm" xreflabel="GPM-&gpm-version;">
<?dbhtml filename="gpm.html"?>
<title><acronym>GPM</acronym>-&gpm-version;</title>

<sect2>
<title>Introduction to <application><acronym>GPM</acronym></application></title>

<para>The <application><acronym>GPM</acronym></application> (General
Purpose Mouse daemon) package contains a mouse server for the console
and <command>xterm</command>. It not only provides cut and paste support
generally, but its library component is used by various software such as
<application>Links</application> to provide mouse support to the
application. It is useful on desktops, especially if following
(Beyond) Linux From Scratch instructions; it's often much easier (and
less error prone) to cut and paste between two console windows than to
type everything by hand!</para>

<sect3><title>Package information</title>
<itemizedlist spacing='compact'>
<listitem><para>Download (HTTP): <ulink
url="&gpm-download-http;"/></para></listitem>
<listitem><para>Download (FTP): <ulink
url="&gpm-download-ftp;"/></para></listitem>
<listitem><para>Download size: &gpm-size;</para></listitem>
<listitem><para>Estimated Disk space required:
&gpm-buildsize;</para></listitem>
<listitem><para>Estimated build time:
&gpm-time;</para></listitem></itemizedlist>
</sect3>

<sect3><title>Additional downloads</title>
<itemizedlist spacing='compact'>
<listitem><para>Recommended Patch: <ulink
url="&patch-root;/gpm-&gpm-version;-segfault-1.patch"/></para></listitem>
<listitem><para>Recommended Patch: <ulink
url="&patch-root;/gpm-&gpm-version;-silent-1.patch"/></para></listitem>
</itemizedlist>
</sect3>

</sect2>

<sect2>
<title>Installation of <application><acronym>GPM</acronym></application></title>

<para>Install <application><acronym>GPM</acronym></application> by running 
the following commands:
</para>

<screen><userinput><command>patch -Np1 -i ../gpm-&gpm-version;-segfault-1.patch &amp;&amp;
patch -Np1 -i ../gpm-&gpm-version;-silent-1.patch &amp;&amp;
LDFLAGS="-lm" ./configure --prefix=/usr --sysconfdir=/etc &amp;&amp;
make &amp;&amp;
make install &amp;&amp;
cp conf/gpm-root.conf /etc &amp;&amp;
ldconfig</command></userinput></screen>
</sect2>

<sect2>
<title>Command explanations</title>

<para><command>LDFLAGS="-lm"</command>: The math library 
must be linked with <command>gpm</command>, as ceil() is used in some cursor
scrolling logic.</para>

<!-- <para><command>ldconfig -n -l </command>: During installation, gpm outputs a
message to run the above command to create the proper library links.</para> -->

</sect2>

<sect2>
<title>Configuring <application><acronym>GPM</acronym></application></title>

<sect3><title>gpm init.d script</title>
<para>Install the <filename>/etc/rc.d/init.d/gpm</filename>
init script included in the
<xref linkend="intro-important-bootscripts"/> package.</para>

<screen><userinput><command>make install-gpm</command></userinput></screen>

</sect3>

<sect3><title>Config files</title>

<para><filename>/etc/gpm-root.conf</filename> and 
<filename>~/.gpm-root</filename>: The default and individual user 
<command>gpm-root</command> configuration files.</para>

<para><filename>/etc/sysconfig/mouse</filename>: 
This file contains the name of your mouse device and the protocol which
it uses.  To create this file, run the following:</para>

<screen><userinput><command>cat &gt; /etc/sysconfig/mouse &lt;&lt; "EOF"</command>
# Begin /etc/sysconfig/mouse

MDEVICE="<replaceable>[yourdevice]</replaceable>"
PROTOCOL="<replaceable>[yourprotocol]</replaceable>"
GPMOPTS="<replaceable>[additional options]</replaceable>"

# End /etc/sysconfig/mouse
<command>EOF</command></userinput></screen>
</sect3>

<sect3><title>Configuration Information</title>

<para>Examples of values to set <envar>MDEVICE</envar>,
<envar>PROTOCOL</envar>, and <envar>GPMOPTS</envar> to are:</para>

<screen><userinput>MDEVICE="/dev/psaux"
PROTOCOL="imps2"
GPMOPTS=""</userinput></screen>

<para>A list of which protocol values are known can be found by running
<command>gpm -t -help</command>.  The <envar>MDEVICE</envar> setting 
depends on which type of mouse you have.  For example,
<filename>/dev/ttyS0</filename> for a serial mouse (on Windows this is
COM1), <filename>/dev/input/mice</filename> is often used for
<acronym>USB</acronym> mice and <filename>/dev/psaux</filename> for PS2 
mice.  <envar>GPMOPTS</envar> is the 'catch all' for any 
additional options that are needed for your hardware.</para>

</sect3>

</sect2>

<sect2>
<title>Contents</title>

<para>The <application><acronym>GPM</acronym></application> package contains
<command>gpm</command>, <command>gpm-root</command>, 
<command>disable-paste</command>, <command>mev</command>, 
<command>mouse-test</command> and <command>hltest</command>.</para>

</sect2>

<sect2><title>Description</title>

<sect3><title>gpm</title>
<para><command>gpm</command> is a cut and paste utility and mouse server for
virtual consoles.</para></sect3>

<sect3><title>gpm-root</title>
<para><command>gpm-root</command> is a default handler for
<command>gpm</command>.  It is used to draw menus on the
root window.</para></sect3>

<sect3><title>disable-paste</title>
<para><command>disable-paste</command> is a security mechanism used to disable 
the paste buffer.</para></sect3>

<sect3><title>mev</title>
<para><command>mev</command> is a program to report mouse events.</para></sect3>

<sect3><title>mouse-test</title>
<para><command>mouse-test</command> is a tool for determining the mouse type 
and device it's attached to.</para></sect3>

<sect3><title>hltest</title>
<para><command>hltest</command> is a simple sample application using the 
high-level library, meant to be read by programmers trying to use the
high-level library.</para></sect3>

</sect2>

</sect1>