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