Merge pull request #16505 from yuwata/network-manage-foreign-routes-cleanups

[thirdparty/systemd.git] / man / systemd-backlight@.service.xml

diff --git a/man/systemd-backlight@.service.xml b/man/systemd-backlight@.service.xml
index 6d26d4b2edda2a0b19999b854ae8bb9e1d3b70b8..6e836d6921bfa8b9472f723e5ac271f32a5be170 100644 (file)
--- a/man/systemd-backlight@.service.xml
+++ b/man/systemd-backlight@.service.xml
@@ -1,71 +1,69 @@
 <?xml version="1.0"?>
 <!--*-nxml-*-->
-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
-<!--
-  This file is part of systemd.
-
-  Copyright 2013 Lennart Poettering
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
+  "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
+<!-- SPDX-License-Identifier: LGPL-2.1+ -->
+<refentry id="systemd-backlight@.service" conditional='ENABLE_BACKLIGHT'>
 
-  systemd is free software; you can redistribute it and/or modify it
-  under the terms of the GNU Lesser General Public License as published by
-  the Free Software Foundation; either version 2.1 of the License, or
-  (at your option) any later version.
+  <refentryinfo>
+    <title>systemd-backlight@.service</title>
+    <productname>systemd</productname>
+  </refentryinfo>
 
-  systemd is distributed in the hope that it will be useful, but
-  WITHOUT ANY WARRANTY; without even the implied warranty of
-  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
-  Lesser General Public License for more details.
+  <refmeta>
+    <refentrytitle>systemd-backlight@.service</refentrytitle>
+    <manvolnum>8</manvolnum>
+  </refmeta>
 
-  You should have received a copy of the GNU Lesser General Public License
-  along with systemd; If not, see <http://www.gnu.org/licenses/>.
--->
-<refentry id="systemd-backlight@.service" conditional='ENABLE_BACKLIGHT'>
+  <refnamediv>
+    <refname>systemd-backlight@.service</refname>
+    <refname>systemd-backlight</refname>
+    <refpurpose>Load and save the display backlight brightness at boot and shutdown</refpurpose>
+  </refnamediv>
 
-        <refentryinfo>
-                <title>systemd-backlight@.service</title>
-                <productname>systemd</productname>
+  <refsynopsisdiv>
+    <para><filename>systemd-backlight@.service</filename></para>
+    <para><filename>/usr/lib/systemd/systemd-backlight</filename></para>
+  </refsynopsisdiv>
 
-                <authorgroup>
-                        <author>
-                                <contrib>Developer</contrib>
-                                <firstname>Lennart</firstname>
-                                <surname>Poettering</surname>
-                                <email>lennart@poettering.net</email>
-                        </author>
-                </authorgroup>
-        </refentryinfo>
+  <refsect1>
+    <title>Description</title>
 
-        <refmeta>
-                <refentrytitle>systemd-backlight@.service</refentrytitle>
-                <manvolnum>8</manvolnum>
-        </refmeta>
+    <para><filename>systemd-backlight@.service</filename> is a service
+    that restores the display backlight brightness at early boot and
+    saves it at shutdown. On disk, the backlight brightness is stored
+    in <filename>/var/lib/systemd/backlight/</filename>. During
+    loading, if the udev property <option>ID_BACKLIGHT_CLAMP</option> is
+    not set to false, the brightness is clamped to a value of at
+    least 1 or 5% of maximum brightness, whichever is greater. This
+    restriction will be removed when the kernel allows user space to
+    reliably set a brightness value which does not turn off the
+    display.</para>
+  </refsect1>
 
-        <refnamediv>
-                <refname>systemd-backlight@.service</refname>
-                <refname>systemd-backlight</refname>
-                <refpurpose>Load and save the display backlight brightness at boot and shutdown</refpurpose>
-        </refnamediv>
+  <refsect1>
+    <title>Kernel Command Line</title>
 
-        <refsynopsisdiv>
-                <para><filename>systemd-backlight@.service</filename></para>
-                <para><filename>/usr/lib/systemd/systemd-backlight</filename></para>
-        </refsynopsisdiv>
+    <para><filename>systemd-backlight</filename> understands the
+    following kernel command line parameter:</para>
 
-        <refsect1>
-                <title>Description</title>
+    <variablelist class='kernel-commandline-options'>
+      <varlistentry>
+        <term><varname>systemd.restore_state=</varname></term>
 
-                <para><filename>systemd-backlight@.service</filename>
-                is a service that restores the display backlight
-                brightness at early boot and saves it at shutdown. On
-                disk, the backlight brightness is stored in
-                <filename>/var/lib/systemd/backlight/</filename>.</para>
-        </refsect1>
+        <listitem><para>Takes a boolean argument. Defaults to
+        <literal>1</literal>. If <literal>0</literal>, does not
+        restore the backlight settings on boot. However, settings will
+        still be stored on shutdown. </para></listitem>
+      </varlistentry>
+    </variablelist>
+  </refsect1>
 
-        <refsect1>
-                <title>See Also</title>
-                <para>
-                        <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>
-                </para>
-        </refsect1>
+  <refsect1>
+    <title>See Also</title>
+    <para>
+      <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+    </para>
+  </refsect1>
 
 </refentry>