xref: /freebsd/usr.bin/backlight/backlight.8 (revision fa9896e082a1046ff4fbc75fcba4d18d1f2efc19)
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.\"
235c3e4249SMateusz Piotrowski.Dd July 19, 2022
249ddaa99dSEmmanuel Vadot.Dt BACKLIGHT 8
259ddaa99dSEmmanuel Vadot.Os
269ddaa99dSEmmanuel Vadot.Sh NAME
279ddaa99dSEmmanuel Vadot.Nm backlight
289ddaa99dSEmmanuel Vadot.Nd configure backlight hardware
299ddaa99dSEmmanuel Vadot.Sh SYNOPSIS
309ddaa99dSEmmanuel Vadot.Nm
31*64a231b9SMateusz Piotrowski.Op Fl q
329ddaa99dSEmmanuel Vadot.Op Fl f Ar device
33*64a231b9SMateusz Piotrowski.Nm
34*64a231b9SMateusz Piotrowski.Op Fl q
35*64a231b9SMateusz Piotrowski.Op Fl f Ar device
36*64a231b9SMateusz Piotrowski.Fl i
37*64a231b9SMateusz Piotrowski.Nm
38*64a231b9SMateusz Piotrowski.Op Fl f Ar device
39*64a231b9SMateusz Piotrowski.Ar value
409ddaa99dSEmmanuel Vadot.Nm
419ddaa99dSEmmanuel Vadot.Op Fl f Ar device
42790c70c8SMateusz Piotrowski.Cm incr Ns | Ns Cm +
439ddaa99dSEmmanuel Vadot.Op Ar value
449ddaa99dSEmmanuel Vadot.Nm
459ddaa99dSEmmanuel Vadot.Op Fl f Ar device
46790c70c8SMateusz Piotrowski.Cm decr Ns | Ns Cm -
479ddaa99dSEmmanuel Vadot.Op Ar value
489ddaa99dSEmmanuel Vadot.Sh DESCRIPTION
499ddaa99dSEmmanuel VadotThe
509ddaa99dSEmmanuel Vadot.Nm
51790c70c8SMateusz Piotrowskiutility can be used to configure brightness levels for registered backlights.
529ddaa99dSEmmanuel Vadot.Pp
53b8e12d2dSBrad DavisCalled without any arguments it will print the current brightness level
54b8e12d2dSBrad Davisof the first registered backlight.
551df30489SEmmanuel Vadot.Pp
569ddaa99dSEmmanuel VadotThe options are as follows:
579ddaa99dSEmmanuel Vadot.Bl -tag -width "-f device"
589ddaa99dSEmmanuel Vadot.It Fl f Ar device
599ddaa99dSEmmanuel VadotDevice to operate on.
609ddaa99dSEmmanuel VadotIf not specified,
619ddaa99dSEmmanuel Vadot.Pa /dev/backlight/backlight0
629ddaa99dSEmmanuel Vadotis used.
639ddaa99dSEmmanuel VadotIf an unqualified name is provided,
642f60a7f9SMateusz Piotrowski.Pa /dev/backlight/
659ddaa99dSEmmanuel Vadotis automatically prepended.
669ddaa99dSEmmanuel Vadot.It Fl i
679ddaa99dSEmmanuel VadotQuery information about the backlight (name, type).
68790c70c8SMateusz Piotrowski.It Fl q
69790c70c8SMateusz PiotrowskiWhen querying the brightness level only print the value.
709ddaa99dSEmmanuel Vadot.It Ar value
719ddaa99dSEmmanuel VadotSet the brightness level to this value, must be between 0 and 100.
72790c70c8SMateusz PiotrowskiA trailing
73790c70c8SMateusz Piotrowski.Dq %
74790c70c8SMateusz Piotrowskiis valid.
75790c70c8SMateusz Piotrowski.It Cm incr Ns | Ns Cm + Op Ar value
769ddaa99dSEmmanuel VadotDecrement the backlight level.
779ddaa99dSEmmanuel VadotIf no value is specified a default of 10 percent is used.
78790c70c8SMateusz Piotrowski.It Cm decr Ns | Ns Cm - Op Ar value
799ddaa99dSEmmanuel VadotIncrement the backlight level.
809ddaa99dSEmmanuel VadotIf no value is specified a default of 10 percent is used.
819ddaa99dSEmmanuel Vadot.El
829ddaa99dSEmmanuel Vadot.Sh EXAMPLES
835c3e4249SMateusz PiotrowskiShow the current brightness level:
84790c70c8SMateusz Piotrowski.Bd -literal -offset indent
855c3e4249SMateusz Piotrowski$ backlight -f /dev/backlight/backlight0
865c3e4249SMateusz Piotrowskibrightness: 98
879ddaa99dSEmmanuel Vadot.Ed
889ddaa99dSEmmanuel Vadot.Sh SEE ALSO
899ddaa99dSEmmanuel Vadot.Xr backlight 9
909ddaa99dSEmmanuel Vadot.Sh HISTORY
919ddaa99dSEmmanuel VadotThe
929ddaa99dSEmmanuel Vadot.Nm
939ddaa99dSEmmanuel Vadotutility appeared in
949ddaa99dSEmmanuel Vadot.Fx 13.0 .
959ddaa99dSEmmanuel Vadot.Sh AUTHORS
969ddaa99dSEmmanuel Vadot.An -nosplit
979ddaa99dSEmmanuel VadotThe
989ddaa99dSEmmanuel Vadot.Nm
999ddaa99dSEmmanuel Vadotutility and this manual page were written by
1009ddaa99dSEmmanuel Vadot.An Emmanuel Vadot Aq Mt manu@FreeBSD.org .
101