[52d29f7] | 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">
|
---|
[34f86ab] | 10 | <!ENTITY gpm-buildsize "6.7 MB">
|
---|
[52d29f7] | 11 | <!ENTITY gpm-time "0.09 SBU">
|
---|
| 12 |
|
---|
| 13 | ]>
|
---|
| 14 |
|
---|
[de8804e] | 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>
|
---|
[f45b1953] | 22 |
|
---|
[52d29f7] | 23 | <sect2>
|
---|
| 24 | <title>Introduction to <application><acronym>GPM</acronym></application></title>
|
---|
[014d11ad] | 25 |
|
---|
[52d29f7] | 26 | <para>The <application><acronym>GPM</acronym></application> (General
|
---|
| 27 | Purpose Mouse daemon) package contains a mouse server for the console
|
---|
| 28 | and <command>xterm</command>. It not only provides cut and paste support
|
---|
| 29 | generally, but its library component is used by various software such as
|
---|
| 30 | <application>Links</application> to provide mouse support to the
|
---|
| 31 | application. It is useful on desktops, especially if following
|
---|
| 32 | (Beyond) Linux From Scratch instructions; it's often much easier (and
|
---|
| 33 | less error prone) to cut and paste between two console windows than to
|
---|
| 34 | type everything by hand!</para>
|
---|
[014d11ad] | 35 |
|
---|
[52d29f7] | 36 | <sect3><title>Package information</title>
|
---|
| 37 | <itemizedlist spacing='compact'>
|
---|
| 38 | <listitem><para>Download (HTTP): <ulink
|
---|
| 39 | url="&gpm-download-http;"/></para></listitem>
|
---|
| 40 | <listitem><para>Download (FTP): <ulink
|
---|
| 41 | url="&gpm-download-ftp;"/></para></listitem>
|
---|
| 42 | <listitem><para>Download size: &gpm-size;</para></listitem>
|
---|
| 43 | <listitem><para>Estimated Disk space required:
|
---|
| 44 | &gpm-buildsize;</para></listitem>
|
---|
| 45 | <listitem><para>Estimated build time:
|
---|
| 46 | &gpm-time;</para></listitem></itemizedlist>
|
---|
| 47 | </sect3>
|
---|
[014d11ad] | 48 |
|
---|
[52d29f7] | 49 | <sect3><title>Additional downloads</title>
|
---|
| 50 | <itemizedlist spacing='compact'>
|
---|
[07b157f4] | 51 | <listitem><para>Recommended Patch: <ulink
|
---|
[4f6275fd] | 52 | url="&patch-root;/gpm-&gpm-version;-segfault-1.patch"/></para></listitem>
|
---|
[07b157f4] | 53 | <listitem><para>Recommended Patch: <ulink
|
---|
[4f6275fd] | 54 | url="&patch-root;/gpm-&gpm-version;-silent-1.patch"/></para></listitem>
|
---|
[52d29f7] | 55 | </itemizedlist>
|
---|
| 56 | </sect3>
|
---|
[014d11ad] | 57 |
|
---|
[52d29f7] | 58 | </sect2>
|
---|
| 59 |
|
---|
| 60 | <sect2>
|
---|
| 61 | <title>Installation of <application><acronym>GPM</acronym></application></title>
|
---|
[014d11ad] | 62 |
|
---|
| 63 | <para>Install <application><acronym>GPM</acronym></application> by running
|
---|
| 64 | the following commands:
|
---|
[52d29f7] | 65 | </para>
|
---|
[014d11ad] | 66 |
|
---|
[4f6275fd] | 67 | <screen><userinput><command>patch -Np1 -i ../gpm-&gpm-version;-segfault-1.patch &&
|
---|
| 68 | patch -Np1 -i ../gpm-&gpm-version;-silent-1.patch &&
|
---|
[52d29f7] | 69 | LDFLAGS="-lm" ./configure --prefix=/usr --sysconfdir=/etc &&
|
---|
| 70 | make &&
|
---|
| 71 | make install &&
|
---|
[3eb080ce] | 72 | cp conf/gpm-root.conf /etc &&
|
---|
| 73 | ldconfig</command></userinput></screen>
|
---|
[52d29f7] | 74 | </sect2>
|
---|
| 75 |
|
---|
| 76 | <sect2>
|
---|
| 77 | <title>Command explanations</title>
|
---|
[014d11ad] | 78 |
|
---|
| 79 | <para><command>LDFLAGS="-lm"</command>: The math library
|
---|
| 80 | must be linked with <command>gpm</command>, as ceil() is used in some cursor
|
---|
[52d29f7] | 81 | scrolling logic.</para>
|
---|
[014d11ad] | 82 |
|
---|
[34f86ab] | 83 | <!-- <para><command>ldconfig -n -l </command>: During installation, gpm outputs a
|
---|
| 84 | message to run the above command to create the proper library links.</para> -->
|
---|
[014d11ad] | 85 |
|
---|
[52d29f7] | 86 | </sect2>
|
---|
| 87 |
|
---|
| 88 | <sect2>
|
---|
| 89 | <title>Configuring <application><acronym>GPM</acronym></application></title>
|
---|
[014d11ad] | 90 |
|
---|
[52d29f7] | 91 | <sect3><title>gpm init.d script</title>
|
---|
| 92 | <para>Install the <filename>/etc/rc.d/init.d/gpm</filename>
|
---|
| 93 | init script included in the
|
---|
| 94 | <xref linkend="intro-important-bootscripts"/> package.</para>
|
---|
[014d11ad] | 95 |
|
---|
[52d29f7] | 96 | <screen><userinput><command>make install-gpm</command></userinput></screen>
|
---|
[014d11ad] | 97 |
|
---|
[52d29f7] | 98 | </sect3>
|
---|
[014d11ad] | 99 |
|
---|
[52d29f7] | 100 | <sect3><title>Config files</title>
|
---|
[34f86ab] | 101 |
|
---|
| 102 | <para><filename>/etc/gpm-root.conf</filename> and
|
---|
| 103 | <filename>~/.gpm-root</filename>: The default and individual user
|
---|
| 104 | <command>gpm-root</command> configuration files.</para>
|
---|
| 105 |
|
---|
| 106 | <para><filename>/etc/sysconfig/mouse</filename>:
|
---|
[52d29f7] | 107 | This file contains the name of your mouse device and the protocol which
|
---|
| 108 | it uses. To create this file, run the following:</para>
|
---|
[014d11ad] | 109 |
|
---|
[52d29f7] | 110 | <screen><userinput><command>cat > /etc/sysconfig/mouse << "EOF"</command>
|
---|
| 111 | # Begin /etc/sysconfig/mouse
|
---|
[014d11ad] | 112 |
|
---|
[004a8284] | 113 | MDEVICE="<replaceable>[yourdevice]</replaceable>"
|
---|
| 114 | PROTOCOL="<replaceable>[yourprotocol]</replaceable>"
|
---|
| 115 | GPMOPTS="<replaceable>[additional options]</replaceable>"
|
---|
[014d11ad] | 116 |
|
---|
[52d29f7] | 117 | # End /etc/sysconfig/mouse
|
---|
| 118 | <command>EOF</command></userinput></screen>
|
---|
| 119 | </sect3>
|
---|
[014d11ad] | 120 |
|
---|
[52d29f7] | 121 | <sect3><title>Configuration Information</title>
|
---|
[014d11ad] | 122 |
|
---|
[004a8284] | 123 | <para>Examples of values to set <envar>MDEVICE</envar>,
|
---|
| 124 | <envar>PROTOCOL</envar>, and <envar>GPMOPTS</envar> to are:</para>
|
---|
[014d11ad] | 125 |
|
---|
[004a8284] | 126 | <screen><userinput>MDEVICE="/dev/psaux"
|
---|
| 127 | PROTOCOL="imps2"
|
---|
| 128 | GPMOPTS=""</userinput></screen>
|
---|
[014d11ad] | 129 |
|
---|
[52d29f7] | 130 | <para>A list of which protocol values are known can be found by running
|
---|
[004a8284] | 131 | <command>gpm -t -help</command>. The <envar>MDEVICE</envar> setting
|
---|
| 132 | depends on which type of mouse you have. For example,
|
---|
[52d29f7] | 133 | <filename>/dev/ttyS0</filename> for a serial mouse (on Windows this is
|
---|
| 134 | COM1), <filename>/dev/input/mice</filename> is often used for
|
---|
[004a8284] | 135 | <acronym>USB</acronym> mice and <filename>/dev/psaux</filename> for PS2
|
---|
| 136 | mice. <envar>GPMOPTS</envar> is the 'catch all' for any
|
---|
| 137 | additional options that are needed for your hardware.</para>
|
---|
[014d11ad] | 138 |
|
---|
[52d29f7] | 139 | </sect3>
|
---|
[014d11ad] | 140 |
|
---|
[52d29f7] | 141 | </sect2>
|
---|
| 142 |
|
---|
| 143 | <sect2>
|
---|
| 144 | <title>Contents</title>
|
---|
[014d11ad] | 145 |
|
---|
[52d29f7] | 146 | <para>The <application><acronym>GPM</acronym></application> package contains
|
---|
[014d11ad] | 147 | <command>gpm</command>, <command>gpm-root</command>,
|
---|
[34f86ab] | 148 | <command>disable-paste</command>, <command>mev</command>,
|
---|
| 149 | <command>mouse-test</command> and <command>hltest</command>.</para>
|
---|
[014d11ad] | 150 |
|
---|
[52d29f7] | 151 | </sect2>
|
---|
[014d11ad] | 152 |
|
---|
[52d29f7] | 153 | <sect2><title>Description</title>
|
---|
[014d11ad] | 154 |
|
---|
[52d29f7] | 155 | <sect3><title>gpm</title>
|
---|
| 156 | <para><command>gpm</command> is a cut and paste utility and mouse server for
|
---|
| 157 | virtual consoles.</para></sect3>
|
---|
[014d11ad] | 158 |
|
---|
[52d29f7] | 159 | <sect3><title>gpm-root</title>
|
---|
| 160 | <para><command>gpm-root</command> is a default handler for
|
---|
| 161 | <command>gpm</command>. It is used to draw menus on the
|
---|
| 162 | root window.</para></sect3>
|
---|
[014d11ad] | 163 |
|
---|
[52d29f7] | 164 | <sect3><title>disable-paste</title>
|
---|
[34f86ab] | 165 | <para><command>disable-paste</command> is a security mechanism used to disable
|
---|
| 166 | the paste buffer.</para></sect3>
|
---|
[014d11ad] | 167 |
|
---|
[52d29f7] | 168 | <sect3><title>mev</title>
|
---|
| 169 | <para><command>mev</command> is a program to report mouse events.</para></sect3>
|
---|
[014d11ad] | 170 |
|
---|
[34f86ab] | 171 | <sect3><title>mouse-test</title>
|
---|
| 172 | <para><command>mouse-test</command> is a tool for determining the mouse type
|
---|
| 173 | and device it's attached to.</para></sect3>
|
---|
| 174 |
|
---|
| 175 | <sect3><title>hltest</title>
|
---|
| 176 | <para><command>hltest</command> is a simple sample application using the
|
---|
| 177 | high-level library, meant to be read by programmers trying to use the
|
---|
| 178 | high-level library.</para></sect3>
|
---|
| 179 |
|
---|
[52d29f7] | 180 | </sect2>
|
---|
[f45b1953] | 181 |
|
---|
| 182 | </sect1>
|
---|