xref: /freebsd/usr.bin/backlight/backlight.8 (revision 5c3e4249589dc5452b738aea13a32e8b11082808)
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.\"
25*5c3e4249SMateusz 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*5c3e4249SMateusz Piotrowski.Op Fl iq
349ddaa99dSEmmanuel Vadot.Op Fl f Ar device
359ddaa99dSEmmanuel Vadot.Op Ar value
369ddaa99dSEmmanuel Vadot.Nm
379ddaa99dSEmmanuel Vadot.Op Fl f Ar device
38790c70c8SMateusz Piotrowski.Cm incr Ns | Ns Cm +
399ddaa99dSEmmanuel Vadot.Op Ar value
409ddaa99dSEmmanuel Vadot.Nm
419ddaa99dSEmmanuel Vadot.Op Fl f Ar device
42790c70c8SMateusz Piotrowski.Cm decr Ns | Ns Cm -
439ddaa99dSEmmanuel Vadot.Op Ar value
449ddaa99dSEmmanuel Vadot.Sh DESCRIPTION
459ddaa99dSEmmanuel VadotThe
469ddaa99dSEmmanuel Vadot.Nm
47790c70c8SMateusz Piotrowskiutility can be used to configure brightness levels for registered backlights.
489ddaa99dSEmmanuel Vadot.Pp
49b8e12d2dSBrad DavisCalled without any arguments it will print the current brightness level
50b8e12d2dSBrad Davisof the first registered backlight.
511df30489SEmmanuel Vadot.Pp
529ddaa99dSEmmanuel VadotThe options are as follows:
539ddaa99dSEmmanuel Vadot.Bl -tag -width "-f device"
549ddaa99dSEmmanuel Vadot.It Fl f Ar device
559ddaa99dSEmmanuel VadotDevice to operate on.
569ddaa99dSEmmanuel VadotIf not specified,
579ddaa99dSEmmanuel Vadot.Pa /dev/backlight/backlight0
589ddaa99dSEmmanuel Vadotis used.
599ddaa99dSEmmanuel VadotIf an unqualified name is provided,
602f60a7f9SMateusz Piotrowski.Pa /dev/backlight/
619ddaa99dSEmmanuel Vadotis automatically prepended.
629ddaa99dSEmmanuel Vadot.It Fl i
639ddaa99dSEmmanuel VadotQuery information about the backlight (name, type).
64790c70c8SMateusz Piotrowski.It Fl q
65790c70c8SMateusz PiotrowskiWhen querying the brightness level only print the value.
669ddaa99dSEmmanuel Vadot.It Ar value
679ddaa99dSEmmanuel VadotSet the brightness level to this value, must be between 0 and 100.
68790c70c8SMateusz PiotrowskiA trailing
69790c70c8SMateusz Piotrowski.Dq %
70790c70c8SMateusz Piotrowskiis valid.
71790c70c8SMateusz Piotrowski.It Cm incr Ns | Ns Cm + Op Ar value
729ddaa99dSEmmanuel VadotDecrement the backlight level.
739ddaa99dSEmmanuel VadotIf no value is specified a default of 10 percent is used.
74790c70c8SMateusz Piotrowski.It Cm decr Ns | Ns Cm - Op Ar value
759ddaa99dSEmmanuel VadotIncrement the backlight level.
769ddaa99dSEmmanuel VadotIf no value is specified a default of 10 percent is used.
779ddaa99dSEmmanuel Vadot.El
789ddaa99dSEmmanuel Vadot.Sh EXAMPLES
79*5c3e4249SMateusz PiotrowskiShow the current brightness level:
80790c70c8SMateusz Piotrowski.Bd -literal -offset indent
81*5c3e4249SMateusz Piotrowski$ backlight -f /dev/backlight/backlight0
82*5c3e4249SMateusz Piotrowskibrightness: 98
839ddaa99dSEmmanuel Vadot.Ed
849ddaa99dSEmmanuel Vadot.Sh SEE ALSO
859ddaa99dSEmmanuel Vadot.Xr backlight 9
869ddaa99dSEmmanuel Vadot.Sh HISTORY
879ddaa99dSEmmanuel VadotThe
889ddaa99dSEmmanuel Vadot.Nm
899ddaa99dSEmmanuel Vadotutility appeared in
909ddaa99dSEmmanuel Vadot.Fx 13.0 .
919ddaa99dSEmmanuel Vadot.Sh AUTHORS
929ddaa99dSEmmanuel Vadot.An -nosplit
939ddaa99dSEmmanuel VadotThe
949ddaa99dSEmmanuel Vadot.Nm
959ddaa99dSEmmanuel Vadotutility and this manual page were written by
969ddaa99dSEmmanuel Vadot.An Emmanuel Vadot Aq Mt manu@FreeBSD.org .
97