<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<title>
rpm2html : the man page</title>
<meta name="GENERATOR" content="amaya V1.3">
</head>
<body bgcolor="#ffffff">
<h1 align=center><a href="http://rufus.w3.org/linux/rpm2html/">rpm2html</a> -
make an html database from rpm repository</h1>
<h3>SYNOPSIS</h3>
<p>
<strong><code>rpm2html [-q][-v][-force][-lang langfile]
config-file(s)...</code></strong></p>
<h3>DESCRIPTION</h3>
<p>
Rpm2html tries to solve 2 big problems one face when grabbing a RPM package
from a mirror on the net and trying to install it:</p>
<ul>
<li>
it gives more information than just the filename before installing the
package.
<li>
it tries to solve the dependancy problem by analyzing all the Provides and
Requires of the set of RPMs. It shows the cross references by the way of
hypertext links.
</ul>
<p>
The second point will only be efficient if the actual number of indexed RPMs
is important.</p>
<p>
Each configuration file is handled independantly as if it was a new invocation
of rpm2html.</p>
<p>
A configuration file represents a list of directories and a ditribution as a
whole. All the references between packages listed in the directories of a
single config file are marked by hyperlinks in the resulting HTML files. Here
is the process leading to the creation of the HTML pages:</p>
<ol>
<li>
The configuration file is parsed, it sets all the default values for rpm2html.
Then all the directory entries are parsed and a list of directories to scan is
built.
<li>
For each directory, the RPM are scanned, the HTML page describing the package
is generated immediately.All ressources provided and needed by the RPM file
are stored in a list of ressources. A list of parsed RPMs is also constructed.
<li>
Once all the RPM for this config file have been scanned all ressources are
dumped in ressources files with links to the RPM providing them (one could
also add the RPM needing them but everything needs libc for example).
<li>
The sorted lists of packages are generated by sorting the RPM list for various
criteria and general front-end pages are generated unsing the new list order.
<li>
The main page is generated with links to the various front-end pages,
statistics and description of the packages analyzed.
<li>
All the lists are freed and global variables are reset.
</ol>
<p>
rpm2html is now ready to handle the next configuration file.</p>
<h3>CONFIGURATION</h3>
<p>
A configuration file a text file, lines beginning with semicolumns are
comments.</p>
<h4>global section</h4>
<p>
The first part is a global section defining some important parameters of
rpm2html. Parameters are defined with the syntax:</p>
<p>
<code>variable=value [value ...]</code></p>
<p>
Values shouln't be quoted and end up with the end of line.</p>
<p>
The folowing variables are supported:</p>
<dl>
<dt>maint</dt>
<dd><p>
Name of the maintainer of the local mirror, NEEDED !</p>
</dd>
<dt>mail</dt>
<dd><p>
The E-mail of the maintainer, NEEDED !</p>
</dd>
<dt>html</dt>
<dd><p>
Dump HTML files, values: true or false, true by default</p>
</dd>
<dt>dir</dt>
<dd><p>
The directory for for the HTML output</p>
</dd>
<dt>url</dt>
<dd><p>
The directory part of theURL for the HTML files on the WWW server</p>
</dd>
<dt>rdf</dt>
<dd><p>
Dump RDF files, values: true or false, false by default</p>
</dd>
<dt>rdf_dir</dt>
<dd><p>
The directory for for the RDF output</p>
</dd>
<dt>tree</dt>
<dd><p>
Dump extra tree pages, values: true or false, false by default</p>
</dd>
</dl>
<h4>directory section(s)</h4>
<p>
After these variables, one section should be filled for each directory on your
system containing RPM files. It starts with the directory filename between
brackets:</p>
<p>
[The name between brackets is the directory, NEEDED !]</p>
<p>
<strong>NOTE:</strong> The special directory name <strong>[localbase]</strong>
<strong>extract informations from the RPM base</strong> of installed software
instead of listing a directory. It allows to dump HTML pages for the installed
RPM base on a machine.</p>
<dl>
<dt>name</dt>
<dd><p>
Name the packages of the subdirectory, NEEDED !</p>
</dd>
<dt>ftp</dt>
<dd><p>
The base URL to fetch the packages on the origin server.</p>
</dd>
<dt>ftpsrc</dt>
<dd><p>
The base URL to fetch the packages sources.</p>
</dd>
<dt>color</dt>
<dd><p>
a color encoding for this directory (#RRGGBB).</p>
</dd>
<dt>url</dt>
<dd><p>
The directory part of theURL for the HTML files on the WWW server.</p>
</dd>
<dt>subdir</dt>
<dd><p>
The subdirectory where the HTML files for thsi directory will be saved.</p>
</dd>
<dt>mirror</dt>
<dd><p>
The nearest mirror for the package. <strong>Note</strong>: more than one
mirror can be listed rpm2html doesn't use the next ones yet, but this will be
added soon.</p>
</dd>
</dl>
<h3>EXAMPLE</h3>
<p>
Here is a simple configuration file for a distribution exporting packages for
various platforms:</p>
<pre>;
; Sample configuration file for rpm2html
;
maint=Joe
mail=joe@mydistrib.org
dir=/home/http/html/MyDistrib
url=/Mydistrib
tree=true
rdf=true
rdf_dir=/home/ftp/pub/mydistrib/RDF
[/MyDistrib/RPM/noarch]
name=Arch independant packages for MyDistrib
ftp=ftp://ftp.mydistrib.org/pub/mydistrib/noarch
subdir=noarch
[/MyDistrib/RPM/i386]
name=i386 packages for MyDistrib
ftp=ftp://ftp.mydistrib.org/pub/mydistrib/i386
ftpsrc=ftp://ftp.mydistrib.org/pub/mydistrib/srcs
color=#e0ffff
subdir=i386
mirror=ftp://ftp.mydistrib.org/pub/mydistrib/i386
mirror=ftp://ftp.elsewhere.org/pub/mydistrib/i386
[/MyDistrib/RPM/alpha]
name=Alpha packages for MyDistrib
ftp=ftp://ftp.mydistrib.org/pub/mydistrib/alpha
ftpsrc=ftp://ftp.mydistrib.org/pub/mydistrib/srcs
color=#ffe0ff
subdir=alpha
mirror=ftp://ftp.mydistrib.org/pub/mydistrib/alpha
mirror=ftp://ftp.elsewhere.org/pub/mydistrib/alpha
[/MyDistrib/RPM/sparc]
name=Sparc packages for MyDistrib
ftp=ftp://ftp.mydistrib.org/pub/mydistrib/sparc
ftpsrc=ftp://ftp.mydistrib.org/pub/mydistrib/srcs
color=#ffffe0
subdir=sparc
[/MyDistrib/RPM/ppc]
name=PPC packages for MyDistrib
ftp=ftp://ftp.mydistrib.org/pub/mydistrib/ppc
ftpsrc=ftp://ftp.mydistrib.org/pub/mydistrib/srcs
color=#e0ffe0
subdir=ppc
mirror=ftp://ftp.mydistrib.org/pub/mydistrib/ppc
mirror=ftp://ftp.pear.com/pub/mydistrib/ppc</pre>
<h3>OPERANDS</h3>
<p>
The following operands are supported: files List of configuration files</p>
<h3>EXIT STATUS</h3>
<p>
The following exit values are returned: 0</p>
<p>
Successful completion. >0 An error occurred.</p>
<h3>CAVEATS AND BUGS</h3>
<h3>SEE ALSO</h3>
<a href="http://rufus.w3.org/linux/RPM/rpm.html">rpm</a>
<h3>AUTHORS</h3>
<address>
<p>
<a href="mailto:veillard@w3.org">Daniel Veillard</a>, with help from
<a href="mailto:er@viking.oleane.com">Emanuel Rouat</a></p>
</address>
<p>
$Id: manuel.html,v 1.1 1998/05/12 04:23:41 veillard Exp $</p>
</body>
</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