======================================================================== * README ======================================================================== /* * README -- gpm 1.xx * * Copyright 1995-2000 rubini@linux.it (Alessandro Rubini) * Copyright 2001-2012 nico-gpm at schottelius.org (Nico Schottelius) * *******/ The gpm (general purpose mouse) daemon tries to be a useful mouse server for applications running on the Linux console. Its roots are in the "selection" package, by Andrew Haylett, and the original code comes from selection itself. This package is intended as a replacement for "selection", to provide additional facilities. From 0.18 onward gpm supports xterm as well, so you can run mouse-sensitive applications under X, and you can easily write curses applications which support the mouse on both the Linux console and xterm. The xterm code is portable to any U*x flavour (look at sample/README). The first clients have been "The Midnight Commander", by Miguel de Icaza and an emacs library included in this release. Recent dialog distributions and the Jed editor use gpm as well, and the same do several custom applications. If you want to make a patch to gpm, please read doc/HACK_GPM. For additionally documentation and other READMEs have a look into doc/. =========== MAINTENANCE As of 1.19.4, gpm is officially maintained again. Most of the README is written by Alessandro Rubine, only minor changes are made by Nico Schottelius. =========== MAILING LIST The mailing list devoted to gpm is "gpm@lists.linux.it" The list is managed by Mailman and is currently open, so non-subscribers are allowed to post. In order to subscribe to the mailing list, visit http://lists.linux.it/listinfo/gpm or send a message with "subscribe" in its body to gpm-request@lists.linux.it. For example: echo subscribe | mail gpm-request@lists.linux.it =========== DOWNLOAD / HOMEPAGE The latest releases can always be found in one of the following place: http://www.nico.schottelius.org/software/gpm/archives/ Mirror: ftp://arcana.linux.it/pub/gpm/ http://www.ar.linux.it/pub/gpm/ The homepage of gpm can be found at http://www.nico.schottelius.org/software/gpm/ You can get the latest development tree of gpm via git: git-clone git://git.schottelius.org/gpm There are three branches available: master: Contains the latest gpm1 code, may be broken. gpm-1-stable: Contains the latest stable source code. gpm-2-dev: Contains work that heads to gpm2. =========== COMPILING AND INSTALLING The package uses autoconf as of 2.12. Use "./autogen.sh && ./configure && make" to compile the gpm suite. To install "make install". This installs everything under the "prefix" directory, which by default is /usr/local. Use "./configure --prefix=/usr" if you want to install under /usr instead of /usr/local. Exectuable files are installed in $(prefix)/bin (except the gpm daemon in $(prefix)/sbin), libraries in $(prefix)/lib, man pages in $(prefix)/man, the lisp library in the proper location for emacs-list files (detected during the "configure" step); info files are installed under $(prefix)/info. If you would like to 'clean'up very tidy, use distclean. Don't forget to use make distclean config! Otherwise there will be no configure script! =========== CONFIGURING Configuration is optional... * You would like to tell emacs to use t-mouse.el when appropriate. Add the following lines to your own .emacs (in your home directory), or in the /usr/lib/emacs/site-lisp/default (if (and (string-match ".*-linux" system-configuration) (not window-system) (or (string-match "linux" (getenv "TERM")) (string-match "con.*" (getenv "TERM")))) (load-library "t-mouse")) * If you want to use gpm-root, copy gpm-root.conf to your /usr/etc directory, test it out and then edit it to suit your feels. * You'd like to name the gpm info file inside /usr/info/dir. Just insert the line * gpm: (gpm.info). A mouse server for the Linux console at the proper place. Note that this is usually automatically performed if you install a package prepared for your own distribution. * To invoke gpm (and gpm-root) at system boot, add something like this to your /etc/rc.d/rc.local /usr/sbin/gpm -t msc -m /dev/tts/0 & /usr/bin/gpm-root & If you are running the new setup of SysVinit, you should better add a "gpm" script in /etc/rc.d/rc.init and install it in your runlevels in the usual way (this is usually included in your distribution as well) You may want to put the mouse server at a higher priority: in this case invoke instead "/usr/bin/nice -n -20 /usr/sbin/gpm -t msc" The program goes to the background by itself, unless it is run with debuging enabled (see the -D option in the documentation). ========== DOCS The directory "./doc" holds the documentation. The release embeds a postscript file, slightly reduced to save paper (doc/gpm2.ps), an info one (doc/gpm.info) and a text-only version (doc/gpmdoc.txt -- but without table of contents, for now). Man pages are automatically extracted from the info file, and are installed with "make install" =========== BUG REPORTS Before sending bug reports, please look at the file "FAQ", which outlines some known problems, and how to deal with them. If your bug isn't fixed by reading there, please report it to me, without getting angry with me if things don't work at first trial (but they usually work). Bug reports are best sent to the gpm mailing list (see above) or to me via email, if you use personal mail please include the string "gpm" somewhere in the subject line. This will help my filters in sorting things out. * When compilation fails I need your kernel version ("uname -a"), the compiler version ("gcc -v") and the library version ("ls -l /lib" or, better "ldd /usr/sbin/gpm"). And the compiler messages, obviously. * When a program hangs or segfaults, please reinvoke the program under strace: strace -tf -o /tmp/trace.gpm gpm -t msc ^^^^^^^^^^ put your true cmdline here. Then send me /tmp/trace.gpm* (they may be one or two files, according to the strace version), and a description of how you reproduce the problem. The last resort is a core dump, but I'll ask it personally if I have real difficulties in tracing out your problem. =========== CREDITS The following people contributed to gpm, in chronological order. This list used to reside in a different file, but it's better for it to stand out in the README Andrew Haylett (ajh@gec-mrc.co.uk) donated "selection" to the linux community, so I could get the idea and the code. A few others contributed to selection, but I lost track of their contributions and names. Steven S. Dick (ssd@nevets.oau.org) fixed a pair of bugs in early gpm versions. Miguel de Icaza (miguel@roxanne.nuclecu.unam.mx) helped fixing some bugs and provided a good client to test my server. He helped a lot in testing the various pre-releases. Olav Woelfelschneider (wosch@rbg.informatik.th-darmstadt.de) fixed 0.10 with MouseSystems compatible mice. Janne Kukonlehto (jtklehto@stekt.oulu.fi) provided xterm mouse decoding to be stolen by me. Rick Lyons (rick@razorback.brisnet.org.au) fixed a bug in gpm-0.9. Reuben Sumner (rasumner@undergrad.math.uwaterloo.ca) helped fixing behaviour with "-t bm". Larry Bartholdi (lbartho@scsun.unige.ch) pinpointed an error in t-mouse-suspend and provided good suggestions for 0.97. Mark Lord (mlord@bnr.ca) ported to Dexxa/Logitech mice and gave feedback several times. Stefan Giessler (stg@gandalf.han.de) fixed some problems with gpm-root and suggested to put gpm in the background (0.97). Roman Shapiro helped with the Logitech MouseMan. Andries Brouwer (aeb@cwi.nl) Provided a Latin-1 LUT for chars, and enhanced lut-loading code (0.98). Adrian Johnson (ajohnson@apanix.apana.org.au) Gave good feedback and ideas for the 0.98's Stephen Lee (sl14@crux1.cit.cornell.edu) Helped a lot with the damned MouseMan protocol (0.98 and 1.0) John van Leeuwen (johnvl@einstein.et.tudelft.nl) Outlined and fixed a pair of bugs in gpm-root 0.98 Alvar Bray (alvar@meiko.co.uk) Pointed out an error with awk (0.99) David A. van Leeuwen (david@tm.tno.nl) Helped with chord-middle protocols (1.0) Pavel Kankovsky (KAN@frode.dcit.cz) Open /dev/ttyxx instead of /dev/console in the lib (1.01) Mark Shadley (shadcat@catcher.com) Helped in turning to ELF (1.01 and 1.02) and in fixing horrible bugs of mine. Without his help 1.03 wouldn't be there. Lou Sortman (lou@lounix4.conc.tdsnet.com) Added support for glidepoint mice within "-t mman". (1.05) Marc Meis (100334.1426@compuserve.com) Provided support for absolute pointing devices, and in particular for the ncr3125 pen. (1.05) Michael Plass (Michael_Plass.PARC@xerox.com) Fixed a damned bug in middle button decoding (M_ms) (1.07) Markus Gutschke (gutschk@uni-muenster.de) Provided a better re-encoding for "-R" (1.10) Karsten Ballueder (Karsten@piobelix.physik.uni-karlsruhe.de) Suggested the reboot compile-time option (1.10) John Davis (davis@space.mit.edu) Found and fixed a buglet in liblow.c for some jed users (1.10) Julian Thompson (jrt@miel.demon.co.uk) Fixed a buglet in gpm-root (1.10) Dave Flater (dave@universe.digex.net) Removed a typo in the disabled decoder for ms-3b (1.11) Thomas E. Dickey (dickey@clark.net) Ported to autoconf (1.11) Pavel Machek (pavel@ucw.cz) New mode "logim" (1.11) and NetMouse (1.14) Matthias Grimrath (y0001032@rzserv8.rz.tu-bs.de) Be c++ compliant in gpm.h (1.11) Stephen Tell (tell@cs.unc.edu) Patch for the ps2 decoder to support misbehaving devices (1.11) Francois Chastrette (no-email) Great help to support plugnpray mice (1.13) Steve Bennett (s.bennett@lancaster.ac.uk) Support for the intellimouse serial devices. (1.13) Jan Daciuk (jandac@pg.gda.pl) t-mouse: yet another regexp possibility Ian Zimmerman is now actively cooperating in maintaining gpm, so he'll no longer appear in the acknowledgements ;-) David Given (dg@tao.co.uk) Offered support for joystick mouse emulation (1.14) Tim Goodwin (tgoodwin@cygnus.co.uk) Colin Plumb (colin@nyx10.nyx.net) Ben Pfaff (pfaffben@pilot.msu.edu) Ian and Iris (brooke@jump.net) All of them sent in support for ps2 intellimouse (1.14) Edmund Grimley Evans (edmund@vocalis.com) Added "-t ms+lr" Stefan Runker (runkeledv@t-online.de) Contributed a new Wacom decoder Alessandro Rubini (rubini@linux.it) He's done a lot of work on gpm and maintained it. He's still helping me a lot to understand all parts of gpm. ======================================================================== * COPYING ======================================================================== GNU GENERAL PUBLIC LICENSE Version 2, June 1991 Copyright (C) 1989, 1991 Free Software Foundation, Inc. 675 Mass Ave, Cambridge, MA 02139, USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. This General Public License applies to most of the Free Software Foundation's software and to any other program whose authors commit to using it. (Some other Free Software Foundation software is covered by the GNU Library General Public License instead.) You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs; and that you know you can do these things. To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it. For example, if you distribute copies of such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software. Also, for each author's protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations. Finally, any free program is threatened constantly by software patents. We wish to avoid the danger that redistributors of a free program will individually obtain patent licenses, in effect making the program proprietary. To prevent this, we have made it clear that any patent must be licensed for everyone's free use or not licensed at all. The precise terms and conditions for copying, distribution and modification follow. GNU GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 0. This License applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The "Program", below, refers to any such program or work, and a "work based on the Program" means either the Program or any derivative work under copyright law: that is to say, a work containing the Program or a portion of it, either verbatim or with modifications and/or translated into another language. (Hereinafter, translation is included without limitation in the term "modification".) Each licensee is addressed as "you". Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running the Program is not restricted, and the output from the Program is covered only if its contents constitute a work based on the Program (independent of having been made by running the Program). Whether that is true depends on what the Program does. 1. You may copy and distribute verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and give any other recipients of the Program a copy of this License along with the Program. You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee. 2. You may modify your copy or copies of the Program or any portion of it, thus forming a work based on the Program, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions: a) You must cause the modified files to carry prominent notices stating that you changed the files and the date of any change. b) You must cause any work that you distribute or publish, that in whole or in part contains or is derived from the Program or any part thereof, to be licensed as a whole at no charge to all third parties under the terms of this License. c) If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the most ordinary way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this License. (Exception: if the Program itself is interactive but does not normally print such an announcement, your work based on the Program is not required to print an announcement.) These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Program, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Program, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it. Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Program. In addition, mere aggregation of another work not based on the Program with the Program (or with a work based on the Program) on a volume of a storage or distribution medium does not bring the other work under the scope of this License. 3. You may copy and distribute the Program (or a work based on it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you also do one of the following: a) Accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, b) Accompany it with a written offer, valid for at least three years, to give any third party, for a charge no more than your cost of physically performing source distribution, a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, c) Accompany it with the information you received as to the offer to distribute corresponding source code. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form with such an offer, in accord with Subsection b above.) The source code for a work means the preferred form of the work for making modifications to it. For an executable work, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the executable. However, as a special exception, the source code distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable. If distribution of executable or object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place counts as distribution of the source code, even though third parties are not compelled to copy the source along with the object code. 4. You may not copy, modify, sublicense, or distribute the Program except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense or distribute the Program is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance. 5. You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Program or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Program (or any work based on the Program), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Program or works based on it. 6. Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties to this License. 7. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Program at all. For example, if a patent license would not permit royalty-free redistribution of the Program by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Program. If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply and the section as a whole is intended to apply in other circumstances. It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system, which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice. This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License. 8. If the distribution and/or use of the Program is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Program under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License. 9. The Free Software Foundation may publish revised and/or new versions of the General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies a version number of this License which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of this License, you may choose any version ever published by the Free Software Foundation. 10. If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally. NO WARRANTY 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. Copyright (C) 19yy This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. Also add information on how to contact you by electronic and paper mail. If the program is interactive, make it output a short notice like this when it starts in an interactive mode: Gnomovision version 69, Copyright (C) 19yy name of author Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, the commands you use may be called something other than `show w' and `show c'; they could even be mouse-clicks or menu items--whatever suits your program. You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the program, if necessary. Here is a sample; alter the names: Yoyodyne, Inc., hereby disclaims all copyright interest in the program `Gnomovision' (which makes passes at compilers) written by James Hacker. , 1 April 1989 Ty Coon, President of Vice This General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Library General Public License instead of this License.