1
<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
3
<!-- Process this file with docbook-to-man to generate an nroff manual
4
page: `docbook-to-man lurker-prune.sgml > lurker-prune.1'.
5
You may view the manual page with:
6
`docbook-to-man lurker-prune.sgml | nroff -man | less'.
7
A typical entry in a Makefile or Makefile.am is:
9
lurker-prune.1: lurker-prune.sgml
10
docbook-to-man $< > $@
13
<!-- Fill in your name for FIRSTNAME and SURNAME. -->
14
<!ENTITY dhfirstname "<firstname>Wesley</firstname>">
15
<!ENTITY dhsurname "<surname>Terpstra</surname>">
16
<!-- Please adjust the date whenever revising the manpage. -->
17
<!ENTITY dhdate "<date>May 10, 2003</date>">
18
<!-- SECTION should be 1-8, maybe w/ subsection other parameters are
19
allowed: see man(7), man(1). -->
20
<!ENTITY dhsection "<manvolnum>1</manvolnum>">
21
<!ENTITY dhemail "<email>terpstra@users.sourceforge.net</email>">
22
<!ENTITY dhusername "Wesley W. Terpstra">
23
<!ENTITY support "<email>lurker\-users@lists.sourceforge.net</email>">
24
<!ENTITY dhucpackage "<refentrytitle>LURKER\-PRUNE</refentrytitle>">
25
<!ENTITY dhpackage "lurker\-prune">
27
<!ENTITY debian "<productname>Debian</productname>">
28
<!ENTITY lurker "<productname>lurker</productname>">
29
<!ENTITY gnu "<acronym>GNU</acronym>">
43
<holder>&dhusername;</holder>
53
<refname>&dhpackage;</refname>
55
<refpurpose>prunes the web-server cache</refpurpose>
59
<command>&dhpackage;</command>
60
<arg>\-c <config-file></arg>
61
<arg>\-d <docroot></arg>
66
<title>DESCRIPTION</title>
68
<para><command>&dhpackage;</command> prunes obsolete or stale files
69
from the web-server accessible cache. This command must be run at
70
regular intervals from eg. a cronjob. If it is not run, then the
71
lurker web interface will appear to not be receiving new mail or have
72
contradictory links between pages. A good interval is every 15 minutes
73
and should not exceed one hour.</para>
75
<para>Be aware that it is possible for an attacker to use up a large
76
amount of disk space through lurker. An attacker could request many
77
distinct lurker web pages each of which is cached, thus using disk
78
space. Please setup a quota for the lurker user, read your logs, and
79
follow whatever site-specific policies you have for denial of
82
<para>A good script to run in parallel with normal lurker\-prune use is
84
if test `du \-s /var/www/lurker | cut \-f1` \-gt 32768; then lurker\-prune \-p; fi
85
This might help guard against a potential denial-of-service attack.</para>
89
<title>OPTIONS</title>
92
<term><option>\-c config-file</option></term>
94
<para>Use this config file for lurker settings.</para>
98
<term><option>\-d docroot</option></term>
100
<para>The base directory of the lurker cache. This must be set to
101
the directory which contains message/*, thread/*, etc. If you have
102
multiple running lurker interfaces, you must run this pointing
103
at each of the document roots.</para>
107
<term><option>\-m days</option></term>
109
<para>Keep cached files for at most this many days. Any cached
110
file regardless of last access will be deleted after the specified
111
number of days (defaults to 7). Files which are obsolete due to
112
new mail, config changes, or no accesses will be deleted earlier.
113
Deleted files will be automagically regenerated if needed.</para>
117
<term><option>\-a days</option></term>
119
<para>Kill cache files not accessed for this many days. Any cached
120
file which has not been read from for the specified number of days
121
(defaults to 1) will be deleted. Files which are obsolete due to
122
new mail or config changes will be deleted earlier. Deleted files
123
will be automagically regenerated if needed.</para>
127
<term><option>\-p</option></term>
129
<para>Purge mode. Delete all cache files even if they do not appear
130
to be expired. This will only deletes files that are generated by
131
lurker, and is thus preferable to rm */*.</para>
135
<term><option>\-v</option></term>
137
<para>Verbose operation. Indicate which files are being deleted
138
and the reasoning behind lurker's decisions. This can help in
139
tracking down why some files are deleted and not others.</para>
145
<title>SEE ALSO</title>
147
<para>lurker\-index(1), lurker\-params(1), lurker\-list(1)</para>
148
<para>lurker documentation on http://lurker.sourceforge.net/</para>
152
<title>COPYRIGHT</title>
155
Copyright (C) 2002: &dhusername; <&dhemail;>
159
This program is free software; you can redistribute it and/or modify
160
it under the terms of the GNU General Public License as published by
161
the Free Software Foundation; version 2.
165
This program is distributed in the hope that it will be useful,
166
but WITHOUT ANY WARRANTY; without even the implied warranty of
167
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
168
GNU General Public License for more details.
172
You should have received a copy of the GNU General Public License
173
along with this program; if not, write to the Free Software
174
Foundation, Inc., 59 Temple Place - Suite 330,
175
Boston, MA 02111-1307, USA.
182
<para>Before reporting a bug, please confirm that the bug you found is
183
still present in the latest official release. If the problem persists,
184
then send mail with instructions describing how to reproduce the bug to
185
<&support;>.</para>
190
<!-- Keep this comment at the end of the file
195
sgml-minimize-attributes:nil
196
sgml-always-quote-attributes:t
199
sgml-parent-document:nil
200
sgml-default-dtd-file:nil
201
sgml-exposed-tags:nil
202
sgml-local-catalogs:nil
203
sgml-local-ecat-files:nil
added
removed
prune/lurker-prune.sgml
