OpenPKG Specs: openpkg/index.pod@a2c6460cfb16

Correct socket error reporting improvement with IPv6 portable code,
after helpful recommendation by Saúl Ibarra Corretgé on OSips devlist.

     1 ##

     2 ##  index.pod -- OpenPKG Package Indexing

     3 ##  Copyright (c) 2000-2012 OpenPKG GmbH <http://openpkg.com/>

     4 ##

     5 ##  This software is property of the OpenPKG GmbH, DE MUC HRB 160208.

     6 ##  All rights reserved. Licenses which grant limited permission to use,

     7 ##  copy, modify and distribute this software are available from the

     8 ##  OpenPKG GmbH.

     9 ##

    10 ##  THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED

    11 ##  WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF

    12 ##  MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.

    13 ##  IN NO EVENT SHALL THE AUTHORS AND COPYRIGHT HOLDERS AND THEIR

    14 ##  CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,

    15 ##  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT

    16 ##  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF

    17 ##  USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND

    18 ##  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,

    19 ##  OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT

    20 ##  OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF

    21 ##  SUCH DAMAGE.

    22 ##

    24 =pod

    26 =head1 NAME

    28 B<openpkg index> - B<OpenPKG> Package Indexing

    30 =head1 SYNOPSIS

    32 B<openpkg>

    33 B<index>

    34 [B<-r> I<resource>]

    35 [B<-p> I<platform>]

    36 [B<-S>]

    37 [B<-T>]

    38 [B<-D>]

    39 [B<-C> I<cache.db>]

    40 [B<-o> I<index.rdf>]

    41 [B<-c>]

    42 [B<-i>]

    43 I<dir> ...

    45 =head1 DESCRIPTION

    47 The B<openpkg index> tool is a frontend for indexing of RPM files. It

    48 creates an XML/RDF based resource index for RPM F<.spec> files in a

    49 source tree or from an RPM package repository. The index holds enough

    50 information to support an automated build process by B<openpkg build>.

    52 =head1 OPTIONS

    54 The following command line options exist:

    56 =over 4

    58 =item B<-r> I<resource>

    60 The name of the resource stored in the index. The default is

    61 "C<OpenPKG-CURRENT/Source/>".

    63 =item B<-p> I<platform>

    65 B<openpkg index> adds a platform attribute for binary RPMs. This

    66 must be unique to correctly identify a specific architecture, OS

    67 and build environment.

    69 =item B<-S>

    71 Optionally determines and stores the size (in bytes) of each indexed file.

    72 This is not required for the correct operation of the B<openpkg build> command, but

    73 the B<openpkg mirror> command requires it.

    75 =item B<-T>

    77 Optionally determines and stores the modification time (C<mtime>) of each indexed file.

    78 This is not required for the correct operation of the B<openpkg build> command, but

    79 the B<openpkg mirror> command requires it.

    81 =item B<-D>

    83 Optionally determines and stores the message digest (C<md5>) of each indexed file.

    84 This is not required for the correct operation of the B<openpkg build> command, but

    85 the B<openpkg mirror> command requires it.

    87 =item B<-C> I<cache.db>

    89 Cache all F<.spec> files into this Berkeley-DB file when indexing source

    90 RPMs. The cache is refreshed automatically when the source RPMs are more

    91 recent than the cache entry. The B<-C> option requires an installed

    92 DB_File perl module.

    94 =item B<-o> I<index.rdf>

    96 Name of the output XML/RDF file, default is to write to F<stdout>.

    98 =item B<-c>

   100 Compress output with C<bzip2>. Use the B<-o> option to specify a F<.bz2>

   101 suffix.

   103 =item B<-i>

   105 The specified directories are RPM repositories. Build index over

   106 all F<.rpm> files in these directories and all subdirectories.

   107 If a subdirectory already contains a C<00INDEX.rdf> or C<00INDEX.rdf.*>

   108 file then skip scanning the subdirectory, instead add a reference

   109 to the index file into the new index.

   111 Without this option the directories are source trees with a subdirectory

   112 per package and a I<package>C<.spec> file inside each subdirectory.

   114 =back

   116 =head1 SEE ALSO

   118 rpm(8).

   120 =head1 HISTORY

   122 The B<openpkg index> command was invented in November 2002 by I<Michael

   123 van Elst> E<lt>mlelstv@serpens.deE<gt> under contract with I<Cable

   124 & Wireless> E<lt>http://www.cw.com/E<gt> for use inside the B<OpenPKG>

   125 project E<lt>http://www.openpkg.org/E<gt>.

   127 =head1 AUTHORS

   129  Michael van Elst

   130  mlelstv@serpens.de

   132 =cut

OpenPKG Specs / file revision