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
  44 First, you must do:
  45
  46   cd <docs>
  47   ./configure --with-bacula=<path-to-bacula-source>
  48
  49   This will find the current Bacula version, and create
  50   all the Makefiles from Makefile.in
  51
  52   Do not edit the Makefiles or your changes will be lost. Always
  53   edit Makefile.in
  54
  55 Web site:  nothing to build, simply copy the files to the
  56            Web site, then load the documents in the appropriate
  57            places.
  58
  59
  60 English manual:
  61    cd <docs>
  62    make
  63
  64    The above builds all the Bacula English manuals.
  65    At some point in the future, it will also build the
  66    other languages, when they are ready for distribution.
  67
  68    Each subdirectory of manuals/en/xxx contains a subdirectory
  69    named xxx which contains the web version of that particular
  70    manual.  The pdf is in manuals/en/xxx/xxx.pdf
  71
  72 German manual:
  73    cd <docs>
  74    make german
  75    Same as above
  76
  77 French manual:
  78    cd <docs>
  79    make french
  80    Same as above:
  81
  82 A distribution is made by exporting the SVN then building everything
  83 and finally tarring it up.