File: README

package info (click to toggle)
ledcontrol 0.5.2-4
  • links: PTS
  • area: main
  • in suites: woody
  • size: 792 kB
  • ctags: 259
  • sloc: ansic: 3,264; sh: 848; makefile: 176; perl: 49
file content (112 lines) | stat: -rw-r--r-- 2,760 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112

Ledcontrol 0.5.2
----------------

Please read this file before trying to use ledcontrol. It's not that
long and it gives you some important information concerning
configuration etc.

You can find a more thorough explanation of everything in the man
pages (you can read them without installing with for example
"./configure"  "man ./ledd.8").


What is it?
-----------

Ledcontrol is a package designed to show any kind of information on
the unused LEDs on your keyboard. Features include blinking LEDs,
animations, priority levels etc. It is released under the GPL.

Included is the program gled, which helps you test different kinds of
features in ledd.

Ledcontrol works both in X and on a text console.


How does it work?
-----------------

Ledcontrol consists of several pieces:

ledd	The LED daemon. ledd must be running when the other programs
	are used. On startup, it executes programs and/or scripts to
	tell it how to set the LEDs. It is configured in ledd.conf.

startup.sh
	The default script to start on startup. It should not be
	executed by the user. It is configured in ledcontrol.conf.

ledcontrol
	A script that gives commands directly to ledd. Can be used
	from the command line to set the LED states.

gled	A graphical front-end for ledcontrol useful for testing
	commands and experimenting. Built only if GTK+ is found.


Installation
------------

Basically you can install it with

./configure
make
make install

Before you install, you can see a bit of what it can do with
"make test" (probably requires root access).

Then you have to configure it manually (mainly
/usr/local/etc/ledcontrol.conf).

See file INSTALL a little more details.


Configuration
-------------

Configuration is done in two files (the locations can be changed both
at compile-time and at runtime):

/usr/local/etc/ledd.conf
	Normally doesn't need to be modified, as the defaults are
	pretty good.

/usr/local/etc/ledcontrol.conf
	Here you configure what the LEDs indicate.


The default files are pretty well documented. More documentation is
found in the man pages ledd.conf(5) and ledcontrol.conf(5). The
commands used in startup.sh (and given to ledd) are documented
thoroughly in the man page ledd(8), section COMMANDS.


Misc stuff
-----------

For some animations and a short help on how to use them, read the file
ANIMATIONS.

To make ledcontrol more silent (no disk-access) see startup.sh(8).

The worst shortcomings are listed at the end of the man page ledd(8).


Contact
-------

Main author:

Name:   Sampo Niskanen
Email:  sampo.niskanen@iki.fi
WWW:    http://www.iki.fi/sampo.niskanen/

Debian maintainer:
Karl Sderstrm <ks@debian.org>


You can always get the latest version of ledcontrol from
http://www.iki.fi/sampo.niskanen/ledcontrol/