openpkg/index.8@a2c6460cfb16
openpkg/index.8
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.
1 .\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.22)
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
6 .if t .sp .5v
7 .if n .sp
8 ..
9 .de Vb \" Begin verbatim text
10 .ft CW
11 .nf
12 .ne \\$1
13 ..
14 .de Ve \" End verbatim text
15 .ft R
16 .fi
17 ..
18 .\" Set up some character translations and predefined strings. \*(-- will
19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
20 .\" double quote, and \*(R" will give a right double quote. \*(C+ will
21 .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
22 .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
23 .\" nothing in troff, for use with C<>.
24 .tr \(*W-
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
26 .ie n \{\
27 . ds -- \(*W-
28 . ds PI pi
29 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
31 . ds L" ""
32 . ds R" ""
33 . ds C`
34 . ds C'
35 'br\}
36 .el\{\
37 . ds -- \|\(em\|
38 . ds PI \(*p
39 . ds L" ``
40 . ds R" ''
41 'br\}
42 .\"
43 .\" Escape single quotes in literal strings from groff's Unicode transform.
44 .ie \n(.g .ds Aq \(aq
45 .el .ds Aq '
46 .\"
47 .\" If the F register is turned on, we'll generate index entries on stderr for
48 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
49 .\" entries marked with X<> in POD. Of course, you'll have to process the
50 .\" output yourself in some meaningful fashion.
51 .ie \nF \{\
52 . de IX
53 . tm Index:\\$1\t\\n%\t"\\$2"
54 ..
55 . nr % 0
56 . rr F
57 .\}
58 .el \{\
59 . de IX
60 ..
61 .\}
62 .\"
63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
64 .\" Fear. Run. Save yourself. No user-serviceable parts.
65 . \" fudge factors for nroff and troff
66 .if n \{\
67 . ds #H 0
68 . ds #V .8m
69 . ds #F .3m
70 . ds #[ \f1
71 . ds #] \fP
72 .\}
73 .if t \{\
74 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
75 . ds #V .6m
76 . ds #F 0
77 . ds #[ \&
78 . ds #] \&
79 .\}
80 . \" simple accents for nroff and troff
81 .if n \{\
82 . ds ' \&
83 . ds ` \&
84 . ds ^ \&
85 . ds , \&
86 . ds ~ ~
87 . ds /
88 .\}
89 .if t \{\
90 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
91 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
92 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
93 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
94 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
95 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
96 .\}
97 . \" troff and (daisy-wheel) nroff accents
98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
105 .ds ae a\h'-(\w'a'u*4/10)'e
106 .ds Ae A\h'-(\w'A'u*4/10)'E
107 . \" corrections for vroff
108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
110 . \" for low resolution devices (crt and lpr)
111 .if \n(.H>23 .if \n(.V>19 \
112 \{\
113 . ds : e
114 . ds 8 ss
115 . ds o a
116 . ds d- d\h'-1'\(ga
117 . ds D- D\h'-1'\(hy
118 . ds th \o'bp'
119 . ds Th \o'LP'
120 . ds ae ae
121 . ds Ae AE
122 .\}
123 .rm #[ #] #H #V #F C
124 .\" ========================================================================
125 .\"
126 .IX Title "INDEX 8"
127 .TH INDEX 8 "OpenPKG" "INDEX(8)" "OpenPKG"
128 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
129 .\" way too many mistakes in technical documents.
130 .if n .ad l
131 .nh
132 .SH "NAME"
133 openpkg index \- OpenPKG Package Indexing
134 .SH "SYNOPSIS"
135 .IX Header "SYNOPSIS"
136 \&\fBopenpkg\fR
137 \&\fBindex\fR
138 [\fB\-r\fR \fIresource\fR]
139 [\fB\-p\fR \fIplatform\fR]
140 [\fB\-S\fR]
141 [\fB\-T\fR]
142 [\fB\-D\fR]
143 [\fB\-C\fR \fIcache.db\fR]
144 [\fB\-o\fR \fIindex.rdf\fR]
145 [\fB\-c\fR]
146 [\fB\-i\fR]
147 \&\fIdir\fR ...
148 .SH "DESCRIPTION"
149 .IX Header "DESCRIPTION"
150 The \fBopenpkg index\fR tool is a frontend for indexing of \s-1RPM\s0 files. It
151 creates an \s-1XML/RDF\s0 based resource index for \s-1RPM\s0 \fI.spec\fR files in a
152 source tree or from an \s-1RPM\s0 package repository. The index holds enough
153 information to support an automated build process by \fBopenpkg build\fR.
154 .SH "OPTIONS"
155 .IX Header "OPTIONS"
156 The following command line options exist:
157 .IP "\fB\-r\fR \fIresource\fR" 4
158 .IX Item "-r resource"
159 The name of the resource stored in the index. The default is
160 "\f(CW\*(C`OpenPKG\-CURRENT/Source/\*(C'\fR".
161 .IP "\fB\-p\fR \fIplatform\fR" 4
162 .IX Item "-p platform"
163 \&\fBopenpkg index\fR adds a platform attribute for binary RPMs. This
164 must be unique to correctly identify a specific architecture, \s-1OS\s0
165 and build environment.
166 .IP "\fB\-S\fR" 4
167 .IX Item "-S"
168 Optionally determines and stores the size (in bytes) of each indexed file.
169 This is not required for the correct operation of the \fBopenpkg build\fR command, but
170 the \fBopenpkg mirror\fR command requires it.
171 .IP "\fB\-T\fR" 4
172 .IX Item "-T"
173 Optionally determines and stores the modification time (\f(CW\*(C`mtime\*(C'\fR) of each indexed file.
174 This is not required for the correct operation of the \fBopenpkg build\fR command, but
175 the \fBopenpkg mirror\fR command requires it.
176 .IP "\fB\-D\fR" 4
177 .IX Item "-D"
178 Optionally determines and stores the message digest (\f(CW\*(C`md5\*(C'\fR) of each indexed file.
179 This is not required for the correct operation of the \fBopenpkg build\fR command, but
180 the \fBopenpkg mirror\fR command requires it.
181 .IP "\fB\-C\fR \fIcache.db\fR" 4
182 .IX Item "-C cache.db"
183 Cache all \fI.spec\fR files into this Berkeley-DB file when indexing source
184 RPMs. The cache is refreshed automatically when the source RPMs are more
185 recent than the cache entry. The \fB\-C\fR option requires an installed
186 DB_File perl module.
187 .IP "\fB\-o\fR \fIindex.rdf\fR" 4
188 .IX Item "-o index.rdf"
189 Name of the output \s-1XML/RDF\s0 file, default is to write to \fIstdout\fR.
190 .IP "\fB\-c\fR" 4
191 .IX Item "-c"
192 Compress output with \f(CW\*(C`bzip2\*(C'\fR. Use the \fB\-o\fR option to specify a \fI.bz2\fR
193 suffix.
194 .IP "\fB\-i\fR" 4
195 .IX Item "-i"
196 The specified directories are \s-1RPM\s0 repositories. Build index over
197 all \fI.rpm\fR files in these directories and all subdirectories.
198 If a subdirectory already contains a \f(CW\*(C`00INDEX.rdf\*(C'\fR or \f(CW\*(C`00INDEX.rdf.*\*(C'\fR
199 file then skip scanning the subdirectory, instead add a reference
200 to the index file into the new index.
201 .Sp
202 Without this option the directories are source trees with a subdirectory
203 per package and a \fIpackage\fR\f(CW\*(C`.spec\*(C'\fR file inside each subdirectory.
204 .SH "SEE ALSO"
205 .IX Header "SEE ALSO"
206 \&\fIrpm\fR\|(8).
207 .SH "HISTORY"
208 .IX Header "HISTORY"
209 The \fBopenpkg index\fR command was invented in November 2002 by \fIMichael
210 van Elst\fR <mlelstv@serpens.de> under contract with \fICable
211 & Wireless\fR <http://www.cw.com/> for use inside the \fBOpenPKG\fR
212 project <http://www.openpkg.org/>.
213 .SH "AUTHORS"
214 .IX Header "AUTHORS"
215 .Vb 2
216 \& Michael van Elst
217 \& mlelstv@serpens.de
218 .Ve
