DragonFly On-Line Manual Pages
ARCHIVE(8) InterNetNews Documentation ARCHIVE(8)
archive - Usenet article archiver
archive [-cfr] [-a archive] [-i index] [-p pattern] [input]
archive makes copies of files specified on its standard input. It is
normally run either as a channel feed under innd or by a script before
news.daily is run.
archive reads the named input 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 ("#") 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 is used to determine the
target file in the archive directory. You can limit the targets taken
from the Xref: header with the -p option.
Files are copied to a directory within the archive directory,
patharchive in inn.conf (or some other directory given with -a). 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, archive will by default store the
in the archive area. This can be modified with the -c and -f options.
If the -a flag is given, its argument specifies the root of the
archive area, instead of patharchive in inn.conf.
-c If the -c flag is given, directory names will be flattened as
described under the -f 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 "YYYYMM", formed from the
current time when archive 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:
in the archive area.
Articles will be separated by a line containing only "-----------".
-f If the -f 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:
in the archive area.
If the -i flag is used, archive will append one line to the file
index for each article that it archives. This line will contain
the destination file name, the Message-ID: header, and the Subject:
header of the message, separated by spaces. If either header is
missing (normally not possible if the article was accepted by
innd), it will be replaced by "<none>". 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).
Limits the targets taken from the Xref: header to the groups
specified in pattern. pattern is a uwildmat(3) pattern matching
newsgroups that you wish to have archive handle.
-r By default, archive sets its standard error to pathlog/errlog. To
suppress this redirection, use the -r flag.
If the input is exhausted, archive 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
pathoutgoing/archive and the program will exit. If an input filename
was given, a temporary file named input.bch (if input is an absolute
pathname) or pathoutgoing/input.bch (if the filename does not begin
with a slash) is created. Once the input is copied, archive will try
to rename this temporary file to be the name of the input file, and
A typical newsfeeds(5) entry to archive most source newsgroups is as
:<pathbin>/archive -f -i <patharchive>/INDEX
Replace <pathbin> and <patharchive> with the appropriate paths.
Written by Rich $alz <email@example.com> for InterNetNews. Converted
to POD by Russ Allbery <firstname.lastname@example.org>.
$Id: archive.pod 9767 2014-12-07 21:13:43Z iulius $
INN 2.6.0 2015-09-12 ARCHIVE(8)
ARCHIVE_WRITE_OPEN(3) DragonFly Library Functions Manual
archive_write_open, archive_write_open2, archive_write_open_fd,
archive_write_open_memory - functions for creating archives
Streaming Archive Library (libarchive, -larchive)
archive_write_open(struct archive *, void *client_data,
archive_open_callback *, archive_write_callback *,
archive_write_open2(struct archive *, void *client_data,
archive_open_callback *, archive_write_callback *,
archive_close_callback *, archive_free_callback *);
archive_write_open_fd(struct archive *, int fd);
archive_write_open_FILE(struct archive *, FILE *file);
archive_write_open_filename(struct archive *, const char *filename);
archive_write_open_memory(struct archive *, void *buffer,
size_t bufferSize, size_t *outUsed);
Freeze the settings, open the archive, and prepare for writing
entries. This is the most generic form of this function, which
accepts pointers to three callback functions which will be
invoked by the compression layer to write the constructed
archive. This does not alter the default archive padding.
Same as archive_write_open() with an additional fourth free
callback. This function should be preferred to
A convenience form of archive_write_open() that accepts a file
descriptor. The archive_write_open_fd() function is safe for use
with tape drives or other block-oriented devices.
A convenience form of archive_write_open() that accepts a FILE *
pointer. Note that archive_write_open_FILE() is not safe for
writing to tape drives or other devices that require correct
A deprecated synonym for archive_write_open_filename().
A convenience form of archive_write_open() that accepts a
filename. A NULL argument indicates that the output should be
written to standard output; an argument of "-" will open a file
with that name. If you have not invoked
archive_write_open_filename() will adjust the last-block padding
depending on the file: it will enable padding when writing to
standard output or to a character or block device node, it will
disable padding otherwise. You can override this by manually
invoking archive_write_set_bytes_in_last_block() before calling
archive_write_open2(). The archive_write_open_filename()
function is safe for use with tape drives or other block-oriented
A convenience form of archive_write_open2() that accepts a
pointer to a block of memory that will receive the archive. The
final size_t * argument points to a variable that will be updated
after each write to reflect how much of the buffer is currently
in use. You should be careful to ensure that this variable
remains allocated until after the archive is closed. This
function will disable padding unless you have specifically set
the block size.
More information about the struct archive object and the overall design
of the library can be found in the libarchive(3) overview.
Note that the convenience forms above vary in how they block the output.
See archive_write_blocksize(3) if you need to control the block size used
for writes or the end-of-file padding behavior.
To use this library, you will need to define and register callback
functions that will be invoked to write data to the resulting archive.
These functions are registered by calling archive_write_open2():
typedef int archive_open_callback(struct archive *, void
The open callback is invoked by archive_write_open(). It should return
ARCHIVE_OK if the underlying file or data source is successfully opened.
If the open fails, it should call archive_set_error() to register an
error code and message and return ARCHIVE_FATAL. Please note that if
open fails, close is not called and resources must be freed inside the
open callback or with the free callback.
typedef la_ssize_t archive_write_callback(struct archive *,
void *client_data, const void *buffer, size_t length)
The write callback is invoked whenever the library needs to write raw
bytes to the archive. For correct blocking, each call to the write
callback function should translate into a single write(2) system call.
This is especially critical when writing archives to tape drives. On
success, the write callback should return the number of bytes actually
written. On error, the callback should invoke archive_set_error() to
register an error code and message and return -1.
typedef int archive_close_callback(struct archive *, void
The close callback is invoked by archive_close when the archive
processing is complete. If the open callback fails, the close callback is
not invoked. The callback should return ARCHIVE_OK on success. On
failure, the callback should invoke archive_set_error() to register an
error code and message and return
typedef int archive_free_callback(struct archive *, void
The free callback is always invoked on archive_free. The return code of
this callback is not processed.
Note that if the client-provided write callback function returns a non-
zero value, that error will be propagated back to the caller through
whatever API function resulted in that call, which may include
archive_write_header(), archive_write_data(), archive_write_close(),
archive_write_finish(), or archive_write_free(). The client callback can
call archive_set_error() to provide values that can then be retrieved by
archive_errno() and archive_error_string().
These functions return ARCHIVE_OK on success, or ARCHIVE_FATAL.
Detailed error codes and textual descriptions are available from the
archive_errno() and archive_error_string() functions.
tar(1), archive_write(3), archive_write_blocksize(3),
archive_write_filter(3), archive_write_format(3), archive_write_new(3),
archive_write_set_options(3), libarchive(3), cpio(5), mtree(5), tar(5)
DragonFly 6.3-DEVELOPMENT November 12, 2020 DragonFly 6.3-DEVELOPMENT