1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/openpkg/index.8 Tue Jul 31 12:23:42 2012 +0200
1.3 @@ -0,0 +1,218 @@
1.4 +.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.22)
1.5 +.\"
1.6 +.\" Standard preamble:
1.7 +.\" ========================================================================
1.8 +.de Sp \" Vertical space (when we can't use .PP)
1.9 +.if t .sp .5v
1.10 +.if n .sp
1.11 +..
1.12 +.de Vb \" Begin verbatim text
1.13 +.ft CW
1.14 +.nf
1.15 +.ne \\$1
1.16 +..
1.17 +.de Ve \" End verbatim text
1.18 +.ft R
1.19 +.fi
1.20 +..
1.21 +.\" Set up some character translations and predefined strings. \*(-- will
1.22 +.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
1.23 +.\" double quote, and \*(R" will give a right double quote. \*(C+ will
1.24 +.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
1.25 +.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
1.26 +.\" nothing in troff, for use with C<>.
1.27 +.tr \(*W-
1.28 +.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
1.29 +.ie n \{\
1.30 +. ds -- \(*W-
1.31 +. ds PI pi
1.32 +. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
1.33 +. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
1.34 +. ds L" ""
1.35 +. ds R" ""
1.36 +. ds C`
1.37 +. ds C'
1.38 +'br\}
1.39 +.el\{\
1.40 +. ds -- \|\(em\|
1.41 +. ds PI \(*p
1.42 +. ds L" ``
1.43 +. ds R" ''
1.44 +'br\}
1.45 +.\"
1.46 +.\" Escape single quotes in literal strings from groff's Unicode transform.
1.47 +.ie \n(.g .ds Aq \(aq
1.48 +.el .ds Aq '
1.49 +.\"
1.50 +.\" If the F register is turned on, we'll generate index entries on stderr for
1.51 +.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
1.52 +.\" entries marked with X<> in POD. Of course, you'll have to process the
1.53 +.\" output yourself in some meaningful fashion.
1.54 +.ie \nF \{\
1.55 +. de IX
1.56 +. tm Index:\\$1\t\\n%\t"\\$2"
1.57 +..
1.58 +. nr % 0
1.59 +. rr F
1.60 +.\}
1.61 +.el \{\
1.62 +. de IX
1.63 +..
1.64 +.\}
1.65 +.\"
1.66 +.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
1.67 +.\" Fear. Run. Save yourself. No user-serviceable parts.
1.68 +. \" fudge factors for nroff and troff
1.69 +.if n \{\
1.70 +. ds #H 0
1.71 +. ds #V .8m
1.72 +. ds #F .3m
1.73 +. ds #[ \f1
1.74 +. ds #] \fP
1.75 +.\}
1.76 +.if t \{\
1.77 +. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
1.78 +. ds #V .6m
1.79 +. ds #F 0
1.80 +. ds #[ \&
1.81 +. ds #] \&
1.82 +.\}
1.83 +. \" simple accents for nroff and troff
1.84 +.if n \{\
1.85 +. ds ' \&
1.86 +. ds ` \&
1.87 +. ds ^ \&
1.88 +. ds , \&
1.89 +. ds ~ ~
1.90 +. ds /
1.91 +.\}
1.92 +.if t \{\
1.93 +. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
1.94 +. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
1.95 +. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
1.96 +. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
1.97 +. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
1.98 +. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
1.99 +.\}
1.100 +. \" troff and (daisy-wheel) nroff accents
1.101 +.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
1.102 +.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
1.103 +.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
1.104 +.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
1.105 +.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
1.106 +.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
1.107 +.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
1.108 +.ds ae a\h'-(\w'a'u*4/10)'e
1.109 +.ds Ae A\h'-(\w'A'u*4/10)'E
1.110 +. \" corrections for vroff
1.111 +.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
1.112 +.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
1.113 +. \" for low resolution devices (crt and lpr)
1.114 +.if \n(.H>23 .if \n(.V>19 \
1.115 +\{\
1.116 +. ds : e
1.117 +. ds 8 ss
1.118 +. ds o a
1.119 +. ds d- d\h'-1'\(ga
1.120 +. ds D- D\h'-1'\(hy
1.121 +. ds th \o'bp'
1.122 +. ds Th \o'LP'
1.123 +. ds ae ae
1.124 +. ds Ae AE
1.125 +.\}
1.126 +.rm #[ #] #H #V #F C
1.127 +.\" ========================================================================
1.128 +.\"
1.129 +.IX Title "INDEX 8"
1.130 +.TH INDEX 8 "OpenPKG" "INDEX(8)" "OpenPKG"
1.131 +.\" For nroff, turn off justification. Always turn off hyphenation; it makes
1.132 +.\" way too many mistakes in technical documents.
1.133 +.if n .ad l
1.134 +.nh
1.135 +.SH "NAME"
1.136 +openpkg index \- OpenPKG Package Indexing
1.137 +.SH "SYNOPSIS"
1.138 +.IX Header "SYNOPSIS"
1.139 +\&\fBopenpkg\fR
1.140 +\&\fBindex\fR
1.141 +[\fB\-r\fR \fIresource\fR]
1.142 +[\fB\-p\fR \fIplatform\fR]
1.143 +[\fB\-S\fR]
1.144 +[\fB\-T\fR]
1.145 +[\fB\-D\fR]
1.146 +[\fB\-C\fR \fIcache.db\fR]
1.147 +[\fB\-o\fR \fIindex.rdf\fR]
1.148 +[\fB\-c\fR]
1.149 +[\fB\-i\fR]
1.150 +\&\fIdir\fR ...
1.151 +.SH "DESCRIPTION"
1.152 +.IX Header "DESCRIPTION"
1.153 +The \fBopenpkg index\fR tool is a frontend for indexing of \s-1RPM\s0 files. It
1.154 +creates an \s-1XML/RDF\s0 based resource index for \s-1RPM\s0 \fI.spec\fR files in a
1.155 +source tree or from an \s-1RPM\s0 package repository. The index holds enough
1.156 +information to support an automated build process by \fBopenpkg build\fR.
1.157 +.SH "OPTIONS"
1.158 +.IX Header "OPTIONS"
1.159 +The following command line options exist:
1.160 +.IP "\fB\-r\fR \fIresource\fR" 4
1.161 +.IX Item "-r resource"
1.162 +The name of the resource stored in the index. The default is
1.163 +"\f(CW\*(C`OpenPKG\-CURRENT/Source/\*(C'\fR".
1.164 +.IP "\fB\-p\fR \fIplatform\fR" 4
1.165 +.IX Item "-p platform"
1.166 +\&\fBopenpkg index\fR adds a platform attribute for binary RPMs. This
1.167 +must be unique to correctly identify a specific architecture, \s-1OS\s0
1.168 +and build environment.
1.169 +.IP "\fB\-S\fR" 4
1.170 +.IX Item "-S"
1.171 +Optionally determines and stores the size (in bytes) of each indexed file.
1.172 +This is not required for the correct operation of the \fBopenpkg build\fR command, but
1.173 +the \fBopenpkg mirror\fR command requires it.
1.174 +.IP "\fB\-T\fR" 4
1.175 +.IX Item "-T"
1.176 +Optionally determines and stores the modification time (\f(CW\*(C`mtime\*(C'\fR) of each indexed file.
1.177 +This is not required for the correct operation of the \fBopenpkg build\fR command, but
1.178 +the \fBopenpkg mirror\fR command requires it.
1.179 +.IP "\fB\-D\fR" 4
1.180 +.IX Item "-D"
1.181 +Optionally determines and stores the message digest (\f(CW\*(C`md5\*(C'\fR) of each indexed file.
1.182 +This is not required for the correct operation of the \fBopenpkg build\fR command, but
1.183 +the \fBopenpkg mirror\fR command requires it.
1.184 +.IP "\fB\-C\fR \fIcache.db\fR" 4
1.185 +.IX Item "-C cache.db"
1.186 +Cache all \fI.spec\fR files into this Berkeley-DB file when indexing source
1.187 +RPMs. The cache is refreshed automatically when the source RPMs are more
1.188 +recent than the cache entry. The \fB\-C\fR option requires an installed
1.189 +DB_File perl module.
1.190 +.IP "\fB\-o\fR \fIindex.rdf\fR" 4
1.191 +.IX Item "-o index.rdf"
1.192 +Name of the output \s-1XML/RDF\s0 file, default is to write to \fIstdout\fR.
1.193 +.IP "\fB\-c\fR" 4
1.194 +.IX Item "-c"
1.195 +Compress output with \f(CW\*(C`bzip2\*(C'\fR. Use the \fB\-o\fR option to specify a \fI.bz2\fR
1.196 +suffix.
1.197 +.IP "\fB\-i\fR" 4
1.198 +.IX Item "-i"
1.199 +The specified directories are \s-1RPM\s0 repositories. Build index over
1.200 +all \fI.rpm\fR files in these directories and all subdirectories.
1.201 +If a subdirectory already contains a \f(CW\*(C`00INDEX.rdf\*(C'\fR or \f(CW\*(C`00INDEX.rdf.*\*(C'\fR
1.202 +file then skip scanning the subdirectory, instead add a reference
1.203 +to the index file into the new index.
1.204 +.Sp
1.205 +Without this option the directories are source trees with a subdirectory
1.206 +per package and a \fIpackage\fR\f(CW\*(C`.spec\*(C'\fR file inside each subdirectory.
1.207 +.SH "SEE ALSO"
1.208 +.IX Header "SEE ALSO"
1.209 +\&\fIrpm\fR\|(8).
1.210 +.SH "HISTORY"
1.211 +.IX Header "HISTORY"
1.212 +The \fBopenpkg index\fR command was invented in November 2002 by \fIMichael
1.213 +van Elst\fR <mlelstv@serpens.de> under contract with \fICable
1.214 +& Wireless\fR <http://www.cw.com/> for use inside the \fBOpenPKG\fR
1.215 +project <http://www.openpkg.org/>.
1.216 +.SH "AUTHORS"
1.217 +.IX Header "AUTHORS"
1.218 +.Vb 2
1.219 +\& Michael van Elst
1.220 +\& mlelstv@serpens.de
1.221 +.Ve
