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 For latex2html to find latex/, you may need:
  17
  18 export TEXINPUTS=`pwd`/latex
  19
  20 You must have at least the following packages loaded:
  21 latex2html
  22 te_latex
  23 tetex
  24 libhtml-parser-perl
  25 libhtml-treebuilder-libxml-perl
  26
  27 instead of the full tex package, you can load:
  28
  29 texlive-base
  30 texlive-fonts-recommended
  31 texlive-latex-recommended
  32
  33 I tend to load pretty much everything with the following apt packages:
  34
  35 dvipdfmx texlive latex2html
  36
  37 and for rpms:
  38
  39 tetex tetex-dvips tetx-fonds tetx-latex
  40
  41 Web site:  nothing to build, simply copy the files to the
  42            Web site, then load the documents in the appropriate
  43            places.
  44
  45
  46 English manual:
  47    cd <docs>
  48    make
  49
  50    The above builds all the Bacula English manuals.
  51    At some point in the future, it will also build the
  52    other languages, when they are ready for distribution.
  53
  54    Each subdirectory of manuals/en/xxx contains a subdirectory
  55    named xxx which contains the web version of that particular
  56    manual.  The pdf is in manuals/en/xxx/xxx.pdf
  57
  58   NOTE!!! Please note that running multiple simultaneous makes does
  59    not work.  I.e. "make -j3" will fail.  If you have a solution, please
  60    send it to me.  Thanks.
  61
  62 German manual:
  63    cd <docs>
  64    make german
  65    Same as above
  66
  67 French manual:
  68    cd <docs>
  69    make french
  70    Same as above:
  71
  72 A distribution is made by exporting the SVN then building everything
  73 and finally tarring it up.
  74
  75 Note: normally this directory is distributed with the correct
  76 version and date.  If you want to change it, simply manually
  77 edit <docs>/manuals/version.tex.
  78
  79 If you want to update the version "automatically" or synchronize
  80 it with the source, edit the update_version file and change the
  81 BACULA_SOURCE variable to point to your source file, then
  82 simply enter:
  83
  84   ./update_version