annotate backlight.1 @ 24:2da99b7156de 1.0.0

misc: update before 1.0.0
author David Demelier <markand@malikania.fr>
date Thu, 17 Dec 2020 09:55:32 +0100
parents 6081cc143d37
children 25155025900d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7
45a06b02a61f misc: add missing files
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 .\"
19
0de3886f98ad misc: minor updates
David Demelier <markand@malikania.fr>
parents: 16
diff changeset
2 .\" Copyright (c) 2010-2020 David Demelier <markand@malikania.fr>
7
45a06b02a61f misc: add missing files
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 .\"
45a06b02a61f misc: add missing files
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 .\" Permission to use, copy, modify, and/or distribute this software for any
45a06b02a61f misc: add missing files
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 .\" purpose with or without fee is hereby granted, provided that the above
45a06b02a61f misc: add missing files
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 .\" copyright notice and this permission notice appear in all copies.
45a06b02a61f misc: add missing files
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 .\"
45a06b02a61f misc: add missing files
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
45a06b02a61f misc: add missing files
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
45a06b02a61f misc: add missing files
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
45a06b02a61f misc: add missing files
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
45a06b02a61f misc: add missing files
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
45a06b02a61f misc: add missing files
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
45a06b02a61f misc: add missing files
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
45a06b02a61f misc: add missing files
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 .\"
45a06b02a61f misc: add missing files
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 .Dd September 16, 2019
45a06b02a61f misc: add missing files
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 .Dt BACKLIGHT 1
45a06b02a61f misc: add missing files
David Demelier <markand@malikania.fr>
parents:
diff changeset
18 .Os
45a06b02a61f misc: add missing files
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 .\" NAME
45a06b02a61f misc: add missing files
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 .Sh NAME
45a06b02a61f misc: add missing files
David Demelier <markand@malikania.fr>
parents:
diff changeset
21 .Nm backlight
14
df8639b5b248 doc: fix manual page
David Demelier <markand@malikania.fr>
parents: 7
diff changeset
22 .Nd adjust screen brightness
7
45a06b02a61f misc: add missing files
David Demelier <markand@malikania.fr>
parents:
diff changeset
23 .\" SYNOPSIS
45a06b02a61f misc: add missing files
David Demelier <markand@malikania.fr>
parents:
diff changeset
24 .Sh SYNOPSIS
45a06b02a61f misc: add missing files
David Demelier <markand@malikania.fr>
parents:
diff changeset
25 .Nm
15
282ec7c30c04 backlight: now supports more commands
David Demelier <markand@malikania.fr>
parents: 14
diff changeset
26 .Ar decrease
23
6081cc143d37 backlight: add OpenBSD support
David Demelier <markand@malikania.fr>
parents: 20
diff changeset
27 .Op Ar amount
15
282ec7c30c04 backlight: now supports more commands
David Demelier <markand@malikania.fr>
parents: 14
diff changeset
28 .Nm
282ec7c30c04 backlight: now supports more commands
David Demelier <markand@malikania.fr>
parents: 14
diff changeset
29 .Ar get
7
45a06b02a61f misc: add missing files
David Demelier <markand@malikania.fr>
parents:
diff changeset
30 .Nm
15
282ec7c30c04 backlight: now supports more commands
David Demelier <markand@malikania.fr>
parents: 14
diff changeset
31 .Ar increase
23
6081cc143d37 backlight: add OpenBSD support
David Demelier <markand@malikania.fr>
parents: 20
diff changeset
32 .Op Ar amount
15
282ec7c30c04 backlight: now supports more commands
David Demelier <markand@malikania.fr>
parents: 14
diff changeset
33 .Nm
282ec7c30c04 backlight: now supports more commands
David Demelier <markand@malikania.fr>
parents: 14
diff changeset
34 .Ar set
282ec7c30c04 backlight: now supports more commands
David Demelier <markand@malikania.fr>
parents: 14
diff changeset
35 .Ar percentage
7
45a06b02a61f misc: add missing files
David Demelier <markand@malikania.fr>
parents:
diff changeset
36 .\" DESCRIPTION
45a06b02a61f misc: add missing files
David Demelier <markand@malikania.fr>
parents:
diff changeset
37 .Sh DESCRIPTION
45a06b02a61f misc: add missing files
David Demelier <markand@malikania.fr>
parents:
diff changeset
38 The
45a06b02a61f misc: add missing files
David Demelier <markand@malikania.fr>
parents:
diff changeset
39 .Nm
45a06b02a61f misc: add missing files
David Demelier <markand@malikania.fr>
parents:
diff changeset
40 tool adjust the brightness on your screen using direct access to ACPI video
45a06b02a61f misc: add missing files
David Demelier <markand@malikania.fr>
parents:
diff changeset
41 extension.
45a06b02a61f misc: add missing files
David Demelier <markand@malikania.fr>
parents:
diff changeset
42 .Pp
15
282ec7c30c04 backlight: now supports more commands
David Demelier <markand@malikania.fr>
parents: 14
diff changeset
43 The following commands are available:
282ec7c30c04 backlight: now supports more commands
David Demelier <markand@malikania.fr>
parents: 14
diff changeset
44 .Bl -tag -width 10n
282ec7c30c04 backlight: now supports more commands
David Demelier <markand@malikania.fr>
parents: 14
diff changeset
45 .It Cm decrease
23
6081cc143d37 backlight: add OpenBSD support
David Demelier <markand@malikania.fr>
parents: 20
diff changeset
46 Decrease the specific
6081cc143d37 backlight: add OpenBSD support
David Demelier <markand@malikania.fr>
parents: 20
diff changeset
47 .Ar amount
6081cc143d37 backlight: add OpenBSD support
David Demelier <markand@malikania.fr>
parents: 20
diff changeset
48 percentage value (default: 10).
15
282ec7c30c04 backlight: now supports more commands
David Demelier <markand@malikania.fr>
parents: 14
diff changeset
49 .It Cm get
282ec7c30c04 backlight: now supports more commands
David Demelier <markand@malikania.fr>
parents: 14
diff changeset
50 Get the current level scaled to a percentage range.
282ec7c30c04 backlight: now supports more commands
David Demelier <markand@malikania.fr>
parents: 14
diff changeset
51 .It Cm increase
23
6081cc143d37 backlight: add OpenBSD support
David Demelier <markand@malikania.fr>
parents: 20
diff changeset
52 Increase the specific
6081cc143d37 backlight: add OpenBSD support
David Demelier <markand@malikania.fr>
parents: 20
diff changeset
53 .Ar amount
6081cc143d37 backlight: add OpenBSD support
David Demelier <markand@malikania.fr>
parents: 20
diff changeset
54 percentage value (default: 10).
15
282ec7c30c04 backlight: now supports more commands
David Demelier <markand@malikania.fr>
parents: 14
diff changeset
55 .It Cm set
282ec7c30c04 backlight: now supports more commands
David Demelier <markand@malikania.fr>
parents: 14
diff changeset
56 Set brightness to the
282ec7c30c04 backlight: now supports more commands
David Demelier <markand@malikania.fr>
parents: 14
diff changeset
57 .Ar percentage
282ec7c30c04 backlight: now supports more commands
David Demelier <markand@malikania.fr>
parents: 14
diff changeset
58 value.
282ec7c30c04 backlight: now supports more commands
David Demelier <markand@malikania.fr>
parents: 14
diff changeset
59 .El
16
0d923f0155dd doc: improve documentation
David Demelier <markand@malikania.fr>
parents: 15
diff changeset
60 .\" SYSTEM SUPPORT
0d923f0155dd doc: improve documentation
David Demelier <markand@malikania.fr>
parents: 15
diff changeset
61 .Sh SYSTEM SUPPORT
0d923f0155dd doc: improve documentation
David Demelier <markand@malikania.fr>
parents: 15
diff changeset
62 .Ss Linux
0d923f0155dd doc: improve documentation
David Demelier <markand@malikania.fr>
parents: 15
diff changeset
63 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
64 kernel.
0d923f0155dd doc: improve documentation
David Demelier <markand@malikania.fr>
parents: 15
diff changeset
65 .Pp
0d923f0155dd doc: improve documentation
David Demelier <markand@malikania.fr>
parents: 15
diff changeset
66 You may use
0d923f0155dd doc: improve documentation
David Demelier <markand@malikania.fr>
parents: 15
diff changeset
67 .Nm
0d923f0155dd doc: improve documentation
David Demelier <markand@malikania.fr>
parents: 15
diff changeset
68 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
69 .Pa /sys/class/backlight
0d923f0155dd doc: improve documentation
David Demelier <markand@malikania.fr>
parents: 15
diff changeset
70 writable by a group or per user.
19
0de3886f98ad misc: minor updates
David Demelier <markand@malikania.fr>
parents: 16
diff changeset
71 .Pp
0de3886f98ad misc: minor updates
David Demelier <markand@malikania.fr>
parents: 16
diff changeset
72 The source package comes with an example of udev rule that can be installed in
0de3886f98ad misc: minor updates
David Demelier <markand@malikania.fr>
parents: 16
diff changeset
73 .Pa /usr/lib/udev/rules.d .
16
0d923f0155dd doc: improve documentation
David Demelier <markand@malikania.fr>
parents: 15
diff changeset
74 .Ss FreeBSD
0d923f0155dd doc: improve documentation
David Demelier <markand@malikania.fr>
parents: 15
diff changeset
75 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
76 .Nm
0d923f0155dd doc: improve documentation
David Demelier <markand@malikania.fr>
parents: 15
diff changeset
77 as root or use setuid permission for non-root users.
0d923f0155dd doc: improve documentation
David Demelier <markand@malikania.fr>
parents: 15
diff changeset
78 .Pp
0d923f0155dd doc: improve documentation
David Demelier <markand@malikania.fr>
parents: 15
diff changeset
79 You also need to load
0d923f0155dd doc: improve documentation
David Demelier <markand@malikania.fr>
parents: 15
diff changeset
80 .Xr acpi_video 4
19
0de3886f98ad misc: minor updates
David Demelier <markand@malikania.fr>
parents: 16
diff changeset
81 module at boot by adding
20
232b390f1682 doc: minor typo
David Demelier <markand@malikania.fr>
parents: 19
diff changeset
82 .Sy acpi_video_load="YES"
232b390f1682 doc: minor typo
David Demelier <markand@malikania.fr>
parents: 19
diff changeset
83 in
19
0de3886f98ad misc: minor updates
David Demelier <markand@malikania.fr>
parents: 16
diff changeset
84 .Pa /boot/loader.conf .
23
6081cc143d37 backlight: add OpenBSD support
David Demelier <markand@malikania.fr>
parents: 20
diff changeset
85 .Ss OpenBSD
6081cc143d37 backlight: add OpenBSD support
David Demelier <markand@malikania.fr>
parents: 20
diff changeset
86 On OpenBSD, the device
6081cc143d37 backlight: add OpenBSD support
David Demelier <markand@malikania.fr>
parents: 20
diff changeset
87 .Pa /dev/ttyC0
6081cc143d37 backlight: add OpenBSD support
David Demelier <markand@malikania.fr>
parents: 20
diff changeset
88 must be writable in your user but this is normally the case when you login.
6081cc143d37 backlight: add OpenBSD support
David Demelier <markand@malikania.fr>
parents: 20
diff changeset
89 Otherwise you may simply run the program as root.
6081cc143d37 backlight: add OpenBSD support
David Demelier <markand@malikania.fr>
parents: 20
diff changeset
90 .Pp
6081cc143d37 backlight: add OpenBSD support
David Demelier <markand@malikania.fr>
parents: 20
diff changeset
91 Note: you may need to specify a bigger
6081cc143d37 backlight: add OpenBSD support
David Demelier <markand@malikania.fr>
parents: 20
diff changeset
92 .Ar amount
6081cc143d37 backlight: add OpenBSD support
David Demelier <markand@malikania.fr>
parents: 20
diff changeset
93 with the
6081cc143d37 backlight: add OpenBSD support
David Demelier <markand@malikania.fr>
parents: 20
diff changeset
94 .Cm increase, decrease
6081cc143d37 backlight: add OpenBSD support
David Demelier <markand@malikania.fr>
parents: 20
diff changeset
95 commands if your system use small percentages.
7
45a06b02a61f misc: add missing files
David Demelier <markand@malikania.fr>
parents:
diff changeset
96 .\" AUTHORS
45a06b02a61f misc: add missing files
David Demelier <markand@malikania.fr>
parents:
diff changeset
97 .Sh AUTHORS
45a06b02a61f misc: add missing files
David Demelier <markand@malikania.fr>
parents:
diff changeset
98 .Nm
45a06b02a61f misc: add missing files
David Demelier <markand@malikania.fr>
parents:
diff changeset
99 was written by David Demelier <markand@malikania.fr>