htcacheclean.xml revision 5f5d1b4cc970b7f06ff8ef6526128e9a27303d88
e34d87a16d31f5820b509b2838582520921c2cd7nd<?xml version='1.0' encoding='UTF-8' ?>
e34d87a16d31f5820b509b2838582520921c2cd7nd<!DOCTYPE manualpage SYSTEM "/style/manualpage.dtd">
e34d87a16d31f5820b509b2838582520921c2cd7nd<?xml-stylesheet type="text/xsl" href="/style/manual.en.xsl"?>
5f5d1b4cc970b7f06ff8ef6526128e9a27303d88nd<!-- $LastChangedRevision$ -->
e34d87a16d31f5820b509b2838582520921c2cd7nd
e34d87a16d31f5820b509b2838582520921c2cd7nd<!--
e34d87a16d31f5820b509b2838582520921c2cd7nd Copyright 2004 The Apache Software Foundation
e34d87a16d31f5820b509b2838582520921c2cd7nd
e34d87a16d31f5820b509b2838582520921c2cd7nd Licensed under the Apache License, Version 2.0 (the "License");
e34d87a16d31f5820b509b2838582520921c2cd7nd you may not use this file except in compliance with the License.
e34d87a16d31f5820b509b2838582520921c2cd7nd You may obtain a copy of the License at
e34d87a16d31f5820b509b2838582520921c2cd7nd
e34d87a16d31f5820b509b2838582520921c2cd7nd http://www.apache.org/licenses/LICENSE-2.0
e34d87a16d31f5820b509b2838582520921c2cd7nd
e34d87a16d31f5820b509b2838582520921c2cd7nd Unless required by applicable law or agreed to in writing, software
e34d87a16d31f5820b509b2838582520921c2cd7nd distributed under the License is distributed on an "AS IS" BASIS,
e34d87a16d31f5820b509b2838582520921c2cd7nd WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
e34d87a16d31f5820b509b2838582520921c2cd7nd See the License for the specific language governing permissions and
e34d87a16d31f5820b509b2838582520921c2cd7nd limitations under the License.
e34d87a16d31f5820b509b2838582520921c2cd7nd-->
e34d87a16d31f5820b509b2838582520921c2cd7nd
e34d87a16d31f5820b509b2838582520921c2cd7nd<manualpage metafile="htcacheclean.xml.meta">
e34d87a16d31f5820b509b2838582520921c2cd7nd<parentdocument href="./">Programs</parentdocument>
e34d87a16d31f5820b509b2838582520921c2cd7nd
e34d87a16d31f5820b509b2838582520921c2cd7nd<title>htcacheclean - Clean up the disk cache</title>
e34d87a16d31f5820b509b2838582520921c2cd7nd
e34d87a16d31f5820b509b2838582520921c2cd7nd<summary>
e34d87a16d31f5820b509b2838582520921c2cd7nd <p><code>htcacheclean</code> is used to keep the size of
e34d87a16d31f5820b509b2838582520921c2cd7nd <module>mod_disk_cache</module>'s storage within a certain limit. This
283a7cdf9eb15d563fa3c7ae71009ca436fb07e1jorton tool can run either manually or in daemon mode. When running in
e34d87a16d31f5820b509b2838582520921c2cd7nd daemon mode, it sleeps in the background and checks the cache directories
283a7cdf9eb15d563fa3c7ae71009ca436fb07e1jorton at regular intervals for cached content to be removed. You can stop the daemon
283a7cdf9eb15d563fa3c7ae71009ca436fb07e1jorton cleanly by sending it a TERM or INT signal.</p>
e34d87a16d31f5820b509b2838582520921c2cd7nd</summary>
e34d87a16d31f5820b509b2838582520921c2cd7nd<seealso><module>mod_disk_cache</module></seealso>
e34d87a16d31f5820b509b2838582520921c2cd7nd
e34d87a16d31f5820b509b2838582520921c2cd7nd<section id="synopsis"><title>Synopsis</title>
e34d87a16d31f5820b509b2838582520921c2cd7nd <p><code><strong>htcacheclean</strong>
e34d87a16d31f5820b509b2838582520921c2cd7nd [ -<strong>D</strong> ]
e34d87a16d31f5820b509b2838582520921c2cd7nd [ -<strong>v</strong> ]
e34d87a16d31f5820b509b2838582520921c2cd7nd [ -<strong>r</strong> ]
e34d87a16d31f5820b509b2838582520921c2cd7nd [ -<strong>n</strong> ]
e34d87a16d31f5820b509b2838582520921c2cd7nd -<strong>p</strong><var>path</var>
e34d87a16d31f5820b509b2838582520921c2cd7nd -<strong>l</strong><var>limit</var></code></p>
e34d87a16d31f5820b509b2838582520921c2cd7nd
e34d87a16d31f5820b509b2838582520921c2cd7nd <p><code><strong>htcacheclean</strong> -<strong>b</strong>
e34d87a16d31f5820b509b2838582520921c2cd7nd [ -<strong>n</strong> ]
e34d87a16d31f5820b509b2838582520921c2cd7nd [ -<strong>i</strong> ]
e34d87a16d31f5820b509b2838582520921c2cd7nd -<strong>d</strong><var>interval</var>
e34d87a16d31f5820b509b2838582520921c2cd7nd -<strong>p</strong><var>path</var>
e34d87a16d31f5820b509b2838582520921c2cd7nd -<strong>l</strong><var>limit</var></code></p>
e34d87a16d31f5820b509b2838582520921c2cd7nd</section>
e34d87a16d31f5820b509b2838582520921c2cd7nd
e34d87a16d31f5820b509b2838582520921c2cd7nd<section id="options"><title>Options</title>
e34d87a16d31f5820b509b2838582520921c2cd7nd <dl>
e34d87a16d31f5820b509b2838582520921c2cd7nd <dt><code>-d<var>interval</var></code></dt>
e34d87a16d31f5820b509b2838582520921c2cd7nd <dd>Daemonize and repeat cache cleaning every <var>interval</var> minutes.
e34d87a16d31f5820b509b2838582520921c2cd7nd This option is mutually exclusive with the <code>-D</code>, <code>-v</code>
e34d87a16d31f5820b509b2838582520921c2cd7nd and <code>-r</code> options. To shutdown the daemon cleanly, just send it
e34d87a16d31f5820b509b2838582520921c2cd7nd a <code>SIGTERM</code> or <code>SIGINT</code>.</dd>
e34d87a16d31f5820b509b2838582520921c2cd7nd
e34d87a16d31f5820b509b2838582520921c2cd7nd <dt><code>-D</code></dt>
e34d87a16d31f5820b509b2838582520921c2cd7nd <dd>Do a dry run and don't delete anything. This option is mutually
e34d87a16d31f5820b509b2838582520921c2cd7nd exclusive with the <code>-d</code> option.</dd>
e34d87a16d31f5820b509b2838582520921c2cd7nd
e34d87a16d31f5820b509b2838582520921c2cd7nd <dt><code>-v</code></dt>
e34d87a16d31f5820b509b2838582520921c2cd7nd <dd>Be verbose and print statistics. This option is mutually exclusive
e34d87a16d31f5820b509b2838582520921c2cd7nd with the <code>-d</code> option.</dd>
e34d87a16d31f5820b509b2838582520921c2cd7nd
e34d87a16d31f5820b509b2838582520921c2cd7nd <dt><code>-r</code></dt>
e34d87a16d31f5820b509b2838582520921c2cd7nd <dd>Clean thoroughly. This assumes that the Apache web server is
e34d87a16d31f5820b509b2838582520921c2cd7nd not running (otherwise you may get garbage in the cache). This option
e34d87a16d31f5820b509b2838582520921c2cd7nd is mutually exclusive with the <code>-d</code> option.</dd>
e34d87a16d31f5820b509b2838582520921c2cd7nd
e34d87a16d31f5820b509b2838582520921c2cd7nd <dt><code>-n</code></dt>
e34d87a16d31f5820b509b2838582520921c2cd7nd <dd>Be nice. This causes slower processing in favour of other
e34d87a16d31f5820b509b2838582520921c2cd7nd processes. <code>htcacheclean</code> will sleep from time to time
e34d87a16d31f5820b509b2838582520921c2cd7nd so that (a) the disk IO will be delayed and (b) the kernel can schedule
e34d87a16d31f5820b509b2838582520921c2cd7nd other processes in the meantime.</dd>
e34d87a16d31f5820b509b2838582520921c2cd7nd
e34d87a16d31f5820b509b2838582520921c2cd7nd <dt><code>-p<var>path</var></code></dt>
e34d87a16d31f5820b509b2838582520921c2cd7nd <dd>Specify <var>path</var> as the root directory of the disk cache. This
e34d87a16d31f5820b509b2838582520921c2cd7nd should be the same value as specified with the <directive
e34d87a16d31f5820b509b2838582520921c2cd7nd module="mod_disk_cache">CacheRoot</directive> directive.</dd>
e34d87a16d31f5820b509b2838582520921c2cd7nd
e34d87a16d31f5820b509b2838582520921c2cd7nd <dt><code>-l<var>limit</var></code></dt>
e34d87a16d31f5820b509b2838582520921c2cd7nd <dd>Specify <var>limit</var> as the total disk cache size limit. The value
e34d87a16d31f5820b509b2838582520921c2cd7nd is expressed in bytes by default (or attaching <code>B</code> to the
e34d87a16d31f5820b509b2838582520921c2cd7nd number). Attach <code>K</code> for Kbytes or <code>M</code> for
e34d87a16d31f5820b509b2838582520921c2cd7nd MBytes.</dd>
e34d87a16d31f5820b509b2838582520921c2cd7nd
e34d87a16d31f5820b509b2838582520921c2cd7nd <dt><code>-i</code></dt>
e34d87a16d31f5820b509b2838582520921c2cd7nd <dd>Be intelligent and run only when there was a modification of the disk
e34d87a16d31f5820b509b2838582520921c2cd7nd cache. This option is only possible together with the <code>-d</code>
e34d87a16d31f5820b509b2838582520921c2cd7nd option.</dd>
e34d87a16d31f5820b509b2838582520921c2cd7nd </dl>
e34d87a16d31f5820b509b2838582520921c2cd7nd</section>
e34d87a16d31f5820b509b2838582520921c2cd7nd
e34d87a16d31f5820b509b2838582520921c2cd7nd<section id="exit"><title>Exit Status</title>
e34d87a16d31f5820b509b2838582520921c2cd7nd <p><code>htcacheclean</code> returns a zero status ("true") if all
e34d87a16d31f5820b509b2838582520921c2cd7nd operations were successful, <code>1</code> otherwise.</p>
e34d87a16d31f5820b509b2838582520921c2cd7nd</section>
e34d87a16d31f5820b509b2838582520921c2cd7nd
e34d87a16d31f5820b509b2838582520921c2cd7nd</manualpage>