Browse Source

Merge pull request #70 from haikarainen/man-page-update

Fix #66: Align man page with help text
Joachim Nilsson 6 years ago
parent
commit
3846efc1fe
No account linked to committer's email
1 changed files with 26 additions and 54 deletions
  1. 26
    54
      light.1

+ 26
- 54
light.1 View File

@@ -7,12 +7,8 @@
7 7
 .Nd a program to control backlight controllers
8 8
 .Sh SYNOPSIS
9 9
 .Nm light
10
-.Op Fl abcGhHkIlLmOprV
11
-.Op Fl s Ar ARG
12
-.Op Fl v Ar LEVEL
13
-.Op Fl A Ar VAL
14
-.Op Fl S Ar VAL
15
-.Op Fl U Ar VAL
10
+.Op Ar OPTIONS
11
+.Op Ar VALUE
16 12
 .Sh DESCRIPTION
17 13
 .Nm
18 14
 is a program to control backlight display and keyboard controllers under
@@ -32,64 +28,40 @@ the display to be pitch black at a vaĺue of 0 (or higher)
32 28
 The following unique commands are supported:
33 29
 .Pp
34 30
 .Bl -tag -width Ds
35
-.It Fl A Ar VAL
36
-Add value
37
-.It Fl G
38
-Get value, default
39 31
 .It Fl H , Fl h
40 32
 Show help text and exit
41
-.It Fl I
42
-Restore brightness
43
-.It Fl L
44
-List controllers
45
-.It Fl O
46
-Save brightness
47
-.It Fl S Ar VAL
48
-Set value
49
-.It Fl U Ar VAL
50
-Subtract value
51 33
 .It Fl V
52 34
 Show program version and exit
35
+.It Fl L
36
+List available devices
37
+.It Fl A
38
+Increase brightness by value
39
+.It Fl U
40
+Decrease brightness by value
41
+.It Fl S
42
+Set brightness to value
43
+.It Fl G
44
+Get brightness, default
45
+.It Fl N
46
+Set minimum brightness to value
47
+.It Fl P
48
+Get minimum brightness
49
+.It Fl I
50
+Save current brightness
51
+.It Fl O
52
+Restore previously saved brightness
53 53
 .El
54 54
 .Sh OPTIONS
55 55
 The behavior of the above commands can be modified using these options:
56 56
 .Pp
57 57
 .Bl -tag -width Ds
58
-.It Fl b
59
-Set
60
-.Fl S ,
61
-Get
62
-.Fl G ,
63
-Add
64
-.Fl A ,
65
-or Subtract
66
-.Fl U
67
-active brightness, default
68
-.It Fl k
69
-Act on keyboard backlight
70
-.It Fl l
71
-Act on display backlight, default
72
-.It Fl m
73
-Get 
74
-.Fl G
75
-maximum brightness
76
-.It Fl c
77
-Set
78
-.Fl S
79
-or get
80
-.Fl G
81
-minimum cap for brightness
82
-.It Fl a
83
-Select controller automatically, default
84
-.It Fl p
85
-Interpret input and output values in percent, default
86 58
 .It Fl r
87 59
 Interpret input and output values in raw mode
88
-.It Fl s Ar ARG
89
-Specify controller to use.  Use
60
+.It Fl s Ar PATH
61
+Specify device target path.  Use
90 62
 .Fl L
91
-to list available controllers
92
-.It Fl v Ar ARG
63
+to list available devices
64
+.It Fl v Ar LEVEL
93 65
 Set verbosity level, by default
94 66
 .Nm
95 67
 only outputs read values:
@@ -110,11 +82,11 @@ When run in its classic SUID root mode
110 82
 .Nm
111 83
 caches settings and current brightness in
112 84
 .Pa /etc/light .
113
-In its non-priviliged mode of operation the
85
+In its non-privileged mode of operation the
114 86
 .Pa ~/.cache/light
115 87
 directory is used instead.
116 88
 .Sh AUTHORS
117
-Copyright \(co 2014 Fredrik Haikarainen
89
+Copyright \(co 2012-2018 Fredrik Haikarainen
118 90
 .Pp
119 91
 This is free software, see the source for copying conditions.  There is NO
120 92
 warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE