Annotation of rpm2html/rpm2html.1, revision 1.3
1.1 veillard 1: .\" @(#)Rpm2html-0.70
2: .\" Copyright 1998 Daniel Veillard
3: .TH rpm2html 1 "22 Feb 1998"
4: .SH NAME
1.2 veillard 5: rpm2html \- make an html database from rpm repository
1.1 veillard 6: .SH SYNOPSIS
7: .B rpm2html
8: .IR
1.3 ! veillard 9: [-q][-v][-force][-lang langfile] config-file
1.1 veillard 10: .SH DESCRIPTION
11: .IX
12: Rpm2html tries to solve 2 big problems one face when
13: grabbing a RPM package from a mirror on the net and trying to
14: install it:
15: .TP 5
16: -
17: it gives more information than just the filename before installing the package.
18: .BR
19: .TP 5
20: -
21: 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.
22: .BR
23: .IX
24: .RE
25: .LP
26: The second point will only be efficient if the actual number of indexed RPMs is important.
27:
28: Each configuration file is handled independantly as if
29: it was a new invocation of rpm2html.
30:
31: A configuration file represents a list of directories
32: and a ditribution as a whole. All the references between
33: packages listed in the directories of a single config file
34: are marked by hyperlinks in the resulting HTML files. Here
35: is the process leading to the creation of the HTML pages:
36:
37: 1/
38: The configuration file is parsed, it sets all the default values for rpm2html.
39: Then all the directory entries are parsed and a list of directories to scan is built.
40:
41: 2/
42: 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.
43:
44: 3/
45: 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).
46:
47: 4/
48: 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.
49:
50: 5/
51: The main page is generated with links to the various front-end pages, statistics and description of the packages analyzed.
52:
53: 6/
54: All the lists are freed and global variables are reset.
55:
56: rpm2html is now ready to handle the next configuration file.
57:
58:
59: .SH CONFIGURATION
60: A configuration file a text file, lines beginning with semicolumns
61: are comments. The first part is a global section
62: defining some important parameters of rpm2html.
63: Parameters are defined with the syntax:
64:
65: .TP 5
66: variable=value
67: .RE
68: Values shouln't be quoted and end up with the end of line
69:
70: The folowing variables are supported:
71: .RE
72: .TP 10
73: .IR maint
74: The maintainer of the local mirror, NEEDED !
75: .TP 10
76: .IR mail
77: The E-mail of the maintainer, NEEDED !
78: .TP 10
79: .IR dir
80: The directory for for the HTML output, NEEDED !
81: .TP 10
82: .IR url
83: The URL for the HTML files on the WWW server
84: .TP 10
85: .IR host
86: The hostname for the server.
87: .RE
88: .BR
89:
90: After these variables, one section should be filled
91: for each directory on your system containing RPM files.
92: It starts with the directory filename between brackets:
93:
94: [The name between brackets is the directory, NEEDED !]
95:
96: The special directory name [localbase] extract informations
97: from the RPM base of installed software instead of listing a
98: directory. It allows to dump HTML pages for the installed RPM
99: base on a machine.
100:
101: All the variables defined below until the next
102: directory or the end of file pertain to this directory.
103: Here are the possible variables:
104:
105: .TP 10
106: .I name
107: A significant name for this mirror, NEEDED !
108: .TP 10
109: .I ftp
110: The original FTP/HTTP url, NEEDED !
111: .TP 10
112: .I ftpsrc
113: Where the associated sources are stored
114: .TP 10
115: .I color
116: Background color for pages
117: .TP 10
118: .I trust
119: Unused yet
120: .TP 10
121: .I url
122: The local FTP/HTTP url.
123: .RE
124:
125: It is possible to indicate other mirrors by adding some
126: mirror=value lines withing the section. The first one
127: will be considered the local one.
128:
129:
130: .SH EXAMPLE
1.3 ! veillard 131: Example of configuration files:
1.1 veillard 132: .BR
133:
134: .nf
135: .sp
1.3 ! veillard 136:
1.1 veillard 137: ;
138: ; Sample configuration file for rpm2html
139: ;
140:
141: maint=Joe
142: mail=joe@mydistrib.org
1.3 ! veillard 143:
1.1 veillard 144: dir=/home/http/html/MyDistrib
1.3 ! veillard 145: url=/Mydistrib
! 146:
! 147: tree=true
1.1 veillard 148:
1.3 ! veillard 149: rdf=true
! 150: rdf_dir=/home/ftp/pub/mydistrib/RDF
1.1 veillard 151:
152: [/MyDistrib/RPM/noarch]
153: name=Arch independant packages for MyDistrib
154: ftp=ftp://ftp.mydistrib.org/pub/mydistrib/noarch
1.3 ! veillard 155: subdir=noarch
1.1 veillard 156:
157: [/MyDistrib/RPM/i386]
158: name=i386 packages for MyDistrib
159: ftp=ftp://ftp.mydistrib.org/pub/mydistrib/i386
1.3 ! veillard 160: ftpsrc=ftp://ftp.mydistrib.org/pub/mydistrib/srcs
! 161: color=#e0ffff
! 162: subdir=i386
! 163: mirror=ftp://ftp.mydistrib.org/pub/mydistrib/i386
! 164: mirror=ftp://ftp.elsewhere.org/pub/mydistrib/i386
1.1 veillard 165:
166: [/MyDistrib/RPM/alpha]
167: name=Alpha packages for MyDistrib
168: ftp=ftp://ftp.mydistrib.org/pub/mydistrib/alpha
1.3 ! veillard 169: ftpsrc=ftp://ftp.mydistrib.org/pub/mydistrib/srcs
! 170: color=#ffe0ff
! 171: subdir=alpha
! 172: mirror=ftp://ftp.mydistrib.org/pub/mydistrib/alpha
! 173: mirror=ftp://ftp.elsewhere.org/pub/mydistrib/alpha
1.1 veillard 174:
175: [/MyDistrib/RPM/sparc]
176: name=Sparc packages for MyDistrib
177: ftp=ftp://ftp.mydistrib.org/pub/mydistrib/sparc
1.3 ! veillard 178: ftpsrc=ftp://ftp.mydistrib.org/pub/mydistrib/srcs
! 179: color=#ffffe0
! 180: subdir=sparc
1.1 veillard 181:
182: [/MyDistrib/RPM/ppc]
183: name=PPC packages for MyDistrib
184: ftp=ftp://ftp.mydistrib.org/pub/mydistrib/ppc
185: ftpsrc=ftp://ftp.mydistrib.org/pub/mydistrib/srcs
1.3 ! veillard 186: color=#e0ffe0
! 187: subdir=ppc
! 188: mirror=ftp://ftp.mydistrib.org/pub/mydistrib/ppc
! 189: mirror=ftp://ftp.pear.com/pub/mydistrib/ppc
1.1 veillard 190:
191: .sp
192:
193: .SH OPERANDS
194: The following operands are supported:
195: .TP 5
196: .I files
197: List of configuration files
198:
199:
200: .SH "EXIT STATUS"
201: The following exit values are returned:
202: .TP 4
203: .B 0
204: Successful completion.
205: .TP
206: .B >0
207: An error occurred.
208: .SH SEE ALSO
209: .BR rpm(1),
Webmaster
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to rpm2html.1 CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [Public] / rpm2html