Debian Codegraph @

INSTALL

raw
1 /*
2 This file is part of g15daemon.
3
4 g15daemon is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
8
9 g15daemon is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
13
14 You should have received a copy of the GNU General Public License
15 along with g15daemon; if not, write to the Free Software
16 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
17
18 (c) 2006 Mike Lampard, Philip Lawatsch, and others
19
20 This daemon listens on localhost port 15550 for client connections,
21 and arbitrates LCD display. Allows for multiple simultaneous clients.
22 Client screens can be cycled through by pressing the 'L1' key.
23 */
24
25 Install Notes for g15daemon-1.2.1
26
27 1.About the G15Daemon.
28 2.Check list.
29 3.Installing.
30 4.Additional Notes
31
32 1. About the G15Daemon.
33 The G15Daemon was written in a effort to add functionality to the Logitech G15 keyboard under Linux.
34 These functions include the handling of the additional keys (or G keys) and writing
35 of data to the LCD display on the keyboard. The data that is written to the LCD is sent by
36 additional programs/scripts that are written for the g15daemon.
37 A clock for the LCD is loaded as default for the daemon.
38 The g15daemon was written by Mike Lampard, Philip Lawatsch, and others.
39 My thanks to them for a great program.
40
41 2. Check list.
42 A few things we need to check before installing the g15daemon.
43
44 For compiling you need:
45 libg15, libg15render, and libusb development packages.
46
47 For running the daemon you need:
48 linux kernel uniput module
49 This module used to send the new keypresses for the additional keys (or G keys).
50 You can check if you have the uniput module loaded by using the lsmod command.
51 If not you can manually the uinput module with 'modprode uinput' (as root...) .
52 You can load the module on boot by adding it your /etc/modules or
53 /etc/modules.preload (depending on your distribution.)
54
55 libg15
56 This library is needed by the daemon for managing the LCD on the keyboard.
57 You can download the libg15 library from the g15tools homepage on Sourceforge.
58 libg15 depends on libusb-dev so please install libusb-dev before compiling libg15.
59 libusb-dev can be found in your distribution's repositories... hopefully.
60 IMPORTANT!! When libg15 is compiled it will be copied into /usr/local/lib but the
61 daemon looks for it in /usr/lib. If you have not already, add /usr/local/lib to the
62 file /etc/ld.so.conf and run the command 'ldconfig' as root. This will allow
63 Linux to find the libraries installed there. Alternatively, run the libg15
64 configure script with --prefix=/usr as an argument, it will then be installed in /usr/lib.
65
66 And that is about it for the check list...
67
68 3.Installing.
69 Ok browse to the directory where you extracted the daemon to.
70 As a user or root type
71 ./configure
72 make
73
74 Then as root type
75 make install
76
77 To run the g15daemon type
78 g15daemon
79 This must be done as root.
80
81 You should see the initial logo and then default clock appear.
82
83 to kill a previously running daemon
84 g15daemon -k
85
86
87 4. Additional Notes.
88
89 As of version 1.2, the MR key is used for switching between LCD clients,
90 and cannot be used for other purposes if the LCD is being used.
91
92 For a number of reasons, by default the keys on the G15 arent usable -
93 especially without g15daemon :) With g15daemon running, the kernel will
94 know all about the new keys, but your 'X' server won't without a bit of help.
95 In the contrib subfolder of the g15daemon distrobution, you'll find an xmodmaprc
96 script. To have all those new keys working in X11, you'll need to have
97 xmodmap read that file on every startup. Depending on your distro, xmodmap
98 may automatically load the file if it is copied to ${HOME}/.Xmodmap
99 otherwise you will have to load it yourself. There is an example xmodmap.sh
100 file in the contrib directory that will do this, if it's placed (for
101 instance) in kde's Autostart folder.
102
103
104 Patches are available for libgraphlcd, in the g15daemon patches
105 subdirectory. You'll need a copy of graphlcd source, which is available
106 from http://graphlcd.berlios.de . The patches are against the current
107 version, which is 1.3. [UPDATE] The g15daemon graphlcd driver is now
108 in the graphlcd SVN repository. If you use the SVN version of graphlcd,
109 you won't need to patch the library to use the LCD.
110
111 To patch the graphlcd source, extract the graphlcd-base archive, then type:
112 patch -p0 -i "g15daemon_src_folder"/patches/graphlcd-1.3_g15daemon_drv.patch
113
114 where 'g15daemon_src_folder' is the directory you extracted the g15daemon
115 sourcecode into...
116
117
118
119