Browse Source

Merge pull request #52 from troglobit/doc-updates

Doc updates
Joachim Nilsson 6 years ago
parent
commit
6ef91ad260
No account linked to committer's email
2 changed files with 13 additions and 8 deletions
  1. 5
    8
      README.md
  2. 8
    0
      light.1

+ 5
- 8
README.md View File

4
 - [Introduction](#introduction)
4
 - [Introduction](#introduction)
5
 - [Examples](#examples)
5
 - [Examples](#examples)
6
 - [Usage](#usage)
6
 - [Usage](#usage)
7
-  - [Operation modes](#operation-modes)
8
-  - [Value modes](#value-modes)
9
-  - [Target](#target)
10
-  - [Field](#field)
11
-  - [Controller modes](#controller-modes)
7
+  - [Commands](#commands)
8
+  - [Options](#options)
12
 - [Installation](#installation)
9
 - [Installation](#installation)
13
   - [Arch Linux](#arch-linux)
10
   - [Arch Linux](#arch-linux)
14
   - [Fedora](#fedora)
11
   - [Fedora](#fedora)
27
 * Automatically detects the best controller
24
 * Automatically detects the best controller
28
 * Possibility to set a minimum brightness value
25
 * Possibility to set a minimum brightness value
29
 
26
 
30
-Let's get started with a few examples, for details, see below for the
31
-full description of the different commands, options and how to access
32
-different controllers.
27
+Let's get started with a few examples!  See the following sections for
28
+the detailed descriptions of all available commands, options and how to
29
+access different controllers.
33
 
30
 
34
 
31
 
35
 Examples
32
 Examples

+ 8
- 0
light.1 View File

105
 Read values, Errors, Warnings, Notices
105
 Read values, Errors, Warnings, Notices
106
 .El
106
 .El
107
 .El
107
 .El
108
+.Sh FILES
109
+When run in its classic SUID root mode
110
+.Nm
111
+caches settings and current brightness in
112
+.Pa /etc/light .
113
+In its non-priviliged mode of operation the
114
+.Pa ~/.cache/light
115
+directory is used instead.
108
 .Sh AUTHORS
116
 .Sh AUTHORS
109
 Copyright \(co 2014 Fredrik Haikarainen
117
 Copyright \(co 2014 Fredrik Haikarainen
110
 .Pp
118
 .Pp