Mercurial > backlight
annotate backlight.1 @ 21:bf880b3c0665
backlight: fix usage
author | David Demelier <markand@malikania.fr> |
---|---|
date | Sun, 09 Feb 2020 10:55:12 +0100 |
parents | 232b390f1682 |
children | 6081cc143d37 |
rev | line source |
---|---|
7 | 1 .\" |
19 | 2 .\" Copyright (c) 2010-2020 David Demelier <markand@malikania.fr> |
7 | 3 .\" |
4 .\" Permission to use, copy, modify, and/or distribute this software for any | |
5 .\" purpose with or without fee is hereby granted, provided that the above | |
6 .\" copyright notice and this permission notice appear in all copies. | |
7 .\" | |
8 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES | |
9 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF | |
10 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR | |
11 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES | |
12 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN | |
13 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF | |
14 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. | |
15 .\" | |
16 .Dd September 16, 2019 | |
17 .Dt BACKLIGHT 1 | |
18 .Os | |
19 .\" NAME | |
20 .Sh NAME | |
21 .Nm backlight | |
14 | 22 .Nd adjust screen brightness |
7 | 23 .\" SYNOPSIS |
24 .Sh SYNOPSIS | |
25 .Nm | |
15
282ec7c30c04
backlight: now supports more commands
David Demelier <markand@malikania.fr>
parents:
14
diff
changeset
|
26 .Ar decrease |
282ec7c30c04
backlight: now supports more commands
David Demelier <markand@malikania.fr>
parents:
14
diff
changeset
|
27 .Nm |
282ec7c30c04
backlight: now supports more commands
David Demelier <markand@malikania.fr>
parents:
14
diff
changeset
|
28 .Ar get |
7 | 29 .Nm |
15
282ec7c30c04
backlight: now supports more commands
David Demelier <markand@malikania.fr>
parents:
14
diff
changeset
|
30 .Ar increase |
282ec7c30c04
backlight: now supports more commands
David Demelier <markand@malikania.fr>
parents:
14
diff
changeset
|
31 .Nm |
282ec7c30c04
backlight: now supports more commands
David Demelier <markand@malikania.fr>
parents:
14
diff
changeset
|
32 .Ar set |
282ec7c30c04
backlight: now supports more commands
David Demelier <markand@malikania.fr>
parents:
14
diff
changeset
|
33 .Ar percentage |
7 | 34 .\" DESCRIPTION |
35 .Sh DESCRIPTION | |
36 The | |
37 .Nm | |
38 tool adjust the brightness on your screen using direct access to ACPI video | |
39 extension. | |
40 .Pp | |
15
282ec7c30c04
backlight: now supports more commands
David Demelier <markand@malikania.fr>
parents:
14
diff
changeset
|
41 The following commands are available: |
282ec7c30c04
backlight: now supports more commands
David Demelier <markand@malikania.fr>
parents:
14
diff
changeset
|
42 .Bl -tag -width 10n |
282ec7c30c04
backlight: now supports more commands
David Demelier <markand@malikania.fr>
parents:
14
diff
changeset
|
43 .It Cm decrease |
282ec7c30c04
backlight: now supports more commands
David Demelier <markand@malikania.fr>
parents:
14
diff
changeset
|
44 Decrease to the next lower level. |
282ec7c30c04
backlight: now supports more commands
David Demelier <markand@malikania.fr>
parents:
14
diff
changeset
|
45 .It Cm get |
282ec7c30c04
backlight: now supports more commands
David Demelier <markand@malikania.fr>
parents:
14
diff
changeset
|
46 Get the current level scaled to a percentage range. |
282ec7c30c04
backlight: now supports more commands
David Demelier <markand@malikania.fr>
parents:
14
diff
changeset
|
47 .It Cm increase |
282ec7c30c04
backlight: now supports more commands
David Demelier <markand@malikania.fr>
parents:
14
diff
changeset
|
48 Increase to the next upper level. |
282ec7c30c04
backlight: now supports more commands
David Demelier <markand@malikania.fr>
parents:
14
diff
changeset
|
49 .It Cm set |
282ec7c30c04
backlight: now supports more commands
David Demelier <markand@malikania.fr>
parents:
14
diff
changeset
|
50 Set brightness to the |
282ec7c30c04
backlight: now supports more commands
David Demelier <markand@malikania.fr>
parents:
14
diff
changeset
|
51 .Ar percentage |
282ec7c30c04
backlight: now supports more commands
David Demelier <markand@malikania.fr>
parents:
14
diff
changeset
|
52 value. |
282ec7c30c04
backlight: now supports more commands
David Demelier <markand@malikania.fr>
parents:
14
diff
changeset
|
53 .El |
16
0d923f0155dd
doc: improve documentation
David Demelier <markand@malikania.fr>
parents:
15
diff
changeset
|
54 .\" SYSTEM SUPPORT |
0d923f0155dd
doc: improve documentation
David Demelier <markand@malikania.fr>
parents:
15
diff
changeset
|
55 .Sh SYSTEM SUPPORT |
0d923f0155dd
doc: improve documentation
David Demelier <markand@malikania.fr>
parents:
15
diff
changeset
|
56 .Ss Linux |
0d923f0155dd
doc: improve documentation
David Demelier <markand@malikania.fr>
parents:
15
diff
changeset
|
57 On Linux, you need to have ACPI Video support either as module or built-in the |
0d923f0155dd
doc: improve documentation
David Demelier <markand@malikania.fr>
parents:
15
diff
changeset
|
58 kernel. |
0d923f0155dd
doc: improve documentation
David Demelier <markand@malikania.fr>
parents:
15
diff
changeset
|
59 .Pp |
0d923f0155dd
doc: improve documentation
David Demelier <markand@malikania.fr>
parents:
15
diff
changeset
|
60 You may use |
0d923f0155dd
doc: improve documentation
David Demelier <markand@malikania.fr>
parents:
15
diff
changeset
|
61 .Nm |
0d923f0155dd
doc: improve documentation
David Demelier <markand@malikania.fr>
parents:
15
diff
changeset
|
62 as non-root user if you create appropriate udev rules to make files under |
0d923f0155dd
doc: improve documentation
David Demelier <markand@malikania.fr>
parents:
15
diff
changeset
|
63 .Pa /sys/class/backlight |
0d923f0155dd
doc: improve documentation
David Demelier <markand@malikania.fr>
parents:
15
diff
changeset
|
64 writable by a group or per user. |
19 | 65 .Pp |
66 The source package comes with an example of udev rule that can be installed in | |
67 .Pa /usr/lib/udev/rules.d . | |
16
0d923f0155dd
doc: improve documentation
David Demelier <markand@malikania.fr>
parents:
15
diff
changeset
|
68 .Ss FreeBSD |
0d923f0155dd
doc: improve documentation
David Demelier <markand@malikania.fr>
parents:
15
diff
changeset
|
69 Access to brightness under FreeBSD requires super-user, you may need to run |
0d923f0155dd
doc: improve documentation
David Demelier <markand@malikania.fr>
parents:
15
diff
changeset
|
70 .Nm |
0d923f0155dd
doc: improve documentation
David Demelier <markand@malikania.fr>
parents:
15
diff
changeset
|
71 as root or use setuid permission for non-root users. |
0d923f0155dd
doc: improve documentation
David Demelier <markand@malikania.fr>
parents:
15
diff
changeset
|
72 .Pp |
0d923f0155dd
doc: improve documentation
David Demelier <markand@malikania.fr>
parents:
15
diff
changeset
|
73 You also need to load |
0d923f0155dd
doc: improve documentation
David Demelier <markand@malikania.fr>
parents:
15
diff
changeset
|
74 .Xr acpi_video 4 |
19 | 75 module at boot by adding |
20 | 76 .Sy acpi_video_load="YES" |
77 in | |
19 | 78 .Pa /boot/loader.conf . |
7 | 79 .\" AUTHORS |
80 .Sh AUTHORS | |
81 .Nm | |
82 was written by David Demelier <markand@malikania.fr> |