------------------------------------------------------------
About this README
------------------------------------------------------------
This README is intended to document the build process of the Guacamole manual
for technical users who wish to contribute or who simply wish to build the
manual themselves.
The latest version of the manual is provided on the Guacamole web site, and
snapshot copies of each release are included in the release archives:
http://guac-dev.org/
------------------------------------------------------------
What is guacamole-manual?
------------------------------------------------------------
The guacamole-manual package is the base documentation for the entire Guacamole
stack. It is written in DocBook, an XML schema commonly used for authoring
manuals and technical documentation.
The build process involves running the Guacamole manual XML through an XSLT
processor called "xsltproc", applying the standard DocBook XSL stylesheets.
------------------------------------------------------------
Building the manual
------------------------------------------------------------
1) Ensure the DocBook XSL stylesheets are installed
Most Linux distributions will provide a "docbook-xsl" or similarly-named
package which install the DocBook stylesheets in a system-wide manner. You
will need to either install these packages, or download the DocBook XSL
stylesheets yourself:
https://sourceforge.net/projects/docbook/files/docbook-xsl/
2) Ensure the DOCBOOK_PATH environment variable is set
The manual build process depends on an environment variable, DOCBOOK_PATH,
which points to the directory in which the DocBook XSL files can be found.
This will be the directory that contains the following file:
html/chunk.xsl
$ export DOCBOOK_PATH=/usr/share/sgml/docbook/xsl-ns-stylesheets-1.78.1
3) Ensure xsltproc is installed
If you do not have xsltproc, the manual will not build. The provided
Makefile depends entirely on using xsltproc to process the Guacamole manual
XML through the installed DocBook stylesheets.
4) Run make
$ make
The manual will now be built using xsltproc. Once complete, the entire
HTML version of the manual will be available within the "html" directory in
the root directory of the source tree.
------------------------------------------------------------
Reporting problems
------------------------------------------------------------
Please report any bugs encountered by opening a new issue in the JIRA system
hosted at:
http://glyptodon.org/jira/