Annotation of rpm2html/manuel.html, revision 1.3
1.1 veillard 1: <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2: <html>
3: <head>
4: <title>
5: rpm2html : the man page</title>
6: <meta name="GENERATOR" content="amaya V1.3">
7: </head>
8: <body bgcolor="#ffffff">
9:
10: <h1 align=center><a href="http://rufus.w3.org/linux/rpm2html/">rpm2html</a> -
11: make an html database from rpm repository</h1>
12:
13: <h3>SYNOPSIS</h3>
14: <p>
15: <strong><code>rpm2html [-q][-v][-force][-lang langfile]
16: config-file(s)...</code></strong></p>
17:
18: <h3>DESCRIPTION</h3>
19: <p>
20: Rpm2html tries to solve 2 big problems one face when grabbing a RPM package
21: from a mirror on the net and trying to install it:</p>
22: <ul>
23: <li>
24: it gives more information than just the filename before installing the
25: package.
26: <li>
27: it tries to solve the dependancy problem by analyzing all the Provides and
28: Requires of the set of RPMs. It shows the cross references by the way of
29: hypertext links.
30: </ul>
31: <p>
32: The second point will only be efficient if the actual number of indexed RPMs
33: is important.</p>
34: <p>
35: Each configuration file is handled independantly as if it was a new invocation
36: of rpm2html.</p>
37: <p>
38: A configuration file represents a list of directories and a ditribution as a
39: whole. All the references between packages listed in the directories of a
40: single config file are marked by hyperlinks in the resulting HTML files. Here
41: is the process leading to the creation of the HTML pages:</p>
42: <ol>
43: <li>
44: The configuration file is parsed, it sets all the default values for rpm2html.
45: Then all the directory entries are parsed and a list of directories to scan is
46: built.
47: <li>
48: For each directory, the RPM are scanned, the HTML page describing the package
49: is generated immediately.All ressources provided and needed by the RPM file
50: are stored in a list of ressources. A list of parsed RPMs is also constructed.
51: <li>
52: Once all the RPM for this config file have been scanned all ressources are
53: dumped in ressources files with links to the RPM providing them (one could
54: also add the RPM needing them but everything needs libc for example).
55: <li>
56: The sorted lists of packages are generated by sorting the RPM list for various
57: criteria and general front-end pages are generated unsing the new list order.
58: <li>
59: The main page is generated with links to the various front-end pages,
60: statistics and description of the packages analyzed.
61: <li>
62: All the lists are freed and global variables are reset.
63: </ol>
64: <p>
65: rpm2html is now ready to handle the next configuration file.</p>
66:
67: <h3>CONFIGURATION</h3>
68: <p>
69: A configuration file a text file, lines beginning with semicolumns are
70: comments.</p>
71:
72: <h4>global section</h4>
73: <p>
74: The first part is a global section defining some important parameters of
75: rpm2html. Parameters are defined with the syntax:</p>
76: <p>
77: <code>variable=value [value ...]</code></p>
78: <p>
79: Values shouln't be quoted and end up with the end of line.</p>
80: <p>
81: The folowing variables are supported:</p>
82: <dl>
83: <dt>maint</dt>
84: <dd><p>
85: Name of the maintainer of the local mirror, NEEDED !</p>
86: </dd>
87: <dt>mail</dt>
88: <dd><p>
89: The E-mail of the maintainer, NEEDED !</p>
90: </dd>
91: <dt>html</dt>
92: <dd><p>
93: Dump HTML files, values: true or false, true by default</p>
94: </dd>
95: <dt>dir</dt>
96: <dd><p>
97: The directory for for the HTML output</p>
98: </dd>
99: <dt>url</dt>
100: <dd><p>
101: The directory part of theURL for the HTML files on the WWW server</p>
102: </dd>
103: <dt>rdf</dt>
104: <dd><p>
105: Dump RDF files, values: true or false, false by default</p>
106: </dd>
107: <dt>rdf_dir</dt>
108: <dd><p>
109: The directory for for the RDF output</p>
110: </dd>
111: <dt>tree</dt>
112: <dd><p>
113: Dump extra tree pages, values: true or false, false by default</p>
114: </dd>
115: </dl>
116:
117: <h4>directory section(s)</h4>
118: <p>
119: After these variables, one section should be filled for each directory on your
120: system containing RPM files. It starts with the directory filename between
121: brackets:</p>
122: <p>
123: [The name between brackets is the directory, NEEDED !]</p>
124: <p>
125: <strong>NOTE:</strong> The special directory name <strong>[localbase]</strong>
126: <strong>extract informations from the RPM base</strong> of installed software
127: instead of listing a directory. It allows to dump HTML pages for the installed
128: RPM base on a machine.</p>
129: <dl>
130: <dt>name</dt>
131: <dd><p>
132: Name the packages of the subdirectory, NEEDED !</p>
133: </dd>
134: <dt>ftp</dt>
135: <dd><p>
136: The base URL to fetch the packages on the origin server.</p>
137: </dd>
138: <dt>ftpsrc</dt>
139: <dd><p>
140: The base URL to fetch the packages sources.</p>
141: </dd>
142: <dt>color</dt>
143: <dd><p>
144: a color encoding for this directory (#RRGGBB).</p>
145: </dd>
146: <dt>url</dt>
147: <dd><p>
148: The directory part of theURL for the HTML files on the WWW server.</p>
149: </dd>
150: <dt>subdir</dt>
151: <dd><p>
152: The subdirectory where the HTML files for thsi directory will be saved.</p>
153: </dd>
154: <dt>mirror</dt>
155: <dd><p>
156: The nearest mirror for the package. <strong>Note</strong>: more than one
157: mirror can be listed rpm2html doesn't use the next ones yet, but this will be
158: added soon.</p>
159: </dd>
160: </dl>
161:
162: <h3>EXAMPLE</h3>
163: <p>
164: Here is a simple configuration file for a distribution exporting packages for
165: various platforms:</p>
166: <pre>;
167: ; Sample configuration file for rpm2html
168: ;
169:
170: maint=Joe
171: mail=joe@mydistrib.org
172:
173: dir=/home/http/html/MyDistrib
174: url=/Mydistrib
175:
176: tree=true
177:
178: rdf=true
179: rdf_dir=/home/ftp/pub/mydistrib/RDF
180:
181: [/MyDistrib/RPM/noarch]
182: name=Arch independant packages for MyDistrib
183: ftp=ftp://ftp.mydistrib.org/pub/mydistrib/noarch
184: subdir=noarch
185:
186: [/MyDistrib/RPM/i386]
187: name=i386 packages for MyDistrib
188: ftp=ftp://ftp.mydistrib.org/pub/mydistrib/i386
189: ftpsrc=ftp://ftp.mydistrib.org/pub/mydistrib/srcs
190: color=#e0ffff
191: subdir=i386
192: mirror=ftp://ftp.mydistrib.org/pub/mydistrib/i386
193: mirror=ftp://ftp.elsewhere.org/pub/mydistrib/i386
194:
195: [/MyDistrib/RPM/alpha]
196: name=Alpha packages for MyDistrib
197: ftp=ftp://ftp.mydistrib.org/pub/mydistrib/alpha
198: ftpsrc=ftp://ftp.mydistrib.org/pub/mydistrib/srcs
199: color=#ffe0ff
200: subdir=alpha
201: mirror=ftp://ftp.mydistrib.org/pub/mydistrib/alpha
202: mirror=ftp://ftp.elsewhere.org/pub/mydistrib/alpha
203:
204: [/MyDistrib/RPM/sparc]
205: name=Sparc packages for MyDistrib
206: ftp=ftp://ftp.mydistrib.org/pub/mydistrib/sparc
207: ftpsrc=ftp://ftp.mydistrib.org/pub/mydistrib/srcs
208: color=#ffffe0
209: subdir=sparc
210:
211: [/MyDistrib/RPM/ppc]
212: name=PPC packages for MyDistrib
213: ftp=ftp://ftp.mydistrib.org/pub/mydistrib/ppc
214: ftpsrc=ftp://ftp.mydistrib.org/pub/mydistrib/srcs
215: color=#e0ffe0
216: subdir=ppc
217: mirror=ftp://ftp.mydistrib.org/pub/mydistrib/ppc
218: mirror=ftp://ftp.pear.com/pub/mydistrib/ppc</pre>
219:
220: <h3>OPERANDS</h3>
221: <p>
222: The following operands are supported: files List of configuration files</p>
223:
224: <h3>EXIT STATUS</h3>
225: <p>
226: The following exit values are returned: 0</p>
227: <p>
228: Successful completion. >0 An error occurred.</p>
229:
230: <h3>CAVEATS AND BUGS</h3>
1.2 veillard 231: <p>
232: rpm2html doesn't remove the old html and rdf files if the corresponding RPM
233: file has been removed.</p>
1.1 veillard 234:
235: <h3>SEE ALSO</h3>
236:
1.3 ! veillard 237: <a href="http://rufus.w3.org/linux/rpm2html/rpmfind.html">rpmfind</a>
1.1 veillard 238: <a href="http://rufus.w3.org/linux/RPM/rpm.html">rpm</a>
239:
240: <h3>AUTHORS</h3>
241: <address>
242: <p>
1.2 veillard 243: <a href="mailto:veillard@w3.org">Daniel Veillard</a>, with help from <a
244: href="mailto:er@viking.oleane.com">Emanuel Rouat</a></p>
1.1 veillard 245: </address>
246: <p>
1.3 ! veillard 247: $Id: manuel.html,v 1.2 1998/05/12 04:31:45 veillard Exp $</p>
1.1 veillard 248: </body>
249: </html>
Webmaster
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to manuel.html CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [Public] / rpm2html