openpkg/index.pod@a2c6460cfb16 (annotated)
openpkg/index.pod
Mon, 28 Jan 2013 17:37:18 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Mon, 28 Jan 2013 17:37:18 +0100
- changeset 758
- a2c6460cfb16
- permissions
- -rw-r--r--
Correct socket error reporting improvement with IPv6 portable code,
after helpful recommendation by Saúl Ibarra Corretgé on OSips devlist.
| michael@428 | 1 | ## |
| michael@428 | 2 | ## index.pod -- OpenPKG Package Indexing |
| michael@428 | 3 | ## Copyright (c) 2000-2012 OpenPKG GmbH <http://openpkg.com/> |
| michael@428 | 4 | ## |
| michael@428 | 5 | ## This software is property of the OpenPKG GmbH, DE MUC HRB 160208. |
| michael@428 | 6 | ## All rights reserved. Licenses which grant limited permission to use, |
| michael@428 | 7 | ## copy, modify and distribute this software are available from the |
| michael@428 | 8 | ## OpenPKG GmbH. |
| michael@428 | 9 | ## |
| michael@428 | 10 | ## THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED |
| michael@428 | 11 | ## WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF |
| michael@428 | 12 | ## MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. |
| michael@428 | 13 | ## IN NO EVENT SHALL THE AUTHORS AND COPYRIGHT HOLDERS AND THEIR |
| michael@428 | 14 | ## CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| michael@428 | 15 | ## SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
| michael@428 | 16 | ## LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF |
| michael@428 | 17 | ## USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND |
| michael@428 | 18 | ## ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, |
| michael@428 | 19 | ## OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT |
| michael@428 | 20 | ## OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF |
| michael@428 | 21 | ## SUCH DAMAGE. |
| michael@428 | 22 | ## |
| michael@428 | 23 | |
| michael@428 | 24 | =pod |
| michael@428 | 25 | |
| michael@428 | 26 | =head1 NAME |
| michael@428 | 27 | |
| michael@428 | 28 | B<openpkg index> - B<OpenPKG> Package Indexing |
| michael@428 | 29 | |
| michael@428 | 30 | =head1 SYNOPSIS |
| michael@428 | 31 | |
| michael@428 | 32 | B<openpkg> |
| michael@428 | 33 | B<index> |
| michael@428 | 34 | [B<-r> I<resource>] |
| michael@428 | 35 | [B<-p> I<platform>] |
| michael@428 | 36 | [B<-S>] |
| michael@428 | 37 | [B<-T>] |
| michael@428 | 38 | [B<-D>] |
| michael@428 | 39 | [B<-C> I<cache.db>] |
| michael@428 | 40 | [B<-o> I<index.rdf>] |
| michael@428 | 41 | [B<-c>] |
| michael@428 | 42 | [B<-i>] |
| michael@428 | 43 | I<dir> ... |
| michael@428 | 44 | |
| michael@428 | 45 | =head1 DESCRIPTION |
| michael@428 | 46 | |
| michael@428 | 47 | The B<openpkg index> tool is a frontend for indexing of RPM files. It |
| michael@428 | 48 | creates an XML/RDF based resource index for RPM F<.spec> files in a |
| michael@428 | 49 | source tree or from an RPM package repository. The index holds enough |
| michael@428 | 50 | information to support an automated build process by B<openpkg build>. |
| michael@428 | 51 | |
| michael@428 | 52 | =head1 OPTIONS |
| michael@428 | 53 | |
| michael@428 | 54 | The following command line options exist: |
| michael@428 | 55 | |
| michael@428 | 56 | =over 4 |
| michael@428 | 57 | |
| michael@428 | 58 | =item B<-r> I<resource> |
| michael@428 | 59 | |
| michael@428 | 60 | The name of the resource stored in the index. The default is |
| michael@428 | 61 | "C<OpenPKG-CURRENT/Source/>". |
| michael@428 | 62 | |
| michael@428 | 63 | =item B<-p> I<platform> |
| michael@428 | 64 | |
| michael@428 | 65 | B<openpkg index> adds a platform attribute for binary RPMs. This |
| michael@428 | 66 | must be unique to correctly identify a specific architecture, OS |
| michael@428 | 67 | and build environment. |
| michael@428 | 68 | |
| michael@428 | 69 | =item B<-S> |
| michael@428 | 70 | |
| michael@428 | 71 | Optionally determines and stores the size (in bytes) of each indexed file. |
| michael@428 | 72 | This is not required for the correct operation of the B<openpkg build> command, but |
| michael@428 | 73 | the B<openpkg mirror> command requires it. |
| michael@428 | 74 | |
| michael@428 | 75 | =item B<-T> |
| michael@428 | 76 | |
| michael@428 | 77 | Optionally determines and stores the modification time (C<mtime>) of each indexed file. |
| michael@428 | 78 | This is not required for the correct operation of the B<openpkg build> command, but |
| michael@428 | 79 | the B<openpkg mirror> command requires it. |
| michael@428 | 80 | |
| michael@428 | 81 | =item B<-D> |
| michael@428 | 82 | |
| michael@428 | 83 | Optionally determines and stores the message digest (C<md5>) of each indexed file. |
| michael@428 | 84 | This is not required for the correct operation of the B<openpkg build> command, but |
| michael@428 | 85 | the B<openpkg mirror> command requires it. |
| michael@428 | 86 | |
| michael@428 | 87 | =item B<-C> I<cache.db> |
| michael@428 | 88 | |
| michael@428 | 89 | Cache all F<.spec> files into this Berkeley-DB file when indexing source |
| michael@428 | 90 | RPMs. The cache is refreshed automatically when the source RPMs are more |
| michael@428 | 91 | recent than the cache entry. The B<-C> option requires an installed |
| michael@428 | 92 | DB_File perl module. |
| michael@428 | 93 | |
| michael@428 | 94 | =item B<-o> I<index.rdf> |
| michael@428 | 95 | |
| michael@428 | 96 | Name of the output XML/RDF file, default is to write to F<stdout>. |
| michael@428 | 97 | |
| michael@428 | 98 | =item B<-c> |
| michael@428 | 99 | |
| michael@428 | 100 | Compress output with C<bzip2>. Use the B<-o> option to specify a F<.bz2> |
| michael@428 | 101 | suffix. |
| michael@428 | 102 | |
| michael@428 | 103 | =item B<-i> |
| michael@428 | 104 | |
| michael@428 | 105 | The specified directories are RPM repositories. Build index over |
| michael@428 | 106 | all F<.rpm> files in these directories and all subdirectories. |
| michael@428 | 107 | If a subdirectory already contains a C<00INDEX.rdf> or C<00INDEX.rdf.*> |
| michael@428 | 108 | file then skip scanning the subdirectory, instead add a reference |
| michael@428 | 109 | to the index file into the new index. |
| michael@428 | 110 | |
| michael@428 | 111 | Without this option the directories are source trees with a subdirectory |
| michael@428 | 112 | per package and a I<package>C<.spec> file inside each subdirectory. |
| michael@428 | 113 | |
| michael@428 | 114 | =back |
| michael@428 | 115 | |
| michael@428 | 116 | =head1 SEE ALSO |
| michael@428 | 117 | |
| michael@428 | 118 | rpm(8). |
| michael@428 | 119 | |
| michael@428 | 120 | =head1 HISTORY |
| michael@428 | 121 | |
| michael@428 | 122 | The B<openpkg index> command was invented in November 2002 by I<Michael |
| michael@428 | 123 | van Elst> E<lt>mlelstv@serpens.deE<gt> under contract with I<Cable |
| michael@428 | 124 | & Wireless> E<lt>http://www.cw.com/E<gt> for use inside the B<OpenPKG> |
| michael@428 | 125 | project E<lt>http://www.openpkg.org/E<gt>. |
| michael@428 | 126 | |
| michael@428 | 127 | =head1 AUTHORS |
| michael@428 | 128 | |
| michael@428 | 129 | Michael van Elst |
| michael@428 | 130 | mlelstv@serpens.de |
| michael@428 | 131 | |
| michael@428 | 132 | =cut |
| michael@428 | 133 |
