xref: /freebsd/usr.bin/backlight/backlight.8 (revision 64a231b90b03037c63bd2c7e51f1c67591016350)
19ddaa99dSEmmanuel Vadot.\" Copyright (c) 2020 Emmanuel Vadot <manu@freebsd.org>
29ddaa99dSEmmanuel Vadot.\"
39ddaa99dSEmmanuel Vadot.\" Redistribution and use in source and binary forms, with or without
49ddaa99dSEmmanuel Vadot.\" modification, are permitted provided that the following conditions
59ddaa99dSEmmanuel Vadot.\" are met:
69ddaa99dSEmmanuel Vadot.\" 1. Redistributions of source code must retain the above copyright
79ddaa99dSEmmanuel Vadot.\"    notice, this list of conditions and the following disclaimer.
89ddaa99dSEmmanuel Vadot.\" 2. Redistributions in binary form must reproduce the above copyright
99ddaa99dSEmmanuel Vadot.\"    notice, this list of conditions and the following disclaimer in the
109ddaa99dSEmmanuel Vadot.\"    documentation and/or other materials provided with the distribution.
119ddaa99dSEmmanuel Vadot.\"
129ddaa99dSEmmanuel Vadot.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
139ddaa99dSEmmanuel Vadot.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
149ddaa99dSEmmanuel Vadot.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
159ddaa99dSEmmanuel Vadot.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
169ddaa99dSEmmanuel Vadot.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
179ddaa99dSEmmanuel Vadot.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
189ddaa99dSEmmanuel Vadot.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
199ddaa99dSEmmanuel Vadot.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
209ddaa99dSEmmanuel Vadot.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
219ddaa99dSEmmanuel Vadot.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
229ddaa99dSEmmanuel Vadot.\"
239ddaa99dSEmmanuel Vadot.\" $FreeBSD$
249ddaa99dSEmmanuel Vadot.\"
255c3e4249SMateusz Piotrowski.Dd July 19, 2022
269ddaa99dSEmmanuel Vadot.Dt BACKLIGHT 8
279ddaa99dSEmmanuel Vadot.Os
289ddaa99dSEmmanuel Vadot.Sh NAME
299ddaa99dSEmmanuel Vadot.Nm backlight
309ddaa99dSEmmanuel Vadot.Nd configure backlight hardware
319ddaa99dSEmmanuel Vadot.Sh SYNOPSIS
329ddaa99dSEmmanuel Vadot.Nm
33*64a231b9SMateusz Piotrowski.Op Fl q
349ddaa99dSEmmanuel Vadot.Op Fl f Ar device
35*64a231b9SMateusz Piotrowski.Nm
36*64a231b9SMateusz Piotrowski.Op Fl q
37*64a231b9SMateusz Piotrowski.Op Fl f Ar device
38*64a231b9SMateusz Piotrowski.Fl i
39*64a231b9SMateusz Piotrowski.Nm
40*64a231b9SMateusz Piotrowski.Op Fl f Ar device
41*64a231b9SMateusz Piotrowski.Ar value
429ddaa99dSEmmanuel Vadot.Nm
439ddaa99dSEmmanuel Vadot.Op Fl f Ar device
44790c70c8SMateusz Piotrowski.Cm incr Ns | Ns Cm +
459ddaa99dSEmmanuel Vadot.Op Ar value
469ddaa99dSEmmanuel Vadot.Nm
479ddaa99dSEmmanuel Vadot.Op Fl f Ar device
48790c70c8SMateusz Piotrowski.Cm decr Ns | Ns Cm -
499ddaa99dSEmmanuel Vadot.Op Ar value
509ddaa99dSEmmanuel Vadot.Sh DESCRIPTION
519ddaa99dSEmmanuel VadotThe
529ddaa99dSEmmanuel Vadot.Nm
53790c70c8SMateusz Piotrowskiutility can be used to configure brightness levels for registered backlights.
549ddaa99dSEmmanuel Vadot.Pp
55b8e12d2dSBrad DavisCalled without any arguments it will print the current brightness level
56b8e12d2dSBrad Davisof the first registered backlight.
571df30489SEmmanuel Vadot.Pp
589ddaa99dSEmmanuel VadotThe options are as follows:
599ddaa99dSEmmanuel Vadot.Bl -tag -width "-f device"
609ddaa99dSEmmanuel Vadot.It Fl f Ar device
619ddaa99dSEmmanuel VadotDevice to operate on.
629ddaa99dSEmmanuel VadotIf not specified,
639ddaa99dSEmmanuel Vadot.Pa /dev/backlight/backlight0
649ddaa99dSEmmanuel Vadotis used.
659ddaa99dSEmmanuel VadotIf an unqualified name is provided,
662f60a7f9SMateusz Piotrowski.Pa /dev/backlight/
679ddaa99dSEmmanuel Vadotis automatically prepended.
689ddaa99dSEmmanuel Vadot.It Fl i
699ddaa99dSEmmanuel VadotQuery information about the backlight (name, type).
70790c70c8SMateusz Piotrowski.It Fl q
71790c70c8SMateusz PiotrowskiWhen querying the brightness level only print the value.
729ddaa99dSEmmanuel Vadot.It Ar value
739ddaa99dSEmmanuel VadotSet the brightness level to this value, must be between 0 and 100.
74790c70c8SMateusz PiotrowskiA trailing
75790c70c8SMateusz Piotrowski.Dq %
76790c70c8SMateusz Piotrowskiis valid.
77790c70c8SMateusz Piotrowski.It Cm incr Ns | Ns Cm + Op Ar value
789ddaa99dSEmmanuel VadotDecrement the backlight level.
799ddaa99dSEmmanuel VadotIf no value is specified a default of 10 percent is used.
80790c70c8SMateusz Piotrowski.It Cm decr Ns | Ns Cm - Op Ar value
819ddaa99dSEmmanuel VadotIncrement the backlight level.
829ddaa99dSEmmanuel VadotIf no value is specified a default of 10 percent is used.
839ddaa99dSEmmanuel Vadot.El
849ddaa99dSEmmanuel Vadot.Sh EXAMPLES
855c3e4249SMateusz PiotrowskiShow the current brightness level:
86790c70c8SMateusz Piotrowski.Bd -literal -offset indent
875c3e4249SMateusz Piotrowski$ backlight -f /dev/backlight/backlight0
885c3e4249SMateusz Piotrowskibrightness: 98
899ddaa99dSEmmanuel Vadot.Ed
909ddaa99dSEmmanuel Vadot.Sh SEE ALSO
919ddaa99dSEmmanuel Vadot.Xr backlight 9
929ddaa99dSEmmanuel Vadot.Sh HISTORY
939ddaa99dSEmmanuel VadotThe
949ddaa99dSEmmanuel Vadot.Nm
959ddaa99dSEmmanuel Vadotutility appeared in
969ddaa99dSEmmanuel Vadot.Fx 13.0 .
979ddaa99dSEmmanuel Vadot.Sh AUTHORS
989ddaa99dSEmmanuel Vadot.An -nosplit
999ddaa99dSEmmanuel VadotThe
1009ddaa99dSEmmanuel Vadot.Nm
1019ddaa99dSEmmanuel Vadotutility and this manual page were written by
1029ddaa99dSEmmanuel Vadot.An Emmanuel Vadot Aq Mt manu@FreeBSD.org .
103