comparison: openpkg/index.pod
openpkg/index.pod
- changeset 540
- 6becb64fe77d
equal
deleted
inserted
replaced
| -1:000000000000 | 0:803a97c185ed |
|---|---|
| 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 ## | |
| 23 | |
| 24 =pod | |
| 25 | |
| 26 =head1 NAME | |
| 27 | |
| 28 B<openpkg index> - B<OpenPKG> Package Indexing | |
| 29 | |
| 30 =head1 SYNOPSIS | |
| 31 | |
| 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> ... | |
| 44 | |
| 45 =head1 DESCRIPTION | |
| 46 | |
| 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>. | |
| 51 | |
| 52 =head1 OPTIONS | |
| 53 | |
| 54 The following command line options exist: | |
| 55 | |
| 56 =over 4 | |
| 57 | |
| 58 =item B<-r> I<resource> | |
| 59 | |
| 60 The name of the resource stored in the index. The default is | |
| 61 "C<OpenPKG-CURRENT/Source/>". | |
| 62 | |
| 63 =item B<-p> I<platform> | |
| 64 | |
| 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. | |
| 68 | |
| 69 =item B<-S> | |
| 70 | |
| 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. | |
| 74 | |
| 75 =item B<-T> | |
| 76 | |
| 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. | |
| 80 | |
| 81 =item B<-D> | |
| 82 | |
| 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. | |
| 86 | |
| 87 =item B<-C> I<cache.db> | |
| 88 | |
| 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. | |
| 93 | |
| 94 =item B<-o> I<index.rdf> | |
| 95 | |
| 96 Name of the output XML/RDF file, default is to write to F<stdout>. | |
| 97 | |
| 98 =item B<-c> | |
| 99 | |
| 100 Compress output with C<bzip2>. Use the B<-o> option to specify a F<.bz2> | |
| 101 suffix. | |
| 102 | |
| 103 =item B<-i> | |
| 104 | |
| 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. | |
| 110 | |
| 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. | |
| 113 | |
| 114 =back | |
| 115 | |
| 116 =head1 SEE ALSO | |
| 117 | |
| 118 rpm(8). | |
| 119 | |
| 120 =head1 HISTORY | |
| 121 | |
| 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>. | |
| 126 | |
| 127 =head1 AUTHORS | |
| 128 | |
| 129 Michael van Elst | |
| 130 mlelstv@serpens.de | |
| 131 | |
| 132 =cut | |
| 133 |
