granicus.if.org Git - apache/blob - docs/man/htcacheclean.8

   1 .\" XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   2 .\" DO NOT EDIT! Generated from XML source.
   3 .\" XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   4 .de Sh \" Subsection
   5 .br
   6 .if t .Sp
   7 .ne 5
   8 .PP
   9 \fB\\$1\fR
  10 .PP
  11 ..
  12 .de Sp \" Vertical space (when we can't use .PP)
  13 .if t .sp .5v
  14 .if n .sp
  15 ..
  16 .de Ip \" List item
  17 .br
  18 .ie \\n(.$>=3 .ne \\$3
  19 .el .ne 3
  20 .IP "\\$1" \\$2
  21 ..
  22 .TH "HTCACHECLEAN" 8 "2008-04-21" "Apache HTTP Server" "htcacheclean"
  23
  24 .SH NAME
  25 htcacheclean \- Clean up the disk cache
  26
  27 .SH "SYNOPSIS"
  28
  29 .PP
  30 \fBhtcacheclean\fR [ -\fBD\fR ] [ -\fBv\fR ] [ -\fBt\fR ] [ -\fBr\fR ] [ -\fBn\fR ] -\fBp\fR\fIpath\fR -\fBl\fR\fIlimit\fR
  31
  32 .PP
  33 \fBhtcacheclean\fR [ -\fBn\fR ] [ -\fBt\fR ] [ -\fBi\fR ] -\fBd\fR\fIinterval\fR -\fBp\fR\fIpath\fR -\fBl\fR\fIlimit\fR
  34
  35
  36 .SH "SUMMARY"
  37
  38 .PP
  39 htcacheclean is used to keep the size of mod_disk_cache's storage within a certain limit\&. This tool can run either manually or in daemon mode\&. When running in daemon mode, it sleeps in the background and checks the cache directories at regular intervals for cached content to be removed\&. You can stop the daemon cleanly by sending it a TERM or INT signal\&.
  40
  41
  42 .SH "OPTIONS"
  43
  44
  45 .TP
  46 -d\fIinterval\fR
  47 Daemonize and repeat cache cleaning every \fIinterval\fR minutes\&. This option is mutually exclusive with the -D, -v and -r options\&. To shutdown the daemon cleanly, just send it a SIGTERM or SIGINT\&.
  48 .TP
  49 -D
  50 Do a dry run and don't delete anything\&. This option is mutually exclusive with the -d option\&.
  51 .TP
  52 -v
  53 Be verbose and print statistics\&. This option is mutually exclusive with the -d option\&.
  54 .TP
  55 -r
  56 Clean thoroughly\&. This assumes that the Apache web server is not running (otherwise you may get garbage in the cache)\&. This option is mutually exclusive with the -d option and implies the -t option\&.
  57 .TP
  58 -n
  59 Be nice\&. This causes slower processing in favour of other processes\&. htcacheclean will sleep from time to time so that (a) the disk IO will be delayed and (b) the kernel can schedule other processes in the meantime\&.
  60 .TP
  61 -t
  62 Delete all empty directories\&. By default only cache files are removed, however with some configurations the large number of directories created may require attention\&. If your configuration requires a very large number of directories, to the point that inode or file allocation table exhaustion may become an issue, use of this option is advised\&.
  63 .TP
  64 -p\fIpath\fR
  65 Specify \fIpath\fR as the root directory of the disk cache\&. This should be the same value as specified with the CacheRoot directive\&.
  66 .TP
  67 -l\fIlimit\fR
  68 Specify \fIlimit\fR as the total disk cache size limit\&. The value is expressed in bytes by default (or attaching B to the number)\&. Attach K for Kbytes or M for MBytes\&.
  69 .TP
  70 -i
  71 Be intelligent and run only when there was a modification of the disk cache\&. This option is only possible together with the -d option\&.
  72
  73 .SH "EXIT STATUS"
  74
  75 .PP
  76 htcacheclean returns a zero status ("true") if all operations were successful, 1 otherwise\&.
  77