git.sur5r.net Git - bacula/docs/blob - docs/README

   1
   2 This is the Bacula documentation directory.
   3
   4 Build instructions:
   5
   6 See the file README.pct for more details of the
   7 build system.  Note, all the previous xxx.in files have
   8 been removed except for one:
   9
  10   manuals/version.tex.in
  11
  12 You normally should not edit that file, rather edit
  13 version.tex, see the end of this file for more on
  14 versions.
  15
  16 You must have at least the following packages loaded:
  17 latex2html
  18 te_latex
  19 tetex
  20
  21 Web site:  nothing to build, simply copy the files to the
  22            Web site, then load the documents in the appropriate
  23            places.
  24
  25
  26 English manual:
  27    cd <docs>
  28    make
  29
  30    The above builds all the Bacula English manuals.
  31    At some point in the future, it will also build the
  32    other languages, when they are ready for distribution.
  33
  34    Each subdirectory of manuals/en/xxx contains a subdirectory
  35    named xxx which contains the web version of that particular
  36    manual.  The pdf is in manuals/en/xxx/xxx.pdf
  37
  38 German manual:
  39    cd <docs>
  40    make german
  41    Same as above
  42
  43 French manual:
  44    cd <docs>
  45    make french
  46    Same as above:
  47
  48 A distribution is made by exporting the SVN then building everything
  49 and finally tarring it up.
  50
  51 Note: normally this directory is distributed with the correct
  52 version and date.  If you want to change it, simply manually
  53 edit <docs>/manuals/version.tex.
  54
  55 If you want to update the version "automatically" or synchronize
  56 it with the source, edit the update_version file and change the
  57 BACULA_SOURCE variable to point to your source file, then
  58 simply enter:
  59
  60   ./update_version