Blame SOURCES/htcacheclean.service.xml

e71654
e71654
e71654
  "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
e71654
e71654
]>
e71654
e71654
 Copyright 2018 Red Hat, Inc.
e71654
e71654
 Licensed to the Apache Software Foundation (ASF) under one or more
e71654
 contributor license agreements.  See the NOTICE file distributed with
e71654
 this work for additional information regarding copyright ownership.
e71654
 The ASF licenses this file to You under the Apache License, Version 2.0
e71654
 (the "License"); you may not use this file except in compliance with
e71654
 the License.  You may obtain a copy of the License at
e71654
e71654
     http://www.apache.org/licenses/LICENSE-2.0
e71654
e71654
 Unless required by applicable law or agreed to in writing, software
e71654
 distributed under the License is distributed on an "AS IS" BASIS,
e71654
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
e71654
 See the License for the specific language overning permissions and
e71654
 limitations under the License.
e71654
-->
e71654
<refentry>
e71654
  <refentryinfo>
e71654
    <title>htcacheclean systemd unit</title>
e71654
    <productname>httpd</productname>
e71654
    <author><contrib>Author</contrib><surname>Orton</surname><firstname>Joe</firstname><email>jorton@redhat.com</email></author>
e71654
  </refentryinfo>
e71654
e71654
  <refmeta>
e71654
    <refentrytitle>htcacheclean.service</refentrytitle>
e71654
    <manvolnum>8</manvolnum>
e71654
  </refmeta>
e71654
e71654
  <refnamediv>
e71654
    <refname>htcacheclean.service</refname>
e71654
    <refpurpose>htcacheclean unit file for systemd</refpurpose>
e71654
  </refnamediv>
e71654
e71654
  <refsynopsisdiv>
e71654
    <para>
e71654
      <filename>/usr/lib/systemd/system/htcacheclean.service</filename>
e71654
    </para>
e71654
  </refsynopsisdiv>
e71654
e71654
  <refsect1>
e71654
    <title>Description</title>
e71654
e71654
    <para>This manual page describes the <command>systemd</command>
e71654
    unit file for the <command>htcacheclean</command> daemon.  This
e71654
    unit file provides a service which runs
e71654
    <command>htcacheclean</command> in daemon mode,
e71654
    periodically cleaning the disk cache root to ensure disk space
e71654
    usage is within configured limits.</para>
e71654
e71654
  </refsect1>
e71654
e71654
  <refsect1>
e71654
    <title>Options</title>
e71654
e71654
    <para>The service is configured by configuration file
e71654
    <filename>/etc/sysconfig/htcacheclean</filename>. The following
e71654
    variables are used, following standard <command>systemd</command>
e71654
    <varname>EnvironmentFile=</varname> syntax:</para>
e71654
e71654
    <variablelist>
e71654
      <varlistentry>
e71654
        <term><varname>INTERVAL=</varname></term>
e71654
e71654
        <listitem><para>Sets the interval between cache clean runs, in
e71654
        minutes.  By default this is configured as
e71654
        <emphasis>15</emphasis>.</para></listitem>
e71654
      </varlistentry>
e71654
e71654
      <varlistentry>
e71654
        <term><varname>CACHE_ROOT=</varname></term>
e71654
e71654
        <listitem><para>Sets the directory name used for the cache
e71654
        root.  By default this is configured as
e71654
        <filename>/var/cache/httpd/proxy</filename>.</para></listitem>
e71654
      </varlistentry>
e71654
e71654
      <varlistentry>
e71654
        <term><varname>LIMIT=</varname></term>
e71654
e71654
        <listitem><para>Sets the total disk cache space limit, in
e71654
        bytes.  Use a <emphasis>K</emphasis> or <emphasis>M</emphasis>
e71654
        suffix to signify kilobytes or megabytes.  By default this is
e71654
        set to <emphasis>100M</emphasis>.</para></listitem>
e71654
      </varlistentry>
e71654
e71654
      <varlistentry>
e71654
        <term><varname>OPTIONS=</varname></term>
e71654
e71654
        <listitem><para>Any other options to pass to
e71654
        <command>htcacheclean</command>.</para></listitem>
e71654
      </varlistentry>
e71654
    </variablelist>
e71654
  </refsect1>
e71654
e71654
  <refsect1>
e71654
    <title>Files</title>
e71654
e71654
    <para><filename>/usr/lib/systemd/system/htcacheclean.service</filename>,
e71654
    <filename>/etc/sysconfig/htcacheclean</filename></para>
e71654
  </refsect1>
e71654
e71654
  <refsect1>
e71654
    <title>See also</title>
e71654
e71654
    <para>
e71654
    <citerefentry><refentrytitle>htcacheclean</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
e71654
    <citerefentry><refentrytitle>httpd</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
e71654
    <citerefentry><refentrytitle>httpd.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
e71654
    <citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>8</manvolnum></citerefentry>
e71654
    </para>
e71654
  </refsect1>
e71654
e71654
</refentry>
e71654
e71654
e71654
-->