test-execute: Add tests for new PassEnvironment= directive

[thirdparty/systemd.git] / man / systemd-quotacheck.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">
<!--
  This file is part of systemd.

  Copyright 2012 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-quotacheck.service" conditional='ENABLE_QUOTACHECK'>

  <refentryinfo>
    <title>systemd-quotacheck.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-quotacheck.service</refentrytitle>
    <manvolnum>8</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>systemd-quotacheck.service</refname>
    <refname>systemd-quotacheck</refname>
    <refpurpose>File system quota checker logic</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <para><filename>systemd-quotacheck.service</filename></para>
    <para><filename>/usr/lib/systemd/systemd-quotacheck</filename></para>
  </refsynopsisdiv>

  <refsect1>
    <title>Description</title>

    <para><filename>systemd-quotacheck.service</filename> is a service
    responsible for file system quota checks. It is run once at boot
    after all necessary file systems are mounted. It is pulled in only
    if at least one file system has quotas enabled.</para>
  </refsect1>

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

    <para><filename>systemd-quotacheck</filename> understands one
    kernel command line parameter:</para>

    <variablelist class='kernel-commandline-options'>
      <varlistentry>
        <term><varname>quotacheck.mode=</varname></term>

        <listitem><para>One of <literal>auto</literal>,
        <literal>force</literal>, <literal>skip</literal>. Controls
        the mode of operation. The default is <literal>auto</literal>,
        and ensures that file system quota checks are done when the
        file system quota checker deems them necessary.
        <literal>force</literal> unconditionally results in full file
        system quota checks. <literal>skip</literal> skips any file
        system quota checks.</para></listitem>
      </varlistentry>
    </variablelist>
  </refsect1>

  <refsect1>
    <title>See Also</title>
    <para>
      <citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
      <citerefentry project='die-net'><refentrytitle>quotacheck</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
      <citerefentry><refentrytitle>systemd-fsck@.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>
    </para>
  </refsect1>

</refentry>