d/freebsd-skq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
master
freebsd-skq/usr.bin/backlight/backlight.8

97 lines
2.8 KiB
Groff
Raw Permalink Normal View History

Add backlight(8) This tool is used to configure registered backlights. It can incr/decr (default to 10%) or accept a percentage value directly. Reviewed by: manpages (gbe@) Relnotes: yes Sponsored by: The FreeBSD Foundation Differential Revision: https://reviews.freebsd.org/D26251
2020-10-02 18:21:30 +00:00
.\" Copyright (c) 2020 Emmanuel Vadot <manu@freebsd.org>
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
backlight(8): Add note that with option it print the current brightness. MFC after: 3 days PR: 253737
2021-03-03 08:00:42 +00:00
.Dd March 03, 2021
Add backlight(8) This tool is used to configure registered backlights. It can incr/decr (default to 10%) or accept a percentage value directly. Reviewed by: manpages (gbe@) Relnotes: yes Sponsored by: The FreeBSD Foundation Differential Revision: https://reviews.freebsd.org/D26251
2020-10-02 18:21:30 +00:00
.Dt BACKLIGHT 8
.Os
.Sh NAME
.Nm backlight
.Nd configure backlight hardware
.Sh SYNOPSIS
.Nm
.Op Fl f Ar device
.Op Fl i
Clean up backlight.8 - Sort flags - Stylize incr|+ and decr|- properly - Add a missing period at the end of the description - Use the standard layout for the EXAMPLES section (remove the list macro and add indentation to the code block)
2020-10-27 09:41:01 +00:00
.Op Fl q
Add backlight(8) This tool is used to configure registered backlights. It can incr/decr (default to 10%) or accept a percentage value directly. Reviewed by: manpages (gbe@) Relnotes: yes Sponsored by: The FreeBSD Foundation Differential Revision: https://reviews.freebsd.org/D26251
2020-10-02 18:21:30 +00:00
.Op Ar value
.Nm
.Op Fl f Ar device
Clean up backlight.8 - Sort flags - Stylize incr|+ and decr|- properly - Add a missing period at the end of the description - Use the standard layout for the EXAMPLES section (remove the list macro and add indentation to the code block)
2020-10-27 09:41:01 +00:00
.Cm incr Ns | Ns Cm +
Add backlight(8) This tool is used to configure registered backlights. It can incr/decr (default to 10%) or accept a percentage value directly. Reviewed by: manpages (gbe@) Relnotes: yes Sponsored by: The FreeBSD Foundation Differential Revision: https://reviews.freebsd.org/D26251
2020-10-02 18:21:30 +00:00
.Op Ar value
.Nm
.Op Fl f Ar device
Clean up backlight.8 - Sort flags - Stylize incr|+ and decr|- properly - Add a missing period at the end of the description - Use the standard layout for the EXAMPLES section (remove the list macro and add indentation to the code block)
2020-10-27 09:41:01 +00:00
.Cm decr Ns | Ns Cm -
Add backlight(8) This tool is used to configure registered backlights. It can incr/decr (default to 10%) or accept a percentage value directly. Reviewed by: manpages (gbe@) Relnotes: yes Sponsored by: The FreeBSD Foundation Differential Revision: https://reviews.freebsd.org/D26251
2020-10-02 18:21:30 +00:00
.Op Ar value
.Sh DESCRIPTION
The
.Nm
Clean up backlight.8 - Sort flags - Stylize incr|+ and decr|- properly - Add a missing period at the end of the description - Use the standard layout for the EXAMPLES section (remove the list macro and add indentation to the code block)
2020-10-27 09:41:01 +00:00
utility can be used to configure brightness levels for registered backlights.
Add backlight(8) This tool is used to configure registered backlights. It can incr/decr (default to 10%) or accept a percentage value directly. Reviewed by: manpages (gbe@) Relnotes: yes Sponsored by: The FreeBSD Foundation Differential Revision: https://reviews.freebsd.org/D26251
2020-10-02 18:21:30 +00:00
.Pp
Improve the wording for showing the brightness level Reviewed by: allanjude
2021-03-12 16:43:33 +00:00
Called without any arguments it will print the current brightness level
of the first registered backlight.
backlight(8): Add note that with option it print the current brightness. MFC after: 3 days PR: 253737
2021-03-03 08:00:42 +00:00
.Pp
Add backlight(8) This tool is used to configure registered backlights. It can incr/decr (default to 10%) or accept a percentage value directly. Reviewed by: manpages (gbe@) Relnotes: yes Sponsored by: The FreeBSD Foundation Differential Revision: https://reviews.freebsd.org/D26251
2020-10-02 18:21:30 +00:00
The options are as follows:
.Bl -tag -width "-f device"
.It Fl f Ar device
Device to operate on.
If not specified,
.Pa /dev/backlight/backlight0
is used.
If an unqualified name is provided,
.Pa /dev/backlight
is automatically prepended.
.It Fl i
Query information about the backlight (name, type).
Clean up backlight.8 - Sort flags - Stylize incr|+ and decr|- properly - Add a missing period at the end of the description - Use the standard layout for the EXAMPLES section (remove the list macro and add indentation to the code block)
2020-10-27 09:41:01 +00:00
.It Fl q
When querying the brightness level only print the value.
Add backlight(8) This tool is used to configure registered backlights. It can incr/decr (default to 10%) or accept a percentage value directly. Reviewed by: manpages (gbe@) Relnotes: yes Sponsored by: The FreeBSD Foundation Differential Revision: https://reviews.freebsd.org/D26251
2020-10-02 18:21:30 +00:00
.It Ar value
Set the brightness level to this value, must be between 0 and 100.
Clean up backlight.8 - Sort flags - Stylize incr|+ and decr|- properly - Add a missing period at the end of the description - Use the standard layout for the EXAMPLES section (remove the list macro and add indentation to the code block)
2020-10-27 09:41:01 +00:00
A trailing
.Dq %
is valid.
.It Cm incr Ns | Ns Cm + Op Ar value
Add backlight(8) This tool is used to configure registered backlights. It can incr/decr (default to 10%) or accept a percentage value directly. Reviewed by: manpages (gbe@) Relnotes: yes Sponsored by: The FreeBSD Foundation Differential Revision: https://reviews.freebsd.org/D26251
2020-10-02 18:21:30 +00:00
Decrement the backlight level.
If no value is specified a default of 10 percent is used.
Clean up backlight.8 - Sort flags - Stylize incr|+ and decr|- properly - Add a missing period at the end of the description - Use the standard layout for the EXAMPLES section (remove the list macro and add indentation to the code block)
2020-10-27 09:41:01 +00:00
.It Cm decr Ns | Ns Cm - Op Ar value
Add backlight(8) This tool is used to configure registered backlights. It can incr/decr (default to 10%) or accept a percentage value directly. Reviewed by: manpages (gbe@) Relnotes: yes Sponsored by: The FreeBSD Foundation Differential Revision: https://reviews.freebsd.org/D26251
2020-10-02 18:21:30 +00:00
Increment the backlight level.
If no value is specified a default of 10 percent is used.
.El
.Sh EXAMPLES
Show the current brightness level
Clean up backlight.8 - Sort flags - Stylize incr|+ and decr|- properly - Add a missing period at the end of the description - Use the standard layout for the EXAMPLES section (remove the list macro and add indentation to the code block)
2020-10-27 09:41:01 +00:00
.Bd -literal -offset indent
Add backlight(8) This tool is used to configure registered backlights. It can incr/decr (default to 10%) or accept a percentage value directly. Reviewed by: manpages (gbe@) Relnotes: yes Sponsored by: The FreeBSD Foundation Differential Revision: https://reviews.freebsd.org/D26251
2020-10-02 18:21:30 +00:00
backlight -f /dev/backlight/backlight0
.Ed
.Sh SEE ALSO
.Xr backlight 9
.Sh HISTORY
The
.Nm
utility appeared in
.Fx 13.0 .
.Sh AUTHORS
.An -nosplit
The
.Nm
utility and this manual page were written by
.An Emmanuel Vadot Aq Mt manu@FreeBSD.org .
Reference in New Issue Copy Permalink