-This is the Bacula documentation directory. It currently contains
-the following subdirectories:
-
- Directory Contents
- home-page The Bacula Web Site
- manual The English Bacula manual
- manual-de The German Bacula manual (in translation)
- manual-fr The French Bacula manual (in translation)
- developers The developer's manual
- techlogs Technical development logs
+This is the Bacula documentation directory.
Build instructions:
-First, you must do:
+See the file README.pct for more details of the
+build system. Note, all the previous xxx.in files have
+been removed except for one:
- cd <docs>
- ./configure --with-bacula=<path-to-bacula-source>
+ manuals/version.tex.in
- This will find the current Bacula version, and create
- all the Makefiles from Makefile.in
+You normally should not edit that file, rather edit
+version.tex, see the end of this file for more on
+versions.
- Do not edit the Makefiles or your changes will be lost. Always
- edit Makefile.in
+You must have at least the following packages loaded:
+latex2html
+te_latex
+tetex
Web site: nothing to build, simply copy the files to the
Web site, then load the documents in the appropriate
cd <docs>
make
- The above builds both the English Bacula document and
- the developer's document. When the other languages are
- ready for distribution, it will also build those languages.
-
- cd manual
- make
+ The above builds all the Bacula English manuals.
+ At some point in the future, it will also build the
+ other languages, when they are ready for distribution.
- The bacula.pdf and the one big html file (bacula.html) will
- be in the directory manual.
- The normal web document (multiple pages) is in
- manual/bacula
+ Each subdirectory of manuals/en/xxx contains a subdirectory
+ named xxx which contains the web version of that particular
+ manual. The pdf is in manuals/en/xxx/xxx.pdf
German manual:
- cd manual-de
+ cd <docs>
+ make german
Same as above
French manual:
- cd manual-fr
+ cd <docs>
+ make french
Same as above:
-developer's manual:
- cd developers
- Same as above.
+A distribution is made by exporting the SVN then building everything
+and finally tarring it up.
-To create a distribution tar file:
- cd <docs>
- make
- make distribution
+Note: normally this directory is distributed with the correct
+version and date. If you want to change it, simply manually
+edit <docs>/manuals/version.tex.
+
+If you want to update the version "automatically" or synchronize
+it with the source, edit the update_version file and change the
+BACULA_SOURCE variable to point to your source file, then
+simply enter:
- The output will be a .tar.gz file in the current directory
- with the name bacula-doc-<version>.tar.gz
- It will print the name.
+ ./update_version