1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/openpkg/index.pod Tue Jul 31 12:23:42 2012 +0200
1.3 @@ -0,0 +1,133 @@
1.4 +##
1.5 +## index.pod -- OpenPKG Package Indexing
1.6 +## Copyright (c) 2000-2012 OpenPKG GmbH <http://openpkg.com/>
1.7 +##
1.8 +## This software is property of the OpenPKG GmbH, DE MUC HRB 160208.
1.9 +## All rights reserved. Licenses which grant limited permission to use,
1.10 +## copy, modify and distribute this software are available from the
1.11 +## OpenPKG GmbH.
1.12 +##
1.13 +## THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED
1.14 +## WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
1.15 +## MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
1.16 +## IN NO EVENT SHALL THE AUTHORS AND COPYRIGHT HOLDERS AND THEIR
1.17 +## CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
1.18 +## SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
1.19 +## LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
1.20 +## USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
1.21 +## ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
1.22 +## OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
1.23 +## OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
1.24 +## SUCH DAMAGE.
1.25 +##
1.26 +
1.27 +=pod
1.28 +
1.29 +=head1 NAME
1.30 +
1.31 +B<openpkg index> - B<OpenPKG> Package Indexing
1.32 +
1.33 +=head1 SYNOPSIS
1.34 +
1.35 +B<openpkg>
1.36 +B<index>
1.37 +[B<-r> I<resource>]
1.38 +[B<-p> I<platform>]
1.39 +[B<-S>]
1.40 +[B<-T>]
1.41 +[B<-D>]
1.42 +[B<-C> I<cache.db>]
1.43 +[B<-o> I<index.rdf>]
1.44 +[B<-c>]
1.45 +[B<-i>]
1.46 +I<dir> ...
1.47 +
1.48 +=head1 DESCRIPTION
1.49 +
1.50 +The B<openpkg index> tool is a frontend for indexing of RPM files. It
1.51 +creates an XML/RDF based resource index for RPM F<.spec> files in a
1.52 +source tree or from an RPM package repository. The index holds enough
1.53 +information to support an automated build process by B<openpkg build>.
1.54 +
1.55 +=head1 OPTIONS
1.56 +
1.57 +The following command line options exist:
1.58 +
1.59 +=over 4
1.60 +
1.61 +=item B<-r> I<resource>
1.62 +
1.63 +The name of the resource stored in the index. The default is
1.64 +"C<OpenPKG-CURRENT/Source/>".
1.65 +
1.66 +=item B<-p> I<platform>
1.67 +
1.68 +B<openpkg index> adds a platform attribute for binary RPMs. This
1.69 +must be unique to correctly identify a specific architecture, OS
1.70 +and build environment.
1.71 +
1.72 +=item B<-S>
1.73 +
1.74 +Optionally determines and stores the size (in bytes) of each indexed file.
1.75 +This is not required for the correct operation of the B<openpkg build> command, but
1.76 +the B<openpkg mirror> command requires it.
1.77 +
1.78 +=item B<-T>
1.79 +
1.80 +Optionally determines and stores the modification time (C<mtime>) of each indexed file.
1.81 +This is not required for the correct operation of the B<openpkg build> command, but
1.82 +the B<openpkg mirror> command requires it.
1.83 +
1.84 +=item B<-D>
1.85 +
1.86 +Optionally determines and stores the message digest (C<md5>) of each indexed file.
1.87 +This is not required for the correct operation of the B<openpkg build> command, but
1.88 +the B<openpkg mirror> command requires it.
1.89 +
1.90 +=item B<-C> I<cache.db>
1.91 +
1.92 +Cache all F<.spec> files into this Berkeley-DB file when indexing source
1.93 +RPMs. The cache is refreshed automatically when the source RPMs are more
1.94 +recent than the cache entry. The B<-C> option requires an installed
1.95 +DB_File perl module.
1.96 +
1.97 +=item B<-o> I<index.rdf>
1.98 +
1.99 +Name of the output XML/RDF file, default is to write to F<stdout>.
1.100 +
1.101 +=item B<-c>
1.102 +
1.103 +Compress output with C<bzip2>. Use the B<-o> option to specify a F<.bz2>
1.104 +suffix.
1.105 +
1.106 +=item B<-i>
1.107 +
1.108 +The specified directories are RPM repositories. Build index over
1.109 +all F<.rpm> files in these directories and all subdirectories.
1.110 +If a subdirectory already contains a C<00INDEX.rdf> or C<00INDEX.rdf.*>
1.111 +file then skip scanning the subdirectory, instead add a reference
1.112 +to the index file into the new index.
1.113 +
1.114 +Without this option the directories are source trees with a subdirectory
1.115 +per package and a I<package>C<.spec> file inside each subdirectory.
1.116 +
1.117 +=back
1.118 +
1.119 +=head1 SEE ALSO
1.120 +
1.121 +rpm(8).
1.122 +
1.123 +=head1 HISTORY
1.124 +
1.125 +The B<openpkg index> command was invented in November 2002 by I<Michael
1.126 +van Elst> E<lt>mlelstv@serpens.deE<gt> under contract with I<Cable
1.127 +& Wireless> E<lt>http://www.cw.com/E<gt> for use inside the B<OpenPKG>
1.128 +project E<lt>http://www.openpkg.org/E<gt>.
1.129 +
1.130 +=head1 AUTHORS
1.131 +
1.132 + Michael van Elst
1.133 + mlelstv@serpens.de
1.134 +
1.135 +=cut
1.136 +
