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 First, you must do:
  16
  17   cd <docs>
  18   ./configure --with-bacula=<path-to-bacula-source>
  19
  20   This will find the current Bacula version, and create
  21   all the Makefiles from Makefile.in
  22
  23   Do not edit the Makefiles or your changes will be lost. Always
  24   edit Makefile.in
  25
  26 Web site:  nothing to build, simply copy the files to the
  27            Web site, then load the documents in the appropriate
  28            places.
  29
  30
  31 English manual:
  32    cd <docs>
  33    make
  34
  35    The above builds both the English Bacula document and
  36    the developer's document.  When the other languages are
  37    ready for distribution, it will also build those languages.
  38
  39    cd manual
  40    make
  41
  42    The bacula.pdf and the one big html file (bacula.html) will
  43    be in the directory manual.
  44    The normal web document (multiple pages) is in
  45    manual/bacula
  46
  47 German manual:
  48    cd manual-de
  49    Same as above
  50
  51 French manual:
  52    cd manual-fr
  53    Same as above:
  54
  55 developer's manual:
  56    cd developers
  57    Same as above.
  58
  59 To create a distribution tar file:
  60    cd <docs>
  61    ./configure --with-bacula=<bacula-source-directory>
  62    make clean
  63    make
  64    make release
  65
  66    The output will be a .tar.gz file in the current directory
  67    with the name bacula-doc-<version>.tar.gz
  68    It will print the name.