Blame SOURCES/htcacheclean.service.xml

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