sd_alias: use DEVPATH instead of path_id to extract SCSI ID
[nas-tools.git] / led_ctrl / README
1 What is led_ctrl ?
2 ------------------
3
4 led_ctrl is a POSIX shell script which allow to configure LEDs (compatible
5 with the GNU/Linux sysfs LED API) via an understandable configuration file.
6
7 How to install ?
8 ----------------
9
10 Just go in the led_ctrl source repository and do
11
12         make install
13
14 How to use ?
15 ------------
16
17 Without any arguments, led_ctrl will list all the available modes:
18
19   $ led_ctrl
20   suspend
21   startup
22   shutdown
23   update
24
25 To set startup mode:
26
27   $ led_ctrl startup
28
29 How to configure ?
30 ------------------
31
32 After installation, the led_ctrl configuration file should /etc/led_ctrl.conf.
33 An alternate configuration file can be specified using the options --config
34 or -c. Note that a default configuration file is provided with this package.
35 Read this file could be helpful.
36
37 A configuration file contain some LED mode definitions. A LED mode allow to
38 apply settings to one or several LEDs.
39
40 - Configuration file format:
41
42 {mode_name1}
43 led_name1       attr1=value1 attr2=value2 ...
44 led_name2       attr1=value1 attr2=value2 ...
45 ...
46
47 {mode_name2}
48 ...
49
50 - Configuration format rules:
51
52   * Comments and empty lines are supported.
53
54   * A Mode keyword must be enclosed in '{' '}'.
55
56   * Each mode settings line must begin with a LED name pattern. As wildcards
57     and globbing are supported, the following settings could apply to several
58     LEDs.
59
60   * Space and tabulations are the only valid separators between LED names and
61     attribute settings.
62
63   * LED settings are of the form 'attr=value'. Attribute names and values
64     should be valid regarding the sysfs LED API.
65
66 - Mode examples:
67
68 {off} # turn off all the LEDs
69 *       brightness=0
70
71 {startup} # turn on the power LED and enable SATA activity on the rear LEDS
72 *:blue:power    trigger=none brightness=255
73 *:blue:sata*    trigger=none sata=1 brightness=255