From e5f8879c6497bede7daf4b59fd4aca429a08916e Mon Sep 17 00:00:00 2001 From: Kern Sibbald Date: Thu, 13 Dec 2007 12:47:25 +0000 Subject: [PATCH] Update README --- docs/README | 74 ++++++++++++++++++++++++++++++----------------------- 1 file changed, 42 insertions(+), 32 deletions(-) diff --git a/docs/README b/docs/README index 368e5410..4a2b20d1 100644 --- a/docs/README +++ b/docs/README @@ -2,12 +2,36 @@ This is the Bacula documentation directory. It currently contains the following subdirectories: - Directory Contents - home-page The Bacula Web Site - manual The English Bacula manual - manual-de The German Bacula manual (in translation) - manual-fr The French Bacula manual (in translation) - developers The developer's manual + Directory Contents + home-page The Bacula Web Site + manuals All the manuals + manuals/en English version of the manuals + manuals/en/catalog Catalog + concepts Concepts + console Console and Operators Guide + developers Developer's guide + install Installation and Configuration Guide + problems Problem Resolution Guide + utility Utility Programs + + manuals/de German translation of the manual + manuals/de/catalog Catalog + concepts Concepts + console Console and Operators Guide + developers Developer's guide + install Installation and Configuration Guide + problems Problem Resolution Guide + utility Utility Programs + + manuals/fr French translation of the manual + manuals/fr/catalog Catalog + concepts Concepts + console Console and Operators Guide + developers Developer's guide + install Installation and Configuration Guide + problems Problem Resolution Guide + utility Utility Programs + techlogs Technical development logs Build instructions: @@ -37,37 +61,23 @@ English manual: cd make - The above builds both the English Bacula document and - the developer's document. When the other languages are - ready for distribution, it will also build those languages. - - cd manual - make + The above builds all the Bacula English manuals. + At some point in the future, it will also build the + other languages, when they are ready for distribution. - The bacula.pdf and the one big html file (bacula.html) will - be in the directory manual. - The normal web document (multiple pages) is in - manual/bacula + Each subdirectory of manuals/en/xxx contains a subdirectory + named xxx which contains the web version of that particular + manual. The pdf is in manuals/en/xxx/xxx.pdf German manual: - cd manual-de + cd + make german Same as above French manual: - cd manual-fr - Same as above: - -developer's manual: - cd developers - Same as above. - -To create a distribution tar file: cd - ./configure --with-bacula= - make clean - make - make release + make french + Same as above: - The output will be a .tar.gz file in the current directory - with the name bacula-doc-.tar.gz - It will print the name. +A distribution is made by exporting the SVN then building everything +and finally tarring it up. -- 2.39.5