X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~ian/git?a=blobdiff_plain;f=doc%2Fpod%2Fexpireover.pod;fp=doc%2Fpod%2Fexpireover.pod;h=0000000000000000000000000000000000000000;hb=b7a32e2d73e3ab1add8208d3e157f7269a31ef4d;hp=69c27ae367ad445700e743fa703f48ebdff62f99;hpb=ac902a8299ff4469b356836f431ead31c3377377;p=innduct.git diff --git a/doc/pod/expireover.pod b/doc/pod/expireover.pod deleted file mode 100644 index 69c27ae..0000000 --- a/doc/pod/expireover.pod +++ /dev/null @@ -1,155 +0,0 @@ -=head1 NAME - -expireover - Expire entries from the news overview database - -=head1 SYNOPSIS - -B [B<-ekNpqs>] [B<-f> I] [B<-w> I] -[B<-z> I] [B<-Z> I] - -=head1 DESCRIPTION - -B expires old entries from the news overview database. It -reads in a list of newsgroups (by default from I/active, but a -different file can be specified with the B<-f> option) and then removes -from the overview database mentions of any articles that no longer exist -in the news spool. - -If I in I is true, B also removes -old articles from the news spool according to the expiration rules in -F. Otherwise it only removes overview entries for articles -that have already been removed by some other process, and B<-e>, B<-k>, -B<-N>, B<-p>, B<-q>, B<-w>, and B<-z> are all ignored. - -When I is set, the default behavior of B is -to remove the article from the spool once it expires out of all of the -newsgroups to which it was crossposted. The article is, however, removed -from the overview database of each newsgroup as soon as it expires out of -that individual newsgroup. The effect is that an article crossposted to -several groups will be removed from the overview database from each group -one-by-one as its age passes the expiration threshold for that group as -set in F, and then when it expires out of the last newsgroup, -it will be deleted from the news spool. - -Articles that are stored in self-expiring storage backends such as CNFS -are normally treated differently and not expired until they expire out of -the backend regardless of F. See B<-N>, however. - -By default, B purges all overview information for newsgroups -that have been removed from the server; this behavior is suppressed if -B<-f> is given. - -=head1 OPTIONS - -=over 4 - -=item B<-e> - -Remove articles from the news spool and all overview databases as soon as -they expire out of any newsgroup to which they are posted, rather than -retain them until they expire out of all newsgroups. B<-e> and B<-k> -cannot be used at the same time. This flag is ignored if -I is false. - -=item B<-f> I - -Use I as the newsgroup list instead of I/active. I -can be C<-> to indicate standard input. Using this flag suppresses the -normal purge of all overview information from newsgroups that have been -removed from the server. - -=item B<-k> - -Retain all overview information for an article, as well as the article -itself, until it expires out of all newsgroups to which it was posted. -This can cause articles to stick around in a newsgroup for longer than the -F rules indicate, when they're crossposted. B<-e> and B<-k> -cannot be used at the same time. This flag is ignored if -I is false. - -=item B<-N> - -Apply F rules to expire articles even from storage methods -that have self-expire functionality. This may remove articles from -self-expiring storage methods before the articles "naturally" expire. -This flag is ignored if I is false. - -=item B<-p> - -By default, B bases decisions on whether to remove an article -on the arrival time on the server. This means that articles may be kept a -little longer than if the decision were based on the article's posting -date. If this option is given, expiration decisions are based on the -article posting date instead. This flag is ignored if I -is false. - -=item B<-q> - -B normally prints statistics at the end of the expiration -process. B<-q> suppresses this report. This flag is ignored if -I is false. - -=item B<-s> - -B normally only checks the existence of articles in the news -spool if querying the storage method for that article to see if it still -exists is considered "inexpensive." To always check the existence of all -articles regardless of how resource-intensive this may be, use the B<-s> -flag. See storage.conf(5) for more information about this metric. - -=item B<-w> I - -"Warps" time so that B thinks that it's running at some time -other than the current time. This is occasionally useful to force groups -to be expired or not expired without changing F for the expire -run. I should be a signed floating point number specifying the -number of days difference from the current time to use as "now." This -flag is ignored if I is false. - -=item B<-z> I - -Don't remove articles immediately but instead write the path to the -article or the token of the article to I, which is suitable input -for fastrm(1). This can substantially speed up deletion of expired -articles for those storage methods where each article is a single file -(such as tradspool and timehash). See the description of I in -news.daily(8) for more details. This flag is ignored if -I is false. - -=item B<-Z> I - -Write the lowest article numbers for each newsgroup as it's expired to the -specified file. This file is then suitable for C. See -ctlinnd(8) for more information. - -=back - -=head1 EXAMPLES - -Normally B is invoked from news.daily(8), which handles such -things as processing the I and I if necessary. -Sometimes it's convenient to manually expire a particular newsgroup, -however. This can be done with a command like: - - echo example.test | expireover -f - -Z /usr/local/news/tmp/lowmark - ctlinnd lowmark /usr/local/news/tmp/lowmark - -This can be particularly useful if a lot of articles in a particular group -have expired but the overview information is still present, causing some -clients to see a lot of "this article may have been cancelled" messages -when they first enter the newsgroup. - -=head1 HISTORY - -Written by Rob Robertson and Rich $alz - (with help from Dave Lawrence ) -for InterNetNews. - -$Id: expireover.pod 5909 2002-12-03 05:17:18Z vinocur $ - -=head1 SEE ALSO - -active(5), ctlinnd(8), expire(8), expire.ctl(5), inn.conf(5), -news.daily(8). - -=cut