man: generate configured paths in manpages

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

<?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" [
<!ENTITY % entities SYSTEM "custom-entities.ent" >
%entities;
]>
<!--
  This file is part of systemd.

  Copyright 2013 Lennart Poettering

  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.

  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.

  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-rfkill@.service" conditional='ENABLE_RFKILL'>

  <refentryinfo>
    <title>systemd-rfkill@.service</title>
    <productname>systemd</productname>

    <authorgroup>
      <author>
        <contrib>Developer</contrib>
        <firstname>Lennart</firstname>
        <surname>Poettering</surname>
        <email>lennart@poettering.net</email>
      </author>
    </authorgroup>
  </refentryinfo>

  <refmeta>
    <refentrytitle>systemd-rfkill@.service</refentrytitle>
    <manvolnum>8</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>systemd-rfkill@.service</refname>
    <refname>systemd-rfkill</refname>
    <refpurpose>Load and save the RF kill switch state at boot and shutdown</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <para><filename>systemd-rfkill@.service</filename></para>
    <para><filename>&rootlibexecdir;/systemd-rfkill</filename></para>
  </refsynopsisdiv>

  <refsect1>
    <title>Description</title>

    <para><filename>systemd-rfkill@.service</filename> is a service
    that restores the RF kill switch state at early boot and saves it
    at shutdown. On disk, the RF kill switch state is stored in
    <filename>/var/lib/systemd/rfkill/</filename>.</para>
  </refsect1>

  <refsect1>
    <title>Kernel Command Line</title>

    <para><filename>systemd-rfkill</filename> understands the
    following kernel command line parameter:</para>

    <variablelist class='kernel-commandline-options'>
      <varlistentry>
        <term><varname>systemd.restore_state=</varname></term>

        <listitem><para>Takes a boolean argument. Defaults to
        <literal>1</literal>. If <literal>0</literal>, does not
        restore the rfkill 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>

</refentry>