The BIRCH Home page has links to
lists of programs by
category, by
package, and an alphabetical
program index. Each program and package has a page with links to
documentation, sample datafiles, command syntax etc. To make it
possible to have a single, unified set of pages for applications
distributed as part of BIRCH, as well as those installed locally, BIRCH
contains two separate databases in the directories:
The script htmldoc.py reads both databases, and creates all of the web
pages described earlier. The result is that the end user sees
documentation for all applications in a single set of web pages,
regardless of whether they are locally-installed, or are part of the
BIRCH distribution.
To run htmldoc.py, cd to the $BIRCH/install-birch directory and type
python htmldoc.py If you are doing a first time BIRCH
installation, the database in $BIRCH/local/public_html/birchdb will be
empty. If you are upgrading from a previous release of BIRCH, the
information from your $BIRCH/local/public_html/birchdb will be
included in the final set of web pages.
Everytime you make a change in
your $BIRCH/local/public_html/birchdb database, you must
run htmldoc.py to update the web pages.
Note: If you are upgrading from BIRCH release
A1.6 or earlier, you will not have this directory. You can move
it from the local-generic directory by going to
$BIRCH/local-generic/public_html
and typing
