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

   1
   2 This is the Bacula documentation directory. It currently contains
   3 the following subdirectories:
   4
   5   Directory          Contents
   6   home-page          The Bacula Web Site
   7   manual             The English Bacula manual
   8   manual-de          The German Bacula manual (in translation)
   9   manual-fr          The French Bacula manual (in translation)
  10   developers         The developer's manual
  11   techlogs           Technical development logs
  12
  13 Build instructions:
  14
  15 You must have at least the following packages loaded:
  16 latex2html
  17 te_latex
  18 tetex
  19
  20 First, you must do:
  21
  22   cd <docs>
  23   ./configure --with-bacula=<path-to-bacula-source>
  24
  25   This will find the current Bacula version, and create
  26   all the Makefiles from Makefile.in
  27
  28   Do not edit the Makefiles or your changes will be lost. Always
  29   edit Makefile.in
  30
  31 Web site:  nothing to build, simply copy the files to the
  32            Web site, then load the documents in the appropriate
  33            places.
  34
  35
  36 English manual:
  37    cd <docs>
  38    make
  39
  40    The above builds both the English Bacula document and
  41    the developer's document.  When the other languages are
  42    ready for distribution, it will also build those languages.
  43
  44    cd manual
  45    make
  46
  47    The bacula.pdf and the one big html file (bacula.html) will
  48    be in the directory manual.
  49    The normal web document (multiple pages) is in
  50    manual/bacula
  51
  52 German manual:
  53    cd manual-de
  54    Same as above
  55
  56 French manual:
  57    cd manual-fr
  58    Same as above:
  59
  60 developer's manual:
  61    cd developers
  62    Same as above.
  63
  64 To create a distribution tar file:
  65    cd <docs>
  66    ./configure --with-bacula=<bacula-source-directory>
  67    make clean
  68    make
  69    make release
  70
  71    The output will be a .tar.gz file in the current directory
  72    with the name bacula-doc-<version>.tar.gz
  73    It will print the name.