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