xref: /freebsd/usr.bin/backlight/backlight.8 (revision 790c70c8258cfe2f4458be1a83df83b9af5296d0)
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*790c70c8SMateusz Piotrowski.Dd October 27, 2020
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
339ddaa99dSEmmanuel Vadot.Op Fl f Ar device
349ddaa99dSEmmanuel Vadot.Op Fl i
35*790c70c8SMateusz Piotrowski.Op Fl q
369ddaa99dSEmmanuel Vadot.Op Ar value
379ddaa99dSEmmanuel Vadot.Nm
389ddaa99dSEmmanuel Vadot.Op Fl f Ar device
39*790c70c8SMateusz Piotrowski.Cm incr Ns | Ns Cm +
409ddaa99dSEmmanuel Vadot.Op Ar value
419ddaa99dSEmmanuel Vadot.Nm
429ddaa99dSEmmanuel Vadot.Op Fl f Ar device
43*790c70c8SMateusz Piotrowski.Cm decr Ns | Ns Cm -
449ddaa99dSEmmanuel Vadot.Op Ar value
459ddaa99dSEmmanuel Vadot.Sh DESCRIPTION
469ddaa99dSEmmanuel VadotThe
479ddaa99dSEmmanuel Vadot.Nm
48*790c70c8SMateusz Piotrowskiutility can be used to configure brightness levels for registered backlights.
499ddaa99dSEmmanuel Vadot.Pp
509ddaa99dSEmmanuel VadotThe options are as follows:
519ddaa99dSEmmanuel Vadot.Bl -tag -width "-f device"
529ddaa99dSEmmanuel Vadot.It Fl f Ar device
539ddaa99dSEmmanuel VadotDevice to operate on.
549ddaa99dSEmmanuel VadotIf not specified,
559ddaa99dSEmmanuel Vadot.Pa /dev/backlight/backlight0
569ddaa99dSEmmanuel Vadotis used.
579ddaa99dSEmmanuel VadotIf an unqualified name is provided,
589ddaa99dSEmmanuel Vadot.Pa /dev/backlight
599ddaa99dSEmmanuel Vadotis automatically prepended.
609ddaa99dSEmmanuel Vadot.It Fl i
619ddaa99dSEmmanuel VadotQuery information about the backlight (name, type).
62*790c70c8SMateusz Piotrowski.It Fl q
63*790c70c8SMateusz PiotrowskiWhen querying the brightness level only print the value.
649ddaa99dSEmmanuel Vadot.It Ar value
659ddaa99dSEmmanuel VadotSet the brightness level to this value, must be between 0 and 100.
66*790c70c8SMateusz PiotrowskiA trailing
67*790c70c8SMateusz Piotrowski.Dq %
68*790c70c8SMateusz Piotrowskiis valid.
69*790c70c8SMateusz Piotrowski.It Cm incr Ns | Ns Cm + Op Ar value
709ddaa99dSEmmanuel VadotDecrement the backlight level.
719ddaa99dSEmmanuel VadotIf no value is specified a default of 10 percent is used.
72*790c70c8SMateusz Piotrowski.It Cm decr Ns | Ns Cm - Op Ar value
739ddaa99dSEmmanuel VadotIncrement the backlight level.
749ddaa99dSEmmanuel VadotIf no value is specified a default of 10 percent is used.
759ddaa99dSEmmanuel Vadot.El
769ddaa99dSEmmanuel Vadot.Sh EXAMPLES
779ddaa99dSEmmanuel VadotShow the current brightness level
78*790c70c8SMateusz Piotrowski.Bd -literal -offset indent
799ddaa99dSEmmanuel Vadotbacklight -f /dev/backlight/backlight0
809ddaa99dSEmmanuel Vadot.Ed
819ddaa99dSEmmanuel Vadot.Sh SEE ALSO
829ddaa99dSEmmanuel Vadot.Xr backlight 9
839ddaa99dSEmmanuel Vadot.Sh HISTORY
849ddaa99dSEmmanuel VadotThe
859ddaa99dSEmmanuel Vadot.Nm
869ddaa99dSEmmanuel Vadotutility appeared in
879ddaa99dSEmmanuel Vadot.Fx 13.0 .
889ddaa99dSEmmanuel Vadot.Sh AUTHORS
899ddaa99dSEmmanuel Vadot.An -nosplit
909ddaa99dSEmmanuel VadotThe
919ddaa99dSEmmanuel Vadot.Nm
929ddaa99dSEmmanuel Vadotutility and this manual page were written by
939ddaa99dSEmmanuel Vadot.An Emmanuel Vadot Aq Mt manu@FreeBSD.org .
94