regen

svn path=/rpkid/doc/Installation; revision=1889

6 files changed, 58 insertions, 8 deletions

diff --git a/rpkid/doc/Installation b/rpkid/doc/Installation
index 8f85b04a..49d7e068 100644
--- a/rpkid/doc/Installation
+++ b/rpkid/doc/Installation
@@ -19,9 +19,26 @@ Installation Guide
    Note that initial development of this code has been on FreeBSD, so
    installation will probably be easiest on FreeBSD.
 
-   Before attempting to build the package, see the list of required Python
-   modules in rpkid/README. Note that the Python code requires Python
-   version 2.5. Install any modules that might be missing.
+   Before attempting to build the package, you need to install any missing
+   prerequisites. Note that the Python code requires Python version 2.5.
+   rpkid et al are mostly self-contained, but do require a small number of
+   external packages to run.
+
+     * http://codespeak.net/lxml/. lxml in turn requires the Gnome LibXML2
+       C libraries.
+          + FreeBSD: /usr/ports/devel/py-lxml
+          + Fedora: python-lxml.i386
+     * http://sourceforge.net/projects/mysql-python/. MySQLdb in turn
+       requires MySQL client and server. rpkid et al have been tested with
+       MySQL 5.0 and 5.1.
+          + FreeBSD: /usr/ports/databases/py-MySQLdb
+          + Fedora: MySQL-python.i386
+     * http://trevp.net/tlslite/. TLSLite pulls in other crypto packages.
+          + FreeBSD: /usr/ports/security/py-tlslite
+
+   rpkid et al also make heavy use of a modified copy of the Python
+   OpenSSL Wrappers (POW) package, but this copy has enough modifications
+   and additions that it's included in the subversion tree.
 
    The next step is to build the OpenSSL and POW binaries. At present the
    OpenSSL code is just a copy of the stock OpenSSL 0.9.8g release,
@@ -47,7 +64,20 @@ Installation Guide
 
    At this point, you should have all the necessary software installed.
    You will probably want to test it. All tests should be run from the
-   rpkid/ directory.
+   rpkid/ directory. The test suite requires a few more external packages,
+   only one of which is Python code.
+
+     * http://pyyaml.org/. testpoke.py (an up-down protocol command line
+       test client) and testbed.py (a test harness) use PyYAML.
+          + FreeBSD: /usr/ports/devel/py-yaml
+     * http://xmlsoft.org/XSLT/. Some of the test code uses xsltproc, from
+       the Gnome LibXSLT package.
+          + FreeBSD: /usr/ports/textproc/libxslt
+     * http://w3m.sourceforge.net/. testbed.py uses w3m to display the
+       summary output from rcynic. Nothing terrible will happen if w3m
+       isn't available, testbed.py will just complain about it being
+       missing and won't display rcynic's output.
+          + FreeBSD: /usr/ports/www/w3m
 
    Some of the tests require MySQL databases to store their data. To set
    up all the databases that the tests will need, run the SQL commands in
@@ -64,8 +94,28 @@ Installation Guide
 
    If nothing explodes, your installation is probably ok. Any Python
    backtraces in the output indicate a problem.
+
+   There's a last set of tools that only developers should need, as
+   they're only used when modifying schemas or regenerating the
+   documentation. These tools are listed here for completeness.
+
+     * http://www.doxygen.org/. Doxygen in turn pulls in several other
+       tools, notably Graphviz, pdfLaTeX, and Ghostscript.
+          + FreeBSD: /usr/ports/devel/doxygen
+     * http://lynx.isc.org/current/. The documentation build process uses
+       xsltproc and Lynx to dump flat text versions of a few critical
+       documentation pages.
+          + FreeBSD: /usr/ports/www/lynx
+     * http://www.thaiopensource.com/relaxng/trang.html. Trang is used to
+       convert RelaxNG schemas from the human-readable "compact" form to
+       the XML form that LibXML2 understands. Trang in turn requires Java.
+          + FreeBSD: /usr/ports/textproc/trang
+     * http://search.cpan.org/dist/SQL-Translator/. SQL-Translator, also
+       known as "SQL Fairy", includes code to parse an SQL schema and dump
+       a description of it as Graphviz input. SQL Fairy in turn requires
+       Perl.
      __________________________________________________________________
 
 
-    Generated on Mon Jun 16 20:14:49 2008 for RPKI Engine by  doxygen
+    Generated on Mon Jun 16 22:22:49 2008 for RPKI Engine by  doxygen
     1.5.5
diff --git a/rpkid/doc/Left-right b/rpkid/doc/Left-right
index cb9097ac..aabfb4a7 100644
--- a/rpkid/doc/Left-right
+++ b/rpkid/doc/Left-right
@@ -473,5 +473,5 @@ Error handling
      __________________________________________________________________
 
 
-    Generated on Mon Jun 16 20:14:49 2008 for RPKI Engine by  doxygen
+    Generated on Mon Jun 16 22:22:49 2008 for RPKI Engine by  doxygen
     1.5.5
diff --git a/rpkid/doc/Operation b/rpkid/doc/Operation
index bdf0e987..88098527 100644
--- a/rpkid/doc/Operation
+++ b/rpkid/doc/Operation
@@ -685,5 +685,5 @@ testpoke.py
      __________________________________________________________________
 
 
-    Generated on Mon Jun 16 20:14:49 2008 for RPKI Engine by  doxygen
+    Generated on Mon Jun 16 22:22:49 2008 for RPKI Engine by  doxygen
     1.5.5
diff --git a/rpkid/doc/Publication b/rpkid/doc/Publication
index c886cf4b..7ead01f8 100644
--- a/rpkid/doc/Publication
+++ b/rpkid/doc/Publication
@@ -220,5 +220,5 @@ Additional access control considerations.
      __________________________________________________________________
 
 
-    Generated on Mon Jun 16 20:14:49 2008 for RPKI Engine by  doxygen
+    Generated on Mon Jun 16 22:22:49 2008 for RPKI Engine by  doxygen
     1.5.5
diff --git a/rpkid/doc/manual.pdf b/rpkid/doc/manual.pdf
index 4376f8b9..c1dfdf09 100644
--- a/rpkid/doc/manual.pdf
+++ b/rpkid/doc/manual.pdf
diff --git a/rpkid/doc/manual.tar.gz b/rpkid/doc/manual.tar.gz
index 3ca78194..f2e9c696 100644
--- a/rpkid/doc/manual.tar.gz
+++ b/rpkid/doc/manual.tar.gz