xref: /freebsd/usr.bin/backlight/backlight.8 (revision a4bcd20486f8c20cc875b39bc75aa0d5a047373f)
1.\" Copyright (c) 2020 Emmanuel Vadot <manu@freebsd.org>
2.\"
3.\" Redistribution and use in source and binary forms, with or without
4.\" modification, are permitted provided that the following conditions
5.\" are met:
6.\" 1. Redistributions of source code must retain the above copyright
7.\"    notice, this list of conditions and the following disclaimer.
8.\" 2. Redistributions in binary form must reproduce the above copyright
9.\"    notice, this list of conditions and the following disclaimer in the
10.\"    documentation and/or other materials provided with the distribution.
11.\"
12.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
13.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
14.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
15.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
16.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
17.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
18.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
19.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
20.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
21.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
22.\"
23.\" $FreeBSD$
24.\"
25.Dd October 06, 2020
26.Dt BACKLIGHT 8
27.Os
28.Sh NAME
29.Nm backlight
30.Nd configure backlight hardware
31.Sh SYNOPSIS
32.Nm
33.Op Fl f Ar device
34.Op Fl q
35.Op Fl i
36.Op Ar value
37.Nm
38.Op Fl f Ar device
39incr | +
40.Op Ar value
41.Nm
42.Op Fl f Ar device
43decr | -
44.Op Ar value
45.Sh DESCRIPTION
46The
47.Nm
48utility can be used to configure brightness levels for registered backlights
49.Pp
50The options are as follows:
51.Bl -tag -width "-f device"
52.It Fl f Ar device
53Device to operate on.
54If not specified,
55.Pa /dev/backlight/backlight0
56is used.
57If an unqualified name is provided,
58.Pa /dev/backlight
59is automatically prepended.
60.It Fl q
61When querying the brightness level only print the value.
62.It Fl i
63Query information about the backlight (name, type).
64.It Ar value
65Set the brightness level to this value, must be between 0 and 100.
66A trailing '%' is valid.
67.It Ar incr | +
68.Op Ar value
69Decrement the backlight level.
70If no value is specified a default of 10 percent is used.
71.It Ar decr | -
72.Op Ar value
73Increment the backlight level.
74If no value is specified a default of 10 percent is used.
75.El
76.Sh EXAMPLES
77.Bl -bullet
78.It
79Show the current brightness level
80.Bd -literal
81backlight -f /dev/backlight/backlight0
82.Ed
83.El
84.Sh SEE ALSO
85.Xr backlight 9
86.Sh HISTORY
87The
88.Nm
89utility appeared in
90.Fx 13.0 .
91.Sh AUTHORS
92.An -nosplit
93The
94.Nm
95utility and this manual page were written by
96.An Emmanuel Vadot Aq Mt manu@FreeBSD.org .
97