diff -r 71503088f51b -r f880f219c566 openpkg/index.8 --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/openpkg/index.8 Tue Jul 31 12:23:42 2012 +0200 @@ -0,0 +1,218 @@ +.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.22) +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. +.\" Set up some character translations and predefined strings. \*(-- will +.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left +.\" double quote, and \*(R" will give a right double quote. \*(C+ will +.\" give a nicer C++. Capital omega is used to do unbreakable dashes and +.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, +.\" nothing in troff, for use with C<>. +.tr \(*W- +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' +.ie n \{\ +. ds -- \(*W- +. ds PI pi +. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch +. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch +. ds L" "" +. ds R" "" +. ds C` +. ds C' +'br\} +.el\{\ +. ds -- \|\(em\| +. ds PI \(*p +. ds L" `` +. ds R" '' +'br\} +.\" +.\" Escape single quotes in literal strings from groff's Unicode transform. +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" +.\" If the F register is turned on, we'll generate index entries on stderr for +.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index +.\" entries marked with X<> in POD. Of course, you'll have to process the +.\" output yourself in some meaningful fashion. +.ie \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" +.. +. nr % 0 +. rr F +.\} +.el \{\ +. de IX +.. +.\} +.\" +.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). +.\" Fear. Run. Save yourself. No user-serviceable parts. +. \" fudge factors for nroff and troff +.if n \{\ +. ds #H 0 +. ds #V .8m +. ds #F .3m +. ds #[ \f1 +. ds #] \fP +.\} +.if t \{\ +. ds #H ((1u-(\\\\n(.fu%2u))*.13m) +. ds #V .6m +. ds #F 0 +. ds #[ \& +. ds #] \& +.\} +. \" simple accents for nroff and troff +.if n \{\ +. ds ' \& +. ds ` \& +. ds ^ \& +. ds , \& +. ds ~ ~ +. ds / +.\} +.if t \{\ +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' +.\} +. \" troff and (daisy-wheel) nroff accents +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' +.ds 8 \h'\*(#H'\(*b\h'-\*(#H' +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] +.ds ae a\h'-(\w'a'u*4/10)'e +.ds Ae A\h'-(\w'A'u*4/10)'E +. \" corrections for vroff +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' +. \" for low resolution devices (crt and lpr) +.if \n(.H>23 .if \n(.V>19 \ +\{\ +. ds : e +. ds 8 ss +. ds o a +. ds d- d\h'-1'\(ga +. ds D- D\h'-1'\(hy +. ds th \o'bp' +. ds Th \o'LP' +. ds ae ae +. ds Ae AE +.\} +.rm #[ #] #H #V #F C +.\" ======================================================================== +.\" +.IX Title "INDEX 8" +.TH INDEX 8 "OpenPKG" "INDEX(8)" "OpenPKG" +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.if n .ad l +.nh +.SH "NAME" +openpkg index \- OpenPKG Package Indexing +.SH "SYNOPSIS" +.IX Header "SYNOPSIS" +\&\fBopenpkg\fR +\&\fBindex\fR +[\fB\-r\fR \fIresource\fR] +[\fB\-p\fR \fIplatform\fR] +[\fB\-S\fR] +[\fB\-T\fR] +[\fB\-D\fR] +[\fB\-C\fR \fIcache.db\fR] +[\fB\-o\fR \fIindex.rdf\fR] +[\fB\-c\fR] +[\fB\-i\fR] +\&\fIdir\fR ... +.SH "DESCRIPTION" +.IX Header "DESCRIPTION" +The \fBopenpkg index\fR tool is a frontend for indexing of \s-1RPM\s0 files. It +creates an \s-1XML/RDF\s0 based resource index for \s-1RPM\s0 \fI.spec\fR files in a +source tree or from an \s-1RPM\s0 package repository. The index holds enough +information to support an automated build process by \fBopenpkg build\fR. +.SH "OPTIONS" +.IX Header "OPTIONS" +The following command line options exist: +.IP "\fB\-r\fR \fIresource\fR" 4 +.IX Item "-r resource" +The name of the resource stored in the index. The default is +"\f(CW\*(C`OpenPKG\-CURRENT/Source/\*(C'\fR". +.IP "\fB\-p\fR \fIplatform\fR" 4 +.IX Item "-p platform" +\&\fBopenpkg index\fR adds a platform attribute for binary RPMs. This +must be unique to correctly identify a specific architecture, \s-1OS\s0 +and build environment. +.IP "\fB\-S\fR" 4 +.IX Item "-S" +Optionally determines and stores the size (in bytes) of each indexed file. +This is not required for the correct operation of the \fBopenpkg build\fR command, but +the \fBopenpkg mirror\fR command requires it. +.IP "\fB\-T\fR" 4 +.IX Item "-T" +Optionally determines and stores the modification time (\f(CW\*(C`mtime\*(C'\fR) of each indexed file. +This is not required for the correct operation of the \fBopenpkg build\fR command, but +the \fBopenpkg mirror\fR command requires it. +.IP "\fB\-D\fR" 4 +.IX Item "-D" +Optionally determines and stores the message digest (\f(CW\*(C`md5\*(C'\fR) of each indexed file. +This is not required for the correct operation of the \fBopenpkg build\fR command, but +the \fBopenpkg mirror\fR command requires it. +.IP "\fB\-C\fR \fIcache.db\fR" 4 +.IX Item "-C cache.db" +Cache all \fI.spec\fR 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 \fB\-C\fR option requires an installed +DB_File perl module. +.IP "\fB\-o\fR \fIindex.rdf\fR" 4 +.IX Item "-o index.rdf" +Name of the output \s-1XML/RDF\s0 file, default is to write to \fIstdout\fR. +.IP "\fB\-c\fR" 4 +.IX Item "-c" +Compress output with \f(CW\*(C`bzip2\*(C'\fR. Use the \fB\-o\fR option to specify a \fI.bz2\fR +suffix. +.IP "\fB\-i\fR" 4 +.IX Item "-i" +The specified directories are \s-1RPM\s0 repositories. Build index over +all \fI.rpm\fR files in these directories and all subdirectories. +If a subdirectory already contains a \f(CW\*(C`00INDEX.rdf\*(C'\fR or \f(CW\*(C`00INDEX.rdf.*\*(C'\fR +file then skip scanning the subdirectory, instead add a reference +to the index file into the new index. +.Sp +Without this option the directories are source trees with a subdirectory +per package and a \fIpackage\fR\f(CW\*(C`.spec\*(C'\fR file inside each subdirectory. +.SH "SEE ALSO" +.IX Header "SEE ALSO" +\&\fIrpm\fR\|(8). +.SH "HISTORY" +.IX Header "HISTORY" +The \fBopenpkg index\fR command was invented in November 2002 by \fIMichael +van Elst\fR under contract with \fICable +& Wireless\fR for use inside the \fBOpenPKG\fR +project . +.SH "AUTHORS" +.IX Header "AUTHORS" +.Vb 2 +\& Michael van Elst +\& mlelstv@serpens.de +.Ve