"SfR Fresh" - the SfR Freeware/Shareware Archive 
Member "gpm-1.20.5/README" of archive gpm-1.20.5.tar.gz:
As a special service "SfR Fresh" has tried to format the requested source page into HTML format using source code syntax highlighting with prefixed line numbers.
Alternatively you can here view or download the uninterpreted source code file.
That can be also achieved for any archive member file by clicking within an archive contents listing on the first character of the file(path) respectively on the according byte size field.
1 /*
2 * README -- gpm 1.xx
3 *
4 * Copyright 1995-2000 rubini@linux.it (Alessandro Rubini)
5 * Copyright 2001-2008 nico-gpm2008 at schottelius.org (Nico Schottelius)
6 *
7 *******/
8
9 The gpm (general purpose mouse) daemon tries to be a useful mouse
10 server for applications running on the Linux console. Its roots are
11 in the "selection" package, by Andrew Haylett, and the original code
12 comes from selection itself. This package is intended as a replacement
13 for "selection", to provide additional facilities. From 0.18 onward
14 gpm supports xterm as well, so you can run mouse-sensitive
15 applications under X, and you can easily write curses applications
16 which support the mouse on both the Linux console and xterm. The xterm
17 code is portable to any U*x flavour (look at sample/README).
18
19 The first clients have been "The Midnight Commander", by Miguel de
20 Icaza and an emacs library included in this release. Recent dialog
21 distributions and the Jed editor use gpm as well, and the same do
22 several custom applications.
23
24 There are still some new features to add (f.i. clean devfs support).
25 Some of gpm's code needs a cleanup.
26
27 If you want to make a patch to gpm, please read doc/HACK_GPM.
28
29 For additionally documentation and other READMEs have a look into doc/.
30
31 =========== REPORT SUCCESS
32
33 As it is always nice to see as an author of FOSS that the software is
34 used and alive und which options are used, you can send a success
35 report to me via ./scripts/report_success.sh.
36
37
38 =========== MAINTENANCE
39
40 As of 1.19.4, gpm is officially maintained again. Most of the README is written
41 by Alessandro Rubine, only minor changes are made by me.
42
43
44 =========== MAILING LIST
45
46 The mailing list devoted to gpm is "gpm@lists.linux.it"
47 The list is managed by Mailman and is currently open,
48 so non-subscribers are allowed to post.
49
50 In order to subscribe to the mailing list, visit
51 http://lists.linux.it/listinfo/gpm
52
53 or send a message with "subscribe" in its body to
54 gpm-request@lists.linux.it.
55
56 For example:
57 echo subscribe | mail gpm-request@lists.linux.it
58
59
60 =========== DOWNLOAD / HOMEPAGE
61
62 The latest releases can always be found in one of the following place:
63
64 http://unix.schottelius.org/gpm/archives/
65 http://unix.schottelius.org/gpm/browse_source/
66
67 Mirror:
68
69 ftp://arcana.linux.it/pub/gpm/
70 http://www.ar.linux.it/pub/gpm/
71
72 The homepage of gpm can be found at
73
74 http://unix.schottelius.org/gpm/
75
76 You can get the latest development tree of gpm via git:
77
78 git-clone http://unix.schottelius.org/git/gpm
79
80 There are three branches available:
81
82 master: Contains the latest gpm1 code, may be broken.
83 gpm-1-stable: Contains the latest stable source code.
84 gpm-2-dev: Contains work that heads to gpm2.
85
86 You can browse the git-tree via gitweb:
87
88 http://unix.schottelius.org/cgi-bin/gitweb.cgi?p=gpm;a=summary
89
90
91 =========== COMPILING AND INSTALLING
92
93 The package uses autoconf as of 2.12. Use "./configure && make" to
94 compile the gpm suite. To install "make install". This installs
95 everything under the "prefix" directory, which by default is
96 /usr/local.
97
98 Use "./configure --prefix=/usr" if you want to install under /usr
99 instead of /usr/local.
100
101 Exectuable files are installed in $(prefix)/bin (except the gpm daemon
102 in $(prefix)/sbin), libraries in $(prefix)/lib, man pages in
103 $(prefix)/man, the lisp library in the proper location for emacs-list
104 files (detected during the "configure" step); info files are installed
105 under $(prefix)/info.
106
107 If you would like to 'clean'up very tidy, use distclean. Don't forget to use
108 make distclean config! Otherwise there will be no configure script!
109
110 If any errors occur, please report them to me. Something like this
111 could be an easy (though brutal) way to do it:
112 make clean;(uname -a; make) | mail -s "gpm compile err." nicos-gpm@pcsystems.de
113
114 What remains to do after installation is a little configuration
115
116
117 =========== CONFIGURING
118
119 Configuration is optional...
120
121 * You would like to tell emacs to use t-mouse.el when appropriate. Add
122 the following lines to your own .emacs (in your home
123 directory), or in the /usr/lib/emacs/site-lisp/default
124
125 (if (and (string-match ".*-linux" system-configuration)
126 (not window-system)
127 (or (string-match "linux" (getenv "TERM"))
128 (string-match "con.*" (getenv "TERM"))))
129 (load-library "t-mouse"))
130
131 * If you want to use gpm-root, copy gpm-root.conf to your /usr/etc
132 directory, test it out and then edit it to suit your feels.
133
134 * You'd like to name the gpm info file inside /usr/info/dir. Just insert
135 the line
136 * gpm: (gpm.info). A mouse server for the Linux console
137 at the proper place. Note that this is usually automatically
138 performed if you install a package prepared for your own
139 distribution.
140
141 * To invoke gpm (and gpm-root) at system boot, add something like this
142 to your /etc/rc.d/rc.local
143
144 /usr/sbin/gpm -t msc -m /dev/tts/0 &
145 /usr/bin/gpm-root &
146
147 If you are running the new setup of SysVinit, you should better
148 add a "gpm" script in /etc/rc.d/rc.init and install it in your
149 runlevels in the usual way (this is usually included in your
150 distribution as well)
151
152 You may want to put the mouse server at a higher priority: in
153 this case invoke instead "/usr/bin/nice -n -20 /usr/sbin/gpm -t
154 msc"
155
156 The program goes to the background by itself, unless
157 it is run with debuging enabled (see the -D option in the
158 documentation).
159
160
161 ========== DOCS
162
163 The directory "./doc" holds the documentation. The release embeds a
164 postscript file, slightly reduced to save paper (doc/gpm2.ps), an info
165 one (doc/gpm.info) and a text-only version (doc/gpmdoc.txt -- but
166 without table of contents, for now). Man pages are automatically
167 extracted from the info file, and are installed with "make install"
168
169
170 =========== BUG REPORTS
171
172 Before sending bug reports, please look at the file "FAQ",
173 which outlines some known problems, and how to deal with them.
174
175 If your bug isn't fixed by reading there, please report it to me,
176 without getting angry with me if things don't work at first trial
177 (but they usually work).
178
179 Bug reports are best sent to the gpm mailing list (see above) or to me
180 via email, if you use personal mail please include the string "gpm"
181 somewhere in the subject line. This will help my filters in sorting
182 things out.
183
184 * When compilation fails I need your kernel version ("uname -a"), the
185 compiler version ("gcc -v") and the library version ("ls -l /lib" or,
186 better "ldd /usr/sbin/gpm"). And the compiler messages, obviously.
187
188 * When a program hangs or segfaults, please reinvoke the program under strace:
189 strace -tf -o /tmp/trace.gpm gpm -t msc
190 ^^^^^^^^^^ put your true cmdline here.
191 Then send me /tmp/trace.gpm* (they may be one or two files, according
192 to the strace version), and a description of how you reproduce the problem.
193
194 The last resort is a core dump, but I'll ask it personally if I have real
195 difficulties in tracing out your problem.
196
197
198 =========== CREDITS
199
200 The following people contributed to gpm, in chronological order. This
201 list used to reside in a different file, but it's better for it to stand
202 out in the README
203
204 Andrew Haylett (ajh@gec-mrc.co.uk)
205 donated "selection" to the linux community, so I could get
206 the idea and the code. A few others contributed to selection,
207 but I lost track of their contributions and names.
208
209 Steven S. Dick (ssd@nevets.oau.org)
210 fixed a pair of bugs in early gpm versions.
211
212 Miguel de Icaza (miguel@roxanne.nuclecu.unam.mx)
213 helped fixing some bugs and provided a good client to test
214 my server. He helped a lot in testing the various pre-releases.
215
216 Olav Woelfelschneider (wosch@rbg.informatik.th-darmstadt.de)
217 fixed 0.10 with MouseSystems compatible mice.
218
219 Janne Kukonlehto (jtklehto@stekt.oulu.fi)
220 provided xterm mouse decoding to be stolen by me.
221
222 Rick Lyons (rick@razorback.brisnet.org.au)
223 fixed a bug in gpm-0.9.
224
225 Reuben Sumner (rasumner@undergrad.math.uwaterloo.ca)
226 helped fixing behaviour with "-t bm".
227
228 Larry Bartholdi (lbartho@scsun.unige.ch)
229 pinpointed an error in t-mouse-suspend
230 and provided good suggestions for 0.97.
231
232 Mark Lord (mlord@bnr.ca)
233 ported to Dexxa/Logitech mice and gave feedback several times.
234
235 Stefan Giessler (stg@gandalf.han.de)
236 fixed some problems with gpm-root and
237 suggested to put gpm in the background (0.97).
238
239 Roman Shapiro
240 helped with the Logitech MouseMan.
241
242 Andries Brouwer (aeb@cwi.nl)
243 Provided a Latin-1 LUT for chars, and enhanced
244 lut-loading code (0.98).
245
246 Adrian Johnson (ajohnson@apanix.apana.org.au)
247 Gave good feedback and ideas for the 0.98's
248
249 Stephen Lee (sl14@crux1.cit.cornell.edu)
250 Helped a lot with the damned MouseMan protocol (0.98 and 1.0)
251
252 John van Leeuwen (johnvl@einstein.et.tudelft.nl)
253 Outlined and fixed a pair of bugs in gpm-root 0.98
254
255 Alvar Bray (alvar@meiko.co.uk)
256 Pointed out an error with awk (0.99)
257
258 David A. van Leeuwen (david@tm.tno.nl)
259 Helped with chord-middle protocols (1.0)
260
261 Pavel Kankovsky (KAN@frode.dcit.cz)
262 Open /dev/ttyxx instead of /dev/console in the lib (1.01)
263
264 Mark Shadley (shadcat@catcher.com)
265 Helped in turning to ELF (1.01 and 1.02) and in fixing
266 horrible bugs of mine. Without his help 1.03 wouldn't be there.
267
268 Lou Sortman (lou@lounix4.conc.tdsnet.com)
269 Added support for glidepoint mice within "-t mman". (1.05)
270
271 Marc Meis (100334.1426@compuserve.com)
272 Provided support for absolute pointing devices, and in
273 particular for the ncr3125 pen. (1.05)
274
275 Michael Plass (Michael_Plass.PARC@xerox.com)
276 Fixed a damned bug in middle button decoding (M_ms) (1.07)
277
278 Markus Gutschke (gutschk@uni-muenster.de)
279 Provided a better re-encoding for "-R" (1.10)
280
281 Karsten Ballueder (Karsten@piobelix.physik.uni-karlsruhe.de)
282 Suggested the reboot compile-time option (1.10)
283
284 John Davis (davis@space.mit.edu)
285 Found and fixed a buglet in liblow.c for some jed users (1.10)
286
287 Julian Thompson (jrt@miel.demon.co.uk)
288 Fixed a buglet in gpm-root (1.10)
289
290 Dave Flater (dave@universe.digex.net)
291 Removed a typo in the disabled decoder for ms-3b (1.11)
292
293 Thomas E. Dickey (dickey@clark.net)
294 Ported to autoconf (1.11)
295
296 Pavel Machek (pavel@ucw.cz)
297 New mode "logim" (1.11) and NetMouse (1.14)
298
299 Matthias Grimrath (y0001032@rzserv8.rz.tu-bs.de)
300 Be c++ compliant in gpm.h (1.11)
301
302 Stephen Tell (tell@cs.unc.edu)
303 Patch for the ps2 decoder to support misbehaving devices (1.11)
304
305 Francois Chastrette (no-email)
306 Great help to support plugnpray mice (1.13)
307
308 Steve Bennett (s.bennett@lancaster.ac.uk)
309 Support for the intellimouse serial devices. (1.13)
310
311 Jan Daciuk (jandac@pg.gda.pl)
312 t-mouse: yet another regexp possibility
313
314 Ian Zimmerman is now actively cooperating in maintaining gpm, so
315 he'll no longer appear in the acknowledgements ;-)
316
317 David Given (dg@tao.co.uk)
318 Offered support for joystick mouse emulation (1.14)
319
320 Tim Goodwin (tgoodwin@cygnus.co.uk)
321 Colin Plumb (colin@nyx10.nyx.net)
322 Ben Pfaff (pfaffben@pilot.msu.edu)
323 Ian and Iris (brooke@jump.net)
324 All of them sent in support for ps2 intellimouse (1.14)
325
326 Edmund Grimley Evans (edmund@vocalis.com)
327 Added "-t ms+lr"
328
329 Stefan Runker (runkeledv@t-online.de)
330 Contributed a new Wacom decoder
331
332 Alessandro Rubini (rubini@linux.it)
333 He's done a lot of work on gpm and maintained it.
334 He's still helping me a lot to understand all parts of gpm.