Browse Source

Created README.md, Removed old README

Fredrik Haikarainen 10 years ago
parent
commit
49edb63381
2 changed files with 102 additions and 92 deletions
  1. 0
    92
      README
  2. 102
    0
      README.md

+ 0
- 92
README View File

@@ -1,92 +0,0 @@
1
-Light 0.9
2
-
3
-Copyright (C) 2012 - 2014, Fredrik Haikarainen
4
-This is free software, see the source for copying conditions.  There is NO
5
-warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE
6
-
7
---------------------------------------------------------------------------
8
-
9
-Description:
10
-
11
-"Light"  is  a program  to control backlight controllers  under GNU/Linux,
12
-it is the successor of lightscript, which was a bash script with the  same
13
-purpose, and tries to maintain the same functionality.
14
-
15
-
16
-Features:
17
-
18
-  * Works excellent where other software has been proven to be unusable or
19
-    problematic, thanks to how it operates internally and to the fact that
20
-    it does not rely on xorg.
21
-
22
-  * Can automatically figure out the best controller to use,   making full
23
-    use of underlying hardware.
24
-
25
-  * Possibility to set a minimum brightness value, as some controllers set
26
-    the screen to be pitch black at a vaĺue of 0 (or higher).
27
-
28
-
29
-Installation:
30
-  
31
-  If you run ArchLinux, there is a package in the AUR called light.
32
-
33
-  1) Install neccessary build tools (gcc, make etc.)
34
-
35
-  2) Type `make`
36
-
37
-  3) As root/with sudo; type `make install`
38
-
39
-  5) Enjoy!
40
-
41
-
42
-Usage:
43
-
44
-  This application has 4 different operation modes, which are:
45
-
46
-    -G:   Get, which reads/gets brightness/data from controllers/files
47
-    -S:   Set, whichs writes/sets brightness/data to controllers/files
48
-    -A:   Add, does like -S but instead adds the value
49
-    -U:   Subtract, does like -S but instead subtracts the value
50
-
51
-  When used by themselves   operate on the brightness of a controller that
52
-  is selected automatically. S, A and U needs another argument,   which is
53
-  the value to set/add/subtract.   This can be specified either in percent
54
-  or in raw values,  but remember to specify the value mode if you want to
55
-  write raw values.
56
-
57
-  The value modes are set with -p for percent (default), and -r for raw.
58
-
59
-  As you can not only read/write the brightness of controllers,    you may
60
-  also specify a target to read/write from/to:
61
-
62
-    -b:   Current brightness of selected controller
63
-    -m:   Maximum brightness of selected controller
64
-    -c:   Minimum brightness (cap) of selected controller
65
-
66
-  Finally, you can either use the built-in controller selection to get the
67
-  controller with the maximum precision,   or you can specify one manually
68
-  with the -s flag. The -a flag will force automatic mode and is default.
69
-
70
-  NOTE:
71
-  This application will only print errors if you are using it incorrectly.
72
-  If something goes wrong, and you can't figure out why,   try setting the
73
-  verbosity flag:
74
-
75
-    -v 0: No debug output
76
-    -v 1: Errors
77
-    -v 2: Errors, warnings
78
-    -v 3: Errors, warnings, notices
79
-
80
-  Examples:
81
-
82
-    * Get the current brightness in percent
83
-    
84
-      light -G
85
-
86
-    * Increase brightness by 5 percent
87
-
88
-      light -A 5
89
-
90
-    * Set the minimum cap to 2 in raw value on the acpi_video0 controller:
91
-
92
-      light -Scrs "acpi_video0" 2

+ 102
- 0
README.md View File

@@ -0,0 +1,102 @@
1
+# Light
2
+
3
+Copyright (C) 2012 - 2014, Fredrik Haikarainen
4
+This is free software, see the source for copying conditions.  There is NO
5
+warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE
6
+
7
+
8
+## Description
9
+
10
+"Light"  is  a program  to control backlight controllers  under GNU/Linux,
11
+it is the successor of lightscript, which was a bash script with the  same
12
+purpose, and tries to maintain the same functionality.
13
+
14
+
15
+## Features
16
+
17
+* Works excellent where other software has been proven to be unusable or problematic, thanks to how it operates internally and to the fact that it does not rely on xorg.
18
+* Can automatically figure out the best controller to use, making full use of underlying hardware drivers.
19
+* Possibility to set a minimum brightness value, as some controllers set the screen to be pitch black at a vaĺue of 0 (or higher).
20
+
21
+
22
+## Installation
23
+
24
+### Arch Linux
25
+
26
+If you run Arch Linux, there exists 2 packages;
27
+* [light-git](https://aur.archlinux.org/packages/light-git) - For the absolutely latest version
28
+* [light](https://aur.archlinux.org/packages/light) - For the latest tagged release
29
+
30
+I recommend you go with light-git as you might miss important features and bugfixes if you do not.
31
+
32
+### Debian/Ubuntu (Or other Debian-based)
33
+
34
+A .deb is on the way
35
+
36
+### Manual
37
+
38
+`make && make install`
39
+
40
+
41
+## Usage
42
+
43
+This application usually has 4 different criteria on flags to use, which are operation modes, value mode, target and controller mode. Flags from these different modes can never be used in conjunction, but all of them do not always have to be specified (although it is recommended to do so for verbosity).
44
+
45
+**Note:** This application will only print errors if you are using it incorrectly. If something goes wrong, and you can't figure out why, try setting the verbosity flag with -v:
46
+
47
+* 0: No debug output
48
+* 1: Errors
49
+* 2: Errors, warnings
50
+* 3: Errors, warnings, notices
51
+
52
+### Operation modes
53
+
54
+The operation modes describe **what** you want to do.
55
+
56
+* -G: Which **reads/gets** brightness/data from controllers/files
57
+* -S: Which **writes/sets** brightness/data to controllers/files
58
+* -A: Which does like -S but instead **adds** the value
59
+* -U: Which does like -S but instead '**subtracts** the value
60
+* -O: Save the current brightness for later use (usually used on shutdown)
61
+* -I: Restore the previously saved brightness (usually used on boot)
62
+* -L: List the available controllers
63
+
64
+When used by themselves operate on the brightness of a controller that is selected automatically. S, A and U needs another argument -- except for the main 4 criteria -- which is the value to set/add/subtract.   This can be specified either in percent or in raw values, but remember to specify the value mode (read below) if you want to write raw values.
65
+
66
+### Value modes
67
+
68
+The value mode specify in what unit you want to read or write values in. The default one (if not specified) is in percent, the other one is raw mode and should always be used when you need very precise values (or only have a controller with a very small amount of brightness levels).
69
+
70
+* -p: Percent
71
+* -r: Raw mode
72
+
73
+Remember, this is the unit that will be used when you set, get, add or subtract brightness values.
74
+
75
+### Target
76
+
77
+As you can not only handle the **brightness** of controllers, you may also specify a target to read/write from/to:
78
+
79
+* -b: Current brightness of selected controller
80
+* -m: Maximum brightness of selected controller
81
+* -c: Minimum brightness (cap) of selected controller
82
+
83
+The minimum brightness is a feature implemented as some controllers make the screen go pitch black at 0%, if you have a controller like that, it is recommended to set this value (in either percent or in raw mode). These values will be saved in raw mode though, so if you specify it in percent it might not be too accurate depending on your controller.
84
+
85
+### Controller modes
86
+
87
+Finally, you can either use the built-in controller selection to get the controller with the maximum precision, or you can specify one manually with the -s flag. The -a flag will force automatic mode and is default. Use -L to get a list of controllers to use with the -s flag (to specify which controller to use).
88
+
89
+### Examples
90
+
91
+Get the current brightness in percent
92
+
93
+`light -G`
94
+
95
+Increase brightness by 5 percent
96
+
97
+`light -A 5`
98
+
99
+Set the minimum cap to 2 in raw value on the acpi_video0 controller:
100
+
101
+`light -Scrs "acpi_video0" 2`
102
+