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