浏览代码

Merge pull request #52 from troglobit/doc-updates

Doc updates
Joachim Nilsson 6 年前
父节点
当前提交
6ef91ad260
没有帐户链接到提交者的电子邮件
共有 2 个文件被更改,包括 13 次插入8 次删除
  1. 5
    8
      README.md
  2. 8
    0
      light.1

+ 5
- 8
README.md 查看文件

@@ -4,11 +4,8 @@ Light - A Program to Control Backlight Controllers
4 4
 - [Introduction](#introduction)
5 5
 - [Examples](#examples)
6 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 9
 - [Installation](#installation)
13 10
   - [Arch Linux](#arch-linux)
14 11
   - [Fedora](#fedora)
@@ -27,9 +24,9 @@ Introduction
27 24
 * Automatically detects the best controller
28 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 32
 Examples

+ 8
- 0
light.1 查看文件

@@ -105,6 +105,14 @@ Read values, Errors, Warnings
105 105
 Read values, Errors, Warnings, Notices
106 106
 .El
107 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 116
 .Sh AUTHORS
109 117
 Copyright \(co 2014 Fredrik Haikarainen
110 118
 .Pp