aboutsummaryrefslogtreecommitdiff
path: root/brightnessctl.1.in
blob: febe4583ac261875f7a0d71c07d7829459fcb257 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
'\" t
.\"     Title: brightnessctl
.\"    Author: Mykyta Holubakha
.\"  Language: English
.\"
.TH "BRIGHTNESSCTL" "1" "VERSION" "brightnessctl" "brightnessctl"

.SH "NAME"
brightnessctl \- read and control device brightness


.SH "SYNOPSIS"

.sp
\fBbrightnessctl\fP [\(aqOPTION\(aq]... [\(aqOPERATION\(aq]... [\(aqVALUE\(aq]...


.SH "OPTIONS"

.sp
\fB\-h, \-\-help\fP
.RS 4
Print this help.
.RE

.sp
\fB\-l, \-\-list\fP
.RS 4
List devices with available brightness controls.
.RE

.sp
\fB\-q, \-\-quiet\fP
.RS 4
Suppress output.
.RE

.sp
\fB\-p, \-\-pretend\fP
.RS 4
Do not perform write operations.
.RE

.sp
\fB\-m, \-\-machine\-readable\fP
.RS 4
Produce machine\-readable output.
.RE

.sp
\fB\-s, \-\-save\fP
.RS 4
Save state in a temporary file.
.RE

.sp
\fB\-r, \-\-restore\fP
.RS 4
Restore previously\-saved state.
.RE

.sp
\fB\-d, \-\-device\fP=\fIDEVICE\fP
.RS 4
Specify device name (can be a wildcard).
.RE

.sp
\fB\-c, \-\-class\fP=\fICLASS\fP
.RS 4
Specify device class.
.RE

.sp
\fB\-v, \-\-version\fP
.RS 4
Print version and exit.
.RE


.SH "OPERATIONS"

.sp
\fBi, info\fP
.RS 4
Get device info.
.RE

.sp
\fBg, get\fP
.RS 4
Get the current brightness of the device.
.RE

.sp
\fBm, max\fP
.RS 4
Get the maximum brightness of the device.
.RE

.sp
\fBs, set\fP \fIVALUE\fP
.RS 4
Set the brightness of the device.

Valid values:
.IP \[bu] 2
absolute value: 500
.IP \[bu]
relative value: 50%
.IP \[bu]
absolute delta: 50-  or +10
.IP \[bu]
relative delta: 50%- or +10%
.RE


.SH "RESOURCES"
.sp
\fBProject development repository:\fP \c
https://github.com/Hummer12007/brightnessctl


.SH "COPYING"
.sp
Copyright \(co 2016\-2018 Mykyta Holubakha.

Free use of this software is granted under the terms of the MIT/Expat License.


.SH "AUTHOR(S)"
.sp
\fBMykyta Holubakha\fP

\fBNicolas Braud-Santoni\fP (manpage)