Annotation of rpm2html/INSTALL, revision 1.5

1.2       veillard    1:   INSTALLING rpm2html
                      2:   ===================
1.1       veillard    3: 
1.4       veillard    4: rpm2html uses the RPM library, which in turn uses
                      5: the libdb library. If one of these seems to be missing
                      6: you should install the rpm-devel and db packages. If
                      7: available, installing rpm2html should hopefully be
                      8: as simple as:
1.1       veillard    9: 
                     10:     ./configure
                     11:     make
                     12:     su
                     13:     make install
                     14:     
1.2       veillard   15: edit /usr/local/share/rpm2html.config (see below)
                     16: and create the directory to hold the HTML output.
1.1       veillard   17: 
                     18:     make test
                     19: 
                     20: To verify that the configuration is Ok,
                     21: And you are ready to install it in your crontab
                     22:   
                     23: NOTE : 
1.2       veillard   24: ======
                     25: 
1.1       veillard   26: - autoconf take /usr/local as the standard prefix,
                     27:   it is possible to override the installation to some
                     28:   place elsewhere.
                     29: - while in use, rpm2html need only 2 files in the
                     30:   system : the binary and the config(s) file passed as
                     31:   argument(s).
                     32: - No special permission are needed it just need write
                     33:   access to the output directory and be able to read
                     34:   the RPM directories and files.
                     35: 
1.2       veillard   36: The CONFIGURATION FILE:
                     37: =======================
                     38: 
                     39:   Is a text file, lines beginning with semicolumns
                     40: are comments. The first part is a global section
                     41: defining some important parameters of rpm2html.
                     42: Parameters are defined with the syntax:
                     43: 
                     44: variable=value
                     45: 
                     46: Values shouln't be quoted and end up with the end of line
                     47: 
                     48: Variable   |   Value
1.5     ! veillard   49: ------------------------------------------------------------
        !            50: maint      | The maintainer of the local mirror, NEEDED !
        !            51: mail       | The E-mail of the maintainer, NEEDED !
        !            52: dir        | The directory for for the HTML output, NEEDED !
        !            53: url        | The URL for the HTML files on the WWW server
        !            54: host       | The hostname for the server.
        !            55: 
        !            56:   After these variables, one section should be filled
        !            57: for each directory on your system containing RPM files.
        !            58: It starts with the directory filename between brackets:
1.2       veillard   59: 
                     60: [The name between brackets is the directory, NEEDED !]
                     61: 
1.3       veillard   62:   The special directory name [localbase] extract informations
                     63: from the RPM base of installed software instead of listing a
                     64: directory. It allows to dump HTML pages for the installed RPM
                     65: base on a machine.
                     66: 
1.2       veillard   67:   All the variables defined below until the next
                     68: directory or the end of file pertain to this directory.
                     69: Here are the possible variables:
                     70: 
                     71: Variable   |   Value
                     72: ---------------------------------------------------
                     73: name       | A significant name for this mirror, NEEDED !
                     74: ftp        | The original FTP/HTTP url, NEEDED !
                     75: ftpsrc     | Where the associated sources are stored
                     76: color      | Background color for pages
                     77: trust      | Unused yet
1.5     ! veillard   78: url        | The local FTP/HTTP url.
1.2       veillard   79: 
1.5     ! veillard   80:   It is possible to indicate other mirrors by adding some
        !            81: mirror=value lines withing the section. The first one
1.2       veillard   82: will be considered the local one.
                     83: 
1.5     ! veillard   84:   See PRINCIPLES for a more general comment on 
        !            85: 
1.2       veillard   86:   
1.1       veillard   87:  Daniel.Veillard@w3.org
                     88: 
1.5     ! veillard   89: $Id: INSTALL,v 1.4 1997/11/17 15:38:25 veillard Exp $

Webmaster