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   manuals                All the manuals
   8   manuals/en             English version of the manuals
   9   manuals/en/catalog     Catalog
  10              concepts    Concepts
  11              console     Console and Operators Guide
  12              developers  Developer's guide
  13              install     Installation and Configuration Guide
  14              problems    Problem Resolution Guide
  15              utility     Utility Programs
  16
  17   manuals/de             German translation of the manual
  18   manuals/de/catalog     Catalog
  19              concepts    Concepts
  20              console     Console and Operators Guide
  21              developers  Developer's guide
  22              install     Installation and Configuration Guide
  23              problems    Problem Resolution Guide
  24              utility     Utility Programs
  25
  26   manuals/fr             French translation of the manual
  27   manuals/fr/catalog     Catalog
  28              concepts    Concepts
  29              console     Console and Operators Guide
  30              developers  Developer's guide
  31              install     Installation and Configuration Guide
  32              problems    Problem Resolution Guide
  33              utility     Utility Programs
  34
  35   techlogs           Technical development logs
  36
  37 Build instructions:
  38
  39 You must have at least the following packages loaded:
  40 latex2html
  41 te_latex
  42 tetex
  43 inkscape
  44 tex4ht
  45 tex4ht-common
  46 texlive-fonts-extra
  47 texlive-fonts-extra-doc
  48 texlive-generic-extra
  49 texlive-latex3
  50 texlive-metapost
  51 texlive-plain-extra
  52 ttf-dejavu
  53 ttf-dejavu-extra
  54 ttf-lyx
  55
  56 First, you must do:
  57
  58   cd <docs>
  59   ./configure --with-bacula=<path-to-bacula-source>
  60
  61   This will find the current Bacula version, and create
  62   all the Makefiles from Makefile.in
  63
  64   Do not edit the Makefiles or your changes will be lost. Always
  65   edit Makefile.in
  66
  67 Web site:  nothing to build, simply copy the files to the
  68            Web site, then load the documents in the appropriate
  69            places.
  70
  71
  72 English manual:
  73    cd <docs>
  74    make
  75
  76    The above builds all the Bacula English manuals.
  77    At some point in the future, it will also build the
  78    other languages, when they are ready for distribution.
  79
  80    Each subdirectory of manuals/en/xxx contains a subdirectory
  81    named xxx which contains the web version of that particular
  82    manual.  The pdf is in manuals/en/xxx/xxx.pdf
  83
  84 German manual:
  85    cd <docs>
  86    make german
  87    Same as above
  88
  89 French manual:
  90    cd <docs>
  91    make french
  92    Same as above:
  93
  94 A distribution is made by exporting the SVN then building everything
  95 and finally tarring it up.