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