"Fossies" - the Fresh Open Source Software Archive

Member "rpm2html-1.11.2/PRINCIPLES" (28 Apr 1998, 4725 Bytes) of package /linux/privat/rpm2html-1.11.2.tar.gz:


As a special service "Fossies" has tried to format the requested text file into HTML format (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file.

    1 
    2 	  How does rpm2html works ?
    3 	  =========================
    4 
    5  The input of rpm2html are:
    6     1/ a list of configuration files
    7     2/ [optional] a language message file.
    8 
    9  Each configuration file is handled independently as if
   10 if was a new invocation of rpm2html.
   11 
   12  A configuration file represents a list of directories
   13 and a distribution as a whole. All the references between
   14 packages listed in the directories of a single config file
   15 are marked by hyperlinks in the resulting HTML files. Here
   16 is the process leading to the creation of the HTML pages:
   17 
   18   1/ The configuration file is parsed, it sets all the
   19      default values for rpm2html.
   20      Then all the directory entries are parsed and a list
   21      of directories to scan is built.
   22 
   23   2/ For each directory, the RPM are scanned, the HTML
   24      page describing the package is generated immediately.
   25      All resources provided and needed by the RPM file
   26      are stored in a list of resources. A list of parsed
   27      RPMs is also constructed.
   28 
   29   3/ Once all the RPM for this config file have been scanned
   30      all resources are dumped in resources files with
   31      links to the RPM providing them (one could also add the
   32      RPM needing them but everything needs libc for example).
   33 
   34   4/ The sorted lists of packages are generated by sorting
   35      the RPM list for various criteria and general front-end
   36      pages are generated unsing the new list order.
   37 
   38   5/ The main page is generated with links to the various
   39      front-end pages, statistics and description of the
   40      packages analyzed.
   41 
   42   6/ All the lists are freed and global variables are reset.
   43 
   44 rpm2html is now ready to handle the next configuration file.
   45      
   46   A configuration file represent a "distribution" where all
   47 the cross-links makes sense, e.g.:
   48 
   49  -->Dist 
   50         --> srcs
   51 	--> noarch
   52 	--> i386
   53 	--> sparc
   54 	--> alpha
   55 	--> ppc
   56 
   57  Here is a possible configuration file for such a distribution
   58 where all the HTML files are stored in the same directory:
   59 
   60 ------------------- config.onedir -----------------
   61 ;
   62 ; Sample configuration file for rpm2html
   63 ; when using a single directory for all HTML output
   64 ;
   65 
   66 maint=Joe
   67 mail=joe@mydistrib.org
   68 dir=/home/http/html/MyDistrib
   69 url=http://www.mydistrib.org/pub/mydistrib
   70 ftpsrc=ftp://ftp.mydistrib.org/pub/mydistrib/srcs
   71 host=MyDistrib.Org
   72 header=mailto:joe@mydistrib.org Feedback
   73 
   74 [/MyDistrib/RPM/srcs]
   75 name=Sources for MyDistrib
   76 ftp=ftp://ftp.mydistrib.org/pub/mydistrib/srcs
   77 
   78 [/MyDistrib/RPM/noarch]
   79 name=Arch independant packages for MyDistrib
   80 ftp=ftp://ftp.mydistrib.org/pub/mydistrib/noarch
   81 
   82 [/MyDistrib/RPM/i386]
   83 name=i386 packages for MyDistrib
   84 ftp=ftp://ftp.mydistrib.org/pub/mydistrib/i386
   85 
   86 [/MyDistrib/RPM/alpha]
   87 name=Alpha packages for MyDistrib
   88 ftp=ftp://ftp.mydistrib.org/pub/mydistrib/alpha
   89 
   90 [/MyDistrib/RPM/sparc]
   91 name=Sparc packages for MyDistrib
   92 ftp=ftp://ftp.mydistrib.org/pub/mydistrib/sparc
   93 
   94 [/MyDistrib/RPM/ppc]
   95 name=PPC packages for MyDistrib
   96 ftp=ftp://ftp.mydistrib.org/pub/mydistrib/ppc
   97 
   98 -------------------------------------------------
   99 
  100   In the second example, the front-end HTML
  101 pages are stored in a general directory, as well
  102 as all the resources pages. The HTML pages
  103 are stored in separate directories. To be able
  104 to provide cross linking between HTML pages located
  105 in different directories on the server, the "subdir"
  106 giving the relative URL path for the HTML directories
  107 is needed, e.g. :
  108 
  109 ----------------- config.multidir ---------------
  110 ;
  111 ; Sample configuration file for rpm2html
  112 ; when using separate directories for the HTML files.
  113 ;
  114 
  115 maint=Joe
  116 mail=joe@mydistrib.org
  117 dir=/home/http/html/MyDistrib
  118 ftpsrc=ftp://ftp.mydistrib.org/pub/mydistrib/srcs
  119 url=/mydistrib
  120 host=MyDistrib.Org
  121 header=mailto:joe@mydistrib.org Feedback
  122 
  123 [/MyDistrib/RPM/srcs]
  124 name=Sources for MyDistrib
  125 ftp=ftp://ftp.mydistrib.org/pub/mydistrib/srcs
  126 subdir=srcs
  127 
  128 [/MyDistrib/RPM/noarch]
  129 name=Arch independant packages for MyDistrib
  130 ftp=ftp://ftp.mydistrib.org/pub/mydistrib/noarch
  131 ftpsrc=ftp://ftp.mydistrib.org/pub/mydistrib/noarch
  132 subdir=noarch
  133 
  134 [/MyDistrib/RPM/i386]
  135 name=i386 packages for MyDistrib
  136 ftp=ftp://ftp.mydistrib.org/pub/mydistrib/i386
  137 subdir=i386
  138 
  139 [/MyDistrib/RPM/alpha]
  140 name=Alpha packages for MyDistrib
  141 ftp=ftp://ftp.mydistrib.org/pub/mydistrib/alpha
  142 subdir=alpha
  143 
  144 [/MyDistrib/RPM/sparc]
  145 name=Sparc packages for MyDistrib
  146 ftp=ftp://ftp.mydistrib.org/pub/mydistrib/sparc
  147 subdir=sparc
  148 
  149 [/MyDistrib/RPM/ppc]
  150 name=PPC packages for MyDistrib
  151 ftp=ftp://ftp.mydistrib.org/pub/mydistrib/ppc
  152 subdir=ppc
  153 
  154 -------------------------------------------------
  155 
  156   In that case the HTTP server tree follow closely
  157 the ditribution tree but this is not mandatory.
  158 
  159 Daniel.Veillard@apocalypse.org
  160 
  161 $Id: PRINCIPLES,v 1.5 1998/04/28 02:25:41 veillard Exp $
  162