aboutsummaryrefslogtreecommitdiff
path: root/brightnessctl.1
blob: d8c2065bbcab9b1facd9688ef152ee77fe2d4a9d (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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
.TH "BRIGHTNESSCTL" "1" "24th Jan 2018" "brightnessctl" "brightnessctl"

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


.SH "SYNOPSIS"

.sp
\fIbrightnessctl\fR [options] \fI[operation]\fR [value...]


.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\-n, \-\-min\-value\fP=\fIVALUE\fP
.RS 4
Set minimum brightness when using delta values, defaults to 1.
.RE

.sp
\fB\-e, \-\-exponent\fP=\fIK\fP
.RS 4
Changes percentage scaling curve to exponential (linear by default). Default exponent is 4.

Percentage equation: % = \fI[VALUE]\fR^\fI[K]\fR * \fI[MAX]\fR * 100^-\fI[K]\fR.

The exponential curve may make the adjustments perceptually equal.
.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.

.SS VALUES
.P
You may specify \fIVALUE\fR for the \fBset\fR command in absolute or relative form, and
as a value or a delta from the current value. For example:
.P
\fBbrightnessctl set 500\fR
.RS "4"
Sets brightness to 500.
.P
.RE
\fBbrightnessctl set 50.75%\fR
.RS "4"
Sets brightness to 50.75% of the maximum.
.P
.RE
\fBbrightnessctl set 50-\fR
.RS "4"
Subtracts 50 from the current brightness.
.P
.RE
\fBbrightnessctl set +10\fR
.RS "4"
Adds 10 to the current brightness.
.P
.RE
\fBbrightnessctl set 50%-\fR
.RS "4"
Subtracts 50% of the maximum from the current brightness.
.P
.RE
\fBbrightnessctl set +10%\fR
.RS "4"
Adds 10% of the maximum to the current brightness.
.P
.RE
.SH AUTHORS
.P
Maintained by Mykyta Holubakha, who is assisted by other open source
contributors. For more information about brightnessctl development, visit:
.P
https://github.com/Hummer12007/brightnessctl