michael@428: ##
michael@428: ##  index.pod -- OpenPKG Package Indexing
michael@428: ##  Copyright (c) 2000-2012 OpenPKG GmbH <http://openpkg.com/>
michael@428: ##
michael@428: ##  This software is property of the OpenPKG GmbH, DE MUC HRB 160208.
michael@428: ##  All rights reserved. Licenses which grant limited permission to use,
michael@428: ##  copy, modify and distribute this software are available from the
michael@428: ##  OpenPKG GmbH.
michael@428: ##
michael@428: ##  THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED
michael@428: ##  WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
michael@428: ##  MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
michael@428: ##  IN NO EVENT SHALL THE AUTHORS AND COPYRIGHT HOLDERS AND THEIR
michael@428: ##  CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
michael@428: ##  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
michael@428: ##  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
michael@428: ##  USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
michael@428: ##  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
michael@428: ##  OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
michael@428: ##  OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
michael@428: ##  SUCH DAMAGE.
michael@428: ##
michael@428: 
michael@428: =pod
michael@428: 
michael@428: =head1 NAME
michael@428: 
michael@428: B<openpkg index> - B<OpenPKG> Package Indexing
michael@428: 
michael@428: =head1 SYNOPSIS
michael@428: 
michael@428: B<openpkg>
michael@428: B<index>
michael@428: [B<-r> I<resource>]
michael@428: [B<-p> I<platform>]
michael@428: [B<-S>]
michael@428: [B<-T>]
michael@428: [B<-D>]
michael@428: [B<-C> I<cache.db>]
michael@428: [B<-o> I<index.rdf>]
michael@428: [B<-c>]
michael@428: [B<-i>]
michael@428: I<dir> ...
michael@428: 
michael@428: =head1 DESCRIPTION
michael@428: 
michael@428: The B<openpkg index> tool is a frontend for indexing of RPM files. It
michael@428: creates an XML/RDF based resource index for RPM F<.spec> files in a
michael@428: source tree or from an RPM package repository. The index holds enough
michael@428: information to support an automated build process by B<openpkg build>.
michael@428: 
michael@428: =head1 OPTIONS
michael@428: 
michael@428: The following command line options exist:
michael@428: 
michael@428: =over 4
michael@428: 
michael@428: =item B<-r> I<resource>
michael@428: 
michael@428: The name of the resource stored in the index. The default is
michael@428: "C<OpenPKG-CURRENT/Source/>".
michael@428: 
michael@428: =item B<-p> I<platform>
michael@428: 
michael@428: B<openpkg index> adds a platform attribute for binary RPMs. This
michael@428: must be unique to correctly identify a specific architecture, OS
michael@428: and build environment.
michael@428: 
michael@428: =item B<-S>
michael@428: 
michael@428: Optionally determines and stores the size (in bytes) of each indexed file.
michael@428: This is not required for the correct operation of the B<openpkg build> command, but
michael@428: the B<openpkg mirror> command requires it.
michael@428: 
michael@428: =item B<-T>
michael@428: 
michael@428: Optionally determines and stores the modification time (C<mtime>) of each indexed file.
michael@428: This is not required for the correct operation of the B<openpkg build> command, but
michael@428: the B<openpkg mirror> command requires it.
michael@428: 
michael@428: =item B<-D>
michael@428: 
michael@428: Optionally determines and stores the message digest (C<md5>) of each indexed file.
michael@428: This is not required for the correct operation of the B<openpkg build> command, but
michael@428: the B<openpkg mirror> command requires it.
michael@428: 
michael@428: =item B<-C> I<cache.db>
michael@428: 
michael@428: Cache all F<.spec> files into this Berkeley-DB file when indexing source
michael@428: RPMs. The cache is refreshed automatically when the source RPMs are more
michael@428: recent than the cache entry. The B<-C> option requires an installed
michael@428: DB_File perl module.
michael@428: 
michael@428: =item B<-o> I<index.rdf>
michael@428: 
michael@428: Name of the output XML/RDF file, default is to write to F<stdout>.
michael@428: 
michael@428: =item B<-c>
michael@428: 
michael@428: Compress output with C<bzip2>. Use the B<-o> option to specify a F<.bz2>
michael@428: suffix.
michael@428: 
michael@428: =item B<-i>
michael@428: 
michael@428: The specified directories are RPM repositories. Build index over
michael@428: all F<.rpm> files in these directories and all subdirectories.
michael@428: If a subdirectory already contains a C<00INDEX.rdf> or C<00INDEX.rdf.*>
michael@428: file then skip scanning the subdirectory, instead add a reference
michael@428: to the index file into the new index.
michael@428: 
michael@428: Without this option the directories are source trees with a subdirectory
michael@428: per package and a I<package>C<.spec> file inside each subdirectory.
michael@428: 
michael@428: =back
michael@428: 
michael@428: =head1 SEE ALSO
michael@428: 
michael@428: rpm(8).
michael@428: 
michael@428: =head1 HISTORY
michael@428: 
michael@428: The B<openpkg index> command was invented in November 2002 by I<Michael
michael@428: van Elst> E<lt>mlelstv@serpens.deE<gt> under contract with I<Cable
michael@428: & Wireless> E<lt>http://www.cw.com/E<gt> for use inside the B<OpenPKG>
michael@428: project E<lt>http://www.openpkg.org/E<gt>.
michael@428: 
michael@428: =head1 AUTHORS
michael@428: 
michael@428:  Michael van Elst
michael@428:  mlelstv@serpens.de
michael@428: 
michael@428: =cut
michael@428: