=pod

=head1 NAME

B<rwipaexport> - Export IPA datasets to SiLK binary data files

=head1 SYNOPSIS

  rwipaimport --catalog=CATALOG [--time=TIME] OUTPUT_FILE

=head1 DESCRIPTION

B<rwipaexport> exports data from an IPA data store to either a SiLK
IPSet, Bag, or prefix map file, depending on the type of the stored IPA
catalog.  For catalogs with time information (e.g. time period at which
the stored data is considered valid) data can be selected for a
specific time of interest.

=head1 OPTIONS

Option names may be abbreviated if the abbreviation is unique or is an
exact match for an option.  A parameter to an option may be specified
as B<--arg>=I<param> or S<B<--arg> I<param>>, though the first form is
required for options that take optional parameters.

=over 4

=item B<--catalog>=I<CATALOG_NAME>

Specifies the name of the IPA catalog to export from.

=item B<--time>=I<TIME>

This argument allows you to export a dataset that was active at
I<TIME>. The expected format of this option is
YYYY/MM/DD[:HH[:MM[:SS]]].  If this option is specified, a dataset will
only be returned if I<TIME> falls between the start and end time for
the dataset.  If this option is not specified, the "no time" dataset
for that catalog will be returned, if present.	See the B<TIME RANGES>
section of B<ipaimport(1)> for more information about how catalogs with
and without time information are handled.

=back

=head1 EXAMPLES

To export the "badhosts" IPSet from an IPA set catalog that has no time
information:

    $ rwipaexport --catalog=badhosts badhosts.set

To export the "flowcount" Bag from an IPA bag catalog that has time
information:

    rwipaexport --catalog=flowcount --time=2007/04/15 \
        flowcount-20070415.bag

=head1 NOTES

Currently, exporting an IPA prefix map catalog produces a text file
that must be processed by the B<rwpmapbuild(1)> utility, rather than
the binary prefix map file itself.  IPSets and Bags, however, are
exported as binary files.

=head1 SEE ALSO

B<rwipaimport(1)>, B<ipaimport(1)>, B<ipaexport(1)>, B<ipaquery(1)>

=cut

$SiLK: rwipaexport.pod 7161 2007-05-14 20:35:53Z tonyc $

Local Variables:
mode:text
indent-tabs-mode:nil
End: