.\" -*- mode: troff; coding: utf-8 -*- .\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. .ie n \{\ . ds C` "" . ds C' "" 'br\} .el\{\ . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "ARCHIVE 8" .TH ARCHIVE 8 2024-04-01 "INN 2.7.2" "InterNetNews Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH NAME archive \- Usenet article archiver .SH SYNOPSIS .IX Header "SYNOPSIS" \&\fBarchive\fR [\fB\-cfr\fR] [\fB\-a\fR \fIarchive\fR] [\fB\-i\fR \fIindex\fR] [\fB\-p\fR \fIpattern\fR] [\fIinput\fR] .SH DESCRIPTION .IX Header "DESCRIPTION" \&\fBarchive\fR makes copies of files specified on its standard input. It is normally run either as a channel feed under \fBinnd\fR or by a script before \fBnews.daily\fR is run. .PP \&\fBarchive\fR reads the named \fIinput\fR file, or standard input if no file is given. The input is taken as a sequence of lines; blank lines and lines starting with a number sign (\f(CW\*(C`#\*(C'\fR) are ignored. All other lines should specify the token of an article to archive. Every article is retrieved from a token, and the Xref header field is used to determine the target file in the archive directory. You can limit the targets taken from the Xref header field with the \fB\-p\fR option. .PP Files are copied to a directory within the archive directory, \&\fIpatharchive\fR in \fIinn.conf\fR (or some other directory given with \fB\-a\fR). The default is to create a hierarchy that mimics a traditional news spool storage of the given articles; intermediate directories will be created as needed. For example, if the input token represents article 2211 in the newsgroup comp.sources.unix, \fBarchive\fR will by default store the article as: .PP .Vb 1 \& comp/sources/unix/2211 .Ve .PP in the archive area. This can be modified with the \fB\-c\fR and \fB\-f\fR options. .SH OPTIONS .IX Header "OPTIONS" .IP "\fB\-a\fR \fIarchive\fR" 4 .IX Item "-a archive" If the \fB\-a\fR flag is given, its argument specifies the root of the archive area, instead of \fIpatharchive\fR in \fIinn.conf\fR. .IP \fB\-c\fR 4 .IX Item "-c" If the \fB\-c\fR flag is given, directory names will be flattened as described under the \fB\-f\fR option. Then, additionally, all posts will be concatenated into a single file, appending to that file if it already exists. The file name will be \f(CW\*(C`YYYYMM\*(C'\fR, formed from the current time when \&\fBarchive\fR is run. In other words, if given an article in comp.sources.unix on December 14th, 1998, the article would be appended to the file: .Sp .Vb 1 \& comp.sources.unix/199812 .Ve .Sp in the archive area. .Sp Articles will be separated by a line containing only \f(CW\*(C`\-\-\-\-\-\-\-\-\-\-\-\*(C'\fR. .IP \fB\-f\fR 4 .IX Item "-f" If the \fB\-f\fR flag is used, directory names will be flattened, replacing the slashes with the periods. In other words, article 2211 in comp.sources.unix will be written to: .Sp .Vb 1 \& comp.sources.unix/2211 .Ve .Sp in the archive area. .IP "\fB\-i\fR \fIindex\fR" 4 .IX Item "-i index" If the \fB\-i\fR flag is used, \fBarchive\fR will append one line to the file \&\fIindex\fR for each article that it archives. This line will contain the destination file name, the Message-ID header field, and the Subject header field of the message, separated by spaces. If either header is missing (normally not possible if the article was accepted by \fBinnd\fR), it will be replaced by \f(CW\*(C`\*(C'\fR. The headers will be transformed using the same rules as are used to generate overview data (unfolded and then with tabs, CR, and LF replaced by spaces). .IP "\fB\-p\fR \fIpattern\fR" 4 .IX Item "-p pattern" Limits the targets taken from the Xref header field to the groups specified in \&\fIpattern\fR. \fIpattern\fR is a \fIuwildmat\fR pattern matching newsgroups that you wish to have \fBarchive\fR handle. .IP \fB\-r\fR 4 .IX Item "-r" By default, \fBarchive\fR sets its standard error to \fIpathlog\fR/errlog. To suppress this redirection, use the \fB\-r\fR flag. .SH "RETURN VALUE" .IX Header "RETURN VALUE" If the input is exhausted, \fBarchive\fR will exit with a zero status. If an I/O error occurs, it will try to spool its input, copying it to a file. If there was no input filename, the standard input will be copied to \&\fIpathoutgoing\fR/archive and the program will exit. If an input filename was given, a temporary file named \fIinput\fR.bch (if \fIinput\fR is an absolute pathname) or \fIpathoutgoing\fR/\fIinput\fR.bch (if the filename does not begin with a slash) is created. Once the input is copied, \fBarchive\fR will try to rename this temporary file to be the name of the input file, and then exit. .SH EXAMPLES .IX Header "EXAMPLES" A typical newsfeeds(5) entry to archive most source newsgroups is as follows: .PP .Vb 4 \& source\-archive!\e \& :!*,*sources*,!*wanted*,!*.d\e \& :Tc,Wn\e \& :/archive \-f \-i /INDEX .Ve .PP Replace and with the appropriate paths. .SH HISTORY .IX Header "HISTORY" Written by Rich $alz for InterNetNews. Converted to POD by Russ Allbery . .SH "SEE ALSO" .IX Header "SEE ALSO" inn.conf(5), libinn_uwildmat(3), newsfeeds(5).