chmod 766 manuals/update_version
# Now move common files into each subdirectory
-for i in manuals/update_version manuals/version.tex manuals/bacula.sty ; do
+for i in manuals/version.tex manuals/bacula.sty ; do
for j in console developers main misc problems utility ; do
- cp -f $i manuals/de/$j
- cp -f $i manuals/en/$j
- cp -f $i manuals/es/$j
- cp -f $i manuals/fr/$j
+ cp -f $i manuals/de/$j/
+ cp -f $i manuals/en/$j/
+ cp -f $i manuals/es/$j/
+ cp -f $i manuals/fr/$j/
done
done
chmod 766 manuals/update_version
# Now move common files into each subdirectory
-for i in manuals/update_version manuals/version.tex manuals/bacula.sty ; do
+for i in manuals/version.tex manuals/bacula.sty ; do
for j in console developers main misc problems utility ; do
- cp -f $i manuals/de/$j
- cp -f $i manuals/en/$j
- cp -f $i manuals/es/$j
- cp -f $i manuals/fr/$j
+ cp -f $i manuals/de/$j/
+ cp -f $i manuals/en/$j/
+ cp -f $i manuals/es/$j/
+ cp -f $i manuals/fr/$j/
done
done
tex:
- @./update_version
+ @../../update_version
@echo "Making version `cat version.tex`"
@cp -fp ${IMAGES}/hires/*.eps .
@touch ${DOC}i-dir.tex ${DOC}i-fd.tex ${DOC}i-sd.tex \
tex:
+ @../../update_version
@cp -fp ${IMAGES}/hires/*.eps .
touch ${DOC}.idx ${DOC}i-general.tex
-latex -interaction=batchmode ${DOC}.tex
tex:
- @./update_version
+ @../../update_version
@echo "Making version `cat version.tex`"
@cp -fp ${IMAGES}/hires/*.eps .
@touch ${DOC}i-dir.tex ${DOC}i-fd.tex ${DOC}i-sd.tex \
tex:
- @./update_version
+ @../../update_version
@echo "Making version `cat version.tex`"
@cp -fp ${IMAGES}/hires/*.eps .
@touch ${DOC}i-dir.tex ${DOC}i-fd.tex ${DOC}i-sd.tex \
+++ /dev/null
-#
-#
-# Makefile for LaTeX
-#
-# To build everything do
-# make tex
-# make web
-# make html
-# make dvipdf
-#
-# or simply
-#
-# make
-#
-# for rapid development do:
-# make tex
-# make show
-#
-#
-# If you are having problems getting "make" to work, debugging it is
-# easier if can see the output from latex, which is normally redirected
-# to /dev/null. To see it, do the following:
-#
-# cd docs/manual
-# make tex
-# latex bacula.tex
-#
-# typically the latex command will stop indicating the error (e.g. a
-# missing \ in front of a _ or a missing { or ] ...
-#
-# The following characters must be preceded by a backslash
-# to be entered as printable characters:
-#
-# # $ % & ~ _ ^ \ { }
-#
-
-IMAGES=../../../images
-
-DOC=catalog
-
-first_rule: all
-
-all: tex web dvipdf mini-clean
-
-.SUFFIXES: .tex .html
-.PHONY:
-.DONTCARE:
-
-
-tex:
- @./update_version
- @echo "Making version `cat version.tex`"
- @cp -fp ${IMAGES}/hires/*.eps .
- @touch ${DOC}i-dir.tex ${DOC}i-fd.tex ${DOC}i-sd.tex \
- ${DOC}i-console.tex ${DOC}i-general.tex
- latex -interaction=batchmode ${DOC}.tex
- makeindex ${DOC}.idx -o ${DOC}.ind 2>/dev/null
- latex -interaction=batchmode ${DOC}.tex
-
-pdf:
- @echo "Making pdfm"
- @cp -fp ${IMAGES}/hires/*.eps .
- dvipdfm -p a4 ${DOC}.dvi
-
-dvipdf:
- @echo "Making dvi to pdf"
- @cp -fp ${IMAGES}/hires/*.eps .
- dvipdf ${DOC}.dvi ${DOC}.pdf
-
-html:
- @echo " "
- @echo "Making html"
- @cp -fp ${IMAGES}/*.eps .
- @rm -f next.eps next.png prev.eps prev.png up.eps up.png
- @(if [ -f imagename_translations ] ; then \
- ./translate_images.pl --from_meaningful_names ${DOC}.html; \
- fi)
- latex2html -white -no_subdir -split 0 -toc_stars -white -notransparent \
- -init_file latex2html-init.pl ${DOC} >tex.out 2>&1
- ./translate_images.pl --to_meaningful_names ${DOC}.html
- @echo "Done making html"
-
-web:
- @echo "Making web"
- @mkdir -p ${DOC}
- @cp -fp ${IMAGES}/*.eps .
- @rm -f next.eps next.png prev.eps prev.png up.eps up.png
- @cp -fp ${IMAGES}/*.eps ${DOC}/
- @cp -fp ${IMAGES}/*.eps ${IMAGES}/*.png ${DOC}/
- @rm -f ${DOC}/xp-*.png
- @rm -f ${DOC}/next.eps ${DOC}/next.png ${DOC}/prev.eps ${DOC}/prev.png ${DOC}/up.eps ${DOC}/up.png
- @rm -rf ${DOC}/*.html
- latex2html -split 3 -local_icons -t "Bacula Catalog Database Guide" -long_titles 4 \
- -toc_stars -contents_in_nav -init_file latex2html-init.pl -white -notransparent ${DOC} >tex.out 2>&1
- ./translate_images.pl --to_meaningful_names ${DOC}/Bacula_Catalo*.html
- @echo "Done making web"
-show:
- xdvi ${DOC}
-
-texcheck:
- ./check_tex.pl ${DOC}.tex
-
-main_configs:
- pic2graph -density 100 <main_configs.pic >main_configs.png
-
-mini-clean:
- @rm -f 1 2 3 *.tex~
- @rm -f *.gif *.jpg *.eps
- @rm -f *.aux *.cp *.fn *.ky *.log *.pg
- @rm -f *.backup *.ilg *.lof *.lot
- @rm -f *.cdx *.cnd *.ddx *.ddn *.fdx *.fnd *.ind *.sdx *.snd
- @rm -f *.dnd *.old *.out
- @rm -f ${DOC}/*.gif ${DOC}/*.jpg ${DOC}/*.eps
- @rm -f ${DOC}/*.aux ${DOC}/*.cp ${DOC}/*.fn ${DOC}/*.ky ${DOC}/*.log ${DOC}/*.pg
- @rm -f ${DOC}/*.backup ${DOC}/*.ilg ${DOC}/*.lof ${DOC}/*.lot
- @rm -f ${DOC}/*.cdx ${DOC}/*.cnd ${DOC}/*.ddx ${DOC}/*.ddn ${DOC}/*.fdx ${DOC}/*.fnd ${DOC}/*.ind ${DOC}/*.sdx ${DOC}/*.snd
- @rm -f ${DOC}/*.dnd ${DOC}/*.old ${DOC}/*.out
- @rm -f ${DOC}/WARNINGS
-
-
-clean:
- @rm -f 1 2 3 *.tex~
- @rm -f *.png *.gif *.jpg *.eps
- @rm -f *.pdf *.aux *.cp *.fn *.ky *.log *.pg
- @rm -f *.html *.backup *.ps *.dvi *.ilg *.lof *.lot
- @rm -f *.cdx *.cnd *.ddx *.ddn *.fdx *.fnd *.ind *.sdx *.snd
- @rm -f *.dnd imagename_translations
- @rm -f *.old WARNINGS *.out *.toc *.idx
- @rm -f ${DOC}i-*.tex
- @rm -rf ${DOC}
-
-
-distclean: clean
- @rm -f images.pl labels.pl internals.pl
- @rm -f Makefile version.tex
+++ /dev/null
-/* Century Schoolbook font is very similar to Computer Modern Math: cmmi */
-.MATH { font-family: "Century Schoolbook", serif; }
-.MATH I { font-family: "Century Schoolbook", serif; font-style: italic }
-.BOLDMATH { font-family: "Century Schoolbook", serif; font-weight: bold }
-
-/* implement both fixed-size and relative sizes */
-SMALL.XTINY { font-size : xx-small }
-SMALL.TINY { font-size : x-small }
-SMALL.SCRIPTSIZE { font-size : smaller }
-SMALL.FOOTNOTESIZE { font-size : small }
-SMALL.SMALL { }
-BIG.LARGE { }
-BIG.XLARGE { font-size : large }
-BIG.XXLARGE { font-size : x-large }
-BIG.HUGE { font-size : larger }
-BIG.XHUGE { font-size : xx-large }
-
-/* heading styles */
-H1 { }
-H2 { }
-H3 { }
-H4 { }
-H5 { }
-
-/* mathematics styles */
-DIV.displaymath { } /* math displays */
-TD.eqno { } /* equation-number cells */
-
-
-/* document-specific styles come next */
+++ /dev/null
-[General]
-img_extIsRegExp=false
-img_extensions=.eps .jpg .jpeg .png .pdf .ps .fig .gif
-kileprversion=2
-kileversion=2.0
-lastDocument=catalog.tex
-masterDocument=
-name=Catalog
-pkg_extIsRegExp=false
-pkg_extensions=.cls .sty
-src_extIsRegExp=false
-src_extensions=.tex .ltx .latex .dtx .ins
-
-[Tools]
-MakeIndex=
-QuickBuild=
-
-[item:catalog.kilepr]
-archive=true
-column=144342808
-encoding=
-highlight=
-line=0
-open=false
-order=-1
-
-[item:catalog.tex]
-archive=true
-column=0
-encoding=UTF-8
-highlight=LaTeX
-line=27
-open=true
-order=0
-
-[item:catmaintenance.tex]
-archive=true
-column=0
-encoding=
-highlight=LaTeX
-line=0
-open=false
-order=-1
-
-[item:internaldb.tex]
-archive=true
-column=0
-encoding=
-highlight=LaTeX
-line=0
-open=false
-order=-1
-
-[item:mysql.tex]
-archive=true
-column=0
-encoding=
-highlight=
-line=0
-open=false
-order=-1
-
-[item:postgresql.tex]
-archive=true
-column=0
-encoding=UTF-8
-highlight=LaTeX
-line=0
-open=false
-order=1
-
-[item:sqlite.tex]
-archive=true
-column=0
-encoding=
-highlight=
-line=0
-open=false
-order=-1
-
-[item:version.tex]
-archive=true
-column=0
-encoding=
-highlight=
-line=0
-open=false
-order=-1
+++ /dev/null
-%%
-%%
-%% The following characters must be preceded by a backslash
-%% to be entered as printable characters:
-%%
-%% # $ % & ~ _ ^ \ { }
-%%
-
-\documentclass[10pt,a4paper]{book}
-
-\topmargin -0.5in
-\oddsidemargin 0.0in
-\evensidemargin 0.0in
-\textheight 10in
-\textwidth 6.5in
-
-\usepackage{html}
-\usepackage{float}
-\usepackage{graphicx}
-\usepackage{bacula}
-\usepackage{longtable}
-\usepackage{makeidx}
-\usepackage{index}
-\usepackage{setspace}
-\usepackage{hyperref}
-\usepackage{url}
-\usepackage{german}
-\usepackage{alltt}
-\makeindex
-\newindex{general}{idx}{ind}{General Index}
-
-\sloppy
-
-\begin{document}
-\sloppy
-
-\newfont{\bighead}{cmr17 at 36pt}
-\parskip 10pt
-\parindent 0pt
-
-\title{\includegraphics{\idir bacula-logo.eps} \\ \bigskip
- \Huge{Bacula Katalog-Datenbank-Handbuch}
- \begin{center}
- \large{Es kommt bei Nacht und saugt die lebenswichtigen Daten aus Ihren Computern.}
- \end{center}
-}
-
-
-\author{Kern Sibbald}
-\date{\vspace{1.0in}\today \\
- Dieses Handbuch dokumentiert Bacula \linebreak in der Version \fullversion \\
- \vspace{0.2in}
- Copyright \copyright 1999-2009, Free Software Foundation Europe
- e.V. \\
- \vspace{0.2in}
- Permission is granted to copy, distribute and/or modify this document under the terms of the
- GNU Free Documentation License, Version 1.2 published by the Free Software Foundation;
- with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
- A copy of the license is included in the section entitled "`GNU Free Documentation License"'.
-}
-
-\maketitle
-
-\clearpage
-\tableofcontents
-\clearpage
-%\listoffigures
-%\clearpage
-\listoftables
-\clearpage
-
-\include{catmaintenance}
-\include{mysql}
-\include{postgresql}
-\include{sqlite}
-\include{internaldb}
-\include{fdl}
-
-
-% The following line tells link_resolver.pl to not include these files:
-% nolinks developersi baculai-dir baculai-fd baculai-sd baculai-console baculai-main
-
-% pull in the index
-\clearpage
-\printindex[general]
-
-\end{document}
+++ /dev/null
-%%
-%%
-
-\chapter{Katalog Verwaltung}
-\label{CatMaintenanceChapter}
-\index[general]{Verwaltung!Katalog }
-\index[general]{Katalog Verwaltung}
-
-Ohne eine ordnungsgem\"{a}{\ss}e Einrichtung und Verwaltung kann es sein,
-dass Ihr Katalog immer gr\"{o}{\ss}er wird wenn Jobs laufen und Daten gesichert werden.
-Zudem kann der Katalog ineffizient und langsam werden. Wie schnell der Katalog w\"{a}chst,
-h\"{a}ngt von der Anzahl der Jobs und der Menge der dabei gesicherten Dateien ab.
-Durch das L\"{o}schen von Eintr\"{a}gen im Katalog kann Platz geschaffen werden f\"{u}r
-neue Eintr\"{a}ge der folgenden Jobs. Durch regelm\"{a}{\ss}iges l\"{o}schen alter abgelaufener
-Daten, \"{a}lter als durch die Aufbewahrungszeitr\"{a}ume (Retention Periods) angegeben,
-wird daf\"{u}r gesorgt, dass die Katalog-Datenbank eine nahezu konstante Gr\"{o}{\ss}e beibeh\"{a}lt.
-
-Sie k\"{o}nnen anfangs die vorgegebene Konfiguration benutzen, sie enth\"{a}lt bereits
-sinnvolle Vorgaben f\"{u}r eine kleine Anzahl von Clients (kleiner 5). Wenn Sie dann einige
-hundert Megabyte freien Plattenplatz haben, wird die daraus resultierende Katalog-Gr\"{o}{\ss}e
-vorerst kein Problem darstellen. Was aber auch immer der Fall ist, grundlegendes Wissen \"{u}ber
-die Retention Periods/Aufbewahrungszeitr\"{a}ume der Daten im Katalog und auf den Volumes ist notwendig.
-
-\section{Einstellung der Aufbewahrungszeitr\"{a}ume}
-\label{Retention}
-\index[general]{Einstellung der Aufbewahrungszeitr\"{a}ume }
-\index[general]{Zeitr\"{a}ume!Einstellung der Aufbewahrungs- }
-
-Bacula benutzt drei verschiedene Aufbewahrungszeitr\"{a}ume:
-die {\bf File Retention}: der Aufbewahrungszeitraum f\"{u}r Dateien,
-die {\bf Job Retention}: der Aufbewahrungszeitraum f\"{u}r Jobs und
-die {\bf Volume Retention}: der Aufbewahrungszeitraum f\"{u}r Volumes.
-Von diesen drei ist der Aufbewahrungszeitraum f\"{u}r Dateien der entscheidende,
-wenn es darum geht, wie gro{\ss} die Datenbank werden wird.
-
-Die {\bf File Retention} und die {\bf Job Retention} werden in der Client-Konfiguration,
-wie unten gezeigt, angegeben. Die {\bf Volume Retention} wird in der Pool-Konfiguration
-angegeben, genauere Informationen dazu finden Sie im Handbuch "`Bacula Installation und Konfiguration"'.
-
-\begin{description}
-
-\item [File Retention = \lt{}time-period-specification\gt{}]
- \index[general]{File Retention}
- Der Aufbewahrungszeitraum f\"{u}r Dateien gibt die Zeitspanne an, die die
-Datei-Eintr\"{a}ge in der Katalog-Datenbank aufbewahrt werden.
-Wenn {\bf AutoPrune} in der Client-Konfiguration auf {\bf yes} gesetzt ist,
-wird Bacula die Katalog-Eintr\"{a}ge der Dateien l\"{o}schen, die \"{a}lter als
-dieser Zeitraum sind. Das L\"{o}schen erfolgt nach Beendigung eines Jobs des entsprechenden Clients.
-Bitte beachten Sie, dass die Client-Datenbank-Eintr\"{a}ge eine Kopie der Aufbewahrungszeitr\"{a}ume
-f\"{u}r Dateien und Jobs enthalten, Bacula aber die Zeitr\"{a}ume aus der aktuellen Client-Konfiguration
-des Director-Dienstes benutzt um alte Katalog-Eintr\"{a}ge zu l\"{o}schen.
-
-Da die Datei-Eintr\"{a}ge ca. 80 Prozent der Katalog-Datenbankgr\"{o}{\ss}e ausmachen,
-sollten Sie sorgf\"{a}lltig ermitteln \"{u}ber welchen Zeitraum Sie die Eintr\"{a}ge aufbewahren wollen.
-Nachdem die Datei-Eintr\"{a}ge gel\"{o}scht wurden, ist es nicht mehr m\"{o}glich einzelne dieser Dateien
-wiederherzustellen. Die Bacula-Versionen 1.37 und sp\"{a}ter sind allerdings in der Lage, aufgrund des
-Job-Eintrags im Katalog, alle Dateien des Jobs zur\"{u}ckzusichern, solange der Job-Eintrag
-im Katalog vorhanden ist.
-
-Aufbewahrungszeitr\"{a}ume werden in Sekunden angegeben, aber der Einfachheit halber sind auch
-eine Reihe von Hilfsangaben m\"{o}glich, so dass man Minuten, Stunden, Tage, Wochen,
-Monate, Quartale und Jahre konfigurieren kann. Lesen Sie bitte das \ilink{Konfigurations-Kapitel}{Time}
-dieses Handbuchs um mehr \"{u}ber diese Hilfsangaben zu erfahren.
-
-Der Standardwert der Aufbewahrungszeit f\"{u}r Dateien ist 60 Tage.
-
-\item [Job Retention = \lt{}time-period-specification\gt{}]
- \index[general]{Job Retention }
- Der Aufbewahrungszeitraum f\"{u}r Jobs gibt die Zeitspanne an, die die
-Job-Eintr\"{a}ge in der Katalog-Datenbank aufbewahrt werden.
-Wenn {\bf AutoPrune} in der Client-Konfiguration auf {\bf yes} gesetzt ist,
-wird Bacula die Katalog-Eintr\"{a}ge der Jobs l\"{o}schen, die \"{a}lter als
-dieser Zeitraum sind. Beachten Sie, dass wenn ein Job-Eintrag gel\"{o}scht wird,
-auch alle zu diesem Job geh\"{o}renden Datei- und JobMedia-Eintr\"{a}ge aus dem
-Katalog gel\"{o}scht werden. Dies passiert unabh\"{a}ngig von der Aufbewahrungszeit f\"{u}r Dateien,
-infolge dessen wird die Aufbewahrungszeit f\"{u}r Dateien normalerweise k\"{u}rzer sein als f\"{u}r Jobs.
-
-Wie oben erw\"{a}hnt, sind Sie nicht mehr in der Lage einzelne Dateien eines Jobs zur\"{u}ckzusichern,
-wenn die Datei-Eintr\"{a}ge aus der Katalog-Datenbank entfernt wurden. Jedoch, solange der Job-Eintrag
-im Katalog vorhanden ist, k\"{o}nnen Sie immer noch den kompletten Job mit allen Dateien wiederherstellen
-(ab Bacula-Version 1.37 und gr\"{o}{\ss}er). Daher ist es eine gute Idee, die Job-Eintr\"{a}ge im Katalog
-l\"{a}nger als die Datei-Eintr\"{a}ge aufzubewahren.
-
-Aufbewahrungszeitr\"{a}ume werden in Sekunden angegeben, aber der Einfachheit halber sind auch
-eine Reihe von Hilfsangaben m\"{o}glich, so dass man Minuten, Stunden, Tage, Wochen,
-Monate, Quartale und Jahre konfigurieren kann. Lesen Sie bitte das \ilink{Konfigurations-Kapitel}{Time}
-dieses Handbuchs um mehr \"{u}ber diese Hilfsangaben zu erfahren.
-
-Der Standardwert der Aufbewahrungszeit f\"{u}r Jobs ist 180 Tage.
-
-\item [AutoPrune = \lt{}yes/no\gt{}]
- \index[general]{AutoPrune }
- Wenn AutoPrune auf {\bf yes} (Standard) gesetzt ist, wird Bacula nach jedem Job
-automatisch \"{u}berpr\"{u}fen, ob die Aufbewahrungszeit f\"{u}r bestimmte Dateien und/oder Jobs
-des gerade gesicherten Clients abgelaufen ist und diese aus dem Katalog entfernen.
-Falls Sie AutoPrune durch das Setzen auf {\bf no} ausschalten, wird Ihre Katalog-Datenbank mit jedem
-gelaufenen Job immer gr\"{o}{\ss}er werden.
-\end{description}
-
-\label{CompactingMySQL}
-\section{Komprimieren Ihrer MySQL Datenbank}
-\index[general]{Datenbank!Komprimieren Ihrer MySQL }
-\index[general]{Komprimieren Ihrer MySQL Datenbank }
-
-Mit der Zeit, wie oben schon angemerkt, wird Ihre Datenbank dazu neigen zu wachsen.
-Auch wenn Bacula regelm\"{a}{\ss}ig Datei-Eintr\"{a}ge l\"{o}scht, wird die {\bf MySQL}-Datenbank
-st\"{a}ndig gr\"{o}{\ss}er werden. Um dies zu vermeiden, muss die Datenbank komprimiert werden.
-Normalerweise kennen gro{\ss}e kommerzielle Datenbanken, wie Oracle, bestimmte Kommandos
-um den verschwendeten Festplattenplatz wieder freizugeben. MySQL hat das {\bf OPTIMIZE TABLE}
-Kommando und bei SQLite (Version 2.8.4 und gr\"{o}{\ss}er) k\"{o}nnen Sie das {\bf VACUUM}
-Kommando zu diesem Zweck benutzen. Wir \"{u}berlassen es Ihnen, die N\"{u}tzlichkeit von
-{\bf OPTIMIZE TABLE} oder {\bf VACUUM} zu beurteilen.
-
-Alle Datenbanken haben Hilfsmittel, um die enthaltenen Daten im ASCII-Format in eine Datei zu schreiben
-und diese Datei dann auch wieder einzulesen. Wenn man das tut, wird die Datenbank erneut erzeugt, was ein
-sehr kompaktes Datenbank-Format als Ergebnis hat. Weiter unten zeigen wir Ihnen, wie Sie das bei
-MySQL, SQLite und PostgreSQL durchf\"{u}hren k\"{o}nnen.
-
-Bei einer {\bf MySQL} Datenbank k\"{o}nnen Sie den Inhalt der Katalog-Datenbank mit den folgenden Kommandos
-in eine ASCII-Datei (bacula.sql) schreiben und neu in die Datenbank importieren:
-
-\footnotesize
-\begin{alltt}
-mysqldump -f --opt bacula > bacula.sql
-mysql bacula < bacula.sql
-rm -f bacula.sql
-\end{alltt}
-\normalsize
-
-Abh\"{a}ngig von der Gr\"{o}{\ss}e Ihrer Datenbank, wird dies mehr oder weniger Zeit und auch Festplattenplatz
-ben\"{o}tigen. Zum Beispiel, wenn ich in das Verzeichnis wechsle, wo meine MySQL-Datenbank liegt (typischerweise
-/var/lib/mysql) und dieses Kommando ausf\"{u}hre:
-
-\footnotesize
-\begin{alltt}
-du bacula
-\end{alltt}
-\normalsize
-
-bekomme ich die Ausgabe {\bf 620,644}, was bedeutet dass das Verzeichnis bacula 620.644 Bl\"{o}cke
-von 1024 Bytes auf der Festplatte belegt, meine Datenbank enth\"{a}lt also ca. 635 MB an Daten.
-Nachdem ich das {\bf mysqldump} ausgef\"{u}hrt habe, ist die dabei entstandene Datei bacula.sql
-{\bf 174.356} Bl\"{o}cke gro{\ss}, wenn diese Datei mit dem Kommando {\bf mysql bacula \lt{} bacula.sql}
-wieder in die Datenbank importiert wird, ergibt sich eine Datenbankgr\"{o}{\ss}e von nur noch {\bf 210.464}
-Bl\"{o}cken. Mit anderen Worten, die komprimierte Version meiner Datenbank, die seit ca. 1 Jahr
-in Benutzung ist, ist ungef\"{a}hr nur noch ein Drittel so gro{\ss} wie vorher.
-
-Als Konsequenz wird empfohlen, auf die Gr\"{o}{\ss}e der Datenbank zu achten und sie von Zeit zu Zeit
-(alle sechs Monate oder j\"{a}hrlich) zu komprimieren.
-
-\label{DatabaseRepair}
-\label{RepairingMySQL}
-\section{Reparatur Ihrer MySQL Datenbank}
-\index[general]{Datenbank!Reparatur Ihrer MySQL }
-\index[general]{Reparatur Ihrer MySQL Datenbank }
-
-Wenn Sie bemerken, dass das Schreiben der MySQL-Datenbank zu Fehlern f\"{u}hrt,
-oder das der Director-Dienst h\"{a}ngt, wenn er auf die Datenbank zugreift,
-sollten Sie sich die MySQL Datenbank\"{u}berpr\"{u}fungs- und Reparaturprogramme ansehen.
-Welches Programm Sie laufen lassen sollten, h\"{a}ngt mit der von Ihnen benutzten Datenbank-
-Indizierung zusammen. Wenn Sie das Standardverfahren nutzen, werden Sie vermutlich {\bf myisamchk}
-laufen lassen. F\"{a}r n\"{a}here Information lesen Sie bitte auch:
-\elink{http://dev.mysql.com/doc/refman/5.1/de/client-utility-programs.html}
-{http://dev.mysql.com/doc/refman/5.1/de/client-utility-programs.html}.
-
-Falls die auftretenden Fehler einfache SQL-Warnungen sind, sollten Sie zuerst das von Bacula mitgelieferte
-dbcheck-Programm ausf\"{u}hren, bevor Sie die MySQL-Datenbank-Reparaturprogramme nutzen.
-Dieses Programm kann verwaiste Datenbankeintr\"{a}ge finden und andere Inkonsistenzen in der
-Katalog-Datenbank beheben.
-
-Eine typische Ursache von Datenbankproblemen ist das Volllaufen einer Partition.
-In solch einem Fall muss entweder zus\"{a}tzlicher Platz geschaffen werden, oder
-belegter Platz freigegeben werden, bevor die Datenbank mit {\bf myisamchk} repariert werden kann.
-
-Hier ist ein Beispiel, wie man eine korrupte Datenbank reparieren k\"{o}nnte, falls nach dem Vollaufen
-einer Partition die Datenbankprobleme mit {\bf myisamchk -r} nicht behoben werden k\"{o}nnen:
-
-kopieren Sie folgende Zeilen in ein Shell-Script names {\bf repair}:
-\footnotesize
-\begin{alltt}
-#!/bin/sh
-for i in *.MYD ; do
- mv \$i x\$\{i\}
- t=`echo \$i | cut -f 1 -d '.' -`
- mysql bacula <<END_OF_DATA
-set autocommit=1;
-truncate table \$t;
-quit
-END_OF_DATA
- cp x\$\{i\} \$\{i\}
- chown mysql:mysql \$\{i\}
- myisamchk -r \$\{t\}
-done
-\end{alltt}
-\normalsize
-
-dieses Shell-Script, wird dann wie folgt aufgerufen:
-
-\footnotesize
-\begin{alltt}
-cd /var/lib/mysql/bacula
-./repair
-\end{alltt}
-\normalsize
-
-nachdem sichergestellt ist, dass die Datenbank wieder korrekt funktioniert,
-kann man die alten Datenbank-Dateien l\"{o}schen:
-\footnotesize
-\begin{alltt}
-cd /var/lib/mysql/bacula
-rm -f x*.MYD
-\end{alltt}
-\normalsize
-
-\section{MySQL-Tabelle ist voll}
-\index[general]{Datenbank!MySQL-Tabelle ist voll}
-\index[general]{MySQL-Tabelle ist voll}
-
-Falls ein Fehler wie {\bf The table 'File' is full ...} auftritt,
-passiert das vermutlich, weil bei den MySQL-Versionen 4.x die Tabellengr\"{o}{\ss}e
-standardm\"{a}{\ss}ig auf 4 GB begrenzt ist und Sie dieses Limit erreicht haben.
-Hinweise zu der maximal m\"{o}glichen Tabellengr\"{o}{\ss}e gibt es auf
-\elink{http://dev.mysql.com/doc/refman/5.1/de/table-size.html}{http://dev.mysql.com/doc/refman/5.1/de/table-size.html}
-
-Sie k\"{o}nnen sich die maximale Tabellengr\"{o}{\ss}e mit:
-
-\footnotesize
-\begin{alltt}
-mysql bacula
-SHOW TABLE STATUS FROM bacula like "File";
-\end{alltt}
-\normalsize
-
-anzeigen lassen. Wenn die Spalte {\bf max\_data\_length} ca. 4 GB entspricht,
-dann ist dass das Problem. Sie k\"{o}nnen die maximale Gr\"{o}{\ss}e aber mit:
-
-\footnotesize
-\begin{alltt}
-mysql bacula
-ALTER TABLE File MAX_ROWS=281474976710656;
-\end{alltt}
-\normalsize
-
-anpassen. Alternativ k\"{o}nnen Sie auch die /etc/my.cnf editieren, bevor Sie die Bacula-Tabellen erstellen,
-setzen Sie im Abschnitt [mysqld]:
-
-\footnotesize
-\begin{alltt}
-set-variable = myisam_data_pointer_size=6
-\end{alltt}
-\normalsize
-
-
-Die myisam Data-Pointer-Gr\"{o}{\ss}e muss vor dem Anlegen der Bacula-Katalog-Datenbank oder ihrer Tabellen
-gesetzt werden, um wirksam zu sein.
-
-Die MAX\_ROWS und Pointer-Anpassungen sollten bei MySQL-Versionen gr\"{o}{\ss}er 5.x nicht n\"{o}tig sein,
-somit sind diese \"{A}nderungen nur bei MySQL 4.x, in Abh\"{a}gigkeit von Ihrer Katalog-Datenbank-Gr\"{o}{\ss}e,
-notwendig.
-
-\section{MySQL-Server Has Gone Away-Fehler}
-\index[general]{Datenbank!MySQL-Server Has Gone Away-Fehler}
-\index[general]{MySQL-Server Has Gone Away-Fehler}
-Fall Sie Probleme damit haben, dass Ihr MySQL-Server nicht mehr erreichbar ist, oder Meldungen wie
-"`MySQL server has gone away"' erscheinen, dann lesen Sie bitte die MySQL-Dokumentation auf:
-
-\elink{http://dev.mysql.com/doc/refman/5.1/de/gone-away.html}
-{http://dev.mysql.com/doc/refman/5.1/de/gone-away.html}
-
-
-\label{RepairingPSQL}
-\section{Reparatur Ihrer PostgreSQL Datenbank}
-\index[general]{Datenbank!Reparatur Ihrer PostgreSQL }
-\index[general]{Reparatur Ihrer PostgreSQL Datenbank}
-
-Dieselben \"{U}berlegungen, wie oben f\"{u}r MySQL angef\"{u}hrt, sind auch hier g\"{u}ltig.
-Lesen Sie die PostgreSQL-Dokumentation um zu erfahren, wie Sie Ihre Datenbank reparieren k\"{o}nnen.
-Erw\"{a}gen Sie auch den Einsatz von Bacula's dbcheck-Programm, falls es sinnvoll erscheint (siehe oben).
-
-\label{DatabasePerformance}
-\section{Datenbank-Leistung}
-\index[general]{Datenbank-Leistung}
-\index[general]{Leistung!Datenbank}
-
-Es gibt viele Wege, die verschiedenen von Bacula unterst\"{u}tzten Datenbanken abzustimmen, um ihre Leistung zu erh\"{o}hen.
-Zwischen einer schlecht und gut abgestimmten Datenbank kann ein Geschwindigkeitsunterschied von 100 und mehr liegen,
-wenn es darum geht Datenbankeintr\"{a}ge zu schreiben oder zu suchen.
-
-Bei jeder der Datenbanken, k\"{o}nnen Sie erhebliche Verbesserungen erwarten, wenn Sie weitere Indexe hinzuf\"{u}gen.
-Die Kommentare in den Bacula make\_xxx\_tables-Scripts (z.B. make\_postgres\_tables) geben einige Hinweise,
-wof\"{u}r Indexe geeignet sind. Sehen Sie bitte auch unten f\"{u}r genaue Informationen, wie Sie Ihre Indexe
-\"{u}berpr\"{u}fen k\"{o}nnen.
-
-F\"{u}r MySQL ist es sehr wichtig, die my.cnf-Datei durchzusehen (gw\"{o}hnlich /etc/my.cnf)
-Eventuell k\"{o}nnen Sie die Leistung wesentlich erh\"{o}hen, wenn Sie die Konfigurationsdateien
-my-large.cnf oder my-huge.cnf aus dem MySQL-Quellcode verwenden.
-
-F\"{u}r SQLite3 ist ein wichtiger Punkt, dass in der Konfiguration die Angabe "`PRAGMA synchronous = NORMAL;"'
-vorhanden ist. Dadurch werden die Zeitabst\"{a}nde vergr\"{o}{\ss}ert, in denen die Datenbank ihren RAM-Zwischenspeicher
-auf die Festplatte schreibt. Es gibt noch andere Einstellungen f\"{u}r PRAGMA die die Effizienz steigern k\"{o}nnen,
-aber auch das Risiko einer Datenbankbesch\"{a}digung beim Absturz des Systems erh\"{o}hen.
-
-Bei PostgreSQL sollten Sie eventuell in Betracht ziehen "`fsync"' abzuschalten,
-aber auch das kann bei Systemabst\"{u}rzen zu Datenbankprobleme f\"{u}hren.
-Es gibt viele Wege die Leistungsf\"{a}higkeit von PostgreSQL zu steigern,
-diese Internetseiten erkl\"{a}ren ein paar von ihnen (auf englisch):
-\elink{http://www.varlena.com/varlena/GeneralBits/Tidbits/perf.html}
-{http://www.varlena.com/varlena/GeneralBits/Tidbits/perf.html}.
-
-Auch in den PostgreSQL FAQ's finden sich Hinweise die Performanz zu verbessern:
-\elink{http://www.postgresql.org/docs/faqs.FAQ.html}
-{http://www.postgresql.org/docs/faqs.FAQ.html}.
-
-Bei PostgreSQL sollten Sie auch auf die "`effective\_cache\_size"' achten.
-F\"{u}r ein System mit 2GB Arbeitsspeicher k\"{o}nnen Sie sie auf 131072 setzen,
-aber setzen Sie sie nicht zu hoch. Zus\"{a}tzlich sind "`work\_mem = 256000"' und
-"`maintenance\_work\_mem = 256000"', f\"{u}r Systeme mit 2GB Speicher, sinnvolle Werte.
-Stellen Sie sicher das "`checkpoint\_segments"' auf mindestens 8 gesetzt ist.
-
-\section{Datenbank-Leistung und Indexe}
-\index[general]{Datenbank-Leistung und Indexe}
-\index[general]{Leistung!Datenbank und Indexe}
-Eine der wichtigsten Aspekte die Leistungsf\"{a}higkeit der Bacula-Datenbank sicherzustellen ist zu \"{u}berpr\"{u}fen,
-ob alle Indexe richtig sind. Mehrere Benutzer haben angemerkt, dass ihre Datenbank in der Standardkonfiguration
-nicht alle notwendigen Indexe hatte. Auch werden Sie eventuell, abh\"{a}ngig von Ihrem Anwendungszweck,
-zus\"{a}tzlich Indexe ben\"{o}tigen.
-
-Die wichtigsten Indexe f\"{u}r eine schnelle Datenbank sind die drei Indexe auf der {\bf File}-Tabelle.
-Der erste Index ist auf der {\bf FileId} und wird automatisch anglegt, da es der eindeutige Schl\"{u}ssel ist,
-um auf die Tabelle zuzugreifen. Die anderen beiden sind der {\bf JobId}-Index und der {\bf Filename, PathId}-Index.
-Wenn einer dieser Indexe fehlt, verliert Ihre Datenbank enorm an Performance.
-
-\subsection{PostgreSQL Indexe}
-Bei PostgreSQL k\"{o}nnen Sie mit dem folgenden Kommandos \"{u}berpr\"{u}fen ob Sie alle Indexe haben:
-
-\footnotesize
-\begin{alltt}
-psql bacula
-select * from pg_indexes where tablename='file';
-\end{alltt}
-\normalsize
-
-Wenn Sie keine Ausgaben sehen die anzeigen das alle drei Indexe vorhanden sind,
-k\"{o}nnen Sie die beiden zus\"{a}tzlichen Indexe mit:
-
-\footnotesize
-\begin{alltt}
-psql bacula
-CREATE INDEX file_jobid_idx on file (jobid);
-CREATE INDEX file_fp_idx on file (filenameid, pathid);
-\end{alltt}
-\normalsize
-
-anlegen.
-
-\subsection{MySQL Indexes}
-Bei MySQL k\"{o}nnen Sie die Indexe mit:
-
-\footnotesize
-\begin{alltt}
-mysql bacula
-show index from File;
-\end{alltt}
-\normalsize
-
-\"{u}berpr\"{u}fen.
-Wenn Indexe fehlen, besonders der {\bf JobId}-Index, kann er mit:
-
-\footnotesize
-\begin{alltt}
-mysql bacula
-CREATE INDEX file_jobid_idx on File (JobId);
-CREATE INDEX file_jpf_idx on File (JobId, FilenameId, PathId);
-\end{alltt}
-\normalsize
-
-erzeugt werden.
-
-Obgleich das normalerweise kein Problem darstellt, sollten Sie sicherstellen, dass Ihre Indexe f\"{u}r {\bf Filename} und {\bf PathId}
-beide auf 255 Zeichen gesetzt sind. Einige Benutzer berichten von Problemen mit Indexen die auf 50 Zeichen gesetzt sind.
-Um das zu kontrollieren, f\"{u}hren Sie:
-
-\footnotesize
-\begin{alltt}
-mysql bacula
-show index from Filename;
-show index from Path;
-\end{alltt}
-\normalsize
-
-aus.
-F\"{u} die Dateinamen ist es wichtig, dass Sie einen Index haben mit dem Key\_name "`Name"' und dem Sub\_part "`255"'.
-F\"{u} den Pfad m\"{u}ssen Sie einen Index mit dem Key\_name "`Path"' und dem Sub\_part "`255"' haben.
-Wenn einer der Indexe nicht existiert oder der Sub\_part kleiner 255 ist, k\"{o}nnen Sie den Index neu anlegen indem Sie
-die folgende Kommandos benutzen:
-
-\footnotesize
-\begin{alltt}
-mysql bacula
-DROP INDEX Path on Path;
-CREATE INDEX Path on Path (Path(255);
-
-DROP INDEX Name on Filename;
-CREATE INDEX Name on Filename (Name(255));
-\end{alltt}
-\normalsize
-
-
-\subsection{SQLite Indexes}
-Bei SQLite k\"{o}nnen Sie so die Indexe \"{u}berpr\"{u}fen:
-
-\footnotesize
-\begin{alltt}
-sqlite <path>bacula.db
-select * from sqlite_master where type='index' and tbl_name='File';
-\end{alltt}
-\normalsize
-
-Falls ein Index fehlt, im besonderen der {\bf JobId}-Index, k\"{o}nnen Sie ihn mit den folgenden Befehlen erstellen:
-
-\footnotesize
-\begin{alltt}
-mysql bacula
-CREATE INDEX file_jobid_idx on File (JobId);
-CREATE INDEX file_jfp_idx on File (JobId, FilenameId, PathId);
-\end{alltt}
-\normalsize
-
-
-
-\label{CompactingPostgres}
-\section{Komprimieren Ihrer PostgreSQL Datenbank}
-\index[general]{Datenbank!Komprimieren Ihrer PostgreSQL }
-\index[general]{Komprimieren Ihrer PostgreSQL Datenbank }
-
-\"{U}ber die Zeit, wie schon oben angemerkt, wird Ihre Datenbank wachsen.
-Auch wenn Bacula regelm\"{a}{\ss}ig alte Daten l\"{o}scht, wird das PostgreSQL Kommando {\bf VACUUM}
-Ihnen helfen die Datenbank zu komprimieren. Alternativ wollen Sie eventuell das {\bf vacuumdb}-Kommando nutzen,
-das vom cron-Dienst gestartet werden kann.
-
-Alle Datenbanken haben Hilfsmittel, um die Daten in eine ASCII-Datei zu schreiben um sie dann erneut einzulesen.
-Wenn Sie das tun, wird die Datenbank komplett neu aufgebaut und so eine kompaktere Version entstehen.
-Wie Sie so etwas tun k\"{o}nnen, zeigt Ihnen das folgende PostgreSQL Beispiel.
-
-Bei einer PostgreSQL-Datenbank lassen Sie die Daten in eine ASCII-Datei schreiben und neu einlesen,
-wenn Sie diese Kommandos ausf\"{u}hren:
-
-\footnotesize
-\begin{alltt}
-pg_dump -c bacula > bacula.sql
-cat bacula.sql | psql bacula
-rm -f bacula.sql
-\end{alltt}
-\normalsize
-
-Abh\"{a}gig von Ihrer Datenbankgr\"{o}{\ss}e wird dieser Vorgang mehr oder
-weniger Zeit und Festplattenplatz in Anspruch nehmen. Sie sollten vorher
-in das Arbeitsverzeichnis Ihrer Datenbank wechseln (typischerweise
-/var/lib/postgres/data) und die Gr\"{o}{\ss}e \"{u}berpr\"{u}fen.
-
-Bestimmte PostgreSQL-Nutzer empfehlen nicht die oben genannte Prozedur, sie sind der Meinung:
-bei PostgreSQL ist es nicht notwendig, die Daten zu exportieren um sie dann wieder einzulesen.
-Das normale Ausf\"{u}hren des {\bf VACUUM}-Kommandos reicht, um die Datenbank performant zu halten.
-Wenn Sie es ganz genau machen wollen, benutzen Sie speziellen Kommandos {\bf VACUUM FULL, REINDEX} und {\bf CLUSTER}
-um sich den Umweg \"{u}ber das exportieren und wiedereinlesen der Daten zu ersparen.
-
-Zum Schlu{\ss} wollen Sie vielleicht noch einen Blick auf die zugeh\"{o}rige PostgreSQL-Dokumentation werfen,
-Sie finden sie (auf englisch) unter:
-\elink{http://www.postgresql.org/docs/8.2/interactive/maintenance.html}
-{http://www.postgresql.org/docs/8.2/interactive/maintenance.html}.
-
-\section{Komprimieren Ihrer SQLite Datenbank}
-\index[general]{Komprimieren Ihrer SQLite Datenbank}
-\index[general]{Datenbank!Komprimieren Ihrer SQLite }
-
-Lesen Sie bitte zuerst die vorherigen Abschnitte die erkl\"{a}ren, warum es erforderlich ist, eine Datenbank zu komprimieren.
-SQLite-Versionen gr\"{o}{\ss}er 2.8.4 haben das {\bf Vacuum}-Kommando um die Datenbank zu komprimieren:
-
-\footnotesize
-\begin{alltt}
-cd {\bf working-directory}
-echo 'vacuum;' | sqlite bacula.db
-\end{alltt}
-\normalsize
-
-Als Alternative k\"{o}nnen Sie auch die folgenden Kommandos (auf Ihr System angepasst) benutzen:
-
-\footnotesize
-\begin{alltt}
-cd {\bf working-directory}
-echo '.dump' | sqlite bacula.db > bacula.sql
-rm -f bacula.db
-sqlite bacula.db < bacula.sql
-rm -f bacula.sql
-\end{alltt}
-\normalsize
-
-Wobei {\bf working-directory} das Verzeichnis ist, dass Sie in Ihrer Director-Dienst-Konfiguration angegeben haben.
-Beachten Sie bitte, dass es im Fall von SQLite erforderlich ist, die alte Datenbank komplett zu l\"{o}schen,
-bevor die komprimierte Version angelegt werden kann.
-
-\section{Migration von SQLite zu MySQL/PostgreSQL}
-\index[general]{MySQL!Migration von SQLite zu }
-\index[general]{PostgreSQL!Migration von SQLite zu }
-\index[general]{Migration von SQLite zu MySQL/PostgreSQL }
-
-Wenn Sie Bacula anfangs mit SQLite zusammen benutzt haben, gibt es sp\"{a}ter
-eine Reihe von Gr\"{u}nden, weshalb Sie eventuell auf MySQL oder PostgreSQL
-umsteigen wollen:
-SQLite belegt mehr Festplattenplatz f\"{u}r dieselbe Datenmenge als MySQL;
-falls die Datenbank besch\"{a}digt wird, ist es mit SQLite problematischer als
-bei MySQL oder PostgreSQL, sie wiederherzustellen. Viele Benutzer sind erfolgreich
-von SQLite auf MySQL oder PostgreSQL umgestiegen, indem sie zuerst die Daten
-exportiert haben und sie dann mit einem Perl-Script in ein passendes Format
-konvertiert haben, um sie in die neue Datenbank zu importieren.
-Dies ist aber kein ganz einfacher Vorgang. Beispiel-Scripte dazu finden Sie
-im Bacula-Quelltext unter {\bf examples/database}.
-
-\label{BackingUpBacula}
-\section{Sichern Ihrer Bacula Datenbank}
-\index[general]{Sichern Ihrer Bacula Datenbank}
-\index[general]{Datenbank!Sichern Ihrer Bacula }
-
-Falls jemals der Rechner auf dem Ihre Bacula-Installation l\"{a}uft abst\"{u}rzt,
-und Sie diesen wiederherstellen m\"{u}ssen, wird es einer der ersten Schritte sein,
-die Datenbank zur\"{u}ckzusichern. Obwohl Bacula fr\"{o}hlich die Datenbank sichert,
-wenn sie im FileSet angegeben ist, ist das kein sehr guter Weg, da Bacula die Datenbank
-\"{a}ndert, w\"{a}hrend sie gesichert wird. Dadurch ist die gesicherte Datenbank wahrscheinlich
-in einem inkonsistenten Zustand. Noch schlimmer ist, dass die Datenbank gesichert wird,
-bevor Bacula alle Aktualisierungen durchf\"{u}hren kann.
-
-Um diese Problem zu umgehen, m\"{u}ssen Sie die Datenbank sichern nachdem alle Backup-Jobs
-gelaufen sind. Zus\"{a}tzlich werden Sie wohl eine Kopie der Datenbank erstellen wollen,
-w\"{a}hrend Bacula keine Aktualisierungen vornimmt. Um das zu erreichen, k\"{o}nnen Sie
-die beiden Scripte {\bf make\_catalog\_backup} und {\bf delete\_catalog\_backup} benutzen,
-die Ihrer Bacula-Version beiliegen. Diese Dateien werden, zusammen mit den anderen Bacula-Scripts,
-automatisch erzeugt. Das erste Script erzeugt eine ASCII-Kopie Ihrer Datenbank namens {\bf bacula.sql}
-in dem Arbeitsverzeichnis, dass Sie in der Konfiguration angegeben haben. Das zweite Script
-l\"{o}scht die Datei {\bf bacula.sql} wieder.
-
-Die grundlegenden Arbeitsschritte damit alles korrekt funktioniert, sind folgende:
-
-\begin{itemize}
-\item alle Backup-Jobs laufen lassen
-\item wenn alle Jobs beendet sind, wird ein Catalog Backup-Job gestartet
-\item Der Catalog Backup-Job muss nach den anderen Backup-Jobs laufen
-
-\item Benutzen Sie {\bf RunBeforeJob} um die ASCII-Sicherungsdatei zu erstellen und
- {\bf RunAfterJob} um sie wieder zu l\"{o}schen
-\end{itemize}
-
-Angenommen Sie starten alle Ihre Backup-Jobs nachts um 01:05, k\"{o}nnen Sie das Catalog-Backup
-mit der folgenden zus\"{a}tzlichen Director-Dienst-Konfiguration ausf\"{u}hren lassen:
-
-\footnotesize
-\begin{alltt}
-# Catalog-Datenbank-Backup (nach der n\"{a}chtlichen Sicherung)
-Job \{
- Name = BackupCatalog
- Type = Backup
- Client=rufus-fd
- FileSet=Catalog
- Schedule = WeeklyCycleAfterBackup
- Storage = DLTDrive
- Messages = Standard
- Pool = Default
- # Achtung!!! Das Passwort auf der Kommandozeile zu \"{u}bergeben ist nicht sicher.
- # Lesen Sie bitte die Kommentare in der Datei make_catalog_backup.
- RunBeforeJob = "/home/bacula/bin/make_catalog_backup"
- RunAfterJob = "/home/bacula/bin/delete_catalog_backup"
- Write Bootstrap = "/home/bacula/working/BackupCatalog.bsr"
-\}
-# Diese Schedule starten das Catalog-Backup nach den anderen Sicherungen
-Schedule \{
- Name = WeeklyCycleAfterBackup
- Run = Level=Full sun-sat at 1:10
-\}
-# Das FileSet f\"{u}r die ASCII-Kopie der Datenbank
-FileSet \{
- Name = Catalog
- Include \{
- Options \{
- signature=MD5
- \}
- File = "<working_directory>/bacula.sql"
- \}
-\}
-\end{alltt}
-\normalsize
-
-Stellen Sie sicher, dass, wie in dem Beispiel, eine Bootstrap-Datei geschrieben wird.
-Bevorzugterweise wird eine Kopie dieser Bootstrap-Datei auf einem andern Computer gespeichert.
-Dies erlaubt eine schnelle Wiederherstellung der Datenbank, falls erforderlich. Wenn Sie
-keine Bootstrap-Datei haben, ist es trotzdem m\"{o}glich, erfordert aber mehr Arbeit und dauert l\"{a}nger.
-
-
-\label{BackingUpBaculaSecurityConsiderations}
-\section{Sicherheitsaspekte}
-\index[general]{Sicherung der Bacula Datenbank - Sicherheitsaspekte }
-\index[general]{Datenbank!Sicherung der Bacula Datenbank - Sicherheitsaspekte }
-
-Das Script make\_catalog\_backup wird als Beispiel bereitgestellt, wie Sie Ihre
-Bacula Datenbank sichern k\"{o}nnen. Wir erwarten das Sie, entsprechend Ihrer Situation,
-Vorsichtsma{\ss}nahmen treffen.
-make\_catalog\_backup ist so ausgelegt, dass das Passwort auf der Kommandozeile \"{u}bergeben wird.
-Das ist in Ordnung, solange sich nur vertrauensw\"{u}rdige Benutzer am System anmelden k\"{o}nnen,
-ansonsten ist es inakzeptabel. Die meisten Datenbanksysteme bieten eine alternative Methode an,
-um das Passwort nicht auf der Kommandozeile \"{u}bergeben zu m\"{u}ssen.
-
-Das Script make\_catalog\_backup enth\"{a}lt einige Warnungen dies betreffend. Bitte lesen Sie
-die Kommentare im Script.
-
-Bei PostgreSQL k\"{o}nnen Sie z.B. eine Passwort-Datei verwenden, siehe
-\elink{.pgpass}{http://www.postgresql.org/docs/8.2/static/libpq-pgpass.html},
-und MySQL hat die \elink{ .my.cnf}{http://dev.mysql.com/doc/refman/5.1/de/password-security.html}.
-
-Wir hoffen, dass wir Ihnen damit etwas helfen konnten,
-aber nur Sie k\"{o}nenn beurteilen, was in Ihrer Situation erforderlich ist.
-
-
-\label{BackingUPOtherDBs}
-\section{Sicherung anderer Datenbanken}
-\index[general]{Sicherung anderer Datenbanken }
-\index[general]{Datenbanken!Sicherung anderer }
-
-Wie oben schon erw\"{a}hnt wurde, f\"{u}hrt das Sichern von Datenbank-Dateien im laufenden Betrieb
-dazu, dass die gesicherten Dateien sich wahrscheinlich in einem inkonsistenten Zustand befinden.
-
-Die beste L\"{o}sung daf\"{u}r ist, die Datenbank vor der Sicherung zu stoppen,
-oder datenbankspezifische Hilfsprogramme zu verwenden, um eine g\"{u}ltige Sicherungsdatei zu erstellen,
-die Bacula dann auf die Volumes schreiben kann. Wenn Sie unsicher sind, wie Sie das am besten mit der
-von Ihnen benutzten Datenbank erreichen k\"{o}nnen, hilft Ihnen eventuell die Webseite von Backup Central
-weiter. Auf \elink{ Free Backup and Recovery Software}{http://www.backupcentral.com/toc-free-backup-software.html}
-finden Sie Links zu Scripts die zeigen, wie man die meisten gr\"{o}{\ss}eren Datenbanken sichern kann.
-
-\label{Size}
-\section{Datenbank Gr\"{o}{\ss}e}
-\index[general]{Gr\"{o}{\ss}e!Datenbank }
-\index[general]{Datenbank Gr\"{o}{\ss}e }
-
-Wenn Sie nicht automatisch alte Datens\"{a}tze aus Ihrer Katalog-Datenbank l\"{o}schen lassen,
-wird Ihre Datenbank mit jedem gelaufenen Backup-Job wachsen (siehe auch weiter oben).
-Normalerweise sollten Sie sich entscheiden, wie lange Sie die Datei-Eintr\"{a}ge im Katalog
-aufbewaren wollen und die {\bf File Retention} entsprechend konfigurieren. Dann k\"{o}nnen Sie
-entweder abwarten wie gro{\ss} Ihre Katalog-Datenbank werden wird, oder es aber auch unge\"{a}hr
-berechnen. Dazu m\"{u}ssen Sie wissen, dass f\"{u}r jede gesicherte Datei in etwa 154 Bytes in der
-Katalog-Datenbank belegt werden und wieviele Dateien Sie auf wievielen Computern sichern werden.
-
-Ein Beispiel: angenommen Sie sichern zwei Computer, jeder mit 100.000 Dateien.
-Weiterhin angenommen, Sie machen ein w\"{o}chentliches Full-Backup und ein
-inkrementelles jeden Tag, wobei bei einem inkrementellen Backup typischerweise 4.000 Dateien
-gesichert werden. Die ungef\"{a}hre Gr\"{o}{\ss}e Ihrer Datenbank nach einem Monat
-kann dann so berechnet werden:
-
-\footnotesize
-\begin{alltt}
- Gr\"{o}{\ss}e = 154 * Anzahl Computer * (100.000 * 4 + 10.000 * 26)
-\end{alltt}
-\normalsize
-
-wenn ein Monat mit 4 Wochen angenommen wird, werden also 26 inkrementelle Backups im Monat laufen.
-Das ergibt das folgende:
-\footnotesize
-\begin{alltt}
- Gr\"{o}{\ss}e = 154 * 2 * (100.000 * 4 + 10.000 * 26)
-or
- Gr\"{o}{\ss}e = 308 * (400.000 + 260.000)
-or
- Gr\"{o}{\ss}e = 203.280.000 Bytes
-\end{alltt}
-\normalsize
-
-f\"{u}r die beiden oben angenommen Computer k\"{o}nnen wir also davon ausgehen, dass die Datenbank
-in etwa 200 Megabytes gro{\ss} wird. Nat\"{u}rlich h\"{a}ngt dieser Wert davon ab, wieviele
-Dateien wirklich gesichert werden.
-
-Unten sehen Sie ein paar Statistiken f\"{u}r eine MySQL-Datenbank die
-Job-Eintr\"{a}ge f\"{u}r 5 Clients \"{u}ber 8.5 Monate und
-Datei-Eintr\"{a}ge \"{u}ber 80 Tage enth\"{a}lt (\"{a}ltere
-Datei-Eintr\"{a}ge wurden schon gel\"{o}scht). Bei diesen 5 Clients wurden
-nur die Benutzer- und System-Dateien gesichert, die sich st\"{a}ndig
-\"{a}ndern. Bei allen anderen Dateien wird angenommen, dass sie leicht aus
-den Software-Paketen des Betriebssystems wiederherstellbar sind.
-
-In der Liste sind die Dateien (die den MySQL-Tabellen entsprechen) mit der Endung .MYD
-die, die die eigentlichen Daten enthalten und die mit der Endung .MYI enthalten die Indexe.
-
-Sie werden bemerken, dass die meisten Eintr\"{a}ge in der Datei File.MYD
-(die die Datei-Attribute enth\"{a}lt) enthalten sind und diese auch den
-meisten Platz auf der Festplatte belegt. Die {\bf File Retention} (der Aufbewahrungszeitraum
-f\"{u}r Dateien) ist also im wesentlichen daf\"{u}r verantwortlich, wie gro{\ss} die Datenbank wird.
-Eine kurze Berechnung zeigt, dass die Datenbank mit jeder gesicherten Datei ungef\"{a}hr um
-154 Bytes w\"{a}chst.
-
-\footnotesize
-\begin{alltt}
-Gr\"{o}{\ss}e
- in Bytes Eintr\"{a}ge Dateiname
- ============ ========= ===========
- 168 5 Client.MYD
- 3,072 Client.MYI
- 344,394,684 3,080,191 File.MYD
- 115,280,896 File.MYI
- 2,590,316 106,902 Filename.MYD
- 3,026,944 Filename.MYI
- 184 4 FileSet.MYD
- 2,048 FileSet.MYI
- 49,062 1,326 JobMedia.MYD
- 30,720 JobMedia.MYI
- 141,752 1,378 Job.MYD
- 13,312 Job.MYI
- 1,004 11 Media.MYD
- 3,072 Media.MYI
- 1,299,512 22,233 Path.MYD
- 581,632 Path.MYI
- 36 1 Pool.MYD
- 3,072 Pool.MYI
- 5 1 Version.MYD
- 1,024 Version.MYI
-\end{alltt}
-\normalsize
-
-Die Datenbank hat eine Gr\"{o}{\ss}e von ca. 450 Megabytes..
-
-H\"{a}tten wir SQLite genommen, w\"{a}re die Bestimmung der Datenbankgr\"{o}{\ss}e
-viel einfacher gewesen, da SQLite alle Daten in einer einzigen Datei speichert,
-dann aber h\"{a}tten wir nicht so einfach erkennen k\"{o}nnen, welche der Tabellen
-den meisten Speicherplatz ben\"{o}tigt.
-
-SQLite Datenbanken k\"{o}nnen bis zu 50 \% gr\"{o}{\ss}er sein als MySQL-Datenbanken
-(bei gleichem Datenbestand), weil bei SQLite alle Daten als ASCII-Zeichenketten gespeichert werden.
-Sogar bin\"{a}re Daten werden als ASCII-Zeichenkette dargestellt, und das scheint den Speicherverbrauch
-zu erh\"{o}hen.
+++ /dev/null
-#!/usr/bin/perl -w
-# Finds potential problems in tex files, and issues warnings to the console
-# about what it finds. Takes a list of files as its only arguments,
-# and does checks on all the files listed. The assumption is that these are
-# valid (or close to valid) LaTeX files. It follows \include statements
-# recursively to pick up any included tex files.
-#
-#
-#
-# Currently the following checks are made:
-#
-# -- Multiple hyphens not inside a verbatim environment (or \verb). These
-# should be placed inside a \verb{} contruct so they will not be converted
-# to single hyphen by latex and latex2html.
-
-
-# Original creation 3-8-05 by Karl Cunningham karlc -at- keckec -dot- com
-#
-#
-
-use strict;
-
-# The following builds the test string to identify and change multiple
-# hyphens in the tex files. Several constructs are identified but only
-# multiple hyphens are changed; the others are fed to the output
-# unchanged.
-my $b = '\\\\begin\\*?\\s*\\{\\s*'; # \begin{
-my $e = '\\\\end\\*?\\s*\\{\\s*'; # \end{
-my $c = '\\s*\\}'; # closing curly brace
-
-# This captures entire verbatim environments. These are passed to the output
-# file unchanged.
-my $verbatimenv = $b . "verbatim" . $c . ".*?" . $e . "verbatim" . $c;
-
-# This captures \verb{..{ constructs. They are passed to the output unchanged.
-my $verb = '\\\\verb\\*?(.).*?\\1';
-
-# This captures multiple hyphens with a leading and trailing space. These are not changed.
-my $hyphsp = '\\s\\-{2,}\\s';
-
-# This identifies other multiple hyphens.
-my $hyphens = '\\-{2,}';
-
-# This identifies \hyperpage{..} commands, which should be ignored.
-my $hyperpage = '\\\\hyperpage\\*?\\{.*?\\}';
-
-# This builds the actual test string from the above strings.
-#my $teststr = "$verbatimenv|$verb|$tocentry|$hyphens";
-my $teststr = "$verbatimenv|$verb|$hyphsp|$hyperpage|$hyphens";
-
-
-sub get_includes {
- # Get a list of include files from the top-level tex file. The first
- # argument is a pointer to the list of files found. The rest of the
- # arguments is a list of filenames to check for includes.
- my $files = shift;
- my ($fileline,$includefile,$includes);
-
- while (my $filename = shift) {
- # Get a list of all the html files in the directory.
- open my $if,"<$filename" or die "Cannot open input file $filename\n";
- $fileline = 0;
- $includes = 0;
- while (<$if>) {
- chomp;
- $fileline++;
- # If a file is found in an include, process it.
- if (($includefile) = /\\include\s*\{(.*?)\}/) {
- $includes++;
- # Append .tex to the filename
- $includefile .= '.tex';
-
- # If the include file has already been processed, issue a warning
- # and don't do it again.
- my $found = 0;
- foreach (@$files) {
- if ($_ eq $includefile) {
- $found = 1;
- last;
- }
- }
- if ($found) {
- print "$includefile found at line $fileline in $filename was previously included\n";
- } else {
- # The file has not been previously found. Save it and
- # recursively process it.
- push (@$files,$includefile);
- get_includes($files,$includefile);
- }
- }
- }
- close IF;
- }
-}
-
-
-sub check_hyphens {
- my (@files) = @_;
- my ($filedata,$this,$linecnt,$before);
-
- # Build the test string to check for the various environments.
- # We only do the conversion if the multiple hyphens are outside of a
- # verbatim environment (either \begin{verbatim}...\end{verbatim} or
- # \verb{--}). Capture those environments and pass them to the output
- # unchanged.
-
- foreach my $file (@files) {
- # Open the file and load the whole thing into $filedata. A bit wasteful but
- # easier to deal with, and we don't have a problem with speed here.
- $filedata = "";
- open IF,"<$file" or die "Cannot open input file $file";
- while (<IF>) {
- $filedata .= $_;
- }
- close IF;
-
- # Set up to process the file data.
- $linecnt = 1;
-
- # Go through the file data from beginning to end. For each match, save what
- # came before it and what matched. $filedata now becomes only what came
- # after the match.
- # Chech the match to see if it starts with a multiple-hyphen. If so
- # warn the user. Keep track of line numbers so they can be output
- # with the warning message.
- while ($filedata =~ /$teststr/os) {
- $this = $&;
- $before = $`;
- $filedata = $';
- $linecnt += $before =~ tr/\n/\n/;
-
- # Check if the multiple hyphen is present outside of one of the
- # acceptable constructs.
- if ($this =~ /^\-+/) {
- print "Possible unwanted multiple hyphen found in line ",
- "$linecnt of file $file\n";
- }
- $linecnt += $this =~ tr/\n/\n/;
- }
- }
-}
-##################################################################
-# MAIN ####
-##################################################################
-
-my (@includes,$cnt);
-
-# Examine the file pointed to by the first argument to get a list of
-# includes to test.
-get_includes(\@includes,@ARGV);
-
-check_hyphens(@includes);
+++ /dev/null
-#
-# Avoid that @VERSION@ and @DATE@ are changed by configure
-# This file is sourced by update_version
-#
-echo "s%@VERSION@%${VERSION}%g" >${out}
-echo "s%@DATE@%${DATE}%g" >>${out}
+++ /dev/null
-% TODO: maybe get rid of centering
-
-\chapter{GNU Free Documentation License}
-\index[general]{GNU Free Documentation License}
-\index[general]{License!GNU Free Documentation}
-
-\label{label_fdl}
-
- \begin{center}
-
- Version 1.2, November 2002
-
-
- Copyright \copyright 2000,2001,2002 Free Software Foundation, Inc.
-
- \bigskip
-
- 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-
- \bigskip
-
- Everyone is permitted to copy and distribute verbatim copies
- of this license document, but changing it is not allowed.
-\end{center}
-
-
-\begin{center}
-{\bf\large Preamble}
-\end{center}
-
-The purpose of this License is to make a manual, textbook, or other
-functional and useful document "free" in the sense of freedom: to
-assure everyone the effective freedom to copy and redistribute it,
-with or without modifying it, either commercially or noncommercially.
-Secondarily, this License preserves for the author and publisher a way
-to get credit for their work, while not being considered responsible
-for modifications made by others.
-
-This License is a kind of "`copyleft"', which means that derivative
-works of the document must themselves be free in the same sense. It
-complements the GNU General Public License, which is a copyleft
-license designed for free software.
-
-We have designed this License in order to use it for manuals for free
-software, because free software needs free documentation: a free
-program should come with manuals providing the same freedoms that the
-software does. But this License is not limited to software manuals;
-it can be used for any textual work, regardless of subject matter or
-whether it is published as a printed book. We recommend this License
-principally for works whose purpose is instruction or reference.
-
-
-\begin{center}
-{\Large\bf 1. APPLICABILITY AND DEFINITIONS}
-\end{center}
-
-This License applies to any manual or other work, in any medium, that
-contains a notice placed by the copyright holder saying it can be
-distributed under the terms of this License. Such a notice grants a
-world-wide, royalty-free license, unlimited in duration, to use that
-work under the conditions stated herein. The \textbf{"`Document"'}, below,
-refers to any such manual or work. Any member of the public is a
-licensee, and is addressed as \textbf{"`you"'}. You accept the license if you
-copy, modify or distribute the work in a way requiring permission
-under copyright law.
-
-A \textbf{"`Modified Version"'} of the Document means any work containing the
-Document or a portion of it, either copied verbatim, or with
-modifications and/or translated into another language.
-
-A \textbf{"`Secondary Section"'} is a named appendix or a front-matter section of
-the Document that deals exclusively with the relationship of the
-publishers or authors of the Document to the Document's overall subject
-(or to related matters) and contains nothing that could fall directly
-within that overall subject. (Thus, if the Document is in part a
-textbook of mathematics, a Secondary Section may not explain any
-mathematics.) The relationship could be a matter of historical
-connection with the subject or with related matters, or of legal,
-commercial, philosophical, ethical or political position regarding
-them.
-
-The \textbf{"`Invariant Sections"'} are certain Secondary Sections whose titles
-are designated, as being those of Invariant Sections, in the notice
-that says that the Document is released under this License. If a
-section does not fit the above definition of Secondary then it is not
-allowed to be designated as Invariant. The Document may contain zero
-Invariant Sections. If the Document does not identify any Invariant
-Sections then there are none.
-
-The \textbf{"`Cover Texts"'} are certain short passages of text that are listed,
-as Front-Cover Texts or Back-Cover Texts, in the notice that says that
-the Document is released under this License. A Front-Cover Text may
-be at most 5 words, and a Back-Cover Text may be at most 25 words.
-
-A \textbf{"`Transparent"'} copy of the Document means a machine-readable copy,
-represented in a format whose specification is available to the
-general public, that is suitable for revising the document
-straightforwardly with generic text editors or (for images composed of
-pixels) generic paint programs or (for drawings) some widely available
-drawing editor, and that is suitable for input to text formatters or
-for automatic translation to a variety of formats suitable for input
-to text formatters. A copy made in an otherwise Transparent file
-format whose markup, or absence of markup, has been arranged to thwart
-or discourage subsequent modification by readers is not Transparent.
-An image format is not Transparent if used for any substantial amount
-of text. A copy that is not "`Transparent"' is called \textbf{"`Opaque"'}.
-
-Examples of suitable formats for Transparent copies include plain
-ASCII without markup, Texinfo input format, LaTeX input format, SGML
-or XML using a publicly available DTD, and standard-conforming simple
-HTML, PostScript or PDF designed for human modification. Examples of
-transparent image formats include PNG, XCF and JPG. Opaque formats
-include proprietary formats that can be read and edited only by
-proprietary word processors, SGML or XML for which the DTD and/or
-processing tools are not generally available, and the
-machine-generated HTML, PostScript or PDF produced by some word
-processors for output purposes only.
-
-The \textbf{"`Title Page"'} means, for a printed book, the title page itself,
-plus such following pages as are needed to hold, legibly, the material
-this License requires to appear in the title page. For works in
-formats which do not have any title page as such, "`Title Page"' means
-the text near the most prominent appearance of the work's title,
-preceding the beginning of the body of the text.
-
-A section \textbf{"`Entitled XYZ"'} means a named subunit of the Document whose
-title either is precisely XYZ or contains XYZ in parentheses following
-text that translates XYZ in another language. (Here XYZ stands for a
-specific section name mentioned below, such as \textbf{"`Acknowledgements"'},
-\textbf{"`Dedications"'}, \textbf{"`Endorsements"'}, or \textbf{"`History"'}.)
-To \textbf{"`Preserve the Title"'}
-of such a section when you modify the Document means that it remains a
-section "`Entitled XYZ"' according to this definition.
-
-The Document may include Warranty Disclaimers next to the notice which
-states that this License applies to the Document. These Warranty
-Disclaimers are considered to be included by reference in this
-License, but only as regards disclaiming warranties: any other
-implication that these Warranty Disclaimers may have is void and has
-no effect on the meaning of this License.
-
-
-\begin{center}
-{\Large\bf 2. VERBATIM COPYING}
-\end{center}
-
-You may copy and distribute the Document in any medium, either
-commercially or noncommercially, provided that this License, the
-copyright notices, and the license notice saying this License applies
-to the Document are reproduced in all copies, and that you add no other
-conditions whatsoever to those of this License. You may not use
-technical measures to obstruct or control the reading or further
-copying of the copies you make or distribute. However, you may accept
-compensation in exchange for copies. If you distribute a large enough
-number of copies you must also follow the conditions in section 3.
-
-You may also lend copies, under the same conditions stated above, and
-you may publicly display copies.
-
-
-\begin{center}
-{\Large\bf 3. COPYING IN QUANTITY}
-\end{center}
-
-
-If you publish printed copies (or copies in media that commonly have
-printed covers) of the Document, numbering more than 100, and the
-Document's license notice requires Cover Texts, you must enclose the
-copies in covers that carry, clearly and legibly, all these Cover
-Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
-the back cover. Both covers must also clearly and legibly identify
-you as the publisher of these copies. The front cover must present
-the full title with all words of the title equally prominent and
-visible. You may add other material on the covers in addition.
-Copying with changes limited to the covers, as long as they preserve
-the title of the Document and satisfy these conditions, can be treated
-as verbatim copying in other respects.
-
-If the required texts for either cover are too voluminous to fit
-legibly, you should put the first ones listed (as many as fit
-reasonably) on the actual cover, and continue the rest onto adjacent
-pages.
-
-If you publish or distribute Opaque copies of the Document numbering
-more than 100, you must either include a machine-readable Transparent
-copy along with each Opaque copy, or state in or with each Opaque copy
-a computer-network location from which the general network-using
-public has access to download using public-standard network protocols
-a complete Transparent copy of the Document, free of added material.
-If you use the latter option, you must take reasonably prudent steps,
-when you begin distribution of Opaque copies in quantity, to ensure
-that this Transparent copy will remain thus accessible at the stated
-location until at least one year after the last time you distribute an
-Opaque copy (directly or through your agents or retailers) of that
-edition to the public.
-
-It is requested, but not required, that you contact the authors of the
-Document well before redistributing any large number of copies, to give
-them a chance to provide you with an updated version of the Document.
-
-
-\begin{center}
-{\Large\bf 4. MODIFICATIONS}
-\end{center}
-
-You may copy and distribute a Modified Version of the Document under
-the conditions of sections 2 and 3 above, provided that you release
-the Modified Version under precisely this License, with the Modified
-Version filling the role of the Document, thus licensing distribution
-and modification of the Modified Version to whoever possesses a copy
-of it. In addition, you must do these things in the Modified Version:
-
-\begin{itemize}
-\item[A.]
- Use in the Title Page (and on the covers, if any) a title distinct
- from that of the Document, and from those of previous versions
- (which should, if there were any, be listed in the History section
- of the Document). You may use the same title as a previous version
- if the original publisher of that version gives permission.
-
-\item[B.]
- List on the Title Page, as authors, one or more persons or entities
- responsible for authorship of the modifications in the Modified
- Version, together with at least five of the principal authors of the
- Document (all of its principal authors, if it has fewer than five),
- unless they release you from this requirement.
-
-\item[C.]
- State on the Title page the name of the publisher of the
- Modified Version, as the publisher.
-
-\item[D.]
- Preserve all the copyright notices of the Document.
-
-\item[E.]
- Add an appropriate copyright notice for your modifications
- adjacent to the other copyright notices.
-
-\item[F.]
- Include, immediately after the copyright notices, a license notice
- giving the public permission to use the Modified Version under the
- terms of this License, in the form shown in the Addendum below.
-
-\item[G.]
- Preserve in that license notice the full lists of Invariant Sections
- and required Cover Texts given in the Document's license notice.
-
-\item[H.]
- Include an unaltered copy of this License.
-
-\item[I.]
- Preserve the section Entitled "`History"', Preserve its Title, and add
- to it an item stating at least the title, year, new authors, and
- publisher of the Modified Version as given on the Title Page. If
- there is no section Entitled "`History"' in the Document, create one
- stating the title, year, authors, and publisher of the Document as
- given on its Title Page, then add an item describing the Modified
- Version as stated in the previous sentence.
-
-\item[J.]
- Preserve the network location, if any, given in the Document for
- public access to a Transparent copy of the Document, and likewise
- the network locations given in the Document for previous versions
- it was based on. These may be placed in the "`History"' section.
- You may omit a network location for a work that was published at
- least four years before the Document itself, or if the original
- publisher of the version it refers to gives permission.
-
-\item[K.]
- For any section Entitled "`Acknowledgements"' or "`Dedications"',
- Preserve the Title of the section, and preserve in the section all
- the substance and tone of each of the contributor acknowledgements
- and/or dedications given therein.
-
-\item[L.]
- Preserve all the Invariant Sections of the Document,
- unaltered in their text and in their titles. Section numbers
- or the equivalent are not considered part of the section titles.
-
-\item[M.]
- Delete any section Entitled "`Endorsements"'. Such a section
- may not be included in the Modified Version.
-
-\item[N.]
- Do not retitle any existing section to be Entitled "`Endorsements"'
- or to conflict in title with any Invariant Section.
-
-\item[O.]
- Preserve any Warranty Disclaimers.
-\end{itemize}
-
-If the Modified Version includes new front-matter sections or
-appendices that qualify as Secondary Sections and contain no material
-copied from the Document, you may at your option designate some or all
-of these sections as invariant. To do this, add their titles to the
-list of Invariant Sections in the Modified Version's license notice.
-These titles must be distinct from any other section titles.
-
-You may add a section Entitled "`Endorsements"', provided it contains
-nothing but endorsements of your Modified Version by various
-parties--for example, statements of peer review or that the text has
-been approved by an organization as the authoritative definition of a
-standard.
-
-You may add a passage of up to five words as a Front-Cover Text, and a
-passage of up to 25 words as a Back-Cover Text, to the end of the list
-of Cover Texts in the Modified Version. Only one passage of
-Front-Cover Text and one of Back-Cover Text may be added by (or
-through arrangements made by) any one entity. If the Document already
-includes a cover text for the same cover, previously added by you or
-by arrangement made by the same entity you are acting on behalf of,
-you may not add another; but you may replace the old one, on explicit
-permission from the previous publisher that added the old one.
-
-The author(s) and publisher(s) of the Document do not by this License
-give permission to use their names for publicity for or to assert or
-imply endorsement of any Modified Version.
-
-
-\begin{center}
-{\Large\bf 5. COMBINING DOCUMENTS}
-\end{center}
-
-
-You may combine the Document with other documents released under this
-License, under the terms defined in section 4 above for modified
-versions, provided that you include in the combination all of the
-Invariant Sections of all of the original documents, unmodified, and
-list them all as Invariant Sections of your combined work in its
-license notice, and that you preserve all their Warranty Disclaimers.
-
-The combined work need only contain one copy of this License, and
-multiple identical Invariant Sections may be replaced with a single
-copy. If there are multiple Invariant Sections with the same name but
-different contents, make the title of each such section unique by
-adding at the end of it, in parentheses, the name of the original
-author or publisher of that section if known, or else a unique number.
-Make the same adjustment to the section titles in the list of
-Invariant Sections in the license notice of the combined work.
-
-In the combination, you must combine any sections Entitled "`History"'
-in the various original documents, forming one section Entitled
-"`History"'; likewise combine any sections Entitled "`Acknowledgements"',
-and any sections Entitled "`Dedications"'. You must delete all sections
-Entitled "`Endorsements"'.
-
-\begin{center}
-{\Large\bf 6. COLLECTIONS OF DOCUMENTS}
-\end{center}
-
-You may make a collection consisting of the Document and other documents
-released under this License, and replace the individual copies of this
-License in the various documents with a single copy that is included in
-the collection, provided that you follow the rules of this License for
-verbatim copying of each of the documents in all other respects.
-
-You may extract a single document from such a collection, and distribute
-it individually under this License, provided you insert a copy of this
-License into the extracted document, and follow this License in all
-other respects regarding verbatim copying of that document.
-
-
-\begin{center}
-{\Large\bf 7. AGGREGATION WITH INDEPENDENT WORKS}
-\end{center}
-
-
-A compilation of the Document or its derivatives with other separate
-and independent documents or works, in or on a volume of a storage or
-distribution medium, is called an "`aggregate"' if the copyright
-resulting from the compilation is not used to limit the legal rights
-of the compilation's users beyond what the individual works permit.
-When the Document is included in an aggregate, this License does not
-apply to the other works in the aggregate which are not themselves
-derivative works of the Document.
-
-If the Cover Text requirement of section 3 is applicable to these
-copies of the Document, then if the Document is less than one half of
-the entire aggregate, the Document's Cover Texts may be placed on
-covers that bracket the Document within the aggregate, or the
-electronic equivalent of covers if the Document is in electronic form.
-Otherwise they must appear on printed covers that bracket the whole
-aggregate.
-
-
-\begin{center}
-{\Large\bf 8. TRANSLATION}
-\end{center}
-
-
-Translation is considered a kind of modification, so you may
-distribute translations of the Document under the terms of section 4.
-Replacing Invariant Sections with translations requires special
-permission from their copyright holders, but you may include
-translations of some or all Invariant Sections in addition to the
-original versions of these Invariant Sections. You may include a
-translation of this License, and all the license notices in the
-Document, and any Warranty Disclaimers, provided that you also include
-the original English version of this License and the original versions
-of those notices and disclaimers. In case of a disagreement between
-the translation and the original version of this License or a notice
-or disclaimer, the original version will prevail.
-
-If a section in the Document is Entitled "`Acknowledgements"',
-"`Dedications"', or "`History"', the requirement (section 4) to Preserve
-its Title (section 1) will typically require changing the actual
-title.
-
-
-\begin{center}
-{\Large\bf 9. TERMINATION}
-\end{center}
-
-
-You may not copy, modify, sublicense, or distribute the Document except
-as expressly provided for under this License. Any other attempt to
-copy, modify, sublicense or distribute the Document is void, and will
-automatically terminate your rights under this License. However,
-parties who have received copies, or rights, from you under this
-License will not have their licenses terminated so long as such
-parties remain in full compliance.
-
-
-\begin{center}
-{\Large\bf 10. FUTURE REVISIONS OF THIS LICENSE}
-\end{center}
-
-
-The Free Software Foundation may publish new, revised versions
-of the GNU Free Documentation License from time to time. Such new
-versions will be similar in spirit to the present version, but may
-differ in detail to address new problems or concerns. See
-http://www.gnu.org/copyleft/.
-
-Each version of the License is given a distinguishing version number.
-If the Document specifies that a particular numbered version of this
-License "`or any later version"' applies to it, you have the option of
-following the terms and conditions either of that specified version or
-of any later version that has been published (not as a draft) by the
-Free Software Foundation. If the Document does not specify a version
-number of this License, you may choose any version ever published (not
-as a draft) by the Free Software Foundation.
-
-
-\begin{center}
-{\Large\bf ADDENDUM: How to use this License for your documents}
-% TODO: this is too long for table of contents
-\end{center}
-
-To use this License in a document you have written, include a copy of
-the License in the document and put the following copyright and
-license notices just after the title page:
-
-\bigskip
-\begin{quote}
- Copyright \copyright YEAR YOUR NAME.
- Permission is granted to copy, distribute and/or modify this document
- under the terms of the GNU Free Documentation License, Version 1.2
- or any later version published by the Free Software Foundation;
- with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
- A copy of the license is included in the section entitled "`GNU
- Free Documentation License"'.
-\end{quote}
-\bigskip
-
-If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts,
-replace the "`with...Texts."' line with this:
-
-\bigskip
-\begin{quote}
- with the Invariant Sections being LIST THEIR TITLES, with the
- Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST.
-\end{quote}
-\bigskip
-
-If you have Invariant Sections without Cover Texts, or some other
-combination of the three, merge those two alternatives to suit the
-situation.
-
-If your document contains nontrivial examples of program code, we
-recommend releasing these examples in parallel under your choice of
-free software license, such as the GNU General Public License,
-to permit their use in free software.
-
-%---------------------------------------------------------------------
+++ /dev/null
-#!/usr/bin/perl -w
-# Fixes various things within tex files.
-
-use strict;
-
-my %args;
-
-
-sub get_includes {
- # Get a list of include files from the top-level tex file.
- my (@list,$file);
-
- foreach my $filename (@_) {
- $filename or next;
- # Start with the top-level latex file so it gets checked too.
- push (@list,$filename);
-
- # Get a list of all the html files in the directory.
- open IF,"<$filename" or die "Cannot open input file $filename";
- while (<IF>) {
- chomp;
- push @list,"$1.tex" if (/\\include\{(.*?)\}/);
- }
-
- close IF;
- }
- return @list;
-}
-
-sub convert_files {
- my (@files) = @_;
- my ($linecnt,$filedata,$output,$itemcnt,$indentcnt,$cnt);
-
- $cnt = 0;
- foreach my $file (@files) {
- # Open the file and load the whole thing into $filedata. A bit wasteful but
- # easier to deal with, and we don't have a problem with speed here.
- $filedata = "";
- open IF,"<$file" or die "Cannot open input file $file";
- while (<IF>) {
- $filedata .= $_;
- }
- close IF;
-
- # We look for a line that starts with \item, and indent the two next lines (if not blank)
- # by three spaces.
- my $linecnt = 3;
- $indentcnt = 0;
- $output = "";
- # Process a line at a time.
- foreach (split(/\n/,$filedata)) {
- $_ .= "\n"; # Put back the return.
- # If this line is less than the third line past the \item command,
- # and the line isn't blank and doesn't start with whitespace
- # add three spaces to the start of the line. Keep track of the number
- # of lines changed.
- if ($linecnt < 3 and !/^\\item/) {
- if (/^[^\n\s]/) {
- $output .= " " . $_;
- $indentcnt++;
- } else {
- $output .= $_;
- }
- $linecnt++;
- } else {
- $linecnt = 3;
- $output .= $_;
- }
- /^\\item / and $linecnt = 1;
- }
-
-
- # This is an item line. We need to process it too. If inside a \begin{description} environment, convert
- # \item {\bf xxx} to \item [xxx] or \item [{xxx}] (if xxx contains '[' or ']'.
- $itemcnt = 0;
- $filedata = $output;
- $output = "";
- my ($before,$descrip,$this,$between);
-
- # Find any \begin{description} environment
- while ($filedata =~ /(\\begin[\s\n]*\{[\s\n]*description[\s\n]*\})(.*?)(\\end[\s\n]*\{[\s\n]*description[\s\n]*\})/s) {
- $output .= $` . $1;
- $filedata = $3 . $';
- $descrip = $2;
-
- # Search for \item {\bf xxx}
- while ($descrip =~ /\\item[\s\n]*\{[\s\n]*\\bf[\s\n]*/s) {
- $descrip = $';
- $output .= $`;
- ($between,$descrip) = find_matching_brace($descrip);
- if (!$descrip) {
- $linecnt = $output =~ tr/\n/\n/;
- print STDERR "Missing matching curly brace at line $linecnt in $file\n" if (!$descrip);
- }
-
- # Now do the replacement.
- $between = '{' . $between . '}' if ($between =~ /\[|\]/);
- $output .= "\\item \[$between\]";
- $itemcnt++;
- }
- $output .= $descrip;
- }
- $output .= $filedata;
-
- # If any hyphens or \item commnads were converted, save the file.
- if ($indentcnt or $itemcnt) {
- open OF,">$file" or die "Cannot open output file $file";
- print OF $output;
- close OF;
- print "$indentcnt indent", ($indentcnt == 1) ? "" : "s"," added in $file\n";
- print "$itemcnt item", ($itemcnt == 1) ? "" : "s"," Changed in $file\n";
- }
-
- $cnt += $indentcnt + $itemcnt;
- }
- return $cnt;
-}
-
-sub find_matching_brace {
- # Finds text up to the next matching brace. Assumes that the input text doesn't contain
- # the opening brace, but we want to find text up to a matching closing one.
- # Returns the text between the matching braces, followed by the rest of the text following
- # (which does not include the matching brace).
- #
- my $str = shift;
- my ($this,$temp);
- my $cnt = 1;
-
- while ($cnt) {
- # Ignore verbatim constructs involving curly braces, or if the character preceding
- # the curly brace is a backslash.
- if ($str =~ /\\verb\*?\{.*?\{|\\verb\*?\}.*?\}|\{|\}/s) {
- $this .= $`;
- $str = $';
- $temp = $&;
-
- if ((substr($this,-1,1) eq '\\') or
- $temp =~ /^\\verb/) {
- $this .= $temp;
- next;
- }
-
- $cnt += ($temp eq '{') ? 1 : -1;
- # If this isn't the matching curly brace ($cnt > 0), include the brace.
- $this .= $temp if ($cnt);
- } else {
- # No matching curly brace found.
- return ($this . $str,'');
- }
- }
- return ($this,$str);
-}
-
-sub check_arguments {
- # Checks command-line arguments for ones starting with -- puts them into
- # a hash called %args and removes them from @ARGV.
- my $args = shift;
- my $i;
-
- for ($i = 0; $i < $#ARGV; $i++) {
- $ARGV[$i] =~ /^\-+/ or next;
- $ARGV[$i] =~ s/^\-+//;
- $args{$ARGV[$i]} = "";
- delete ($ARGV[$i]);
-
- }
-}
-
-##################################################################
-# MAIN ####
-##################################################################
-
-my @includes;
-my $cnt;
-
-check_arguments(\%args);
-die "No Files given to Check\n" if ($#ARGV < 0);
-
-# Examine the file pointed to by the first argument to get a list of
-# includes to test.
-@includes = get_includes(@ARGV);
-
-$cnt = convert_files(@includes);
-print "No lines changed\n" unless $cnt;
+++ /dev/null
-# This module does multiple indices, supporting the style of the LaTex 'index'
-# package.
-
-# Version Information:
-# 16-Feb-2005 -- Original Creation. Karl E. Cunningham
-# 14-Mar-2005 -- Clarified and Consolodated some of the code.
-# Changed to smoothly handle single and multiple indices.
-
-# Two LaTeX index formats are supported...
-# --- SINGLE INDEX ---
-# \usepackage{makeidx}
-# \makeindex
-# \index{entry1}
-# \index{entry2}
-# \index{entry3}
-# ...
-# \printindex
-#
-# --- MULTIPLE INDICES ---
-#
-# \usepackage{makeidx}
-# \usepackage{index}
-# \makeindex -- latex2html doesn't care but LaTeX does.
-# \newindex{ref1}{ext1}{ext2}{title1}
-# \newindex{ref2}{ext1}{ext2}{title2}
-# \newindex{ref3}{ext1}{ext2}{title3}
-# \index[ref1]{entry1}
-# \index[ref1]{entry2}
-# \index[ref3]{entry3}
-# \index[ref2]{entry4}
-# \index{entry5}
-# \index[ref3]{entry6}
-# ...
-# \printindex[ref1]
-# \printindex[ref2]
-# \printindex[ref3]
-# \printindex
-# ___________________
-#
-# For the multiple-index style, each index is identified by the ref argument to \newindex, \index,
-# and \printindex. A default index is allowed, which is indicated by omitting the optional
-# argument. The default index does not require a \newindex command. As \index commands
-# are encountered, their entries are stored according
-# to the ref argument. When the \printindex command is encountered, the stored index
-# entries for that argument are retrieved and printed. The title for each index is taken
-# from the last argument in the \newindex command.
-# While processing \index and \printindex commands, if no argument is given the index entries
-# are built into a default index. The title of the default index is simply "Index".
-# This makes the difference between single- and multiple-index processing trivial.
-#
-# Another method can be used by omitting the \printindex command and just using \include to
-# pull in index files created by the makeindex program. These files will start with
-# \begin{theindex}. This command is used to determine where to print the index. Using this
-# approach, the indices will be output in the same order as the newindex commands were
-# originally found (see below). Using a combination of \printindex and \include{indexfile} has not
-# been tested and may produce undesireable results.
-#
-# The index data are stored in a hash for later sorting and output. As \printindex
-# commands are handled, the order in which they were found in the tex filea is saved,
-# associated with the ref argument to \printindex.
-#
-# We use the original %index hash to store the index data into. We append a \002 followed by the
-# name of the index to isolate the entries in different indices from each other. This is necessary
-# so that different indices can have entries with the same name. For the default index, the \002 is
-# appended without the name.
-#
-# Since the index order in the output cannot be determined if the \include{indexfile}
-# command is used, the order will be assumed from the order in which the \newindex
-# commands were originally seen in the TeX files. This order is saved as well as the
-# order determined from any printindex{ref} commands. If \printindex commnads are used
-# to specify the index output, that order will be used. If the \include{idxfile} command
-# is used, the order of the original newindex commands will be used. In this case the
-# default index will be printed last since it doesn't have a corresponding \newindex
-# command and its order cannot be determined. Mixing \printindex and \include{idxfile}
-# commands in the same file is likely to produce less than satisfactory results.
-#
-#
-# The hash containing index data is named %indices. It contains the following data:
-#{
-# 'title' => {
-# $ref1 => $indextitle ,
-# $ref2 => $indextitle ,
-# ...
-# },
-# 'newcmdorder' => [ ref1, ref2, ..., * ], # asterisk indicates the position of the default index.
-# 'printindorder' => [ ref1, ref2, ..., * ], # asterisk indicates the position of the default index.
-#}
-
-
-# Globals to handle multiple indices.
-my %indices;
-
-# This tells the system to use up to 7 words in index entries.
-$WORDS_IN_INDEX = 10;
-
-# KEC 2-18-05
-# Handles the \newindex command. This is called if the \newindex command is
-# encountered in the LaTex source. Gets the index ref and title from the arguments.
-# Saves the index ref and title.
-# Note that we are called once to handle multiple \newindex commands that are
-# newline-separated.
-sub do_cmd_newindex {
- my $data = shift;
- # The data is sent to us as fields delimited by their ID #'s. We extract the
- # fields.
- foreach my $line (split("\n",$data)) {
- my @fields = split (/(?:\<\#\d+?\#\>)+/,$line);
-
- # The index name and title are the second and fourth fields in the data.
- if ($line =~ /^</ or $line =~ /^\\newindex/) {
- my ($indexref,$indextitle) = ($fields[1],$fields[4]);
- $indices{'title'}{$indexref} = $indextitle;
- push (@{$indices{'newcmdorder'}},$indexref);
- }
- }
-}
-
-
-# KEC -- Copied from makeidx.perl and modified to do multiple indices.
-# Processes an \index entry from the LaTex file.
-# Gets the optional argument from the index command, which is the name of the index
-# into which to place the entry.
-# Drops the brackets from the index_name
-# Puts the index entry into the html stream
-# Creates the tokenized index entry (which also saves the index entry info
-sub do_real_index {
- local($_) = @_;
- local($pat,$idx_entry,$index_name);
- # catches opt-arg from \index commands for index.sty
- $index_name = &get_next_optional_argument;
- $index_name = "" unless defined $index_name;
- # Drop leading and trailing brackets from the index name.
- $index_name =~ s/^\[|\]$//g;
-
- $idx_entry = &missing_braces unless (
- (s/$next_pair_pr_rx/$pat=$1;$idx_entry=$2;''/e)
- ||(s/$next_pair_rx/$pat=$1;$idx_entry=$2;''/e));
-
- if ($index_name and defined $idx_entry and
- !defined $indices{'title'}{$index_name}) {
- print STDERR "\nInvalid Index Name: \\index \[$index_name\]\{$idx_entry\}\n";
- }
-
- $idx_entry = &named_index_entry($pat, $idx_entry,$index_name);
- $idx_entry.$_;
-}
-
-# Creates and saves an index entry in the index hashes.
-# Modified to do multiple indices.
-# Creates an index_key that allows index entries to have the same characteristics but be in
-# different indices. This index_key is the regular key with the index name appended.
-# Save the index order for the entry in the %index_order hash.
-sub named_index_entry {
- local($br_id, $str, $index_name) = @_;
- my ($index_key);
- # escape the quoting etc characters
- # ! -> \001
- # @ -> \002
- # | -> \003
- $* = 1; $str =~ s/\n\s*/ /g; $* = 0; # remove any newlines
- # protect \001 occurring with images
- $str =~ s/\001/\016/g; # 0x1 to 0xF
- $str =~ s/\\\\/\011/g; # Double backslash -> 0xB
- $str =~ s/\\;SPMquot;/\012/g; # \;SPMquot; -> 0xC
- $str =~ s/;SPMquot;!/\013/g; # ;SPMquot; -> 0xD
- $str =~ s/!/\001/g; # Exclamation point -> 0x1
- $str =~ s/\013/!/g; # 0xD -> Exclaimation point
- $str =~ s/;SPMquot;@/\015/g; # ;SPMquot;@ to 0xF
- $str =~ s/@/\002/g; # At sign -> 0x2
- $str =~ s/\015/@/g; # 0xF to At sign
- $str =~ s/;SPMquot;\|/\017/g; # ;SMPquot;| to 0x11
- $str =~ s/\|/\003/g; # Vertical line to 0x3
- $str =~ s/\017/|/g; # 0x11 to vertical line
- $str =~ s/;SPMquot;(.)/\1/g; # ;SPMquot; -> whatever the next character is
- $str =~ s/\012/;SPMquot;/g; # 0x12 to ;SPMquot;
- $str =~ s/\011/\\\\/g; # 0x11 to double backslash
- local($key_part, $pageref) = split("\003", $str, 2);
-
- # For any keys of the form: blablabla!blablabla, which want to be split at the
- # exclamation point, replace the ! with a comma and a space. We don't do it
- # that way for this index.
- $key_part =~ s/\001/, /g;
- local(@keys) = split("\001", $key_part);
- # If TITLE is not yet available use $before.
- $TITLE = $saved_title if (($saved_title)&&(!($TITLE)||($TITLE eq $default_title)));
- $TITLE = $before unless $TITLE;
- # Save the reference
- local($words) = '';
- if ($SHOW_SECTION_NUMBERS) { $words = &make_idxnum; }
- elsif ($SHORT_INDEX) { $words = &make_shortidxname; }
- else { $words = &make_idxname; }
- local($super_key) = '';
- local($sort_key, $printable_key, $cur_key);
- foreach $key (@keys) {
- $key =~ s/\016/\001/g; # revert protected \001s
- ($sort_key, $printable_key) = split("\002", $key);
- #
- # RRM: 16 May 1996
- # any \label in the printable-key will have already
- # created a label where the \index occurred.
- # This has to be removed, so that the desired label
- # will be found on the Index page instead.
- #
- if ($printable_key =~ /tex2html_anchor_mark/ ) {
- $printable_key =~ s/><tex2html_anchor_mark><\/A><A//g;
- local($tmpA,$tmpB) = split("NAME=\"", $printable_key);
- ($tmpA,$tmpB) = split("\"", $tmpB);
- $ref_files{$tmpA}='';
- $index_labels{$tmpA} = 1;
- }
- #
- # resolve and clean-up the hyperlink index-entries
- # so they can be saved in an index.pl file
- #
- if ($printable_key =~ /$cross_ref_mark/ ) {
- local($label,$id,$ref_label);
- # $printable_key =~ s/$cross_ref_mark#(\w+)#(\w+)>$cross_ref_mark/
- $printable_key =~ s/$cross_ref_mark#([^#]+)#([^>]+)>$cross_ref_mark/
- do { ($label,$id) = ($1,$2);
- $ref_label = $external_labels{$label} unless
- ($ref_label = $ref_files{$label});
- '"' . "$ref_label#$label" . '">' .
- &get_ref_mark($label,$id)}
- /geo;
- }
- $printable_key =~ s/<\#[^\#>]*\#>//go;
- #RRM
- # recognise \char combinations, for a \backslash
- #
- $printable_key =~ s/\&\#;\'134/\\/g; # restore \\s
- $printable_key =~ s/\&\#;\`<BR> /\\/g; # ditto
- $printable_key =~ s/\&\#;*SPMquot;92/\\/g; # ditto
- #
- # $sort_key .= "@$printable_key" if !($printable_key); # RRM
- $sort_key .= "@$printable_key" if !($sort_key); # RRM
- $sort_key =~ tr/A-Z/a-z/;
- if ($super_key) {
- $cur_key = $super_key . "\001" . $sort_key;
- $sub_index{$super_key} .= $cur_key . "\004";
- } else {
- $cur_key = $sort_key;
- }
-
- # Append the $index_name to the current key with a \002 delimiter. This will
- # allow the same index entry to appear in more than one index.
- $index_key = $cur_key . "\002$index_name";
-
- $index{$index_key} .= "";
-
- #
- # RRM, 15 June 1996
- # if there is no printable key, but one is known from
- # a previous index-entry, then use it.
- #
- if (!($printable_key) && ($printable_key{$index_key}))
- { $printable_key = $printable_key{$index_key}; }
-# if (!($printable_key) && ($printable_key{$cur_key}))
-# { $printable_key = $printable_key{$cur_key}; }
- #
- # do not overwrite the printable_key if it contains an anchor
- #
- if (!($printable_key{$index_key} =~ /tex2html_anchor_mark/ ))
- { $printable_key{$index_key} = $printable_key || $key; }
-# if (!($printable_key{$cur_key} =~ /tex2html_anchor_mark/ ))
-# { $printable_key{$cur_key} = $printable_key || $key; }
-
- $super_key = $cur_key;
- }
- #
- # RRM
- # page-ranges, from |( and |) and |see
- #
- if ($pageref) {
- if ($pageref eq "\(" ) {
- $pageref = '';
- $next .= " from ";
- } elsif ($pageref eq "\)" ) {
- $pageref = '';
- local($next) = $index{$index_key};
-# local($next) = $index{$cur_key};
- # $next =~ s/[\|] *$//;
- $next =~ s/(\n )?\| $//;
- $index{$index_key} = "$next to ";
-# $index{$cur_key} = "$next to ";
- }
- }
-
- if ($pageref) {
- $pageref =~ s/\s*$//g; # remove trailing spaces
- if (!$pageref) { $pageref = ' ' }
- $pageref =~ s/see/<i>see <\/i> /g;
- #
- # RRM: 27 Dec 1996
- # check if $pageref corresponds to a style command.
- # If so, apply it to the $words.
- #
- local($tmp) = "do_cmd_$pageref";
- if (defined &$tmp) {
- $words = &$tmp("<#0#>$words<#0#>");
- $words =~ s/<\#[^\#]*\#>//go;
- $pageref = '';
- }
- }
- #
- # RRM: 25 May 1996
- # any \label in the pageref section will have already
- # created a label where the \index occurred.
- # This has to be removed, so that the desired label
- # will be found on the Index page instead.
- #
- if ($pageref) {
- if ($pageref =~ /tex2html_anchor_mark/ ) {
- $pageref =~ s/><tex2html_anchor_mark><\/A><A//g;
- local($tmpA,$tmpB) = split("NAME=\"", $pageref);
- ($tmpA,$tmpB) = split("\"", $tmpB);
- $ref_files{$tmpA}='';
- $index_labels{$tmpA} = 1;
- }
- #
- # resolve and clean-up any hyperlinks in the page-ref,
- # so they can be saved in an index.pl file
- #
- if ($pageref =~ /$cross_ref_mark/ ) {
- local($label,$id,$ref_label);
- # $pageref =~ s/$cross_ref_mark#(\w+)#(\w+)>$cross_ref_mark/
- $pageref =~ s/$cross_ref_mark#([^#]+)#([^>]+)>$cross_ref_mark/
- do { ($label,$id) = ($1,$2);
- $ref_files{$label} = ''; # ???? RRM
- if ($index_labels{$label}) { $ref_label = ''; }
- else { $ref_label = $external_labels{$label}
- unless ($ref_label = $ref_files{$label});
- }
- '"' . "$ref_label#$label" . '">' . &get_ref_mark($label,$id)}/geo;
- }
- $pageref =~ s/<\#[^\#>]*\#>//go;
-
- if ($pageref eq ' ') { $index{$index_key}='@'; }
- else { $index{$index_key} .= $pageref . "\n | "; }
- } else {
- local($thisref) = &make_named_href('',"$CURRENT_FILE#$br_id",$words);
- $thisref =~ s/\n//g;
- $index{$index_key} .= $thisref."\n | ";
- }
- #print "\nREF: $sort_key : $index_key :$index{$index_key}";
-
- #join('',"<A NAME=$br_id>$anchor_invisible_mark<\/A>",$_);
-
- "<A NAME=\"$br_id\">$anchor_invisible_mark<\/A>";
-}
-
-
-# KEC. -- Copied from makeidx.perl, then modified to do multiple indices.
-# Feeds the index entries to the output. This is called for each index to be built.
-#
-# Generates a list of lookup keys for index entries, from both %printable_keys
-# and %index keys.
-# Sorts the keys according to index-sorting rules.
-# Removes keys with a 0x01 token. (duplicates?)
-# Builds a string to go to the index file.
-# Adds the index entries to the string if they belong in this index.
-# Keeps track of which index is being worked on, so only the proper entries
-# are included.
-# Places the index just built in to the output at the proper place.
-{ my $index_number = 0;
-sub add_real_idx {
- print "\nDoing the index ... Index Number $index_number\n";
- local($key, @keys, $next, $index, $old_key, $old_html);
- my ($idx_ref,$keyref);
- # RRM, 15.6.96: index constructed from %printable_key, not %index
- @keys = keys %printable_key;
-
- while (/$idx_mark/) {
- # Get the index reference from what follows the $idx_mark and
- # remove it from the string.
- s/$idxmark\002(.*?)\002/$idxmark/;
- $idx_ref = $1;
- $index = '';
- # include non- makeidx index-entries
- foreach $key (keys %index) {
- next if $printable_key{$key};
- $old_key = $key;
- if ($key =~ s/###(.*)$//) {
- next if $printable_key{$key};
- push (@keys, $key);
- $printable_key{$key} = $key;
- if ($index{$old_key} =~ /HREF="([^"]*)"/i) {
- $old_html = $1;
- $old_html =~ /$dd?([^#\Q$dd\E]*)#/;
- $old_html = $1;
- } else { $old_html = '' }
- $index{$key} = $index{$old_key} . $old_html."</A>\n | ";
- };
- }
- @keys = sort makeidx_keysort @keys;
- @keys = grep(!/\001/, @keys);
- my $cnt = 0;
- foreach $key (@keys) {
- my ($keyref) = $key =~ /.*\002(.*)/;
- next unless ($idx_ref eq $keyref); # KEC.
- $index .= &add_idx_key($key);
- $cnt++;
- }
- print "$cnt Index Entries Added\n";
- $index = '<DD>'.$index unless ($index =~ /^\s*<D(D|T)>/);
- $index_number++; # KEC.
- if ($SHORT_INDEX) {
- print "(compact version with Legend)";
- local($num) = ( $index =~ s/\<D/<D/g );
- if ($num > 50 ) {
- s/$idx_mark/$preindex<HR><DL>\n$index\n<\/DL>$preindex/o;
- } else {
- s/$idx_mark/$preindex<HR><DL>\n$index\n<\/DL>/o;
- }
- } else {
- s/$idx_mark/<DL COMPACT>\n$index\n<\/DL>/o; }
- }
-}
-}
-
-# KEC. Copied from latex2html.pl and modified to support multiple indices.
-# The bibliography and the index should be treated as separate sections
-# in their own HTML files. The \bibliography{} command acts as a sectioning command
-# that has the desired effect. But when the bibliography is constructed
-# manually using the thebibliography environment, or when using the
-# theindex environment it is not possible to use the normal sectioning
-# mechanism. This subroutine inserts a \bibliography{} or a dummy
-# \textohtmlindex command just before the appropriate environments
-# to force sectioning.
-sub add_bbl_and_idx_dummy_commands {
- local($id) = $global{'max_id'};
-
- s/([\\]begin\s*$O\d+$C\s*thebibliography)/$bbl_cnt++; $1/eg;
- ## if ($bbl_cnt == 1) {
- s/([\\]begin\s*$O\d+$C\s*thebibliography)/$id++; "\\bibliography$O$id$C$O$id$C $1"/geo;
- #}
- $global{'max_id'} = $id;
- # KEC. Modified to global substitution to place multiple index tokens.
- s/[\\]begin\s*($O\d+$C)\s*theindex/\\textohtmlindex$1/go;
- # KEC. Modified to pick up the optional argument to \printindex
- s/[\\]printindex\s*(\[.*?\])?/
- do { (defined $1) ? "\\textohtmlindex $1" : "\\textohtmlindex []"; } /ego;
- &lib_add_bbl_and_idx_dummy_commands() if defined(&lib_add_bbl_and_idx_dummy_commands);
-}
-
-# KEC. Copied from latex2html.pl and modified to support multiple indices.
-# For each textohtmlindex mark found, determine the index titles and headers.
-# We place the index ref in the header so the proper index can be generated later.
-# For the default index, the index ref is blank.
-#
-# One problem is that this routine is called twice.. Once for processing the
-# command as originally seen, and once for processing the command when
-# doing the name for the index file. We can detect that by looking at the
-# id numbers (or ref) surrounding the \theindex command, and not incrementing
-# index_number unless a new id (or ref) is seen. This has the side effect of
-# having to unconventionally start the index_number at -1. But it works.
-#
-# Gets the title from the list of indices.
-# If this is the first index, save the title in $first_idx_file. This is what's referenced
-# in the navigation buttons.
-# Increment the index_number for next time.
-# If the indexname command is defined or a newcommand defined for indexname, do it.
-# Save the index TITLE in the toc
-# Save the first_idx_file into the idxfile. This goes into the nav buttons.
-# Build index_labels if needed.
-# Create the index headings and put them in the output stream.
-
-{ my $index_number = 0; # Will be incremented before use.
- my $first_idx_file; # Static
- my $no_increment = 0;
-
-sub do_cmd_textohtmlindex {
- local($_) = @_;
- my ($idxref,$idxnum,$index_name);
-
- # We get called from make_name with the first argument = "\001noincrement". This is a sign
- # to not increment $index_number the next time we are called. We get called twice, once
- # my make_name and once by process_command. Unfortunately, make_name calls us just to set the name
- # but doesn't use the result so we get called a second time by process_command. This works fine
- # except for cases where there are multiple indices except if they aren't named, which is the case
- # when the index is inserted by an include command in latex. In these cases we are only able to use
- # the index number to decide which index to draw from, and we don't know how to increment that index
- # number if we get called a variable number of times for the same index, as is the case between
- # making html (one output file) and web (multiple output files) output formats.
- if (/\001noincrement/) {
- $no_increment = 1;
- return;
- }
-
- # Remove (but save) the index reference
- s/^\s*\[(.*?)\]/{$idxref = $1; "";}/e;
-
- # If we have an $idxref, the index name was specified. In this case, we have all the
- # information we need to carry on. Otherwise, we need to get the idxref
- # from the $index_number and set the name to "Index".
- if ($idxref) {
- $index_name = $indices{'title'}{$idxref};
- } else {
- if (defined ($idxref = $indices{'newcmdorder'}->[$index_number])) {
- $index_name = $indices{'title'}{$idxref};
- } else {
- $idxref = '';
- $index_name = "Index";
- }
- }
-
- $idx_title = "Index"; # The name displayed in the nav bar text.
-
- # Only set $idxfile if we are at the first index. This will point the
- # navigation panel to the first index file rather than the last.
- $first_idx_file = $CURRENT_FILE if ($index_number == 0);
- $idxfile = $first_idx_file; # Pointer for the Index button in the nav bar.
- $toc_sec_title = $index_name; # Index link text in the toc.
- $TITLE = $toc_sec_title; # Title for this index, from which its filename is built.
- if (%index_labels) { &make_index_labels(); }
- if (($SHORT_INDEX) && (%index_segment)) { &make_preindex(); }
- else { $preindex = ''; }
- local $idx_head = $section_headings{'textohtmlindex'};
- local($heading) = join(''
- , &make_section_heading($TITLE, $idx_head)
- , $idx_mark, "\002", $idxref, "\002" );
- local($pre,$post) = &minimize_open_tags($heading);
- $index_number++ unless ($no_increment);
- $no_increment = 0;
- join('',"<BR>\n" , $pre, $_);
-}
-}
-
-# Returns an index key, given the key passed as the first argument.
-# Not modified for multiple indices.
-sub add_idx_key {
- local($key) = @_;
- local($index, $next);
- if (($index{$key} eq '@' )&&(!($index_printed{$key}))) {
- if ($SHORT_INDEX) { $index .= "<DD><BR>\n<DT>".&print_key."\n<DD>"; }
- else { $index .= "<DT><DD><BR>\n<DT>".&print_key."\n<DD>"; }
- } elsif (($index{$key})&&(!($index_printed{$key}))) {
- if ($SHORT_INDEX) {
- $next = "<DD>".&print_key."\n : ". &print_idx_links;
- } else {
- $next = "<DT>".&print_key."\n<DD>". &print_idx_links;
- }
- $index .= $next."\n";
- $index_printed{$key} = 1;
- }
-
- if ($sub_index{$key}) {
- local($subkey, @subkeys, $subnext, $subindex);
- @subkeys = sort(split("\004", $sub_index{$key}));
- if ($SHORT_INDEX) {
- $index .= "<DD>".&print_key unless $index_printed{$key};
- $index .= "<DL>\n";
- } else {
- $index .= "<DT>".&print_key."\n<DD>" unless $index_printed{$key};
- $index .= "<DL COMPACT>\n";
- }
- foreach $subkey (@subkeys) {
- $index .= &add_sub_idx_key($subkey) unless ($index_printed{$subkey});
- }
- $index .= "</DL>\n";
- }
- return $index;
-}
-
-1; # Must be present as the last line.
+++ /dev/null
-%%
-%%
-
-\chapter{Die interne Katalog-Datenbank (Bitte nicht benutzen) }
-\label{InternalDbChapter}
-\index[general]{Die interne Katalog-Datenbank }
-
-\section{Interne Bacula Datenbank}
-\index[general]{Interne Bacula Datenbank }
-\index[general]{Datenbank!Interne Bacula }
-
-Urspr\"{u}nglich war die internen Datenbank haupts\"{a}chlich f\"{u}r
-die Bacula-Programmierer gedacht, um eine Testm\"{o}glichkeit w\"{a}hrend der
-Entwicklung bereit zu stellen; wenngleich auch SQLite eine gute Wahl daf\"{u}r ist.
-Jedenfalls ist die interne Datenbank nicht zum allgemeinen Gebrauch bestimmt.
-
-Die interne Datenbank ist so einfach ausgelegt, dass sie nur aus einer Datei besteht
-an die die internen benutzten Bacula-Strukturen fortlaufend angef\"{u}gt werden.
-Daher ist diese Datenbank auch nicht f\"{u}r Bacula-Installation mit vielen
-Clients oder mit gro{\ss}en Datenmengen geeignet.
-
-Untern finden Sie eine Tabelle in der die Funktionen von MySQL, SQLite und der
-internen Datenbank verglichen werden. Momentan ist es nicht m\"{o}glich im
-laufenden Betrieb zwischen den verschiedenen Datenbanken umzuschalten,
-Bacula muss dazu neu kompiliert werden. Wenn Sie mit verschiedenen Datenbanken
-testen m\"{o}chten, k\"{o}nnen Sie allerdings die entsprechenden Bacula-Programm-Dateien
-in zwei verschiedene Verzeichnisse installieren.
-
-\addcontentsline{lot}{table}{SQLite und MySQL im Vergleich zu der internen Bacula-Datenbank}
-\begin{longtable}{|l|l|l|}
- \hline
-\multicolumn{1}{|c| }{\bf Feature } & \multicolumn{1}{c| }{\bf SQLite oder MySQL
- } & \multicolumn{1}{c| }{\bf Bacula } \\
- \hline
-{Job Record } & {Ja } & {Ja } \\
- \hline
-{Media Record } & {Ja } & {Ja } \\
- \hline
-{FileName Record } & {Ja } & {Nein } \\
- \hline
-{File Record } & {Ja } & {Nein } \\
- \hline
-{FileSet Record } & {Ja } & {Ja } \\
- \hline
-{Pool Record } & {Ja } & {Ja } \\
- \hline
-{Client Record } & {Ja } & {Ja } \\
- \hline
-{JobMedia Record } & {Ja } & {Ja } \\
- \hline
-{List Job Records } & {Ja } & {Ja } \\
- \hline
-{List Media Records } & {Ja } & {Ja } \\
- \hline
-{List Pool Records } & {Ja } & {Ja } \\
- \hline
-{List JobMedia Records } & {Ja } & {Ja } \\
- \hline
-{Delete Pool Record } & {Ja } & {Ja } \\
- \hline
-{Delete Media Record } & {Ja } & {Ja } \\
- \hline
-{Update Pool Record } & {Ja } & {Ja } \\
- \hline
-{Verify verf\"{u}gbar } & {Ja } & {Nein } \\
- \hline
-{MD5 Signaturen } & {Ja } & {Nein }
-\\ \hline
-
-\end{longtable}
-
-Da bei der internen Datenbank kein Zugriff \"{u}ber SQL-Kommandos m\"{o}glich ist,
-stehen auch die Console-Kommandos {\bf sqlquery}, {\bf query}, {\bf retention},
-sowie weitere die direkt SQL benutzen, nicht zur Verf\"{u}gung.
+++ /dev/null
-# This file serves as a place to put initialization code and constants to
-# affect the behavior of latex2html for generating the bacula manuals.
-
-# $LINKPOINT specifies what filename to use to link to when creating
-# index.html. Not that this is a hard link.
-$LINKPOINT='"$OVERALL_TITLE"';
-
-
-# The following must be the last line of this file.
-1;
+++ /dev/null
-%%
-%%
-
-\chapter{MySQL Installation und Konfiguration}
-\label{MySqlChapter}
-\index[general]{MySQL!Installation und Konfiguration }
-\index[general]{MySQL Installation und Konfiguration }
-
-\section{MySQL Installation und Konfiguration -- Phase I}
-\index[general]{MySQL Installation und Konfiguration -- Phase I }
-\index[general]{Phase I!MySQL Installation und Konfiguration -- }
-
-Wenn Sie bei der Konfiguration des Bacula-Quelltextes die Option
-\verb:--:with-mysql=/Pfad/zu/MySQL angeben, muss MySQL in der Version
-4.1 oder sp\"{a}ter auf Ihrem System, in /Pfad/zu/MySQL, installiert sein.
-
-Falls Sie eine Standard-MySQL-Installation verwenden reicht es,
-wenn Sie \verb:--:with-mysql angeben. Bacula wird den Pfad zu MySQL dann
-selbst finden. Wenn MySQL zum Beispiel in Ihrem home-Verzeichnis
-installiert ist, m\"{u}ssen Sie den vollen Pfad zu der
-MySQL-Installation angeben.
-
-Die Installation und Konfiguration von MySQL ist zwar nicht sehr schwierig,
-kann aber beim ersten Mal doch verwirrend sein. Daher werden hier einmal die
-notwendigen Schritte zu einer laufenden MySQL-Datenbank beschrieben.
-Bitte beachten Sie, dass die MySQL-Datenbank-Anmeldungen nach der Installation
-noch nicht durch Passw\"{o}rter gesch\"{u}zt sind. Falls Sie auf Ihrem
-System andere lokale Benutzer haben, ist das nicht unbedingt w\"{u}nschenswert.
-
-Als n\"{a}chstes folgen die Schritte, die n\"{o}tig sind, um MySQL aus
-dem Quelltext zu kompilieren. Falls Sie MySQL schon installiert haben,
-k\"{o}nnen Sie jetzt die Installation von Bacula fortsetzen, um hier sp\"{a}ter
-mit der Phase II der MySQL-Installation weiterzumachen. Wenn Sie die MySQL-RPMs
-installieren wollen, ben\"{o}tigen Sie diese Pakete:
-
-\footnotesize
-\begin{alltt}
-mysql-<version>.rpm
-mysql-server-<version>.rpm
-mysql-devel-<version>.rpm
-\end{alltt}
-\normalsize
-Die Namen k\"{o}nnen, je nach Distribution, auch abweichen.
-Wichtig ist es, dass Sie auch das devel-Paket, das die header-Dateien
-und Bibliotheken enth\"{a}lt, die notwendig sind um Bacula zu
-\"{u}bersetzen, installieren. Eventuell sind auch noch weitere
-Pakete zu installieren die von den MySQL-RPMs benutzt werden,
-zum Beispiel zlib und openssl. Nachdem diese Pakete installiert
-sind, k\"{o}nnen Sie Bacula aus dem Quelltext \"{u}bersetzen.
-
-\begin{enumerate}
-\item downloaden Sie den MySQL-Quelltext von
- \elink{www.mysql.com/downloads}{http://www.mysql.com/downloads}
-
-\item und entpacken Sie ihn mit einem Kommando wie zum Beispiel:
-
- {\bf tar xvfz mysql-filename}
-
-Falls Sie kein GNU-tar auf Ihrem System haben, k\"{o}nnen Sie auch
-
-{\bf zcat mysql-filename | tar xvf - }
-
-ausf\"{u}hren, das Ergebnis ist das selbe.
-
-\item cd {\bf MySQL-Quelltext-Verzeichnis}
-
- ersetzen Sie "`MySQL-Quelltext-Verzeichnis"' mit dem Verzeichnis,
- in das Sie gerade den Quelltext entpackt haben.
-
-
-
-\item ./configure \verb:--:enable-thread-safe-client \verb:--:prefix=MySQL-Verzeichnis
-
- Seit der Bacula-Version 1.31 wird die thread-safe-Version der
- MySQL-Client-Bibliotheken verwendet. Daher muss die Option
- {\bf \verb:--:enable-thread-safe-client} beim Konfigurieren des
- MySQL-Quelltextes angegeben werden.
- Der MySQL-Client ben\"{o}tigt zudem die gzip-Kompressions-Bibliotheken
- {\bf libz.a} oder {\bf libz.so}. Wenn Sie RPM-Pakete verwenden, finden Sie
- diese in {\bf libz-devel} und bei Debian hei{\ss}t dieses Paket {\bf zlib1g-dev}
- (auf anderen Distributionen wird der Name \"{a}hnlich sein).
-
- Ersetzen Sie "`MySQL-Verzeichnis"' mit dem Pfad, in den MySQL installiert werden soll.
- Normalerweise /usr/local/mysql f\"{u}r systemweite Installation oder zum Beispiel
- /home/bacula/mysql damit der Benutzer bacula eine eigene Datenbank zur Verf\"{u}gung hat.
-
- Bitte beachten Sie, dass Sie das "`MySQL-Verzeichnis"' auch beim konfigurieren
- des Bacula-Quelltextes mit der Option {\bf \verb:--:with-mysql=MySQL-Verzeichnis}
- angeben m\"{u}ssen.
-
-\item make
-
- startet das Kompilieren des Quelltextes und wird einige Zeit ben\"{o}tigen
-
-\item make install
-
- installiert alle ausf\"{u}hrbaren Dateien, Bibliotheken und anderen
- ben\"{o}tigten Dateien in das angegebene "`MySQL-Verzeichnis"'.
-
-\item ./scripts/mysql\_install\_db
-
- erzeugt die MySQL-Datenbanken die f\"{u}r die Benutzer-Autorisierung erforderlich sind.
- Dieses Script liegt auch im "`MySQL-Verzeichnis"' unter bin/.
-
-\end{enumerate}
-
-An diesem Punkt, fahren Sie jetzt bitte mit der Installation von Bacula fort.
-Nachdem Bacula installiert ist, lesen Sie hier unter "`Phase II"' weiter.
-Einige Scripte, die Sie f\"{u}r die zweite Phase der MySQL-Installation und
-Konfiguration ben\"{o}tigen, werden erst bei der Installation von Bacula erstellt.
-
-\label{mysql_phase2}
-\section{MySQL Installation und Konfiguration -- Phase II}
-\index[general]{MySQL Installation und Konfiguration -- Phase II }
-\index[general]{Phase II!MySQL Installation und Konfiguration -- }
-
-An diesem Punkt sollten Sie bereits MySQL und Bacula kompiliert
-und installiert haben. Falls nicht, schlie{\ss}en Sie bitte diese
-beiden Schritte erst ab, bevor Sie hier weitermachen.
-
-Bei der Installation von Bacula werden mehrere Scripte in das
-Installations-Verzeichnis kopiert, mit denen Sie verschiedene
-\"{A}nderungen an der Datenbank durchf\"{u}hren k\"{o}nnen.
-Diese Scripte haben Namen im Format *\_bacula\_*
-(z.B. create\_bacula\_database)und dienen dazu die Datenbank
-zu initialisieren, zu aktualisieren oder zu l\"{o}schen.
-Diese Scripte sind auch im Bacula-Quelltext-Verzeichnis, nach
-der Ausf\"{u}hrung des "`./configure"'-Scripts, unter
-\lt{}bacula-src\gt{}/src/cats zu finden. Wenn Sie sich, zum
-Beispiel, das Script create\_bacula\_database n\"{a}her ansehen
-werden Sie merken, dass dieses Script einfach nur
-create\_mysql\_database ausf\"{u}hrt. Alle Scripte die *\_bacula\_*
-heissen, dienen nur der Bequemlichkeit. Es spielt keine Rolle
-mit welcher Datenbank Sie den Bacula-Quelltext \"{u}bersetzt haben,
-das Script create\_bacula\_database wird immer die f\"{u}r Sie
-richtige Datenbank erstellen.
-
-Die folgenden Schritte sind n\"{o}tig um die MySQL-Datenbank und Tabellen
-zu erstellen, die Bacula benutzt:
-
-\begin{enumerate}
-\item Starten Sie {\bf mysql}. Dazu k\"{o}nnen Sie auch das Script {\bf startmysql}
- benutzen, dass Bacula mitinstalliert.
-
-\item cd \lt{}Bacula-Installations-Verzeichnis\gt{}
- In diesem Verzeichnis finden Sie die Bacula-Datenbank-Scripte.
-
-\item ./grant\_bacula\_privileges
- Dieses Script erm\"{o}glicht dem Benutzer "`bacula"' uneingeschr\"{a}nkten
- Zugriff auf die Datenbank. Eventuell m\"{u}ssen Sie es anpassen, um es auf
- Ihre Umgebung anzupassen. Bitte beachten Sie auch, dass nach der Installation
- kein Datenbank-Benutzer, auch root, ein Passwort gesetzt hat. Falls das
- f\"{u}r Sie zu unsicher ist, k\"{o}nnen Sie mit dem Kommando "`mysqladmin"'
- den Benutzern Passw\"{o}rter zuweisen.
-
-\item ./create\_bacula\_database
- Dieses Script erzeugt die Bacula-Katalog-Datenbank. Diese Datenbank,
- und auch die bei der Installation angelegte MySQL-interne Benutzer-Datenbank,
- liegt danach im Verzeichnis var/ unterhalb des "`MySQL-Verzeichnis"'
- das Sie bei der Konfiguration des MySQL-Quelltextes mit der Option
- {\bf \verb:--:prefix} angegeben haben. Dieser Pfad zu den
- Datenbank-Dateien kann wichtig sein, wenn Sie diese Dateien auf speziellem
- Weg sichern wollen oder falls Sie wissen m\"{o}chten, welche Gr\"{o}{\ss}e
- die Datenbank hat.
-
-\item ./make\_bacula\_tables
- Dieses Script legt die Tabellen an die Bacula ben\"{o}tigt.
-\end{enumerate}
-
-Jedes dieser Scripte erlaubt es Ihnen Optionen mit auf der Kommandozeile
-zu \"{u}bergeben. Das kann n\"{u}tzlich sein, wenn Sie zum Beispiel einen
-Benutzer oder Passwort zum Zugriff auf die Datenbank angeben m\"{u}ssen.
-So ist es m\"{o}glich auf der Kommandozeile beispielsweise {\bf -u root} anzugeben,
-um gen\"{u}gend Rechte zur Erstellung der Bacula-Datenbank zu haben.
-
-Um einen genaueren Blick auf die oben gesetzten Zugriffsrechte f\"{u}r
-den Benutzer bacula innerhalb der Datenbank zu werfen, k\"{o}nnen Sie
-folgende Kommandos ausf\"{u}hren:
-
-\footnotesize
-\begin{alltt}
-<MySQL-Verzeichnis>/bin/mysql -u root mysql
-select * from user;
-\end{alltt}
-\normalsize
-
-\section{Re-Initialisierung der Katalog-Datenbank}
-\index[general]{Datenbank!Re-Initialisierung der Katalog- }
-\index[general]{Re-Initialisierung der Katalog-Datenbank }
-
-Nachdem Sie einige anf\"{a}ngliche Tests mit Bacula gemacht haben, wollen
-Sie eventuell Ihre Katalog-Datenbank komplett leeren, um alle gelaufenen
-Test-Backups aus der Datenbank zu entfernen. Um das zu erreichen,
-tun Sie folgendes:
-
-\footnotesize
-\begin{alltt}
- cd <install-directory>
- ./drop_bacula_tables
- ./make_bacula_tables
-\end{alltt}
-\normalsize
-
-Bitte bedenken Sie, dass dabei alle Informationen unwiderruflich
-aus der Datenbank gel\"{o}scht werden. Falls Sie auch beschriebene
-Volumes wiederverwenden wollen, m\"{u}ssen Sie das Volume-Label
-\"{u}berschreiben damit Bacula sie erneut benutzen kann.
-Das erreichen Sie durch:
-
-\footnotesize
-\begin{alltt}
- (stop Bacula or unmount the drive)
- mt -f /dev/nst0 rewind
- mt -f /dev/nst0 weof
-\end{alltt}
-\normalsize
-
-hierbei m\"{u}ssen Sie {\bf /dev/nst0} durch das Device ersetzen,
-dem Ihr Tapelaufwerk entspricht.
-
-\section{Bacula mit MySQL linken}
-\index[general]{Bacula mit MySQL linken }
-\index[general]{MySQL!linken Bacula mit }
-
-
-Nach der MySQL-Quelltext-Konfiguration mit:
-
-./configure \verb:--:enable-thread-safe-client \verb:--:prefix=\lt{}MySQL-Verzeichnis\gt{}
-wobei "`MySQL-Verzeichnis"' in diesem Beispiel {\bf /home/bacula/mysql} ist,
-m\"{u}ssen Sie Ihrem Betriebssystem mitteilen wo die MySQL-Bibliotheken zu
-finden sind. Falls Sie MySQL in einem Standard-Pfad installiert haben, wie
-zum Beispiel {\bf /usr/lib} oder {\bf /usr/local/lib}, ist dies nicht n\"{o}tig.
-In diesem Beispiel ist es aber notwendig den Pfad {\bf /home/bacula/mysql}
-dem Loader-Proze{\ss} f\"{u}r dynamische Bibliotheken bekannt zu machen.
-Die folgende Beschreibung ist Linux-spezifisch, bei anderen Betriebssystemen
-lesen Sie bitte deren Dokumentation um dieses Ziel zu erreichen.
-
-Als erstes m\"{u}ssen Sie die Datei {\bf /etc/ld.so.conf} editieren
-und am Ende eine neue Zeile mit dem entsprechenden Pfad hinzuf\"{u}gen.
-
-In diesem Beispiel: "`/home/bacula/mysql/lib/mysql"'
-danach muss der Cache des Loader-Proze{\ss}es mit {\bf /sbin/ldconfig}
-neu gebaut werden.
-
-Wenn Sie MySQL auf eine neuere Version updaten \"{a}ndern eventuell
-einige der Bibliotheken ihre Namen, dann m\"{u}ssen Sie den Loader-Cache
-wiederum mit {\bf /sbin/ldconfig} aktualisieren. Das Gleiche gilt
-wenn Sie MySQL mit anderen Optionen neu kompilieren und sich dadurch
-die MySQL-Bibliotheken \"{a}ndern, zum Beispiel, weil Sie beim ersten
-kompilieren die ben\"{o}tigte Option \verb:--:enable-thread-safe-client
-vergessen haben.
-
-Eventuell kennt Ihr System auch eine Umgebungsvariable die zu diesem Zweck
-gesetzt werden kann. Auf Solaris kann man die Variable
-LD\_LIBRARY\_PATH dazu benutzen. In diesem Beispiel setzt man sie dazu auf:
-
-LD\_LIBRARY\_PATH=/home/bacula/mysql/lib/mysql
-
-Falls Sie zus\"{a}tzlich die Verschl\"{u}ssellung in MySQL aktiviert haben,
-ist es m\"{o}glich, dass Sie {\bf -lssl -lcrypto} mit an den Linker
-\"{u}bergeben m\"{u}ssen. Dazu k\"{o}nnen Sie entweder die LDFLAGS-Definition
-exportieren, oder sie direkt beim Aufruf von ./configure angeben:
-
-\footnotesize
-\begin{alltt}
-LDFLAGS="-lssl -lcyrpto" \
- ./configure \
- <your-options>
-\end{alltt}
-\normalsize
-
-\section{MySQL RPM-Installation}
-\index[general]{MySQL!RPM-Installation}
-\index[general]{MySQL RPM-Installation}
-Wenn Sie die MySQL-RPMs installieren wollen, ben\"{o}tigen Sie
-sowohl das eigentlich MySQL- als auch das Paket, dass die Client-
-Bibliotheken enth\"{a}lt, normalerweise das devel-Paket.
-Sie m\"{u}ssen also diese beiden Pakete installieren:
-
-\footnotesize
-\begin{alltt}
- mysql
- mysql-devel
-\end{alltt}
-\normalsize
-
-Bei den meisten anderen Paket-Managern wird das \"{a}hnlich aussehen.
-Nach der Installation der Pakete m\"{u}ssen Sie die oben genannten
-Bacula-Scripte zur Datenbank-Einrichtung ausf\"{u}hren.
-
-\section{MySQL updaten}
-\index[general]{MySQL updaten }
-\index[general]{MySQL!updaten }
-\index[general]{Update}
-Um Ihre MySQL-Installation zu aktualisieren, m\"{u}ssen Sie
-es neu konfigurieren, kompilieren und installieren. Andernfalls
-kann es sein, dass bei Bacula merkw\"{u}rdige Fehler auftreten.
-Auch nach der Aktualisierung der MySQL-RPMs ist es notwendig
-Bacula neu zu bauen. Das k\"{o}nnen Sie einfach, mit den
-entsprechenden RPM-Kommandos, \"{u}ber das Bacula-Source-RPM
-ereichen. Eventuell m\"{u}ssen Sie aber vorher die bacula.spec
-anpassen, damit es mit der neuen MySQL-Version funktioniert.
+++ /dev/null
-%%
-%%
-
-\chapter{PostgreSQL Installation und Konfiguration}
-\label{PostgreSqlChapter}
-\index[general]{PostgreSQL!Installation und Konfiguration }
-\index[general]{PostgreSQL Installation und Konfiguration }
-\index[general]{Update}
-
-Wenn Sie sich dazu entschlie{\ss}en PostgreSQL zu verwenden,
-sollten Sie sich \"{u}ber den Aufwand, den ein Datenbank-Update
-mit sich bringt, im Klaren sein. Grunds\"{a}tzlich werden Sie bei
-jeder neuen Hauptversion von PostgreSQL Ihre alte Datenbank
-exportieren m\"{u}ssen, um sie dann in die neue Version einzupflegen.
-Das wird dadurch erforderlich, dass sich regelm\"{a}{\ss}ig
-einige internen "`Datenformate"' \"{a}ndern und von den
-PostgreSQL-Entwicklern keine Tools zu Verf\"{u}gung gestellt
-werden, um den Update-Vorgang zu automatisieren. Falls Sie den
-Daten-Ex- und -Import vergessen sollten, kann es sein das Sie
-auf die Datenbank nicht mehr zugreifen k\"{o}nnen, da die neue
-PostgreSQL-Version nicht mit den alten Datenbank-Dateien
-zusammenarbeitet.
-
-Sollten Sie PostgreSQL aus dem Quelltext selbst
-kompilieren, m\"{u}ssen Sie dem configure-Kommando die
-Option {\bf \verb:--:enable-thread-safety} \"{u}bergeben.
-
-\section{PostgreSQL Installation}
-\index[general]{PostgreSQL!Installation }
-Wenn Sie bei der Konfiguration des Bacula-Quelltextes {\bf ./configure
-\verb:--:with-postgresql=PostgreSQL-Verzeichnis} angeben, m\"{u}ssen Sie
-PostgreSQL mindestens in Version 7.4 installiert haben. \"{A}ltere
-PostgreSQL-Versionen funktionieren mit Bacula nicht. Falls PostgreSQL
-in einem Standard-Verzeichnis installiert ist, brauchen Sie das
-"`PostgreSQL-Verzeichnis"' nicht angeben. Wenn es aber zum Beispiel in
-Ihrem Home-Verzeichnis installiert ist, m\"{u}ssen Sie den kompletten
-Pfad angeben.
-
-Die Konfiguration und Installation von PostgreSQL ist zwar nicht sehr
-schwer, kann aber beim ersten Mal etwas verwirrend sein. Wenn Sie es vorziehen,
-k\"{o}nnen Sie PostgreSQL auch \"{u}ber die Paket-Verwaltung Ihres Betriebssystems
-installieren. Vorkompilierte Pakete finden Sie auf www.postgresql.org
-unter \elink{Downloads}{http://www.postgresql.org/download/}
-
-Wenn Sie PostgreSQL lieber aus dem Quelltext selbst kompilieren m\"{o}chten,
-empfehlen wir Ihnen den Anweisungen in der \elink{PostgreSQL
-Dokumentation}{http://www.postgresql.org/docs/} zu folgen.
-
-Benutzer von FreeBSD finden in diesem \elink{FreeBSD Diary
-Artikel}{http://www.freebsddiary.org/postgresql.php} weitere n\"{u}tzliche
-Informationen. Selbstverst\"{a}ndlich enth\"{a}lt der Artikel auch f\"{u}r
-Nicht-FreeBSD-Benutzer wissenswertes bez\"{u}glich der Installation und
-Konfiguration von PostgreSQL
-
-Falls Sie die Bacula "`Batch-Insert"'-Funktion benutzen wollen, die
-standardm\"{a}{\ss}ig aktiviert ist und f\"{u}r eine schnelle Verarbeitung
-der Attribute der gesicherten Datein sorgt, m\"{u}ssen Sie unbedingt darauf
-achten, dass PostgreSQL mit der Option {\bf \verb:--:enable-thread-safety}
-kompiliert wurde. Bei den meisten gro{\ss}en Linux-Distributionen ist das
-der Fall. Aber falls Sie nicht sichert sind k\"{o}nnen Sie mit folgendem
-Kommando feststellen, ob Ihr PostgreSQL gegen die pthreads-Bibliothek
-gelinked ist:
-
-\footnotesize
-\begin{alltt}
- nm /usr/lib/libpq.a | grep pthread_mutex_lock
-\end{alltt}
-\normalsize
-
-Die Kommandos m\"{u}ssen in etwa eine Zeile wie diese zur\"{u}ckgeben:
-
-\footnotesize
-\begin{alltt}
- U pthread_mutex_lock
-\end{alltt}
-\normalsize
-
-wenn das der Fall ist, ist alles in Ordnung. Wenn keine Zeilen zur\"{u}ckgegeben
-werden, wird Bacula beim kompilieren die "`Batch-Insert"`-Funktion deaktivieren.
-Wenn Sie sie trotzdem benutzen wollen, m\"{u}ssen Sie PostgreSQL mit der Option
-\verb:--:enable-thread-safety neu kompilieren.
-
-Nach der PostgreSQL-Installation fahren Sie bitte mit der Installation von Bacula
-fort. Sp\"{a}ter wenn Sie diese abgeschlossen haben, lesen Sie hier weiter, um
-die Konfiguration von PostgreSQL zu beenden. Bitte beachten Sie, dass einige
-Schritte im weiteren Verlauf der PostgreSQL-Konfiguration Scripte ben\"{o}tigen,
-die erst bei der Installation von Bacula erstellt werden. Auch wenn Sie f\"{u}r
-die Installation von PostgreSQL vorkompilierte Pakete verwendet haben (zum
-Beispiel rpm oder deb) m\"{u}ssen Sie sp\"{a}ter hier weitermachen, um die
-Konfiguration von PostgreSQL zu vervollst\"{a}ndigen.
-
-Bitte beachten Sie, dass Sie das Installationsverzeichnis von PostgreSQL,
-das Sie mit der Option {\bf \verb:--:with-postgresql=PostgreSQL-Verzeichnis}
-dem configure-Script \"{u}bergeben haben, auch bei der Konfiguration des
-Bacula-Quelltextes mit {\bf \verb:--:with-postgresql=PostgreSQL-Verzeichnis}
-angeben m\"{u}ssen. Die einzige Ausnahme ist, dass Sie kein spezielles
-Verzeichnis angegeben haben und PostgreSQL somit in den Standard-Verzeichnissen
-installiert ist. In diesem Fall findet das configure-Script von Bacula
-die PostgreSQL Header und Bibliotheken auch ohne explizite Angabe des Verzeichnisses.
-
-\label{PostgreSQL Konfiguration}
-\section{Konfiguration PostgreSQL}
-\index[general]{PostgreSQL!Konfiguration PostgreSQL}
-
-An diesem Punkt sollten Sie PostgreSQL und Bacula
-kompiliert und installiert haben. Falls nicht,
-schlie{\ss}en Sie bitte diese beiden Schritte erst ab,
-bevor Sie hier weitermachen.
-
-Bei der Installation von Bacula werden mehrere Scripte in das
-Installations-Verzeichnis kopiert, mit denen Sie verschiedene
-\"{A}nderungen an der Datenbank durchf\"{u}hren k\"{o}nnen.
-Diese Scripte haben Namen im Format *\_bacula\_*
-(z.B. create\_bacula\_database)und dienen dazu die Datenbank
-zu initialisieren, zu aktualisieren oder zu l\"{o}schen.
-Diese Scripte sind auch im Bacula-Quelltext-Verzeichnis, nach
-der Ausf\"{u}hrung des "`./configure"'-Scripts, unter
-\lt{}bacula-src\gt{}/src/cats zu finden. Wenn Sie sich, zum
-Beispiel, das Script create\_bacula\_database n\"{a}her ansehen
-werden Sie merken, dass dieses Script einfach nur
-create\_postgresql\_database ausf\"{u}hrt. Alle Scripte die *\_bacula\_*
-heissen, dienen nur der Bequemlichkeit. Es spielt keine Rolle
-mit welcher Datenbank Sie den Bacula-Quelltext \"{u}bersetzt haben,
-das Script create\_bacula\_database wird immer die f\"{u}r Sie
-richtige Datenbank erstellen.
-
-Die folgenden Schritte sind n\"{o}tig um die PostgreSQL-Datenbank und Tabellen
-zu erstellen, die Bacula benutzt:
-
-\begin{enumerate}
-\item cd \lt{}Bacula-Installations-Verzeichnis\gt{}
-
- In diesem Verzeichnis finden Sie die Bacula-Datenbank-Scripte.
-
-\item ./create\_bacula\_database
-
- Dieses Script erzeugt die Bacula-Katalog-Datenbank.
- Bevor Sie dieses Script ausf\"{u}hren, sollten Sie sich \"{u}ber
- die verwendete Kodierung der Text-Felder (Pfade, Dateien, ...)
- innerhalb der Datenbank Gedanken machen. Idealerweise wird UTF8 verwendet.
- Allerdings sind bei vielen Unix-Systeme die Dateinamen nicht in UTF8 kodiert,
- weil eventuell UTF8 auf diesen Systemen nicht als Standard-Kodierung gesetzt ist,
- oder weil Dateien von anderen Systemen (z.B. MacOS X) kopiert worden sind.
- Aus diesem Grund verwendet Bacula SQL\_ASCII als Datenbank-Kodierung.
- Wenn Sie das \"{a}ndern wollen, m\"{u}ssen Sie das Script vor der
- Ausf\"{u}hrung entsprechend anpassen. Bedenken Sie dabei aber, dass
- sp\"{a}tere Backups eventuell fehlschlagen, falls Bacula Dateien und
- Verzeichnisse sichern soll, deren Namen nicht UTF8-kodiert sind.
-
- Wenn die Ausf\"{u}hrung dieses Scripts fehlschl\"{a}gt kann es sein,
- dass die Datenbank einem anderen Benutzer geh\"{o}rt als der, mit dem
- Sie gerade angemeldet sind. Auf vielen Systemen ist der Datenbank-
- Besitzer {\bf pgsql} oder, auf Fedora und RedHat {\bf postgres}.
- Am leichtesten finden Sie den Namen des Besitzers in der /etc/passwd.
- Um einen neuen Datenbank-Benutzer anzulegen, k\"{o}nnen Sie folgende
- Kommandos ausf\"{u}hren:
-
-\begin{alltt}
- su
- (Eingabe des root-Passworts)
- su pgsql (oder postgres)
- createuser IhrLogin (oder beispielsweise bacula)
- Shall the new user be allowed to create databases? (y/n) y
- Shall the new user be allowed to create more new users? (y/n) n
- exit
-\end{alltt}
-
- Jetzt sollten Sie in der Lage sein das Script ./create\_bacula\_database
- auszuf\"{u}hren.
-
-\item ./make\_bacula\_tables
-
- Diese Script erstellt die von Bacula ben\"{o}tigten Tabellen.
-
-\item ./grant\_bacula\_privileges
-
- Dieses Script erstellt den Datenbank-Benutzer "`bacula"', der nur begrenzte
- Datenbank-Berechtigungen erh\"{a}lt. Eventuell wollen Sie das Ihrer Situation entsprechend
- anpassen. Bitte beachten Sie auch, dass dem Datenbank-Benutzer bacula nicht
- automatisch ein Passwort zugewiesen wird.
-
-\end{enumerate}
-
-Jedes dieser drei Scripte (create\_bacula\_database, make\_bacula\_tables und
-grant\_bacula\_privileges) erlaubt die Verwendung von Kommandozeilen-Parametern.
-Damit k\"{o}nnen Sie den Datenbank-Benutzernamen oder auch mit "`-h Rechnername"'
-einen Server angeben, auf dem die PostgreSQL-Instanz l\"{a}uft.
-
-Um sich anzusehen, was f\"{u}r Zugriffsrechte die Scripte vergeben haben,
-k\"{o}nnen Sie diese Kommando ausf\"{u}hren:
-
-\footnotesize
-\begin{alltt}
-PostgreSQL-Verzeichnis/bin/psql --command \\dp bacula
-\end{alltt}
-\normalsize
-
-Falls Autorisationsprobleme beim Zugriff auf die Datenbank auftreten,
-kann es helfen die Datei pg\_hba.conf (normalerweise in /etc/postgresql/)
-wie folgt anzupassen:
-
-\footnotesize
-\begin{alltt}
- local all all ident sameuser
-to
- local all all trust sameuser
-\end{alltt}
-\normalsize
-
-Dadurch k\"{o}nnen einige Probleme behoben werden. Allerdings ist das
-aus Sicherheitsbedenken kein sehr guter Ansatz, auch wenns es hilft
-ohne Passwort auf die Datenbank zuzugreifen.
-
-Ein besserer Weg ist es auf Passworter-Autorisierung umzustellen
-und dann bei jeden Datenbank-Login das vergebene Passwort zu benutzen.
-Dazu f\"{u}gen Sie vor den existierenden "`local"' und "`host"' Eintr\"{a}gen
-einfach die folgende Zeile ein:
-
-\footnotesize
-\begin{alltt}
- local bacula bacula md5
-\end{alltt}
-\normalsize
-
-Danach ist es notwendig die PostgreSQL-Instanz neu zu starten oder
-"`pg\_ctl reload"' auszuf\"{u}hren, damit die neue Regel aktiviert wird.
-Als n\"{a}chstes muss noch ein Passwort f\"{u}r den Datenbank-Benutzer
-bacula vergeben werden. Wechseln Sie dazu den Benutzer (z.B. mit su - postgres)
-und f\"{u}hren Sie folgende Kommandos aus:
-
-\footnotesize
-\begin{alltt}
- \$ psql bacula
- bacula=# alter user bacula with password 'secret';
- ALTER USER
- bacula=# \\q
-\end{alltt}
-\normalsize
-
-Das vergebene Passwort m\"{u}ssen Sie an den folgenden Stellen in
-der Bacula-Konfiguration verwenden: einmal im Katalog-Eintrag
-der Bacula-Director-Konfiguration und im Job-Eintrag des BackupCatalog-Jobs
-bei dem RunBeforeJob-Kommando. Mit dem Passwort m\"{u}ssen diese
-beiden Zeilen dann in etwa so aussehen:
-
-\footnotesize
-\begin{alltt}
- dbname = bacula; user = bacula; password = "secret"
- ... und ...
- # WARNING!!! Passing the password via the command line is insecure.
- # see comments in make_catalog_backup for details.
- RunBeforeJob = "/etc/make_catalog_backup bacula bacula secret"
-\end{alltt}
-\normalsize
-
-Nat\"{u}rlich sollte ein mehr zuf\"{a}lliges Passwort gew\"{a}hlt werden
-als in diesem Beispiel. Zudem sollte die Director-Konfiguratios-Datei bacula-dir.conf
-entsprechend gesichert werden, dass nicht alle Benutzer Zugriff darauf haben,
-sondern nur der Benutzer als der der Bacula-Director l\"{a}uft.
-
-Der Datenbank-Zugriff kann auch \"{u}ber die Datei .pgpass,
-im Home-Verzeichnis des entsprechenden Benutzer der Zugriff auf
-die Datenbank ben\"{o}tigt, gel\"{o}st werden.
-Dazu muss diese Datei folgendes enthalten:
-
-\footnotesize
-\begin{alltt}
- localhost:5432:bacula:bacula:secret
-\end{alltt}
-\normalsize
-
-Danach kann diese Datei in die Home-Verzeichnisse aller Benutzer kopiert werden
-die Datenbank-Zugriff erhalten sollen (z.B. bacula, root und den Benutzern die
-\"{u}ber die Bacula-Console Zugriff haben sollen). Die Datei muss dem Benutzer
-und seiner Gruppe geh\"{o}ren, f\"{u}r root also "`root:root"' und die
-Zugriffsrechte m\"{u}ssen auf 600 (nur der Benutzer darf sie lesen) gesetzt sein.
-
-\section{Re-Initialisierung der Katalog-Datenbank}
-\index[general]{Datenbank!Re-Initialisierung der Katalog- }
-\index[general]{Re-Initialisierung der Katalog-Datenbank }
-
-Nachdem Sie einige anf\"{a}ngliche Tests mit Bacula gemacht haben, wollen
-Sie eventuell Ihre Katalog-Datenbank komplett leeren, um alle gelaufenen
-Test-Backups aus der Datenbank zu entfernen. Um das zu erreichen,
-tun Sie folgendes:
-
-\footnotesize
-\begin{alltt}
- cd <install-directory>
- ./drop_bacula_tables
- ./make_bacula_tables
-\end{alltt}
-\normalsize
-
-Bitte bedenken Sie, dass dabei alle Informationen unwiderruflich
-aus der Datenbank gel\"{o}scht werden. Falls Sie auch beschriebene
-Volumes wiederverwenden wollen, m\"{u}ssen Sie das Volume-Label
-\"{u}berschreiben damit Bacula sie erneut benutzen kann.
-Das erreichen Sie durch:
-
-\footnotesize
-\begin{alltt}
- (stop Bacula or unmount the drive)
- mt -f /dev/nst0 rewind
- mt -f /dev/nst0 weof
-\end{alltt}
-\normalsize
-
-hierbei m\"{u}ssen Sie {\bf /dev/nst0} durch das Device ersetzen,
-dem Ihr Tapelaufwerk entspricht.
-
-\section{PostgreSQL RPM-Installation}
-\index[general]{PostgreSQL!RPM-Installation}
-\index[general]{PostgreSQL RPM-Installation}
-Wenn Sie lieber die PostgreSQL-RPMs Ihrer Distribution verwenden wollen,
-m\"{u}ssen Sie sowohl das PostgreSQL-RPM, als auch das PostgreSQL-Client-RPM
-installieren. Die ben\"{o}tigten Client-Bibliotheken finden Sie normalerweise im
-PostgreSQL-devel-RPM. Folgende Pakete m\"{u}ssen installiert werden:
-
-\footnotesize
-\begin{alltt}
- postgresql
- postgresql-devel
- postgresql-server
- postgresql-libs
-\end{alltt}
-\normalsize
-
-Bei dem meisten anderen Paket-Managern werden die Pakete \"{a}hnlich
-Namen haben. Nach der Installation der Pakete m\"{u}ssen Sie die oben genannten
-Bacula-Scripte zur Datenbank-Einrichtung ausf\"{u}hren.
-
-
-\section{Migration von MySQL zu PostgreSQL}
-\index[general]{PostgreSQL!Migration von MySQL zu }
-\index[general]{Migration von MySQL zu PostgreSQL }
-
-Die hier beschriebenen Schritte wurden mit folgenden Software-Versionen getestet:
-
-\begin{itemize}
-\item Linux Mandrake 10/Kernel 2.4.22-10 SMP
-\item Mysql Ver 12.21 Distrib 4.0.15, for mandrake-linux-gnu (i586)
-\item PostgreSQL 7.3.4
-\item Bacula 1.34.5
- \end{itemize}
-
-Warnung: Sichern Sie Ihre komplette MySQL-Datenbank bevor Sie diese Schritte
-ausf\"{u}hren!
-
-\begin{enumerate}
-\item Stoppen Sie Bacula (cd /etc/bacula;./bacula stop oder /etc/init.d/bacula stop)
-\item F\"{u}hren Sie das folgende Kommando aus, um die Daten Ihrer MySQL-Datenbank
-zu exportieren:
-
- \footnotesize
-\begin{alltt}
- mysqldump -f -t -n >bacula-backup.dmp
-
-\end{alltt}
-\normalsize
-
-\item Sichern Sie Ihr /etc/Bacula-Verzeichnis, \"{a}ndern Sie aber nicht das bestehende Verzeichnis
-\item F\"{u}hren Sie erneut die Konfiguration des Bacula-Quelltextes durch und w\"{a}hlen Sie dabei
-PostgreSQL anstelle von MySQL als Datenbank aus (Option --with-postgresql=PostgreSQL-Verzeichnis).
-\item Kompilieren und Installieren Sie Bacula.
-\item Stoppen Sie MySQL.
-\item Starten Sie PostgreSQL.
-\item Erstellen Sie den Datenbankbenutzer bacula mit dem weiter oben beschriebenen Kommandos.
-\item \"{U}berpr\"{u}fen Sie die Datei pg\_hba.conf daraufhin das der Benutzer bacula die entsprechenden
-Berechtigungen f\"{u}r den Datenbankzugriff besitzt. Wenn Ihr System entsprechend gesichert ist,
-k\"{o}nnte der Eintrag so aussehen:
-
-\footnotesize
-\begin{alltt}
-local all all trust
-
-host all all 127.0.0.1 255.255.255.255 trust
-
-Hinweis: PostgreSQL muss nach Anpassungen dieser Datei neu gestartet werden.
-
-\end{alltt}
-\normalsize
-
-\item Wechseln Sie in das Verzeichnis /etc/bacula und Initialisieren Sie die Katalogdatenbank
-mit diesen Kommandos:
-
-\footnotesize
-\begin{alltt}
-./create_postgresql_database
-
-./make_postgresql_tables
-
-./grant_postgresql_privileges
-
-\end{alltt}
-\normalsize
-
-\item \"{U}berpr\"{u}fen Sie, ob Sie die Berechtigung zum Datanbankzugriff haben:
-
- \footnotesize
-\begin{alltt}
-psql -Ubacula bacula
-\end{alltt}
-\normalsize
-
-Das sollte zu keinen Fehlern f\"{u}hren.
-
-\item Importieren Sie die Daten aus Ihrer MySQL-Datenbank mit:
-
- \footnotesize
-\begin{alltt}
-psql -Ubacula bacula <bacula-backup.dmp>
-\end{alltt}
-\normalsize
-
-\item Aktualisieren Sie die Datenbank-Tabellen mit folgenden Kommandos:
-
- \footnotesize
-\begin{alltt}
-psql -Ubacula bacula
-
-SELECT SETVAL('basefiles_baseid_seq', (SELECT
-MAX(baseid) FROM basefiles));
-SELECT SETVAL('client_clientid_seq', (SELECT
-MAX(clientid) FROM client));
-SELECT SETVAL('file_fileid_seq', (SELECT MAX(fileid)
-FROM file));
-SELECT SETVAL('filename_filenameid_seq', (SELECT
-MAX(filenameid) FROM filename));
-
-SELECT SETVAL('fileset_filesetid_seq', (SELECT
-MAX(filesetid) FROM fileset));
-
-SELECT SETVAL('job_jobid_seq', (SELECT MAX(jobid) FROM job));
-SELECT SETVAL('jobmedia_jobmediaid_seq', (SELECT
-MAX(jobmediaid) FROM jobmedia));
-SELECT SETVAL('media_mediaid_seq', (SELECT MAX(mediaid) FROM media));
-SELECT SETVAL('path_pathid_seq', (SELECT MAX(pathid) FROM path));
-
-SELECT SETVAL('pool_poolid_seq', (SELECT MAX(poolid) FROM pool));
-
-\end{alltt}
-\normalsize
-
-\item Starten Sie Bacula und \"{u}berpr\"{u}fen Sie den Datenbestand.
-F\"{u}hren Sie einen Backup-Job aus um zu sehen, ob alles erwartungsgem\"{a}{\ss} funktioniert.
-\end{enumerate}
-
-\section{PostgreSQL updaten}
-\index[general]{PostgreSQL updaten }
-\index[general]{updaten!PostgreSQL }
-\index[general]{Updaten}
-Wenn Sie PostgreSQL aktualisieren, m\"{u}ssen Sie Bacula
-neu kompilieren und installieren, andernfalls kann es zu
-Fehlern kommen. Auch nach der Aktualisierung der PostgreSQL-RPMs
-ist es notwendig Bacula neu zu bauen. Das k\"{o}nnen Sie einfach,
-mit den entsprechenden RPM-Kommandos, \"{u}ber das Bacula-Source-RPM
-ereichen. Eventuell m\"{u}ssen Sie aber vorher die bacula.spec
-anpassen, damit es mit der neuen PostgreSQL-Version funktioniert.
+++ /dev/null
-/*
- * html2latex
- */
-
-available {
- sun4_sunos.4
- sun4_solaris.2
- rs_aix.3
- rs_aix.4
- sgi_irix
-}
-
-description {
- From Jeffrey Schaefer, Geometry Center. Translates HTML document to LaTeX
-}
-
-install {
- bin/html2latex /afs/rpi.edu/dept/acs/rpinfo/filters/GChtml2latex/html2latex
- bin/html2latex.tag /afs/rpi.edu/dept/acs/rpinfo/filters/GChtml2latex/html2latex.tag
- bin/html2latex-local.tag /afs/rpi.edu/dept/acs/rpinfo/filters/GChtml2latex/html2latex-local.tag
- bin/webtex2latex.tag /afs/rpi.edu/dept/acs/rpinfo/filters/GChtml2latex/webtex2latex.tag
- man/man1/html2latex.1 /afs/rpi.edu/dept/acs/rpinfo/filters/GChtml2latex/html2latex.1
-}
+++ /dev/null
-%%
-%%
-
-\chapter{SQLite Installation und Konfiguration}
-\label{SqlLiteChapter}
-\index[general]{SQLite Installation und Konfiguration}
-\index[general]{SQLite!Installation und Konfiguration}
-
-Bitte beachten Sie, dass SQLite, in Version 2 und 3, beide nicht
-netzwerkf\"{a}hig sind. Das bedeutet, dass SQLite auf dem selben System
-installiert sein muss wie der Bacula-Director-Dienst. Es ist kein Zugriff
-\"{u}ber das Netzwerk, wie bei MySQL und PostgreSQL, m\"{o}glich. Daraus
-ergeben sich diese Konsequenzen:
-\begin{enumerate}
-\item SQLite kann nicht mit der Web-GUI {\bf bweb} benutzt werden.
-\item Wenn SQLite auf einer anderen Maschine als Ihr Storage-Dienst
-l\"{a}uft, m\"{u}ssen Sie die Datenbank auf das System des Storage-Dienstes
-kopieren, bevor Sie die SD-Hilfsprogramme wie bscan usw. benutzen k\"{o}nnen.
-\end{enumerate}
-
-\section{SQLite Installation und Konfiguration -- Phase I}
-\index[general]{Phase I!SQLite Installation und Konfiguration -- }
-\index[general]{SQLite Installation und Konfiguration -- Phase I }
-
-Wenn Sie den Bacula-Quelltext mit {\bf ./configure \verb:--:with-sqlite}
-konfigurieren, m\"{u}ssen Sie SQLite in Version 2.8.16 oder neuer installiert
-haben. Diese SQLite-Version finden Sie in dem "`Dependency-Package"' unter
-{\bf depkgs/sqlite-<Version>}. Wenn neuere Version von SQLite verf\"{u}gbar sind,
-wird auch dieses Paket aktualisiert.
-
-Die Installation und Konfiguration ist sehr einfach:
-
-\begin{enumerate}
-\item downloaden Sie das Bacula-Dependency-Package.
-\item entpacken Sie es mit einem Kommando wie:
-
- {\bf tar xvfz depkgs.tar.gz}
-
- Dieses Kommando ben\"{o}tigt das GNU tar Programm,
- ansonsten wird:
-
- {\bf zcat depkgs.tar.gz | tar xvf -}
-
- zum gleichen Ziel f\"{u}hren.
-
-\item {\bf cd depkgs}
-
-\item f\"{u}r SQLite2: {\bf make sqlite}
-
-\item oder f\"{u}r SQLite3: {\bf make sqlite3}
-
-\end{enumerate}
-
-Je nachdem welche Version Sie installiert haben, SQLite oder SQLite3, m\"{u}ssen Sie
-Bacule entsprechend mit {\bf \verb:--:with-sqlite} oder {\bf \verb:--:with-sqlite3}
-konfigurieren. Die Version 2 von SQLite k\"{o}nnen Sie nicht zusammen mit der
-Bacula-Konfigurations-Option {\bf \verb:--:enable-batch-insert} verwenden, da die Version 2
-nicht thread-safe ist. Mit SQLite3 k\"{o}nnen Sie diese Option nur verwenden, wenn Sie
-SQLite3 mit {\bf \verb:--:enable-threadsafe} und {\bf \verb:--:enable-cross-thread-connections}
-konfiguriert und kompiliert haben.
-
-Standardm\"{a}{\ss}ig l\"{a}uft SQLite3 mit {\bf PRAGMA synchronous=OFF}.
-Das erh\"{o}ht zwar die Geschwindigkeit um bis zu das 30-fache, hat aber den
-Nachteil, dass Ihre Datenbank leichter besch\"{a}digt wird, falls Ihre
-Maschine, etwa durch Stromausfall oder einen Kernel-Bug, stehen bleibt.
-Falls Sie auf die h\"{o}here Geschwindigkeit zugunsten der Sicherheit
-verzichten wollen, k\"{o}nnen Sie PRAGMA in der Datei src/version.h
-entsprechend anpassen.
-
-An dieser Stelle sollten Sie mit der Installation von Bacula
-fortfahren.
-
-\section{SQLite Installation und Konfiguration -- Phase II}
-\label{sqlite_phase2}
-\index[general]{Phase II!SQLite Installation und Konfiguration -- }
-\index[general]{SQLite Installation und Konfiguration -- Phase II }
-
-Die Phase II wird durchgef\"{u}hrt, nachdem Bacula installiert wurde.
-
-Bei der Installation von Bacula werden mehrere Scripte in das
-Installations-Verzeichnis kopiert, mit denen Sie verschiedene
-\"{A}nderungen an der Datenbank durchf\"{u}hren k\"{o}nnen.
-Diese Scripte haben Namen im Format *\_bacula\_*
-(z.B. create\_bacula\_database)und dienen dazu die Datenbank
-zu initialisieren, zu aktualisieren oder zu l\"{o}schen.
-Diese Scripte sind auch im Bacula-Quelltext-Verzeichnis, nach
-der Ausf\"{u}hrung des "`./configure"'-Scripts, unter
-\lt{}bacula-src\gt{}/src/cats zu finden. Wenn Sie sich, zum
-Beispiel, das Script create\_bacula\_database n\"{a}her ansehen
-werden Sie merken, dass dieses Script einfach nur
-create\_mysql\_database ausf\"{u}hrt. Alle Scripte die *\_bacula\_*
-heissen, dienen nur der Bequemlichkeit. Es spielt keine Rolle
-mit welcher Datenbank Sie den Bacula-Quelltext \"{u}bersetzt haben,
-das Script create\_bacula\_database wird immer die f\"{u}r Sie
-richtige Datenbank erstellen.
-
-Jetzt k\"{o}nnen die Datenbank und die Tabellen erstellt werden:
-
-\begin{enumerate}
-\item cd \lt{}Bacula-Installations-Verzeichnis\gt{}
- In diesem Verzeichnis finden Sie die Bacula-Datenbank-Scripte.
-
-\item ./make\_sqlite\_tables
-
- Dieses Script erzeugt sowohl die Datenbank als auch die Tabellen
- die Bacula benutzt. Standardm\"{a}{\ss}ig wird die Datenbank als
- {\bf bacula.db} im Arbeitsverzeichnis von Bacula erstellt.
-\end{enumerate}
-
-\section{Bacula mit SQLite linken}
-\index[general]{SQLite!Bacula linken mit}
-\index[general]{Bacula mit SQLite linken}
-
-Wenn Sie alle Schritte bis hierhin befolgt haben, passiert das
-Linken der SQLite-Bibliotheken mit Bacula automatisch.
-
-\section{SQLite Tests}
-\index[general]{SQLite!Tests }
-\index[general]{SQLite Tests }
-
-Da SQLite eigentlich nicht in Produktionsumgebungen eingestzt wird,
-gibt es viel weniger Anwender und Erfahrungen als z.B. bei MySQL.
-Als "`Hilfsdatenbank"' die w\"{a}hrend der Entwicklung eingesetzt wird,
-funktioniert SQLite allerdings sehr gut. Trotzdem wird immer wieder von
-Benutzer gemeldet, dass sie Probleme mit ihrer SQLite-Datenbank haben.
-Aus diesem Grund wird davon abgeraten, SQLite in Produktionsumgebungen
-einzusetzen.
-
-Falls Bacula beim Start mit dem folgenden Fehler abbricht:
-
-\footnotesize
-\begin{alltt}
-Using default Catalog name=MyCatalog DB=bacula
-Could not open database "bacula".
-sqlite.c:151 Unable to open Database=/var/lib/bacula/bacula.db.
-ERR=malformed database schema - unable to open a temporary database file
-for storing temporary tables
-\end{alltt}
-\normalsize
-
-liegt es meistens daran, dass SQLite versucht, die Datenbank-Datei
-im aktuellen Verzeichnis zu erstellen. Falls das fehlschl\"{a}gt,
-weil Bacula keine Schreibrechte f\"{u}r dieses Verzeichnis besitzt,
-kommt es zu diesem Fehler. Als Abhilfe sollten Sie Bacula in einem
-Verzeichnis starten wo es Schreibrechte besitzt.
-
-\section{Re-Initialisierung der Katalog-Datenbank}
-\index[general]{Datenbank!Re-Initialisierung der Katalog- }
-\index[general]{Re-Initialisierung der Katalog-Datenbank }
-
-Nachdem Sie einige anf\"{a}ngliche Tests mit Bacula gemacht haben, wollen
-Sie eventuell Ihre Katalog-Datenbank komplett leeren, um alle gelaufenen
-Test-Backups aus der Datenbank zu entfernen. Um das zu erreichen,
-tun Sie folgendes:
-
-\footnotesize
-\begin{alltt}
- cd <install-directory>
- ./drop_bacula_tables
- ./make_bacula_tables
-\end{alltt}
-\normalsize
-
-Bitte bedenken Sie, dass dabei alle Informationen unwiderruflich
-aus der Datenbank gel\"{o}scht werden. Falls Sie auch beschriebene
-Volumes wiederverwenden wollen, m\"{u}ssen Sie das Volume-Label
-\"{u}berschreiben damit Bacula sie erneut benutzen kann.
-Das erreichen Sie durch:
-
-\footnotesize
-\begin{alltt}
- (stop Bacula or unmount the drive)
- mt -f /dev/nst0 rewind
- mt -f /dev/nst0 weof
-\end{alltt}
-\normalsize
-
-hierbei m\"{u}ssen Sie {\bf /dev/nst0} durch das Device ersetzen,
-dem Ihr Tapelaufwerk entspricht.
+++ /dev/null
-#!/usr/bin/perl -w
-#
-use strict;
-
-# Used to change the names of the image files generated by latex2html from imgxx.png
-# to meaningful names. Provision is made to go either from or to the meaningful names.
-# The meaningful names are obtained from a file called imagename_translations, which
-# is generated by extensions to latex2html in the make_image_file subroutine in
-# bacula.perl.
-
-# Opens the file imagename_translations and reads the contents into a hash.
-# The hash is creaed with the imgxx.png files as the key if processing TO
-# meaningful filenames, and with the meaningful filenames as the key if
-# processing FROM meaningful filenames.
-# Then opens the html file(s) indicated in the command-line arguments and
-# changes all image references according to the translations described in the
-# above file. Finally, it renames the image files.
-#
-# Original creation: 3-27-05 by Karl Cunningham.
-# Modified 5-21-05 to go FROM and TO meaningful filenames.
-#
-my $TRANSFILE = "imagename_translations";
-my $path;
-
-# Loads the contents of $TRANSFILE file into the hash referenced in the first
-# argument. The hash is loaded to translate old to new if $direction is 0,
-# otherwise it is loaded to translate new to old. In this context, the
-# 'old' filename is the meaningful name, and the 'new' filename is the
-# imgxx.png filename. It is assumed that the old image is the one that
-# latex2html has used as the source to create the imgxx.png filename.
-# The filename extension is taken from the file
-sub read_transfile {
- my ($trans,$direction) = @_;
-
- if (!open IN,"<$path$TRANSFILE") {
- print "WARNING: Cannot open image translation file $path$TRANSFILE for reading\n";
- print " Image filename translation aborted\n\n";
- exit 0;
- }
-
- while (<IN>) {
- chomp;
- my ($new,$old) = split(/\001/);
-
- # Old filenames will usually have a leading ./ which we don't need.
- $old =~ s/^\.\///;
-
- # The filename extension of the old filename must be made to match
- # the new filename because it indicates the encoding format of the image.
- my ($ext) = $new =~ /(\.[^\.]*)$/;
- $old =~ s/\.[^\.]*$/$ext/;
- if ($direction == 0) {
- $trans->{$new} = $old;
- } else {
- $trans->{$old} = $new;
- }
- }
- close IN;
-}
-
-# Translates the image names in the file given as the first argument, according to
-# the translations in the hash that is given as the second argument.
-# The file contents are read in entirely into a string, the string is processed, and
-# the file contents are then written. No particular care is taken to ensure that the
-# file is not lost if a system failure occurs at an inopportune time. It is assumed
-# that the html files being processed here can be recreated on demand.
-#
-# Links to other files are added to the %filelist for processing. That way,
-# all linked files will be processed (assuming they are local).
-sub translate_html {
- my ($filename,$trans,$filelist) = @_;
- my ($contents,$out,$this,$img,$dest);
- my $cnt = 0;
-
- # If the filename is an external link ignore it. And drop any file:// from
- # the filename.
- $filename =~ /^(http|ftp|mailto)\:/ and return 0;
- $filename =~ s/^file\:\/\///;
- # Load the contents of the html file.
- if (!open IF,"<$path$filename") {
- print "WARNING: Cannot open $path$filename for reading\n";
- print " Image Filename Translation aborted\n\n";
- exit 0;
- }
-
- while (<IF>) {
- $contents .= $_;
- }
- close IF;
-
- # Now do the translation...
- # First, search for an image filename.
- while ($contents =~ /\<\s*IMG[^\>]*SRC=\"/si) {
- $contents = $';
- $out .= $` . $&;
-
- # The next thing is an image name. Get it and translate it.
- $contents =~ /^(.*?)\"/s;
- $contents = $';
- $this = $&;
- $img = $1;
- # If the image is in our list of ones to be translated, do it
- # and feed the result to the output.
- $cnt += $this =~ s/$img/$trans->{$img}/ if (defined($trans->{$img}));
- $out .= $this;
- }
- $out .= $contents;
-
- # Now send the translated text to the html file, overwriting what's there.
- open OF,">$path$filename" or die "Cannot open $path$filename for writing\n";
- print OF $out;
- close OF;
-
- # Now look for any links to other files and add them to the list of files to do.
- while ($out =~ /\<\s*A[^\>]*HREF=\"(.*?)\"/si) {
- $out = $';
- $dest = $1;
- # Drop an # and anything after it.
- $dest =~ s/\#.*//;
- $filelist->{$dest} = '' if $dest;
- }
- return $cnt;
-}
-
-# REnames the image files spefified in the %translate hash.
-sub rename_images {
- my $translate = shift;
- my ($response);
-
- foreach (keys(%$translate)) {
- if (! $translate->{$_}) {
- print " WARNING: No destination Filename for $_\n";
- } else {
- $response = `mv -f $path$_ $path$translate->{$_} 2>&1`;
- $response and print "ERROR from system $response\n";
- }
- }
-}
-
-#################################################
-############# MAIN #############################
-################################################
-
-# %filelist starts out with keys from the @ARGV list. As files are processed,
-# any links to other files are added to the %filelist. A hash of processed
-# files is kept so we don't do any twice.
-
-# The first argument must be either --to_meaningful_names or --from_meaningful_names
-
-my (%translate,$search_regex,%filelist,%completed,$thisfile);
-my ($cnt,$direction);
-
-my $arg0 = shift(@ARGV);
-$arg0 =~ /^(--to_meaningful_names|--from_meaningful_names)$/ or
- die "ERROR: First argument must be either \'--to_meaningful_names\' or \'--from_meaningful_names\'\n";
-
-$direction = ($arg0 eq '--to_meaningful_names') ? 0 : 1;
-
-(@ARGV) or die "ERROR: Filename(s) to process must be given as arguments\n";
-
-# Use the first argument to get the path to the file of translations.
-my $tmp = $ARGV[0];
-($path) = $tmp =~ /(.*\/)/;
-$path = '' unless $path;
-
-read_transfile(\%translate,$direction);
-
-foreach (@ARGV) {
- # Strip the path from the filename, and use it later on.
- if (s/(.*\/)//) {
- $path = $1;
- } else {
- $path = '';
- }
- $filelist{$_} = '';
-
- while ($thisfile = (keys(%filelist))[0]) {
- $cnt += translate_html($thisfile,\%translate,\%filelist) if (!exists($completed{$thisfile}));
- delete($filelist{$thisfile});
- $completed{$thisfile} = '';
- }
- print "translate_images.pl: $cnt image filenames translated ",($direction)?"from":"to"," meaningful names\n";
-}
-
-rename_images(\%translate);
+++ /dev/null
-#
-#
-# Makefile for LaTeX
-#
-# To build everything do
-# make tex
-# make web
-# make html
-# make dvipdf
-#
-# or simply
-#
-# make
-#
-# for rapid development do:
-# make tex
-# make show
-#
-#
-# If you are having problems getting "make" to work, debugging it is
-# easier if can see the output from latex, which is normally redirected
-# to /dev/null. To see it, do the following:
-#
-# cd docs/manual
-# make tex
-# latex bacula.tex
-#
-# typically the latex command will stop indicating the error (e.g. a
-# missing \ in front of a _ or a missing { or ] ...
-#
-# The following characters must be preceded by a backslash
-# to be entered as printable characters:
-#
-# # $ % & ~ _ ^ \ { }
-#
-
-IMAGES=../../../images
-
-DOC=concepts
-
-first_rule: all
-
-all: tex web dvipdf mini-clean
-
-.SUFFIXES: .tex .html
-.PHONY:
-.DONTCARE:
-
-
-tex:
- @./update_version
- @echo "Making version `cat version.tex`"
- @cp -fp ${IMAGES}/hires/*.eps .
- @touch ${DOC}i-dir.tex ${DOC}i-fd.tex ${DOC}i-sd.tex \
- ${DOC}i-console.tex ${DOC}i-general.tex
- latex -interaction=batchmode ${DOC}.tex
- makeindex ${DOC}.idx -o ${DOC}.ind 2>/dev/null
- makeindex ${DOC}.ddx -o ${DOC}.dnd >/dev/null 2>/dev/null
- makeindex ${DOC}.fdx -o ${DOC}.fnd >/dev/null 2>/dev/null
- makeindex ${DOC}.sdx -o ${DOC}.snd >/dev/null 2>/dev/null
- makeindex ${DOC}.cdx -o ${DOC}.cnd >/dev/null 2>/dev/null
- latex -interaction=batchmode ${DOC}.tex
-
-pdf:
- @echo "Making pdfm"
- @cp -fp ${IMAGES}/hires/*.eps .
- dvipdfm -p a4 ${DOC}.dvi
-
-dvipdf:
- @echo "Making dvi to pdf"
- @cp -fp ${IMAGES}/hires/*.eps .
- dvipdf ${DOC}.dvi ${DOC}.pdf
-
-html:
- @echo " "
- @echo "Making html"
- @cp -fp ${IMAGES}/*.eps .
- @rm -f next.eps next.png prev.eps prev.png up.eps up.png
- @(if [ -f imagename_translations ] ; then \
- ./translate_images.pl --from_meaningful_names ${DOC}.html; \
- fi)
- latex2html -white -no_subdir -split 0 -toc_stars -white \
- -init_file latex2html-init.pl ${DOC} >tex.out 2>&1
- ./translate_images.pl --to_meaningful_names ${DOC}.html
- @echo "Done making html"
-
-web:
- @echo "Making web"
- @mkdir -p ${DOC}
- @cp -fp ${IMAGES}/*.eps .
- @rm -f next.eps next.png prev.eps prev.png up.eps up.png
- @cp -fp ${IMAGES}/*.eps ${DOC}/
- @cp -fp ${IMAGES}/*.eps ${IMAGES}/*.png ${DOC}/
- @rm -f ${DOC}/xp-*.png
- @rm -f ${DOC}/next.eps ${DOC}/next.png ${DOC}/prev.eps ${DOC}/prev.png ${DOC}/up.eps ${DOC}/up.png
- @rm -rf ${DOC}/*.html
- latex2html -split 3 -local_icons -t "Bacula Concepts and Overview Guide" -long_titles 4 \
- -toc_stars -contents_in_nav -init_file latex2html-init.pl -white ${DOC} >tex.out 2>&1
- ./translate_images.pl --to_meaningful_names ${DOC}/Bacula_Concep_Overvi_Guide.html
- @echo "Done making web"
-show:
- xdvi ${DOC}
-
-texcheck:
- ./check_tex.pl ${DOC}.tex
-
-main_configs:
- pic2graph -density 100 <main_configs.pic >main_configs.png
-
-mini-clean:
- @rm -f 1 2 3 *.tex~
- @rm -f *.gif *.jpg *.eps
- @rm -f *.aux *.cp *.fn *.ky *.log *.pg
- @rm -f *.backup *.ilg *.lof *.lot
- @rm -f *.cdx *.cnd *.ddx *.ddn *.fdx *.fnd *.ind *.sdx *.snd
- @rm -f *.dnd *.old *.out
- @rm -f ${DOC}/*.gif ${DOC}/*.jpg ${DOC}/*.eps
- @rm -f ${DOC}/*.aux ${DOC}/*.cp ${DOC}/*.fn ${DOC}/*.ky ${DOC}/*.log ${DOC}/*.pg
- @rm -f ${DOC}/*.backup ${DOC}/*.ilg ${DOC}/*.lof ${DOC}/*.lot
- @rm -f ${DOC}/*.cdx ${DOC}/*.cnd ${DOC}/*.ddx ${DOC}/*.ddn ${DOC}/*.fdx ${DOC}/*.fnd ${DOC}/*.ind ${DOC}/*.sdx ${DOC}/*.snd
- @rm -f ${DOC}/*.dnd ${DOC}/*.old ${DOC}/*.out
- @rm -f ${DOC}/WARNINGS
-
-
-clean:
- @rm -f 1 2 3 *.tex~
- @rm -f *.png *.gif *.jpg *.eps
- @rm -f *.pdf *.aux *.cp *.fn *.ky *.log *.pg
- @rm -f *.html *.backup *.ps *.dvi *.ilg *.lof *.lot
- @rm -f *.cdx *.cnd *.ddx *.ddn *.fdx *.fnd *.ind *.sdx *.snd
- @rm -f *.dnd imagename_translations
- @rm -f *.old WARNINGS *.out *.toc *.idx
- @rm -f ${DOC}i-*.tex
- @rm -rf ${DOC}
-
-
-distclean: clean
- @rm -f images.pl labels.pl internals.pl
- @rm -f Makefile version.tex
+++ /dev/null
-TODO
-
-maybe spell out "config" to "configuration" as appropriate
-
-Use American versus British spelling
-
-not critical, but for later consider cleaning out some use of
-"there" and rewrite to not be so passive.
-
-make sure use of \elink shows URL in printed book
-
-get rid of many references of "Red Hat" -- too platform specific?
-
-remove references to names, like "Dan Langille shared ..."
-just put their names in credits for book
-
-don't refer to very old software by specific version such as
-"Red Hat 7" or FreeBSD 4.9 because is too old to put in book. It may be
-relevant, but may be confusing. Maybe just remove the version number
-if applicable.
-
-maybe fine, but discuss point-of-view: don't use personal "I" or
-possessive "my" unless that is consistent style for book.
-
-replace "32 bit" and "64 bit" with "32-bit" and "64-bit" respectively.
-It seems like more popular style standard
-
-be consistent with "Note" and "NOTE". maybe use tex header for this
-
-get rid of redundant or noisy exclamation marks
-
-style for "ctl-alt-del" and "ctl-d"? and be consisten with formatting
-
-be consistent for case for ext3, ext2, EXT3, or EXT2.
-
-fix spelling of "inspite" in source and in docs (maybe use "regardless
-in one place where I already changed to "in spite"
-
-be consistent with software names, like postgres, postgresql, PostreSQL
-and others
-
-instead of using whitehouse for examples, use example.org (as that is defined
-for that usage); also check other hostnames and maybe IPs and networks
-
-use section numbers and cross reference by section number or page number
-no underlining in book (this is not the web :)
-
-some big gaps between paragraphs or between section headers and paragraphs
--- due to tex -- adjust as necessary to look nice
-
-don't include the GPL and LGPL in book. This will save 19 (A4) pages.
-For 6x9 book this will save 30 pages. (Keep GFDL though.)
-
-many index items are too long
-
-appendices not listed as appendix
-
-some how consolidate indexes into one? on 6x9, the indexes are over 30 pages
-
-don't refer to some website without including URL also
-(such as "this FreeBSD Diary article")
-
-get rid of (R) trademark symbols -- only use on first use; for example
-don't put on the RPM Packaging FAQ
-
-split up very long paragraphs, such as "As mentioned above, you will need ..."
-(on my page 783).
-
-use smaller font or split up long lines (especially from
-console output which is wider than printed page)
-
-don't assume all BSD is "FreeBSD"
-
-don't assume all "kernel" is Linux. If it is Linux, be clear.
-
-
+++ /dev/null
-
-\chapter{ANSI und IBM Tape Labels}
-\label{AnsiLabelsChapter}
-\index[general]{ANSI und IBM Tape Labels}
-\index[general]{Labels!Tape}
-
-Wenn Bacula entsprechend konfiguriert wird, unterst\"{u}tzt es ANSI und IBM Tape Labels.
-Mit der richtigen Konfiguration, kann man Bacula sogar zwingen,
-nur noch ANSI oder IBM Labels zu verwenden.
-
-Bacula kann ein ANSI oder IBM Tape Label erstellen, aber wenn Check Labels
-konfiguriert ist (siehe unten), wird Bacula versuchen ein existierendes Tape Label zu finden,
-und dieses dann verwenden.
-Sie k\"{o}nnen die Tape Labels also mit anderen Programmen erstellen
-und Bacula wird diese Labels erkennen und damit arbeiten.
-
-Obwohl Bacula ANSI und IBM Tape Labels erkennen und auch schreiben kann,
-wird es immer auch ein eigenes Tape Label erzeugen.
-
-Wenn ANSI oder IBM Tape Labels verwenden werden,
-d\"{u}rfen die Volume Namen nicht mehr als 6 Zeichen beinhalten.
-
-Wenn Sie Ihre Volumes nicht mit Bacula gelabelt haben, dann wird
-das ANSI oder IBM Tape Label nur von Bacula erkannt, wenn Sie das
-HDR1 Label mit {\bf BACULA.DATA} im Dateinamen (beginnend mit
-dem 5. Zeichen) erzeugt haben. Wenn Bacula das Tape Label schreibt,
-werden diese Informationen genutzt um das Tape als Bacula Tape zu erkennen.
-Dieses erm\"{o}glicht Tapes mit ANSI oder IBM Labels mit unterschiedlichen Backupprogrammen zu benutzen.
-
-
-\section{Director Pool Konfiguration}
-
-\begin{description}
-\item [ Label Type = ANSI | IBM | Bacula]
- Diese Direktive ist in der Director Pool und in der SD Device Konfiguration g\"{u}ltig.
- Wenn sie in der SD Device Konfiguration angegeben wird, hat sie Vorrang vor dem,
- was der Director dem SD \"{u}bergibt.
- Der Standardwert ist Label Type = Bacula.
-\end{description}
-
-\section{Storage Daemon Device Konfiguration}
-
-\begin{description}
-\item [ Label Type = ANSI | IBM | Bacula]
- Diese Direktive ist in der Director Pool und in der SD Device Konfiguration g\"{u}ltig.
- Wenn sie in der SD Device Konfiguration angegeben wird, hat sie Vorrang vor dem,
- was der Director dem SD \"{u}bergibt.
- Der Standardwert ist Label Type = Bacula.
-
-\item [Check Labels = yes | no]
- Diese Direktive ist in der SD Device Konfiguration g\"{u}ltig.
- Wenn Sie beabsichtigen, ANSI oder IBM Tape Labels zu lesen, *muss*
- sie auf yes gesetzt sein. Auch wenn das Volume kein ANSI oder IBM Label hat,
- kann diese Direktive auf yes gesetzt werden,
- Bacula wird dann den Typ des Tape Labels automatisch \"{u}berpr\"{u}fen.
- Wird sie nicht auf yes gesetzt, wird Bacula annehmen, dass das Volume
- mit einem Bacula Tape Label versehen ist,
- eine \"{U}berpr\"{u}fung auf ANSI oder IBM Tape Labels finden dann nicht statt.
- Der Standardwert ist Check Labels = no.
- \end{description}
+++ /dev/null
-\subsection*{Autochanger-Konfiguration}
-\label{AutochangerRes}
-\index[sd]{Autochanger-Konfiguration }
-\index[sd]{Konfiguration!Autochanger }
-\addcontentsline{toc}{subsection}{Autochanger-Konfiguration}
-
-In der Autochanger-Konfiguration k\"{o}nnen Autochanger mit einzelnen oder mehreren Laufwerken angelegt werden,
-indem eine oder mehrere Ger\"{a}tekonfigurationen zu einer Einheit, die Bacula Autochanger nennt,
-gruppiert werden. (Autochangerherrsteller nennen so etwas auch "`Tape Library"')
-
-Damit Ihr Autochanger korrekt funktioniert,
-{\bf m\"{u}ssen} Sie eine Autochanger-Konfiguration in der Konfigurationsdatei
-des Storage-Dienstes erstellen und in der Konfiguration des Director-Dienstes
-{\bf muss} ein entsprechender Storage-Eintrag auf den Autochanger-Namen
-in der Storage-Dienst-Konfiguration verweisen.
-In fr\"{u}heren Bacula-Versionen verwies die Autochanger-Konfiguration des
-Director-Dienstes direkt auf Ger\"{a}te-Konfigurationen des Storage-Dienstes.
-Seit Version 1.38.0 ist es nicht mehr m\"{o}glich, aus einer Autochanger-Konfiguration des Director-Dienstes,
-direkt auf die Autochanger-Ger\"{a}te zu verweisen.
-
-\begin{description}
-\item [Name = \lt{}Autochanger-Name\gt{}]
- \index[sd]{Name}
- die Angabe des Autochanger-Namens. Dieser Name wird in der Director-Storage-Definition benutzt um auf den
- Autochanger zu verweisen.
- Die Konfiguration des Namens ist zwingend erforderlich.
-
-\item [Device = \lt{}Device-name1, device-name2, ...\gt{}]
- die Angabe eines oder mehrerer Ger\"{a}te-Namen, die den Device-Eintr\"{a}gen der Laufwerke
- des Autochangers entsprechen.
- Wenn Ihr Autochanger mehrere Laufwerke hat, m\"{u}ssen Sie auch mehrere Ger\"{a}te-Namen angeben,
- jeweils einen f\"{u}r jede Ger\"{a}te-Konfiguration, die einem Laufwerk des Autochangers entspricht.
- Sie k\"{o}nnen mehrere Ger\"{a}te-Namen durch Kommas getrennt in einer Zeile,
- oder mehrere Device-Eintr\"{a}ge angeben.
- Die Konfiguration der Ger\"{a}te-Namen ist zwingend erforderlich.
-
-\item [Changer Device = {\it Bezeichner}]
- \index[sd]{Changer Device}
- der angegebene {\bf Bezeichner} entspricht dem Ger\"{a}te-Namen des Autochangers (nicht der Laufwerke)
- der durch das Betriebssystem vergeben wird.
- Wenn der Ger\"{a}te-Name hier konfiguriert wird, braucht er nicht mehr in den Device-Eintr\"{a}gen der Laufwerke
- angegeben werden.
- Wenn der Ger\"{a}te-Name auch in den Device-Eintr\"{a}gen angegeben wird,
- hat der dortige Eintrag Vorrang vor der Angabe in der Autochanger-Konfiguration.
-
-\item [Changer Command = {\it Bezeichner}]
- \index[sd]{Changer Command }
- der angegebene {\bf Bezeichner} gibt das zu verwendende externe Programm an,
- dass Bacula aufruft, um automatisch Volumes zu wechseln. Meistens wird hier
- das mit Bacula zur Verf\"{u}gung gestellte {\bf mtx-changer} angegeben.
- Wenn der Kommando-Name hier konfiguriert wird, braucht er nicht mehr in den Device-Eintr\"{a}gen der Laufwerke
- angegeben werden.
- Wenn der Kommando-Name auch in den Device-Eintr\"{a}gen angegeben wird,
- hat der dortige Eintrag Vorrang vor der Angabe in der Autochanger-Konfiguration.
-\end{description}
-
-Das Folgende ist ein Beispiel einer g\"{u}ltigen Autochanger-Konfiguration:
-
-\footnotesize
-\begin{verbatim}
-Autochanger {
- Name = "DDS-4-changer"
- Device = DDS-4-1, DDS-4-2, DDS-4-3
- Changer Device = /dev/sg0
- Changer Command = "/etc/bacula/mtx-changer %c %o %S %a %d"
-}
-Device {
- Name = "DDS-4-1"
- Drive Index = 0
- Autochanger = yes
- ...
-}
-Device {
- Name = "DDS-4-2"
- Drive Index = 1
- Autochanger = yes
- ...
-Device {
- Name = "DDS-4-3"
- Drive Index = 2
- Autochanger = yes
- Autoselect = no
- ...
-}
-\end{verbatim}
-\normalsize
-
-Bitte beachten Sie dass es wichtig ist, dass {\bf Autochanger = yes} in allen Device-Eintr\"{a}gen
-angegeben wird die zum Autochanger geh\"{o}ren.
-Ein Device-Eintrag darf nie zu mehr als einem Autochanger geh\"{o}ren.
-Au{\ss}erdem darf die Storage-Konfiguration des Director-Dienstes nur auf die Autochanger-Konfiguration
-zeigen und nicht auf die Device-Eintr\"{a}ge.
-
-Wenn Sie ein Laufwerk des Autochangers nicht automatisch durch Bacula benutzen lassen wollen,
-z.B. um immer ein freies Laufwerk f\"{u}r R\"{u}cksicherungen zu haben,
-k\"{o}nnen Sie folgendes dem entsprechenden Device-Eintrag hinzuf\"{u}gen:
-
-\footnotesize
-\begin{verbatim}
-Autoselect = no
-\end{verbatim}
-\normalsize
-
-In diesem Fall wird Bacula das Laufwerk nicht mehr automatisch ausw\"{a}hlen, wenn es auf den Autochanger zugreift.
-Sie k\"{o}nnen das Laufwerk weiterhin benutzen, indem Sie direkt den Device-Namen ansprechen,
-anstatt des Autochangers.
-Ein Beispiel einer solchen Konfiguration sehen Sie oben bei dem Device-Eintrag DDS-4-3.
-Diese Laufwerk wird nicht benutzt werden, wenn der Autochanger-Name DDS-4-changer als Storage-Definition
-genutzt wird, es l\"{a}sst sich aber direkt, mit entsprechenden Storage-Konfigurations-Eintrag im Director-Dienst,
-als Storage DDS-4-3 ansprechen.
+++ /dev/null
-%%
-%%
-
-\chapter{Autochanger Unterst\"{u}tzung}
-\label{AutochangersChapter}
-\index[general]{Unterst\"{u}tzung!Autochanger }
-\index[general]{Autochanger Unterst\"{u}tzung }
-
-Bacula unterst\"{u}tzt Autochanger zum Lesen und Schreiben von Tapes.
-Damit Bacula mit einem Autochanger arbeiten kann, m\"{u}ssen einige Voraussetzungen erf\"{u}llt sein,
-die Details werden im folgenden gekl\"{a}rt.
-
-\begin{itemize}
-\item Ein Script das den Autochanger, gem\"{a}{\ss} den von Bacula gesendeten Kommandos, steuert.
- Bacula stellt solch ein Script in der {\bf depkgs} Distribution zur Verf\"{u}gung.
-
-\item Jedes Volume (Tape) das benutzt wird, muss sowohl im Katalog definiert sein,
- als auch eine Slotnummer zugeteilt sein, nur so kann Bacula wissen, welches Volume
- aktuell im Autochanger verf\"{u}gbar ist.
- Normalerweise wird das mittels des {\bf label} Kommandos erreicht,
- weiter unten wird genauer darauf eingegangen.
- Volumes m\"{u}ssen manuell gelabelt werden, bevor sie benutzt werden k\"{o}nnen.
-
-\item Die Konfigurationsdateien des Storage-Dienstes m\"{u}ssen angepasst werden,
- damit Device-Eintr\"{a}ge Autochangern zugeordnet werden k\"{o}nnen,
- sowie einige Parameter mehr.
-
-\item Sie sollten auch die Storage-Definitionen in der Director-Dienst-Konfiguration anpassen,
- so dass automatisch nachgefragt wird, welcher Slot genutzt werden soll, wenn ein Volume gelabelt wird.
-
-\item Sie m\"{u}ssen sicherstellen, dass der Storage-Dienst (wenn er nicht als root ausgef\"{u}hrt wird)
- Zugriffsrechte auf die Laufwerks- und auf das Autochanger-Kontroll-Device hat.
-
-\item Sie m\"{u}ssen {\bf Autochanger = yes} in der Storage-Definitionen des Director-Dienstes setzen,
- damit nach dem Slot gefragt wird wenn Sie Volumes labeln.
-\end{itemize}
-
-In Version 1.37 und sp\"{a}ter, gibt es eine neue \ilink{Autochanger-Konfiguration}{AutochangerRes}
-die erlaubt, bestimmte Device-Eintr\"{a}ge zu gruppieren um einen Autochanger mit mehreren Laufwerken
-zu konfigurieren. Diese Konfiguration m\"{u}ssen Sie benutzen, wenn Sie einen Autochanger verwenden wollen.
-
-Bacula benutzt sein eigenes {\bf mtx-changer} Script als Interface zu dem Programm,
-dass die Steuerung des Autochangers \"{u}bernimmt. {\bf mtx-changer} kann im Prinzip so angepasst werden,
-dass es mit jedem Steuerungsprogramm f\"{u}r beliebige Autochanger funktioniert.
-Die derzeitige Version von {\bf mtx-changer} arbeitet mit {\bf mtx}.
-FreeBSD-Benutzer haben ein Script zur Verf\"{u}gung gestellt (im Verzeichnis {\bf examples/autochangers}),
-dass Bacula {\bf chio} benutzen l\"{a}sst.
-
-Bacula unterst\"{u}tzt Autochanger mir Barcode-Lesern,
-dieses beinhaltet zwei Consolen-Kommandos: {\bf label barcodes} und {\bf update slots}.
-Im Abschnitt "`Barcode Unterst\"{u}tzung"' (siehe unten) erfolgt eine detaillierte Beschreibung dieser Kommandos.
-
-Momentan beinhaltet die Autochanger-Unterst\"{u}tzung keine Stacker und Silos,
-und auch keine Laufwerks-Reinigung (Cleaning). Stacker und Silos werden nicht unterst\"{u}tzt,
-da sie keinen wahlfreien Zugriff auf ihre Slots erlauben.
-Unter Umst\"{a}nden schaffen Sie es vielleicht, einen Stacker (GravityFeed o. \"{a}.)
-mit Bacula zum laufen zu bringen, indem Sie Ihre Konfiguration soweit anpassen, dass auf
-den Autochanger nur sequentiell zugegriffen wird.
-Die Unterst\"{u}tzung f\"{u}r Autochanger mit mehreren Laufwerken erfordert eine
-Konfiguration wie in \ilink{Autochanger resource}{AutochangerRes} beschrieben.
-Diese Konfiguration ist aber auch f\"{u}r Autochanger mit nur einem Laufwerk zu benutzen.
-
-Wenn {\bf mtx} korrekt mit Ihrem Autochanger zusammenarbeitet,
-dann ist es nur eine Frage der Anpassung des {\bf mtx-changer} Scripts (falls n\"{o}tig)
-um den Autochanger mit Bacula zu benutzen.
-Eine Liste mit von {\bf mtx} unterst\"{u}zten Autochangern, finden Sie unter folgendem Link:
-\elink{http://mtx.opensource-sw.net/compatibility.php}{http://mtx.opensource-sw.net/compatibility.php}.
-Die Homepage des {\bf mtx} Projekts ist:
-\elink{http://mtx.opensource-sw.net/}{http://mtx.opensource-sw.net/}.
-
-Anmerkung: wir haben R\"{u}ckmeldungen von einigen Benutzern erhalten,
-die \"{u}ber gewisse Inkompatibilit\"{a}ten zwischen dem Linux-Kernel und mtx berichten.
-Zum Beispiel zwischen Kernel 2.6.18-8.1.8.el5 von CentOS und RedHat und Version 1.3.10
-und 1.3.11 von mtx. Ein Umstieg auf Kernel-Version 2.6.22 hat diese Probleme behoben.
-
-Zus\"{a}tzlich scheinen einige Versionen von mtx, z.B. 1.3.11, die maximale Anzahl der Slots auf 64
-zu begrenzen, Abhilfe schafft die Benutzung von mtx-Version 1.3.10.
-
-Wenn Sie Probleme haben, benutzen Sie bitte das {\bf auto} Kommando im {\bf btape} Programm,
-um die Funktionalit\"{a}t des Autochangers mit Bacula zu testen.
-Bitte bedenken Sie, dass bei vielen Distributionen (z.B. FreeBSD, Debian, ...) der Storage-Dienst
-nicht als Benutzer und Gruppe {\bf root} l\"{a}uft, sonder als Benutzer {\bf bacula} und Gruppe {\bf tape}.
-In diesem Fall m\"{u}ssen Sie sicherstellen, das der Benutzer oder die Gruppe entsprechende Rechte hat,
-um auf den Autochanger und die Laufwerke zuzugreifen.
-
-Manche Benutzer berichten, dass der Storage-Dienst unter Umst\"{a}nden
-beim laden eines Tapes in das Laufwerk blockiert, falls schon ein Tape im Laufwerk ist.
-Soweit wir das ermitteln konnten, ist es einfache eine Frage der Wartezeit:
-Das Laufwerk hat vorher ein Tape beschrieben und wird f\"{u}r eine ganze Zeit
-(bis zu 7 Minuten bei langsamen Laufwerken) im Status BLOCKED verbleiben,
-w\"{a}hrend das Tape zur\"{u}ckgespult und entladen wird, erst danach kann ein anderes
-Tape in das Laufwerk geladen werden.
-
-\label{SCSI devices}
-\section{Zuordnung der SCSI Ger\"{a}te}
-\index[general]{Zuordnung der SCSI Ger\"{a}te}
-\index[general]{SCSI Ger\"{a}te}
-\index[general]{Ger\"{a}te!SCSI}
-
-Unter Linux k\"{o}nnen Sie:
-\footnotesize
-\begin{verbatim}
-cat /proc/scsi/scsi
-\end{verbatim}
-\normalsize
-
-ausf\"{u}hren, um zu sehen welche SCSI-Ger\"{a}te Sie haben.
-Zudem k\"{o}nnen Sie:
-\footnotesize
-\begin{verbatim}
-cat /proc/scsi/sg/device_hdr /proc/scsi/sg/devices
-\end{verbatim}
-\normalsize
-
-benutzen, um herauszufinden, welches das Autochanger-Kontroll-Device ist,
-({\bf /dev/sg0} f\"{u}r die erste Zeile, {\bf /dev/sg1} f\"{u}r die zweite, ...)
-das Sie in der Konfiguration unter {\bf Changer Device = } angeben m\"{u}ssen.
-
-Falls verf\"{u}gbar k\"{o}nnen Sie auch das Kommando {\bf lsscsi} benutzen.
-Unten sehen Sie dazu ein Beispiel, das Changer-Device ist dabei mit {\bf mediumx}
-bezeichnet und entspricht dem Device {\bf /dev/sg10}.
-\footnotesize
-\begin{verbatim}
-$ lsscsi -g
- [1:0:2:0] tape SEAGATE ULTRIUM06242-XXX 1619 /dev/st0 /dev/sg9
- [1:0:14:0] mediumx STK L180 0315 /dev/sch0 /dev/sg10
- [2:0:3:0] tape HP Ultrium 3-SCSI G24S /dev/st1 /dev/sg11
- [3:0:0:0] enclosu HP A6255A HP04 - /dev/sg3
- [3:0:1:0] disk HP 36.4G ST336753FC HP00 /dev/sdd /dev/sg4
-\end{verbatim}
-\normalsize
-
-F\"{u}r weiterf\"{u}hrende Information \"{u}ber SCSI-Ger\"{a}te, schauen Sie bitte in den Abschnitt
-\ilink{Linux SCSI Tricks}{SCSITricks} aus dem Tape-Testing-Kapitel des Handbuchs.
-
-Unter FreeBSD k\"{o}nnen Sie:
-
-\footnotesize
-\begin{verbatim}
-camcontrol devlist
-\end{verbatim}
-\normalsize
-
-benutzen, um SCSI-Ger\"{a}te und die Kontroll-Devices {\bf /dev/passn} des Autochangers anzuzeigen,
-die Sie in der Konfiguration unter {\bf Changer Device = } angeben m\"{u}ssen.
-
-Bitte stellen Sie sicher, dass der Storage-Dienst auf diese Ger\"{a}te zugreifen darf.
-
-Der folgende Tipp f\"{u}r FreeBSD-Benutzer kommt von Danny Butroyd:
-beim Neustart des Computers hat Bacula keine Berechtigung auf das Autochanger-Kontroll-Device
-(z.B. /dev/pass0) zuzugreifen,
-Um dies zu umgehen, editieren Sie die Datei /etc/devfs.conf und f\"{u}gen unten diese Zeilen hinzu:
-
-\footnotesize
-\begin{verbatim}
-own pass0 root:bacula
-perm pass0 0666
-own nsa0.0 root:bacula
-perm nsa0.0 0666
-\end{verbatim}
-\normalsize
-
-Das gibt der Gruppe bacula, nur um sicher zu gehen, auch die Schreib-Berechtigung f\"{u}r das Ger\"{a}t nsa0.0.
-Damit die neue Konfiguration wirksam wird, m\"{u}ssen Sie:
-
-/etc/rc.d/devfs restart
-
-ausf\"{u}hren.
-Danach brauchen Sie nie wieder die Berechtigungen von Hand zu setzen, wenn der Computer neu gestartet wurde.
-
-\label{scripts}
-\section{Beispiel Scripte}
-\index[general]{Scripte!Beispiel }
-\index[general]{Beispiel Scripte }
-
-Lesen Sie bitte den nachfolgenden Abschnitt, damit Sie verstehen wie Bacula mit Autochangern arbeitet.
-Auch wenn Bacula ein standard {\bf mtx-changer} Script installiert, ben\"{o}tigen Sie f\"{u}r Ihren Autochanger
-eventuell einige Anpassungen. Falls Sie Beispiele sehen wollen, schauen Sie bitte in das Verzeichnis
-{\bf\lt{}bacula-src\gt{}/examples/devices}, wo Sie eine {\bf HP-autoloader.conf} Bacula-Ger\"{a}te-Konfiguration,
-sowie mehrere {\bf mtx-changer} Scripte finden werden, die schon f\"{u}r unterschiedliche Autochanger angepasst sind.
-
-\label{Slots}
-
-\section{Slots}
-\index[general]{Slots }
-
-Um den Autochanger richtig ansteuern zu k\"{o}nnen, muss Bacula wissen
-welches Volume in welchem Slot des Autochangers ist. In den Slots werden die Tapes aufbewahrt,
-die nicht in einem Laufwerk geladen sind. Bacula nummeriert diese Slots von eins bis zur Anzahl der
-vorhandenen Tapes im Autochanger.
-
-Bacula benutzt niemals ein Volume im Autochanger, dass nicht gelabelt ist, dem keine Slotnummer im Katalog
-zugewiesen ist oder wenn das Volume nicht als InChanger im Katalog markiert ist. Bacula muss wissen wo das
-Volume/Tape ist, sonst kann es nicht geladen werden.
-Jedem Volume im Autochanger muss \"{u}ber das Console-Programm eine Slot-Nummer zugewiesen werden.
-Diese Information wird im Katalog, zusammen mit anderen Informationen \"{u}ber das Volume, gespeichert.
-Wenn kein Slot angegeben, oder der Slot auf Null gesetzt ist, wird Bacula das Volume nicht benutzen,
-auch wenn alle anderen ben\"{o}tigten Konfigurationsparameter richtig gesetzt sind.
-Wenn Sie das {\bf mount} Console-Kommando ausf\"{u}hren, m\"{u}ssen Sie angeben welches Tape aus welchem Slot
-in das Laufwerk geladen werden soll. Falls schon ein Tape im Laufwerk ist, wird es entladen und danach das
-beim {bf\ mount} angegeben Tape geladen. Normalerweise wird kein anderes Tape im Laufwerk sein, da Bacula beim
-{\bf unmount} Console-Kommando das Laufwerk leert.
-
-Sie k\"{o}nnen die Slot-Nummer und die InChanger-Markierung \"{u}berpr\"{u}fen, indem Sie:
-\begin{verbatim}
-list Volumes
-\end{verbatim}
-im Consolen-Programm ausf\"{u}hren.
-
-\label{mult}
-\section{mehrere Laufwerke}
-\index[general]{Laufwerke!mehrere }
-\index[general]{mehrere Laufwerke }
-
-Einige Autochanger haben mehr als ein Laufwerk. Die in Version 1.37 vorgestellte \ilink{Autochanger-Konfiguration}{AutochangerRes}, erlaubt Ihnen mehrere Ger\"{a}te-Konfigurationen,
-die jeweils einem Laufwerk entsprechen, zu einem Autochanger zu gruppieren. Der Director-Dienst k\"{o}nnte trotzdem
-die Laufwerke direkt ansprechen, aber dies zu erlauben, w\"{u}rde die einwandfreie Zusammenarbeit der Laufwerke
-einschr\"{a}nken. Anstelle dessen sollte dem Director-Dienst, in der Director-Storage-Konfiguration, eine Autochanger-Konfiguration zugewiesen werden. Dieses erlaubt dem Storage-Dienst sicherzustellen, dass nur auf
-ein Laufwerk zur Zeit vom {\bf mtx-changer} Script zugegriffen wird und nicht beide Laufwerke auf dasselbe Volume verweisen.
-
-Mehrere Laufwerke erfordern das Setzen des {\bf Drive Index} in den Ger\"{a}te-Eintr\"{a}gen der
-Storage-Dienst-Konfiguration.
-Laufwerks-Nummern bzw. der {\bf Drive Index} beginnen standardm\"{a}{\ss}ig bei Null.
-Um mit dem zweiten Laufwerk im Autochanger arbeiten zu k\"{o}nnen, muss ein weiterer Ger\"{a}te-Eintrag
-erstellt werden, wobei der {\bf Drive Index} dann Eins ist.
-Normalerweise wird das zweite Laufwerk dasselbe {\bf Changer Device} verwenden,
-aber ein anderes {\bf Archive Device}.
-
-Bacula Jobs werden bevorzugt auf das Volume geschrieben, dass schon in einem Laufwerk geladen ist.
-Wenn Sie mehrere Laufwerke haben und Bacula auf mehreren Laufwerke gleichzeitig Jobs,
-die denselben Pool verwenden, schreiben soll, muss der Parameter \ilink{Prefer Mounted Volumes} {PreferMountedVolumes}
-in der Director-Dienst-Konfiguration in den entsprechenden Job-Eintr\"{a}gen auf "`no"' gesetzt werden.
-Der Storage-Dienst wird daraufhin so viele Volumes wie m\"{o}glich in die Laufwerke laden.
-
-\label{ConfigRecords}
-\section{Ger\"{a}te-Konfigurations-Parameter}
-\index[general]{Parameter!Ger\"{a}te-Konfiguration }
-\index[general]{Ger\"{a}te-Konfigurations-Parameter }
-
-Bacula's Autochanger-Konfiguration wird in den Ger\"{a}te-Eintr\"{a}gen des Storage-Dienstes festgelegt.
-Vier Parameter: {\bf Autochanger}, {\bf Changer Device},{\bf Changer Command}, und {\bf Maximum Changer Wait}
-steuern wie Bacula den Autochanger benutzt.
-
-Diese vier Parameter der {\bf Device}-Konfiguration, sind unten detailliert beschrieben.
-{\bf Changer Device} und {\bf Changer Command} werden in der Gr\"{a}te-Konfiguration nicht ben\"{o}tigt,
-wenn sie in der {\bf Autochanger}-Konfiguration stehen.
-
-\begin{description}
-
-\item [Autochanger = {\it Yes|No} ]
- \index[sd]{Autochanger }
- Der {\bf Autochanger}-Parameter gibt an, ob der Ger\"{a}te-Eintrag einen Autochanger beschreibt oder nicht.
- Der Standardwert ist Autochanger = No.
-
-\item [Changer Device = \lt{}device-name\gt{}]
- \index[sd]{Changer Device }
- Zus\"{a}tzlich zu dem Archive Device Eintrag, muss das {\bf Changer Device} angegeben werden.
-Das ist notwendig, weil die meisten Autochanger \"{u}ber ein anderes Ger\"{a}t gesteuert werden,
-als f\"{u}r das Schreiben und Lesen der Volumes verwendet wird.
-Ein Beispiel: unter Linux wird normalerweise das generische SCSI-Interface zum Steuern des Autochangers verwendet,
-w\"{a}rend das standard SCSI-Interface f\"{u}r Lese- und Schreibvorg\"{a}ge genutzt wird.
-F\"{u}r das {\bf Archive Device = /dev/nst0} hat man dann typischerweise das {\bf Changer Device = /dev/sg0}.
-Gr\"{o}{\ss}ere Autochanger, mit mehreren Laufwerken und vielen Slots, k\"{o}nnen das Kontroll-Device
-auch auf z.B. {\bf Changer Device = /dev/sg2} haben.
-
-Unter FreeBSD liegt das Kontroll-Device zwischen {\bf /dev/pass0} und {\bf /dev/passn}.
-
-Unter Solaris finden Sie das Kontroll-Device im Verzeichnis {\bf /dev/rdsk}.
-
-Stellen Sie bitte sicher, dass der Storage-Dienst die notwendigen Rechte besitzt,
-um auf die entsprechenden Ger\"{a}te zugreifen zu d\"{u}rfen.
-
-\item [Changer Command = \lt{}command\gt{}]
- \index[sd]{Changer Command }
- Dieser Parameter gibt an, welches externe Kommando und mit welchen Argumenten,
-aufgerufen wird, um den Autochanger zu steuern.
-Es wird vorausgesetzt, dass dieses Kommando ein normales Programm oder Shell-Script ist,
-das vom Betriebssystem ausgef\"{u}hrt werden kann.
-Dieses Kommando wird jedes mal aufgerufen, wenn Bacula das Autochanger-Kontroll-Device ansprechen m\"{o}chte.
-Die folgenden Ersetzungen werden durchgef\"{u}hrt, bevor das {\bf command} dem Betriebssystem zur
-Ausf\"{u}hrung \"{u}bergeben wird:
-
-\footnotesize
-\begin{verbatim}
- %% = %
- %a = archive device name
- %c = changer device name
- %d = changer drive index base 0
- %f = Client's name
- %j = Job name
- %o = command (loaded, load, or unload)
- %s = Slot base 0
- %S = Slot base 1
- %v = Volume name
-\end{verbatim}
-\normalsize
-
-Hier ist ein Beispiel f\"[{u}r die Benutzung von {\bf mtx} mit dem {\bf mtx-changer} Script,
-dass in der Bacula-Distribution enthalten ist:
-
-\footnotesize
-\begin{verbatim}
-Changer Command = "/etc/bacula/mtx-changer %c %o %S %a %d"
-\end{verbatim}
-\normalsize
-
-Falls das {\bf mtx-changer} Script nicht in {\bf /etc/bacula} liegt,
-m\"{u}ssen Sie den Pfad entsprechend anpassen,
-Einzelheiten zu den drei von Bacula benutzten Kommandos (loaded, load, unload),
-sowie zu den von Bacula erwarteten Ausgaben des {\bf mtx-changer} Scripts,
-werden weiter unten im Abschnitt {\bf Bacula Autochanger Schnittstelle} beschrieben..
-
-\item [Maximum Changer Wait = \lt{}time\gt{}]
- \index[sd]{Maximum Changer Wait }
- Dieser Parameter gibt an, wie lange Bacula maximal warten soll,
-bis der Autochanger auf ein Kommando (z.B. load) reagiert.
-Der Standardwert betr\"{a}gt 120 Sekunden. Wenn Sie einen langsamen Autochanger haben,
-m\"{u}ssen Sie hier eventuell eine l\"{a}ngere Zeit konfigurieren.
-
-Wenn der Autochanger nicht innerhalb der {\bf Maximum Changer Wait} Zeit antwortet,
-wird das Kommando abgebrochen und Bacula wird das Eingreifen des Bedieners verlangen.
-
-\item [Drive Index = \lt{}number\gt{}]
- \index[sd]{Drive Index }
- Dieser Parameter gibt die Nummer des Laufwerks innerhalb des Autochangers an.
-Da die Nummerierung bei Null beginnt, wird das zweite Laufwerk mit folgendem Eintrag angegeben:
-
-\footnotesize
-\begin{verbatim}
-Device Index = 1
-\end{verbatim}
-\normalsize
-
-Um das zweite Laufwerk nutzen zu k\"{o}nnen, muss ein zweiter Device-Eintrag in der Konfigurationsdatei des
-Storage-Dienstes erstellt werden. Einzelheiten dazu stehen, weiter oben in diesem Kapitel, in dem Abschnitt
-{\bf mehrere Laufwerke}
-\end{description}
-
-Damit der Autochanger zuverl\"{a}{\ss}ig funktioniert, muss zus\"{a}tzlich ein Autochanger-Eintrag erstellt werden.
-\input{autochangerres}
-
-\label{example}
-\section{eine Beispiel-Konfigurationsdatei}
-\index[general]{Beispiel-Konfigurationsdatei}
-\index[general]{Datei!Beispiel Konfiguration }
-
-Die folgenden beiden Konfigurations-Eintr\"{a}ge realisieren einen Autochanger:
-
-\footnotesize
-\begin{verbatim}
-Autochanger {
- Name = "Autochanger"
- Device = DDS-4
- Changer Device = /dev/sg0
- Changer Command = "/etc/bacula/mtx-changer %c %o %S %a %d"
-}
-
-Device {
- Name = DDS-4
- Media Type = DDS-4
- Archive Device = /dev/nst0 # Normal archive device
- Autochanger = yes
- LabelMedia = no;
- AutomaticMount = yes;
- AlwaysOpen = yes;
-}
-\end{verbatim}
-\normalsize
-
-Wobei Sie {\bf Archive Device}, {\bf Changer Device} und den Pfad zum
-{\bf Changer Command} Ihrem System entsprechend anpassen m\"{u}ssen.
-
-\section{eine Beispiel-Konfigurationsdatei f\"{u}r mehrere Laufwerke}
-\index[general]{Beispiel-Konfigurationsdatei f\"{u}r mehrere Laufwerke}
-
-Die folgenden Konfigurations-Eintr\"{a}ge realisieren einen Autochanger mit mehreren Laufwerken:
-
-\footnotesize
-\begin{verbatim}
-Autochanger {
- Name = "Autochanger"
- Device = Drive-1, Drive-2
- Changer Device = /dev/sg0
- Changer Command = "/etc/bacula/mtx-changer %c %o %S %a %d"
-}
-
-Device {
- Name = Drive-1
- Drive Index = 0
- Media Type = DDS-4
- Archive Device = /dev/nst0 # Normal archive device
- Autochanger = yes
- LabelMedia = no;
- AutomaticMount = yes;
- AlwaysOpen = yes;
-}
-
-Device {
- Name = Drive-2
- Drive Index = 1
- Media Type = DDS-4
- Archive Device = /dev/nst1 # Normal archive device
- Autochanger = yes
- LabelMedia = no;
- AutomaticMount = yes;
- AlwaysOpen = yes;
-}
-
-\end{verbatim}
-\normalsize
-
-Wobei Sie {\bf Archive Device}, {\bf Changer Device} und den Pfad zum
-{\bf Changer Command} Ihrem System entsprechend anpassen m\"{u}ssen.
-
-\label{SpecifyingSlots}
-\section{Festlegen der Slots beim Labeln}
-\index[general]{Festlegen der Slots beim Labeln }
-\index[general]{Labeln!Festlegen der Slots }
-
-Wenn Sie einen {\bf Autochanger = yes} Eintrag in Ihrer Storage-Konfiguration des
-Director-Dienstes hinzugef\"{u}gt haben, wird die Bacula Console Sie bei diesen beiden Kommandos
-{\bf add} und {\bf label} automatisch nach einem Slot f\"{u}r die jeweilige Aktion fragen.
-Beim {\bf label} Kommando wird Bacula automatisch das richtige Volume in ein Laufwerk laden.
-
-Au{\ss}erdem muss, wie oben beschrieben, der Parameter {\bf Autochanger = yes} in der Ger\"{a}te-Konfiguration
-des Storage-Dienstes vorhanden sein, damit der Autochanger benutzt werden kann.
-N\"{a}here Informationen zu diesen Parametern finden Sie in der \ilink{Storage Konfiguration}{Autochanger1}
-des Director-Kapitels und in \ilink{Device Konfiguration}{Autochanger} des Storage-Kapitels.
-
-Somit k\"{o}nnen alle Aktionen mit dem Autochanger komplett automatisiert werden.
-Zudem ist es m\"{o}glich mit dem Men\"{u}punkt {\bf Volume Parameters} des Consolen-Kommandos {\bf update} den Slot
-zu setzen und zu \"{a}ndern.
-
-Selbst wenn alle oben genannten Konfigurationen und Parameter richtig angegeben sind,
-wird Bacula nur dann korrekt mit den Volumes im Autochanger arbeiten, wenn
-den Volume-Eintr\"{a}ge im Katalog, die den Tapes im Autochanger entsprechenden,
-auch eine {\bf slot}-Nummer zugewiesen ist.
-
-Wenn Ihr Autochanger Barcodes unterst\"{u}tzt, k\"{o}nnen Sie alle Volumes im Autochanger,
-eins nach dem anderen, labeln indem Sie das Console-Kommando {\bf label barcodes} verwenden.
-Jedes Tape mit Barcode, wird von Bacula in ein Laufwerk geladen und dann mit dem selben Namen gelabelt,
-der auch auf dem Barcode steht. Gleichzeitig wird ein Katalog-Eintrag f\"{u}r das Volume angelegt.
-Wenn der Barcode mit der Zeichenkette beginnt, die als {\bf CleaningPrefix= } konfiguriert ist,
-wird Bacula das Tape f\"{u}r ein Reinigungsband halten und es wird nicht versucht das Tape zu labeln.
-Ein Beispiel:
-
-\footnotesize
-\begin{verbatim}
-Pool {
- Name ...
- Cleaning Prefix = "CLN"
-}
-\end{verbatim}
-\normalsize
-
-Jedes Volume mit einem Barcode wie CLNxxxxx wird als Reinigungsband behandelt und nicht gelabelt.
-
-Bitte bedenken Sie, dass jedes Volume, dass der Autochanger automatisch benutzen soll, bereits vor-gelabelt sein muss.
-Wenn Sie keinen Barcode-Leser haben, muss das von Hand geschehen (oder durch ein Script).
-
-\section{Tape-Wechsel}
-\index[general]{Tapewechsel }
-Wenn Sie Tapes dem Autochanger entnehmen oder hinzuf\"{u}gen wollen,
-oder das {\bf mtx} Kommando von Hand aufrufen wollen,
-m\"{u}ssen Sie Bacula den Autochanger freigeben lassen,
-indem Sie folgendes Console-Kommando ausf\"{u}hren:
-
-\footnotesize
-\begin{verbatim}
-unmount
-(wechseln der Tapes und/oder mtx ausf\"{u}hren
-mount
-\end{verbatim}
-\normalsize
-
-Wenn Sie den Autochanger nicht freigeben, wei{\ss} Bacula
-nach dem Tapewechsel nicht mehr, welches Volume in welchen Slot des Autochanger ist
-und wird nicht mehr korrekt mit dem Autochanger arbeiten k\"{o}nnen.
-Bacula geht immer davon aus, dass es exklusiven Zugriff auf den Autochanger hat,
-solange ein Laufwerk gemountet ist.
-
-
-\label{Magazines}
-\section{Arbeiten mit mehreren Magazinen}
-\index[general]{Arbeiten mit mehreren Magazinen }
-\index[general]{Magazine!Arbeiten mit mehreren }
-
-Wenn Sie mehrere Magazine haben, oder wenn Sie Tapes in den Magazinen tauschen,
-m\"{u}ssen Sie Bacula dar\"{u}ber informieren. Bacula wird immer die Tapes im Autochanger
-bevorzugt vor anderen Tapes benutzen, somit werden Bedienereingriffe minimiert.
-
-Wenn Ihr Autochanger mit Barcodes (maschinenlesbare Tape Labels) arbeitet,
-ist der Schritt, Bacula \"{u}ber die im Autochanger verf\"{u}gbaren Tapes zu informieren, sehr einfach.
-Jedes mal wenn Sie ein Magazin wechseln, oder Tapes aus dem Magazine entfernen bzw. hinzuf\"{u}gen,
-f\"{u}hren Sie einfach:
-
-\footnotesize
-\begin{verbatim}
-unmount
-(Magazin/Tapes wechseln)
-update slots
-mount
-\end{verbatim}
-\normalsize
-
-im Console-Programm aus. Daraufhin wird Bacula den Autochanger nach einer aktuellen Liste
-der in den Magazinen verf\"{u}gbaren Tapes fragen. Bei diesem Vorgang werden keine Tapes gelesen,
-diese Informationen werden vom Autochanger w\"{a}hrend des Inventory ermittelt.
-Bacula aktualisiert die Volume-Eintr\"{a}ge im Katalog, so dass bei allen in den Magazinen vorhandenen Tapes
-das {\bf InChanger} Flag und auch die Slot-Nummern richtig gesetzt werden.
-
-Falls Sie keinen Barcode-Leser im Autochanger haben, gibt es mehrere andere M\"{o}glichkeiten.
-
-\begin{enumerate}
-\item Sie k\"{o}nnen den Slot und das {\bf InChanger} Flag manuell setzen, indem Sie das {\bf update volume}
-Consolen-Kommando verwenden (sehr umst\"{a}ndlich).
-
-\item Sie k\"{o}nnen das
-
-\footnotesize
-\begin{verbatim}
-update slots scan
-\end{verbatim}
-\normalsize
-
- Consolen-Kommando ausf\"{u}hren. Daraufhin wird Bacula jedes Tape nacheinander in ein Laufwerk laden,
- das Tape Label lesen und den Katalog (Slot, InChanger-Flag) aktualisieren.
- Dieses Vorgehen ist zwar wirkungsvoll, aber auch sehr langsam.
-
-\item Sie k\"{o}nnen das {\bf mtx-changer} Script anpassen, damit es die Barcodes im Autochanger simuliert (siehe unten).
-\end{enumerate}
-
-\label{simulating}
-\section{Simulieren von Barcodes im Autochanger}
-\index[general]{Autochanger!Simulieren von Barcodes im }
-\index[general]{Simulieren von Barcodes im Autochanger }
-
-Sie k\"{o}nnen die Barcodes im Autochanger simulieren, indem Sie das {\bf mtx-changer} Script so anpassen,
-dass es die selben Informationen zur\"{u}ckgibt, die ein Autochanger mit Barcodes liefert.
-Dazu wird die folgende Zeile im {\bf mtx-changer} Script:
-
-\footnotesize
-\begin{verbatim}
- ${MTX} -f $ctl status |
- grep " *Storage Element [0-9]*:.*Full" |
- awk "{print \$3 \$4}" | sed "s/Full *\(:VolumeTag=\)*//"
-\end{verbatim}
-\normalsize
-(Der Zeilenumbruch dient hier nur der Darstellung, im {\bf mtx-changer} Script ist es eine Zeile)
-
-durch ein \# auskommentiert oder einfach gel\"{o}scht (Zeilennummer ist ungef\"{a}hr 99).
-An ihrer Stelle wird eine neue Zeile erstellt, die den Inhalt einer Datei ausgibt.
-Zum Beispiel:
-
-\footnotesize
-\begin{verbatim}
-cat /etc/bacula/changer.volumes
-\end{verbatim}
-\normalsize
-
-Stellen Sie sicher, dass Sie den kompletten Pfad zur Datei angeben, Ort und Name der Datei sind egal.
-Die Inhalt der Datei muss folgenden Beispiel entsprechen:
-
-\footnotesize
-\begin{verbatim}
-1:Volume1
-2:Volume2
-3:Volume3
-...
-\end{verbatim}
-\normalsize
-
-Wobei die 1, 2 und 3 die Slot-Nummern und Volume1, Volume2 und Volume3 die Namen (bzw. Barcodes) sind.
-Sie k\"{o}]nnen mehrere Datei erstellen, die den Tapes in verschiedenen Magazinen entsprechen und beim Wechsel
-der Magazine einfach die f\"{u}r das Magazine g\"{u}ltige Datei in die {\bf /etc/bacula/changer.volumes} kopieren.
-Sie brauchen Bacula nicht neu zu starten, wenn Sie Magazine wechseln, nur die Datei muss den richtigen Inhalt haben.
-Wenn Sie dann das Console-Kommando {\bf update slots} ausf\"{u}hren, wird Ihr Autochanger f\"{u}r Bacula so erscheinen,
-als ob er Barcodes unterst\"{u}tzen w\"{u}rde.
-
-
-\label{updateslots}
-\section{Alle Parameter des Update Slots Kommandos}
-\index[general]{Alle Parameter des Update Slots Kommandos }
-\index[general]{Kommandos!alle Parameter des Update Slots }
-
-Wenn Sie ncht alle Slots \"{u}berpr\"{u}fen lassen wollen, nur weil Sie ein Tape im Magazin getauscht haben,
-k\"{o}nnen Sie das Consolen-Kommando {\bf update slots}, genauso wie das Kommando {\bf update slots scan},
-mit zus\"{a}tzlichen Parametern aufrufen:
-
-\footnotesize
-\begin{verbatim}
-update slots=n1,n2,n3-n4, ...
-\end{verbatim}
-\normalsize
-
-wobei der Parameter {\bf scan} optional ist. Die Parameter n1, n2, n3-n7... geben die Slots an,
-wobei n1, n2 f\"{u}r einzelne Slots und n3-n7 f\"{u}r einen Bereich von Slots steht (n3 bis n7).
-
-Diese Parameter sind n\"{u}tzlich, wenn Sie {\bf update slots scan} (sehr langsam) ausf\"{u}hren und dabei
-die Slots auf die mit gewechselten Tapes begrenzen k\"{o}nnen.
-
-Als Beispiel, das Console-Kommando :
-
-\footnotesize
-\begin{verbatim}
-update slots=1,6 scan
-\end{verbatim}
-\normalsize
-
-veranlasst Bacula, das Tape im ersten Slot des Autochangers in ein Laufwerk zu laden, das Label zu lesen und den
-Katalog entsprechend zu aktualisieren.
-Danach passiert dasselbe mit dem Tape im sechsten Slot.
-Das Console-Kommando:
-
-\footnotesize
-\begin{verbatim}
-update slots=1-3,6
-\end{verbatim}
-\normalsize
-
-liest die Barcodes der Tapes in den Slots 1, 2, 3 und 6 und aktualisiert den Katalog.
-Wenn Ihr Autochanger keinen Barcode-Leser hat und Sie das {\bf mtx changer} Script nicht, wie oben beschrieben,
-angepasst haben, wird dieses Console-Kommando keine Tapes finden und folglich nichts tun.
-
-\label{FreeBSD}
-\section{FreeBSD Belange}
-\index[general]{Belange!FreeBSD }
-\index[general]{FreeBSD Belange }
-
-Falls unter FreeBSD Probleme auftreten, wenn Bacula versucht auf ein Laufwerk zuzugreifen
-und folgende Fehlermeldung erscheint: {\bf Device not configured},
-passiert dass weil FreeBSD den Ger\"{a}te-Eintrag {\bf /dev/nsa1} entfernt, wenn kein Tape im Laufwerk ist.
-Das hat zur Folge, dass Bacula das Ger\"{a}t nicht \"{o}ffnen kann. Die L\"{o}sung f\"{u}r dieses Problem ist es,
-sicherzustellen, dass immer ein Tape im Laufwerk ist, wenn Bacula gestartet wird.
-Diese Problem ist in den Bacula-Versionen 1.32f-5 und sp\"{a}ter behoben.
-
-Beachten Sie bitte das Kapitel \ilink{Laufwerk-Tests}{FreeBSDTapes} bevor Sie den Autochanger testen,
-dort finden Sie weitere {\bf wichtige} Informationen die Laufwerke betreffend.
-
-\label{AutochangerTesting}
-\section{Autochanger-Test und Anpassung des mtx-changer Scripts}
-\index[general]{Autochanger-Test }
-\index[general]{Anpassung des mtx-changer Scripts}
-
-
-Bevor Sie den Autochanger gleich mit Bacula ausprobieren, ist es vorzuziehen, zuerst von Hand
-zu testen ob er richtig funktioniert.
-Um das zu tun, empfehlen wir, dass Sie die folgenden Kommandos ausf\"{u}hren (wobei angenommen wird,
-dass das {\bf mtx-changer} Script unter {\bf /etc/bacula/mtx-changer} liegt):
-
-\begin{description}
-
-\item [Stellen Sie sicher, dass Bacula nicht l\"{a}uft.]
-
-\item [/etc/bacula/mtx-changer \ /dev/sg0 \ list \ 0 \ /dev/nst0 \ 0]
-\index[sd]{mtx-changer list}
-
-Das Kommando sollte diese Ausgabe erzeugen:
-
-\footnotesize
-\begin{verbatim}
- 1:
- 2:
- 3:
- ...
-
-\end{verbatim}
-\normalsize
-
-eine oder mehrere Zeilen f\"{u}r jeden belegten Slot im Autochanger,
-wobei hinter jeder Zahl ein Doppelpunkt ({\bf :}) stehen muss.
-Wenn Ihr Autochanger Barcodes unterst\"{u}tzt, steht hinter dem Doppelpunkt der Barcode.
-Falls ein Fehler auftritt, muss die Ursache gefunden werden
-(versuchen Sie z.B. ein anderes Kontroll-Device zu verwenden, falls {\bf /dev/sg0} falsch ist).
-Unter FreeBSD z.B. liegt das Kontroll-Device gew\"{o}hnlich auf {\bf /dev/pass2}.
-
-\item [/etc/bacula/mtx-changer \ /dev/sg0 \ slots ]
-\index[sd]{mtx-changer slots}
-
-Das Kommando sollte die Anzahl der Slots im Autochanger anzeigen.
-
-\item [/etc/bacula/mtx-changer \ /dev/sg0 \ unload \ 1 \ /dev/nst0 \ 0 ]
-\index[sd]{mtx-changer unload}
-
- Falls das Tape aus Slot 1 in einem Laufwerk geladen ist, sollte es jetzt entladen werden.
-
-\item [/etc/bacula/mtx-changer \ /dev/sg0 \ load \ 3 \ /dev/nst0 \ 0 ]
-\index[sd]{mtx-changer load}
-
-Angenommen in Slot 3 ist ein Tape, dann wird es jetzt in das erste Laufwerk geladen (\bf Drive Index = 0)
-
-\item [/etc/bacula/mtx-changer \ /dev/sg0 \ loaded \ 0 \ /dev/nst0 \ 0]
-\index[sd]{mtx-changer loaded}
-
-Dieses Kommando sollte jetzt 3 ausgeben (Die Slot-Nummer des in Laufwerk 0 geladenen Tapes.).
-Beachten Sie, dass wir im Kommando eine ung\"{u}ltige Slotnummer 0 verwendet haben.
-In diesem Fall, wird sie einfach ignoriert, weil sie nicht ben\"{o}tigt wird.
-Allerdings musste eine Slot-Nummer angegeben werden, weil der Laufwerksparameter
-am Ende des Kommandos erforderlich war, um das richtige Laufwerk zu w\"{a}hlen.
-
-\item [/etc/bacula/mtx-changer \ /dev/sg0 \ unload \ 3 /dev/nst0 \ 0]
-
-wird das Laufwerk mit {\bf Drive Index = 0} in Slot 3 entladen.
-
-\end{description}
-
-Nachdem alle oben genannten Kommandos funktionieren und in der
-Storage-Dienst-Konfiguration auch das richtige {\bf Changer Command} angegeben ist,
-sollte Bacula jetzt mit Ihrem Autochanger arbeiten k\"{o}nnen.
-Das letzte verbleibende Problem ist, dass der Autochanger einige Zeit ben\"{o}tigt,
-das Tape zu laden, nachdem das entsprechende Kommando abgesetzt wurde.
-Wenn sich das {\bf mtx-changer} Script nach dem load-Kommando beendet,
-wird Bacula sofort versuchen das Tape zur\"{u}ckzuspulen und zu lesen.
-Wenn Bacula Ein-/Ausgabe-Fehler nach dem Laden des Tapes meldet, werden Sie eventuell eine
-Verz\"{o}gerungszeit (z.B. {\bf sleep 20}) im {\bf mtx changer} Script nach dem {\bf mtx} Kommando
-einf\"{u}gen m\"{u}ssen. Bitte bedenken Sie, dass egal was Sie dem {\bf mtx changer} Script an Kommandos
-hinzuf\"{u}gen, sich das Script immer mit {\bf exit 0} beendet.
-Bacula \"{u}berpr\"{u}ft den R\"{u}ckgabewert des Script nach jedem Aufruf und er muss immer 0 sein,
-wenn alles geklappt hat.
-
-Ob Sie eine {\bf sleep}-Zeit im Script angeben m\"{u}ssen, k\"{o}nnen Sie mit folgenden
-Kommandos \"{u}berpr\"{u}fen, indem Sie sie in ein Script schreiben und ausf\"{u}hren.
-
-\footnotesize
-\begin{verbatim}
-#!/bin/sh
-/etc/bacula/mtx-changer /dev/sg0 unload 1 /dev/nst0 0
-/etc/bacula/mtx-changer /dev/sg0 load 3 /dev/nst0 0
-mt -f /dev/st0 rewind
-mt -f /dev/st0 weof
-\end{verbatim}
-\normalsize
-
-Wenn das Script funktioniert, haben Sie wahrscheinlich keine zeitlichen Probleme.
-Wenn es nicht funktioniert, tragen Sie, direkt hinter dem mtx-changer load Kommando,
-{\bf sleep 30} oder auch {\bf sleep 60} ein. Wenn es damit funktioniert,
-\"{u}bernehmen Sie den passenden {\bf sleep}-Eintrag in das {\bf mtx-changer} Script,
-so wird diese Verz\"{o}gerungszeit jedes mal angewendet, wenn Bacula das Script aufruft.
-
-Ein zweites Problem, dass einige Autochanger betrifft, ist dass die Laufwerke diese Autochanger das Tape
-auswerfen m\"{u}ssen, bevor es aus dem Laufwerk entfernt werden kann. Falls das zutrifft, wird das Kommando
-{\bf load 3} niemals erfolgreich beendet werden, egal wie lange Sie warten.
-In diesem Fall, k\"{o}nnen Sie ein Auswurf-Kommando direkt hinter das {\bf unload} setzen,
-so dass das Script dann so aussieht:
-
-\footnotesize
-\begin{verbatim}
-#!/bin/sh
-/etc/bacula/mtx-changer /dev/sg0 unload 1 /dev/nst0 0
-mt -f /dev/st0 offline
-/etc/bacula/mtx-changer /dev/sg0 load 3 /dev/nst0 0
-mt -f /dev/st0 rewind
-mt -f /dev/st0 weof
-\end{verbatim}
-\normalsize
-
-Nat\"{u}rlich m\"{u}ssen Sie das {\bf offline} Kommando in das {\bf mtx changer} Script \"{u}bernehmen,
-falls es das Problem behebt. Da Bacula den R\"{u}ckgabewert des {\bf mtx changer} Scripts \"{u}berpr\"{u}ft,
-stellen sie wiederum sicher, dass er immer 0 ist, bzw. das der R\"{u}ckgabewert des {\bf mtx} Kommandos an
-Bacula \"{u}bergeben wird.
-
-Wie vorher schon angemerkt, sind im Verzeichnis {\bf \lt{}bacula-source\gt{}/examples/devices} mehrere
-Scripte, die die oben genannten Kommandos bereits enthalten. Sie k\"{o}nnen eine Hilfe sein, um Ihr Script
-zum laufen zu bringen.
-
-Wenn Bacula den Fehler {\bf Rewind error on /dev/nst0. ERR=Input/output error.} ausgibt,
-werden Sie in den meisten F\"{a}llen eine l\"{a}ngere {\bf sleep}-Zeit in Ihrem {\bf mtx-changer} Script
-hinzuf\"{u}gen m\"{u}ssen, bevor es nach dem {\bf load} Kommando beendet wird.
-
-\label{using}
-\section{Arbeiten mit dem Autochanger}
-\index[general]{Arbeiten mit dem Autochanger }
-\index[general]{Autochanger!Arbeiten mit dem }
-
-Angenommen, Sie haben alle notwendigen Storage-Dienst-Device-Eintr\"{a}ge richtig konfiguriert
-und Sie haben einen {\bf Autochanger = yes} Eintrag zu der Storage-Konfiguration im Director-Dienst
-hinzuge\"{u}gt.
-
-Jetzt f\"{u}llen Sie Ihren Autochanger mit, zum Beispiel, 6 leeren Tapes.
-
-Was muss passieren, damit Bacula auf diese Tapes zugreifen kann?
-
-Eine M\"{o}glichkeit ist, dass jedes Tape vorgelabelt wird. Starten Sie Bacula und
-f\"{u}hren Sie das Console-Programm aus, innerhalb des Console-Programms verwenden Sie das Kommando {\bf label}:
-
-\footnotesize
-\begin{verbatim}
-./bconsole
-Connecting to Director rufus:8101
-1000 OK: rufus-dir Version: 1.26 (4 October 2002)
-*label
-\end{verbatim}
-\normalsize
-
-wird etwas \"{a}hnliches wie hier ausgeben:
-
-\footnotesize
-\begin{verbatim}
-Using default Catalog name=BackupDB DB=bacula
-The defined Storage resources are:
- 1: Autochanger
- 2: File
-Select Storage resource (1-2): 1
-\end{verbatim}
-\normalsize
-
-W\"{a}hlen Sie den Autochanger und es erscheint:
-
-\footnotesize
-\begin{verbatim}
-Enter new Volume name: TestVolume1
-Enter slot (0 for none): 1
-\end{verbatim}
-\normalsize
-
-geben Sie {\bf Testvolume1} f\"{u}r den Tape-Namen ein und {\bf 1} f\"{u}r den Slot.
-Bacula fragt:
-
-\footnotesize
-\begin{verbatim}
-Defined Pools:
- 1: Default
- 2: File
-Select the Pool (1-2): 1
-\end{verbatim}
-\normalsize
-
-W\"{a}hlen Sie den Default Pool. Das wird automatisch gemacht, wenn Sie nur einen Pool haben.
-Nun wird Bacula damit beginnen, das ben\"{o}tigte Laufwerk zu entladen und
-das Tape aus Slot 1 in das Laufwerk zu laden und als Testvolume1 zu labeln.
-In diesem Beispiel war kein Tape im Laufwerk, die Ausgabe sieht dann so aus:
-
-\footnotesize
-\begin{verbatim}
-Connecting to Storage daemon Autochanger at localhost:9103 ...
-Sending label command ...
-3903 Issuing autochanger "load slot 1" command.
-3000 OK label. Volume=TestVolume1 Device=/dev/nst0
-Media record for Volume=TestVolume1 successfully created.
-Requesting mount Autochanger ...
-3001 Device /dev/nst0 is mounted with Volume TestVolume1
-You have messages.
-*
-\end{verbatim}
-\normalsize
-
-Sie k\"{o}nnen dann damit fortfahren, die andern Tapes zu labeln.
-Die Ausgaben werden etwas anders aussehen, weil Bacula dann erst das
-vorherige, gerade gelabelte Tape, aus dem Laufwerk entladen muss,
-bevor das neue Tape geladen werden kann.
-
-Wenn Sie alle Tapes gelabelt haben, wird Bacula sie automatisch verwenden, wenn sie ben\"{o}tigt werden.
-
-Um nachzusehen, wie die Tapes gelabelt sind, geben Sie einfach das Console-Kommando {\bf list volumes} ein,
-das wird eine Liste, wie die folgende ausgeben:
-
-\footnotesize
-\begin{verbatim}
-*{\bf list volumes}
-Using default Catalog name=BackupDB DB=bacula
-Defined Pools:
- 1: Default
- 2: File
-Select the Pool (1-2): 1
-+-------+----------+--------+---------+-------+--------+----------+-------+------+
-| MedId | VolName | MedTyp | VolStat | Bites | LstWrt | VolReten | Recyc | Slot |
-+-------+----------+--------+---------+-------+--------+----------+-------+------+
-| 1 | TestVol1 | DDS-4 | Append | 0 | 0 | 30672000 | 0 | 1 |
-| 2 | TestVol2 | DDS-4 | Append | 0 | 0 | 30672000 | 0 | 2 |
-| 3 | TestVol3 | DDS-4 | Append | 0 | 0 | 30672000 | 0 | 3 |
-| ... |
-+-------+----------+--------+---------+-------+--------+----------+-------+------+
-\end{verbatim}
-\normalsize
-
-\label{Barcodes}
-\section{Barcode Unterst\"{u}tzung}
-\index[general]{Unterst\"{u}tzung!Barcode }
-\index[general]{Barcode Unterst\"{u}tzung }
-
-Bacula unterst\"{u}tzt Barcodes mit zwei Console-Kommandos:
-{\bf label barcodes} und {\bf update slots}.
-
-Das Kommando {\bf label barcodes} bewirkt, dass Bacula mittels des {\bf mtx-changer} {\bf list}
-Kommandos die Barcodes der Tapes in allen Slots einliest. Danach wird jedes Tape, eins nach dem anderen,
-mit dem Namen gelabelt, den der Barcode enth\"{a}lt.
-
-Das {\bf update slots} Kommando holt, \"{u}ber das {\bf mtx-changer} Script, zuerst eine Liste aller Tapes und deren Barcodes. Dann versucht es im Katalog die entsprechenden Tapes zu finden und aktualisiert
-den {\bf Slot} und das {\bf InChanger} Flag. Falls das Tape nicht im Katalog gelistet ist, passiert nichts.
-Diese Kommando wird ben\"{o}tigt, um die Volume-Eintr\"{a}ge im Katalog mit den tats\"{a}chlich im Autochanger
-zur Verf\"{u}gung stehenden Tapes abzugleichen, nachdem Tapes gewechselt oder in andere Slots verschoben wurden.
-Wenn keine Magazine oder Tapes im Autochanger sind, passiert nichts.
-
-Die Angabe des {\bf Cleaning Prefix} kann in der Pool-Konfiguration benutzt werden, um anzugeben welche
-Tapes (Barcodes) im Katalog mit dem {\bf VolStatus} {\bf Cleaning} gekennzeichnet werden sollen.
-Das verhindert, dass Bacula versucht auf dem Tape zu schreiben.
-
-\section{Volumes im Autochanger anzeigen}
-
-Mit dem Console-Kommando {\bf status slots storage=xxx} k\"{o}nnen Sie sich
-den Inhalt des angegebenen Autochangers anzeigen lassen:
-\footnotesize
-\begin{verbatim}
- Slot | Volume Name | Status | Type | Pool | Loaded |
-------+-----------------+----------+-------------------+----------------+---------|
- 1 | 00001 | Append | DiskChangerMedia | Default | 0 |
- 2 | 00002 | Append | DiskChangerMedia | Default | 0 |
- 3*| 00003 | Append | DiskChangerMedia | Scratch | 0 |
- 4 | | | | | 0 |
-\end{verbatim}
-\normalsize
-
-Falls ein {\bf *} neben einer Slot-Nummer angezeigt wird bedeutet das,
-dass der Inhalt des Autochangers nicht synchron mit der Katalog-Datenbank ist.
-In diesem Fall m\"{u}ssen Sie das Console-Kommmando {\bf update slots} ausf\"{u}hren,
-um die Volume-Eintr\"{a}ge in der Katalog-Datenbank zu aktualisieren.
-
-
-\label{interface}
-\section{Bacula Autochanger Schnittstelle}
-\index[general]{Schnittstelle!Bacula Autochanger }
-\index[general]{Bacula Autochanger Schnittstelle }
-
-Bacula ruft das Autochanger-Script auf, dass Sie als {\bf Changer Command} angegeben haben.
-Normalerweise ist es das von Bacula mitgelieferte {\bf mtx-changer} Script,
-aber tats\"{a}chlich kann es auch jedes andere Programm sein.
-Die einzige Anforderung ist, dass es die Kommandos die Bacula benutzt,
-{\bf loaded}, {\bf load}, {\bf unload}, {\bf list} und {\bf slots}, unterst\"{u}tzt.
-Ausserdem muss jedes dieser Kommandos genau diese R\"{u}ckgabewerte liefern:
-
-\footnotesize
-\begin{verbatim}
-- Die momentan benutzten Autochanger-Kommandos sind:
- loaded -- gibt, ab 1 beginnend, die Nummer des im Laufwerk geladenen Slot zur\"{u}ck,
- bzw. 0 wenn das Laufwerk leer ist.
- load -- l\"{a}dt das Tape aus dem angegebenen Slot in das Laufwerk (einige Autochanger
- ben\"{o}tigen eine 30-sek\"{u}ndige Pause nach diesem Kommando)
- unload -- entl\"{a}dt das Tape aus dem Laufwerk zur\"{u}ck in den Slot
- list -- gibt eine Zeile pro Tape im Autochanger aus.
- Das Format ist: <Slot>:<Barcode>. Wobei
- der {\bf Slot} eine Zahl (nicht null) ist, die der Slot-Nummer entspricht,
- und {\bf Barcode} ist, falls vorhanden, der Barcode des Tapes,
- ansonsten ist {\bf Barcode} leer.
- slots -- gibt die absolute Anzahl der Slots im Autochanger zur\"{u}ck.
-\end{verbatim}
-\normalsize
-
-Bacula \"{u}berpr\"{u}ft den R\"{u}ckgabewert des aufgerufenen Programms,
-wenn er Null ist, werden die gelieferten Daten akzeptiert.
-Wenn der R\"{u}ckgabewert nicht Null ist, wird eine entsprechende Fehlermeldung ausgegeben und
-Bacula wird ein manuelles laden des Tapes in das Laufwerk erwarten.
+++ /dev/null
-%%
-%%
-
-\chapter{Die Bootstrap-Datei}
-\label{BootstrapChapter}
-\index[general]{Datei!Bootstrap }
-\index[general]{Bootstrap-Datei }
-
-Die Informationen in diesem Kapitel sollen Ihnen helfen, entweder eigene Bootstrap-Dateien
-zu erstellen, oder die von Bacula erzeugten zu editieren. Da die Bootstrap-Datei automatisch beim ausf\"{u}hren des
-\ilink{restore}{_ConsoleChapter} Console-Kommandos, oder wenn Sie \ilink{ Write Bootstrap}{writebootstrap}
-in den Job-Eintr\"{a}gen der Director-Dienst-Konfiguration angeben, erzeugt wird,
-brauchen Sie das genaue Format eigentlich nicht wissen.
-
-Die Bootstrap-Datei enth\"{a}lt Informationen im ASCII-Format,
-die pr\"{a}zise angeben, welche Dateien wiederhergestellt werden sollen, auf welchem Volume sie liegen
-und wo auf dem Volume. Es ist ein relativ kompaktes Format diese Informationen anzugeben, aber es ist
-lesbar f\"{u}r Menschen und kann mit einem Texteditor ge\"{a}ndert werden.
-
-\section{Bootstrap-Datei Format}
-\index[general]{Format!Bootstrap}
-\index[general]{Bootstrap-Datei Format }
-
-Das generelle Format der Bootstrap-Datei ist:
-
-{\bf \lt{}Schl\"{u}sselwort\gt{} = \lt{}Wert\gt{}}
-
-Wobei jedes Schl\"{u}sselwort und sein Wert angeben, welche Dateien wiederhergestellt werden.
-Genauer gesagt, das Schl\"{u}sselwort und sein Wert dienen dazu, zu limitieren welche
-Dateien wiederhergestellt werden, sie verhalten sich wie ein Filter.
-Das Fehlen eines Schl\"{u}sselwort bedeutet, dass alle Dateien angenommen werden.
-
-In der Bootstrap-Datei werden Leerzeilen und Zeilen beginnent mit {\#} ignoriert.
-
-Es existieren Schl\"{u}sselw\"{o}rter, die die Filterung nach Volume, Client, Job, Fileindex, Session ID,
-Session Time usw. erlauben.
-
-Je mehr Schl\"{u}sselw\"{o}rter Sie angeben, desto genauer ist die Auswahl der Dateien, die wiederhergestellt werden.
-Alle Schl\"{u}sselw\"{o}rter werden \"{u}ber {\bf UND} verkn\"{u}pft.
-
-Ein Beispiel:
-
-\footnotesize
-\begin{verbatim}
-Volume = Test-001
-VolSessionId = 1
-VolSessionTime = 108927638
-\end{verbatim}
-\normalsize
-
-veranlasst den Storage-Dienst (oder das {\bf bextract} Programm), nur die Dateien wiederherzustellen, die
-auf dem Volume Test-001 vorhanden sind {\bf UND} eine VolumeSessionID mit 1 haben {\bf UND} deren VolumeSessionTime
-gleich 108927638 ist.
-
-Hier ist eine Liste aller erlaubten Schl\"{u}sselw\"{o}rter in der Reihenfolge in der sie auf
-die auf dem Volume befindlichen Daten angewendet werden:
-
-\begin{description}
-
-\item [Volume]
- \index[general]{Volume }
- Dieser Wert gibt an, auf welches Volume die folgenden Schl\"{u}sselw\"{o}rter angewendet werden sollen.
- Falls in der Bootstrap-Datei ein zweites Volume angegeben wird, beziehen sich die darauf folgenden
- Schl\"{u}sselw\"{o}rter auf dieses Volume.
- Wenn der Name des Volumes Leerzeichen enth\"{a}lt, muss er in Anf\"{u}hrungszeichen gesetzt werden.
- Mindestens ein Volume muss angegeben werden.
-
-\item [Count]
- \index[general]{Count}
- Dieser Wert ist die Gesamtanzahl der Dateien, die von dem Volume gelesen werden sollen.
- Daran erkennt der Storage-Dienst, wann er das Lesen beenden soll.
- Dieser Wert ist optional.
-
-\item [VolFile]
- \index[general]{VolFile}
- Dieser Wert gibt eine Dateinummer oder eine Liste bzw. einen Bereich von Dateinummern an,
- die auf dem aktuellen Volume gefunden werden soll. Die Dateinummer stellt die physikalische
- Datei auf dem Volume da, wo die Daten gespeichert sind. Bei einem Tape wird dieser Wert benutzt,
- um das Band richtig zu positionieren und wenn das Laufwerk die letzte angegebene Datei gelesen hat,
- wird der Lesevorgang gestoppt.
-
-\item [VolBlock]
- \index[general]{VolBlock}
- Dieser Wert gibt eine Blocknummer oder eine Liste bzw. einen Bereich von Blocknummern an,
- die auf dem aktuellen Volume gefunden werden soll. Die Blocknummer stellt die physikalischen
- Bl\"{o}cke auf dem Volume da, wo die Daten gespeichert sind.
-
-\item [VolSessionTime]
- \index[general]{VolSessionTime }
- Dieser Wert gibt die Volume-Session-Zeit an, die auf dem aktuellen Volume gefunden werden soll.
-
-\item [VolSessionId]
- \index[general]{VolSessionId }
- Dieser Wert gibt eine Volume-Session-ID oder eine Liste bzw. einen Bereich von Volume-Sesion-IDs an,
- die auf dem aktuellen Volume gefunden werden soll. Jedes Paar aus Volume-Session-ID und Volume-Session-Zeit,
- stimmt mit einem einzelnen Job \"{u}berein, der auf dem Volume gespeichert ist.
-
-\item [JobId]
- \index[general]{JobId }
- Dieser Wert gibt eine Job-ID oder eine Liste bzw. einen Bereich von Job-Ids an,
- die auf dem aktuellen Volume gefunden werden soll. Beachten Sie bitte, dass die Job-ID
- eventuell nicht eindeutig ist, falls Sie mehrere Director-Dienste haben, oder falls Sie
- Ihre Datenbank neu initialisiert haben sollten. Der Job-ID-Filter funktioniert nicht, wenn
- Sie mehrere Jobs gleichzeitig haben laufen lassen.
- Dieser Wert ist optional und wird von Bacula nicht zum zur\"{u}cksichern ben\"{o}tigt.
-
-\item [Job]
- \index[general]{Job }
- Dieser Wert gibt einen Job-Namen oder eine Liste von Job-Namen an, die auf dem aktuellen
- Volume gefunden werden sollen. Der Job-Name stimmt mit einem einzigartigen Paar aus Volume-Session-Zeit
- und VolumeSessionID \"{u}berein, allerdings ist er f\"{u}r Menschen ein bischen leichter zu lesen.
- Gew\"{o}hnliche regul\"{a}re Ausdr\"{u}cke k\"{o}nnen benutzt werden, um einen entsprechenden Job-Namen zu finden.
- Der Job-Name-Filter funktioniert nicht, wenn Sie mehrere Jobs gleichzeitig haben laufen lassen.
- Dieser Wert ist optional und wird von Bacula nicht zum zur\"{u}cksichern ben\"{o}tigt.
-
-\item [Client]
- \index[general]{Client }
- Dieser Wert gibt einen Client-Namen oder eine Liste von Client-Namen an, dia auf dem aktuellen
- Volume gefunden werden soll. Gew\"{o}hnliche regul\"{a}re Ausdr\"{u}cke k\"{o}nnen benutzt werden,
- um einen entsprechenden Job-Namen zu finden. Der Client-Filter funktioniert nicht,
- wenn Sie mehrere Jobs gleichzeitig haben laufen lassen.
- Dieser Wert ist optional und wird von Bacula nicht zum zur\"{u}cksichern ben\"{o}tigt.
-
-\item [FileIndex]
- \index[general]{FileIndex }
- Dieser Wert gibt einen File-Index oder eine Liste bzw. einen Bereich von File-Indexen an,
- die auf dem aktuellen Volume gefunden werden soll. Jedes File (Datei) das auf einem Volume gespeichert ist,
- hat f\"{u}r seine Session einen einzigartigen File-Index. Bei jeder Session wird f\"{u}r das erste
- gespeicherte File der File-Index auf eins gesetzt und dann mit jedem weiteren File um eins erh\"{o}ht.
-
- F\"{u}r ein beliebiges Volume bedeutet das, dass die drei Werte von Volume-Session-ID, Volume-Session-Time
- und File-Index zusammen eine einzelne einzigartige Datei auf einem Volume angeben. Diese Datei ist eventuell
- mehrfach auf dem Volume vorhanden, aber f\"{u}r jedes Vorkommen gibt es eine einzigartige Kombination
- dieser drei Werte. Diese drei Werte sind f\"{u}r jede Datei in der Katalog-Datenbank gespeichert.
-
- Um eine einzelne Datei wiederherzustellen, ist die Angabe eines Wertes (oder einer Liste von File-Indexen)
- erforderlich.
-
-\item [FileRegex]
- \index[general]{FileRegex }
- Hier k\"{o}nnen Sie einen regul\"{a}ren Ausdruck angeben, um nur Dateien wiederherzustellen,
- auf die diesen Ausdruck passt.
-
-\item [Slot]
- \index[general]{Slot }
- Dieser Wert gibt den Autochanger-Slot an. F\"{u}r jedes Volume darf nur ein Slot angegeben werden.
-
-\item [Stream]
- \index[general]{Stream }
- Dieser Wert gibt einen Stream (Strom) oder eine Liste bzw. einen Bereich von Streams an.
- Solange Sie nicht wirklich wissen, was Sie tun, (wenn Sie das interne Arbeiten von Bacula kennen),
- sollten Sie auf diese Angabe verzichten.
- Dieser Wert ist optional und wird von Bacula nicht zum zur\"{u}cksichern ben\"{o}tigt.
-
-\item [*JobType]
- \index[general]{*JobType }
- Noch nicht implementiert.
-
-\item [*JobLevel]
- \index[general]{*JobLevel }
- Noch nicht implementiert.
-\end{description}
-
-Bei der Angabe des Volume ist zu bedenken, dass dies der erste Parameter sein muss.
-Alle anderen Parameter k\"{o}nnen in beliebiger Reihenfolge und Anzahl hinter einem
-Volume-Eintrag angegeben werden.
-
-Mehrere Volume-Eintr\"{a}ge k\"{o}nnen in der selben Bootstrap-Datei vorkommen,
-aber mit jedem Vorkommen beginnt ein neuer Satz an Filter, g\"{u}ltig f\"{u}r
-das abgegebene Volume.
-
-Beim verarbeiten der Bootstrap-Datei werden alle Schl\"{u}sselw\"{o}rter
-unterhalb eines Volume-Eintrags mit {\bf UND} verkn\"{u}pft.
-Also wird:
-
-\footnotesize
-\begin{verbatim}
-Volume = Test-01
-Client = "My machine"
-FileIndex = 1
-\end{verbatim}
-\normalsize
-
-auf alle Dateien auf dem Volume Test-01 {\bf UND} von Client My machine
-{\bf UND} mit dem Fileindex 1 passen.
-
-Mehrfach angegebene Schl\"{u}sselw\"{o}rter werden mit {\bf ODER} verkn\"{u}pft.
-Also wird:
-
-\footnotesize
-\begin{verbatim}
-Volume = Test-01
-Client = "My machine"
-Client = "Backup machine"
-FileIndex = 1
-\end{verbatim}
-\normalsize
-
-auf alle Dateien auf dem Volume Test-01 {\bf UND} von Client My machine
-{\bf ODER} vom Client Backup machine {\bf UND} mit dem Fileindex 1 passen.
-
-F\"{u}r Zahlenwerte k\"{o}nnen Sie einen Bereich oder eine Liste angeben,
-f\"{u}r alle anderen Parameter, bis auf Volumes, nur eine Liste.
-Eine Liste ist gleichbedeutend mit mehrfachen Angaben eines Parameters.
-Ein Beispiel
-
-\footnotesize
-\begin{verbatim}
-Volume = Test-01
-Client = "My machine", "Backup machine"
-FileIndex = 1-20, 35
-\end{verbatim}
-\normalsize
-
-passt auf alle Dateien auf dem Volume Test-01 {\bf UND} von Client My machine
-{\bf ODER} vom Client Backup machine {\bf UND} mit dem Fileindex 1 {\bf ODER}
-2 {\bf ODER} 3 ... {\bf ODER} 20 {\bf ODER} 35.
-
-Wie oben erw\"{a}hnt, k\"{o}nnen mehrere Volume-Eintr\"{a}ge in der selben
-Bootstrap-Datei stehen. Jedes Vorkommen eines Volume-Eintrags beginnt einen neuen
-Satz an Filterregeln der auf dem angegebenen Volume angewendet wird und mit weiteren
-Volume-Eintr\"{a}gen \"{u}ber {\bf ODER} verkn\"{u}pft wird.
-
-Als ein Beispiel nehmen wir an, dass wir, mit dem Console-Kommando {\bf query} ,
-nach dem Satz Volumes fragen, die ben\"{o}tigt werden, um alle Dateien des Clients Rufus
-wiederherstellen zu k\"{o}nnen:
-
-\footnotesize
-\begin{verbatim}
-Using default Catalog name=MySQL DB=bacula
-*query
-Available queries:
- 1: List Job totals:
- 2: List where a file is saved:
- 3: List where the most recent copies of a file are saved:
- 4: List total files/bytes by Job:
- 5: List total files/bytes by Volume:
- 6: List last 10 Full Backups for a Client:
- 7: List Volumes used by selected JobId:
- 8: List Volumes to Restore All Files:
-Choose a query (1-8): 8
-Enter Client Name: Rufus
-+-------+------------------+------------+-----------+----------+------------+
-| JobId | StartTime | VolumeName | StartFile | VolSesId | VolSesTime |
-+-------+------------------+------------+-----------+----------+------------+
-| 154 | 2002-05-30 12:08 | test-02 | 0 | 1 | 1022753312 |
-| 202 | 2002-06-15 10:16 | test-02 | 0 | 2 | 1024128917 |
-| 203 | 2002-06-15 11:12 | test-02 | 3 | 1 | 1024132350 |
-| 204 | 2002-06-18 08:11 | test-02 | 4 | 1 | 1024380678 |
-+-------+------------------+------------+-----------+----------+------------+
-\end{verbatim}
-\normalsize
-
-Die Ausgabe zeigt uns, dass wir vier Jobs wiederherstellen m\"{u}ssen.
-Der erste ist eine vollst\"{a}ndige Sicherung, und die drei folgenden sind inkrementelle Sicherungen.
-
-Die folgende Bootstrap-Datei wird ben\"{o}tigt um alle Dateien wiederherzustellen:
-
-\footnotesize
-\begin{verbatim}
-Volume=test-02
-VolSessionId=1
-VolSessionTime=1022753312
-Volume=test-02
-VolSessionId=2
-VolSessionTime=1024128917
-Volume=test-02
-VolSessionId=1
-VolSessionTime=1024132350
-Volume=test-02
-VolSessionId=1
-VolSessionTime=1024380678
-\end{verbatim}
-\normalsize
-
-Als letztes Beispiel nehmen wir an, dass die erste vollst\"{a}ndige Sicherung sich
-\"{u}ber zwei verschiedene Volumes erstreckt. Die Ausgabe des Console-Kommandos
-{\bf query} sieht eventuell so aus:
-
-\footnotesize
-\begin{verbatim}
-+-------+------------------+------------+-----------+----------+------------+
-| JobId | StartTime | VolumeName | StartFile | VolSesId | VolSesTime |
-+-------+------------------+------------+-----------+----------+------------+
-| 242 | 2002-06-25 16:50 | File0003 | 0 | 1 | 1025016612 |
-| 242 | 2002-06-25 16:50 | File0004 | 0 | 1 | 1025016612 |
-| 243 | 2002-06-25 16:52 | File0005 | 0 | 2 | 1025016612 |
-| 246 | 2002-06-25 19:19 | File0006 | 0 | 2 | 1025025494 |
-+-------+------------------+------------+-----------+----------+------------+
-\end{verbatim}
-\normalsize
-
-und die folgende Bootstrap-Datei wird ben\"{o}tigt, um diese Dateien wiederherzustellen:
-
-\footnotesize
-\begin{verbatim}
-Volume=File0003
-VolSessionId=1
-VolSessionTime=1025016612
-Volume=File0004
-VolSessionId=1
-VolSessionTime=1025016612
-Volume=File0005
-VolSessionId=2
-VolSessionTime=1025016612
-Volume=File0006
-VolSessionId=2
-VolSessionTime=1025025494
-\end{verbatim}
-\normalsize
-
-\section{automatische Erzeugung der Bootstrap-Datei}
-\index[general]{Datei!automatische Erzeugung der Bootstrap-}
-\index[general]{automatische Erzeugung der Bootstrap-Datei }
-
-
-Eine Sache ist vermutlich wissenswert: die Bootstrap-Dateien die automatisch
-am Ende eines jeden Jobs erzeugt werden, sind nicht so optimiert wie die, die
-durch das Console-Kommando {\bf restore} erzeugt werden.
-Das ist so, weil die Bootstrap-Dateien, die am Ende des Jobs erstellt werden,
-alle Dateien enthalten, die f\"{u}r diesen Job auf das Volume geschrieben wurden.
-Die Konsequenz ist, dass alle Dateien die w\"{a}rend eines inkrementellen oder differenziellen
-Jobs geschrieben wurden, beim Wiederherstellen zun\"{a}chst von der vollst\"{a}ndigen Sicherung
-wiederhergestellt werden und dann von der inkrementellen oder differenziellen Sicherung.
-
-Wenn die Bootstrap-Datei f\"{u}r die Wiederherstellung erstellt wird,
-wird immer nur eine Version der Datei (die aktuellste) zur Wiederherstellung aufgelistet.
-
-Falls Ihr Rechner noch ein bischen Zeit \"{u}brig hat, k\"{o}nnen Sie Ihre
-Bootstrap-Dateien optimieren, indem Sie das folgende tun:
-
-\footnotesize
-\begin{verbatim}
- ./bconsole
- restore client=xxx select all
- done
- no
- quit
- Backup bootstrap file.
-\end{verbatim}
-\normalsize
-
-Das wird allerdings nicht funktionieren, wenn Ihr Client mehrere Filesets hat,
-denn dann wird noch eine weitere Eingabe erforderlich.
-Das Console-Kommando {\bf restore client=xxx select all} erstellt den Restore-Dateibaum
-und w\"{a}hlt alle Dateien aus, {\bf done} beendet den Auswahlmodus, dann wird die Bootstrap-Datei f\"{u}r diesen
-Wiederherstellungs-Job geschrieben.
-Das {\bf no} beantwortet die Frage {\bf Do you want to run this (yes/mod/no)}.
-{\bf quit} beendet das Console-Programm, danach kann die neu erstellte Bootstrap-Datei gesichert werden.
-
-\label{bscanBootstrap}
-\section{Bootstrap-Datei f\"{u}r bscan}
-\index[general]{bscan}
-\index[general]{bscan!Bootstrap-Datei}
-\index[general]{bscan Bootstrap-Datei}
-Wenn Sie mit dem bscan-Programm sehr viele Volumes abfragen m\"{u}ssen,
-wird Ihr Kommando eventuell das Limit der Kommandozeilel\"{a}nge \"{u}berschreiten (511 Zeichen).
-In dem Fall, k\"{o}nnen Sie eine einfache Bootstrap-Datei erzeugen, die nur Volume-Namen enth\"{a}lt.
-Ein Beispiel:
-
-\footnotesize
-\begin{verbatim}
-Volume="Vol001"
-Volume="Vol002"
-Volume="Vol003"
-Volume="Vol004"
-Volume="Vol005"
-\end{verbatim}
-\normalsize
-
-
-\section{ein weiteres Beispiel der Bootstrap-Datei}
-\index[general]{Beispiel ein weiteres!Bootstrap-Datei }
-\index[general]{ein weiteres Beispiel der Bootstrap-Datei }
-
-Wenn Sie nur einen einzigen Job vom Volume lesen wollen, k\"{o}nnen Sie das
-durch ausw\"{a}hlen der Job-Id tun (Funktion nicht getestet), oder besser noch,
-Sie geben die VolumeSessionTime und VolumeSessionID an, falls Sie sie wissen.
-(Die beiden Werte werden auf dem Job-Report ausgegeben und sind in der Katalog-Datenbank
-zu finden.)
-Die VolumeSessionTime und VolumeSessionID anzugeben ist auch die Art,
-wie Bacula Wiederherstellungen durchf\"{u}hrt.
-Eine Bootstrap-Datei kann dann wie folgt aussehen:
-
-\footnotesize
-\begin{verbatim}
-Volume="Vol001"
-VolSessionId=10
-VolSessionTime=1080847820
-\end{verbatim}
-\normalsize
-
-Wenn Sie wissen, wie viele Dateien gesichert wurden (siehe den Job-Report),
-k\"{o}nnen Sie die Auswahl enorm beschleunigen, indem Sie der Bootstrap-Datei
-folgendes hinzuf\"{u}gen (angenommen es waren 157 Dateien):
-
-\footnotesize
-\begin{verbatim}
-FileIndex=1-157
-Count=157
-\end{verbatim}
-\normalsize
-
-Letztendlich, wenn Sie auch die File-Nummer wissen, wo auf dem Volume die
-ausgew\"{a}hlten Dateien liegen, k\"{o}nnen Sie das bcopy-Programm veranlassen,
-zum richtigen File auf dem Volumen zu springen, ohne jeden Eintrag lesen zu m\"{u}ssen:
-
-\footnotesize
-\begin{verbatim}
-VolFile=20
-\end{verbatim}
-\normalsize
-
-Bootstrap-Dateien sind weder magisch noch kompliziert. Sie zu lesen und Bacula sinnvoll mit ihnen
-arbeiten zu lassen *ist* magisch, aber darum brauchen Sie sich nicht k\"{u}mmern.
-
-Wenn Sie eine *echte* Bootstrap-Datei sehen wollen, starten sie das Console-Programm und geben Sie
-{\bf restore} ein, w\"{a}hlen ein paar Dateien aus und antworten mit {\bf no},
-wenn Sie gefragt werden, ob Sie die Wiederherstellung starten wollen. Dann finden Sie die Bootstrap-Datei
-im Arbeitsverzeichnis des Director-Dienstes (z.B. unter /var/lib/bacula/backup-dir.restore.2.bsr).
+++ /dev/null
-%%
-%%
-
-\section{Bacula Bugs}
-\label{BugsChapter}
-\index[general]{Bacula Bugs }
-\index[general]{Bugs!Bacula }
-
-Zum Gl\"{u}ck gibt es in Bacula nicht sehr viele Programmfehler (Bugs),
-aber dank Dan Langille haben wir eine \elink{Bug-Datenbank}{http://bugs.bacula.org},
-wo Fehler gemeldet werden k\"{o}nnen. Wenn ein Fehler behoben ist, wird normalerweise ein
-Programmst\"{u}ck das den Fehler korrigiert (Patch), auf der Seite des Fehlerberichts
-ver\"{o}ffentlicht.
-
-Das Verzeichnis {\bf patches} im aktuellen SVN enth\"{a}lt eine Liste aller Programmkorrekturen
-die f\"{u}r \"{a}ltere Bacula-Versionen ver\"{o}ffentlicht wurden.
-
-Eine "`grobe"' \"{U}bersicht der momentanen Arbeit und bekannter Probleme befindet sich
-auch in der Datei {\bf kernstodo} im Hauptverzeichnis der Bacula-Programmquellen.
+++ /dev/null
-#!/usr/bin/perl -w
-# Finds potential problems in tex files, and issues warnings to the console
-# about what it finds. Takes a list of files as its only arguments,
-# and does checks on all the files listed. The assumption is that these are
-# valid (or close to valid) LaTeX files. It follows \include statements
-# recursively to pick up any included tex files.
-#
-#
-#
-# Currently the following checks are made:
-#
-# -- Multiple hyphens not inside a verbatim environment (or \verb). These
-# should be placed inside a \verb{} contruct so they will not be converted
-# to single hyphen by latex and latex2html.
-
-
-# Original creation 3-8-05 by Karl Cunningham karlc -at- keckec -dot- com
-#
-#
-
-use strict;
-
-# The following builds the test string to identify and change multiple
-# hyphens in the tex files. Several constructs are identified but only
-# multiple hyphens are changed; the others are fed to the output
-# unchanged.
-my $b = '\\\\begin\\*?\\s*\\{\\s*'; # \begin{
-my $e = '\\\\end\\*?\\s*\\{\\s*'; # \end{
-my $c = '\\s*\\}'; # closing curly brace
-
-# This captures entire verbatim environments. These are passed to the output
-# file unchanged.
-my $verbatimenv = $b . "verbatim" . $c . ".*?" . $e . "verbatim" . $c;
-
-# This captures \verb{..{ constructs. They are passed to the output unchanged.
-my $verb = '\\\\verb\\*?(.).*?\\1';
-
-# This captures multiple hyphens with a leading and trailing space. These are not changed.
-my $hyphsp = '\\s\\-{2,}\\s';
-
-# This identifies other multiple hyphens.
-my $hyphens = '\\-{2,}';
-
-# This identifies \hyperpage{..} commands, which should be ignored.
-my $hyperpage = '\\\\hyperpage\\*?\\{.*?\\}';
-
-# This builds the actual test string from the above strings.
-#my $teststr = "$verbatimenv|$verb|$tocentry|$hyphens";
-my $teststr = "$verbatimenv|$verb|$hyphsp|$hyperpage|$hyphens";
-
-
-sub get_includes {
- # Get a list of include files from the top-level tex file. The first
- # argument is a pointer to the list of files found. The rest of the
- # arguments is a list of filenames to check for includes.
- my $files = shift;
- my ($fileline,$includefile,$includes);
-
- while (my $filename = shift) {
- # Get a list of all the html files in the directory.
- open my $if,"<$filename" or die "Cannot open input file $filename\n";
- $fileline = 0;
- $includes = 0;
- while (<$if>) {
- chomp;
- $fileline++;
- # If a file is found in an include, process it.
- if (($includefile) = /\\include\s*\{(.*?)\}/) {
- $includes++;
- # Append .tex to the filename
- $includefile .= '.tex';
-
- # If the include file has already been processed, issue a warning
- # and don't do it again.
- my $found = 0;
- foreach (@$files) {
- if ($_ eq $includefile) {
- $found = 1;
- last;
- }
- }
- if ($found) {
- print "$includefile found at line $fileline in $filename was previously included\n";
- } else {
- # The file has not been previously found. Save it and
- # recursively process it.
- push (@$files,$includefile);
- get_includes($files,$includefile);
- }
- }
- }
- close IF;
- }
-}
-
-
-sub check_hyphens {
- my (@files) = @_;
- my ($filedata,$this,$linecnt,$before);
-
- # Build the test string to check for the various environments.
- # We only do the conversion if the multiple hyphens are outside of a
- # verbatim environment (either \begin{verbatim}...\end{verbatim} or
- # \verb{--}). Capture those environments and pass them to the output
- # unchanged.
-
- foreach my $file (@files) {
- # Open the file and load the whole thing into $filedata. A bit wasteful but
- # easier to deal with, and we don't have a problem with speed here.
- $filedata = "";
- open IF,"<$file" or die "Cannot open input file $file";
- while (<IF>) {
- $filedata .= $_;
- }
- close IF;
-
- # Set up to process the file data.
- $linecnt = 1;
-
- # Go through the file data from beginning to end. For each match, save what
- # came before it and what matched. $filedata now becomes only what came
- # after the match.
- # Chech the match to see if it starts with a multiple-hyphen. If so
- # warn the user. Keep track of line numbers so they can be output
- # with the warning message.
- while ($filedata =~ /$teststr/os) {
- $this = $&;
- $before = $`;
- $filedata = $';
- $linecnt += $before =~ tr/\n/\n/;
-
- # Check if the multiple hyphen is present outside of one of the
- # acceptable constructs.
- if ($this =~ /^\-+/) {
- print "Possible unwanted multiple hyphen found in line ",
- "$linecnt of file $file\n";
- }
- $linecnt += $this =~ tr/\n/\n/;
- }
- }
-}
-##################################################################
-# MAIN ####
-##################################################################
-
-my (@includes,$cnt);
-
-# Examine the file pointed to by the first argument to get a list of
-# includes to test.
-get_includes(\@includes,@ARGV);
-
-check_hyphens(@includes);
+++ /dev/null
-[General]
-img_extIsRegExp=false
-img_extensions=.eps .jpg .jpeg .png .pdf .ps .fig .gif
-kileprversion=2
-kileversion=2.0
-lastDocument=newfeatures.tex
-masterDocument=
-name=Concepts
-pkg_extIsRegExp=false
-pkg_extensions=.cls .sty
-src_extIsRegExp=false
-src_extensions=.tex .ltx .latex .dtx .ins
-
-[Tools]
-MakeIndex=
-QuickBuild=
-
-[item:ansi-labels.tex]
-archive=true
-column=11
-encoding=
-highlight=LaTeX
-line=38
-open=false
-order=-1
-
-[item:autochangerres.tex]
-archive=true
-column=0
-encoding=
-highlight=
-line=0
-open=false
-order=-1
-
-[item:autochangers.tex]
-archive=true
-column=0
-encoding=
-highlight=LaTeX
-line=69
-open=false
-order=-1
-
-[item:bootstrap.tex]
-archive=true
-column=0
-encoding=
-highlight=LaTeX
-line=0
-open=false
-order=-1
-
-[item:bugs.tex]
-archive=true
-column=0
-encoding=
-highlight=LaTeX
-line=19
-open=false
-order=-1
-
-[item:concepts.kilepr]
-archive=true
-column=134217831
-encoding=
-highlight=
-line=0
-open=false
-order=-1
-
-[item:concepts.tex]
-archive=true
-column=20
-encoding=UTF-8
-highlight=LaTeX
-line=50
-open=false
-order=0
-
-[item:dataencryption.tex]
-archive=true
-column=16
-encoding=UTF-8
-highlight=LaTeX
-line=194
-open=false
-order=0
-
-[item:disk.tex]
-archive=true
-column=3
-encoding=UTF-8
-highlight=LaTeX
-line=362
-open=true
-order=0
-
-[item:dvd.tex]
-archive=true
-column=0
-encoding=
-highlight=
-line=0
-open=false
-order=-1
-
-[item:fdl.tex]
-archive=true
-column=0
-encoding=
-highlight=
-line=0
-open=false
-order=-1
-
-[item:general.tex]
-archive=true
-column=0
-encoding=
-highlight=
-line=0
-open=false
-order=-1
-
-[item:gpl.tex]
-archive=true
-column=56
-encoding=
-highlight=LaTeX
-line=9
-open=false
-order=-1
-
-[item:lesser.tex]
-archive=true
-column=7864421
-encoding=
-highlight=
-line=0
-open=false
-order=-1
-
-[item:license.tex]
-archive=true
-column=0
-encoding=
-highlight=
-line=0
-open=false
-order=-1
-
-[item:migration.tex]
-archive=true
-column=0
-encoding=
-highlight=LaTeX
-line=0
-open=true
-order=2
-
-[item:newfeatures.tex]
-archive=true
-column=86
-encoding=UTF-8
-highlight=LaTeX
-line=1524
-open=true
-order=4
-
-[item:pools.tex]
-archive=true
-column=2
-encoding=
-highlight=LaTeX
-line=0
-open=false
-order=-1
-
-[item:projects.tex]
-archive=true
-column=0
-encoding=
-highlight=
-line=0
-open=false
-order=-1
-
-[item:python.tex]
-archive=true
-column=23
-encoding=
-highlight=LaTeX
-line=6
-open=false
-order=-1
-
-[item:recycling.tex]
-archive=true
-column=2
-encoding=
-highlight=LaTeX
-line=0
-open=true
-order=1
-
-[item:requirements.tex]
-archive=true
-column=7864421
-encoding=
-highlight=
-line=0
-open=false
-order=-1
-
-[item:rescue.tex]
-archive=true
-column=0
-encoding=
-highlight=
-line=0
-open=false
-order=-1
-
-[item:restore.tex]
-archive=true
-column=2
-encoding=
-highlight=LaTeX
-line=0
-open=true
-order=3
-
-[item:spooling.tex]
-archive=true
-column=2
-encoding=
-highlight=LaTeX
-line=0
-open=false
-order=-1
-
-[item:state.tex]
-archive=true
-column=0
-encoding=
-highlight=
-line=0
-open=false
-order=-1
-
-[item:statistics.tex]
-archive=true
-column=33
-encoding=UTF-8
-highlight=LaTeX
-line=9
-open=false
-order=1
-
-[item:strategies.tex]
-archive=true
-column=0
-encoding=
-highlight=
-line=0
-open=false
-order=-1
-
-[item:stunnel.tex]
-archive=true
-column=0
-encoding=
-highlight=
-line=0
-open=false
-order=-1
-
-[item:supportedchangers.tex]
-archive=true
-column=147888641
-encoding=
-highlight=
-line=0
-open=false
-order=-1
-
-[item:supporteddrives.tex]
-archive=true
-column=0
-encoding=
-highlight=
-line=0
-open=false
-order=-1
-
-[item:supportedoses.tex]
-archive=true
-column=0
-encoding=
-highlight=
-line=0
-open=false
-order=-1
-
-[item:thanks.tex]
-archive=true
-column=0
-encoding=
-highlight=
-line=0
-open=false
-order=-1
-
-[item:tls.tex]
-archive=true
-column=25
-encoding=
-highlight=
-line=0
-open=false
-order=-1
-
-[item:tutorial.tex]
-archive=true
-column=10
-encoding=
-highlight=LaTeX
-line=1148
-open=false
-order=-1
-
-[item:vars.tex]
-archive=true
-column=26
-encoding=
-highlight=LaTeX
-line=6
-open=false
-order=-1
-
-[item:verify.tex]
-archive=true
-column=0
-encoding=
-highlight=
-line=0
-open=false
-order=-1
-
-[item:version.tex]
-archive=true
-column=0
-encoding=
-highlight=
-line=0
-open=false
-order=-1
-
-[item:win32.tex]
-archive=true
-column=7864421
-encoding=
-highlight=
-line=0
-open=false
-order=-1
+++ /dev/null
-%%
-%%
-%% The following characters must be preceded by a backslash
-%% to be entered as printable characters:
-%%
-%% # $ % & ~ _ ^ \ { }
-%%
-
-\documentclass[10pt,a4paper]{book}
-
-\topmargin -0.5in
-\oddsidemargin 0.0in
-\evensidemargin 0.0in
-\textheight 10in
-\textwidth 6.5in
-
-\usepackage{html}
-\usepackage{float}
-\usepackage{graphicx}
-\usepackage{bacula}
-\usepackage{longtable}
-\usepackage{makeidx}
-\usepackage{index}
-\usepackage{setspace}
-\usepackage{hyperref}
-\usepackage{url}
-\usepackage{alltt}
-\usepackage{german}
-
-
-\makeindex
-\newindex{dir}{ddx}{dnd}{Director Index}
-\newindex{fd}{fdx}{fnd}{File Daemon Index}
-\newindex{sd}{sdx}{snd}{Storage Daemon Index}
-\newindex{console}{cdx}{cnd}{Console Index}
-\newindex{general}{idx}{ind}{General Index}
-
-\sloppy
-
-\begin{document}
-\sloppy
-
-\newfont{\bighead}{cmr17 at 36pt}
-\parskip 10pt
-\parindent 0pt
-
-\title{\includegraphics{\idir bacula-logo.eps} \\ \bigskip
- \Huge{Bacula Konzepte und \"{U}berblick}
- \begin{center}
- \large{Es kommt bei Nacht und saugt die lebenswichtigen Daten aus Ihren Computern.}
- \end{center}
-}
-
-
-\author{Kern Sibbald}
-\date{\vspace{1.0in}\today \\
- Dieses Handbuch dokumentiert Bacula \linebreak in der Version \fullversion \\
- \vspace{0.2in}
- Copyright \copyright 1999-2009, Free Software Foundation Europe
- e.V. \\
- \vspace{0.2in}
- Permission is granted to copy, distribute and/or modify this document under the terms of the
- GNU Free Documentation License, Version 1.2 published by the Free Software Foundation;
- with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
- A copy of the license is included in the section entitled "`GNU Free Documentation License"'.
-}
-
-\maketitle
-
-\clearpage
-\pagenumbering{roman}
-\tableofcontents
-\clearpage
-\listoffigures
-\clearpage
-\listoftables
-\clearpage
-
-\markboth{Bacula Manual}{}
-\pagestyle{myheadings}
-\markboth{Bacula Version \version}{Bacula Version \version}
-\pagenumbering{arabic}
-\include{general}
-\include{newfeatures}
-\include{state}
-\include{requirements}
-\include{supportedoses}
-\include{supporteddrives}
-\include{tutorial}
-\include{restore}
-\include{recycling}
-\include{disk}
-\include{pools}
-\include{migration}
-\include{strategies}
-\include{autochangers}
-\include{supportedchangers}
-\include{spooling}
-\include{statistics}
-\include{python}
-\include{ansi-labels}
-\include{win32}
-\include{rescue}
-\include{tls}
-\include{dataencryption}
-\include{verify}
-\include{bootstrap}
-\include{license}
-\include{fdl}
-\include{gpl}
-\include{lesser}
-\include{projects}
-\include{thanks}
-\include{bugs}
-\include{vars}
-\include{stunnel}
-\include{dvd}
-
-% pull in the index
-\clearpage
-\printindex[general]
-\printindex[dir]
-\printindex[fd]
-\printindex[sd]
-\printindex[console]
-
-\end{document}
+++ /dev/null
-
-\chapter{Daten-Verschl\"{u}sselung}
-\label{DataEncryption}
-\index[general]{Daten-Versch\"{u}sselung}
-\index[general]{Versch\"{u}sselung!Daten-}
-
-Bacula erm\"{o}glicht Ihnen die Backup-Daten Clientseitig zu verschl\"{u}sseln
-und zu signieren, bevor sie zum Storage-Dienst gesendet werden. W\"{a}hrend
-der Wiederherstellung werden die Signaturen \"{u}berpr\"{u}ft und Abweichungen
-gemeldet. Director- und Storage-Dienst haben dabei zu keinem Zeitpunkt Zugriff
-auf unverschl\"{u}sselte Daten.
-
-Dabei gibt es zwei sehr wichtige Punkte zu beachten:
-\begin{itemize}
-\item zum einen gilt es bei der Wiederherstellung zu bedenken,
- dass es f\"{u}r den Director-Dienst m\"{o}glich ist neue Schl\"{u}ssel
- oder eine andere Konfigurations-Datei auf dem Client zu erstellen.
- Dadurch kann die Verschl\"{u}sselung abgeschaltet oder mit ungewollten
- Schl\"{u}sseln durchgef\"{u}hrt werden. Damit das nicht unbeabsichtigt
- passieren kann, sollten Sie nie den Speicherortder Schl\"{u}ssel, noch
- die Schl\"{u}ssel selbst \"{a}ndern. Falls solche \"{A}nderungen jemals
- notwendig sind, sollten Sie sicherstellen, dass niemals aus versehen
- die alte Konfiguration wiederhergestellt wird. Im schlimmsten Fall
- sind Sie sp\"{a}ter nicht mehr in der Lage sich mit dem Client-Dienst
- zu verbinden.
-\item Die Verschl\"{u}sselung wird nicht bei den Metadaten, wie
- Verzeichnisname, Rechte und Eigent\"{u}mer der Dateien durchgef\"{u}hrt.
- Ebensowenig werden erweiterte Datei-Attribute verschl\"{u}sselt.
- Mac OS X \elink{resource forks}{http://en.wikipedia.org/wiki/Resource_fork}
- werden allerdings verschl\"{u}sselt.
-\end{itemize}
-
-Die Verschl\"{u}sselung und Signierung wird mittels RSA privaten Schl\"{u}ssel
-in Verbindung mit selbstsignierten X509 \"{o}ffentlichen Zertifikate durchgef\"{u}hrt.
-Dieses Verfahren ist auch als \elink{PKI}{http://de.wikipedia.org/wiki/Public-Key-Infrastruktur}
-(Public-Key-Infrastruktur) bekannt.
-
-Jeder Client-Dienst sollte sein eigenes einzigartiges privates/\"{o}ffentliches
-Schl\"{u}ssel-paar besitzen. Zus\"{a}tzlich, zu diesem Schl\"{u}ssel-Paar,
-k\"{o}nnen beliebig viele "`Master Keys"' angegeben werden. Das sind
-Schl\"{u}ssel-Paare die zum entschl\"{u}sseln benutzt werden k\"{o}nnen,
-falls der Schl\"{u}ssel des Client-Dienstes verloren geht. Nur die \"{o}ffentlichen
-Schl\"{u}ssel der Master-Keys sollten auf dem Client zur Verf\"{u}gung stehen
-und {\bf niemals} die privaten.
-
-Die Master-Keys sollten zudem an einem sicheren Ort aufbewart werden,
-zum Beispiel in einem feuerfesten Stahlschrank oder einem Bankdepot.
-Diese Schl\"{u}ssel sollten nie auf den Systemen auf denen der Director-
-und der Storage-Dienst l\"{a}uft aufbewart werden. Ansonsten ist es eventuell
-unautorisierten Benutzer m\"{o}glich auf die verschl\"{u}sselten Daten zuzugreifen.
-
-Obwohl weniger kritisch, sind es auch die Client-Schl\"{u}ssel Wert,
-an einem sicheren Ort gespeichert zu werden.
-
-WARNUNG: Wenn Sie jemals die zur Entschl\"{u}sselung ben\"{o}tigten
-Schl\"{u}ssel verlieren, k\"{o}nnen Sie keine Daten mehr aus Ihrem Backups
-wiederherstellen! Heben Sie {\bf IMMER} eine Kopie der Schl\"{u}ssel
-an einem sicheren Ort au{\ss}erhalb Ihres Standortes auf.
-
-Der wesentliche Ablauf eines jeden Backup-Jobs mit Verschl\"{u}sselung ist:
-\begin{enumerate}
-\item Der Client-Dienst generiert einen Session-Schl\"{u}ssel.
-\item Der Client-Dienst verschl\"{u}sselt diesen Session-Schl\"{u}ssel mittels PKI
- f\"{u}r alle \"{o}ffentlichen Schl\"{u}ssel die konfiguriert sind
- (Client- und Master-Schl\"{u}ssel).
-\item Der Client-Dienst benutzt den Session-Schl\"{u}ssel zum symetrischen
- Verschl\"{u}sseln der Daten.
-\end{enumerate}
-
-
-\section{Bacula mit Unterst\"{u}tzung f\"{u}r Verschl\"{u}sselung kompilieren}
-\index[general]{Bacula mit Unterst\"{u}tzung f\"{u}r Verschl\"{u}sselung kompilieren}
-
-Um die Unterst\"{u}tzung der Daten-Verschl\"{u}sselung aktivieren zu k\"{o}nnen,
-m\"{u}ssen die OpenSSL Header und Bibliotheken installiert sein. Bei der Konfiguration
-des Bacula-Quelltextes muss folgende Option angegeben werden:
-
-\begin{verbatim}
- ./configure --with-openssl ...
-\end{verbatim}
-
-\section{Technische Einzelheiten der Verschl\"{u}sselung}
-\index[general]{Technische Einzelheiten der Verschl\"{u}sselung}
-
-Diese Verschl"`{u}sselung benutzt 128-Bit AES-CBC mit RSA verschl\"{u}sselten
-symetrischen Session-Schl\"{u}sseln. Diese RSA-Schl\"{u}sseln werden vom
-Benutzer erstellt. Wenn Sie OpenSSL in Version 0.9.8 (oder gr\"{o}{\ss}er)
-benutzen, wird f\"{u}r die Signierung der Datei-Hashes SHA-256 verwendet,
-ansonsten SHA-1.
-
-Eine Konfigurations-M\"{o}glichkeit des End-Benutzers f\"{u}r den Algorithmus
-ist momentan nicht vorgesehen, nur die oben genannten werden verwendet.
-Allerdings unterst\"{u}tzen die auf die Volumes geschriebenen Daten auch
-frei w\"{a}hlbare symetrische, asymetrische und Digest Algorithmen.
-Es sind also noch viele M\"{o}glichkeiten zur Erweiterung
-der Verschl\"{u}sselung vorhanden.
-
-Director-seitig wird unterst\"{u}tzt:
-
-\begin{alltt}
-Symmetrische Verschl\"{u}sselung:
- - 128, 192 und 256-bit AES-CBC
- - Blowfish-CBC
-
-Asymmetrische Verschl\"{u}sselung (zum verschl\"{u}sseln der symmetrischen Session-Keys):
- - RSA
-
-Digest Algorithmen:
- - MD5
- - SHA1
- - SHA256
- - SHA512
-\end{alltt}
-
-Die verschiedenen Algorithmen werden durch eine wiederverwendbare
-OpenSSL-Schnittstelle bereitgestellt. Dadurch ist es jederzeit
-M\"{o}glich neue Verschl\"{u}sselungs-Methoden zu implementieren.
-Das Volume-Format ist DER-verschl\"{u}sseltes ASN.1, entwickelt nach
-der "'Cryptographic Message Syntax"` des RFC 3852. Leider war die
-direkte Verwendung von CMS nicht m\"{o}glich, da zu dem Zeitpunkt der
-Entwicklung kein freier DER-Decoder/Encoder f\"{u}r Datenstr\"{o}me zur
-Verf\"{u}gung stand.
-
-\section{Entschl\"{u}sselung mit einem Master Key}
-\index[general]{Entschl\"{u}sselung mit einem Master Key}
-
-Bevorzugter Weise sollten Sie immer eine unverschl\"{u }sselte Kopie
-der Client-Schl\"{u}ssel an einem sicheren Ort aufbewahren.
-Falls sie trotzdem verloren gehen, k\"{o}nnen Sie die gesicherten Daten
-noch mittels der Master-Keys entsch\"{u}sseln.
-
-Dazu m\"{u}ssen folgende Voraussetzungen erf\"{u}llt sein:
-\begin{itemize}
-\item verketten Sie den privaten und \"{o}ffentlichen Master-Schl\"{u}ssel
- in einer einzelnen Schl\"{u}ssel-Paar-Datei, zum Beispiel mit:
- [user@host]\$ cat master.key master.cert \gt master.keypair
-
-\item Setzen Sie den Eintrag "'PKI Keypair"` in der Client-Konfiguration auf
- die eben erzeugte Datei:
-
-\begin{verbatim}
- PKI Keypair = master.keypair
-\end{verbatim}
-
-\item Starten Sie die Wiederherstellung, und das Master-Key-Paar
- wird zum entschl\"{u}sseln der Daten verwendet.
-\end{itemize}
-
-
-\section{Erstellung privater/\"{o}ffentlicher Schl\"{u}ssel}
-\index[general]{Erstellung privater/\"{o}ffentlicher Schl\"{u}ssel}
-
-Mit den folgenden Kommandos generieren Sie ein Master-Key-Paar:
-
-\footnotesize
-\begin{verbatim}
- openssl genrsa -out master.key 2048
- openssl req -new -key master.key -x509 -out master.cert
-\end{verbatim}
-\normalsize
-
-Die folgenden Kommandos erstellen das Schl\"{u}ssel-Paar f\"{u}r
-den Client-Dienst:
-
-\footnotesize
-\begin{verbatim}
- openssl genrsa -out fd-example.key 2048
- openssl req -new -key fd-example.key -x509 -out fd-example.cert
- cat fd-example.key fd-example.cert >fd-example.pem
-\end{verbatim}
-\normalsize
-
-Bez\"{u}glich der verwendeten Datei-Erweiterung f\"{u}r die Schl\"{u}ssel
-gibt es eine Menge Verwirrung. Zum Beispiel kann eine .pem-Datei folgendes
-enthalten: private Schl\"{u}ssel (RSA und DSA), \"{o}ffentliche Schl\"{u}ssel
-(RSA und DSA) und Zertifikate (x509). Das ist das von OpenSSLstandardm\"{a}{\ss}ig
-verwendete Format. Es speichert die Daten im Base64 codiertem DER-Format,
-das von ASCII-Header umgeben wird. So kann es als Text-Datei zwischen verschiedenen
-Computer \"{u}bertragen werden. Eine .pem-Datei kann eine beliebige Anzahl von
-entweder privaten und/oder \"{o}ffentlichen Schl\"{u}sseln enthalten.
-In der Bacula-Konfiguration wird diese Datei-Erweiterung nur f\"{u}r
-Dateien verwendet die jeweils einen privaten und einen \"{o}ffentlichen
-Schl\"{u}ssel enthalten. Zudem wird, wie oben zu sehen, f\"{u}r
-Dateien die nur einen einzigen \"{o}ffentlichen Schl\"{u}ssel enthalten
-die Erweiterung .cert verwendet (als Verweis auf die x509 Zertifikats-Kodierung).
-
-\section{Beispiel-Konfiguration mit Verschl\"{u}sselung}
-\index[general]{Beispiel!Client-Konfiguration mit Verschl\"{u}sselung}
-
-{\bf bacula-fd.conf}
-\footnotesize
-\begin{alltt}
-FileDaemon {
- Name = example-fd
- FDport = 9102
- WorkingDirectory = /var/bacula/working
- Pid Directory = /var/run
- Maximum Concurrent Jobs = 20
-
- PKI Signatures = Yes # aktiviert die Daten-Signierung
- PKI Encryption = Yes # aktiviert die Daten-Verschl\"{u}sselung
- PKI Keypair = "/etc/bacula/fd-example.pem" # private und \"{o}ffentliche Schl\"{u}ssel
- PKI Master Key = "/etc/bacula/master.cert" # NUR der \"{o}ffentliche Schl\"{u}ssel
-}
-\end{alltt}
-\normalsize
+++ /dev/null
-%%
-%%
-
-\chapter{Grundlegendes Volume-Management}
-\label{DiskChapter}
-\index[general]{Grundlegendes Volume-Management}
-\index[general]{Management!Grundlegendes Volume}
-\index[general]{Disk/Festplatten Volumes}
-
-In diesem Kapitel werden die grundlegenden Funktionen erkl\"{a}rt,
-die zum Volume-Management ben\"{o}tigt werden. Die meisten dieser Konzepte
-sind sowohl f\"{u}r Tape- als auch f\"{u}r Disk/Festplatten-Volumes g\"{u}ltig.
-Allerdings wurde dieses Kapitel \"{u}rspr\"{u}nglich geschrieben,
-um das Mangement von Disk-Volumes zu beschreiben. Sie werden diese
-Tendenz sicher stellenweise bemerken, trotzdem gelten alle Konfigurations-
-M\"{o}glichkeiten gleicherma{\ss}en f\"{u}r Tape- und Disk-Volumes.
-
-Disk-Volumes werden normalerweise benutzt, wenn sowieso sehr viel Festplatten-
-Platz verf\"{u}gbar ist, oder die Backup-Jobs innerhalb eines sehr kleinen
-Zeitfensters laufen m\"{u}ssen, wo die Festplatten einen Geschwindigkeitsvorteil
-gegen\"{u}ber den Bandlaufwerken haben.
-
-\section{Schl\"{u}sselkonzepte und Konfigurations-Parameter}
-\label{Concepts}
-\index[general]{Schl\"{u}sselkonzepte und Konfigurations-Parameter }
-\index[general]{Records!Key Concepts and Resource }
-
-Bacula dazu zu bringen, dass es auf Disk-Volumes statt auf Tapes schreibt
-ist im einfachsten Fall sehr leicht zu bewerkstelligen. In der Konfiguration
-des Storage-Dienstes geben Sie dazu als {\bf Archive Device} ein Verzeichnis an.
-Wenn Sie, zum Beispiel, m\"{o}chten das Ihre Backups im Verzeichnis
-{\bf /home/bacula/backups} gespeichert werden, k\"{o}nnen Sie folgende
-Ger\"{a}te-Konfiguration verwenden:
-
-\footnotesize
-\begin{verbatim}
-Device {
- Name = FileBackup
- Media Type = File
- Archive Device = /home/bacula/backups
- Random Access = Yes;
- AutomaticMount = yes;
- RemovableMedia = no;
- AlwaysOpen = no;
-}
-\end{verbatim}
-\normalsize
-
-Zus\"{a}tzlich muss der entsprechende {\bf Storage}-Eintrag in der Konfiguration
-des Director-Dienstes vorhanden sein:
-
-\footnotesize
-\begin{verbatim}
-Storage {
- Name = FileStorage
- Address = host.firma.de
- Password = xxxxx
- Device = FileBackup
- Media Type = File
-}
-\end{verbatim}
-\normalsize
-
-Bacula wird dann die Backup-Daten in die Datei
-{\bf /home/bacula/backups/\lt{}Volume-Name\gt{}} schreiben.
-\lt{}Volume-Name\gt{} ist dabei der Name eines vorher erstellten Volumes.
-Falls Sie ein Volume namens {\bf Vol001} erstellt haben, wird Bacula also
-in die Datei names {\bf /home/bacula/backups/Vol001} schreiben.
-Obwohl Sie diese Datei sp\"{a}ter problemlos in ein anderes Verzeichnis
-verschieben k\"{o}nnen, d\"{u}rfen Sie niemals den Namen der Datei \"{a}ndern.
-Bacula verwendet den Datei-Namen des Volumes als Teil des internen Volume-Labels,
-daher wird Bacula das Volume nicht mehr als korrekt erkennen, wenn der Dateiname
-von Volume-Label abweicht.
-
-Auch wenn bis jetzt alles sehr einfach aussieht gibt es doch ein paar Probleme
-mit dieser Beispiel-Konfiguration. Das Erste ist, dass Bacula immer auf das
-selbe Volume schreiben wird, so lange bis die Festplatte voll ist. Die
-L\"{o}sung daf\"{u}r wird weiter unten beschrieben.
-
-Zus\"{a}tzlich m\"{u}ssen Sie auch noch andere Details beachten, wenn Sie
-zum Beispiel wollen, dass mehrere Backup-Jobs gleichzeitig laufen.
-Eine Beispiel-Konfiguration f\"{u}r so ein Setup finden Sie am Ende
-dieses Kapitels im Abschnitt \ilink{gleichzeitige Disk Jobs}{ConcurrentDiskJobs}.
-
-
-\subsection{Pool-Konfigurations-Optionen zur Begrenzung der Volume-Benutzung}
-\index[general]{Benutzung!Pool-Konfigurations-Optionen zur Begrenzung der Volume-}
-\index[general]{Pool-Konfigurations-Optionen zur Begrenzung der Volume-Benutzung}
-
-Hier ist eine Liste aller Optionen die Sie in der Pool-Konfiguration
-angeben k\"{o}nnen, um die Benutzung der Volumes durch Bacula zu begrenzen:
-
-\begin{itemize}
-\item Um jedes Volume nur einmal zu benutzen (in diesem Beispiel nur f\"{u}r einen
-Backup-Job pro Volume) k\"{o}nnen Sie
-
- {\bf UseVolumeOnce = yes}
-
-in der Pool-Konfiguration angeben.
-
-\item Um nnn Backup-Jobs auf jedes Volume zu schreiben, benutzen Sie:
-
- {\bf Maximum Volume Jobs = nnn}.
-
-\item Um die Gr\"{o}{\ss}e des Volumes zu begrenzen, konfigurieren Sie:
-
- {\bf Maximum Volume Bytes = mmmm}.
-
- Bitte beachten Sie, dass, wenn Sie Disk-Volumes mit Bacula-Version bis
- 1.39.28 verwenden, Sie die maximale Volume-Gr\"{o}{\ss}e auf einen
- sinnvollen Wert, wie zum Beispiel 5 GB, setzen. Das ist notwendig,
- weil Bacula w\"{a}hrend der Wiederherstellung das gesamte Volume
- lesen muss, bis an den Punkt wo die wiederherzustellenden Daten
- beginnen. Wenn Ihre Volumes 50GB gro{\ss} sind, dauert das
- nat\"{u}rlich entsprechend l\"{a}nger. Auch bei einer teilweise
- defekten Festplatte verlieren Sie wahrscheinlich weniger Volumes,
- wenn diese entsprechend kleiner sind.
-
-\item Um die Zeit einzuschr\"{a}nken in der ein Volume beschrieben werden darf,
- k\"{o}nnen Sie diesen Parameter setzen:
-
-{\bf Volume Use Duration = ttt}.
-\end{itemize}
-
-Obwohl Sie wahrscheinlich niemals die Anzahl der Bytes begrenzen wollen,
-die auf ein Tape geschrieben werden d\"{u}rfen, k\"{o}nnen die anderen
-genannten Konfigurations-Optionen auch bei Bandlaufwerken sehr n\"{u}tzlich
-sein. Als Beispiel k\"{o}nnen Sie mit den oben beschriebenen Optionen
-daf\"{u}r sorgen, dass Ihre B\"{a}nder in einer t\"{a}glichen Rotation
-verwendet werden.
-
-Wie schon erw\"{a}hnt, wird jede dieser Optionen innerhalb der Pool-
-Konfiguration angegeben die f\"{u}r den Pool, in dem die Volumes sind,
-gilt. Die Parameter {\bf Maximum Volume Job}, {\bf Maximum Volume Bytes}
-und {\bf Volume Use Duration} k\"{o}nnen f\"{u}r jedes Volume einzelt
-gesetzt werden. Dazu werden die Werte aus der Pool-Konfiguration beim
-Labeln des Volumes in einen eigenen Datenbank-Eintrag, der nur f\"{u}r
-das Volume g\"{u}ltig ist, \"{u}bernommen. Dieser Datenbank-Eintrag kann
-dann mittels des Console-Kommandos {\bf update volume} seperat angepasst
-werden. Dadurch das die Pool-Konfiguration als eigener Eintrag f\"{u}r
-die Volumes in die Datenbank \"{u}bernommen wird, ist eine \"{A}nderung
-in der Pool-Konfiguration nur f\"{u}r Volumes g\"{u}ltig die nachher
-erstellt werden. Um die neue Pool-Konfiguration auch auf die
-bereits bestehenden Volumes anzuwenden, muss in der Console bei dem
-Kommando {bf update volume} die Funktion {bf All Volumes from Pool}
-aufgrufen werden.
-
-Als ein Beispiel f\"{u}r die Benutzung eines der oben genannten
-Paramter, nehmen wir einmal an, Ihre Pool-Konfiguration sieht so aus:
-
-\footnotesize
-\begin{verbatim}
-Pool {
- Name = File
- Pool Type = Backup
- Volume Use Duration = 23h
-}
-\end{verbatim}
-\normalsize
-
-Wenn Ihre Backup-Jobs dann einmal am Tag laufen (also alle 24 Stunden)
-wird Bacula f\"{u}r jeden Backup-Lauf ein neues Volume verwenden, da f\"{u}r
-die Volumes eine maximale Benutzungs-Zeit von 23 Stunden gesetzt ist.
-Die Zeit gilt dabei ab dem ersten Schreibvorgang auf dem Volume.
-Bedenken Sie, dass das Setzen einer Use-Duration f\"{u}r Tape-Volumes dazu
-f\"{u}hren kann, dass eventuell auch am Wochenende neue leere Tapes in das Laufwerk
-gelegt werden m\"{u}ssen (sofern Sie keinen Autochanger benutzen).
-
-\subsection{Automatisches labeln der Volumes}
-\label{AutomaticLabeling}
-\index[general]{Automatisches labeln der Volumes}
-\index[general]{Labeln!Volumes automatisch }
-
-Wenn Sie die genannten Konfigurations-Parameter benutzen, sto{\ss}en
-Sie wahrscheinlich auf das n\"{a}chste Problem: Sie m\"{u}ssen die
-Volumes labeln. Sie k\"{o}nnen dabei zwischen zwei Varianten w\"{a}hlen,
-entweder Sie labeln die Volumes manuell bevor Bacula sie ben\"{o}tigt,
-oder Sie lassen Sie automatisch durch Bacula, in dem Moment wo sie
-gebraucht werden, labeln. Beim automatischen Labeln der Volumes
-k\"{o}nnen Sie auf eine vielzahl von Informationen, Umgebungsvariablen
-und internen Z\"{a}hlern von Bacula zugreifen, um sinnvolle Volume-Label
-erstellen zu lassen. Sie k\"{o}nnen auch mittels eines Python-Script
-das Bacula-Event "`NewVolume"' auswerten und durch das Script ein
-neues Volume erstellen lassen. Dabei haben Sie dann alle Freiheit was
-den Namen des zu erstellenden Volumes angeht. Mehr Informationen
-\"{u}ber die Verwendung von Python-Scripten finden Sie im Kapitel
-\ilink{Python Scripte}{PythonChapter} dieses Handbuchs.
-
-Das automatische Labeln von Volumes kann auch mit Tapes benutzt werden,
-dabei ist allerdings zu bendeken, dass die Tapes daf\"{u}r gemountet
-werden m\"{u}ssen, was eventuell menschliches Eingreifen erfordert.
-Automatisches Labeln nach Templates (Vorlagen) funktioniert mit Autochangern
-nicht, da Bacula niemals auf Slots zugreift, die unbekannte Tapes enthalten.
-Im Kapitel \ilink{Autochanger}{AutochangersChapter} dieses Handbuchs
-sind mehrere Methoden beschrieben, wie alle Tapes innerhalb des Autochangers
-gelabelt werden k\"{o}nnen.
-
-Automatisches Labeln der Volumes wird durch Anpassungen in der Pool-
-(Director) und Ger\"{a}te- (Storage) Konfiguration, wie unten
-beschrieben, aktiviert. In der Pool-Konfiguration m\"{u}ssen Sie Bacula
-das Label-Format vorgeben. In diesem Format werden dann die neuen Volumes
-benannt. In der einfachsten Form ist das Format nur der Volume-Name
-an den Bacula dann eine vierstellige laufende Nummer anh\"{a}ngt.
-Diese Nummer beginnt bei 0000 und wird pro Volume immer uns Eins erh\"{o}ht.
-Wenn Sie Ihre Pool-Konfiguration also folgend anpassen:
-
-\footnotesize
-\begin{verbatim}
-Pool {
- Name = File
- Pool Type = Backup
- Volume Use Duration = 23h
- LabelFormat = "Vol"
-}
-\end{verbatim}
-\normalsize
-
-wird Bacula Volumes names Vol0001, Vol0002 und so weiter immer dann erstellen
-wenn sie ben\"{o}tigt werden. Weit komplexere und ausf\"{u}hrliche Namen
-lassen sich mittels Variablen-Auswertung erstellen. Hilfe dazu finden Sie im
-Kapitel \ilink{Variablen-Auswertung}{VarsChapter}.
-
-N\"{a}here Angaben zum {\bf Label Format} finden Sie im Kapitel
-"`Label Format"' des Bacula-Installations- und Konfigurations-Handbuchs.
-
-Der zweite notwendige Schritt um das automatische Labeln zu aktivieren, ist es
-dem Storage-Dienst das Labeln zu erlauben. Das tun Sie indem Sie {\bf LabelMedia = yes}
-in der Ger\"{a}te-Konfiguration angeben:
-
-\footnotesize
-\begin{verbatim}
-Device {
- Name = File
- Media Type = File
- Archive Device = /home/bacula/backups
- Random Access = Yes;
- AutomaticMount = yes;
- RemovableMedia = no;
- AlwaysOpen = no;
- LabelMedia = yes
-}
-\end{verbatim}
-\normalsize
-
-\subsection{Wiederverwendung und Begrenzung der Anzahl der Volumes}
-\label{Recycling1}
-\index[general]{Wiederverwendung!Wiederverwendung und Begrenzung der Anzahl der Volumes}
-\index[general]{Wiederverwendung und Begrenzung der Anzahl der Volumes}
-
-Das oben beschriebene automatische Labeln der Volumes l\"{a}sst ein neues Problem
-entstehen: es wird eine Art Volume-Management ben\"{o}tigt. Mit dem bisherigen
-Schema wird jeden Tag ein neues Volume erstellt. Wenn Sie keine Aufbewarungszeitr\"{a}ume
-konfiguriert haben, wird sich Ihre Katalog-Datenbank, zus\"{a}tzlich
-zu den jeden Tag enstehenden Volumes, immer weiter mit den Informationen
-\"{u}ber alle von Bacula gesicherten Dateien f\"{u}llen.
-
-Bacula stellt folgende Konfigurations-Parameter zur Verf\"{u}gung
-um diese Probleme automatisch handzuhaben:
-
-\begin{enumerate}
-\item der Aufbewarungszeitraum f\"{u}r Datei-Eintr\"{a}ge im Katalog, der
- \ilink{File Retention = ttt}{FileRetention} Eintrag in der Client-Konfiguration
-\item der Aufbewarungszeitraum f\"{u}r Job-Eintr\"{a}ge im Katalog, der
- \ilink{Job Retention = ttt}{JobRetention} Eintrag in der Client-Konfiguration
-\item Der
- \ilink{ AutoPrune = yes}{AutoPrune} Eintrag in der Client-Konfiguration
- erlaubt Bacula die beiden oberen Augbewarungszeitr\"{a}ume anzuwenden.
-\item Der
- \ilink{ Volume Retention = ttt}{VolRetention} Eintrag in der Pool-Konfiguration
- bestimmt die Zeit, in der die Volumes nicht \"{u}berschrieben werden d\"{u}rfen.
-\item Der
- \ilink{ AutoPrune = yes}{PoolAutoPrune} Eintrag in der Pool-Konfiguration
- um Bacula die automatische Anwendung der Volume Retention zu erlauben.
-\item Der
- \ilink{ Recycle = yes}{PoolRecycle} Eintrag in der Pool-Konfiguration
- um Bacula zu erlauben, Volumes mit abgelaufener Aufbewarungzeit wiederzuverwenden.
-\item Der
- \ilink{ Recycle Oldest Volume = yes}{RecycleOldest} Eintrag in der Pool-Konfiguration
- sagt Bacula, dass die Ablaufzeitr\"{a}ume nur auf das \"{a}lteste Volume im Pool
- angewendet werden sollen. Wenn alle enthaltenen Daten abgelaufen sind, wird das
- Volume wiederverwendet.
-\item Der
- \ilink{ Recycle Current Volume = yes}{RecycleCurrent} Eintrag in der Pool-Konfiguration
- sagt Bacula, dass die Ablaufzeitr\"{a}ume nur auf das momentan gemountete Volume
- angewendet werden sollen. Wenn alle enthaltenen Daten abgelaufen sind, wird das
- Volume wiederverwendet.
-\item Der
- \ilink{ Purge Oldest Volume = yes}{PurgeOldest} Eintrag in der Pool-Konfiguration
- erlaubt Bacula die Wiederverwendung des \"{a}ltesten Volumes im Pool
- zu erzwingen, wenn ein leeres Volume ben\"{o}tigt wird.
- {\bf Achtung! Dabei werden keine Ablaufzeitr\"{a}ume beachtet. Das \"{a}lteste
- vorhandene Volume wird einfach widerverwendet. Normalerweise sollte
- "`Recycle Oldest Volume"' anstelle dieses Eintrags verwendet werden.}
-\item Der
- \ilink{ Maximum Volumes = nnn}{MaxVolumes} Eintrag in der Pool-Konfiguration
- begrenzt die maximale Anzahl von Volumes die Bacula f\"{u}r diesen Pool erstellen darf.
-\end{enumerate}
-
-Die ersten drei Konfigurations-Eintr\"{a}ge (File Retention, Job Retention und AutoPrune)
-bestimmen die Zeit, die die Job- und Datei-Eintr\"{a}ge in der Katalog-Datenbank
-aufbewart werden. Eine genaue Beschreibung dieser Parameter finden Sie im Kapitel
-\ilink{automatische Volume Wiederverwendung}{RecyclingChapter} in diesem Handbuch.
-
-Volume Retention, AutoPrune und Recycle bestimmen, wie lange Bacula die Volumes
-vor dem Wiederbeschreiben aufbewart. Auch das wird im Kapitel
-\ilink{automatische Volume Wiederverwendung}{RecyclingChapter} n\"{a}her beschrieben.
-
-Der Parameter "`Maximum Volumes"' kann in Verbindung mit der "`Volume Retention
-Period"' dazu verwendet werden, die maximale Anzahl der Volumes zu begrenzen
-die Bacula verwendet. Wenn eine angemessene Aufbewarungszeit f\"{u}r die Volumes
-gesetzt ist, werden die Volumes, kurz bevor wieder ein neues Volume
-ben\"{o}tigt wird, automatisch ablaufen. Das periodische Wiederverwenden einer
-festen Anzahl von Volumes kann auch durch setzen von {\bf Recycle Oldest Volume = yes}
-oder {\bf Recycle Current Volume = yes} erreicht werden. In diesem Fall wird Bacula,
-wenn ein neues Volume ben\"{o}tigt wird, das enstsprechende Volume wiederverwenden.
-
-\label{ConcurrentDiskJobs}
-\section{parallele Festplatten-Jobs}
-\index[general]{parallele Festplatten-Jobs}
-
-Oberhalb wurde beschrieben, wie Sie ein einzelnes Storage-Ger\"{a}t
-namens {\bf FileBackup} benutzen k\"{o}nnen, um die zu sichernden Daten
-auf Volumes im Verzeichnis {\bf /home/bacula/backups} zu schreiben.
-Nat\"{u}rlich ist es auch m\"{o}glich mehrere Jobs gleichzeitig auf
-diesem einen Storage-Ger\"{a}t laufen zu lassen. Alle Jobs werden
-dann parallel auf das Volume geschrieben.
-
-
-Falls Sie mehrere Pools, was auch bedeutet mehrere Volumes,
-verwenden wollen, oder m\"{o}chten das jeder Backup-Client
-auf ein eigenes Volume gesichert wird, oder in ein seperates
-Verzeichnis wie etwa {\bf /home/bacula/client1} und
-{\bf /home/bacula/client2}, dann werden Sie das mit der bisherigen
-Konfiguration nicht bewerkstelligen k\"{o}nnen. Das liegt daran,
-dass Bacula Festplatten-Volumes nach den gleichen Regeln
-behandelt wie Bandlaufwerke. Ein Storage-Ger\"{a}t kann zu
-jeden beliebigen Zeitpunkt nur ein einziges Volume enthalten.
-Wenn Sie also gleichzeitig auf mehreren Volumes schreiben
-m\"{o}chten, m\"{u}ssen Sie auch mehrere Storage-Ger\"{a}te
-in der Konfiguration des Storage-Dienstes und des Director-Dienstes
-angeben.
-
-Mehrere Ger\"{a}te-Definitionen sind also notwendig, wenn auf mehr als
-ein Storage-Ger\"{a}t oder in verschiedene Verzeichnisse gesichert werden soll.
-Weiterhin m\"{u}ssen Sie wissen, dass in der Katalog-Datenbank nur die
-Informationen \"{u}ber den "`Media-Type"' und nicht das spezielle
-Storage-Ger\"{a}t gespeichert werden. Dadurch wird es m\"{o}glich,
-dass, zum Beispiel ein Tape, in jedem anderen kompatiblen Storage-Ger\"{a}t
-gemounted werden kann. Diese Kompitabilit\"{a}t wird durch einen identischen
-Media-Type der verschiedene Storage-Ger\"{a}te erreicht. Das ist auch
-f\"{u}r Festplatten-Volumes g\"{u}ltig. Da ein Volume, das vom Storage-
-Ger\"{a}t in dem Verzeichnis {\bf /home/bacula/backups} beschrieben
-wurde, nicht von einem Storage-Ger\"{a}t gelesen werden kann, dass
-{\bf /home/bacula/client1} als "`ArchiveDevice"' konfiguriert hat,
-werden Sie Probleme bei der Wiederherstellung von Daten bekommen,
-falls beide Ger\"{a}te mit {Media Type = File} angegeben sind.
-Bei der Wiederherstellung von Daten wird Bacula das erste zur Verf\"{u}gung
-stehende Laufwerk mit dem passenden "`Media Type"' w\"{a}hlen,
-unabh\"{a}hngig davon, ob es das Richtige ist. Falls das verwirrend klingt,
-erinnern Sie sich daran, dass der Director-Dienst nur den Volume-Namen
-und den Media-Type kennt. Auf welchen Ger\"{a}t das Volume beschrieben wurde,
-und unter welchem Verzeichnis, ist zu diesem Zeitpunkt unbekannt. Daher
-m\"{u}ssen Sie Ihre Volumes, mittels des Media Types, den korrekten
-Ger\"{a}ten zuordnen.
-
-Das folgende Beispiel zeigt eine Konfiguration, bei der zwei Clients
-zwei verschiedene Pools und Verzeichnisse zum speichern ihrer Daten
-benutzen.
-
-\label{Example2}
-\section{Ein Beispiel}
-\index[general]{Example }
-%%TODO index => Example ..... for what??
-
-Das folgende Beispiel ist nicht sehr praxisnah, aber es reicht aus, um in kurzer
-Zeit, den Ablauf zu demonstrieren. In diesem Beispiel gibt es zwei Clients
-die auf je einen Satz von 12 Volumes und in zwei verschiedene Verzeichnisse
-gesichert werden. Jedes Volume wird nur einmal benutzt und innerhalb einer
-Stunden werden vier Vollbackups gestartet. Damit dauert der komplette Lauf
-\"{u}ber alle 12 Volumes pro Client nur 3 Stunden.
-
-Der Schl\"{u}ssel hierbei ist, dass die beiden physikalischen Storage-
-Ger\"{a}te unterschiedliche Media Types benutzen. Das erm\"{o}glicht
-dem Director-Dienst, bei der Wiederherstellung von Daten, das richtige
-Gera\"{a}t auszuw\"{a}hlen.
-
-Die Director-Dienst-Konfiguration sind wie folgend aus:
-
-\footnotesize
-\begin{verbatim}
-Director {
- Name = my-dir
- QueryFile = "~/bacula/bin/query.sql"
- PidDirectory = "~/bacula/working"
- WorkingDirectory = "~/bacula/working"
- Password = dir_password
-}
-Schedule {
- Name = "FourPerHour"
- Run = Level=Full hourly at 0:05
- Run = Level=Full hourly at 0:20
- Run = Level=Full hourly at 0:35
- Run = Level=Full hourly at 0:50
-}
-Job {
- Name = "RecycleExample"
- Type = Backup
- Level = Full
- Client = Rufus
- FileSet= "Example FileSet"
- Messages = Standard
- Storage = FileStorage
- Pool = Recycle
- Schedule = FourPerHour
-}
-
-Job {
- Name = "RecycleExample2"
- Type = Backup
- Level = Full
- Client = Roxie
- FileSet= "Example FileSet"
- Messages = Standard
- Storage = FileStorage1
- Pool = Recycle1
- Schedule = FourPerHour
-}
-
-FileSet {
- Name = "Example FileSet"
- Include {
- Options {
- compression=GZIP
- signature=SHA1
- }
- File = /home/kern/bacula/bin
- }
-}
-Client {
- Name = Rufus
- Address = rufus
- Catalog = BackupDB
- Password = client_password
-}
-
-Client {
- Name = Roxie
- Address = roxie
- Catalog = BackupDB
- Password = client1_password
-}
-
-Storage {
- Name = FileStorage
- Address = rufus
- Password = local_storage_password
- Device = RecycleDir
- Media Type = File
-}
-
-Storage {
- Name = FileStorage1
- Address = rufus
- Password = local_storage_password
- Device = RecycleDir1
- Media Type = File1
-}
-
-Catalog {
- Name = BackupDB
- dbname = bacula; user = bacula; password = ""
-}
-Messages {
- Name = Standard
- ...
-}
-Pool {
- Name = Recycle
- Use Volume Once = yes
- Pool Type = Backup
- LabelFormat = "Recycle-"
- AutoPrune = yes
- VolumeRetention = 2h
- Maximum Volumes = 12
- Recycle = yes
-}
-
-Pool {
- Name = Recycle1
- Use Volume Once = yes
- Pool Type = Backup
- LabelFormat = "Recycle1-"
- AutoPrune = yes
- VolumeRetention = 2h
- Maximum Volumes = 12
- Recycle = yes
-}
-
-\end{verbatim}
-\normalsize
-
-und die Konfiguration des Storage-Dienstes:
-
-\footnotesize
-\begin{verbatim}
-Storage {
- Name = my-sd
- WorkingDirectory = "~/bacula/working"
- Pid Directory = "~/bacula/working"
- MaximumConcurrentJobs = 10
-}
-Director {
- Name = my-dir
- Password = local_storage_password
-}
-Device {
- Name = RecycleDir
- Media Type = File
- Archive Device = /home/bacula/backups
- LabelMedia = yes;
- Random Access = Yes;
- AutomaticMount = yes;
- RemovableMedia = no;
- AlwaysOpen = no;
-}
-
-Device {
- Name = RecycleDir1
- Media Type = File1
- Archive Device = /home/bacula/backups1
- LabelMedia = yes;
- Random Access = Yes;
- AutomaticMount = yes;
- RemovableMedia = no;
- AlwaysOpen = no;
-}
-
-Messages {
- Name = Standard
- director = my-dir = all
-}
-\end{verbatim}
-\normalsize
-
-Mit ein wenig Anpassung k\"{o}nnen Sie dieses Beispiel als Grundlage
-f\"{u}r einen w\"{o}chentlichen oder monatlichen Backup-Ablauf
-verwenden. Beacht6en Sie dabei aber den zur Verf\"{u}gung stehenden
-Festplattenplatz.
-
-\label{MultipleDisks}
-\section{Backup auf mehrere Festplatten}
-\index[general]{Festplatten!Backup auf mehrere }
-\index[general]{Backup auf mehrere Festplatten }
-
-Bacula kann nat\"{u}rlich auch auf mehrere Festplatten sichern, dabei muss
-aber jede Festplatte in der Storage-Dienst-Konfiguration als eigenes Ger\"{a}t
-angegeben werden. Dann kann \"{u}ber die Client-Konfiguration das zu
-benutzende Ger\"{a}t, also die Festplatte, ausgew\"{a}hlt werden. Zus\"{a}tzlich
-muss jedes Storage-Ger\"{a}t einen anderen Media Type benutzen, damit Bacula
-bei der Wiederherstellung von Daten das richtige Ger\"{a}t ausw\"{a}hlen kann.
-
-Wenn Sie zwei Festplatten oder Partitionen als ein logisches Storage-Ger\"{a}t
-verwenden wollen, wird es etwas komplizierter, da Bacula so ein vorgehen nicht
-direkt unterst\"{u}tzt. Trotzdem ist es m\"{o}glich zwei Festplatten als ein
-Ger\"{a}t anzusprechen, indem Sie die Volume-Dateien auf den Festplatten
-verlinken.
-
-Angenommen Sie haben zwei Festplatten namens {\bf /disk1} und {\bf/disk2}.
-Wenn Sie jetzt die Standard-Konfiguration f\"{u}r ein Backup auf die erste
-Festplatte anlegen, sieht Ihre Storage-Dienst-Konfiguration wie folgt aus:
-
-\footnotesize
-\begin{verbatim}
-Device {
- Name = client1
- Media Type = File
- Archive Device = /disk1
- LabelMedia = yes;
- Random Access = Yes;
- AutomaticMount = yes;
- RemovableMedia = no;
- AlwaysOpen = no;
-}
-\end{verbatim}
-\normalsize
-
-Da es keinen Weg gibt diese Ger\"{a}te-Konfiguration auf beide Festplatten zeigen
-zu lassen, m\"{u}ssen Sie die Volumes auf /disk2 auf folgende Weise von Hand erstellen:
-
-\footnotesize
-\begin{verbatim}
-ln -s /disk2/Disk2-vol001 /disk1/Disk2-vol001
-ln -s /disk2/Disk2-vol002 /disk1/Disk2-vol002
-ln -s /disk2/Disk2-vol003 /disk1/Disk2-vol003
-...
-\end{verbatim}
-\normalsize
-
-An diesem Punkt k\"{o}nnen Sie die Volumes mit den folgenden Namen labeln:
-{\bf Disk2-vol001}, {\bf Disk2-vol002}, ... . Bacula wird sie dann so benutzen
-als w\"{a}ren sie auf /disk1, aber die Daten werden in Wirklichkeit auf /disk2
-geschrieben. Die einzigen Unbequemlichkeit dabei sind, dass Sie die Namen
-der Volumes ausdr\"{u}cklich angeben m\"{u}ssen und dass das automatische
-Labeln der Volumes nur noch funktioniert, wenn die Label der Volumes
-genau den Namen der Links entsprechen, die Sie angelegt haben.
-
-Wichtig zu wissen ist, dass Bacula Volumes auf Festplatten, soweit wie
-m\"{o}glich, als Bandlaufwerke zu behandelen zu versucht. Das bedeutet,
-dass immer nur ein einziges Festplatten-Volume zur Zeit in einem,
-in der Storage-Dienst-Konfiguration angebenen Ger\"{a}t, gemounted sein
-kann. Sie k\"{o}nnen mehrere Backup-Jobs parallel auf das gerade
-gemountete Volume schreiben lassen, aber wenn Sie die Jobs gleichzeitig
-auf unterschiedliche Volumes schreiben lassen wollen, m\"{u}ssen Sie
-mehrere Ger\"{a}te-Konfiguration, eine f\"{u}r jeden gleichzeitigen Job,
-anlegen. Das ist dasselbe Vorgehen, wie es bei zwei Bandlaufwerken
-erforderlich ist. Allerdings gibt es einen gro{\ss}en Unterschied,
-die Volumes die Sie auf Festplatten erstellen k\"{o}nnen nicht so
-ohne weiteres gegen einander ausgetauscht werden, wie es bei Bandlaufwerken
-m\"{o}glich ist. Daher muss jedes Festplatten-Volume/-Ger\"{a}t einen
-anderen Media Type verwenden, nur so kann sichergestellt werden,
-dass Bacula bei der Wiederherstellung das korrekte Ger\"{a}t
-ausw\"{a}hlt.
-
-Ein Beispiel daf\"{u}r:
-
-\footnotesize
-\begin{verbatim}
-Device {
- Name = Disk1
- Media Type = File1
- Archive Device = /disk1
- LabelMedia = yes;
- Random Access = Yes;
- AutomaticMount = yes;
- RemovableMedia = no;
- AlwaysOpen = no;
-}
-
-Device {
- Name = Disk2
- Media Type = File2
- Archive Device = /disk2
- LabelMedia = yes;
- Random Access = Yes;
- AutomaticMount = yes;
- RemovableMedia = no;
- AlwaysOpen = no;
-}
-\end{verbatim}
-\normalsize
-
-Mit den oben genannten Ger\"{a}te-Konfigurationen k\"{o}nnen Sie
-zwei Backup-Jobs parallel auf zwei veschiedene Ger\"{a}te schreiben,
-eine Job auf {\bf /disk1} und einen Job auf {\bf /disk2}. Durch den
-unterschiedlichen Media Type kann Bacula das richtige Ger\"{a}tzur
-Wiederherstellung von Daten bestimmen.
-
-\label{MultipleClients}
-\section{\"{U}berlegungen bez\"{u}glich mehrerer Clients}
-\index[general]{Clients!\"{U}berlegungen bez\"{u}glich mehrerer }
-\index[general]{mehrere Clients}
-
-Bevor wir dem obigen Beispiel einen weiteren Client hinzuf\"{u}gen,
-sollten, sollten folgende Aspekte bedacht werden:
-
-\begin{itemize}
-\item auch wenn der zweite Client auf den gleichen Satz Volumes gesichert werden kann,
- wollen Sie eventuell einen eigene Satz Volumes f\"{u}r ihn verwenden.
-\item Sie k\"{o}nnen die Daten auf anderen Volumes sichern, indem Sie einen zweiten
- Pool anlegen, der einen anderen Namen hat und ein anderes {\bf LabelFormat} verwendet.
-\item Wenn Sie die Volumes f\"{u}r den zweiten Client in einem anderen Verzeichnis,
- oder zur Lastverteilung auf einer anderen Festplatte, speichern m\"{o}chten,
- m\"{u}ssen Sie ein zweites Storage-Ger\"{a}t in der Storage-Dienst-Konfiguration
- anlegen. Dabei muss der Ger\"{a}te-Name anders sein und das {\bf ArchiveDevice}
- darf anders sein. Um sicherzustellen, dass sich die Volumes eindeutig den
- Ger\"{a}ten und Pools zuordnen lassen, verwenden Sie unterschiedliche Media Types.
-\end{itemize}
-
-Hier ein Beispiel f\"{u}r zwei Backup-Clients die jeder in einen anderen
-Pool und auf unterschiedlich viele Volumes gesichert werden. Zus\"{a}tzlich
-schreiben sie in unterschiedliche Verzeichnisse mit unterschiedlich gelabelten
-Volumes.
-
-Hier die Konfiguration des Director-Dienstes:
-
-\footnotesize
-\begin{verbatim}
-Director {
- Name = my-dir
- QueryFile = "~/bacula/bin/query.sql"
- PidDirectory = "~/bacula/working"
- WorkingDirectory = "~/bacula/working"
- Password = dir_password
-}
-# Basic weekly schedule
-Schedule {
- Name = "WeeklySchedule"
- Run = Level=Full fri at 1:30
- Run = Level=Incremental sat-thu at 1:30
-}
-FileSet {
- Name = "Example FileSet"
- Include {
- Options {
- compression=GZIP
- signature=SHA1
- }
- File = /home/kern/bacula/bin
- }
-}
-Job {
- Name = "Backup-client1"
- Type = Backup
- Level = Full
- Client = client1
- FileSet= "Example FileSet"
- Messages = Standard
- Storage = File1
- Pool = client1
- Schedule = "WeeklySchedule"
-}
-Job {
- Name = "Backup-client2"
- Type = Backup
- Level = Full
- Client = client2
- FileSet= "Example FileSet"
- Messages = Standard
- Storage = File2
- Pool = client2
- Schedule = "WeeklySchedule"
-}
-Client {
- Name = client1
- Address = client1
- Catalog = BackupDB
- Password = client1_password
- File Retention = 7d
-}
-Client {
- Name = client2
- Address = client2
- Catalog = BackupDB
- Password = client2_password
-}
-# Two Storage definitions with different Media Types
-# permits different directories
-Storage {
- Name = File1
- Address = rufus
- Password = local_storage_password
- Device = client1
- Media Type = File1
-}
-Storage {
- Name = File2
- Address = rufus
- Password = local_storage_password
- Device = client2
- Media Type = File2
-}
-Catalog {
- Name = BackupDB
- dbname = bacula; user = bacula; password = ""
-}
-Messages {
- Name = Standard
- ...
-}
-# Two pools permits different cycling periods and Volume names
-# Cycle through 15 Volumes (two weeks)
-Pool {
- Name = client1
- Use Volume Once = yes
- Pool Type = Backup
- LabelFormat = "Client1-"
- AutoPrune = yes
- VolumeRetention = 13d
- Maximum Volumes = 15
- Recycle = yes
-}
-# Cycle through 8 Volumes (1 week)
-Pool {
- Name = client2
- Use Volume Once = yes
- Pool Type = Backup
- LabelFormat = "Client2-"
- AutoPrune = yes
- VolumeRetention = 6d
- Maximum Volumes = 8
- Recycle = yes
-}
-\end{verbatim}
-\normalsize
-
-und die Storage-Dienst-Konfiguration:
-
-\footnotesize
-\begin{verbatim}
-Storage {
- Name = my-sd
- WorkingDirectory = "~/bacula/working"
- Pid Directory = "~/bacula/working"
- MaximumConcurrentJobs = 10
-}
-Director {
- Name = my-dir
- Password = local_storage_password
-}
-# Archive directory for Client1
-Device {
- Name = client1
- Media Type = File1
- Archive Device = /home/bacula/client1
- LabelMedia = yes;
- Random Access = Yes;
- AutomaticMount = yes;
- RemovableMedia = no;
- AlwaysOpen = no;
-}
-# Archive directory for Client2
-Device {
- Name = client2
- Media Type = File2
- Archive Device = /home/bacula/client2
- LabelMedia = yes;
- Random Access = Yes;
- AutomaticMount = yes;
- RemovableMedia = no;
- AlwaysOpen = no;
-}
-Messages {
- Name = Standard
- director = my-dir = all
-}
-\end{verbatim}
-\normalsize
+++ /dev/null
-#
-# Avoid that @VERSION@ and @DATE@ are changed by configure
-# This file is sourced by update_version
-#
-echo "s%@VERSION@%${VERSION}%g" >${out}
-echo "s%@DATE@%${DATE}%g" >>${out}
+++ /dev/null
-%%
-%%
-
-\chapter{DVD Volumes}
-\label{_DVDChapterStart}
-\index[general]{DVD Volumes}
-\index[general]{Volumes!DVD}
-
-Bacula erlaubt es Ihnen Ihre Daten auf DVDs zu sichern,
-dabei werden alle DVD-Formate, wie DVD+RW, DVD+R, DVD-R oder DVD-RW,
-unterst\"{u}tzt. Bacula schreibt dabei die Daten zuerst in eine
-Image-Datei im Spool-Verzeichnis und je nach Konfiguration,
-zum Beispiel wenn die Image-Datei eine bestimmte Gr\"{o}{\ss}e
-erreicht hat oder direkt nach dem Job, wird diese Image-Datei auf die
-DVD geschrieben. Der eigentliche Schreibvorgang wird von dem
-Script {\bf dvd-handler} gesteuert. Dieses Script verwendet das
-Programm {\bf growisofs} um DVDs zu erstellen
-oder weitere Daten zu einer DVD hinzuzuf\"{u}gen.
-
-Um DVDs mit Bacula schreiben zu k\"{o}nnen, m\"{u}ssen Sie die
-{\bf dvd+rw-tools} in der Version {\gt}= 7.1 auf Ihrem System
-installiert haben. Falls Sie eine \"{a}ltere Version als 7.1
-verwenden, m\"{u}ssen Sie den Quelltext patchen, Patches f\"{u}r
-die Versionen 6.1 und 5.21.4.10.8 finden Sie im patch-Verzeichnis
-des Bacula Quelltextes.
-
-Da Bacula nicht direkt \"{u}ber das Betriebssystem auf die DVD
-schreiben kann, macht den gesamten Proze{\ss} etwas komplizierter
-als, zum Beispiel, das Beschreiben von Bandlaufwerken. Mit einer
-entsprechenden angepassten Konfiguration funktioniert es aber.
-Der Quelltext, der die Funktionen f\"{u}r die Sicherung auf
-DVDs enth\"{a}lt, ist Momentan noch im BETA-Stadium, bitte
-bedenken Sie das und testen Sie entsprechend sorgf\"{a}ltig
-bevor Sie produktive Daten auf DVDs sichern.
-
-Der Rest dieses Kapitels beschreibt die verschiedenen
-Konfigurations-Parameter, die Sie benutzen k\"{o}nnen,
-um den DVD-Schreibvorgang zu steuern.
-
-\label{DVDdirectives}
-\section{DVD spezifische SD Konfiguration}
-\index[general]{Konfiguration!DVD}
-\index[general]{DVD spezifische SD Konfiguration }
-
-Die folgenden DVD spezifischen Konfigurations-Parameter
-k\"{o}nnen in der Storage-Dienst-Konfiguration verwendet werden:
-
-\begin{description}
-
-\item [Requires Mount = {\it Yes|No}]
- \index[sd]{Requires Mount }
- F\"{u}r DVDs muss hier {\bf yes} gesetzt werden, bei allen anderen Ger\"{a}ten
- (Bandlaufwerke, Festplatten) muss {\bf no} konfiguriert werden. Hiermit wird
- angegeben, dass f\"{u}r das Ger\"{a}t ein {\bf Mount-Command} abgesetzt werden muss,
- bevor es durch Bacula genutzt werden kann. Um auf DVDs schreiben zu k\"{o}nnen,
- m\"{u}ssen zus\"{a}tzlich noch {\bf Mount Command}, {\bf Unmount Command} und
- {\bf Write Part Command} angegeben werden.
-
-\item [Mount Point = {\it Verzeichnis}]
- \index[sd]{Mount Point}
- Das Verzeichnis in dem die DVD gemounted werden soll.
-
-\item [Mount Command = {\it Zeichenkette}]
- \index[sd]{Mount Command}
- Das Kommando das zum Mounten des Ger\"{a}tes ausgef\"{u}hrt werden soll.
- Auch wenn die DVD direkt beschrieben wird, wird ein mount ben\"{o}tigt
- um den freien Speicherplatz auf der DVD zu ermitteln. Bei der Ausf\"{u}hrung
- dieses Kommandos werden die Platzhalter \%a durch das {\bf Archive Device}
- und \%m durch den {\bf Mount Point} ersetzt.
-
- In den meisten F\"{a}llen wird das Mount Command wie folgt aussehen:
-
-\footnotesize
-\begin{verbatim}
- Mount Command = "/bin/mount -t iso9660 -o ro %a %m"
-\end{verbatim}
-\normalsize
-
-Wenn Sie den DVD-Brenner in /etc/fstab angegeben haben, k\"{o}nnen Sie
-auch ein Kommando in dieser Form verwenden:
-
-\footnotesize
-\begin{verbatim}
- Mount Command = "/bin/mount /media/dvd"
-\end{verbatim}
-\normalsize
-
-
-\item [Unmount Command = {\it Zeichenkette}]
- \index[sd]{Unmount Command}
- Das unmount-Kommando wird verwendet um die Laufwerkseinbindung zu beenden.
- Command that must be executed to unmount the device. Bei der Ausf\"{u}hrung
- dieses Kommandos werden die Platzhalter \%a durch das {\bf Archive Device}
- und \%m durch den {\bf Mount Point} ersetzt.
-
- Eine gebr\"{a}uchliche Form ist:
-
-\footnotesize
-\begin{verbatim}
- Unmount Command = "/bin/umount %m"
-\end{verbatim}
-\normalsize
-
-\item [Write Part Command = {\it Zeichenkette}]
- \index[sd]{Write Part Command }
- Das Kommando, dass ausgef\"{u}hrt werden soll, wenn eine weitere Session,
- ein weiterer Teil Daten, auf die DVD geschrieben werden soll.Bei der
- Ausf\"{u}hrung dieses Kommandos werden die Platzhalter \%a durch
- das {\bf Archive Device}, \%m durch den {\bf Mount Point}, \%e wird
- durch 1 wenn der erste Teil und durch 0 bei weiteren Teilen ersetzt
- und \%v durch den Namen des aktuell geschriebenen Teils der Daten.
-
- F\"{u}r DVDs werden Sie meistens das von Bacula mitgelieferte Script
- {\bf dvd-handler} wie folgt verwenden:
-
-\footnotesize
-\begin{verbatim}
- Write Part Command = "/Pfad/dvd-handler %a write %e %v"
-\end{verbatim}
-\normalsize
-
- Hierbei ist {\bf /Pfad} der komplette Pfad zum Verzeichnis
- in dem das Script liegt. In der Standard-Konfiguration des
- Storage-Dienstes ist dieses Kommando bereits angegeben,
- aber auskommentiert. Um es zu verwenden, entfernen Sie einfach
- das Symbol \# an Anfang der Zeile.
-
-\item [Free Space Command = {\it Zeichenkette}]
- \index[sd]{Free Space Command }
- Das Kommando, dass ausgef\"{u}hrt werden soll,um den freien
- Speicherplatz auf der DVD zu ermitteln. Vor der Ausf\"{u}hrung
- wird der Platzhalter \%a durch das {\bf Archive Device} ersetzt.
-
- F\"{u}r DVDs werden Sie meistens das von Bacula mitgelieferte Script
- {\bf dvd-handler} wie folgt verwenden:
-
-\footnotesize
-\begin{verbatim}
- Free Space Command = "/path/dvd-handler %a free"
-\end{verbatim}
-\normalsize
-
- Hierbei ist {\bf /Pfad} der komplette Pfad zum Verzeichnis
- in dem das Script liegt. Wenn Sie ein eigenes Kommando benutzen
- wollen, schauen Sie sich bitte an, wie und welche Informationen
- das Script an Bacula \"{u}bergibt. In der Standard-Konfiguration des
- Storage-Dienstes ist dieses Kommando bereits angegeben,
- aber auskommentiert. Um es zu verwenden, entfernen Sie einfach
- das Symbol \# an Anfang der Zeile.
-
- Wenn diese Kommando nicht konfiguriert ist, geht Bacula davon aus,
- dass immer freier Speicherplatz auf der DVD verf\"{u}gbar ist.
-
-\end{description}
-
-Zus\"{a}tzlich zu den oben genannten Paramtern m\"{u}ssen auch die
-nicht DVD-spezifischen Standard-Eintr\"{a}ge vorhanden sein. Sehen
-Sie sich hierzu bitte die beispielhafte DVD-Konfiguration in der
-Konfigurations-Datei des Storage-Dienstes an. Stellen Sie bitte sicher,
-dass Sie einen Ger\"{a}te-Eintrag als {\bf Archive Device} angeben,
-zum Beispiel {\bf /dev/cdrom} und nicht ein Verzeichnis wie {\bf
-/media/cdrom}. Abweichend k\"{o}nnen die Eintr\"{a}ge auch {\bf
-/dev/cdrecorder}, {\bf /dev/dvd} oder {\bf /dev/sr0} hei{\ss}en.
-
-Letztendlich muss noch {\bf growisofs} in der Lage sein gen\"{u}gend
-Arbeitsspeicher sperren zu d\"{u}rfen. Wenn dies nicht gelingt,
-kann es zu Fehlern f\"{u}hren. Falls Sie die {\bf bash} verwenden,
-k\"{o}nnen Sie mit dem folgenden Kommando den sperrbaren Speicher
-auf unbegrenzt festlegen:
-
-\footnotesize
-\begin{verbatim}
-ulimit -l unlimited
-\end{verbatim}
-\normalsize
-
-\section{Platzhalter bei DVD Kommandos}
-\index[general]{Kommandos!DVD Platzhalter}
-\index[general]{Platzhalter bei DVD Kommandos }
-
-Bevor die Kommandos, die f\"{u}r {\bf Mount Command}, {\bf Unmount Command},
-{\bf Write Part Command} oder {\bf Free Space Command} konfiguriert
-sind, an das Betriebssystem zur Ausf\"{u}hrung \"{u}bergeben werden,
-ersetzt Bacula folgende Paltzhalter durch die angegeben Parameter:
-
-\footnotesize
-\begin{alltt}
- %% = %
- %a = das Archive Device, z.B. /dev/dvdrecorder
- %e = erase, ersetzt durch 1 wenn das mounten nicht m\"{o}glich war
- oder wenn der erste Teil der DVD geschrieben wird, ansonsten 0
- %n = die Nummer des aktuell geschriebenen Teils
- %m = der Mount Point, z.B. /media/dvd
- %v = der Dateiname des aktuell geschriebenen Teils
-\end{alltt}
-\normalsize
-
-
-
-\section{DVD spezifische Director Konfiguration}
-\index[general]{Konfiguration!DVD}
-\index[general]{DVD spezifische Director Konfiguration }
-
-Die folgenden DVD spezifischen Parameter k\"{o}nnen
-in der Konfiguration des Director-Dienstes angegeben werden:
-
-\label{WritePartAfterJob}
-\begin{description}
-\item [Write Part After Job = \lt{}yes|no\gt{}]
- \index[dir]{Write Part After Job }
- Wenn Sie hier {\bf yes} angeben, der Standard ist {\bf no},
- werden die Daten des Backup-Jobs sofort nach dessen Ende
- auf die DVD geschrieben. Dazu wird eine tempor\"{a}re
- Image-Datei erstellt, die dann, an die Daten auf der DVD,
- als neuer Teil/neue Session, angef\"{u}gt wird.
-
- Bei Ger\"{a}ten die gemounted werden m\"{u}ssen (zum Beispiel DVDs),
- sollten Sie es auf {\bf yes} setzen. Nur so k\"{o}nnen Sie sicher sein,
- dass alle Job-Daten auf das Ger\"{a}t geschrieben werden und keine Daten
- in der tempor\"{a}ren Datei auf der Festplatte verbleiben. Allerdings
- wird bei einigen Medien, wie DVD-R und DVD+R, f\"{u}r jede Session/
- jeden "`Part"' in etwa 10 Mb zus\"{a}tzlicher Speicherplatz verbraucht.
- Wenn Sie also mehrere Jobs nacheinander laufen lassen, sollte {\bf WritePartAfterJob}
- bei allen Jobs, ausser bei dem Letzten, auf {\bf no} gesetzt werden.
- Dadurch wird verhindert, dass zu viel Speicherplatz verschwendet wird
- und trotzdem sichergestellt, dass alle Daten auf das Medium geschrieben werden.
-
- Dieser Parameter wird nur ausgewertet, wenn als Ger\"{a}te-Typ DVD angegeben ist.
-
-\end{description}
-
-
-\label{DVDpoints}
-\section{Hinweise zur Verwendung von DVDs}
-\index[general]{Hinweise!Verwendung von DVDs}
-\index[general]{Hinweise zur Verwendung von DVDs}
-
-\begin{itemize}
-\item Stellen Sie bitte sicher, dass jede Art von automatischem
- mounten auf Ihrem System abgeschaltet ist (zum Beispiel via /etc/fstab oder
- hotplug). Wenn die DVD automatisch vom Betriebssystem eingebunden wird,
- werden Probleme auftreten, wenn Bacula versucht die DVD zu mounten/unmounten.
-\item Setzen Sie {\bf Write Part After Job} auf {\bf yes}, ansonsten wird
- der letzte Teil der Backup-Daten eventuell nicht auf die DVD geschrieben
- und verbleibt in der tempor\"{a}ren Datei auf der Festplatte.
- Wenn Sie mehrere Jobs nacheinander laufen lassen reicht es aus,
- wenn {\bf Write Part After Job} f\"{u}r den letzten Job auf {\bf yes}
- gesetzt ist.
-\item Bacula ist momentan noch nicht darauf ausgelegt mehrere Jobs parallel
- auf eine DVD zu schreiben. Stelln Sie daher sicher, dass niemals zwei Jobs
- gleichzeitig versuchen auf die DVD zu schreiben.
-\item auch wenn das Lesen und Schreiben von DVD+RW sehr zuverl\"{a}ssig
- funktioniert, gibt es kaum Erfahrungen ob das auch f\"{u}r DVD-RW und
- andere DVD-Formate gilt.
-\item DVD+RW unterst\"{u}tzt nur 1000 Schreibvorg\"{a}nge und jedesmal
- wenn die DVD mit Schreibzugriff eingebunden/gemounted wird, z\"{a}hlt
- das als ein Schreibzugriff. Dadurch k\"{o}nnen die 1000 Schreibzugriffe
- sehr schnell zustande kommen. Es empfiehlt sich daher, dass Sie die DVD+RW
- nur lesbar (read-only) einbinden. Bacula greift beim Schreiben direkt
- auf die Hardware zu, daher spielt es keine Rolle wie die DVD eingebunden ist.
-\item durch mehrmaliges formatieren oder neu formatieren kann es passieren,
- dass eine DVD+RW unbrauchbar wird. Normalerweise sollte es nicht notwendig
- sein eine DVD+RW erneut zu formatieren, falls doch, erkennen aktuelle
- Versionen von growisofs dies automatisch.
-\item Bei der Benutzung von DVD-RW (nicht bei DVD+RW) k\"{o}nnen Probleme
- autreten, da diese Medien zwei verschiedene Schreib-Methoden kennen:
- {\bf Incremental Sequential} und {\bf Restricted Overwrite}. In
- Abh\"{a}ngigkeit von Ihrem Laufwerk und dem verwendeten Medium kann
- es passieren, dass eine dieser Methoden nicht korrekt funktioniert.
-
- Um sich die aktuell verwendete Schreib-Methode anzeigen zu lassen,
- k\"{o}nnen Sie diese Kommando ausf\"{u}hren:
-\begin{verbatim}
- dvd+rw-mediainfo /dev/xxx
-\end{verbatim}
- wobei Sie {\bf xxx} mit dem Ger\"{a}te-namen Ihres DVD-Brenners ersetzen m\"{u}ssen.
- Die gew\"{u}nschte Information finden Sie dann in der Zeile die mit
- {\bf Mounted Media} anf\"{a}ngt.
-
- Um den DVD-Brenner in den {\bf Restricted Overwrite} Modus zu versetzen,
- f\"{u}hren Sie dieses Kommando aus:
-\begin{verbatim}
- dvd+rw-format /dev/xxx
-\end{verbatim}
- In dem Modus {\bf Incremental Sequential} setzen Sie Ihr Laufwerk mittels:
-\begin{verbatim}
- dvd+rw-format -blank /dev/xxx
-\end{verbatim}
-
-\item Bacula akzeptiert zum schreiben nur leere DVDs. Um eine DVD schnell zu
- l\"{o}schen f\"{u}hren Sie dieses Kommando aus:
-\begin{verbatim}
- dd if=/dev/zero bs=1024 count=512 | growisofs -Z /dev/xxx=/dev/fd/0
-\end{verbatim}
- Danach k\"{o}nnen Sie versuchen die DVD zu mounten, falls die fehlschl\"{a}gt,
- war der L\"{o}schvorgang erfolgreich und Bacula kann diese DVD verwenden.
- Ansonsten m\"{u}ssen Sie die Daten auf der DVD komplett l\"{o}schen.
-\item Um eine DVD komplett zu l\"{o}schen verwenden Sie dieses Kommando:
-\begin{verbatim}
- growisofs -Z /dev/xxx=/dev/zero
-\end{verbatim}
- Dadurch wird die gesamte DVD gel\"{o}scht. Dieser Vorgang kann, abh\"{a}ngig
- von Ihrem Laufwerk, bis zu 30 Minuten dauern.
-\item DVD-RW und DVD+RW lassen sich circa 1000 Mal neu beschreiben,
- verwenden Sie also nicht \"{u}ber mehrere Jahre dieselben DVDs.
-
-Das Kommando um eine leere DVD zum ersten Mal zu beschreiben ist:
-\begin{verbatim}
- growisofs -Z /dev/xxx filename
-\end{verbatim}
-
-weitere Sessions werden dann mittels:
-\begin{verbatim}
- growisofs -M /dev/xxx filename
-\end{verbatim}
-auf die DVD geschrieben.
-
-Seit growisofs 5.20 gibt es die Option {\bf -use-the-force-luke=4gms}.
-Dadurch wird verhindert das growisofs das Limit von 4GB beachtet.
-Auf allen Kernel ab 2.6.8 sollte diese Option verwendet werden,
-da diese Kernel auch mehr als 4GB schreiben k\"{o}nnen. Weiter
-Informationen dazu finden Sie, auf Englisch, unter dem unten genannten Link.
-
-\item Mehr Informationen zum Thema DVDs brennen finden Sie auf der
-\elink{Homepage der dvd+rw-tools}{http://fy.chalmers.se/~appro/linux/DVD+RW/}.
-
-\item Dem Fehlerbericht Nummer 912 zufolge, kann bscan keine multisession DVDs lesen.
-Dieses Problem wird in der Zukunft behoben, je eher jemand einen Patch schreibt,
-desto schneller.
-\end{itemize}
+++ /dev/null
-% TODO: maybe get rid of centering
-
-\chapter{GNU Free Documentation License}
-\index[general]{GNU Free Documentation License}
-\index[general]{License!GNU Free Documentation}
-
-\label{label_fdl}
-
- \begin{center}
-
- Version 1.2, November 2002
-
-
- Copyright \copyright 2000,2001,2002 Free Software Foundation, Inc.
-
- \bigskip
-
- 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-
- \bigskip
-
- Everyone is permitted to copy and distribute verbatim copies
- of this license document, but changing it is not allowed.
-\end{center}
-
-
-\begin{center}
-{\bf\large Preamble}
-\end{center}
-
-The purpose of this License is to make a manual, textbook, or other
-functional and useful document "free" in the sense of freedom: to
-assure everyone the effective freedom to copy and redistribute it,
-with or without modifying it, either commercially or noncommercially.
-Secondarily, this License preserves for the author and publisher a way
-to get credit for their work, while not being considered responsible
-for modifications made by others.
-
-This License is a kind of "`copyleft"', which means that derivative
-works of the document must themselves be free in the same sense. It
-complements the GNU General Public License, which is a copyleft
-license designed for free software.
-
-We have designed this License in order to use it for manuals for free
-software, because free software needs free documentation: a free
-program should come with manuals providing the same freedoms that the
-software does. But this License is not limited to software manuals;
-it can be used for any textual work, regardless of subject matter or
-whether it is published as a printed book. We recommend this License
-principally for works whose purpose is instruction or reference.
-
-
-\begin{center}
-{\Large\bf 1. APPLICABILITY AND DEFINITIONS}
-\end{center}
-
-This License applies to any manual or other work, in any medium, that
-contains a notice placed by the copyright holder saying it can be
-distributed under the terms of this License. Such a notice grants a
-world-wide, royalty-free license, unlimited in duration, to use that
-work under the conditions stated herein. The \textbf{"`Document"'}, below,
-refers to any such manual or work. Any member of the public is a
-licensee, and is addressed as \textbf{"`you"'}. You accept the license if you
-copy, modify or distribute the work in a way requiring permission
-under copyright law.
-
-A \textbf{"`Modified Version"'} of the Document means any work containing the
-Document or a portion of it, either copied verbatim, or with
-modifications and/or translated into another language.
-
-A \textbf{"`Secondary Section"'} is a named appendix or a front-matter section of
-the Document that deals exclusively with the relationship of the
-publishers or authors of the Document to the Document's overall subject
-(or to related matters) and contains nothing that could fall directly
-within that overall subject. (Thus, if the Document is in part a
-textbook of mathematics, a Secondary Section may not explain any
-mathematics.) The relationship could be a matter of historical
-connection with the subject or with related matters, or of legal,
-commercial, philosophical, ethical or political position regarding
-them.
-
-The \textbf{"`Invariant Sections"'} are certain Secondary Sections whose titles
-are designated, as being those of Invariant Sections, in the notice
-that says that the Document is released under this License. If a
-section does not fit the above definition of Secondary then it is not
-allowed to be designated as Invariant. The Document may contain zero
-Invariant Sections. If the Document does not identify any Invariant
-Sections then there are none.
-
-The \textbf{"`Cover Texts"'} are certain short passages of text that are listed,
-as Front-Cover Texts or Back-Cover Texts, in the notice that says that
-the Document is released under this License. A Front-Cover Text may
-be at most 5 words, and a Back-Cover Text may be at most 25 words.
-
-A \textbf{"`Transparent"'} copy of the Document means a machine-readable copy,
-represented in a format whose specification is available to the
-general public, that is suitable for revising the document
-straightforwardly with generic text editors or (for images composed of
-pixels) generic paint programs or (for drawings) some widely available
-drawing editor, and that is suitable for input to text formatters or
-for automatic translation to a variety of formats suitable for input
-to text formatters. A copy made in an otherwise Transparent file
-format whose markup, or absence of markup, has been arranged to thwart
-or discourage subsequent modification by readers is not Transparent.
-An image format is not Transparent if used for any substantial amount
-of text. A copy that is not "`Transparent"' is called \textbf{"`Opaque"'}.
-
-Examples of suitable formats for Transparent copies include plain
-ASCII without markup, Texinfo input format, LaTeX input format, SGML
-or XML using a publicly available DTD, and standard-conforming simple
-HTML, PostScript or PDF designed for human modification. Examples of
-transparent image formats include PNG, XCF and JPG. Opaque formats
-include proprietary formats that can be read and edited only by
-proprietary word processors, SGML or XML for which the DTD and/or
-processing tools are not generally available, and the
-machine-generated HTML, PostScript or PDF produced by some word
-processors for output purposes only.
-
-The \textbf{"`Title Page"'} means, for a printed book, the title page itself,
-plus such following pages as are needed to hold, legibly, the material
-this License requires to appear in the title page. For works in
-formats which do not have any title page as such, "`Title Page"' means
-the text near the most prominent appearance of the work's title,
-preceding the beginning of the body of the text.
-
-A section \textbf{"`Entitled XYZ"'} means a named subunit of the Document whose
-title either is precisely XYZ or contains XYZ in parentheses following
-text that translates XYZ in another language. (Here XYZ stands for a
-specific section name mentioned below, such as \textbf{"`Acknowledgements"'},
-\textbf{"`Dedications"'}, \textbf{"`Endorsements"'}, or \textbf{"`History"'}.)
-To \textbf{"`Preserve the Title"'}
-of such a section when you modify the Document means that it remains a
-section "`Entitled XYZ"' according to this definition.
-
-The Document may include Warranty Disclaimers next to the notice which
-states that this License applies to the Document. These Warranty
-Disclaimers are considered to be included by reference in this
-License, but only as regards disclaiming warranties: any other
-implication that these Warranty Disclaimers may have is void and has
-no effect on the meaning of this License.
-
-
-\begin{center}
-{\Large\bf 2. VERBATIM COPYING}
-\end{center}
-
-You may copy and distribute the Document in any medium, either
-commercially or noncommercially, provided that this License, the
-copyright notices, and the license notice saying this License applies
-to the Document are reproduced in all copies, and that you add no other
-conditions whatsoever to those of this License. You may not use
-technical measures to obstruct or control the reading or further
-copying of the copies you make or distribute. However, you may accept
-compensation in exchange for copies. If you distribute a large enough
-number of copies you must also follow the conditions in section 3.
-
-You may also lend copies, under the same conditions stated above, and
-you may publicly display copies.
-
-
-\begin{center}
-{\Large\bf 3. COPYING IN QUANTITY}
-\end{center}
-
-
-If you publish printed copies (or copies in media that commonly have
-printed covers) of the Document, numbering more than 100, and the
-Document's license notice requires Cover Texts, you must enclose the
-copies in covers that carry, clearly and legibly, all these Cover
-Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
-the back cover. Both covers must also clearly and legibly identify
-you as the publisher of these copies. The front cover must present
-the full title with all words of the title equally prominent and
-visible. You may add other material on the covers in addition.
-Copying with changes limited to the covers, as long as they preserve
-the title of the Document and satisfy these conditions, can be treated
-as verbatim copying in other respects.
-
-If the required texts for either cover are too voluminous to fit
-legibly, you should put the first ones listed (as many as fit
-reasonably) on the actual cover, and continue the rest onto adjacent
-pages.
-
-If you publish or distribute Opaque copies of the Document numbering
-more than 100, you must either include a machine-readable Transparent
-copy along with each Opaque copy, or state in or with each Opaque copy
-a computer-network location from which the general network-using
-public has access to download using public-standard network protocols
-a complete Transparent copy of the Document, free of added material.
-If you use the latter option, you must take reasonably prudent steps,
-when you begin distribution of Opaque copies in quantity, to ensure
-that this Transparent copy will remain thus accessible at the stated
-location until at least one year after the last time you distribute an
-Opaque copy (directly or through your agents or retailers) of that
-edition to the public.
-
-It is requested, but not required, that you contact the authors of the
-Document well before redistributing any large number of copies, to give
-them a chance to provide you with an updated version of the Document.
-
-
-\begin{center}
-{\Large\bf 4. MODIFICATIONS}
-\end{center}
-
-You may copy and distribute a Modified Version of the Document under
-the conditions of sections 2 and 3 above, provided that you release
-the Modified Version under precisely this License, with the Modified
-Version filling the role of the Document, thus licensing distribution
-and modification of the Modified Version to whoever possesses a copy
-of it. In addition, you must do these things in the Modified Version:
-
-\begin{itemize}
-\item[A.]
- Use in the Title Page (and on the covers, if any) a title distinct
- from that of the Document, and from those of previous versions
- (which should, if there were any, be listed in the History section
- of the Document). You may use the same title as a previous version
- if the original publisher of that version gives permission.
-
-\item[B.]
- List on the Title Page, as authors, one or more persons or entities
- responsible for authorship of the modifications in the Modified
- Version, together with at least five of the principal authors of the
- Document (all of its principal authors, if it has fewer than five),
- unless they release you from this requirement.
-
-\item[C.]
- State on the Title page the name of the publisher of the
- Modified Version, as the publisher.
-
-\item[D.]
- Preserve all the copyright notices of the Document.
-
-\item[E.]
- Add an appropriate copyright notice for your modifications
- adjacent to the other copyright notices.
-
-\item[F.]
- Include, immediately after the copyright notices, a license notice
- giving the public permission to use the Modified Version under the
- terms of this License, in the form shown in the Addendum below.
-
-\item[G.]
- Preserve in that license notice the full lists of Invariant Sections
- and required Cover Texts given in the Document's license notice.
-
-\item[H.]
- Include an unaltered copy of this License.
-
-\item[I.]
- Preserve the section Entitled "`History"', Preserve its Title, and add
- to it an item stating at least the title, year, new authors, and
- publisher of the Modified Version as given on the Title Page. If
- there is no section Entitled "`History"' in the Document, create one
- stating the title, year, authors, and publisher of the Document as
- given on its Title Page, then add an item describing the Modified
- Version as stated in the previous sentence.
-
-\item[J.]
- Preserve the network location, if any, given in the Document for
- public access to a Transparent copy of the Document, and likewise
- the network locations given in the Document for previous versions
- it was based on. These may be placed in the "`History"' section.
- You may omit a network location for a work that was published at
- least four years before the Document itself, or if the original
- publisher of the version it refers to gives permission.
-
-\item[K.]
- For any section Entitled "`Acknowledgements"' or "`Dedications"',
- Preserve the Title of the section, and preserve in the section all
- the substance and tone of each of the contributor acknowledgements
- and/or dedications given therein.
-
-\item[L.]
- Preserve all the Invariant Sections of the Document,
- unaltered in their text and in their titles. Section numbers
- or the equivalent are not considered part of the section titles.
-
-\item[M.]
- Delete any section Entitled "`Endorsements"'. Such a section
- may not be included in the Modified Version.
-
-\item[N.]
- Do not retitle any existing section to be Entitled "`Endorsements"'
- or to conflict in title with any Invariant Section.
-
-\item[O.]
- Preserve any Warranty Disclaimers.
-\end{itemize}
-
-If the Modified Version includes new front-matter sections or
-appendices that qualify as Secondary Sections and contain no material
-copied from the Document, you may at your option designate some or all
-of these sections as invariant. To do this, add their titles to the
-list of Invariant Sections in the Modified Version's license notice.
-These titles must be distinct from any other section titles.
-
-You may add a section Entitled "`Endorsements"', provided it contains
-nothing but endorsements of your Modified Version by various
-parties--for example, statements of peer review or that the text has
-been approved by an organization as the authoritative definition of a
-standard.
-
-You may add a passage of up to five words as a Front-Cover Text, and a
-passage of up to 25 words as a Back-Cover Text, to the end of the list
-of Cover Texts in the Modified Version. Only one passage of
-Front-Cover Text and one of Back-Cover Text may be added by (or
-through arrangements made by) any one entity. If the Document already
-includes a cover text for the same cover, previously added by you or
-by arrangement made by the same entity you are acting on behalf of,
-you may not add another; but you may replace the old one, on explicit
-permission from the previous publisher that added the old one.
-
-The author(s) and publisher(s) of the Document do not by this License
-give permission to use their names for publicity for or to assert or
-imply endorsement of any Modified Version.
-
-
-\begin{center}
-{\Large\bf 5. COMBINING DOCUMENTS}
-\end{center}
-
-
-You may combine the Document with other documents released under this
-License, under the terms defined in section 4 above for modified
-versions, provided that you include in the combination all of the
-Invariant Sections of all of the original documents, unmodified, and
-list them all as Invariant Sections of your combined work in its
-license notice, and that you preserve all their Warranty Disclaimers.
-
-The combined work need only contain one copy of this License, and
-multiple identical Invariant Sections may be replaced with a single
-copy. If there are multiple Invariant Sections with the same name but
-different contents, make the title of each such section unique by
-adding at the end of it, in parentheses, the name of the original
-author or publisher of that section if known, or else a unique number.
-Make the same adjustment to the section titles in the list of
-Invariant Sections in the license notice of the combined work.
-
-In the combination, you must combine any sections Entitled "`History"'
-in the various original documents, forming one section Entitled
-"`History"'; likewise combine any sections Entitled "`Acknowledgements"',
-and any sections Entitled "`Dedications"'. You must delete all sections
-Entitled "`Endorsements"'.
-
-\begin{center}
-{\Large\bf 6. COLLECTIONS OF DOCUMENTS}
-\end{center}
-
-You may make a collection consisting of the Document and other documents
-released under this License, and replace the individual copies of this
-License in the various documents with a single copy that is included in
-the collection, provided that you follow the rules of this License for
-verbatim copying of each of the documents in all other respects.
-
-You may extract a single document from such a collection, and distribute
-it individually under this License, provided you insert a copy of this
-License into the extracted document, and follow this License in all
-other respects regarding verbatim copying of that document.
-
-
-\begin{center}
-{\Large\bf 7. AGGREGATION WITH INDEPENDENT WORKS}
-\end{center}
-
-
-A compilation of the Document or its derivatives with other separate
-and independent documents or works, in or on a volume of a storage or
-distribution medium, is called an "`aggregate"' if the copyright
-resulting from the compilation is not used to limit the legal rights
-of the compilation's users beyond what the individual works permit.
-When the Document is included in an aggregate, this License does not
-apply to the other works in the aggregate which are not themselves
-derivative works of the Document.
-
-If the Cover Text requirement of section 3 is applicable to these
-copies of the Document, then if the Document is less than one half of
-the entire aggregate, the Document's Cover Texts may be placed on
-covers that bracket the Document within the aggregate, or the
-electronic equivalent of covers if the Document is in electronic form.
-Otherwise they must appear on printed covers that bracket the whole
-aggregate.
-
-
-\begin{center}
-{\Large\bf 8. TRANSLATION}
-\end{center}
-
-
-Translation is considered a kind of modification, so you may
-distribute translations of the Document under the terms of section 4.
-Replacing Invariant Sections with translations requires special
-permission from their copyright holders, but you may include
-translations of some or all Invariant Sections in addition to the
-original versions of these Invariant Sections. You may include a
-translation of this License, and all the license notices in the
-Document, and any Warranty Disclaimers, provided that you also include
-the original English version of this License and the original versions
-of those notices and disclaimers. In case of a disagreement between
-the translation and the original version of this License or a notice
-or disclaimer, the original version will prevail.
-
-If a section in the Document is Entitled "`Acknowledgements"',
-"`Dedications"', or "`History"', the requirement (section 4) to Preserve
-its Title (section 1) will typically require changing the actual
-title.
-
-
-\begin{center}
-{\Large\bf 9. TERMINATION}
-\end{center}
-
-
-You may not copy, modify, sublicense, or distribute the Document except
-as expressly provided for under this License. Any other attempt to
-copy, modify, sublicense or distribute the Document is void, and will
-automatically terminate your rights under this License. However,
-parties who have received copies, or rights, from you under this
-License will not have their licenses terminated so long as such
-parties remain in full compliance.
-
-
-\begin{center}
-{\Large\bf 10. FUTURE REVISIONS OF THIS LICENSE}
-\end{center}
-
-
-The Free Software Foundation may publish new, revised versions
-of the GNU Free Documentation License from time to time. Such new
-versions will be similar in spirit to the present version, but may
-differ in detail to address new problems or concerns. See
-http://www.gnu.org/copyleft/.
-
-Each version of the License is given a distinguishing version number.
-If the Document specifies that a particular numbered version of this
-License "`or any later version"' applies to it, you have the option of
-following the terms and conditions either of that specified version or
-of any later version that has been published (not as a draft) by the
-Free Software Foundation. If the Document does not specify a version
-number of this License, you may choose any version ever published (not
-as a draft) by the Free Software Foundation.
-
-
-\begin{center}
-{\Large\bf ADDENDUM: How to use this License for your documents}
-% TODO: this is too long for table of contents
-\end{center}
-
-To use this License in a document you have written, include a copy of
-the License in the document and put the following copyright and
-license notices just after the title page:
-
-\bigskip
-\begin{quote}
- Copyright \copyright YEAR YOUR NAME.
- Permission is granted to copy, distribute and/or modify this document
- under the terms of the GNU Free Documentation License, Version 1.2
- or any later version published by the Free Software Foundation;
- with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
- A copy of the license is included in the section entitled "`GNU
- Free Documentation License"'.
-\end{quote}
-\bigskip
-
-If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts,
-replace the "`with...Texts."' line with this:
-
-\bigskip
-\begin{quote}
- with the Invariant Sections being LIST THEIR TITLES, with the
- Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST.
-\end{quote}
-\bigskip
-
-If you have Invariant Sections without Cover Texts, or some other
-combination of the three, merge those two alternatives to suit the
-situation.
-
-If your document contains nontrivial examples of program code, we
-recommend releasing these examples in parallel under your choice of
-free software license, such as the GNU General Public License,
-to permit their use in free software.
-
-%---------------------------------------------------------------------
+++ /dev/null
-#!/usr/bin/perl -w
-# Fixes various things within tex files.
-
-use strict;
-
-my %args;
-
-
-sub get_includes {
- # Get a list of include files from the top-level tex file.
- my (@list,$file);
-
- foreach my $filename (@_) {
- $filename or next;
- # Start with the top-level latex file so it gets checked too.
- push (@list,$filename);
-
- # Get a list of all the html files in the directory.
- open IF,"<$filename" or die "Cannot open input file $filename";
- while (<IF>) {
- chomp;
- push @list,"$1.tex" if (/\\include\{(.*?)\}/);
- }
-
- close IF;
- }
- return @list;
-}
-
-sub convert_files {
- my (@files) = @_;
- my ($linecnt,$filedata,$output,$itemcnt,$indentcnt,$cnt);
-
- $cnt = 0;
- foreach my $file (@files) {
- # Open the file and load the whole thing into $filedata. A bit wasteful but
- # easier to deal with, and we don't have a problem with speed here.
- $filedata = "";
- open IF,"<$file" or die "Cannot open input file $file";
- while (<IF>) {
- $filedata .= $_;
- }
- close IF;
-
- # We look for a line that starts with \item, and indent the two next lines (if not blank)
- # by three spaces.
- my $linecnt = 3;
- $indentcnt = 0;
- $output = "";
- # Process a line at a time.
- foreach (split(/\n/,$filedata)) {
- $_ .= "\n"; # Put back the return.
- # If this line is less than the third line past the \item command,
- # and the line isn't blank and doesn't start with whitespace
- # add three spaces to the start of the line. Keep track of the number
- # of lines changed.
- if ($linecnt < 3 and !/^\\item/) {
- if (/^[^\n\s]/) {
- $output .= " " . $_;
- $indentcnt++;
- } else {
- $output .= $_;
- }
- $linecnt++;
- } else {
- $linecnt = 3;
- $output .= $_;
- }
- /^\\item / and $linecnt = 1;
- }
-
-
- # This is an item line. We need to process it too. If inside a \begin{description} environment, convert
- # \item {\bf xxx} to \item [xxx] or \item [{xxx}] (if xxx contains '[' or ']'.
- $itemcnt = 0;
- $filedata = $output;
- $output = "";
- my ($before,$descrip,$this,$between);
-
- # Find any \begin{description} environment
- while ($filedata =~ /(\\begin[\s\n]*\{[\s\n]*description[\s\n]*\})(.*?)(\\end[\s\n]*\{[\s\n]*description[\s\n]*\})/s) {
- $output .= $` . $1;
- $filedata = $3 . $';
- $descrip = $2;
-
- # Search for \item {\bf xxx}
- while ($descrip =~ /\\item[\s\n]*\{[\s\n]*\\bf[\s\n]*/s) {
- $descrip = $';
- $output .= $`;
- ($between,$descrip) = find_matching_brace($descrip);
- if (!$descrip) {
- $linecnt = $output =~ tr/\n/\n/;
- print STDERR "Missing matching curly brace at line $linecnt in $file\n" if (!$descrip);
- }
-
- # Now do the replacement.
- $between = '{' . $between . '}' if ($between =~ /\[|\]/);
- $output .= "\\item \[$between\]";
- $itemcnt++;
- }
- $output .= $descrip;
- }
- $output .= $filedata;
-
- # If any hyphens or \item commnads were converted, save the file.
- if ($indentcnt or $itemcnt) {
- open OF,">$file" or die "Cannot open output file $file";
- print OF $output;
- close OF;
- print "$indentcnt indent", ($indentcnt == 1) ? "" : "s"," added in $file\n";
- print "$itemcnt item", ($itemcnt == 1) ? "" : "s"," Changed in $file\n";
- }
-
- $cnt += $indentcnt + $itemcnt;
- }
- return $cnt;
-}
-
-sub find_matching_brace {
- # Finds text up to the next matching brace. Assumes that the input text doesn't contain
- # the opening brace, but we want to find text up to a matching closing one.
- # Returns the text between the matching braces, followed by the rest of the text following
- # (which does not include the matching brace).
- #
- my $str = shift;
- my ($this,$temp);
- my $cnt = 1;
-
- while ($cnt) {
- # Ignore verbatim constructs involving curly braces, or if the character preceding
- # the curly brace is a backslash.
- if ($str =~ /\\verb\*?\{.*?\{|\\verb\*?\}.*?\}|\{|\}/s) {
- $this .= $`;
- $str = $';
- $temp = $&;
-
- if ((substr($this,-1,1) eq '\\') or
- $temp =~ /^\\verb/) {
- $this .= $temp;
- next;
- }
-
- $cnt += ($temp eq '{') ? 1 : -1;
- # If this isn't the matching curly brace ($cnt > 0), include the brace.
- $this .= $temp if ($cnt);
- } else {
- # No matching curly brace found.
- return ($this . $str,'');
- }
- }
- return ($this,$str);
-}
-
-sub check_arguments {
- # Checks command-line arguments for ones starting with -- puts them into
- # a hash called %args and removes them from @ARGV.
- my $args = shift;
- my $i;
-
- for ($i = 0; $i < $#ARGV; $i++) {
- $ARGV[$i] =~ /^\-+/ or next;
- $ARGV[$i] =~ s/^\-+//;
- $args{$ARGV[$i]} = "";
- delete ($ARGV[$i]);
-
- }
-}
-
-##################################################################
-# MAIN ####
-##################################################################
-
-my @includes;
-my $cnt;
-
-check_arguments(\%args);
-die "No Files given to Check\n" if ($#ARGV < 0);
-
-# Examine the file pointed to by the first argument to get a list of
-# includes to test.
-@includes = get_includes(@ARGV);
-
-$cnt = convert_files(@includes);
-print "No lines changed\n" unless $cnt;
+++ /dev/null
-%%
-%%
-
-\chapter{Was ist Bacula?}
-\label{GeneralChapter}
-\index[general]{Bacula!Was ist }
-\index[general]{Was ist Bacula? }
-
-
-Bacula ist ein System von Computerprogrammen, mit denen Sie
-(oder der System-Administrator) in der Lage sind, Computerdaten innerhalb eines
-heterogenen Netzwerkes zu sichern, die Sicherungen wiederherzustellen und zu \"{u}berpr\"{u}fen.
-Bacula kann aber auch auf nur einem einzigen Computer benutzt werden und
-auf verschiedene Arten von Medien, wie B\"{a}nder oder Festplatten sichern.
-
-Technisch gesehen ist es ein netzwerkf\"{a}higes
-Sicherungsprogramm mit Client/Server-Architektur.
-Bacula ist leistungsf\"{a}hig und vergleichsweise einfach zu benutzen.
-Dabei hat es viele anspruchsvolle Funktionen zur Verwaltung der Sicherung,
-die das Auffinden und die Wiederherstellung besch\"{a}digter oder verlorener
-Dateien erleichtern. Durch seinen modularen Aufbau l\"{a}sst es sich jedem System
-anpassen: Vom Einzelplatzrechner bis zu einem gro{\ss}en System mit hunderten von
-Computern, die \"{u}ber ein weitr\"{a}umiges Netzwerk verteilt sind.
-
-\section{Wer ben\"{o}tigt Bacula?}
-\index[general]{Wer ben\"{o}tigt Bacula? }
-\index[general]{Bacula!Wer ben\"{o}tigt }
-
-Wenn Sie momentan Programme wie tar, dump oder
-bru zur Datensicherung verwenden und eine Netzwerkl\"{o}sung, gr\"{o}{\ss}ere Flexibilit\"{a}t
-oder einen Verzeichnis-Dienst suchen, wird Bacula wahrscheinlich die
-zus\"{a}tzlichen Funktionen zur Verf\"{u}gung stellen, die Sie suchen. Wenn Sie dagegen
-ein UNIX-Neuling sind oder keine weitergehenden Erfahrung mit
-anspruchsvollen Sicherungsprogrammen haben, raten wir von Bacula ab, da es in
-der Einrichtung und der Benutzung sehr viel komplizierter ist als z.B.
-tar oder dump.
-
-Wenn Bacula, wie die oben genannten einfachen Programme funktionieren und
-einfach nur ein beliebiges Band in Ihrem Laufwerk beschreiben soll, wird Ihnen der Umgang
-mit Bacula kompliziert vorkommen. Bacula ist so entworfen, dass es Ihre
-Daten nach von Ihnen festgelegten Regeln sichert, was bedeutet, dass die
-Wiederverwendung eines Bandes nur die letzte Wahl sein kann.
-Nat\"{u}rlich ist es m\"{o}glich, Bacula dazu zu bringen, jedes beliebige Band
-im Laufwerk zu beschreiben, jedoch ist es einfacher und wirkungsvoller
-hierf\"{u}r ein anderes Programm zu verwenden.
-Wenn Sie Amanda verwenden und ein Sicherungsprogramm suchen, das
-einzelne Backup-Jobs auf mehrere Volumes schreiben kann
-(also die Job-Gr\"{o}{\ss}e nicht durch die Speicherkapazit\"{a}t Ihres Bandlaufwerkes beschr\"{a}nkt ist)
-wird Bacula wahrscheinlich Ihren Bed\"{u}rfnissen entsprechen.
-Viele unserer Benutzer finden au{\ss}erdem, dass Bacula
-einfacher zu konfigurieren und zu benutzen ist als entsprechende andere Programme.
-
-Wenn Sie gegenw\"{a}rtig ein anspruchsvolles kommerzielles Programm wie Legato
-Networker, ARCserveIT, Arkeia oder PerfectBackup+ verwenden,
-k\"{o}nnte Sie Bacula interessieren, da es viele Eigenschaften und Funktionen dieser Programme hat,
-dabei aber als freie Software unter der GNU Software Lizenz Version 2 verf\"{u}gbar ist.
-
-
-\section{Bacula Komponenten oder Dienste}
-\index[general]{Bacula Komponenten oder Dienste }
-\index[general]{Dienste!Bacula Komponenten oder }
-
-Bacula besteht aus den folgenden f\"{u}nf Hauptkomponenten bzw. Diensten:
-
-\addcontentsline{lof}{figure}{Bacula Applications}
-\includegraphics{\idir bacula-applications.eps}
-(Dank an Aristedes Maniatis f\"{u}r diese und die folgende Grafik)
-
-\subsection*{Bacula Director}
- \label{DirDef}
- Der Bacula Director-Dienst ist das Programm, das alle Sicherungs-, Wiederherstellungs-, Verifizierungs- und
-Archivierungsvorg\"{a}nge \"{u}berwacht und steuert.
-Der Systemadministrator verwendet den Bacula Director, um die Zeitpunkte
-der Sicherungen festzulegen und Dateien wiederherzustellen.
-N\"{a}heres hierzu im Dokument ``Director Services Daemon Design'' im ``Bacula Developer's Guide''.
-Der Director l\"{a}uft als D\"{a}mon bzw. Dienst (also im Hintergrund).
-
-\subsection*{Bacula Console}
- \label{UADef}
- Der Bacula Console-Dienst ist jenes Programm, welches es einem
-Systemadministrator oder Benutzer erlaubt, mit dem Bacula Director zu
-kommunizieren. Zur Zeit ist die Bacula Console in drei Versionen
-verf\"{u}gbar. Die erste und einfachste, ist das Consolen Programm in einer
-Shell zu starten (also eine TTY-Schnittstelle). Die meisten
-Systemadministratoren werden das v\"{o}llig angemessen finden.
-Die zweite M\"{o}glichkeit ist ein grafisches GNOME-Interface, das weit davon entfernt
-ist, vollst\"{a}ndig zu sein, aber schon ganz gut funktioniert und die meisten
-M\"{o}glichkeiten bietet, die auch die Shell-Konsole hat. Die dritte
-Version ist eine grafische wxWidgets-Benutzeroberfl\"{a}che, \"{u}ber die Daten
-interaktiv wiederhergestellt werden k\"{o}nnen. Auch sie hat die meisten Funktionen
-der Shell-Konsole, bietet eine Befehlsvervollst\"{a}ndigung per Tabulatorentaste
-und Kontexthilfe w\"{a}hrend der Befehlseingabe.
-N\"{a}heres hierzu im Kapitel \ilink{Bacula Console Design Document}{_ChapterStart23}.
-
-\subsection*{Bacula File}
-\label{FDDef}
- Bacula File (Datei)-Dienste (bzw. Client-Programme) sind jene
-Programme, die auf den Rechnern installiert sind, deren Daten gesichert
-werden sollen. Sie sind je nach Betriebssystem verschieden, immer aber
-verantwortlich f\"{u}r die Auslieferung der Daten und deren Attribute, die der
-Director von ihnen anfordert. Die Datendienste sind auch f\"{u}r den
-betriebssystemabh\"{a}ngigen Teil der Wiederherstellung der Daten und deren
-Attribute zust\"{a}ndig. N\"{a}heres hierzu im Dokument ``File Services Daemon Design'' im ``Bacula Developer's
-Guide''. Auf den Rechnern, derren Daten gesichert werden sollen, l\"{a}uft dieses
-Programm als D\"{a}monprozess. Der File-D\"{a}mon wird in dieser Dokumentation auch als
-``Client'' bezeichnet (zum Beispiel in den Konfigurationsdatei von Bacula).
-Ausser den Unix/Linux File-D\"{a}monen gibt es einen File-D\"{a}mon f\"{u}r Windows
-(der in der Regel als kompiliertes Programm erh\"{a}ltlich ist). Der File-D\"{a}mon f\"{u}r Windows l\"{a}uft
-unter allen g\"{a}ngigen Windows-Versionen (95, 98, Me, NT, 2000, XP).
-
-\subsection*{Bacula Storage}
-\label{SDDef}
- Den Bacula Storage (Sicherungs)-Dienst leisten Programme, die
-Sicherung und Wiederherstellung der Dateien und ihrer Attribute auf das
-physikalische Sicherungsmedium bzw. die Volumes leisten. Der Storage-D\"{a}mon ist also f\"{u}r das
-Beschreiben und Lesen Ihrer B\"{a}nder (oder eines anderen Sicherungsmediums wie
-z.B. Dateien) zust\"{a}ndig. N\"{a}heres hierzu im Kapitel ``Storage Services Daemon
-Design'' im ``Bacula Developer's Guide''. Der Sicherungsdienst l\"{a}uft als
-D\"{a}monprozess auf dem Rechner, der \"{u}ber das Datensicherungsger\"{a}t verf\"{u}gt (in der
-Regel ein Bandlaufwerk).
-
-\subsection*{Catalog}
-\label{DBDefinition}
- Die Catalog (Verzeichnis)-Dienste werden von Programmen
-geleistet, die f\"{u}r die Wartung der Datieindizes und Volume-Datenbanken
-aller gesicherten Dateien zust\"{a}ndig sind. \"{U}ber einen Verzeichnis-Dienst kann der
-Systemadministrator oder Benutzer jede gew\"{u}nschte Datei schnell finden
-und wiederherstellen. Durch den Verzeichnisdienst unterscheidet sich Bacula von
-einfachen Sicherungsprogrammen wie ``tar'' oder ``bru'', da dieser
-Dienst die Aufzeichnung aller verwendeten Volumes, aller gelaufener
-Sicherungen und aller gesicherter Dateien pflegt und dadurch eine
-effiziente Wiederherstellung und eine Verwaltung der Volumes erlaubt. Bacula
-unterst\"{u}tzt momentan die drei Datenbanksysteme MySQL, PostgreSQL
-und SQLite, von denen eines vor der Kompilierung von {\bf Bacula} ausgew\"{a}hlt sein
-muss.
-
-Die drei Datenbanksysteme (MySQL, PostgreSQL und SQLite), die z.Z. unterst\"{u}tzt
-werden, haben eine ganze Reihe von Besonderheiten wie z.B. schnelle Indizierung,
-Baumsuche und Sicherheitsfunktionen. Wir planen die Unterst\"{u}tzung weiterer
-gr\"{o}{\ss}erer SQL-Datenbanksysteme, doch hat die momentane Bacula-Version nur
-Schnittstellen zu MySQL, PostgreSQL und SQLite. N\"{a}heres hierzu im Kapitel
-\ilink{``Catalog Services Design Document''}{_ChapterStart30}.
-
-MySQL und PostgreSQL sind f\"{u}r viele Betriebssysteme verf\"{u}gbar.
-Alternativ, k\"{o}nnen sie auch aus den Quelldateien installiert werden.
-N\"{a}heres hierzu im Kapitel \ilink{``Installation und Konfiguration
-von MySQL''}{_ChapterStart} in diesem Handbuch. Weitere Informationen zu MySQL
-im Internet: \elink{www.mysql.com}{http://www.mysql.com}.
-Zu PostgreSQL lesen Sie bitte das Kapitel \ilink{``Installation und
-Konfiguration von PostgreSQL''}{_ChapterStart10} in diesem Dokument.
-Weiter Informationen zu PostgreSQL finden Sie hier:
-\elink{www.postgresql.org}{http://www.postgresql.org}.
-
-Die Konfiguration und Installation eines SQLite-Datenbanksystems ist noch
-einfacher. Einzelheiten dazu im Kapitel \ilink{``Installation und Konfiguration
-von SQLite''}{_ChapterStart33} in diesem Handbuch.
-
-\subsection*{Bacula Monitor}
-\label{MonDef}
- Der Bacula Monitor-Dienst ist das Programm, welches es dem
-Administrator oder Benutzer erlaubt, den aktuellen Zustand des Bacula
-Directors, der Bacula File D\"{a}monen und der Bacula Storage D\"{a}monen
-zu beobachten. Zur Zeit ist hierf\"{u}r nur eine GTK+-Version
-verf\"{u}gbar, die auf Gnome und KDE aufsetzt (oder jedem anderen Fenstermanager,
-der den Standard von FreeDesktop.org f\"{u}r das System-Tray unterst\"{u}tzt).
-
-Um erfolgreich sichern und wiederherstellen zu k\"{o}nnen, m\"{u}ssen die folgenden
-vier D\"{a}monprozesse konfiguriert und gestartet sein: Der Director-Dienst, der
-File-Dienst, der Storage-Dienst und die Katalog-Datenbank (MySQL, PostgreSQL oder SQLite).
-
-\section{Die Bacula Konfiguration}
-\index[general]{Konfiguration!Die Bacula }
-\index[general]{Die Bacula Konfiguration }
-
-Damit sich Bacula in Ihrem System zurechtfindet und es weiss welche
-Client-Rechner wie zu sichern sind, m\"{u}ssen mehrere Konfigurationsdateien
-erstellt werden, die bestimmte Eintr\"{a}ge (bzw. Ressourcen) enthalten. Die
-folgende Abbildung gibt hierzu eine \"{U}bersicht:
-
-\addcontentsline{lof}{figure}{Bacula Objects}
-\includegraphics{\idir bacula-objects.eps}
-
-\section{Die in diesem Dokument verwendeten Konventionen}
-\index[general]{Die in diesem Dokument verwendeten Konventionen }
-\index[general]{Dokument!verwendete Konventionen}
-
-{\bf Bacula} ist in der Entwicklung und daher wird dieses Handbuch nicht in
-jedem Fall mit dem Stand des Programmcodes \"{u}bereinstimmen. Steht in diesem
-Handbuch vor einem Abschnitt ein Stern (*), bedeutet dies, dass das Beschriebene
-noch nicht implementiert ist. Die Kennzeichnung durch ein Pluszeichen (+)
-bedeutet, dass die Funktion m\"{o}glicherweise teilweise implementiert ist.
-
-Wenn Sie dieses Handbuch als Teil eines offiziellen Release der
-Software lesen, ist diese Kennzeichnung verl\"{a}{\ss}lich. Lesen Sie hingegen die
-Online-Version dieses Handbuches auf \elink{ www.bacula.org}{http://www.bacula.org}, denken Sie
-bitte daran, dass hier die aktuelle Entwicklungsversion (wie sie im SVN
-vorhanden ist) beschrieben wird. In beiden F\"{a}llen wird aber das Handbuch dem
-Code ein St\"{u}ckchen hinterherhinken.
-
-\section{Quick Start}
-\index[general]{Quick Start }
-\index[general]{Start!Quick }
-
-Um Bacula schnell zu konfigurieren und zum Laufen zu bringen, empfehlen wir,
-zuerst den untenstehenden Abschnitt mit den Fachausdr\"{u}cken und das n\"{a}chste
-Kapitel \ilink{``Baculas gegenw\"{a}rtiger Zustand''}{_ChapterStart2} durchzusehen.
-
-Lesen Sie dann das Kapitel \ilink{``Mit Bacula beginnen''}{_ChapterStart37}, das
-eine kurze \"{U}bersicht dar\"{u}ber gibt, wie man Bacula startet. Lesen
-Sie danach das Kapitel \"{u}ber \ilink{``Die Installation von
-Bacula''}{_ChapterStart17}, dann \ilink{``Die Konfiguration
-von Bacula''}{_ChapterStart16} und schlie{\ss}lich das Kapitel \ilink{
-``Bacula in Betrieb nehmen''}{_ChapterStart1}.
-
-\section{Terminologie}
-\index[general]{Terminologie }
-
-Um die Kommunikation \"{u}ber diese Projekt zu erleichtern, sind hier die
-verwendeten Begriffe erl\"{a}utert
-
-\begin{description}
-
-\item [Administrator]
- \index[fd]{Administrator }
- Die Person bzw. die Personen, die f\"{u}r die Pflege des Bacula-Systems
-verantwortlich sind.
-
-\item [Backup]
- \index[fd]{Backup }
- Wir verwenden den Ausdruck {\bf Backup} (Sicherung) wenn wir von einem
-Bacula-Job sprechen, bei dem Dateien gesichert werden.
-
-\item [Bootstrap File]
- \index[fd]{Bootstrap File }
- Das bootstrap file (Bootstrap-Datei) ist eine ASCII-Datei, die in kompakter
-Form jene Befehle enth\"{a}lt, mit denen Bacula oder das eigenst\"{a}ndige
-Dateiextrahierungswerkzeug bextract den Inhalt eines oder mehrerer
-Volumes wiederherstellen kann, wie z.B. einen vorher gesicherten Systemzustand.
-Mit einer Bootstrap-Datei kann Bacula Ihr System wiederherstellen, ohne auf
-eine Catalog-Datenbank angewiesen zu sein. Aus einem Catalog kann eine Bootstrap-Datei
-erzeugt werden, um jede gew\"{u}nschte Datei auf den Volumes wiederzufinden.
-
-\item [Catalog]
- \index[fd]{Catalog }
- Der Catalog (das Verzeichnis) wird verwendet, um zusammenfassende
-Informationen \"{u}ber Jobs, Clients und die gesicherten Dateien zu speichern,
-sowie Informationen dar\"{u}ber, auf welchen Volumes diese Daten sind. Die
-Informationen, die in der Catalog-Datenbank gespeichert sind, erm\"{o}glichen es dem Administrator
-bzw. Benutzer zu bestimmen, welche Jobs gelaufen sind, geben Auskunft \"{u}ber ihren
-Status und wichtige Eigenschaften der gesicherten Dateien. Der Catalog ist eine
-``online resource'', enth\"{a}lt aber nicht die Daten der gesicherten Dateien. Vieles
-der Catalog-Informationen ist auch auf den Volumes (z.B. den B\"{a}ndern)
-gespeichert. Nat\"{u}rlich sind auf den B\"{a}ndern auch die Kopien der Dateien und
-deren Attribute (siehe unten).
-
-Die Catalog-Datenbank ist eine Besonderheit von Bacula, das es von einfachen Backup- und
-Archiv-Programmen wie {\bf dump} und {\bf tar} unterscheidet.
-
-\item [Client]
- \index[fd]{Client }
- In Baculas Terminologie bezeichnet das Wort Client jenen Rechner,
-dessen Daten gesichert werden. Client ist auch ein anderes Wort f\"{u}r
-den File-Dienst oder File-D\"{a}mon, der oft auch nur mit FD bezeichnet wird.
-Clients werden durch einen Eintrag in den Konfigurationsdatein definiert.
-
-\item [Console]
- \index[fd]{Console }
- Die Console (Konsole) ist ein Programm, das die Schnittstelle zum Director
-bildet und \"{u}ber welches der Benutzer oder Systemadministrator Bacula
-steuern kann.
-
-\item [Daemon]
- \index[fd]{Daemon }
- D\"{a}monprozess ist ein Unix-Fachausdruck f\"{u}r ein Programm, dass
-st\"{a}ndig im Hintergrund l\"{a}uft um spezielle Aufgaben
-auszuf\"{u}hren. Auf Windows- und manchen Linux-Systemen werden
-D\"{a}monprozesse Services (Dienste) genannt.
-
-\item [Directive]
- \index[fd]{Directive }
- Der Ausdruck directive (Anweisung) bezeichnet eine einzelne Angabe
-innerhalb eines Konfigurations-Eintrags einer Konfigurationsdatei, welche
-einen speziellen Sachverhalt definiert. Beispielsweise definiert die {\bf
-Name}-directive den Namen einer Resource.
-
-\item [Director]
- \index[fd]{Director }
- Baculas wichtigster D\"{a}monprozess, der alle Aktivit\"{a}ten des Bacula-Systems
-zeitlich festlegt und beaufsichtigt. Gelegentlich auch als DIR bezeichnet.
-
-\item [Differential]
- \index[fd]{Differential }
- Differentiell ist eine Sicherung, wenn sie alle Dateien einbezieht, die
-seit Beginn der letzten Vollsicherung ge\"{a}ndert wurden. Beachten Sie bitte, dass
-dies von anderen Sicherungsprogrammen m\"{o}glicherweise anders definiert wird.
-
-\item [File Attributes]
- \index[fd]{File Attributes }
- File Attributes (Dateiattribute) sind all diejenigen Informationen, die
-n\"{o}tig sind, um eine Datei und alle ihre Eigenschaften zu identifizieren.
-Dazu geh\"{o}ren alle ihre Gr\"{o}{\ss}e, Zeitpunkt der Erzeugung, Zeitpunkt der letzten
-\"{A}nderung, Berechtigungen, usw.
-Im Normalfall wird der Umgang mit den Attributen vollst\"{a}ndig von Bacula
-\"{u}bernommen, so dass sich der Benutzer dar\"{u}ber keine Gedanken machen muss.
-Zu den Attributen geh\"{o}rt nicht der Inhalt der Datei.
-
-\item [File Daemon]
- \index[fd]{File Daemon }
- Derjenige D\"{a}monprozess, welcher auf dem Client-Computer l\"{a}uft, dessen Daten
-gesichert werden sollen. Wird manchmal auch als File-Service (Datendienst),
-Client-Service (Client-Dienst) oder als FD bezeichnet.
-
-\label{FileSetDef}
-\item [FileSet]
-\index[fd]{FileSet }
-Ein FileSet (Zusammenstellung von Dateien) ist eine Eintrag einer
-Konfigurationsdatei, der festlegt, welche Dateien gesichert werden sollen.
-Es besteht aus einer Liste mit zu sichernden Dateien oder Verzeichnissen,
-eventuell einer Liste mit Dateien die nicht mitgesichert werden sollen und Informationen
-dar\"{u}ber, wie diese Dateien zu sichern sind (komprimiert, verschl\"{u}sselt,
-signiert). N\"{a}heres hierzu im Abschnitt \ilink{``Definition der FileSet
-Resource''}{FileSetResource} im Director-Kapitel dieses Dokuments.
-
-\item [Incremental]
- \index[fd]{Incremental }
- Inkrementell ist eine Sicherung dann, wenn sie alle Dateien einbezieht, die
-seit Beginn der letzten vollen, differentiellen oder inkrementellen Sicherung
-ge\"{a}ndert wurden. Normalerweise wird dies entweder durch die
-Level-Direktive innerhalb der Definition einer Job Ressource oder in
-einem Schedule-Eintrag festgelegt.
-
-\label{JobDef}
-\item [Job]
-\index[fd]{Job }
-Ein Bacula Job ist ein Konfigurations-Eintrag, der die Art und
-Weise definiert, in der Bacula die Daten eines bestimmten Client-Rechners
-sichert oder wiederherstellt. Sie besteht aus den Definitionen des {\bf Type}
-(Sicherung, Wiederherstellung, \"{U}berpr\"{u}fung, usw.), des {\bf Level} (voll,
-inkrementell,...), des {\bf FileSet} und des Speicherorts ({\bf Storage}) an
-welchem die Dateien gesichert werden sollen (Speicherger\"{a}t, Media-Pool). N\"{a}heres
-hierzu im Abschnitt \ilink{``Definition der Job-Resource''
-}{JobResource} im \textbf{Director}-Kapitel dieses Dokuments.
-
-\item [Monitor]
- \index[fd]{Monitor }
- Dieses Programm hat eine Schnittstelle zu allen D\"{a}monprozessen, um dem
-Benutzer oder Systemadministrator die Beobachtung von Baculas Zustand zu
-erm\"{o}glichen.
-
-\item [Resource]
- \index[fd]{Resource }
- Eine Resource ist ein Teil einer Konfigurationsdatei, die eine
-bestimmte Informationseinheit definiert. Eine
-Ressource enth\"{a}lt mehrere Direktiven (einzelne Konfigurations-Anweisungen).
-Die Job-Resource beispielsweise definiert
-alle Eigenschaften eines bestimmten Jobs: Name, Zeitplan, Volume-Pool, Art der
-Sicherung, Level der Sicherung...
-
-\item [Restore]
- \index[fd]{Restore }
- ist eine Ressource innerhalb einer Konfigurationsdatei, die den
-Vorgang der Wiederherstellung einer verlorenen oder besch\"{a}digten Datei von
-einem Sicherungsmedium beschreibt. Es ist der umgekehrte Vorgang wie bei
-einer Sicherung, au{\ss}er dass in den meisten F\"{a}llen bei einem Restore nur
-einige wenige Dateien wiederhergestellt werden, w\"{a}hrend bei einer Sicherung
-normalerweise alle Dateien eines Systems gesichert werden. Selbstverst\"{a}ndlich
-kann Bacula, z.B. nach dem Ausfall einer Festplatte, dazu benutzt werden, ein
-vollst\"{a}ndiges Restore aller im System vorhandenen Dateien auszuf\"{u}hren.
-
-\item [Schedule]
- \index[fd]{Schedule }
- Die Schedule (Zeitplan) ist eine Resource innerhalb einer
-Konfigurationsdatei, die definiert, wann ein Bacula-Job ausgef\"{u}hrt
-wird. Hierzu benutzt die Job-Resource den Namen der Schedule.
-N\"{a}heres hierzu im Abschnitt \ilink{``Definition
-der Schedule-Resource''}{ScheduleResource} im
-``Director''-Kapitel diese Handbuches.
-
-\item [Service]
- \index[fd]{Service }
- Dienst ist die Bezeichnung f\"{u}r einen {\bf Daemon}(D\"{a}monprozess) unter
-Windows. Diese Bezeichnung wird in letzter Zeit auch h\"{a}ufig in
-Unix-Umgebungen benutzt. Als Dienst werden Programme bezeichnet,
-die im st\"{a}ndig Hintergrund laufen.
-
-\item [Storage Coordinates]
- \index[fd]{Storage Coordinates }
- Diejenige Information, die der Storage-Dienst zur\"{u}ckgibt und die eine
-Datei eindeutig auf dem Sicherungsmedium kennzeichnen.
-Sie besteht aus einem Teil der zu jeder gespeicherten Datei
-und einem Teil, der zum ganzen Job geh\"{o}rt.
-Normalerweise wird diese Information im Catalog gespeichert, so dass der
-Benutzer keine besonderen Kenntnisse der Storage Coordinates braucht.
-Zu den Storage Coordinates geh\"{o}ren die Dateiattribute und der eindeutige
-Ort der Sicherung auf dem Sicherungs-Volume.
-
-\item [Storage Daemon]
- \index[fd]{Storage Daemon }
- Der Storage Daemon (Speicher-D\"{a}mon), manchmal auch mit SD bezeichnet,
-ist jenes Programm, das die Attribute und die Daten auf ein Sicherungs-Volume
-schreibt (normalerweise ein Band oder eine Festplatte).
-
-\item [Session]
- \index[sd]{Session }
-Die Session (Sitzung) bezeichnet in der Regel die interne Kommunikation
-zwischen dem File-D\"{a}mon und dem Storage-D\"{a}mon. Der File-D\"{a}mon er\"{o}ffnet
-eine Session mit dem Storage-D\"{a}mon, um ein FileSet zu sichern
-oder wiederherzustellen. Jede Session entspricht einem Bacula-Job (siehe oben).
-
-\item [Verify]
- \index[sd]{Verify }
- Ein Verify ist ein Job, bei dem die aktuellen Dateiattribute mit
-jenen verglichen werden, die zuvor im Catalog
-hinterlegt worden sind. Diese Funktion kann verwendet werden, um \"{A}nderungen an
-wichtigen Systemdateien zu erkennen und ist damit Tripwire \"{a}hnlich. Einer
-der haupts\"{a}chlichen Vorteile dieser Funktionalit\"{a}t ist es, dass es gen\"{u}gt,
-auf dem Rechner, den man sch\"{u}tzen will, den File-D\"{a}mon laufen zu haben.
-Director, Storage-D\"{a}mon und der Catalog sind auf
-einem anderen Rechner installiert. Wenn der Server dann gef\"{a}hrdet wird, ist es
-\"{a}u{\ss}erst unwahrscheinlich, dass die Datenbank mit den Verifikationen davon
-mitbetroffen ist.
-
-Verify kann auch zur \"{U}berpr\"{u}fung benutzt werden, ob die Daten des
-zuletzt gelaufenen Jobs mit denen \"{u}bereinstimmen, die im Catalog
-gespeichert wurden (es werden also die Dateiattribute verglichen).
-Verify kann aber auch den Inhalt eines Volumes mit den Originaldateien
-auf der Festplatte vergleichen.
-
-\item [*Archive]
- \index[fd]{*Archive }
- Eine Archive-Funktion wird nach einer Sicherung durchgef\"{u}hrt. Dabei
-werden die Volumes, auf denen die Daten gesichert sind, der aktiven
-Benutzung entzogen, als ``Archived'' gekennzeichnet und f\"{u}r weitere
-Sicherungen nicht mehr verwendet. Alle Datei- und Job-Eintr\"{a}ge des archivierten
-Volumes werden aus dem Catalog entfernt.
-NOCH NICHT IMPLEMENTIERT.
-
-\item [Retention Period]
- \index[fd]{Retention Period }
- Bacula kennt verschiedene Arten von Retention Periods
-(Aufbewahrungszeitr\"{a}ume). Das sind die File Retention Period,
-die Job Retention Period und die Volume Retention Period.
-Jede diese Retention-Periods bezieht sich auf die
-Zeit, w\"{a}hrend der bestimmte Aufzeichnungen in der Catalog-Datenbank
-gehalten werden. Dies sollte nicht mit jener Zeit verwechselt werden w\"{a}hrend
-der Daten eines Volume g\"{u}ltig sind.
-
-Die File Retention Period bestimmt wie lange die Eintr\"{a}ge zu den
-Dateien in der Catalog-Datenbank gehalten werden. Diese Zeitspanne ist
-wichtig, da diese Eintr\"{a}ge bei weitem den gr\"{o}{\ss}ten Teil des Speicherplatzes in
-der Datenbank belegen. Daher muss gew\"{a}hrleistet sein, dass \"{u}berfl\"{u}ssige oder
-veraltete Eintr\"{a}ge regelm\"{a}{\ss}ig aus der Datenbank entfernt werden
-(hierzu N\"{a}heres im Abschnitt zum {\bf prune}-Befehl in der Beschreibung der Console-Befehle).
-
-Die Job Retention Period ist die Zeitspanne, w\"{a}hrend der Eintr\"{a}ge zu
-den Jobs in der Datenbank gehalten werden. Beachten Sie, dass alle Dateieintr\"{a}ge
-mit dem Job, mit dem sie gesichert wurden, verbunden sind. Die Eintr\"{a}ge zu den
-Dateien k\"{o}nnen gel\"{o}scht sein, w\"{a}hrend die Aufzeichnungen zu den Jobs erhalten
-bleiben. In diesem Fall wird man Informationen \"{u}ber gelaufene Sicherungsjobs
-haben, jedoch keine Einzelheiten \"{u}ber die Dateien, die dabei gesichert
-wurden. Normalerweise werden mit dem L\"{o}schen eines
-Job-Eintrags auch alle seine Aufzeichnungen zu den Dateien gel\"{o}scht.
-
-Die Volume Retention Period bestimmt die Mindestzeit, die
-ein bestimmtes Volume aufbewart wird, bevor Bacula es wiederverwendet.
-Bacula wird in der Regel niemals ein Volume \"{u}berschreiben, dass als
-einziges die Sicherungskopie einer bestimmten Datei enth\"{a}lt. Im Idealfall wird
-der Catalog f\"{u}r alle benutzten Volumes die Eintr\"{a}ge aller
-gesicherten Daeien enthalten. Wenn ein Volume \"{u}berschrieben wird,
-werden die Dateieeintr\"{a}ge, die zuvor auf ihm gespeichert waren aus dem
-Catalog entfernt. Gibt es allerdings einen sehr gro{\ss}en Pool von
-Volumes oder gibt es Volumes, die nie \"{u}berschrieben werden,
-kann die Catalog-Datenbank sehr gro{\ss} werden. Um den Catalog in
-einer handhabbaren Gr\"{o}{\ss}e zu halten, sollten Informationen zu den Sicherungen
-nach der definierten File Retention Period aus ihm entfernt werden.
-Bacula hat Mechanismen, um den Catalog entsprechend der
-definierten Retention Periods automatisch zu bereinigen.
-
-\item [Scan]
- \index[sd]{Scan }
- Bei einer Scan-Operation wird der Inhalt eines oder mehrerer
-Volumes durchsucht. Diese Volumes und die Informationen \"{u}ber
-die Dateien, welche sie enthalten, werden wieder in den Bacula-Catalog
-eingetragen. Danach k\"{o}nnen die Dateien von diesen Volumes auf
-normale Weise wiederhergestellt werden. Diese Funktion ist teilweise
-hilfreich, wenn bestimmte Volumes oder Jobs ihre Retention Period
-\"{u}berschritten haben und aus dem Catalog entfernt worden sind. Um die
-Daten von den Volumes in die Datenbank einzulesen, wird das Programm
-bscan verwendet. N\"{a}heres hierzu im Abschnitt \ilink{bscan}{bscan}
-im Kapitel ``Bacula Hilfsprogramme'' dieses Handbuches.
-
-\item [Volume]
- \index[sd]{Volume }
- Ein Volume ist eine Einheit, auf der gesichert wird, normalerweise
-ein Band oder eine benannte Datei auf der Festplatte auf denen Bacula die
-Daten einer oder mehrerer Sicherungsjobs speichert. Alle Volumes
-erhalten von Bacula eine digitale Kennzeichnung, das Label, so dass Bacula jederzeit wei{\ss},
-welches Volume es tats\"{a}chlich liest. (Normalerweise sollte es mit
-Dateien auf der Festplatte keine Verwechslungen geben, doch bei B\"{a}ndern mountet
-man aus Versehen leicht das Falsche).
-\end{description}
-
-\section{Was Bacula nicht ist}
-\index[general]{Was Bacula nicht ist }
-\index[general]{nicht ist!Was Bacula }
-
-Bacula ist ein Sicherungs-, Wiederherstellungs- und Verifikationsprogramm,
-aber von sich aus noch kein komplettes Rettungsprogramm f\"{u}r den
-Katastrophenfall. Allerdings kann Bacula Teil eines Rettungsprogramms sein,
-falls Sie sorgf\"{a}ltig planen und die Anweisungen im Kapitel
-\ilink{Disaster Recovery}{_ChapterStart38} dieses Handbuches beachten.
-
-Bei sorgf\"{a}ltiger Planung, wie sie im Kapitel ``Disaster Recovery'' dargestellt
-ist, kann {\bf Bacula} ein wesentlicher Bestandteil eines
-Rettungssystems sein. Wenn Sie zum Beispiel eine Bootdiskette
-erstellt haben, dazu eine Bacula-Rettungs-CD, auf der sie die aktuellen
-Partitionsdaten Ihrer Festplatte gespeichert haben und eine komplette Bacula
-Sicherung vorhalten, ist es m\"{o}glich, Ihr System auf einer leeren Festplatte
-wieder herzustellen.
-
-Wenn Sie die den Eintrag {\bf WriteBootstrap} in einem Ihrer Sicherungs-Jobs
-verwendet oder auf irgend eine andere Art eine g\"{u}ltige Bootstrap-Datei
-gesichert haben, werden Sie damit in der Lage sein, die notwendigen Dateien
-wiederherzustellen (auch ohne den Catalog zu verwenden oder von Hand nach Dateien
-suchen zu m\"{u}ssen).
-
-
-\section{Interaktionen zwischen den Bacula-Diensten}
-\index[general]{Interaktionen zwischen den Bacula-Diensten }
-\index[general]{Diensten!Interaktionen zwischen den Bacula- }
-
-Das untenstehende Diagramm zeigt typische Interaktionen zwischen den einzelnen
-Bacula-Diensten bei einem Sicherungs-Job. Jeder Block steht ungef\"{a}hr f\"{u}r einen
-eigenen Prozess (normalerweise ein D\"{a}mon). Im gro{\ss}en und ganzen hat der
-Director den \"{U}berblick \"{u}ber die Aktionen und pflegt die
-Katalog-Datenbank.
-
-\addcontentsline{lof}{figure}{Interaktionen zwischen den Bacula-Diensten}
-\includegraphics{\idir flow.eps}
+++ /dev/null
-%%
-%%
-
-\section*{GNU General Public License}
-\label{GplChapter}
-\index[general]{GNU General Public License }
-\index[general]{License!GNU General Public }
-
-\elink{image of a Philosophical
-GNU}{http://www.gnu.org/graphics/philosophicalgnu.html}
-
-\begin{itemize}
-\item
- \elink{What to do if you see a possible GPL
- violation}{http://www.gnu.org/copyleft/gpl-violation.html}
-\item
- \elink{Translations of the
- GPL}{http://www.gnu.org/copyleft/copyleft.html\#translations}
-\end{itemize}
-
-
-\section{Table of Contents}
-\index[general]{Table of Contents }
-\index[general]{Contents!Table of }
-
-\begin{itemize}
-\item
- \label{TOC1}
- \ilink{GNU GENERAL PUBLIC LICENSE}{SEC1}
-
-\begin{itemize}
-\item
- \label{TOC2}
- \ilink{Preamble}{SEC2}
-\item
- \label{TOC3}
- \ilink{TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND
-MODIFICATION}{SEC3}
-\item
- \label{TOC4}
- \ilink{How to Apply These Terms to Your New Programs}{SEC4}
-\end{itemize}
-
-\end{itemize}
-
-
-\section{GNU GENERAL PUBLIC LICENSE}
-\label{SEC1}
-\index[general]{GNU GENERAL PUBLIC LICENSE }
-\index[general]{LICENSE!GNU GENERAL PUBLIC }
-
-Version 2, June 1991
-
-\footnotesize
-\begin{verbatim}
-Copyright (C) 1989, 1991 Free Software Foundation, Inc.
-51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-Everyone is permitted to copy and distribute verbatim copies
-of this license document, but changing it is not allowed.
-\end{verbatim}
-\normalsize
-
-\section{Preamble}
-\label{SEC2}
-\index[general]{Preamble }
-
-The licenses for most software are designed to take away your freedom to share
-and change it. By contrast, the GNU General Public License is intended to
-guarantee your freedom to share and change free software\verb:--:to make sure the
-software is free for all its users. This General Public License applies to
-most of the Free Software Foundation's software and to any other program whose
-authors commit to using it. (Some other Free Software Foundation software is
-covered by the GNU Library General Public License instead.) You can apply it
-to your programs, too.
-
-When we speak of free software, we are referring to freedom, not price. Our
-General Public Licenses are designed to make sure that you have the freedom to
-distribute copies of free software (and charge for this service if you wish),
-that you receive source code or can get it if you want it, that you can change
-the software or use pieces of it in new free programs; and that you know you
-can do these things.
-
-To protect your rights, we need to make restrictions that forbid anyone to
-deny you these rights or to ask you to surrender the rights. These
-restrictions translate to certain responsibilities for you if you distribute
-copies of the software, or if you modify it.
-
-For example, if you distribute copies of such a program, whether gratis or for
-a fee, you must give the recipients all the rights that you have. You must
-make sure that they, too, receive or can get the source code. And you must
-show them these terms so they know their rights.
-
-We protect your rights with two steps: (1) copyright the software, and (2)
-offer you this license which gives you legal permission to copy, distribute
-and/or modify the software.
-
-Also, for each author's protection and ours, we want to make certain that
-everyone understands that there is no warranty for this free software. If the
-software is modified by someone else and passed on, we want its recipients to
-know that what they have is not the original, so that any problems introduced
-by others will not reflect on the original authors' reputations.
-
-Finally, any free program is threatened constantly by software patents. We
-wish to avoid the danger that redistributors of a free program will
-individually obtain patent licenses, in effect making the program proprietary.
-To prevent this, we have made it clear that any patent must be licensed for
-everyone's free use or not licensed at all.
-
-The precise terms and conditions for copying, distribution and modification
-follow.
-
-\section{TERMS AND CONDITIONS}
-\label{SEC3}
-\index[general]{CONDITIONS!TERMS AND }
-\index[general]{TERMS AND CONDITIONS }
-
-TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
-
-{\bf 0.} This License applies to any program or other work which contains a
-notice placed by the copyright holder saying it may be distributed under the
-terms of this General Public License. The "`Program"', below, refers to any
-such program or work, and a "`work based on the Program"' means either the
-Program or any derivative work under copyright law: that is to say, a work
-containing the Program or a portion of it, either verbatim or with
-modifications and/or translated into another language. (Hereinafter,
-translation is included without limitation in the term "`modification"'.) Each
-licensee is addressed as "`you"'.
-
-Activities other than copying, distribution and modification are not covered
-by this License; they are outside its scope. The act of running the Program is
-not restricted, and the output from the Program is covered only if its
-contents constitute a work based on the Program (independent of having been
-made by running the Program). Whether that is true depends on what the Program
-does.
-
-{\bf 1.} You may copy and distribute verbatim copies of the Program's source
-code as you receive it, in any medium, provided that you conspicuously and
-appropriately publish on each copy an appropriate copyright notice and
-disclaimer of warranty; keep intact all the notices that refer to this License
-and to the absence of any warranty; and give any other recipients of the
-Program a copy of this License along with the Program.
-
-You may charge a fee for the physical act of transferring a copy, and you may
-at your option offer warranty protection in exchange for a fee.
-
-{\bf 2.} You may modify your copy or copies of the Program or any portion of
-it, thus forming a work based on the Program, and copy and distribute such
-modifications or work under the terms of Section 1 above, provided that you
-also meet all of these conditions:
-
-\begin{itemize}
-\item {\bf a)} You must cause the modified files to carry prominent notices
- stating that you changed the files and the date of any change.
-
-\item {\bf b)} You must cause any work that you distribute or publish, that
- in whole or in part contains or is derived from the Program or any part
- thereof, to be licensed as a whole at no charge to all third parties under
- the terms of this License.
-
-\item {\bf c)} If the modified program normally reads commands interactively
- when run, you must cause it, when started running for such interactive use in
- the most ordinary way, to print or display an announcement including an
- appropriate copyright notice and a notice that there is no warranty (or else,
- saying that you provide a warranty) and that users may redistribute the
- program under these conditions, and telling the user how to view a copy of
- this License. (Exception: if the Program itself is interactive but does not
- normally print such an announcement, your work based on the Program is not
- required to print an announcement.)
-\end{itemize}
-
-These requirements apply to the modified work as a whole. If identifiable
-sections of that work are not derived from the Program, and can be reasonably
-considered independent and separate works in themselves, then this License,
-and its terms, do not apply to those sections when you distribute them as
-separate works. But when you distribute the same sections as part of a whole
-which is a work based on the Program, the distribution of the whole must be on
-the terms of this License, whose permissions for other licensees extend to the
-entire whole, and thus to each and every part regardless of who wrote it.
-
-Thus, it is not the intent of this section to claim rights or contest your
-rights to work written entirely by you; rather, the intent is to exercise the
-right to control the distribution of derivative or collective works based on
-the Program.
-
-In addition, mere aggregation of another work not based on the Program with
-the Program (or with a work based on the Program) on a volume of a storage or
-distribution medium does not bring the other work under the scope of this
-License.
-
-{\bf 3.} You may copy and distribute the Program (or a work based on it, under
-Section 2) in object code or executable form under the terms of Sections 1 and
-2 above provided that you also do one of the following:
-
-\begin{itemize}
-\item {\bf a)} Accompany it with the complete corresponding machine-readable
- source code, which must be distributed under the terms of Sections 1 and 2
- above on a medium customarily used for software interchange; or,
-
-\item {\bf b)} Accompany it with a written offer, valid for at least three
- years, to give any third party, for a charge no more than your cost of
- physically performing source distribution, a complete machine-readable copy of
- the corresponding source code, to be distributed under the terms of Sections
- 1 and 2 above on a medium customarily used for software interchange; or,
-
-\item {\bf c)} Accompany it with the information you received as to the offer
- to distribute corresponding source code. (This alternative is allowed only
- for noncommercial distribution and only if you received the program in object
- code or executable form with such an offer, in accord with Subsection b
- above.)
-\end{itemize}
-
-The source code for a work means the preferred form of the work for making
-modifications to it. For an executable work, complete source code means all
-the source code for all modules it contains, plus any associated interface
-definition files, plus the scripts used to control compilation and
-installation of the executable. However, as a special exception, the source
-code distributed need not include anything that is normally distributed (in
-either source or binary form) with the major components (compiler, kernel, and
-so on) of the operating system on which the executable runs, unless that
-component itself accompanies the executable.
-
-If distribution of executable or object code is made by offering access to
-copy from a designated place, then offering equivalent access to copy the
-source code from the same place counts as distribution of the source code,
-even though third parties are not compelled to copy the source along with the
-object code.
-
-{\bf 4.} You may not copy, modify, sublicense, or distribute the Program
-except as expressly provided under this License. Any attempt otherwise to
-copy, modify, sublicense or distribute the Program is void, and will
-automatically terminate your rights under this License. However, parties who
-have received copies, or rights, from you under this License will not have
-their licenses terminated so long as such parties remain in full compliance.
-
-{\bf 5.} You are not required to accept this License, since you have not
-signed it. However, nothing else grants you permission to modify or distribute
-the Program or its derivative works. These actions are prohibited by law if
-you do not accept this License. Therefore, by modifying or distributing the
-Program (or any work based on the Program), you indicate your acceptance of
-this License to do so, and all its terms and conditions for copying,
-distributing or modifying the Program or works based on it.
-
-{\bf 6.} Each time you redistribute the Program (or any work based on the
-Program), the recipient automatically receives a license from the original
-licensor to copy, distribute or modify the Program subject to these terms and
-conditions. You may not impose any further restrictions on the recipients'
-exercise of the rights granted herein. You are not responsible for enforcing
-compliance by third parties to this License.
-
-{\bf 7.} If, as a consequence of a court judgment or allegation of patent
-infringement or for any other reason (not limited to patent issues),
-conditions are imposed on you (whether by court order, agreement or otherwise)
-that contradict the conditions of this License, they do not excuse you from
-the conditions of this License. If you cannot distribute so as to satisfy
-simultaneously your obligations under this License and any other pertinent
-obligations, then as a consequence you may not distribute the Program at all.
-For example, if a patent license would not permit royalty-free redistribution
-of the Program by all those who receive copies directly or indirectly through
-you, then the only way you could satisfy both it and this License would be to
-refrain entirely from distribution of the Program.
-
-If any portion of this section is held invalid or unenforceable under any
-particular circumstance, the balance of the section is intended to apply and
-the section as a whole is intended to apply in other circumstances.
-
-It is not the purpose of this section to induce you to infringe any patents or
-other property right claims or to contest validity of any such claims; this
-section has the sole purpose of protecting the integrity of the free software
-distribution system, which is implemented by public license practices. Many
-people have made generous contributions to the wide range of software
-distributed through that system in reliance on consistent application of that
-system; it is up to the author/donor to decide if he or she is willing to
-distribute software through any other system and a licensee cannot impose that
-choice.
-
-This section is intended to make thoroughly clear what is believed to be a
-consequence of the rest of this License.
-
-{\bf 8.} If the distribution and/or use of the Program is restricted in
-certain countries either by patents or by copyrighted interfaces, the original
-copyright holder who places the Program under this License may add an explicit
-geographical distribution limitation excluding those countries, so that
-distribution is permitted only in or among countries not thus excluded. In
-such case, this License incorporates the limitation as if written in the body
-of this License.
-
-{\bf 9.} The Free Software Foundation may publish revised and/or new versions
-of the General Public License from time to time. Such new versions will be
-similar in spirit to the present version, but may differ in detail to address
-new problems or concerns.
-
-Each version is given a distinguishing version number. If the Program
-specifies a version number of this License which applies to it and "`any later
-version"', you have the option of following the terms and conditions either of
-that version or of any later version published by the Free Software
-Foundation. If the Program does not specify a version number of this License,
-you may choose any version ever published by the Free Software Foundation.
-
-{\bf 10.} If you wish to incorporate parts of the Program into other free
-programs whose distribution conditions are different, write to the author to
-ask for permission. For software which is copyrighted by the Free Software
-Foundation, write to the Free Software Foundation; we sometimes make
-exceptions for this. Our decision will be guided by the two goals of
-preserving the free status of all derivatives of our free software and of
-promoting the sharing and reuse of software generally.
-
-{\bf NO WARRANTY}
-
-{\bf 11.} BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
-FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
-OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE
-THE PROGRAM "`AS IS"' WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR
-IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
-MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO
-THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM
-PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR
-CORRECTION.
-
-{\bf 12.} IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
-WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
-REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
-INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
-OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO
-LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR
-THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
-EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
-DAMAGES.
-
-END OF TERMS AND CONDITIONS
-
-\section{How to Apply These Terms to Your New Programs}
-\label{SEC4}
-\index[general]{Programs!How to Apply These Terms to Your New }
-\index[general]{How to Apply These Terms to Your New Programs }
-
-If you develop a new program, and you want it to be of the greatest possible
-use to the public, the best way to achieve this is to make it free software
-which everyone can redistribute and change under these terms.
-
-To do so, attach the following notices to the program. It is safest to attach
-them to the start of each source file to most effectively convey the exclusion
-of warranty; and each file should have at least the "`copyright"' line and a
-pointer to where the full notice is found.
-
-\footnotesize
-\begin{verbatim}
-{\em one line to give the program's name and an idea of what it does.}
-Copyright (C) {\em yyyy} {\em name of author}
-This program is free software; you can redistribute it and/or
-modify it under the terms of the GNU General Public License
-as published by the Free Software Foundation; either version 2
-of the License, or (at your option) any later version.
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-GNU General Public License for more details.
-You should have received a copy of the GNU General Public License
-along with this program; if not, write to the Free Software
-Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
-02110-1301 USA
-\end{verbatim}
-\normalsize
-
-Also add information on how to contact you by electronic and paper mail.
-
-If the program is interactive, make it output a short notice like this when it
-starts in an interactive mode:
-
-\footnotesize
-\begin{verbatim}
-Gnomovision version 69, Copyright (C) {\em year} {\em name of author}
-Gnomovision comes with ABSOLUTELY NO WARRANTY; for details
-type `show w'. This is free software, and you are welcome
-to redistribute it under certain conditions; type `show c'
-for details.
-\end{verbatim}
-\normalsize
-
-The hypothetical commands {\tt `show w'} and {\tt `show c'} should show the
-appropriate parts of the General Public License. Of course, the commands you
-use may be called something other than {\tt `show w'} and {\tt `show c'}; they
-could even be mouse-clicks or menu items\verb:--:whatever suits your program.
-
-You should also get your employer (if you work as a programmer) or your
-school, if any, to sign a "`copyright disclaimer"' for the program, if
-necessary. Here is a sample; alter the names:
-
-\footnotesize
-\begin{verbatim}
-Yoyodyne, Inc., hereby disclaims all copyright
-interest in the program `Gnomovision'
-(which makes passes at compilers) written
-by James Hacker.
-{\em signature of Ty Coon}, 1 April 1989
-Ty Coon, President of Vice
-\end{verbatim}
-\normalsize
-
-This General Public License does not permit incorporating your program into
-proprietary programs. If your program is a subroutine library, you may
-consider it more useful to permit linking proprietary applications with the
-library. If this is what you want to do, use the GNU Library General Public
-License instead of this License.
-Return to
-\elink{GNU's home page}{http://www.gnu.org/home.html}.
-
-FSF \& GNU inquiries \& questions to
-\elink{gnu@gnu.org}{mailto:gnu@gnu.org}. Other
-\elink{ways to contact}{http://www.gnu.org/home.html\#ContactInfo} the FSF.
-
-Comments on these web pages to
-\elink{webmasters@www.gnu.org}{mailto:webmasters@www.gnu.org}, send other
-questions to
-\elink{gnu@gnu.org}{mailto:gnu@gnu.org}.
-
-Copyright notice above.
-Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
-Boston, MA 02110-1301 USA
-
-Updated: 3 Jan 2000 rms
+++ /dev/null
-# This module does multiple indices, supporting the style of the LaTex 'index'
-# package.
-
-# Version Information:
-# 16-Feb-2005 -- Original Creation. Karl E. Cunningham
-# 14-Mar-2005 -- Clarified and Consolodated some of the code.
-# Changed to smoothly handle single and multiple indices.
-
-# Two LaTeX index formats are supported...
-# --- SINGLE INDEX ---
-# \usepackage{makeidx}
-# \makeindex
-# \index{entry1}
-# \index{entry2}
-# \index{entry3}
-# ...
-# \printindex
-#
-# --- MULTIPLE INDICES ---
-#
-# \usepackage{makeidx}
-# \usepackage{index}
-# \makeindex -- latex2html doesn't care but LaTeX does.
-# \newindex{ref1}{ext1}{ext2}{title1}
-# \newindex{ref2}{ext1}{ext2}{title2}
-# \newindex{ref3}{ext1}{ext2}{title3}
-# \index[ref1]{entry1}
-# \index[ref1]{entry2}
-# \index[ref3]{entry3}
-# \index[ref2]{entry4}
-# \index{entry5}
-# \index[ref3]{entry6}
-# ...
-# \printindex[ref1]
-# \printindex[ref2]
-# \printindex[ref3]
-# \printindex
-# ___________________
-#
-# For the multiple-index style, each index is identified by the ref argument to \newindex, \index,
-# and \printindex. A default index is allowed, which is indicated by omitting the optional
-# argument. The default index does not require a \newindex command. As \index commands
-# are encountered, their entries are stored according
-# to the ref argument. When the \printindex command is encountered, the stored index
-# entries for that argument are retrieved and printed. The title for each index is taken
-# from the last argument in the \newindex command.
-# While processing \index and \printindex commands, if no argument is given the index entries
-# are built into a default index. The title of the default index is simply "Index".
-# This makes the difference between single- and multiple-index processing trivial.
-#
-# Another method can be used by omitting the \printindex command and just using \include to
-# pull in index files created by the makeindex program. These files will start with
-# \begin{theindex}. This command is used to determine where to print the index. Using this
-# approach, the indices will be output in the same order as the newindex commands were
-# originally found (see below). Using a combination of \printindex and \include{indexfile} has not
-# been tested and may produce undesireable results.
-#
-# The index data are stored in a hash for later sorting and output. As \printindex
-# commands are handled, the order in which they were found in the tex filea is saved,
-# associated with the ref argument to \printindex.
-#
-# We use the original %index hash to store the index data into. We append a \002 followed by the
-# name of the index to isolate the entries in different indices from each other. This is necessary
-# so that different indices can have entries with the same name. For the default index, the \002 is
-# appended without the name.
-#
-# Since the index order in the output cannot be determined if the \include{indexfile}
-# command is used, the order will be assumed from the order in which the \newindex
-# commands were originally seen in the TeX files. This order is saved as well as the
-# order determined from any printindex{ref} commands. If \printindex commnads are used
-# to specify the index output, that order will be used. If the \include{idxfile} command
-# is used, the order of the original newindex commands will be used. In this case the
-# default index will be printed last since it doesn't have a corresponding \newindex
-# command and its order cannot be determined. Mixing \printindex and \include{idxfile}
-# commands in the same file is likely to produce less than satisfactory results.
-#
-#
-# The hash containing index data is named %indices. It contains the following data:
-#{
-# 'title' => {
-# $ref1 => $indextitle ,
-# $ref2 => $indextitle ,
-# ...
-# },
-# 'newcmdorder' => [ ref1, ref2, ..., * ], # asterisk indicates the position of the default index.
-# 'printindorder' => [ ref1, ref2, ..., * ], # asterisk indicates the position of the default index.
-#}
-
-
-# Globals to handle multiple indices.
-my %indices;
-
-# This tells the system to use up to 7 words in index entries.
-$WORDS_IN_INDEX = 10;
-
-# KEC 2-18-05
-# Handles the \newindex command. This is called if the \newindex command is
-# encountered in the LaTex source. Gets the index ref and title from the arguments.
-# Saves the index ref and title.
-# Note that we are called once to handle multiple \newindex commands that are
-# newline-separated.
-sub do_cmd_newindex {
- my $data = shift;
- # The data is sent to us as fields delimited by their ID #'s. We extract the
- # fields.
- foreach my $line (split("\n",$data)) {
- my @fields = split (/(?:\<\#\d+?\#\>)+/,$line);
-
- # The index name and title are the second and fourth fields in the data.
- if ($line =~ /^</ or $line =~ /^\\newindex/) {
- my ($indexref,$indextitle) = ($fields[1],$fields[4]);
- $indices{'title'}{$indexref} = $indextitle;
- push (@{$indices{'newcmdorder'}},$indexref);
- }
- }
-}
-
-
-# KEC -- Copied from makeidx.perl and modified to do multiple indices.
-# Processes an \index entry from the LaTex file.
-# Gets the optional argument from the index command, which is the name of the index
-# into which to place the entry.
-# Drops the brackets from the index_name
-# Puts the index entry into the html stream
-# Creates the tokenized index entry (which also saves the index entry info
-sub do_real_index {
- local($_) = @_;
- local($pat,$idx_entry,$index_name);
- # catches opt-arg from \index commands for index.sty
- $index_name = &get_next_optional_argument;
- $index_name = "" unless defined $index_name;
- # Drop leading and trailing brackets from the index name.
- $index_name =~ s/^\[|\]$//g;
-
- $idx_entry = &missing_braces unless (
- (s/$next_pair_pr_rx/$pat=$1;$idx_entry=$2;''/e)
- ||(s/$next_pair_rx/$pat=$1;$idx_entry=$2;''/e));
-
- if ($index_name and defined $idx_entry and
- !defined $indices{'title'}{$index_name}) {
- print STDERR "\nInvalid Index Name: \\index \[$index_name\]\{$idx_entry\}\n";
- }
-
- $idx_entry = &named_index_entry($pat, $idx_entry,$index_name);
- $idx_entry.$_;
-}
-
-# Creates and saves an index entry in the index hashes.
-# Modified to do multiple indices.
-# Creates an index_key that allows index entries to have the same characteristics but be in
-# different indices. This index_key is the regular key with the index name appended.
-# Save the index order for the entry in the %index_order hash.
-sub named_index_entry {
- local($br_id, $str, $index_name) = @_;
- my ($index_key);
- # escape the quoting etc characters
- # ! -> \001
- # @ -> \002
- # | -> \003
- $* = 1; $str =~ s/\n\s*/ /g; $* = 0; # remove any newlines
- # protect \001 occurring with images
- $str =~ s/\001/\016/g; # 0x1 to 0xF
- $str =~ s/\\\\/\011/g; # Double backslash -> 0xB
- $str =~ s/\\;SPMquot;/\012/g; # \;SPMquot; -> 0xC
- $str =~ s/;SPMquot;!/\013/g; # ;SPMquot; -> 0xD
- $str =~ s/!/\001/g; # Exclamation point -> 0x1
- $str =~ s/\013/!/g; # 0xD -> Exclaimation point
- $str =~ s/;SPMquot;@/\015/g; # ;SPMquot;@ to 0xF
- $str =~ s/@/\002/g; # At sign -> 0x2
- $str =~ s/\015/@/g; # 0xF to At sign
- $str =~ s/;SPMquot;\|/\017/g; # ;SMPquot;| to 0x11
- $str =~ s/\|/\003/g; # Vertical line to 0x3
- $str =~ s/\017/|/g; # 0x11 to vertical line
- $str =~ s/;SPMquot;(.)/\1/g; # ;SPMquot; -> whatever the next character is
- $str =~ s/\012/;SPMquot;/g; # 0x12 to ;SPMquot;
- $str =~ s/\011/\\\\/g; # 0x11 to double backslash
- local($key_part, $pageref) = split("\003", $str, 2);
-
- # For any keys of the form: blablabla!blablabla, which want to be split at the
- # exclamation point, replace the ! with a comma and a space. We don't do it
- # that way for this index.
- $key_part =~ s/\001/, /g;
- local(@keys) = split("\001", $key_part);
- # If TITLE is not yet available use $before.
- $TITLE = $saved_title if (($saved_title)&&(!($TITLE)||($TITLE eq $default_title)));
- $TITLE = $before unless $TITLE;
- # Save the reference
- local($words) = '';
- if ($SHOW_SECTION_NUMBERS) { $words = &make_idxnum; }
- elsif ($SHORT_INDEX) { $words = &make_shortidxname; }
- else { $words = &make_idxname; }
- local($super_key) = '';
- local($sort_key, $printable_key, $cur_key);
- foreach $key (@keys) {
- $key =~ s/\016/\001/g; # revert protected \001s
- ($sort_key, $printable_key) = split("\002", $key);
- #
- # RRM: 16 May 1996
- # any \label in the printable-key will have already
- # created a label where the \index occurred.
- # This has to be removed, so that the desired label
- # will be found on the Index page instead.
- #
- if ($printable_key =~ /tex2html_anchor_mark/ ) {
- $printable_key =~ s/><tex2html_anchor_mark><\/A><A//g;
- local($tmpA,$tmpB) = split("NAME=\"", $printable_key);
- ($tmpA,$tmpB) = split("\"", $tmpB);
- $ref_files{$tmpA}='';
- $index_labels{$tmpA} = 1;
- }
- #
- # resolve and clean-up the hyperlink index-entries
- # so they can be saved in an index.pl file
- #
- if ($printable_key =~ /$cross_ref_mark/ ) {
- local($label,$id,$ref_label);
- # $printable_key =~ s/$cross_ref_mark#(\w+)#(\w+)>$cross_ref_mark/
- $printable_key =~ s/$cross_ref_mark#([^#]+)#([^>]+)>$cross_ref_mark/
- do { ($label,$id) = ($1,$2);
- $ref_label = $external_labels{$label} unless
- ($ref_label = $ref_files{$label});
- '"' . "$ref_label#$label" . '">' .
- &get_ref_mark($label,$id)}
- /geo;
- }
- $printable_key =~ s/<\#[^\#>]*\#>//go;
- #RRM
- # recognise \char combinations, for a \backslash
- #
- $printable_key =~ s/\&\#;\'134/\\/g; # restore \\s
- $printable_key =~ s/\&\#;\`<BR> /\\/g; # ditto
- $printable_key =~ s/\&\#;*SPMquot;92/\\/g; # ditto
- #
- # $sort_key .= "@$printable_key" if !($printable_key); # RRM
- $sort_key .= "@$printable_key" if !($sort_key); # RRM
- $sort_key =~ tr/A-Z/a-z/;
- if ($super_key) {
- $cur_key = $super_key . "\001" . $sort_key;
- $sub_index{$super_key} .= $cur_key . "\004";
- } else {
- $cur_key = $sort_key;
- }
-
- # Append the $index_name to the current key with a \002 delimiter. This will
- # allow the same index entry to appear in more than one index.
- $index_key = $cur_key . "\002$index_name";
-
- $index{$index_key} .= "";
-
- #
- # RRM, 15 June 1996
- # if there is no printable key, but one is known from
- # a previous index-entry, then use it.
- #
- if (!($printable_key) && ($printable_key{$index_key}))
- { $printable_key = $printable_key{$index_key}; }
-# if (!($printable_key) && ($printable_key{$cur_key}))
-# { $printable_key = $printable_key{$cur_key}; }
- #
- # do not overwrite the printable_key if it contains an anchor
- #
- if (!($printable_key{$index_key} =~ /tex2html_anchor_mark/ ))
- { $printable_key{$index_key} = $printable_key || $key; }
-# if (!($printable_key{$cur_key} =~ /tex2html_anchor_mark/ ))
-# { $printable_key{$cur_key} = $printable_key || $key; }
-
- $super_key = $cur_key;
- }
- #
- # RRM
- # page-ranges, from |( and |) and |see
- #
- if ($pageref) {
- if ($pageref eq "\(" ) {
- $pageref = '';
- $next .= " from ";
- } elsif ($pageref eq "\)" ) {
- $pageref = '';
- local($next) = $index{$index_key};
-# local($next) = $index{$cur_key};
- # $next =~ s/[\|] *$//;
- $next =~ s/(\n )?\| $//;
- $index{$index_key} = "$next to ";
-# $index{$cur_key} = "$next to ";
- }
- }
-
- if ($pageref) {
- $pageref =~ s/\s*$//g; # remove trailing spaces
- if (!$pageref) { $pageref = ' ' }
- $pageref =~ s/see/<i>see <\/i> /g;
- #
- # RRM: 27 Dec 1996
- # check if $pageref corresponds to a style command.
- # If so, apply it to the $words.
- #
- local($tmp) = "do_cmd_$pageref";
- if (defined &$tmp) {
- $words = &$tmp("<#0#>$words<#0#>");
- $words =~ s/<\#[^\#]*\#>//go;
- $pageref = '';
- }
- }
- #
- # RRM: 25 May 1996
- # any \label in the pageref section will have already
- # created a label where the \index occurred.
- # This has to be removed, so that the desired label
- # will be found on the Index page instead.
- #
- if ($pageref) {
- if ($pageref =~ /tex2html_anchor_mark/ ) {
- $pageref =~ s/><tex2html_anchor_mark><\/A><A//g;
- local($tmpA,$tmpB) = split("NAME=\"", $pageref);
- ($tmpA,$tmpB) = split("\"", $tmpB);
- $ref_files{$tmpA}='';
- $index_labels{$tmpA} = 1;
- }
- #
- # resolve and clean-up any hyperlinks in the page-ref,
- # so they can be saved in an index.pl file
- #
- if ($pageref =~ /$cross_ref_mark/ ) {
- local($label,$id,$ref_label);
- # $pageref =~ s/$cross_ref_mark#(\w+)#(\w+)>$cross_ref_mark/
- $pageref =~ s/$cross_ref_mark#([^#]+)#([^>]+)>$cross_ref_mark/
- do { ($label,$id) = ($1,$2);
- $ref_files{$label} = ''; # ???? RRM
- if ($index_labels{$label}) { $ref_label = ''; }
- else { $ref_label = $external_labels{$label}
- unless ($ref_label = $ref_files{$label});
- }
- '"' . "$ref_label#$label" . '">' . &get_ref_mark($label,$id)}/geo;
- }
- $pageref =~ s/<\#[^\#>]*\#>//go;
-
- if ($pageref eq ' ') { $index{$index_key}='@'; }
- else { $index{$index_key} .= $pageref . "\n | "; }
- } else {
- local($thisref) = &make_named_href('',"$CURRENT_FILE#$br_id",$words);
- $thisref =~ s/\n//g;
- $index{$index_key} .= $thisref."\n | ";
- }
- #print "\nREF: $sort_key : $index_key :$index{$index_key}";
-
- #join('',"<A NAME=$br_id>$anchor_invisible_mark<\/A>",$_);
-
- "<A NAME=\"$br_id\">$anchor_invisible_mark<\/A>";
-}
-
-
-# KEC. -- Copied from makeidx.perl, then modified to do multiple indices.
-# Feeds the index entries to the output. This is called for each index to be built.
-#
-# Generates a list of lookup keys for index entries, from both %printable_keys
-# and %index keys.
-# Sorts the keys according to index-sorting rules.
-# Removes keys with a 0x01 token. (duplicates?)
-# Builds a string to go to the index file.
-# Adds the index entries to the string if they belong in this index.
-# Keeps track of which index is being worked on, so only the proper entries
-# are included.
-# Places the index just built in to the output at the proper place.
-{ my $index_number = 0;
-sub add_real_idx {
- print "\nDoing the index ... Index Number $index_number\n";
- local($key, @keys, $next, $index, $old_key, $old_html);
- my ($idx_ref,$keyref);
- # RRM, 15.6.96: index constructed from %printable_key, not %index
- @keys = keys %printable_key;
-
- while (/$idx_mark/) {
- # Get the index reference from what follows the $idx_mark and
- # remove it from the string.
- s/$idxmark\002(.*?)\002/$idxmark/;
- $idx_ref = $1;
- $index = '';
- # include non- makeidx index-entries
- foreach $key (keys %index) {
- next if $printable_key{$key};
- $old_key = $key;
- if ($key =~ s/###(.*)$//) {
- next if $printable_key{$key};
- push (@keys, $key);
- $printable_key{$key} = $key;
- if ($index{$old_key} =~ /HREF="([^"]*)"/i) {
- $old_html = $1;
- $old_html =~ /$dd?([^#\Q$dd\E]*)#/;
- $old_html = $1;
- } else { $old_html = '' }
- $index{$key} = $index{$old_key} . $old_html."</A>\n | ";
- };
- }
- @keys = sort makeidx_keysort @keys;
- @keys = grep(!/\001/, @keys);
- my $cnt = 0;
- foreach $key (@keys) {
- my ($keyref) = $key =~ /.*\002(.*)/;
- next unless ($idx_ref eq $keyref); # KEC.
- $index .= &add_idx_key($key);
- $cnt++;
- }
- print "$cnt Index Entries Added\n";
- $index = '<DD>'.$index unless ($index =~ /^\s*<D(D|T)>/);
- $index_number++; # KEC.
- if ($SHORT_INDEX) {
- print "(compact version with Legend)";
- local($num) = ( $index =~ s/\<D/<D/g );
- if ($num > 50 ) {
- s/$idx_mark/$preindex<HR><DL>\n$index\n<\/DL>$preindex/o;
- } else {
- s/$idx_mark/$preindex<HR><DL>\n$index\n<\/DL>/o;
- }
- } else {
- s/$idx_mark/<DL COMPACT>\n$index\n<\/DL>/o; }
- }
-}
-}
-
-# KEC. Copied from latex2html.pl and modified to support multiple indices.
-# The bibliography and the index should be treated as separate sections
-# in their own HTML files. The \bibliography{} command acts as a sectioning command
-# that has the desired effect. But when the bibliography is constructed
-# manually using the thebibliography environment, or when using the
-# theindex environment it is not possible to use the normal sectioning
-# mechanism. This subroutine inserts a \bibliography{} or a dummy
-# \textohtmlindex command just before the appropriate environments
-# to force sectioning.
-sub add_bbl_and_idx_dummy_commands {
- local($id) = $global{'max_id'};
-
- s/([\\]begin\s*$O\d+$C\s*thebibliography)/$bbl_cnt++; $1/eg;
- ## if ($bbl_cnt == 1) {
- s/([\\]begin\s*$O\d+$C\s*thebibliography)/$id++; "\\bibliography$O$id$C$O$id$C $1"/geo;
- #}
- $global{'max_id'} = $id;
- # KEC. Modified to global substitution to place multiple index tokens.
- s/[\\]begin\s*($O\d+$C)\s*theindex/\\textohtmlindex$1/go;
- # KEC. Modified to pick up the optional argument to \printindex
- s/[\\]printindex\s*(\[.*?\])?/
- do { (defined $1) ? "\\textohtmlindex $1" : "\\textohtmlindex []"; } /ego;
- &lib_add_bbl_and_idx_dummy_commands() if defined(&lib_add_bbl_and_idx_dummy_commands);
-}
-
-# KEC. Copied from latex2html.pl and modified to support multiple indices.
-# For each textohtmlindex mark found, determine the index titles and headers.
-# We place the index ref in the header so the proper index can be generated later.
-# For the default index, the index ref is blank.
-#
-# One problem is that this routine is called twice.. Once for processing the
-# command as originally seen, and once for processing the command when
-# doing the name for the index file. We can detect that by looking at the
-# id numbers (or ref) surrounding the \theindex command, and not incrementing
-# index_number unless a new id (or ref) is seen. This has the side effect of
-# having to unconventionally start the index_number at -1. But it works.
-#
-# Gets the title from the list of indices.
-# If this is the first index, save the title in $first_idx_file. This is what's referenced
-# in the navigation buttons.
-# Increment the index_number for next time.
-# If the indexname command is defined or a newcommand defined for indexname, do it.
-# Save the index TITLE in the toc
-# Save the first_idx_file into the idxfile. This goes into the nav buttons.
-# Build index_labels if needed.
-# Create the index headings and put them in the output stream.
-
-{ my $index_number = 0; # Will be incremented before use.
- my $first_idx_file; # Static
- my $no_increment = 0;
-
-sub do_cmd_textohtmlindex {
- local($_) = @_;
- my ($idxref,$idxnum,$index_name);
-
- # We get called from make_name with the first argument = "\001noincrement". This is a sign
- # to not increment $index_number the next time we are called. We get called twice, once
- # my make_name and once by process_command. Unfortunately, make_name calls us just to set the name
- # but doesn't use the result so we get called a second time by process_command. This works fine
- # except for cases where there are multiple indices except if they aren't named, which is the case
- # when the index is inserted by an include command in latex. In these cases we are only able to use
- # the index number to decide which index to draw from, and we don't know how to increment that index
- # number if we get called a variable number of times for the same index, as is the case between
- # making html (one output file) and web (multiple output files) output formats.
- if (/\001noincrement/) {
- $no_increment = 1;
- return;
- }
-
- # Remove (but save) the index reference
- s/^\s*\[(.*?)\]/{$idxref = $1; "";}/e;
-
- # If we have an $idxref, the index name was specified. In this case, we have all the
- # information we need to carry on. Otherwise, we need to get the idxref
- # from the $index_number and set the name to "Index".
- if ($idxref) {
- $index_name = $indices{'title'}{$idxref};
- } else {
- if (defined ($idxref = $indices{'newcmdorder'}->[$index_number])) {
- $index_name = $indices{'title'}{$idxref};
- } else {
- $idxref = '';
- $index_name = "Index";
- }
- }
-
- $idx_title = "Index"; # The name displayed in the nav bar text.
-
- # Only set $idxfile if we are at the first index. This will point the
- # navigation panel to the first index file rather than the last.
- $first_idx_file = $CURRENT_FILE if ($index_number == 0);
- $idxfile = $first_idx_file; # Pointer for the Index button in the nav bar.
- $toc_sec_title = $index_name; # Index link text in the toc.
- $TITLE = $toc_sec_title; # Title for this index, from which its filename is built.
- if (%index_labels) { &make_index_labels(); }
- if (($SHORT_INDEX) && (%index_segment)) { &make_preindex(); }
- else { $preindex = ''; }
- local $idx_head = $section_headings{'textohtmlindex'};
- local($heading) = join(''
- , &make_section_heading($TITLE, $idx_head)
- , $idx_mark, "\002", $idxref, "\002" );
- local($pre,$post) = &minimize_open_tags($heading);
- $index_number++ unless ($no_increment);
- $no_increment = 0;
- join('',"<BR>\n" , $pre, $_);
-}
-}
-
-# Returns an index key, given the key passed as the first argument.
-# Not modified for multiple indices.
-sub add_idx_key {
- local($key) = @_;
- local($index, $next);
- if (($index{$key} eq '@' )&&(!($index_printed{$key}))) {
- if ($SHORT_INDEX) { $index .= "<DD><BR>\n<DT>".&print_key."\n<DD>"; }
- else { $index .= "<DT><DD><BR>\n<DT>".&print_key."\n<DD>"; }
- } elsif (($index{$key})&&(!($index_printed{$key}))) {
- if ($SHORT_INDEX) {
- $next = "<DD>".&print_key."\n : ". &print_idx_links;
- } else {
- $next = "<DT>".&print_key."\n<DD>". &print_idx_links;
- }
- $index .= $next."\n";
- $index_printed{$key} = 1;
- }
-
- if ($sub_index{$key}) {
- local($subkey, @subkeys, $subnext, $subindex);
- @subkeys = sort(split("\004", $sub_index{$key}));
- if ($SHORT_INDEX) {
- $index .= "<DD>".&print_key unless $index_printed{$key};
- $index .= "<DL>\n";
- } else {
- $index .= "<DT>".&print_key."\n<DD>" unless $index_printed{$key};
- $index .= "<DL COMPACT>\n";
- }
- foreach $subkey (@subkeys) {
- $index .= &add_sub_idx_key($subkey) unless ($index_printed{$subkey});
- }
- $index .= "</DL>\n";
- }
- return $index;
-}
-
-1; # Must be present as the last line.
+++ /dev/null
-# This file serves as a place to put initialization code and constants to
-# affect the behavior of latex2html for generating the bacula manuals.
-
-# $LINKPOINT specifies what filename to use to link to when creating
-# index.html. Not that this is a hard link.
-$LINKPOINT='"$OVERALL_TITLE"';
-
-
-# The following must be the last line of this file.
-1;
+++ /dev/null
-%%
-%%
-
-\section*{GNU Lesser General Public License}
-\label{LesserChapter}
-\index[general]{GNU Lesser General Public License }
-\index[general]{License!GNU Lesser General Public }
-
-\elink{image of a Philosophical GNU}
-{\url{http://www.gnu.org/graphics/philosophicalgnu.html}} [
-\elink{English}{\url{http://www.gnu.org/copyleft/lesser.html}} |
-\elink{Japanese}{\url{http://www.gnu.org/copyleft/lesser.ja.html}} ]
-
-\begin{itemize}
-\item
- \elink{Why you shouldn't use the Lesser GPL for your next
- library}{\url{http://www.gnu.org/philosophy/why-not-lgpl.html}}
-\item
- \elink{What to do if you see a possible LGPL
- violation}{\url{http://www.gnu.org/copyleft/gpl-violation.html}}
-\item
- \elink{Translations of the LGPL}
-{\url{http://www.gnu.org/copyleft/copyleft.html\#translationsLGPL}}
-\item The GNU Lesser General Public License as a
- \elink{text file}{\url{http://www.gnu.org/copyleft/lesser.txt}}
-\item The GNU Lesser General Public License as a
- \elink{Texinfo}{\url{http://www.gnu.org/copyleft/lesser.texi}} file
- \end{itemize}
-
-
-This GNU Lesser General Public License counts as the successor of the GNU
-Library General Public License. For an explanation of why this change was
-necessary, read the
-\elink{Why you shouldn't use the Lesser GPL for your next
-library}{\url{http://www.gnu.org/philosophy/why-not-lgpl.html}} article.
-
-\section{Table of Contents}
-\index[general]{Table of Contents }
-\index[general]{Contents!Table of }
-
-\begin{itemize}
-\item
- \label{TOC12}
- \ilink{GNU LESSER GENERAL PUBLIC LICENSE}{SEC12}
-
-\begin{itemize}
-\item
- \label{TOC23}
- \ilink{Preamble}{SEC23}
-\item
- \label{TOC34}
- \ilink{TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND
-MODIFICATION}{SEC34}
-\item
- \label{TOC45}
- \ilink{How to Apply These Terms to Your New Libraries}{SEC45}
-\end{itemize}
-
-\end{itemize}
-
-
-\section{GNU LESSER GENERAL PUBLIC LICENSE}
-\label{SEC12}
-\index[general]{LICENSE!GNU LESSER GENERAL PUBLIC }
-\index[general]{GNU LESSER GENERAL PUBLIC LICENSE }
-
-Version 2.1, February 1999
-
-\footnotesize
-\begin{verbatim}
-Copyright (C) 1991, 1999 Free Software Foundation, Inc.
-51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-Everyone is permitted to copy and distribute verbatim copies
-of this license document, but changing it is not allowed.
-[This is the first released version of the Lesser GPL. It also counts
- as the successor of the GNU Library Public License, version 2, hence
- the version number 2.1.]
-\end{verbatim}
-\normalsize
-
-\section{Preamble}
-\label{SEC23}
-\index[general]{Preamble }
-
-The licenses for most software are designed to take away your freedom to share
-and change it. By contrast, the GNU General Public Licenses are intended to
-guarantee your freedom to share and change free software\verb:--:to make sure the
-software is free for all its users.
-
-This license, the Lesser General Public License, applies to some specially
-designated software packages\verb:--:typically libraries\verb:--:of the Free Software
-Foundation and other authors who decide to use it. You can use it too, but we
-suggest you first think carefully about whether this license or the ordinary
-General Public License is the better strategy to use in any particular case,
-based on the explanations below.
-
-When we speak of free software, we are referring to freedom of use, not price.
-Our General Public Licenses are designed to make sure that you have the
-freedom to distribute copies of free software (and charge for this service if
-you wish); that you receive source code or can get it if you want it; that you
-can change the software and use pieces of it in new free programs; and that
-you are informed that you can do these things.
-
-To protect your rights, we need to make restrictions that forbid distributors
-to deny you these rights or to ask you to surrender these rights. These
-restrictions translate to certain responsibilities for you if you distribute
-copies of the library or if you modify it.
-
-For example, if you distribute copies of the library, whether gratis or for a
-fee, you must give the recipients all the rights that we gave you. You must
-make sure that they, too, receive or can get the source code. If you link
-other code with the library, you must provide complete object files to the
-recipients, so that they can relink them with the library after making changes
-to the library and recompiling it. And you must show them these terms so they
-know their rights.
-
-We protect your rights with a two-step method: (1) we copyright the library,
-and (2) we offer you this license, which gives you legal permission to copy,
-distribute and/or modify the library.
-
-To protect each distributor, we want to make it very clear that there is no
-warranty for the free library. Also, if the library is modified by someone
-else and passed on, the recipients should know that what they have is not the
-original version, so that the original author's reputation will not be
-affected by problems that might be introduced by others.
-
-Finally, software patents pose a constant threat to the existence of any free
-program. We wish to make sure that a company cannot effectively restrict the
-users of a free program by obtaining a restrictive license from a patent
-holder. Therefore, we insist that any patent license obtained for a version of
-the library must be consistent with the full freedom of use specified in this
-license.
-
-Most GNU software, including some libraries, is covered by the ordinary GNU
-General Public License. This license, the GNU Lesser General Public License,
-applies to certain designated libraries, and is quite different from the
-ordinary General Public License. We use this license for certain libraries in
-order to permit linking those libraries into non-free programs.
-
-When a program is linked with a library, whether statically or using a shared
-library, the combination of the two is legally speaking a combined work, a
-derivative of the original library. The ordinary General Public License
-therefore permits such linking only if the entire combination fits its
-criteria of freedom. The Lesser General Public License permits more lax
-criteria for linking other code with the library.
-
-We call this license the "`Lesser"' General Public License because it does
-Less to protect the user's freedom than the ordinary General Public License.
-It also provides other free software developers Less of an advantage over
-competing non-free programs. These disadvantages are the reason we use the
-ordinary General Public License for many libraries. However, the Lesser
-license provides advantages in certain special circumstances.
-
-For example, on rare occasions, there may be a special need to encourage the
-widest possible use of a certain library, so that it becomes a de-facto
-standard. To achieve this, non-free programs must be allowed to use the
-library. A more frequent case is that a free library does the same job as
-widely used non-free libraries. In this case, there is little to gain by
-limiting the free library to free software only, so we use the Lesser General
-Public License.
-
-In other cases, permission to use a particular library in non-free programs
-enables a greater number of people to use a large body of free software. For
-example, permission to use the GNU C Library in non-free programs enables many
-more people to use the whole GNU operating system, as well as its variant, the
-GNU/Linux operating system.
-
-Although the Lesser General Public License is Less protective of the users'
-freedom, it does ensure that the user of a program that is linked with the
-Library has the freedom and the wherewithal to run that program using a
-modified version of the Library.
-
-The precise terms and conditions for copying, distribution and modification
-follow. Pay close attention to the difference between a "`work based on the
-library"' and a "`work that uses the library"'. The former contains code
-derived from the library, whereas the latter must be combined with the library
-in order to run.
-
-\section{TERMS AND CONDITIONS}
-\label{SEC34}
-\index[general]{CONDITIONS!TERMS AND }
-\index[general]{TERMS AND CONDITIONS }
-
-TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
-
-{\bf 0.} This License Agreement applies to any software library or other
-program which contains a notice placed by the copyright holder or other
-authorized party saying it may be distributed under the terms of this Lesser
-General Public License (also called "`this License"'). Each licensee is
-addressed as "`you"'.
-
-A "library" means a collection of software functions and/or data prepared so
-as to be conveniently linked with application programs (which use some of
-those functions and data) to form executables.
-
-The "`Library"', below, refers to any such software library or work which has
-been distributed under these terms. A "`work based on the Library"' means
-either the Library or any derivative work under copyright law: that is to say,
-a work containing the Library or a portion of it, either verbatim or with
-modifications and/or translated straightforwardly into another language.
-(Hereinafter, translation is included without limitation in the term
-"`modification"'.)
-
-"`Source code"' for a work means the preferred form of the work for making
-modifications to it. For a library, complete source code means all the source
-code for all modules it contains, plus any associated interface definition
-files, plus the scripts used to control compilation and installation of the
-library.
-
-Activities other than copying, distribution and modification are not covered
-by this License; they are outside its scope. The act of running a program
-using the Library is not restricted, and output from such a program is covered
-only if its contents constitute a work based on the Library (independent of
-the use of the Library in a tool for writing it). Whether that is true depends
-on what the Library does and what the program that uses the Library does.
-
-{\bf 1.} You may copy and distribute verbatim copies of the Library's complete
-source code as you receive it, in any medium, provided that you conspicuously
-and appropriately publish on each copy an appropriate copyright notice and
-disclaimer of warranty; keep intact all the notices that refer to this License
-and to the absence of any warranty; and distribute a copy of this License
-along with the Library.
-
-You may charge a fee for the physical act of transferring a copy, and you may
-at your option offer warranty protection in exchange for a fee.
-
-{\bf 2.} You may modify your copy or copies of the Library or any portion of
-it, thus forming a work based on the Library, and copy and distribute such
-modifications or work under the terms of Section 1 above, provided that you
-also meet all of these conditions:
-
-\begin{itemize}
-\item {\bf a)} The modified work must itself be a software library.
-\item {\bf b)} You must cause the files modified to carry prominent notices
- stating that you changed the files and the date of any change.
-\item {\bf c)} You must cause the whole of the work to be licensed at no
- charge to all third parties under the terms of this License.
-\item {\bf d)} If a facility in the modified Library refers to a function or
- a table of data to be supplied by an application program that uses the
- facility, other than as an argument passed when the facility is invoked, then
-you must make a good faith effort to ensure that, in the event an application
-does not supply such function or table, the facility still operates, and
-performs whatever part of its purpose remains meaningful.
-
-(For example, a function in a library to compute square roots has a purpose
-that is entirely well-defined independent of the application. Therefore,
-Subsection 2d requires that any application-supplied function or table used
-by this function must be optional: if the application does not supply it, the
-square root function must still compute square roots.)
-
-These requirements apply to the modified work as a whole. If identifiable
-sections of that work are not derived from the Library, and can be reasonably
-considered independent and separate works in themselves, then this License,
-and its terms, do not apply to those sections when you distribute them as
-separate works. But when you distribute the same sections as part of a whole
-which is a work based on the Library, the distribution of the whole must be
-on the terms of this License, whose permissions for other licensees extend to
-the entire whole, and thus to each and every part regardless of who wrote
-it.
-
-Thus, it is not the intent of this section to claim rights or contest your
-rights to work written entirely by you; rather, the intent is to exercise the
-right to control the distribution of derivative or collective works based on
-the Library.
-
-In addition, mere aggregation of another work not based on the Library with
-the Library (or with a work based on the Library) on a volume of a storage or
-distribution medium does not bring the other work under the scope of this
-License.
-\end{itemize}
-
-{\bf 3.} You may opt to apply the terms of the ordinary GNU General Public
-License instead of this License to a given copy of the Library. To do this,
-you must alter all the notices that refer to this License, so that they refer
-to the ordinary GNU General Public License, version 2, instead of to this
-License. (If a newer version than version 2 of the ordinary GNU General Public
-License has appeared, then you can specify that version instead if you wish.)
-Do not make any other change in these notices.
-
-Once this change is made in a given copy, it is irreversible for that copy, so
-the ordinary GNU General Public License applies to all subsequent copies and
-derivative works made from that copy.
-
-This option is useful when you wish to copy part of the code of the Library
-into a program that is not a library.
-
-{\bf 4.} You may copy and distribute the Library (or a portion or derivative
-of it, under Section 2) in object code or executable form under the terms of
-Sections 1 and 2 above provided that you accompany it with the complete
-corresponding machine-readable source code, which must be distributed under
-the terms of Sections 1 and 2 above on a medium customarily used for software
-interchange.
-
-If distribution of object code is made by offering access to copy from a
-designated place, then offering equivalent access to copy the source code from
-the same place satisfies the requirement to distribute the source code, even
-though third parties are not compelled to copy the source along with the
-object code.
-
-{\bf 5.} A program that contains no derivative of any portion of the Library,
-but is designed to work with the Library by being compiled or linked with it,
-is called a "`work that uses the Library"'. Such a work, in isolation, is not
-a derivative work of the Library, and therefore falls outside the scope of
-this License.
-
-However, linking a "`work that uses the Library"' with the Library creates an
-executable that is a derivative of the Library (because it contains portions
-of the Library), rather than a "`work that uses the library"'. The executable
-is therefore covered by this License. Section 6 states terms for distribution
-of such executables.
-
-When a "`work that uses the Library"' uses material from a header file that is
-part of the Library, the object code for the work may be a derivative work of
-the Library even though the source code is not. Whether this is true is
-especially significant if the work can be linked without the Library, or if
-the work is itself a library. The threshold for this to be true is not
-precisely defined by law.
-
-If such an object file uses only numerical parameters, data structure layouts
-and accessors, and small macros and small inline functions (ten lines or less
-in length), then the use of the object file is unrestricted, regardless of
-whether it is legally a derivative work. (Executables containing this object
-code plus portions of the Library will still fall under Section 6.)
-
-Otherwise, if the work is a derivative of the Library, you may distribute the
-object code for the work under the terms of Section 6. Any executables
-containing that work also fall under Section 6, whether or not they are linked
-directly with the Library itself.
-
-{\bf 6.} As an exception to the Sections above, you may also combine or link a
-"`work that uses the Library"' with the Library to produce a work containing
-portions of the Library, and distribute that work under terms of your choice,
-provided that the terms permit modification of the work for the customer's own
-use and reverse engineering for debugging such modifications.
-
-You must give prominent notice with each copy of the work that the Library is
-used in it and that the Library and its use are covered by this License. You
-must supply a copy of this License. If the work during execution displays
-copyright notices, you must include the copyright notice for the Library among
-them, as well as a reference directing the user to the copy of this License.
-Also, you must do one of these things:
-
-\begin{itemize}
-\item {\bf a)} Accompany the work with the complete corresponding
- machine-readable source code for the Library including whatever changes were
- used in the work (which must be distributed under Sections 1 and 2 above);
-and, if the work is an executable linked with the Library, with the complete
-machine-readable "`work that uses the Library"', as object code and/or source
-code, so that the user can modify the Library and then relink to produce a
-modified executable containing the modified Library. (It is understood that
-the user who changes the contents of definitions files in the Library will
-not necessarily be able to recompile the application to use the modified
-definitions.)
-\item {\bf b)} Use a suitable shared library mechanism for linking with the
- Library. A suitable mechanism is one that (1) uses at run time a copy of the
- library already present on the user's computer system, rather than copying
-library functions into the executable, and (2) will operate properly with a
-modified version of the library, if the user installs one, as long as the
-modified version is interface-compatible with the version that the work was
-made with.
-\item {\bf c)} Accompany the work with a written offer, valid for at least
- three years, to give the same user the materials specified in Subsection 6a,
- above, for a charge no more than the cost of performing this distribution.
-\item {\bf d)} If distribution of the work is made by offering access to copy
- from a designated place, offer equivalent access to copy the above specified
- materials from the same place.
-\item {\bf e)} Verify that the user has already received a copy of these
- materials or that you have already sent this user a copy.
- \end{itemize}
-
-For an executable, the required form of the "`work that uses the Library"'
-must include any data and utility programs needed for reproducing the
-executable from it. However, as a special exception, the materials to be
-distributed need not include anything that is normally distributed (in either
-source or binary form) with the major components (compiler, kernel, and so on)
-of the operating system on which the executable runs, unless that component
-itself accompanies the executable.
-
-It may happen that this requirement contradicts the license restrictions of
-other proprietary libraries that do not normally accompany the operating
-system. Such a contradiction means you cannot use both them and the Library
-together in an executable that you distribute.
-
-{\bf 7.} You may place library facilities that are a work based on the Library
-side-by-side in a single library together with other library facilities not
-covered by this License, and distribute such a combined library, provided that
-the separate distribution of the work based on the Library and of the other
-library facilities is otherwise permitted, and provided that you do these two
-things:
-
-\begin{itemize}
-\item {\bf a)} Accompany the combined library with a copy of the same work
- based on the Library, uncombined with any other library facilities. This must
- be distributed under the terms of the Sections above.
-\item {\bf b)} Give prominent notice with the combined library of the fact
- that part of it is a work based on the Library, and explaining where to find
- the accompanying uncombined form of the same work.
-\end{itemize}
-
-{\bf 8.} You may not copy, modify, sublicense, link with, or distribute the
-Library except as expressly provided under this License. Any attempt otherwise
-to copy, modify, sublicense, link with, or distribute the Library is void, and
-will automatically terminate your rights under this License. However, parties
-who have received copies, or rights, from you under this License will not have
-their licenses terminated so long as such parties remain in full compliance.
-
-{\bf 9.} You are not required to accept this License, since you have not
-signed it. However, nothing else grants you permission to modify or distribute
-the Library or its derivative works. These actions are prohibited by law if
-you do not accept this License. Therefore, by modifying or distributing the
-Library (or any work based on the Library), you indicate your acceptance of
-this License to do so, and all its terms and conditions for copying,
-distributing or modifying the Library or works based on it.
-
-{\bf 10.} Each time you redistribute the Library (or any work based on the
-Library), the recipient automatically receives a license from the original
-licensor to copy, distribute, link with or modify the Library subject to these
-terms and conditions. You may not impose any further restrictions on the
-recipients' exercise of the rights granted herein. You are not responsible for
-enforcing compliance by third parties with this License.
-
-{\bf 11.} If, as a consequence of a court judgment or allegation of patent
-infringement or for any other reason (not limited to patent issues),
-conditions are imposed on you (whether by court order, agreement or otherwise)
-that contradict the conditions of this License, they do not excuse you from
-the conditions of this License. If you cannot distribute so as to satisfy
-simultaneously your obligations under this License and any other pertinent
-obligations, then as a consequence you may not distribute the Library at all.
-For example, if a patent license would not permit royalty-free redistribution
-of the Library by all those who receive copies directly or indirectly through
-you, then the only way you could satisfy both it and this License would be to
-refrain entirely from distribution of the Library.
-
-If any portion of this section is held invalid or unenforceable under any
-particular circumstance, the balance of the section is intended to apply, and
-the section as a whole is intended to apply in other circumstances.
-
-It is not the purpose of this section to induce you to infringe any patents or
-other property right claims or to contest validity of any such claims; this
-section has the sole purpose of protecting the integrity of the free software
-distribution system which is implemented by public license practices. Many
-people have made generous contributions to the wide range of software
-distributed through that system in reliance on consistent application of that
-system; it is up to the author/donor to decide if he or she is willing to
-distribute software through any other system and a licensee cannot impose that
-choice.
-
-This section is intended to make thoroughly clear what is believed to be a
-consequence of the rest of this License.
-
-{\bf 12.} If the distribution and/or use of the Library is restricted in
-certain countries either by patents or by copyrighted interfaces, the original
-copyright holder who places the Library under this License may add an explicit
-geographical distribution limitation excluding those countries, so that
-distribution is permitted only in or among countries not thus excluded. In
-such case, this License incorporates the limitation as if written in the body
-of this License.
-
-{\bf 13.} The Free Software Foundation may publish revised and/or new versions
-of the Lesser General Public License from time to time. Such new versions will
-be similar in spirit to the present version, but may differ in detail to
-address new problems or concerns.
-
-Each version is given a distinguishing version number. If the Library
-specifies a version number of this License which applies to it and "`any later
-version"', you have the option of following the terms and conditions either of
-that version or of any later version published by the Free Software
-Foundation. If the Library does not specify a license version number, you may
-choose any version ever published by the Free Software Foundation.
-
-{\bf 14.} If you wish to incorporate parts of the Library into other free
-programs whose distribution conditions are incompatible with these, write to
-the author to ask for permission. For software which is copyrighted by the
-Free Software Foundation, write to the Free Software Foundation; we sometimes
-make exceptions for this. Our decision will be guided by the two goals of
-preserving the free status of all derivatives of our free software and of
-promoting the sharing and reuse of software generally.
-
-{\bf NO WARRANTY}
-
-{\bf 15.} BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
-FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
-OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE
-THE LIBRARY "`AS IS"' WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR
-IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
-MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO
-THE QUALITY AND PERFORMANCE OF THE LIBRARY IS WITH YOU. SHOULD THE LIBRARY
-PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR
-CORRECTION.
-
-{\bf 16.} IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
-WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
-REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
-INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
-OUT OF THE USE OR INABILITY TO USE THE LIBRARY (INCLUDING BUT NOT LIMITED TO
-LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR
-THIRD PARTIES OR A FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE),
-EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
-DAMAGES.
-
-END OF TERMS AND CONDITIONS
-
-\section{How to Apply These Terms to Your New Libraries}
-\label{SEC45}
-\index[general]{Libraries!How to Apply These Terms to Your New }
-\index[general]{How to Apply These Terms to Your New Libraries }
-
-
-If you develop a new library, and you want it to be of the greatest possible
-use to the public, we recommend making it free software that everyone can
-redistribute and change. You can do so by permitting redistribution under
-these terms (or, alternatively, under the terms of the ordinary General Public
-License).
-
-To apply these terms, attach the following notices to the library. It is
-safest to attach them to the start of each source file to most effectively
-convey the exclusion of warranty; and each file should have at least the
-"copyright" line and a pointer to where the full notice is found.
-
-\footnotesize
-\begin{verbatim}
-{\it one line to give the library's name and an idea of what it does.}
-Copyright (C) {\it year} {\it name of author}
-This library is free software; you can redistribute it and/or
-modify it under the terms of the GNU Lesser General Public
-License as published by the Free Software Foundation; either
-version 2.1 of the License, or (at your option) any later version.
-This library is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
-Lesser General Public License for more details.
-You should have received a copy of the GNU Lesser General Public
-License along with this library; if not, write to the Free Software
-Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
-USA
-\end{verbatim}
-\normalsize
-
-Also add information on how to contact you by electronic and paper mail.
-
-You should also get your employer (if you work as a programmer) or your
-school, if any, to sign a "copyright disclaimer" for the library, if
-necessary. Here is a sample; alter the names:
-
-\footnotesize
-\begin{verbatim}
-Yoyodyne, Inc., hereby disclaims all copyright interest in
-the library "Frob" (a library for tweaking knobs) written
-by James Random Hacker.
-{\it signature of Ty Coon}, 1 April 1990
-Ty Coon, President of Vice
-\end{verbatim}
-\normalsize
-
-That's all there is to it!
-Return to
-\elink{GNU's home page}{\url{http://www.gnu.org/home.html}}.
-
-FSF \& GNU inquiries \& questions to
-\elink{gnu@gnu.org}{mailto:gnu@gnu.org}. Other
-\elink{ways to contact}{\url{http://www.gnu.org/home.html\#ContactInfo}} the FSF.
-
-Comments on these web pages to
-\elink{webmasters@www.gnu.org}{mailto:webmasters@www.gnu.org}, send other
-questions to
-\elink{gnu@gnu.org}{mailto:gnu@gnu.org}.
-
-Copyright notice above.
-Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
-Boston, MA 02110-1301 USA
-USA
-
-Updated: 27 Nov 2000 paulv
+++ /dev/null
-%%
-%%
-
-\chapter{Bacula Urheberrecht, Handelsmarke und Lizenzen}
-\label{LicenseChapter}
-\index[general]{Lizenzen!Bacula Urheberrecht Handelsmarke}
-\index[general]{Bacula Urheberrecht, Handelsmarke und Lizenzen}
-
-Bacula verwendet eine Anzahl von verschiedenen Lizenzen. Falls
-Sie eine gedruckte Ausgabe dieses Handbuchs haben, k\"{o}nnen Sie
-Einzelheiten zu den unten genannten Lizenzen unter \elink{http://www.bacula.org}{\url{http://www.bacula.org}} finden.
-
-\section{FDL}
-\index[general]{FDL }
-
-Die GNU Free Documentation License (FDL) die f\"{u}r dieses Handbuch
-benutzt wird, ist eine freie und offene Lizenz. Das bedeutet,
-dass Sie dieses Handbuch vervielf\"{a}ltigen und \"{a}ndern d\"{u}rfen.
-Allerdings sollten Sie ein ge\"{a}ndertes oder angepasstes Handbuch
-bitte nicht selbst ver\"{o}ffentlichen, sondern Ihre \"{A}nderungen
-und Korrekturen in das offizielle Handbuch des Bacula-Projekts
-einflie{\ss}en lassen.
-
-Die jeweils aktuellste Version des Handbuch finden Sie im Internet unter
-\elink{http://www.bacula.org}{\url{http://www.bacula.org}}.
-
-% TODO: Point to appendix that has it
-
-
-\section{GPL}
-\index[general]{GPL }
-
-Der weitgehend gr\"{o}{\ss}te Teil des Quellcodes ist unter der
-\ilink{GNU General Public License version 2.}{GplChapter} ver\"{o}ffentlicht.
-
-Der weitgehend gr\"{o}{\ss}te Teil des Quellcodes ist urheberrechtlich
-gesch\"{u}tzt: Copyright \copyright 2000-2009 Free Software Foundation Europe e.V.
-
-Teile des Quellcodes sind eventuell durch Dritte urheberrerchtlich
-gesch\"{u}tzt (ATT, the Free Software Foundation, ...) aber unter der
-GPL Lizenz freigegeben.
-
-\section{LGPL}
-\index[general]{LGPL }
-
-Einige der Bacula-Bibliotheken sind unter der
-\ilink{GNU Lesser General Public Lizenz}{LesserChapter}
-freigegeben. Das erlaubt es Dritten diesen Quellcode
-in ihren propriet\"{a}ren Programmen zu verwenden um
-mit den Bacula-Prozessen zu interagieren.
-
-\section{Public Domain}
-\index[general]{Domain!Public }
-\index[general]{Public Domain }
-
-Einige Teile des Quellcodes sind lizenzfrei.
-Zum Beispiel md5.c und SQLite.
-
-\section{Handelsmarke}
-\index[general]{Handelsmarke}
-
-Bacula\raisebox{.6ex}{\textsuperscript{\textregistered}} ist eine
-registrierte Handelsmarke von Kern Sibbald.
-
-Diese Marke wurde registriert um sicherzustellen, dass jedes Programm
-das den Namen Bacula tr\"{a}gt, kompatibel mit dem Programm ist, das
-wir als Bacula freigegeben haben. Die Benutzung der Marke Bacula ist
-auf Softwaresysteme beschr\"{a}nkt, die exakt mit den hier beschriebenen
-Programmen \"{u}bereinstimmen.
-
-\section{treuh\"{a}nderisches Lizenz-Abkommen}
-\index[general]{treuh\"{a}nderisches Lizenz-Abkommen}
-Entwickler die signifikante \"{A}nderungen zum Bacula Quellcode
-beutragen, sollten einem treuh\"{a}nderisches Lizenz-Abkommen zustimmen.
-Dadurch bleiben die Rechte am entwickelten Code ebenso beim Author,
-wie sie aber auch die Free Software Foundation Europe (und somit auch an das
-Bacula-Projekt) \"{u}bertragen werden. Das treuh\"{a}nderische Lizenz-Abkommen
-finden Sie im Internet unter:
-\elink{http://www.bacula.org/en/FLA-bacula.en.pdf}{\url{http://www.bacula.org/en/FLA-bacula.en.pdf}}
-
-es sollte ausgef\"{u}llt an diese Adresse geschickt werden:
-
-\begin{quote}
- Free Software Foundation Europe \\
- Freedom Task Force \\
- Sumatrastrasse 25 \\
- 8006 Z\"{u}rich \\
- Switzerland \\
-\end{quote}
-
-Bitte beachten Sie, dass die oben genannte Adresse sich von der, in dem Dokument
-genannten, unterscheidet. Wenn Sie das ausgef\"{u}llte Lizenz-Abkommen absenden,
-sollten Sie auch mir unter kern at sibbald dot com bescheid geben.
-
-
-\section{Disclaimer}
-\index[general]{Haftungsausschluss }
-
-NO WARRANTY
-
-BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE
-PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE
-STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE
-PROGRAM \"AS IS\" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED,
-INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
-FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND
-PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE,
-YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
-
-IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY
-COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE
-PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
-GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE
-OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR
-DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR
-A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH
-HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
+++ /dev/null
-
-\chapter{Migration}
-\label{MigrationChapter}
-\index[general]{Migration}
-
-The term Migration, as used in the context of Bacula, means moving data from
-one Volume to another. In particular it refers to a Job (similar to a backup
-job) that reads data that was previously backed up to a Volume and writes
-it to another Volume. As part of this process, the File catalog records
-associated with the first backup job are purged. In other words, Migration
-moves Bacula Job data from one Volume to another by reading the Job data
-from the Volume it is stored on, writing it to a different Volume in a
-different Pool, and then purging the database records for the first Job.
-
-The section process for which Job or Jobs are migrated
-can be based on quite a number of different criteria such as:
-\begin{itemize}
-\item a single previous Job
-\item a Volume
-\item a Client
-\item a regular expression matching a Job, Volume, or Client name
-\item the time a Job has been on a Volume
-\item high and low water marks (usage or occupation) of a Pool
-\item Volume size
-\end{itemize}
-
-The details of these selection criteria will be defined below.
-
-To run a Migration job, you must first define a Job resource very similar
-to a Backup Job but with {\bf Type = Migrate} instead of {\bf Type =
-Backup}. One of the key points to remember is that the Pool that is
-specified for the migration job is the only pool from which jobs will
-be migrated, with one exception noted below. In addition, the Pool to
-which the selected Job or Jobs will be migrated is defined by the {\bf
-Next Pool = ...} in the Pool resource specified for the Migration Job.
-
-Bacula permits pools to contain Volumes with different Media Types.
-However, when doing migration, this is a very undesirable condition. For
-migration to work properly, you should use pools containing only Volumes of
-the same Media Type for all migration jobs.
-
-The migration job normally is either manually started or starts
-from a Schedule much like a backup job. It searches
-for a previous backup Job or Jobs that match the parameters you have
-specified in the migration Job resource, primarily a {\bf Selection Type}
-(detailed a bit later). Then for
-each previous backup JobId found, the Migration Job will run a new Job which
-copies the old Job data from the previous Volume to a new Volume in
-the Migration Pool. It is possible that no prior Jobs are found for
-migration, in which case, the Migration job will simply terminate having
-done nothing, but normally at a minimum, three jobs are involved during a
-migration:
-
-\begin{itemize}
-\item The currently running Migration control Job. This is only
- a control job for starting the migration child jobs.
-\item The previous Backup Job (already run). The File records
- for this Job are purged if the Migration job successfully
- terminates. The original data remains on the Volume until
- it is recycled and rewritten.
-\item A new Migration Backup Job that moves the data from the
- previous Backup job to the new Volume. If you subsequently
- do a restore, the data will be read from this Job.
-\end{itemize}
-
-If the Migration control job finds a number of JobIds to migrate (e.g.
-it is asked to migrate one or more Volumes), it will start one new
-migration backup job for each JobId found on the specified Volumes.
-Please note that Migration doesn't scale too well since Migrations are
-done on a Job by Job basis. This if you select a very large volume or
-a number of volumes for migration, you may have a large number of
-Jobs that start. Because each job must read the same Volume, they will
-run consecutively (not simultaneously).
-
-\section{Migration Job Resource Directives}
-
-The following directives can appear in a Director's Job resource, and they
-are used to define a Migration job.
-
-\begin{description}
-\item [Pool = \lt{}Pool-name\gt{}] The Pool specified in the Migration
- control Job is not a new directive for the Job resource, but it is
- particularly important because it determines what Pool will be examined for
- finding JobIds to migrate. The exception to this is when {\bf Selection
- Type = SQLQuery}, in which case no Pool is used, unless you
- specifically include it in the SQL query. Note, the Pool resource
- referenced must contain a {\bf Next Pool = ...} directive to define
- the Pool to which the data will be migrated.
-
-\item [Type = Migrate]
- {\bf Migrate} is a new type that defines the job that is run as being a
- Migration Job. A Migration Job is a sort of control job and does not have
- any Files associated with it, and in that sense they are more or less like
- an Admin job. Migration jobs simply check to see if there is anything to
- Migrate then possibly start and control new Backup jobs to migrate the data
- from the specified Pool to another Pool.
-
-\item [Selection Type = \lt{}Selection-type-keyword\gt{}]
- The \lt{}Selection-type-keyword\gt{} determines how the migration job
- will go about selecting what JobIds to migrate. In most cases, it is
- used in conjunction with a {\bf Selection Pattern} to give you fine
- control over exactly what JobIds are selected. The possible values
- for \lt{}Selection-type-keyword\gt{} are:
- \begin{description}
- \item [SmallestVolume] This selection keyword selects the volume with the
- fewest bytes from the Pool to be migrated. The Pool to be migrated
- is the Pool defined in the Migration Job resource. The migration
- control job will then start and run one migration backup job for
- each of the Jobs found on this Volume. The Selection Pattern, if
- specified, is not used.
-
- \item [OldestVolume] This selection keyword selects the volume with the
- oldest last write time in the Pool to be migrated. The Pool to be
- migrated is the Pool defined in the Migration Job resource. The
- migration control job will then start and run one migration backup
- job for each of the Jobs found on this Volume. The Selection
- Pattern, if specified, is not used.
-
- \item [Client] The Client selection type, first selects all the Clients
- that have been backed up in the Pool specified by the Migration
- Job resource, then it applies the {\bf Selection Pattern} (defined
- below) as a regular expression to the list of Client names, giving
- a filtered Client name list. All jobs that were backed up for those
- filtered (regexed) Clients will be migrated.
- The migration control job will then start and run one migration
- backup job for each of the JobIds found for those filtered Clients.
-
- \item [Volume] The Volume selection type, first selects all the Volumes
- that have been backed up in the Pool specified by the Migration
- Job resource, then it applies the {\bf Selection Pattern} (defined
- below) as a regular expression to the list of Volume names, giving
- a filtered Volume list. All JobIds that were backed up for those
- filtered (regexed) Volumes will be migrated.
- The migration control job will then start and run one migration
- backup job for each of the JobIds found on those filtered Volumes.
-
- \item [Job] The Job selection type, first selects all the Jobs (as
- defined on the {\bf Name} directive in a Job resource)
- that have been backed up in the Pool specified by the Migration
- Job resource, then it applies the {\bf Selection Pattern} (defined
- below) as a regular expression to the list of Job names, giving
- a filtered Job name list. All JobIds that were run for those
- filtered (regexed) Job names will be migrated. Note, for a given
- Job named, they can be many jobs (JobIds) that ran.
- The migration control job will then start and run one migration
- backup job for each of the Jobs found.
-
- \item [SQLQuery] The SQLQuery selection type, used the {\bf Selection
- Pattern} as an SQL query to obtain the JobIds to be migrated.
- The Selection Pattern must be a valid SELECT SQL statement for your
- SQL engine, and it must return the JobId as the first field
- of the SELECT.
-
- \item [PoolOccupancy] This selection type will cause the Migration job
- to compute the total size of the specified pool for all Media Types
- combined. If it exceeds the {\bf Migration High Bytes} defined in
- the Pool, the Migration job will migrate all JobIds beginning with
- the oldest Volume in the pool (determined by Last Write time) until
- the Pool bytes drop below the {\bf Migration Low Bytes} defined in the
- Pool. This calculation should be consider rather approximative because
- it is made once by the Migration job before migration is begun, and
- thus does not take into account additional data written into the Pool
- during the migration. In addition, the calculation of the total Pool
- byte size is based on the Volume bytes saved in the Volume (Media)
-database
- entries. The bytes calculate for Migration is based on the value stored
- in the Job records of the Jobs to be migrated. These do not include the
- Storage daemon overhead as is in the total Pool size. As a consequence,
- normally, the migration will migrate more bytes than strictly necessary.
-
- \item [PoolTime] The PoolTime selection type will cause the Migration job to
- look at the time each JobId has been in the Pool since the job ended.
- All Jobs in the Pool longer than the time specified on {\bf Migration Time}
- directive in the Pool resource will be migrated.
- \end{description}
-
-\item [Selection Pattern = \lt{}Quoted-string\gt{}]
- The Selection Patterns permitted for each Selection-type-keyword are
- described above.
-
- For the OldestVolume and SmallestVolume, this
- Selection pattern is not used (ignored).
-
- For the Client, Volume, and Job
- keywords, this pattern must be a valid regular expression that will filter
- the appropriate item names found in the Pool.
-
- For the SQLQuery keyword, this pattern must be a valid SELECT SQL statement
- that returns JobIds.
-
-\end{description}
-
-\section{Migration Pool Resource Directives}
-
-The following directives can appear in a Director's Pool resource, and they
-are used to define a Migration job.
-
-\begin{description}
-\item [Migration Time = \lt{}time-specification\gt{}]
- If a PoolTime migration is done, the time specified here in seconds (time
- modifiers are permitted -- e.g. hours, ...) will be used. If the
- previous Backup Job or Jobs selected have been in the Pool longer than
- the specified PoolTime, then they will be migrated.
-
-\item [Migration High Bytes = \lt{}byte-specification\gt{}]
- This directive specifies the number of bytes in the Pool which will
- trigger a migration if a {\bf PoolOccupancy} migration selection
- type has been specified. The fact that the Pool
- usage goes above this level does not automatically trigger a migration
- job. However, if a migration job runs and has the PoolOccupancy selection
- type set, the Migration High Bytes will be applied. Bacula does not
- currently restrict a pool to have only a single Media Type, so you
- must keep in mind that if you mix Media Types in a Pool, the results
- may not be what you want, as the Pool count of all bytes will be
- for all Media Types combined.
-
-\item [Migration Low Bytes = \lt{}byte-specification\gt{}]
- This directive specifies the number of bytes in the Pool which will
- stop a migration if a {\bf PoolOccupancy} migration selection
- type has been specified and triggered by more than Migration High
- Bytes being in the pool. In other words, once a migration job
- is started with {\bf PoolOccupancy} migration selection and it
- determines that there are more than Migration High Bytes, the
- migration job will continue to run jobs until the number of
- bytes in the Pool drop to or below Migration Low Bytes.
-
-\item [Next Pool = \lt{}pool-specification\gt{}]
- The Next Pool directive specifies the pool to which Jobs will be
- migrated. This directive is required to define the Pool into which
- the data will be migrated. Without this directive, the migration job
- will terminate in error.
-
-\item [Storage = \lt{}storage-specification\gt{}]
- The Storage directive specifies what Storage resource will be used
- for all Jobs that use this Pool. It takes precedence over any other
- Storage specifications that may have been given such as in the
- Schedule Run directive, or in the Job resource. We highly recommend
- that you define the Storage resource to be used in the Pool rather
- than elsewhere (job, schedule run, ...).
-\end{description}
-
-\section{Important Migration Considerations}
-\index[general]{Important Migration Considerations}
-\begin{itemize}
-\item Each Pool into which you migrate Jobs or Volumes {\bf must}
- contain Volumes of only one Media Type.
-
-\item Migration takes place on a JobId by JobId basis. That is
- each JobId is migrated in its entirety and independently
- of other JobIds. Once the Job is migrated, it will be
- on the new medium in the new Pool, but for the most part,
- aside from having a new JobId, it will appear with all the
- same characteristics of the original job (start, end time, ...).
- The column RealEndTime in the catalog Job table will contain the
- time and date that the Migration terminated, and by comparing
- it with the EndTime column you can tell whether or not the
- job was migrated. The original job is purged of its File
- records, and its Type field is changed from "B" to "M" to
- indicate that the job was migrated.
-
-\item Jobs on Volumes will be Migration only if the Volume is
- marked, Full, Used, or Error. Volumes that are still
- marked Append will not be considered for migration. This
- prevents Bacula from attempting to read the Volume at
- the same time it is writing it. It also reduces other deadlock
- situations, as well as avoids the problem that you migrate a
- Volume and later find new files appended to that Volume.
-
-\item As noted above, for the Migration High Bytes, the calculation
- of the bytes to migrate is somewhat approximate.
-
-\item If you keep Volumes of different Media Types in the same Pool,
- it is not clear how well migration will work. We recommend only
- one Media Type per pool.
-
-\item It is possible to get into a resource deadlock where Bacula does
- not find enough drives to simultaneously read and write all the
- Volumes needed to do Migrations. For the moment, you must take
- care as all the resource deadlock algorithms are not yet implemented.
-
-\item Migration is done only when you run a Migration job. If you set a
- Migration High Bytes and that number of bytes is exceeded in the Pool
- no migration job will automatically start. You must schedule the
- migration jobs, and they must run for any migration to take place.
-
-\item If you migrate a number of Volumes, a very large number of Migration
- jobs may start.
-
-\item Figuring out what jobs will actually be migrated can be a bit complicated
- due to the flexibility provided by the regex patterns and the number of
- different options. Turning on a debug level of 100 or more will provide
- a limited amount of debug information about the migration selection
- process.
-
-\item Bacula currently does only minimal Storage conflict resolution, so you
- must take care to ensure that you don't try to read and write to the
- same device or Bacula may block waiting to reserve a drive that it
- will never find. In general, ensure that all your migration
- pools contain only one Media Type, and that you always
- migrate to pools with different Media Types.
-
-\item The {\bf Next Pool = ...} directive must be defined in the Pool
- referenced in the Migration Job to define the Pool into which the
- data will be migrated.
-
-\item Pay particular attention to the fact that data is migrated on a Job
- by Job basis, and for any particular Volume, only one Job can read
- that Volume at a time (no simultaneous read), so migration jobs that
- all reference the same Volume will run sequentially. This can be a
- potential bottle neck and does not scale very well to large numbers
- of jobs.
-
-\item Only migration of Selection Types of Job and Volume have
- been carefully tested. All the other migration methods (time,
- occupancy, smallest, oldest, ...) need additional testing.
-
-\item Migration is only implemented for a single Storage daemon. You
- cannot read on one Storage daemon and write on another.
-\end{itemize}
-
-
-\section{Example Migration Jobs}
-\index[general]{Example Migration Jobs}
-
-When you specify a Migration Job, you must specify all the standard
-directives as for a Job. However, certain such as the Level, Client, and
-FileSet, though they must be defined, are ignored by the Migration job
-because the values from the original job used instead.
-
-As an example, suppose you have the following Job that
-you run every night. To note: there is no Storage directive in the
-Job resource; there is a Storage directive in each of the Pool
-resources; the Pool to be migrated (File) contains a Next Pool
-directive that defines the output Pool (where the data is written
-by the migration job).
-
-\footnotesize
-\begin{verbatim}
-# Define the backup Job
-Job {
- Name = "NightlySave"
- Type = Backup
- Level = Incremental # default
- Client=rufus-fd
- FileSet="Full Set"
- Schedule = "WeeklyCycle"
- Messages = Standard
- Pool = Default
-}
-
-# Default pool definition
-Pool {
- Name = Default
- Pool Type = Backup
- AutoPrune = yes
- Recycle = yes
- Next Pool = Tape
- Storage = File
- LabelFormat = "File"
-}
-
-# Tape pool definition
-Pool {
- Name = Tape
- Pool Type = Backup
- AutoPrune = yes
- Recycle = yes
- Storage = DLTDrive
-}
-
-# Definition of File storage device
-Storage {
- Name = File
- Address = rufus
- Password = "ccV3lVTsQRsdIUGyab0N4sMDavui2hOBkmpBU0aQKOr9"
- Device = "File" # same as Device in Storage daemon
- Media Type = File # same as MediaType in Storage daemon
-}
-
-# Definition of DLT tape storage device
-Storage {
- Name = DLTDrive
- Address = rufus
- Password = "ccV3lVTsQRsdIUGyab0N4sMDavui2hOBkmpBU0aQKOr9"
- Device = "HP DLT 80" # same as Device in Storage daemon
- Media Type = DLT8000 # same as MediaType in Storage daemon
-}
-
-\end{verbatim}
-\normalsize
-
-Where we have included only the essential information -- i.e. the
-Director, FileSet, Catalog, Client, Schedule, and Messages resources are
-omitted.
-
-As you can see, by running the NightlySave Job, the data will be backed up
-to File storage using the Default pool to specify the Storage as File.
-
-Now, if we add the following Job resource to this conf file.
-
-\footnotesize
-\begin{verbatim}
-Job {
- Name = "migrate-volume"
- Type = Migrate
- Level = Full
- Client = rufus-fd
- FileSet = "Full Set"
- Messages = Standard
- Pool = Default
- Maximum Concurrent Jobs = 4
- Selection Type = Volume
- Selection Pattern = "File"
-}
-\end{verbatim}
-\normalsize
-
-and then run the job named {\bf migrate-volume}, all volumes in the Pool
-named Default (as specified in the migrate-volume Job that match the
-regular expression pattern {\bf File} will be migrated to tape storage
-DLTDrive because the {\bf Next Pool} in the Default Pool specifies that
-Migrations should go to the pool named {\bf Tape}, which uses
-Storage {\bf DLTDrive}.
-
-If instead, we use a Job resource as follows:
-
-\footnotesize
-\begin{verbatim}
-Job {
- Name = "migrate"
- Type = Migrate
- Level = Full
- Client = rufus-fd
- FileSet="Full Set"
- Messages = Standard
- Pool = Default
- Maximum Concurrent Jobs = 4
- Selection Type = Job
- Selection Pattern = ".*Save"
-}
-\end{verbatim}
-\normalsize
-
-All jobs ending with the name Save will be migrated from the File Default to
-the Tape Pool, or from File storage to Tape storage.
+++ /dev/null
-#!/bin/sh
-#
-# Bacula interface to mtx autoloader
-#
-# Created OCT/31/03 by Alexander Kuehn, derived from Ludwig Jaffe's script
-#
-# Works with the HP C1537A L708 DDS3
-#
-#set -x
-# these are the labels of the tapes in each virtual slot, not the slots!
-labels="PSE-0001 PSE-0002 PSE-0003 PSE-0004 PSE-0005 PSE-0006 PSE-0007 PSE-0008 PSE-0009 PSE-0010 PSE-0011 PSE-0012"
-
-# who to send a mail to?
-recipient=root@localhost
-logfile=/var/log/mtx.log
-
-# Delay in seconds how often to check whether a new tape has been inserted
-TAPEDELAY=10 # the default is every 10 seconds
-echo `date` ":" $@ >>$logfile
-
-# change this if mt is not in the path (use different quotes!)
-mt=`which mt`
-grep=`which grep`
-#
-# how to run the console application?
-console="/usr/local/sbin/console -c /usr/local/etc/console.conf"
-
-command="$1"
-
-#TAPEDRIVE0 holds the device/name of your 1st and only drive (Bacula supports only 1 drive currently)
-#Read TAPEDRIVE from command line parameters
-if [ -z "$2" ] ; then
- TAPEDRIVE0=/dev/nsa0
-else
- TAPEDRIVE0=$2
-fi
-
-#Read slot from command line parameters
-if [ -z "$3" ] ; then
- slot=`expr 1`
-else
- slot=`expr $3`
-fi
-
-if [ -z "$command" ] ; then
- echo ""
- echo "The mtx-changer script for Bacula"
- echo "---------------------------------"
- echo ""
- echo "usage: mtx-changer <command> <devicename of tapedrive> [slot]"
- echo " mtx-changer"
- echo ""
- echo "Valid commands:"
- echo ""
- echo "unload Unloads a tape into the slot"
- echo " from where it was loaded."
- echo "load <slot> Loads a tape from the slot <slot>"
- echo "list Lists full storage slots"
- echo "loaded Gives slot from where the tape was loaded."
- echo " 0 means the tape drive is empty."
- echo "slots Gives Number of avialable slots."
- echo "volumes List avialable slots and the label of the."
- echo " tape in it (slot:volume)"
- echo "Example:"
- echo " mtx-changer load /dev/nst0 1 loads a tape from slot1"
- echo " mtx-changer %a %o %S "
- echo ""
- exit 0
-fi
-
-
-case "$command" in
- unload)
- # At first do mt -f /dev/st0 offline to unload the tape
- #
- # Check if you want to fool me
- echo "unmount"|$console >/dev/null 2>/dev/null
- echo "mtx-changer: Checking if drive is loaded before we unload. Request unload" >>$logfile
- if $mt -f $TAPEDRIVE0 status >/dev/null 2>/dev/null ; then # mt says status ok
- echo "mtx-changer: Doing mt -f $TAPEDRIVE0 rewoffl to rewind and unload the tape!" >>$logfile
- $mt -f $TAPEDRIVE0 rewoffl
- else
- echo "mtx-changer: *** Don't fool me! *** The Drive $TAPEDRIVE0 is empty." >>$logfile
- fi
- exit 0
- ;;
-
- load)
- #Let's check if drive is loaded before we load it
- echo "mtx-changer: Checking if drive is loaded before we load. I Request loaded" >>$logfile
- LOADEDVOL=`echo "status Storage"|$console|$grep $TAPEDRIVE0|grep ^Device|grep -v "not open."|grep -v "ERR="|grep -v "no Bacula volume is mounted"|sed -e s/^.*Volume\ //|cut -d\" -f2`
-# if [ -z "$LOADEDVOL" ] ; then # this is wrong, becaus Bacula would try to use the tape if we mount it!
-# LOADEDVOL=`echo "mount"|$console|$grep $TAPEDRIVE0|grep Device|grep -v "not open."|grep -v "ERR="|sed -e s/^.*Volume\ //|cut -d\" -f2`
-# if [ -z "$LOADEDVOL" ] ; then
-# echo "mtx-changer: The Drive $TAPEDRIVE0 is empty." >>$logfile
-# else # restore state?
-# if [ $LOADEDVOL = $3 ] ; then # requested Volume mounted -> exit
-# echo "mtx-changer: *** Don't fool me! *** Tape $LOADEDVOL is already in drive $TAPEDRIVE0!" >>$logfile
-# exit
-# else # oops, wrong volume
-# echo "unmount"|$console >/dev/null 2>/dev/null
-# fi
-# fi
-# fi
- if [ -z "$LOADEDVOL" ] ; then
- echo "unmount"|$console >/dev/null 2>/dev/null
- LOADEDVOL=0
- else
- #Check if you want to fool me
- if [ $LOADEDVOL = $3 ] ; then
- echo "mtx-changer: *** Don't fool me! *** Tape $LOADEDVOL is already in drive $TAPEDRIVE0!" >>$logfile
- exit
- fi
- echo "mtx-changer: The Drive $TAPEDRIVE0 is loaded with the tape $LOADEDVOL" >>$logfile
- echo "mtx-changer: Unmounting..." >>$logfile
- echo "unmount"|$console >/dev/null 2>/dev/null
- fi
- echo "mtx-changer: Unloading..." >>$logfile
- echo "mtx-changer: Doing mt -f $TAPEDRIVE0 rewoffl to rewind and unload the tape!" >>$logfile
- mt -f $TAPEDRIVE0 rewoffl 2>/dev/null
- #Now we can load the drive as desired
- echo "mtx-changer: Doing mtx -f $1 $2 $3" >>$logfile
- # extract label for the mail
- count=`expr 1`
- for label in $labels ; do
- if [ $slot -eq $count ] ; then volume=$label ; fi
- count=`expr $count + 1`
- done
-
- mail -s "Bacula needs volume $volume." $recipient <<END_OF_DATA
-Please insert volume $volume from slot $slot into $TAPEDRIVE0 .
-Kind regards,
-Bacula.
-END_OF_DATA
- sleep 15
- $mt status >/dev/null 2>/dev/null
- while [ $? -ne 0 ] ; do
- sleep $TAPEDELAY
- $mt status >/dev/null 2>/dev/null
- done
- mail -s "Bacula says thank you." $recipient <<END_OF_DATA
-Thank you for inserting the new tape! (I requested volume $volume from slot $slot.)
-Kind regards,
-Bacula.
-END_OF_DATA
- echo "Successfully loaded a tape into drive $TAPEDRIVE0 (requested $volume from slot $slot)." >>$logfile
- echo "Loading finished." ; >>$logfile
- echo "$slot"
- exit 0
- ;;
-
- list)
- echo "mtx-changer: Requested list" >>$logfile
- LOADEDVOL=`echo "status Storage"|$console|$grep $TAPEDRIVE0|grep ^Device|grep -v "not open."|grep -v "ERR="|grep -v "no Bacula volume is mounted"|sed -e s/^.*Volume\ //|cut -d\" -f2`
- if [ -z $LOADEDVOL ] ; then # try mounting
- LOADEDVOL=`echo "mount"|$console|$grep $TAPEDRIVE0|grep Device|grep -v "not open."|grep -v "ERR="|sed -e s/^.*Volume\ //|cut -d\" -f2`
- if [ -z $LOADEDVOL ] ; then # no luck
- LOADEDVOL="_no_tape"
- else # restore state
- echo "unmount"|$console >/dev/null 2>/dev/null
- fi
- fi
- count=`expr 1`
- for label in $labels ; do
- if [ "$label" != "$LOADEDVOL" ] ; then
- printf "$count "
- fi
- count=`expr $count + 1`
- done
- printf "\n"
- ;;
-
- loaded)
- echo "mtx-changer: Request loaded, dev $TAPEDRIVE0" >>$logfile
- LOADEDVOL=`echo "status Storage"|$console|$grep $TAPEDRIVE0|grep ^Device|grep -v "not open."|grep -v "ERR="|grep -v "no Bacula volume is mounted"|sed -e s/^.*Volume\ //|cut -d\" -f2`
- if [ -z $LOADEDVOL ] ; then
- LOADEDVOL=`echo "mount"|$console|$grep $TAPEDRIVE0|grep Device|grep -v "not open."|grep -v "ERR="|grep -v "no Bacula volume is mounted"|sed -e s/^.*Volume\ //|cut -d\" -f2`
- if [ -z "$LOADEDVOL" ] ; then # no luck
- echo "$TAPEDRIVE0 not mounted!" >>$logfile
- else # restore state
- echo "unmount"|$console >/dev/null 2>/dev/null
- fi
- fi
- if [ -z "$LOADEDVOL" ] ; then
- LOADEDVOL="_no_tape" >>$logfile
- echo "0"
- else
- count=`expr 1`
- for label in $labels ; do
- if [ $LOADEDVOL = $label ] ; then echo $count ; fi
- count=`expr $count + 1`
- done
- fi
- exit 0
- ;;
-
- slots)
- echo "mtx-changer: Request slots" >>$logfile
- count=`expr 0`
- for label in $labels ; do
- count=`expr $count + 1`
- done
- echo $count
- ;;
-
- volumes)
- echo "mtx-changer: Request volumes" >>$logfile
- count=`expr 1`
- for label in $labels ; do
- printf "$count:$label "
- count=`expr $count + 1`
- done
- printf "\n"
- ;;
-esac
+++ /dev/null
-%%
-
-%%
-
-\chapter{New Features in 3.1.4 (Development Version}
-\label{NewFeaturesChapter}
-
-This chapter presents the new features that are currently under development
-in the 3.1.x versions to be released as Bacula version 3.2.0 sometime in
-late 2009 or early 2010.
-
-
-\section{Maximum concurent jobs for Devices}
-\label{sec:maximumconcurentjobdevice}
-
-{\bf Maximum Concurrent Jobs} is a new Device directive in the Storage
-Daemon configuration permits setting the maximum number of Jobs that can
-run concurrently on a specified Device. Using this directive, it is
-possible to have different Jobs using multiple drives, because when the
-Maximum Concurrent Jobs limit is reached, the Storage Daemon will start new
-Jobs on any other available compatible drive. This facilitates writing to
-multiple drives with multiple Jobs that all use the same Pool.
-
-\section{Restore from Multiple Storage Daemons}
-\index[general]{Restore}
-
-Previously, you were able to restore from multiple devices in a single Storage
-Daemon. Now, Bacula is able to restore from multiple Storage Daemons. For
-example, if your full backup runs on a Storage Daemon with an autochanger, and
-your incremental jobs use another Storage Daemon with lots of disks, Bacula
-will switch automatically from one Storage Daemon to an other within the same
-Restore job.
-
-You must upgrade your File Daemon to version 3.0.3 to use this feature.
-
-This project was funded by Bacula Systems with the help of Equiinet.
-
-\section{File Deduplication using Base Jobs}
-A base job is sort of like a Full save except that you will want the FileSet to
-contain only files that are unlikely to change in the future (i.e. a snapshot
-of most of your system after installing it). After the base job has been run,
-when you are doing a Full save, you specify one or more Base jobs to be used.
-All files that have been backed up in the Base job/jobs but not modified will
-then be excluded from the backup. During a restore, the Base jobs will be
-automatically pulled in where necessary.
-
-This is something none of the competition does, as far as we know (except
-perhaps BackupPC, which is a Perl program that saves to disk only). It is big
-win for the user, it makes Bacula stand out as offering a unique optimization
-that immediately saves time and money. Basically, imagine that you have 100
-nearly identical Windows or Linux machine containing the OS and user files.
-Now for the OS part, a Base job will be backed up once, and rather than making
-100 copies of the OS, there will be only one. If one or more of the systems
-have some files updated, no problem, they will be automatically restored.
-
-A new Job directive \texttt{Base=Jobx, Joby...} permits to specify the list of
-files that will be used during Full backup as base.
-
-\begin{verbatim}
-Job {
- Name = BackupLinux
- Level= Base
- ...
-}
-
-Job {
- Name = BackupZog4
- Base = BackupZog4, BackupLinux
- Accurate = yes
- ...
-}
-\end{verbatim}
-
-In this example, the job \texttt{BackupZog4} will use the most recent version
-of all files contained in \texttt{BackupZog4} and \texttt{BackupLinux}
-jobs. Base jobs should have run with \texttt{level=Base} to be used.
-
-By default, Bacula will compare permissions bits, user and group fields,
-modification time, size and the checksum of the file to choose between the
-current backup and the BaseJob file list. You can change this behavior with the
-\texttt{BaseJob} FileSet option. This option works like the \texttt{verify=}
-one, that is described in the \ilink{FileSet}{FileSetResource} chapter.
-
-\begin{verbatim}
-FileSet {
- Name = Full
- Include = {
- Options {
- BaseJob = pmugcs5
- Accurate = mcs5
- Verify = pin5
- }
- File = /
- }
-}
-\end{verbatim}
-
-
-This project was funded by Bacula Systems.
-
-
-\section{Accurate Fileset options}
-\label{sec:accuratefileset}
-
-In previous version, the accurate code was using file time creation and
-modification to determine if a file was modified or not. Now you can specify
-witch attribute to use (time, size, checksum, permission, owner, group,
-\dots).
-
-\begin{verbatim}
-FileSet {
- Name = Full
- Include = {
- Options {
- Accurate = mcs5
- Verify = pin5
- }
- File = /
- }
-}
-\end{verbatim}
-
-\begin{description}
-\item {\bf i}
- compare the inodes
-
-\item {\bf p}
- compare the permission bits
-
-\item {\bf n}
- compare the number of links
-
-\item {\bf u}
- compare the user id
-
-\item {\bf g}
- compare the group id
-
-\item {\bf s}
- compare the size
-
-\item {\bf a}
- compare the access time
-
-\item {\bf m}
- compare the modification time (st\_mtime)
-
-\item {\bf c}
- compare the change time (st\_ctime)
-
-\item {\bf d}
- report file size decreases
-
-\item {\bf 5}
- compare the MD5 signature
-
-\item {\bf 1}
- compare the SHA1 signature
-\end{description}
-
-\textbf{Important note:} If you decide to use checksum in Accurate jobs, the
-File Daemon will have to read all files even if they won't be saved. It
-increases the I/O load, but also the security. By default, Bacula will
-check modification/creation time and size.
-
-\section{Bvfs API}
-\label{sec:bvfs}
-
-To help developers in restore GUI interfaces, we have added new \textsl{dot
- commands} that permit to browse the catalog in a very simple way.
-
-\begin{itemize}
-\item \texttt{.update [jobid=x,y,z]} This command is required to update the
- Bvfs cache in the catalog. You need to run it before any access to the Bvfs
- layer.
-\item \texttt{.lsdirs jobid=x,y,z path=/path | pathid=101} This command will
- list all directories in the specified \texttt{path} or \texttt{pathid}. Using
- \texttt{pathid} avoids problems with caracters encoding.
-\item \texttt{.lsfiles jobid=x,y,z path=/path | pathid=101} This command will
- list all files in the specified \texttt{path} or \texttt{pathid}. Using
- \texttt{pathid} avoids problems with caracters encoding.
-\end{itemize}
-
-You can use \texttt{limit=xxx} and \texttt{offset=yyy} to limit the amount of
-data that will be displayed.
-
-\begin{verbatim}
-* .update jobid=1,2
-* .update
-* .lsdir path=/ jobid=1,2
-\end{verbatim}
-
-\section{Testing your tape drive}
-\label{sec:btapespeed}
-
-To determine the best configuration of your tape drive, you can run the new
-\texttt{speed} command available in \texttt{btape}.
-
-This command can have the following arguments:
-\begin{itemize}
-\item[\texttt{file\_size=n}] Specify the Maximum File Size for this test
- (between 1 and 5GB). This counter is in GB.
-\item[\texttt{nb\_file=n}] Specify the number of file to be written. The amount
- of data should be greater than your memory ($file\_size*nb\_file$).
-\item[\texttt{skip\_zero}] This flag permits to skip tests with constant
- data.
-\item[\texttt{skip\_random}] This flag permits to skip tests with random
- data.
-\item[\texttt{skip\_raw}] This flag permits to skip tests with raw access.
-\item[\texttt{skip\_block}] This flag permits to skip tests with Bacula block
- access.
-\end{itemize}
-
-\begin{verbatim}
-*speed file_size=3 skip_raw
-btape.c:1078 Test with zero data and bacula block structure.
-btape.c:956 Begin writing 3 files of 3.221 GB with blocks of 129024 bytes.
-++++++++++++++++++++++++++++++++++++++++++
-btape.c:604 Wrote 1 EOF to "Drive-0" (/dev/nst0)
-btape.c:406 Volume bytes=3.221 GB. Write rate = 44.128 MB/s
-...
-btape.c:383 Total Volume bytes=9.664 GB. Total Write rate = 43.531 MB/s
-
-btape.c:1090 Test with random data, should give the minimum throughput.
-btape.c:956 Begin writing 3 files of 3.221 GB with blocks of 129024 bytes.
-+++++++++++++++++++++++++++++++++++++++++++
-btape.c:604 Wrote 1 EOF to "Drive-0" (/dev/nst0)
-btape.c:406 Volume bytes=3.221 GB. Write rate = 7.271 MB/s
-+++++++++++++++++++++++++++++++++++++++++++
-...
-btape.c:383 Total Volume bytes=9.664 GB. Total Write rate = 7.365 MB/s
-
-\end{verbatim}
-
-When using compression, the random test will give your the minimum throughput
-of your drive . The test using constant string will give you the maximum speed
-of your hardware chain. (cpu, memory, scsi card, cable, drive, tape).
-
-You can change the block size in the Storage Daemon configuration file.
-
-\section{New {\bf Block Checksum} Device directive}
-You may now turn off the Block Checksum (CRC32) code
-that Bacula uses when writing blocks to a Volume. This is
-done by adding:
-
-\begin{verbatim}
-Block Checksum = no
-\end{verbatim}
-
-doing so can reduce the Storage daemon CPU speed slightly. It
-will also permit Bacula to read a Volume that has corrupted data.
-
-The default is {\bf yes} -- i.e. the checksum is computed on write
-and checked on read.
-
-We do not recommend to turn this off particularly on older tape
-drives or for disk Volumes where doing so may allow corrupted data
-to be undetected.
-
-\section{New Bat Features}
-
-\subsection{Media information view}
-
-By double-clicking on a volume (on the Media list, in the Autochanger content
-or in the Job information panel), you can access a detailed overview of your
-Volume. (cf \ref{fig:mediainfo}.)
-\begin{figure}[htbp]
- \centering
- \includegraphics[width=13cm]{\idir bat11.eps}
- \caption{Media information}
- \label{fig:mediainfo}
-\end{figure}
-
-\subsection{Job information view}
-
-By double-clicking on a Job record (on the Job run list or in the Media
-information panel), you can access a detailed overview of your Job. (cf
-\ref{fig:jobinfo}.)
-\begin{figure}[htbp]
- \centering
- \includegraphics[width=13cm]{\idir bat12.eps}
- \caption{Job information}
- \label{fig:jobinfo}
-\end{figure}
-
-\subsection{Autochanger content view}
-
-By double-clicking on a Storage record (on the Storage list panel), you can
-access a detailed overview of your Autochanger. (cf \ref{fig:jobinfo}.)
-\begin{figure}[htbp]
- \centering
- \includegraphics[width=13cm]{\idir bat13.eps}
- \caption{Autochanger content}
- \label{fig:achcontent}
-\end{figure}
-
-\chapter{New Features in Released Version 3.0.2}
-
-This chapter presents the new features added to the
-Released Bacula Version 3.0.2.
-
-\section{Full restore from a given JobId}
-\index[general]{Restore menu}
-
-This feature allows selecting a single JobId and having Bacula
-automatically select all the other jobs that comprise a full backup up to
-and including the selected JobId.
-
-Assume we start with the following jobs:
-\begin{verbatim}
-+-------+--------------+---------------------+-------+----------+------------+
-| jobid | client | starttime | level | jobfiles | jobbytes |
-+-------+--------------+---------------------+-------+----------+------------
-| 6 | localhost-fd | 2009-07-15 11:45:49 | I | 2 | 0 |
-| 5 | localhost-fd | 2009-07-15 11:45:45 | I | 15 | 44143 |
-| 3 | localhost-fd | 2009-07-15 11:45:38 | I | 1 | 10 |
-| 1 | localhost-fd | 2009-07-15 11:45:30 | F | 1527 | 44143073 |
-+-------+--------------+---------------------+-------+----------+------------+
-\end{verbatim}
-
-Below is an example of this new feature (which is number 12 in the
-menu).
-
-\begin{verbatim}
-* restore
-To select the JobIds, you have the following choices:
- 1: List last 20 Jobs run
- 2: List Jobs where a given File is saved
-...
- 12: Select full restore to a specified JobId
- 13: Cancel
-
-Select item: (1-13): 12
-Enter JobId to restore: 5
-You have selected the following JobIds: 1,3,5
-
-Building directory tree for JobId(s) 1,3,5 ... +++++++++++++++++++
-1,444 files inserted into the tree.
-\end{verbatim}
-
-This project was funded by Bacula Systems.
-
-\section{Source Address}
-\index[general]{Source Address}
-
-A feature has been added which allows the administrator to specify the address
-from which the Director and File daemons will establish connections. This
-may be used to simplify system configuration overhead when working in complex
-networks utilizing multi-homing and policy-routing.
-
-To accomplish this, two new configuration directives have been implemented:
-\begin{verbatim}
-FileDaemon {
- FDSourceAddress=10.0.1.20 # Always initiate connections from this address
-}
-
-Director {
- DirSourceAddress=10.0.1.10 # Always initiate connections from this address
-}
-\end{verbatim}
-
-Simply adding specific host routes on the OS
-would have an undesirable side-effect: any
-application trying to contact the destination host would be forced to use the
-more specific route possibly diverting management traffic onto a backup VLAN.
-Instead of adding host routes for each client connected to a multi-homed backup
-server (for example where there are management and backup VLANs), one can
-use the new directives to specify a specific source address at the application
-level.
-
-Additionally, this allows the simplification and abstraction of firewall rules
-when dealing with a Hot-Standby director or storage daemon configuration. The
-Hot-standby pair may share a CARP address, which connections must be sourced
-from, while system services listen and act from the unique interface addresses.
-
-This project was funded by Collaborative Fusion, Inc.
-
-\section{Show volume availability when doing restore}
-
-When doing a restore the selection dialog ends by displaying this
-screen:
-
-\begin{verbatim}
- The job will require the following
- Volume(s) Storage(s) SD Device(s)
- ===========================================================================
- *000741L3 LTO-4 LTO3
- *000866L3 LTO-4 LTO3
- *000765L3 LTO-4 LTO3
- *000764L3 LTO-4 LTO3
- *000756L3 LTO-4 LTO3
- *001759L3 LTO-4 LTO3
- *001763L3 LTO-4 LTO3
- 001762L3 LTO-4 LTO3
- 001767L3 LTO-4 LTO3
-
-Volumes marked with ``*'' are online (in the autochanger).
-\end{verbatim}
-
-This should help speed up large restores by minimizing the time spent
-waiting for the operator to discover that he must change tapes in the library.
-
-This project was funded by Bacula Systems.
-
-\section{Accurate estimate command}
-
-The \texttt{estimate} command can now use the accurate code to detect changes
-and give a better estimation.
-
-You can set the accurate behavior on the command line by using
-\texttt{accurate=yes\vb{}no} or use the Job setting as default value.
-
-\begin{verbatim}
-* estimate listing accurate=yes level=incremental job=BackupJob
-\end{verbatim}
-
-This project was funded by Bacula Systems.
-
-\chapter{New Features in 3.0.0}
-\label{NewFeaturesChapter}
-\index[general]{New Features}
-
-This chapter presents the new features added to the development 2.5.x
-versions to be released as Bacula version 3.0.0 sometime in April 2009.
-
-\section{Accurate Backup}
-\index[general]{Accurate Backup}
-
-As with most other backup programs, by default Bacula decides what files to
-backup for Incremental and Differental backup by comparing the change
-(st\_ctime) and modification (st\_mtime) times of the file to the time the last
-backup completed. If one of those two times is later than the last backup
-time, then the file will be backed up. This does not, however, permit tracking
-what files have been deleted and will miss any file with an old time that may
-have been restored to or moved onto the client filesystem.
-
-\subsection{Accurate = \lt{}yes\vb{}no\gt{}}
-If the {\bf Accurate = \lt{}yes\vb{}no\gt{}} directive is enabled (default no) in
-the Job resource, the job will be run as an Accurate Job. For a {\bf Full}
-backup, there is no difference, but for {\bf Differential} and {\bf
- Incremental} backups, the Director will send a list of all previous files
-backed up, and the File daemon will use that list to determine if any new files
-have been added or or moved and if any files have been deleted. This allows
-Bacula to make an accurate backup of your system to that point in time so that
-if you do a restore, it will restore your system exactly.
-
-One note of caution
-about using Accurate backup is that it requires more resources (CPU and memory)
-on both the Director and the Client machines to create the list of previous
-files backed up, to send that list to the File daemon, for the File daemon to
-keep the list (possibly very big) in memory, and for the File daemon to do
-comparisons between every file in the FileSet and the list. In particular,
-if your client has lots of files (more than a few million), you will need
-lots of memory on the client machine.
-
-Accurate must not be enabled when backing up with a plugin that is not
-specially designed to work with Accurate. If you enable it, your restores
-will probably not work correctly.
-
-This project was funded by Bacula Systems.
-
-
-
-\section{Copy Jobs}
-\index[general]{Copy Jobs}
-
-A new {\bf Copy} job type 'C' has been implemented. It is similar to the
-existing Migration feature with the exception that the Job that is copied is
-left unchanged. This essentially creates two identical copies of the same
-backup. However, the copy is treated as a copy rather than a backup job, and
-hence is not directly available for restore. The {\bf restore} command lists
-copy jobs and allows selection of copies by using \texttt{jobid=}
-option. If the keyword {\bf copies} is present on the command line, Bacula will
-display the list of all copies for selected jobs.
-
-\begin{verbatim}
-* restore copies
-[...]
-These JobIds have copies as follows:
-+-------+------------------------------------+-----------+------------------+
-| JobId | Job | CopyJobId | MediaType |
-+-------+------------------------------------+-----------+------------------+
-| 2 | CopyJobSave.2009-02-17_16.31.00.11 | 7 | DiskChangerMedia |
-+-------+------------------------------------+-----------+------------------+
-+-------+-------+----------+----------+---------------------+------------------+
-| JobId | Level | JobFiles | JobBytes | StartTime | VolumeName |
-+-------+-------+----------+----------+---------------------+------------------+
-| 19 | F | 6274 | 76565018 | 2009-02-17 16:30:45 | ChangerVolume002 |
-| 2 | I | 1 | 5 | 2009-02-17 16:30:51 | FileVolume001 |
-+-------+-------+----------+----------+---------------------+------------------+
-You have selected the following JobIds: 19,2
-
-Building directory tree for JobId(s) 19,2 ... ++++++++++++++++++++++++++++++++++++++++++++
-5,611 files inserted into the tree.
-...
-\end{verbatim}
-
-
-The Copy Job runs without using the File daemon by copying the data from the
-old backup Volume to a different Volume in a different Pool. See the Migration
-documentation for additional details. For copy Jobs there is a new selection
-directive named {\bf PoolUncopiedJobs} which selects all Jobs that were
-not already copied to another Pool.
-
-As with Migration, the Client, Volume, Job, or SQL query, are
-other possible ways of selecting the Jobs to be copied. Selection
-types like SmallestVolume, OldestVolume, PoolOccupancy and PoolTime also
-work, but are probably more suited for Migration Jobs.
-
-If Bacula finds a Copy of a job record that is purged (deleted) from the catalog,
-it will promote the Copy to a \textsl{real} backup job and will make it available for
-automatic restore. If more than one Copy is available, it will promote the copy
-with the smallest JobId.
-
-A nice solution which can be built with the new Copy feature is often
-called disk-to-disk-to-tape backup (DTDTT). A sample config could
-look something like the one below:
-
-\begin{verbatim}
-Pool {
- Name = FullBackupsVirtualPool
- Pool Type = Backup
- Purge Oldest Volume = Yes
- Storage = vtl
- NextPool = FullBackupsTapePool
-}
-
-Pool {
- Name = FullBackupsTapePool
- Pool Type = Backup
- Recycle = Yes
- AutoPrune = Yes
- Volume Retention = 365 days
- Storage = superloader
-}
-
-#
-# Fake fileset for copy jobs
-#
-Fileset {
- Name = None
- Include {
- Options {
- signature = MD5
- }
- }
-}
-
-#
-# Fake client for copy jobs
-#
-Client {
- Name = None
- Address = localhost
- Password = "NoNe"
- Catalog = MyCatalog
-}
-
-#
-# Default template for a CopyDiskToTape Job
-#
-JobDefs {
- Name = CopyDiskToTape
- Type = Copy
- Messages = StandardCopy
- Client = None
- FileSet = None
- Selection Type = PoolUncopiedJobs
- Maximum Concurrent Jobs = 10
- SpoolData = No
- Allow Duplicate Jobs = Yes
- Allow Higher Duplicates = No
- Cancel Queued Duplicates = No
- Cancel Running Duplicates = No
- Priority = 13
-}
-
-Schedule {
- Name = DaySchedule7:00
- Run = Level=Full daily at 7:00
-}
-
-Job {
- Name = CopyDiskToTapeFullBackups
- Enabled = Yes
- Schedule = DaySchedule7:00
- Pool = FullBackupsVirtualPool
- JobDefs = CopyDiskToTape
-}
-\end{verbatim}
-
-The example above had 2 pool which are copied using the PoolUncopiedJobs
-selection criteria. Normal Full backups go to the Virtual pool and are copied
-to the Tape pool the next morning.
-
-The command \texttt{list copies [jobid=x,y,z]} lists copies for a given
-\textbf{jobid}.
-
-\begin{verbatim}
-*list copies
-+-------+------------------------------------+-----------+------------------+
-| JobId | Job | CopyJobId | MediaType |
-+-------+------------------------------------+-----------+------------------+
-| 9 | CopyJobSave.2008-12-20_22.26.49.05 | 11 | DiskChangerMedia |
-+-------+------------------------------------+-----------+------------------+
-\end{verbatim}
-
-\section{ACL Updates}
-\index[general]{ACL Updates}
-The whole ACL code had been overhauled and in this version each platforms has
-different streams for each type of acl available on such an platform. As ACLs
-between platforms tend to be not that portable (most implement POSIX acls but
-some use an other draft or a completely different format) we currently only
-allow certain platform specific ACL streams to be decoded and restored on the
-same platform that they were created on. The old code allowed to restore ACL
-cross platform but the comments already mention that not being to wise. For
-backward compatability the new code will accept the two old ACL streams and
-handle those with the platform specific handler. But for all new backups it
-will save the ACLs using the new streams.
-
-Currently the following platforms support ACLs:
-
-\begin{itemize}
- \item {\bf AIX}
- \item {\bf Darwin/OSX}
- \item {\bf FreeBSD}
- \item {\bf HPUX}
- \item {\bf IRIX}
- \item {\bf Linux}
- \item {\bf Tru64}
- \item {\bf Solaris}
-\end{itemize}
-
-Currently we support the following ACL types (these ACL streams use a reserved
-part of the stream numbers):
-
-\begin{itemize}
-\item {\bf STREAM\_ACL\_AIX\_TEXT} 1000 AIX specific string representation from
- acl\_get
- \item {\bf STREAM\_ACL\_DARWIN\_ACCESS\_ACL} 1001 Darwin (OSX) specific acl\_t
- string representation from acl\_to\_text (POSIX acl)
- \item {\bf STREAM\_ACL\_FREEBSD\_DEFAULT\_ACL} 1002 FreeBSD specific acl\_t
- string representation from acl\_to\_text (POSIX acl) for default acls.
- \item {\bf STREAM\_ACL\_FREEBSD\_ACCESS\_ACL} 1003 FreeBSD specific acl\_t
- string representation from acl\_to\_text (POSIX acl) for access acls.
- \item {\bf STREAM\_ACL\_HPUX\_ACL\_ENTRY} 1004 HPUX specific acl\_entry
- string representation from acltostr (POSIX acl)
- \item {\bf STREAM\_ACL\_IRIX\_DEFAULT\_ACL} 1005 IRIX specific acl\_t string
- representation from acl\_to\_text (POSIX acl) for default acls.
- \item {\bf STREAM\_ACL\_IRIX\_ACCESS\_ACL} 1006 IRIX specific acl\_t string
- representation from acl\_to\_text (POSIX acl) for access acls.
- \item {\bf STREAM\_ACL\_LINUX\_DEFAULT\_ACL} 1007 Linux specific acl\_t
- string representation from acl\_to\_text (POSIX acl) for default acls.
- \item {\bf STREAM\_ACL\_LINUX\_ACCESS\_ACL} 1008 Linux specific acl\_t string
- representation from acl\_to\_text (POSIX acl) for access acls.
- \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_ACL} 1009 Tru64 specific acl\_t
- string representation from acl\_to\_text (POSIX acl) for default acls.
- \item {\bf STREAM\_ACL\_TRU64\_DEFAULT\_DIR\_ACL} 1010 Tru64 specific acl\_t
- string representation from acl\_to\_text (POSIX acl) for default acls.
- \item {\bf STREAM\_ACL\_TRU64\_ACCESS\_ACL} 1011 Tru64 specific acl\_t string
- representation from acl\_to\_text (POSIX acl) for access acls.
- \item {\bf STREAM\_ACL\_SOLARIS\_ACLENT} 1012 Solaris specific aclent\_t
- string representation from acltotext or acl\_totext (POSIX acl)
- \item {\bf STREAM\_ACL\_SOLARIS\_ACE} 1013 Solaris specific ace\_t string
- representation from from acl\_totext (NFSv4 or ZFS acl)
-\end{itemize}
-
-In future versions we might support conversion functions from one type of acl
-into an other for types that are either the same or easily convertable. For now
-the streams are seperate and restoring them on a platform that doesn't
-recognize them will give you a warning.
-
-\section{Extended Attributes}
-\index[general]{Extended Attributes}
-Something that was on the project list for some time is now implemented for
-platforms that support a similar kind of interface. Its the support for backup
-and restore of so called extended attributes. As extended attributes are so
-platform specific these attributes are saved in seperate streams for each
-platform. Restores of the extended attributes can only be performed on the
-same platform the backup was done. There is support for all types of extended
-attributes, but restoring from one type of filesystem onto an other type of
-filesystem on the same platform may lead to supprises. As extended attributes
-can contain any type of data they are stored as a series of so called
-value-pairs. This data must be seen as mostly binary and is stored as such.
-As security labels from selinux are also extended attributes this option also
-stores those labels and no specific code is enabled for handling selinux
-security labels.
-
-Currently the following platforms support extended attributes:
-\begin{itemize}
- \item {\bf Darwin/OSX}
- \item {\bf FreeBSD}
- \item {\bf Linux}
- \item {\bf NetBSD}
-\end{itemize}
-
-On linux acls are also extended attributes, as such when you enable ACLs on a
-Linux platform it will NOT save the same data twice e.g. it will save the ACLs
-and not the same exteneded attribute.
-
-To enable the backup of extended attributes please add the following to your
-fileset definition.
-\begin{verbatim}
- FileSet {
- Name = "MyFileSet"
- Include {
- Options {
- signature = MD5
- xattrsupport = yes
- }
- File = ...
- }
- }
-\end{verbatim}
-
-\section{Shared objects}
-\index[general]{Shared objects}
-A default build of Bacula will now create the libraries as shared objects
-(.so) rather than static libraries as was previously the case.
-The shared libraries are built using {\bf libtool} so it should be quite
-portable.
-
-An important advantage of using shared objects is that on a machine with the
-Directory, File daemon, the Storage daemon, and a console, you will have only
-one copy of the code in memory rather than four copies. Also the total size of
-the binary release is smaller since the library code appears only once rather
-than once for every program that uses it; this results in significant reduction
-in the size of the binaries particularly for the utility tools.
-
-In order for the system loader to find the shared objects when loading the
-Bacula binaries, the Bacula shared objects must either be in a shared object
-directory known to the loader (typically /usr/lib) or they must be in the
-directory that may be specified on the {\bf ./configure} line using the {\bf
- {-}{-}libdir} option as:
-
-\begin{verbatim}
- ./configure --libdir=/full-path/dir
-\end{verbatim}
-
-the default is /usr/lib. If {-}{-}libdir is specified, there should be
-no need to modify your loader configuration provided that
-the shared objects are installed in that directory (Bacula
-does this with the make install command). The shared objects
-that Bacula references are:
-
-\begin{verbatim}
-libbaccfg.so
-libbacfind.so
-libbacpy.so
-libbac.so
-\end{verbatim}
-
-These files are symbolically linked to the real shared object file,
-which has a version number to permit running multiple versions of
-the libraries if desired (not normally the case).
-
-If you have problems with libtool or you wish to use the old
-way of building static libraries, or you want to build a static
-version of Bacula you may disable
-libtool on the configure command line with:
-
-\begin{verbatim}
- ./configure --disable-libtool
-\end{verbatim}
-
-
-\section{Building Static versions of Bacula}
-\index[general]{Static linking}
-In order to build static versions of Bacula, in addition
-to configuration options that were needed you now must
-also add --disable-libtool. Example
-
-\begin{verbatim}
- ./configure --enable-static-client-only --disable-libtool
-\end{verbatim}
-
-
-\section{Virtual Backup (Vbackup)}
-\index[general]{Virtual Backup}
-\index[general]{Vbackup}
-
-Bacula's virtual backup feature is often called Synthetic Backup or
-Consolidation in other backup products. It permits you to consolidate the
-previous Full backup plus the most recent Differential backup and any
-subsequent Incremental backups into a new Full backup. This new Full
-backup will then be considered as the most recent Full for any future
-Incremental or Differential backups. The VirtualFull backup is
-accomplished without contacting the client by reading the previous backup
-data and writing it to a volume in a different pool.
-
-In some respects the Vbackup feature works similar to a Migration job, in
-that Bacula normally reads the data from the pool specified in the
-Job resource, and writes it to the {\bf Next Pool} specified in the
-Job resource. Note, this means that usually the output from the Virtual
-Backup is written into a different pool from where your prior backups
-are saved. Doing it this way guarantees that you will not get a deadlock
-situation attempting to read and write to the same volume in the Storage
-daemon. If you then want to do subsequent backups, you may need to
-move the Virtual Full Volume back to your normal backup pool.
-Alternatively, you can set your {\bf Next Pool} to point to the current
-pool. This will cause Bacula to read and write to Volumes in the
-current pool. In general, this will work, because Bacula will
-not allow reading and writing on the same Volume. In any case, once
-a VirtualFull has been created, and a restore is done involving the
-most current Full, it will read the Volume or Volumes by the VirtualFull
-regardless of in which Pool the Volume is found.
-
-The Vbackup is enabled on a Job by Job in the Job resource by specifying
-a level of {\bf VirtualFull}.
-
-A typical Job resource definition might look like the following:
-
-\begin{verbatim}
-Job {
- Name = "MyBackup"
- Type = Backup
- Client=localhost-fd
- FileSet = "Full Set"
- Storage = File
- Messages = Standard
- Pool = Default
- SpoolData = yes
-}
-
-# Default pool definition
-Pool {
- Name = Default
- Pool Type = Backup
- Recycle = yes # Automatically recycle Volumes
- AutoPrune = yes # Prune expired volumes
- Volume Retention = 365d # one year
- NextPool = Full
- Storage = File
-}
-
-Pool {
- Name = Full
- Pool Type = Backup
- Recycle = yes # Automatically recycle Volumes
- AutoPrune = yes # Prune expired volumes
- Volume Retention = 365d # one year
- Storage = DiskChanger
-}
-
-# Definition of file storage device
-Storage {
- Name = File
- Address = localhost
- Password = "xxx"
- Device = FileStorage
- Media Type = File
- Maximum Concurrent Jobs = 5
-}
-
-# Definition of DDS Virtual tape disk storage device
-Storage {
- Name = DiskChanger
- Address = localhost # N.B. Use a fully qualified name here
- Password = "yyy"
- Device = DiskChanger
- Media Type = DiskChangerMedia
- Maximum Concurrent Jobs = 4
- Autochanger = yes
-}
-\end{verbatim}
-
-Then in bconsole or via a Run schedule, you would run the job as:
-
-\begin{verbatim}
-run job=MyBackup level=Full
-run job=MyBackup level=Incremental
-run job=MyBackup level=Differential
-run job=MyBackup level=Incremental
-run job=MyBackup level=Incremental
-\end{verbatim}
-
-So providing there were changes between each of those jobs, you would end up
-with a Full backup, a Differential, which includes the first Incremental
-backup, then two Incremental backups. All the above jobs would be written to
-the {\bf Default} pool.
-
-To consolidate those backups into a new Full backup, you would run the
-following:
-
-\begin{verbatim}
-run job=MyBackup level=VirtualFull
-\end{verbatim}
-
-And it would produce a new Full backup without using the client, and the output
-would be written to the {\bf Full} Pool which uses the Diskchanger Storage.
-
-If the Virtual Full is run, and there are no prior Jobs, the Virtual Full will
-fail with an error.
-
-Note, the Start and End time of the Virtual Full backup is set to the
-values for the last job included in the Virtual Full (in the above example,
-it is an Increment). This is so that if another incremental is done, which
-will be based on the Virtual Full, it will backup all files from the
-last Job included in the Virtual Full rather than from the time the Virtual
-Full was actually run.
-
-
-
-\section{Catalog Format}
-\index[general]{Catalog Format}
-Bacula 3.0 comes with some changes to the catalog format. The upgrade
-operation will convert the FileId field of the File table from 32 bits (max 4
-billion table entries) to 64 bits (very large number of items). The
-conversion process can take a bit of time and will likely DOUBLE THE SIZE of
-your catalog during the conversion. Also you won't be able to run jobs during
-this conversion period. For example, a 3 million file catalog will take 2
-minutes to upgrade on a normal machine. Please don't forget to make a valid
-backup of your database before executing the upgrade script. See the
-ReleaseNotes for additional details.
-
-\section{64 bit Windows Client}
-\index[general]{Win64 Client}
-Unfortunately, Microsoft's implementation of Volume Shadown Copy (VSS) on
-their 64 bit OS versions is not compatible with a 32 bit Bacula Client.
-As a consequence, we are also releasing a 64 bit version of the Bacula
-Windows Client (win64bacula-3.0.0.exe) that does work with VSS.
-These binaries should only be installed on 64 bit Windows operating systems.
-What is important is not your hardware but whether or not you have
-a 64 bit version of the Windows OS.
-
-Compared to the Win32 Bacula Client, the 64 bit release contains a few differences:
-\begin{enumerate}
-\item Before installing the Win64 Bacula Client, you must totally
- deinstall any prior 2.4.x Client installation using the
- Bacula deinstallation (see the menu item). You may want
- to save your .conf files first.
-\item Only the Client (File daemon) is ported to Win64, the Director
- and the Storage daemon are not in the 64 bit Windows installer.
-\item bwx-console is not yet ported.
-\item bconsole is ported but it has not been tested.
-\item The documentation is not included in the installer.
-\item Due to Vista security restrictions imposed on a default installation
- of Vista, before upgrading the Client, you must manually stop
- any prior version of Bacula from running, otherwise the install
- will fail.
-\item Due to Vista security restrictions imposed on a default installation
- of Vista, attempting to edit the conf files via the menu items
- will fail. You must directly edit the files with appropriate
- permissions. Generally double clicking on the appropriate .conf
- file will work providing you have sufficient permissions.
-\item All Bacula files are now installed in
- {\bf C:/Program Files/Bacula} except the main menu items,
- which are installed as before. This vastly simplifies the installation.
-\item If you are running on a foreign language version of Windows, most
- likely {\bf C:/Program Files} does not exist, so you should use the
- Custom installation and enter an appropriate location to install
- the files.
-\item The 3.0.0 Win32 Client continues to install files in the locations used
- by prior versions. For the next version we will convert it to use
- the same installation conventions as the Win64 version.
-\end{enumerate}
-
-This project was funded by Bacula Systems.
-
-
-\section{Duplicate Job Control}
-\index[general]{Duplicate Jobs}
-The new version of Bacula provides four new directives that
-give additional control over what Bacula does if duplicate jobs
-are started. A duplicate job in the sense we use it here means
-a second or subsequent job with the same name starts. This
-happens most frequently when the first job runs longer than expected because no
-tapes are available.
-
-The four directives each take as an argument a {\bf yes} or {\bf no} value and
-are specified in the Job resource.
-
-They are:
-
-\subsection{Allow Duplicate Jobs = \lt{}yes\vb{}no\gt{}}
-\index[general]{Allow Duplicate Jobs}
- If this directive is enabled duplicate jobs will be run. If
- the directive is set to {\bf no} (default) then only one job of a given name
- may run at one time, and the action that Bacula takes to ensure only
- one job runs is determined by the other directives (see below).
-
- If {\bf Allow Duplicate Jobs} is set to {\bf no} and two jobs
- are present and none of the three directives given below permit
- cancelling a job, then the current job (the second one started)
- will be cancelled.
-
-
-\subsection{Allow Higher Duplicates = \lt{}yes\vb{}no\gt{}}
-\index[general]{Allow Higher Duplicates}
- If this directive is set to {\bf yes} (default) the job with a higher
- priority (lower priority number) will be permitted to run, and
- the current job will be cancelled. If the
- priorities of the two jobs are the same, the outcome is determined by
- other directives (see below).
-
-\subsection{Cancel Queued Duplicates = \lt{}yes\vb{}no\gt{}}
-\index[general]{Cancel Queued Duplicates}
- If {\bf Allow Duplicate Jobs} is set to {\bf no} and
- if this directive is set to {\bf yes} any job that is
- already queued to run but not yet running will be canceled.
- The default is {\bf no}.
-
-\subsection{Cancel Running Duplicates = \lt{}yes\vb{}no\gt{}}
-\index[general]{Cancel Running Duplicates}
- If {\bf Allow Duplicate Jobs} is set to {\bf no} and
- if this directive is set to {\bf yes} any job that is already running
- will be canceled. The default is {\bf no}.
-
-
-\section{TLS Authentication}
-\index[general]{TLS Authentication}
-In Bacula version 2.5.x and later, in addition to the normal Bacula
-CRAM-MD5 authentication that is used to authenticate each Bacula
-connection, you can specify that you want TLS Authentication as well,
-which will provide more secure authentication.
-
-This new feature uses Bacula's existing TLS code (normally used for
-communications encryption) to do authentication. To use it, you must
-specify all the TLS directives normally used to enable communications
-encryption (TLS Enable, TLS Verify Peer, TLS Certificate, ...) and
-a new directive:
-
-\subsection{TLS Authenticate = yes}
-\begin{verbatim}
-TLS Authenticate = yes
-\end{verbatim}
-
-in the main daemon configuration resource (Director for the Director,
-Client for the File daemon, and Storage for the Storage daemon).
-
-When {\bf TLS Authenticate} is enabled, after doing the CRAM-MD5
-authentication, Bacula will also do TLS authentication, then TLS
-encryption will be turned off, and the rest of the communication between
-the two Bacula daemons will be done without encryption.
-
-If you want to encrypt communications data, use the normal TLS directives
-but do not turn on {\bf TLS Authenticate}.
-
-\section{bextract non-portable Win32 data}
-\index[general]{bextract handles Win32 non-portable data}
-{\bf bextract} has been enhanced to be able to restore
-non-portable Win32 data to any OS. Previous versions were
-unable to restore non-portable Win32 data to machines that
-did not have the Win32 BackupRead and BackupWrite API calls.
-
-\section{State File updated at Job Termination}
-\index[general]{State File}
-In previous versions of Bacula, the state file, which provides a
-summary of previous jobs run in the {\bf status} command output was
-updated only when Bacula terminated, thus if the daemon crashed, the
-state file might not contain all the run data. This version of
-the Bacula daemons updates the state file on each job termination.
-
-\section{MaxFullInterval = \lt{}time-interval\gt{}}
-\index[general]{MaxFullInterval}
-The new Job resource directive {\bf Max Full Interval = \lt{}time-interval\gt{}}
-can be used to specify the maximum time interval between {\bf Full} backup
-jobs. When a job starts, if the time since the last Full backup is
-greater than the specified interval, and the job would normally be an
-{\bf Incremental} or {\bf Differential}, it will be automatically
-upgraded to a {\bf Full} backup.
-
-\section{MaxDiffInterval = \lt{}time-interval\gt{}}
-\index[general]{MaxDiffInterval}
-The new Job resource directive {\bf Max Diff Interval = \lt{}time-interval\gt{}}
-can be used to specify the maximum time interval between {\bf Differential} backup
-jobs. When a job starts, if the time since the last Differential backup is
-greater than the specified interval, and the job would normally be an
-{\bf Incremental}, it will be automatically
-upgraded to a {\bf Differential} backup.
-
-\section{Honor No Dump Flag = \lt{}yes\vb{}no\gt{}}
-\index[general]{MaxDiffInterval}
-On FreeBSD systems, each file has a {\bf no dump flag} that can be set
-by the user, and when it is set it is an indication to backup programs
-to not backup that particular file. This version of Bacula contains a
-new Options directive within a FileSet resource, which instructs Bacula to
-obey this flag. The new directive is:
-
-\begin{verbatim}
- Honor No Dump Flag = yes\vb{}no
-\end{verbatim}
-
-The default value is {\bf no}.
-
-
-\section{Exclude Dir Containing = \lt{}filename-string\gt{}}
-\index[general]{IgnoreDir}
-The {\bf ExcludeDirContaining = \lt{}filename\gt{}} is a new directive that
-can be added to the Include section of the FileSet resource. If the specified
-filename ({\bf filename-string}) is found on the Client in any directory to be
-backed up, the whole directory will be ignored (not backed up). For example:
-
-\begin{verbatim}
- # List of files to be backed up
- FileSet {
- Name = "MyFileSet"
- Include {
- Options {
- signature = MD5
- }
- File = /home
- Exclude Dir Containing = .excludeme
- }
- }
-\end{verbatim}
-
-But in /home, there may be hundreds of directories of users and some
-people want to indicate that they don't want to have certain
-directories backed up. For example, with the above FileSet, if
-the user or sysadmin creates a file named {\bf .excludeme} in
-specific directories, such as
-
-\begin{verbatim}
- /home/user/www/cache/.excludeme
- /home/user/temp/.excludeme
-\end{verbatim}
-
-then Bacula will not backup the two directories named:
-
-\begin{verbatim}
- /home/user/www/cache
- /home/user/temp
-\end{verbatim}
-
-NOTE: subdirectories will not be backed up. That is, the directive
-applies to the two directories in question and any children (be they
-files, directories, etc).
-
-
-\section{Bacula Plugins}
-\index[general]{Plugin}
-Support for shared object plugins has been implemented in the Linux, Unix
-and Win32 File daemons. The API will be documented separately in
-the Developer's Guide or in a new document. For the moment, there is
-a single plugin named {\bf bpipe} that allows an external program to
-get control to backup and restore a file.
-
-Plugins are also planned (partially implemented) in the Director and the
-Storage daemon.
-
-\subsection{Plugin Directory}
-\index[general]{Plugin Directory}
-Each daemon (DIR, FD, SD) has a new {\bf Plugin Directory} directive that may
-be added to the daemon definition resource. The directory takes a quoted
-string argument, which is the name of the directory in which the daemon can
-find the Bacula plugins. If this directive is not specified, Bacula will not
-load any plugins. Since each plugin has a distinctive name, all the daemons
-can share the same plugin directory.
-
-\subsection{Plugin Options}
-\index[general]{Plugin Options}
-The {\bf Plugin Options} directive takes a quoted string
-arguement (after the equal sign) and may be specified in the
-Job resource. The options specified will be passed to all plugins
-when they are run. This each plugin must know what it is looking
-for. The value defined in the Job resource can be modified
-by the user when he runs a Job via the {\bf bconsole} command line
-prompts.
-
-Note: this directive may be specified, and there is code to modify
-the string in the run command, but the plugin options are not yet passed to
-the plugin (i.e. not fully implemented).
-
-\subsection{Plugin Options ACL}
-\index[general]{Plugin Options ACL}
-The {\bf Plugin Options ACL} directive may be specified in the
-Director's Console resource. It functions as all the other ACL commands
-do by permitting users running restricted consoles to specify a
-{\bf Plugin Options} that overrides the one specified in the Job
-definition. Without this directive restricted consoles may not modify
-the Plugin Options.
-
-\subsection{Plugin = \lt{}plugin-command-string\gt{}}
-\index[general]{Plugin}
-The {\bf Plugin} directive is specified in the Include section of
-a FileSet resource where you put your {\bf File = xxx} directives.
-For example:
-
-\begin{verbatim}
- FileSet {
- Name = "MyFileSet"
- Include {
- Options {
- signature = MD5
- }
- File = /home
- Plugin = "bpipe:..."
- }
- }
-\end{verbatim}
-
-In the above example, when the File daemon is processing the directives
-in the Include section, it will first backup all the files in {\bf /home}
-then it will load the plugin named {\bf bpipe} (actually bpipe-dir.so) from
-the Plugin Directory. The syntax and semantics of the Plugin directive
-require the first part of the string up to the colon (:) to be the name
-of the plugin. Everything after the first colon is ignored by the File daemon but
-is passed to the plugin. Thus the plugin writer may define the meaning of the
-rest of the string as he wishes.
-
-Please see the next section for information about the {\bf bpipe} Bacula
-plugin.
-
-\section{The bpipe Plugin}
-\index[general]{The bpipe Plugin}
-The {\bf bpipe} plugin is provided in the directory src/plugins/fd/bpipe-fd.c of
-the Bacula source distribution. When the plugin is compiled and linking into
-the resulting dynamic shared object (DSO), it will have the name {\bf bpipe-fd.so}.
-
-The purpose of the plugin is to provide an interface to any system program for
-backup and restore. As specified above the {\bf bpipe} plugin is specified in
-the Include section of your Job's FileSet resource. The full syntax of the
-plugin directive as interpreted by the {\bf bpipe} plugin (each plugin is free
-to specify the sytax as it wishes) is:
-
-\begin{verbatim}
- Plugin = "<field1>:<field2>:<field3>:<field4>"
-\end{verbatim}
-
-where
-\begin{description}
-\item {\bf field1} is the name of the plugin with the trailing {\bf -fd.so}
-stripped off, so in this case, we would put {\bf bpipe} in this field.
-
-\item {\bf field2} specifies the namespace, which for {\bf bpipe} is the
-pseudo path and filename under which the backup will be saved. This pseudo
-path and filename will be seen by the user in the restore file tree.
-For example, if the value is {\bf /MYSQL/regress.sql}, the data
-backed up by the plugin will be put under that "pseudo" path and filename.
-You must be careful to choose a naming convention that is unique to avoid
-a conflict with a path and filename that actually exists on your system.
-
-\item {\bf field3} for the {\bf bpipe} plugin
-specifies the "reader" program that is called by the plugin during
-backup to read the data. {\bf bpipe} will call this program by doing a
-{\bf popen} on it.
-
-\item {\bf field4} for the {\bf bpipe} plugin
-specifies the ``writer´´ program that is called by the plugin during
-restore to write the data back to the filesystem.
-\end{description}
-
-Putting it all together, the full plugin directive line might look
-like the following:
-
-\begin{verbatim}
-Plugin = "bpipe:/MYSQL/regress.sql:mysqldump -f
- --opt --databases bacula:mysql"
-\end{verbatim}
-
-The directive has been split into two lines, but within the {\bf bacula-dir.conf} file
-would be written on a single line.
-
-This causes the File daemon to call the {\bf bpipe} plugin, which will write
-its data into the "pseudo" file {\bf /MYSQL/regress.sql} by calling the
-program {\bf mysqldump -f --opt --database bacula} to read the data during
-backup. The mysqldump command outputs all the data for the database named
-{\bf bacula}, which will be read by the plugin and stored in the backup.
-During restore, the data that was backed up will be sent to the program
-specified in the last field, which in this case is {\bf mysql}. When
-{\bf mysql} is called, it will read the data sent to it by the plugn
-then write it back to the same database from which it came ({\bf bacula}
-in this case).
-
-The {\bf bpipe} plugin is a generic pipe program, that simply transmits
-the data from a specified program to Bacula for backup, and then from Bacula to
-a specified program for restore.
-
-By using different command lines to {\bf bpipe},
-you can backup any kind of data (ASCII or binary) depending
-on the program called.
-
-\section{Microsoft Exchange Server 2003/2007 Plugin}
-\index[general]{Microsoft Exchange Server 2003/2007 Plugin}
-\subsection{Background}
-The Exchange plugin was made possible by a funded development project
-between Equiinet Ltd -- www.equiinet.com (many thanks) and Bacula Systems.
-The code for the plugin was written by James Harper, and the Bacula core
-code by Kern Sibbald. All the code for this funded development has become
-part of the Bacula project. Thanks to everyone who made it happen.
-
-\subsection{Concepts}
-Although it is possible to backup Exchange using Bacula VSS the Exchange
-plugin adds a good deal of functionality, because while Bacula VSS
-completes a full backup (snapshot) of Exchange, it does
-not support Incremental or Differential backups, restoring is more
-complicated, and a single database restore is not possible.
-
-Microsoft Exchange organises its storage into Storage Groups with
-Databases inside them. A default installation of Exchange will have a
-single Storage Group called 'First Storage Group', with two Databases
-inside it, "Mailbox Store (SERVER NAME)" and
-"Public Folder Store (SERVER NAME)\",
-which hold user email and public folders respectively.
-
-In the default configuration, Exchange logs everything that happens to
-log files, such that if you have a backup, and all the log files since,
-you can restore to the present time. Each Storage Group has its own set
-of log files and operates independently of any other Storage Groups. At
-the Storage Group level, the logging can be turned off by enabling a
-function called "Enable circular logging\". At this time the Exchange
-plugin will not function if this option is enabled.
-
-The plugin allows backing up of entire storage groups, and the restoring
-of entire storage groups or individual databases. Backing up and
-restoring at the individual mailbox or email item is not supported but
-can be simulated by use of the "Recovery" Storage Group (see below).
-
-\subsection{Installing}
-The Exchange plugin requires a DLL that is shipped with Microsoft
-Exchanger Server called {\bf esebcli2.dll}. Assuming Exchange is installed
-correctly the Exchange plugin should find this automatically and run
-without any additional installation.
-
-If the DLL can not be found automatically it will need to be copied into
-the Bacula installation
-directory (eg C:\verb+\+Program Files\verb+\+Bacula\verb+\+bin). The Exchange API DLL is
-named esebcli2.dll and is found in C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+bin on a
-default Exchange installation.
-
-\subsection{Backup up}
-To back up an Exchange server the Fileset definition must contain at
-least {\bf Plugin = \dq{}exchange:/@EXCHANGE/Microsoft Information Store\dq{}} for
-the backup to work correctly. The 'exchange:' bit tells Bacula to look
-for the exchange plugin, the '@EXCHANGE' bit makes sure all the backed
-up files are prefixed with something that isn't going to share a name
-with something outside the plugin, and the 'Microsoft Information Store'
-bit is required also. It is also possible to add the name of a storage
-group to the "Plugin =" line, eg \\
-{\bf Plugin = \dq{}exchange:/@EXCHANGE/Microsoft Information Store/First Storage Group\dq{}} \\
-if you want only a single storage group backed up.
-
-Additionally, you can suffix the 'Plugin =' directive with
-\dq{}:notrunconfull\dq{} which will tell the plugin not to truncate the Exchange
-database at the end of a full backup.
-
-An Incremental or Differential backup will backup only the database logs
-for each Storage Group by inspecting the "modified date" on each
-physical log file. Because of the way the Exchange API works, the last
-logfile backed up on each backup will always be backed up by the next
-Incremental or Differential backup too. This adds 5MB to each
-Incremental or Differential backup size but otherwise does not cause any
-problems.
-
-By default, a normal VSS fileset containing all the drive letters will
-also back up the Exchange databases using VSS. This will interfere with
-the plugin and Exchange's shared ideas of when the last full backup was
-done, and may also truncate log files incorrectly. It is important,
-therefore, that the Exchange database files be excluded from the backup,
-although the folders the files are in should be included, or they will
-have to be recreated manually if a baremetal restore is done.
-
-\begin{verbatim}
-FileSet {
- Include {
- File = C:/Program Files/Exchsrvr/mdbdata
- Plugin = "exchange:..."
- }
- Exclude {
- File = C:/Program Files/Exchsrvr/mdbdata/E00.chk
- File = C:/Program Files/Exchsrvr/mdbdata/E00.log
- File = C:/Program Files/Exchsrvr/mdbdata/E000000F.log
- File = C:/Program Files/Exchsrvr/mdbdata/E0000010.log
- File = C:/Program Files/Exchsrvr/mdbdata/E0000011.log
- File = C:/Program Files/Exchsrvr/mdbdata/E00tmp.log
- File = C:/Program Files/Exchsrvr/mdbdata/priv1.edb
- }
-}
-\end{verbatim}
-
-The advantage of excluding the above files is that you can significantly
-reduce the size of your backup since all the important Exchange files
-will be properly saved by the Plugin.
-
-
-\subsection{Restoring}
-The restore operation is much the same as a normal Bacula restore, with
-the following provisos:
-
-\begin{itemize}
-\item The {\bf Where} restore option must not be specified
-\item Each Database directory must be marked as a whole. You cannot just
- select (say) the .edb file and not the others.
-\item If a Storage Group is restored, the directory of the Storage Group
- must be marked too.
-\item It is possible to restore only a subset of the available log files,
- but they {\bf must} be contiguous. Exchange will fail to restore correctly
- if a log file is missing from the sequence of log files
-\item Each database to be restored must be dismounted and marked as \dq{}Can be
- overwritten by restore\dq{}
-\item If an entire Storage Group is to be restored (eg all databases and
- logs in the Storage Group), then it is best to manually delete the
- database files from the server (eg C:\verb+\+Program Files\verb+\+Exchsrvr\verb+\+mdbdata\verb+\+*)
- as Exchange can get confused by stray log files lying around.
-\end{itemize}
-
-\subsection{Restoring to the Recovery Storage Group}
-The concept of the Recovery Storage Group is well documented by
-Microsoft
-\elink{http://support.microsoft.com/kb/824126}{http://support.microsoft.com/kb/824126},
-but to briefly summarize...
-
-Microsoft Exchange allows the creation of an additional Storage Group
-called the Recovery Storage Group, which is used to restore an older
-copy of a database (e.g. before a mailbox was deleted) into without
-messing with the current live data. This is required as the Standard and
-Small Business Server versions of Exchange can not ordinarily have more
-than one Storage Group.
-
-To create the Recovery Storage Group, drill down to the Server in Exchange
-System Manager, right click, and select
-{\bf \dq{}New -> Recovery Storage Group...\dq{}}. Accept or change the file
-locations and click OK. On the Recovery Storage Group, right click and
-select {\bf \dq{}Add Database to Recover...\dq{}} and select the database you will
-be restoring.
-
-Restore only the single database nominated as the database in the
-Recovery Storage Group. Exchange will redirect the restore to the
-Recovery Storage Group automatically.
-Then run the restore.
-
-\subsection{Restoring on Microsoft Server 2007}
-Apparently the {\bf Exmerge} program no longer exists in Microsoft Server
-2007, and henc you use a new proceedure for recovering a single mail box.
-This procedure is ducomented by Microsoft at:
-\elink{http://technet.microsoft.com/en-us/library/aa997694.aspx}{http://technet.microsoft.com/en-us/library/aa997694.aspx},
-and involves using the {\bf Restore-Mailbox} and {\bf
-Get-MailboxStatistics} shell commands.
-
-\subsection{Caveats}
-This plugin is still being developed, so you should consider it
-currently in BETA test, and thus use in a production environment
-should be done only after very careful testing.
-
-When doing a full backup, the Exchange database logs are truncated by
-Exchange as soon as the plugin has completed the backup. If the data
-never makes it to the backup medium (eg because of spooling) then the
-logs will still be truncated, but they will also not have been backed
-up. A solution to this is being worked on. You will have to schedule a
-new Full backup to ensure that your next backups will be usable.
-
-The "Enable Circular Logging" option cannot be enabled or the plugin
-will fail.
-
-Exchange insists that a successful Full backup must have taken place if
-an Incremental or Differential backup is desired, and the plugin will
-fail if this is not the case. If a restore is done, Exchange will
-require that a Full backup be done before an Incremental or Differential
-backup is done.
-
-The plugin will most likely not work well if another backup application
-(eg NTBACKUP) is backing up the Exchange database, especially if the
-other backup application is truncating the log files.
-
-The Exchange plugin has not been tested with the {\bf Accurate} option, so
-we recommend either carefully testing or that you avoid this option for
-the current time.
-
-The Exchange plugin is not called during processing the bconsole {\bf
-estimate} command, and so anything that would be backed up by the plugin
-will not be added to the estimate total that is displayed.
-
-
-\section{libdbi Framework}
-\index[general]{libdbi Framework}
-As a general guideline, Bacula has support for a few catalog database drivers
-(MySQL, PostgreSQL, SQLite)
-coded natively by the Bacula team. With the libdbi implementation, which is a
-Bacula driver that uses libdbi to access the catalog, we have an open field to
-use many different kinds database engines following the needs of users.
-
-The according to libdbi (http://libdbi.sourceforge.net/) project: libdbi
-implements a database-independent abstraction layer in C, similar to the
-DBI/DBD layer in Perl. Writing one generic set of code, programmers can
-leverage the power of multiple databases and multiple simultaneous database
-connections by using this framework.
-
-Currently the libdbi driver in Bacula project only supports the same drivers
-natively coded in Bacula. However the libdbi project has support for many
-others database engines. You can view the list at
-http://libdbi-drivers.sourceforge.net/. In the future all those drivers can be
-supported by Bacula, however, they must be tested properly by the Bacula team.
-
-Some of benefits of using libdbi are:
-\begin{itemize}
-\item The possibility to use proprietary databases engines in which your
- proprietary licenses prevent the Bacula team from developing the driver.
- \item The possibility to use the drivers written for the libdbi project.
- \item The possibility to use other database engines without recompiling Bacula
- to use them. Just change one line in bacula-dir.conf
- \item Abstract Database access, this is, unique point to code and profiling
- catalog database access.
- \end{itemize}
-
- The following drivers have been tested:
- \begin{itemize}
- \item PostgreSQL, with and without batch insert
- \item Mysql, with and without batch insert
- \item SQLite
- \item SQLite3
- \end{itemize}
-
- In the future, we will test and approve to use others databases engines
- (proprietary or not) like DB2, Oracle, Microsoft SQL.
-
- To compile Bacula to support libdbi we need to configure the code with the
- --with-dbi and --with-dbi-driver=[database] ./configure options, where
- [database] is the database engine to be used with Bacula (of course we can
- change the driver in file bacula-dir.conf, see below). We must configure the
- access port of the database engine with the option --with-db-port, because the
- libdbi framework doesn't know the default access port of each database.
-
-The next phase is checking (or configuring) the bacula-dir.conf, example:
-\begin{verbatim}
-Catalog {
- Name = MyCatalog
- dbdriver = dbi:mysql; dbaddress = 127.0.0.1; dbport = 3306
- dbname = regress; user = regress; password = ""
-}
-\end{verbatim}
-
-The parameter {\bf dbdriver} indicates that we will use the driver dbi with a
-mysql database. Currently the drivers supported by Bacula are: postgresql,
-mysql, sqlite, sqlite3; these are the names that may be added to string \dq{}dbi:\dq{}
-
-The following limitations apply when Bacula is set to use the libdbi framework:
- - Not tested on the Win32 platform
- - A little performance is lost if comparing with native database driver.
- The reason is bound with the database driver provided by libdbi and the
- simple fact that one more layer of code was added.
-
-It is important to remember, when compiling Bacula with libdbi, the
-following packages are needed:
- \begin{itemize}
- \item libdbi version 1.0.0, http://libdbi.sourceforge.net/
- \item libdbi-drivers 1.0.0, http://libdbi-drivers.sourceforge.net/
- \end{itemize}
-
- You can download them and compile them on your system or install the packages
- from your OS distribution.
-
-\section{Console Command Additions and Enhancements}
-\index[general]{Console Additions}
-
-\subsection{Display Autochanger Content}
-\index[general]{StatusSlots}
-
-The {\bf status slots storage=\lt{}storage-name\gt{}} command displays
-autochanger content.
-
-\footnotesize
-\begin{verbatim}
- Slot | Volume Name | Status | Media Type | Pool |
-------+---------------+----------+-------------------+------------|
- 1 | 00001 | Append | DiskChangerMedia | Default |
- 2 | 00002 | Append | DiskChangerMedia | Default |
- 3*| 00003 | Append | DiskChangerMedia | Scratch |
- 4 | | | | |
-\end{verbatim}
-\normalsize
-
-If you an asterisk ({\bf *}) appears after the slot number, you must run an
-{\bf update slots} command to synchronize autochanger content with your
-catalog.
-
-\subsection{list joblog job=xxx or jobid=nnn}
-\index[general]{list joblog}
-A new list command has been added that allows you to list the contents
-of the Job Log stored in the catalog for either a Job Name (fully qualified)
-or for a particular JobId. The {\bf llist} command will include a line with
-the time and date of the entry.
-
-Note for the catalog to have Job Log entries, you must have a directive
-such as:
-
-\begin{verbatim}
- catalog = all
-\end{verbatim}
-
-In your Director's {\bf Messages} resource.
-
-\subsection{Use separator for multiple commands}
-\index[general]{Command Separator}
- When using bconsole with readline, you can set the command separator with
- \textbf{@separator} command to one
- of those characters to write commands who require multiple input in one line.
-\begin{verbatim}
- !$%&'()*+,-/:;<>?[]^`{|}~
-\end{verbatim}
-
-\subsection{Deleting Volumes}
-The delete volume bconsole command has been modified to
-require an asterisk (*) in front of a MediaId otherwise the
-value you enter is a taken to be a Volume name. This is so that
-users may delete numeric Volume names. The previous Bacula versions
-assumed that all input that started with a number was a MediaId.
-
-This new behavior is indicated in the prompt if you read it
-carefully.
-
-\section{Bare Metal Recovery}
-The old bare metal recovery project is essentially dead. One
-of the main features of it was that it would build a recovery
-CD based on the kernel on your system. The problem was that
-every distribution has a different boot procedure and different
-scripts, and worse yet, the boot procedures and scripts change
-from one distribution to another. This meant that maintaining
-(keeping up with the changes) the rescue CD was too much work.
-
-To replace it, a new bare metal recovery USB boot stick has been developed
-by Bacula Systems. This technology involves remastering a Ubuntu LiveCD to
-boot from a USB key.
-
-Advantages:
-\begin{enumerate}
-\item Recovery can be done from within graphical environment.
-\item Recovery can be done in a shell.
-\item Ubuntu boots on a large number of Linux systems.
-\item The process of updating the system and adding new
- packages is not too difficult.
-\item The USB key can easily be upgraded to newer Ubuntu versions.
-\item The USB key has writable partitions for modifications to
- the OS and for modification to your home directory.
-\item You can add new files/directories to the USB key very easily.
-\item You can save the environment from multiple machines on
- one USB key.
-\item Bacula Systems is funding its ongoing development.
-\end{enumerate}
-
-The disadvantages are:
-\begin{enumerate}
-\item The USB key is usable but currently under development.
-\item Not everyone may be familiar with Ubuntu (no worse
- than using Knoppix)
-\item Some older OSes cannot be booted from USB. This can
- be resolved by first booting a Ubuntu LiveCD then plugging
- in the USB key.
-\item Currently the documentation is sketchy and not yet added
- to the main manual. See below ...
-\end{enumerate}
-
-The documentation and the code can be found in the {\bf rescue} package
-in the directory {\bf linux/usb}.
-
-\section{Miscellaneous}
-\index[general]{Misc New Features}
-
-\subsection{Allow Mixed Priority = \lt{}yes\vb{}no\gt{}}
-\index[general]{Allow Mixed Priority}
- This directive is only implemented in version 2.5 and later. When
- set to {\bf yes} (default {\bf no}), this job may run even if lower
- priority jobs are already running. This means a high priority job
- will not have to wait for other jobs to finish before starting.
- The scheduler will only mix priorities when all running jobs have
- this set to true.
-
- Note that only higher priority jobs will start early. Suppose the
- director will allow two concurrent jobs, and that two jobs with
- priority 10 are running, with two more in the queue. If a job with
- priority 5 is added to the queue, it will be run as soon as one of
- the running jobs finishes. However, new priority 10 jobs will not
- be run until the priority 5 job has finished.
-
-\subsection{Bootstrap File Directive -- FileRegex}
-\index[general]{Bootstrap File Directive}
- {\bf FileRegex} is a new command that can be added to the bootstrap
- (.bsr) file. The value is a regular expression. When specified, only
- matching filenames will be restored.
-
- During a restore, if all File records are pruned from the catalog
- for a Job, normally Bacula can restore only all files saved. That
- is there is no way using the catalog to select individual files.
- With this new feature, Bacula will ask if you want to specify a Regex
- expression for extracting only a part of the full backup.
-
-\begin{verbatim}
- Building directory tree for JobId(s) 1,3 ...
- There were no files inserted into the tree, so file selection
- is not possible.Most likely your retention policy pruned the files
-
- Do you want to restore all the files? (yes\vb{}no): no
-
- Regexp matching files to restore? (empty to abort): /tmp/regress/(bin|tests)/
- Bootstrap records written to /tmp/regress/working/zog4-dir.restore.1.bsr
-\end{verbatim}
-
-\subsection{Bootstrap File Optimization Changes}
-In order to permit proper seeking on disk files, we have extended the bootstrap
-file format to include a {\bf VolStartAddr} and {\bf VolEndAddr} records. Each
-takes a 64 bit unsigned integer range (i.e. nnn-mmm) which defines the start
-address range and end address range respectively. These two directives replace
-the {\bf VolStartFile}, {\bf VolEndFile}, {\bf VolStartBlock} and {\bf
- VolEndBlock} directives. Bootstrap files containing the old directives will
-still work, but will not properly take advantage of proper disk seeking, and
-may read completely to the end of a disk volume during a restore. With the new
-format (automatically generated by the new Director), restores will seek
-properly and stop reading the volume when all the files have been restored.
-
-\subsection{Solaris ZFS/NFSv4 ACLs}
-This is an upgrade of the previous Solaris ACL backup code
-to the new library format, which will backup both the old
-POSIX(UFS) ACLs as well as the ZFS ACLs.
-
-The new code can also restore POSIX(UFS) ACLs to a ZFS filesystem
-(it will translate the POSIX(UFS)) ACL into a ZFS/NFSv4 one) it can also
-be used to transfer from UFS to ZFS filesystems.
-
-
-\subsection{Virtual Tape Emulation}
-\index[general]{Virtual Tape Emulation}
-We now have a Virtual Tape emulator that allows us to run though 99.9\% of
-the tape code but actually reading and writing to a disk file. Used with the
-\textbf{disk-changer} script, you can now emulate an autochanger with 10 drives
-and 700 slots. This feature is most useful in testing. It is enabled
-by using {\bf Device Type = vtape} in the Storage daemon's Device
-directive. This feature is only implemented on Linux machines and should not be
-used for production.
-
-\subsection{Bat Enhancements}
-\index[general]{Bat Enhancements}
-Bat (the Bacula Administration Tool) GUI program has been significantly
-enhanced and stabilized. In particular, there are new table based status
-commands; it can now be easily localized using Qt4 Linguist.
-
-The Bat communications protocol has been significantly enhanced to improve
-GUI handling. Note, you {\bf must} use a the bat that is distributed with
-the Director you are using otherwise the communications protocol will not
-work.
-
-\subsection{RunScript Enhancements}
-\index[general]{RunScript Enhancements}
-The {\bf RunScript} resource has been enhanced to permit multiple
-commands per RunScript. Simply specify multiple {\bf Command} directives
-in your RunScript.
-
-\begin{verbatim}
-Job {
- Name = aJob
- RunScript {
- Command = "/bin/echo test"
- Command = "/bin/echo an other test"
- Command = "/bin/echo 3 commands in the same runscript"
- RunsWhen = Before
- }
- ...
-}
-\end{verbatim}
-
-A new Client RunScript {\bf RunsWhen} keyword of {\bf AfterVSS} has been
-implemented, which runs the command after the Volume Shadow Copy has been made.
-
-Console commands can be specified within a RunScript by using:
-{\bf Console = \lt{}command\gt{}}, however, this command has not been
-carefully tested and debugged and is known to easily crash the Director.
-We would appreciate feedback. Due to the recursive nature of this command, we
-may remove it before the final release.
-
-\subsection{Status Enhancements}
-\index[general]{Status Enhancements}
-The bconsole {\bf status dir} output has been enhanced to indicate
-Storage daemon job spooling and despooling activity.
-
-\subsection{Connect Timeout}
-\index[general]{Connect Timeout}
-The default connect timeout to the File
-daemon has been set to 3 minutes. Previously it was 30 minutes.
-
-\subsection{ftruncate for NFS Volumes}
-\index[general]{ftruncate for NFS Volumes}
-If you write to a Volume mounted by NFS (say on a local file server),
-in previous Bacula versions, when the Volume was recycled, it was not
-properly truncated because NFS does not implement ftruncate (file
-truncate). This is now corrected in the new version because we have
-written code (actually a kind user) that deletes and recreates the Volume,
-thus accomplishing the same thing as a truncate.
-
-\subsection{Support for Ubuntu}
-The new version of Bacula now recognizes the Ubuntu (and Kubuntu)
-version of Linux, and thus now provides correct autostart routines.
-Since Ubuntu officially supports Bacula, you can also obtain any
-recent release of Bacula from the Ubuntu repositories.
-
-\subsection{Recycle Pool = \lt{}pool-name\gt{}}
-\index[general]{Recycle Pool}
-The new \textbf{RecyclePool} directive defines to which pool the Volume will
-be placed (moved) when it is recycled. Without this directive, a Volume will
-remain in the same pool when it is recycled. With this directive, it can be
-moved automatically to any existing pool during a recycle. This directive is
-probably most useful when defined in the Scratch pool, so that volumes will
-be recycled back into the Scratch pool.
-
-\subsection{FD Version}
-\index[general]{FD Version}
-The File daemon to Director protocol now includes a version
-number, which although there is no visible change for users,
-will help us in future versions automatically determine
-if a File daemon is not compatible.
-
-\subsection{Max Run Sched Time = \lt{}time-period-in-seconds\gt{}}
-\index[general]{Max Run Sched Time}
-The time specifies the maximum allowed time that a job may run, counted from
-when the job was scheduled. This can be useful to prevent jobs from running
-during working hours. We can see it like \texttt{Max Start Delay + Max Run
- Time}.
-
-\subsection{Max Wait Time = \lt{}time-period-in-seconds\gt{}}
-\index[general]{Max Wait Time}
-Previous \textbf{MaxWaitTime} directives aren't working as expected, instead
-of checking the maximum allowed time that a job may block for a resource,
-those directives worked like \textbf{MaxRunTime}. Some users are reporting to
-use \textbf{Incr/Diff/Full Max Wait Time} to control the maximum run time of
-their job depending on the level. Now, they have to use
-\textbf{Incr/Diff/Full Max Run Time}. \textbf{Incr/Diff/Full Max Wait Time}
-directives are now deprecated.
-
-\subsection{Incremental|Differential Max Wait Time = \lt{}time-period-in-seconds\gt{}}
-\index[general]{Incremental Max Wait Time}
-\index[general]{Differential Max Wait Time}
-
-These directives have been deprecated in favor of
-\texttt{Incremental|Differential Max Run Time}.
-
-\subsection{Max Run Time directives}
-\index[general]{Max Run Time directives}
-Using \textbf{Full/Diff/Incr Max Run Time}, it's now possible to specify the
-maximum allowed time that a job can run depending on the level.
-
-\addcontentsline{lof}{figure}{Job time control directives}
-\includegraphics{\idir different_time.eps}
-
-\subsection{Statistics Enhancements}
-\index[general]{Statistics Enhancements}
-If you (or probably your boss) want to have statistics on your backups to
-provide some \textit{Service Level Agreement} indicators, you could use a few
-SQL queries on the Job table to report how many:
-
-\begin{itemize}
-\item jobs have run
-\item jobs have been successful
-\item files have been backed up
-\item ...
-\end{itemize}
-
-However, these statistics are accurate only if your job retention is greater
-than your statistics period. Ie, if jobs are purged from the catalog, you won't
-be able to use them.
-
-Now, you can use the \textbf{update stats [days=num]} console command to fill
-the JobHistory table with new Job records. If you want to be sure to take in
-account only \textbf{good jobs}, ie if one of your important job has failed but
-you have fixed the problem and restarted it on time, you probably want to
-delete the first \textit{bad} job record and keep only the successful one. For
-that simply let your staff do the job, and update JobHistory table after two or
-three days depending on your organization using the \textbf{[days=num]} option.
-
-These statistics records aren't used for restoring, but mainly for
-capacity planning, billings, etc.
-
-The Bweb interface provides a statistics module that can use this feature. You
-can also use tools like Talend or extract information by yourself.
-
-The \textbf{Statistics Retention = \lt{}time\gt{}} director directive defines
-the length of time that Bacula will keep statistics job records in the Catalog
-database after the Job End time. (In \texttt{JobHistory} table) When this time
-period expires, and if user runs \texttt{prune stats} command, Bacula will
-prune (remove) Job records that are older than the specified period.
-
-You can use the following Job resource in your nightly \textbf{BackupCatalog}
-job to maintain statistics.
-\begin{verbatim}
-Job {
- Name = BackupCatalog
- ...
- RunScript {
- Console = "update stats days=3"
- Console = "prune stats yes"
- RunsWhen = After
- RunsOnClient = no
- }
-}
-\end{verbatim}
-
-\subsection{ScratchPool = \lt{}pool-resource-name\gt{}}
-\index[general]{ScratchPool}
-This directive permits to specify a specific \textsl{Scratch} pool for the
-current pool. This is useful when using multiple storage sharing the same
-mediatype or when you want to dedicate volumes to a particular set of pool.
-
-\subsection{Enhanced Attribute Despooling}
-\index[general]{Attribute Despooling}
-If the storage daemon and the Director are on the same machine, the spool file
-that contains attributes is read directly by the Director instead of being
-transmitted across the network. That should reduce load and speedup insertion.
-
-\subsection{SpoolSize = \lt{}size-specification-in-bytes\gt{}}
-\index[general]{SpoolSize}
-A new Job directive permits to specify the spool size per job. This is used
-in advanced job tunning. {\bf SpoolSize={\it bytes}}
-
-\subsection{MaxConsoleConnections = \lt{}number\gt{}}
-\index[general]{MaxConsoleConnections}
-A new director directive permits to specify the maximum number of Console
-Connections that could run concurrently. The default is set to 20, but you may
-set it to a larger number.
-
-\subsection{VerId = \lt{}string\gt{}}
-\index[general]{VerId}
-A new director directive permits to specify a personnal identifier that will be
-displayed in the \texttt{version} command.
-
-\subsection{dbcheck enhancements}
-\index[general]{dbcheck enhancements}
-If you are using Mysql, dbcheck will now ask you if you want to create
-temporary indexes to speed up orphaned Path and Filename elimination.
-
-A new \texttt{-B} option allows you to print catalog information in a simple
-text based format. This is useful to backup it in a secure way.
-
-\begin{verbatim}
- $ dbcheck -B
- catalog=MyCatalog
- db_type=SQLite
- db_name=regress
- db_driver=
- db_user=regress
- db_password=
- db_address=
- db_port=0
- db_socket=
-\end{verbatim} %$
-
-You can now specify the database connection port in the command line.
-
-\subsection{{-}{-}docdir configure option}
-\index[general]{{-}{-}docdir configure option}
-You can use {-}{-}docdir= on the ./configure command to
-specify the directory where you want Bacula to install the
-LICENSE, ReleaseNotes, ChangeLog, ... files. The default is
-{\bf /usr/share/doc/bacula}.
-
-\subsection{{-}{-}htmldir configure option}
-\index[general]{{-}{-}htmldir configure option}
-You can use {-}{-}htmldir= on the ./configure command to
-specify the directory where you want Bacula to install the bat html help
-files. The default is {\bf /usr/share/doc/bacula/html}
-
-\subsection{{-}{-}with-plugindir configure option}
-\index[general]{{-}{-}plugindir configure option}
-You can use {-}{-}plugindir= on the ./configure command to
-specify the directory where you want Bacula to install
-the plugins (currently only bpipe-fd). The default is
-/usr/lib.
+++ /dev/null
-%%
-%%
-
-\chapter{Automated Disk Backup}
-\label{PoolsChapter}
-\index[general]{Volumes!Using Pools to Manage}
-\index[general]{Disk!Automated Backup}
-\index[general]{Using Pools to Manage Volumes}
-\index[general]{Automated Disk Backup}
-
-If you manage five or ten machines and have a nice tape backup, you don't need
-Pools, and you may wonder what they are good for. In this chapter, you will
-see that Pools can help you optimize disk storage space. The same techniques
-can be applied to a shop that has multiple tape drives, or that wants to mount
-various different Volumes to meet their needs.
-
-The rest of this chapter will give an example involving backup to disk
-Volumes, but most of the information applies equally well to tape Volumes.
-
-\label{TheProblem}
-\section{The Problem}
-\index[general]{Problem}
-
-A site that I administer (a charitable organization) had a tape DDS-3 tape
-drive that was failing. The exact reason for the failure is still unknown.
-Worse yet, their full backup size is about 15GB whereas the capacity of their
-broken DDS-3 was at best 8GB (rated 6/12). A new DDS-4 tape drive and the
-necessary cassettes was more expensive than their budget could handle.
-
-\label{TheSolution}
-\section{The Solution}
-\index[general]{Solution}
-
-They want to maintain six months of backup data, and be able to access the old
-files on a daily basis for a week, a weekly basis for a month, then monthly
-for six months. In addition, offsite capability was not needed (well perhaps
-it really is, but it was never used). Their daily changes amount to about
-300MB on the average, or about 2GB per week.
-
-As a consequence, the total volume of data they need to keep to meet their
-needs is about 100GB (15GB x 6 + 2GB x 5 + 0.3 x 7) = 102.1GB.
-
-The chosen solution was to buy a 120GB hard disk for next to nothing -- far
-less than 1/10th the price of a tape drive and the cassettes to handle the
-same amount of data, and to have Bacula write to disk files.
-
-The rest of this chapter will explain how to setup Bacula so that it would
-automatically manage a set of disk files with the minimum sysadmin
-intervention. The system has been running since 22 January 2004 until today
-(23 June 2007) with no intervention, with the exception of adding
-a second 120GB hard disk after a year because their needs grew
-over that time to more than the 120GB (168GB to be exact). The only other
-intervention I have made is a periodic (about once a year) Bacula upgrade.
-
-\label{OverallDesign}
-\section{Overall Design}
-\index[general]{Overall Design}
-\index[general]{Design!Overall}
-
-Getting Bacula to write to disk rather than tape in the simplest case is
-rather easy, and is documented in the previous chapter. In addition, all the
-directives discussed here are explained in that chapter. We'll leave it to you
-to look at the details there. If you haven't read it and are not familiar with
-Pools, you probably should at least read it once quickly for the ideas before
-continuing here.
-
-One needs to consider about what happens if we have only a single large Bacula
-Volume defined on our hard disk. Everything works fine until the Volume fills,
-then Bacula will ask you to mount a new Volume. This same problem applies to
-the use of tape Volumes if your tape fills. Being a hard disk and the only one
-you have, this will be a bit of a problem. It should be obvious that it is
-better to use a number of smaller Volumes and arrange for Bacula to
-automatically recycle them so that the disk storage space can be reused. The
-other problem with a single Volume, is that until version 2.0.0,
-Bacula did not seek within a disk Volume, so restoring a single file can take
-more time than one would expect.
-
-As mentioned, the solution is to have multiple Volumes, or files on the disk.
-To do so, we need to limit the use and thus the size of a single Volume, by
-time, by number of jobs, or by size. Any of these would work, but we chose to
-limit the use of a single Volume by putting a single job in each Volume with
-the exception of Volumes containing Incremental backup where there will be 6
-jobs (a week's worth of data) per volume. The details of this will be
-discussed shortly. This is a single client backup, so if you have multiple
-clients you will need to multiply those numbers by the number of clients,
-or use a different system for switching volumes, such as limiting the
-volume size.
-
-The next problem to resolve is recycling of Volumes. As you noted from above,
-the requirements are to be able to restore monthly for 6 months, weekly for a
-month, and daily for a week. So to simplify things, why not do a Full save
-once a month, a Differential save once a week, and Incremental saves daily.
-Now since each of these different kinds of saves needs to remain valid for
-differing periods, the simplest way to do this (and possibly the only) is to
-have a separate Pool for each backup type.
-
-The decision was to use three Pools: one for Full saves, one for Differential
-saves, and one for Incremental saves, and each would have a different number
-of volumes and a different Retention period to accomplish the requirements.
-
-\label{FullPool}
-\subsection{Full Pool}
-\index[general]{Pool!Full}
-\index[general]{Full Pool}
-
-Putting a single Full backup on each Volume, will require six Full save
-Volumes, and a retention period of six months. The Pool needed to do that is:
-
-\footnotesize
-\begin{verbatim}
-Pool {
- Name = Full-Pool
- Pool Type = Backup
- Recycle = yes
- AutoPrune = yes
- Volume Retention = 6 months
- Maximum Volume Jobs = 1
- Label Format = Full-
- Maximum Volumes = 9
-}
-\end{verbatim}
-\normalsize
-
-Since these are disk Volumes, no space is lost by having separate Volumes for
-each backup (done once a month in this case). The items to note are the
-retention period of six months (i.e. they are recycled after six months), that
-there is one job per volume (Maximum Volume Jobs = 1), the volumes will be
-labeled Full-0001, ... Full-0006 automatically. One could have labeled these
-manually from the start, but why not use the features of Bacula.
-
-Six months after the first volume is used, it will be subject to pruning
-and thus recycling, so with a maximum of 9 volumes, there should always be
-3 volumes available (note, they may all be marked used, but they will be
-marked purged and recycled as needed).
-
-If you have two clients, you would want to set {\bf Maximum Volume Jobs} to
-2 instead of one, or set a limit on the size of the Volumes, and possibly
-increase the maximum number of Volumes.
-
-
-\label{DiffPool}
-\subsection{Differential Pool}
-\index[general]{Pool!Differential}
-\index[general]{Differential Pool}
-
-For the Differential backup Pool, we choose a retention period of a bit longer
-than a month and ensure that there is at least one Volume for each of the
-maximum of five weeks in a month. So the following works:
-
-\footnotesize
-\begin{verbatim}
-Pool {
- Name = Diff-Pool
- Pool Type = Backup
- Recycle = yes
- AutoPrune = yes
- Volume Retention = 40 days
- Maximum Volume Jobs = 1
- Label Format = Diff-
- Maximum Volumes = 10
-}
-\end{verbatim}
-\normalsize
-
-As you can see, the Differential Pool can grow to a maximum of 9 volumes,
-and the Volumes are retained 40 days and thereafter they can be recycled. Finally
-there is one job per volume. This, of course, could be tightened up a lot, but
-the expense here is a few GB which is not too serious.
-
-If a new volume is used every week, after 40 days, one will have used 7
-volumes, and there should then always be 3 volumes that can be purged and
-recycled.
-
-See the discussion above concering the Full pool for how to handle multiple
-clients.
-
-\label{IncPool}
-\subsection{Incremental Pool}
-\index[general]{Incremental Pool}
-\index[general]{Pool!Incremental}
-
-Finally, here is the resource for the Incremental Pool:
-
-\footnotesize
-\begin{verbatim}
-Pool {
- Name = Inc-Pool
- Pool Type = Backup
- Recycle = yes
- AutoPrune = yes
- Volume Retention = 20 days
- Maximum Volume Jobs = 6
- Label Format = Inc-
- Maximum Volumes = 7
-}
-\end{verbatim}
-\normalsize
-
-We keep the data for 20 days rather than just a week as the needs require. To
-reduce the proliferation of volume names, we keep a week's worth of data (6
-incremental backups) in each Volume. In practice, the retention period should
-be set to just a bit more than a week and keep only two or three volumes
-instead of five. Again, the lost is very little and as the system reaches the
-full steady state, we can adjust these values so that the total disk usage
-doesn't exceed the disk capacity.
-
-If you have two clients, the simplest thing to do is to increase the
-maximum volume jobs from 6 to 12. As mentioned above, it is also possible
-limit the size of the volumes. However, in that case, you will need to
-have a better idea of the volume or add sufficient volumes to the pool so
-that you will be assured that in the next cycle (after 20 days) there is
-at least one volume that is pruned and can be recycled.
-
-
-\label{Example}
-\section{The Actual Conf Files}
-\index[general]{Files!Actual Conf}
-\index[general]{Actual Conf Files}
-
-The following example shows you the actual files used, with only a few minor
-modifications to simplify things.
-
-The Director's configuration file is as follows:
-
-\footnotesize
-\begin{verbatim}
-Director { # define myself
- Name = bacula-dir
- DIRport = 9101
- QueryFile = "/home/bacula/bin/query.sql"
- WorkingDirectory = "/home/bacula/working"
- PidDirectory = "/home/bacula/working"
- Maximum Concurrent Jobs = 1
- Password = " *** CHANGE ME ***"
- Messages = Standard
-}
-# By default, this job will back up to disk in /tmp
-Job {
- Name = client
- Type = Backup
- Client = client-fd
- FileSet = "Full Set"
- Schedule = "WeeklyCycle"
- Storage = File
- Messages = Standard
- Pool = Default
- Full Backup Pool = Full-Pool
- Incremental Backup Pool = Inc-Pool
- Differential Backup Pool = Diff-Pool
- Write Bootstrap = "/home/bacula/working/client.bsr"
- Priority = 10
-}
-
-# Backup the catalog database (after the nightly save)
-Job {
- Name = "BackupCatalog"
- Type = Backup
- Client = client-fd
- FileSet="Catalog"
- Schedule = "WeeklyCycleAfterBackup"
- Storage = File
- Messages = Standard
- Pool = Default
- # This creates an ASCII copy of the catalog
- # WARNING!!! Passing the password via the command line is insecure.
- # see comments in make_catalog_backup for details.
- RunBeforeJob = "/home/bacula/bin/make_catalog_backup bacula bacula"
- # This deletes the copy of the catalog
- RunAfterJob = "/home/bacula/bin/delete_catalog_backup"
- Write Bootstrap = "/home/bacula/working/BackupCatalog.bsr"
- Priority = 11 # run after main backup
-}
-
-# Standard Restore template, to be changed by Console program
-Job {
- Name = "RestoreFiles"
- Type = Restore
- Client = havana-fd
- FileSet="Full Set"
- Storage = File
- Messages = Standard
- Pool = Default
- Where = /tmp/bacula-restores
-}
-
-
-
-# List of files to be backed up
-FileSet {
- Name = "Full Set"
- Include = { Options { signature=SHA1; compression=GZIP9 }
- File = /
- File = /usr
- File = /home
- File = /boot
- File = /var
- File = /opt
- }
- Exclude = {
- File = /proc
- File = /tmp
- File = /.journal
- File = /.fsck
- ...
- }
-}
-Schedule {
- Name = "WeeklyCycle"
- Run = Level=Full 1st sun at 2:05
- Run = Level=Differential 2nd-5th sun at 2:05
- Run = Level=Incremental mon-sat at 2:05
-}
-
-# This schedule does the catalog. It starts after the WeeklyCycle
-Schedule {
- Name = "WeeklyCycleAfterBackup"
- Run = Level=Full sun-sat at 2:10
-}
-
-# This is the backup of the catalog
-FileSet {
- Name = "Catalog"
- Include { Options { signature=MD5 }
- File = /home/bacula/working/bacula.sql
- }
-}
-
-Client {
- Name = client-fd
- Address = client
- FDPort = 9102
- Catalog = MyCatalog
- Password = " *** CHANGE ME ***"
- AutoPrune = yes # Prune expired Jobs/Files
- Job Retention = 6 months
- File Retention = 60 days
-}
-
-Storage {
- Name = File
- Address = localhost
- SDPort = 9103
- Password = " *** CHANGE ME ***"
- Device = FileStorage
- Media Type = File
-}
-
-Catalog {
- Name = MyCatalog
- dbname = bacula; user = bacula; password = ""
-}
-
-Pool {
- Name = Full-Pool
- Pool Type = Backup
- Recycle = yes # automatically recycle Volumes
- AutoPrune = yes # Prune expired volumes
- Volume Retention = 6 months
- Maximum Volume Jobs = 1
- Label Format = Full-
- Maximum Volumes = 9
-}
-
-Pool {
- Name = Inc-Pool
- Pool Type = Backup
- Recycle = yes # automatically recycle Volumes
- AutoPrune = yes # Prune expired volumes
- Volume Retention = 20 days
- Maximum Volume Jobs = 6
- Label Format = Inc-
- Maximum Volumes = 7
-}
-
-Pool {
- Name = Diff-Pool
- Pool Type = Backup
- Recycle = yes
- AutoPrune = yes
- Volume Retention = 40 days
- Maximum Volume Jobs = 1
- Label Format = Diff-
- Maximum Volumes = 10
-}
-
-Messages {
- Name = Standard
- mailcommand = "bsmtp -h mail.domain.com -f \"\(Bacula\) %r\"
- -s \"Bacula: %t %e of %c %l\" %r"
- operatorcommand = "bsmtp -h mail.domain.com -f \"\(Bacula\) %r\"
- -s \"Bacula: Intervention needed for %j\" %r"
- mail = root@domain.com = all, !skipped
- operator = root@domain.com = mount
- console = all, !skipped, !saved
- append = "/home/bacula/bin/log" = all, !skipped
-}
-\end{verbatim}
-\normalsize
-
-and the Storage daemon's configuration file is:
-
-\footnotesize
-\begin{verbatim}
-Storage { # definition of myself
- Name = bacula-sd
- SDPort = 9103 # Director's port
- WorkingDirectory = "/home/bacula/working"
- Pid Directory = "/home/bacula/working"
-}
-Director {
- Name = bacula-dir
- Password = " *** CHANGE ME ***"
-}
-Device {
- Name = FileStorage
- Media Type = File
- Archive Device = /files/bacula
- LabelMedia = yes; # lets Bacula label unlabeled media
- Random Access = Yes;
- AutomaticMount = yes; # when device opened, read it
- RemovableMedia = no;
- AlwaysOpen = no;
-}
-Messages {
- Name = Standard
- director = bacula-dir = all
-}
-\end{verbatim}
-\normalsize
+++ /dev/null
-%%
-%%
-
-\chapter{Bacula Projects}
-\label{ProjectsChapter}
-\index[general]{Projects!Bacula }
-\index[general]{Bacula Projects }
-
-Once a new major version of Bacula is released, the Bacula
-users will vote on a list of new features. This vote is used
-as the main element determining what new features will be
-implemented for the next version. Generally, the development time
-for a new release is between four to nine months. Sometimes it may be
-a bit longer, but in that case, there will be a number of bug fix
-updates to the currently released version.
-
-For the current list of project, please see the projects page in the CVS
-at: \elink{http://cvs.sourceforge.net/viewcvs.py/*checkout*/bacula/bacula/projects}
-{http://cvs.sourceforge.net/viewcvs.py/*checkout*/bacula/bacula/projects}
-see the {\bf projects} file in the main source directory. The projects
-file is updated approximately once every six months.
-
-Separately from the project list, Kern maintains a current list of
-tasks as well as ideas, feature requests, and occasionally design
-notes. This list is updated roughly weekly (sometimes more often).
-For a current list of tasks you can see {\bf kernstodo} in the Source Forge
-CVS at \elink{http://cvs.sourceforge.net/viewcvs.py/*checkout*/bacula/bacula/kernstodo}
-{http://cvs.sourceforge.net/viewcvs.py/*checkout*/bacula/bacula/kernstodo}.
+++ /dev/null
-%%
-%%
-
-\chapter{Python Scripte}
-\label{PythonChapter}
-\index[general]{Python Scripte}
-\index[general]{Scripte!Python}
-
-You may be asking what Python is and why a scripting language is
-needed in Bacula. The answer to the first question is that Python
-is an Object Oriented scripting language with features similar
-to those found in Perl, but the syntax of the language is much
-cleaner and simpler. The answer to why have scripting in Bacula is to
-give the user more control over the whole backup process. Probably
-the simplest example is when Bacula needs a new Volume name, with
-a scripting language such as Python, you can generate any name
-you want, based on the current state of Bacula.
-
-\section{Python Configuration}
-\index[general]{Python Configuration}
-\index[general]{Configuration!Python}
-
-Python must be enabled during the configuration process by adding
-a \verb:--:with-python, and possibly specifying an alternate
-directory if your Python is not installed in a standard system
-location. If you are using RPMs you will need the python-devel package
-installed.
-
-When Python is configured, it becomes an integral part of Bacula and
-runs in Bacula's address space, so even though it is an interpreted
-language, it is very efficient.
-
-When the Director starts, it looks to see if you have a {\bf
-Scripts Directory} Directive defined (normal default {\bf
-/etc/bacula/scripts}, if so, it looks in that directory for a file named
-{\bf DirStartUp.py}. If it is found, Bacula will pass this file to Python
-for execution. The {\bf Scripts Directory} is a new directive that you add
-to the Director resource of your bacula-dir.conf file.
-
-Note: Bacula does not install Python scripts by default because these
-scripts are for you to program. This means that with a default
-installation with Python enabled, Bacula will print the following error
-message:
-
-\begin{verbatim}
-09-Jun 15:14 bacula-dir: ERROR in pythonlib.c:131 Could not import
-Python script /etc/bacula/scripts/DirStartUp. Python disabled.
-\end{verbatim}
-
-The source code directory {\bf examples/python} contains sample scripts
-for DirStartUp.py, SDStartUp.py, and FDStartUp.py that you might want
-to use as a starting point. Normally, your scripts directory (at least
-where you store the Python scripts) should be writable by Bacula, because
-Python will attempt to write a compiled version of the scripts (e.g.
-DirStartUp.pyc) back to that directory.
-
-When starting with the sample scripts, you can delete any part that
-you will not need, but you should keep all the Bacula Event and Job Event
-definitions. If you do not want a particular event, simply replace the
-existing code with a {\bf noop = 1}.
-
-\section{Bacula Events}
-\index[general]{Bacula Events}
-\index[general]{Events}
-A Bacula event is a point in the Bacula code where Bacula
-will call a subroutine (actually a method) that you have
-defined in the Python StartUp script. Events correspond
-to some significant event such as a Job Start, a Job End,
-Bacula needs a new Volume Name, ... When your script is
-called, it will have access to all the Bacula variables
-specific to the Job (attributes of the Job Object), and
-it can even call some of the Job methods (subroutines)
-or set new values in the Job attributes, such as the
-Priority. You will see below how the events are used.
-
-\section{Python Objects}
-\index[general]{Python Objects}
-\index[general]{Objects!Python}
-
-There are four Python objects that you will need to work with:
-\begin{description}
-\item [The Bacula Object]
- The Bacula object is created by the Bacula daemon (the Director
- in the present case) when the daemon starts. It is available to
- the Python startup script, {\bf DirStartup.py}, by importing the
- Bacula definitions with {\bf import bacula}. The methods
- available with this object are described below.
-
-\item [The Bacula Events Class]
- You create this class in the startup script, and you pass
- it to the Bacula Object's {\bf set\_events} method. The
- purpose of the Bacula Events Class is to define what global
- or daemon events you want to monitor. When one of those events
- occurs, your Bacula Events Class will be called at the method
- corresponding to the event. There are currently three events,
- JobStart, JobEnd, and Exit, which are described in detail below.
-
-\item [The Job Object]
- When a Job starts, and assuming you have defined a JobStart method
- in your Bacula Events Class, Bacula will create a Job Object. This
- object will be passed to the JobStart event. The Job Object has a
- has good number of read-only members or attributes providing many
- details of the Job, and it also has a number of writable attributes
- that allow you to pass information into the Job. These attributes
- are described below.
-
-\item [The Job Events Class]
- You create this class in the JobStart method of your Bacula Events
- class, and it allows you to define which of the possible Job Object
- events you want to see. You must pass an instance of your Job Events
- class to the Job Object set\_events() method.
- Normally, you will probably only have one
- Job Events Class, which will be instantiated for each Job. However,
- if you wish to see different events in different Jobs, you may have
- as many Job Events classes as you wish.
-\end{description}
-
-
-The first thing the startup script must do is to define what global Bacula
-events (daemon events), it wants to see. This is done by creating a
-Bacula Events class, instantiating it, then passing it to the
-{\bf set\_events} method. There are three possible
-events.
-
-\begin{description}
-\item [JobStart]
- \index[dir]{JobStart}
- This Python method, if defined, will be called each time a Job is started.
- The method is passed the class instantiation object as the first argument,
- and the Bacula Job object as the second argument. The Bacula Job object
- has several built-in methods, and you can define which ones you
- want called. If you do not define this method, you will not be able
- to interact with Bacula jobs.
-
-\item [JobEnd]
- This Python method, if defined, will be called each time a Job terminates.
- The method is passed the class instantiation object as the first argument,
- and the Bacula Job object as the second argument.
-
-\item [Exit]
- This Python method, if defined, will be called when the Director terminates.
- The method is passed the class instantiation object as the first argument.
-\end{description}
-
-Access to the Bacula variables and methods is done with:
-
- import bacula
-
-The following are the read-only attributes provided by the bacula object.
-\begin{description}
-\item [Name]
-\item [ConfigFile]
-\item [WorkingDir]
-\item [Version] string consisting of "`Version Build-date"'
-\end{description}
-
-
-A simple definition of the Bacula Events Class might be the following:
-
-\footnotesize
-\begin{verbatim}
-import sys, bacula
-class BaculaEvents:
- def JobStart(self, job):
- ...
-\end{verbatim}
-\normalsize
-
-Then to instantiate the class and pass it to Bacula, you
-would do:
-
-\footnotesize
-\begin{verbatim}
-bacula.set_events(BaculaEvents()) # register Bacula Events wanted
-\end{verbatim}
-\normalsize
-
-And at that point, each time a Job is started, your BaculaEvents JobStart
-method will be called.
-
-Now to actually do anything with a Job, you must define which Job events
-you want to see, and this is done by defining a JobEvents class containing
-the methods you want called. Each method name corresponds to one of the
-Job Events that Bacula will generate.
-
-A simple Job Events class might look like the following:
-
-\footnotesize
-\begin{verbatim}
-class JobEvents:
- def NewVolume(self, job):
- ...
-\end{verbatim}
-\normalsize
-
-Here, your JobEvents class method NewVolume will be called each time
-the Job needs a new Volume name. To actually register the events defined
-in your class with the Job, you must instantiate the JobEvents class and
-set it in the Job {\bf set\_events} variable. Note, this is a bit different
-from how you registered the Bacula events. The registration process must
-be done in the Bacula JobStart event (your method). So, you would modify
-Bacula Events (not the Job events) as follows:
-
-\footnotesize
-\begin{verbatim}
-import sys, bacula
-class BaculaEvents:
- def JobStart(self, job):
- events = JobEvents() # create instance of Job class
- job.set_events(events) # register Job events desired
- ...
-\end{verbatim}
-\normalsize
-
-When a job event is triggered, the appropriate event definition is
-called in the JobEvents class. This is the means by which your Python
-script or code gets control. Once it has control, it may read job
-attributes, or set them. See below for a list of read-only attributes,
-and those that are writable.
-
-In addition, the Bacula {\bf job} object in the Director has
-a number of methods (subroutines) that can be called. They
-are:
-\begin{description}
-\item [set\_events] The set\_events method takes a single
- argument, which is the instantiation of the Job Events class
- that contains the methods that you want called. The method
- names that will be called must correspond to the Bacula
- defined events. You may define additional methods but Bacula
- will not use them.
-\item [run] The run method takes a single string
- argument, which is the run command (same as in the Console)
- that you want to submit to start a new Job. The value
- returned by the run method is the JobId of the job that
- started, or -1 if there was an error.
-\item [write] The write method is used to be able to send
- print output to the Job Report. This will be described later.
-\item[cancel] The cancel method takes a single integer argument,
- which is a JobId. If JobId is found, it will be canceled.
-\item [DoesVolumeExist] The DoesVolumeExist method takes a single
- string argument, which is the Volume name, and returns
- 1 if the volume exists in the Catalog and 0 if the volume
- does not exist.
-\end{description}
-
-The following attributes are read/write within the Director
-for the {\bf job} object.
-
-\begin{description}
-\item [Priority] Read or set the Job priority.
- Note, that setting a Job Priority is effective only before
- the Job actually starts.
-\item [Level] This attribute contains a string representing the Job
- level, e.g. Full, Differential, Incremental, ... if read.
- The level can also be set.
-\end{description}
-
-The following read-only attributes are available within the Director
-for the {\bf job} object.
-
-\begin{description}
-\item [Type] This attribute contains a string representing the Job
- type, e.g. Backup, Restore, Verify, ...
-\item [JobId] This attribute contains an integer representing the
- JobId.
-\item [Client] This attribute contains a string with the name of the
- Client for this job.
-\item [NumVols] This attribute contains an integer with the number of
- Volumes in the Pool being used by the Job.
-\item [Pool] This attribute contains a string with the name of the Pool
- being used by the Job.
-\item [Storage] This attribute contains a string with the name of the
- Storage resource being used by the Job.
-\item [Catalog] This attribute contains a string with the name of the
- Catalog resource being used by the Job.
-\item [MediaType] This attribute contains a string with the name of the
- Media Type associated with the Storage resource being used by the Job.
-\item [Job] This attribute contains a string containing the name of the
- Job resource used by this job (not unique).
-\item [JobName] This attribute contains a string representing the full
- unique Job name.
-\item [JobStatus] This attribute contains a single character string
- representing the current Job status. The status may change
- during execution of the job. It may take on the following
- values:
- \begin{description}
- \item [C] Created, not yet running
- \item [R] Running
- \item [B] Blocked
- \item [T] Completed successfully
- \item [E] Terminated with errors
- \item [e] Non-fatal error
- \item [f] Fatal error
- \item [D] Verify found differences
- \item [A] Canceled by user
- \item [F] Waiting for Client
- \item [S] Waiting for Storage daemon
- \item [m] Waiting for new media
- \item [M] Waiting for media mount
- \item [s] Waiting for storage resource
- \item [j] Waiting for job resource
- \item [c] Waiting for client resource
- \item [d] Waiting on maximum jobs
- \item [t] Waiting on start time
- \item [p] Waiting on higher priority jobs
- \end{description}
-
-\item [Priority] This attribute contains an integer with the priority
- assigned to the job.
-\item [CatalogRes] tuple consisting of (DBName, Address, User,
- Password, Socket, Port, Database Vendor) taken from the Catalog resource
- for the Job with the exception of Database Vendor, which is
- one of the following: MySQL, PostgreSQL, SQLite, Internal,
- depending on what database you configured.
-\item [VolumeName]
- After a Volume has been purged, this attribute will contain the
- name of that Volume. At other times, this value may have no meaning.
-\end{description}
-
-The following write-only attributes are available within the
-Director:
-
-\begin{description}
-\item [JobReport] Send line to the Job Report.
-\item [VolumeName] Set a new Volume name. Valid only during the
- NewVolume event.
-\end{description}
-
-\section{Python Console Command}
-\index[general]{Python Console Command}
-\index[general]{Console Command!Python}
-
-There is a new Console command named {\bf python}. It takes
-a single argument {\bf restart}. Example:
-\begin{verbatim}
- python restart
-\end{verbatim}
-
-This command restarts the Python interpreter in the Director.
-This can be useful when you are modifying the DirStartUp script,
-because normally Python will cache it, and thus the
-script will be read one time.
-
-\section{Debugging Python Scripts}
-\index[general]{Debugging Python Scripts}
-In general, you debug your Python scripts by using print statements.
-You can also develop your script or important parts of it as a
-separate file using the Python interpreter to run it. Once you
-have it working correctly, you can then call the script from
-within the Bacula Python script (DirStartUp.py).
-
-If you are having problems loading DirStartUp.py, you will probably
-not get any error messages because Bacula can only print Python
-error messages after the Python interpreter is started. However, you
-may be able to see the error messages by starting Bacula in
-a shell window with the {\bf -d1} option on the command line. That
-should cause the Python error messages to be printed in the shell
-window.
-
-If you are getting error messages such as the following when
-loading DirStartUp.py:
-
-\begin{verbatim}
- Traceback (most recent call last):
- File "/etc/bacula/scripts/DirStartUp.py", line 6, in ?
- import time, sys, bacula
- ImportError: /usr/lib/python2.3/lib-dynload/timemodule.so: undefined
- symbol: PyInt_FromLong
- bacula-dir: pythonlib.c:134 Python Import error.
-\end{verbatim}
-
-It is because the DirStartUp script is calling a dynamically loaded
-module (timemodule.so in the above case) that then tries to use
-Python functions exported from the Python interpreter (in this case
-PyInt\_FromLong). The way Bacula is currently linked with Python does
-not permit this. The solution to the problem is to put such functions
-(in this case the import of time into a separate Python script, which
-will do your calculations and return the values you want. Then call
-(not import) this script from the Bacula DirStartUp.py script, and
-it all should work as you expect.
-
-
-
-
-
-\section{Python Example}
-\index[general]{Python Example}
-\index[general]{Example!Python}
-
-An example script for the Director startup file is provided in
-{\bf examples/python/DirStartup.py} as follows:
-
-\footnotesize
-\begin{verbatim}
-#
-# Bacula Python interface script for the Director
-#
-
-# You must import both sys and bacula
-import sys, bacula
-
-# This is the list of Bacula daemon events that you
-# can receive.
-class BaculaEvents(object):
- def __init__(self):
- # Called here when a new Bacula Events class is
- # is created. Normally not used
- noop = 1
-
- def JobStart(self, job):
- """
- Called here when a new job is started. If you want
- to do anything with the Job, you must register
- events you want to receive.
- """
- events = JobEvents() # create instance of Job class
- events.job = job # save Bacula's job pointer
- job.set_events(events) # register events desired
- sys.stderr = events # send error output to Bacula
- sys.stdout = events # send stdout to Bacula
- jobid = job.JobId; client = job.Client
- numvols = job.NumVols
- job.JobReport="Python Dir JobStart: JobId=%d Client=%s NumVols=%d\n" % (jobid,client,numvols)
-
- # Bacula Job is going to terminate
- def JobEnd(self, job):
- jobid = job.JobId
- client = job.Client
- job.JobReport="Python Dir JobEnd output: JobId=%d Client=%s.\n" % (jobid, client)
-
- # Called here when the Bacula daemon is going to exit
- def Exit(self, job):
- print "Daemon exiting."
-
-bacula.set_events(BaculaEvents()) # register daemon events desired
-
-"""
- These are the Job events that you can receive.
-"""
-class JobEvents(object):
- def __init__(self):
- # Called here when you instantiate the Job. Not
- # normally used
- noop = 1
-
- def JobInit(self, job):
- # Called when the job is first scheduled
- noop = 1
-
- def JobRun(self, job):
- # Called just before running the job after initializing
- # This is the point to change most Job parameters.
- # It is equivalent to the JobRunBefore point.
- noop = 1
-
- def NewVolume(self, job):
- # Called when Bacula wants a new Volume name. The Volume
- # name returned, if any, must be stored in job.VolumeName
- jobid = job.JobId
- client = job.Client
- numvol = job.NumVols;
- print job.CatalogRes
- job.JobReport = "JobId=%d Client=%s NumVols=%d" % (jobid, client, numvol)
- job.JobReport="Python before New Volume set for Job.\n"
- Vol = "TestA-%d" % numvol
- job.JobReport = "Exists=%d TestA-%d" % (job.DoesVolumeExist(Vol), numvol)
- job.VolumeName="TestA-%d" % numvol
- job.JobReport="Python after New Volume set for Job.\n"
- return 1
-
- def VolumePurged(self, job):
- # Called when a Volume is purged. The Volume name can be referenced
- # with job.VolumeName
- noop = 1
-
-
-
-\end{verbatim}
-\normalsize
+++ /dev/null
-%%
-%%
-
-\chapter{automatische Volume Wiederverwendung}
-\label{RecyclingChapter}
-\index[general]{Recycling!Automatic Volume }
-\index[general]{Automatic Volume Recycling }
-
-By default, once Bacula starts writing a Volume, it can append to the
-volume, but it will not overwrite the existing data thus destroying it.
-However when Bacula {\bf recycles} a Volume, the Volume becomes available
-for being reused, and Bacula can at some later time overwrite the previous
-contents of that Volume. Thus all previous data will be lost. If the
-Volume is a tape, the tape will be rewritten from the beginning. If the
-Volume is a disk file, the file will be truncated before being rewritten.
-
-You may not want Bacula to automatically recycle (reuse) tapes. This would
-require a large number of tapes though, and in such a case, it is possible
-to manually recycle tapes. For more on manual recycling, see the section
-entitled \ilink{ Manually Recycling Volumes}{manualrecycling} below in this
-chapter.
-
-Most people prefer to have a Pool of tapes that are used for daily backups and
-recycled once a week, another Pool of tapes that are used for Full backups
-once a week and recycled monthly, and finally a Pool of tapes that are used
-once a month and recycled after a year or two. With a scheme like this, the
-number of tapes in your pool or pools remains constant.
-
-By properly defining your Volume Pools with appropriate Retention periods,
-Bacula can manage the recycling (such as defined above) automatically.
-
-Automatic recycling of Volumes is controlled by four records in the {\bf
-Pool} resource definition in the Director's configuration file. These four
-records are:
-
-\begin{itemize}
-\item AutoPrune = yes
-\item VolumeRetention = \lt{}time\gt{}
-\item Recycle = yes
-\item RecyclePool = \lt{}APool\gt{} (\textit{This require bacula 2.1.4 or greater})
-\end{itemize}
-
-The above three directives are all you need assuming that you fill
-each of your Volumes then wait the Volume Retention period before
-reusing them. If you want Bacula to stop using a Volume and recycle
-it before it is full, you will need to use one or more additional
-directives such as:
-\begin{itemize}
-\item Use Volume Once = yes
-\item Volume Use Duration = ttt
-\item Maximum Volume Jobs = nnn
-\item Maximum Volume Bytes = mmm
-\end{itemize}
-Please see below and
-the \ilink{Basic Volume Management}{DiskChapter} chapter
-of this manual for more complete examples.
-
-Automatic recycling of Volumes is performed by Bacula only when it wants a
-new Volume and no appendable Volumes are available in the Pool. It will then
-search the Pool for any Volumes with the {\bf Recycle} flag set and whose
-Volume Status is {\bf Full}. At that point, the recycling occurs in two steps.
-The first is that the Catalog for a Volume must be purged of all Jobs and
-Files contained on that Volume, and the second step is the actual recycling of
-the Volume. The Volume will be purged if the VolumeRetention period has
-expired. When a Volume is marked as Purged, it means that no Catalog records
-reference that Volume, and the Volume can be recycled. Until recycling
-actually occurs, the Volume data remains intact. If no Volumes can be found
-for recycling for any of the reasons stated above, Bacula will request
-operator intervention (i.e. it will ask you to label a new volume).
-
-A key point mentioned above, that can be a source of frustration, is that Bacula
-will only recycle purged Volumes if there is no other appendable Volume
-available, otherwise, it will always write to an appendable Volume before
-recycling even if there are Volume marked as Purged. This preserves your data
-as long as possible. So, if you wish to "force" Bacula to use a purged
-Volume, you must first ensure that no other Volume in the Pool is marked {\bf
-Append}. If necessary, you can manually set a volume to {\bf Full}. The reason
-for this is that Bacula wants to preserve the data on your old tapes (even
-though purged from the catalog) as long as absolutely possible before
-overwriting it. There are also a number of directives such as
-{\bf Volume Use Duration} that will automatically mark a volume as {\bf
-Used} and thus no longer appendable.
-
-\label{AutoPruning}
-\section{Automatic Pruning}
-\index[general]{Automatic Pruning}
-\index[general]{Pruning!Automatic}
-
-As Bacula writes files to tape, it keeps a list of files, jobs, and volumes
-in a database called the catalog. Among other things, the database helps
-Bacula to decide which files to back up in an incremental or differential
-backup, and helps you locate files on past backups when you want to restore
-something. However, the catalog will grow larger and larger as time goes
-on, and eventually it can become unacceptably large.
-
-Bacula's process for removing entries from the catalog is called Pruning.
-The default is Automatic Pruning, which means that once an entry reaches a
-certain age (e.g. 30 days old) it is removed from the catalog. Once a job
-has been pruned, you can still restore it from the backup tape, but one
-additional step is required: scanning the volume with bscan. The
-alternative to Automatic Pruning is Manual Pruning, in which you explicitly
-tell Bacula to erase the catalog entries for a volume. You'd usually do
-this when you want to reuse a Bacula volume, because there's no point in
-keeping a list of files that USED TO BE on a tape. Or, if the catalog is
-starting to get too big, you could prune the oldest jobs to save space.
-Manual pruning is done with the \ilink{ prune command}{ManualPruning} in
-the console. (thanks to Bryce Denney for the above explanation).
-
-\section{Pruning Directives}
-\index[general]{Pruning Directives }
-\index[general]{Directives!Pruning }
-
-There are three pruning durations. All apply to catalog database records and
-not to the actual data in a Volume. The pruning (or retention) durations are
-for: Volumes (Media records), Jobs (Job records), and Files (File records).
-The durations inter-depend a bit because if Bacula prunes a Volume, it
-automatically removes all the Job records, and all the File records. Also when
-a Job record is pruned, all the File records for that Job are also pruned
-(deleted) from the catalog.
-
-Having the File records in the database means that you can examine all the
-files backed up for a particular Job. They take the most space in the catalog
-(probably 90-95\% of the total). When the File records are pruned, the Job
-records can remain, and you can still examine what Jobs ran, but not the
-details of the Files backed up. In addition, without the File records, you
-cannot use the Console restore command to restore the files.
-
-When a Job record is pruned, the Volume (Media record) for that Job can still
-remain in the database, and if you do a "`list volumes"', you will see the
-volume information, but the Job records (and its File records) will no longer
-be available.
-
-In each case, pruning removes information about where older files are, but it
-also prevents the catalog from growing to be too large. You choose the
-retention periods in function of how many files you are backing up and the
-time periods you want to keep those records online, and the size of the
-database. You can always re-insert the records (with 98\% of the original data)
-by using "`bscan"' to scan in a whole Volume or any part of the volume that
-you want.
-
-By setting {\bf AutoPrune} to {\bf yes} you will permit {\bf Bacula} to
-automatically prune all Volumes in the Pool when a Job needs another Volume.
-Volume pruning means removing records from the catalog. It does not shrink the
-size of the Volume or affect the Volume data until the Volume gets
-overwritten. When a Job requests another volume and there are no Volumes with
-Volume Status {\bf Append} available, Bacula will begin volume pruning. This
-means that all Jobs that are older than the {\bf VolumeRetention} period will
-be pruned from every Volume that has Volume Status {\bf Full} or {\bf Used}
-and has Recycle set to {\bf yes}. Pruning consists of deleting the
-corresponding Job, File, and JobMedia records from the catalog database. No
-change to the physical data on the Volume occurs during the pruning process.
-When all files are pruned from a Volume (i.e. no records in the catalog), the
-Volume will be marked as {\bf Purged} implying that no Jobs remain on the
-volume. The Pool records that control the pruning are described below.
-
-\begin{description}
-
-\item [AutoPrune = \lt{}yes|no\gt{}]
- \index[console]{AutoPrune }
- If AutoPrune is set to {\bf yes} (default), Bacula
- will automatically apply the Volume retention period when running a Job and
- it needs a new Volume but no appendable volumes are available. At that point,
- Bacula will prune all Volumes that can be pruned (i.e. AutoPrune set) in an
- attempt to find a usable volume. If during the autoprune, all files are
- pruned from the Volume, it will be marked with VolStatus {\bf Purged}. The
- default is {\bf yes}. Note, that although the File and Job records may be
- pruned from the catalog, a Volume will be marked Purged (and hence
- ready for recycling) if the Volume status is Append, Full, Used, or Error.
- If the Volume has another status, such as Archive, Read-Only, Disabled,
- Busy, or Cleaning, the Volume status will not be changed to Purged.
-
-\item [Volume Retention = \lt{}time-period-specification\gt{}]
- \index[console]{Volume Retention}
- The Volume Retention record defines the length of time that Bacula will
- guarantee that the Volume is not reused counting from the time the last
- job stored on the Volume terminated. A key point is that this time
- period is not even considered as long at the Volume remains appendable.
- The Volume Retention period count down begins only when the Append
- status has been changed to some othe status (Full, Used, Purged, ...).
-
- When this time period expires, and if {\bf AutoPrune} is set to {\bf
- yes}, and a new Volume is needed, but no appendable Volume is available,
- Bacula will prune (remove) Job records that are older than the specified
- Volume Retention period.
-
- The Volume Retention period takes precedence over any Job Retention
- period you have specified in the Client resource. It should also be
- noted, that the Volume Retention period is obtained by reading the
- Catalog Database Media record rather than the Pool resource record.
- This means that if you change the VolumeRetention in the Pool resource
- record, you must ensure that the corresponding change is made in the
- catalog by using the {\bf update pool} command. Doing so will insure
- that any new Volumes will be created with the changed Volume Retention
- period. Any existing Volumes will have their own copy of the Volume
- Retention period that can only be changed on a Volume by Volume basis
- using the {\bf update volume} command.
-
- When all file catalog entries are removed from the volume, its VolStatus is
- set to {\bf Purged}. The files remain physically on the Volume until the
- volume is overwritten.
-
- Retention periods are specified in seconds, minutes, hours, days, weeks,
- months, quarters, or years on the record. See the
- \ilink{Configuration chapter}{Time} of this manual for
- additional details of time specification.
-
-The default is 1 year.
-% TODO: if that is the format, should it be in quotes? decide on a style
-
-\item [Recycle = \lt{}yes|no\gt{}]
- \index[fd]{Recycle }
- This statement tells Bacula whether or not the particular Volume can be
- recycled (i.e. rewritten). If Recycle is set to {\bf no} (the
- default), then even if Bacula prunes all the Jobs on the volume and it
- is marked {\bf Purged}, it will not consider the tape for recycling. If
- Recycle is set to {\bf yes} and all Jobs have been pruned, the volume
- status will be set to {\bf Purged} and the volume may then be reused
- when another volume is needed. If the volume is reused, it is relabeled
- with the same Volume Name, however all previous data will be lost.
- \end{description}
-
- It is also possible to "force" pruning of all Volumes in the Pool
- associated with a Job by adding {\bf Prune Files = yes} to the Job resource.
-
-\label{Recycling}
-\label{RecyclingAlgorithm}
-\section{Recycling Algorithm}
-\index[general]{Algorithm!Recycling }
-\index[general]{Recycling Algorithm }
-
-After all Volumes of a Pool have been pruned (as mentioned above, this happens
-when a Job needs a new Volume and no appendable Volumes are available), Bacula
-will look for the oldest Volume that is Purged (all Jobs and Files expired),
-and if the {\bf Recycle} flag is on (Recycle=yes) for that Volume, Bacula will
-relabel it and write new data on it.
-
-As mentioned above, there are two key points for getting a Volume
-to be recycled. First, the Volume must no longer be marked Append (there
-are a number of directives to automatically make this change), and second
-since the last write on the Volume, one or more of the Retention periods
-must have expired so that there are no more catalog backup job records
-that reference that Volume. Once both those conditions are satisfied,
-the volume can be marked Purged and hence recycled.
-
-The full algorithm that Bacula uses when it needs a new Volume is:
-\index[general]{New Volume Algorithm}
-\index[general]{Algorithm!New Volume}
-
-The algorithm described below assumes that AutoPrune is enabled,
-that Recycling is turned on, and that you have defined
-appropriate Retention periods, or used the defaults for all these
-items.
-
-\begin{itemize}
-\item If the request is for an Autochanger device, look only
- for Volumes in the Autochanger (i.e. with InChanger set and that have
- the correct Storage device).
-\item Search the Pool for a Volume with VolStatus=Append (if there is more
- than one, the Volume with the oldest date last written is chosen. If
- two have the same date then the one with the lowest MediaId is chosen).
-\item Search the Pool for a Volume with VolStatus=Recycle and the InChanger
- flag is set true (if there is more than one, the Volume with the oldest
- date last written is chosen. If two have the same date then the one
- with the lowest MediaId is chosen).
-\item Try recycling any purged Volumes.
-\item Prune volumes applying Volume retention period (Volumes with VolStatus
- Full, Used, or Append are pruned). Note, even if all the File and Job
- records are pruned from a Volume, the Volume will not be marked Purged
- until the Volume retention period expires.
-\item Search the Pool for a Volume with VolStatus=Purged
-\item If a Pool named "Scratch" exists, search for a Volume and if found
- move it to the current Pool for the Job and use it. Note, when
- the Scratch Volume is moved into the current Pool, the basic
- Pool defaults are applied as if it is a newly labeled Volume
- (equivalent to an {\bf update volume from pool} command).
-\item If we were looking for Volumes in the Autochanger, go back to
- step 2 above, but this time, look for any Volume whether or not
- it is in the Autochanger.
-\item Attempt to create a new Volume if automatic labeling enabled
- If Python is enabled, a Python NewVolume event is generated before
- the Label Format directve is used. If the maximum number of Volumes
- specified for the pool is reached, a new Volume will not be created.
-\item Prune the oldest Volume if RecycleOldestVolume=yes (the Volume with the
- oldest LastWritten date and VolStatus equal to Full, Recycle, Purged, Used,
- or Append is chosen). This record ensures that all retention periods are
- properly respected.
-\item Purge the oldest Volume if PurgeOldestVolume=yes (the Volume with the
- oldest LastWritten date and VolStatus equal to Full, Recycle, Purged, Used,
- or Append is chosen). We strongly recommend against the use of {\bf
- PurgeOldestVolume} as it can quite easily lead to loss of current backup
- data.
-\item Give up and ask operator.
-\end{itemize}
-
-The above occurs when Bacula has finished writing a Volume or when no Volume
-is present in the drive.
-
-On the other hand, if you have inserted a different Volume after the last job,
-and Bacula recognizes the Volume as valid, it will request authorization from
-the Director to use this Volume. In this case, if you have set {\bf Recycle
-Current Volume = yes} and the Volume is marked as Used or Full, Bacula will
-prune the volume and if all jobs were removed during the pruning (respecting
-the retention periods), the Volume will be recycled and used.
-
-The recycling algorithm in this case is:
-\begin{itemize}
-\item If the VolStatus is {\bf Append} or {\bf Recycle}
- is set, the volume will be used.
-\item If {\bf Recycle Current Volume} is set and the volume is marked {\bf
- Full} or {\bf Used}, Bacula will prune the volume (applying the retention
- period). If all Jobs are pruned from the volume, it will be recycled.
-\end{itemize}
-
-This permits users to manually change the Volume every day and load tapes in
-an order different from what is in the catalog, and if the volume does not
-contain a current copy of your backup data, it will be used.
-
-A few points from Alan Brown to keep in mind:
-
-\begin{enumerate}
-\item If a pool doesn't have maximum volumes defined then Bacula will prefer to
- demand new volumes over forcibly purging older volumes.
-
-\item If volumes become free through pruning and the Volume retention period has
- expired, then they get marked as "purged" and are immediately available for
- recycling - these will be used in preference to creating new volumes.
-
-\item If the Job, File, and Volume retention periods are different, then
- it's common to see a tape with no files or jobs listed in the database,
- but which is still not marked as "`purged"'.
-\end{enumerate}
-
-
-\section{Recycle Status}
-\index[general]{Status!Recycle }
-\index[general]{Recycle Status }
-
-Each Volume inherits the Recycle status (yes or no) from the Pool resource
-record when the Media record is created (normally when the Volume is labeled).
-This Recycle status is stored in the Media record of the Catalog. Using
-the Console program, you may subsequently change the Recycle status for each
-Volume. For example in the following output from {\bf list volumes}:
-
-\footnotesize
-\begin{verbatim}
-+----------+-------+--------+---------+------------+--------+-----+
-| VolumeNa | Media | VolSta | VolByte | LastWritte | VolRet | Rec |
-+----------+-------+--------+---------+------------+--------+-----+
-| File0001 | File | Full | 4190055 | 2002-05-25 | 14400 | 1 |
-| File0002 | File | Full | 1896460 | 2002-05-26 | 14400 | 1 |
-| File0003 | File | Full | 1896460 | 2002-05-26 | 14400 | 1 |
-| File0004 | File | Full | 1896460 | 2002-05-26 | 14400 | 1 |
-| File0005 | File | Full | 1896460 | 2002-05-26 | 14400 | 1 |
-| File0006 | File | Full | 1896460 | 2002-05-26 | 14400 | 1 |
-| File0007 | File | Purged | 1896466 | 2002-05-26 | 14400 | 1 |
-+----------+-------+--------+---------+------------+--------+-----+
-\end{verbatim}
-\normalsize
-
-all the volumes are marked as recyclable, and the last Volume, {\bf File0007}
-has been purged, so it may be immediately recycled. The other volumes are all
-marked recyclable and when their Volume Retention period (14400 seconds or four
-hours) expires, they will be eligible for pruning, and possibly recycling.
-Even though Volume {\bf File0007} has been purged, all the data on the Volume
-is still recoverable. A purged Volume simply means that there are no entries
-in the Catalog. Even if the Volume Status is changed to {\bf Recycle}, the
-data on the Volume will be recoverable. The data is lost only when the Volume
-is re-labeled and re-written.
-
-To modify Volume {\bf File0001} so that it cannot be recycled, you use the
-{\bf update volume pool=File} command in the console program, or simply {\bf
-update} and Bacula will prompt you for the information.
-
-\footnotesize
-\begin{verbatim}
-+----------+------+-------+---------+-------------+-------+-----+
-| VolumeNa | Media| VolSta| VolByte | LastWritten | VolRet| Rec |
-+----------+------+-------+---------+-------------+-------+-----+
-| File0001 | File | Full | 4190055 | 2002-05-25 | 14400 | 0 |
-| File0002 | File | Full | 1897236 | 2002-05-26 | 14400 | 1 |
-| File0003 | File | Full | 1896460 | 2002-05-26 | 14400 | 1 |
-| File0004 | File | Full | 1896460 | 2002-05-26 | 14400 | 1 |
-| File0005 | File | Full | 1896460 | 2002-05-26 | 14400 | 1 |
-| File0006 | File | Full | 1896460 | 2002-05-26 | 14400 | 1 |
-| File0007 | File | Purged| 1896466 | 2002-05-26 | 14400 | 1 |
-+----------+------+-------+---------+-------------+-------+-----+
-\end{verbatim}
-\normalsize
-
-In this case, {\bf File0001} will never be automatically recycled. The same
-effect can be achieved by setting the Volume Status to Read-Only.
-
-As you have noted, the Volume Status (VolStatus) column in the
-catalog database contains the current status of the Volume, which
-is normally maintained automatically by Bacula. To give you an
-idea of some of the values it can take during the life cycle of
-a Volume, here is a picture created by Arno Lehmann:
-
-\footnotesize
-\begin{verbatim}
-A typical volume life cycle is like this:
-
- because job count or size limit exceeded
- Append ----------------------------------------> Used
- ^ |
- | First Job writes to Retention time passed |
- | the volume and recycling takes |
- | place |
- | v
- Recycled <-------------------------------------- Purged
- Volume is selected for reuse
-
-\end{verbatim}
-\normalsize
-
-
-\section{Making Bacula Use a Single Tape}
-\label{singletape}
-\index[general]{Tape!Making Bacula Use a Single}
-\index[general]{Making Bacula Use a Single Tape}
-
-Most people will want Bacula to fill a tape and when it is full, a new tape
-will be mounted, and so on. However, as an extreme example, it is possible for
-Bacula to write on a single tape, and every night to rewrite it. To get this
-to work, you must do two things: first, set the VolumeRetention to less than
-your save period (one day), and the second item is to make Bacula mark the
-tape as full after using it once. This is done using {\bf UseVolumeOnce =
-yes}. If this latter record is not used and the tape is not full after the
-first time it is written, Bacula will simply append to the tape and eventually
-request another volume. Using the tape only once, forces the tape to be marked
-{\bf Full} after each use, and the next time {\bf Bacula} runs, it will
-recycle the tape.
-
-An example Pool resource that does this is:
-
-\footnotesize
-\begin{verbatim}
-Pool {
- Name = DDS-4
- Use Volume Once = yes
- Pool Type = Backup
- AutoPrune = yes
- VolumeRetention = 12h # expire after 12 hours
- Recycle = yes
-}
-\end{verbatim}
-\normalsize
-
-\section{Daily, Weekly, Monthly Tape Usage Example}
-\label{usageexample}
-\index[general]{Daily, Weekly, Monthly Tape Usage Example }
-\index[general]{Example!Daily Weekly Monthly Tape Usage }
-
-This example is meant to show you how one could define a fixed set of volumes
-that Bacula will rotate through on a regular schedule. There are an infinite
-number of such schemes, all of which have various advantages and
-disadvantages.
-
-We start with the following assumptions:
-
-\begin{itemize}
-\item A single tape has more than enough capacity to do a full save.
-\item There are ten tapes that are used on a daily basis for incremental
- backups. They are prelabeled Daily1 ... Daily10.
-\item There are four tapes that are used on a weekly basis for full backups.
- They are labeled Week1 ... Week4.
-\item There are 12 tapes that are used on a monthly basis for full backups.
- They are numbered Month1 ... Month12
-\item A full backup is done every Saturday evening (tape inserted Friday
- evening before leaving work).
-\item No backups are done over the weekend (this is easy to change).
-\item The first Friday of each month, a Monthly tape is used for the Full
- backup.
-\item Incremental backups are done Monday - Friday (actually Tue-Fri
- mornings).
-% TODO: why this "actually"? does this need to be explained?
- \end{itemize}
-
-We start the system by doing a Full save to one of the weekly volumes or one
-of the monthly volumes. The next morning, we remove the tape and insert a
-Daily tape. Friday evening, we remove the Daily tape and insert the next tape
-in the Weekly series. Monday, we remove the Weekly tape and re-insert the
-Daily tape. On the first Friday of the next month, we insert the next Monthly
-tape in the series rather than a Weekly tape, then continue. When a Daily tape
-finally fills up, {\bf Bacula} will request the next one in the series, and
-the next day when you notice the email message, you will mount it and {\bf
-Bacula} will finish the unfinished incremental backup.
-
-What does this give? Well, at any point, you will have the last complete
-Full save plus several Incremental saves. For any given file you want to
-recover (or your whole system), you will have a copy of that file every day
-for at least the last 14 days. For older versions, you will have at least three
-and probably four Friday full saves of that file, and going back further, you
-will have a copy of that file made on the beginning of the month for at least
-a year.
-
-So you have copies of any file (or your whole system) for at least a year, but
-as you go back in time, the time between copies increases from daily to weekly
-to monthly.
-
-What would the Bacula configuration look like to implement such a scheme?
-
-\footnotesize
-\begin{verbatim}
-Schedule {
- Name = "NightlySave"
- Run = Level=Full Pool=Monthly 1st sat at 03:05
- Run = Level=Full Pool=Weekly 2nd-5th sat at 03:05
- Run = Level=Incremental Pool=Daily tue-fri at 03:05
-}
-Job {
- Name = "NightlySave"
- Type = Backup
- Level = Full
- Client = LocalMachine
- FileSet = "File Set"
- Messages = Standard
- Storage = DDS-4
- Pool = Daily
- Schedule = "NightlySave"
-}
-# Definition of file storage device
-Storage {
- Name = DDS-4
- Address = localhost
- SDPort = 9103
- Password = XXXXXXXXXXXXX
- Device = FileStorage
- Media Type = 8mm
-}
-FileSet {
- Name = "File Set"
- Include = signature=MD5 {
- fffffffffffffffff
- }
- Exclude = { *.o }
-}
-Pool {
- Name = Daily
- Pool Type = Backup
- AutoPrune = yes
- VolumeRetention = 10d # recycle in 10 days
- Maximum Volumes = 10
- Recycle = yes
-}
-Pool {
- Name = Weekly
- Use Volume Once = yes
- Pool Type = Backup
- AutoPrune = yes
- VolumeRetention = 30d # recycle in 30 days (default)
- Recycle = yes
-}
-Pool {
- Name = Monthly
- Use Volume Once = yes
- Pool Type = Backup
- AutoPrune = yes
- VolumeRetention = 365d # recycle in 1 year
- Recycle = yes
-}
-\end{verbatim}
-\normalsize
-
-\section{ Automatic Pruning and Recycling Example}
-\label{PruningExample}
-\index[general]{Automatic Pruning and Recycling Example }
-\index[general]{Example!Automatic Pruning and Recycling }
-
-Perhaps the best way to understand the various resource records that come into
-play during automatic pruning and recycling is to run a Job that goes through
-the whole cycle. If you add the following resources to your Director's
-configuration file:
-
-\footnotesize
-\begin{verbatim}
-Schedule {
- Name = "30 minute cycle"
- Run = Level=Full Pool=File Messages=Standard Storage=File
- hourly at 0:05
- Run = Level=Full Pool=File Messages=Standard Storage=File
- hourly at 0:35
-}
-Job {
- Name = "Filetest"
- Type = Backup
- Level = Full
- Client=XXXXXXXXXX
- FileSet="Test Files"
- Messages = Standard
- Storage = File
- Pool = File
- Schedule = "30 minute cycle"
-}
-# Definition of file storage device
-Storage {
- Name = File
- Address = XXXXXXXXXXX
- SDPort = 9103
- Password = XXXXXXXXXXXXX
- Device = FileStorage
- Media Type = File
-}
-FileSet {
- Name = "Test Files"
- Include = signature=MD5 {
- fffffffffffffffff
- }
- Exclude = { *.o }
-}
-Pool {
- Name = File
- Use Volume Once = yes
- Pool Type = Backup
- LabelFormat = "File"
- AutoPrune = yes
- VolumeRetention = 4h
- Maximum Volumes = 12
- Recycle = yes
-}
-\end{verbatim}
-\normalsize
-
-Where you will need to replace the {\bf ffffffffff}'s by the appropriate files
-to be saved for your configuration. For the FileSet Include, choose a
-directory that has one or two megabytes maximum since there will probably be
-approximately eight copies of the directory that {\bf Bacula} will cycle through.
-
-In addition, you will need to add the following to your Storage daemon's
-configuration file:
-
-\footnotesize
-\begin{verbatim}
-Device {
- Name = FileStorage
- Media Type = File
- Archive Device = /tmp
- LabelMedia = yes;
- Random Access = Yes;
- AutomaticMount = yes;
- RemovableMedia = no;
- AlwaysOpen = no;
-}
-\end{verbatim}
-\normalsize
-
-With the above resources, Bacula will start a Job every half hour that saves a
-copy of the directory you chose to /tmp/File0001 ... /tmp/File0012. After 4
-hours, Bacula will start recycling the backup Volumes (/tmp/File0001 ...). You
-should see this happening in the output produced. Bacula will automatically
-create the Volumes (Files) the first time it uses them.
-
-To turn it off, either delete all the resources you've added, or simply
-comment out the {\bf Schedule} record in the {\bf Job} resource.
-
-\section{Manually Recycling Volumes}
-\label{manualrecycling}
-\index[general]{Volumes!Manually Recycling }
-\index[general]{Manually Recycling Volumes }
-
-Although automatic recycling of Volumes is implemented in version 1.20 and
-later (see the
-\ilink{Automatic Recycling of Volumes}{RecyclingChapter} chapter of
-this manual), you may want to manually force reuse (recycling) of a Volume.
-
-Assuming that you want to keep the Volume name, but you simply want to write
-new data on the tape, the steps to take are:
-
-\begin{itemize}
-\item Use the {\bf update volume} command in the Console to ensure that the
- {\bf Recycle} field is set to {\bf 1}
-\item Use the {\bf purge jobs volume} command in the Console to mark the
- Volume as {\bf Purged}. Check by using {\bf list volumes}.
-\end{itemize}
-
-Once the Volume is marked Purged, it will be recycled the next time a Volume
-is needed.
-
-If you wish to reuse the tape by giving it a new name, follow the following
-steps:
-
-\begin{itemize}
-\item Use the {\bf purge jobs volume} command in the Console to mark the
- Volume as {\bf Purged}. Check by using {\bf list volumes}.
-\item In Bacula version 1.30 or greater, use the Console {\bf relabel}
- command to relabel the Volume.
-\end{itemize}
-
-Please note that the relabel command applies only to tape Volumes.
-
-For Bacula versions prior to 1.30 or to manually relabel the Volume, use the
-instructions below:
-
-\begin{itemize}
-\item Use the {\bf delete volume} command in the Console to delete the Volume
- from the Catalog.
-\item If a different tape is mounted, use the {\bf unmount} command,
- remove the tape, and insert the tape to be renamed.
-\item Write an EOF mark in the tape using the following commands:
-
-\footnotesize
-\begin{verbatim}
- mt -f /dev/nst0 rewind
- mt -f /dev/nst0 weof
-\end{verbatim}
-\normalsize
-
-where you replace {\bf /dev/nst0} with the appropriate device name on your
-system.
-\item Use the {\bf label} command to write a new label to the tape and to
- enter it in the catalog.
-\end{itemize}
-
-Please be aware that the {\bf delete} command can be dangerous. Once it is
-done, to recover the File records, you must either restore your database as it
-was before the {\bf delete} command, or use the {\bf bscan} utility program to
-scan the tape and recreate the database entries.
+++ /dev/null
-%%
-%%
-
-\chapter{Systemvoraussetzungen}
-\label{SysReqs}
-\index[general]{Systemvoraussetzungen }
-\index[general]{Voraussetzungen!des System }
-
-\begin{itemize}
-\item {\bf Bacula} ist auf RedHat-Linux, FreeBSD- und
- Solaris-Systemen kompiliert und installiert worden.
-\item Zur Kompilierung ben\"{o}tigen Sie GNU C++ in der Version 2.95 oder h\"{o}her. Sie k\"{o}nnen es mit anderen Compilern oder \"{a}lteren Versionen versuchen, doch bieten wir hierf\"{u}r keine Unterst\"{u}tzung.
-Wir haben Bacula unter RH8.0/RH9/RHEL 3.0/FC3 mit GCC 3.4 erfolgreich kompiliert und verwendet.
-Beachten Sie bitte, dass GNU C++ normalerweise ein eigenes Paket (z.B. RPM) neben GNU C ist. Auf RedHat-Systemen ist der C++-Compiler im RPM-Paket {\bf gcc-c++}.
-
-\item Bacula ben\"{o}tigt bestimmte Pakete von Drittanbietern, die Sie au{\ss}er ``MySQL'' und ``PostgreSQL'' alle in den Releases {\bf depkgs} und {\bf depkgs1} finden.
-
-\item Wenn Sie die Win32-Quelldateien kompilieren wollen, ben\"{o}tigen Sie einen Microsoft
- Visual C++-Compiler (oder Visual Studio). Obwohl sich alle Komponenten kompilieren lassen
- (Console bringt einige Warnmeldungen), wurde nur der File-D\"{a}mon getestet.
-
-\item {\bf Bacula} erfordert um zu funktionieren eine gute Implementierung der PThreads. Auf einigen BSD-Systemen ist das nicht gegeben.
-
-\item Bei der Codierung achteten wir auf Portabilit\"{a}t. Daher ist der Code gr\"{o}{\ss}tenteils POSIX-kompatibel und m\"{u}sste sich daher verh\"{a}ltnism\"{a}{\ss}ig leicht auf POSIX-Systeme \"{u}bertragen lassen.
-
-\item Die GNOME-Konsole wurde unter GNOME 2.x. entwickelt und getestet. Sie l\"{a}uft auch unter GNOME 1.4, doch ist diese Version veraltet und wird daher nicht mehr gewartet.
-
-\item Das wxWidgets-Konsolenprogramm wurde mit der letzten stabilen ANSI- (nicht Unicode-)Version von \elink{wxWidgets}{http://www.wxwidgets.org/} (2.6.1) entwickelt und getestet. Es arbeitet gut mit der Windows- und GTK+-Version von wxWidgets zusammen und sollte auch auf anderen Plattformen laufen, die wxWidgets unterst\"{u}tzen.
-
-\item Das Tray-Monitorprogramm wurde f\"{u}r GTK+-2.x entwickelt. Es ben\"{o}tigt Gnome in der Version 2.2 oder h\"{o}her, KDE in der Version 3.1 oder h\"{o}her oder einen anderen Window-Manager, der den Standard f\"{u}r System-Trays von \elink{FreeDesktop}{http://www.freedesktop.org/Standards/systemtray-spec} unterst\"{u}tzt.
-
-\item Wenn sie eine Kommandozeileneditierung und -history nutzen wollen, brauchen sie die Headerdatei /usr/include/termcap.h und m\"{u}ssen entweder die ``Termcap''- oder die ``Ncurses''- Bibliothek geladen haben (libtermcap-devel oder ncurses-devel).
-
-\item Wenn sie DVDs als Sicherungsmedium benutzen wollen, m\"{u}ssen Sie sich die \elink{dvd+rw-tools 5.21.4.10.10.8}{http://fy.chalmers.se/~appro/linux/DVD+RW/} herunterladen. Benutzen sie den \elink{patch}{http://cvs.sourceforge.net/viewcvs.py/*checkout*/bacula/bacula/patches/dvd+rw-tools-5.21.4.10.8.bacula.patch}, um diese Hilfsprogramme zu Bacula kompatibel zu machen, kompilieren und installieren Sie sie. Verwenden Sie nicht die ``dvd+rw-tools'', die Ihrer Distribution beiliegen. Diese werden zusammen mit Bacula nicht funktionieren.
-\end{itemize}
+++ /dev/null
-%%
-%%
-
-\chapter{Disaster Recovery Using Bacula}
-\label{RescueChapter}
-\index[general]{Disaster Recovery Using Bacula}
-\index[general]{Bacula!Disaster Recovery Using}
-\index[general]{Recovery!Disaster Recovery}
-\index[general]{Rescue!Disaster Recovery}
-
-\section{General}
-\index[general]{General}
-
-When disaster strikes, you must have a plan, and you must have prepared in
-advance otherwise the work of recovering your system and your files will be
-considerably greater. For example, if you have not previously saved the
-partitioning information for your hard disk, how can you properly rebuild
-it if the disk must be replaced?
-
-Unfortunately, many of the steps one must take before and immediately after
-a disaster are very operating system dependent. As a consequence, this
-chapter will discuss in detail disaster recovery (also called Bare Metal
-Recovery) for
-{\bf Linux} and {\bf Solaris}. For Solaris, the procedures are still quite
-manual. For FreeBSD the same procedures may be used but they are not yet
-developed. For Win32, a number of Bacula users have reported success using
-BartPE.
-
-
-\label{considerations1}
-\section{Important Considerations}
-\index[general]{Important Considerations}
-\index[general]{Considerations!Important}
-
-Here are a few important considerations concerning disaster recovery that
-you should take into account before a disaster strikes.
-
-\begin{itemize}
-\item If the building which houses your computers burns down or is otherwise
- destroyed, do you have off-site backup data?
-\item Disaster recovery is much easier if you have several machines. If you
- have a single machine, how will you handle unforeseen events if your only
- machine is down?
-\item Do you want to protect your whole system and use Bacula to recover
- everything? or do you want to try to restore your system from the original
- installation disks and apply any other updates and only restore user files?
-\end{itemize}
-
-\label{steps1}
-\section{Steps to Take Before Disaster Strikes}
-\index[general]{Steps to Take Before Disaster Strikes}
-\index[general]{Strikes!Steps to Take Before Disaster}
-
-\begin{itemize}
-\item Create a Bacula Rescue CDROM for each of your Linux systems. Note, it
- is possible to create one CDROM by copying the bacula-hostname directory from
- each machine to the machine where you will be burning the CDROM, so
- if the Linux distro/version is the same, you can have a single CDROM that can recover
- multiple systems.
-\item Ensure that you always have a valid bootstrap file for your backup and
- that it is saved to an alternate machine. This will permit you to
- easily do a full restore of your system.
-\item If possible copy your catalog nightly to an alternate machine. If you
- have a valid bootstrap file, this is not necessary, but can be very useful if
- you do not want to reload everything. .
-\item Ensure that you always have a valid bootstrap file for your catalog
- backup that is saved to an alternate machine. This will permit you to restore
- your catalog more easily if needed.
-\item Test using the Bacula Rescue CDROM before you are forced to use it in
- an emergency situation.
-\item Make a copy of your Bacula .conf files, particularly your
- bacula-dir.conf, and your bacula-sd.conf files, because if your server
- goes down, these files will be needed to get it back up and running,
- and they can be difficult to rebuild from memory.
-\end{itemize}
-
-\label{rescueCDROM}
-\section{Bare Metal Recovery on Linux with a Bacula Rescue CD}
-\index[general]{Bare Metal Recovery on Linux with a Bacula Rescue CD}
-\index[general]{CDROM!Bare Metal Recovery on Linux with a Bacula Rescue}
-%% NOTE: using "CD" instead of "CDROM" so it fits on book page in Table of Contents
-
-As an alternative to creating a Bacula Rescue CD, please see the
-section below entitled \ilink{Bare Metal Recovery using a LiveCD}{LiveCD}.
-
-The remainder of this section concerns recovering a {\bf Linux} client
-computer (i.e. one running just the Bacula File daemon). The {\bf
-Solaris} procedures can be found below under the \ilink{Solaris Bare Metal
-Recovery}{solaris} section of this chapter.
-
-Previously Bacula supported a floppy rescue disk. This code has been
-removed in 1.37.40 and later.
-
-A so called "Bare Metal" recovery is one where you start with an empty hard
-disk and you restore your machine. There are also cases where you may lose a
-file or a directory and want it restored. Please see the previous chapter for
-more details for those cases.
-
-
-The primary goals of the Bacula rescue CD are:
-
-\begin{itemize}
-\item NOT to be a general or universal recovery disk.
-\item to capture and setup a restore environment for a single system running
- as a Client.
-\item to capture the current state of the hard disks on your system, so that
- they can be easily restored from pre-generated scripts. Note, this is
- not done by any other rescue CDROM, as far as I am aware.
-\item to create and save a statically linked copy of your current Bacula FD.
- Thus you need no packages or other software to be installed before using
- this CDROM and the Bacula File daemon on it.
-\item to be relatively easy to create. In most cases you simply type {\bf
- make all} in the {\bf rescue/linux/cdrom} directory, then burn the ISO image
- created. In contrast, if you have looked at any of the documentation on how
- to remaster a CD or how to roll your own rescue CD, your head will spin
- (at least mine did).
-\item to be easy for you to add any additional files, binaries, or libraries
- to the CD.
-\item to build and work on any (or almost any) Linux flavor or release.
-\item you might ask why I don't use Knoppix or some other preprepared recovery
- disk, especially since Knoppix is very kind and provides the Bacula FD on
- their disk. The answer is that: I am more comfortable having my Linux boot
- up in rescue mode rather than another flavor. In addition, the Bacula rescue
- CDROM contains a complete snapshot of your disk partitioning, which is not
- the case with any other rescue disk. If your harddisk dies, do you remember all
- the partitions you had and how big they are? I don't, and without that information,
- you have little hope of reformatting your harddisk and rebuilding your system.
-\end{itemize}
-
-One of the main of the advantages of a Bacula Rescue CDROM is that it contains
-a bootable copy of your system, so you should be familiar with it.
-
-
-Bare Metal Recovery assumes that you have the following items for your system:
-
-\begin{itemize}
-\item A Bacula Rescue CDROM containing a copy of your OS and a copy of your
- hard disk information, as well as a statically linked version of the
- Bacula File daemon. This chapter describes how to build such a CDROM.
-\item A full Bacula backup of your system possibly including Incremental or
- Differential backups since the last Full backup
-\item A second system running the Bacula Director, the Catalog, and the
- Storage daemon. (this is not an absolute requirement, but how to get
- around it is not yet documented here)
-\end{itemize}
-
-\section{Requirements}
-\index[general]{Requirements}
-
-In addition, to the above assumptions, the following conditions or
-restrictions apply:
-
-\begin{itemize}
-\item Linux only -- tested only on SuSE and Fedora Core 4, but should work
- on other Linux distros.
-\item The scripts handle only SCSI and IDE disks.
-\item All partitions will be recreated, but only {\bf ext2}, {\bf ext3}, {\bf
- rfs} and {\bf swap} partitions will be reformatted. Any other partitions such
- as Windows FAT partitions will not be formatted by the scripts, but you can
- do it by hand.
-\item You are using either {\bf lilo} or {\bf grub} as a boot loader, and you
- know which one (not automatically detected).
-\item The partitioning and reformatting scripts *should* work with RAID
- devices, but probably not with other "`complicated"' disk
- partitioning/formatting schemes. They also should work with Reiser
- filesystems. Please check them carefully. You will probably need to
- edit the scripts by hand to make them work.
-\item You will need mkisofs (might be part of cdrtools, but is a separate rpm
- on my system); cdrecord or some other tool for burning the CDROM.
-\end{itemize}
-
-\section{Directories}
-\index[general]{Directories}
-
-To build the Bacula Rescue CDROM, you must get a copy of the rescue files.
-In version 1.37 and later, they are separate from the Bacula source. The
-rescue files are distributed as a compressed tar file on the Source Forge
-Bacula release area with the name bacula-rescue-xx.yy.zz.tar.gz. They are
-also automatically installed in /etc/bacula/rescue when installing by rpms.
-Another place you can find the rescue files is in the Source Forge Bacula
-SVN module named {\bf rescue}.
-
-Please read the README file in the main directory of the
-Rescue source code. Before using it, you must run configure and
-specify the location of the Bacula source code (not necessary if installed
-from rpms). This permits the rescue build scripts to automatically
-create a statically linked Bacula File daemon.
-
-You will find the necessary scripts in {\bf
-linux/cdrom} subdirectory of the rescue source code. If you installed
-the bacula rpm package the scripts will be found in the {\bf
-/etc/bacula/rescue/linux/cdrom} directory.
-
-\section{Preparation for a Bare Metal Recovery}
-\index[general]{Recovery!Preparation for a Bare Metal}
-\index[general]{Preparation for a Bare Metal Recovery}
-
-Before you can do a Bare Metal recovery, you must create a Bacula Rescue
-CDROM, which will contain everything you need to begin recovery. This assumes
-that you will have your Director and Storage daemon running on a different
-machine. If you want to recover a machine where the Director and/or the
-database were previously running, things will be much more complicated.
-
-\label{CreateRescue}
-\section{Creating a Bacula Rescue CDROM}
-\index[general]{CDROM!Creating a Bacula Rescue}
-\index[general]{Creating a Bacula Rescue CDROM}
-\index[general]{Upgrading}
-
-You should probably make a new rescue CDROM each time you upgrade a major
-version of Bacula and whenever you modify your disk partitioning.
-
-To build the rescue CDROM from source, you must first configure the
-rescue package, which is distributed separately from the source.
-The simplest procedure is for you to pre-build a static-bacula-fd taking
-care to use a minimum configuration such as:
-
-\footnotesize
-\begin{verbatim}
-cd <bacula-source>
-./configure \
- --prefix=/usr \
- --sbindir=/usr/sbin \
- --sysconfdir=/etc/bacula \
- --with-scriptdir=/etc/bacula \
- --enable-smartalloc \
- --enable-client-only \
- --enable-static-fd
-make
-\end{verbatim}
-\normalsize
-
-Then to copy the src/filed/static-bacula-fd, and a valid
-working copy of your bacula-fd.conf file to some specific
-directory. You can then proceed to configure the rescue
-package with:
-
-\footnotesize
-\begin{verbatim}
-cd <bacula-rescue>
-./configure \
- --with-static-fd=<directory-containing-static-bacula-fd> \
- --with-bacula-scripts=<directory-containing-bacula-fd.conf>
-cd linux/cdrom
-su
-(enter root password)
-make
-\end{verbatim}
-\normalsize
-
-The above instructions were for building the rescue CDROM from
-a bacula-rescue release. The advantage of the above procedure is
-that you have explicitly built your static-bacula-fd and you will
-supply the configuration with a working copy of bacula-fd.conf containing
-the correct Director name and password.
-
-Alternatively when you configure the rescue package, you could supply
-it with the path to your Bacula source code, and when building the
-rescue disk, it will attepmpt to build a static-bacula-fd for you.
-We suggest you manually build your static Bacula File daemon and
-use the {\bf --with-static-fd} option rather than letting the script
-attempt to build it (as shown below) because by manually building it,
-you can ensure that there are no errors, and you can execute it
-prior to putting it on the CD (e.g. ./bacula-fd -t).
-
-To have the rescue scripts automatically build a static File daemon
-for you, use:
-
-\footnotesize
-\begin{verbatim}
-cd <bacula-rescue>
-./configure \
- --with-bacula=<bacula-source-directory>
-cd linux/cdrom
-su
-(enter root password)
-make
-\end{verbatim}
-\normalsize
-
-
-If you have multiple kernels installed on your system, you can
-specify which one using the following configuration option:
-
-\footnotesize
-\begin{verbatim}
-cd <bacula-rescue>
-./configure \
- --with-kernel=<kernel-version> \
- ...
-\end{verbatim}
-\normalsize
-
-For example a {\bf kernel-version} might be 2.6.14-1.1653.
-
-One additional option that can be useful is to specify the
-device name of your CDROM on the ./configure. To do so use:
-
-\footnotesize
-\begin{verbatim}
-cd <bacula-rescue>
-./configure \
- --with-dev=<device> \
- ...
-\end{verbatim}
-\normalsize
-
-Where \lt{}device\gt{} is typically replaced with something like
-{\bf /dev/hdc}. This option is needed only if you have a recent OS
-that used device specifications rather than rather than ATA addresses, and
-you want to use the Bacula script {\bf make burn} to automatically
-burn your ISO onto a CDROM.
-
-
-For users of the bacula-rescue rpm the static bacula-fd has already been built
-and placed in {\bf /etc/bacula/rescue/linux/cdrom/bin/} along with a symbolic link
-to your {\bf /etc/bacula/bacula-fd.conf} file. Rpm users only need to do the
-second step:
-
-\footnotesize
-\begin{verbatim}
-cd /etc/bacula/rescue/linux/cdrom
-su (become root)
-make
-\end{verbatim}
-\normalsize
-
-At this point, if the scripts are successful, they should have done the
-following things:
-
-\begin{itemize}
-\item Made a copy of your kernel and its essential files.
-\item Copied a number of binary files from your system.
-\item Copied all the necessary shared libraries to run the above binary
- files.
-\item Made a statically-linked version of your File daemon and copied it into
- the CDROM build area.
-\item Made an ISO image and left it in {\bf bootcd.iso}
-\end{itemize}
-
-Once this is accomplished, you need only burn it into a CDROM. This can be
-done directly from the makefile with:
-
-\footnotesize
-\begin{verbatim}
-make burn
-\end{verbatim}
-\normalsize
-
-However, you may need to modify the Makefile to properly specify your CD
-burner as the detection process is complicated especially if you have two
-CDROMs or do not have {\bf cdrecord} loaded on your system. Users of the
-rescue rpm package should definitely examine the Makefile since it was
-configured on the host used to produce the rpm package. If you find that the
-{\bf make burn} does not work for you, try doing a:
-
-\footnotesize
-\begin{verbatim}
-make scan
-\end{verbatim}
-\normalsize
-
-and use the output of that to modify the Makefile accordingly.
-
-The "make" that you did above actually does the equivalent to the
-following:
-
-\footnotesize
-\begin{verbatim}
-make kernel
-make binaries
-make bacula
-make iso
-\end{verbatim}
-\normalsize
-
-If you wish, you can modify what you put on the CDROM and redo any part of the
-make that you wish. For example, if you want to add a new directory, you might
-do the first three makes, then add a new directory to the CDROM, and finally
-do a "`make iso"'. Please see the README file in the {\bf rescue/linux/cdrom}
-or {\bf /etc/bacula/rescue/linux/cdrom}directory for instructions on changing the
-contents of the CDROM.
-
-At the current time, the size of the CDROM is about 100MB (compressed to about
-20MB), so there is quite a bit more room for additional programs. Keep in mind
-that when this CDROM is booted, *everything* is in memory, so the total size
-cannot exceed your memory size, and even then you will need some reserve
-memory for running programs, ...
-
-Finally, if you want to be completely responsible for getting your
-own FD binary on the disk, you can do the following:
-
-\footnotesize
-\begin{verbatim}
-cd linux/cdrom
-touch rpm_release
-make kernel
-make binaries
-make bacula
-(add your own Bacula FD to the bacula/bin directory)
-make iso
-rm -f rpm_release
-\end{verbatim}
-\normalsize
-
-The rpm\_release file prevents the {\bf make bacula} from attempting to
-build or copy a File daemon, so that you can do it before the
-"make iso" step. Once "make iso" is run, you can no longer add
-anything to the in-memory part of the image. You can still add
-files to the cdtree directory, and when you do a "make burn" they
-will be written to the CDROM. However, to access them, you must
-be able to mount the CDROM after booting it, then copy them into
-memory.
-
-
-\label{twosystemcd}
-\section{Putting Multiple Systems on Your Rescue Disk}
-\index[general]{Putting Multiple Systems on Your Rescue Disk}
-\index[general]{Disk!Putting Multiple Systems on Your CD}
-
-You can put multiple systems on the same rescue CD if you wish. This is
-because the information that is specific to your OS will be stored in the {\bf
-/bacula-hostname} directory, where {\bf hostname} is the name of the host on
-which you are building the CD. Suppose for example, you have two systems. One
-named {\bf client1} and one named {\bf client2}. Assume also that your CD
-burner is on client1, and that is the machine we start on, and that we can ssh
-into client2 and also client2's disks are mounted on client1.
-
-\footnotesize
-\begin{verbatim}
-ssh client2
-cd <bacula-source>
-./configure --with-static-fd (our options)
-make
-cd <bacula-rescue-source>
-./configure --with-bacula=<path-to-bacula-source>
-cd linux/cdrom
-su (become root)
-make bacula
-exit
-\end{verbatim}
-\normalsize
-
-Again, for rpm package users the above command set would be:
-
-\footnotesize
-\begin{verbatim}
-ssh client2
-cd /etc/bacula/rescue/linux/cdrom
-su
-(enter root password)
-make bacula
-exit
-\end{verbatim}
-\normalsize
-
-Thus we have just built a Bacula rescue directory on client2. Now, on client1,
-we copy the appropriate directory to two places (explained below), then build
-an ISO and burn it:
-
-\footnotesize
-\begin{verbatim}
-cd <bacula-source>
-./configure (your options)
-make
-cd <bacula-rescue-source>
-./configure --with-bacula=<path-to-bacula-source>
-cd linux/cdrom
-su (become root)
-c=/mnt/client2/home/user/bacula/rescue/linux/cdrom
-cp -a $c/roottree/bacula-client2 cdtree
-make
-make burn
-exit
-\end{verbatim}
-\normalsize
-
-And with the rpm package:
-
-\footnotesize
-\begin{verbatim}
-cd /etc/bacula/rescue/linux/cdrom
-su
-(enter root password)
-c=/mnt/client2/etc/bacula/rescue/linux/cdrom
-cp -a $c/roottree/bacula-client2 cdtree
-make
-make burn
-exit
-\end{verbatim}
-\normalsize
-
-In summary, with the above commands, we first build a Bacula directory on
-client2 in roottree/bacula-client2, then we copied the bacula-client2
-directory into the client1's cdtree so it will also be on the CD as
-a separate directory and thus can be read without booting the CDROM. Then we
-made and burned the CDROM for client1, which of course, contains the client2
-data.
-
-\label{restore_client}
-\section{Restoring a Client System}
-\index[general]{Restoring a Client System}
-\index[general]{System!Restoring a Client}
-
-Now, let's assume that your hard disk has just died and that you have replaced
-it with an new identical drive. In addition, we assume that you have:
-
-\begin{enumerate}
-\item A recent Bacula backup (Full plus Incrementals)
-\item A Bacula Rescue CDROM.
-\item Your Bacula Director, Catalog, and Storage daemon running on another
- machine on your local network.
-\end{enumerate}
-
-This is a relatively simple case, and later in this chapter, as time permits,
-we will discuss how you might recover from a situation where the machine that
-crashes is your main Bacula server (i.e. has the Director, the Catalog, and
-the Storage daemon).
-
-You will take the following steps to get your system back up and running:
-
-\begin{enumerate}
-\item Boot with your Bacula Rescue CDROM.
-\item Start the Network (local network)
-\item Re-partition your hard disk(s) as it was before
-\item Re-format your partitions
-\item Restore the Bacula File daemon (static version)
-\item Perform a Bacula restore of all your files
-\item Re-install your boot loader
-\item Reboot
-\end{enumerate}
-
-Now for the details ...
-
-\section{Boot with your Bacula Rescue CDROM}
-\index[general]{CDROM!Boot with your Bacula Rescue}
-\index[general]{Boot with your Bacula Rescue CDROM}
-
-When the CDROM boots, you will be presented with a script that looks like:
-
-\footnotesize
-\begin{verbatim}
-
- Welcome to the Bacula Rescue Disk 2.0.0
-To proceed, press the <ENTER> key or type "linux <runlevel>"
-
- linux 1 -> shell
- linux 2 -> login (default if ENTER pressed)
- linux 3 -> network started and login (network not working yet)
- linux debug -> print debug during boot then login
-\end{verbatim}
-\normalsize
-
-Normally, at this point, you simply press ENTER. However, you may supply
-options for the boot if you wish.
-
-Once it has booted, you will be requested to login something like:
-
-\footnotesize
-\begin{verbatim}
-bash-3.1#
-\end{verbatim}
-\normalsize
-
-You will be in the root directory, and you can proceed to
-examine your system.
-
-The complete Bacula rescue part of the CD will be in the directory: {\bf
-/bacula-hostname}, where hostname is replaced by the name of the host machine
-on which you did the build for the CDROM. This naming procedure allows you to
-put multiple restore environments for each of your machines on a single CDROM
-if you so wish to do. Please see the README document in the {\bf
-rescue/linux/cdrom} directory for more information on adding to the CDROM.
-
-\paragraph*{Start the Network:}
-
-At this point, you should bring up your network. Normally, this is quite
-simple and requires just a few commands. Please cd into the /bacula-hostname
-directory before continuing. To simplify your task, we have created a script
-that should work in most cases by typing:
-
-\footnotesize
-\begin{verbatim}
-cd /bacula-hostname
-./start_network
-\end{verbatim}
-\normalsize
-
-You can test it by pinging another machine, or pinging your broken machine
-machine from another machine. Do not proceed until your network is up.
-
-\paragraph*{Partition Your Hard Disk(s):}
-
-Assuming that your hard disk crashed and needs repartitioning, proceed with:
-
-\footnotesize
-\begin{verbatim}
-./partition.hda
-\end{verbatim}
-\normalsize
-
-If you have multiple disks, do the same for each of them. For SCSI disks, the
-repartition script will be named: {\bf partition.sda}. If the script complains
-about the disk being in use, simply go back and redo the {\bf df} command and
-{\bf umount} commands until you no longer have your hard disk mounted. Note,
-in many cases, if your hard disk was seriously damaged or a new one installed,
-it will not automatically be mounted. If it is mounted, it is because the
-emergency kernel found one or more possibly valid partitions.
-
-If for some reason this procedure does not work, you can use the information
-in {\bf partition.hda} to re-partition your disks by hand using {\bf fdisk}.
-
-\paragraph*{Format Your Hard Disk(s):}
-
-If you have repartitioned your hard disk, you must format it appropriately.
-The formatting script will put back swap partitions, normal Unix partitions
-(ext2) and journaled partitions (ext3) as well as Reiser partitions (rei). Do
-so by entering for each disk:
-
-\footnotesize
-\begin{verbatim}
-./format.hda
-\end{verbatim}
-\normalsize
-
-The format script will ask you if you want a block check done. We recommend to
-answer yes, but realize that for very large disks this can take hours.
-
-\paragraph*{Mount the Newly Formatted Disks:}
-
-Once the disks are partitioned and formatted, you can remount them with the
-{\bf mount\_drives} script. All your drives must be mounted for Bacula to be
-able to access them. Run the script as follows:
-
-\footnotesize
-\begin{verbatim}
-./mount_drives
-df
-\end{verbatim}
-\normalsize
-
-The {\bf df} command will tell you if the drives are mounted. If not, re-run
-the script again. It isn't always easy to figure out and create the mount
-points and the mounts in the proper order, so repeating the {\bf
-./mount\_drives} command will not cause any harm and will most likely work the
-second time. If not, correct it by hand before continuing.
-
-\paragraph*{Start the Network:}
-
-Before starting the File Daemon, you must bring up the network
-so that it can communicate with the Director and Storage daemon.
-Generally you can do so by running:
-
-\footnotesize
-\begin{verbatim}
-./start_network
-\end{verbatim}
-\normalsize
-
-
-
-\paragraph*{Restore and Start the File Daemon:}
-
-If you have booted with a Bacula Rescue CDROM, your statically linked Bacula
-File daemon and the bacula-fd.conf file will be in the /bacula-hostname/bin
-directory. Make sure {\bf bacula-fd} and {\bf bacula-fd.conf} are both there.
-
-If you did not already install a correct conf file, please
-edit the Bacula configuration file, create the working/pid/subsys directory if
-you haven't already done so above, and start Bacula. Before starting Bacula,
-you will need to move it and bacula-fd.conf from /bacula-hostname/bin, to the
-/mnt/disk/tmp directory so that it will be on your hard disk. Then start it
-with the following command:
-
-\footnotesize
-\begin{verbatim}
-chroot /mnt/disk /tmp/bacula-fd -c /tmp/bacula-fd.conf
-\end{verbatim}
-\normalsize
-
-The above command starts the Bacula File daemon with the proper root disk
-location (i.e. {\bf /mnt/disk/tmp}. If Bacula does not start, correct the
-problem and start it. You can check if it is running by entering:
-
-\footnotesize
-\begin{verbatim}
-ps fax
-\end{verbatim}
-\normalsize
-
-You can kill Bacula by entering:
-
-\footnotesize
-\begin{verbatim}
-kill -TERM <pid>
-\end{verbatim}
-\normalsize
-
-where {\bf pid} is the first number printed in front of the first occurrence
-of {\bf bacula-fd} in the {\bf ps fax} command.
-
-Now, you should be able to use another computer with Bacula installed to check
-the status by entering:
-
-\footnotesize
-\begin{verbatim}
-status client=xxxx
-\end{verbatim}
-\normalsize
-
-into the Console program, where xxxx is the name of the client you are
-restoring.
-
-One common problem is that your {\bf bacula-dir.conf} may contain machine
-addresses that are not properly resolved on the stripped down system to be
-restored because it is not running DNS. This is particularly true for the
-address in the Storage resource of the Director, which may be very well
-resolved on the Director's machine, but not on the machine being restored and
-running the File daemon. In that case, be prepared to edit {\bf
-bacula-dir.conf} to replace the name of the Storage daemon's domain name with
-its IP address.
-
-\paragraph*{Restore Your Files:}
-
-On the computer that is running the Director, you now run a {\bf restore}
-command and select the files to be restored (normally everything), but before
-starting the restore, there is one final change you must make using the {\bf
-mod} option. You must change the {\bf Where} directory to be the root by using
-the {\bf mod} option just before running the job and selecting {\bf Where}.
-Set it to:
-
-\footnotesize
-\begin{verbatim}
-/
-\end{verbatim}
-\normalsize
-
-then run the restore.
-
-You might be tempted to avoid using {\bf chroot} and running Bacula directly
-and then using a {\bf Where} to specify a destination of {\bf /mnt/disk}. This
-is possible, however, the current version of Bacula always restores files to
-the new location, and thus any soft links that have been specified with
-absolute paths will end up with {\bf /mnt/disk} prefixed to them. In general
-this is not fatal to getting your system running, but be aware that you will
-have to fix these links if you do not use {\bf chroot}.
-
-\paragraph*{Final Step:}
-
-At this point, the restore should have finished with no errors, and all your
-files will be restored. One last task remains and that is to write a new boot
-sector so that your machine will boot. For {\bf lilo}, you enter the following
-command:
-
-\footnotesize
-\begin{verbatim}
-./run_lilo
-\end{verbatim}
-\normalsize
-
-If you are using grub instead of lilo, you must enter the following:
-
-\footnotesize
-\begin{verbatim}
-./run_grub
-\end{verbatim}
-\normalsize
-
-Note, I've had quite a number of problems with {\bf grub} because it is rather
-complicated and not designed to install easily under a simplified system.
-In fact, the ./run\_grub script is not going to work on most Linux 2.6 kernels
-with the latest grub, because grub-install references /usr/share/grub/...
-and it uses /dev/pts, which will not be in /dev if you are using udev (as
-do many 2.6 kernels).
-
-So, if you experience errors or end up unexpectedly in a {\bf chroot}
-shell, simply exit back to the normal shell and type in the appropriate
-commands from the {\bf run\_grub} script by hand until you get it to
-install. When you run the run\_grub script, it will print the commands
-that you should manually enter if that is necessary.
-
-In my more recent tests on FC4 running a 2.6.14 kernel and udev, I see that
-because of the above mentioned problems with grub, you will need version
-1.8.2 rescue disk or later, and you may be more successful in getting grub
-to run by running it directly from the command line while logged into the
-rescue kernel using:
-
-\footnotesize
-\begin{verbatim}
-/sbin/grub-install --root-directory=/mnt/disk /dev/hda
-\end{verbatim}
-\normalsize
-
-Note, in this case, you omit the chroot command, and you must
-replace /dev/hda with your boot device. If you don't know what your
-boot device is, run the ./run\_grub script once and it will tell
-you.
-
-Finally, I've even run into a case where grub-install was unable to
-rewrite the boot block. In my case, it produced the following error
-message:
-
-\footnotesize
-\begin{verbatim}
-/dev/hdx does not have any corresponding BIOS drive.
-\end{verbatim}
-\normalsize
-
-The solution is to insure that all your disks are properly mounted on
-/mnt/disk, then do the following:
-
-\footnotesize
-\begin{verbatim}
-chroot /mnt/disk
-mount /dev/pts
-\end{verbatim}
-\normalsize
-
-Then edit the file {\bf /boot/grub/grub.conf} and uncomment the line
-that reads:
-
-\footnotesize
-\begin{verbatim}
-#boot=/dev/hda
-\end{verbatim}
-\normalsize
-
-So that it reads:
-
-\footnotesize
-\begin{verbatim}
-boot=/dev/hda
-\end{verbatim}
-\normalsize
-
-Note, the /dev/hda may be /dev/sda or possibly some other drive depending
-on your configuration, but in any case, it is the same as the one that
-you previously tried with {\bf grub-install}.
-
-Then, enter the following commands:
-
-\footnotesize
-\begin{verbatim}
-grub --batch --device-map=/boot/grub/device.map \
- --config-file=/boot/grub/grub.conf --no-floppy
-root (hd0,0)
-setup (hd0)
-quit
-\end{verbatim}
-\normalsize
-
-If the {\bf grub} call worked, you will get a prompt of {\bf grub\gt{}}
-before the {\bf root}, {\bf setup}, and {\bf quit} commands, and after
-entering the {\bf setup} command, it should indicate that it successfully
-wrote the MBR (master boot record).
-
-
-\paragraph*{Reboot:}
-
-First unmount all your hard disks, otherwise they will not be cleanly
-shutdown, then reboot your machine by entering {\bf exit} until you get to the
-main prompt then enter {\bf Ctrl-d}. Once back to the main CDROM prompt, you
-will need to turn the power off, then back on to your machine to get it to
-reboot.
-
-If everything went well, you should now be back up and running. If not,
-re-insert the emergency boot CDROM, boot, and figure out what is wrong.
-
-\label{restore_server}
-\section{Restoring a Server}
-\index[general]{Restoring a Server}
-\index[general]{Server!Restoring a}
-
-Above, we considered how to recover a client machine where a valid Bacula
-server was running on another machine. However, what happens if your server
-goes down and you no longer have a running Director, Catalog, or Storage
-daemon? There are several solutions:
-
-\begin{enumerate}
-\item Bring up static versions of your Director, Catalog, and Storage daemon
- on the damaged machine.
-
-\item Move your server to another machine.
-
-\item Use a Hot Spare Server on another Machine.
-\end{enumerate}
-
-The first option, is very difficult because it requires you to have created a
-static version of the Director and the Storage daemon as well as the Catalog.
-If the Catalog uses MySQL or PostgreSQL, this may or may not be possible. In
-addition, to loading all these programs on a bare system (quite possible), you
-will need to make sure you have a valid driver for your tape drive.
-
-The second suggestion is probably a much simpler solution, and one I have done
-myself. To do so, you might want to consider the following steps:
-
-\begin{itemize}
-\item If you are using MySQL or PostgreSQL, configure, build and install it
- from source (or use rpms) on your new system.
-\item Load the Bacula source code onto your new system, configure, install
- it, and create the Bacula database.
-\item Ideally, you will have a copy of all the Bacula conf files that
- were being used on your server. If not, you will at a minimum need
- create a bacula-dir.conf that has the same Client resource that
- was used to backup your system.
-\item If you have a valid saved Bootstrap file as created for your damaged
- machine with WriteBootstrap, use it to restore the files to the damaged
- machine, where you have loaded a static Bacula File daemon using the
- Bacula Rescue disk). This is done by using the restore command and at
- the yes/mod/no prompt, selecting {\bf mod} then specifying the path to
- the bootstrap file.
-\item If you have the Bootstrap file, you should now be back up and running,
- if you do not have a Bootstrap file, continue with the suggestions below.
-\item Using {\bf bscan} scan the last set of backup tapes into your MySQL,
- PostgreSQL or SQLite database.
-\item Start Bacula, and using the Console {\bf restore} command, restore the
- last valid copy of the Bacula database and the Bacula configuration
- files.
-\item Move the database to the correct location.
-\item Start the database, and restart Bacula. Then use the Console {\bf
- restore} command, restore all the files on the damaged machine, where you
- have loaded a Bacula File daemon using the Bacula Rescue disk.
-\end{itemize}
-
-For additional details of restoring your database, please see the
-\ilink{Restoring When Things Go Wrong}{database_restore} section
-of the Console Restore Command chapter of this manual.
-
-
-\label{problems2}
-\section{Linux Problems or Bugs}
-\index[general]{Bugs!Linux Problems or}
-\index[general]{Linux Problems or Bugs}
-
-Since every flavor and every release of Linux is different, there are likely
-to be some small difficulties with the scripts, so please be prepared to edit
-them in a minimal environment. A rudimentary knowledge of {\bf vi} is very
-useful. Also, these scripts do not do everything. You will need to reformat
-Windows partitions by hand, for example.
-
-Getting the boot loader back can be a problem if you are using {\bf grub}
-because it is so complicated. If all else fails, reboot your system from your
-floppy but using the restored disk image, then proceed to a reinstallation of
-grub (looking at the run-grub script can help). By contrast, lilo is a piece
-of cake.
-
-\label{LiveCD}
-\section{Bare Metal Recovery using a LiveCD}
-\index[general]{Bare Metal Recovery using a LiveCD}
-\index[general]{Recovery!Bare Metal Recovery using a LiveCD}
-\index[general]{Rescue!Bare Metal Recovery using a LiveCD}
-\index[general]{LiveCD!Bare Metal Recovery using a LiveCD}
-
-Rather than building a full Bacula Rescue CDROM, you can use any
-system rescue or LiveCD to recover your system. The big problem
-with most rescue or LiveCDs is that they are not designed to
-capture the current state of your system, so when you boot them on
-a damaged system, you might be somewhat lost -- e.g. how many of
-you remember your exact hard disk partitioning.
-
-This lack can be easily corrected by running the part of the
-Bacula Rescue code that creates a directory containing a
-static-bacula-fd, a snapshot of your current system disk
-configuration, and scripts that help restoring it.
-
-The procedure is similar to creating and your Bacula Rescue CDROM
-described above, but with the following differences:
-
-Before a disaster strikes:
-\begin{enumerate}
-\item Run only the {\bf make bacula} part of the
- Bacula Rescue procedure to create the static Bacula
- File daemon, and system disk snapshot.
-\item Save the directory generated (more details below)
- preferrably on a CDROM or alternatively to some other
- system.
-\item Possibly run {\bf make bacula} every night as
- part of your backup process to ensure that you have
- a current snapshot of your system.
-\end{enumerate}
-
-Then when disaster strikes, do the following:
-
-\begin{enumerate}
-\item Boot with your system rescue disk or LiveCD
- (e.g. Knoppix).
-\item Start the Network (local network).
-\item Copy the Bacula recovery directory to the
- damaged system using ftp, scp, wget or if your
- boot disk permits it reading it directly from a
- CDROM.
-\item Continue as documented above as if you were
- using the Bacula Rescue CDROM -- that is.
-\item Re-partition your hard disk(s) as it was before,
- if necessary.
-\item Re-format your partitions, if necessary.
-\item Restore the Bacula File daemon (static version).
-\item Perform a Bacula restore of all your files.
-\item Re-install your boot loader.
-\item Reboot.
-\end{enumerate}
-
-In order to create the Bacula recovery directory, you need
-a copy of the Bacula Rescue code as described above, and
-you must first configure that directory (and possibly your
-Bacula source) as described above in the section entitled
-\ilink{Creating a Bacula Rescue CDROM}{CreateRescue}.
-
-Once the configuration is done, you can do the following
-to create the Bacula recovery directory:
-
-\footnotesize
-\begin{verbatim}
-cd <bacula-rescue-source>/linux/cdrom
-su (become root)
-make bacula
-\end{verbatim}
-\normalsize
-
-The directory you want to save will be created in
-the current directory with the name {\bf bacula}. You
-need only save that directory either as a directory or
-possibly as a compressed tar file. If you run this procedure
-on multiple machines, you will probably want to rename this directory
-to something like {\bf bacula-hostname}.
-
-
-
-\label{FreeBSD1}
-\section{FreeBSD Bare Metal Recovery}
-\index[general]{Recovery!FreeBSD Bare Metal}
-\index[general]{Rescue!FreeBSD Bare Metal}
-\index[general]{FreeBSD Bare Metal Recovery}
-
-The same basic techniques described above also apply to FreeBSD. Although we
-don't yet have a fully automated procedure, Alex Torres Molina has provided us
-with the following instructions with a few additions from Jesse Guardiani and
-Dan Langille:
-
-\begin{enumerate}
-\item Boot with the FreeBSD installation disk
-\item Go to Custom, Partition and create your slices and go to Label and
- create the partitions that you want. Apply changes.
-\item Go to Fixit to start an emergency console.
-\item Create devs ad0 .. .. if they don't exist under /mnt2/dev (in my situation)
- with MAKEDEV. The device or devices you create depend on what hard drives you
- have. ad0 is your first ATA drive. da0 would by your first SCSI drive. Under
-OS version 5 and greater, your device files are most likely automatically
-created for you.
-\item mkdir /mnt/disk
- this is the root of the new disk
-\item mount /mnt2/dev/ad0s1a /mnt/disk
- mount /mnt2/dev/ad0s1c /mnt/disk/var
- mount /mnt2/dev/ad0s1d /mnt/disk/usr
-.....
-The same hard drive issues as above apply here too. Note, under OS version 5
-or higher, your disk devices may be in /dev not /mnt2/dev.
-\item Network configuration (ifconfig xl0 ip/mask + route add default
- ip-gateway)
-\item mkdir /mnt/disk/tmp
-\item cd /mnt/disk/tmp
-\item Copy bacula-fd and bacula-fd.conf to this path
-\item If you need to, use sftp to copy files, after which you must do this:
- ln -s /mnt2/usr/bin /usr/bin
-\item chmod u+x bacula-fd
-\item Modify bacula-fd.conf to fit this machine
-\item Copy /bin/sh to /mnt/disk, necessary for chroot
-\item Don't forget to put your bacula-dir's IP address and domain name in
- /mnt/disk/etc/hosts if it's not on a public net. Otherwise the FD on the
- machine you are restoring to won't be able to contact the SD and DIR on the
-remote machine.
-\item mkdir -p /mnt/disk/var/db/bacula
-\item chroot /mnt/disk /tmp/bacula-fd -c /tmp/bacula-fd.conf
- to start bacula-fd
-\item Now you can go to bacula-dir and restore the job with the entire
- contents of the broken server.
-\item You must create /proc
-\end{enumerate}
-
-\label{solaris}
-\section{Solaris Bare Metal Recovery}
-\index[general]{Solaris Bare Metal Recovery}
-\index[general]{Recovery!Solaris Bare Metal}
-
-The same basic techniques described above apply to Solaris:
-
-\begin{itemize}
-\item the same restrictions as those given for Linux apply
-\item you will need to create a Bacula Rescue disk
- \end{itemize}
-
-However, during the recovery phase, the boot and disk preparation procedures
-are different:
-
-\begin{itemize}
-\item there is no need to create an emergency boot disk since it is an
- integrated part of the Solaris boot.
-\item you must partition and format your hard disk by hand following manual
- procedures as described in W. Curtis Preston's book "`Unix Backup \&
- Recovery"'
-\end{itemize}
-
-Once the disk is partitioned, formatted and mounted, you can continue with
-bringing up the network and reloading Bacula.
-
-\section{Preparing Solaris Before a Disaster}
-\index[general]{Preparing Solaris Before a Disaster}
-\index[general]{Disaster!Preparing Solaris Before a}
-
-As mentioned above, before a disaster strikes, you should prepare the
-information needed in the case of problems. To do so, in the {\bf
-rescue/solaris} subdirectory enter:
-
-\footnotesize
-\begin{verbatim}
-su
-./getdiskinfo
-./make_rescue_disk
-\end{verbatim}
-\normalsize
-
-The {\bf getdiskinfo} script will, as in the case of Linux described above,
-create a subdirectory {\bf diskinfo} containing the output from several system
-utilities. In addition, it will contain the output from the {\bf SysAudit}
-program as described in Curtis Preston's book. This file {\bf
-diskinfo/sysaudit.bsi} will contain the disk partitioning information that
-will allow you to manually follow the procedures in the "`Unix Backup \&
-Recovery"' book to repartition and format your hard disk. In addition, the
-{\bf getdiskinfo} script will create a {\bf start\_network} script.
-
-Once you have your disks repartitioned and formatted, do the following:
-
-\begin{itemize}
-\item Start Your Network with the {\bf start\_network} script
-\item Restore the Bacula File daemon as documented above
-\item Perform a Bacula restore of all your files using the same commands as
- described above for Linux
-\item Re-install your boot loader using the instructions outlined in the
- "`Unix Backup \& Recovery"' book using installboot
-\end{itemize}
-
-\label{genbugs}
-
-\section{Bugs and Other Considerations}
-\index[general]{Considerations!Bugs and Other}
-\index[general]{Bugs and Other Considerations}
-
-\paragraph*{Directory Modification and Access Times are Modified on pre-1.30
-Baculas :}
-
-When a pre-1.30 version of Bacula restores a directory, it first must create
-the directory, then it populates the directory with its files and
-subdirectories. The act of creating the files and subdirectories updates both
-the modification and access times associated with the directory itself. As a
-consequence, all modification and access times of all directories will be
-updated to the time of the restore.
-
-This has been corrected in Bacula version 1.30 and later. The directory
-modification and access times are reset to the value saved in the backup after
-all the files and subdirectories have been restored. This has been tested and
-verified on normal restore operations, but not verified during a bare metal
-recovery.
-
-\paragraph*{Strange Bootstrap Files:}
-
-If any of you look closely at the bootstrap file that is produced and used for
-the restore (I sure do), you will probably notice that the FileIndex item does
-not include all the files saved to the tape. This is because in some instances
-there are duplicates (especially in the case of an Incremental save), and in
-such circumstances, {\bf Bacula} restores only the last of multiple copies of
-a file or directory.
-
-\label{Win3233}
-\section{Disaster Recovery of Win32 Systems}
-\index[general]{Systems!Disaster Recovery of Win32}
-\index[general]{Disaster Recovery of Win32 Systems}
-
-Due to open system files, and registry problems, Bacula cannot save and
-restore a complete Win2K/XP/NT environment.
-
-A suggestion by Damian Coutts using Microsoft's NTBackup utility in
-conjunction with Bacula should permit a Full bare metal restore of Win2K/XP
-(and possibly NT systems). His suggestion is to do an NTBackup of the critical
-system state prior to running a Bacula backup with the following command:
-
-\footnotesize
-\begin{verbatim}
-ntbackup backup systemstate /F c:\systemstate.bkf
-\end{verbatim}
-\normalsize
-
-The {\bf backup} is the command, the {\bf systemstate} says to backup only the
-system state and not all the user files, and the {\bf /F
-c:\textbackslash{}systemstate.bkf} specifies where to write the state file.
-this file must then be saved and restored by Bacula. This command
-can be put in a Client Run Before Job directive so that it is automatically
-run during each backup, and thus saved to a Bacula Volume.
-
-To restore the system state, you first reload a base operating system, then
-you would use Bacula to restore all the users files and to recover the {\bf
-c:\textbackslash{}systemstate.bkf} file, and finally, run {\bf NTBackup} and
-{\bf catalogue} the system statefile, and then select it for restore. The
-documentation says you can't run a command line restore of the systemstate.
-
-This procedure has been confirmed to work by Ludovic Strappazon -- many
-thanks!
-
-A new tool is provided in the form of a bacula plugin for the BartPE rescue
-CD. BartPE is a self-contained WindowsXP boot CD which you can make using the
-PeBuilder tools available at
-\elink{http://www.nu2.nu/pebuilder/}{\url{http://www.nu2.nu/pebuilder/}} and a valid
-Windows XP SP1 CDROM. The plugin is provided as a zip archive. Unzip the file
-and copy the bacula directory into the plugin directory of your BartPE
-installation. Edit the configuration files to suit your installation and build
-your CD according to the instructions at Bart's site. This will permit you to
-boot from the cd, configure and start networking, start the bacula file client
-and access your director with the console program. The programs menu on the
-booted CD contains entries to install the file client service, start the file
-client service, and start the WX-Console. You can also open a command line
-window and CD Programs\textbackslash{}Bacula and run the command line console
-bconsole.
-
-\section{Ownership and Permissions on Win32 Systems}
-\index[general]{Systems!Resetting Directory and File Ownership and Permissions
-on Win32}
-\index[general]{Resetting Directory and File Ownership and Permissions on
-Win32 Systems}
-% TODO: should this be in the win32 chapter?
-
-Bacula versions after 1.31 should properly restore ownership and permissions
-on all WinNT/XP/2K systems. If you do experience problems, generally in
-restores to alternate directories because higher level directories were not
-backed up by Bacula, you can correct any problems with the {\bf SetACL}
-available under the GPL license at:
-\elink{http://sourceforge.net/projects/setacl/}{\url{http://sourceforge.net/project%
-s/setacl/}}.
-
-\section{Alternate Disaster Recovery Suggestion for Win32 Systems}
-\index[general]{Systems!Alternate Disaster Recovery Suggestion for Win32}
-\index[general]{Alternate Disaster Recovery Suggestion for Win32 Systems}
-% TODO: should this be in the win32 chapter??
-
-Ludovic Strappazon has suggested an interesting way to backup and restore
-complete Win32 partitions. Simply boot your Win32 system with a Linux Rescue
-disk as described above for Linux, install a statically linked Bacula, and
-backup any of the raw partitions you want. Then to restore the system, you
-simply restore the raw partition or partitions. Here is the email that Ludovic
-recently sent on that subject:
-
-\footnotesize
-\begin{verbatim}
-I've just finished testing my brand new cd LFS/Bacula
-with a raw Bacula backup and restore of my portable.
-I can't resist sending you the results: look at the rates !!!
-hunt-dir: Start Backup JobId 100, Job=HuntBackup.2003-04-17_12.58.26
-hunt-dir: Bacula 1.30 (14Apr03): 17-Apr-2003 13:14
-JobId: 100
-Job: HuntBackup.2003-04-17_12.58.26
-FileSet: RawPartition
-Backup Level: Full
-Client: sauvegarde-fd
-Start time: 17-Apr-2003 12:58
-End time: 17-Apr-2003 13:14
-Files Written: 1
-Bytes Written: 10,058,586,272
-Rate: 10734.9 KB/s
-Software Compression: None
-Volume names(s): 000103
-Volume Session Id: 2
-Volume Session Time: 1050576790
-Last Volume Bytes: 10,080,883,520
-FD termination status: OK
-SD termination status: OK
-Termination: Backup OK
-hunt-dir: Begin pruning Jobs.
-hunt-dir: No Jobs found to prune.
-hunt-dir: Begin pruning Files.
-hunt-dir: No Files found to prune.
-hunt-dir: End auto prune.
-hunt-dir: Start Restore Job RestoreFilesHunt.2003-04-17_13.21.44
-hunt-sd: Forward spacing to file 1.
-hunt-dir: Bacula 1.30 (14Apr03): 17-Apr-2003 13:54
-JobId: 101
-Job: RestoreFilesHunt.2003-04-17_13.21.44
-Client: sauvegarde-fd
-Start time: 17-Apr-2003 13:21
-End time: 17-Apr-2003 13:54
-Files Restored: 1
-Bytes Restored: 10,056,130,560
-Rate: 5073.7 KB/s
-FD termination status: OK
-Termination: Restore OK
-hunt-dir: Begin pruning Jobs.
-hunt-dir: No Jobs found to prune.
-hunt-dir: Begin pruning Files.
-hunt-dir: No Files found to prune.
-hunt-dir: End auto prune.
-\end{verbatim}
-\normalsize
-
-\label{running}
-
-\section{Restoring to a Running System}
-\index[general]{System!Restoring to a Running}
-\index[general]{Restoring to a Running System}
-
-If for some reason you want to do a Full restore to a system that has a
-working kernel (not recommended), you will need to take care not to
-overwrite the following files:
-
-\footnotesize
-\begin{verbatim}
-/etc/grub.conf
-/etc/X11/Conf
-/etc/fstab
-/etc/mtab
-/lib/modules
-/usr/modules
-/usr/X11R6
-/etc/modules.conf
-\end{verbatim}
-\normalsize
-
-\label{Resources}
-
-\section{Additional Resources}
-\index[general]{Additional Resources}
-\index[general]{Resources!Additional}
-
-Many thanks to Charles Curley who wrote
-\elink{Linux Complete Backup and Recovery HOWTO}
-{\url{http://www.tldp.org/HOWTO/Linux-Complete-Backup-and-Recovery-HOWTO/index.html%
-}} for the
-\elink{The Linux Documentation Project}{\url{http://www.tldp.org/}}. This is an
-excellent document on how to do Bare Metal Recovery on Linux systems, and it
-was this document that made me realize that Bacula could do the same thing.
-
-You can find quite a few additional resources, both commercial and free at
-\elink{Storage Mountain}{\url{http://www.backupcentral.com}}, formerly known as
-Backup Central.
-
-And finally, the O'Reilly book, "`Unix Backup \& Recovery"' by W. Curtis
-Preston covers virtually every backup and recovery topic including bare metal
-recovery for a large range of Unix systems.
+++ /dev/null
-%%
-%%
-\chapter{The Restore Command}
-\label{RestoreChapter}
-\index[general]{Command!Console Restore}
-\index[general]{Console Restore Command}
-
-\section{General}
-\index[general]{General }
-
-Below, we will discuss restoring files with the Console {\bf restore} command,
-which is the recommended way of doing restoring files. It is not possible
-to restore files by automatically starting a job as you do with Backup,
-Verify, ... jobs. However, in addition to the console restore command,
-there is a standalone program named {\bf bextract}, which also permits
-restoring files. For more information on this program, please see the
-\ilink{Bacula Utility Programs}{bextract} chapter of this manual. We
-don't particularly recommend the {\bf bextract} program because it
-lacks many of the features of the normal Bacula restore, such as the
-ability to restore Win32 files to Unix systems, and the ability to
-restore access control lists (ACL). As a consequence, we recommend,
-wherever possible to use Bacula itself for restores as described below.
-
-You may also want to look at the {\bf bls} program in the same chapter,
-which allows you to list the contents of your Volumes. Finally, if you
-have an old Volume that is no longer in the catalog, you can restore the
-catalog entries using the program named {\bf bscan}, documented in the same
-\ilink{Bacula Utility Programs}{bscan} chapter.
-
-In general, to restore a file or a set of files, you must run a {\bf restore}
-job. That is a job with {\bf Type = Restore}. As a consequence, you will need
-a predefined {\bf restore} job in your {\bf bacula-dir.conf} (Director's
-config) file. The exact parameters (Client, FileSet, ...) that you define are
-not important as you can either modify them manually before running the job or
-if you use the {\bf restore} command, explained below, Bacula will
-automatically set them for you. In fact, you can no longer simply run a restore
-job. You must use the restore command.
-
-Since Bacula is a network backup program, you must be aware that when you
-restore files, it is up to you to ensure that you or Bacula have selected the
-correct Client and the correct hard disk location for restoring those files.
-{\bf Bacula} will quite willingly backup client A, and restore it by sending
-the files to a different directory on client B. Normally, you will want to
-avoid this, but assuming the operating systems are not too different in their
-file structures, this should work perfectly well, if so desired.
-By default, Bacula will restore data to the same Client that was backed
-up, and those data will be restored not to the original places but to
-{\bf /tmp/bacula-restores}. You may modify any of these defaults when the
-restore command prompts you to run the job by selecting the {\bf mod}
-option.
-
-\label{Example1}
-\section{The Restore Command}
-\index[general]{Command!Restore}
-\index[general]{Restore Command}
-
-Since Bacula maintains a catalog of your files and on which Volumes (disk or
-tape), they are stored, it can do most of the bookkeeping work, allowing you
-simply to specify what kind of restore you want (current, before a particular
-date), and what files to restore. Bacula will then do the rest.
-
-This is accomplished using the {\bf restore} command in the Console. First you
-select the kind of restore you want, then the JobIds are selected,
-the File records for those Jobs are placed in an internal Bacula directory
-tree, and the restore enters a file selection mode that allows you to
-interactively walk up and down the file tree selecting individual files to be
-restored. This mode is somewhat similar to the standard Unix {\bf restore}
-program's interactive file selection mode.
-
-If a Job's file records have been pruned from the catalog, the {\bf
-restore} command will be unable to find any files to restore. See below
-for more details on this.
-
-Within the Console program, after entering the {\bf restore} command, you are
-presented with the following selection prompt:
-
-\footnotesize
-\begin{verbatim}
-First you select one or more JobIds that contain files
-to be restored. You will be presented several methods
-of specifying the JobIds. Then you will be allowed to
-select which files from those JobIds are to be restored.
-To select the JobIds, you have the following choices:
- 1: List last 20 Jobs run
- 2: List Jobs where a given File is saved
- 3: Enter list of comma separated JobIds to select
- 4: Enter SQL list command
- 5: Select the most recent backup for a client
- 6: Select backup for a client before a specified time
- 7: Enter a list of files to restore
- 8: Enter a list of files to restore before a specified time
- 9: Find the JobIds of the most recent backup for a client
- 10: Find the JobIds for a backup for a client before a specified time
- 11: Enter a list of directories to restore for found JobIds
- 12: Cancel
-Select item: (1-12):
-\end{verbatim}
-\normalsize
-
-There are a lot of options, and as a point of reference, most people will
-want to slect item 5 (the most recent backup for a client). The details
-of the above options are:
-
-\begin{itemize}
-\item Item 1 will list the last 20 jobs run. If you find the Job you want,
- you can then select item 3 and enter its JobId(s).
-
-\item Item 2 will list all the Jobs where a specified file is saved. If you
- find the Job you want, you can then select item 3 and enter the JobId.
-
-\item Item 3 allows you the enter a list of comma separated JobIds whose
- files will be put into the directory tree. You may then select which
- files from those JobIds to restore. Normally, you would use this option
- if you have a particular version of a file that you want to restore and
- you know its JobId. The most common options (5 and 6) will not select
- a job that did not terminate normally, so if you know a file is
- backed up by a Job that failed (possibly because of a system crash), you
- can access it through this option by specifying the JobId.
-
-\item Item 4 allows you to enter any arbitrary SQL command. This is
- probably the most primitive way of finding the desired JobIds, but at
- the same time, the most flexible. Once you have found the JobId(s), you
- can select item 3 and enter them.
-
-\item Item 5 will automatically select the most recent Full backup and all
- subsequent incremental and differential backups for a specified Client.
- These are the Jobs and Files which, if reloaded, will restore your
- system to the most current saved state. It automatically enters the
- JobIds found into the directory tree in an optimal way such that only
- the most recent copy of any particular file found in the set of Jobs
- will be restored. This is probably the most convenient of all the above
- options to use if you wish to restore a selected Client to its most
- recent state.
-
- There are two important things to note. First, this automatic selection
- will never select a job that failed (terminated with an error status).
- If you have such a job and want to recover one or more files from it,
- you will need to explicitly enter the JobId in item 3, then choose the
- files to restore.
-
- If some of the Jobs that are needed to do the restore have had their
- File records pruned, the restore will be incomplete. Bacula currently
- does not correctly detect this condition. You can however, check for
- this by looking carefully at the list of Jobs that Bacula selects and
- prints. If you find Jobs with the JobFiles column set to zero, when
- files should have been backed up, then you should expect problems.
-
- If all the File records have been pruned, Bacula will realize that there
- are no file records in any of the JobIds chosen and will inform you. It
- will then propose doing a full restore (non-selective) of those JobIds.
- This is possible because Bacula still knows where the beginning of the
- Job data is on the Volumes, even if it does not know where particular
- files are located or what their names are.
-
-\item Item 6 allows you to specify a date and time, after which Bacula will
- automatically select the most recent Full backup and all subsequent
- incremental and differential backups that started before the specified date
- and time.
-
-\item Item 7 allows you to specify one or more filenames (complete path
- required) to be restored. Each filename is entered one at a time or if you
- prefix a filename with the less-than symbol (\lt{}) Bacula will read that
- file and assume it is a list of filenames to be restored. If you
- prefix the filename with a question mark (?), then the filename will
- be interpreted as an SQL table name, and Bacula will include the rows
- of that table in the list to be restored. The table must contain the
- JobId in the first column and the FileIndex in the second column.
- This table feature is intended for external programs that want to build
- their own list of files to be restored.
- The filename entry mode is terminated by entering a blank line.
-
-\item Item 8 allows you to specify a date and time before entering the
- filenames. See Item 7 above for more details.
-
-\item Item 9 allows you find the JobIds of the most recent backup for
- a client. This is much like option 5 (it uses the same code), but
- those JobIds are retained internally as if you had entered them
- manually. You may then select item 11 (see below) to restore one
- or more directories.
-
-\item Item 10 is the same as item 9, except that it allows you to enter
- a before date (as with item 6). These JobIds will then be retained
- internally.
-
-\index[general]{Restore Directories}
-\item Item 11 allows you to enter a list of JobIds from which you can
- select directories to be restored. The list of JobIds can have been
- previously created by using either item 9 or 10 on the menu. You
- may then enter a full path to a directory name or a filename preceded
- by a less than sign (\lt{}). The filename should contain a list
- of directories to be restored. All files in those directories will
- be restored, but if the directory contains subdirectories, nothing
- will be restored in the subdirectory unless you explicitly enter its
- name.
-
-\item Item 12 allows you to cancel the restore command.
-\end{itemize}
-
-As an example, suppose that we select item 5 (restore to most recent state).
-If you have not specified a client=xxx on the command line, it
-it will then ask for the desired Client, which on my system, will print all
-the Clients found in the database as follows:
-
-\footnotesize
-\begin{verbatim}
-Defined clients:
- 1: Rufus
- 2: Matou
- 3: Polymatou
- 4: Minimatou
- 5: Minou
- 6: MatouVerify
- 7: PmatouVerify
- 8: RufusVerify
- 9: Watchdog
-Select Client (File daemon) resource (1-9):
-\end{verbatim}
-\normalsize
-
-You will probably have far fewer Clients than this example, and if you have
-only one Client, it will be automatically selected. In this case, I enter
-{\bf Rufus} to select the Client. Then Bacula needs to know what FileSet is
-to be restored, so it prompts with:
-
-\footnotesize
-\begin{verbatim}
-The defined FileSet resources are:
- 1: Full Set
- 2: Other Files
-Select FileSet resource (1-2):
-\end{verbatim}
-\normalsize
-
-If you have only one FileSet defined for the Client, it will be selected
-automatically. I choose item 1, which is my full backup. Normally, you
-will only have a single FileSet for each Job, and if your machines are
-similar (all Linux) you may only have one FileSet for all your Clients.
-
-At this point, {\bf Bacula} has all the information it needs to find the most
-recent set of backups. It will then query the database, which may take a bit
-of time, and it will come up with something like the following. Note, some of
-the columns are truncated here for presentation:
-
-\footnotesize
-\begin{verbatim}
-+-------+------+----------+-------------+-------------+------+-------+----------
---+
-| JobId | Levl | JobFiles | StartTime | VolumeName | File | SesId |
-VolSesTime |
-+-------+------+----------+-------------+-------------+------+-------+----------
---+
-| 1,792 | F | 128,374 | 08-03 01:58 | DLT-19Jul02 | 67 | 18 |
-1028042998 |
-| 1,792 | F | 128,374 | 08-03 01:58 | DLT-04Aug02 | 0 | 18 |
-1028042998 |
-| 1,797 | I | 254 | 08-04 13:53 | DLT-04Aug02 | 5 | 23 |
-1028042998 |
-| 1,798 | I | 15 | 08-05 01:05 | DLT-04Aug02 | 6 | 24 |
-1028042998 |
-+-------+------+----------+-------------+-------------+------+-------+----------
---+
-You have selected the following JobId: 1792,1792,1797
-Building directory tree for JobId 1792 ...
-Building directory tree for JobId 1797 ...
-Building directory tree for JobId 1798 ...
-cwd is: /
-$
-\end{verbatim}
-\normalsize
-
-Depending on the number of {\bf JobFiles} for each JobId, the {\bf Building
-directory tree ...} can take a bit of time. If you notice ath all the
-JobFiles are zero, your Files have probably been pruned and you will not be
-able to select any individual files -- it will be restore everything or
-nothing.
-
-In our example, Bacula found four Jobs that comprise the most recent backup of
-the specified Client and FileSet. Two of the Jobs have the same JobId because
-that Job wrote on two different Volumes. The third Job was an incremental
-backup to the previous Full backup, and it only saved 254 Files compared to
-128,374 for the Full backup. The fourth Job was also an incremental backup
-that saved 15 files.
-
-Next Bacula entered those Jobs into the directory tree, with no files marked
-to be restored as a default, tells you how many files are in the tree, and
-tells you that the current working directory ({\bf cwd}) is /. Finally, Bacula
-prompts with the dollar sign (\$) to indicate that you may enter commands to
-move around the directory tree and to select files.
-
-If you want all the files to automatically be marked when the directory
-tree is built, you could have entered the command {\bf restore all}, or
-at the \$ prompt, you can simply enter {\bf mark *}.
-
-Instead of choosing item 5 on the first menu (Select the most recent backup
-for a client), if we had chosen item 3 (Enter list of JobIds to select) and we
-had entered the JobIds {\bf 1792,1797,1798} we would have arrived at the same
-point.
-
-One point to note, if you are manually entering JobIds, is that you must enter
-them in the order they were run (generally in increasing JobId order). If you
-enter them out of order and the same file was saved in two or more of the
-Jobs, you may end up with an old version of that file (i.e. not the most
-recent).
-
-Directly entering the JobIds can also permit you to recover data from
-a Job that wrote files to tape but that terminated with an error status.
-
-While in file selection mode, you can enter {\bf help} or a question mark (?)
-to produce a summary of the available commands:
-
-\footnotesize
-\begin{verbatim}
- Command Description
- ======= ===========
- cd change current directory
- count count marked files in and below the cd
- dir long list current directory, wildcards allowed
- done leave file selection mode
- estimate estimate restore size
- exit same as done command
- find find files, wildcards allowed
- help print help
- ls list current directory, wildcards allowed
- lsmark list the marked files in and below the cd
- mark mark dir/file to be restored recursively in dirs
- markdir mark directory name to be restored (no files)
- pwd print current working directory
- unmark unmark dir/file to be restored recursively in dir
- unmarkdir unmark directory name only no recursion
- quit quit and do not do restore
- ? print help
-\end{verbatim}
-\normalsize
-
-As a default no files have been selected for restore (unless you
-added {\bf all} to the command line. If you want to restore
-everything, at this point, you should enter {\bf mark *}, and then {\bf done}
-and {\bf Bacula} will write the bootstrap records to a file and request your
-approval to start a restore job.
-
-If you do not enter the above mentioned {\bf mark *} command, you will start
-with an empty slate. Now you can simply start looking at the tree and {\bf
-mark} particular files or directories you want restored. It is easy to make
-a mistake in specifying a file to mark or unmark, and Bacula's error handling
-is not perfect, so please check your work by using the {\bf ls} or {\bf dir}
-commands to see what files are actually selected. Any selected file has its
-name preceded by an asterisk.
-
-To check what is marked or not marked, enter the {\bf count} command, which
-displays:
-
-\footnotesize
-\begin{verbatim}
-128401 total files. 128401 marked to be restored.
-
-\end{verbatim}
-\normalsize
-
-Each of the above commands will be described in more detail in the next
-section. We continue with the above example, having accepted to restore all
-files as Bacula set by default. On entering the {\bf done} command, Bacula
-prints:
-
-\footnotesize
-\begin{verbatim}
-Bootstrap records written to /home/kern/bacula/working/restore.bsr
-The job will require the following
- Volume(s) Storage(s) SD Device(s)
-===========================================================================
-
- DLT-19Jul02 Tape DLT8000
- DLT-04Aug02 Tape DLT8000
-
-128401 files selected to restore.
-Run Restore job
-JobName: kernsrestore
-Bootstrap: /home/kern/bacula/working/restore.bsr
-Where: /tmp/bacula-restores
-Replace: always
-FileSet: Other Files
-Client: Rufus
-Storage: Tape
-When: 2006-12-11 18:20:33
-Catalog: MyCatalog
-Priority: 10
-OK to run? (yes/mod/no):
-
-\end{verbatim}
-\normalsize
-
-Please examine each of the items very carefully to make sure that they are
-correct. In particular, look at {\bf Where}, which tells you where in the
-directory structure the files will be restored, and {\bf Client}, which
-tells you which client will receive the files. Note that by default the
-Client which will receive the files is the Client that was backed up.
-These items will not always be completed with the correct values depending
-on which of the restore options you chose. You can change any of these
-default items by entering {\bf mod} and responding to the prompts.
-
-The above assumes that you have defined a {\bf Restore} Job resource in your
-Director's configuration file. Normally, you will only need one Restore Job
-resource definition because by its nature, restoring is a manual operation,
-and using the Console interface, you will be able to modify the Restore Job to
-do what you want.
-
-An example Restore Job resource definition is given below.
-
-Returning to the above example, you should verify that the Client name is
-correct before running the Job. However, you may want to modify some of the
-parameters of the restore job. For example, in addition to checking the Client
-it is wise to check that the Storage device chosen by Bacula is indeed
-correct. Although the {\bf FileSet} is shown, it will be ignored in restore.
-The restore will choose the files to be restored either by reading the {\bf
-Bootstrap} file, or if not specified, it will restore all files associated
-with the specified backup {\bf JobId} (i.e. the JobId of the Job that
-originally backed up the files).
-
-Finally before running the job, please note that the default location for
-restoring files is {\bf not} their original locations, but rather the directory
-{\bf /tmp/bacula-restores}. You can change this default by modifying your {\bf
-bacula-dir.conf} file, or you can modify it using the {\bf mod} option. If you
-want to restore the files to their original location, you must have {\bf
-Where} set to nothing or to the root, i.e. {\bf /}.
-
-If you now enter {\bf yes}, Bacula will run the restore Job. The Storage
-daemon will first request Volume {\bf DLT-19Jul02} and after the appropriate
-files have been restored from that volume, it will request Volume {\bf
-DLT-04Aug02}.
-
-\section{Selecting Files by Filename}
-\index[general]{Selecting Files by Filename }
-\index[general]{Filename!Selecting Files by }
-
-If you have a small number of files to restore, and you know the filenames,
-you can either put the list of filenames in a file to be read by Bacula, or
-you can enter the names one at a time. The filenames must include the full
-path and filename. No wild cards are used.
-
-To enter the files, after the {\bf restore}, you select item number 7 from the
-prompt list:
-
-\footnotesize
-\begin{verbatim}
-To select the JobIds, you have the following choices:
- 1: List last 20 Jobs run
- 2: List Jobs where a given File is saved
- 3: Enter list of comma separated JobIds to select
- 4: Enter SQL list command
- 5: Select the most recent backup for a client
- 6: Select backup for a client before a specified time
- 7: Enter a list of files to restore
- 8: Enter a list of files to restore before a specified time
- 9: Find the JobIds of the most recent backup for a client
- 10: Find the JobIds for a backup for a client before a specified time
- 11: Enter a list of directories to restore for found JobIds
- 12: Cancel
-Select item: (1-12):
-\end{verbatim}
-\normalsize
-
-which then prompts you for the client name:
-
-\footnotesize
-\begin{verbatim}
-Defined Clients:
- 1: Timmy
- 2: Tibs
- 3: Rufus
-Select the Client (1-3): 3
-\end{verbatim}
-\normalsize
-
-Of course, your client list will be different, and if you have only one
-client, it will be automatically selected. And finally, Bacula requests you to
-enter a filename:
-
-\footnotesize
-\begin{verbatim}
-Enter filename:
-\end{verbatim}
-\normalsize
-
-At this point, you can enter the full path and filename
-
-\footnotesize
-\begin{verbatim}
-Enter filename: /home/kern/bacula/k/Makefile.in
-Enter filename:
-\end{verbatim}
-\normalsize
-
-as you can see, it took the filename. If Bacula cannot find a copy of the
-file, it prints the following:
-
-\footnotesize
-\begin{verbatim}
-Enter filename: junk filename
-No database record found for: junk filename
-Enter filename:
-\end{verbatim}
-\normalsize
-
-If you want Bacula to read the filenames from a file, you simply precede the
-filename with a less-than symbol (\lt{}). When you have entered all the
-filenames, you enter a blank line, and Bacula will write the bootstrap file,
-tells you what tapes will be used, and proposes a Restore job to be run:
-
-\footnotesize
-\begin{verbatim}
-Enter filename:
-Automatically selected Storage: DDS-4
-Bootstrap records written to /home/kern/bacula/working/restore.bsr
-The restore job will require the following Volumes:
-
- test1
-1 file selected to restore.
-Run Restore job
-JobName: kernsrestore
-Bootstrap: /home/kern/bacula/working/restore.bsr
-Where: /tmp/bacula-restores
-Replace: always
-FileSet: Other Files
-Client: Rufus
-Storage: DDS-4
-When: 2003-09-11 10:20:53
-Priority: 10
-OK to run? (yes/mod/no):
-\end{verbatim}
-\normalsize
-
-It is possible to automate the selection by file by putting your list of files
-in say {\bf /tmp/file-list}, then using the following command:
-
-\footnotesize
-\begin{verbatim}
-restore client=Rufus file=</tmp/file-list
-\end{verbatim}
-\normalsize
-
-If in modifying the parameters for the Run Restore job, you find that Bacula
-asks you to enter a Job number, this is because you have not yet specified
-either a Job number or a Bootstrap file. Simply entering zero will allow you
-to continue and to select another option to be modified.
-\label{CommandArguments}
-
-\section{Command Line Arguments}
-\index[general]{Arguments!Command Line }
-\index[general]{Command Line Arguments }
-
-If all the above sounds complicated, you will probably agree that it really
-isn't after trying it a few times. It is possible to do everything that was
-shown above, with the exception of selecting the FileSet, by using command
-line arguments with a single command by entering:
-
-\footnotesize
-\begin{verbatim}
-restore client=Rufus select current all done yes
-\end{verbatim}
-\normalsize
-
-The {\bf client=Rufus} specification will automatically select Rufus as the
-client, the {\bf current} tells Bacula that you want to restore the system to
-the most current state possible, and the {\bf yes} suppresses the final {\bf
-yes/mod/no} prompt and simply runs the restore.
-
-The full list of possible command line arguments are:
-
-\begin{itemize}
-\item {\bf all} -- select all Files to be restored.
-\item {\bf select} -- use the tree selection method.
-\item {\bf done} -- do not prompt the user in tree mode.
-\item {\bf current} -- automatically select the most current set of backups
- for the specified client.
-\item {\bf client=xxxx} -- select the specified client.
-\item {\bf jobid=nnn} -- specify a JobId or comma separated list of JobIds to
- be restored.
-\item {\bf before=YYYY-MM-DD HH:MM:SS} -- specify a date and time to which
- the system should be restored. Only Jobs started before the specified
- date/time will be selected, and as is the case for {\bf current} Bacula will
- automatically find the most recent prior Full save and all Differential and
- Incremental saves run before the date you specify. Note, this command is not
- too user friendly in that you must specify the date/time exactly as shown.
-\item {\bf file=filename} -- specify a filename to be restored. You must
- specify the full path and filename. Prefixing the entry with a less-than
- sign
- (\lt{}) will cause Bacula to assume that the filename is on your system and
- contains a list of files to be restored. Bacula will thus read the list from
- that file. Multiple file=xxx specifications may be specified on the command
- line.
-\item {\bf jobid=nnn} -- specify a JobId to be restored.
-\item {\bf pool=pool-name} -- specify a Pool name to be used for selection of
- Volumes when specifying options 5 and 6 (restore current system, and restore
- current system before given date). This permits you to have several Pools,
- possibly one offsite, and to select the Pool to be used for restoring.
-\item {\bf where=/tmp/bacula-restore} -- restore files in {\bf where} directory.
-\item {\bf yes} -- automatically run the restore without prompting for
- modifications (most useful in batch scripts).
-\item {\bf strip\_prefix=/prod} -- remove a part of the filename when restoring.
-\item {\bf add\_prefix=/test} -- add a prefix to all files when restoring (like
- where) (can't be used with {\bf where=}).
-\item {\bf add\_suffix=.old} -- add a suffix to all your files.
-\item {\bf regexwhere=!a.pdf!a.bkp.pdf!} -- do complex filename manipulation
- like with sed unix command. Will overwrite other filename manipulation.
-\end{itemize}
-
-\label{restorefilerelocation}
-\section{Using File Relocation}
-\index[general]{Using File Relocation}
-\label{filerelocation}
-
-\subsection{Introduction}
-
-The \textbf{where=} option is simple, but not very powerful. With file
-relocation, Bacula can restore a file to the same directory, but with a
-different name, or in an other directory without recreating the full path.
-
-You can also do filename and path manipulations, implemented in Bacula
-2.1.8 or later, such as adding a suffix to all your files, renaming files
-or directories, etc. Theses options will overwrite {\bf where=} option.
-
-
-For example, many users use OS snapshot features so that file
-\texttt{/home/eric/mbox} will be backed up from the directory
-\texttt{/.snap/home/eric/mbox}, which can complicate restores. If you use
-\textbf{where=/tmp}, the file will be restored to
-\texttt{/tmp/.snap/home/eric/mbox} and you will have to move the file to
-\texttt{/home/eric/mbox.bkp} by hand. In this case, you could use
-\textbf{strip\_prefix=/.snap} and \textbf{add\_suffix=.bkp} options and
-Bacula will restore the file to its original location -- that is
-\texttt{/home/eric/mbox}.
-
-To use this feature, there are command line options as described in
-the \ilink{restore section}{restorefilerelocation} of this manual;
-you can modify your restore job before running it; or you can
-add options to your restore job in as described in
-\ilink{bacula-dir.conf}{confaddprefix}.
-
-\begin{verbatim}
-Parameters to modify:
- 1: Level
- 2: Storage
-..
- 10: File Relocation
-..
-Select parameter to modify (1-12):
-
-
-This will replace your current Where value
- 1: Strip prefix
- 2: Add prefix
- 3: Add file suffix
- 4: Enter a regexp
- 5: Test filename manipulation
- 6: Use this ?
-Select parameter to modify (1-6):
-\end{verbatim}
-
-
-\subsection{RegexWhere format}
-
-The format is very close to that used by sed or Perl (\texttt{s/replace this/by
- that/}) operator. A valid regexwhere expression has three fields :
-\begin{itemize}
-\item a search expression (with optionnal submatch)
-\item a replacement expression (with optionnal back references \$1 to \$9)
-\item a set of search options (only case-insensitive ``i'' at this time)
-\end{itemize}
-
-Each field is delimited by a separator specified by the user as the first
-character of the expression. The separator can be one of the following:
-\begin{verbatim}
-<separator-keyword> = / !�; % : , ~ # = &
-\end{verbatim}
-
-You can use several expressions separated by a commas.
-
-\subsection*{Examples}
-
-\begin{tabular}{|c|c|c|l}
-\hline
-Orignal filename & Computed filename & RegexWhere & Comments \\
-\hline
-\hline
-\texttt{c:/system.ini} & \texttt{c:/system.old.ini} & \texttt{/.ini\$/.old.ini/} & use \$ as end of filename\\
-\hline
-\texttt{/prod/u01/pdata/} & \texttt{/rect/u01/rdata} & \texttt{/prod/rect/,/pdata/rdata/} & using two regexp\\
-\hline
-\texttt{/prod/u01/pdata/} & \texttt{/rect/u01/rdata} & \texttt{!/prod/!/rect/!,/pdata/rdata/} & using \texttt{!} instead of \texttt{/}\\
-\hline
-\texttt{C:/WINNT} & \texttt{d:/WINNT} & \texttt{/c:/d:/i} & using case-insensitive pattern matching \\
-\hline
-
-\end{tabular}
-
-%\subsubsection{Using group}
-%
-%Like with Perl or Sed, you can make submatch with \texttt{()},
-%
-%\subsubsection*{Examples}
-
-
-%\subsubsection{Options}
-%
-% i Do case-insensitive pattern matching.
-
-\section{Restoring Directory Attributes}
-\index[general]{Attributes!Restoring Directory }
-\index[general]{Restoring Directory Attributes }
-
-Depending how you do the restore, you may or may not get the directory entries
-back to their original state. Here are a few of the problems you can
-encounter, and for same machine restores, how to avoid them.
-
-\begin{itemize}
-\item You backed up on one machine and are restoring to another that is
- either a different OS or doesn't have the same users/groups defined. Bacula
- does the best it can in these situations. Note, Bacula has saved the
- user/groups in numeric form, which means on a different machine, they
- may map to different user/group names.
-
-\item You are restoring into a directory that is already created and has
- file creation restrictions. Bacula tries to reset everything but
- without walking up the full chain of directories and modifying them all
- during the restore, which Bacula does and will not do, getting
- permissions back correctly in this situation depends to a large extent
- on your OS.
-
-\item You are doing a recursive restore of a directory tree. In this case
- Bacula will restore a file before restoring the file's parent directory
- entry. In the process of restoring the file Bacula will create the
- parent directory with open permissions and ownership of the file being
- restored. Then when Bacula tries to restore the parent directory Bacula
- sees that it already exists (Similar to the previous situation). If you
- had set the Restore job's "Replace" property to "never" then Bacula will
- not change the directory's permissions and ownerships to match what it
- backed up, you should also notice that the actual number of files
- restored is less then the expected number. If you had set the Restore
- job's "Replace" property to "always" then Bacula will change the
- Directory's ownership and permissions to match what it backed up, also
- the actual number of files restored should be equal to the expected
- number.
-
-\item You selected one or more files in a directory, but did not select the
- directory entry to be restored. In that case, if the directory is not
- on disk Bacula simply creates the directory with some default attributes
- which may not be the same as the original. If you do not select a
- directory and all its contents to be restored, you can still select
- items within the directory to be restored by individually marking those
- files, but in that case, you should individually use the "markdir"
- command to select all higher level directory entries (one at a time) to
- be restored if you want the directory entries properly restored.
-
-\item The {\bf bextract} program does not restore access control lists
- (ACLs), nor will it restore non-portable Win32 data (default) to Unix
- machines.
-\end{itemize}
-
-\label{Windows}
-\section{Restoring on Windows}
-\index[general]{Restoring on Windows }
-\index[general]{Windows!Restoring on }
-
-If you are restoring on WinNT/2K/XP systems, Bacula will restore the files
-with the original ownerships and permissions as would be expected. This is
-also true if you are restoring those files to an alternate directory (using
-the Where option in restore). However, if the alternate directory does not
-already exist, the Bacula File daemon (Client) will try to create it. In
-some cases, it may not create the directories, and if it does since the
-File daemon runs under the SYSTEM account, the directory will be created
-with SYSTEM ownership and permissions. In this case, you may have problems
-accessing the newly restored files.
-
-To avoid this problem, you should create any alternate directory before
-doing the restore. Bacula will not change the ownership and permissions of
-the directory if it is already created as long as it is not one of the
-directories being restored (i.e. written to tape).
-
-The default restore location is {\bf /tmp/bacula-restores/} and if you are
-restoring from drive {\bf E:}, the default will be
-{\bf /tmp/bacula-restores/e/}, so you should ensure that this directory
-exists before doing the restore, or use the {\bf mod} option to
-select a different {\bf where} directory that does exist.
-
-Some users have experienced problems restoring files that participate in
-the Active Directory. They also report that changing the userid under which
-Bacula (bacula-fd.exe) runs, from SYSTEM to a Domain Admin userid, resolves
-the problem.
-
-
-\section{Restoring Files Can Be Slow}
-\index[general]{Slow!Restoring Files Can Be }
-\index[general]{Restoring Files Can Be Slow }
-
-Restoring files is generally {\bf much} slower than backing them up for several
-reasons. The first is that during a backup the tape is normally already
-positioned and Bacula only needs to write. On the other hand, because restoring
-files is done so rarely, Bacula keeps only the start file and block on the
-tape for the whole job rather than on a file by file basis which would use
-quite a lot of space in the catalog.
-
-Bacula will forward space to the correct file mark on the tape for the Job,
-then forward space to the correct block, and finally sequentially read each
-record until it gets to the correct one(s) for the file or files you want to
-restore. Once the desired files are restored, Bacula will stop reading the
-tape.
-
-Finally, instead of just reading a file for backup, during the restore, Bacula
-must create the file, and the operating system must allocate disk space for
-the file as Bacula is restoring it.
-
-For all the above reasons the restore process is generally much slower than
-backing up (sometimes it takes three times as long).
-
-\section{Problems Restoring Files}
-\index[general]{Files!Problems Restoring }
-\index[general]{Problems Restoring Files }
-
-The most frequent problems users have restoring files are error messages such
-as:
-
-\footnotesize
-\begin{verbatim}
-04-Jan 00:33 z217-sd: RestoreFiles.2005-01-04_00.31.04 Error:
-block.c:868 Volume data error at 20:0! Short block of 512 bytes on
-device /dev/tape discarded.
-\end{verbatim}
-\normalsize
-
-or
-
-\footnotesize
-\begin{verbatim}
-04-Jan 00:33 z217-sd: RestoreFiles.2005-01-04_00.31.04 Error:
-block.c:264 Volume data error at 20:0! Wanted ID: "BB02", got ".".
-Buffer discarded.
-\end{verbatim}
-\normalsize
-
-Both these kinds of messages indicate that you were probably running your tape
-drive in fixed block mode rather than variable block mode. Fixed block mode
-will work with any program that reads tapes sequentially such as tar, but
-Bacula repositions the tape on a block basis when restoring files because this
-will speed up the restore by orders of magnitude when only a few files are being
-restored. There are several ways that you can attempt to recover from this
-unfortunate situation.
-
-Try the following things, each separately, and reset your Device resource to
-what it is now after each individual test:
-
-\begin{enumerate}
-\item Set "Block Positioning = no" in your Device resource and try the
- restore. This is a new directive and untested.
-
-\item Set "Minimum Block Size = 512" and "Maximum Block Size = 512" and
- try the restore. If you are able to determine the block size your drive
- was previously using, you should try that size if 512 does not work.
- This is a really horrible solution, and it is not at all recommended
- to continue backing up your data without correcting this condition.
- Please see the Tape Testing chapter for more on this.
-
-\item Try editing the restore.bsr file at the Run xxx yes/mod/no prompt
- before starting the restore job and remove all the VolBlock statements.
- These are what causes Bacula to reposition the tape, and where problems
- occur if you have a fixed block size set for your drive. The VolFile
- commands also cause repositioning, but this will work regardless of the
- block size.
-
-\item Use bextract to extract the files you want -- it reads the Volume
- sequentially if you use the include list feature, or if you use a .bsr
- file, but remove all the VolBlock statements after the .bsr file is
- created (at the Run yes/mod/no) prompt but before you start the restore.
-\end{enumerate}
-
-\section{Restore Errors}
-\index[general]{Errors!Restore}
-\index[general]{Restore Errors}
-
-There are a number of reasons why there may be restore errors or
-warning messages. Some of the more common ones are:
-
-\begin{description}
-
-\item [file count mismatch]
- This can occur for the following reasons:
- \begin{itemize}
- \item You requested Bacula not to overwrite existing or newer
- files.
- \item A Bacula miscount of files/directories. This is an
- on-going problem due to the complications of directories,
- soft/hard link, and such. Simply check that all the files you
- wanted were actually restored.
- \end{itemize}
-
-\item [file size error]
- When Bacula restores files, it checks that the size of the
- restored file is the same as the file status data it saved
- when starting the backup of the file. If the sizes do not
- agree, Bacula will print an error message. This size mismatch
- most often occurs because the file was being written as Bacula
- backed up the file. In this case, the size that Bacula
- restored will be greater than the status size. This often
- happens with log files.
-
- If the restored size is smaller, then you should be concerned
- about a possible tape error and check the Bacula output as
- well as your system logs.
-\end{description}
-
-
-
-\section{Example Restore Job Resource}
-\index[general]{Example Restore Job Resource }
-\index[general]{Resource!Example Restore Job }
-
-\footnotesize
-\begin{verbatim}
-Job {
- Name = "RestoreFiles"
- Type = Restore
- Client = Any-client
- FileSet = "Any-FileSet"
- Storage = Any-storage
- Where = /tmp/bacula-restores
- Messages = Standard
- Pool = Default
-}
-\end{verbatim}
-\normalsize
-
-If {\bf Where} is not specified, the default location for restoring files will
-be their original locations.
-\label{Selection}
-
-\section{File Selection Commands}
-\index[general]{Commands!File Selection }
-\index[general]{File Selection Commands }
-
-After you have selected the Jobs to be restored and Bacula has created the
-in-memory directory tree, you will enter file selection mode as indicated by
-the dollar sign ({\bf \$}) prompt. While in this mode, you may use the
-commands listed above. The basic idea is to move up and down the in memory
-directory structure with the {\bf cd} command much as you normally do on the
-system. Once you are in a directory, you may select the files that you want
-restored. As a default no files are marked to be restored. If you wish to
-start with all files, simply enter: {\bf cd /} and {\bf mark *}. Otherwise
-proceed to select the files you wish to restore by marking them with the {\bf
-mark} command. The available commands are:
-
-\begin{description}
-
-\item [cd]
- The {\bf cd} command changes the current directory to the argument
- specified.
- It operates much like the Unix {\bf cd} command. Wildcard specifications are
- not permitted.
-
- Note, on Windows systems, the various drives (c:, d:, ...) are treated like
- a
- directory within the file tree while in the file selection mode. As a
- consequence, you must do a {\bf cd c:} or possibly in some cases a {\bf cd
- C:} (note upper case) to get down to the first directory.
-
-\item [dir]
- \index[dir]{dir }
- The {\bf dir} command is similar to the {\bf ls} command, except that it
- prints it in long format (all details). This command can be a bit slower
- than
- the {\bf ls} command because it must access the catalog database for the
- detailed information for each file.
-
-\item [estimate]
- \index[dir]{estimate }
- The {\bf estimate} command prints a summary of the total files in the tree,
- how many are marked to be restored, and an estimate of the number of bytes
- to
- be restored. This can be useful if you are short on disk space on the
- machine
- where the files will be restored.
-
-\item [find]
- \index[dir]{find}
- The {\bf find} command accepts one or more arguments and displays all files
- in the tree that match that argument. The argument may have wildcards. It is
- somewhat similar to the Unix command {\bf find / -name arg}.
-
-\item [ls]
- The {\bf ls} command produces a listing of all the files contained in the
- current directory much like the Unix {\bf ls} command. You may specify an
- argument containing wildcards, in which case only those files will be
- listed.
-
- Any file that is marked to be restored will have its name preceded by an
- asterisk ({\bf *}). Directory names will be terminated with a forward slash
- ({\bf /}) to distinguish them from filenames.
-
-\item [lsmark]
- \index[fd]{lsmark}
- The {\bf lsmark} command is the same as the {\bf ls} except that it will
- print only those files marked for extraction. The other distinction is that
- it will recursively descend into any directory selected.
-
-\item [mark]
- \index[dir]{mark}
- The {\bf mark} command allows you to mark files to be restored. It takes a
- single argument which is the filename or directory name in the current
- directory to be marked for extraction. The argument may be a wildcard
- specification, in which case all files that match in the current directory
- are marked to be restored. If the argument matches a directory rather than a
- file, then the directory and all the files contained in that directory
- (recursively) are marked to be restored. Any marked file will have its name
- preceded with an asterisk ({\bf *}) in the output produced by the {\bf ls}
-or
- {\bf dir} commands. Note, supplying a full path on the mark command does not
- work as expected to select a file or directory in the current directory.
- Also, the {\bf mark} command works on the current and lower directories but
- does not touch higher level directories.
-
- After executing the {\bf mark} command, it will print a brief summary:
-
-\footnotesize
-\begin{verbatim}
- No files marked.
-
-\end{verbatim}
-\normalsize
-
- If no files were marked, or:
-
-\footnotesize
-\begin{verbatim}
- nn files marked.
-
-\end{verbatim}
-\normalsize
-
- if some files are marked.
-
-\item [unmark]
- \index[dir]{unmark }
- The {\bf unmark} is identical to the {\bf mark} command, except that it
- unmarks the specified file or files so that they will not be restored. Note:
- the {\bf unmark} command works from the current directory, so it does not
- unmark any files at a higher level. First do a {\bf cd /} before the {\bf
- unmark *} command if you want to unmark everything.
-
-\item [pwd]
- \index[dir]{pwd }
- The {\bf pwd} command prints the current working directory. It accepts no
- arguments.
-
-\item [count]
- \index[dir]{count }
- The {\bf count} command prints the total files in the directory tree and the
- number of files marked to be restored.
-
-\item [done]
- \index[dir]{done }
- This command terminates file selection mode.
-
-\item [exit]
- \index[fd]{exit }
- This command terminates file selection mode (the same as done).
-
-\item [quit]
- \index[fd]{quit }
- This command terminates the file selection and does not run the restore
-job.
-
-
-\item [help]
- \index[fd]{help }
- This command prints a summary of the commands available.
-
-\item [?]
- This command is the same as the {\bf help} command.
-\end{description}
-
-\label{database_restore}
-\section{Restoring When Things Go Wrong}
-\index[general]{Restoring When Things Go Wrong }
-\index[general]{Restoring Your Database}
-\index[general]{Database!Restoring}
-
-This and the following sections will try to present a few of the kinds of
-problems that can come up making restoring more difficult. We will try to
-provide a few ideas how to get out of these problem situations.
-In addition to what is presented here, there is more specific information
-on restoring a \ilink{Client}{restore_client} and your
-\ilink{Server}{restore_server} in the \ilink{Disaster Recovery Using
-Bacula}{RescueChapter} chapter of this manual.
-
-\begin{description}
-\item[Problem]
- My database is broken.
-\item[Solution]
- For SQLite, use the vacuum command to try to fix the database. For either
- MySQL or PostgreSQL, see the vendor's documentation. They have specific tools
- that check and repair databases, see the \ilink{database
- repair}{DatabaseRepair} sections of this manual for links to vendor
- information.
-
- Assuming the above does not resolve the problem, you will need to restore
- or rebuild your catalog. Note, if it is a matter of some
- inconsistencies in the Bacula tables rather than a broken database, then
- running \ilink{dbcheck}{dbcheck} might help, but you will need to ensure
- that your database indexes are properly setup. Please see
- the \ilink{Database Performance Issues}{DatabasePerformance} sections
- of this manual for more details.
-
-\item[Problem]
- How do I restore my catalog?
-\item[Solution with a Catalog backup]
- If you have backed up your database nightly (as you should) and you
- have made a bootstrap file, you can immediately load back your
- database (or the ASCII SQL output). Make a copy of your current
- database, then re-initialize it, by running the following scripts:
-\begin{verbatim}
- ./drop_bacula_tables
- ./make_bacula_tables
-\end{verbatim}
- After re-initializing the database, you should be able to run
- Bacula. If you now try to use the restore command, it will not
- work because the database will be empty. However, you can manually
- run a restore job and specify your bootstrap file. You do so
- by entering the {bf run} command in the console and selecting the
- restore job. If you are using the default bacula-dir.conf, this
- Job will be named {\bf RestoreFiles}. Most likely it will prompt
- you with something such as:
-
-\footnotesize
-\begin{verbatim}
-Run Restore job
-JobName: RestoreFiles
-Bootstrap: /home/kern/bacula/working/restore.bsr
-Where: /tmp/bacula-restores
-Replace: always
-FileSet: Full Set
-Client: rufus-fd
-Storage: File
-When: 2005-07-10 17:33:40
-Catalog: MyCatalog
-Priority: 10
-OK to run? (yes/mod/no):
-\end{verbatim}
-\normalsize
-
- A number of the items will be different in your case. What you want to
- do is: to use the mod option to change the Bootstrap to point to your
- saved bootstrap file; and to make sure all the other items such as
- Client, Storage, Catalog, and Where are correct. The FileSet is not
- used when you specify a bootstrap file. Once you have set all the
- correct values, run the Job and it will restore the backup of your
- database, which is most likely an ASCII dump.
-
- You will then need to follow the instructions for your
- database type to recreate the database from the ASCII backup file.
- See the \ilink {Catalog Maintenance}{CatMaintenanceChapter} chapter of
- this manual for examples of the command needed to restore a
- database from an ASCII dump (they are shown in the Compacting Your
- XXX Database sections).
-
- Also, please note that after you restore your database from an ASCII
- backup, you do NOT want to do a {\bf make\_bacula\_tables} command, or
- you will probably erase your newly restored database tables.
-
-
-\item[Solution with a Job listing]
- If you did save your database but did not make a bootstrap file, then
- recovering the database is more difficult. You will probably need to
- use bextract to extract the backup copy. First you should locate the
- listing of the job report from the last catalog backup. It has
- important information that will allow you to quickly find your database
- file. For example, in the job report for the CatalogBackup shown below,
- the critical items are the Volume name(s), the Volume Session Id and the
- Volume Session Time. If you know those, you can easily restore your
- Catalog.
-
-\footnotesize
-\begin{verbatim}
-22-Apr 10:22 HeadMan: Start Backup JobId 7510,
-Job=CatalogBackup.2005-04-22_01.10.0
-22-Apr 10:23 HeadMan: Bacula 1.37.14 (21Apr05): 22-Apr-2005 10:23:06
- JobId: 7510
- Job: CatalogBackup.2005-04-22_01.10.00
- Backup Level: Full
- Client: Polymatou
- FileSet: "CatalogFile" 2003-04-10 01:24:01
- Pool: "Default"
- Storage: "DLTDrive"
- Start time: 22-Apr-2005 10:21:00
- End time: 22-Apr-2005 10:23:06
- FD Files Written: 1
- SD Files Written: 1
- FD Bytes Written: 210,739,395
- SD Bytes Written: 210,739,521
- Rate: 1672.5 KB/s
- Software Compression: None
- Volume name(s): DLT-22Apr05
- Volume Session Id: 11
- Volume Session Time: 1114075126
- Last Volume Bytes: 1,428,240,465
- Non-fatal FD errors: 0
- SD Errors: 0
- FD termination status: OK
- SD termination status: OK
- Termination: Backup OK
-\end{verbatim}
-\normalsize
-
- From the above information, you can manually create a bootstrap file,
- and then follow the instructions given above for restoring your database.
- A reconstructed bootstrap file for the above backup Job would look
- like the following:
-
-\footnotesize
-\begin{verbatim}
-Volume="DLT-22Apr05"
-VolSessionId=11
-VolSessionTime=1114075126
-FileIndex=1-1
-\end{verbatim}
-\normalsize
-
- Where we have inserted the Volume name, Volume Session Id, and Volume
- Session Time that correspond to the values in the job report. We've also
- used a FileIndex of one, which will always be the case providing that
- there was only one file backed up in the job.
-
- The disadvantage of this bootstrap file compared to what is created when
- you ask for one to be written, is that there is no File and Block
- specified, so the restore code must search all data in the Volume to find
- the requested file. A fully specified bootstrap file would have the File
- and Blocks specified as follows:
-
-\footnotesize
-\begin{verbatim}
-Volume="DLT-22Apr05"
-VolSessionId=11
-VolSessionTime=1114075126
-VolFile=118-118
-VolBlock=0-4053
-FileIndex=1-1
-\end{verbatim}
-\normalsize
-
- Once you have restored the ASCII dump of the database,
- you will then to follow the instructions for your
- database type to recreate the database from the ASCII backup file.
- See the \ilink {Catalog Maintenance}{CatMaintenanceChapter} chapter of
- this manual for examples of the command needed to restore a
- database from an ASCII dump (they are shown in the Compacting Your
- XXX Database sections).
-
- Also, please note that after you restore your database from an ASCII
- backup, you do NOT want to do a {\bf make\_bacula\_tables} command, or
- you will probably erase your newly restored database tables.
-
-\item [Solution without a Job Listing]
- If you do not have a job listing, then it is a bit more difficult.
- Either you use the \ilink{bscan}{bscan} program to scan the contents
- of your tape into a database, which can be very time consuming
- depending on the size of the tape, or you can use the \ilink{bls}{bls}
- program to list everything on the tape, and reconstruct a bootstrap
- file from the bls listing for the file or files you want following
- the instructions given above.
-
- There is a specific example of how to use {\bf bls} below.
-
-\item [Problem]
- I try to restore the last known good full backup by specifying
- item 3 on the restore menu then the JobId to restore. Bacula
- then reports:
-
-\footnotesize
-\begin{verbatim}
- 1 Job 0 Files
-\end{verbatim}
-\normalsize
- and restores nothing.
-
-\item[Solution]
- Most likely the File records were pruned from the database either due
- to the File Retention period expiring or by explicitly purging the
- Job. By using the "llist jobid=nn" command, you can obtain all the
- important information about the job:
-
-\footnotesize
-\begin{verbatim}
-llist jobid=120
- JobId: 120
- Job: save.2005-12-05_18.27.33
- Job.Name: save
- PurgedFiles: 0
- Type: B
- Level: F
- Job.ClientId: 1
- Client.Name: Rufus
- JobStatus: T
- SchedTime: 2005-12-05 18:27:32
- StartTime: 2005-12-05 18:27:35
- EndTime: 2005-12-05 18:27:37
- JobTDate: 1133803657
- VolSessionId: 1
- VolSessionTime: 1133803624
- JobFiles: 236
- JobErrors: 0
- JobMissingFiles: 0
- Job.PoolId: 4
- Pool.Name: Full
- Job.FileSetId: 1
- FileSet.FileSet: BackupSet
-\end{verbatim}
-\normalsize
-
- Then you can find the Volume(s) used by doing:
-
-\footnotesize
-\begin{verbatim}
-sql
-select VolumeName from JobMedia,Media where JobId=1 and JobMedia.MediaId=Media.MediaId;
-\end{verbatim}
-\normalsize
-
- Finally, you can create a bootstrap file as described in the previous
- problem above using this information.
-
- If you are using Bacula version 1.38.0 or greater, when you select
- item 3 from the menu and enter the JobId, it will ask you if
- you would like to restore all the files in the job, and it will
- collect the above information and write the bootstrap file for
- you.
-
-\item [Problem]
- You don't have a bootstrap file, and you don't have the Job report for
- the backup of your database, but you did backup the database, and you
- know the Volume to which it was backed up.
-
-\item [Solution]
- Either bscan the tape (see below for bscanning), or better use {\bf bls}
- to find where it is on the tape, then use {\bf bextract} to
- restore the database. For example,
-
-
-\footnotesize
-\begin{verbatim}
-./bls -j -V DLT-22Apr05 /dev/nst0
-\end{verbatim}
-\normalsize
- Might produce the following output:
-\footnotesize
-\begin{verbatim}
-bls: butil.c:258 Using device: "/dev/nst0" for reading.
-21-Jul 18:34 bls: Ready to read from volume "DLT-22Apr05" on device "DLTDrive"
-(/dev/nst0).
-Volume Record: File:blk=0:0 SessId=11 SessTime=1114075126 JobId=0 DataLen=164
-...
-Begin Job Session Record: File:blk=118:0 SessId=11 SessTime=1114075126
-JobId=7510
- Job=CatalogBackup.2005-04-22_01.10.0 Date=22-Apr-2005 10:21:00 Level=F Type=B
-End Job Session Record: File:blk=118:4053 SessId=11 SessTime=1114075126
-JobId=7510
- Date=22-Apr-2005 10:23:06 Level=F Type=B Files=1 Bytes=210,739,395 Errors=0
-Status=T
-...
-21-Jul 18:34 bls: End of Volume at file 201 on device "DLTDrive" (/dev/nst0),
-Volume "DLT-22Apr05"
-21-Jul 18:34 bls: End of all volumes.
-\end{verbatim}
-\normalsize
- Of course, there will be many more records printed, but we have indicated
- the essential lines of output. From the information on the Begin Job and End
- Job Session Records, you can reconstruct a bootstrap file such as the one
- shown above.
-
-\item[Problem]
- How can I find where a file is stored.
-\item[Solution]
- Normally, it is not necessary, you just use the {\bf restore} command to
- restore the most recently saved version (menu option 5), or a version
- saved before a given date (menu option 8). If you know the JobId of the
- job in which it was saved, you can use menu option 3 to enter that JobId.
-
- If you would like to know the JobId where a file was saved, select
- restore menu option 2.
-
- You can also use the {\bf query} command to find information such as:
-\footnotesize
-\begin{verbatim}
-*query
-Available queries:
- 1: List up to 20 places where a File is saved regardless of the
-directory
- 2: List where the most recent copies of a file are saved
- 3: List last 20 Full Backups for a Client
- 4: List all backups for a Client after a specified time
- 5: List all backups for a Client
- 6: List Volume Attributes for a selected Volume
- 7: List Volumes used by selected JobId
- 8: List Volumes to Restore All Files
- 9: List Pool Attributes for a selected Pool
- 10: List total files/bytes by Job
- 11: List total files/bytes by Volume
- 12: List Files for a selected JobId
- 13: List Jobs stored on a selected MediaId
- 14: List Jobs stored for a given Volume name
- 15: List Volumes Bacula thinks are in changer
- 16: List Volumes likely to need replacement from age or errors
-Choose a query (1-16):
-\end{verbatim}
-\normalsize
-
-\item[Problem]
- I didn't backup my database. What do I do now?
-\item[Solution]
- This is probably the worst of all cases, and you will probably have
- to re-create your database from scratch and then bscan in all your
- Volumes, which is a very long, painful, and inexact process.
-
-There are basically three steps to take:
-
-\begin{enumerate}
-\item Ensure that your SQL server is running (MySQL or PostgreSQL)
- and that the Bacula database (normally bacula) exists. See the
- \ilink{Installation}{CreateDatabase} chapter of the manual.
-\item Ensure that the Bacula databases are created. This is also
- described at the above link.
-\item Start and stop the Bacula Director using the propriate
- bacula-dir.conf file so that it can create the Client and
- Storage records which are not stored on the Volumes. Without these
- records, scanning is unable to connect the Job records to the proper
- client.
-\end{enumerate}
-
-When the above is complete, you can begin bscanning your Volumes. Please
-see the \ilink{bscan}{bscan} section of the Volume Utility Tools of this
-chapter for more details.
-
-\end{description}
+++ /dev/null
-/*
- * html2latex
- */
-
-available {
- sun4_sunos.4
- sun4_solaris.2
- rs_aix.3
- rs_aix.4
- sgi_irix
-}
-
-description {
- From Jeffrey Schaefer, Geometry Center. Translates HTML document to LaTeX
-}
-
-install {
- bin/html2latex /afs/rpi.edu/dept/acs/rpinfo/filters/GChtml2latex/html2latex
- bin/html2latex.tag /afs/rpi.edu/dept/acs/rpinfo/filters/GChtml2latex/html2latex.tag
- bin/html2latex-local.tag /afs/rpi.edu/dept/acs/rpinfo/filters/GChtml2latex/html2latex-local.tag
- bin/webtex2latex.tag /afs/rpi.edu/dept/acs/rpinfo/filters/GChtml2latex/webtex2latex.tag
- man/man1/html2latex.1 /afs/rpi.edu/dept/acs/rpinfo/filters/GChtml2latex/html2latex.1
-}
+++ /dev/null
-%%
-%%
-
-\chapter{Data Spooling}
-\label{SpoolingChapter}
-\index[general]{Data Spooling }
-\index[general]{Spooling!Data }
-
-Bacula allows you to specify that you want the Storage daemon to initially
-write your data to disk and then subsequently to tape. This serves several
-important purposes.
-
-\begin{itemize}
-\item It takes a long time for data to come in from the File daemon during
- an Incremental backup. If it is directly written to tape, the tape will
- start and stop or shoe-shine as it is often called causing tape wear.
- By first writing the data to disk, then writing it to tape, the tape can
- be kept in continual motion.
-\item While the spooled data is being written to the tape, the despooling
- process has exclusive use of the tape. This means that you can spool
- multiple simultaneous jobs to disk, then have them very efficiently
- despooled one at a time without having the data blocks from several jobs
- intermingled, thus substantially improving the time needed to restore
- files. While despooling, all jobs spooling continue running.
-\item Writing to a tape can be slow. By first spooling your data to disk,
- you can often reduce the time the File daemon is running on a system,
- thus reducing downtime, and/or interference with users. Of course, if
- your spool device is not large enough to hold all the data from your
- File daemon, you may actually slow down the overall backup.
-\end{itemize}
-
-Data spooling is exactly that "`spooling"'. It is not a way to first write a
-"`backup"' to a disk file and then to a tape. When the backup has only been
-spooled to disk, it is not complete yet and cannot be restored until it is
-written to tape.
-
-Bacula version 1.39.x and later supports writing a backup
-to disk then later {\bf Migrating} or moving it to a tape (or any
-other medium). For
-details on this, please see the \ilink{Migration}{MigrationChapter} chapter
-of this manual for more details.
-
-The remainder of this chapter explains the various directives that you can use
-in the spooling process.
-
-\label{directives}
-\section{Data Spooling Directives}
-\index[general]{Directives!Data Spooling }
-\index[general]{Data Spooling Directives }
-
-The following directives can be used to control data spooling.
-
-\begin{itemize}
-\item To turn data spooling on/off at the Job level in the Job resource in
- the Director's conf file (default {\bf no}).
-
-{\bf SpoolData = yes|no}
-
-\item To override the Job specification in a Schedule Run directive in the
- Director's conf file.
-
-{\bf SpoolData = yes|no}
-
-\item To limit the maximum total size of the spooled data for a particular
- device. Specified in the Device resource of the Storage daemon's conf file
- (default unlimited).
-
-{\bf Maximum Spool Size = size}
- Where size is a the maximum spool size for all jobs specified in bytes.
-
-\item To limit the maximum total size of the spooled data for a particular
- device for a single job. Specified in the Device Resource of the Storage
- daemon's conf file (default unlimited).
-
-{\bf Maximum Job Spool Size = size}
- Where size is the maximum spool file size for a single job specified in
- bytes.
-
-\item To specify the spool directory for a particular device. Specified in
- the Device Resource of the Storage daemon's conf file (default, the working
- directory).
-
-{\bf Spool Directory = directory}
-\end{itemize}
-
-\label{warning}
-
-% TODO: fix this section name
-\section{!!! MAJOR WARNING !!!}
-\index[general]{WARNING! MAJOR }
-\index[general]{ MAJOR WARNING }
-
-Please be very careful to exclude the spool directory from any backup,
-otherwise, your job will write enormous amounts of data to the Volume, and
-most probably terminate in error. This is because in attempting to backup the
-spool file, the backup data will be written a second time to the spool file,
-and so on ad infinitum.
-
-Another advice is to always specify the maximum spool size so that your disk
-doesn't completely fill up. In principle, data spooling will properly detect a
-full disk, and despool data allowing the job to continue. However, attribute
-spooling is not so kind to the user. If the disk on which attributes are being
-spooled fills, the job will be canceled. In addition, if your working
-directory is on the same partition as the spool directory, then Bacula jobs
-will fail possibly in bizarre ways when the spool fills.
-
-\label{points}
-\section{Other Points}
-\index[general]{Points!Other }
-\index[general]{Other Points }
-
-\begin{itemize}
-\item When data spooling is enabled, Bacula automatically turns on attribute
- spooling. In other words, it also spools the catalog entries to disk. This is
- done so that in case the job fails, there will be no catalog entries
- pointing to non-existent tape backups.
-\item Attribute despooling occurs near the end of a job. The Storage daemon
- accumulates file attributes during the backup and sends them to the
- Director at the end of the job. The Director then inserts the file
- attributes into the catalog. During this insertion, the tape drive may
- be inactive. When the file attribute insertion is completed, the job
- terminates.
-\item Attribute spool files are always placed in the working directory of
- the Storage daemon.
-\item When Bacula begins despooling data spooled to disk, it takes exclusive
- use of the tape. This has the major advantage that in running multiple
- simultaneous jobs at the same time, the blocks of several jobs will not be
- intermingled.
-\item It probably does not make a lot of sense to enable data spooling if you
- are writing to disk files.
-\item It is probably best to provide as large a spool file as possible to
- avoid repeatedly spooling/despooling. Also, while a job is despooling to
- tape, the File daemon must wait (i.e. spooling stops for the job while it is
- despooling).
-\item If you are running multiple simultaneous jobs, Bacula will continue
- spooling other jobs while one is despooling to tape, provided there is
- sufficient spool file space.
-\end{itemize}
+++ /dev/null
-%%
-%%
-
-\chapter{Baculas Stand}
-\label{StateChapter}
-\index[general]{Baculas momentaner Stand }
-
-was gegenw\"{a}rtig implementiert und funktionsf\"{a}hig ist und was nicht.
-
-\section{Was implementiert ist}
-\index[general]{implementiert!Was ist }
-\index[general]{Was implementiert ist }
-
-\begin{itemize}
-\item Job-Steuerung
- \begin{itemize}
- \item Sicherung/Wiederherstellung im Netzwerkes unter der Regie eines
- zentralen Director-Prozess.
- \item automatische Ausf\"{u}hrung von
- \ilink{Job}{JobDef}s nach einem festgelegten Zeitplan.
- \item Terminplanung f\"{u}r mehrere Jobs zur gleichen Zeit.
- \item die M\"{o}glichkeit einen oder mehrere Jobs zur gleichen Zeit auszuf\"{u}hren.
- \item zeitliche Staffelung der Jobs entsprechend ihrer Priorit\"{a}t.
- \item \ilink{Console}{UADef} Programm als Benutzer-Schnittstelle zum Director-Dienst.
- Eine shell-, Qt4-GUI-, GNOME-GUI und wxWidgets-Version sind derzeit verf\"{u}gbar.
- Die Qt4-Version der Console, Bacula Administration Tool, kurz bat genannt, bietet
- viele zus\"{a}tzliche Funktionen gegen\"{u}ber der shell-Version.
- \end{itemize}
-
-\item Sicherheit
- \begin{itemize}
- \item die Verifikation der Dateien, die zuvor in das
- Catalog-Verzeichnis aufgenommen wurden, erlaubt eine
- Funktionalit\"{a}t wie sie das Programm Tripwire hat (Intrusion
- Detection).
- \item die Authentifizierung der Komponenten (Dienste) untereinander
- durch CRAM-MD5 Passw\"{o}rter.
- \item eine konfigurierbare \ilink{TLS (ssl)-Verschl\"{u}sselung }{CommEncryption}
- zwischen den einzelnen Komponenten.
- \item bei Bedarf die Berechnung von MD5 oder SHA1 Signaturen der
- Dateidaten.
- \end{itemize}
-
-\item Wiederherstellungs-Funktionen
- \begin{itemize}
- \item leicht verst\"{a}ndliche und erweiterbare
- \ilink{Konfigurationsdateien}{_ChapterStart40} f\"{u}r jeden einzelnen
- D\"{a}monprozess.
- \end{itemize}
-
-\item SQL-Datenbank
- \begin{itemize}
- \item eine Catalog-Datenbank zur Aufzeichnung der Volumes,
- Pools, Jobs und der Informationen \"{u}ber die gesicherten
- Dateien.
- \item Unterst\"{u}tzung von SQLite, PostgreSQL und
- MySQL als Catalog-Datenbanksystemen.
- \item vom Benutzer erweiterbare Datenbankabfragen an SQLite-,
- PostgreSQL und MySQL-Datenbanksysteme.
- \end{itemize}
-
-\item fortschrittliches Volume- und Pool-Management
- \begin{itemize}
- \item gekennzeichnete \textbf{Volumes}, die ein versehentliches
- \"{u}berschreiben (zumindest durch Bacula) verhindern.
- \item eine beliebige Anzahl verschiedener Jobs und
- Clients kann auf ein einzelnes Volume gesichert werden. Dies
- bedeutet, dass von Linux-, Unix-, Sun- und Windows-Rechnern auf das gleiche
- Volume gesichert werden kann. Das gleiche gilt f\"{u}r die
- Wiederherstellung.
- \item eine Sicherung kann sich \"{u}ber mehrere Volumes erstrecken. Sobald ein
- Volume voll ist, fordert Bacula automatisch das n\"{a}chste
- Volume an und setzt die Sicherung fort.
- \item die Verwaltung von \ilink{Pools
- und Volumes}{PoolResource} erlaubt einen
- flexiblen Umgang mit Volumes (z.B. Gruppen von
- Volumes f\"{u}r die monatliche, w\"{o}chentliche,
- t\"{a}gliche Sicherung, Gruppen von Volumes f\"{u}r
- bestimmte Clients).
- \item das Datenformat der Volumes ist systemunabh\"{a}ngig. Bei Bedarf
- k\"{o}nnen die Daten von Linux-, Solaris- und Windows-Clients in
- dasselbe Volumen gespeichert werden.
- \item jede Bacula-Version kann jedes, mit einer kleineren Version, erstellte Volume lesen.
- \item ein konfigurierbares \ilink{Messages}{MessagesChapter}-Handling.
- Dazu geh\"{o}rt der Versand von Botschaften aller D\"{a}mon-Prozesse
- an den Director-Dienst und die automatische Benachrichtigung des
- Benutzers \"{u}ber das Mailsystem.
- \item Zwischenspeicherung der zu sichernden Daten auf der Festplatte (Spooling) und
- fortlaufende Beschreibung des Bandes mit den zwischengespeicherten Daten
- verhindert den ``Schoe-Shine-Effekt'' bei einer inkrementellen oder
- differentiellen Sicherung.
- \end{itemize}
-
-\item Unterst\"{u}tzung f\"{u}r fast alle Speicher-Ger\"{a}te
- \begin{itemize}
- \item die Unterst\"{u}tzung von Autochangern \"{u}ber ein einfache Shell-Schnittstelle.
- Damit ist es m\"{o}glich, praktisch mit jedem Autoloader-Programm zu kommunizieren.
- Ein Skript f\"{u}r {\bf mtx} ist bereitgestellt.
- \item unterst\"{u}tzt Autochanger-Barcodes -- entsprechend der Barcodes
- wird das Band gekennzeichnet.
- \item automatische Unterst\"{u}tzung mehrerer Autochanger-Magazine.
- Hierbei wird entweder der Barcode oder das Band gelesen.
- \item Unterst\"{u}tzung von Autochangern mit mehreren Laufwerken
- \item Sicherung/Wiederherstellung als raw-Backup. Hierbei mu{\ss} die
- Wiederherstellung auf den gleichen Datentr\"{a}ger erfolgen.
- \item jeder Datenblock (etwa 64KByte) der Volumes enth\"{a}lt die
- Pr\"{u}fsumme der Daten.
- \item Migration, die M\"{o}glichkeit gesicherte Daten von einem Pool oder Volume,
- in einen anderen Pool oder auf ein anderes Volume zu verschieben.
- \item schreibbare DVD k\"{o}nnen als Backup-Medium verwendet werden
- \end{itemize}
-
-\item Unterst\"{u}tzung verschiedener Bertiebssysteme
- \begin{itemize}
- \item Programmtechnisch keine Begrenzung der L\"{a}nge der Dateinamen oder
- der Nachrichten. Auf Win32 ist die L\"{a}nge der Dateinamen/Pfade auf 64k begrenzt.
- \item GZIP-Komprimierung f\"{u}r jede einzelne Datei, die schon der Client
- erledigt, sofern dies vor einer \"{U}bertragung im Netzwerk angefordert wird.
- \item POSIX ACLs werden - wenn aktiviert - unter den meisten Betriebssystemen gesichert und wiederhergestellt.
- \item Zugangskontrolllisten f\"{u}r Consolen, die dem Benutzer einen Zugang nur zu den eigenen Daten erlauben.
- \item Sicherung/Wiederherstellung von Dateien, die gr\"{o}{\ss}er sind als 2GB.
- \item Unterst\"{u}tzung von 64Bit-Systemen wie z.B. AMD64.
- \item Unterst\"{u}tzung von ANSI- und IBM Band-Labels.
- \item Unterst\"{u}tzung von Unicode-Dateinamen (z.B. Chinesisch) auf
- Win32-Rechnern mit der Bacula-Version 1.37.28 und h\"{o}her.
- \item konsistente Sicherung von ge\"{o}ffneten Dateien von Win32-Systemen
- (WinXP, Win2003, nicht Win2000) durch Verwendung von Volume Shadow Copy
- (VSS).
- \end{itemize}
-
-
-\item Verschiedenes
- \begin{itemize}
- \item Implementierung der Prozesse als Multithread-Programme.
- \item leicht verst\"{a}ndliche und erweiterbare
- \ilink{Konfigurationsdateien}{DirectorChapter} f\"{u}r jeden einzelnen
- D\"{a}monprozess.
- \end{itemize}
-\end{itemize}
-
-\section{Vorteile gegen\"{u}ber anderen Sicherungsprogrammen}
-\index[general]{Vorteile gegen\"{u}ber anderen Sicherungsprogrammen}
-\index[general]{Sicherungsprogrammen!Vorteile gegen\"{u}ber anderen}
-
-\begin{itemize}
-\item da f\"{u}r jeden Rechner ein eigener Client existiert, k\"{o}nnen die
- Daten von Betriebssystemen aller Art gesichert und wiederhergestellt
- werden, wobei immer gew\"{a}hrleistet ist, dass ihre Dateiattribute
- korrekt gesichert und wiederhergestellt werden.
-\item Man kann auch Clients sichern ohne eine Client-Software zu benutzen
- und verwendet hierzu NFS oder Samba. Wir empfehlen jedoch, sofern
- m\"{o}glich, auf jedem Rechner, von dem Daten gesichert werden
- sollen, einen eigenen File-D\"{a}mon laufen zu lassen.
-\item Bacula kann mit Sicherungen umgehen, die auf mehrere Volumes verteilt
- sind.
-\item eine umfassende SQL-Datenbank aller gesicherter Dateien
- erm\"{o}glicht den \"{U}berblick \"{u}ber alle gespeicherte Dateien in
- jedem einzelnen Volume.
-\item automatische Bereinigung der Datenbank (die Entfernung alter
- Aufzeichnungen) und dadurch eine Vereinfachung der Datenbankadministration.
-\item durch die Verwendung beliebiger SQL-Datenbanksysteme ist Bacula sehr
- anpassungsf\"{a}hig. Derzeit werden MySQL, PostgreSQL und SQLite unterst\"{u}tzt.
-\item durch den modularen, dabei aber einheitlichen Entwurf ist Bacula in
- hohem Ma{\ss}e skalierbar.
-\item da Bacula D\"{a}monen auf den Client-Rechnern benutzt, ist es
- m\"{o}glich, dort laufende Anwendungen durch Bacula mit
- systemeigenen Befehlen zu stoppen und nach der Sicherung die
- entsprechenden Anwendungen wieder zu starten. Dies alles kann aus einem
- einzigen Bacula-Job heraus geschehen.
-\item Bacula hat ein eingebauten Zeitplaner f\"{u}r die
- Sicherungsjobs.
-\item Das Format der Volumes ist dokumentiert und es gibt einfache
- C-Programme mit denen sie gelesen und beschrieben werden k\"{o}nnen
-\item Bacula benutzt eindeutige (bei der IANA registrierte) TCP/IP-Ports --
- also weder RPCs noch Shared Memory.
-\item Baculas Installation und Konfiguration ist gegen\"{u}ber anderen
- vergleichbaren Produkten relativ einfach.
-%\item laut einem unserer Benutzer ist Bacula genau so schnell wie die
-% wichtigen gro{\ss}en kommerziellen Programme.
-\item hohe Geschwindigkeit durch das Speichern der Datei-Informationen
- in einer SQL-Datenbank anstatt in einzelnen Dateien auf der Festplatte.
-\item neben der grafischen Benutzeroberfl\"{a}che zur Verwaltung hat Bacula
- eine umfassende Shell-Schnittstelle f\"{u}r die Wartungsaufgaben, wobei der
- Administrator Werkzeuge wie z.B. ``ssh'' verwenden kann, um jeden Teil von
- Bacula von \"{u}berall (sogar von Zuhause) zu administrieren.
-\item Bacula hat eine Rettungs-CD f\"{u}r Linux-Systeme mit den folgenden Eigenschaften:
- \begin{itemize}
- \item Sie kompilieren sie von Grund auf auf ihrem eigenen System mit einem einzigen einfachen Befehl:
- ``make'' (...OK, Sie brauchen dann noch ``make burn''...).
- \item die Rettungs-CD verwendet Ihren Kernel
- \item sie schreibt Skripte entsprechend der Parameter Ihrer Festplatte mit denen Sie diese automatisch
- repartitionieren und formatieren k\"{o}nnen, um den Ausgangszustand wieder herzustellen.
- \item sie hat ein Skript, das Ihr Netzwerk wieder starten wird (mit der
- korrekten IP-Adresse)
- \item sie hat ein Skript, mit dem Ihre Festplatten automatisch gemountet werden.
- \item ein Bacula-Client ist statisch eingebunden
- \item sie k\"{o}nnen der Rettungs-CD auf einfache Weise zus\"{a}tzliche
- Daten und Programme hinzuf\"{u}gen.
- \end{itemize}
-\end{itemize}
-
-\section{Einschr\"{a}nkungen der aktuellen Implementierung}
-\index[general]{Einschr\"{a}nkungen der aktuellen Implementierung }
-\index[general]{aktuelle Implementierung! Einschr\"{a}nkungen der}
-
-\begin{itemize}
-\item Sollten Sie mehr als 4 Milliarden Dateieintr\"{a}ge in Ihrer
- Datenbank gespeichert haben, wird die FileID der Datenbank vermutlich
- \"{u}berlaufen. Dies w\"{a}re eine ziemlich gro{\ss}e Datenbank, aber
- immerhin ist sie denkbar. Allerdings k\"{o}nnen Sie die FileID auf 64 Bit
- erweitern (ab Bacula-Version 1.39) und das Problem ist gel\"{o}st,
- dies muss aber von Hand geschehen.
-\item Dateien, die nach einer Vollsicherung gel\"{o}scht wurden, werden bei
- einer Wiederherstellung eingeschlossen. Es wird momentan daran gearbeitet,
- dies zu verhindern.
-\item differentielle und inkrementelle Sicherungen basieren auf den Zeitstempeln
- der Dateien. Das bedeutet, dass falls Sie nach einen vollst\"{a}ndigen Sicherung
- Verzeichnisse oder Dateien auf dem Client in das FileSet verschieben,
- diese beim n\"{a}chsten inkrementellen Backup nicht gesichert werden.
- Um das Sichern der Daten zu erzwingen, m\"{u}ssen Sie nach dem verschieben
- die Timestamps der Daten aktualisieren, damit Bacula sie als neu erkennt.
-\item Datei-System-Module fehlen (dies w\"{a}ren konfigurierbare Routinen,
- um spezielle Dateien zu sichern/wiederherzustellen, das kann aber \"{u}ber RunScripts gel\"{o}st werden).
-\item Bacula kann zwei verschiedene Jobs nicht im selben Restore wiederherstellen,
- wenn diese Backup-Jobs gleichzeitig gelaufen sind. Die Ausnahme ist, dass Sie
- Spooling aktiviert haben und die Jobs nach dem spoolen nacheinander auf das
- Volume geschrieben wurden. Es ist also nicht m\"{o}glich, die verschachtelten
- Bl\"{o}cke auf dem Volume in einem Job zu trennen.
-\item generell kann Bacula jedes Backup von jedem Client auch auf einem anderen
- Client wiederherstellen. Allerdings gibt es, wenn die Architektur der Rechner
- unterschiedlich ist (z.B. 32Bit zu 64Bit oder Windows zu Unix)
- einige Einschr\"{a}nkungen. Zum Beispiel kennt Linux/Unix keine Solaris door-Dateien.
- Zudem gibt es Hinweise, dass sich Zlib-Kompremierte Dateien von 64Bit-Systemen
- nicht immer korrekt auf 32Bit-Systemen entpacken lassen.
- \end{itemize}
-
-\section{Grenzen und Beschr\"{a}nkungen des Software Design}
-\index[general]{Restrictions!Design Limitations or }
-\index[general]{Design Limitations or Restrictions }
-
-\begin{itemize}
-\item Namen (Resource-Namen, Volume-Names und
- \"{a}hnliche) in Baculas Konfigurationsdateien sind auf eine bestimmte
- L\"{a}nge beschr\"{a}nkt . Momentan liegt die Grenze bei 127 Zeichen.
- Beachten Sie bitte, dass diese Einschr\"{a}nkungen nicht die Dateinamen
- betrifft, die beliebig lang sein k\"{o}nnen.
-
-\end{itemize}
+++ /dev/null
-\chapter{Using Bacula catalog to grab information}
-\label{UseBaculaCatalogToExtractInformationChapter}
-\index[general]{Statistics}
-
-Bacula catalog contains lot of information about your IT infrastructure, how
-many files, their size, the number of video or music files etc. Using Bacula
-catalog during the day to get them permit to save resources on your servers.
-
-In this chapter, you will find tips and information to measure bacula
-efficiency and report statistics.
-
-\section{Job statistics}
-If you (or probably your boss) want to have statistics on your backups to
-provide some \textit{Service Level Agreement} indicators, you could use a few
-SQL queries on the Job table to report how many:
-
-\begin{itemize}
-\item jobs have run
-\item jobs have been successful
-\item files have been backed up
-\item ...
-\end{itemize}
-
-However, these statistics are accurate only if your job retention is greater
-than your statistics period. Ie, if jobs are purged from the catalog, you won't
-be able to use them.
-
-Now, you can use the \textbf{update stats [days=num]} console command to fill
-the JobHistory table with new Job records. If you want to be sure to take in
-account only \textbf{good jobs}, ie if one of your important job has failed but
-you have fixed the problem and restarted it on time, you probably want to
-delete the first \textit{bad} job record and keep only the successful one. For
-that simply let your staff do the job, and update JobHistory table after two or
-three days depending on your organization using the \textbf{[days=num]} option.
-
-These statistics records aren't used for restoring, but mainly for
-capacity planning, billings, etc.
-
-The Bweb interface provides a statistics module that can use this feature. You
-can also use tools like Talend or extract information by yourself.
-
-The {\textbf Statistics Retention = \lt{}time\gt{}} director directive defines
-the length of time that Bacula will keep statistics job records in the Catalog
-database after the Job End time. (In \texttt{JobHistory} table) When this time
-period expires, and if user runs \texttt{prune stats} command, Bacula will
-prune (remove) Job records that are older than the specified period.
-
-You can use the following Job resource in your nightly \textbf{BackupCatalog}
-job to maintain statistics.
-\begin{verbatim}
-Job {
- Name = BackupCatalog
- ...
- RunScript {
- Console = "update stats days=3"
- Console = "prune stats yes"
- RunsWhen = After
- RunsOnClient = no
- }
-}
-\end{verbatim}
+++ /dev/null
-%%
-%%
-
-\chapter{Backup Strategies}
-\label{StrategiesChapter}
-\index[general]{Strategies!Backup }
-\index[general]{Backup Strategies }
-
-Although Recycling and Backing Up to Disk Volume have been discussed in
-previous chapters, this chapter is meant to give you an overall view of
-possible backup strategies and to explain their advantages and disadvantages.
-\label{Simple}
-
-\section{Simple One Tape Backup}
-\index[general]{Backup!Simple One Tape }
-\index[general]{Simple One Tape Backup }
-
-Probably the simplest strategy is to back everything up to a single tape and
-insert a new (or recycled) tape when it fills and Bacula requests a new one.
-
-\subsection{Advantages}
-\index[general]{Advantages }
-
-\begin{itemize}
-\item The operator intervenes only when a tape change is needed. (once a
- month at my site).
-\item There is little chance of operator error because the tape is not
- changed daily.
-\item A minimum number of tapes will be needed for a full restore. Typically
- the best case will be one tape and worst two.
-\item You can easily arrange for the Full backup to occur a different night
- of the month for each system, thus load balancing and shortening the backup
- time.
-\end{itemize}
-
-\subsection{Disadvantages}
-\index[general]{Disadvantages }
-
-\begin{itemize}
-\item If your site burns down, you will lose your current backups, and in my
- case about a month of data.
-\item After a tape fills and you have put in a blank tape, the backup will
- continue, and this will generally happen during working hours.
- \end{itemize}
-
-\subsection{Practical Details}
-\index[general]{Details!Practical }
-\index[general]{Practical Details }
-
-This system is very simple. When the tape fills and Bacula requests a new
-tape, you {\bf unmount} the tape from the Console program, insert a new tape
-and {\bf label} it. In most cases after the label, Bacula will automatically
-mount the tape and resume the backup. Otherwise, you simply {\bf mount} the
-tape.
-
-Using this strategy, one typically does a Full backup once a week followed by
-daily Incremental backups. To minimize the amount of data written to the tape,
-one can do a Full backup once a month on the first Sunday of the
-month, a Differential backup on the 2nd-5th Sunday of the month, and
-incremental backups the rest of the week.
-\label{Manual}
-
-\section{Manually Changing Tapes}
-\index[general]{Tapes!Manually Changing }
-\index[general]{Manually Changing Tapes }
-
-If you use the strategy presented above, Bacula will ask you to change the
-tape, and you will {\bf unmount} it and then remount it when you have inserted
-the new tape.
-
-If you do not wish to interact with Bacula to change each tape, there are
-several ways to get Bacula to release the tape:
-
-\begin{itemize}
-\item In your Storage daemon's Device resource, set
- {\bf AlwaysOpen = no}
- In this case, Bacula will release the tape after every job. If you run
- several jobs, the tape will be rewound and repositioned to the end at the
- beginning of every job. This is not very efficient, but does let you change
- the tape whenever you want.
-\item Use a {\bf RunAfterJob} statement to run a script after your last job.
- This could also be an {\bf Admin} job that runs after all your backup jobs.
- The script could be something like:
-
-\footnotesize
-\begin{verbatim}
- #!/bin/sh
- /full-path/bconsole -c /full-path/bconsole.conf <<END_OF_DATA
- release storage=your-storage-name
- END_OF_DATA
-
-\end{verbatim}
-\normalsize
-
-In this example, you would have {\bf AlwaysOpen=yes}, but the {\bf release}
-command would tell Bacula to rewind the tape and on the next job assume the
-tape has changed. This strategy may not work on some systems, or on
-autochangers because Bacula will still keep the drive open.
-\item The final strategy is similar to the previous case except that you
- would use the unmount command to force Bacula to release the drive. Then you
- would eject the tape, and remount it as follows:
-
-\footnotesize
-\begin{verbatim}
- #!/bin/sh
- /full-path/bconsole -c /full-path/bconsole.conf <\<END_OF_DATA
- unmount storage=your-storage-name
- END_OF_DATA
- # the following is a shell command
- mt eject
- /full-path/bconsole -c /full-path/bconsole.conf <<END_OF_DATA
- mount storage=your-storage-name
- END_OF_DATA
-
-\end{verbatim}
-\normalsize
-
-\end{itemize}
-
-\label{Daily}
-
-\section{Daily Tape Rotation}
-\index[general]{Rotation!Daily Tape }
-\index[general]{Daily Tape Rotation }
-
-This scheme is quite different from the one mentioned above in that a Full
-backup is done to a different tape every day of the week. Generally, the
-backup will cycle continuously through five or six tapes each week. Variations are
-to use a different tape each Friday, and possibly at the beginning of the
-month. Thus if backups are done Monday through Friday only, you need only five
-tapes, and by having two Friday tapes, you need a total of six tapes. Many sites
-run this way, or using modifications of it based on two week cycles or longer.
-
-
-\subsection{Advantages}
-\index[general]{Advantages }
-
-\begin{itemize}
-\item All the data is stored on a single tape, so recoveries are simple and
- faster.
-\item Assuming the previous day's tape is taken offsite each day, a maximum
- of one days data will be lost if the site burns down.
- \end{itemize}
-
-\subsection{Disadvantages}
-\index[general]{Disadvantages }
-
-\begin{itemize}
-\item The tape must be changed every day requiring a lot of operator
- intervention.
-\item More errors will occur because of human mistakes.
-\item If the wrong tape is inadvertently mounted, the Backup for that day
- will not occur exposing the system to data loss.
-\item There is much more movement of the tape each day (rewinds) leading to
- shorter tape drive life time.
-\item Initial setup of Bacula to run in this mode is more complicated than
- the Single tape system described above.
-\item Depending on the number of systems you have and their data capacity, it
- may not be possible to do a Full backup every night for time reasons or
- reasons of tape capacity.
-\end{itemize}
-
-\subsection{Practical Details}
-\index[general]{Details!Practical }
-\index[general]{Practical Details }
-
-The simplest way to "force" Bacula to use a different tape each day is to
-define a different Pool for each day of the the week a backup is done. In
-addition, you will need to specify appropriate Job and File retention periods
-so that Bacula will relabel and overwrite the tape each week rather than
-appending to it. Nic Bellamy has supplied an actual working model of this
-which we include here.
-
-What is important is to create a different Pool for each day of the week, and
-on the {\bf run} statement in the Schedule, to specify which Pool is to be
-used. He has one Schedule that accomplishes this, and a second Schedule that
-does the same thing for the Catalog backup run each day after the main backup
-(Priorities were not available when this script was written). In addition, he
-uses a {\bf Max Start Delay} of 22 hours so that if the wrong tape is
-premounted by the operator, the job will be automatically canceled, and the
-backup cycle will re-synchronize the next day. He has named his Friday Pool
-{\bf WeeklyPool} because in that Pool, he wishes to have several tapes to be
-able to restore to a time older than one week.
-
-And finally, in his Storage daemon's Device resource, he has {\bf Automatic
-Mount = yes} and {\bf Always Open = No}. This is necessary for the tape
-ejection to work in his {\bf end\_of\_backup.sh} script below.
-
-For example, his bacula-dir.conf file looks like the following:
-
-\footnotesize
-\begin{verbatim}
-
-# /etc/bacula/bacula-dir.conf
-#
-# Bacula Director Configuration file
-#
-Director {
- Name = ServerName
- DIRport = 9101
- QueryFile = "/etc/bacula/query.sql"
- WorkingDirectory = "/var/lib/bacula"
- PidDirectory = "/var/run"
- SubSysDirectory = "/var/lock/subsys"
- Maximum Concurrent Jobs = 1
- Password = "console-pass"
- Messages = Standard
-}
-#
-# Define the main nightly save backup job
-#
-Job {
- Name = "NightlySave"
- Type = Backup
- Client = ServerName
- FileSet = "Full Set"
- Schedule = "WeeklyCycle"
- Storage = Tape
- Messages = Standard
- Pool = Default
- Write Bootstrap = "/var/lib/bacula/NightlySave.bsr"
- Max Start Delay = 22h
-}
-# Backup the catalog database (after the nightly save)
-Job {
- Name = "BackupCatalog"
- Type = Backup
- Client = ServerName
- FileSet = "Catalog"
- Schedule = "WeeklyCycleAfterBackup"
- Storage = Tape
- Messages = Standard
- Pool = Default
- # This creates an ASCII copy of the catalog
- # WARNING!!! Passing the password via the command line is insecure.
- # see comments in make_catalog_backup for details.
- RunBeforeJob = "/usr/lib/bacula/make_catalog_backup -u bacula"
- # This deletes the copy of the catalog, and ejects the tape
- RunAfterJob = "/etc/bacula/end_of_backup.sh"
- Write Bootstrap = "/var/lib/bacula/BackupCatalog.bsr"
- Max Start Delay = 22h
-}
-# Standard Restore template, changed by Console program
-Job {
- Name = "RestoreFiles"
- Type = Restore
- Client = ServerName
- FileSet = "Full Set"
- Storage = Tape
- Messages = Standard
- Pool = Default
- Where = /tmp/bacula-restores
-}
-# List of files to be backed up
-FileSet {
- Name = "Full Set"
- Include = signature=MD5 {
- /
- /data
- }
- Exclude = { /proc /tmp /.journal }
-}
-#
-# When to do the backups
-#
-Schedule {
- Name = "WeeklyCycle"
- Run = Level=Full Pool=MondayPool Monday at 8:00pm
- Run = Level=Full Pool=TuesdayPool Tuesday at 8:00pm
- Run = Level=Full Pool=WednesdayPool Wednesday at 8:00pm
- Run = Level=Full Pool=ThursdayPool Thursday at 8:00pm
- Run = Level=Full Pool=WeeklyPool Friday at 8:00pm
-}
-# This does the catalog. It starts after the WeeklyCycle
-Schedule {
- Name = "WeeklyCycleAfterBackup"
- Run = Level=Full Pool=MondayPool Monday at 8:15pm
- Run = Level=Full Pool=TuesdayPool Tuesday at 8:15pm
- Run = Level=Full Pool=WednesdayPool Wednesday at 8:15pm
- Run = Level=Full Pool=ThursdayPool Thursday at 8:15pm
- Run = Level=Full Pool=WeeklyPool Friday at 8:15pm
-}
-# This is the backup of the catalog
-FileSet {
- Name = "Catalog"
- Include = signature=MD5 {
- /var/lib/bacula/bacula.sql
- }
-}
-# Client (File Services) to backup
-Client {
- Name = ServerName
- Address = dionysus
- FDPort = 9102
- Catalog = MyCatalog
- Password = "client-pass"
- File Retention = 30d
- Job Retention = 30d
- AutoPrune = yes
-}
-# Definition of file storage device
-Storage {
- Name = Tape
- Address = dionysus
- SDPort = 9103
- Password = "storage-pass"
- Device = Tandberg
- Media Type = MLR1
-}
-# Generic catalog service
-Catalog {
- Name = MyCatalog
- dbname = bacula; user = bacula; password = ""
-}
-# Reasonable message delivery -- send almost all to email address
-# and to the console
-Messages {
- Name = Standard
- mailcommand = "/usr/sbin/bsmtp -h localhost -f \"\(Bacula\) %r\"
- -s \"Bacula: %t %e of %c %l\" %r"
- operatorcommand = "/usr/sbin/bsmtp -h localhost -f \"\(Bacula\) %r\"
- -s \"Bacula: Intervention needed for %j\" %r"
- mail = root@localhost = all, !skipped
- operator = root@localhost = mount
- console = all, !skipped, !saved
- append = "/var/lib/bacula/log" = all, !skipped
-}
-
-# Pool definitions
-#
-# Default Pool for jobs, but will hold no actual volumes
-Pool {
- Name = Default
- Pool Type = Backup
-}
-Pool {
- Name = MondayPool
- Pool Type = Backup
- Recycle = yes
- AutoPrune = yes
- Volume Retention = 6d
- Maximum Volume Jobs = 2
-}
-Pool {
- Name = TuesdayPool
- Pool Type = Backup
- Recycle = yes
- AutoPrune = yes
- Volume Retention = 6d
- Maximum Volume Jobs = 2
-}
-Pool {
- Name = WednesdayPool
- Pool Type = Backup
- Recycle = yes
- AutoPrune = yes
- Volume Retention = 6d
- Maximum Volume Jobs = 2
-}
-Pool {
- Name = ThursdayPool
- Pool Type = Backup
- Recycle = yes
- AutoPrune = yes
- Volume Retention = 6d
- Maximum Volume Jobs = 2
-}
-Pool {
- Name = WeeklyPool
- Pool Type = Backup
- Recycle = yes
- AutoPrune = yes
- Volume Retention = 12d
- Maximum Volume Jobs = 2
-}
-# EOF
-\end{verbatim}
-\normalsize
-
-Note, the mailcommand and operatorcommand should be on a single line each.
-They were split to preserve the proper page width. In order to get Bacula to
-release the tape after the nightly backup, he uses a {\bf RunAfterJob} script
-that deletes the ASCII copy of the database back and then rewinds and ejects
-the tape. The following is a copy of {\bf end\_of\_backup.sh}
-
-\footnotesize
-\begin{verbatim}
-#! /bin/sh
-/usr/lib/bacula/delete_catalog_backup
-mt rewind
-mt eject
-exit 0
-\end{verbatim}
-\normalsize
-
-Finally, if you list his Volumes, you get something like the following:
-
-\footnotesize
-\begin{verbatim}
-*list media
-Using default Catalog name=MyCatalog DB=bacula
-Pool: WeeklyPool
-+-----+-----------+-------+--------+-----------+-----------------+-------+------+
-| MeId| VolumeName| MedTyp| VolStat| VolBytes | LastWritten | VolRet| Recyc|
-+-----+-----------+-------+--------+-----------+-----------------+-------+------+
-| 5 | Friday_1 | MLR1 | Used | 2157171998| 2003-07-11 20:20| 103680| 1 |
-| 6 | Friday_2 | MLR1 | Append | 0 | 0 | 103680| 1 |
-+-----+-----------+-------+--------+-----------+-----------------+-------+------+
-Pool: MondayPool
-+-----+-----------+-------+--------+-----------+-----------------+-------+------+
-| MeId| VolumeName| MedTyp| VolStat| VolBytes | LastWritten | VolRet| Recyc|
-+-----+-----------+-------+--------+-----------+-----------------+-------+------+
-| 2 | Monday | MLR1 | Used | 2260942092| 2003-07-14 20:20| 518400| 1 |
-+-----+-----------+-------+--------+-----------+-----------------+-------+------+
-Pool: TuesdayPool
-+-----+-----------+-------+--------+-----------+-----------------+-------+------+
-| MeId| VolumeName| MedTyp| VolStat| VolBytes | LastWritten | VolRet| Recyc|
-+-----+-----------+-------+--------+-----------+-----------------+-------+------+
-| 3 | Tuesday | MLR1 | Used | 2268180300| 2003-07-15 20:20| 518400| 1 |
-+-----+-----------+-------+--------+-----------+-----------------+-------+------+
-Pool: WednesdayPool
-+-----+-----------+-------+--------+-----------+-----------------+-------+------+
-| MeId| VolumeName| MedTyp| VolStat| VolBytes | LastWritten | VolRet| Recyc|
-+-----+-----------+-------+--------+-----------+-----------------+-------+------+
-| 4 | Wednesday | MLR1 | Used | 2138871127| 2003-07-09 20:2 | 518400| 1 |
-+-----+-----------+-------+--------+-----------+-----------------+-------+------+
-Pool: ThursdayPool
-+-----+-----------+-------+--------+-----------+-----------------+-------+------+
-| MeId| VolumeName| MedTyp| VolStat| VolBytes | LastWritten | VolRet| Recyc|
-+-----+-----------+-------+--------+-----------+-----------------+-------+------+
-| 1 | Thursday | MLR1 | Used | 2146276461| 2003-07-10 20:50| 518400| 1 |
-+-----+-----------+-------+--------+-----------+-----------------+-------+------+
-Pool: Default
-No results to list.
-\end{verbatim}
-\normalsize
-
-Note, I have truncated a number of the columns so that the information fits on
-the width of a page.
+++ /dev/null
-%%
-%%
-
-\chapter{Using Stunnel to Encrypt Communications}
-\label{StunnelChapter}
-\index[general]{Using Stunnel to Encrypt Communications to Clients }
-
-Prior to version 1.37, Bacula did not have built-in communications encryption.
-Please see the \ilink {TLS chapter}{CommEncryption} if you are using Bacula
-1.37 or greater.
-
-Without too much effort, it is possible to encrypt the communications
-between any of the daemons. This chapter will show you how to use {\bf
-stunnel} to encrypt communications to your client programs. We assume the
-Director and the Storage daemon are running on one machine that will be called
-{\bf server} and the Client or File daemon is running on a different machine
-called {\bf client}. Although the details may be slightly different, the same
-principles apply whether you are encrypting between Unix, Linux, or Win32
-machines. This example was developed between two Linux machines running
-stunnel version 4.04-4 on a Red Hat Enterprise 3.0 system.
-
-\section{Communications Ports Used}
-\index[general]{Used!Communications Ports }
-\index[general]{Communications Ports Used }
-
-First, you must know that with the standard Bacula configuration, the Director
-will contact the File daemon on port 9102. The File daemon then contacts the
-Storage daemon using the address and port parameters supplied by the Director.
-The standard port used will be 9103. This is the typical server/client view of
-the world, the File daemon is a server to the Director (i.e. listens for the
-Director to contact it), and the Storage daemon is a server to the File
-daemon.
-
-\section{Encryption}
-\index[general]{Encryption }
-
-The encryption is accomplished between the Director and the File daemon by
-using an stunnel on the Director's machine (server) to encrypt the data and to
-contact an stunnel on the File daemon's machine (client), which decrypts the
-data and passes it to the client.
-
-Between the File daemon and the Storage daemon, we use an stunnel on the File
-daemon's machine to encrypt the data and another stunnel on the Storage
-daemon's machine to decrypt the data.
-
-As a consequence, there are actually four copies of stunnel running, two on the
-server and two on the client. This may sound a bit complicated, but it really
-isn't. To accomplish this, we will need to construct four separate conf files
-for stunnel, and we will need to make some minor modifications to the
-Director's conf file. None of the other conf files need to be changed.
-
-\section{A Picture}
-\index[general]{Picture }
-
-Since pictures usually help a lot, here is an overview of what we will be
-doing. Don't worry about all the details of the port numbers and such for the
-moment.
-
-\footnotesize
-\begin{verbatim}
- File daemon (client):
- stunnel-fd1.conf
- |===========|
- Port 29102 >----| Stunnel 1 |-----> Port 9102
- |===========|
- stunnel-fd2.conf
- |===========|
- Port 9103 >----| Stunnel 2 |-----> server:29103
- |===========|
- Director (server):
- stunnel-dir.conf
- |===========|
- Port 29102 >----| Stunnel 3 |-----> client:29102
- |===========|
- stunnel-sd.conf
- |===========|
- Port 29103 >----| Stunnel 4 |-----> 9103
- |===========|
-\end{verbatim}
-\normalsize
-
-\section{Certificates}
-\index[general]{Certificates }
-
-In order for stunnel to function as a server, which it does in our diagram for
-Stunnel 1 and Stunnel 4, you must have a certificate and the key. It is
-possible to keep the two in separate files, but normally, you keep them in one
-single .pem file. You may create this certificate yourself in which case, it
-will be self-signed, or you may have it signed by a CA.
-
-If you want your clients to verify that the server is in fact valid (Stunnel 2
-and Stunnel 3), you will need to have the server certificates signed by a CA
-(Certificate Authority), and you will need to have the CA's public certificate
-(contains the CA's public key).
-
-Having a CA signed certificate is {\bf highly} recommended if you are using
-your client across the Internet, otherwise you are exposed to the man in the
-middle attack and hence loss of your data.
-
-See below for how to create a self-signed certificate.
-
-\section{Securing the Data Channel}
-\index[general]{Channel!Securing the Data }
-\index[general]{Securing the Data Channel }
-
-To simplify things a bit, let's for the moment consider only the data channel.
-That is the connection between the File daemon and the Storage daemon, which
-takes place on port 9103. In fact, in a minimalist solution, this is the only
-connection that needs to be encrypted, because it is the one that transports your
-data. The connection between the Director and the File daemon is simply a
-control channel used to start the job and get the job status.
-
-Normally the File daemon will contact the Storage daemon on port 9103
-(supplied by the Director), so we need an stunnel that listens on port 9103 on
-the File daemon's machine, encrypts the data and sends it to the Storage
-daemon. This is depicted by Stunnel 2 above. Note that this stunnel is
-listening on port 9103 and sending to server:29103. We use port 29103 on the
-server because if we would send the data to port 9103, it would go directly to the
-Storage daemon, which doesn't understand encrypted data. On the server
-machine, we run Stunnel 4, which listens on port 29103, decrypts the data and
-sends it to the Storage daemon, which is listening on port 9103.
-
-\section{Data Channel Configuration}
-\index[general]{Modification of bacula-dir.conf for the Data Channel }
-\index[general]{baculoa-dir.conf!Modification for the Data Channel }
-
-The Storage resource of the bacula-dir.conf normally looks something like the
-following:
-
-\footnotesize
-\begin{verbatim}
-Storage {
- Name = File
- Address = server
- SDPort = 9103
- Password = storage_password
- Device = File
- Media Type = File
-}
-\end{verbatim}
-\normalsize
-
-Notice that this is running on the server machine, and it points the File
-daemon back to server:9103, which is where our Storage daemon is listening. We
-modify this to be:
-
-\footnotesize
-\begin{verbatim}
-Storage {
- Name = File
- Address = localhost
- SDPort = 9103
- Password = storage_password
- Device = File
- Media Type = File
-}
-\end{verbatim}
-\normalsize
-
-This causes the File daemon to send the data to the stunnel running on
-localhost (the client machine). We could have used client as the address as
-well.
-
-\section{Stunnel Configuration for the Data Channel}
-\index[general]{Stunnel Configuration for the Data Channel }
-
-In the diagram above, we see above Stunnel 2 that we use stunnel-fd2.conf on the
-client. A pretty much minimal config file would look like the following:
-
-\footnotesize
-\begin{verbatim}
-client = yes
-[29103]
-accept = localhost:9103
-connect = server:29103
-\end{verbatim}
-\normalsize
-
-The above config file does encrypt the data but it does not require a
-certificate, so it is subject to the man in the middle attack. The file I
-actually used, stunnel-fd2.conf, looked like this:
-
-\footnotesize
-\begin{verbatim}
-#
-# Stunnel conf for Bacula client -> SD
-#
-pid = /home/kern/bacula/bin/working/stunnel.pid
-#
-# A cert is not mandatory here. If verify=2, a
-# cert signed by a CA must be specified, and
-# either CAfile or CApath must point to the CA's
-# cert
-#
-cert = /home/kern/stunnel/stunnel.pem
-CAfile = /home/kern/ssl/cacert.pem
-verify = 2
-client = yes
-# debug = 7
-# foreground = yes
-[29103]
-accept = localhost:9103
-connect = server:29103
-\end{verbatim}
-\normalsize
-
-You will notice that I specified a pid file location because I ran stunnel
-under my own userid so I could not use the default, which requires root
-permission. I also specified a certificate that I have as well as verify level
-2 so that the certificate is required and verified, and I must supply the
-location of the CA (Certificate Authority) certificate so that the stunnel
-certificate can be verified. Finally, you will see that there are two lines
-commented out, which when enabled, produce a lot of nice debug info in the
-command window.
-
-If you do not have a signed certificate (stunnel.pem), you need to delete the
-cert, CAfile, and verify lines.
-
-Note that the stunnel.pem, is actually a private key and a certificate in a
-single file. These two can be kept and specified individually, but keeping
-them in one file is more convenient.
-
-The config file, stunnel-sd.conf, needed for Stunnel 4 on the server machine
-is:
-
-\footnotesize
-\begin{verbatim}
-#
-# Bacula stunnel conf for Storage daemon
-#
-pid = /home/kern/bacula/bin/working/stunnel.pid
-#
-# A cert is mandatory here, it may be self signed
-# If it is self signed, the client may not use
-# verify
-#
-cert = /home/kern/stunnel/stunnel.pem
-client = no
-# debug = 7
-# foreground = yes
-[29103]
-accept = 29103
-connect = 9103
-\end{verbatim}
-\normalsize
-
-\section{Starting and Testing the Data Encryption}
-\index[general]{Starting and Testing the Data Encryption }
-\index[general]{Encryption!Starting and Testing the Data }
-
-It will most likely be the simplest to implement the Data Channel encryption
-in the following order:
-
-\begin{itemize}
-\item Setup and run Bacula backing up some data on your client machine
- without encryption.
-\item Stop Bacula.
-\item Modify the Storage resource in the Director's conf file.
-\item Start Bacula
-\item Start stunnel on the server with:
-
- \footnotesize
-\begin{verbatim}
- stunnel stunnel-sd.conf
-
-\end{verbatim}
-\normalsize
-
-\item Start stunnel on the client with:
-
- \footnotesize
-\begin{verbatim}
- stunnel stunnel-fd2.conf
-
-\end{verbatim}
-\normalsize
-
-\item Run a job.
-\item If it doesn't work, turn debug on in both stunnel conf files, restart
- the stunnels, rerun the job, repeat until it works.
- \end{itemize}
-
-\section{Encrypting the Control Channel}
-\index[general]{Channel!Encrypting the Control }
-\index[general]{Encrypting the Control Channel }
-
-The Job control channel is between the Director and the File daemon, and as
-mentioned above, it is not really necessary to encrypt, but it is good
-practice to encrypt it as well. The two stunnels that are used in this case
-will be Stunnel 1 and Stunnel 3 in the diagram above. Stunnel 3 on the server
-might normally listen on port 9102, but if you have a local File daemon, this
-will not work, so we make it listen on port 29102. It then sends the data to
-client:29102. Again we use port 29102 so that the stunnel on the client
-machine can decrypt the data before passing it on to port 9102 where the File
-daemon is listening.
-
-\section{Control Channel Configuration}
-\index[general]{Control Channel Configuration }
-
-We need to modify the standard Client resource, which would normally look
-something like:
-
-\footnotesize
-\begin{verbatim}
-Client {
- Name = client-fd
- Address = client
- FDPort = 9102
- Catalog = BackupDB
- Password = "xxx"
-}
-\end{verbatim}
-\normalsize
-
-to be:
-
-\footnotesize
-\begin{verbatim}
-Client {
- Name = client-fd
- Address = localhost
- FDPort = 29102
- Catalog = BackupDB
- Password = "xxx"
-}
-\end{verbatim}
-\normalsize
-
-This will cause the Director to send the control information to
-localhost:29102 instead of directly to the client.
-
-\section{Stunnel Configuration for the Control Channel}
-\index[general]{Config Files for stunnel to Encrypt the Control Channel }
-
-The stunnel config file, stunnel-dir.conf, for the Director's machine would
-look like the following:
-
-\footnotesize
-\begin{verbatim}
-#
-# Bacula stunnel conf for the Directory to contact a client
-#
-pid = /home/kern/bacula/bin/working/stunnel.pid
-#
-# A cert is not mandatory here. If verify=2, a
-# cert signed by a CA must be specified, and
-# either CAfile or CApath must point to the CA's
-# cert
-#
-cert = /home/kern/stunnel/stunnel.pem
-CAfile = /home/kern/ssl/cacert.pem
-verify = 2
-client = yes
-# debug = 7
-# foreground = yes
-[29102]
-accept = localhost:29102
-connect = client:29102
-\end{verbatim}
-\normalsize
-
-and the config file, stunnel-fd1.conf, needed to run stunnel on the Client
-would be:
-
-\footnotesize
-\begin{verbatim}
-#
-# Bacula stunnel conf for the Directory to contact a client
-#
-pid = /home/kern/bacula/bin/working/stunnel.pid
-#
-# A cert is not mandatory here. If verify=2, a
-# cert signed by a CA must be specified, and
-# either CAfile or CApath must point to the CA's
-# cert
-#
-cert = /home/kern/stunnel/stunnel.pem
-CAfile = /home/kern/ssl/cacert.pem
-verify = 2
-client = yes
-# debug = 7
-# foreground = yes
-[29102]
-accept = localhost:29102
-connect = client:29102
-\end{verbatim}
-\normalsize
-
-\section{Starting and Testing the Control Channel}
-\index[general]{Starting and Testing the Control Channel }
-\index[general]{Channel!Starting and Testing the Control }
-
-It will most likely be the simplest to implement the Control Channel
-encryption in the following order:
-
-\begin{itemize}
-\item Stop Bacula.
-\item Modify the Client resource in the Director's conf file.
-\item Start Bacula
-\item Start stunnel on the server with:
-
- \footnotesize
-\begin{verbatim}
- stunnel stunnel-dir.conf
-
-\end{verbatim}
-\normalsize
-
-\item Start stunnel on the client with:
-
- \footnotesize
-\begin{verbatim}
- stunnel stunnel-fd1.conf
-
-\end{verbatim}
-\normalsize
-
-\item Run a job.
-\item If it doesn't work, turn debug on in both stunnel conf files, restart
- the stunnels, rerun the job, repeat until it works.
- \end{itemize}
-
-\section{Using stunnel to Encrypt to a Second Client}
-\index[general]{Using stunnel to Encrypt to a Second Client }
-\index[general]{Client!Using stunnel to Encrypt to a Second }
-
-On the client machine, you can just duplicate the setup that you have on the
-first client file for file and it should work fine.
-
-In the bacula-dir.conf file, you will want to create a second client pretty
-much identical to how you did for the first one, but the port number must be
-unique. We previously used:
-
-\footnotesize
-\begin{verbatim}
-Client {
- Name = client-fd
- Address = localhost
- FDPort = 29102
- Catalog = BackupDB
- Password = "xxx"
-}
-\end{verbatim}
-\normalsize
-
-so for the second client, we will, of course, have a different name, and we
-will also need a different port. Remember that we used port 29103 for the
-Storage daemon, so for the second client, we can use port 29104, and the
-Client resource would look like:
-
-\footnotesize
-\begin{verbatim}
-Client {
- Name = client2-fd
- Address = localhost
- FDPort = 29104
- Catalog = BackupDB
- Password = "yyy"
-}
-\end{verbatim}
-\normalsize
-
-Now, fortunately, we do not need a third stunnel to on the Director's machine,
-we can just add the new port to the config file, stunnel-dir.conf, to make:
-
-\footnotesize
-\begin{verbatim}
-#
-# Bacula stunnel conf for the Directory to contact a client
-#
-pid = /home/kern/bacula/bin/working/stunnel.pid
-#
-# A cert is not mandatory here. If verify=2, a
-# cert signed by a CA must be specified, and
-# either CAfile or CApath must point to the CA's
-# cert
-#
-cert = /home/kern/stunnel/stunnel.pem
-CAfile = /home/kern/ssl/cacert.pem
-verify = 2
-client = yes
-# debug = 7
-# foreground = yes
-[29102]
-accept = localhost:29102
-connect = client:29102
-[29104]
-accept = localhost:29102
-connect = client2:29102
-\end{verbatim}
-\normalsize
-
-There are no changes necessary to the Storage daemon or the other stunnel so
-that this new client can talk to our Storage daemon.
-
-\section{Creating a Self-signed Certificate}
-\index[general]{Creating a Self-signed Certificate }
-\index[general]{Certificate!Creating a Self-signed }
-
-You may create a self-signed certificate for use with stunnel that will permit
-you to make it function, but will not allow certificate validation. The .pem
-file containing both the certificate and the key can be made with the
-following, which I put in a file named {\bf makepem}:
-
-\footnotesize
-\begin{verbatim}
-#!/bin/sh
-#
-# Simple shell script to make a .pem file that can be used
-# with stunnel and Bacula
-#
-OPENSSL=openssl
- umask 77
- PEM1="/bin/mktemp openssl.XXXXXX"
- PEM2="/bin/mktemp openssl.XXXXXX"
- ${OPENSSL} req -newkey rsa:1024 -keyout $PEM1 -nodes \
- -x509 -days 365 -out $PEM2
- cat $PEM1 > stunnel.pem
- echo "" >>stunnel.pem
- cat $PEM2 >>stunnel.pem
- rm $PEM1 $PEM2
-\end{verbatim}
-\normalsize
-
-The above script will ask you a number of questions. You may simply answer
-each of them by entering a return, or if you wish you may enter your own data.
-
-
-\section{Getting a CA Signed Certificate}
-\index[general]{Certificate!Getting a CA Signed }
-\index[general]{Getting a CA Signed Certificate }
-
-The process of getting a certificate that is signed by a CA is quite a bit
-more complicated. You can purchase one from quite a number of PKI vendors, but
-that is not at all necessary for use with Bacula.
-
-To get a CA signed
-certificate, you will either need to find a friend that has setup his own CA
-or to become a CA yourself, and thus you can sign all your own certificates.
-The book OpenSSL by John Viega, Matt Mesier \& Pravir Chandra from O'Reilly
-explains how to do it, or you can read the documentation provided in the
-Open-source PKI Book project at Source Forge:
-\elink{
-http://ospkibook.sourceforge.net/docs/OSPKI-2.4.7/OSPKI-html/ospki-book.htm}
-{http://ospkibook.sourceforge.net/docs/OSPKI-2.4.7/OSPKI-html/ospki-book.htm}.
-Note, this link may change.
-
-\section{Using ssh to Secure the Communications}
-\index[general]{Communications!Using ssh to Secure the }
-\index[general]{Using ssh to Secure the Communications }
-
-Please see the script {\bf ssh-tunnel.sh} in the {\bf examples} directory. It
-was contributed by Stephan Holl.
+++ /dev/null
-%%
-%%
-
-\chapter{Supported Autochangers}
-\label{Models}
-\index[general]{Supported Autochanger Models}
-\index[general]{Autochangers!Supported}
-
-I hesitate to call these "supported" autochangers because the only
-autochangers that I have in my possession and am able to test are the HP
-SureStore DAT40X6 and the Overland PowerLoader LTO-2. All the other
-autochangers have been reported to work by Bacula users. Note, in the
-Capacity/Slot column below, I quote the Compressed capacity per tape (or
-Slot).
-
-Since on most systems (other than FreeBSD), Bacula uses {\bf mtx}
-through the {\bf mtx-changer} script, in principle, if {\bf mtx}
-will operate your changer correctly, then it is just a question
-of adapting the {\bf mtx-changer} script (or selecting one
-already adapted) for proper interfacing. You can find a list of
-autochangers supported by {\bf mtx} at the following link:
-\elink{http://mtx.opensource-sw.net/compatibility.php}
-{\url{http://mtx.opensource-sw.net/compatibility.php}}.
-The home page for the {\bf mtx} project can be found at:
-\elink{http://mtx.opensource-sw.net/}{\url{http://mtx.opensource-sw.net/}}.
-
-
-\addcontentsline{lot}{table}{Autochangers Known to Work with Bacula}
-\begin{longtable}{|p{0.6in}|p{0.8in}|p{1.9in}|p{0.8in}|p{0.5in}|p{0.75in}|}
- \hline
-\multicolumn{1}{|c| }{\bf OS } & \multicolumn{1}{c| }{\bf Man. } &
-\multicolumn{1}{c| }{\bf Media } & \multicolumn{1}{c| }{\bf Model } &
-\multicolumn{1}{c| }{\bf Slots } & \multicolumn{1}{c| }{\bf Cap/Slot } \\
- \hline {Linux } & {Adic } & {DDS-3} & {Adic 1200G } & {12} & {-} \\
- \hline {Linux } & {Adic } & {DLT} & {FastStore 4000 } & {7} & {20GB} \\
- \hline {Linux } & {Adic } & {LTO-1/2, SDLT 320 } & {Adic Scalar 24 } & {24} & {100GB } \\
- \hline {Linux } & {Adic } & {LTO-2 } & {Adic FastStor 2, Sun Storedge L8 } & {8} & {200GB } \\
- \hline {Linux } & {BDT } & {AIT } & {BDT ThinStor } & {?} & {200GB } \\
- \hline {- } & {CA-VM } & {?? } & {Tape } & {??} & {?? } \\
- \hline {Linux } & {Dell} & {DLT VI,LTO-2,LTO3} & {PowerVault 122T/132T/136T } & {-} & {100GB } \\
- \hline {Linux } & {Dell} & {LTO-2} & {PowerVault 124T } & {-} & {200GB } \\
- \hline {- } & {DFSMS } & {?? } & {VM RMM} & {-} & {?? } \\
- \hline {Linux } & {Exabyte } & {VXA2 } & {VXA PacketLoader 1x10 2U } & {10} & {80/160GB } \\
- \hline {- } & {Exabyte } & {LTO } & {Magnum 1x7 LTO Tape Auotloader } & {7} & {200/400GB } \\
- \hline {Linux } & {Exabyte } & {AIT-2 } & {215A } & {15 (2 drives)} & {50GB } \\
- \hline {Linux } & {HP } & {DDS-4 } & {SureStore DAT-40X6 } & {6 } & {40GB } \\
- \hline {Linux } & {HP } & {Ultrium-2/LTO } & {MSL 6000/ 60030/ 5052 } & {28 } & {200/400GB } \\
- \hline {- } & {HP } & {DLT } & {A4853 DLT } & {30} & {40/70GB } \\
- \hline {Linux } & {HP (Compaq) } & {DLT VI } & {Compaq TL-895 } & {96+4 import export} & {35/70GB } \\
- \hline {z/VM } & {IBM } & {?? } & {IBM Tape Manager } & {-} & {?? } \\
- \hline {z/VM } & {IBM } & {?? } & {native tape } & {-} & {?? } \\
- \hline {Linux } & {IBM } & {LTO } & {IBM 3581 Ultrium Tape Loader } & {7} & {200/400GB } \\
- \hline {FreeBSD 5.4} & {IBM } & {DLT} & {IBM 3502-R14 -- rebranded ATL L-500} & {14} & {35/70GB } \\
- \hline {Linux} & {IBM } & {???} & {IBM TotalStorage 3582L23} & {??} & {?? } \\
- \hline {Debian} & {Overland } & {LTO } & {Overland LoaderXpress LTO/DLT8000 } & {10-19} & {40-100GB } \\
- \hline {Fedora} & {Overland } & {LTO } & {Overland PowerLoader LTO-2 } & {10-19} & {200/400GB } \\
- \hline {FreeBSD 5.4-Stable} & {Overland} & {LTO-2} & {Overland Powerloader tape} & {17} & {100GB } \\
- \hline {- } & {Overland} & {LTO } & {Overland Neo2000 LTO } & {26-30} & {100GB } \\
- \hline {Linux} & {Quantum } & {DLT-S4} & {Superloader 3} & {16} & {800/1600GB } \\
- \hline {Linux} & {Quantum } & {LTO-2} & {Superloader 3} & {16} & {200/400GB } \\
- \hline {Linux} & {Quantum } & {LTO-3 } & {PX502 } & {??} & {?? } \\
- \hline {FreeBSD 4.9 } & {QUALSTAR TLS-4210 (Qualstar) } & {AIT1: 36GB, AIT2: 50GB all
-uncomp } & {QUALSTAR TLS-4210 } & {12} & {AIT1: 36GB, AIT2: 50GB all uncomp }\\
- \hline {Linux } & {Skydata } & {DLT } & {ATL-L200 } & {8} & {40/80 } \\
- \hline {- } & {Sony } & {DDS-4 } & {TSL-11000 } & {8} & {40GB } \\
- \hline {Linux } & {Sony } & {AIT-2} & {LIB-304(SDX-500C) } & {?} & {200GB } \\
- \hline {Linux } & {Sony } & {AIT-3} & {LIB-D81) } & {?} & {200GB } \\
- \hline {FreeBSD 4.9-STABLE } & {Sony } & {AIT-1 } & {TSL-SA300C } & {4} & {45/70GB }\\
- \hline {- } & {Storagetek } & {DLT } & {Timberwolf DLT } & {6} & {40/70 } \\
- \hline {- } & {Storagetek } & {?? } & {ACSLS } & {??} & {?? } \\
- \hline {Solaris } & {Sun } & {4mm DLT } & {Sun Desktop Archive Python 29279 } & {4} & {20GB } \\
- \hline {Linux } & {Tandberg } & {DLT VI } & {VS 640 } & {8?} & {35/70GB } \\
- \hline {Linux 2.6.x } & {Tandberg Data } & {SLR100 } & {SLR100 Autoloader } & {8} & {50/100GB }\\
-\hline
-
-\end{longtable}
+++ /dev/null
-%%
-%%
-
-\chapter{Unterst\"{u}tzte Bandlaufwerke}
-\label{SupportedDrives}
-\index[general]{Bandlaufwerke!unterst\"{u}tzte}
-\index[general]{Unterst\"{u}tzte Bandlaufwerke }
-
-Auch wenn Ihr Bandlaufwerk in der untenstehenden Liste eingetragen ist, lesen Sie bitte im Kapitel \ilink{Test der Bandlaufwerke}{btape1} in diesem Handbuch wie Sie sich vergewissern k\"{o}nnen, dass Ihr Bandlaufwerk mit Bacula zusammen funktionieren wird.
-
-Wenn Ihr Laufwerk im festen Block-Modus arbeitet, k\"{o}nnte es zun\"{a}chst so aussehen, als ob es funkioniert, bis sie dann eine Wiederherstellung machen und Bacula versucht, das Band zu positionieren. Sie k\"{o}nnen nur sicher sein, wenn sie die oben vorgeschlagenen Verfahren befolgen und testen.
-
-Weil wir so wenige R\"{u}ckmeldungen haben, ist es sehr schwierig, eine Liste der unterst\"{u}tzten Laufwerke oder zumindest jener zu liefern, mit denen Bacula funktioniert (wenn sie also Bacula mit einem anderen Laufwerk benutzen, melden Sie es bitte). Laut unseren Benutzern arbeiten die folgenden Laufwerke unter Bacula. Ein Strich in einer Spalte bedeutet ``unbekannt''.
-
-\addcontentsline{lot}{table}{Supported Tape Drives}
-%war: zwei mal 2.5 in
-\begin{longtable}{|p{1.0in}|l|l|p{1.5in}|l|}
- \hline
-\multicolumn{1}{|c| }{\bf BS } & \multicolumn{1}{c| }{\bf Herst.} &
-\multicolumn{1}{c| }{\bf Media } & \multicolumn{1}{c| }{\bf Modell } &
-\multicolumn{1}{c| }{\bf Kapazit\"{a}t } \\
- \hline {- } & {ADIC } & {DLT } & {Adic Scalar 100 DLT } & {100GB } \\
- \hline {- } & {ADIC } & {DLT } & {Adic Fastor 22 DLT } & {- } \\
- \hline {- } & {- } & {DDS } & {Compaq DDS 2,3,4 } & {- } \\
- \hline {- } & {Exabyte } & {- } & {Exabyte LWe, \lt 10 Jahre alt } & {- } \\
- \hline {- } & {Exabyte } & {- } & {Exabyte VXA LWe } & {- } \\
- \hline {- } & {HP } & {Travan 4 } & {Colorado T4000S } & {- } \\
- \hline {- } & {HP } & {DLT } & {HP DLT LWe } & {- } \\
- \hline {- } & {HP } & {LTO } & {HP LTO Ultrium LWe } & {- } \\
- \hline {- } & {IBM} & {??} & {3480, 3480XL, 3490, 3490E, 3580 and 3590 LWe} & {- } \\
- \hline {FreeBSD 4.10 RELEASE } & {HP } & {DAT } & {HP StorageWorks DAT72i } & {- } \\
- \hline {FreeBSD 5.4-RELEASE-p1 amd64 } & {Certance} & {LTO } & {AdicCertance CL400 LTO Ultrium 2 } & {200GB } \\
- \hline {- } & {Overland } & {LTO } & {LoaderXpress LTO } & {- } \\
- \hline {SuSE 8.1 Pro} & {Compaq} & {AIT } & {Compaq AIT 35 LVD } & {35/70GB } \\
- \hline {- } & {Overland } & {- } & {Neo2000 } & {- } \\
- \hline {- } & {OnStream } & {- } & {OnStream LWe (siehe unten) } & {- } \\
- \hline {- } & {Quantum } & {DLT } & {DLT-8000 } & {40/80GB } \\
- \hline {Linux } & {Seagate } & {DDS-4 } & {Scorpio 40 } & {20/40GB } \\
- \hline {FreeBSD 4.9 STABLE } & {Seagate } & {DDS-4 } & {STA2401LW } & {20/40GB } \\
- \hline {FreeBSD 5.2.1, Pthreads gepatcht } & {Seagate } & {AIT-1 } & {STA1701W} & {35/70GB } \\
- \hline {Linux } & {Sony } & {DDS-2,3,4 } & {- } & {4-40GB } \\
- \hline {Linux } & {Tandberg } & {- } & {Tandbert MLR3 } & {- } \\
- \hline {FreeBSD } & {Tandberg } & {- } & {Tandberg SLR6 } & {- } \\
- \hline {FreeBSD 4.11-Release} & {Quantum } & {SDLT } & {SDLT320 } & {160/320GB } \\
- \hline {Solaris } & {Tandberg } & {- } & {Tandberg SLR75 } & {- } \\
- \hline
-
-\end{longtable}
-
-Es gibt eine Liste mit \ilink{unterst\"{u}tzten Autochanger}{Models} im Kapitel ``Unterst\"{u}tzte Autochanger'' in diesem Dokument, in dem noch weitere Laufwerke aufgef\"{u}hrt sind, die mit Bacula funktionieren.
-
-\section{Nicht unterst\"{u}tzte Bandlaufwerke}
-\label{UnSupportedDrives}
-\index[general]{Nicht unterst\"{u}tzte Bandlaufwerke }
-\index[general]{Bandlaufwerke!nicht unterst\"{u}tzte }
-
-Bisher funktionierten OnStream IDE-SCSI Bandlaufwerke nicht unter Bacula. Seit der Bacula-Version 1.33 und der Version 0.9.14 des osst-Kerneldrivers funktionieren sie nun. Da sie eine feste Blockgr\"{o}{\ss}e einstellen m\"{u}ssen, beachten sie bitte das Kapitel zum Testen.
-
-Von QIC-B\"{a}ndern wei{\ss} man, dass sie einige Besonderheiten haben (feste Blockgr\"{o}{\ss}e, eher ein EOF als zwei zur Markierung des Bandendes). Sie m\"{u}ssen diese daher sehr sorgf\"{a}ltig konfigurieren, wenn sie korrekt mit Bacula arbeiten sollen.
-
-\section{Warnung f\"{u}r FreeBSD-Benutzer!!!}
-\index[general]{Warnung f\"{u}r FreeBSD-Benutzer!!! }
-\index[general]{FreeBSD-Benutzer!Warnung f\"{u}r}
-
-Solange die Pthreads-Bibliothek der meisten FreeBSD-Systeme nicht gepatcht ist, werden Sie Daten verlieren, wenn Sie mit Bacula B\"{a}nder vollschreiben. Die ungepatchte Pthreads-Bibliothek ist nicht in der Lage, Bacula eine Warnung zur\"{u}ckzugeben, wenn das Bandende naht. Beachten Sie bitte das Kapitel zum Test der B\"{a}nder in diesem Handbuch mit \textbf{wichtigen} Informationen, wie man das Bandlaufwerk so konfiguriert, dass es zu Bacula kompatibel ist.
-
-
-\section{Unterst\"{u}tzte Autochanger}
-\index[general]{Autochanger!unterst\"{u}tzte }
-\index[general]{Unterst\"{u}tzte Autochanger }
-
-Informationen zu den unterst\"{u}tzten Autochangern stehen im Abschnitt
-\ilink{Autochangers Known to Work with Bacula}{Models}
-im Kapitel ``Unterst\"{u}tzte Autochanger'' dieses Handbuches.
-
-\section{Band-Spezifikationen}
-\index[general]{Spezifikationen!Band-}
-\index[general]{Band-Spezifikationen}
-Wir k\"{o}nnen Ihnen wirklich nicht sagen welche B\"{a}nder zusammen mit Bacula funktionieren werden. Wenn Sie ein Laufwerk kaufen wollen, sollten Sie versuchen, DDS-Laufwerke zu vermeiden. Deren Technologie ist relativ alt und die Laufwerke ben\"{o}tigen regelm\"{a}{\ss}ige Reinigung. DLT-Laufwerke sind im allgemeinen viel besser (neuere Technologie) und ben\"{o}tigen keine regelm\"{a}{\ss}ige Reinigung.
-
-Unten ist eine Tabelle mit den Spezifikationen von DLT- und LTO-B\"{a}ndern, die Ihnen einen Eindruck der Geschwindigkeit und Kapazit\"{a}t aktueller B\"{a}nder geben soll. Die aufgef\"{u}hrte Kapazit\"{a}t ist die reine Bandkapazit\"{a}t ohne Kompression. Alle modernen Laufwerke arbeiten mit Hardware-Kompression und die Hersteller geben oft eine Kompressionsrate von 2:1 an. Die tats\"{a}chliche Kompressionsrate h\"{a}ngt haupts\"{a}chlich von den zu sichernden Daten ab, aber ich finde 1,5:1 ist ein viel vern\"{u}nftigerer Wert (multiplizieren Sie die Werte der Tabelle mit 1,5 und Sie werden ein grobes Mittel dessen erhalten, was Sie m\"{o}glicherweise sehen werden). Die Transferraten sind auf den n\"{a}chsten GB/hr-Wert gerundet. Die Werte wurden von verschiedenen Herstellern zur Verf\"{u}gung gestellt.
-In der Spalte ``Medien Typ'' stehen die Benennungen der Hersteller. Es ist nicht notwendig, diese Namen in den Konfigurationsdateien von Bacula zu benutzen. Allerdings k\"{o}nnen Sie das tun.
-
-
- \begin{tabular}{|c|c|c|c}
- Medien Typ & Laufwerks-Type & Medien Kapazit\"{a}t & Transferrate \\ \hline
- DDS-1 & DAT & 2 GB & ?? GB/hr \\ \hline
- DDS-2 & DAT & 4 GB & ?? GB/hr \\ \hline
- DDS-3 & DAT & 12 GB & 5.4 GB/hr \\ \hline
- Travan 40 & Travan & 20 GB & ?? GB/hr \\ \hline
- DDS-4 & DAT & 20 GB & 11 GB/hr \\ \hline
- VXA-1 & Exabyte & 33 GB & 11 GB/hr \\ \hline
- DAT-72 & DAT & 36 GB & 13 GB/hr \\ \hline
- DLT IV & DLT8000 & 40 GB & 22 GB/hr \\ \hline
- VXA-2 & Exabyte & 80 GB & 22 GB/hr \\ \hline
- Half-high Ultrum 1 & LTO 1 & 100 GB & 27 GB/hr \\ \hline
- Ultrium 1 & LTO 1 & 100 GB & 54 GB/hr \\ \hline
- Super DLT 1 & SDLT 220 & 110 GB & 40 GB/hr \\ \hline
- VXA-3 & Exabyte & 160 GB & 43 GB/hr \\ \hline
- Super DLT I & SDLT 320 & 160 GB & 58 GB/hr \\ \hline
- Ultrium 2 & LTO 2 & 200 GB & 108 GB/hr \\ \hline
- Super DLT II & SDLT 600 & 300 GB & 127 GB/hr \\ \hline
- VXA-4 & Exabyte & 320 GB & 86 GB/hr \\ \hline
- Ultrium 3 & LTO 3 & 400 GB & 216 GB/hr \\ \hline
- \end{tabular}
-
+++ /dev/null
-%%
-%%
-
-\chapter{Unterst\"{u}tzte Betriebssysteme}
-\label{SupportedOSes}
-\index[general]{Betriebssysteme!Unterst\"{u}tzte }
-\index[general]{Unterst\"{u}tzte Betriebssysteme }
-
-\begin{itemize}
-\item[X] Fully supported
-\item[$\star$] The are reported to work in many cases. However they are NOT
- supported by the bacula's project.
-\end{itemize}
-
-
-\begin{tabular}[h]{|l|l|c|c|c|}
- \hline
- Operating Systems & Version & Client \small{Daemon} & Director \small{Daemon} & Storage \small{Daemon} \\
- \hline
- \hline
- GNU/Linux
- & All & X & X & X \\
- \hline
- FreeBSD & $\geq$ 5.0 & X & X & X
- \\
- \hline
- Solaris & $\geq$ 8 & X & X & X \\
- \hline
- OpenSolaris & ~ & X & X & X \\
- \hline
- \hline
- MS Windows 32bit& Win98/Me & X & ~ & ~ \\
- \hline
- ~ & WinNT/2K & X & $\star$ & $\star$ \\
- \hline
- ~ & XP & X & $\star$ & $\star$ \\
- ~ & 2008/Vista & X & $\star$ & $\star$ \\
- MS Windows 64bit& 2008/Vista & X & ~ & ~ \\
- \hline
- \hline
- MacOS X/Darwin & ~ & X & ~ & ~ \\
- \hline
- OpenBSD & ~ & X & $\star$ & ~ \\
- \hline
- NetBSD & ~ & X & $\star$ & ~ \\
- \hline
- Irix & ~ & $\star$ & ~ & ~ \\
- \hline
- True64 & ~ & $\star$ & ~ & ~ \\
- \hline
- AIX & $\geq$ 4.3 & $\star$ & ~ & ~ \\
- \hline
- BSDI & ~ & $\star$ & ~ & ~ \\
- \hline
- HPUX & ~ & $\star$ & ~ & ~ \\
- \hline
-\end{tabular}
-
-\section*{Important notes}
-
-\begin{itemize}
-\item By GNU/Linux, we mean 32/64bit Gentoo, Red Hat, Fedora, Mandriva,
- Debian, OpenSuSE, Ubuntu, Kubuntu, \dots
-
-\item FreeBSD (zur Unterst\"{u}tzung der Bandlaufwerke in Version 1.30 lesen
- Sie bitte die \textbf{wichtige} Hinweise im Abschnitt \ilink{Band-Modi
- unter FreeBSD}{FreeBSDTapes} des Kapitels zum Test der Bandlaufwerke in
- diesem Handbuch.)
-
-\item MS Windows Director and Storage daemon are available
- in the binary Client installer
-
-\item For MacOSX see \elink{
- http://fink.sourceforge.net/}{http://fink.sourceforge.net/ for
- obtaining the packages}
-\end{itemize}
-
-Wenn Sie ein neueres ``RedHat'' Linux-System mit Kernel 2.4.x haben und im
-System ein Verzeichnis {\bf /lib/tls} angelegt ist (normalerweise
-voreingestellt), wird Bacula {\bf NICHT} starten. Dies liegt an der neuen
-Pthreads-Bibliothek, die fehlerhaft ist. Um Bacula zum laufen zu bringen, muss
-dieses Verzeichnis entfernt oder umbenannt und der Computer neu gestartet
-werden (eine der seltenen Gelegenheiten, bei denen man Linux neu booten
-muss). Sollte es nicht m\"{o}glich sein, /lib/tls zu entfernen oder
-umzubenennen, setzt man stattdessen die Umgebungsvariable
-``LD\_ASSUME\_KERNEL=2.4.19'' bevor man Bacula startet. Hierbei muss der
-Rechner nicht neu gestartet werden und alle anderen Programme werden /lib/tls
-weiterhin benutzen.
-
-Aus R\"{u}ckmeldungen unsere Benutzer wissen wir, dass das Problem auch mit
-Kerneln der Version 2.6 besteht. Hier w\"{u}rden wir eher dazu raten die
-Umgebungsvariable neu zu setzen (LD\_ASSUME\_KERNEL=2.4.19), als das
-Verzeichnis /lib/tls zu entfernen.
-
-Lesen Sie zur Portierung im ``Bacula Developer's Guide'' Informationen, wie man
-Bacula auf andere Systeme \"{u}bertr\"{a}gt.
-
-
+++ /dev/null
-%%
-%%
-
-\chapter{Thanks}
-\label{ThanksChapter}
-\index[general]{Thanks }
-I thank everyone who has helped this project. Unfortunately, I cannot
-thank everyone (bad memory). However, the AUTHORS file in the main source
-code directory should include the names of all persons who have contributed
-to the Bacula project. Just the same, I would like to include thanks below
-to special contributors as well as to the major contributors to the current
-release.
-
-Thanks to Richard Stallman for starting the Free Software movement and for
-bringing us gcc and all the other GNU tools as well as the GPL license.
-
-Thanks to Linus Torvalds for bringing us Linux.
-
-Thanks to all the Free Software programmers. Without being able to peek at
-your code, and in some cases, take parts of it, this project would have been
-much more difficult.
-
-Thanks to John Walker for suggesting this project, giving it a name,
-contributing software he has written, and for his programming efforts on
-Bacula as well as having acted as a constant sounding board and source of
-ideas.
-
-Thanks to the apcupsd project where I started my Free Software efforts, and
-from which I was able to borrow some ideas and code that I had written.
-
-Special thanks to D. Scott Barninger for writing the bacula RPM spec file,
-building all the RPM files and loading them onto Source Forge. This has been a
-tremendous help.
-
-Many thanks to Karl Cunningham for converting the manual from html format to
-LaTeX. It was a major effort flawlessly done that will benefit the Bacula
-users for many years to come. Thanks Karl.
-
-Thanks to Dan Langille for the {\bf incredible} amount of testing he did on
-FreeBSD. His perseverance is truly remarkable. Thanks also for the many
-contributions he has made to improve Bacula (pthreads patch for FreeBSD,
-improved start/stop script and addition of Bacula userid and group, stunnel,
-...), his continuing support of Bacula users. He also wrote the PostgreSQL
-driver for Bacula and has been a big help in correcting the SQL.
-
-Thanks to multiple other Bacula Packagers who make and release packages for
-different platforms for Bacula.
-
-Thanks to Christopher Hull for developing the native Win32 Bacula emulation
-code and for contributing it to the Bacula project.
-
-Thanks to Robert Nelson for bringing our Win32 implementation up to par
-with all the same features that exist in the Unix/Linux versions. In
-addition, he has ported the Director and Storage daemon to Win32!
-
-Thanks to Thorsten Engel for his excellent knowledge of Win32 systems, and
-for making the Win32 File daemon Unicode compatible, as well as making
-the Win32 File daemon interface to Microsoft's Volume Shadow Copy (VSS).
-These two are big pluses for Bacula!
-
-Thanks to Landon Fuller for writing both the communications and the
-data encryption code for Bacula.
-
-Thanks to Arno Lehmann for his excellent and infatigable help and advice
-to users.
-
-Thanks to all the Bacula users, especially those of you who have contributed
-ideas, bug reports, patches, and new features.
-
-Bacula can be enabled with data encryption and/or communications
-encryption. If this is the case, you will be including OpenSSL code that
-that contains cryptographic software written by Eric Young
-(eay@cryptsoft.com) and also software written by Tim Hudson
-(tjh@cryptsoft.com).
-
-The Bat (Bacula Administration Tool) graphs are based in part on the work
-of the Qwt project (http://qwt.sf.net).
-
-The original variable expansion code used in the LabelFormat comes from the
-Open Source Software Project (www.ossp.org). It has been adapted and extended
-for use in Bacula. This code is now deprecated.
-
-There have been numerous people over the years who have contributed ideas,
-code, and help to the Bacula project. The file AUTHORS in the main source
-release file contains a list of contributors. For all those who I have
-left out, please send me a reminder, and in any case, thanks for your
-contribution.
-
-Thanks to the Free Software Foundation Europe e.V. for assuming the
-responsibilities of protecting the Bacula copyright.
-
-% TODO: remove this from the book?
-\section*{Copyrights and Trademarks}
-\index[general]{Trademarks!Copyrights and }
-\index[general]{Copyrights and Trademarks }
-
-Certain words and/or products are Copyrighted or Trademarked such as Windows
-(by Microsoft). Since they are numerous, and we are not necessarily aware of
-the details of each, we don't try to list them here. However, we acknowledge
-all such Copyrights and Trademarks, and if any copyright or trademark holder
-wishes a specific acknowledgment, notify us, and we will be happy to add it
-where appropriate.
+++ /dev/null
-
-\chapter{Bacula TLS -- Communications Encryption}
-\label{CommEncryption}
-\index[general]{TLS -- Communications Encryption}
-\index[general]{Communications Encryption}
-\index[general]{Encryption!Communications}
-\index[general]{Encryption!Transport}
-\index[general]{Transport Encryption}
-\index[general]{TLS}
-
-Bacula TLS (Transport Layer Security) is built-in network
-encryption code to provide secure network transport similar to
-that offered by {\bf stunnel} or {\bf ssh}. The data written to
-Volumes by the Storage daemon is not encrypted by this code.
-For data encryption, please see the \ilink{Data Encryption
-Chapter}{DataEncryption} of this manual.
-
-The Bacula encryption implementations were written by Landon Fuller.
-
-Supported features of this code include:
-\begin{itemize}
-\item Client/Server TLS Requirement Negotiation
-\item TLSv1 Connections with Server and Client Certificate
-Validation
-\item Forward Secrecy Support via Diffie-Hellman Ephemeral Keying
-\end{itemize}
-
-This document will refer to both "server" and "client" contexts. These
-terms refer to the accepting and initiating peer, respectively.
-
-Diffie-Hellman anonymous ciphers are not supported by this code. The
-use of DH anonymous ciphers increases the code complexity and places
-explicit trust upon the two-way CRAM-MD5 implementation. CRAM-MD5 is
-subject to known plaintext attacks, and it should be considered
-considerably less secure than PKI certificate-based authentication.
-
-Appropriate autoconf macros have been added to detect and use OpenSSL
-if enabled on the {\bf ./configure} line with {\bf \verb?--?with-openssl}
-
-\section{TLS Configuration Directives}
-Additional configuration directives have been added to all the daemons
-(Director, File daemon, and Storage daemon) as well as the various
-different Console programs.
-These new directives are defined as follows:
-
-\begin{description}
-\item [TLS Enable = \lt{}yes|no\gt{}]
-Enable TLS support. If TLS is not enabled, none of the other TLS directives
-have any effect. In other words, even if you set {\bf TLS Require = yes}
-you need to have TLS enabled or TLS will not be used.
-
-\item [TLS Require = \lt{}yes|no\gt{}]
-Require TLS connections. This directive is ignored unless {\bf TLS Enable}
-is set to {\bf yes}. If TLS is not required, and TLS is enabled, then
-Bacula will connect with other daemons either with or without TLS depending
-on what the other daemon requests. If TLS is enabled and TLS is required,
-then Bacula will refuse any connection that does not use TLS.
-
-\item [TLS Certificate = \lt{}Filename\gt{}]
-The full path and filename of a PEM encoded TLS certificate. It can be
-used as either a client or server certificate. PEM stands for Privacy
-Enhanced Mail, but in this context refers to how the certificates are
-encoded. It is used because PEM files are base64 encoded and hence ASCII
-text based rather than binary. They may also contain encrypted
-information.
-
-\item [TLS Key = \lt{}Filename\gt{}]
-The full path and filename of a PEM encoded TLS private key. It must
-correspond to the TLS certificate.
-
-\item [TLS Verify Peer = \lt{}yes|no\gt{}]
-Verify peer certificate. Instructs server to request and verify the
-client's x509 certificate. Any client certificate signed by a known-CA
-will be accepted unless the TLS Allowed CN configuration directive is used,
-in which case the client certificate must correspond to the Allowed
-Common Name specified. This directive is valid only for a server
-and not in a client context.
-
-\item [TLS Allowed CN = \lt{}string list\gt{}]
-Common name attribute of allowed peer certificates. If this directive is
-specified, all server certificates will be verified against this list. This
-can be used to ensure that only the CA-approved Director may connect.
-This directive may be specified more than once.
-
-\item [TLS CA Certificate File = \lt{}Filename\gt{}]
-The full path and filename specifying a
-PEM encoded TLS CA certificate(s). Multiple certificates are
-permitted in the file. One of \emph{TLS CA Certificate File} or \emph{TLS
-CA Certificate Dir} are required in a server context if \emph{TLS
-Verify Peer} (see above) is also specified, and are always required in a client
-context.
-
-\item [TLS CA Certificate Dir = \lt{}Directory\gt{}]
-Full path to TLS CA certificate directory. In the current implementation,
-certificates must be stored PEM encoded with OpenSSL-compatible hashes,
-which is the subject name's hash and an extension of {bf .0}.
-One of \emph{TLS CA Certificate File} or \emph{TLS CA Certificate Dir} are
-required in a server context if \emph{TLS Verify Peer} is also specified,
-and are always required in a client context.
-
-\item [TLS DH File = \lt{}Directory\gt{}]
-Path to PEM encoded Diffie-Hellman parameter file. If this directive is
-specified, DH key exchange will be used for the ephemeral keying, allowing
-for forward secrecy of communications. DH key exchange adds an additional
-level of security because the key used for encryption/decryption by the
-server and the client is computed on each end and thus is never passed over
-the network if Diffie-Hellman key exchange is used. Even if DH key
-exchange is not used, the encryption/decryption key is always passed
-encrypted. This directive is only valid within a server context.
-
-To generate the parameter file, you
-may use openssl:
-
-\begin{verbatim}
- openssl dhparam -out dh1024.pem -5 1024
-\end{verbatim}
-
-\end{description}
-
-\section{Creating a Self-signed Certificate}
-\index[general]{Creating a Self-signed Certificate }
-\index[general]{Certificate!Creating a Self-signed }
-
-You may create a self-signed certificate for use with the Bacula TLS that
-will permit you to make it function, but will not allow certificate
-validation. The .pem file containing both the certificate and the key
-valid for ten years can be made with the following:
-
-\footnotesize
-\begin{verbatim}
- openssl req -new -x509 -nodes -out bacula.pem -keyout bacula.pem -days 3650
-\end{verbatim}
-\normalsize
-
-The above script will ask you a number of questions. You may simply answer
-each of them by entering a return, or if you wish you may enter your own data.
-
-Note, however, that self-signed certificates will only work for the
-outgoing end of connections. For example, in the case of the Director
-making a connection to a File Daemon, the File Daemon may be configured to
-allow self-signed certificates, but the certificate used by the
-Director must be signed by a certificate that is explicitly trusted on the
-File Daemon end.
-
-This is necessary to prevent ``man in the middle'' attacks from tools such
-as \elink{ettercap}{http://ettercap.sourceforge.net/}. Essentially, if the
-Director does not verify that it is talking to a trusted remote endpoint,
-it can be tricked into talking to a malicious 3rd party who is relaying and
-capturing all traffic by presenting its own certificates to the Director
-and File Daemons. The only way to prevent this is by using trusted
-certificates, so that the man in the middle is incapable of spoofing the
-connection using his own.
-
-To get a trusted certificate (CA or Certificate Authority signed
-certificate), you will either need to purchase certificates signed by a
-commercial CA or find a friend that has setup his own CA or become a CA
-yourself, and thus you can sign all your own certificates. The book
-OpenSSL by John Viega, Matt Mesier \& Pravir Chandra from O'Reilly explains
-how to do it, or you can read the documentation provided in the Open-source
-PKI Book project at Source Forge: \elink{
-http://ospkibook.sourceforge.net/docs/OSPKI-2.4.7/OSPKI-html/ospki-book.htm}
-{http://ospkibook.sourceforge.net/docs/OSPKI-2.4.7/OSPKI-html/ospki-book.htm}.
-Note, this link may change.
-
-The program TinyCA has a very nice Graphical User Interface
-that allows you to easily setup and maintain your own CA.
-TinyCA can be found at
-\elink{http://tinyca.sm-zone.net/}{http://tinyca.sm-zone.net/}.
-
-
-\section{Getting a CA Signed Certificate}
-\index[general]{Certificate!Getting a CA Signed }
-\index[general]{Getting a CA Signed Certificate }
-
-The process of getting a certificate that is signed by a CA is quite a bit
-more complicated. You can purchase one from quite a number of PKI vendors, but
-that is not at all necessary for use with Bacula. To get a CA signed
-certificate, you will either need to find a friend that has setup his own CA
-or to become a CA yourself, and thus you can sign all your own certificates.
-The book OpenSSL by John Viega, Matt Mesier \& Pravir Chandra from O'Reilly
-explains how to do it, or you can read the documentation provided in the
-Open-source PKI Book project at Source Forge:
-\elink{
-http://ospkibook.sourceforge.net/docs/OSPKI-2.4.7/OSPKI-html/ospki-book.htm}
-{http://ospkibook.sourceforge.net/docs/OSPKI-2.4.7/OSPKI-html/ospki-book.htm}.
-Note, this link may change.
-
-\section{Example TLS Configuration Files}
-\index[general]{Example!TLS Configuration Files}
-\index[general]{TLS Configuration Files}
-
-Landon has supplied us with the TLS portions of his configuration
-files, which should help you setting up your own. Note, this example
-shows the directives necessary for a Director to Storage daemon session.
-The technique is the same between the Director and the Client and
-for bconsole to the Director.
-
-{\bf bacula-dir.conf}
-\footnotesize
-\begin{verbatim}
- Director { # define myself
- Name = backup1-dir
- ...
- TLS Enable = yes
- TLS Require = yes
- TLS Verify Peer = yes
- TLS Allowed CN = "bacula@backup1.example.com"
- TLS Allowed CN = "administrator@example.com"
- TLS CA Certificate File = /usr/local/etc/ssl/ca.pem
- # This is a server certificate, used for incoming
- # console connections.
- TLS Certificate = /usr/local/etc/ssl/backup1/cert.pem
- TLS Key = /usr/local/etc/ssl/backup1/key.pem
- }
-
- Storage {
- Name = File
- Address = backup1.example.com
- ...
- TLS Require = yes
- TLS CA Certificate File = /usr/local/etc/ssl/ca.pem
- # This is a client certificate, used by the director to
- # connect to the storage daemon
- TLS Certificate = /usr/local/etc/ssl/bacula@backup1/cert.pem
- TLS Key = /usr/local/etc/ssl/bacula@backup1/key.pem
- }
-
- Client {
- Name = backup1-fd
- Address = server1.example.com
- ...
-
- TLS Enable = yes
- TLS Require = yes
- TLS CA Certificate File = /usr/local/etc/ssl/ca.pem
- }
-
-\end{verbatim}
-\normalsize
-
-{\bf bacula-fd.conf}
-\footnotesize
-\begin{verbatim}
- Director {
- Name = backup1-dir
- ...
- TLS Enable = yes
- TLS Require = yes
- TLS Verify Peer = yes
- # Allow only the Director to connect
- TLS Allowed CN = "bacula@backup1.example.com"
- TLS CA Certificate File = /usr/local/etc/ssl/ca.pem
- # This is a server certificate. It is used by connecting
- # directors to verify the authenticity of this file daemon
- TLS Certificate = /usr/local/etc/ssl/server1/cert.pem
- TLS Key = /usr/local/etc/ssl/server1/key.pem
- }
-
- FileDaemon {
- Name = backup1-fd
- ...
- # you need these TLS entries so the SD and FD can
- # communicate
- TLS Enable = yes
- TLS Require = yes
-
- TLS CA Certificate File = /usr/local/etc/ssl/ca.pem
- TLS Certificate = /usr/local/etc/ssl/server1/cert.pem
- TLS Key = /usr/local/etc/ssl/server1/key.pem
-}
-\end{verbatim}
-\normalsize
-
-{\bf bacula-sd.conf}
-\footnotesize
-\begin{verbatim}
- Storage { # definition of myself
- Name = backup1-sd
- ...
- # These TLS configuration options are used for incoming
- # file daemon connections. Director TLS settings are handled
- # below.
- TLS Enable = yes
- TLS Require = yes
- # Peer certificate is not required/requested -- peer validity
- # is verified by the storage connection cookie provided to the
- # File Daemon by the director.
- TLS Verify Peer = no
- TLS CA Certificate File = /usr/local/etc/ssl/ca.pem
- # This is a server certificate. It is used by connecting
- # file daemons to verify the authenticity of this storage daemon
- TLS Certificate = /usr/local/etc/ssl/backup1/cert.pem
- TLS Key = /usr/local/etc/ssl/backup1/key.pem
- }
-
- #
- # List Directors who are permitted to contact Storage daemon
- #
- Director {
- Name = backup1-dir
- ...
- TLS Enable = yes
- TLS Require = yes
- # Require the connecting director to provide a certificate
- # with the matching CN.
- TLS Verify Peer = yes
- TLS Allowed CN = "bacula@backup1.example.com"
- TLS CA Certificate File = /usr/local/etc/ssl/ca.pem
- # This is a server certificate. It is used by the connecting
- # director to verify the authenticity of this storage daemon
- TLS Certificate = /usr/local/etc/ssl/backup1/cert.pem
- TLS Key = /usr/local/etc/ssl/backup1/key.pem
- }
-\end{verbatim}
-\normalsize
+++ /dev/null
-#!/usr/bin/perl -w
-#
-use strict;
-
-# Used to change the names of the image files generated by latex2html from imgxx.png
-# to meaningful names. Provision is made to go either from or to the meaningful names.
-# The meaningful names are obtained from a file called imagename_translations, which
-# is generated by extensions to latex2html in the make_image_file subroutine in
-# bacula.perl.
-
-# Opens the file imagename_translations and reads the contents into a hash.
-# The hash is creaed with the imgxx.png files as the key if processing TO
-# meaningful filenames, and with the meaningful filenames as the key if
-# processing FROM meaningful filenames.
-# Then opens the html file(s) indicated in the command-line arguments and
-# changes all image references according to the translations described in the
-# above file. Finally, it renames the image files.
-#
-# Original creation: 3-27-05 by Karl Cunningham.
-# Modified 5-21-05 to go FROM and TO meaningful filenames.
-#
-my $TRANSFILE = "imagename_translations";
-my $path;
-
-# Loads the contents of $TRANSFILE file into the hash referenced in the first
-# argument. The hash is loaded to translate old to new if $direction is 0,
-# otherwise it is loaded to translate new to old. In this context, the
-# 'old' filename is the meaningful name, and the 'new' filename is the
-# imgxx.png filename. It is assumed that the old image is the one that
-# latex2html has used as the source to create the imgxx.png filename.
-# The filename extension is taken from the file
-sub read_transfile {
- my ($trans,$direction) = @_;
-
- if (!open IN,"<$path$TRANSFILE") {
- print "WARNING: Cannot open image translation file $path$TRANSFILE for reading\n";
- print " Image filename translation aborted\n\n";
- exit 0;
- }
-
- while (<IN>) {
- chomp;
- my ($new,$old) = split(/\001/);
-
- # Old filenames will usually have a leading ./ which we don't need.
- $old =~ s/^\.\///;
-
- # The filename extension of the old filename must be made to match
- # the new filename because it indicates the encoding format of the image.
- my ($ext) = $new =~ /(\.[^\.]*)$/;
- $old =~ s/\.[^\.]*$/$ext/;
- if ($direction == 0) {
- $trans->{$new} = $old;
- } else {
- $trans->{$old} = $new;
- }
- }
- close IN;
-}
-
-# Translates the image names in the file given as the first argument, according to
-# the translations in the hash that is given as the second argument.
-# The file contents are read in entirely into a string, the string is processed, and
-# the file contents are then written. No particular care is taken to ensure that the
-# file is not lost if a system failure occurs at an inopportune time. It is assumed
-# that the html files being processed here can be recreated on demand.
-#
-# Links to other files are added to the %filelist for processing. That way,
-# all linked files will be processed (assuming they are local).
-sub translate_html {
- my ($filename,$trans,$filelist) = @_;
- my ($contents,$out,$this,$img,$dest);
- my $cnt = 0;
-
- # If the filename is an external link ignore it. And drop any file:// from
- # the filename.
- $filename =~ /^(http|ftp|mailto)\:/ and return 0;
- $filename =~ s/^file\:\/\///;
- # Load the contents of the html file.
- if (!open IF,"<$path$filename") {
- print "WARNING: Cannot open $path$filename for reading\n";
- print " Image Filename Translation aborted\n\n";
- exit 0;
- }
-
- while (<IF>) {
- $contents .= $_;
- }
- close IF;
-
- # Now do the translation...
- # First, search for an image filename.
- while ($contents =~ /\<\s*IMG[^\>]*SRC=\"/si) {
- $contents = $';
- $out .= $` . $&;
-
- # The next thing is an image name. Get it and translate it.
- $contents =~ /^(.*?)\"/s;
- $contents = $';
- $this = $&;
- $img = $1;
- # If the image is in our list of ones to be translated, do it
- # and feed the result to the output.
- $cnt += $this =~ s/$img/$trans->{$img}/ if (defined($trans->{$img}));
- $out .= $this;
- }
- $out .= $contents;
-
- # Now send the translated text to the html file, overwriting what's there.
- open OF,">$path$filename" or die "Cannot open $path$filename for writing\n";
- print OF $out;
- close OF;
-
- # Now look for any links to other files and add them to the list of files to do.
- while ($out =~ /\<\s*A[^\>]*HREF=\"(.*?)\"/si) {
- $out = $';
- $dest = $1;
- # Drop an # and anything after it.
- $dest =~ s/\#.*//;
- $filelist->{$dest} = '' if $dest;
- }
- return $cnt;
-}
-
-# REnames the image files spefified in the %translate hash.
-sub rename_images {
- my $translate = shift;
- my ($response);
-
- foreach (keys(%$translate)) {
- if (! $translate->{$_}) {
- print " WARNING: No destination Filename for $_\n";
- } else {
- $response = `mv -f $path$_ $path$translate->{$_} 2>&1`;
- $response and print "ERROR from system $response\n";
- }
- }
-}
-
-#################################################
-############# MAIN #############################
-################################################
-
-# %filelist starts out with keys from the @ARGV list. As files are processed,
-# any links to other files are added to the %filelist. A hash of processed
-# files is kept so we don't do any twice.
-
-# The first argument must be either --to_meaningful_names or --from_meaningful_names
-
-my (%translate,$search_regex,%filelist,%completed,$thisfile);
-my ($cnt,$direction);
-
-my $arg0 = shift(@ARGV);
-$arg0 =~ /^(--to_meaningful_names|--from_meaningful_names)$/ or
- die "ERROR: First argument must be either \'--to_meaningful_names\' or \'--from_meaningful_names\'\n";
-
-$direction = ($arg0 eq '--to_meaningful_names') ? 0 : 1;
-
-(@ARGV) or die "ERROR: Filename(s) to process must be given as arguments\n";
-
-# Use the first argument to get the path to the file of translations.
-my $tmp = $ARGV[0];
-($path) = $tmp =~ /(.*\/)/;
-$path = '' unless $path;
-
-read_transfile(\%translate,$direction);
-
-foreach (@ARGV) {
- # Strip the path from the filename, and use it later on.
- if (s/(.*\/)//) {
- $path = $1;
- } else {
- $path = '';
- }
- $filelist{$_} = '';
-
- while ($thisfile = (keys(%filelist))[0]) {
- $cnt += translate_html($thisfile,\%translate,\%filelist) if (!exists($completed{$thisfile}));
- delete($filelist{$thisfile});
- $completed{$thisfile} = '';
- }
- print "translate_images.pl: $cnt image filenames translated ",($direction)?"from":"to"," meaningful names\n";
-}
-
-rename_images(\%translate);
+++ /dev/null
-%%
-%%
-
-\chapter{Kurzanleitung}
-\label{TutorialChapter}
-\index[general]{Kurzanleitung}
-
-Diese Kapitel soll Ihnen helfen Bacula in Betrieb zu nehmen.
-Dazu wird vorrausgesetzt, dass Sie Bacula installiert aber noch keine
-\"{A}nderungen an den Konfigurations-Dateien (.conf) vorgenommen haben.
-Falls Sie schon \"{A}nderungen durchgef\"{u}hrt haben, deinstallieren Sie
-Bacula und installieren es erneut. Alle Beispiele in diesem Kapitel gehen
-von der Standard-Konfiguration nach der Installation aus. Wenn Sie Bacula
-in Ihrem Home-Verzeichnis installiert haben, sind keine root-Rechte notwendig
-um den Beispielen zu folgen. Alle Volumes werden in /tmp erstellt und es wird nur
-das Verzeichnis mit dem Bacula-Quelltext gesichert. Beachten Sie bitte, dass
-bei produktiven Installationen zumindest der Bacula-Client-Dienst (bacula-fd)
-als Benutzer root laufen muss. Mehr Informationen dazu finden Sie im Kapitel
-\"{u}ber Sicherheitsbelange im Bacula-Installations-Handbuch..
-
-Der generelle Ablauf ist folgender:
-
-\begin{enumerate}
-\item cd \lt{}Installations-Verzeichnis\gt{}
-\item starten Sie die Datenbank (falls Sie MySQL oder PostgreSQL benutzen)
-\item starten Sie die Bacula-Dienste mit {\bf ./bacula start}
-\item starten Sie das Console-Programm um den Director-Dienst bedienen zu k\"{o}nnen
-\item starten Sie einen Backup-Job
-\item Wenn das Volume voll ist, m\"{u}ssen Sie es unmounten, falls es ein Tape ist,
- m\"{u}ssen Sie ein neues labeln. Allerdings wird in diesem Kapitel nur mit
- Festplatten-Volumes gearbeitet, so dass Sie sich im Moment noch keine Gedanken
- um Tape machen m\"{u}ssen.
-\item versuchen Sie einige der gerade gesicherten Dateien wiederherzustellen.
- Stellen Sie dabei sicher, dass die Dateien dabei korrekt verarbeitet werden.
- Es ist besser jetzt zu testen, als auf den Ernstfall zu warten.
-\item f\"{u}gen Sie einen zweiten Client hinzu.
- \end{enumerate}
-
-Jeder dieser Schritte wird im folgenden ausf\"{u}hrlich erkl\"{a}rt.
-
-\section{Vor dem Start von Bacula}
-\index[general]{Bacula!vor dem Start }
-\index[general]{Vor dem Start von Bacula}
-
-% TODO: some of this content is already covered once or twice critical
-% TODO: or quickstart. Consolidate!
-
-Bevor Sie Bacula das erste Mal in der Produktion einsetzen, empfehlen wir
-Ihnen das {\bf test}-Kommando des btape-Programms auszuf\"{u}hren.
-Die Beschreibung dazu finden Sie im Kapitel {\bf btape} des Handbuchs
-\"{u}ber die Bacula-Dienstprogramme. Dadurch k\"{o}nnen Sie sicherstellen,
-dass Bacula ordnungsgem\"{a}{\ss} mit Ihrem Bandlaufwerk zusammenarbeitet.
-Wenn Sie ein modernes HP, Quantum oder Sony DDS- oder DLT-Laufwerk unter
-Linux verwenden, k\"{o}nnen Sie diesen Test auslassen, da diese Kombination
-im Normalfall immer funktionieren. In allen anderen F\"{a}llen sollten Sie
-diesen Tests aber durchf\"{u}hren bevor Sie hier weitermachen. Innerhalb
-des btape-Programms k\"{o}nnen Sie auch mittels des {\bf fill}-Kommandos
-das Vollschreiben eines Tapes simulieren, so dass Bacula ein neus Tape laden
-muss, um den Test fortzusetzen. Bedenken Sie aber, dass ein solcher Test mehrere
-Stunden dauern kann, abh\"{a}ngig von der Speicherkapazit\"{a}t Ihres Bandlaufwerks.
-
-\section{Starten der Datenbank}
-\label{StartDB}
-\index[general]{Starten der Datenbank}
-\index[general]{Datenbank!Starten der }
-
-Wenn Sie MySQL oder PostgreSQL als Katalog-Datenbank benutzen, m\"{u}ssen
-Sie die Datenbank vor Bacula starten. Andernfalls werden Sie beim Start von
-Bacula Fehlermeldungen erhalten. Um Ihre lokale MySQL-Instanz zu starten oder
-zu stoppen, k\"{o}nnen Sie die Scripte {\bf startmysql} und {\bf stopmysql}
-aus dem Bacula-Quelltext verwenden. Im Falle von SQLite ist kein Start der
-Datenbank notwendig, dass wird beim Start von Bacula automatisch getan.
-In Produktionsumgebungen sollten Sie sicherstellen, dass Ihre Katalog-Datenbank
-im Falle eines Reboots vor dem Bacula-Diensten gestartet wird.
-
-\section{Starten der Bacula-Dienste}
-\label{StartDaemon}
-\index[general]{Starten der Bacula-Dienste }
-\index[general]{Bacula-Dienste!Starten der }
-
-Wenn Sie Bacula aus dem Quelltext \"{u}bersetzt oder die rpm-Pakete
-installiert haben, k\"{o}nnen Sie die drei Bacula-Dienste einfach
-durch Eingabe von:
-
-./bacula start
-
-im Installations-Verzeichnis starten.
-
-Dieses Script starten den Storage-, File- und Director-Dienst, die danach
-im Hintergrund ausgef\"{u}hrt werden. Wenn Sie die Autostart-Scripte mitinstalliert
-haben, k\"{o}nnen Sie Bacula automatisch beim Rechnerstart oder auch gezielt
-\"{u}ber {\bf bacula-dir}, {\bf bacula-fd} und {\bf bacula-sd} im Verzeichnis
-{\bf /etc/init.d}, die einzelnen Dienste starten und stoppen.
-
-Wie Sie die Dienste unter Windows starten und anhalten k\"{o}nnen, finden
-Sie im Kapitel "`Die Windows-Version von Bacula"' in diesem Handbuch.
-
-Bei der Installation der rpm-Pakete werden die Dienste so konfiguriert,
-dass sie unter der Gruppe bacula als Benutzer root ausgef\"{u}hrt werden.
-Die Gruppe bacula wird dabei, falls notwendig, automatisch erstellt.
-Alle Benutzer die der Gruppe bacula angeh\"{o}ren haben Zugriff auf alle
-Dateien die die Dienste anlegen. Um das abzu\"{a}ndern, m\"{u}ssen Sie diese
-Start-Scripte entsprechend anpassen:
-
-\begin{itemize}
-\item /etc/bacula/bacula
-\item /etc/init.d/bacula-dir
-\item /etc/init.d/bacula-sd
-\item /etc/init.d/bacula-fd
-\end{itemize}
-
-und Bacula, wie oben beschrieben, neu starten.
-
-Im Bacula-Installations-Handbuch wird beschrieben, welche Schritte
-durchzuf\"{u}hren sind, um Bacula automatisch beim booten des Systems
-zu starten.
-
-\section{Starten der Console}
-\index[general]{Console!Starten der}
-\index[general]{Starten der Console}
-% TODO: section name is too long; maybe use "Using the Console Program" ??
-
-Um den Status von Jobs abzufragen oder um neue Jobs zu starten m\"{u}ssen Sie
-, aus dem Installationsverzeichnis, das Console-Programm starten:
-
-./bconsole
-
-Alternativ zu diesem Kommando k\"{o}nnen Sie auch das Bacula-Administration-Tool
-verwenden. Das setzt vorraus, dass Sie Qt4 installiert und bei der Konfiguration des
-Bacula-Quelltextes die Option {\bf \verb:--:enable-bat} angegeben haben.
-Starten Sie bat mit:
-
-./bat
-
-bat bietet Ihnen eine graphische Benutzerschnittstelle zum Director-Dienst
-und wesentlich mehr Funktionen als die bconsole.
-
-Weitere M\"{o}glichkeiten sind die GNOME-Konsole {\bf bgnome-console} oder
-das wxWidgets-Programm {\bf bwx-console}.
-
-Der Einfachheit halber wird hier nur die bconsole beschrieben. Die meisten
-Kommandos k\"{o}nnen Sie aber in identischer Form auch mit bat, bgnome-console
-und der bwx-console ausf\"{u}hren.
-
-Das Befehl ./bconsole startet das Console-Programm das sich mit dem
-Bacula-Director-Dienst verbindet. Da Bacula ein netzwerkf\"{a}higes Programm ist,
-k\"{o}nnen Sie die Console auf einem beliebigen Computer starten. Meistens wird
-es aber auf derselben Maschine, auf der auch der Director-Dienst l\"{a}uft,
-ausgef\"{u}hrt. Beim starten gibt die Console folgendes aus:
-
-\footnotesize
-\begin{verbatim}
-[kern@polymatou bin]$ ./bconsole
-Connecting to Director lpmatou:9101
-1000 OK: HeadMan Version: 2.1.8 (14 May 2007)
-*
-\end{verbatim}
-\normalsize
-
-Der Stern ist das Console-Prompt.
-
-Geben Sie {\bf help} ein, um eine Liste der verf\"{u}gbaren Kommandos zu erhalten:
-
-\footnotesize
-\begin{verbatim}
-*help
- Command Description
- ======= ===========
- add add media to a pool
- autodisplay autodisplay [on|off] -- console messages
- automount automount [on|off] -- after label
- cancel cancel [<jobid=nnn> | <job=name>] -- cancel a job
- create create DB Pool from resource
- delete delete [pool=<pool-name> | media volume=<volume-name>]
- disable disable <job=name> -- disable a job
- enable enable <job=name> -- enable a job
- estimate performs FileSet estimate, listing gives full listing
- exit exit = quit
- gui gui [on|off] -- non-interactive gui mode
- help print this command
- list list [pools | jobs | jobtotals | media <pool=pool-name> |
-files <jobid=nn>]; from catalog
- label label a tape
- llist full or long list like list command
- memory print current memory usage
- messages messages
- mount mount <storage-name>
- prune prune expired records from catalog
- purge purge records from catalog
- python python control commands
- quit quit
- query query catalog
- restore restore files
- relabel relabel a tape
- release release <storage-name>
- reload reload conf file
- run run <job-name>
- status status [[slots] storage=<name> | dir | client]=<name>
- setdebug sets debug level
- setip sets new client address -- if authorized
- show show (resource records) [jobs | pools | ... | all]
- sqlquery use SQL to query catalog
- time print current time
- trace turn on/off trace to file
- unmount unmount <storage-name>
- umount umount <storage-name> for old-time Unix guys
- update update Volume, Pool or slots
- use use catalog xxx
- var does variable expansion
- version print Director version
- wait wait until no jobs are running [<jobname=name> | <jobid=nnn> | <ujobid=complete_name>]
-*
-\end{verbatim}
-\normalsize
-
-Im Bacula-Console-und-Benutzer-Handbuch finden Sie eine detaillierte
-Beschreibung aller Kommandos.
-
-\section{Starten des ersten Jobs}
-\label{Running}
-\index[general]{Job!Starten des ersten }
-\index[general]{Starten des ersten Jobs }
-
-An diesem Punkt gehen wir von folgenden Voraussetzungen aus:
-
-\begin{itemize}
-\item Der Bacula-Quelltext wurde konfiguriert mit {\bf ./configure \verb:--:Ihre-Optionen}
-\item Der Quelltext wurde \"{u}bersetzt, mit {\bf make}
-\item Bacula ist installiert worden, mit {\bf make install}
-\item Sie haben die Bacula-Datenbank erstellt, z.B. mit
- {\bf./create\_sqlite\_database}
-\item Sie haben die notwendigen Tabellen erstellt, z.B. mit
- {\bf ./make\_bacula\_tables}
-\item Sie haben eventuell die Director-Dienst-Konfiguration ({\bf bacula-dir.conf})
- an Ihr System angepasst. Beachten Sie bitte, dass wenn Sie den Director-Namen
- \"{a}ndern, dass Sie ihn dann in allen Konfigurations-Dateien anpassen m\"{u}ssen.
- F\"{u}r den Augenblick ist es einfacher, die Konfigurations-Dateien nicht zu \"{a}ndern.
-\item Sie haben Bacula gestartet, mit {\bf ./bacula start}
-\item Sie haben mit {\bf ./bconsole} das Console-Programm gestartet.
-\end{itemize}
-
-Weiterhin nehmen wir an, dass Bacula mit der Standard-Konfiguration l\"{a}uft.
-
-Geben Sie das folgende Kommando in der Console ein:
-
-\footnotesize
-\begin{verbatim}
-show filesets
-\end{verbatim}
-\normalsize
-
-und Sie bekommen, in etwa, diese Ausgaben angezeigt:
-
-\footnotesize
-\begin{verbatim}
-FileSet: name=Full Set
- O M
- N
- I /home/bacula/regress/build
- N
- E /proc
- E /tmp
- E /.journal
- E /.fsck
- N
-FileSet: name=Catalog
- O M
- N
- I /home/bacula/regress/working/bacula.sql
- N
-\end{verbatim}
-\normalsize
-
-Was Sie sehen ist ein vordefiniertes FileSet namens "`Full Set"',
-dass das Verzeichnis mit Ihrem Bacula-Quelltext sichert.
-Der angeteigte Verzeichnisname ist abh\"{a}ngig von Ihrer
-Konfiguration. Zum Testen ist das ein gutes Verzeichnis,
-es ist von angemessener Gr\"{o}{\ss} und enth\"{a}lt gen\"{u}gend Dateien,
-ohne zu un\"{u}bersichtlich zu sein. Das zweite angezeigte FileSet,
-namens "`Catalog"', wird benutzt um die Katalog-Datenbank zu sichern,
-aber das ist im Moment noch nicht von Interesse. Alle Eintr\"{a}ge mit {\bf I}
-bezeichnen Verzeichnisse oder Dateien die vom Job "`included"', also gesichert
-werden sollen. Die {\bf E}-Eintr\"{a}ge bezeichnen Dateien und Verzeichnisse
-die "`excluded"', also nicht gesichert werden sollen. Eintr\"{a}ge mit {\bf O}
-geben FileSet-Optionen an. Die FileSet-Eintr\"{a}ge k\"{o}nnen in der Konfigurations-Datei
-des Director-Dienstes angepasst werden. Das passiert innerhalb des FileSet-Eintrags
-bei den Zeilen die mit {\bf File=} beginnen.
-
-Jetzt k\"{o}nnen Sie Ihren ersten Backup-Job starten. Der Job wird das Verzeichnis
-mit dem Bacula-Quelltext auf ein Festplatten-Volume unterhalb von /tmp sichern.
-Geben Sie bitte folgendes Kommando ein:
-
-\footnotesize
-\begin{verbatim}
-status dir
-\end{verbatim}
-\normalsize
-
-und Sie erhalten diese Ausgaben:
-
-\footnotesize
-\begin{verbatim}
-rufus-dir Version: 1.30 (28 April 2003)
-Daemon started 28-Apr-2003 14:03, 0 Jobs run.
-Console connected at 28-Apr-2003 14:03
-No jobs are running.
-Level Type Scheduled Name
-=================================================================
-Incremental Backup 29-Apr-2003 01:05 Client1
-Full Backup 29-Apr-2003 01:10 BackupCatalog
-====
-\end{verbatim}
-\normalsize
-
-wobei die Uhrzeiten, Director-Version und -Name bei Ihrer Installation
-wahrscheinlich abweichen. Die Ausgabe zeigt Ihnen, dass ein inkrementeller
-Backup-Job f\"{u}r den Client "`Client1"' um 01:05 Uhr geplant ist. Danach,
-um 01:10 Uhr, wird ein Voll-Backup der Katalog-Datenbank ausgef\"{u}hrt.
-Bevor Sie sp\"{a}ter weitere Clients zu Ihrer Konfiguration hinzuf\"{u}gen,
-sollten Sie den Namen "`Client1"' z.B. auf den Namen Ihres Computers setzen,
-ansonsten kann es mit mehreren Clients un\"{u}bersichtlich werden.
-
-Geben Sie jetzt
-
-\footnotesize
-\begin{verbatim}
-status client
-\end{verbatim}
-\normalsize
-
-ein um sich den Status Ihres Clients anzeigen zu lassen:
-
-\footnotesize
-\begin{verbatim}
-The defined Client resources are:
- 1: rufus-fd
-Item 1 selected automatically.
-Connecting to Client rufus-fd at rufus:8102
-rufus-fd Version: 1.30 (28 April 2003)
-Daemon started 28-Apr-2003 14:03, 0 Jobs run.
-Director connected at: 28-Apr-2003 14:14
-No jobs running.
-====
-\end{verbatim}
-\normalsize
-
-In diesem Beispiel heisst der Client "`rufus-fd"'. Da nur ein Client konfiguriert
-ist, w\"{a}hlt Bacula ihn automatisch aus und zeigt den Status an. Die Ausgaben
-ab der Zeile {\bf rufus-sd Version: ...} stammen vom Client, so das Sie sicher
-sein k\"{o}nnen, dass der Bacula-Client-Dienst auf dieser Maschine korrekt
-ausgef\"{u}hrt wird.
-
-Abschlie{\ss}end lassen Sie sich noch den Status des Storage-Dienstes anzeigen.
-Geben Sie dazu folgendes Kommando ein:
-
-\footnotesize
-\begin{verbatim}
-status storage
-\end{verbatim}
-\normalsize
-
-und Sie sehen:
-
-\footnotesize
-\begin{verbatim}
-The defined Storage resources are:
- 1: File
-Item 1 selected automatically.
-Connecting to Storage daemon File at rufus:8103
-rufus-sd Version: 1.30 (28 April 2003)
-Daemon started 28-Apr-2003 14:03, 0 Jobs run.
-Device /tmp is not open.
-No jobs running.
-====
-\end{verbatim}
-\normalsize
-
-Da es nur einen Storage-Eintrag gibt, wird dieser wieder automatisch von
-Bacula ausgew\"{a}hlt. Momentan gibt es nur das Storage-Device {\bf /tmp},
-welches nicht ge\"{o}ffnet ist und es laufen aktuell keine Jobs.
-
-Jetzt starten Sie den ersten Job:
-
-\footnotesize
-\begin{verbatim}
-run
-\end{verbatim}
-\normalsize
-
-die folgende Meldung erscheint:
-
-\footnotesize
-\begin{verbatim}
-Using default Catalog name=MyCatalog DB=bacula
-A job name must be specified.
-The defined Job resources are:
- 1: Client1
- 2: BackupCatalog
- 3: RestoreFiles
-Select Job resource (1-3):
-\end{verbatim}
-\normalsize
-
-Da es mehr als einen Job-Eintrag in der Director-Dienst-Konfiguration gibt,
-m\"{u}ssen Sie jetzt den gew\"{u}nschten ausw\"{a}hlen. Geben Sie bitte {\bf 1}
-ein und Bacula zeigt Ihnen die Job-Details an:
-
-\footnotesize
-\begin{verbatim}
-Run Backup job
-JobName: Client1
-FileSet: Full Set
-Level: Incremental
-Client: rufus-fd
-Storage: File
-Pool: Default
-When: 2003-04-28 14:18:57
-OK to run? (yes/mod/no):
-\end{verbatim}
-\normalsize
-
-Bevor Sie fortfahren und den Job starten, sollten Sie sich die Ausgaben genau
-ansehen und verstehen. Bacula fragt Sie, ob es OK ist den folgenden Job zu starten:
-Der Name des Jobs ist {\bf Client1}, das FileSet hei{\ss}t {\bf Full Set} und
-der Job wird mit dem Level {\bf Incremental} auf dem Client {\bf rufus-fd} laufen.
-Die gesicherten Daten werden in den Pool {\bf Default} auf dem Storage {\bf File}
-abgelegt und der Job wird sofort gestartet, da unter {\bf When} die aktuelle
-Uhrzeit angezeigt wird.
-
-Sie haben nun die Wahl den Job durch Eingabe von {\bf yes} zu starten
-oder mittels {\bf mod} ein oder mehrere Job-Parameter anzupassen. Wenn Sie
-{\bf no} eingeben wird der Job nicht gestartet. Geben Sie jetzt {\bf yes} ein,
-danach sehen Sie sofort wieder die Eingabeaufforderung der Console, den Stern.
-Nachdem Sie einige Sekunden gewartet haben, geben Sie bitte {\bf messages} ein
-und Sie erhalten in etwa folgende Ausgabe:
-
-\footnotesize
-\begin{verbatim}
-28-Apr-2003 14:22 rufus-dir: Last FULL backup time not found. Doing
- FULL backup.
-28-Apr-2003 14:22 rufus-dir: Start Backup JobId 1,
- Job=Client1.2003-04-28_14.22.33
-28-Apr-2003 14:22 rufus-sd: Job Client1.2003-04-28_14.22.33 waiting.
- Cannot find any appendable volumes.
-Please use the "label" command to create a new Volume for:
- Storage: FileStorage
- Media type: File
- Pool: Default
-\end{verbatim}
-\normalsize
-
-Die erste Zeile zeigt Ihnen, dass kein vorheriges Voll-Backup des Clients gefunden
-wurde, daher wird der Backup-Level des Jobs auf Full, statt Incremental, gesetzt.
-Die zweite Zeile gibt an, dass der Job mit der Job-ID 1 gestartet wurde und
-in der dritten Zeile sehen Sie die Meldung "`Cannot find any appendable volumes."'.
-Das bedeutet, dass Bacula im Pool Default kein passendes Volume f\"{u}r diesen Job
-gefunden hat. Zus\"{a}tzlich erscheint der Hinweis das Label-Kommando zu benutzen,
-um ein Volume zu erstellen. Da dieser Schritt noch nicht ausgef\"{u}hrt wurde,
-ist diese Meldung normal.
-
-Der Job ist jetzt dadurch blockiert, dass er auf ein passendes Volume wartet.
-Das k\"{o}nnen Sie \"{u}berpr\"{u}fen, inden Sie das Kommando {\bf status director}
-ausf\"{u}hren. Damit der Job laufen kann muss zuerst ein Volume erstellt werden.
-Dazu benutzen Sie das Kommando:
-
-\footnotesize
-\begin{verbatim}
-label
-\end{verbatim}
-\normalsize
-
-worauf Bacula folgendes ausgibt:
-
-\footnotesize
-\begin{verbatim}
-The defined Storage resources are:
- 1: File
-Item 1 selected automatically.
-Enter new Volume name:
-\end{verbatim}
-\normalsize
-
-Sie m\"{u}ssen jetzt einen Namen f\"{u}r das zu erstellende Volume w\"{a}hlen.
-Volume-Namen sollten mit einem Buchstaben beginnen und d\"{u}rfen Buchstaben,
-Zahlen sowie den Bindestrich, Unterstrich und den Punkt enthalten.
-In diesem Beispiel geben Sie bitte den Namen {\bf TestVolume001} ein:
-
-\footnotesize
-\begin{verbatim}
-Defined Pools:
- 1: Default
-Item 1 selected automatically.
-Connecting to Storage daemon File at rufus:8103 ...
-Sending label command for Volume "TestVolume001" Slot 0 ...
-3000 OK label. Volume=TestVolume001 Device=/tmp
-Catalog record for Volume "TestVolume002", Slot 0 successfully created.
-Requesting mount FileStorage ...
-3001 OK mount. Device=/tmp
-\end{verbatim}
-\normalsize
-
-Da nur ein Pool existiert, wird das neue Volume diesem automatisch zugeordnet.
-Im Hintergrund wird der Job jetzt gestartet. Mit den Kommandos {\bf status director}
-und {\bf status client} k\"{o}nnen Sie den Ablauf verfolgen. Wenn {\bf status director}
-keine laufenden Jobs mehr auflistet k\"{o}nnen Sie sich mit dem Kommando
-{\bf messages} die Ausgaben zu dem beendeten Job anzeigen lassen:
-
-\footnotesize
-\begin{verbatim}
-28-Apr-2003 14:30 rufus-sd: Wrote label to prelabeled Volume
- "TestVolume001" on device /tmp
-28-Apr-2003 14:30 rufus-dir: Bacula 1.30 (28Apr03): 28-Apr-2003 14:30
-JobId: 1
-Job: Client1.2003-04-28_14.22.33
-FileSet: Full Set
-Backup Level: Full
-Client: rufus-fd
-Start time: 28-Apr-2003 14:22
-End time: 28-Apr-2003 14:30
-Files Written: 1,444
-Bytes Written: 38,988,877
-Rate: 81.2 KB/s
-Software Compression: None
-Volume names(s): TestVolume001
-Volume Session Id: 1
-Volume Session Time: 1051531381
-Last Volume Bytes: 39,072,359
-FD termination status: OK
-SD termination status: OK
-Termination: Backup OK
-28-Apr-2003 14:30 rufus-dir: Begin pruning Jobs.
-28-Apr-2003 14:30 rufus-dir: No Jobs found to prune.
-28-Apr-2003 14:30 rufus-dir: Begin pruning Files.
-28-Apr-2003 14:30 rufus-dir: No Files found to prune.
-28-Apr-2003 14:30 rufus-dir: End auto prune.
-\end{verbatim}
-\normalsize
-
-Hier sehen Sie verschiedene Angaben wie die Laufzeit, Datenrate, verwendete Volumes
-und unter "`Termination"' das der Backup-Job erfolgreich gelaufen ist.
-Nach der Eingabe von {\bf autodisplay on} gibt die Console wartende Benachrichtigungen
-auch ohne Eingabe von {\bf messages} aus.
-
-Wenn Sie sich den Inhalt des /tmp-Verzeichnisses mit ls -l anzeigen lassen,
-sehen Sie das, mit dem Label-Kommando erstellte Volume:
-
-\footnotesize
-\begin{verbatim}
--rw-r----- 1 bacula bacula 39072153 Apr 28 14:30 TestVolume001
-\end{verbatim}
-\normalsize
-
-In diesem Festplatten-Volume wurden die Daten aus dem eben gelaufenen Job geschrieben.
-Wenn Sie weitere Jobs starten, werden deren Daten an dieses Volume angeh\"{a}ngt.
-
-Eventuell fragen Sie sich jetzt, ob Sie jedes Volume das Bacula benutzen soll,
-auf die oben beschriebene Weise erstellen m\"{u}ssen. Bei Festplatten-Volumes,
-wie eben benutzt, ist das nicht der Fall. Es ist m\"{o}glich Bacula so zu
-konfigurieren, dass es automatisch neue Volumes erzeugt (labelt), wenn sie
-ben\"{o}tigt werden. Bei Tape-Volumes ist das allerdings nicht der Fall,
-diese m\"{u}ssen einzelnd gelabelt werden, bevor Bacula sie verwenden kann.
-
-An dieser Stelle k\"{o}nnen Sie das Console-Programm mit {\bf quit} beenden
-und die Bacula-Dienste mit {\bf ./bacula stop} anhalten. Fall Sie wieder von
-Vorne anfangen m\"{o}chten, l\"{o}schen Sie das angelegte Volume mit {\bf rm
-/tmp/TestVolume001} und reinitialisieren Sie Ihre Datenbank mit den Komandos:
-
-\footnotesize
-\begin{verbatim}
-./drop_bacula_tables
-./make_bacula_tables
-\end{verbatim}
-\normalsize
-
-Dadurch werden alle Informationen zu allen gelaufenen Jobs endg\"{u}ltig gel\"{o}scht.
-Zum Testen ist das duraus hilfreich, sp\"{a}ter in einer produktiven Umgebung werden Sie
-das wahrscheinlich nicht ausf\"{u}hren wollen.
-
-Wenn Sie versuchen wollen, die in diesem Beispiel gesicherten Daten wiederherzustellen,
-lesen Sie bitte den folgenden Abschnitt.
-
-
-\section{Wiederherstellung Ihrer Daten}
-\label{restoring}
-\index[general]{Daten!Wiederherstellung Ihrer }
-\index[general]{Wiederherstellung Ihrer Daten }
-
-Wenn Sie die standardm\"{a}{\ss}ige Konfiguration benutzt und wie oben beschrieben,
-den Bacula-Quelltext gesichert haben, k\"{o}nnen Sie mit der Console diese Daten
-auf dem folgenden Weg wiederherstellen:
-
-\footnotesize
-\begin{verbatim}
-restore all
-\end{verbatim}
-\normalsize
-
-worauf diese Auswahlliste erscheint:
-
-\footnotesize
-\begin{verbatim}
-First you select one or more JobIds that contain files
-to be restored. You will be presented several methods
-of specifying the JobIds. Then you will be allowed to
-select which files from those JobIds are to be restored.
-
-To select the JobIds, you have the following choices:
- 1: List last 20 Jobs run
- 2: List Jobs where a given File is saved
- 3: Enter list of comma separated JobIds to select
- 4: Enter SQL list command
- 5: Select the most recent backup for a client
- 6: Select backup for a client before a specified time
- 7: Enter a list of files to restore
- 8: Enter a list of files to restore before a specified time
- 9: Find the JobIds of the most recent backup for a client
- 10: Find the JobIds for a backup for a client before a specified time
- 11: Enter a list of directories to restore for found JobIds
- 12: Cancel
-Select item: (1-12):
-\end{verbatim}
-\normalsize
-
-Wie Sie sehen k\"{o}nnen, haben Sie mehrere Optionen, aber in diesem
-Beispiel w\"{a}hlen Sie bitte die {\bf 5}. Dadurch wird eine Wiederherstellung
-des letzten Voll-Backups f\"{u}r einen anzugebenen Client ausgew\"{a}hlt:
-
-\footnotesize
-\begin{verbatim}
-Defined Clients:
- 1: rufus-fd
-Item 1 selected automatically.
-The defined FileSet resources are:
- 1: 1 Full Set 2003-04-28 14:22:33
-Item 1 selected automatically.
-+-------+-------+----------+---------------------+---------------+
-| JobId | Level | JobFiles | StartTime | VolumeName |
-+-------+-------+----------+---------------------+---------------+
-| 1 | F | 1444 | 2003-04-28 14:22:33 | TestVolume002 |
-+-------+-------+----------+---------------------+---------------+
-You have selected the following JobId: 1
-Building directory tree for JobId 1 ...
-1 Job inserted into the tree and marked for extraction.
-The defined Storage resources are:
- 1: File
-Item 1 selected automatically.
-You are now entering file selection mode where you add and
-remove files to be restored. All files are initially added.
-Enter "done" to leave this mode.
-cwd is: /
-$
-\end{verbatim}
-\normalsize
-
-Das es momentan nur einen Client, ein FileSet und ein Storage-Device gibt,
-w\"{a}hlt Bacula automatisch die entsprechenden Eintr\"{a}ge aus. Zudem wird
-aus allen Dateien des Jobs ein Verzeichnis-Baum aufgebaut, ein Abbild
-der gesicherten Verzeichnis- und Datei-Struktur. Sie k\"{o}nnen jetzt
-die Kommandos {\bf cd} und {\bf ls} oder {\bf dir} benutzen, um das Verzeichnis
-zu wechseln oder sich den Inhalt auflisten zu lassen. Wenn Sie, zum Beispiel,
-erst {\bf cd /home/bacula/bacula-2.4.1} wechseln (Ihr Pfad wird anders lauten)
-und dann {\bf dir} ausf\"{u}hren, erhalten Sie eine Liste aller Dateien und
-Verzeichnisse im Bacula-Quelltext-Verzeichnis. F\"{u}r weiter Informationen
-lesen Sie bitte auch das Kapitel "`Wiederherstellung von Daten"' in diesem
-Handbuch.
-
-Um diesen Auswahl-Modus zu beenden, geben Sie
-
-\footnotesize
-\begin{verbatim}
-done
-\end{verbatim}
-\normalsize
-
-ein.
-Danach sehen Sie diese Ausgaben:
-
-\footnotesize
-\begin{verbatim}
-Bootstrap records written to
- /home/bacula/testbin/working/restore.bsr
-The restore job will require the following Volumes:
-
- TestVolume001
-1444 files selected to restore.
-Run Restore job
-JobName: RestoreFiles
-Bootstrap: /home/bacula/testbin/working/restore.bsr
-Where: /tmp/bacula-restores
-Replace: always
-FileSet: Full Set
-Backup Client: rufus-fd
-Restore Client: rufus-fd
-Storage: File
-JobId: *None*
-When: 2005-04-28 14:53:54
-OK to run? (yes/mod/no):
-\end{verbatim}
-\normalsize
-
-Wenn Sie jetzt {\bf yes} eingeben, werden die Datein unterhalb von
-{\bf /tmp/bacula-restores} wiederhergestellt. Dies ist der Standard f\"{u}r
-die Wiederherstellung und l\"{a}sst sich \"{u}ber {\bf mod} und {\bf Where}
-anpassen. Um die Dateien an ihrem originalen Ort widerherzustellen,
-m\"{u}ssen Sie {\bf Where} entweder leer lassen oder auf {\bf /} setzen.
-In diesem Beispiel antworten Sie bitte einfach mit {\bf yes} um die
-Wiederherstellung zu starten. Warten Sie inene kurzen Moment und geben Sie
-{\bf messages} ein. Wenn der Wiederherstellungs-Job beendet ist, sehen Sie
-folgende Ausgaben:
-
-\footnotesize
-\begin{verbatim}
-28-Apr-2005 14:56 rufus-dir: Bacula 2.1.8 (08May07): 08-May-2007 14:56:06
-Build OS: i686-pc-linux-gnu suse 10.2
-JobId: 2
-Job: RestoreFiles.2007-05-08_14.56.06
-Restore Client: rufus-fd
-Start time: 08-May-2007 14:56
-End time: 08-May-2007 14:56
-Files Restored: 1,444
-Bytes Restored: 38,816,381
-Rate: 9704.1 KB/s
-FD Errors: 0
-FD termination status: OK
-SD termination status: OK
-Termination: Restore OK
-08-May-2007 14:56 rufus-dir: Begin pruning Jobs.
-08-May-2007 14:56 rufus-dir: No Jobs found to prune.
-08-May-2007 14:56 rufus-dir: Begin pruning Files.
-08-May-2007 14:56 rufus-dir: No Files found to prune.
-08-May-2007 14:56 rufus-dir: End auto prune.
-\end{verbatim}
-\normalsize
-
-Nachdem Sie die Console verlassen haben, k\"{o}nnen Sie sich die
-wiederhergestellten Dateien untehlab von /tmp/bacula-restores ansehen.
-Um diese Dateien wieder zu l\"{o}schen, f\"{u}hren Sie :
-
-\footnotesize
-\begin{verbatim}
-rm -rf /tmp/bacula-restore
-\end{verbatim}
-\normalsize
-
-aus.
-
-\section{Beenden des Console-Programms}
-\index[general]{Console!Beenden der }
-\index[general]{Beenden des Console-Programms }
-
-Die Console wird durch Eingabe von {\bf quit} beendet.
-
-\section{Hinzuf\"{u}gen eines zweiten Clients}
-\label{SecondClient}
-\index[general]{Client!Hinuzf\"{u}gen eines zweiten }
-\index[general]{Hinzuf\"{u}gen eines zweiten Clients }
-
-Wenn Sie die oben beschriebenen Beispiele zur Sicherung und Wiederherstellung
-nachvollziehen konnten, k\"{o}nnen Sie jetzt einen zweiten Client hinzuf\"{u}gen.
-Daf\"{u}r ben\"{o}tigen Sie einen zweiten Computer den Sie sichern wollen.
-Auf diesem Client m\"{u}ssen Sie nur den Bacula-Client-Dienst installieren,
-{\bf bacula-fd} oder auf Windows {\bf bacula-fd.exe}, sowie eine passende
-Konfigurations-Datei {\bf bacula-fd.conf}. Sie k\"{o}nnen als Vorlage die bereits
-bestehende Konfigurations-Datei Ihresersten Clients benutzen. \"{A}ndern Sie einfach
-nur den Namen des Clients im Abschnitt "`FileDaemon"' der Datei.
-Ein Beispiel, aus :
-
-\footnotesize
-\begin{verbatim}
-...
-#
-# "Global" File daemon configuration specifications
-#
-FileDaemon { # this is me
- Name = rufus-fd
- FDport = 9102 # where we listen for the director
- WorkingDirectory = /home/bacula/working
- Pid Directory = /var/run
-}
-...
-\end{verbatim}
-\normalsize
-
-wird dabei:
-
-\footnotesize
-\begin{verbatim}
-...
-#
-# "Global" File daemon configuration specifications
-#
-FileDaemon { # this is me
- Name = matou-fd
- FDport = 9102 # where we listen for the director
- WorkingDirectory = /home/bacula/working
- Pid Directory = /var/run
-}
-...
-\end{verbatim}
-\normalsize
-
-wobei nur der Ausschnitt der Datei dargestellt wird, in dem die \"{A}nderung von
-{\bf rufus-fd} zu {\bf matou-fd} gemacht wird. Alle anderen Eintr\"{a}ge
-k\"{o}nnen im Moment so bleiben wie sie sind. Eventuell wollen Sie sp\"{a}ter
-noch ein anderes Passwort f\"{u}r den zweiten Client verwenden. Die angepasste
-Konfigurations-datei k\"{o}nnen Sie jetzt auf dem Client als {\bf bacula-fd.conf}
-speichern. Des weiteren m\"{u}ssen Sie jetzt die Konfiguration des Bacula-Director-Dienstes
-um die Eintr\"{a}ge f\"{u}r den neuen Client erweitern. Dazu kopieren Sie den
-Job- und Client-Eintrag des {\bf rufus-fd} in der Director-Dienst-Konfiguration
-{\bf bacula-dir.conf} und passen die Namen in den Eintr\"{a}gen entsprechend an:
-
-
-\footnotesize
-\begin{verbatim}
-#
-# Define the main nightly save backup job
-# By default, this job will back up to disk in /tmp
-Job {
- Name = "Matou"
- Type = Backup
- Client = matou-fd
- FileSet = "Full Set"
- Schedule = "WeeklyCycle"
- Storage = File
- Messages = Standard
- Pool = Default
- Write Bootstrap = "/home/bacula/working/matou.bsr"
-}
-# Client (File Services) to backup
-Client {
- Name = matou-fd
- Address = matou
- FDPort = 9102
- Catalog = MyCatalog
- Password = "xxxxx" # password for
- File Retention = 30d # 30 days
- Job Retention = 180d # six months
- AutoPrune = yes # Prune expired Jobs/Files
-}
-\end{verbatim}
-\normalsize
-
-Verwenden Sie bitte vollst\"{a}ndige Hostnamen f\"{u}r den Parameter
-Address im Client-Eintrag, wenn Sie etwas wie "`localhost"' verwenden,
-kann es zu Problem bei der Namensaufl\"{o}sung kommen. Teilweise werden
-diese Parameter vom Director-Dienst zu den Client- oder Storage-Diensten
-gesendet, wo die Aufl\"{o}sung von "`localhost"' dann etwas anderes
-bewirkt als gewollt.
-
-Damit sind alle notwendigen Schritte zur Definition des zweiten Clients
-abgeschlossen. Die bestehende Konfiguration des Clients {\bf rufus-fd}
-wurde kopiert und angepasst, so dass die Eintr\"{a}ge jetzt {\bf matou}
-und {\bf matou-fd} hei{\ss}en. Ebenso wurden die Eintr\"{a}ge in der
-Director-Dienst-Konfiguration kopiert und angepasst. Ge\"{a}dert haben
-sich nur der Job-Name, der Client-Name und die Client-Adresse sowie
-der Name der Bootstrap-Datei. Das bedeutet, dass der Client {\bf matou-fd}
-zur selben Zeit in den selben Pool gesichert wird, wie der Client
-{\bf rufus-fd}. Das k\"{o}nnen Sie sp\"{a}ter nat\"{u}rlich noch Ihren
-Bed\"{u}rfnissen anpassen, aber f\"{u}r dieses Beispiel wollen wir
-die Konfiguration so einfach wie m\"{o}glich belassen.
-
-Damit der Director-Dienst die neue Konfiguration einliest, muss er entweder
-neue gestartet werden, oder Sie rufen in der Console das Kommando {\bf reload} auf.
-Jetzt ist alles notwendige getan, damit der zweite Client gesichert werden kann.
-
-
-Die gr\"{o}sten Unterschiede zu einer produktiven Bacula-Installation sind
-jetzt nur noch, dass alle (beiden) Clients in einen Pool und zur selben Zeit
-gesichert werden. Aber das k\"{o}nen Sie jederzeit entsprechend umkonfigurieren.
-Auf alle F\"{a}lle sollte aus Sicherheitsgr\"{u}nden das Passwort des zweiten
-Clients noch ge\"{a}ndert werden.
-
-Einige wichtige Tipps die die Namen und Passw\"{o}rter betreffen, sowie
-ein Diagramm welche Namen und Passw\"{o}rter \"{u}bereinstimmen m\"{u}ssen,
-finden Sie im Kapitel "`Autorisierungs-Probleme"' im Bacula-Fehlerdiagnose-Handbuch.
-
-\section{Der erste Tape-Wechsel}
-\label{FullTape}
-\index[general]{Tape-Wechsel!der erste }
-\index[general]{Der erste Tape-Wechsel }
-
-Wenn die geplanten Backup-Jobs laufen, typischerweise Nachts, wird irgendwann
-das Tape, beziehungsweise das Festplatten-Volume, vollgeschrieben sein.
-Bacula kann keine weiteren Daten auf dem Laufwerk schreiben und gibt eine
-Meldung, \"{a}hnlich der folgenden, aus:
-
-\footnotesize
-\begin{verbatim}
-rufus-sd: block.c:337 === Write error errno=28: ERR=No space left
- on device
-\end{verbatim}
-\normalsize
-
-Daran k\"{o}nnen Sie erkennen, dass ein Schreibfehler auf dem Ger\"{a}t
-aufgetreten ist, die Fehlerbeschreibung lautet "`kein freier Platz mehr auf dem Ger\"{a}t.
-Bacula versucht jetzt im entsprechenden Pool ein Volume zu finden, auf dem das Backup
-weiterlaufen kann. Im besten Fall sind in dem Pool alte Volumes verf\"{u}gbar,
-deren Aufbewahrungs-Zeitraum abgelaufen ist. Bacula wird dann das \"{a}lteste Volume
-automatisch wiederverwenden und \"{u}berschreiben. Weitere Informationen dazu
-finden Sie im Kapitel \"{u}ber automatisches Volume Recycling im Handbuch "'Bacula
-Konzepte und \"{U}berblick"`. Falls Ihre Volumes, eventuell durch einen Konfigurations-Fehler,
-nicht automatisch \"{u}berschrieben werden, finden Sie im selben Kapitel unter "'manuelle
-Wiederverwendung der Volumes"` Hilfe.
-
-Wenn Bacula kein Volume im Pool findet auf dem das Backup fortgesetzt werden kann,
-erhalten Sie folgende Benachrichtigung:
-
-\footnotesize
-\begin{verbatim}
-rufus-sd: Job kernsave.2002-09-19.10:50:48 waiting. Cannot find any
- appendable volumes.
-Please use the "label" command to create a new Volume for:
- Storage: SDT-10000
- Media type: DDS-4
- Pool: Default
-\end{verbatim}
-\normalsize
-
-Solange Sie kein neues Volume erstellen, wiederholt Bacula diese Meldung
-erst st\"{u}ndlich, dann zwei-st\"{u}ndlich und so weiter, in immer doppelten
-Zeitabst\"{a}nden. Der maximale Interval betr\"{a}gt dabei 24 Stunden.
-
-Jetzt stellt sich nat\"{u}rlich die Frage: Was tun?
-
-Die Antwort ist einfach: Starten Sie das Console-Programm und geben Sie das
-Laufwerk mit dem {\bf unmount}-Kommando frei. Wenn Sie nur ein einzelnes
-Laufwerk haben, wird Bacula das automatisch ausw\"{a}hlen, falls Sie mehrere
-Laufwerke haben, achten Sie darauf, dass Sie das freigegeben welches in der
-Benachrichtigung erw\"{a}hnt ist. In diesem Beispiel {\bf SDT-10000}.
-
-Als n\"{a}chtes entfernen Sie das volle Volume aus dem Ger\"{a}t und legen
-ein Neues ein. Auf einigen \"{a}lteren Laufwerken m\"{u}ssen Sie vorher eine
-"'EOF"`- (End of File) Markierung schreiben, damit das Band nicht losl\"{a}uft,
-wenn Bacula versucht das Label zu lesen.
-
-Anschlie{\ss}end benutzen Sie das {\bf label}-Kommando um das neue Volume zu labeln.
-Das label-Kommando veranla{\ss}t den Storage-Dienst eine Software-Markierung auf
-das Volume zu schreiben. Wenn das erfolgreich war, wird das neue Volume dem
-entsprechendem Pool zugeordnet und das Volume in das Laufwerk geladen. Weiter oben
-in diesem Kapitel finden Sie weitere Information bez\"{u}glich des label-Kommandos.
-
-Das Ergebnis ist, dass Bacula den Backup-Job mit dem neuen Volume fortsetzen kann.
-
-Wenn Sie einen Pool haben dessen Volumes periodisch wiederverwendet werden,
-kann statt der Meldung "'Cannot find any appendable volumes"` auch die
-Aufforderung kommen, ein bestimmtes Volume zu mounten. In diesem Fall
-solten Sie genau dies auch tun. Falls das angefragte Volume, aus welchen
-Gr\"{u}nden auch immer, nicht mehr zur Verf\"{u}gung steht, k\"{o}nnen Sie
-auch ein anderes beschreibbares Volume aus dem entsprechenden Pool mounten.
-Im Console-Programm k\"{o}nnen Sie das Kommando {\bf list volumes} verwenden,
-um ein passendes Volume zu suchen.
-
-Falls, trotz korrekt konfigurierter Aufbewahrungszeitr\"{a}ume, f\"{u}r
-einen Pool kein freies Volume mehr zur Verf\"{u}gung steht, k\"{o}nnen Sie
-ein Volume auf die folgende Art zur Wiederverwendung freigeben:
-
-\begin{itemize}
-\item Benutzen Sie das {\bf list volumes}-Kommando um das \"{a}lteste Volume
- im Pool zu finden.
-\item Benutzen Sie das {purge volume}-Kommando um alle mit diesem Volume
- verkn\"{u}pften Eintr\"{a}ge aus der Katalog-Datenbank zu l\"{o}schen.
-\item Danach ist der Volume-Status "'recycle"` und das Volume kann
- wiederverwendet werden
- \end{itemize}
-
-Wenn es notwendig ist, dem Volume ein neues Label zu verpassen,
-folgen Sie bitte diesen zus\"{a}tzlichen Schritten:
-
-\begin{itemize}
-\item verwenden Sie zuerst das {\bf delete volume}-Kommando um das Volume
- und alle sich darauf beziehenden Eintr\"{a}ge aus der katalog-Datenbank
- zu l\"{o}schen
-\item laden Sie das, aus der Datenbank gel\"{o}schte, Volume in das Laufwerk
-\item Von der Kommmandozeile aus benutzen Sie folgende Befehle um das
- bestehende Bacula-Volume-Label zu \"{u}berschreiben:
- {\bf mt \ -f \ /dev/st0 \ rewind} und {\bf mt \ -f \ /dev/st0 \ weof},
- wobei Sie nat\"{u}rlich den korrekten Device-Namen f\"{u}r Ihr System
- benutzen m\"{u}ssen
-\item Dann k\"{o}nnen Sie, wie gewohnt, in dem Console-Programm das
- {\bf label}-Kommando benutzen um das neue Volume-Label zu erstellen.
-\item Falls das Volume danach nicht automatischin das Laufwerk geladen wird,
- benutzen Sie daf\"{u}r das {\bf mount}-Kommando.
- \end{itemize}
-
-\section{andere n\"{u}tzliche Consolen-Kommandos}
-\index[general]{Consolen-Kommandos!andere n\"{u}tzliche }
-\index[general]{andere n\"{u}tzliche Consolen-Kommandos }
-
-\begin{description}
-
-\item [status dir]
- \index[console]{status dir }
- Gibt den Status des Director-Dienstes, mit allen laufenden und f\"{u}r die
- n\"{a}chsten 24 Stunden geplanten Jobs, aus.
-\item [status]
- \index[console]{status }
- Gibte eine Liste aller Dienste aus, deren Status abfragbar ist.
-\item [status jobid=nn]
- \index[console]{status jobid }
- Gibt den Status eines laufenden Jobs mit der entsprechenden Job-ID aus.
-\item [list pools]
- \index[console]{list pools }
- Gibt die Liste aller in der Katalog-Datenbank bekannten Pools aus.
-\item [list media]
- \index[console]{list media }
- Gibt die Liste aller im Katalog definierten Volumes aus.
-\item [list jobs]
- \index[console]{list jobs }
- Gibt die Liste aller gelaufenen Jobs aus.
-\item [list jobid=nn]
- \index[console]{list jobid }
- Zeigt den Katalog-Eintrag der angegebenen Job-ID an.
-\item [list jobtotals]
- \index[console]{list jobtotals }
- Gibt eine Liste mit \"{U}bersichtswerten f\"{u}r alle Jobs aus.
-\item [list files jobid=nn]
- \index[console]{list files jobid }
- Gibt die Liste der gesicherten Dateien und Verzeichnisse f\"{u}r
- die angegebene Job-ID aus.
-\item [list jobmedia]
- \index[console]{list jobmedia }
- Zeigt die benutzten Volume-Namen f\"{u}r alle Jobs im Katalog an.
-\item [messages]
- \index[console]{messages }
- Gibt die wartenden Benachrichtigungen in der Console aus.
-\item [unmount storage=storage-name]
- \index[console]{unmount storage }
- Gibt das angegebene Laufwerk, falls es nicht gerade benutzt wird.
- Diese Kommando kann benutzt werden um das Laufwerk zu leeren, wenn man ein freies
- Ger\"{a}t zum Beispiel zum labeln von neuen Tapes ben\"{o}tigt.
-\item [mount storage=storage-name]
- \index[sd]{mount storage }
- L\"{a}dt ein anzugebenes Volume in das Laufwerk. Dieses Kommando wird ebenfalls
- nach einem Bandwechsel ausgef\"{u}hrt, nachdem Bacula die Meldung
- "'Please mount Volume xxx"` ausgegeben hat. Das Kommandos signalisiert Bacula
- das ein neues Volume im Laufwerk zur Verf\"{u}gung steht.
-\item [quit]
- \index[sd]{quit }
- beendet das Console-Programm
-\end{description}
-
-Die meisten oben genannten Kommandos werden Sie nach weiteren ben\"{o}tigten
-Parameter fragen, wenn sie ohne welche aufgerufen werden.
-
-\section{Debug-Ausgaben der Dienste}
-\index[general]{Debug-Ausgaben der Dienste }
-\index[general]{Ausgaben!Debug- Dienste }
-
-Falls Sie die Debug-Ausgaben der Dienste im laufenden Betrieb sehen wollen,
-k\"{o}nnen Sie sie, aus dem Installationsverzeichnnis, wie folgt starten:
-
-\footnotesize
-\begin{verbatim}
-./bacula start -d100
-\end{verbatim}
-\normalsize
-
-Die Ausgaben k\"{o}nnen hilfreich sein, falls die Dienste nicht korrekt starten.
-Normalerweise werden diese Ausgaben auf /dev/null umgeleitet, erst bei einem
-Debug-Level gr\"{o}{\ss}er als 0 werden sie auf dem Terminal ausgegeben.
-
-Um alle drei Dienste wieder zu stoppen f\"{u}hren Sie :
-
-\footnotesize
-\begin{verbatim}
-./bacula stop
-\end{verbatim}
-\normalsize
-
-aus. Falls einer der Dienste nicht korrekt starten k\"{o}nnte, kann es sein,
-dass beim stoppen eine Fehlermeldung bez\"{u}glich nicht gefundener PIDs
-auftreten. Das ist aber ziemlich selten.
-
-Um ein Systems komplett sichern zu k\"{o}nnen, muss der Client-Dienst
-als Benutzer root laufen damit er die Berechtigung hat auf alle Dateien zuzugreifen.
-Die anderen beiden Dienste, Storage- und Director-Dienst, ben\"{o}tigen diese
-Berechtigung nicht. Allerdings braucht der Storage-Dienst Lese- und Schreibrechte
-auf den Tape-Devices (zum Beispiel /dev/nstx). Auf vielen Systemen ist diser Zugriff
-nur dem Benutzer root gestattet, so dass der Storage-Dienst entweder als root laufen muss
-oder Sie m\"{u}ssen die Rechte auf den Devices so anpassen, dass auch normale Benutzer
-Zugriff haben. Auch die Katalog-Datenbank kann im Falle von MySQL oder PostgreSQL
-ohne root-Rechte laufen.
-
-\section{Geduld wenn die Dienste starten oder neue Tapes eingelesen werden}
-
-Wenn Sie die Dienste starten versucht der Storage-Dienst alle definierten
-Storage-Ger\"{a}te zu \"{o}ffnen und die enthaltenen Volumes zu pr\"{u}fen.
-Bis diese Vorg\"{a}nge abgeschlossen sind, nimmt der Storage-Dienst keine
-Verbindungen vom Console-Programm entgegen. Falls ein bereits beschriebenes
-Tape im Laufwerk ist, wird dieses zur\"{u}ckgespult, was bei einigen Laufwerken
-mehrere Minuten dauern kann. Daher brauchen Sie etwas Geduld wenn Sie nach dem
-starten der Dienste den Storage-Dienst kontaktieren wollen. Falls Sie Ihr
-Tape-Laufwerk sehen k\"{o}nnen, erkennen Sie an den Lichter wann das Laufwerk
-bereit ist.
-
-Die selben Aspekte treffen zu, wenn Sie ein neues unbeschriebens Tape zum Beispiel
-in ein HP-DLT-Laufwerk einlegen. Es kann ein bis zwei Minuten dauern bis das Laufwerk
-erkennt, dass das Tape komplett leer ist. Wenn Sie schon innerhalb dieser Zeit
-versuchen das Volume mit dm {\bf mount}-Kommando einzubinden, kann es sein das es
-zu Problemen mit dem SCSI-Treiber kommt. Haben Sie also auch in disem Fall Geduld
-und warten Sie ab bis das Laufwerk mit dem Einlesen des Tapes fertig ist,
-bevor Sie darauf zugreifen.
-
-\section{Verbindungsprobleme zwischen FD und SD}
-\index[general]{Verbindungsproblem zwischen FD und SD}
-\index[general]{SD!Verbindungsprobleme zwischen FD und SD}
-
-Wenn Ihre Client-Dienste Problem haben sich mit dem Storage-Dienst zu verbinden
-liegt das meistens daran, dass als {\bf Address} des Storage-Dienstes kein
-vollst\"{a}ndig qualifizierter Domain-Name angegeben ist. Der Rechner auf dem der
-Client-Dienst (nicht der Director-Dienst) l\"{a}uft muss in der Lage sein
-diesen Namen in eine IP-Adresse aufzul\"{o}sen. Ein Name der zum Beispiel
-auf dem Director-System funktionieren kann, aber garantiert nicht auf dem Client
-ist {\bf localhost}. Die Angabe des Names ohne Domain, zum Beispiel {\bf megalon},
-kann funktionieren, besser ist es jedoch den Namen mit Domain anzugeben :
-{\bf megalon.ihredomain.de}. Probleme mit Windows-Client-Systemen k\"{o}nnen Sie
-eventuell auch durch direkte Angabe der IP-Adresse als {\bf Address} umgehen.
-
-
-Falls die konfigurierte {\bf Address} korrekt ist, aber trotzdem keine Verbindung
-zustande kommt, sollten Sie \"{u}berpr\"{u}fen ob andere Programme den vom
-Storage-Dienst ben\"{o}tigten Port 9103 benutzen. Die Bacula Port-Nummern sind zwar
-alle durch die IANA zugewiesen und kein anderes Progrtamm sollte sie benutzen,
-aber einige HP-Drucker benutzen sie zum Beispiel doch. Mittels {\bf netstat -a}
-k\"{o}nnen Sie herrausfinden, welches Programm den Port 9103 ge\"{o}ffnet hat.
-
-\section{Kommandozeilen-Optionen der Dienste}
-\index[general]{Kommandozeilen-Optionen der Dienste }
-\index[general]{Optionen!Kommandozeilen- der Dienste }
-
-Jedem der drei Dienste (Director, File/Client und Storage) k\"{o}nnen beim
-Start die folgenden Optionen, die auch beim Console-Programm funktionieren,
-\"{u}bergeben werden:
-
-\begin{description}
-
-\item [-c \lt{}Datei\gt{}]
- \index[sd]{-c \lt{}Datei\gt{} }
- gibt eine Datei an die als Konfigurations-Datei verwendet werden soll.
- Standardm\"{a}{\ss}ig es ist der Dienst-Name gefolgt von {\bf .conf},
- also {\bf bacula-dir.conf} f\"{u}r den Director-Dienst, sowie
- {\bf bacula-sd.conf} und {bacula-fd.conf} f\"{u}r Storage- und Client/File-Dienst.
-
-\item [-d nn]
- \index[sd]{-d nn }
- Setzt den Debug-Level auf {\bf nn}. Je h\"{o}her der Level desto mehr Debug-
- Ausgaben werden erzeugt.
-
-\item [-f]
- Starte den Dienst im Vordergrund. Diese Option wird ben\"{o}tigt um die Dienste
- unter einem Debugger laufen zu lassen.
-
-\item [-g <Gruppenname>]
- Durch Angabe eines Gruppen-Namens können Sie den Dienst
- unter einem anderen Gruppen-Konto laufen lassen.
-
-\item [-s]
- Betriebssystem-Signale ignorieren. Diese Option wird ben\"{o}tigt um die Dienste
- unter einem Debugger laufen zu lassen.
-
-\item [-t]
- Liest die Konfigurations-Dateien ein und beendet den Dienst sofort wieder.
- Dient dazu die Konfiguration auf Fehler hin zu \"{u}berpr\"{u}fen.
-
-\item [-u <Benutzername>]
- Durch Angabe eines Benutzer-Namens können Sie den Dienst
- unter einem anderen Benutzer-Konto laufen lassen.
-
-\item [-v]
- Gibt genauere Fehler- und Informations-Meldungen aus. Sollte immer angegeben werden.
-
-\item [-?]
- Gibt die Version und die Liste der bekannten Optionen aus.
- \end{description}
-
-\section{Einen Pool erstellen }
-\label{Pool}
-\index[general]{Pool!erstellen }
-\index[general]{Einen Pool erstellen}
-
-Die Erstellung der Pools erfolgt automatisch aufgrund der Pool-Konfiguration
-wenn Bacula startet. Wenn Sie wissen was ein Pool ist, k\"{o}nnen Sie dieses
-Kapitel \"{u}berspringen.
-
-Eins der Dinge die Bacula wissen muss wenn ein Backup-Job startet ist,
-welches Volume zur Sicherung verwendet werden soll. Anstelle eines einzelnen
-Volumes wird in der Konfiguration ein Pool von Volumes angegeben, aus
-dem Bacula sich ein beschreibbares Volume f\"{u}r den Job aussucht.
-Bacula wird das erste verf\"{u}gbare Volume aus dem Pool w\"{a}hlen das
-zu dem, in der Job-Konfiguration angegebenen, Storage-Device passt.
-Nachdem das Volume vollgeschrieben wurde, setzt Bacula den Volume-Status
-von {\bf Append} auf {\bf Full}, danach wird ein weiteres Volume aus dem Pool
-benutzt um den Job fortzusetzen. Wenn kein passendes Volume mehr im Pool
-verf\"{u}gbar ist, wird der Director versuchen ein Volume zu finden
-dessen Daten bereits abgelaufen sind und das Volume recyclen. Wenn auch
-das fehlscl\"{a}gt gibt Bacula eine Meldung aus mit dem Hinweis
-ein neues Volume in dem Pool zu erstellen
-
-Bacula beh\"{a}lt st\"{a}ndig die \"{U}bersicht \"{u}ber die Pools,
-die Volumes in den Pools und die verschiedenen Eigenschaften der Volumes.
-
-Wenn Bacula startet wird sichergestellt, dass alle Pool-Eintr\"{a}ge
-aus der Konfiguration auch in der Katalog-Datenbank vorhanden sind.
-Mit dem folgenden Console-Kommando k\"{o}nnen Sie das \"{u}berpr\"{u}fen:
-
-\footnotesize
-\begin{verbatim}
-list pools
-\end{verbatim}
-\normalsize
-
-in Abh\"{a}ngigkeit der konfigurierten Pools wird eine Liste wie diese angezeigt:
-
-\footnotesize
-\begin{verbatim}
-*list pools
-Using default Catalog name=MySQL DB=bacula
-+--------+---------+---------+---------+----------+-------------+
-| PoolId | Name | NumVols | MaxVols | PoolType | LabelFormat |
-+--------+---------+---------+---------+----------+-------------+
-| 1 | Default | 3 | 0 | Backup | * |
-| 2 | File | 12 | 12 | Backup | File |
-+--------+---------+---------+---------+----------+-------------+
-*
-\end{verbatim}
-\normalsize
-
-Wenn Sie versuchen einen bereits bestehenden Pool ein zweites Mal zu erstellen,
-wird Bacula folgende Meldung ausgeben:
-
-\footnotesize
-\begin{verbatim}
-Error: Pool Default already exists.
-Once created, you may use the {\bf update} command to
-modify many of the values in the Pool record.
-\end{verbatim}
-\normalsize
-
-
-\section{Labeln der Volumes}
-\label{Labeling}
-\index[general]{Volumes!Labeln }
-\index[general]{Labeln der Volumes }
-
-Bacula ben\"{o}tigt auf jedem Volume ein Software-Label. Dabei gibt es verschiedene
-M\"{o}glichkeiten das Label auf ein Volume zu schreiben. Sie k\"{o}nnen die Volumes
-zum Beispiel labeln, wenn Bacula Sie mit einer entsprechenden Meldung dazu auffordert.
-Mittels des Console-Kommandos {\bf label} erstellen Sie dann ein neues Volume im
-entsprechenden Pool. Alternativ k\"{o}nnen Sie auch das Console-Kommando {\bf relabel}
-verwenden um ein bereits abgelaufenens Volume, im Status "'purged"`, wiederzuverwenden.
-
-Eine weitere Methode ist es viele Volumes zu labeln und dann nach und nach zu
-benutzen, je nachdem wann Bacula ein neues Volume verlangt. Das wird meistens
-bei Tape-Volumes gemacht die dann in einem Autochanger verwendet werden k\"{o}nnen.
-Lesen Sie dazu auch das Kapitel "'automatisches Volume Wiederverwendung"` in diesem
-Handbuch.
-
-\section{Volumes mit dem Console-Programm labeln}
-\index[general]{Volumes mit dem Console-Programm labeln }
-\index[general]{Labeln!Volumes mit dem Console-Programm }
-
-Zum labeln der Volumes wird normalerweise das Console-Programm verwendet.
-
-\begin{enumerate}
-\item ./bconsole
-\item label
-\end{enumerate}
-
-Falls Bacula eine Meldung ausgibt, dass das Volume nicht gelabelt werden kann
-da es bereits ein Label enth\"{a}lt, m\"{u}ssen Sie ein ungelabeltes Volume in
-das Laufwerk einlegen.
-
-Danach m\"{u}ssen Sie eins der konfigurierten Storage-Ger\"{a}te ausw\"{a}hlen
-in dem das zu labelnde Volume ist, zum Beispiel:
-
-\footnotesize
-\begin{verbatim}
-The defined Storage resources are:
- 1: File
- 2: 8mmDrive
- 3: DLTDrive
- 4: SDT-10000
-Select Storage resource (1-4):
-\end{verbatim}
-\normalsize
-
-In dem Ger\"{a}t das Sie jetzt ausw\"{a}hlen sollte ein neues ungelabeltes Volume sein.
-
-Bacula fragt Sie nun nach dem Namen f\"{u}r das Volume:
-
-\footnotesize
-\begin{verbatim}
-Enter new Volume name:
-\end{verbatim}
-\normalsize
-
-Falls Bacula diese Meldung ausgibt:
-
-\footnotesize
-\begin{verbatim}
-Media record for Volume xxxx already exists.
-\end{verbatim}
-\normalsize
-
-bedeutet es, dass der von Ihnen eingegebene Volume-Name schon in der Katalog-Datenbank
-existiert. Sie k\"{o}nnen sich alle definierten Volumes mit dem Kommando {\bf list media}
-anzeigen lassen:
-
-\footnotesize
-\begin{verbatim}
-+---------------+---------+--------+----------------+-----/~/-+------------+-----+
-| VolumeName | MediaTyp| VolStat| VolBytes | LastWri | VolReten | Recy|
-+---------------+---------+--------+----------------+---------+------------+-----+
-| DLTVol0002 | DLT8000 | Purged | 56,128,042,217 | 2001-10 | 31,536,000 | 0 |
-| DLT-07Oct2001 | DLT8000 | Full | 56,172,030,586 | 2001-11 | 31,536,000 | 0 |
-| DLT-08Nov2001 | DLT8000 | Full | 55,691,684,216 | 2001-12 | 31,536,000 | 0 |
-| DLT-01Dec2001 | DLT8000 | Full | 55,162,215,866 | 2001-12 | 31,536,000 | 0 |
-| DLT-28Dec2001 | DLT8000 | Full | 57,888,007,042 | 2002-01 | 31,536,000 | 0 |
-| DLT-20Jan2002 | DLT8000 | Full | 57,003,507,308 | 2002-02 | 31,536,000 | 0 |
-| DLT-16Feb2002 | DLT8000 | Full | 55,772,630,824 | 2002-03 | 31,536,000 | 0 |
-| DLT-12Mar2002 | DLT8000 | Full | 50,666,320,453 | 1970-01 | 31,536,000 | 0 |
-| DLT-27Mar2002 | DLT8000 | Full | 57,592,952,309 | 2002-04 | 31,536,000 | 0 |
-| DLT-15Apr2002 | DLT8000 | Full | 57,190,864,185 | 2002-05 | 31,536,000 | 0 |
-| DLT-04May2002 | DLT8000 | Full | 60,486,677,724 | 2002-05 | 31,536,000 | 0 |
-| DLT-26May02 | DLT8000 | Append | 1,336,699,620 | 2002-05 | 31,536,000 | 1 |
-+---------------+---------+--------+----------------+-----/~/-+------------+-----+
-\end{verbatim}
-\normalsize
-
-Wenn Sie dann einen Namen eingegeben haben der noch nicht im Katalog vorhanden ist,
-wird Bacula Sie als n\"{a}chstes nach dem Pool fragen in dem das neue Volume
-erstellt werden soll. Wenn es nur einen Pool gibt, w\"{a}hlt Bacula diesen
-automatisch aus.
-
-Wenn das Volume dann erfolgreich gelabelt wurde, erstellt Bacula eine Katalog-Eintrag
-f\"{u}r das neue Volume. Darin wird der Name des Volumes sowie alle seine Parameter
-gespeichert. Zeitgleich wird das neue Volume auch f\"{u}r Backup-Jobs verf\"{u}gbar.
-
-Beimlabeln m\"{u}ssen Sie nur sehr wenige Daten eingeben, den Volume-Namen,
-den Pool und eventuell den Slot. Der Katalog-Eintrag f\"{u}r ein Volume enth\"{a}lt
-aber sehr viel mehr Werte. Die meisten davon werden aus der Pool-Konfiguration gesetzt,
-die f\"{u}r alle Volumes des Pools gilt.
-
-Sie k\"{o}nnen Volumes auch zum Pool hinzuf\"{u}gen ohne sie physikalisch labeln zu
-m\"{u}ssen. Dazu kann das Console-Kommando {\bf add} verwendet werden.
-Weitere Informationen dar\"{u}ber finden Sie im Kapitel "'Die Bacula Console"`
-des "'Bacula Console- und Benutzer-Handbuchs"`.
+++ /dev/null
-#!/bin/sh
-
-ftp -i ftp.sectoor.de <<END_OF_DATA
-cd www/htdocs/dev-manual
-lcd /home/kern/bacula/docs/manual/bacula
-mput *
-cd ..
-lcd ..
-put dev-bacula.pdf dev-bacula.pdf
-quit
-END_OF_DATA
+++ /dev/null
-%%
-%%
-
-\chapter{Variablen-Auswertung}
-\label{VarsChapter}
-\index[general]{Variablen-Auswertung}
-\index[general]{Auswertung!Variablen }
-
-% TODO: does the following mean that this should not be in book?
-
-Please note that as of version 1.37, the Variable Expansion
-is deprecated and replaced by Python scripting (not yet
-documented).
-
-Variable expansion is somewhat similar to Unix shell variable expansion.
-Currently (version 1.31), it is used only in format labels, but in the future,
-it will most likely be used in more places.
-
-\section{General Functionality}
-\index[general]{Functionality!General }
-\index[general]{General Functionality }
-
-This is basically a string expansion capability that permits referencing
-variables, indexing arrays, conditional replacement of variables, case
-conversion, substring selection, regular expression matching and replacement,
-character class replacement, padding strings, repeated expansion in a user
-controlled loop, support of arithmetic expressions in the loop start, step and
-end conditions, and recursive expansion.
-
-When using variable expansion characters in a Volume Label Format record, the
-format should always be enclosed in double quotes.
-
-For example, {\bf \$\{HOME\}} will be replaced by your home directory as
-defined in the environment. If you have defined the variable {\bf xxx} to be
-{\bf Test}, then the reference {\bf \$\{xxx:p/7/Y/r\}} will right pad the
-contents of {\bf xxx} to a length of seven characters filling with the
-character {\bf Y} giving {\bf YYYTest}.
-
-\section{Bacula Variables}
-\index[general]{Bacula Variables }
-\index[general]{Variables!Bacula }
-
-Within Bacula, there are three main classes of variables with some minor
-variations within the classes. The classes are:
-
-\begin{description}
-
-\item [Counters]
- \index[dir]{Counters }
- Counters are defined by the {\bf Counter} resources in the Director's conf
-file. The counter can either be a temporary counter that lasts for the
-duration of Bacula's execution, or it can be a variable that is stored in
-the catalog, and thus retains its value from one Bacula execution to another.
-Counter variables may be incremented by postfixing a plus sign ({\bf +} after
-the variable name).
-
-\item [Internal Variables]
- \index[dir]{Internal Variables }
- Internal variables are read-only, and may be related to the current job (i.e.
-Job name), or maybe special variables such as the date and time. The
-following variables are available:
-
-\begin{itemize}
-\item [Year] -- the full year
-\item [Month] -- the current month 1-12
-\item [Day] -- the day of the month 1-31
-\item [Hour] -- the hour 0-24
-\item [Minute] -- the current minute 0-59
-\item [Second] -- the current second 0-59
-\item [WeekDay] -- the current day of the week 0-6 with 0 being Sunday
-\item [Job] -- the job name
-\item [Dir] -- the Director's name
-\item [Level] -- the Job Level
-\item [Type] -- the Job type
-\item [JobId] -- the JobId
-\item [JobName] -- the unique job name composed of Job and date
-\item [Storage] -- the Storage daemon's name
-\item [Client] -- the Client's name
-\item [NumVols] -- the current number of Volumes in the Pool
-\item [Pool] -- the Pool name
-\item [Catalog] -- the Catalog name
-\item [MediaType] -- the Media Type
- \end{itemize}
-
-\item [Environment Variables]
- \index[dir]{Environment Variables }
- Environment variables are read-only, and must be defined in the environment
-prior to executing Bacula. Environment variables may be either scalar or an
-array, where the elements of the array are referenced by subscripting the
-variable name (e.g. {\bf \$\{Months[3]\}}). Environment variable arrays are
-defined by separating the elements with a vertical bar ({\bf |}), thus {\bf
-set Months="`Jan|Feb|Mar|Apr|..."'} defines an environment variable named
-{\bf Month} that will be treated as an array, and the reference {\bf
-\$\{Months[3]\}} will yield {\bf Mar}. The elements of the array can have
-differing lengths.
-\end{description}
-
-\section{Full Syntax}
-\index[general]{Syntax!Full }
-\index[general]{Full Syntax }
-
-Since the syntax is quite extensive, below, you will find the pseudo BNF. The
-special characters have the following meaning:
-
-\footnotesize
-\begin{verbatim}
- ::= definition
- ( ) grouping if the parens are not quoted
- | separates alternatives
- '/' literal / (or any other character)
- CAPS a character or character sequence
- * preceding item can be repeated zero or more times
- ? preceding item can appear zero or one time
- + preceding item must appear one or more times
-\end{verbatim}
-\normalsize
-
-And the pseudo BNF describing the syntax is:
-
-\footnotesize
-\begin{verbatim}
- input ::= ( TEXT
- | variable
- | INDEX_OPEN input INDEX_CLOSE (loop_limits)?
- )*
- variable ::= DELIM_INIT (name|expression)
- name ::= (NAME_CHARS)+
- expression ::= DELIM_OPEN
- (name|variable)+
- (INDEX_OPEN num_exp INDEX_CLOSE)?
- (':' command)*
- DELIM_CLOSE
- command ::= '-' (TEXT_EXP|variable)+
- | '+' (TEXT_EXP|variable)+
- | 'o' NUMBER ('-'|',') (NUMBER)?
- | '#'
- | '*' (TEXT_EXP|variable)+
- | 's' '/' (TEXT_PATTERN)+
- '/' (variable|TEXT_SUBST)*
- '/' ('m'|'g'|'i'|'t')*
- | 'y' '/' (variable|TEXT_SUBST)+
- '/' (variable|TEXT_SUBST)*
- '/'
- | 'p' '/' NUMBER
- '/' (variable|TEXT_SUBST)*
- '/' ('r'|'l'|'c')
- | '%' (name|variable)+
- ('(' (TEXT_ARGS)? ')')?
- | 'l'
- | 'u'
- num_exp ::= operand
- | operand ('+'|'-'|'*'|'/'|'%') num_exp
- operand ::= ('+'|'-')? NUMBER
- | INDEX_MARK
- | '(' num_exp ')'
- | variable
- loop_limits ::= DELIM_OPEN
- (num_exp)? ',' (num_exp)? (',' (num_exp)?)?
- DELIM_CLOSE
- NUMBER ::= ('0'|...|'9')+
- TEXT_PATTERN::= (^('/'))+
- TEXT_SUBST ::= (^(DELIM_INIT|'/'))+
- TEXT_ARGS ::= (^(DELIM_INIT|')'))+
- TEXT_EXP ::= (^(DELIM_INIT|DELIM_CLOSE|':'|'+'))+
- TEXT ::= (^(DELIM_INIT|INDEX_OPEN|INDEX_CLOSE))+
- DELIM_INIT ::= '$'
- DELIM_OPEN ::= '{'
- DELIM_CLOSE ::= '}'
- INDEX_OPEN ::= '['
- INDEX_CLOSE ::= ']'
- INDEX_MARK ::= '#'
- NAME_CHARS ::= 'a'|...|'z'|'A'|...|'Z'|'0'|...|'9'
-\end{verbatim}
-\normalsize
-
-\section{Semantics}
-\index[general]{Semantics }
-
-The items listed in {\bf command} above, which always follow a colon ({\bf :})
-have the following meanings:
-
-\footnotesize
-\begin{verbatim}
- - perform substitution if variable is empty
- + perform substitution if variable is not empty
- o cut out substring of the variable value
- # length of the variable value
- * substitute empty string if the variable value is not empty,
- otherwise substitute the trailing parameter
- s regular expression search and replace. The trailing
- options are: m = multiline, i = case insensitive,
- g = global, t = plain text (no regexp)
- y transpose characters from class A to class B
- p pad variable to l = left, r = right or c = center,
- with second value.
- % special function call (none implemented)
- l lower case the variable value
- u upper case the variable value
-\end{verbatim}
-\normalsize
-
-The {\bf loop\_limits} are start, step, and end values.
-
-A counter variable name followed immediately by a plus ({\bf +}) will cause
-the counter to be incremented by one.
-
-\section{Examples}
-\index[general]{Examples }
-
-To create an ISO date:
-
-\footnotesize
-\begin{verbatim}
- DLT-${Year}-${Month:p/2/0/r}-${Day:p/2/0/r}
-\end{verbatim}
-\normalsize
-
-on 20 June 2003 would give {\bf DLT-2003-06-20}
-
-If you set the environment variable {\bf mon} to
-
-\footnotesize
-\begin{verbatim}
- January|February|March|April|May|...
- File-${mon[${Month}]}/${Day}/${Year}
-\end{verbatim}
-\normalsize
-
-on the first of March would give {\bf File-March/1/2003 }
+++ /dev/null
-%%
-%%
-
-% TODO: this chapter name is confusing ... maybe rename to
-% TODO: "File Integrity Checking with Bacula"?
-\chapter{Using Bacula to Improve Computer Security}
-\label{VerifyChapter}
-\index[general]{Security!Using Bacula to Improve Computer }
-\index[general]{Using Bacula to Improve Computer Security }
-
-% TODO: only those two digest algorithms?
-% TODO: can it use multiple at a time? (record and use both SHA1 and MD5?)
-Since Bacula maintains a catalog of files, their attributes, and either SHA1
-or MD5 signatures, it can be an ideal tool for improving computer security.
-This is done by making a snapshot of your system files with a {\bf Verify} Job
-and then checking the current state of your system against the snapshot, on a
-regular basis (e.g. nightly).
-
-The first step is to set up a {\bf Verify} Job and to run it with:
-
-\footnotesize
-\begin{verbatim}
-Level = InitCatalog
-\end{verbatim}
-\normalsize
-
-The {\bf InitCatalog} level tells {\bf Bacula} simply to get the information on
-the specified files and to put it into the catalog. That is your database is
-initialized and no comparison is done. The {\bf InitCatalog} is normally run
-one time manually.
-
-Thereafter, you will run a Verify Job on a daily (or whatever) basis with:
-
-\footnotesize
-\begin{verbatim}
-Level = Catalog
-\end{verbatim}
-\normalsize
-
-The {\bf Level = Catalog} level tells Bacula to compare the current state of
-the files on the Client to the last {\bf InitCatalog} that is stored in the
-catalog and to report any differences. See the example below for the format of
-the output.
-
-You decide what files you want to form your "`snapshot"' by specifying them in
-a {\bf FileSet} resource, and normally, they will be system files that do not
-change, or that only certain features change.
-
-Then you decide what attributes of each file you want compared by specifying
-comparison options on the {\bf Include} statements that you use in the {\bf
-FileSet} resource of your {\bf Catalog} Jobs.
-
-\section{The Details}
-\index[general]{Details }
-
-In the discussion that follows, we will make reference to the Verify
-Configuration Example that is included below in the {\bf A Verify
-Configuration Example} section. You might want to look it over now to get an
-idea of what it does.
-
-The main elements consist of adding a schedule, which will normally be run
-daily, or perhaps more often. This is provided by the {\bf VerifyCycle}
-Schedule, which runs at 5:05 in the morning every day.
-
-Then you must define a Job, much as is done below. We recommend that the Job
-name contain the name of your machine as well as the word {\bf Verify} or {\bf
-Check}. In our example, we named it {\bf MatouVerify}. This will permit you to
-easily identify your job when running it from the Console.
-
-You will notice that most records of the Job are quite standard, but that the
-{\bf FileSet} resource contains {\bf verify=pins1} option in addition to the
-standard {\bf signature=SHA1} option. If you don't want SHA1 signature
-comparison, and we cannot imagine why not, you can drop the {\bf
-signature=SHA1} and none will be computed nor stored in the catalog. Or
-alternatively, you can use {\bf verify=pins5} and {\bf signature=MD5}, which
-will use the MD5 hash algorithm. The MD5 hash computes faster than SHA1, but
-is cryptographically less secure.
-
-The {\bf verify=pins1} is ignored during the {\bf InitCatalog} Job, but is
-used during the subsequent {\bf Catalog} Jobs to specify what attributes of
-the files should be compared to those found in the catalog. {\bf pins1} is a
-reasonable set to begin with, but you may want to look at the details of these
-and other options. They can be found in the
-\ilink{FileSet Resource}{FileSetResource} section of this manual.
-Briefly, however, the {\bf p} of the {\bf pins1} tells Verify to compare the
-permissions bits, the {\bf i} is to compare inodes, the {\bf n} causes
-comparison of the number of links, the {\bf s} compares the file size, and the
-{\bf 1} compares the SHA1 checksums (this requires the {\bf signature=SHA1}
-option to have been set also).
-
-You must also specify the {\bf Client} and the {\bf Catalog} resources for
-your Verify job, but you probably already have them created for your client
-and do not need to recreate them, they are included in the example below for
-completeness.
-
-As mentioned above, you will need to have a {\bf FileSet} resource for the
-Verify job, which will have the additional {\bf verify=pins1} option. You will
-want to take some care in defining the list of files to be included in your
-{\bf FileSet}. Basically, you will want to include all system (or other) files
-that should not change on your system. If you select files, such as log files
-or mail files, which are constantly changing, your automatic Verify job will
-be constantly finding differences. The objective in forming the FileSet is to
-choose all unchanging important system files. Then if any of those files has
-changed, you will be notified, and you can determine if it changed because you
-loaded a new package, or because someone has broken into your computer and
-modified your files. The example below shows a list of files that I use on my
-Red Hat 7.3 system. Since I didn't spend a lot of time working on it, it
-probably is missing a few important files (if you find one, please send it to
-me). On the other hand, as long as I don't load any new packages, none of
-these files change during normal operation of the system.
-
-\section{Running the Verify}
-\index[general]{Running the Verify }
-\index[general]{Verify!Running the }
-
-The first thing you will want to do is to run an {\bf InitCatalog} level
-Verify Job. This will initialize the catalog to contain the file information
-that will later be used as a basis for comparisons with the actual file
-system, thus allowing you to detect any changes (and possible intrusions into
-your system).
-
-The easiest way to run the {\bf InitCatalog} is manually with the console
-program by simply entering {\bf run}. You will be presented with a list of
-Jobs that can be run, and you will choose the one that corresponds to your
-Verify Job, {\bf MatouVerify} in this example.
-
-\footnotesize
-\begin{verbatim}
-The defined Job resources are:
- 1: MatouVerify
- 2: kernsrestore
- 3: Filetest
- 4: kernsave
-Select Job resource (1-4): 1
-\end{verbatim}
-\normalsize
-
-Next, the console program will show you the basic parameters of the Job and
-ask you:
-
-\footnotesize
-\begin{verbatim}
-Run Verify job
-JobName: MatouVerify
-FileSet: Verify Set
-Level: Catalog
-Client: MatouVerify
-Storage: DLTDrive
-OK to run? (yes/mod/no): mod
-\end{verbatim}
-\normalsize
-
-Here, you want to respond {\bf mod} to modify the parameters because the Level
-is by default set to {\bf Catalog} and we want to run an {\bf InitCatalog}
-Job. After responding {\bf mod}, the console will ask:
-
-\footnotesize
-\begin{verbatim}
-Parameters to modify:
- 1: Job
- 2: Level
- 3: FileSet
- 4: Client
- 5: Storage
-Select parameter to modify (1-5): 2
-\end{verbatim}
-\normalsize
-
-you should select number 2 to modify the {\bf Level}, and it will display:
-
-\footnotesize
-\begin{verbatim}
-Levels:
- 1: Initialize Catalog
- 2: Verify from Catalog
- 3: Verify Volume
- 4: Verify Volume Data
-Select level (1-4): 1
-\end{verbatim}
-\normalsize
-
-Choose item 1, and you will see the final display:
-
-\footnotesize
-\begin{verbatim}
-Run Verify job
-JobName: MatouVerify
-FileSet: Verify Set
-Level: Initcatalog
-Client: MatouVerify
-Storage: DLTDrive
-OK to run? (yes/mod/no): yes
-\end{verbatim}
-\normalsize
-
-at which point you respond {\bf yes}, and the Job will begin.
-
-Thereafter the Job will automatically start according to the schedule you
-have defined. If you wish to immediately verify it, you can simply run a
-Verify {\bf Catalog} which will be the default. No differences should be
-found.
-
-\section{What To Do When Differences Are Found}
-\index[general]{What To Do When Differences Are Found }
-\index[general]{Found!What To Do When Differences Are }
-
-If you have setup your messages correctly, you should be notified if there are
-any differences and exactly what they are. For example, below is the email
-received after doing an update of OpenSSH:
-
-\footnotesize
-\begin{verbatim}
-HeadMan: Start Verify JobId 83 Job=RufusVerify.2002-06-25.21:41:05
-HeadMan: Verifying against Init JobId 70 run 2002-06-21 18:58:51
-HeadMan: File: /etc/pam.d/sshd
-HeadMan: st_ino differ. Cat: 4674b File: 46765
-HeadMan: File: /etc/rc.d/init.d/sshd
-HeadMan: st_ino differ. Cat: 56230 File: 56231
-HeadMan: File: /etc/ssh/ssh_config
-HeadMan: st_ino differ. Cat: 81317 File: 8131b
-HeadMan: st_size differ. Cat: 1202 File: 1297
-HeadMan: SHA1 differs.
-HeadMan: File: /etc/ssh/sshd_config
-HeadMan: st_ino differ. Cat: 81398 File: 81325
-HeadMan: st_size differ. Cat: 1182 File: 1579
-HeadMan: SHA1 differs.
-HeadMan: File: /etc/ssh/ssh_config.rpmnew
-HeadMan: st_ino differ. Cat: 812dd File: 812b3
-HeadMan: st_size differ. Cat: 1167 File: 1114
-HeadMan: SHA1 differs.
-HeadMan: File: /etc/ssh/sshd_config.rpmnew
-HeadMan: st_ino differ. Cat: 81397 File: 812dd
-HeadMan: st_size differ. Cat: 2528 File: 2407
-HeadMan: SHA1 differs.
-HeadMan: File: /etc/ssh/moduli
-HeadMan: st_ino differ. Cat: 812b3 File: 812ab
-HeadMan: File: /usr/bin/scp
-HeadMan: st_ino differ. Cat: 5e07e File: 5e343
-HeadMan: st_size differ. Cat: 26728 File: 26952
-HeadMan: SHA1 differs.
-HeadMan: File: /usr/bin/ssh-keygen
-HeadMan: st_ino differ. Cat: 5df1d File: 5e07e
-HeadMan: st_size differ. Cat: 80488 File: 84648
-HeadMan: SHA1 differs.
-HeadMan: File: /usr/bin/sftp
-HeadMan: st_ino differ. Cat: 5e2e8 File: 5df1d
-HeadMan: st_size differ. Cat: 46952 File: 46984
-HeadMan: SHA1 differs.
-HeadMan: File: /usr/bin/slogin
-HeadMan: st_ino differ. Cat: 5e359 File: 5e2e8
-HeadMan: File: /usr/bin/ssh
-HeadMan: st_mode differ. Cat: 89ed File: 81ed
-HeadMan: st_ino differ. Cat: 5e35a File: 5e359
-HeadMan: st_size differ. Cat: 219932 File: 234440
-HeadMan: SHA1 differs.
-HeadMan: File: /usr/bin/ssh-add
-HeadMan: st_ino differ. Cat: 5e35b File: 5e35a
-HeadMan: st_size differ. Cat: 76328 File: 81448
-HeadMan: SHA1 differs.
-HeadMan: File: /usr/bin/ssh-agent
-HeadMan: st_ino differ. Cat: 5e35c File: 5e35b
-HeadMan: st_size differ. Cat: 43208 File: 47368
-HeadMan: SHA1 differs.
-HeadMan: File: /usr/bin/ssh-keyscan
-HeadMan: st_ino differ. Cat: 5e35d File: 5e96a
-HeadMan: st_size differ. Cat: 139272 File: 151560
-HeadMan: SHA1 differs.
-HeadMan: 25-Jun-2002 21:41
-JobId: 83
-Job: RufusVerify.2002-06-25.21:41:05
-FileSet: Verify Set
-Verify Level: Catalog
-Client: RufusVerify
-Start time: 25-Jun-2002 21:41
-End time: 25-Jun-2002 21:41
-Files Examined: 4,258
-Termination: Verify Differences
-\end{verbatim}
-\normalsize
-
-At this point, it was obvious that these files were modified during
-installation of the RPMs. If you want to be super safe, you should run a {\bf
-Verify Level=Catalog} immediately before installing new software to verify
-that there are no differences, then run a {\bf Verify Level=InitCatalog}
-immediately after the installation.
-
-To keep the above email from being sent every night when the Verify Job runs,
-we simply re-run the Verify Job setting the level to {\bf InitCatalog} (as we
-did above in the very beginning). This will re-establish the current state of
-the system as your new basis for future comparisons. Take care that you don't
-do an {\bf InitCatalog} after someone has placed a Trojan horse on your
-system!
-
-If you have included in your {\bf FileSet} a file that is changed by the
-normal operation of your system, you will get false matches, and you will need
-to modify the {\bf FileSet} to exclude that file (or not to Include it), and
-then re-run the {\bf InitCatalog}.
-
-The FileSet that is shown below is what I use on my Red Hat 7.3 system. With a
-bit more thought, you can probably add quite a number of additional files that
-should be monitored.
-
-\section{A Verify Configuration Example}
-\index[general]{Verify Configuration Example }
-\index[general]{Example!Verify Configuration }
-
-\footnotesize
-\begin{verbatim}
-Schedule {
- Name = "VerifyCycle"
- Run = Level=Catalog sun-sat at 5:05
-}
-Job {
- Name = "MatouVerify"
- Type = Verify
- Level = Catalog # default level
- Client = MatouVerify
- FileSet = "Verify Set"
- Messages = Standard
- Storage = DLTDrive
- Pool = Default
- Schedule = "VerifyCycle"
-}
-#
-# The list of files in this FileSet should be carefully
-# chosen. This is a good starting point.
-#
-FileSet {
- Name = "Verify Set"
- Include {
- Options {
- verify=pins1
- signature=SHA1
- }
- File = /boot
- File = /bin
- File = /sbin
- File = /usr/bin
- File = /lib
- File = /root/.ssh
- File = /home/kern/.ssh
- File = /var/named
- File = /etc/sysconfig
- File = /etc/ssh
- File = /etc/security
- File = /etc/exports
- File = /etc/rc.d/init.d
- File = /etc/sendmail.cf
- File = /etc/sysctl.conf
- File = /etc/services
- File = /etc/xinetd.d
- File = /etc/hosts.allow
- File = /etc/hosts.deny
- File = /etc/hosts
- File = /etc/modules.conf
- File = /etc/named.conf
- File = /etc/pam.d
- File = /etc/resolv.conf
- }
- Exclude = { }
-P
-Client {
- Name = MatouVerify
- Address = lmatou
- Catalog = Bacula
- Password = ""
- File Retention = 80d # 80 days
- Job Retention = 1y # one year
- AutoPrune = yes # Prune expired Jobs/Files
-}
-Catalog {
- Name = Bacula
- dbname = verify; user = bacula; password = ""
-}
-\end{verbatim}
-\normalsize
+++ /dev/null
-%%
-%%
-
-\chapter{The Windows Version of Bacula}
-\label{Win32Chapter}
-\index[general]{Windows Version of Bacula}
-
-At the current time only the File daemon or Client program has
-been thouroughly tested on Windows and is suitable for a
-production environment. As a consequence, when we
-speak of the Windows version of Bacula below, we are referring to
-the File daemon (client) only.
-
-As of Bacula version 1.39.20 or greater, the installer is capable
-of installing not just the Client program, but also the Director
-and the Storage daemon and all the other programs that were
-previously available only on Unix systems. These additional
-programs, notably the Director and Storage daemon, have been partially
-tested, are reported to have some bugs, and still need to be documented.
-They are not yet supported, and we cannot currently accept or fix
-bug reports on them. Consequently, please test them carefully before putting
-them into a critical production environment.
-
-The Windows version of the Bacula File daemon has been tested on Win98, WinMe,
-WinNT, WinXP, Win2000, and Windows 2003 systems. We have coded to support
-Win95, but no longer have a system for testing. The Windows version of
-Bacula is a native Win32 port, but there are very few source code changes
-to the Unix code, which means that the Windows version is for the most part
-running code that has long proved stable on Unix systems. When running, it
-is perfectly integrated with Windows and displays its icon in the system
-icon tray, and provides a system tray menu to obtain additional information
-on how Bacula is running (status and events dialog boxes). If so desired,
-it can also be stopped by using the system tray menu, though this should
-normally never be necessary.
-
-Once installed Bacula normally runs as a system service. This means that it is
-immediately started by the operating system when the system is booted, and
-runs in the background even if there is no user logged into the system.
-
-\section{Win32 Installation}
-\label{installation}
-\index[general]{Installation}
-\index[general]{Win32!Installation}
-
-Normally, you will install the Windows version of Bacula from the binaries.
-This install is standard Windows .exe that runs an install wizard using the
-NSIS Free Software installer, so if you have already installed Windows
-software, it should be very familiar to you.
-
-If you have a previous version Bacula (1.39.20 or lower)
-installed, you should stop the service, uninstall it, and remove
-the Bacula installation directory possibly saving your
-bacula-fd.conf, bconsole.conf, and bwx-console.conf files
-for use with the new version you will install. The Uninstall
-program is normally found in {\bf c:\textbackslash{}bacula\textbackslash{}Uninstall.exe}.
-We also recommend that you completely remove the directory
-{\bf c:\textbackslash{}bacula}, because the current installer
-uses a different directory structure (see below).
-
-Providing you do not already have Bacula installed,
-the new installer (1.39.22 and later) installs the binaries and dlls in
-c:\textbackslash{}Program Files\textbackslash{}Bacula\textbackslash{}bin
-and the configuration files
-in c:\textbackslash{}Documents and Settings\textbackslash{}All Users\textbackslash{}Application Data\textbackslash{}Bacula
-In addition, the {\bf Start\-\gt{}All Programs\-\gt{}Bacula} menu item
-will be created during the installation, and on that menu, you
-will find items for editing the configuration files, displaying
-the document, and starting bwx-console or bconsole.
-
-
-Finally, proceed with the installation.
-
-\begin{itemize}
-\item You must be logged in as Administrator to the local machine
-to do a correct installation, if not, please do so before continuing.
-Some users have attempted to install logged in as a domain administrator
-account and experienced permissions problems attempting to run
-Bacula, so we don't recommend that option.
-
-\item Simply double click on the {\bf winbacula-1.xx.0.exe} NSIS install
- icon. The actual name of the icon will vary from one release version to
- another.
-
-\includegraphics{\idir win32-nsis.eps} winbacula-1.xx.0.exe
-
-\item Once launched, the installer wizard will ask you if you want to install
- Bacula.
-
-\addcontentsline{lof}{figure}{Win32 Client Setup Wizard}
-\includegraphics{\idir win32-welcome.eps}
-
-\item Next you will be asked to select the installation type.
-
-\addcontentsline{lof}{figure}{Win32 Installation Type}
-\includegraphics{\idir win32-installation-type.eps}
-
-
-\item If you proceed, you will be asked to select the components to be
- installed. You may install the Bacula program (Bacula File Service) and or
- the documentation. Both will be installed in sub-directories of the install
- location that you choose later. The components dialog looks like the
- following:
-
-\addcontentsline{lof}{figure}{Win32 Component Selection Dialog}
-\includegraphics{\idir win32-pkg.eps}
-\index[general]{Upgrading}
-
-\item If you are installing for the first time, you will be asked to
- enter some very basic information about your configuration. If
- you are not sure what to enter, or have previously saved configuration
- files, you can put anything you want into the fields, then either
- replace the configuration files later with the ones saved, or edit
- the file.
-
- If you are upgrading an existing installation, the following will
- not be displayed.
-
-
-\addcontentsline{lof}{figure}{Win32 Configure}
-\includegraphics{\idir win32-config.eps}
-
-\item While the various files are being loaded, you will see the following
- dialog:
-
- \addcontentsline{lof}{figure}{Win32 Install Progress}
- \includegraphics{\idir win32-installing.eps}
-
-
-\item Finally, the finish dialog will appear:
-
- \addcontentsline{lof}{figure}{Win32 Client Setup Completed}
- \includegraphics{\idir win32-finish.eps}
-
-\
-\end{itemize}
-
-That should complete the installation process. When the Bacula File Server is
-ready to serve files, an icon \includegraphics{\idir idle.eps} representing a
-cassette (or tape) will appear in the system tray
-\includegraphics{\idir tray-icon.eps}; right click on it and a menu will appear.\\
-\includegraphics{\idir menu.eps}\\
-The {\bf Events} item is currently unimplemented, by selecting the {\bf
-Status} item, you can verify whether any jobs are running or not.
-
-When the Bacula File Server begins saving files, the color of the holes in the
-cassette icon will change from white to green \includegraphics{\idir running.eps},
-and if there is an error, the holes in the cassette icon will change to red
-\includegraphics{\idir error.eps}.
-
-If you are using remote desktop connections between your Windows boxes, be
-warned that that tray icon does not always appear. It will always be visible
-when you log into the console, but the remote desktop may not display it.
-
-\section{Post Win32 Installation}
-\index[general]{Post Win32 Installation}
-\index[general]{Win32!Post Installation}
-
-After installing Bacula and before running it, you should check the contents
-of the configuration files to ensure that they correspond to your
-installation. You can get to them by using:
-the {\bf Start\-\gt{}All Programs\-\gt{}Bacula} menu item.
-
-Finally, but pulling up the Task Manager (ctl-alt-del), verify that Bacula
-is running as a process (not an Application) with User Name SYSTEM. If this is
-not the case, you probably have not installed Bacula while running as
-Administrator, and hence it will be unlikely that Bacula can access
-all the system files.
-
-\section{Uninstalling Bacula on Win32}
-\index[general]{Win32!Uninstalling Bacula}
-\index[general]{Uninstalling Bacula on Win32}
-
-Once Bacula has been installed, it can be uninstalled using the standard
-Windows Add/Remove Programs dialog found on the Control panel.
-
-\section{Dealing with Win32 Problems}
-\label{problems}
-\index[general]{Win32!Dealing with Problems}
-\index[general]{Dealing with Win32 Problems}
-
-Sometimes Win32 machines the File daemon may have very slow
-backup transfer rates compared to other machines. To you might
-try setting the Maximum Network Buffer Size to 32,768 in both the
-File daemon and in the Storage daemon. The default size is larger,
-and apparently some Windows ethernet controllers do not deal with
-a larger network buffer size.
-
-Many Windows ethernet drivers have a tendency to either run slowly
-due to old broken firmware, or because they are running in half-duplex
-mode. Please check with the ethernet card manufacturer for the latest
-firmware and use whatever techniques are necessary to ensure that the
-card is running in duplex.
-
-If you are not using the portable option, and you have VSS
-(Volume Shadow Copy) enabled in the Director, and you experience
-problems with Bacula not being able to open files, it is most
-likely that you are running an antivirus program that blocks
-Bacula from doing certain operations. In this case, disable the
-antivirus program and try another backup. If it succeeds, either
-get a different (better) antivirus program or use something like
-RunClientJobBefore/After to turn off the antivirus program while
-the backup is running.
-
-If turning off anti-virus software does not resolve your VSS
-problems, you might have to turn on VSS debugging. The following
-link describes how to do this:
-\elink{http://support.microsoft.com/kb/887013/en-us}{\url{http://support.microsoft.com/kb/887013/en-us}}.
-
-In Microsoft Windows Small Business Server 2003 the VSS Writer for Exchange
-is turned off by default. To turn it on, please see the following link:
-\elink{http://support.microsoft.com/default.aspx?scid=kb;EN-US;Q838183}{\url{
-http://support.microsoft.com/default.aspx?scid=kb;EN-US;Q838183}}
-
-
-The most likely source of problems is authentication when the Director
-attempts to connect to the File daemon that you installed. This can occur if
-the names and the passwords defined in the File daemon's configuration file
-{\bf bacula-fd.conf} file on
-the Windows machine do not match with the names and the passwords in the
-Director's configuration file {\bf bacula-dir.conf} located on your Unix/Linux
-server.
-
-More specifically, the password found in the {\bf Client} resource in the
-Director's configuration file must be the same as the password in the {\bf
-Director} resource of the File daemon's configuration file. In addition, the
-name of the {\bf Director} resource in the File daemon's configuration file
-must be the same as the name in the {\bf Director} resource of the Director's
-configuration file.
-
-It is a bit hard to explain in words, but if you understand that a Director
-normally has multiple Clients and a Client (or File daemon) may permit access
-by multiple Directors, you can see that the names and the passwords on both
-sides must match for proper authentication.
-
-One user had serious problems with the configuration file until he realized
-that the Unix end of line conventions were used and Bacula wanted them in
-Windows format. This has not been confirmed though, and Bacula version 2.0.0
-and above should now accept all end of line conventions (Win32,
-Unix, Mac).
-
-Running Unix like programs on Windows machines is a bit frustrating because
-the Windows command line shell (DOS Window) is rather primitive. As a
-consequence, it is not generally possible to see the debug information and
-certain error messages that Bacula prints. With a bit of work, however, it is
-possible. When everything else fails and you want to {\bf see} what is going
-on, try the following:
-
-\footnotesize
-\begin{verbatim}
- Start a DOS shell Window.
- c:\Program Files\bacula\bin\bacula-fd -t >out
- type out
-\end{verbatim}
-\normalsize
-
-The precise path to bacula-fd depends on where it is installed. The
-example above is the default used in 1.39.22 and later.
-The {\bf -t} option will cause Bacula to read the configuration file, print
-any error messages and then exit. the {\bf \gt{}} redirects the output to the
-file named {\bf out}, which you can list with the {\bf type} command.
-
-If something is going wrong later, or you want to run {\bf Bacula} with a
-debug option, you might try starting it as:
-
-\footnotesize
-\begin{verbatim}
- c:\Program Files\bacula\bin\bacula-fd -d 100 >out
-\end{verbatim}
-\normalsize
-
-In this case, Bacula will run until you explicitly stop it, which will give
-you a chance to connect to it from your Unix/Linux server. In later versions
-of Bacula (1.34 on, I think), when you start the File daemon in debug mode it
-can write the output to a trace file {\bf bacula.trace} in the current
-directory. To enable this, before running a job, use the console, and enter:
-
-\footnotesize
-\begin{verbatim}
- trace on
-\end{verbatim}
-\normalsize
-
-then run the job, and once you have terminated the File daemon, you will find
-the debug output in the {\bf bacula.trace} file, which will probably be
-located in the same directory as bacula-fd.exe.
-
-In addition, you should look in the System Applications log on the Control
-Panel to find any Windows errors that Bacula got during the startup process.
-
-Finally, due to the above problems, when you turn on debugging, and specify
-trace=1 on a setdebug command in the Console, Bacula will write the debug
-information to the file {\bf bacula.trace} in the directory from which Bacula
-is executing.
-
-If you are having problems with ClientRunBeforeJob scripts randomly dying,
-it is possible that you have run into an Oracle bug. See bug number 622 in
-the bugs.bacula.org database. The following information has been
-provided by a user on this issue:
-
-\footnotesize
-\begin{verbatim}
-The information in this document applies to:
- Oracle HTTP Server - Version: 9.0.4
- Microsoft Windows Server 2003
- Symptoms
- When starting an OC4J instance, the System Clock runs faster, about 7
-seconds per minute.
-
- Cause
-
- + This is caused by the Sun JVM bug 4500388, which states that "Calling
-Thread.sleep() with a small argument affects the system clock". Although
-this is reported as fixed in JDK 1.4.0_02, several reports contradict this
-(see the bug in
-http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4500388).
-
- + Also reported by Microsoft as "The system clock may run fast when you
-use the ACPI power management timer as a high-resolution counter on Windows
-2000-based computers" (See http://support.microsoft.com/?id=821893)
-\end{verbatim}
-\normalsize
-
-You may wish to start the daemon with debug mode on rather than doing it
-using bconsole. To do so, edit the following registry key:
-
-\footnotesize
-\begin{verbatim}
-HKEY_LOCAL_MACHINE\HARDWARE\SYSTEM\CurrentControlSet\Services\Bacula-dir
-\end{verbatim}
-\normalsize
-
-using regedit, then add -dnn after the /service option, where nn represents
-the debug level you want.
-
-\label{Compatibility}
-\section{Windows Compatibility Considerations}
-\index[general]{Windows Compatibility Considerations}
-\index[general]{Considerations!Windows Compatibility}
-
-If you are not using the VSS (Volume Shadow Copy) option described in the
-next section of this chapter, and if any applications are running during
-the backup and they have files opened exclusively, Bacula will not be able
-to backup those files, so be sure you close your applications (or tell your
-users to close their applications) before the backup. Fortunately, most
-Microsoft applications do not open files exclusively so that they can be
-backed up. However, you will need to experiment. In any case, if Bacula
-cannot open the file, it will print an error message, so you will always
-know which files were not backed up. For version 1.37.25 and greater, see
-the section below on Volume Shadow Copy Service that permits backing up any
-file.
-
-During backup, Bacula doesn't know about the system registry, so you will
-either need to write it out to an ASCII file using {\bf regedit~~/e} or use a
-program specifically designed to make a copy or backup the registry.
-
-In Bacula version 1.31 and later, we use Windows backup API calls by
-default. Typical of Windows, programming these special BackupRead and
-BackupWrite calls is a real nightmare of complications. The end result
-gives some distinct advantages and some disadvantages.
-
-First, the advantages are that on WinNT/2K/XP systems, the security and
-ownership information is now backed up. In addition, with the exception of
-files in exclusive use by another program, Bacula can now access all system
-files. This means that when you restore files, the security and ownership
-information will be restored on WinNT/2K/XP along with the data.
-
-The disadvantage of the Windows backup API calls is that it produces
-non-portable backups. That is files and their data that are backed up on
-WinNT using the native API calls (BackupRead/BackupWrite) cannot be
-restored on Win95/98/Me or Unix systems. In principle, a file backed up on
-WinNT can be restored on WinXP, but this remains to be seen in practice
-(not yet tested). In addition, the stand-alone tools such as {\bf bls} and
-{\bf bextract} cannot be used to retrieve the data for those files because
-those tools are not available on Windows. All restores must use the Bacula
-{\bf restore} command. As of Bacula 1.39.x, thanks to Thorsten Engel, this
-restriction is removed, and Bacula should be able to read non-portable
-backups on any system and restore the data appropriately. However,
-on a system that does not have the BackupRead/BackupWrite calls (older
-Windows versions and all Unix/Linux machines), though the file data
-can be restored, the Windows security and access control data will not be restored.
-This means that a standard set of access permissions will be set for
-such restored files.
-
-
-As a default, Bacula backs up Windows systems using the Windows API calls.
-If you want to backup data on a WinNT/2K/XP system and restore it on a
-Unix/Win95/98/Me system, we have provided a special {\bf portable} option
-that backs up the data in a portable fashion by using portable API calls.
-See the \ilink{portable option}{portable} on the Include statement in a
-FileSet resource in the Director's configuration chapter for the details on
-setting this option. However, using the portable option means you may have
-permissions problems accessing files, and none of the security and
-ownership information will be backed up or restored. The file data can,
-however, be restored on any system.
-
-You should always be able to restore any file backed up on Unix or Win95/98/Me
-to any other system. On some systems, such as WinNT/2K/XP, you may have to
-reset the ownership of such restored files. Any file backed up on WinNT/2K/XP
-should in principle be able to be restored to a similar system (i.e.
-WinNT/2K/XP), however, I am unsure of the consequences if the owner
-information and accounts are not identical on both systems. Bacula will not
-let you restore files backed up on WinNT/2K/XP to any other system (i.e. Unix
-Win95/98/Me) if you have used the defaults.
-
-Finally, if you specify the {\bf portable=yes} option on the files you back
-up. Bacula will be able to restore them on any other system. However, any
-WinNT/2K/XP specific security and ownership information will be lost.
-
-The following matrix will give you an idea of what you can expect. Thanks to
-Marc Brueckner for doing the tests:
-
-\addcontentsline{lot}{table}{WinNT/2K/XP Restore Portability Status}
-\begin{longtable}{|l|l|p{2.8in}|}
- \hline
-\multicolumn{1}{|c|}{\bf Backup OS} & \multicolumn{1}{c|}{\bf Restore OS}
-& \multicolumn{1}{c|}{\bf Results } \\
- \hline {WinMe} & {WinMe} & {Works } \\
- \hline {WinMe} & {WinNT} & {Works (SYSTEM permissions) } \\
- \hline {WinMe} & {WinXP} & {Works (SYSTEM permissions) } \\
- \hline {WinMe} & {Linux} & {Works (SYSTEM permissions) } \\
- \hline {\ } & {\ } & {\ } \\
- \hline {WinXP} & {WinXP} & {Works } \\
- \hline {WinXP} & {WinNT} & {Works (all files OK, but got "The data is invalid"
-message) } \\
- \hline {WinXP} & {WinMe} & {Error: Win32 data stream not supported. } \\
- \hline {WinXP} & {WinMe} & {Works if {\bf Portable=yes} specified during backup.} \\
- \hline {WinXP} & {Linux} & {Error: Win32 data stream not supported. } \\
- \hline {WinXP} & {Linux} & {Works if {\bf Portable=yes} specified during backup.}\\
- \hline {\ } & {\ } & {\ } \\
- \hline {WinNT} & {WinNT} & {Works } \\
- \hline {WinNT} & {WinXP} & {Works } \\
- \hline {WinNT} & {WinMe} & {Error: Win32 data stream not supported. } \\
- \hline {WinNT} & {WinMe} & {Works if {\bf Portable=yes} specified during backup.}\\
- \hline {WinNT} & {Linux} & {Error: Win32 data stream not supported. } \\
- \hline {WinNT} & {Linux} & {Works if {\bf Portable=yes} specified during backup. }\\
- \hline {\ } & {\ } & {\ } \\
- \hline {Linux} & {Linux} & {Works } \\
- \hline {Linux} & {WinNT} & {Works (SYSTEM permissions) } \\
- \hline {Linux} & {WinMe} & {Works } \\
- \hline {Linux} & {WinXP} & {Works (SYSTEM permissions)}
-\\ \hline
-\end{longtable}
-
-Note: with Bacula versions 1.39.x and later, non-portable Windows data can
-be restore to any machine.
-
-
-\label{VSS}
-\section{Volume Shadow Copy Service}
-\index[general]{Volume Shadow Copy Service}
-\index[general]{VSS}
-In version 1.37.30 and greater, you can turn on Microsoft's Volume
-Shadow Copy Service (VSS).
-
-Microsoft added VSS to Windows XP and Windows 2003. From the perspective of
-a backup-solution for Windows, this is an extremely important step. VSS
-allows Bacula to backup open files and even to interact with applications like
-RDBMS to produce consistent file copies. VSS aware applications are called
-VSS Writers, they register with the OS so that when Bacula wants to do a
-Snapshot, the OS will notify the register Writer programs, which may then
-create a consistent state in their application, which will be backed up.
-Examples for these writers are "`MSDE"' (Microsoft database
-engine), "`Event Log Writer"', "`Registry Writer"' plus 3rd
-party-writers. If you have a non-vss aware application (e.g.
-SQL Anywhere or probably MySQL), a shadow copy is still generated
-and the open files can be backed up, but there is no guarantee
-that the file is consistent.
-
-Bacula produces a message from each of the registered writer programs
-when it is doing a VSS backup so you know which ones are correctly backed
-up.
-
-Bacula supports VSS on both Windows 2003 and Windows XP.
-Technically Bacula creates a shadow copy as soon as the backup process
-starts. It does then backup all files from the shadow copy and destroys the
-shadow copy after the backup process. Please have in mind, that VSS
-creates a snapshot and thus backs up the system at the state it had
-when starting the backup. It will disregard file changes which occur during
-the backup process.
-
-VSS can be turned on by placing an
-
-\index[dir]{Enable VSS}
-\index[general]{Enable VSS}
-\begin{verbatim}
-Enable VSS = yes
-\end{verbatim}
-
-in your FileSet resource.
-
-The VSS aware File daemon has the letters VSS on the signon line that
-it produces when contacted by the console. For example:
-\begin{verbatim}
-Tibs-fd Version: 1.37.32 (22 July 2005) VSS Windows XP MVS NT 5.1.2600
-\end{verbatim}
-the VSS is shown in the line above. This only means that the File daemon
-is capable of doing VSS not that VSS is turned on for a particular backup.
-There are two ways of telling if VSS is actually turned on during a backup.
-The first is to look at the status output for a job, e.g.:
-\footnotesize
-\begin{verbatim}
-Running Jobs:
-JobId 1 Job NightlySave.2005-07-23_13.25.45 is running.
- VSS Backup Job started: 23-Jul-05 13:25
- Files=70,113 Bytes=3,987,180,650 Bytes/sec=3,244,247
- Files Examined=75,021
- Processing file: c:/Documents and Settings/kern/My Documents/My Pictures/Misc1/Sans titre - 39.pdd
- SDReadSeqNo=5 fd=352
-\end{verbatim}
-\normalsize
-Here, you see under Running Jobs that JobId 1 is "`VSS Backup Job started ..."'
-This means that VSS is enabled for that job. If VSS is not enabled, it will
-simply show "`Backup Job started ..."' without the letters VSS.
-
-The second way to know that the job was backed up with VSS is to look at the
-Job Report, which will look something like the following:
-\footnotesize
-\begin{verbatim}
-23-Jul 13:25 rufus-dir: Start Backup JobId 1, Job=NightlySave.2005-07-23_13.25.45
-23-Jul 13:26 rufus-sd: Wrote label to prelabeled Volume "TestVolume001" on device "DDS-4" (/dev/nst0)
-23-Jul 13:26 rufus-sd: Spooling data ...
-23-Jul 13:26 Tibs: Generate VSS snapshots. Driver="VSS WinXP", Drive(s)="C"
-23-Jul 13:26 Tibs: VSS Writer: "MSDEWriter", State: 1 (VSS_WS_STABLE)
-23-Jul 13:26 Tibs: VSS Writer: "Microsoft Writer (Bootable State)", State: 1 (VSS_WS_STABLE)
-23-Jul 13:26 Tibs: VSS Writer: "WMI Writer", State: 1 (VSS_WS_STABLE)
-23-Jul 13:26 Tibs: VSS Writer: "Microsoft Writer (Service State)", State: 1 (VSS_WS_STABLE)
-\end{verbatim}
-\normalsize
-In the above Job Report listing, you see that the VSS snapshot was generated for drive C (if
-other drives are backed up, they will be listed on the {\bf Drive(s)="`C"'} You also see the
-reports from each of the writer program. Here they all report VSS\_WS\_STABLE, which means
-that you will get a consistent snapshot of the data handled by that writer.
-
-\section{VSS Problems}
-\index[general]{Problems!VSS}
-\index[fd] {Problems!VSS}
-\index[general]{VSS Problems}
-\index[fd]{VSS Problems}
-
-If you are experiencing problems such as VSS hanging on MSDE, first try
-running {\bf vssadmin} to check for problems, then try running {\bf
-ntbackup} which also uses VSS to see if it has similar problems. If so, you
-know that the problem is in your Windows machine and not with Bacula.
-
-The FD hang problems were reported with {\bf MSDEwriter} when:
-\begin{itemize}
-\item a local firewall locked local access to the MSDE TCP port (MSDEwriter
-seems to use TCP/IP and not Named Pipes).
-\item msdtcs was installed to run under "`localsystem"': try running msdtcs
-under networking account (instead of local system) (com+ seems to work
-better with this configuration).
-\end{itemize}
-
-
-\section{Windows Firewalls}
-\index[general]{Firewalls!Windows}
-\index[general]{Windows Firewalls}
-
-If you turn on the firewalling feature on Windows (default in WinXP SP2), you
-are likely to find that the Bacula ports are blocked and you cannot
-communicate to the other daemons. This can be deactivated through the {\bf
-Security Notification} dialog, which is apparently somewhere in the {\bf
-Security Center}. I don't have this on my computer, so I cannot give the exact
-details.
-
-The command:
-
-\footnotesize
-\begin{verbatim}
-netsh firewall set opmode disable
-\end{verbatim}
-\normalsize
-
-is purported to disable the firewall, but this command is not accepted on my
-WinXP Home machine.
-
-\section{Windows Port Usage}
-\index[general]{Windows Port Usage}
-\index[general]{Usage!Windows Port}
-
-If you want to see if the File daemon has properly opened the port and is
-listening, you can enter the following command in a shell window:
-
-\footnotesize
-\begin{verbatim}
- netstat -an | findstr 910[123]
-\end{verbatim}
-\normalsize
-
-TopView is another program that has been recommend, but it is not a
-standard Win32 program, so you must find and download it from the Internet.
-
-\section{Windows Disaster Recovery}
-\index[general]{Recovery!Windows Disaster}
-\index[general]{Windows Disaster Recovery}
-
-We don't currently have a good solution for disaster recovery on Windows as we
-do on Linux. The main piece lacking is a Windows boot floppy or a Windows boot
-CD. Microsoft releases a Windows Pre-installation Environment ({\bf WinPE})
-that could possibly work, but we have not investigated it. This means that
-until someone figures out the correct procedure, you must restore the OS from
-the installation disks, then you can load a Bacula client and restore files.
-Please don't count on using {\bf bextract} to extract files from your backup
-tapes during a disaster recovery unless you have backed up those files using
-the {\bf portable} option. {\bf bextract} does not run on Windows, and the
-normal way Bacula saves files using the Windows API prevents the files from
-being restored on a Unix machine. Once you have an operational Windows OS
-loaded, you can run the File daemon and restore your user files.
-
-Please see
-\ilink{ Disaster Recovery of Win32 Systems}{Win3233} for the latest
-suggestion, which looks very promising.
-
-It looks like Bart PE Builder, which creates a Windows PE (Pre-installation
-Environment) Boot-CD, may be just what is needed to build a complete disaster
-recovery system for Win32. This distribution can be found at
-\elink{http://www.nu2.nu/pebuilder/}{\url{http://www.nu2.nu/pebuilder/}}.
-
-\section{Windows Restore Problems}
-\index[general]{Problems!Windows Restore}
-\index[general]{Windows Restore Problems}
-Please see the
-\ilink{Restore Chapter}{Windows} of this manual for problems
-that you might encounter doing a restore.
-
-section{Windows Backup Problems}
-\index[general]{Problems!Windows Backup}
-\index[general]{Windows Backup Problems}
-If during a Backup, you get the message:
-{\bf ERR=Access is denied} and you are using the portable option,
-you should try both adding both the non-portable (backup API) and
-the Volume Shadow Copy options to your Director's conf file.
-
-In the Options resource:
-\footnotesize
-\begin{verbatim}
-portable = no
-\end{verbatim}
-\normalsize
-
-In the FileSet resource:
-\footnotesize
-\begin{verbatim}
-enablevss = yes
-\end{verbatim}
-\normalsize
-
-In general, specifying these two options should allow you to backup
-any file on a Windows system. However, in some cases, if users
-have allowed to have full control of their folders, even system programs
-such a Bacula can be locked out. In this case, you must identify
-which folders or files are creating the problem and do the following:
-
-\begin{enumerate}
-\item Grant ownership of the file/folder to the Administrators group,
-with the option to replace the owner on all child objects.
-\item Grant full control permissions to the Administrators group,
-and change the user's group to only have Modify permission to
-the file/folder and all child objects.
-\end{enumerate}
-
-Thanks to Georger Araujo for the above information.
-
-\section{Windows Ownership and Permissions Problems}
-\index[general]{Problems!Windows Ownership and Permissions}
-\index[general]{Windows Ownership and Permissions Problems}
-
-If you restore files backed up from WinNT/XP/2K to an alternate directory,
-Bacula may need to create some higher level directories that were not saved
-(or restored). In this case, the File daemon will create them under the SYSTEM
-account because that is the account that Bacula runs under as a service. As of
-version 1.32f-3, Bacula creates these files with full access permission.
-However, there may be cases where you have problems accessing those files even
-if you run as administrator. In principle, Microsoft supplies you with the way
-to cease the ownership of those files and thus change the permissions.
-However, a much better solution to working with and changing Win32 permissions
-is the program {\bf SetACL}, which can be found at
-\elink{http://setacl.sourceforge.net/}{\url{http://setacl.sourceforge.net/}}.
-
-If you have not installed Bacula while running as Administrator
-and if Bacula is not running as a Process with the userid (User Name) SYSTEM,
-then it is very unlikely that it will have sufficient permission to
-access all your files.
-
-Some users have experienced problems restoring files that participate in
-the Active Directory. They also report that changing the userid under which
-Bacula (bacula-fd.exe) runs, from SYSTEM to a Domain Admin userid, resolves
-the problem.
-
-
-\section{Manually resetting the Permissions}
-\index[general]{Manually resetting the Permissions}
-\index[general]{Permissions!Manually resetting the}
-
-The following solution was provided by Dan Langille \lt{}dan at langille in
-the dot org domain\gt{}. The steps are performed using Windows 2000 Server but
-they should apply to most Win32 platforms. The procedure outlines how to deal
-with a problem which arises when a restore creates a top-level new directory.
-In this example, "top-level" means something like {\bf
-c:\textbackslash{}src}, not {\bf c:\textbackslash{}tmp\textbackslash{}src}
-where {\bf c:\textbackslash{}tmp} already exists. If a restore job specifies /
-as the {\bf Where:} value, this problem will arise.
-
-The problem appears as a directory which cannot be browsed with Windows
-Explorer. The symptoms include the following message when you try to click on
-that directory:
-
-\includegraphics{\idir access-is-denied.eps}
-
-If you encounter this message, the following steps will change the permissions
-to allow full access.
-
-\begin{enumerate}
-\item right click on the top level directory (in this example, {\bf c:/src})
- and select {\bf Properties}.
-\item click on the Security tab.
-\item If the following message appears, you can ignore it, and click on {\bf
- OK}.
-
-\includegraphics{\idir view-only.eps}
-
-You should see something like this:
-
-\includegraphics{\idir properties-security.eps}
-\item click on Advanced
-\item click on the Owner tab
-\item Change the owner to something other than the current owner (which is
- {\bf SYSTEM} in this example as shown below).
-
-\includegraphics{\idir properties-security-advanced-owner.eps}
-\item ensure the "`Replace owner on subcontainers and objects"' box is
- checked
-\item click on OK
-\item When the message "`You do not have permission to read the contents of
- directory c:\textbackslash{}src\textbackslash{}basis. Do you wish to replace
- the directory permissions with permissions granting you Full Control?"', click
-on Yes.
-
-\includegraphics{\idir confirm.eps}
-\item Click on OK to close the Properties tab
- \end{enumerate}
-
-With the above procedure, you should now have full control over your restored
-directory.
-
-In addition to the above methods of changing permissions, there is a Microsoft
-program named {\bf cacls} that can perform similar functions.
-
-\section{Backing Up the WinNT/XP/2K System State}
-\index[general]{State!Backing Up the WinNT/XP/2K System}
-\index[general]{Backing Up the WinNT/XP/2K System State}
-
-A suggestion by Damian Coutts using Microsoft's NTBackup utility in
-conjunction with Bacula should permit a full restore of any damaged system
-files on Win2K/XP. His suggestion is to do an NTBackup of the critical system
-state prior to running a Bacula backup with the following command:
-
-\footnotesize
-\begin{verbatim}
-ntbackup backup systemstate /F c:\systemstate.bkf
-\end{verbatim}
-\normalsize
-
-The {\bf backup} is the command, the {\bf systemstate} says to backup only the
-system state and not all the user files, and the {\bf /F
-c:\textbackslash{}systemstate.bkf} specifies where to write the state file.
-this file must then be saved and restored by Bacula.
-
-To restore the system state, you first reload a base operating system if the
-OS is damaged, otherwise, this is not necessary, then you would use Bacula to
-restore all the damaged or lost user's files and to recover the {\bf
-c:\textbackslash{}systemstate.bkf} file. Finally if there are any damaged or
-missing system files or registry problems, you run {\bf NTBackup} and {\bf
-catalogue} the system statefile, and then select it for restore. The
-documentation says you can't run a command line restore of the systemstate.
-
-To the best of my knowledge, this has not yet been tested. If you test it,
-please report your results to the Bacula email list.
-
-\section{Considerations for Filename Specifications}
-\index[general]{Windows!Considerations for Filename Specifications}
-
-Please see the
-\ilink{Director's Configuration chapter}{win32} of this manual
-for important considerations on how to specify Windows paths in Bacula FileSet
-Include and Exclude directives.
-
-\index[general]{Unicode}
-Bacula versions prior to 1.37.28 do not support Windows Unicode filenames.
-As of that version, both {\bf bconsole} and {\bf bwx-console} support Windows
-Unicode filenames. There may still be some problems with multiple byte
-characters (e.g. Chinese, ...) where it is a two byte character but the
-displayed character is not two characters wide.
-
-\index[general]{Win32 Path Length Restriction}
-Path/filenames longer than 260 characters (up to 32,000) are supported
-beginning with Bacula version 1.39.20. Older Bacula versions support
-only 260 character path/filenames.
-
-\section{Win32 Specific File daemon Command Line}
-\index[general]{Client!Win32 Specific File daemon Command Line Options}
-\index[general]{Win32 Specific File daemon Command Line Options}
-
-These options are not normally seen or used by the user, and are documented
-here only for information purposes. At the current time, to change the default
-options, you must either manually run {\bf Bacula} or you must manually edit
-the system registry and modify the appropriate entries.
-
-In order to avoid option clashes between the options necessary for {\bf
-Bacula} to run on Windows and the standard Bacula options, all Windows
-specific options are signaled with a forward slash character (/), while as
-usual, the standard Bacula options are signaled with a minus (-), or a minus
-minus (\verb:--:). All the standard Bacula options can be used on the Windows
-version. In addition, the following Windows only options are implemented:
-
-\begin{description}
-
-\item [/service ]
- \index[fd]{/service}
- Start Bacula as a service
-
-\item [/run ]
- \index[fd]{/run}
- Run the Bacula application
-
-\item [/install ]
- \index[fd]{/install}
- Install Bacula as a service in the system registry
-
-\item [/remove ]
- \index[fd]{/remove}
- Uninstall Bacula from the system registry
-
-\item [/about ]
- \index[fd]{/about}
- Show the Bacula about dialogue box
-
-\item [/status ]
- \index[fd]{/status}
- Show the Bacula status dialogue box
-
-\item [/events ]
- \index[fd]{/events}
- Show the Bacula events dialogue box (not yet implemented)
-
-\item [/kill ]
- \index[fd]{/kill}
- Stop any running {\bf Bacula}
-
-\item [/help ]
- \index[fd]{/help}
- Show the Bacula help dialogue box
-\end{description}
-
-It is important to note that under normal circumstances the user should never
-need to use these options as they are normally handled by the system
-automatically once Bacula is installed. However, you may note these options in
-some of the .bat files that have been created for your use.
-
-\section{Shutting down Windows Systems}
-\index[general]{Shutting down Windows Systems}
-\index[general]{Systems!Shutting down Windows}
-
-Some users like to shutdown their Windows machines after a backup using a
-Client Run After Job directive. If you want to do something similar, you might
-take the shutdown program from the
-\elink{apcupsd project}{\url{http://www.apcupsd.com}} or one from the
-\elink{Sysinternals project}
-{\url{http://technet.microsoft.com/en-us/sysinternals/bb897541.aspx}}.
-
+++ /dev/null
-#
-#
-# Makefile for LaTeX
-#
-# To build everything do
-# make tex
-# make web
-# make html
-# make dvipdf
-#
-# or simply
-#
-# make
-#
-# for rapid development do:
-# make tex
-# make show
-#
-#
-# If you are having problems getting "make" to work, debugging it is
-# easier if can see the output from latex, which is normally redirected
-# to /dev/null. To see it, do the following:
-#
-# cd docs/manual
-# make tex
-# latex bacula.tex
-#
-# typically the latex command will stop indicating the error (e.g. a
-# missing \ in front of a _ or a missing { or ] ...
-#
-# The following characters must be preceded by a backslash
-# to be entered as printable characters:
-#
-# # $ % & ~ _ ^ \ { }
-#
-
-IMAGES=../../../images
-
-DOC=console
-
-first_rule: all
-
-all: tex web dvipdf mini-clean
-
-.SUFFIXES: .tex .html
-.PHONY:
-.DONTCARE:
-
-
-tex:
- @./update_version
- @echo "Making version `cat version.tex`"
- @cp -fp ${IMAGES}/hires/*.eps .
- @touch ${DOC}i-dir.tex ${DOC}i-fd.tex ${DOC}i-sd.tex \
- ${DOC}i-console.tex ${DOC}i-general.tex
- latex -interaction=batchmode ${DOC}.tex
- makeindex ${DOC}.idx -o ${DOC}.ind 2>/dev/null
- latex -interaction=batchmode ${DOC}.tex
-
-pdf:
- @echo "Making pdfm"
- @cp -fp ${IMAGES}/hires/*.eps .
- dvipdfm -p a4 ${DOC}.dvi
-
-dvipdf:
- @echo "Making dvi to pdf"
- @cp -fp ${IMAGES}/hires/*.eps .
- dvipdf ${DOC}.dvi ${DOC}.pdf
-
-html:
- @echo " "
- @echo "Making html"
- @cp -fp ${IMAGES}/*.eps .
- @rm -f next.eps next.png prev.eps prev.png up.eps up.png
- @(if [ -f imagename_translations ] ; then \
- ./translate_images.pl --from_meaningful_names ${DOC}.html; \
- fi)
- latex2html -white -no_subdir -split 0 -toc_stars -white -notransparent \
- -init_file latex2html-init.pl ${DOC} >tex.out 2>&1
- ./translate_images.pl --to_meaningful_names ${DOC}.html
- @echo "Done making html"
-
-web:
- @echo "Making web"
- @mkdir -p ${DOC}
- @cp -fp ${IMAGES}/*.eps .
- @rm -f next.eps next.png prev.eps prev.png up.eps up.png
- @cp -fp ${IMAGES}/*.eps ${DOC}/
- @cp -fp ${IMAGES}/*.eps ${IMAGES}/*.png ${DOC}/
- @rm -f ${DOC}/xp-*.png
- @rm -f ${DOC}/next.eps ${DOC}/next.png ${DOC}/prev.eps ${DOC}/prev.png ${DOC}/up.eps ${DOC}/up.png
- @rm -rf ${DOC}/*.html
- latex2html -split 3 -local_icons -t "Bacula Console and Operators Guide" -long_titles 4 \
- -toc_stars -contents_in_nav -init_file latex2html-init.pl -white -notransparent ${DOC} >tex.out 2>&1
- ./translate_images.pl --to_meaningful_names ${DOC}/Bacula_Consol*.html
- @echo "Done making web"
-show:
- xdvi ${DOC}
-
-texcheck:
- ./check_tex.pl ${DOC}.tex
-
-main_configs:
- pic2graph -density 100 <main_configs.pic >main_configs.png
-
-mini-clean:
- @rm -f 1 2 3 *.tex~
- @rm -f *.gif *.jpg *.eps
- @rm -f *.aux *.cp *.fn *.ky *.log *.pg
- @rm -f *.backup *.ilg *.lof *.lot
- @rm -f *.cdx *.cnd *.ddx *.ddn *.fdx *.fnd *.ind *.sdx *.snd
- @rm -f *.dnd *.old *.out
- @rm -f ${DOC}/*.gif ${DOC}/*.jpg ${DOC}/*.eps
- @rm -f ${DOC}/*.aux ${DOC}/*.cp ${DOC}/*.fn ${DOC}/*.ky ${DOC}/*.log ${DOC}/*.pg
- @rm -f ${DOC}/*.backup ${DOC}/*.ilg ${DOC}/*.lof ${DOC}/*.lot
- @rm -f ${DOC}/*.cdx ${DOC}/*.cnd ${DOC}/*.ddx ${DOC}/*.ddn ${DOC}/*.fdx ${DOC}/*.fnd ${DOC}/*.ind ${DOC}/*.sdx ${DOC}/*.snd
- @rm -f ${DOC}/*.dnd ${DOC}/*.old ${DOC}/*.out
- @rm -f ${DOC}/WARNINGS
-
-
-clean:
- @rm -f 1 2 3 *.tex~
- @rm -f *.png *.gif *.jpg *.eps
- @rm -f *.pdf *.aux *.cp *.fn *.ky *.log *.pg
- @rm -f *.html *.backup *.ps *.dvi *.ilg *.lof *.lot
- @rm -f *.cdx *.cnd *.ddx *.ddn *.fdx *.fnd *.ind *.sdx *.snd
- @rm -f *.dnd imagename_translations
- @rm -f *.old WARNINGS *.out *.toc *.idx
- @rm -f ${DOC}i-*.tex
- @rm -rf ${DOC}
-
-
-distclean: clean
- @rm -f images.pl labels.pl internals.pl
- @rm -f Makefile version.tex
+++ /dev/null
-%%
-%%
-
-\chapter{Die Bacula Console}
-\label{_ConsoleChapter}
-\index[general]{Console!Bacula}
-\index[general]{Bacula Console}
-\index[general]{Console!Bacula}
-\index[general]{Bacula Console}
-
-Die {\bf Bacula Console} (manchmal auch die Benutzer-Schnittstelle genannt)
-ist ein Programm, dass es dem Anwender oder System Administrator erlaubt,
-den Bacula-Director-Dienst im laufenden Betrieb zu bedienen.
-
-Momentan gibt es zwei Versionen des Console-Programms: eine Shell- (TTY)
-und eine GNOME GUI-Version. Beide erlauben es dem Administrator oder
-autorisierten Benutzern Bacula zu steuern. Sie k\"{o}nnen sich zum Beispiel
-den Status eines bestimmten Jobs oder den Inhalt des Katalogs anzeigen lassen,
-sowie bestimmte Aktionen mit Tapes und Autochangern durchf\"{u}hren.
-
-Zus\"{a}tzlich gibt es noch die bwx-Console, die auf wxWidgets aufbaut
-und eine M\"{o}glichkeit bietet, den Wiederherstellungsproze{\ss} graphisch zu steuern.
-Die bwx-Console befindet sich in einem fr\"{u}hen Entwicklungsstadium und
-wurde leider seit einiger Zeit nicht weiterentwickelt. (Trotzdem kann sie sehr hilfreich sein.)
-
-Da sich alle Bacula-Consolen \"{u}ber das Netzwerk mit dem Director-Dienst verbinden,
-ist es nicht notwendig, dass sie auf dem selben Computer laufen.
-
-Ein gewisses, minimales Grundwissen \"{u}ber die Console ist schon dann notwendig,
-wenn Bacula auf mehr als einem Tape schreiben soll. Bacula wird n\"{a}mlich nach einem
-leeren Band fragen, falls keines mehr verf\"{u}gbar ist, und erst nach dem mounten
-eines neuen Tapes mittels der Console, wird Bacula weiterarbeiten k\"{o}nnen.
-
-\section{Console Konfiguration}
-\index[general]{Console Konfiguration}
-\index[general]{Konfiguration!Console}
-\index[general]{Console Konfiguration}
-\index[general]{Konfiguration!Console}
-
-Wenn Sie die Bacula-Console starten, liest sie ihre Standard-Konfigurations-Datei
-namens {\bf bconsole.conf}, bzw. {\bf bgnome-console.conf} f\"{u}r die GNOME-Console, ein.
-Mittels der Kommandozeilen-Option {\bf {-}c} k\"{o}nnen Sie aber auch eine eigene Konfigurations-
-Datei angeben. Im einfachsten Fall enth\"{a}llt diese Datei nur den Namen und die
-Adresse des Director-Dienstes sowie das Passwort, dass f\"{u}r die Verbindung zum
-Director-Dienst ben\"{o}tigt wird. F\"{u}r weitere Informationen zu dieser Datei,
-lesen Sie bitte das Kapitel \"{u}ber die
-\ilink{Console-Konfiguration-Datei}{ConsoleConfChapter} in diesem Handbuch.
-
-\section{Benutzung des Console-Programms}
-\index[general]{Benutzung des Console-Programms}
-\index[general]{Programm!Benutzung des Console-}
-\index[general]{Benutzung des Console-Programms}
-\index[general]{Programm!Benutzung des Console-}
-
-Das Console-Programm kann mit den folgenden Optionen gestartet werden:
-\footnotesize
-\begin{verbatim}
-Usage: bconsole [-s] [-c Konfigurations-Datei] [-d Debug-Level]
- -c <Datei> gibt die zu verwendene Konfigurations-Datei an
- -dnn setzt den Debug-Level auf nn
- -n kein conio
- -s keine Signale (*)
- -t test - liest die Konfigurations-Datei und beendet sich dann
- -? gibt diese Hilfe aus.
-\end{verbatim}
-\normalsize
-
-(*) \elink{Signale}{http://de.wikipedia.org/wiki/Signal\_\%28Computer\%29}
-
-Nach dem Start des Console-Programms zeigt es durch sein Prompt (*) an,
-dass es auf Benutzereingaben wartet. (in der GNOME-Console gibt es kein Prompt,
-geben Sie die Befehle bitte einfach in der Textbox unten im Fenster ein.)
-Sie k\"{o}nnen in jeder Console einfach nur das Kommando eingeben, wenn weitere Parameter
-erforderlich sind, wird das Programm Sie danach fragen. Alternativ k\"{o}nnen Sie
-nat\"{u}rlich auch das komplette Kommando mit allen ben\"{o}tigten Parametern eingeben
-und ausf\"{u}hren. Das normale Befehlsformat ist dieses:
-
-\footnotesize
-\begin{verbatim}
- <Kommando> <Parameter1>[=<Argument1>] <Parameter2>[=<Argument2>] ...
-\end{verbatim}
-\normalsize
-
-wobei {\bf Kommando} einer der unten aufgef\"{u}hrten Console-Befehle
-und {\bf Parameter} eines der unten aufgelisteten Schl\"{u}sselw\"{o}rter ist,
-dem dann meistens ein {\bf Argument} folgt. Alle Befehle k\"{o}nnen in der
-k\"{u}rzesten eindeutigen Form eingegeben werden. Falls zwei Befehle mit identischen
-Buchstaben anfangen, wird der ausgef\"{u}hrt, der in der Ausgabe des {\bf help}-Kommandos
-am weitesten oben steht. Wenn Sie das andere Kommando ausf\"{u}hren m\"{o}chten m\"{u}ssen Sie
-dementsprechend mehr Buchstaben eingeben, um es eindeutig anzugeben. Keiner der
-Parameter darf abgek\"{u}rzt werden.
-
-Ein Beispiel:
-
-\footnotesize
-\begin{verbatim}
-list files jobid=23
-\end{verbatim}
-\normalsize
-
-zeigt alle gesicherten Dateien mit der JobID 23 an.
-
-\footnotesize
-\begin{verbatim}
-show pools
-\end{verbatim}
-\normalsize
-
-zeigt alle Pool-Konfigurations-Eintr\"{a}ge an.
-
-Die maximale L\"{a}nge der eingegebenen Befehle, mit Parametern, ist 511 Zeichen.
-Falls Sie die Console \"{u}ber ein Script ansprechen, denken Sie bitte daran,
-dass Sie dieses Limit nicht \"{u}berschreiten.
-
-\section{Beenden des Console-Programms}
-\index[general]{Programm!Beenden des Console-}
-\index[general]{Beenden des Console-Programms}
-\index[general]{Programm!Beenden des Console-}
-\index[general]{Beenden des Console-Programms}
-
-Normalerweise beenden Sie das Console-Programm durch die Eingabe von {\bf quit} oder {\bf exit}.
-Allerdings wartet die Console bis der Director-Dienst das Kommando best\"{a}tigt. Wenn der
-Director bereits ein l\"{a}nger laufendes Kommando ausf\"{u}hrt, kann es sein, dass das Beenden
-der Console einen Moment dauert. Falls Sie die Console sofort verlassen wollen, k\"{o}nnen Sie
-in dem Fall das Kommando {\bf .quit} verwenden.
-
-Momentan gibt es keinen Weg ein laufendes Kommando nach dem Starten abzubrechen (z.B. mit STRG+C).
-Allerdings k\"{o}nnen Sie jederzeit, wenn die Console Sie nach einer weiteren Eingabe fragt,
-das aktuelle Kommando beenden, indem Sie einen Punkt {\bf .} eingeben. Nach der Eingabe des Punktes,
-werden Sie automatisch zum Hauptprompt oder bei verschachtelten Abfragen zum passenden letzten Prompt
-zur\"{u}ckgeleitet. Bei einigen Eingaben, wie zum Beispiel der Frage nach einem Volume-Namen, wird
-der Punkt als Eingabe gewertet und Sie haben beim n\"{a}chsten Prompt die M\"{o}glichkeit,
-das Kommando abzubrechen.
-
-\label{keywords}
-\section{Alphabetische Liste der Console-Schl\"{u}sselw\"{o}rter}
-\index[general]{Schl\"{u}sselw\"{o}rter!Alphabetische Liste der Console}
-\index[general]{Alphabetische Liste der Console-Schl\"{u}sselw\"{o}rter}
-\index[general]{Schl\"{u}sselw\"{o}rter!Alphabetische Liste der Console}
-\index[general]{Alphabetische Liste der Console-Schl\"{u}sselw\"{o}rter}
-Wenn es nicht anders angegeben ist, ben\"{o}tigt jedes der folgenden Schl\"{u}sselw\"{o}rter
-(Parameter der Console-Befehle) ein Argument, welches dem Schl\"{u}sselwort,
-getrennt durch ein Gleichheitszeichen, folgt.
-Ein Beispiel:
-\begin{verbatim}
-jobid=536
-\end{verbatim}
-
-Bitte beachten Sie, dass diese Liste durch die st\"{a}ndig weitergehende
-Entwicklung eventuell weder komplett, noch in der richtigen alphabetischen
-Reihenfolge sein kann.
-
-\begin{description}
-\item [all]
- Parameter des status und show-Kommandos,
- dadurch werden alle Komponenten oder Eintr\"{a}ge ausgew\"{a}hlt
-\item [allfrompool]
- Parameter des update-Kommandos,
- gibt an das alle Volumes des (im Parameter pool angegebenen) Pools
- aktualisiert werden sollen.
-\item [allfrompools]
- Parameter des update-Kommandos,
- gibt an das alle Volumes aller Pools aktualisiert werden sollen.
-\item [before]
- Parameter des restore-Kommandos.
-\item [bootstrap]
- Parameter des restore-Kommandos.
-\item [catalog]
- im use-Kommando erlaubt,
- um den zu benutzenden Katalog auszuw\"{a}hlen
-\item [catalogs]
- Parameter des show-Kommandos.
- Ben\"{o}tigt keine Argumente.
-\item [client | fd]
-\item [clients]
- Parameter des show, list und llist-Kommandos,
- bezeichnet alle Clients. Ben\"{o}tigt keine Argumente.
-\item [counters]
- im show-Kommando erlaubt.
- Ben\"{o}tigt keine Argumente.
-\item [current]
- Parameter des restore-Kommandos.
- Ben\"{o}tigt keine Argumente.
-\item [days]
- definiert die Anzahl der Tage, die das "`list nextvol"'-Kommando
- in Betracht ziehen soll. Der Parameter days kann auch im Kommando
- "`status director"' verwendet werden, um die geplanten Jobs f\"{u}r die
- angegebene Anzahl Tage zu zeigen.
-\item [devices]
- Parameter des show-Kommandos.
- Ben\"{o}tigt keine Argumente.
-\item [director | dir]
-\item [directors]
- Parameter des show-Kommandos.
- Ben\"{o}tigt keine Argumente.
-\item [directory]
- Parameter des restore-Kommandos.
- Das Argument gibt das wiederherzustellende Verzeichnis an.
-\item [enabled]
- Dieser Parameter kann bei den Kommandos "`update volumes"' und "`update slots"'
- verwendet werden. Das Argument kann yes, true, no, false, archived, 0,1 oder 2 sein.
- 0 ist identisch mit no oder false, 1 mit yes oder true und 2 mit archived.
- Archived Volumes werden weder benutzt noch automatisch aus dem Katalog gel\"{o}scht.
- Volumes die nicht enabled sind, werden nicht f\"{u}r das Backup oder die Wiederherstellung benutzt.
-\item [done]
- wird im restore-Kommando benutzt.
- Ben\"{o}tigt keine Argumente.
-\item [file]
- Parameter des restore-Kommandos.
-\item [files]
- Parameter des list und llist-Kommandos.
- Ben\"{o}tigt keine Argumente.
-\item [fileset]
-\item [filesets]
- Parameter des show-Kommandos.
- Ben\"{o}tigt keine Argumente.
-\item [help]
- Parameter des show-Kommandos.
- Ben\"{o}tigt keine Argumente.
-\item [jobs]
- Parameter des show, list und llist-Kommandos.
- Ben\"{o}tigt keine Argumente.
-\item [jobmedia]
- Parameter des list und llist-Kommandos.
- Ben\"{o}tigt keine Argumente.
-\item [jobtotals]
- Parameter des list und llist-Kommandos.
- Ben\"{o}tigt keine Argumente.
-\item [jobid]
- Parameter des list und llist-Kommandos.
- Die jobid ist die numerische Jobid, die im Job-Report angezeigt wird.
- Sie ist der Index f\"{u}r die Datenbankeintr\"{a}ge des entsprechenden Jobs.
- Da sie f\"{u}r alle in der Datenbank existierenden Jobs einzigartig ist,
- kann sie erst wiederverwendet werden, wenn der vorherige Job mit dieser Jobid
- aus der Datenbank gel\"{o}scht wurde.
-\item [job | jobname]
- Parameter des list und llist-Kommandos.
- Der Job oder JobName entspricht dem Namen den Sie im Job-Eintr\"{a}g
- angegeben haben, somit bezieht er sich auf alle Jobs dieses Namens,
- die jemals gelaufen sind und deren Eintr\"{a}ge noch im Katalog existieren.
-\item [level]
-\item [listing]
- Parameter des estimate-Kommandos.
- Ben\"{o}tigt keine Argumente.
-\item [limit]
-\item [messages]
- Parameter des show-Kommandos.
- Ben\"{o}tigt keine Argumente.
-\item [media]
- Parameter des list und llist-Kommandos.
- Ben\"{o}tigt keine Argumente.
-\item [nextvol | nextvolume]
- Parameter des list und llist-Kommandos.
- Ben\"{o}tigt keine Argumente.
-\item [on]
- Ben\"{o}tigt keine Argumente.
-\item [off]
- Ben\"{o}tigt keine Argumente.
-\item [pool]
-\item [pools]
- Parameter des show, list und llist-Kommandos.
- Ben\"{o}tigt keine Argumente.
-\item [restart]
- Parameter des python-Kommandos,
- dadurch wird der python-Interpreter neu gestartet. Ben\"{o}tigt keine Argumente.
-\item [select]
- Parameter des restore-Kommandos.
- Ben\"{o}tigt keine Argumente.
-\item [storages]
- Parameter des show-Kommandos.
- Ben\"{o}tigt keine Argumente.
-\item [schedules]
- Parameter des show-Kommandos.
- Ben\"{o}tigt keine Argumente.
-\item [sd | store | storage]
-\item [ujobid]
- Parameter des list-Kommandos.
- Die ujobid ist eine M\"{o}glichkeit einen Job eindeutig zu identifizieren.
- Momentan besteht die ujobid aus dem JobNamen und der Uhrzeit wann der Job gelaufen ist.
-\item [volume]
-\item [volumes]
- Parameter des list und llist-Kommandos.
- Ben\"{o}tigt keine Argumente.
-\item [where]
- Parameter des restore-Kommandos.
-\item [yes]
- Parameter des restore-Kommandos.
- Ben\"{o}tigt keine Argumente.
-\end{description}
-
-\label{list}
-\section{Alphabetische Liste der Console-Kommandos}
-\index[general]{Kommandos!Alphabetische Liste der Console-}
-\index[general]{Alphabetische Liste der Console-Kommandos}
-\index[general]{Kommandos!Alphabetische Liste der Console-}
-\index[general]{Alphabetische Liste der Console-Kommandos}
-
-Die folgenden Kommandos sind derzeit verf\"{u}gbar:
-
-\begin{description}
-\item [{add [pool=\lt{}pool-name\gt{} storage=\lt{}storage\gt{}
- jobid=\lt{}JobId\gt{}]} ]
- \index[general]{add}
- Das add-Kommando wird benutzt um Volumes zu einem bestehenden Pool
- hinzuzuf\"{u}gen. Dabei wird der Volume-Eintrag in der Datenbank erzeugt
- und das Volume dem Pool zugeordnet. Allerdings erfolgt kein physikalischer Zugriff
- auf das Volume. Nach dem hinzuf\"{u}gen zu einem Pool geht Bacula davon
- aus, dass das Volume wirklich existiert und auch bereits gelabelt ist.
- Dieses Kommando wird normalerweise nicht benutzt, da Bacula die Volumes
- automatisch beim labeln einem Pool hinzuf\"{u}gt. Allerdings ist es hilfreich,
- falls Sie ein Volume aus dem Katalog gel\"{o}scht haben und es sp\"{a}ter wieder
- hinzuf\"{u}gen wollen.
-
- Typischerweise wird das label-Kommando anstelle des add-Kommandos benutzt, da
- es au{\ss}er dem labeln des physikalischen Volumes, die identischen Schritte
- wie das add-Kommando ausf\"{u}hrt. Das add-Kommando \"{a}ndert nur die Katalog-Eintr\"{a}ge
- und nicht die physikalischen Volumes. Die physikalischen Volumes m\"{u}ssen
- vorhanden und gelabelt sein (normalerweise mit dem label-Kommando). Trotzdem
- kann das add-Kommando sinnvoll sein, wenn Sie zum Beispiel eine bestimmte Anzahl
- von Volumes einem Pool hinzuf\"{u}gen wollen, wobei die Volumes erst zu einem
- sp\"{a}teren Zeitpunkt gelabelt werden. Auch um ein Volume eines anderen Bacula-Systems
- (bzw. anderen Director-Dienstes) zu importieren, kann das add-Kommando benutzt werden.
- Die erlaubten Zeichen f\"{u}r einen Volume-Namen finden Sie weiter unten
- in der Beschreibung des label-Kommandos.
-
-\item [autodisplay on/off]
- \index[general]{autodisplay on/off}
- Das autodisplay-Kommando kennt zwei Parameter: {\bf on} und {\bf off},
- wodurch die automatische Anzeige von Nachrichten in der Console entsprechend
- ein- oder ausgeschaltet wird. Der Standardwert ist {\bf off}, was bedeutet, dass
- Sie \"{u}ber neue Meldungen benachrichtigt werden, sie aber nicht automatisch
- angezeigt werden. In der GNOME-Console ist das automatische Anzeigen dagegen
- standardm\"{a}{\ss}ig aktiviert, d.h. neue Meldungen werden automatisch
- ausgegeben, wenn sie vom Director-Dienst empfangen wurden (typischerweise innerhalb von
- ca. 5 Sekunden nachdem sie generiert wurden).
-
- Wenn autodisplay auf off steht, m\"{u}ssen Sie neue Nachrichten mit dem
- {\bf messages}-Kommando abrufen, um sie sich anzeigen zu lassen.
- Wenn autodisplay auf on steht, werden die Nachrichten angezeigt, sobald die Console sie
- empfangen hat.
-
-\item [automount on/off]
- \index[general]{automount on/off}
- Das automount-Kommando kennt zwei Parameter: {\bf on} und {\bf off},
- die entsprechend das automatische mounten nach dem labeln ({\bf label}-Kommando)
- an- oder ausschalten. Der Standardwert ist on. Wenn automount ausgeschaltet ist,
- m\"{u}ssen Sie nach dem labeln eines Volumes dieses explizit mounten ({\bf mount}-Kommando),
- um es benutzen zu k\"{o}nnen.
-
-\item [{cancel [jobid=\lt{}number\gt{} job=\lt{}job-name\gt{} ujobid=\lt{}unique-jobid\gt{}]}]
- \index[general]{cancel jobid}
- Das cancel-Kommando wird benutzt um einen Job abzubrechen und kennt die
- Parameter {\bf jobid=nnn} oder {\bf job=xxx}, wobei jobid die numerische JobID ist
- und job der Job-Name. Wenn Sie weder job noch jobid angeben, listet die Console
- alle in Frage kommenden Jobs auf und erlaubt Ihnen aus dieser Liste den abzubrechenden
- Job auszuw\"{a}hlen.
-
- Wenn ein Job als abzubrechen gekennzeichnet wurde, kann es einige Zeit dauern,
- bis er tats\"{a}chlich beendet wird (normalerweise innerhalb einer Minute).
- Diese Zeit ist aber abh\"{a}ngig davon, was der Job gerade tut.
-
-\item [{create [pool=\lt{}pool-name\gt{}]}]
- \index[general]{create pool}
- Das create-Kommando wird normalerweise nicht benutzt, da die Pool-Eintr\"{a}ge
- im Katalog automatisch angelegt werden, wenn der Director-Dienst startet und
- er seine Pool-Konfiguration aus den Konfigurations-Dateien einliest. Falls ben\"{o}tigt,
- kann mit diesem Kommando ein Pool-Eintrag in der Katalog-Datenbank erstellt werden,
- der auf einem Pool-Konfigurations-Eintrag basiert, der in der Director-Dienst-Konfiguration
- enthalten ist. Einfach gesagt \"{u}bernimmt dieses Kommando nur den Pool-Eintrag aus der
- Konfiguration in die Datenbank. Normalerweise wird diese Kommando automatisch ausgef\"{u}hrt,
- wenn der Pool zum ersten mal in einem Job-Eintrag benutzt wird. Wenn Sie dieses Kommando
- auf einem bestehenden Pool ausf\"{u}hren, wird der Katalog sofort aktualisiert und enth\"{a}lt
- dann die identische Pool-Konfiguration, wie die Konfigurations-Dateien. Nach dem Erstellen
- eines Pool in den Konfigurations-Dateien werden Sie allerdings h\"{o}chstwahrscheinlich
- das {\bf label}-Kommando benutzen, um ein oder mehrere Volumes dem neuen Pool hinzuzuf\"{u}gen
- und die entsprechenden Eintr\"{a}ge im Katalog zu erzeugen, anstatt des create-Kommandos.
-
- Wenn ein Job gestartet wird und Bacula bemerkt,
- dass kein passender Pool-Eintrag im Katalog vorhanden ist,
- aber in den Konfigurations-Dateien, dann wird der Pool im Katalog automatisch angelegt.
- Wenn Sie m\"{o}chten, dass der Pool-Eintrag sofort (ohne das ein Job mit diesem Pool gestartet wurde)
- im Katalog erscheint, k\"{o}nnen Sie einfach diese Kommando ausf\"{u}hren, um diesen Vorgang
- zu erzwingen.
-
-\item [{delete [volume=\lt{}vol-name\gt{} pool=\lt{}pool-name\gt{} job
- jobid=\lt{}id\gt{}]}]
- \index[general]{delete}
- Das delete-Kommando wird benutzt um ein Volume, einen Pool oder einen Job-Eintrag,
- sowie jeweils alle dazugeh\"{o}rigen Datenbank-Eintr\"{a}ge, aus dem Katalog zu
- entfernen. Das Kommando \"{a}ndert nur die Katalog-Datenbank, es hat keine
- Auswirkungen auf die Konfigurations-Dateien oder die Daten auf den Volumes.
- Wir empfehlen Ihnen dieses Kommando nur zu benutzen, wenn Sie wirklich wissen was Sie tun.
-
- Wenn der Parameter {\bf Volume} angegeben wird, wird das entsprechende Volume aus dem Katalog
- gel\"{o}scht, wenn ein {\bf Pool} angeben wird, der entsprechende Pool und bei Angabe des Parameters
- {\bf Job} der entsprechende Job, sowie alle zu diesem Job geh\"{o}hrenden JobMedia- und
- Datei-Eintr\"{a}ge.
- Das delete-Kommando kann folgenderma{\ss}en aufgerufen werden:
-
-\begin{verbatim}
-delete pool=<pool-name> oder
-\end{verbatim}
-
-\begin{verbatim}
-delete volume=<volume-name> pool=<pool-name> oder
-\end{verbatim}
-
-\begin{verbatim}
-delete JobId=<job-id> JobId=<job-id2> ... oder
-\end{verbatim}
-
-\begin{verbatim}
-delete Job JobId=n,m,o-r,t ...
-\end{verbatim}
-
- Das erste Beispiel l\"{o}scht einen Pool-Eintrag aus der Katalog-Datenbank.
- Das zweite l\"{o}scht einen Volume-Eintrag aus dem angegebenen Pool
- und das dritte Beispiel l\"{o}scht die genannten JobID-Eintr\"{a}ge aus
- dem Katalog. Es werden die JobIDs n, m, o, p, q, r und t gel\"{o}scht,
- wobei die JobID's n, m, o ... nat\"{u}rlich Zahlen entsprechen m\"{u}ssen.
- Wie Sie sehen, kann das delete-Kommando Listen von JobIDs und auch Bereiche
- (z.B. o-r) verarbeiten.
-
-\item [disable job\lt{}job-name\gt{}]
- \index[general]{disable}
- Das disable-Kommando erlaubt es Ihnen zu verhindern, dass ein Job
- automatisch durch den Director-Dienst ausgef\"{u}hrt wird. Wenn Sie den Director-Dienst
- neu starten, wird der Status des Jobs wieder auf den Wert gesetzt, der
- im Job-Eintrag der Director-Konfiguration eingetragen ist.
-
-\item [enable job\lt{}job-name\gt{}]
- \index[general]{enable}
- Das enable-Kommando erlaubt es Ihnen, einen Job der durch das
- disable-Kommando aus der automatischen Job-Planung entfernt wurde,
- wieder zu aktivieren. Wenn Sie den Director-Dienst neu starten,
- wird der Status des Jobs wieder auf den Wert gesetzt, der im
- Job-Eintrag der Director-Konfiguration eingetragen ist.
-
-\label{estimate}
-\item [estimate]
- \index[general]{estimate}
- Mit dem estimate-Kommando k\"{o}nnen Sie sich anzeigen lassen, welche
- Dateien durch einen bestimmten Job gesichert werden, ohne diesen Job
- ausf\"{u}hren zu m\"{u}ssen. Standardm\"{a}{\ss}ig wird dabei ein Voll-Backup
- angenommen. Sie k\"{o}nnen das aber durch den Parameter level entsprechend anpassen,
- indem Sie zum Beispiel {\bf level=Incremental} oder {\bf level=Differential} an das
- estimate-Kommando mit \"{u}bergeben. Wenn Sie im Aufruf des Kommandos keinen Job-Name
- angegeben, wird die Console Ihnen eine Auswahlliste der m\"{o}glichen Jobs anzeigen.
- Zus\"{a}tzlich k\"{o}nnen Sie noch die Parameter Client und FileSet angeben. Nach dem
- Starten des Kommandos wird der Director-Dienst den Client kontaktieren, der daraufhin
- eine Liste der zu sichernden Dateien mit ihrer Gr\"{o}{\ss}e zur\"{u}ckgibt. Bitte beachten
- Sie, dass das estimate-Kommando nur die Anzahl der von der Datei belegten Bl\"{o}cke zur
- Bestimmung der Dateigr\"{o}{\ss}e einbezieht, so dass die Datenmenge, die das estimate-Kommando
- anzeigt, immer etwas gr\"{o}{\ss}er sein wird als das echte Backup.
-
- Wahlweise k\"{o}nnen Sie noch den Parameter {\bf listing} mit \"{u}bergeben,
- dann wird eine Liste aller zu sichernden Dateien ausgegeben. Abh\"{a}ngig vom FileSet
- kann diese Liste sehr lang sein und es daher einige Zeit dauern, alle Dateien anzuzeigen.
- Das estimate-Kommando kann folgenderma{\ss}en aufgerufen werden:
-
-
-\begin{verbatim}
-estimate job=<job-name> listing client=<client-name>
- fileset=<fileset-name> level=<level-name>
-\end{verbatim}
-
- die Angabe des Jobs ist ausreichend, aber Sie k\"{o}nnen durch Angabe
- des Clients, FileSets und/oder des Backup-Levels die entsprechenden Werte \"{u}berschreiben.
-
-Zum Beispiel k\"{o}nnen Sie folgendes eingeben:
-
-\footnotesize
-\begin{verbatim}
- @output /tmp/listing
- estimate job=NightlySave listing level=Incremental
- @output
-\end{verbatim}
-\normalsize
-
- durch das erste Kommando wird die Ausgabe der Console in die Datei
- {\bf /tmp/listing} umgeleitet. Dann wird durch das estimate-Kommando
- eine Liste aller Dateien erstellt, die beim n\"{a}chsten inkrementellen
- Backup des Jobs {\bf NightlySave} gesichert werden. Die Console gibt dabei keine
- Meldungen aus, da die Ausgabe ja auf die Datei /tmp/listing zeigt. Durch
- das dritte Kommando @output wird die Umleitung der Ausgabe wieder aufgehoben.
- Beachten Sie bitte, dass die angezeigten Bytes in der Ausgabe des estimate-Kommandos
- \"{u}ber die Angabe der Dateigr\"{o}{\ss}e im Verzeichnis-Eintrag bestimmt wird.
- Das kann zu gro{\ss}en Abweichungen bei der ermittelten Backup-Gr\"{o}{\ss}e f\"{u}hren,
- falls im FileSet \elink{sparse}{http://de.wikipedia.org/wiki/Sparse-Datei}-Dateien
- vorhanden sind. sparse-Dateien finden sich oft auf 64-Bit-Maschinen, wo sie f\"{u}r
- bestimmte Systemdateien benutzt werden. Die angezeigten Bytes sind die Gesammtgr\"{o}{\ss}e
- der gesicherten Dateien, wenn die FileSet-Option "`sparse"' nicht gesetzt ist.
- Momentan gibt es keinen Weg, um mit dem estimate-Kommando die echte Backup-Gr\"{o}{\ss}e
- f\"{u}r ein FileSet anzuzeigen, bei dem die sparse-Option gesetzt ist.
-
-\item [exit]
- \index[general]{exit}
- Das exit-Kommando beendet die Console.
-
-+\item [gui]
- \index[general]{gui}
- Aktiviert den nicht-interaktiven GUI-Modus.
-\begin{verbatim}
-gui [on|off]
-\end{verbatim}
-
-\item [help]
- \index[general]{help}
- Das help-Kommando zeigt alle verf\"{u}gbaren Kommandos mit einer kurzen Beschreibung an.
-
-\item [label]
- \index[general]{label}
- \index[general]{relabel}
- \index[general]{label}
- \index[general]{relabel}
- Das label-Kommando wird benutzt um physikalische Volumes zu labeln.
- Das label-Kommando kann folgenderma{\ss}en aufgerufen werden:
-
-\begin{verbatim}
-label storage=<storage-name> volume=<volume-name> slot=<slot>
-\end{verbatim}
-
- Wenn Sie einen der Parameter storage, volume oder slot nicht angeben,
- werden Sie von der Console danach gefragt. Der Media-Typ wird automatisch
- anhand des Storage-Eintrags in der Director-Konfiguration gesetzt.
- Wenn alle ben\"{o}tigten Informationen vorliegen, kontaktiert die
- Console den angegebenen Storage-Dienst und sendet das label-Kommando.
- Wenn das labeln erfolgreich war, wird ein entsprechender Volume-Eintrag
- im passenden Pool erzeugt.
-
- Im Volume-Name d\"{u}rfen Buchstaben, Zahlen und folgende Sonderzeichen
- verwendet werden: Binde- ({\bf -}) und Unterstrich ({\bf \_}),
- Doppelpunkt ({\bf :}) und Punkt ({\bf .}). Alle anderen Zeichen,
- einschlie{\ss}lich des Leerzeichens, sind nicht erlaubt.
- Durch diese Einschr\"{a}nkung soll sichergestellt werden, dass
- die Volume-Namen gut lesbar sind und es nicht zu Benutzerfehlern
- aufgrund von Sonderzeichen im Namen kommt.
-
- Bitte beachten Sie, dass Bacula einen Ein-/Ausgabefehler meldet,
- wenn ein neues bzw. komplett leeres Volume gelabelt wird. Bacula
- versucht den ersten Block des Volumes zu lesen, um ein eventuell schon
- vorhandenes label nicht zu \"{u}berschreiben, dieser Versuch erzeugt
- den oben genannten Fehler. Um diesen Fehler zu vermeiden, k\"{o}nnen Sie
- mit den folgenden Shell-Kommandos ein EOF am den Anfang des Volumes schreiben:
-
-\footnotesize
-\begin{verbatim}
- mt rewind
- mt weof
-\end{verbatim}
-\normalsize
-
-Das label-Kommando kann aufgrund verschiedener Gr\"{u}nde fehlschlagen:
-
-\begin{enumerate}
-\item Der angegebene Volume-Name existiert schon in der Katalog-Datenbank
-
-\item Der Storage-Dienst hat schon ein Tape oder anderes Volume in dem
- ben\"{o}tigten Ger\"{a}t gemountet. In diesem Fall m\"{u}ssen Sie
- das Ger\"{a}t erst mit dem {\bf unmount}-Kommando freigeben und dann
- ein leeres Volume zum labeln einlegen.
-
-\item Das Volume ist bereits gelabelt. Bacula wird niemals ein bestehendes label
- \"{u}berschreiben, solange das Volume nicht abgelaufen ist und Sie das
- {\bf relabel}-Kommando verwenden.
-
-\item Es ist kein Volume im Ger\"{a}t.
-\end{enumerate}
-
-Es gibt zwei M\"{o}glichkeiten ein bestehendes Bacula-label zu \"{u}berschreiben.
-Die brutale Methode ist es, einfach ein EOF an den Anfang des Volumes zu schreiben
-(dabei wird das bestehende label durch das EOF \"{u}berschrieben).
-Mit dem Programm {\bf mt} k\"{o}nnen Sie das zum Beispiel so tun:
-
-\footnotesize
-\begin{verbatim}
- [user@host]$ mt -f /dev/st0 rewind
- [user@host]$ mt -f /dev/st0 weof
-\end{verbatim}
-\normalsize
-
-Ein Festplatten-Volume k\"{o}nnen Sie auch manuell l\"{o}schen.
-
-Danach benutzten Sie das label-Kommando, um ein neues label zu erzeugen.
-Allerdings kann diese Vorgehensweise Spuren des alten Volumes in der
-Katalog-Datenbank hinterlassen.
-
-Die bevorzugte Methode ein Volume neu zu labeln sollte es sein,
-zuerst das Volume als bereinigt (purged) zu markieren. Das passiert entweder automatisch,
-wenn die Aufbewahrungszeit (Volume-Retention) f\"{u}r das Volume abl\"{a}uft,
-oder kann aber auch mit dem {\bf purge}-Kommando erzwungen werden.
-Danach k\"{o}nnen Sie das {\bf relabel}-Kommando, wie weiter unten beschrieben, verwenden.
-
-Falls Ihr Autochanger Barcode-Labels unterst\"{u}tzt, k\"{o}nnen Sie
-alle Volumes im Autochanger, eins nach dem anderen, mit dem Kommando
-{\bf label barcodes} labeln. Dabei wird jedes Tape mit Barcode nacheinander
-im Laufwerk gemountet und mit der auf dem Barcode enthaltenen Zeichenfolge
-als Namen gelabelt. Ein entsprechender Katalog-Eintrag wird automatisch
-mit erzeugt. Jedes Volume mit einem Barcode der mit den Zeichen beginnt,
-die im Pool-Eintrag als CleaningPrefix konfiguriert sind, wird wie ein
-Reinigungsband behandelt und nicht gelabelt. Allerdings wird dabei auch
-ein Katalog-Eintrag f\"{u}r das Reinigungsband erstellt.
-
-Als Beispiel, mit dem Eintrag:
-\footnotesize
-\begin{verbatim}
- Pool {
- Name ...
- Cleaning Prefix = "CLN"
- }
-\end{verbatim}
-\normalsize
-
-wird jedes Tape, dessen Barcode mit CLN beginnt, als Reinigungsband betrachtet
-und nicht automatisch gemountet.
-Das label-Kommando kann folgenderma{\ss}en aufgerufen werden:
-
-\footnotesize
-\begin{verbatim}
-label storage=xxx pool=yyy slots=1-5,10 barcodes
-\end{verbatim}
-\normalsize
-
-\item [list]
- \index[general]{list}
- Das list-Kommando zeigt den angegebenen Inhalt der Katalog-Datenbank an.
- Die verschiedenen Felder jedes Eintrags werden in einer Zeile ausgegeben.
- Die verschiedenen M\"{o}glichkeiten sind:
-\footnotesize
-\begin{verbatim}
- list jobs
-
- list jobid=<id> (zeigt jobid <id> an)
-
- list ujobid=<unique job name> (zeigt den job mit dem Namen <unique job name> an)
-
- list job=<job-name> (zeigt alle Jobs mit dem Namen <job-name> an)
-
- list jobname=<job-name> (identisch mit dem oberen)
-
- Im oberen Beispiel kann auch den Parameter limit=nn angegeben
- werden, um die Ausgabe des Kommandos auf nn Jobs zu begrenzen
-
- list jobmedia
-
- list jobmedia jobid=<id>
-
- list jobmedia job=<job-name>
-
- list files jobid=<id>
-
- list files job=<job-name>
-
- list pools
-
- list clients
-
- list jobtotals
-
- list volumes
-
- list volumes jobid=<id>
-
- list volumes pool=<pool-name>
-
- list volumes job=<job-name>
-
- list volume=<volume-name>
-
- list nextvolume job=<job-name>
-
- list nextvol job=<job-name>
-
- list nextvol job=<job-name> days=nnn
-
-\end{verbatim}
-\normalsize
-
- Die meisten der oben genannten Parameter sollten selbsterkl\"{a}rend sein.
- \"{U}blicherweise werden Sie, falls Sie nicht gen\"{u}gend Parameter angeben,
- von der Console nach den fehlenden Informationen gefragt.
-
- Das {\bf list nextvol}-Kommando gibt den Volume-Namen aus, der von dem angegebenen Job
- beim n\"{a}chsten Backup benutzt werden wird. Allerdings sollten Sie beachten, dass
- das tats\"{a}chlich benutzte Volume von einer Reihe von Faktoren, wie zum Beispiel
- von den vorher laufenden Jobs oder der Zeit, wann der Job l\"{a}uft, abh\"{a}ngen kann.
- Eventuell wird ein Tape schon voll sein, das aber noch freien Platz hatte, als Sie
- das Kommando ausf\"{u}hrten. Dieses Kommando gibt Ihnen also nur einen Hinweis darauf,
- welches Tape benutzt werden k\"{o}nnte, aber es kann keine definitive Aussage dar\"{u}ber treffen.
- Zus\"{a}tzlich kann dieses Kommando mehrere Seiteneffekte haben, da es den selben
- Algorithmus durchl\"{a}uft, wie ein echter Backup-Job. Das bedeutet, dass es dazu f\"{u}hren kann,
- dass aufgrund dieses Kommandos Volumes automatisch recycled oder gel\"{o}scht (purged) werden.
- Standardm\"{a}{\ss}ig muss der angegebene Job innerhalb der n\"{a}chsten zwei Tage laufen,
- ansonsten wird kein Volume f\"{u}r den Job gefunden. Allerdings k\"{o}nnen Sie durch
- Angabe des Parameters
- {\bf days=nnn} bis zu 50 Tage in die Zukunft angeben, die das Kommando in die Berechnung
- mit einbeziehen soll. Falls Sie, zum Beispiel, Freitags sehen wollen, welches Volume am Montag
- voraussichtlich benutzt wird, k\"{o}nnen Sie folgendes Kommando benutzen:
- {\bf list nextvol job=MyJob days=3}.
-
- Wenn Sie bestimmte, von Ihnen \"{o}fter ben\"{o}tigte, eigene Kommandos anlegen wollen
- um sich bestimmte Inhalte der Katalog-Datenbank anzeigen zu lassen,
- k\"{o}nnen Sie diese der Datei {\bf query.sql} hinzu\"{u}gen. Allerdings
- erfordert das einiges an Wissen \"{u}ber SQL-Kommandos. Lesen Sie dazu bitte
- den Abschnitt \"{u}ber das {\bf query}-Kommando in diesem Kapitel.
-
- Weiter unten finden Sie auch eine Beispiel-Ausgabe des {\bf llist}-Kommandos,
- das Ihnen den kompletten Inhalt des Katalogs zu einem bestimmten Konfigurations-Eintrag
- anzeigt.
-
- Als ein Beispiel, kann Ihnen der Aufruf des Kommandos {\bf list pools} die folgenden
- Ausgaben anzeigen:
-
-\footnotesize
-\begin{verbatim}
-+------+---------+---------+---------+----------+-------------+
-| PoId | Name | NumVols | MaxVols | PoolType | LabelFormat |
-+------+---------+---------+---------+----------+-------------+
-| 1 | Default | 0 | 0 | Backup | * |
-| 2 | Recycle | 0 | 8 | Backup | File |
-+------+---------+---------+---------+----------+-------------+
-\end{verbatim}
-\normalsize
-
- Wie oben schon angedeutet, zeigt das {\bf list}-Kommando den Inhalt
- der Katalog-Datenbank an. Einige Konfigurations-Eintr\"{a}ge, bzw.
- \"{A}nderungen an den Konfigurations-Eintr\"{a}gen, werden beim
- Start des Director-Dienstes in die Datenbank geschrieben.
- Die meisten Einstellungen und \"{A}nderungen werden hingegen
- erst im Katalog aktualisiert, wenn sie zum ersten Mal
- benutzt werden, so zum Beispiel die Client- und Job-Eintr\"{a}ge.
-
- Bacula erzeugt den Client-Eintrag also dann, wenn zum ersten Mal
- ein Job f\"{u}r diesen Client startet. Durch das {\bf status}-Kommando
- wird die Katalog-Datenbank nicht aktualisiert, auch wenn Sie dort
- eventuell schon einen Eintrag f\"{u}r den neuen Client in der Liste der
- geplanten Jobs sehen. Der Client-Eintrag wird auf alle F\"{a}lle
- beim starten des ersten Jobs des Clients erzeugt, egal ob der Job
- erfolgreich lief oder nicht. Zus\"{a}tzlich schreibt der Director-Dienst
- noch eine weitere Client-Information in die Katalog-Datenbank (die Ausgabe
- von "`uname -a"').
-
- Wenn Sie alle verf\"{u}gbaren Client-Eintr\"{a}ge der Datenbank (auch aus mehreren
- Katalog-Datenbanken, falls konfiguriert) sehen wollen,
- k\"{o}nnen Sie auch das {\bf show clients}-Kommando verwenden, das zudem
- noch Informationen \"{u}ber die Adresse, den Port und den Katalog-Namen des Clients
- (sowie einige andere) ausgibt.
-
-\item [llist]
- \index[general]{llist}
- Das llist-Kommando ("`langes list"') benutzt dieselben Parameter wie das oben
- beschriebene list-Kommando. Der Unterschied ist, dass das llist-Kommando
- den kompletten Inhalt der Katalog-Datenbank, zu der als Parameter angegebenen
- Konfiguration, anzeigt. Dabei werden die einzelnen Felder der Datenbank-Eintr\"{a}ge
- untereinander, mit einem Feld pro Zeile, ausgegeben. Diese Kommando kann eine
- sehr lange Liste an Ausgaben produzieren.
-
- Wenn Sie anstelle des {\bf list pools}, wie im oberen Beispiel, das
- Kommando {\bf llist pools} verwenden, erhalten Sie diese Ausgabe:
-
-\footnotesize
-\begin{verbatim}
- PoolId: 1
- Name: Default
- NumVols: 0
- MaxVols: 0
- UseOnce: 0
- UseCatalog: 1
- AcceptAnyVolume: 1
- VolRetention: 1,296,000
- VolUseDuration: 86,400
- MaxVolJobs: 0
- MaxVolBytes: 0
- AutoPrune: 0
- Recycle: 1
- PoolType: Backup
- LabelFormat: *
-
- PoolId: 2
- Name: Recycle
- NumVols: 0
- MaxVols: 8
- UseOnce: 0
- UseCatalog: 1
- AcceptAnyVolume: 1
- VolRetention: 3,600
- VolUseDuration: 3,600
- MaxVolJobs: 1
- MaxVolBytes: 0
- AutoPrune: 0
- Recycle: 1
- PoolType: Backup
- LabelFormat: File
-\end{verbatim}
-\normalsize
-
-\item [messages]
- \index[general]{messages}
- Durch ausf\"{u}hren des messages-Kommandos werden wartende Console-Meldungen
- sofort angezeigt.
-
-\item [memory]
- \index[general]{memory}
- Gibt die momentane Speichernutzung des Director-Dienstes aus.
-
-\item [mount]
- \index[general]{mount}
- Das mount-Kommando veranlasst Bacula dazu, ein Volume in einem physikalischen
- Laufwerk zu lesen. Es ist damit m\"{o}glich Bacula mitzuteilen, dass ein neues
- Tape im Laufwerk ist und Bacula wird daraufhin versuchen das Label einlesen,
- um das Volume richtig zuordnen zu k\"{o}nnen. Normalerweise wird dieses Kommando
- nur ausgef\"{u}hrt, wenn kein Volume im Laufwerk war und Bacula Sie auffordert
- ein neues einzulegen, oder wenn Sie das Laufwerk vorher mit dem {\bf unmount}-Kommando
- freigegeben haben. Falls Sie einen Autochanger benutzen, wird das mount-Kommando
- Sie nach dem Slot des Tapes und dem Laufwerk fragen, in welchem das Tape gemountet werden soll.
-
- Das mount-Kommando kann folgenderma{\ss}en aufgerufen werden
-
-\footnotesize
-\begin{verbatim}
-mount storage=<storage-name> [ slot=<num> ] [
- drive=<num> ]
-
-mount [ jobid=<id> | job=<job-name> ]
-\end{verbatim}
-\normalsize
-
- Wenn Sie in der Ger\"{a}te-Konfiguration des Storage-Dienstes {\bf Automatic Mount = yes}
- angegeben haben, wird Bacula automatisch auf das Ger\"{a}t zugreifen, solange Sie es
- nicht explizit mit dem {\bf unmount}-Kommando freigegeben haben.
-
-\item[python]
- \index[general]{python}
- Das python-Kommando kennt nur den Parameter {\bf restart}:
-
-\footnotesize
-\begin{verbatim}
- python restart
-\end{verbatim}
-\normalsize
-
- dadurch wird der python-Interpreter des Director-Dienstes neu geladen.
- Das kann beim Testen hilfreich sein, da es der einzige Weg ist, den python-Interpreter
- nach dem Start des Director-Dienstes dazu zu veranlassen, seine Konfiguration
- in der Datei {\bf DirStartUp.py} neu einzulesen. F\"{u}r weiterf\"{u}hrende Informationen
- zum Thema python-Scripting lesen Sie bitte das Kapitel \ilink{PythonScripting}{PythonChapter}.
-
-\label{ManualPruning}
-\item [prune]
- \index[general]{prune}
- Das prune-Kommando erlaubt es Ihnen, abgelaufenen Job- oder Volume-Eintr\"{a}ge
- aus der Katalog-Datenbank zu entfernen. Dieses Kommando arbeitet nur auf der
- Katalog-Datenbank und l\"{o}scht keine Dateien von den Volumes. Auf jeden Fall
- wird ein Aufbewahrungszeitraum (RetentionPeriod) auf die angegebenen Eintr\"{a}ge angewendet,
- wenn Sie dieses Kommando ausf\"{u}hren. Falls die Katalog-Eintr\"{a}ge also noch nicht
- abgelaufen sind, hat das prune-Kommando auch keine Auswirkungen. Sie k\"{o}nnen
- mit diesem Kommando abgelaufene Dateien aus den Job-Eintr\"{a}gen
- l\"{o}schen, abgelaufene Jobs oder Statistiken aus dem Katalog entfernen
- und Sie k\"{o}nnen veraltete Job- und Datei-Eintr\"{a}ge eines bestimmten
- Volumes aus dem Katalog entfernen.
-
-\footnotesize
-\begin{verbatim}
-prune files|jobs|volume|stats client=<client-name>
-volume=<volume-name>
-\end{verbatim}
-\normalsize
-
- Um die Katalog-Eintr\"{a}ge eines Volumes zu l\"{o}schen, muss der
- {\bf VolStatus} entweder Full, Used oder Append sein, ansonsten werden
- keine Eintr\"{a}ge entfernt.
-
-\item [purge]
- \index[general]{purge}
- Das purge-Kommando entfernt die angegebenen Katalog-Eintr\"{a}ge
- ohne den Aufbewahrungszeitraum zu beachten. Dieses Kommando arbeitet nur
- auf der Katalog-Datenbank und l\"{o}scht keine Dateien von den Volumes.
- Mit diesem Kommando k\"{o}nnen auch versehentlich aktuelle Eintr\"{a}ge,
- die eventuell dringend ben\"{o}tigt werden, aus der Katalog-Datenbank
- gel\"{o}scht werden. Wir empfehlen Ihnen daher, dieses Kommando nur zu benutzen,
- wenn Sie wirklich wissen was Sie tun.
- Das purge-Kommando kann folgenderma{\ss}en aufgerufen werden:
-
-\footnotesize
-\begin{verbatim}
-purge files jobid=<jobid>|job=<job-name>|client=<client-name>
-
-purge jobs client=<client-name> (of all jobs)
-
-purge volume|volume=<vol-name> (of all jobs)
-\end{verbatim}
-\normalsize
-
- Damit das purge-Kommando Volume-Eintr\"{a}ge aus der Katalog-Datenbank
- entfernen kann, muss der {\bf VolStatus} entweder Full, Error, Used oder
- Append sein.
-
- Die Daten auf den Volumes werden durch dieses Kommando nicht ver\"{a}ndert.
-
-\item [quit]
- \index[general]{quit}
- Das quit-Kommando beendet das Consolen-Programm. Die Console sendet das quit-
- Kommando an den Director-Dienst und wartet auf seine Best\"{a}tigung. Falls der
- Director mit der Aus\"{u}hrung von anderen Kommandos besch\"{a}ftigt ist,
- kann es einen Moment dauern, bis das quit ausgef\"{u}hrt werden kann. In dem
- Fall k\"{o}nnen Sie durch Eingabe von {\bf .quit} die Console sofort beenden.
-
-\item [query]
- \index[general]{query}
- Das query-Kommando liest die vordefinierten SQL-Komandos aus der Datei,
- die unter QueryFile in der Konfiguration des Director-Dienstes angegeben ist, ein.
- Danach k\"{o}nnen Sie aus der Liste der verf\"{u}gbaren SQL-Anweisungen eine
- zur Ausf\"{u}hrung ausw\"{a}hlen.
-
-Die folgenden Anweisungen sind momentan vordefiniert (Version 2.2.7):
-
-\footnotesize
-\begin{verbatim}
-Available queries:
-1: List up to 20 places where a File is saved regardless of the directory
-2: List where the most recent copies of a file are saved
-3: List last 20 Full Backups for a Client
-4: List all backups for a Client after a specified time
-5: List all backups for a Client
-6: List Volume Attributes for a selected Volume
-7: List Volumes used by selected JobId
-8: List Volumes to Restore All Files
-9: List Pool Attributes for a selected Pool
-10: List total files/bytes by Job
-11: List total files/bytes by Volume
-12: List Files for a selected JobId
-13: List Jobs stored on a selected MediaId
-14: List Jobs stored for a given Volume name
-15: List Volumes Bacula thinks are in changer
-16: List Volumes likely to need replacement from age or errors
-Choose a query (1-16):
-
-\end{verbatim}
-\normalsize
-
-\item [relabel]
- \index[general]{relabel}
- \index[general]{relabel}
- Das relabel-Kommando wird benutzt um ein neues label auf ein bereits
- gelabeltes physikalisches Volume zu schreiben. Das Kommando wird wie folgt
- aufgerufen:
-
-\footnotesize
-\begin{verbatim}
-relabel storage=<storage-name> oldvolume=<old-volume-name>
- volume=<newvolume-name>
-\end{verbatim}
-\normalsize
-
- Wenn Sie einen Parameter nicht angeben, wird die Console Sie danach fragen.
- Damit der alte Volume-Name (das label) \"{u}berschrieben werden kann,
- muss der {\bf VolStatus} entweder Purged oder Recycle sein, was automatisch
- passiert, wenn die entsprechenden Aufbewahrungszeitr\"{a}ume abgelaufen sind
- (oder alle Datei- und Job-Eintr\"{a}ge dieses Volumes mit dem purge-Kommando
- aus der Katalog-Datenbank entfernt wurden).
-
- Wenn das Volume erfolgreich relabelt wurde, sind alle Daten auf dem Volume verloren
- und k\"{o}nnen nicht wiederhergestellt werden.
-
-\item [release]
- \index[general]{release}
- Das release-Kommando veranla{\ss}t den Storage-Dienst, dass im angegebenen Ger\"{a}t
- befindliche Tape zur\"{u}ckzuspulen und das label beim n\"{a}chsten Zugriff neu einzulesen.
-
-\footnotesize
-\begin{verbatim}
-release storage=<storage-name>
-\end{verbatim}
-\normalsize
-
- Nach dem release-Kommando ist das Ger\"{a}t weiterhin von Bacula ge\"{o}ffnet
- (au{\ss}er Sie haben "`Always Open"' in der Storage-Dienst-Konfiguration auf "`No"' gesetzt),
- andere Proze{\ss}e/Programme k\"{o}nnen also nicht auf das Ger\"{a}t zugreifen.
- Allerdings k\"{o}nnen Sie bei einigen Laufwerken, nach dem release-Kommando,
- das Tape gegen ein anderes austauschen, da Bacula weiss, dass es das label
- neu einlesen muss. Falls Sie mit anderen Programmen auf das Ger\"{a}t zugreifen wollen,
- m\"{u}ssen Sie das unmount-Kommando verwenden, nur dann gibt Bacula das Ger\"{a}t komplett frei.
-
-\item [reload]
- \index[general]{reload}
- Das reload-Kommando veranla{\ss}t den Director-Dienst seine Konfigurations-Dateien
- neu einzulesen und mit der aktuellen Konfiguration weiterzuarbeiten. Die neue
- Konfiguration wird dabei sofort f\"{u}r alle neuen Jobs g\"{u}ltig.
- Wenn Sie die Zeitpl\"{a}ne (Schedules) \"{a}ndern, bedenken Sie bitte, dass Bacula
- die geplanten Jobs bis zu zwei Stunden im vorraus berechnet und es dadurch zu einer
- Verz\"{o}gerung kommen kann, bis die neue Konfiguration g\"{u}ltig wird. Jobs die bereits
- in der Warteschlange sind (deren eigentliche Startzeit also schon vorbei ist), werden
- mit den alten Konfigurations-Werten abgearbeitet. Neue Jobs werden die neue Konfiguration
- benutzen. Wenn Sie das reload-Kommando ausf\"{u}hren w\"{a}hrend Jobs laufen,
- wird die neue Konfiguration solange zur\"{u}ckgehalten, bis alle Jobs beendet sind
- und erst dann wirksam. Sie k\"{o}nnen bis zu zehn Konfigurations\"{a}nderungen
- durchf\"{u}hren w\"{a}hrend Jobs laufen, erst danach wird der Director-Dienst
- eine Meldung ausgeben, dass er nicht mehr unterschiedliche Konfigurationen
- im Speicher vorhalten kann.
-
- Auch wenn es m\"{o}glich ist, die Director-Konfiguration zur Laufzeit neu zu laden,
- und auch dann wenn Jobs laufen, sollten Sie bei der n\"{a}chsten Gelegenheit
- den Director-Dienst neu starten um Seiteneffekte auszuschlie{\ss}en. Das neue Einlesen
- der Konfiguration ist ein sehr komplexer Vorgang und nur nach dem Neustart
- k\"{o}nnen Sie sicher sein, dass nur noch mit der neuen Konfiguration gearbeitet wird.
-
-\label{restore_command}
-\item [restore]
- \index[general]{restore}
- Das restore-Kommando erlaubt es Ihnen auf verschiedenen Wegen, einen oder mehrere Jobs (JobIDs)
- zur Wiederherstellung auszuw\"{a}hlen. Nachdem die JobIDs ausgew\"{a}hlt wurden,
- erstellt der Director-Dienst aus den dazugeh\"{o}hrigen Datei-Eintr\"{a}gen
- einen internen Verzeichnis-Baum in dem Sie dann die Dateien und Verzeichnisse
- zur Wiederherstellung markieren k\"{o}nnen. Dieser restore-Modus der Console
- verh\"{a}hlt sich \"{a}hnlich dem Unix-Standard-Kommando {\bf restore}.
-
-\footnotesize
-\begin{verbatim}
-restore storage=<storage-name> client=<backup-client-name>
- where=<path> pool=<pool-name> fileset=<fileset-name>
- restoreclient=<restore-client-name>
- select current all done
-\end{verbatim}
-\normalsize
-
- Wobei {\bf current}, falls angegeben, das restore-Kommando dazu veranla{\ss}t,
- automatisch das aktuellste Backup zur Wiederherstellung auszuw\"{a}hlen.
- Das Schl\"{u}sselwort {\bf all} w\"{a}hlt automatisch alle Dateien aus.
- Falls Sie einen ben\"{o}tigten Parameter nicht angeben, wird das restore-Kommando
- Sie danach fragen. F\"{u}r weitere Informationen zum {\bf restore}-Kommando
- lesen Sie bitte das \ilink{Restore Kapitel}{RestoreChapter} dieses Handbuchs.
-
- Das Schl\"{u}sselwort {\bf client} gibt sowohl den Client an, auf dem das Backup
- gemacht wurde, als auch den Client auf dem das Backup widerhergestellt werden soll.
- Durch Angabe des {\bf restoreclient} k\"{o}nnen Sie allerdings auch einen anderen Client
- w\"{a}hlen, auf dem das Backup statt dessen wiederhergestellt werden soll.
-
-\item [run]
- \index[general]{run}
- Das run-Kommando erlaubt es Ihnen, Jobs in den Zeitplan des Director-Dienstes einzuf\"{u}gen,
- die sofort gestartet werden sollen. Das run-Kommando kann wie folgend aufgerufen werden:
-
-\footnotesize
-\begin{verbatim}
-run job=<job-name> client=<client-name>
- fileset=<FileSet-name> level=<level-keyword>
- storage=<storage-name> where=<directory-prefix>
- when=<universal-time-specification> spooldata=yes|no yes
-\end{verbatim}
-\normalsize
-
- Jede ben\"{o}tigte Information, die nicht angegeben wurde, wird zur Auswahl aufgelistet.
- Bevor der Job in den Zeitplan des Directors eingef\"{u}gt wird, werden Sie
- aufgefordert die Parameter zu best\"{a}tigen, zu \"{a}ndern oder den Job abzubrechen.
- Falls Sie das Schl\"{u}sselwort {\bf yes} angegeben haben, wird der Job ohne Nachfrage
- in den Zeitplan aufgenommen.
-
- Ein Beispiel:
-
-\footnotesize
-\begin{verbatim}
-A job name must be specified.
-The defined Job resources are:
- 1: Matou
- 2: Polymatou
- 3: Rufus
- 4: Minimatou
- 5: Minou
- 6: PmatouVerify
- 7: MatouVerify
- 8: RufusVerify
- 9: Watchdog
-Select Job resource (1-9):
-
-\end{verbatim}
-\normalsize
-
-Nach der Auswahl der Nummer 5 erscheint:
-
-\footnotesize
-\begin{verbatim}
-Run Backup job
-JobName: Minou
-FileSet: Minou Full Set
-Level: Incremental
-Client: Minou
-Storage: DLTDrive
-Pool: Default
-When: 2003-04-23 17:08:18
-OK to run? (yes/mod/no):
-
-\end{verbatim}
-\normalsize
-
-Wenn Sie jetzt {\bf yes} eingeben, wird der Job gestartet,
-falls Sie {\bf mod} ausw\"{a}hlen,
-erscheint diese Liste der ver\"{a}nderbaren Parameter:
-
-\footnotesize
-\begin{verbatim}
-Parameters to modify:
- 1: Level
- 2: Storage
- 3: Job
- 4: FileSet
- 5: Client
- 6: When
- 7: Pool
-Select parameter to modify (1-7):
-
-\end{verbatim}
-\normalsize
-
-Wenn Sie den Job zum Beispiel erst zu einem sp\"{a}teren Zeitpunkt starten wollen,
-k\"{o}nnen Sie \"{u}ber die Auswahl Nr. 6 "`When"', die Startzeit anpassen.
-Die Zeit muss im Format YYYY-MM-DD HH:MM:SS angegeben werden.
-
-Der Parameter spooldata kann nicht \"{u}ber diese Auswahlliste ge\"{a}ndert werden.
-Er muss beim Starten des run-Kommandos auf der Kommandozeile mit angegeben werden.
-Wir er nicht gesetzt, \"{u}bernimmt das run-Kommando die spooldata-Option aus
-der Job-, Storage- oder Schedule-Konfiguration.
-
-\item [setdebug]
- \index[general]{setdebug}
- \index[general]{setdebug}
- \index[general]{debugging}
- \index[general]{debugging Win32}
- \index[general]{Windows!debugging}
- Das setdebug-Kommando wird benutzt um den Debug-Level f\"{u}r die verschiedenen
- Dienste zu setzen (der Debug-Level bestimmt die Menge der ausgegebenen Programm-Informationen,
- die z.B. zur Fehlersuche verwendet werden k\"{o}nnen).
- Es wird wie folgt aufgerufen:
-
-\footnotesize
-\begin{verbatim}
-setdebug level=nn [trace=0/1 client=<client-name> | dir | director |
- storage=<storage-name> | all]
-\end{verbatim}
-\normalsize
-
- Wenn trace=1 gesetzt wird, schreibt der gew\"{a}hlte Dienst alle Ausgaben
- in eine Datei ("`Dienst-Name"'.trace) in seinem konfigurierten Arbeitsverzeichnis.
- Das ist vor allem bei Windows-Systemen n\"{u}tzlich, da sich dort die Programm-Ausgaben
- nicht \"{u}ber die Kommandozeile in Dateien umlenken lassen, bzw. keine Ausgaben
- im Terminal dargetestellt werden. Im Trace-Modus wird jede Programm-Ausgabe der Trace-Datei
- angeh\"{a}ngt. Diese Datei muss von Hand durch den Benutzer gel\"{o}scht werden.
-
-\item [setip]
- \index[general]{setip}
- erm\"{o}glicht dem Client seine aktuelle IP-Adresse dem Director-Dienst
- mitzuteilen, falls er dazu autorisiert ist.
-
-\item [show]
- \index[general]{show}
- \index[general]{show}
- Das show-Kommando zeigt die Konfiguration des Director-Dienstes an.
- Diese Kommando wird haupts\"{a}chlich zur Fehlersuche durch die Entwickler
- benutzt. Die folgenden Schl\"{u}sselw\"{o}rter k\"{o}nnen angegeben werden:
- catalogs, clients, counters, devices, directors,filesets, jobs, messages,
- pools, schedules, storages, all, help. Bitte beachten Sie den Unterschied zum
- list-Kommando, welches den Inhalt der Katalog-Datenbank anzeigt.
-
-\item [sqlquery]
- \index[general]{sqlquery}
- Das sqlquery-Kommando versetzt die Console in den SQL-Abfrage-Modus.
- Nach diesem Kommando k\"{o}nnen Sie, auch \"{u}ber mehrere Zeilen, eine
- SQL-Anweisung eingeben. Nachdem die Anweisung mit einem Semikolon (;) abgeschlossen
- ist, wird sie direkt an die Datenbank \"{u}bergeben. Nach der Ausgabe des Ergebnisses
- wird wieder eine neue SQL-Anweisung erwartet. Den SQL-Abfrage-Modus k\"{o}nnen Sie
- durch die Eingabe eines Punktes (.), als erstes Zeichen in der Eingabezeile, beenden.
-
- Mittels dieses Kommandos k\"{o}nnen Sie direkt die Katalog-Datenbank abfragen.
- Seihen Sie bitte vorsichtig, damit Sie nicht aus Versehen Datenbank-Eintr\"{a}ge
- \"{a}ndern oder l\"{o}schen. Lesen Sie bitte auch die Beschreibung des query-Kommandos
- weiter unten, mit dem Sie einfacher und sicherer Datenbank-Abfragen durchf\"{u}hren k\"{o}nnen.
-
- Abh\"{a}ngig von dem von Ihnen verwendeten Datenbank-Systems (MySQL, PostgreSQL
- oder SQLite) haben Sie mehr oder weniger M\"{o}glichkeiten direkte
- Datenbank-Abfragen durchzuf\"{u}hren.
- Mehr Informationen finden Sie in der Beschreibung Ihrer Datenbank.
-
-\item [status]
- \index[general]{status}
- Das status-Kommando zeigt den momentanen Status des gew\"{a}hlten Dienstes an
- (Director, Storage oder eines Clients). Beim Storage-Dienst k\"{o}nnen Sie
- sich den Laufwerks-Status oder den Inhalt des Autochangers anzeigen lassen.
- Der Client zeigt Informationen \"{u}ber aktuell laufende Jobs und deren
- Geschwindigkeit an. Es kann wie folgt aufgerufen werden:
-
-\footnotesize
-\begin{verbatim}
-status [all | dir=<dir-name> | director [days=nnn] |
- client=<client-name> | [slots] storage=<storage-name> ]
-\end{verbatim}
-\normalsize
-
- Wenn Sie das Kommando {\bf status dir} ausf\"{u}hren, listet die Console
- die momentan laufenden Jobs, alle f\"{u}r die n\"{a}chsten 24 Stunden
- geplanten Jobs und die letzten 10 beendeten Jobs, sowie deren Status auf.
- Die Liste der geplanten Jobs enth\"{a}lt auch den Namen des Volumes,
- das voraussichtlich benutzt wird. Beachten Sie dabei bitte diese beiden Punkte:
- 1. um das Volume zu ermitteln wird dieselbe Funktion benutzt wie in dem Moment
- wo der Backup-Job startet, allerdings werden die Ablaufzeitr\"{a}ume der Volumes
- nicht in Betracht gezogen; 2. das angezeigte Volume ist die nur bestm\"{o}gliche
- Sch\"{a}tzung, da das Volume eventuell in der zwischenzeit andersweitig benutzt
- oder auch durch vorher laufende Jobs vollgeschrieben werden k\"{o}nnte.
-
- In der Liste der laufenden Jobs finden Sie diese Informationen:
-
-\footnotesize
-\begin{verbatim}
-2507 Catalog MatouVerify.2004-03-13_05.05.02 is waiting execution
-5349 Full CatalogBackup.2004-03-13_01.10.00 is waiting for higher
- priority jobs to finish
-5348 Differe Minou.2004-03-13_01.05.09 is waiting on max Storage jobs
-5343 Full Rufus.2004-03-13_01.05.04 is running
-\end{verbatim}
-\normalsize
-
- Wenn Sie sich diese Ausgabe von unten nach oben anschauen, sehen Sie,
- dass JobId 5343 (Rufus) gerade l\"{a}uft. JobId 5348 (Minou) wartet darauf,
- dass der Job 5343 beendet wird, da dieser momentan die Storage-Resource verwendet,
- daher die Meldung: "`waiting on max Storage jobs"'. JobId 5349 (CatalogBackup)
- hat eine geringere Priorit\"{a}t und wartet daher auf die Beendigung der
- Jobs mit h\"{o}heren Priorit\"{a}ten. Zuoberst steht die JobId 2507 (MatouVerify),
- die als letzte dieser JobIds geplant wurde, da schon andere wartende und
- laufende JobIds vorhanden sind, hat sie nur den Status "`waiting execution"'.
-
- Das Kommando {\bf status dir} zeigt standardm\"{a}{\ss}ig nur die f\"{u}r
- heute und morgen geplanten Jobs an. Falls Sie die geplanten Jobs der n\"{a}chsten
- drei Tage sehen m\"{o}chten um, zum Beispiel am Freitag zu kontrollieren,
- welche Volumes am Freitag, am Wochenende und am Montag benutzt werden,
- k\"{o}nnen Sie die Option {\bf days=3} verwenden. {\bf days=0} zeigt nur die
- f\"{u}r heute geplanten Jobs an.
-
- Falls Ihre Jobs also nicht wie gew\"{u}nscht starten, k\"{o}nnen
- Sie sich mit dem Kommando {\bf status dir} einen \"{U}berblick \"{u}ber
- die momentan laufenden und wartenden Jobs, sowie den Grund des wartens,
- verschaffen. Genauere Informationen bekommen Sie meistens, wenn Sie
- das Kommando {\bf status storage=xxx} verwenden. Als Beispiel sind hier die
- Ausgaben die dieses Kommando auf einem Storage im Leerlauf anzeigt:
-
-\footnotesize
-\begin{verbatim}
-status storage=File
-Connecting to Storage daemon File at 192.168.68.112:8103
-
-rufus-sd Version: 1.39.6 (24 March 2006) i686-pc-linux-gnu redhat (Stentz)
-Daemon started 26-Mar-06 11:06, 0 Jobs run since started.
-
-Running Jobs:
-No Jobs running.
-====
-
-Jobs waiting to reserve a drive:
-====
-
-Terminated Jobs:
- JobId Level Files Bytes Status Finished Name
-======================================================================
- 59 Full 234 4,417,599 OK 15-Jan-06 11:54 kernsave
-====
-
-Device status:
-Autochanger "DDS-4-changer" with devices:
- "DDS-4" (/dev/nst0)
-Device "DDS-4" (/dev/nst0) is mounted with Volume="TestVolume002"
-Pool="*unknown*"
- Slot 2 is loaded in drive 0.
- Total Bytes Read=0 Blocks Read=0 Bytes/block=0
- Positioned at File=0 Block=0
-Device "Dummy" is not open or does not exist.
-No DEVICE structure.
-
-Device "DVD-Writer" (/dev/hdc) is not open.
-Device "File" (/tmp) is not open.
-====
-
-In Use Volume status:
-====
-\end{verbatim}
-\normalsize
-
-Ganz oben sind unter "`Running Jobs"' und "`Jobs waiting .."' keine Eintr\"{a}ge,
-was bedeutet, dass momentan kein Job l\"{a}uft und damit auch keine Ger\"{a}te
-benutzt werden. Jetzt wird der Autochanger mit dem {\bf unmount}-Kommando
-freigegeben und ein Job gestartet der das Ger\"{a}t vom Typ "`File (/tmp)"'
-benutzen soll. Daraufhin gibt das Kommando {\bf status storage=xxx} diese
-Meldungen aus:
-
-\footnotesize
-\begin{verbatim}
-status storage=File
-...
-Device status:
-Autochanger "DDS-4-changer" with devices:
- "DDS-4" (/dev/nst0)
-Device "DDS-4" (/dev/nst0) is not open.
- Device is BLOCKED. User unmounted.
- Drive 0 is not loaded.
-Device "Dummy" is not open or does not exist.
-No DEVICE structure.
-
-Device "DVD-Writer" (/dev/hdc) is not open.
-Device "File" (/tmp) is not open.
- Device is BLOCKED waiting for media.
-====
-...
-\end{verbatim}
-\normalsize
-
-Der Autochanger ist, durch das {\bf unmount}-Kommando, im Status "`BLOCKED. User unmounted"'.
-Das Device File, mit dem der Job gestartet wurde, ist im Status "`BLOCKED waiting for media"',
-Bacula wartet jetzt darauf, dass Sie ein Volume labeln und mounten.
-
-\item [time]
- \index[general]{time}
- Gibt die aktuelle Uhrzeit aus.
-
-\item [trace]
- \index[general]{trace}
- Schaltet das Mitschneiden der Dienst-Ausgaben in eine Datei ein oder aus.
- Siehe setdebug Kommando.
-
-\item [umount]
- \index[general]{umount}
- identisch mit unmount (in Anlehnung an das Unix-Kommando umount).
-
-\item [unmount]
- \index[general]{unmount}
- Das unmount-Kommando veranlasst den Storage-Dienst dazu, dass angegebene Ger\"{a}t
- freizugeben. Der Aufruf dieses Kommandos ist identisch mit dem mount-Kommando:
-\footnotesize
-\begin{verbatim}
-unmount storage=<storage-name> [ drive=<num> ]
-
-unmount [ jobid=<id> | job=<job-name> ]
-\end{verbatim}
-\normalsize
-
- Nachdem ein Ger\"{a}t mit dem unmount-Kommando freigegeben wurde, kann
- Bacula es so lange nicht verwenden, bis es wieder mit dem mount-Kommando
- ge\"{o}ffnet wird. Falls Bacula das Ger\"{a}t zwischenzeitlich f\"{u}r einen
- Job ben\"{o}tigt, wird Bacula in regelm\"{a}{\ss}igen Abst\"{a}nden den Benutzer
- informieren, dass Ger\"{a}t zu mounten.
-
- Wenn das Ger\"{a}t ein Autochanger ist, wird das angebene Laufwerk
- zudem entladen. Wenn keine Laufwerk angegeben ist, wird Laufwerk 1 verwendet.
-
-\label{UpdateCommand}
-\item [update]
- \index[general]{update}
- Das update-Kommando aktualisiert die Katalog-Datenbank entsprechend der angegebenen
- Option. M\"{o}glich sind Pool- oder Volume-Eintr\"{a}ge oder auch die Volumes
- in den Slots eines Autochangers mit Barcode-Unterst\"{u}tzung. Im Falle der Pool-Eintr\"{a}ge
- werden die aktuellen Information aus den Konfigurations-Dateien des Director-Dienstes gelesen.
- Die folgenden Schl\"{u}sselw\"{o}rter k\"{o}nnen angegeben werden:
-\footnotesize
-\begin{verbatim}
- media, volume, pool, slots, stats
-\end{verbatim}
-\normalsize
-
-Falls Sie Volumes aktualisieren, werden Sie nach den zu \"{a}ndernden Parametern gefragt.
-Folgende Volume-Parameter k\"{o}nnen angepasst werden:
-\footnotesize
-\begin{verbatim}
-
- Volume Status
- Volume Retention Period
- Volume Use Duration
- Maximum Volume Jobs
- Maximum Volume Files
- Maximum Volume Bytes
- Recycle Flag
- Recycle Pool
- Slot
- InChanger Flag
- Pool
- Volume Files
- Volume from Pool
- All Volumes from Pool
- All Volumes from all Pools
-
-\end{verbatim}
-\normalsize
-
- Bei Auswahl von {\bf Pool} wird Bacula das gew\"{a}hlte Volume in den angegebenen
- Pool verschieben.
-
- Bei Auswahl von {\bf Volume from Pool}, {\bf All Volumes from Pool} und {\bf All Volumes
- from all Pools} werden alle Volumes im entsprechenden Pool so angepasst, wie es aktuell
- in der Konfiguration des Director-Dienstes steht. Das betrifft folgende Eintr\"{a}ge:
- Recycle, RecyclePool, VolRetention, VolUseDuration, MaxVolJobs, MaxVolFiles,
- und MaxVolBytes. (RecyclePool ist erst ab Version \gt 2.1.4 verf\"{u}gbar.)
-
- Durch das Kommando {\bf update slots} holt sich Bacula eine aktuelle Liste der
- Volume-Barcodes in den Slots des Autochangers. F\"{u}r jeden gefundenen Barcode
- wird automatisch der Slot des Volumes in der Katalog-Datenbank angepasst.
- Das ist n\"{u}tzlich, falls Sie Volumes in den Magazinen verschoben oder gewechselt haben.
- Beim aktualisieren der Slots wird auch das InChanger-Flag der Volumes im Katalog angepasst,
- dadurch weiss Bacula welche Volumes im Autochanger verf\"{u}gbar sind.
-
- Falls Ihr Autochanger keine Barcodes unterst\"{u}tzt, k\"{o}nnen Sie die
- Volumes im Autochanger mit dem Kommando {\bf update slots scan} aktualisieren.
- Das Schl\"{u}sselwort {\bf scan} teilt Bacula (nur Version \gt 1.33) mit,
- dass es alle Volumes nacheinandern mounten soll, um das Tape-Label einzulesen.
-
- Das update-Kommando kann wie folgt aufgerufen werden:
-
-\footnotesize
-\begin{verbatim}
- update volume=xxx pool=yyy slots volstatus=xxx VolRetention=ddd
- VolUse=ddd MaxVolJobs=nnn MaxVolBytes=nnn Recycle=yes|no
- slot=nnn enabled=n recyclepool=zzz
-
-\end{verbatim}
-\normalsize
-
-\item [use]
- \index[general]{use}
- Das use-Kommando wird verwendet um dem Director-Dienst mitzuteilen, welche Katalog-
- Datenbank verwendet werden soll. Da es normalerweise nur eine Datenbank gibt,
- wird diese immer automatisch ausgew\"{a}hlt. Fall Sie jedoch mehrere Katalog-Eintr\"{a}ge
- in der Konfiguration des Director-Dienstes angegeben haben, k\"{o}nnen Sie mittels
- des use-Kommandos von einem Katalog zum anderen wechseln.
-
-\footnotesize
-\begin{verbatim}
-use <database-name>
-\end{verbatim}
-\normalsize
-
-\item [var]
- \label{var}
- \index[general]{var name}
- Das var-Kommando akzeptiert eine Zeichenkette (auch in Anf\"{u}hrungstrichen)
- und f\"{u}hrt Variablen-Ersetzungen durch, wie sie auch mit der {\bf LabelFormat}
- Zeichenkette geschehen. Der einzige Unterschied ist, dass beim Ausf\"{u}hren des
- var-Kommandos kein Job l\"{a}uft und daher andere Werte verwendet werden anstelle von
- den Job-spezifischen. Allerdings werden Sie trotzdem einen Eindruck davon erhalten, was
- f\"{u}r eine Ausgabe zu erwarten ist.
-
-\item [version]
- \index[general]{version}
- Das version-Kommando gibt die Version des Director-Dienstes aus.
-
-\item [wait]
- \index[general]{wait}
- Das wait-Kommando wartet solange bis keine Jobs mehr laufen. Es kann
- in Batch-Programmen verwendet werden, die z.B. \"{u}ber den cron-Dienst
- gestartet werden und eine bestimmte Aktion erst ausf\"{u}hren sollen,
- wenn der Director im Leerlauf ist.
- Das wait-Kommando kennt die folgenden Optionen:
-\footnotesize
-\begin{verbatim}
- wait [jobid=nn] [jobuid=unique id] [job=job name]
-\end{verbatim}
-\normalsize
- Wenn eine der Optionen angegeben ist, wartet das wait-Kommando darauf,
- dass sich der spezifizierte Job beendet.
-\end{description}
-
-\label{dotcommands}
-\section{Spezielle Punkt-Kommandos}
-\index[general]{Kommandos!Spezielle Punkt-}
-\index[general]{Spezielle Punkt-Kommandos}
-
-Es gibt eine Reihen von Kommandos die mit einem Punkt (.) beginnen.
-Diese Kommandos sind prinzipiell f\"{u}r die Verwendung in Batch-Programmen
-oder Benutzerschnittstellen gedacht. Sie werden normalerweise nicht durch einen
-Benutzer in der Console ausgef\"{u}hrt. Hier ist eine \"{U}bersicht:
-
-\footnotesize
-\begin{verbatim}
-.backups job=xxx zeigt die Backups des angegebenen Jobs an
-.clients listet alle Client-Namen auf
-.defaults client=xxx fileset=yyy zeigt die Defaults des angegebenen Clients an
-.die verursacht einen Segment-Fault des Directors (zur Fehlersuche)
-.dir im Datei-Auswahl-Modus des restore-Kommandos werden die Ausgaben
- durch ein Komma getrennt, statt durch Leerzeichen wie beim dir
-.exit quit
-.filesets zeigt alle FileSet-Namen an
-.help zeigt die Hilfe unformatiert an
-.jobs zeigt alle Job-Namen an
-.levels zeigt alle Backup-Level an
-.messages siehe messages
-.msgs zeigt die message-Konfigurations-Namen an
-.pools zeigt alle Pool-Namen an
-.quit quit
-.status holt Status-Ausgaben
-.storage zeigt die Namen der Storage-Einträge an
-.types zeigt die Job-Typen an
-\end{verbatim}
-\normalsize
-
-\label{atcommands}
-
-\section{Spezielle @-Kommandos}
-\index[general]{Kommandos!Spezielle @-}
-\index[general]{Spezielle @-Kommandos}
-
-Normalerweise werden alle eingegebenen Kommandos direkt zur Ausf\"{u}hrung an den
-Director-Dienst, welcher eventuell auf einem anderen Computer l\"{a}uft, geschickt.
-Allerdings gibt es eine kleine Anzahl {\bf @}-Kommandos, die mit einem @ beginnen,
-und die nicht durch den Director, sondern durch die Console selbst, ausgef\"{u}hrt werden.
-Diese Kommandos sind nur in der Terminal(tty)-Version der Console implementiert, aber nicht in der
-GNOME-Version. Diese Kommandos sind:
-
-\begin{description}
-
-\item [@input \lt{}filename\gt{}]
- \index[general]{@input \lt{}filename\gt{}}
- Liest und f\"{u}hrt die Kommandos aus der angegebenen Datei aus.
-
-\item [@output \lt{}filename\gt{} w/a]
- \index[general]{@output \lt{}filename\gt{} w/a}
- Schreibt die Ausgaben der Console in die angegebene Datei.
- Entweder wird die Datei \"{u}berschrieben (Option w) oder es wird an
- eine bestehende Datei angeh\"{a}ngt (Option a). Um die Ausgaben wieder an das Terminal
- umzuleiten k\"{o}nnen Sie einfach {\bf @output} ohne einen Datei-Namen angeben.
- Passen Sie aber auf, dass Sie nicht versehentlich eine bereits bestehende Datei
- \"{u}berschreiben. Hier ein Beispiel um alle Ausgaben zu unterdr\"{u}cken:
-
-\footnotesize
-\begin{verbatim}
- @output /dev/null
- weitere Kommandos ...
- @output
-\end{verbatim}
-\normalsize
-
-\item [@tee \lt{}filename\gt{} w/a]
- \index[general]{@tee \lt{}filename\gt{} w/a}
- Sendet die Ausgaben an das Terminal und an die angegebene Datei.
- Zum Beenden f\"{u}hren Sie {\bf @tee} oder {\bf @output} ohne Datei-Namen aus.
-
-\item [@sleep \lt{}seconds\gt{}]
- \index[general]{@sleep \lt{}seconds\gt{}}
- Schl\"{a}ft die angegebene Zeit in Sekunden.
-
-\item [@time]
- \index[general]{@time}
- zeigt die aktuelle Zeit und das Datum an.
-
-\item [@version]
- \index[general]{@version}
- zeigt die Console-Version an
-
-\item [@quit]
- \index[general]{@quit}
- quit
-
-\item [@exit]
- \index[general]{@exit}
- quit
-
-\item [@\# anything]
- \index[general]{anything}
- ein Kommantar
-\end{description}
-
-\label{scripting}
-\section{Steuern der Console durch ein Shell-Script}
-\index[general]{Script!Steuern der Console durch ein Shell-}
-\index[general]{Steuern der Console durch ein Shell-Script}
-
-Sie k\"{o}nnen viele Console-Aufgaben durch Shell-Scripte vereinfachen.
-Wenn Sie zum Beispiel folgende Kommandos in ein Script schreiben:
-
-\footnotesize
-\begin{verbatim}
- ./bconsole -c ./bconsole.conf <<END_OF_DATA
- unmount storage=DDS-4
- quit
- END_OF_DATA
-\end{verbatim}
-\normalsize
-
-wird durch seine Ausf\"{u}hrung das Ger\"{a}t DDS-4 freigegeben und im Falle
-eines Autochangers auch entladen. Sie k\"{o}nnen solche Scripte auch in
-der Job-Konfiguration als {\bf RunBeforeJob} oder {\bf RunAfterJob} angeben.
-
-Sie k\"{o}nnen die Console auch die Datei mit den Kommandos einlesen lassen,
-wenn Sie sie so starten:
-
-\footnotesize
-\begin{verbatim}
-./bconsole -c ./bconsole.conf <Dateiname
-\end{verbatim}
-\normalsize
-
-wobei die Datei {\bf Dateiname} beliebige und beliebig viele Kommandos
-enthalten kann.
-
-Als ein Beispiel, eine Datei die w\"{a}hrend Entwicklungstests von Bacula benutzt wird,
-es wird ein Festplatten-Volume gelabelt, ein Job gestartet und die gesicherten Dateien
-wiederhergestellt:
-
-\footnotesize
-\begin{verbatim}
-./bconsole -c ./bconsole.conf <<END_OF_DATA
-@output /dev/null
-messages
-@output /tmp/log1.out
-label volume=TestVolume001
-run job=Client1 yes
-wait
-messages
-@#
-@# now do a restore
-@#
-@output /tmp/log2.out
-restore current all
-yes
-wait
-messages
-@output
-quit
-END_OF_DATA
-\end{verbatim}
-\normalsize
-
-Die Ausgaben des Jobs werden dabei zu /tmp/log1.out und die Ausgaben der Wiederherstellung
-zu /tmp/log2.out umgeleitet. Um automatisch zu \"{u}berpr\"{u}fen, ob beides erfolgreich war,
-werden die beiden Log-Dateien mit diesem Script kontrolliert:
-
-\footnotesize
-\begin{verbatim}
-grep "^Termination: *Backup OK" /tmp/log1.out
-backupstat=$?
-grep "^Termination: *Restore OK" /tmp/log2.out
-restorestat=$?
-\end{verbatim}
-\normalsize
-
-\section{Volumes zu einem Pool hinzuf\"{u}gen}
-\index[general]{Volumes zu einem Pool hinzuf\"{u}gen}
-\index[general]{Pool!Volumes hinzuf\"{u}gen}
-
-Fall Sie das {\bf label}-Kommando zum labeln eines Volumes benutzt haben,
-wird es automatisch zu dem angegebenen Pool hinzugef\"{u}gt.
-Alternativ k\"{o}nnen Sie aber auch Volumes zu einem Pool hinzuf\"{u}gen ohne sie zu labeln.
-Diese k\"{o}nnen dann sp\"{a}ter je nachdem gelabelt werden, wie Bacula sie ben\"{o}tigt.
-
-Die folgenden Informationen m\"{u}ssen Sie vor dem hinzuf\"{u}gen haben:
-
-\begin{enumerate}
-\item Den Namen des Pools (normalerweise "`Default"')
-\item Den Media-Typ wie er in dem Storage-Eintrag der Director-Dienst-Konfiguration angegeben ist
-(z.B. DLT8000)
-\item Die Anzahl und Namen der Volumes die Sie erstellen m\"{o}chten
-\end{enumerate}
-
-Um die Volumes zu dem Pool hinzuzuf\"{u}gen, k\"{o}nnen Sie dann beispielweise
-folgende Kommandos ausf\"{u}hren:
-
-\footnotesize
-\begin{verbatim}
-*add
-Enter name of Pool to add Volumes to: Default
-Enter the Media Type: DLT8000
-Enter number of Media volumes to create. Max=1000: 10
-Enter base volume name: Save
-Enter the starting number: 1
-10 Volumes created in pool Default
-*
-\end{verbatim}
-\normalsize
-
-Zur Kontrolle k\"{o}nnen Sie sich dann die neuen Volumes anzeigen lassen:
-
-\footnotesize
-\begin{verbatim}
-*list media pool=Default
-+-------+----------+---------+---------+-------+------------------+
-| MedId | VolumeNa | MediaTyp| VolStat | Bytes | LastWritten |
-+-------+----------+---------+---------+-------+------------------+
-| 11 | Save0001 | DLT8000 | Append | 0 | 0000-00-00 00:00 |
-| 12 | Save0002 | DLT8000 | Append | 0 | 0000-00-00 00:00 |
-| 13 | Save0003 | DLT8000 | Append | 0 | 0000-00-00 00:00 |
-| 14 | Save0004 | DLT8000 | Append | 0 | 0000-00-00 00:00 |
-| 15 | Save0005 | DLT8000 | Append | 0 | 0000-00-00 00:00 |
-| 16 | Save0006 | DLT8000 | Append | 0 | 0000-00-00 00:00 |
-| 17 | Save0007 | DLT8000 | Append | 0 | 0000-00-00 00:00 |
-| 18 | Save0008 | DLT8000 | Append | 0 | 0000-00-00 00:00 |
-| 19 | Save0009 | DLT8000 | Append | 0 | 0000-00-00 00:00 |
-| 20 | Save0010 | DLT8000 | Append | 0 | 0000-00-00 00:00 |
-+-------+----------+---------+---------+-------+------------------+
-*
-\end{verbatim}
-\normalsize
-
-Bitte beachten Sie, dass die Console automatisch eine fortlaufende Nummer
-an den Volume-Namen (Save in diesem Beispiel) anh\"{a}ngt. Wenn Sie diese Nummern
-nicht angeh\"{a}ngt haben m\"{o}chten, m\"{u}ssen Sie auf die Frage "`Enter number
-of Media volumes to create. Max=1000:"' mit 0 (Null) antworten. Dann wird nur ein
-einzelnes Volume, mit dem von Ihnen eingegebenen Namen, erzeugt.
+++ /dev/null
-#!/usr/bin/perl -w
-# Finds potential problems in tex files, and issues warnings to the console
-# about what it finds. Takes a list of files as its only arguments,
-# and does checks on all the files listed. The assumption is that these are
-# valid (or close to valid) LaTeX files. It follows \include statements
-# recursively to pick up any included tex files.
-#
-#
-#
-# Currently the following checks are made:
-#
-# -- Multiple hyphens not inside a verbatim environment (or \verb). These
-# should be placed inside a \verb{} contruct so they will not be converted
-# to single hyphen by latex and latex2html.
-
-
-# Original creation 3-8-05 by Karl Cunningham karlc -at- keckec -dot- com
-#
-#
-
-use strict;
-
-# The following builds the test string to identify and change multiple
-# hyphens in the tex files. Several constructs are identified but only
-# multiple hyphens are changed; the others are fed to the output
-# unchanged.
-my $b = '\\\\begin\\*?\\s*\\{\\s*'; # \begin{
-my $e = '\\\\end\\*?\\s*\\{\\s*'; # \end{
-my $c = '\\s*\\}'; # closing curly brace
-
-# This captures entire verbatim environments. These are passed to the output
-# file unchanged.
-my $verbatimenv = $b . "verbatim" . $c . ".*?" . $e . "verbatim" . $c;
-
-# This captures \verb{..{ constructs. They are passed to the output unchanged.
-my $verb = '\\\\verb\\*?(.).*?\\1';
-
-# This captures multiple hyphens with a leading and trailing space. These are not changed.
-my $hyphsp = '\\s\\-{2,}\\s';
-
-# This identifies other multiple hyphens.
-my $hyphens = '\\-{2,}';
-
-# This identifies \hyperpage{..} commands, which should be ignored.
-my $hyperpage = '\\\\hyperpage\\*?\\{.*?\\}';
-
-# This builds the actual test string from the above strings.
-#my $teststr = "$verbatimenv|$verb|$tocentry|$hyphens";
-my $teststr = "$verbatimenv|$verb|$hyphsp|$hyperpage|$hyphens";
-
-
-sub get_includes {
- # Get a list of include files from the top-level tex file. The first
- # argument is a pointer to the list of files found. The rest of the
- # arguments is a list of filenames to check for includes.
- my $files = shift;
- my ($fileline,$includefile,$includes);
-
- while (my $filename = shift) {
- # Get a list of all the html files in the directory.
- open my $if,"<$filename" or die "Cannot open input file $filename\n";
- $fileline = 0;
- $includes = 0;
- while (<$if>) {
- chomp;
- $fileline++;
- # If a file is found in an include, process it.
- if (($includefile) = /\\include\s*\{(.*?)\}/) {
- $includes++;
- # Append .tex to the filename
- $includefile .= '.tex';
-
- # If the include file has already been processed, issue a warning
- # and don't do it again.
- my $found = 0;
- foreach (@$files) {
- if ($_ eq $includefile) {
- $found = 1;
- last;
- }
- }
- if ($found) {
- print "$includefile found at line $fileline in $filename was previously included\n";
- } else {
- # The file has not been previously found. Save it and
- # recursively process it.
- push (@$files,$includefile);
- get_includes($files,$includefile);
- }
- }
- }
- close IF;
- }
-}
-
-
-sub check_hyphens {
- my (@files) = @_;
- my ($filedata,$this,$linecnt,$before);
-
- # Build the test string to check for the various environments.
- # We only do the conversion if the multiple hyphens are outside of a
- # verbatim environment (either \begin{verbatim}...\end{verbatim} or
- # \verb{--}). Capture those environments and pass them to the output
- # unchanged.
-
- foreach my $file (@files) {
- # Open the file and load the whole thing into $filedata. A bit wasteful but
- # easier to deal with, and we don't have a problem with speed here.
- $filedata = "";
- open IF,"<$file" or die "Cannot open input file $file";
- while (<IF>) {
- $filedata .= $_;
- }
- close IF;
-
- # Set up to process the file data.
- $linecnt = 1;
-
- # Go through the file data from beginning to end. For each match, save what
- # came before it and what matched. $filedata now becomes only what came
- # after the match.
- # Chech the match to see if it starts with a multiple-hyphen. If so
- # warn the user. Keep track of line numbers so they can be output
- # with the warning message.
- while ($filedata =~ /$teststr/os) {
- $this = $&;
- $before = $`;
- $filedata = $';
- $linecnt += $before =~ tr/\n/\n/;
-
- # Check if the multiple hyphen is present outside of one of the
- # acceptable constructs.
- if ($this =~ /^\-+/) {
- print "Possible unwanted multiple hyphen found in line ",
- "$linecnt of file $file\n";
- }
- $linecnt += $this =~ tr/\n/\n/;
- }
- }
-}
-##################################################################
-# MAIN ####
-##################################################################
-
-my (@includes,$cnt);
-
-# Examine the file pointed to by the first argument to get a list of
-# includes to test.
-get_includes(\@includes,@ARGV);
-
-check_hyphens(@includes);
+++ /dev/null
-/* Century Schoolbook font is very similar to Computer Modern Math: cmmi */
-.MATH { font-family: "Century Schoolbook", serif; }
-.MATH I { font-family: "Century Schoolbook", serif; font-style: italic }
-.BOLDMATH { font-family: "Century Schoolbook", serif; font-weight: bold }
-
-/* implement both fixed-size and relative sizes */
-SMALL.XTINY { font-size : xx-small }
-SMALL.TINY { font-size : x-small }
-SMALL.SCRIPTSIZE { font-size : smaller }
-SMALL.FOOTNOTESIZE { font-size : small }
-SMALL.SMALL { }
-BIG.LARGE { }
-BIG.XLARGE { font-size : large }
-BIG.XXLARGE { font-size : x-large }
-BIG.HUGE { font-size : larger }
-BIG.XHUGE { font-size : xx-large }
-
-/* heading styles */
-H1 { }
-H2 { }
-H3 { }
-H4 { }
-H5 { }
-
-/* mathematics styles */
-DIV.displaymath { } /* math displays */
-TD.eqno { } /* equation-number cells */
-
-
-/* document-specific styles come next */
+++ /dev/null
-[General]
-img_extIsRegExp=false
-img_extensions=.eps .jpg .jpeg .png .pdf .ps .fig .gif
-kileprversion=2
-kileversion=2.0
-lastDocument=console.tex
-masterDocument=
-name=Console
-pkg_extIsRegExp=false
-pkg_extensions=.cls .sty
-src_extIsRegExp=false
-src_extensions=.tex .ltx .latex .dtx .ins
-
-[Tools]
-MakeIndex=
-QuickBuild=
-
-[item:bconsole.tex]
-archive=true
-column=47
-encoding=
-highlight=LaTeX
-line=1326
-open=false
-order=0
-
-[item:console.kilepr]
-archive=true
-column=0
-encoding=
-highlight=
-line=0
-open=false
-order=-1
-
-[item:console.tex]
-archive=true
-column=36
-encoding=UTF-8
-highlight=LaTeX
-line=54
-open=true
-order=0
-
-[item:fdl.tex]
-archive=true
-column=143392992
-encoding=
-highlight=
-line=0
-open=false
-order=-1
-
-[item:gui.tex]
-archive=true
-column=0
-encoding=
-highlight=LaTeX
-line=0
-open=false
-order=2
-
-[item:version.tex]
-archive=true
-column=0
-encoding=
-highlight=
-line=0
-open=false
-order=-1
+++ /dev/null
-%%
-%%
-%% The following characters must be preceded by a backslash
-%% to be entered as printable characters:
-%%
-%% # $ % & ~ _ ^ \ { }
-%%
-
-\documentclass[10pt,a4paper]{book}
-
-\topmargin -0.5in
-\oddsidemargin 0.0in
-\evensidemargin 0.0in
-\textheight 10in
-\textwidth 6.5in
-
-
-\usepackage{html}
-\usepackage{float}
-\usepackage{graphicx}
-\usepackage{bacula}
-\usepackage{longtable}
-\usepackage{makeidx}
-\usepackage{index}
-\usepackage{setspace}
-\usepackage{hyperref}
-\usepackage{url}
-\usepackage{german}
-
-
-\makeindex
-\newindex{general}{idx}{ind}{General Index}
-
-\sloppy
-
-\begin{document}
-\sloppy
-
-\newfont{\bighead}{cmr17 at 36pt}
-\parskip 10pt
-\parindent 0pt
-
-\title{\includegraphics{\idir bacula-logo.eps} \\ \bigskip
- \Huge{Bacula Console- und Benutzer-Handbuch}
- \begin{center}
- \large{Es kommt bei Nacht und saugt die lebenswichtigen Daten aus Ihren Computern.}
- \end{center}
-}
-
-
-\author{Kern Sibbald}
-\date{\vspace{1.0in}\today \\
- Dieses Handbuch dokumentiert Bacula \linebreak in der Version \fullversion \\
- \vspace{0.2in}
- Copyright \copyright 1999-2009, Free Software Foundation Europe
- e.V. \\
- \vspace{0.2in}
- Permission is granted to copy, distribute and/or modify this document under the terms of the
- GNU Free Documentation License, Version 1.2 published by the Free Software Foundation;
- with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
- A copy of the license is included in the section entitled "`GNU Free Documentation License"'.
-}
-
-\maketitle
-
-\clearpage
-\tableofcontents
-\clearpage
-%%no tables and figures
-%\listoffigures
-%\clearpage
-%\listoftables
-%\clearpage
-
-\include{bconsole}
-\include{gui}
-\include{fdl}
-
-
-% The following line tells link_resolver.pl to not include these files:
-% nolinks developersi baculai-dir baculai-fd baculai-sd baculai-console baculai-main
-
-% pull in the index
-\clearpage
-\printindex[general]
-
-\end{document}
+++ /dev/null
-#
-# Avoid that @VERSION@ and @DATE@ are changed by configure
-# This file is sourced by update_version
-#
-echo "s%@VERSION@%${VERSION}%g" >${out}
-echo "s%@DATE@%${DATE}%g" >>${out}
+++ /dev/null
-% TODO: maybe get rid of centering
-
-\chapter{GNU Free Documentation License}
-\index[general]{GNU Free Documentation License}
-\index[general]{License!GNU Free Documentation}
-
-\label{label_fdl}
-
- \begin{center}
-
- Version 1.2, November 2002
-
-
- Copyright \copyright 2000,2001,2002 Free Software Foundation, Inc.
-
- \bigskip
-
- 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-
- \bigskip
-
- Everyone is permitted to copy and distribute verbatim copies
- of this license document, but changing it is not allowed.
-\end{center}
-
-
-\begin{center}
-{\bf\large Preamble}
-\end{center}
-
-The purpose of this License is to make a manual, textbook, or other
-functional and useful document "free" in the sense of freedom: to
-assure everyone the effective freedom to copy and redistribute it,
-with or without modifying it, either commercially or noncommercially.
-Secondarily, this License preserves for the author and publisher a way
-to get credit for their work, while not being considered responsible
-for modifications made by others.
-
-This License is a kind of "`copyleft"', which means that derivative
-works of the document must themselves be free in the same sense. It
-complements the GNU General Public License, which is a copyleft
-license designed for free software.
-
-We have designed this License in order to use it for manuals for free
-software, because free software needs free documentation: a free
-program should come with manuals providing the same freedoms that the
-software does. But this License is not limited to software manuals;
-it can be used for any textual work, regardless of subject matter or
-whether it is published as a printed book. We recommend this License
-principally for works whose purpose is instruction or reference.
-
-
-\begin{center}
-{\Large\bf 1. APPLICABILITY AND DEFINITIONS}
-\end{center}
-
-This License applies to any manual or other work, in any medium, that
-contains a notice placed by the copyright holder saying it can be
-distributed under the terms of this License. Such a notice grants a
-world-wide, royalty-free license, unlimited in duration, to use that
-work under the conditions stated herein. The \textbf{"`Document"'}, below,
-refers to any such manual or work. Any member of the public is a
-licensee, and is addressed as \textbf{"`you"'}. You accept the license if you
-copy, modify or distribute the work in a way requiring permission
-under copyright law.
-
-A \textbf{"`Modified Version"'} of the Document means any work containing the
-Document or a portion of it, either copied verbatim, or with
-modifications and/or translated into another language.
-
-A \textbf{"`Secondary Section"'} is a named appendix or a front-matter section of
-the Document that deals exclusively with the relationship of the
-publishers or authors of the Document to the Document's overall subject
-(or to related matters) and contains nothing that could fall directly
-within that overall subject. (Thus, if the Document is in part a
-textbook of mathematics, a Secondary Section may not explain any
-mathematics.) The relationship could be a matter of historical
-connection with the subject or with related matters, or of legal,
-commercial, philosophical, ethical or political position regarding
-them.
-
-The \textbf{"`Invariant Sections"'} are certain Secondary Sections whose titles
-are designated, as being those of Invariant Sections, in the notice
-that says that the Document is released under this License. If a
-section does not fit the above definition of Secondary then it is not
-allowed to be designated as Invariant. The Document may contain zero
-Invariant Sections. If the Document does not identify any Invariant
-Sections then there are none.
-
-The \textbf{"`Cover Texts"'} are certain short passages of text that are listed,
-as Front-Cover Texts or Back-Cover Texts, in the notice that says that
-the Document is released under this License. A Front-Cover Text may
-be at most 5 words, and a Back-Cover Text may be at most 25 words.
-
-A \textbf{"`Transparent"'} copy of the Document means a machine-readable copy,
-represented in a format whose specification is available to the
-general public, that is suitable for revising the document
-straightforwardly with generic text editors or (for images composed of
-pixels) generic paint programs or (for drawings) some widely available
-drawing editor, and that is suitable for input to text formatters or
-for automatic translation to a variety of formats suitable for input
-to text formatters. A copy made in an otherwise Transparent file
-format whose markup, or absence of markup, has been arranged to thwart
-or discourage subsequent modification by readers is not Transparent.
-An image format is not Transparent if used for any substantial amount
-of text. A copy that is not "`Transparent"' is called \textbf{"`Opaque"'}.
-
-Examples of suitable formats for Transparent copies include plain
-ASCII without markup, Texinfo input format, LaTeX input format, SGML
-or XML using a publicly available DTD, and standard-conforming simple
-HTML, PostScript or PDF designed for human modification. Examples of
-transparent image formats include PNG, XCF and JPG. Opaque formats
-include proprietary formats that can be read and edited only by
-proprietary word processors, SGML or XML for which the DTD and/or
-processing tools are not generally available, and the
-machine-generated HTML, PostScript or PDF produced by some word
-processors for output purposes only.
-
-The \textbf{"`Title Page"'} means, for a printed book, the title page itself,
-plus such following pages as are needed to hold, legibly, the material
-this License requires to appear in the title page. For works in
-formats which do not have any title page as such, "`Title Page"' means
-the text near the most prominent appearance of the work's title,
-preceding the beginning of the body of the text.
-
-A section \textbf{"`Entitled XYZ"'} means a named subunit of the Document whose
-title either is precisely XYZ or contains XYZ in parentheses following
-text that translates XYZ in another language. (Here XYZ stands for a
-specific section name mentioned below, such as \textbf{"`Acknowledgements"'},
-\textbf{"`Dedications"'}, \textbf{"`Endorsements"'}, or \textbf{"`History"'}.)
-To \textbf{"`Preserve the Title"'}
-of such a section when you modify the Document means that it remains a
-section "`Entitled XYZ"' according to this definition.
-
-The Document may include Warranty Disclaimers next to the notice which
-states that this License applies to the Document. These Warranty
-Disclaimers are considered to be included by reference in this
-License, but only as regards disclaiming warranties: any other
-implication that these Warranty Disclaimers may have is void and has
-no effect on the meaning of this License.
-
-
-\begin{center}
-{\Large\bf 2. VERBATIM COPYING}
-\end{center}
-
-You may copy and distribute the Document in any medium, either
-commercially or noncommercially, provided that this License, the
-copyright notices, and the license notice saying this License applies
-to the Document are reproduced in all copies, and that you add no other
-conditions whatsoever to those of this License. You may not use
-technical measures to obstruct or control the reading or further
-copying of the copies you make or distribute. However, you may accept
-compensation in exchange for copies. If you distribute a large enough
-number of copies you must also follow the conditions in section 3.
-
-You may also lend copies, under the same conditions stated above, and
-you may publicly display copies.
-
-
-\begin{center}
-{\Large\bf 3. COPYING IN QUANTITY}
-\end{center}
-
-
-If you publish printed copies (or copies in media that commonly have
-printed covers) of the Document, numbering more than 100, and the
-Document's license notice requires Cover Texts, you must enclose the
-copies in covers that carry, clearly and legibly, all these Cover
-Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
-the back cover. Both covers must also clearly and legibly identify
-you as the publisher of these copies. The front cover must present
-the full title with all words of the title equally prominent and
-visible. You may add other material on the covers in addition.
-Copying with changes limited to the covers, as long as they preserve
-the title of the Document and satisfy these conditions, can be treated
-as verbatim copying in other respects.
-
-If the required texts for either cover are too voluminous to fit
-legibly, you should put the first ones listed (as many as fit
-reasonably) on the actual cover, and continue the rest onto adjacent
-pages.
-
-If you publish or distribute Opaque copies of the Document numbering
-more than 100, you must either include a machine-readable Transparent
-copy along with each Opaque copy, or state in or with each Opaque copy
-a computer-network location from which the general network-using
-public has access to download using public-standard network protocols
-a complete Transparent copy of the Document, free of added material.
-If you use the latter option, you must take reasonably prudent steps,
-when you begin distribution of Opaque copies in quantity, to ensure
-that this Transparent copy will remain thus accessible at the stated
-location until at least one year after the last time you distribute an
-Opaque copy (directly or through your agents or retailers) of that
-edition to the public.
-
-It is requested, but not required, that you contact the authors of the
-Document well before redistributing any large number of copies, to give
-them a chance to provide you with an updated version of the Document.
-
-
-\begin{center}
-{\Large\bf 4. MODIFICATIONS}
-\end{center}
-
-You may copy and distribute a Modified Version of the Document under
-the conditions of sections 2 and 3 above, provided that you release
-the Modified Version under precisely this License, with the Modified
-Version filling the role of the Document, thus licensing distribution
-and modification of the Modified Version to whoever possesses a copy
-of it. In addition, you must do these things in the Modified Version:
-
-\begin{itemize}
-\item[A.]
- Use in the Title Page (and on the covers, if any) a title distinct
- from that of the Document, and from those of previous versions
- (which should, if there were any, be listed in the History section
- of the Document). You may use the same title as a previous version
- if the original publisher of that version gives permission.
-
-\item[B.]
- List on the Title Page, as authors, one or more persons or entities
- responsible for authorship of the modifications in the Modified
- Version, together with at least five of the principal authors of the
- Document (all of its principal authors, if it has fewer than five),
- unless they release you from this requirement.
-
-\item[C.]
- State on the Title page the name of the publisher of the
- Modified Version, as the publisher.
-
-\item[D.]
- Preserve all the copyright notices of the Document.
-
-\item[E.]
- Add an appropriate copyright notice for your modifications
- adjacent to the other copyright notices.
-
-\item[F.]
- Include, immediately after the copyright notices, a license notice
- giving the public permission to use the Modified Version under the
- terms of this License, in the form shown in the Addendum below.
-
-\item[G.]
- Preserve in that license notice the full lists of Invariant Sections
- and required Cover Texts given in the Document's license notice.
-
-\item[H.]
- Include an unaltered copy of this License.
-
-\item[I.]
- Preserve the section Entitled "`History"', Preserve its Title, and add
- to it an item stating at least the title, year, new authors, and
- publisher of the Modified Version as given on the Title Page. If
- there is no section Entitled "`History"' in the Document, create one
- stating the title, year, authors, and publisher of the Document as
- given on its Title Page, then add an item describing the Modified
- Version as stated in the previous sentence.
-
-\item[J.]
- Preserve the network location, if any, given in the Document for
- public access to a Transparent copy of the Document, and likewise
- the network locations given in the Document for previous versions
- it was based on. These may be placed in the "`History"' section.
- You may omit a network location for a work that was published at
- least four years before the Document itself, or if the original
- publisher of the version it refers to gives permission.
-
-\item[K.]
- For any section Entitled "`Acknowledgements"' or "`Dedications"',
- Preserve the Title of the section, and preserve in the section all
- the substance and tone of each of the contributor acknowledgements
- and/or dedications given therein.
-
-\item[L.]
- Preserve all the Invariant Sections of the Document,
- unaltered in their text and in their titles. Section numbers
- or the equivalent are not considered part of the section titles.
-
-\item[M.]
- Delete any section Entitled "`Endorsements"'. Such a section
- may not be included in the Modified Version.
-
-\item[N.]
- Do not retitle any existing section to be Entitled "`Endorsements"'
- or to conflict in title with any Invariant Section.
-
-\item[O.]
- Preserve any Warranty Disclaimers.
-\end{itemize}
-
-If the Modified Version includes new front-matter sections or
-appendices that qualify as Secondary Sections and contain no material
-copied from the Document, you may at your option designate some or all
-of these sections as invariant. To do this, add their titles to the
-list of Invariant Sections in the Modified Version's license notice.
-These titles must be distinct from any other section titles.
-
-You may add a section Entitled "`Endorsements"', provided it contains
-nothing but endorsements of your Modified Version by various
-parties--for example, statements of peer review or that the text has
-been approved by an organization as the authoritative definition of a
-standard.
-
-You may add a passage of up to five words as a Front-Cover Text, and a
-passage of up to 25 words as a Back-Cover Text, to the end of the list
-of Cover Texts in the Modified Version. Only one passage of
-Front-Cover Text and one of Back-Cover Text may be added by (or
-through arrangements made by) any one entity. If the Document already
-includes a cover text for the same cover, previously added by you or
-by arrangement made by the same entity you are acting on behalf of,
-you may not add another; but you may replace the old one, on explicit
-permission from the previous publisher that added the old one.
-
-The author(s) and publisher(s) of the Document do not by this License
-give permission to use their names for publicity for or to assert or
-imply endorsement of any Modified Version.
-
-
-\begin{center}
-{\Large\bf 5. COMBINING DOCUMENTS}
-\end{center}
-
-
-You may combine the Document with other documents released under this
-License, under the terms defined in section 4 above for modified
-versions, provided that you include in the combination all of the
-Invariant Sections of all of the original documents, unmodified, and
-list them all as Invariant Sections of your combined work in its
-license notice, and that you preserve all their Warranty Disclaimers.
-
-The combined work need only contain one copy of this License, and
-multiple identical Invariant Sections may be replaced with a single
-copy. If there are multiple Invariant Sections with the same name but
-different contents, make the title of each such section unique by
-adding at the end of it, in parentheses, the name of the original
-author or publisher of that section if known, or else a unique number.
-Make the same adjustment to the section titles in the list of
-Invariant Sections in the license notice of the combined work.
-
-In the combination, you must combine any sections Entitled "`History"'
-in the various original documents, forming one section Entitled
-"`History"'; likewise combine any sections Entitled "`Acknowledgements"',
-and any sections Entitled "`Dedications"'. You must delete all sections
-Entitled "`Endorsements"'.
-
-\begin{center}
-{\Large\bf 6. COLLECTIONS OF DOCUMENTS}
-\end{center}
-
-You may make a collection consisting of the Document and other documents
-released under this License, and replace the individual copies of this
-License in the various documents with a single copy that is included in
-the collection, provided that you follow the rules of this License for
-verbatim copying of each of the documents in all other respects.
-
-You may extract a single document from such a collection, and distribute
-it individually under this License, provided you insert a copy of this
-License into the extracted document, and follow this License in all
-other respects regarding verbatim copying of that document.
-
-
-\begin{center}
-{\Large\bf 7. AGGREGATION WITH INDEPENDENT WORKS}
-\end{center}
-
-
-A compilation of the Document or its derivatives with other separate
-and independent documents or works, in or on a volume of a storage or
-distribution medium, is called an "`aggregate"' if the copyright
-resulting from the compilation is not used to limit the legal rights
-of the compilation's users beyond what the individual works permit.
-When the Document is included in an aggregate, this License does not
-apply to the other works in the aggregate which are not themselves
-derivative works of the Document.
-
-If the Cover Text requirement of section 3 is applicable to these
-copies of the Document, then if the Document is less than one half of
-the entire aggregate, the Document's Cover Texts may be placed on
-covers that bracket the Document within the aggregate, or the
-electronic equivalent of covers if the Document is in electronic form.
-Otherwise they must appear on printed covers that bracket the whole
-aggregate.
-
-
-\begin{center}
-{\Large\bf 8. TRANSLATION}
-\end{center}
-
-
-Translation is considered a kind of modification, so you may
-distribute translations of the Document under the terms of section 4.
-Replacing Invariant Sections with translations requires special
-permission from their copyright holders, but you may include
-translations of some or all Invariant Sections in addition to the
-original versions of these Invariant Sections. You may include a
-translation of this License, and all the license notices in the
-Document, and any Warranty Disclaimers, provided that you also include
-the original English version of this License and the original versions
-of those notices and disclaimers. In case of a disagreement between
-the translation and the original version of this License or a notice
-or disclaimer, the original version will prevail.
-
-If a section in the Document is Entitled "`Acknowledgements"',
-"`Dedications"', or "`History"', the requirement (section 4) to Preserve
-its Title (section 1) will typically require changing the actual
-title.
-
-
-\begin{center}
-{\Large\bf 9. TERMINATION}
-\end{center}
-
-
-You may not copy, modify, sublicense, or distribute the Document except
-as expressly provided for under this License. Any other attempt to
-copy, modify, sublicense or distribute the Document is void, and will
-automatically terminate your rights under this License. However,
-parties who have received copies, or rights, from you under this
-License will not have their licenses terminated so long as such
-parties remain in full compliance.
-
-
-\begin{center}
-{\Large\bf 10. FUTURE REVISIONS OF THIS LICENSE}
-\end{center}
-
-
-The Free Software Foundation may publish new, revised versions
-of the GNU Free Documentation License from time to time. Such new
-versions will be similar in spirit to the present version, but may
-differ in detail to address new problems or concerns. See
-http://www.gnu.org/copyleft/.
-
-Each version of the License is given a distinguishing version number.
-If the Document specifies that a particular numbered version of this
-License "`or any later version"' applies to it, you have the option of
-following the terms and conditions either of that specified version or
-of any later version that has been published (not as a draft) by the
-Free Software Foundation. If the Document does not specify a version
-number of this License, you may choose any version ever published (not
-as a draft) by the Free Software Foundation.
-
-
-\begin{center}
-{\Large\bf ADDENDUM: How to use this License for your documents}
-% TODO: this is too long for table of contents
-\end{center}
-
-To use this License in a document you have written, include a copy of
-the License in the document and put the following copyright and
-license notices just after the title page:
-
-\bigskip
-\begin{quote}
- Copyright \copyright YEAR YOUR NAME.
- Permission is granted to copy, distribute and/or modify this document
- under the terms of the GNU Free Documentation License, Version 1.2
- or any later version published by the Free Software Foundation;
- with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
- A copy of the license is included in the section entitled "`GNU
- Free Documentation License"'.
-\end{quote}
-\bigskip
-
-If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts,
-replace the "`with...Texts."' line with this:
-
-\bigskip
-\begin{quote}
- with the Invariant Sections being LIST THEIR TITLES, with the
- Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST.
-\end{quote}
-\bigskip
-
-If you have Invariant Sections without Cover Texts, or some other
-combination of the three, merge those two alternatives to suit the
-situation.
-
-If your document contains nontrivial examples of program code, we
-recommend releasing these examples in parallel under your choice of
-free software license, such as the GNU General Public License,
-to permit their use in free software.
-
-%---------------------------------------------------------------------
+++ /dev/null
-#!/usr/bin/perl -w
-# Fixes various things within tex files.
-
-use strict;
-
-my %args;
-
-
-sub get_includes {
- # Get a list of include files from the top-level tex file.
- my (@list,$file);
-
- foreach my $filename (@_) {
- $filename or next;
- # Start with the top-level latex file so it gets checked too.
- push (@list,$filename);
-
- # Get a list of all the html files in the directory.
- open IF,"<$filename" or die "Cannot open input file $filename";
- while (<IF>) {
- chomp;
- push @list,"$1.tex" if (/\\include\{(.*?)\}/);
- }
-
- close IF;
- }
- return @list;
-}
-
-sub convert_files {
- my (@files) = @_;
- my ($linecnt,$filedata,$output,$itemcnt,$indentcnt,$cnt);
-
- $cnt = 0;
- foreach my $file (@files) {
- # Open the file and load the whole thing into $filedata. A bit wasteful but
- # easier to deal with, and we don't have a problem with speed here.
- $filedata = "";
- open IF,"<$file" or die "Cannot open input file $file";
- while (<IF>) {
- $filedata .= $_;
- }
- close IF;
-
- # We look for a line that starts with \item, and indent the two next lines (if not blank)
- # by three spaces.
- my $linecnt = 3;
- $indentcnt = 0;
- $output = "";
- # Process a line at a time.
- foreach (split(/\n/,$filedata)) {
- $_ .= "\n"; # Put back the return.
- # If this line is less than the third line past the \item command,
- # and the line isn't blank and doesn't start with whitespace
- # add three spaces to the start of the line. Keep track of the number
- # of lines changed.
- if ($linecnt < 3 and !/^\\item/) {
- if (/^[^\n\s]/) {
- $output .= " " . $_;
- $indentcnt++;
- } else {
- $output .= $_;
- }
- $linecnt++;
- } else {
- $linecnt = 3;
- $output .= $_;
- }
- /^\\item / and $linecnt = 1;
- }
-
-
- # This is an item line. We need to process it too. If inside a \begin{description} environment, convert
- # \item {\bf xxx} to \item [xxx] or \item [{xxx}] (if xxx contains '[' or ']'.
- $itemcnt = 0;
- $filedata = $output;
- $output = "";
- my ($before,$descrip,$this,$between);
-
- # Find any \begin{description} environment
- while ($filedata =~ /(\\begin[\s\n]*\{[\s\n]*description[\s\n]*\})(.*?)(\\end[\s\n]*\{[\s\n]*description[\s\n]*\})/s) {
- $output .= $` . $1;
- $filedata = $3 . $';
- $descrip = $2;
-
- # Search for \item {\bf xxx}
- while ($descrip =~ /\\item[\s\n]*\{[\s\n]*\\bf[\s\n]*/s) {
- $descrip = $';
- $output .= $`;
- ($between,$descrip) = find_matching_brace($descrip);
- if (!$descrip) {
- $linecnt = $output =~ tr/\n/\n/;
- print STDERR "Missing matching curly brace at line $linecnt in $file\n" if (!$descrip);
- }
-
- # Now do the replacement.
- $between = '{' . $between . '}' if ($between =~ /\[|\]/);
- $output .= "\\item \[$between\]";
- $itemcnt++;
- }
- $output .= $descrip;
- }
- $output .= $filedata;
-
- # If any hyphens or \item commnads were converted, save the file.
- if ($indentcnt or $itemcnt) {
- open OF,">$file" or die "Cannot open output file $file";
- print OF $output;
- close OF;
- print "$indentcnt indent", ($indentcnt == 1) ? "" : "s"," added in $file\n";
- print "$itemcnt item", ($itemcnt == 1) ? "" : "s"," Changed in $file\n";
- }
-
- $cnt += $indentcnt + $itemcnt;
- }
- return $cnt;
-}
-
-sub find_matching_brace {
- # Finds text up to the next matching brace. Assumes that the input text doesn't contain
- # the opening brace, but we want to find text up to a matching closing one.
- # Returns the text between the matching braces, followed by the rest of the text following
- # (which does not include the matching brace).
- #
- my $str = shift;
- my ($this,$temp);
- my $cnt = 1;
-
- while ($cnt) {
- # Ignore verbatim constructs involving curly braces, or if the character preceding
- # the curly brace is a backslash.
- if ($str =~ /\\verb\*?\{.*?\{|\\verb\*?\}.*?\}|\{|\}/s) {
- $this .= $`;
- $str = $';
- $temp = $&;
-
- if ((substr($this,-1,1) eq '\\') or
- $temp =~ /^\\verb/) {
- $this .= $temp;
- next;
- }
-
- $cnt += ($temp eq '{') ? 1 : -1;
- # If this isn't the matching curly brace ($cnt > 0), include the brace.
- $this .= $temp if ($cnt);
- } else {
- # No matching curly brace found.
- return ($this . $str,'');
- }
- }
- return ($this,$str);
-}
-
-sub check_arguments {
- # Checks command-line arguments for ones starting with -- puts them into
- # a hash called %args and removes them from @ARGV.
- my $args = shift;
- my $i;
-
- for ($i = 0; $i < $#ARGV; $i++) {
- $ARGV[$i] =~ /^\-+/ or next;
- $ARGV[$i] =~ s/^\-+//;
- $args{$ARGV[$i]} = "";
- delete ($ARGV[$i]);
-
- }
-}
-
-##################################################################
-# MAIN ####
-##################################################################
-
-my @includes;
-my $cnt;
-
-check_arguments(\%args);
-die "No Files given to Check\n" if ($#ARGV < 0);
-
-# Examine the file pointed to by the first argument to get a list of
-# includes to test.
-@includes = get_includes(@ARGV);
-
-$cnt = convert_files(@includes);
-print "No lines changed\n" unless $cnt;
+++ /dev/null
-# This module does multiple indices, supporting the style of the LaTex 'index'
-# package.
-
-# Version Information:
-# 16-Feb-2005 -- Original Creation. Karl E. Cunningham
-# 14-Mar-2005 -- Clarified and Consolodated some of the code.
-# Changed to smoothly handle single and multiple indices.
-
-# Two LaTeX index formats are supported...
-# --- SINGLE INDEX ---
-# \usepackage{makeidx}
-# \makeindex
-# \index{entry1}
-# \index{entry2}
-# \index{entry3}
-# ...
-# \printindex
-#
-# --- MULTIPLE INDICES ---
-#
-# \usepackage{makeidx}
-# \usepackage{index}
-# \makeindex -- latex2html doesn't care but LaTeX does.
-# \newindex{ref1}{ext1}{ext2}{title1}
-# \newindex{ref2}{ext1}{ext2}{title2}
-# \newindex{ref3}{ext1}{ext2}{title3}
-# \index[ref1]{entry1}
-# \index[ref1]{entry2}
-# \index[ref3]{entry3}
-# \index[ref2]{entry4}
-# \index{entry5}
-# \index[ref3]{entry6}
-# ...
-# \printindex[ref1]
-# \printindex[ref2]
-# \printindex[ref3]
-# \printindex
-# ___________________
-#
-# For the multiple-index style, each index is identified by the ref argument to \newindex, \index,
-# and \printindex. A default index is allowed, which is indicated by omitting the optional
-# argument. The default index does not require a \newindex command. As \index commands
-# are encountered, their entries are stored according
-# to the ref argument. When the \printindex command is encountered, the stored index
-# entries for that argument are retrieved and printed. The title for each index is taken
-# from the last argument in the \newindex command.
-# While processing \index and \printindex commands, if no argument is given the index entries
-# are built into a default index. The title of the default index is simply "Index".
-# This makes the difference between single- and multiple-index processing trivial.
-#
-# Another method can be used by omitting the \printindex command and just using \include to
-# pull in index files created by the makeindex program. These files will start with
-# \begin{theindex}. This command is used to determine where to print the index. Using this
-# approach, the indices will be output in the same order as the newindex commands were
-# originally found (see below). Using a combination of \printindex and \include{indexfile} has not
-# been tested and may produce undesireable results.
-#
-# The index data are stored in a hash for later sorting and output. As \printindex
-# commands are handled, the order in which they were found in the tex filea is saved,
-# associated with the ref argument to \printindex.
-#
-# We use the original %index hash to store the index data into. We append a \002 followed by the
-# name of the index to isolate the entries in different indices from each other. This is necessary
-# so that different indices can have entries with the same name. For the default index, the \002 is
-# appended without the name.
-#
-# Since the index order in the output cannot be determined if the \include{indexfile}
-# command is used, the order will be assumed from the order in which the \newindex
-# commands were originally seen in the TeX files. This order is saved as well as the
-# order determined from any printindex{ref} commands. If \printindex commnads are used
-# to specify the index output, that order will be used. If the \include{idxfile} command
-# is used, the order of the original newindex commands will be used. In this case the
-# default index will be printed last since it doesn't have a corresponding \newindex
-# command and its order cannot be determined. Mixing \printindex and \include{idxfile}
-# commands in the same file is likely to produce less than satisfactory results.
-#
-#
-# The hash containing index data is named %indices. It contains the following data:
-#{
-# 'title' => {
-# $ref1 => $indextitle ,
-# $ref2 => $indextitle ,
-# ...
-# },
-# 'newcmdorder' => [ ref1, ref2, ..., * ], # asterisk indicates the position of the default index.
-# 'printindorder' => [ ref1, ref2, ..., * ], # asterisk indicates the position of the default index.
-#}
-
-
-# Globals to handle multiple indices.
-my %indices;
-
-# This tells the system to use up to 7 words in index entries.
-$WORDS_IN_INDEX = 10;
-
-# KEC 2-18-05
-# Handles the \newindex command. This is called if the \newindex command is
-# encountered in the LaTex source. Gets the index ref and title from the arguments.
-# Saves the index ref and title.
-# Note that we are called once to handle multiple \newindex commands that are
-# newline-separated.
-sub do_cmd_newindex {
- my $data = shift;
- # The data is sent to us as fields delimited by their ID #'s. We extract the
- # fields.
- foreach my $line (split("\n",$data)) {
- my @fields = split (/(?:\<\#\d+?\#\>)+/,$line);
-
- # The index name and title are the second and fourth fields in the data.
- if ($line =~ /^</ or $line =~ /^\\newindex/) {
- my ($indexref,$indextitle) = ($fields[1],$fields[4]);
- $indices{'title'}{$indexref} = $indextitle;
- push (@{$indices{'newcmdorder'}},$indexref);
- }
- }
-}
-
-
-# KEC -- Copied from makeidx.perl and modified to do multiple indices.
-# Processes an \index entry from the LaTex file.
-# Gets the optional argument from the index command, which is the name of the index
-# into which to place the entry.
-# Drops the brackets from the index_name
-# Puts the index entry into the html stream
-# Creates the tokenized index entry (which also saves the index entry info
-sub do_real_index {
- local($_) = @_;
- local($pat,$idx_entry,$index_name);
- # catches opt-arg from \index commands for index.sty
- $index_name = &get_next_optional_argument;
- $index_name = "" unless defined $index_name;
- # Drop leading and trailing brackets from the index name.
- $index_name =~ s/^\[|\]$//g;
-
- $idx_entry = &missing_braces unless (
- (s/$next_pair_pr_rx/$pat=$1;$idx_entry=$2;''/e)
- ||(s/$next_pair_rx/$pat=$1;$idx_entry=$2;''/e));
-
- if ($index_name and defined $idx_entry and
- !defined $indices{'title'}{$index_name}) {
- print STDERR "\nInvalid Index Name: \\index \[$index_name\]\{$idx_entry\}\n";
- }
-
- $idx_entry = &named_index_entry($pat, $idx_entry,$index_name);
- $idx_entry.$_;
-}
-
-# Creates and saves an index entry in the index hashes.
-# Modified to do multiple indices.
-# Creates an index_key that allows index entries to have the same characteristics but be in
-# different indices. This index_key is the regular key with the index name appended.
-# Save the index order for the entry in the %index_order hash.
-sub named_index_entry {
- local($br_id, $str, $index_name) = @_;
- my ($index_key);
- # escape the quoting etc characters
- # ! -> \001
- # @ -> \002
- # | -> \003
- $* = 1; $str =~ s/\n\s*/ /g; $* = 0; # remove any newlines
- # protect \001 occurring with images
- $str =~ s/\001/\016/g; # 0x1 to 0xF
- $str =~ s/\\\\/\011/g; # Double backslash -> 0xB
- $str =~ s/\\;SPMquot;/\012/g; # \;SPMquot; -> 0xC
- $str =~ s/;SPMquot;!/\013/g; # ;SPMquot; -> 0xD
- $str =~ s/!/\001/g; # Exclamation point -> 0x1
- $str =~ s/\013/!/g; # 0xD -> Exclaimation point
- $str =~ s/;SPMquot;@/\015/g; # ;SPMquot;@ to 0xF
- $str =~ s/@/\002/g; # At sign -> 0x2
- $str =~ s/\015/@/g; # 0xF to At sign
- $str =~ s/;SPMquot;\|/\017/g; # ;SMPquot;| to 0x11
- $str =~ s/\|/\003/g; # Vertical line to 0x3
- $str =~ s/\017/|/g; # 0x11 to vertical line
- $str =~ s/;SPMquot;(.)/\1/g; # ;SPMquot; -> whatever the next character is
- $str =~ s/\012/;SPMquot;/g; # 0x12 to ;SPMquot;
- $str =~ s/\011/\\\\/g; # 0x11 to double backslash
- local($key_part, $pageref) = split("\003", $str, 2);
-
- # For any keys of the form: blablabla!blablabla, which want to be split at the
- # exclamation point, replace the ! with a comma and a space. We don't do it
- # that way for this index.
- $key_part =~ s/\001/, /g;
- local(@keys) = split("\001", $key_part);
- # If TITLE is not yet available use $before.
- $TITLE = $saved_title if (($saved_title)&&(!($TITLE)||($TITLE eq $default_title)));
- $TITLE = $before unless $TITLE;
- # Save the reference
- local($words) = '';
- if ($SHOW_SECTION_NUMBERS) { $words = &make_idxnum; }
- elsif ($SHORT_INDEX) { $words = &make_shortidxname; }
- else { $words = &make_idxname; }
- local($super_key) = '';
- local($sort_key, $printable_key, $cur_key);
- foreach $key (@keys) {
- $key =~ s/\016/\001/g; # revert protected \001s
- ($sort_key, $printable_key) = split("\002", $key);
- #
- # RRM: 16 May 1996
- # any \label in the printable-key will have already
- # created a label where the \index occurred.
- # This has to be removed, so that the desired label
- # will be found on the Index page instead.
- #
- if ($printable_key =~ /tex2html_anchor_mark/ ) {
- $printable_key =~ s/><tex2html_anchor_mark><\/A><A//g;
- local($tmpA,$tmpB) = split("NAME=\"", $printable_key);
- ($tmpA,$tmpB) = split("\"", $tmpB);
- $ref_files{$tmpA}='';
- $index_labels{$tmpA} = 1;
- }
- #
- # resolve and clean-up the hyperlink index-entries
- # so they can be saved in an index.pl file
- #
- if ($printable_key =~ /$cross_ref_mark/ ) {
- local($label,$id,$ref_label);
- # $printable_key =~ s/$cross_ref_mark#(\w+)#(\w+)>$cross_ref_mark/
- $printable_key =~ s/$cross_ref_mark#([^#]+)#([^>]+)>$cross_ref_mark/
- do { ($label,$id) = ($1,$2);
- $ref_label = $external_labels{$label} unless
- ($ref_label = $ref_files{$label});
- '"' . "$ref_label#$label" . '">' .
- &get_ref_mark($label,$id)}
- /geo;
- }
- $printable_key =~ s/<\#[^\#>]*\#>//go;
- #RRM
- # recognise \char combinations, for a \backslash
- #
- $printable_key =~ s/\&\#;\'134/\\/g; # restore \\s
- $printable_key =~ s/\&\#;\`<BR> /\\/g; # ditto
- $printable_key =~ s/\&\#;*SPMquot;92/\\/g; # ditto
- #
- # $sort_key .= "@$printable_key" if !($printable_key); # RRM
- $sort_key .= "@$printable_key" if !($sort_key); # RRM
- $sort_key =~ tr/A-Z/a-z/;
- if ($super_key) {
- $cur_key = $super_key . "\001" . $sort_key;
- $sub_index{$super_key} .= $cur_key . "\004";
- } else {
- $cur_key = $sort_key;
- }
-
- # Append the $index_name to the current key with a \002 delimiter. This will
- # allow the same index entry to appear in more than one index.
- $index_key = $cur_key . "\002$index_name";
-
- $index{$index_key} .= "";
-
- #
- # RRM, 15 June 1996
- # if there is no printable key, but one is known from
- # a previous index-entry, then use it.
- #
- if (!($printable_key) && ($printable_key{$index_key}))
- { $printable_key = $printable_key{$index_key}; }
-# if (!($printable_key) && ($printable_key{$cur_key}))
-# { $printable_key = $printable_key{$cur_key}; }
- #
- # do not overwrite the printable_key if it contains an anchor
- #
- if (!($printable_key{$index_key} =~ /tex2html_anchor_mark/ ))
- { $printable_key{$index_key} = $printable_key || $key; }
-# if (!($printable_key{$cur_key} =~ /tex2html_anchor_mark/ ))
-# { $printable_key{$cur_key} = $printable_key || $key; }
-
- $super_key = $cur_key;
- }
- #
- # RRM
- # page-ranges, from |( and |) and |see
- #
- if ($pageref) {
- if ($pageref eq "\(" ) {
- $pageref = '';
- $next .= " from ";
- } elsif ($pageref eq "\)" ) {
- $pageref = '';
- local($next) = $index{$index_key};
-# local($next) = $index{$cur_key};
- # $next =~ s/[\|] *$//;
- $next =~ s/(\n )?\| $//;
- $index{$index_key} = "$next to ";
-# $index{$cur_key} = "$next to ";
- }
- }
-
- if ($pageref) {
- $pageref =~ s/\s*$//g; # remove trailing spaces
- if (!$pageref) { $pageref = ' ' }
- $pageref =~ s/see/<i>see <\/i> /g;
- #
- # RRM: 27 Dec 1996
- # check if $pageref corresponds to a style command.
- # If so, apply it to the $words.
- #
- local($tmp) = "do_cmd_$pageref";
- if (defined &$tmp) {
- $words = &$tmp("<#0#>$words<#0#>");
- $words =~ s/<\#[^\#]*\#>//go;
- $pageref = '';
- }
- }
- #
- # RRM: 25 May 1996
- # any \label in the pageref section will have already
- # created a label where the \index occurred.
- # This has to be removed, so that the desired label
- # will be found on the Index page instead.
- #
- if ($pageref) {
- if ($pageref =~ /tex2html_anchor_mark/ ) {
- $pageref =~ s/><tex2html_anchor_mark><\/A><A//g;
- local($tmpA,$tmpB) = split("NAME=\"", $pageref);
- ($tmpA,$tmpB) = split("\"", $tmpB);
- $ref_files{$tmpA}='';
- $index_labels{$tmpA} = 1;
- }
- #
- # resolve and clean-up any hyperlinks in the page-ref,
- # so they can be saved in an index.pl file
- #
- if ($pageref =~ /$cross_ref_mark/ ) {
- local($label,$id,$ref_label);
- # $pageref =~ s/$cross_ref_mark#(\w+)#(\w+)>$cross_ref_mark/
- $pageref =~ s/$cross_ref_mark#([^#]+)#([^>]+)>$cross_ref_mark/
- do { ($label,$id) = ($1,$2);
- $ref_files{$label} = ''; # ???? RRM
- if ($index_labels{$label}) { $ref_label = ''; }
- else { $ref_label = $external_labels{$label}
- unless ($ref_label = $ref_files{$label});
- }
- '"' . "$ref_label#$label" . '">' . &get_ref_mark($label,$id)}/geo;
- }
- $pageref =~ s/<\#[^\#>]*\#>//go;
-
- if ($pageref eq ' ') { $index{$index_key}='@'; }
- else { $index{$index_key} .= $pageref . "\n | "; }
- } else {
- local($thisref) = &make_named_href('',"$CURRENT_FILE#$br_id",$words);
- $thisref =~ s/\n//g;
- $index{$index_key} .= $thisref."\n | ";
- }
- #print "\nREF: $sort_key : $index_key :$index{$index_key}";
-
- #join('',"<A NAME=$br_id>$anchor_invisible_mark<\/A>",$_);
-
- "<A NAME=\"$br_id\">$anchor_invisible_mark<\/A>";
-}
-
-
-# KEC. -- Copied from makeidx.perl, then modified to do multiple indices.
-# Feeds the index entries to the output. This is called for each index to be built.
-#
-# Generates a list of lookup keys for index entries, from both %printable_keys
-# and %index keys.
-# Sorts the keys according to index-sorting rules.
-# Removes keys with a 0x01 token. (duplicates?)
-# Builds a string to go to the index file.
-# Adds the index entries to the string if they belong in this index.
-# Keeps track of which index is being worked on, so only the proper entries
-# are included.
-# Places the index just built in to the output at the proper place.
-{ my $index_number = 0;
-sub add_real_idx {
- print "\nDoing the index ... Index Number $index_number\n";
- local($key, @keys, $next, $index, $old_key, $old_html);
- my ($idx_ref,$keyref);
- # RRM, 15.6.96: index constructed from %printable_key, not %index
- @keys = keys %printable_key;
-
- while (/$idx_mark/) {
- # Get the index reference from what follows the $idx_mark and
- # remove it from the string.
- s/$idxmark\002(.*?)\002/$idxmark/;
- $idx_ref = $1;
- $index = '';
- # include non- makeidx index-entries
- foreach $key (keys %index) {
- next if $printable_key{$key};
- $old_key = $key;
- if ($key =~ s/###(.*)$//) {
- next if $printable_key{$key};
- push (@keys, $key);
- $printable_key{$key} = $key;
- if ($index{$old_key} =~ /HREF="([^"]*)"/i) {
- $old_html = $1;
- $old_html =~ /$dd?([^#\Q$dd\E]*)#/;
- $old_html = $1;
- } else { $old_html = '' }
- $index{$key} = $index{$old_key} . $old_html."</A>\n | ";
- };
- }
- @keys = sort makeidx_keysort @keys;
- @keys = grep(!/\001/, @keys);
- my $cnt = 0;
- foreach $key (@keys) {
- my ($keyref) = $key =~ /.*\002(.*)/;
- next unless ($idx_ref eq $keyref); # KEC.
- $index .= &add_idx_key($key);
- $cnt++;
- }
- print "$cnt Index Entries Added\n";
- $index = '<DD>'.$index unless ($index =~ /^\s*<D(D|T)>/);
- $index_number++; # KEC.
- if ($SHORT_INDEX) {
- print "(compact version with Legend)";
- local($num) = ( $index =~ s/\<D/<D/g );
- if ($num > 50 ) {
- s/$idx_mark/$preindex<HR><DL>\n$index\n<\/DL>$preindex/o;
- } else {
- s/$idx_mark/$preindex<HR><DL>\n$index\n<\/DL>/o;
- }
- } else {
- s/$idx_mark/<DL COMPACT>\n$index\n<\/DL>/o; }
- }
-}
-}
-
-# KEC. Copied from latex2html.pl and modified to support multiple indices.
-# The bibliography and the index should be treated as separate sections
-# in their own HTML files. The \bibliography{} command acts as a sectioning command
-# that has the desired effect. But when the bibliography is constructed
-# manually using the thebibliography environment, or when using the
-# theindex environment it is not possible to use the normal sectioning
-# mechanism. This subroutine inserts a \bibliography{} or a dummy
-# \textohtmlindex command just before the appropriate environments
-# to force sectioning.
-sub add_bbl_and_idx_dummy_commands {
- local($id) = $global{'max_id'};
-
- s/([\\]begin\s*$O\d+$C\s*thebibliography)/$bbl_cnt++; $1/eg;
- ## if ($bbl_cnt == 1) {
- s/([\\]begin\s*$O\d+$C\s*thebibliography)/$id++; "\\bibliography$O$id$C$O$id$C $1"/geo;
- #}
- $global{'max_id'} = $id;
- # KEC. Modified to global substitution to place multiple index tokens.
- s/[\\]begin\s*($O\d+$C)\s*theindex/\\textohtmlindex$1/go;
- # KEC. Modified to pick up the optional argument to \printindex
- s/[\\]printindex\s*(\[.*?\])?/
- do { (defined $1) ? "\\textohtmlindex $1" : "\\textohtmlindex []"; } /ego;
- &lib_add_bbl_and_idx_dummy_commands() if defined(&lib_add_bbl_and_idx_dummy_commands);
-}
-
-# KEC. Copied from latex2html.pl and modified to support multiple indices.
-# For each textohtmlindex mark found, determine the index titles and headers.
-# We place the index ref in the header so the proper index can be generated later.
-# For the default index, the index ref is blank.
-#
-# One problem is that this routine is called twice.. Once for processing the
-# command as originally seen, and once for processing the command when
-# doing the name for the index file. We can detect that by looking at the
-# id numbers (or ref) surrounding the \theindex command, and not incrementing
-# index_number unless a new id (or ref) is seen. This has the side effect of
-# having to unconventionally start the index_number at -1. But it works.
-#
-# Gets the title from the list of indices.
-# If this is the first index, save the title in $first_idx_file. This is what's referenced
-# in the navigation buttons.
-# Increment the index_number for next time.
-# If the indexname command is defined or a newcommand defined for indexname, do it.
-# Save the index TITLE in the toc
-# Save the first_idx_file into the idxfile. This goes into the nav buttons.
-# Build index_labels if needed.
-# Create the index headings and put them in the output stream.
-
-{ my $index_number = 0; # Will be incremented before use.
- my $first_idx_file; # Static
- my $no_increment = 0;
-
-sub do_cmd_textohtmlindex {
- local($_) = @_;
- my ($idxref,$idxnum,$index_name);
-
- # We get called from make_name with the first argument = "\001noincrement". This is a sign
- # to not increment $index_number the next time we are called. We get called twice, once
- # my make_name and once by process_command. Unfortunately, make_name calls us just to set the name
- # but doesn't use the result so we get called a second time by process_command. This works fine
- # except for cases where there are multiple indices except if they aren't named, which is the case
- # when the index is inserted by an include command in latex. In these cases we are only able to use
- # the index number to decide which index to draw from, and we don't know how to increment that index
- # number if we get called a variable number of times for the same index, as is the case between
- # making html (one output file) and web (multiple output files) output formats.
- if (/\001noincrement/) {
- $no_increment = 1;
- return;
- }
-
- # Remove (but save) the index reference
- s/^\s*\[(.*?)\]/{$idxref = $1; "";}/e;
-
- # If we have an $idxref, the index name was specified. In this case, we have all the
- # information we need to carry on. Otherwise, we need to get the idxref
- # from the $index_number and set the name to "Index".
- if ($idxref) {
- $index_name = $indices{'title'}{$idxref};
- } else {
- if (defined ($idxref = $indices{'newcmdorder'}->[$index_number])) {
- $index_name = $indices{'title'}{$idxref};
- } else {
- $idxref = '';
- $index_name = "Index";
- }
- }
-
- $idx_title = "Index"; # The name displayed in the nav bar text.
-
- # Only set $idxfile if we are at the first index. This will point the
- # navigation panel to the first index file rather than the last.
- $first_idx_file = $CURRENT_FILE if ($index_number == 0);
- $idxfile = $first_idx_file; # Pointer for the Index button in the nav bar.
- $toc_sec_title = $index_name; # Index link text in the toc.
- $TITLE = $toc_sec_title; # Title for this index, from which its filename is built.
- if (%index_labels) { &make_index_labels(); }
- if (($SHORT_INDEX) && (%index_segment)) { &make_preindex(); }
- else { $preindex = ''; }
- local $idx_head = $section_headings{'textohtmlindex'};
- local($heading) = join(''
- , &make_section_heading($TITLE, $idx_head)
- , $idx_mark, "\002", $idxref, "\002" );
- local($pre,$post) = &minimize_open_tags($heading);
- $index_number++ unless ($no_increment);
- $no_increment = 0;
- join('',"<BR>\n" , $pre, $_);
-}
-}
-
-# Returns an index key, given the key passed as the first argument.
-# Not modified for multiple indices.
-sub add_idx_key {
- local($key) = @_;
- local($index, $next);
- if (($index{$key} eq '@' )&&(!($index_printed{$key}))) {
- if ($SHORT_INDEX) { $index .= "<DD><BR>\n<DT>".&print_key."\n<DD>"; }
- else { $index .= "<DT><DD><BR>\n<DT>".&print_key."\n<DD>"; }
- } elsif (($index{$key})&&(!($index_printed{$key}))) {
- if ($SHORT_INDEX) {
- $next = "<DD>".&print_key."\n : ". &print_idx_links;
- } else {
- $next = "<DT>".&print_key."\n<DD>". &print_idx_links;
- }
- $index .= $next."\n";
- $index_printed{$key} = 1;
- }
-
- if ($sub_index{$key}) {
- local($subkey, @subkeys, $subnext, $subindex);
- @subkeys = sort(split("\004", $sub_index{$key}));
- if ($SHORT_INDEX) {
- $index .= "<DD>".&print_key unless $index_printed{$key};
- $index .= "<DL>\n";
- } else {
- $index .= "<DT>".&print_key."\n<DD>" unless $index_printed{$key};
- $index .= "<DL COMPACT>\n";
- }
- foreach $subkey (@subkeys) {
- $index .= &add_sub_idx_key($subkey) unless ($index_printed{$subkey});
- }
- $index .= "</DL>\n";
- }
- return $index;
-}
-
-1; # Must be present as the last line.
+++ /dev/null
-# This file serves as a place to put initialization code and constants to
-# affect the behavior of latex2html for generating the bacula manuals.
-
-# $LINKPOINT specifies what filename to use to link to when creating
-# index.html. Not that this is a hard link.
-$LINKPOINT='"$OVERALL_TITLE"';
-
-
-# The following must be the last line of this file.
-1;
+++ /dev/null
-/*
- * html2latex
- */
-
-available {
- sun4_sunos.4
- sun4_solaris.2
- rs_aix.3
- rs_aix.4
- sgi_irix
-}
-
-description {
- From Jeffrey Schaefer, Geometry Center. Translates HTML document to LaTeX
-}
-
-install {
- bin/html2latex /afs/rpi.edu/dept/acs/rpinfo/filters/GChtml2latex/html2latex
- bin/html2latex.tag /afs/rpi.edu/dept/acs/rpinfo/filters/GChtml2latex/html2latex.tag
- bin/html2latex-local.tag /afs/rpi.edu/dept/acs/rpinfo/filters/GChtml2latex/html2latex-local.tag
- bin/webtex2latex.tag /afs/rpi.edu/dept/acs/rpinfo/filters/GChtml2latex/webtex2latex.tag
- man/man1/html2latex.1 /afs/rpi.edu/dept/acs/rpinfo/filters/GChtml2latex/html2latex.1
-}
+++ /dev/null
-#!/usr/bin/perl -w
-#
-use strict;
-
-# Used to change the names of the image files generated by latex2html from imgxx.png
-# to meaningful names. Provision is made to go either from or to the meaningful names.
-# The meaningful names are obtained from a file called imagename_translations, which
-# is generated by extensions to latex2html in the make_image_file subroutine in
-# bacula.perl.
-
-# Opens the file imagename_translations and reads the contents into a hash.
-# The hash is creaed with the imgxx.png files as the key if processing TO
-# meaningful filenames, and with the meaningful filenames as the key if
-# processing FROM meaningful filenames.
-# Then opens the html file(s) indicated in the command-line arguments and
-# changes all image references according to the translations described in the
-# above file. Finally, it renames the image files.
-#
-# Original creation: 3-27-05 by Karl Cunningham.
-# Modified 5-21-05 to go FROM and TO meaningful filenames.
-#
-my $TRANSFILE = "imagename_translations";
-my $path;
-
-# Loads the contents of $TRANSFILE file into the hash referenced in the first
-# argument. The hash is loaded to translate old to new if $direction is 0,
-# otherwise it is loaded to translate new to old. In this context, the
-# 'old' filename is the meaningful name, and the 'new' filename is the
-# imgxx.png filename. It is assumed that the old image is the one that
-# latex2html has used as the source to create the imgxx.png filename.
-# The filename extension is taken from the file
-sub read_transfile {
- my ($trans,$direction) = @_;
-
- if (!open IN,"<$path$TRANSFILE") {
- print "WARNING: Cannot open image translation file $path$TRANSFILE for reading\n";
- print " Image filename translation aborted\n\n";
- exit 0;
- }
-
- while (<IN>) {
- chomp;
- my ($new,$old) = split(/\001/);
-
- # Old filenames will usually have a leading ./ which we don't need.
- $old =~ s/^\.\///;
-
- # The filename extension of the old filename must be made to match
- # the new filename because it indicates the encoding format of the image.
- my ($ext) = $new =~ /(\.[^\.]*)$/;
- $old =~ s/\.[^\.]*$/$ext/;
- if ($direction == 0) {
- $trans->{$new} = $old;
- } else {
- $trans->{$old} = $new;
- }
- }
- close IN;
-}
-
-# Translates the image names in the file given as the first argument, according to
-# the translations in the hash that is given as the second argument.
-# The file contents are read in entirely into a string, the string is processed, and
-# the file contents are then written. No particular care is taken to ensure that the
-# file is not lost if a system failure occurs at an inopportune time. It is assumed
-# that the html files being processed here can be recreated on demand.
-#
-# Links to other files are added to the %filelist for processing. That way,
-# all linked files will be processed (assuming they are local).
-sub translate_html {
- my ($filename,$trans,$filelist) = @_;
- my ($contents,$out,$this,$img,$dest);
- my $cnt = 0;
-
- # If the filename is an external link ignore it. And drop any file:// from
- # the filename.
- $filename =~ /^(http|ftp|mailto)\:/ and return 0;
- $filename =~ s/^file\:\/\///;
- # Load the contents of the html file.
- if (!open IF,"<$path$filename") {
- print "WARNING: Cannot open $path$filename for reading\n";
- print " Image Filename Translation aborted\n\n";
- exit 0;
- }
-
- while (<IF>) {
- $contents .= $_;
- }
- close IF;
-
- # Now do the translation...
- # First, search for an image filename.
- while ($contents =~ /\<\s*IMG[^\>]*SRC=\"/si) {
- $contents = $';
- $out .= $` . $&;
-
- # The next thing is an image name. Get it and translate it.
- $contents =~ /^(.*?)\"/s;
- $contents = $';
- $this = $&;
- $img = $1;
- # If the image is in our list of ones to be translated, do it
- # and feed the result to the output.
- $cnt += $this =~ s/$img/$trans->{$img}/ if (defined($trans->{$img}));
- $out .= $this;
- }
- $out .= $contents;
-
- # Now send the translated text to the html file, overwriting what's there.
- open OF,">$path$filename" or die "Cannot open $path$filename for writing\n";
- print OF $out;
- close OF;
-
- # Now look for any links to other files and add them to the list of files to do.
- while ($out =~ /\<\s*A[^\>]*HREF=\"(.*?)\"/si) {
- $out = $';
- $dest = $1;
- # Drop an # and anything after it.
- $dest =~ s/\#.*//;
- $filelist->{$dest} = '' if $dest;
- }
- return $cnt;
-}
-
-# REnames the image files spefified in the %translate hash.
-sub rename_images {
- my $translate = shift;
- my ($response);
-
- foreach (keys(%$translate)) {
- if (! $translate->{$_}) {
- print " WARNING: No destination Filename for $_\n";
- } else {
- $response = `mv -f $path$_ $path$translate->{$_} 2>&1`;
- $response and print "ERROR from system $response\n";
- }
- }
-}
-
-#################################################
-############# MAIN #############################
-################################################
-
-# %filelist starts out with keys from the @ARGV list. As files are processed,
-# any links to other files are added to the %filelist. A hash of processed
-# files is kept so we don't do any twice.
-
-# The first argument must be either --to_meaningful_names or --from_meaningful_names
-
-my (%translate,$search_regex,%filelist,%completed,$thisfile);
-my ($cnt,$direction);
-
-my $arg0 = shift(@ARGV);
-$arg0 =~ /^(--to_meaningful_names|--from_meaningful_names)$/ or
- die "ERROR: First argument must be either \'--to_meaningful_names\' or \'--from_meaningful_names\'\n";
-
-$direction = ($arg0 eq '--to_meaningful_names') ? 0 : 1;
-
-(@ARGV) or die "ERROR: Filename(s) to process must be given as arguments\n";
-
-# Use the first argument to get the path to the file of translations.
-my $tmp = $ARGV[0];
-($path) = $tmp =~ /(.*\/)/;
-$path = '' unless $path;
-
-read_transfile(\%translate,$direction);
-
-foreach (@ARGV) {
- # Strip the path from the filename, and use it later on.
- if (s/(.*\/)//) {
- $path = $1;
- } else {
- $path = '';
- }
- $filelist{$_} = '';
-
- while ($thisfile = (keys(%filelist))[0]) {
- $cnt += translate_html($thisfile,\%translate,\%filelist) if (!exists($completed{$thisfile}));
- delete($filelist{$thisfile});
- $completed{$thisfile} = '';
- }
- print "translate_images.pl: $cnt image filenames translated ",($direction)?"from":"to"," meaningful names\n";
-}
-
-rename_images(\%translate);
+++ /dev/null
-#
-#
-# Makefile for LaTeX
-#
-# To build everything do
-# make tex
-# make web
-# make html
-# make dvipdf
-#
-# or simply
-#
-# make
-#
-
-IMAGES=../../../images
-
-DOC=developers
-
-first_rule: all
-
-all: tex web dvipdf mini-clean
-
-.SUFFIXES: .tex .html
-.PHONY:
-.DONTCARE:
-
-
-tex:
- @cp -fp ${IMAGES}/hires/*.eps .
- touch ${DOC}.idx ${DOC}i-general.tex
- -latex -interaction=batchmode ${DOC}.tex
- makeindex ${DOC}.idx >/dev/null 2>/dev/null
- -latex -interaction=batchmode ${DOC}.tex
-
-pdf:
- @echo "Making ${DOC} pdf"
- @cp -fp ${IMAGES}/hires/*.eps .
- dvipdf ${DOC}.dvi ${DOC}.pdf
- @rm -f *.eps *.old
-
-dvipdf:
- @echo "Making ${DOC} pdfm"
- @cp -fp ${IMAGES}/hires/*.eps .
- dvipdfm -p a4 ${DOC}.dvi >tex.out 2>&1
-
-html:
- @echo "Making ${DOC} html"
- @cp -fp ${IMAGES}/*.eps .
- @rm -f next.eps next.png prev.eps prev.png up.eps up.png
- @touch ${DOC}.html
- @(if [ -f imagename_translations ] ; then \
- ./translate_images.pl --from_meaningful_names ${DOC}.html; \
- fi)
- latex2html -white -no_subdir -split 0 -toc_stars -white -notransparent \
- ${DOC} >tex.out 2>&1
- ./translate_images.pl --to_meaningful_names ${DOC}.html
- @rm -f *.eps *.gif *.jpg *.old
-
-web:
- @echo "Making ${DOC} web"
- @mkdir -p ${DOC}
- @rm -f ${DOC}/*
- @cp -fp ${IMAGES}/*.eps .
- @rm -f next.eps next.png prev.eps prev.png up.eps up.png
- @cp -fp ${IMAGES}/*.eps ${IMAGES}/*.png ${DOC}/
- @rm -f ${DOC}/next.eps ${DOC}/next.png ${DOC}/prev.eps ${DOC}/prev.png ${DOC}/up.eps ${DOC}/up.png
- @(if [ -f ${DOC}/imagename_translations ] ; then \
- ./translate_images.pl --to_meaningful_names ${DOC}/Developer*Guide.html; \
- fi)
- @rm -rf ${DOC}/*.html
- latex2html -split 4 -local_icons -t "Developer's Guide" -long_titles 4 \
- -contents_in_nav -toc_stars -white -notransparent ${DOC} >tex.out 2>&1
- ./translate_images.pl --to_meaningful_names ${DOC}/Developer*Guide.html
- @cp -f ${DOC}/Developer_s_Guide.html ${DOC}/index.html
- @rm -f *.eps *.gif *.jpg ${DOC}/*.eps *.old
- @rm -f ${DOC}/idle.png
- @rm -f ${DOC}/win32-*.png ${DOC}/wx-console*.png ${DOC}/xp-*.png
- @rm -f ${DOC}/*.pl ${DOC}/*.log ${DOC}/*.aux ${DOC}/*.idx
- @rm -f ${DOC}/*.out WARNINGS
-
-texcheck:
- ./check_tex.pl ${DOC}.tex
-
-main_configs:
- pic2graph -density 100 <main_configs.pic >main_configs.png
-
-mini-clean:
- @rm -f 1 2 3 *.tex~
- @rm -f *.gif *.jpg *.eps
- @rm -f *.aux *.cp *.fn *.ky *.log *.pg
- @rm -f *.backup *.ilg *.lof *.lot
- @rm -f *.cdx *.cnd *.ddx *.ddn *.fdx *.fnd *.ind *.sdx *.snd
- @rm -f *.dnd *.old *.out
- @rm -f ${DOC}/*.gif ${DOC}/*.jpg ${DOC}/*.eps
- @rm -f ${DOC}/*.aux ${DOC}/*.cp ${DOC}/*.fn ${DOC}/*.ky ${DOC}/*.log ${DOC}/*.pg
- @rm -f ${DOC}/*.backup ${DOC}/*.ilg ${DOC}/*.lof ${DOC}/*.lot
- @rm -f ${DOC}/*.cdx ${DOC}/*.cnd ${DOC}/*.ddx ${DOC}/*.ddn ${DOC}/*.fdx ${DOC}/*.fnd ${DOC}/*.ind ${DOC}/*.sdx ${DOC}/*.snd
- @rm -f ${DOC}/*.dnd ${DOC}/*.old ${DOC}/*.out
- @rm -f ${DOC}/WARNINGS
-
-clean:
- @rm -f 1 2 3
- @rm -f *.png *.gif *.jpg *.eps
- @rm -f *.pdf *.aux *.cp *.fn *.ky *.log *.pg
- @rm -f *.html *.backup *.pdf *.ps *.dvi *.ilg *.lof *.lot
- @rm -f *.cdx *.cnd *.ddx *.ddn *.fdx *.fnd *.ind *.sdx *.snd
- @rm -f *.dnd imagename_translations
- @rm -f *.old WARNINGS *.out *.toc *.idx
- @rm -f images.pl labels.pl internals.pl
- @rm -rf ${DOC}
- @rm -f images.tex ${DOC}i.tex
- @rm -f ${DOC}i-*.tex
-
-
-distclean: clean
- @rm -f ${DOC}.html ${DOC}.pdf
- @rm -f Makefile version.tex
+++ /dev/null
-%%
-%%
-
-\chapter{Catalog Services}
-\label{_ChapterStart30}
-\index[general]{Services!Catalog }
-\index[general]{Catalog Services }
-
-\section{General}
-\index[general]{General }
-\addcontentsline{toc}{subsection}{General}
-
-This chapter is intended to be a technical discussion of the Catalog services
-and as such is not targeted at end users but rather at developers and system
-administrators that want or need to know more of the working details of {\bf
-Bacula}.
-
-The {\bf Bacula Catalog} services consist of the programs that provide the SQL
-database engine for storage and retrieval of all information concerning files
-that were backed up and their locations on the storage media.
-
-We have investigated the possibility of using the following SQL engines for
-Bacula: Beagle, mSQL, GNU SQL, PostgreSQL, SQLite, Oracle, and MySQL. Each
-presents certain problems with either licensing or maturity. At present, we
-have chosen for development purposes to use MySQL, PostgreSQL and SQLite.
-MySQL was chosen because it is fast, proven to be reliable, widely used, and
-actively being developed. MySQL is released under the GNU GPL license.
-PostgreSQL was chosen because it is a full-featured, very mature database, and
-because Dan Langille did the Bacula driver for it. PostgreSQL is distributed
-under the BSD license. SQLite was chosen because it is small, efficient, and
-can be directly embedded in {\bf Bacula} thus requiring much less effort from
-the system administrator or person building {\bf Bacula}. In our testing
-SQLite has performed very well, and for the functions that we use, it has
-never encountered any errors except that it does not appear to handle
-databases larger than 2GBytes. That said, we would not recommend it for
-serious production use.
-
-The Bacula SQL code has been written in a manner that will allow it to be
-easily modified to support any of the current SQL database systems on the
-market (for example: mSQL, iODBC, unixODBC, Solid, OpenLink ODBC, EasySoft
-ODBC, InterBase, Oracle8, Oracle7, and DB2).
-
-If you do not specify either {\bf \verb{--{with-mysql} or {\bf \verb{--{with-postgresql} or
-{\bf \verb{--{with-sqlite} on the ./configure line, Bacula will use its minimalist
-internal database. This database is kept for build reasons but is no longer
-supported. Bacula {\bf requires} one of the three databases (MySQL,
-PostgreSQL, or SQLite) to run.
-
-\subsection{Filenames and Maximum Filename Length}
-\index[general]{Filenames and Maximum Filename Length }
-\index[general]{Length!Filenames and Maximum Filename }
-\addcontentsline{toc}{subsubsection}{Filenames and Maximum Filename Length}
-
-In general, either MySQL, PostgreSQL or SQLite permit storing arbitrary long
-path names and file names in the catalog database. In practice, there still
-may be one or two places in the Catalog interface code that restrict the
-maximum path length to 512 characters and the maximum file name length to 512
-characters. These restrictions are believed to have been removed. Please note,
-these restrictions apply only to the Catalog database and thus to your ability
-to list online the files saved during any job. All information received and
-stored by the Storage daemon (normally on tape) allows and handles arbitrarily
-long path and filenames.
-
-\subsection{Installing and Configuring MySQL}
-\index[general]{MySQL!Installing and Configuring }
-\index[general]{Installing and Configuring MySQL }
-\addcontentsline{toc}{subsubsection}{Installing and Configuring MySQL}
-
-For the details of installing and configuring MySQL, please see the
-\ilink{Installing and Configuring MySQL}{_ChapterStart} chapter of
-this manual.
-
-\subsection{Installing and Configuring PostgreSQL}
-\index[general]{PostgreSQL!Installing and Configuring }
-\index[general]{Installing and Configuring PostgreSQL }
-\addcontentsline{toc}{subsubsection}{Installing and Configuring PostgreSQL}
-
-For the details of installing and configuring PostgreSQL, please see the
-\ilink{Installing and Configuring PostgreSQL}{_ChapterStart10}
-chapter of this manual.
-
-\subsection{Installing and Configuring SQLite}
-\index[general]{Installing and Configuring SQLite }
-\index[general]{SQLite!Installing and Configuring }
-\addcontentsline{toc}{subsubsection}{Installing and Configuring SQLite}
-
-For the details of installing and configuring SQLite, please see the
-\ilink{Installing and Configuring SQLite}{_ChapterStart33} chapter of
-this manual.
-
-\subsection{Internal Bacula Catalog}
-\index[general]{Catalog!Internal Bacula }
-\index[general]{Internal Bacula Catalog }
-\addcontentsline{toc}{subsubsection}{Internal Bacula Catalog}
-
-Please see the
-\ilink{Internal Bacula Database}{_ChapterStart42} chapter of this
-manual for more details.
-
-\subsection{Database Table Design}
-\index[general]{Design!Database Table }
-\index[general]{Database Table Design }
-\addcontentsline{toc}{subsubsection}{Database Table Design}
-
-All discussions that follow pertain to the MySQL database. The details for the
-PostgreSQL and SQLite databases are essentially identical except for that all
-fields in the SQLite database are stored as ASCII text and some of the
-database creation statements are a bit different. The details of the internal
-Bacula catalog are not discussed here.
-
-Because the Catalog database may contain very large amounts of data for large
-sites, we have made a modest attempt to normalize the data tables to reduce
-redundant information. While reducing the size of the database significantly,
-it does, unfortunately, add some complications to the structures.
-
-In simple terms, the Catalog database must contain a record of all Jobs run by
-Bacula, and for each Job, it must maintain a list of all files saved, with
-their File Attributes (permissions, create date, ...), and the location and
-Media on which the file is stored. This is seemingly a simple task, but it
-represents a huge amount interlinked data. Note: the list of files and their
-attributes is not maintained when using the internal Bacula database. The data
-stored in the File records, which allows the user or administrator to obtain a
-list of all files backed up during a job, is by far the largest volume of
-information put into the Catalog database.
-
-Although the Catalog database has been designed to handle backup data for
-multiple clients, some users may want to maintain multiple databases, one for
-each machine to be backed up. This reduces the risk of confusion of accidental
-restoring a file to the wrong machine as well as reducing the amount of data
-in a single database, thus increasing efficiency and reducing the impact of a
-lost or damaged database.
-
-\section{Sequence of Creation of Records for a Save Job}
-\index[general]{Sequence of Creation of Records for a Save Job }
-\index[general]{Job!Sequence of Creation of Records for a Save }
-\addcontentsline{toc}{subsection}{Sequence of Creation of Records for a Save
-Job}
-
-Start with StartDate, ClientName, Filename, Path, Attributes, MediaName,
-MediaCoordinates. (PartNumber, NumParts). In the steps below, ``Create new''
-means to create a new record whether or not it is unique. ``Create unique''
-means each record in the database should be unique. Thus, one must first
-search to see if the record exists, and only if not should a new one be
-created, otherwise the existing RecordId should be used.
-
-\begin{enumerate}
-\item Create new Job record with StartDate; save JobId
-\item Create unique Media record; save MediaId
-\item Create unique Client record; save ClientId
-\item Create unique Filename record; save FilenameId
-\item Create unique Path record; save PathId
-\item Create unique Attribute record; save AttributeId
- store ClientId, FilenameId, PathId, and Attributes
-\item Create new File record
- store JobId, AttributeId, MediaCoordinates, etc
-\item Repeat steps 4 through 8 for each file
-\item Create a JobMedia record; save MediaId
-\item Update Job record filling in EndDate and other Job statistics
- \end{enumerate}
-
-\section{Database Tables}
-\index[general]{Database Tables }
-\index[general]{Tables!Database }
-\addcontentsline{toc}{subsection}{Database Tables}
-
-\addcontentsline{lot}{table}{Filename Table Layout}
-\begin{longtable}{|l|l|l|}
- \hline
-\multicolumn{3}{|l| }{\bf Filename } \\
- \hline
-\multicolumn{1}{|c| }{\bf Column Name } & \multicolumn{1}{l| }{\bf Data Type }
-& \multicolumn{1}{l| }{\bf Remark } \\
- \hline
-{FilenameId } & {integer } & {Primary Key } \\
- \hline
-{Name } & {Blob } & {Filename }
-\\ \hline
-
-\end{longtable}
-
-The {\bf Filename} table shown above contains the name of each file backed up
-with the path removed. If different directories or machines contain the same
-filename, only one copy will be saved in this table.
-
-\
-
-\addcontentsline{lot}{table}{Path Table Layout}
-\begin{longtable}{|l|l|l|}
- \hline
-\multicolumn{3}{|l| }{\bf Path } \\
- \hline
-\multicolumn{1}{|c| }{\bf Column Name } & \multicolumn{1}{c| }{\bf Data Type
-} & \multicolumn{1}{c| }{\bf Remark } \\
- \hline
-{PathId } & {integer } & {Primary Key } \\
- \hline
-{Path } & {Blob } & {Full Path }
-\\ \hline
-
-\end{longtable}
-
-The {\bf Path} table contains shown above the path or directory names of all
-directories on the system or systems. The filename and any MSDOS disk name are
-stripped off. As with the filename, only one copy of each directory name is
-kept regardless of how many machines or drives have the same directory. These
-path names should be stored in Unix path name format.
-
-Some simple testing on a Linux file system indicates that separating the
-filename and the path may be more complication than is warranted by the space
-savings. For example, this system has a total of 89,097 files, 60,467 of which
-have unique filenames, and there are 4,374 unique paths.
-
-Finding all those files and doing two stats() per file takes an average wall
-clock time of 1 min 35 seconds on a 400MHz machine running RedHat 6.1 Linux.
-
-Finding all those files and putting them directly into a MySQL database with
-the path and filename defined as TEXT, which is variable length up to 65,535
-characters takes 19 mins 31 seconds and creates a 27.6 MByte database.
-
-Doing the same thing, but inserting them into Blob fields with the filename
-indexed on the first 30 characters and the path name indexed on the 255 (max)
-characters takes 5 mins 18 seconds and creates a 5.24 MB database. Rerunning
-the job (with the database already created) takes about 2 mins 50 seconds.
-
-Running the same as the last one (Path and Filename Blob), but Filename
-indexed on the first 30 characters and the Path on the first 50 characters
-(linear search done there after) takes 5 mins on the average and creates a 3.4
-MB database. Rerunning with the data already in the DB takes 3 mins 35
-seconds.
-
-Finally, saving only the full path name rather than splitting the path and the
-file, and indexing it on the first 50 characters takes 6 mins 43 seconds and
-creates a 7.35 MB database.
-
-\
-
-\addcontentsline{lot}{table}{File Table Layout}
-\begin{longtable}{|l|l|l|}
- \hline
-\multicolumn{3}{|l| }{\bf File } \\
- \hline
-\multicolumn{1}{|c| }{\bf Column Name } & \multicolumn{1}{c| }{\bf Data Type
-} & \multicolumn{1}{c| }{\bf Remark } \\
- \hline
-{FileId } & {integer } & {Primary Key } \\
- \hline
-{FileIndex } & {integer } & {The sequential file number in the Job } \\
- \hline
-{JobId } & {integer } & {Link to Job Record } \\
- \hline
-{PathId } & {integer } & {Link to Path Record } \\
- \hline
-{FilenameId } & {integer } & {Link to Filename Record } \\
- \hline
-{MarkId } & {integer } & {Used to mark files during Verify Jobs } \\
- \hline
-{LStat } & {tinyblob } & {File attributes in base64 encoding } \\
- \hline
-{MD5 } & {tinyblob } & {MD5 signature in base64 encoding }
-\\ \hline
-
-\end{longtable}
-
-The {\bf File} table shown above contains one entry for each file backed up by
-Bacula. Thus a file that is backed up multiple times (as is normal) will have
-multiple entries in the File table. This will probably be the table with the
-most number of records. Consequently, it is essential to keep the size of this
-record to an absolute minimum. At the same time, this table must contain all
-the information (or pointers to the information) about the file and where it
-is backed up. Since a file may be backed up many times without having changed,
-the path and filename are stored in separate tables.
-
-This table contains by far the largest amount of information in the Catalog
-database, both from the stand point of number of records, and the stand point
-of total database size. As a consequence, the user must take care to
-periodically reduce the number of File records using the {\bf retention}
-command in the Console program.
-
-\
-
-\addcontentsline{lot}{table}{Job Table Layout}
-\begin{longtable}{|l|l|p{2.5in}|}
- \hline
-\multicolumn{3}{|l| }{\bf Job } \\
- \hline
-\multicolumn{1}{|c| }{\bf Column Name } & \multicolumn{1}{c| }{\bf Data Type
-} & \multicolumn{1}{c| }{\bf Remark } \\
- \hline
-{JobId } & {integer } & {Primary Key } \\
- \hline
-{Job } & {tinyblob } & {Unique Job Name } \\
- \hline
-{Name } & {tinyblob } & {Job Name } \\
- \hline
-{PurgedFiles } & {tinyint } & {Used by Bacula for purging/retention periods
-} \\
- \hline
-{Type } & {binary(1) } & {Job Type: Backup, Copy, Clone, Archive, Migration
-} \\
- \hline
-{Level } & {binary(1) } & {Job Level } \\
- \hline
-{ClientId } & {integer } & {Client index } \\
- \hline
-{JobStatus } & {binary(1) } & {Job Termination Status } \\
- \hline
-{SchedTime } & {datetime } & {Time/date when Job scheduled } \\
- \hline
-{StartTime } & {datetime } & {Time/date when Job started } \\
- \hline
-{EndTime } & {datetime } & {Time/date when Job ended } \\
- \hline
-{JobTDate } & {bigint } & {Start day in Unix format but 64 bits; used for
-Retention period. } \\
- \hline
-{VolSessionId } & {integer } & {Unique Volume Session ID } \\
- \hline
-{VolSessionTime } & {integer } & {Unique Volume Session Time } \\
- \hline
-{JobFiles } & {integer } & {Number of files saved in Job } \\
- \hline
-{JobBytes } & {bigint } & {Number of bytes saved in Job } \\
- \hline
-{JobErrors } & {integer } & {Number of errors during Job } \\
- \hline
-{JobMissingFiles } & {integer } & {Number of files not saved (not yet used) }
-\\
- \hline
-{PoolId } & {integer } & {Link to Pool Record } \\
- \hline
-{FileSetId } & {integer } & {Link to FileSet Record } \\
- \hline
-{PurgedFiles } & {tiny integer } & {Set when all File records purged } \\
- \hline
-{HasBase } & {tiny integer } & {Set when Base Job run }
-\\ \hline
-
-\end{longtable}
-
-The {\bf Job} table contains one record for each Job run by Bacula. Thus
-normally, there will be one per day per machine added to the database. Note,
-the JobId is used to index Job records in the database, and it often is shown
-to the user in the Console program. However, care must be taken with its use
-as it is not unique from database to database. For example, the user may have
-a database for Client data saved on machine Rufus and another database for
-Client data saved on machine Roxie. In this case, the two database will each
-have JobIds that match those in another database. For a unique reference to a
-Job, see Job below.
-
-The Name field of the Job record corresponds to the Name resource record given
-in the Director's configuration file. Thus it is a generic name, and it will
-be normal to find many Jobs (or even all Jobs) with the same Name.
-
-The Job field contains a combination of the Name and the schedule time of the
-Job by the Director. Thus for a given Director, even with multiple Catalog
-databases, the Job will contain a unique name that represents the Job.
-
-For a given Storage daemon, the VolSessionId and VolSessionTime form a unique
-identification of the Job. This will be the case even if multiple Directors
-are using the same Storage daemon.
-
-The Job Type (or simply Type) can have one of the following values:
-
-\addcontentsline{lot}{table}{Job Types}
-\begin{longtable}{|l|l|}
- \hline
-\multicolumn{1}{|c| }{\bf Value } & \multicolumn{1}{c| }{\bf Meaning } \\
- \hline
-{B } & {Backup Job } \\
- \hline
-{V } & {Verify Job } \\
- \hline
-{R } & {Restore Job } \\
- \hline
-{C } & {Console program (not in database) } \\
- \hline
-{D } & {Admin Job } \\
- \hline
-{A } & {Archive Job (not implemented) }
-\\ \hline
-
-\end{longtable}
-
-The JobStatus field specifies how the job terminated, and can be one of the
-following:
-
-\addcontentsline{lot}{table}{Job Statuses}
-\begin{longtable}{|l|l|}
- \hline
-\multicolumn{1}{|c| }{\bf Value } & \multicolumn{1}{c| }{\bf Meaning } \\
- \hline
-{C } & {Created but not yet running } \\
- \hline
-{R } & {Running } \\
- \hline
-{B } & {Blocked } \\
- \hline
-{T } & {Terminated normally } \\
- \hline
-{E } & {Terminated in Error } \\
- \hline
-{e } & {Non-fatal error } \\
- \hline
-{f } & {Fatal error } \\
- \hline
-{D } & {Verify Differences } \\
- \hline
-{A } & {Canceled by the user } \\
- \hline
-{F } & {Waiting on the File daemon } \\
- \hline
-{S } & {Waiting on the Storage daemon } \\
- \hline
-{m } & {Waiting for a new Volume to be mounted } \\
- \hline
-{M } & {Waiting for a Mount } \\
- \hline
-{s } & {Waiting for Storage resource } \\
- \hline
-{j } & {Waiting for Job resource } \\
- \hline
-{c } & {Waiting for Client resource } \\
- \hline
-{d } & {Wating for Maximum jobs } \\
- \hline
-{t } & {Waiting for Start Time } \\
- \hline
-{p } & {Waiting for higher priority job to finish }
-\\ \hline
-
-\end{longtable}
-
-\
-
-\addcontentsline{lot}{table}{File Sets Table Layout}
-\begin{longtable}{|l|l|l|}
- \hline
-\multicolumn{3}{|l| }{\bf FileSet } \\
- \hline
-\multicolumn{1}{|c| }{\bf Column Name } & \multicolumn{1}{c| }{\bf Data Type\
-\ \ } & \multicolumn{1}{c| }{\bf Remark } \\
- \hline
-{FileSetId } & {integer } & {Primary Key } \\
- \hline
-{FileSet } & {tinyblob } & {FileSet name } \\
- \hline
-{MD5 } & {tinyblob } & {MD5 checksum of FileSet } \\
- \hline
-{CreateTime } & {datetime } & {Time and date Fileset created }
-\\ \hline
-
-\end{longtable}
-
-The {\bf FileSet} table contains one entry for each FileSet that is used. The
-MD5 signature is kept to ensure that if the user changes anything inside the
-FileSet, it will be detected and the new FileSet will be used. This is
-particularly important when doing an incremental update. If the user deletes a
-file or adds a file, we need to ensure that a Full backup is done prior to the
-next incremental.
-
-\
-
-\addcontentsline{lot}{table}{JobMedia Table Layout}
-\begin{longtable}{|l|l|p{2.5in}|}
- \hline
-\multicolumn{3}{|l| }{\bf JobMedia } \\
- \hline
-\multicolumn{1}{|c| }{\bf Column Name } & \multicolumn{1}{c| }{\bf Data Type\
-\ \ } & \multicolumn{1}{c| }{\bf Remark } \\
- \hline
-{JobMediaId } & {integer } & {Primary Key } \\
- \hline
-{JobId } & {integer } & {Link to Job Record } \\
- \hline
-{MediaId } & {integer } & {Link to Media Record } \\
- \hline
-{FirstIndex } & {integer } & {The index (sequence number) of the first file
-written for this Job to the Media } \\
- \hline
-{LastIndex } & {integer } & {The index of the last file written for this
-Job to the Media } \\
- \hline
-{StartFile } & {integer } & {The physical media (tape) file number of the
-first block written for this Job } \\
- \hline
-{EndFile } & {integer } & {The physical media (tape) file number of the
-last block written for this Job } \\
- \hline
-{StartBlock } & {integer } & {The number of the first block written for
-this Job } \\
- \hline
-{EndBlock } & {integer } & {The number of the last block written for this
-Job } \\
- \hline
-{VolIndex } & {integer } & {The Volume use sequence number within the Job }
-\\ \hline
-
-\end{longtable}
-
-The {\bf JobMedia} table contains one entry at the following: start of
-the job, start of each new tape file, start of each new tape, end of the
-job. Since by default, a new tape file is written every 2GB, in general,
-you will have more than 2 JobMedia records per Job. The number can be
-varied by changing the "Maximum File Size" specified in the Device
-resource. This record allows Bacula to efficiently position close to
-(within 2GB) any given file in a backup. For restoring a full Job,
-these records are not very important, but if you want to retrieve
-a single file that was written near the end of a 100GB backup, the
-JobMedia records can speed it up by orders of magnitude by permitting
-forward spacing files and blocks rather than reading the whole 100GB
-backup.
-
-
-
-\
-
-\addcontentsline{lot}{table}{Media Table Layout}
-\begin{longtable}{|l|l|p{2.4in}|}
- \hline
-\multicolumn{3}{|l| }{\bf Media } \\
- \hline
-\multicolumn{1}{|c| }{\bf Column Name } & \multicolumn{1}{c| }{\bf Data Type\
-\ \ } & \multicolumn{1}{c| }{\bf Remark } \\
- \hline
-{MediaId } & {integer } & {Primary Key } \\
- \hline
-{VolumeName } & {tinyblob } & {Volume name } \\
- \hline
-{Slot } & {integer } & {Autochanger Slot number or zero } \\
- \hline
-{PoolId } & {integer } & {Link to Pool Record } \\
- \hline
-{MediaType } & {tinyblob } & {The MediaType supplied by the user } \\
- \hline
-{FirstWritten } & {datetime } & {Time/date when first written } \\
- \hline
-{LastWritten } & {datetime } & {Time/date when last written } \\
- \hline
-{LabelDate } & {datetime } & {Time/date when tape labeled } \\
- \hline
-{VolJobs } & {integer } & {Number of jobs written to this media } \\
- \hline
-{VolFiles } & {integer } & {Number of files written to this media } \\
- \hline
-{VolBlocks } & {integer } & {Number of blocks written to this media } \\
- \hline
-{VolMounts } & {integer } & {Number of time media mounted } \\
- \hline
-{VolBytes } & {bigint } & {Number of bytes saved in Job } \\
- \hline
-{VolErrors } & {integer } & {Number of errors during Job } \\
- \hline
-{VolWrites } & {integer } & {Number of writes to media } \\
- \hline
-{MaxVolBytes } & {bigint } & {Maximum bytes to put on this media } \\
- \hline
-{VolCapacityBytes } & {bigint } & {Capacity estimate for this volume } \\
- \hline
-{VolStatus } & {enum } & {Status of media: Full, Archive, Append, Recycle,
-Read-Only, Disabled, Error, Busy } \\
- \hline
-{Recycle } & {tinyint } & {Whether or not Bacula can recycle the Volumes:
-Yes, No } \\
- \hline
-{VolRetention } & {bigint } & {64 bit seconds until expiration } \\
- \hline
-{VolUseDuration } & {bigint } & {64 bit seconds volume can be used } \\
- \hline
-{MaxVolJobs } & {integer } & {maximum jobs to put on Volume } \\
- \hline
-{MaxVolFiles } & {integer } & {maximume EOF marks to put on Volume }
-\\ \hline
-
-\end{longtable}
-
-The {\bf Volume} table (internally referred to as the Media table) contains
-one entry for each volume, that is each tape, cassette (8mm, DLT, DAT, ...),
-or file on which information is or was backed up. There is one Volume record
-created for each of the NumVols specified in the Pool resource record.
-
-\
-
-\addcontentsline{lot}{table}{Pool Table Layout}
-\begin{longtable}{|l|l|p{2.4in}|}
- \hline
-\multicolumn{3}{|l| }{\bf Pool } \\
- \hline
-\multicolumn{1}{|c| }{\bf Column Name } & \multicolumn{1}{c| }{\bf Data Type
-} & \multicolumn{1}{c| }{\bf Remark } \\
- \hline
-{PoolId } & {integer } & {Primary Key } \\
- \hline
-{Name } & {Tinyblob } & {Pool Name } \\
- \hline
-{NumVols } & {Integer } & {Number of Volumes in the Pool } \\
- \hline
-{MaxVols } & {Integer } & {Maximum Volumes in the Pool } \\
- \hline
-{UseOnce } & {tinyint } & {Use volume once } \\
- \hline
-{UseCatalog } & {tinyint } & {Set to use catalog } \\
- \hline
-{AcceptAnyVolume } & {tinyint } & {Accept any volume from Pool } \\
- \hline
-{VolRetention } & {bigint } & {64 bit seconds to retain volume } \\
- \hline
-{VolUseDuration } & {bigint } & {64 bit seconds volume can be used } \\
- \hline
-{MaxVolJobs } & {integer } & {max jobs on volume } \\
- \hline
-{MaxVolFiles } & {integer } & {max EOF marks to put on Volume } \\
- \hline
-{MaxVolBytes } & {bigint } & {max bytes to write on Volume } \\
- \hline
-{AutoPrune } & {tinyint } & {yes|no for autopruning } \\
- \hline
-{Recycle } & {tinyint } & {yes|no for allowing auto recycling of Volume }
-\\
- \hline
-{PoolType } & {enum } & {Backup, Copy, Cloned, Archive, Migration } \\
- \hline
-{LabelFormat } & {Tinyblob } & {Label format }
-\\ \hline
-
-\end{longtable}
-
-The {\bf Pool} table contains one entry for each media pool controlled by
-Bacula in this database. One media record exists for each of the NumVols
-contained in the Pool. The PoolType is a Bacula defined keyword. The MediaType
-is defined by the administrator, and corresponds to the MediaType specified in
-the Director's Storage definition record. The CurrentVol is the sequence
-number of the Media record for the current volume.
-
-\
-
-\addcontentsline{lot}{table}{Client Table Layout}
-\begin{longtable}{|l|l|l|}
- \hline
-\multicolumn{3}{|l| }{\bf Client } \\
- \hline
-\multicolumn{1}{|c| }{\bf Column Name } & \multicolumn{1}{c| }{\bf Data Type
-} & \multicolumn{1}{c| }{\bf Remark } \\
- \hline
-{ClientId } & {integer } & {Primary Key } \\
- \hline
-{Name } & {TinyBlob } & {File Services Name } \\
- \hline
-{UName } & {TinyBlob } & {uname -a from Client (not yet used) } \\
- \hline
-{AutoPrune } & {tinyint } & {yes|no for autopruning } \\
- \hline
-{FileRetention } & {bigint } & {64 bit seconds to retain Files } \\
- \hline
-{JobRetention } & {bigint } & {64 bit seconds to retain Job }
-\\ \hline
-
-\end{longtable}
-
-The {\bf Client} table contains one entry for each machine backed up by Bacula
-in this database. Normally the Name is a fully qualified domain name.
-
-\
-
-\addcontentsline{lot}{table}{Unsaved Files Table Layout}
-\begin{longtable}{|l|l|l|}
- \hline
-\multicolumn{3}{|l| }{\bf UnsavedFiles } \\
- \hline
-\multicolumn{1}{|c| }{\bf Column Name } & \multicolumn{1}{c| }{\bf Data Type
-} & \multicolumn{1}{c| }{\bf Remark } \\
- \hline
-{UnsavedId } & {integer } & {Primary Key } \\
- \hline
-{JobId } & {integer } & {JobId corresponding to this record } \\
- \hline
-{PathId } & {integer } & {Id of path } \\
- \hline
-{FilenameId } & {integer } & {Id of filename }
-\\ \hline
-
-\end{longtable}
-
-The {\bf UnsavedFiles} table contains one entry for each file that was not
-saved. Note! This record is not yet implemented.
-
-\
-
-\addcontentsline{lot}{table}{Counter Table Layout}
-\begin{longtable}{|l|l|l|}
- \hline
-\multicolumn{3}{|l| }{\bf Counter } \\
- \hline
-\multicolumn{1}{|c| }{\bf Column Name } & \multicolumn{1}{c| }{\bf Data Type
-} & \multicolumn{1}{c| }{\bf Remark } \\
- \hline
-{Counter } & {tinyblob } & {Counter name } \\
- \hline
-{MinValue } & {integer } & {Start/Min value for counter } \\
- \hline
-{MaxValue } & {integer } & {Max value for counter } \\
- \hline
-{CurrentValue } & {integer } & {Current counter value } \\
- \hline
-{WrapCounter } & {tinyblob } & {Name of another counter }
-\\ \hline
-
-\end{longtable}
-
-The {\bf Counter} table contains one entry for each permanent counter defined
-by the user.
-
-\
-
-\addcontentsline{lot}{table}{Version Table Layout}
-\begin{longtable}{|l|l|l|}
- \hline
-\multicolumn{3}{|l| }{\bf Version } \\
- \hline
-\multicolumn{1}{|c| }{\bf Column Name } & \multicolumn{1}{c| }{\bf Data Type
-} & \multicolumn{1}{c| }{\bf Remark } \\
- \hline
-{VersionId } & {integer } & {Primary Key }
-\\ \hline
-
-\end{longtable}
-
-The {\bf Version} table defines the Bacula database version number. Bacula
-checks this number before reading the database to ensure that it is compatible
-with the Bacula binary file.
-
-\
-
-\addcontentsline{lot}{table}{Base Files Table Layout}
-\begin{longtable}{|l|l|l|}
- \hline
-\multicolumn{3}{|l| }{\bf BaseFiles } \\
- \hline
-\multicolumn{1}{|c| }{\bf Column Name } & \multicolumn{1}{c| }{\bf Data Type
-} & \multicolumn{1}{c| }{\bf Remark } \\
- \hline
-{BaseId } & {integer } & {Primary Key } \\
- \hline
-{BaseJobId } & {integer } & {JobId of Base Job } \\
- \hline
-{JobId } & {integer } & {Reference to Job } \\
- \hline
-{FileId } & {integer } & {Reference to File } \\
- \hline
-{FileIndex } & {integer } & {File Index number }
-\\ \hline
-
-\end{longtable}
-
-The {\bf BaseFiles} table contains all the File references for a particular
-JobId that point to a Base file -- i.e. they were previously saved and hence
-were not saved in the current JobId but in BaseJobId under FileId. FileIndex
-is the index of the file, and is used for optimization of Restore jobs to
-prevent the need to read the FileId record when creating the in memory tree.
-This record is not yet implemented.
-
-\
-
-\subsection{MySQL Table Definition}
-\index[general]{MySQL Table Definition }
-\index[general]{Definition!MySQL Table }
-\addcontentsline{toc}{subsubsection}{MySQL Table Definition}
-
-The commands used to create the MySQL tables are as follows:
-
-\footnotesize
-\begin{verbatim}
-USE bacula;
-CREATE TABLE Filename (
- FilenameId INTEGER UNSIGNED NOT NULL AUTO_INCREMENT,
- Name BLOB NOT NULL,
- PRIMARY KEY(FilenameId),
- INDEX (Name(30))
- );
-CREATE TABLE Path (
- PathId INTEGER UNSIGNED NOT NULL AUTO_INCREMENT,
- Path BLOB NOT NULL,
- PRIMARY KEY(PathId),
- INDEX (Path(50))
- );
-CREATE TABLE File (
- FileId INTEGER UNSIGNED NOT NULL AUTO_INCREMENT,
- FileIndex INTEGER UNSIGNED NOT NULL DEFAULT 0,
- JobId INTEGER UNSIGNED NOT NULL REFERENCES Job,
- PathId INTEGER UNSIGNED NOT NULL REFERENCES Path,
- FilenameId INTEGER UNSIGNED NOT NULL REFERENCES Filename,
- MarkId INTEGER UNSIGNED NOT NULL DEFAULT 0,
- LStat TINYBLOB NOT NULL,
- MD5 TINYBLOB NOT NULL,
- PRIMARY KEY(FileId),
- INDEX (JobId),
- INDEX (PathId),
- INDEX (FilenameId)
- );
-CREATE TABLE Job (
- JobId INTEGER UNSIGNED NOT NULL AUTO_INCREMENT,
- Job TINYBLOB NOT NULL,
- Name TINYBLOB NOT NULL,
- Type BINARY(1) NOT NULL,
- Level BINARY(1) NOT NULL,
- ClientId INTEGER NOT NULL REFERENCES Client,
- JobStatus BINARY(1) NOT NULL,
- SchedTime DATETIME NOT NULL,
- StartTime DATETIME NOT NULL,
- EndTime DATETIME NOT NULL,
- JobTDate BIGINT UNSIGNED NOT NULL,
- VolSessionId INTEGER UNSIGNED NOT NULL DEFAULT 0,
- VolSessionTime INTEGER UNSIGNED NOT NULL DEFAULT 0,
- JobFiles INTEGER UNSIGNED NOT NULL DEFAULT 0,
- JobBytes BIGINT UNSIGNED NOT NULL,
- JobErrors INTEGER UNSIGNED NOT NULL DEFAULT 0,
- JobMissingFiles INTEGER UNSIGNED NOT NULL DEFAULT 0,
- PoolId INTEGER UNSIGNED NOT NULL REFERENCES Pool,
- FileSetId INTEGER UNSIGNED NOT NULL REFERENCES FileSet,
- PurgedFiles TINYINT NOT NULL DEFAULT 0,
- HasBase TINYINT NOT NULL DEFAULT 0,
- PRIMARY KEY(JobId),
- INDEX (Name(128))
- );
-CREATE TABLE FileSet (
- FileSetId INTEGER UNSIGNED NOT NULL AUTO_INCREMENT,
- FileSet TINYBLOB NOT NULL,
- MD5 TINYBLOB NOT NULL,
- CreateTime DATETIME NOT NULL,
- PRIMARY KEY(FileSetId)
- );
-CREATE TABLE JobMedia (
- JobMediaId INTEGER UNSIGNED NOT NULL AUTO_INCREMENT,
- JobId INTEGER UNSIGNED NOT NULL REFERENCES Job,
- MediaId INTEGER UNSIGNED NOT NULL REFERENCES Media,
- FirstIndex INTEGER UNSIGNED NOT NULL DEFAULT 0,
- LastIndex INTEGER UNSIGNED NOT NULL DEFAULT 0,
- StartFile INTEGER UNSIGNED NOT NULL DEFAULT 0,
- EndFile INTEGER UNSIGNED NOT NULL DEFAULT 0,
- StartBlock INTEGER UNSIGNED NOT NULL DEFAULT 0,
- EndBlock INTEGER UNSIGNED NOT NULL DEFAULT 0,
- VolIndex INTEGER UNSIGNED NOT NULL DEFAULT 0,
- PRIMARY KEY(JobMediaId),
- INDEX (JobId, MediaId)
- );
-CREATE TABLE Media (
- MediaId INTEGER UNSIGNED NOT NULL AUTO_INCREMENT,
- VolumeName TINYBLOB NOT NULL,
- Slot INTEGER NOT NULL DEFAULT 0,
- PoolId INTEGER UNSIGNED NOT NULL REFERENCES Pool,
- MediaType TINYBLOB NOT NULL,
- FirstWritten DATETIME NOT NULL,
- LastWritten DATETIME NOT NULL,
- LabelDate DATETIME NOT NULL,
- VolJobs INTEGER UNSIGNED NOT NULL DEFAULT 0,
- VolFiles INTEGER UNSIGNED NOT NULL DEFAULT 0,
- VolBlocks INTEGER UNSIGNED NOT NULL DEFAULT 0,
- VolMounts INTEGER UNSIGNED NOT NULL DEFAULT 0,
- VolBytes BIGINT UNSIGNED NOT NULL DEFAULT 0,
- VolErrors INTEGER UNSIGNED NOT NULL DEFAULT 0,
- VolWrites INTEGER UNSIGNED NOT NULL DEFAULT 0,
- VolCapacityBytes BIGINT UNSIGNED NOT NULL,
- VolStatus ENUM('Full', 'Archive', 'Append', 'Recycle', 'Purged',
- 'Read-Only', 'Disabled', 'Error', 'Busy', 'Used', 'Cleaning') NOT NULL,
- Recycle TINYINT NOT NULL DEFAULT 0,
- VolRetention BIGINT UNSIGNED NOT NULL DEFAULT 0,
- VolUseDuration BIGINT UNSIGNED NOT NULL DEFAULT 0,
- MaxVolJobs INTEGER UNSIGNED NOT NULL DEFAULT 0,
- MaxVolFiles INTEGER UNSIGNED NOT NULL DEFAULT 0,
- MaxVolBytes BIGINT UNSIGNED NOT NULL DEFAULT 0,
- InChanger TINYINT NOT NULL DEFAULT 0,
- MediaAddressing TINYINT NOT NULL DEFAULT 0,
- VolReadTime BIGINT UNSIGNED NOT NULL DEFAULT 0,
- VolWriteTime BIGINT UNSIGNED NOT NULL DEFAULT 0,
- PRIMARY KEY(MediaId),
- INDEX (PoolId)
- );
-CREATE TABLE Pool (
- PoolId INTEGER UNSIGNED NOT NULL AUTO_INCREMENT,
- Name TINYBLOB NOT NULL,
- NumVols INTEGER UNSIGNED NOT NULL DEFAULT 0,
- MaxVols INTEGER UNSIGNED NOT NULL DEFAULT 0,
- UseOnce TINYINT NOT NULL,
- UseCatalog TINYINT NOT NULL,
- AcceptAnyVolume TINYINT DEFAULT 0,
- VolRetention BIGINT UNSIGNED NOT NULL,
- VolUseDuration BIGINT UNSIGNED NOT NULL,
- MaxVolJobs INTEGER UNSIGNED NOT NULL DEFAULT 0,
- MaxVolFiles INTEGER UNSIGNED NOT NULL DEFAULT 0,
- MaxVolBytes BIGINT UNSIGNED NOT NULL,
- AutoPrune TINYINT DEFAULT 0,
- Recycle TINYINT DEFAULT 0,
- PoolType ENUM('Backup', 'Copy', 'Cloned', 'Archive', 'Migration', 'Scratch') NOT NULL,
- LabelFormat TINYBLOB,
- Enabled TINYINT DEFAULT 1,
- ScratchPoolId INTEGER UNSIGNED DEFAULT 0 REFERENCES Pool,
- RecyclePoolId INTEGER UNSIGNED DEFAULT 0 REFERENCES Pool,
- UNIQUE (Name(128)),
- PRIMARY KEY (PoolId)
- );
-CREATE TABLE Client (
- ClientId INTEGER UNSIGNED NOT NULL AUTO_INCREMENT,
- Name TINYBLOB NOT NULL,
- Uname TINYBLOB NOT NULL, /* full uname -a of client */
- AutoPrune TINYINT DEFAULT 0,
- FileRetention BIGINT UNSIGNED NOT NULL,
- JobRetention BIGINT UNSIGNED NOT NULL,
- UNIQUE (Name(128)),
- PRIMARY KEY(ClientId)
- );
-CREATE TABLE BaseFiles (
- BaseId INTEGER UNSIGNED AUTO_INCREMENT,
- BaseJobId INTEGER UNSIGNED NOT NULL REFERENCES Job,
- JobId INTEGER UNSIGNED NOT NULL REFERENCES Job,
- FileId INTEGER UNSIGNED NOT NULL REFERENCES File,
- FileIndex INTEGER UNSIGNED,
- PRIMARY KEY(BaseId)
- );
-CREATE TABLE UnsavedFiles (
- UnsavedId INTEGER UNSIGNED AUTO_INCREMENT,
- JobId INTEGER UNSIGNED NOT NULL REFERENCES Job,
- PathId INTEGER UNSIGNED NOT NULL REFERENCES Path,
- FilenameId INTEGER UNSIGNED NOT NULL REFERENCES Filename,
- PRIMARY KEY (UnsavedId)
- );
-CREATE TABLE Version (
- VersionId INTEGER UNSIGNED NOT NULL
- );
--- Initialize Version
-INSERT INTO Version (VersionId) VALUES (7);
-CREATE TABLE Counters (
- Counter TINYBLOB NOT NULL,
- MinValue INTEGER,
- MaxValue INTEGER,
- CurrentValue INTEGER,
- WrapCounter TINYBLOB NOT NULL,
- PRIMARY KEY (Counter(128))
- );
-\end{verbatim}
-\normalsize
+++ /dev/null
-#!/usr/bin/perl -w
-# Finds potential problems in tex files, and issues warnings to the console
-# about what it finds. Takes a list of files as its only arguments,
-# and does checks on all the files listed. The assumption is that these are
-# valid (or close to valid) LaTeX files. It follows \include statements
-# recursively to pick up any included tex files.
-#
-#
-#
-# Currently the following checks are made:
-#
-# -- Multiple hyphens not inside a verbatim environment (or \verb). These
-# should be placed inside a \verb{} contruct so they will not be converted
-# to single hyphen by latex and latex2html.
-
-
-# Original creation 3-8-05 by Karl Cunningham karlc -at- keckec -dot- com
-#
-#
-
-use strict;
-
-# The following builds the test string to identify and change multiple
-# hyphens in the tex files. Several constructs are identified but only
-# multiple hyphens are changed; the others are fed to the output
-# unchanged.
-my $b = '\\\\begin\\*?\\s*\\{\\s*'; # \begin{
-my $e = '\\\\end\\*?\\s*\\{\\s*'; # \end{
-my $c = '\\s*\\}'; # closing curly brace
-
-# This captures entire verbatim environments. These are passed to the output
-# file unchanged.
-my $verbatimenv = $b . "verbatim" . $c . ".*?" . $e . "verbatim" . $c;
-
-# This captures \verb{..{ constructs. They are passed to the output unchanged.
-my $verb = '\\\\verb\\*?(.).*?\\1';
-
-# This captures multiple hyphens with a leading and trailing space. These are not changed.
-my $hyphsp = '\\s\\-{2,}\\s';
-
-# This identifies other multiple hyphens.
-my $hyphens = '\\-{2,}';
-
-# This identifies \hyperpage{..} commands, which should be ignored.
-my $hyperpage = '\\\\hyperpage\\*?\\{.*?\\}';
-
-# This builds the actual test string from the above strings.
-#my $teststr = "$verbatimenv|$verb|$tocentry|$hyphens";
-my $teststr = "$verbatimenv|$verb|$hyphsp|$hyperpage|$hyphens";
-
-
-sub get_includes {
- # Get a list of include files from the top-level tex file. The first
- # argument is a pointer to the list of files found. The rest of the
- # arguments is a list of filenames to check for includes.
- my $files = shift;
- my ($fileline,$includefile,$includes);
-
- while (my $filename = shift) {
- # Get a list of all the html files in the directory.
- open my $if,"<$filename" or die "Cannot open input file $filename\n";
- $fileline = 0;
- $includes = 0;
- while (<$if>) {
- chomp;
- $fileline++;
- # If a file is found in an include, process it.
- if (($includefile) = /\\include\s*\{(.*?)\}/) {
- $includes++;
- # Append .tex to the filename
- $includefile .= '.tex';
-
- # If the include file has already been processed, issue a warning
- # and don't do it again.
- my $found = 0;
- foreach (@$files) {
- if ($_ eq $includefile) {
- $found = 1;
- last;
- }
- }
- if ($found) {
- print "$includefile found at line $fileline in $filename was previously included\n";
- } else {
- # The file has not been previously found. Save it and
- # recursively process it.
- push (@$files,$includefile);
- get_includes($files,$includefile);
- }
- }
- }
- close IF;
- }
-}
-
-
-sub check_hyphens {
- my (@files) = @_;
- my ($filedata,$this,$linecnt,$before);
-
- # Build the test string to check for the various environments.
- # We only do the conversion if the multiple hyphens are outside of a
- # verbatim environment (either \begin{verbatim}...\end{verbatim} or
- # \verb{--}). Capture those environments and pass them to the output
- # unchanged.
-
- foreach my $file (@files) {
- # Open the file and load the whole thing into $filedata. A bit wasteful but
- # easier to deal with, and we don't have a problem with speed here.
- $filedata = "";
- open IF,"<$file" or die "Cannot open input file $file";
- while (<IF>) {
- $filedata .= $_;
- }
- close IF;
-
- # Set up to process the file data.
- $linecnt = 1;
-
- # Go through the file data from beginning to end. For each match, save what
- # came before it and what matched. $filedata now becomes only what came
- # after the match.
- # Chech the match to see if it starts with a multiple-hyphen. If so
- # warn the user. Keep track of line numbers so they can be output
- # with the warning message.
- while ($filedata =~ /$teststr/os) {
- $this = $&;
- $before = $`;
- $filedata = $';
- $linecnt += $before =~ tr/\n/\n/;
-
- # Check if the multiple hyphen is present outside of one of the
- # acceptable constructs.
- if ($this =~ /^\-+/) {
- print "Possible unwanted multiple hyphen found in line ",
- "$linecnt of file $file\n";
- }
- $linecnt += $this =~ tr/\n/\n/;
- }
- }
-}
-##################################################################
-# MAIN ####
-##################################################################
-
-my (@includes,$cnt);
-
-# Examine the file pointed to by the first argument to get a list of
-# includes to test.
-get_includes(\@includes,@ARGV);
-
-check_hyphens(@includes);
+++ /dev/null
-%%
-%%
-
-\chapter{Daemon Protocol}
-\label{_ChapterStart2}
-\index{Protocol!Daemon }
-\index{Daemon Protocol }
-
-\section{General}
-\index{General }
-\addcontentsline{toc}{subsection}{General}
-
-This document describes the protocols used between the various daemons. As
-Bacula has developed, it has become quite out of date. The general idea still
-holds true, but the details of the fields for each command, and indeed the
-commands themselves have changed considerably.
-
-It is intended to be a technical discussion of the general daemon protocols
-and as such is not targeted at end users but rather at developers and system
-administrators that want or need to know more of the working details of {\bf
-Bacula}.
-
-\section{Low Level Network Protocol}
-\index{Protocol!Low Level Network }
-\index{Low Level Network Protocol }
-\addcontentsline{toc}{subsection}{Low Level Network Protocol}
-
-At the lowest level, the network protocol is handled by {\bf BSOCK} packets
-which contain a lot of information about the status of the network connection:
-who is at the other end, etc. Each basic {\bf Bacula} network read or write
-actually consists of two low level network read/writes. The first write always
-sends four bytes of data in machine independent byte order. If data is to
-follow, the first four bytes are a positive non-zero integer indicating the
-length of the data that follow in the subsequent write. If the four byte
-integer is zero or negative, it indicates a special request, a sort of network
-signaling capability. In this case, no data packet will follow. The low level
-BSOCK routines expect that only a single thread is accessing the socket at a
-time. It is advised that multiple threads do not read/write the same socket.
-If you must do this, you must provide some sort of locking mechanism. It would
-not be appropriate for efficiency reasons to make every call to the BSOCK
-routines lock and unlock the packet.
-
-\section{General Daemon Protocol}
-\index{General Daemon Protocol }
-\index{Protocol!General Daemon }
-\addcontentsline{toc}{subsection}{General Daemon Protocol}
-
-In general, all the daemons follow the following global rules. There may be
-exceptions depending on the specific case. Normally, one daemon will be
-sending commands to another daemon (specifically, the Director to the Storage
-daemon and the Director to the File daemon).
-
-\begin{itemize}
-\item Commands are always ASCII commands that are upper/lower case dependent
- as well as space sensitive.
-\item All binary data is converted into ASCII (either with printf statements
- or using base64 encoding).
-\item All responses to commands sent are always prefixed with a return
- numeric code where codes in the 1000's are reserved for the Director, the
- 2000's are reserved for the File daemon, and the 3000's are reserved for the
-Storage daemon.
-\item Any response that is not prefixed with a numeric code is a command (or
- subcommand if you like) coming from the other end. For example, while the
- Director is corresponding with the Storage daemon, the Storage daemon can
-request Catalog services from the Director. This convention permits each side
-to send commands to the other daemon while simultaneously responding to
-commands.
-\item Any response that is of zero length, depending on the context, either
- terminates the data stream being sent or terminates command mode prior to
- closing the connection.
-\item Any response that is of negative length is a special sign that normally
- requires a response. For example, during data transfer from the File daemon
- to the Storage daemon, normally the File daemon sends continuously without
-intervening reads. However, periodically, the File daemon will send a packet
-of length -1 indicating that the current data stream is complete and that the
-Storage daemon should respond to the packet with an OK, ABORT JOB, PAUSE,
-etc. This permits the File daemon to efficiently send data while at the same
-time occasionally ``polling'' the Storage daemon for his status or any
-special requests.
-
-Currently, these negative lengths are specific to the daemon, but shortly,
-the range 0 to -999 will be standard daemon wide signals, while -1000 to
--1999 will be for Director user, -2000 to -2999 for the File daemon, and
--3000 to -3999 for the Storage daemon.
-\end{itemize}
-
-\section{The Protocol Used Between the Director and the Storage Daemon}
-\index{Daemon!Protocol Used Between the Director and the Storage }
-\index{Protocol Used Between the Director and the Storage Daemon }
-\addcontentsline{toc}{subsection}{Protocol Used Between the Director and the
-Storage Daemon}
-
-Before sending commands to the File daemon, the Director opens a Message
-channel with the Storage daemon, identifies itself and presents its password.
-If the password check is OK, the Storage daemon accepts the Director. The
-Director then passes the Storage daemon, the JobId to be run as well as the
-File daemon authorization (append, read all, or read for a specific session).
-The Storage daemon will then pass back to the Director a enabling key for this
-JobId that must be presented by the File daemon when opening the job. Until
-this process is complete, the Storage daemon is not available for use by File
-daemons.
-
-\footnotesize
-\begin{verbatim}
-SD: listens
-DR: makes connection
-DR: Hello <Director-name> calling <password>
-SD: 3000 OK Hello
-DR: JobId=nnn Allow=(append, read) Session=(*, SessionId)
- (Session not implemented yet)
-SD: 3000 OK Job Authorization=<password>
-DR: use device=<device-name> media_type=<media-type>
- pool_name=<pool-name> pool_type=<pool_type>
-SD: 3000 OK use device
-\end{verbatim}
-\normalsize
-
-For the Director to be authorized, the \lt{}Director-name\gt{} and the
-\lt{}password\gt{} must match the values in one of the Storage daemon's
-Director resources (there may be several Directors that can access a single
-Storage daemon).
-
-\section{The Protocol Used Between the Director and the File Daemon}
-\index{Daemon!Protocol Used Between the Director and the File }
-\index{Protocol Used Between the Director and the File Daemon }
-\addcontentsline{toc}{subsection}{Protocol Used Between the Director and the
-File Daemon}
-
-A typical conversation might look like the following:
-
-\footnotesize
-\begin{verbatim}
-FD: listens
-DR: makes connection
-DR: Hello <Director-name> calling <password>
-FD: 2000 OK Hello
-DR: JobId=nnn Authorization=<password>
-FD: 2000 OK Job
-DR: storage address = <Storage daemon address> port = <port-number>
- name = <DeviceName> mediatype = <MediaType>
-FD: 2000 OK storage
-DR: include
-DR: <directory1>
-DR: <directory2>
- ...
-DR: Null packet
-FD: 2000 OK include
-DR: exclude
-DR: <directory1>
-DR: <directory2>
- ...
-DR: Null packet
-FD: 2000 OK exclude
-DR: full
-FD: 2000 OK full
-DR: save
-FD: 2000 OK save
-FD: Attribute record for each file as sent to the
- Storage daemon (described above).
-FD: Null packet
-FD: <append close responses from Storage daemon>
- e.g.
- 3000 OK Volumes = <number of volumes>
- 3001 Volume = <volume-id> <start file> <start block>
- <end file> <end block> <volume session-id>
- 3002 Volume data = <date/time of last write> <Number bytes written>
- <number errors>
- ... additional Volume / Volume data pairs for volumes 2 .. n
-FD: Null packet
-FD: close socket
-\end{verbatim}
-\normalsize
-
-\section{The Save Protocol Between the File Daemon and the Storage Daemon}
-\index{Save Protocol Between the File Daemon and the Storage Daemon }
-\index{Daemon!Save Protocol Between the File Daemon and the Storage }
-\addcontentsline{toc}{subsection}{Save Protocol Between the File Daemon and
-the Storage Daemon}
-
-Once the Director has send a {\bf save} command to the File daemon, the File
-daemon will contact the Storage daemon to begin the save.
-
-In what follows: FD: refers to information set via the network from the File
-daemon to the Storage daemon, and SD: refers to information set from the
-Storage daemon to the File daemon.
-
-\subsection{Command and Control Information}
-\index{Information!Command and Control }
-\index{Command and Control Information }
-\addcontentsline{toc}{subsubsection}{Command and Control Information}
-
-Command and control information is exchanged in human readable ASCII commands.
-
-
-\footnotesize
-\begin{verbatim}
-FD: listens
-SD: makes connection
-FD: append open session = <JobId> [<password>]
-SD: 3000 OK ticket = <number>
-FD: append data <ticket-number>
-SD: 3000 OK data address = <IPaddress> port = <port>
-\end{verbatim}
-\normalsize
-
-\subsection{Data Information}
-\index{Information!Data }
-\index{Data Information }
-\addcontentsline{toc}{subsubsection}{Data Information}
-
-The Data information consists of the file attributes and data to the Storage
-daemon. For the most part, the data information is sent one way: from the File
-daemon to the Storage daemon. This allows the File daemon to transfer
-information as fast as possible without a lot of handshaking and network
-overhead.
-
-However, from time to time, the File daemon needs to do a sort of checkpoint
-of the situation to ensure that everything is going well with the Storage
-daemon. To do so, the File daemon sends a packet with a negative length
-indicating that he wishes the Storage daemon to respond by sending a packet of
-information to the File daemon. The File daemon then waits to receive a packet
-from the Storage daemon before continuing.
-
-All data sent are in binary format except for the header packet, which is in
-ASCII. There are two packet types used data transfer mode: a header packet,
-the contents of which are known to the Storage daemon, and a data packet, the
-contents of which are never examined by the Storage daemon.
-
-The first data packet to the Storage daemon will be an ASCII header packet
-consisting of the following data.
-
-\lt{}File-Index\gt{} \lt{}Stream-Id\gt{} \lt{}Info\gt{} where {\bf
-\lt{}File-Index\gt{}} is a sequential number beginning from one that
-increments with each file (or directory) sent.
-
-where {\bf \lt{}Stream-Id\gt{}} will be 1 for the Attributes record and 2 for
-uncompressed File data. 3 is reserved for the MD5 signature for the file.
-
-where {\bf \lt{}Info\gt{}} transmit information about the Stream to the
-Storage Daemon. It is a character string field where each character has a
-meaning. The only character currently defined is 0 (zero), which is simply a
-place holder (a no op). In the future, there may be codes indicating
-compressed data, encrypted data, etc.
-
-Immediately following the header packet, the Storage daemon will expect any
-number of data packets. The series of data packets is terminated by a zero
-length packet, which indicates to the Storage daemon that the next packet will
-be another header packet. As previously mentioned, a negative length packet is
-a request for the Storage daemon to temporarily enter command mode and send a
-reply to the File daemon. Thus an actual conversation might contain the
-following exchanges:
-
-\footnotesize
-\begin{verbatim}
-FD: <1 1 0> (header packet)
-FD: <data packet containing file-attributes>
-FD: Null packet
-FD: <1 2 0>
-FD: <multiple data packets containing the file data>
-FD: Packet length = -1
-SD: 3000 OK
-FD: <2 1 0>
-FD: <data packet containing file-attributes>
-FD: Null packet
-FD: <2 2 0>
-FD: <multiple data packets containing the file data>
-FD: Null packet
-FD: Null packet
-FD: append end session <ticket-number>
-SD: 3000 OK end
-FD: append close session <ticket-number>
-SD: 3000 OK Volumes = <number of volumes>
-SD: 3001 Volume = <volumeid> <start file> <start block>
- <end file> <end block> <volume session-id>
-SD: 3002 Volume data = <date/time of last write> <Number bytes written>
- <number errors>
-SD: ... additional Volume / Volume data pairs for
- volumes 2 .. n
-FD: close socket
-\end{verbatim}
-\normalsize
-
-The information returned to the File daemon by the Storage daemon in response
-to the {\bf append close session} is transmit in turn to the Director.
+++ /dev/null
-/* Century Schoolbook font is very similar to Computer Modern Math: cmmi */
-.MATH { font-family: "Century Schoolbook", serif; }
-.MATH I { font-family: "Century Schoolbook", serif; font-style: italic }
-.BOLDMATH { font-family: "Century Schoolbook", serif; font-weight: bold }
-
-/* implement both fixed-size and relative sizes */
-SMALL.XTINY { font-size : xx-small }
-SMALL.TINY { font-size : x-small }
-SMALL.SCRIPTSIZE { font-size : smaller }
-SMALL.FOOTNOTESIZE { font-size : small }
-SMALL.SMALL { }
-BIG.LARGE { }
-BIG.XLARGE { font-size : large }
-BIG.XXLARGE { font-size : x-large }
-BIG.HUGE { font-size : larger }
-BIG.XHUGE { font-size : xx-large }
-
-/* heading styles */
-H1 { }
-H2 { }
-H3 { }
-H4 { }
-H5 { }
-
-/* mathematics styles */
-DIV.displaymath { } /* math displays */
-TD.eqno { } /* equation-number cells */
-
-
-/* document-specific styles come next */
+++ /dev/null
-[General]
-img_extIsRegExp=false
-img_extensions=.eps .jpg .jpeg .png .pdf .ps .fig .gif
-kileprversion=2
-kileversion=2.0
-lastDocument=developers.tex
-masterDocument=
-name=Developers
-pkg_extIsRegExp=false
-pkg_extensions=.cls .sty
-src_extIsRegExp=false
-src_extensions=.tex .ltx .latex .dtx .ins
-
-[Tools]
-MakeIndex=
-QuickBuild=
-
-[item:catalog.tex]
-archive=true
-column=120
-encoding=
-highlight=
-line=0
-open=false
-order=-1
-
-[item:daemonprotocol.tex]
-archive=true
-column=0
-encoding=
-highlight=
-line=0
-open=false
-order=-1
-
-[item:developers.kilepr]
-archive=true
-column=114
-encoding=
-highlight=
-line=0
-open=false
-order=-1
-
-[item:developers.tex]
-archive=true
-column=36
-encoding=UTF-8
-highlight=LaTeX
-line=48
-open=true
-order=0
-
-[item:director.tex]
-archive=true
-column=0
-encoding=
-highlight=
-line=0
-open=false
-order=-1
-
-[item:fdl.tex]
-archive=true
-column=7864421
-encoding=
-highlight=
-line=0
-open=false
-order=-1
-
-[item:file.tex]
-archive=true
-column=0
-encoding=
-highlight=
-line=0
-open=false
-order=-1
-
-[item:generaldevel.tex]
-archive=true
-column=120
-encoding=
-highlight=
-line=0
-open=false
-order=-1
-
-[item:gui-interface.tex]
-archive=true
-column=7864421
-encoding=
-highlight=
-line=0
-open=false
-order=-1
-
-[item:md5.tex]
-archive=true
-column=147078704
-encoding=
-highlight=
-line=0
-open=false
-order=-1
-
-[item:mediaformat.tex]
-archive=true
-column=0
-encoding=
-highlight=
-line=0
-open=false
-order=-1
-
-[item:mempool.tex]
-archive=true
-column=0
-encoding=
-highlight=
-line=0
-open=false
-order=-1
-
-[item:netprotocol.tex]
-archive=true
-column=0
-encoding=
-highlight=
-line=0
-open=false
-order=-1
-
-[item:platformsupport.tex]
-archive=true
-column=7864421
-encoding=
-highlight=
-line=0
-open=false
-order=-1
-
-[item:porting.tex]
-archive=true
-column=0
-encoding=
-highlight=
-line=0
-open=false
-order=-1
-
-[item:regression.tex]
-archive=true
-column=0
-encoding=
-highlight=
-line=0
-open=false
-order=-1
-
-[item:smartall.tex]
-archive=true
-column=146049728
-encoding=
-highlight=
-line=0
-open=false
-order=-1
-
-[item:storage.tex]
-archive=true
-column=0
-encoding=
-highlight=
-line=0
-open=false
-order=-1
-
-[item:tls-techdoc.tex]
-archive=true
-column=0
-encoding=
-highlight=
-line=0
-open=false
-order=-1
-
-[item:version.tex]
-archive=true
-column=0
-encoding=
-highlight=
-line=0
-open=false
-order=-1
+++ /dev/null
-%%
-%%
-
-\documentclass[10pt,a4paper]{book}
-
-\topmargin -0.5in
-\oddsidemargin 0.0in
-\evensidemargin 0.0in
-\textheight 10in
-\textwidth 6.5in
-
-\usepackage{html}
-\usepackage{float}
-\usepackage{graphicx}
-\usepackage{bacula}
-\usepackage{longtable}
-\usepackage{makeidx}
-\usepackage{index}
-\usepackage{setspace}
-\usepackage{hyperref}
-\usepackage{url}
-
-
-\makeindex
-\newindex{general}{idx}{ind}{General Index}
-
-\sloppy
-
-\begin{document}
-\sloppy
-
-\newfont{\bighead}{cmr17 at 36pt}
-\parskip 10pt
-\parindent 0pt
-
-\title{\includegraphics{\idir bacula-logo.eps} \\ \bigskip
- \Huge{Developers' Guide}
- \begin{center}
- \large{It comes in the night and sucks
- the essence from your computers. }
- \end{center}
-}
-
-
-\author{Kern Sibbald}
-\date{\vspace{1.0in}\today \\
- This manual documents Bacula version \input{version} \\
- \vspace{0.2in}
- Copyright \copyright 1999-2009, Free Software Foundation Europe
- e.V. \\
- \vspace{0.2in}
- Permission is granted to copy, distribute and/or modify this document under the terms of the
- GNU Free Documentation License, Version 1.2 published by the Free Software Foundation;
- with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
- A copy of the license is included in the section entitled "GNU Free Documentation License".
-}
-
-
-\maketitle
-
-\clearpage
-\tableofcontents
-\clearpage
-\listoffigures
-\clearpage
-\listoftables
-\clearpage
-
-\include{generaldevel}
-\include{platformsupport}
-\include{daemonprotocol}
-\include{director}
-\include{file}
-\include{storage}
-\include{catalog}
-\include{mediaformat}
-\include{porting}
-\include{gui-interface}
-\include{tls-techdoc}
-\include{regression}
-\include{md5}
-\include{mempool}
-\include{netprotocol}
-\include{smartall}
-\include{fdl}
-
-
-% The following line tells link_resolver.pl to not include these files:
-% nolinks developersi baculai-dir baculai-fd baculai-sd baculai-console baculai-main
-
-% pull in the index
-\clearpage
-\printindex
-
-\end{document}
+++ /dev/null
-%%
-%%
-
-\chapter{Director Services Daemon}
-\label{_ChapterStart6}
-\index{Daemon!Director Services }
-\index{Director Services Daemon }
-\addcontentsline{toc}{section}{Director Services Daemon}
-
-This chapter is intended to be a technical discussion of the Director services
-and as such is not targeted at end users but rather at developers and system
-administrators that want or need to know more of the working details of {\bf
-Bacula}.
-
-The {\bf Bacula Director} services consist of the program that supervises all
-the backup and restore operations.
-
-To be written ...
+++ /dev/null
-%---------The file header---------------------------------------------
-
-%% \usepackage[english]{babel} %language selection
-%% \usepackage[T1]{fontenc}
-
-%%\pagenumbering{arabic}
-
-%% \usepackage{hyperref}
-%% \hypersetup{colorlinks,
-%% citecolor=black,
-%% filecolor=black,
-%% linkcolor=black,
-%% urlcolor=black,
-%% pdftex}
-
-
-%---------------------------------------------------------------------
-\chapter{GNU Free Documentation License}
-\index[general]{GNU ree Documentation License}
-\index[general]{License!GNU ree Documentation}
-\addcontentsline{toc}{section}{GNU ree Documentation License}
-
-%\label{label_fdl}
-
- \begin{center}
-
- Version 1.2, November 2002
-
-
- Copyright \copyright 2000,2001,2002 Free Software Foundation, Inc.
-
- \bigskip
-
- 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-
- \bigskip
-
- Everyone is permitted to copy and distribute verbatim copies
- of this license document, but changing it is not allowed.
-\end{center}
-
-
-\begin{center}
-{\bf\large Preamble}
-\end{center}
-
-The purpose of this License is to make a manual, textbook, or other
-functional and useful document "free" in the sense of freedom: to
-assure everyone the effective freedom to copy and redistribute it,
-with or without modifying it, either commercially or noncommercially.
-Secondarily, this License preserves for the author and publisher a way
-to get credit for their work, while not being considered responsible
-for modifications made by others.
-
-This License is a kind of "copyleft", which means that derivative
-works of the document must themselves be free in the same sense. It
-complements the GNU General Public License, which is a copyleft
-license designed for free software.
-
-We have designed this License in order to use it for manuals for free
-software, because free software needs free documentation: a free
-program should come with manuals providing the same freedoms that the
-software does. But this License is not limited to software manuals;
-it can be used for any textual work, regardless of subject matter or
-whether it is published as a printed book. We recommend this License
-principally for works whose purpose is instruction or reference.
-
-
-\begin{center}
-{\Large\bf 1. APPLICABILITY AND DEFINITIONS}
-\addcontentsline{toc}{section}{1. APPLICABILITY AND DEFINITIONS}
-\end{center}
-
-This License applies to any manual or other work, in any medium, that
-contains a notice placed by the copyright holder saying it can be
-distributed under the terms of this License. Such a notice grants a
-world-wide, royalty-free license, unlimited in duration, to use that
-work under the conditions stated herein. The \textbf{"Document"}, below,
-refers to any such manual or work. Any member of the public is a
-licensee, and is addressed as \textbf{"you"}. You accept the license if you
-copy, modify or distribute the work in a way requiring permission
-under copyright law.
-
-A \textbf{"Modified Version"} of the Document means any work containing the
-Document or a portion of it, either copied verbatim, or with
-modifications and/or translated into another language.
-
-A \textbf{"Secondary Section"} is a named appendix or a front-matter section of
-the Document that deals exclusively with the relationship of the
-publishers or authors of the Document to the Document's overall subject
-(or to related matters) and contains nothing that could fall directly
-within that overall subject. (Thus, if the Document is in part a
-textbook of mathematics, a Secondary Section may not explain any
-mathematics.) The relationship could be a matter of historical
-connection with the subject or with related matters, or of legal,
-commercial, philosophical, ethical or political position regarding
-them.
-
-The \textbf{"Invariant Sections"} are certain Secondary Sections whose titles
-are designated, as being those of Invariant Sections, in the notice
-that says that the Document is released under this License. If a
-section does not fit the above definition of Secondary then it is not
-allowed to be designated as Invariant. The Document may contain zero
-Invariant Sections. If the Document does not identify any Invariant
-Sections then there are none.
-
-The \textbf{"Cover Texts"} are certain short passages of text that are listed,
-as Front-Cover Texts or Back-Cover Texts, in the notice that says that
-the Document is released under this License. A Front-Cover Text may
-be at most 5 words, and a Back-Cover Text may be at most 25 words.
-
-A \textbf{"Transparent"} copy of the Document means a machine-readable copy,
-represented in a format whose specification is available to the
-general public, that is suitable for revising the document
-straightforwardly with generic text editors or (for images composed of
-pixels) generic paint programs or (for drawings) some widely available
-drawing editor, and that is suitable for input to text formatters or
-for automatic translation to a variety of formats suitable for input
-to text formatters. A copy made in an otherwise Transparent file
-format whose markup, or absence of markup, has been arranged to thwart
-or discourage subsequent modification by readers is not Transparent.
-An image format is not Transparent if used for any substantial amount
-of text. A copy that is not "Transparent" is called \textbf{"Opaque"}.
-
-Examples of suitable formats for Transparent copies include plain
-ASCII without markup, Texinfo input format, LaTeX input format, SGML
-or XML using a publicly available DTD, and standard-conforming simple
-HTML, PostScript or PDF designed for human modification. Examples of
-transparent image formats include PNG, XCF and JPG. Opaque formats
-include proprietary formats that can be read and edited only by
-proprietary word processors, SGML or XML for which the DTD and/or
-processing tools are not generally available, and the
-machine-generated HTML, PostScript or PDF produced by some word
-processors for output purposes only.
-
-The \textbf{"Title Page"} means, for a printed book, the title page itself,
-plus such following pages as are needed to hold, legibly, the material
-this License requires to appear in the title page. For works in
-formats which do not have any title page as such, "Title Page" means
-the text near the most prominent appearance of the work's title,
-preceding the beginning of the body of the text.
-
-A section \textbf{"Entitled XYZ"} means a named subunit of the Document whose
-title either is precisely XYZ or contains XYZ in parentheses following
-text that translates XYZ in another language. (Here XYZ stands for a
-specific section name mentioned below, such as \textbf{"Acknowledgements"},
-\textbf{"Dedications"}, \textbf{"Endorsements"}, or \textbf{"History"}.)
-To \textbf{"Preserve the Title"}
-of such a section when you modify the Document means that it remains a
-section "Entitled XYZ" according to this definition.
-
-The Document may include Warranty Disclaimers next to the notice which
-states that this License applies to the Document. These Warranty
-Disclaimers are considered to be included by reference in this
-License, but only as regards disclaiming warranties: any other
-implication that these Warranty Disclaimers may have is void and has
-no effect on the meaning of this License.
-
-
-\begin{center}
-{\Large\bf 2. VERBATIM COPYING}
-\addcontentsline{toc}{section}{2. VERBATIM COPYING}
-\end{center}
-
-You may copy and distribute the Document in any medium, either
-commercially or noncommercially, provided that this License, the
-copyright notices, and the license notice saying this License applies
-to the Document are reproduced in all copies, and that you add no other
-conditions whatsoever to those of this License. You may not use
-technical measures to obstruct or control the reading or further
-copying of the copies you make or distribute. However, you may accept
-compensation in exchange for copies. If you distribute a large enough
-number of copies you must also follow the conditions in section 3.
-
-You may also lend copies, under the same conditions stated above, and
-you may publicly display copies.
-
-
-\begin{center}
-{\Large\bf 3. COPYING IN QUANTITY}
-\addcontentsline{toc}{section}{3. COPYING IN QUANTITY}
-\end{center}
-
-
-If you publish printed copies (or copies in media that commonly have
-printed covers) of the Document, numbering more than 100, and the
-Document's license notice requires Cover Texts, you must enclose the
-copies in covers that carry, clearly and legibly, all these Cover
-Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
-the back cover. Both covers must also clearly and legibly identify
-you as the publisher of these copies. The front cover must present
-the full title with all words of the title equally prominent and
-visible. You may add other material on the covers in addition.
-Copying with changes limited to the covers, as long as they preserve
-the title of the Document and satisfy these conditions, can be treated
-as verbatim copying in other respects.
-
-If the required texts for either cover are too voluminous to fit
-legibly, you should put the first ones listed (as many as fit
-reasonably) on the actual cover, and continue the rest onto adjacent
-pages.
-
-If you publish or distribute Opaque copies of the Document numbering
-more than 100, you must either include a machine-readable Transparent
-copy along with each Opaque copy, or state in or with each Opaque copy
-a computer-network location from which the general network-using
-public has access to download using public-standard network protocols
-a complete Transparent copy of the Document, free of added material.
-If you use the latter option, you must take reasonably prudent steps,
-when you begin distribution of Opaque copies in quantity, to ensure
-that this Transparent copy will remain thus accessible at the stated
-location until at least one year after the last time you distribute an
-Opaque copy (directly or through your agents or retailers) of that
-edition to the public.
-
-It is requested, but not required, that you contact the authors of the
-Document well before redistributing any large number of copies, to give
-them a chance to provide you with an updated version of the Document.
-
-
-\begin{center}
-{\Large\bf 4. MODIFICATIONS}
-\addcontentsline{toc}{section}{4. MODIFICATIONS}
-\end{center}
-
-You may copy and distribute a Modified Version of the Document under
-the conditions of sections 2 and 3 above, provided that you release
-the Modified Version under precisely this License, with the Modified
-Version filling the role of the Document, thus licensing distribution
-and modification of the Modified Version to whoever possesses a copy
-of it. In addition, you must do these things in the Modified Version:
-
-\begin{itemize}
-\item[A.]
- Use in the Title Page (and on the covers, if any) a title distinct
- from that of the Document, and from those of previous versions
- (which should, if there were any, be listed in the History section
- of the Document). You may use the same title as a previous version
- if the original publisher of that version gives permission.
-
-\item[B.]
- List on the Title Page, as authors, one or more persons or entities
- responsible for authorship of the modifications in the Modified
- Version, together with at least five of the principal authors of the
- Document (all of its principal authors, if it has fewer than five),
- unless they release you from this requirement.
-
-\item[C.]
- State on the Title page the name of the publisher of the
- Modified Version, as the publisher.
-
-\item[D.]
- Preserve all the copyright notices of the Document.
-
-\item[E.]
- Add an appropriate copyright notice for your modifications
- adjacent to the other copyright notices.
-
-\item[F.]
- Include, immediately after the copyright notices, a license notice
- giving the public permission to use the Modified Version under the
- terms of this License, in the form shown in the Addendum below.
-
-\item[G.]
- Preserve in that license notice the full lists of Invariant Sections
- and required Cover Texts given in the Document's license notice.
-
-\item[H.]
- Include an unaltered copy of this License.
-
-\item[I.]
- Preserve the section Entitled "History", Preserve its Title, and add
- to it an item stating at least the title, year, new authors, and
- publisher of the Modified Version as given on the Title Page. If
- there is no section Entitled "History" in the Document, create one
- stating the title, year, authors, and publisher of the Document as
- given on its Title Page, then add an item describing the Modified
- Version as stated in the previous sentence.
-
-\item[J.]
- Preserve the network location, if any, given in the Document for
- public access to a Transparent copy of the Document, and likewise
- the network locations given in the Document for previous versions
- it was based on. These may be placed in the "History" section.
- You may omit a network location for a work that was published at
- least four years before the Document itself, or if the original
- publisher of the version it refers to gives permission.
-
-\item[K.]
- For any section Entitled "Acknowledgements" or "Dedications",
- Preserve the Title of the section, and preserve in the section all
- the substance and tone of each of the contributor acknowledgements
- and/or dedications given therein.
-
-\item[L.]
- Preserve all the Invariant Sections of the Document,
- unaltered in their text and in their titles. Section numbers
- or the equivalent are not considered part of the section titles.
-
-\item[M.]
- Delete any section Entitled "Endorsements". Such a section
- may not be included in the Modified Version.
-
-\item[N.]
- Do not retitle any existing section to be Entitled "Endorsements"
- or to conflict in title with any Invariant Section.
-
-\item[O.]
- Preserve any Warranty Disclaimers.
-\end{itemize}
-
-If the Modified Version includes new front-matter sections or
-appendices that qualify as Secondary Sections and contain no material
-copied from the Document, you may at your option designate some or all
-of these sections as invariant. To do this, add their titles to the
-list of Invariant Sections in the Modified Version's license notice.
-These titles must be distinct from any other section titles.
-
-You may add a section Entitled "Endorsements", provided it contains
-nothing but endorsements of your Modified Version by various
-parties--for example, statements of peer review or that the text has
-been approved by an organization as the authoritative definition of a
-standard.
-
-You may add a passage of up to five words as a Front-Cover Text, and a
-passage of up to 25 words as a Back-Cover Text, to the end of the list
-of Cover Texts in the Modified Version. Only one passage of
-Front-Cover Text and one of Back-Cover Text may be added by (or
-through arrangements made by) any one entity. If the Document already
-includes a cover text for the same cover, previously added by you or
-by arrangement made by the same entity you are acting on behalf of,
-you may not add another; but you may replace the old one, on explicit
-permission from the previous publisher that added the old one.
-
-The author(s) and publisher(s) of the Document do not by this License
-give permission to use their names for publicity for or to assert or
-imply endorsement of any Modified Version.
-
-
-\begin{center}
-{\Large\bf 5. COMBINING DOCUMENTS}
-\addcontentsline{toc}{section}{5. COMBINING DOCUMENTS}
-\end{center}
-
-
-You may combine the Document with other documents released under this
-License, under the terms defined in section 4 above for modified
-versions, provided that you include in the combination all of the
-Invariant Sections of all of the original documents, unmodified, and
-list them all as Invariant Sections of your combined work in its
-license notice, and that you preserve all their Warranty Disclaimers.
-
-The combined work need only contain one copy of this License, and
-multiple identical Invariant Sections may be replaced with a single
-copy. If there are multiple Invariant Sections with the same name but
-different contents, make the title of each such section unique by
-adding at the end of it, in parentheses, the name of the original
-author or publisher of that section if known, or else a unique number.
-Make the same adjustment to the section titles in the list of
-Invariant Sections in the license notice of the combined work.
-
-In the combination, you must combine any sections Entitled "History"
-in the various original documents, forming one section Entitled
-"History"; likewise combine any sections Entitled "Acknowledgements",
-and any sections Entitled "Dedications". You must delete all sections
-Entitled "Endorsements".
-
-\begin{center}
-{\Large\bf 6. COLLECTIONS OF DOCUMENTS}
-\addcontentsline{toc}{section}{6. COLLECTIONS OF DOCUMENTS}
-\end{center}
-
-You may make a collection consisting of the Document and other documents
-released under this License, and replace the individual copies of this
-License in the various documents with a single copy that is included in
-the collection, provided that you follow the rules of this License for
-verbatim copying of each of the documents in all other respects.
-
-You may extract a single document from such a collection, and distribute
-it individually under this License, provided you insert a copy of this
-License into the extracted document, and follow this License in all
-other respects regarding verbatim copying of that document.
-
-
-\begin{center}
-{\Large\bf 7. AGGREGATION WITH INDEPENDENT WORKS}
-\addcontentsline{toc}{section}{7. AGGREGATION WITH INDEPENDENT WORKS}
-\end{center}
-
-
-A compilation of the Document or its derivatives with other separate
-and independent documents or works, in or on a volume of a storage or
-distribution medium, is called an "aggregate" if the copyright
-resulting from the compilation is not used to limit the legal rights
-of the compilation's users beyond what the individual works permit.
-When the Document is included in an aggregate, this License does not
-apply to the other works in the aggregate which are not themselves
-derivative works of the Document.
-
-If the Cover Text requirement of section 3 is applicable to these
-copies of the Document, then if the Document is less than one half of
-the entire aggregate, the Document's Cover Texts may be placed on
-covers that bracket the Document within the aggregate, or the
-electronic equivalent of covers if the Document is in electronic form.
-Otherwise they must appear on printed covers that bracket the whole
-aggregate.
-
-
-\begin{center}
-{\Large\bf 8. TRANSLATION}
-\addcontentsline{toc}{section}{8. TRANSLATION}
-\end{center}
-
-
-Translation is considered a kind of modification, so you may
-distribute translations of the Document under the terms of section 4.
-Replacing Invariant Sections with translations requires special
-permission from their copyright holders, but you may include
-translations of some or all Invariant Sections in addition to the
-original versions of these Invariant Sections. You may include a
-translation of this License, and all the license notices in the
-Document, and any Warranty Disclaimers, provided that you also include
-the original English version of this License and the original versions
-of those notices and disclaimers. In case of a disagreement between
-the translation and the original version of this License or a notice
-or disclaimer, the original version will prevail.
-
-If a section in the Document is Entitled "Acknowledgements",
-"Dedications", or "History", the requirement (section 4) to Preserve
-its Title (section 1) will typically require changing the actual
-title.
-
-
-\begin{center}
-{\Large\bf 9. TERMINATION}
-\addcontentsline{toc}{section}{9. TERMINATION}
-\end{center}
-
-
-You may not copy, modify, sublicense, or distribute the Document except
-as expressly provided for under this License. Any other attempt to
-copy, modify, sublicense or distribute the Document is void, and will
-automatically terminate your rights under this License. However,
-parties who have received copies, or rights, from you under this
-License will not have their licenses terminated so long as such
-parties remain in full compliance.
-
-
-\begin{center}
-{\Large\bf 10. FUTURE REVISIONS OF THIS LICENSE}
-\addcontentsline{toc}{section}{10. FUTURE REVISIONS OF THIS LICENSE}
-\end{center}
-
-
-The Free Software Foundation may publish new, revised versions
-of the GNU Free Documentation License from time to time. Such new
-versions will be similar in spirit to the present version, but may
-differ in detail to address new problems or concerns. See
-http://www.gnu.org/copyleft/.
-
-Each version of the License is given a distinguishing version number.
-If the Document specifies that a particular numbered version of this
-License "or any later version" applies to it, you have the option of
-following the terms and conditions either of that specified version or
-of any later version that has been published (not as a draft) by the
-Free Software Foundation. If the Document does not specify a version
-number of this License, you may choose any version ever published (not
-as a draft) by the Free Software Foundation.
-
-
-\begin{center}
-{\Large\bf ADDENDUM: How to use this License for your documents}
-\addcontentsline{toc}{section}{ADDENDUM: How to use this License for your documents}
-\end{center}
-
-To use this License in a document you have written, include a copy of
-the License in the document and put the following copyright and
-license notices just after the title page:
-
-\bigskip
-\begin{quote}
- Copyright \copyright YEAR YOUR NAME.
- Permission is granted to copy, distribute and/or modify this document
- under the terms of the GNU Free Documentation License, Version 1.2
- or any later version published by the Free Software Foundation;
- with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
- A copy of the license is included in the section entitled "GNU
- Free Documentation License".
-\end{quote}
-\bigskip
-
-If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts,
-replace the "with...Texts." line with this:
-
-\bigskip
-\begin{quote}
- with the Invariant Sections being LIST THEIR TITLES, with the
- Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST.
-\end{quote}
-\bigskip
-
-If you have Invariant Sections without Cover Texts, or some other
-combination of the three, merge those two alternatives to suit the
-situation.
-
-If your document contains nontrivial examples of program code, we
-recommend releasing these examples in parallel under your choice of
-free software license, such as the GNU General Public License,
-to permit their use in free software.
-
-%---------------------------------------------------------------------
+++ /dev/null
-%%
-%%
-
-\chapter{File Services Daemon}
-\label{_ChapterStart11}
-\index{File Services Daemon }
-\index{Daemon!File Services }
-\addcontentsline{toc}{section}{File Services Daemon}
-
-Please note, this section is somewhat out of date as the code has evolved
-significantly. The basic idea has not changed though.
-
-This chapter is intended to be a technical discussion of the File daemon
-services and as such is not targeted at end users but rather at developers and
-system administrators that want or need to know more of the working details of
-{\bf Bacula}.
-
-The {\bf Bacula File Services} consist of the programs that run on the system
-to be backed up and provide the interface between the Host File system and
-Bacula -- in particular, the Director and the Storage services.
-
-When time comes for a backup, the Director gets in touch with the File daemon
-on the client machine and hands it a set of ``marching orders'' which, if
-written in English, might be something like the following:
-
-OK, {\bf File daemon}, it's time for your daily incremental backup. I want you
-to get in touch with the Storage daemon on host archive.mysite.com and perform
-the following save operations with the designated options. You'll note that
-I've attached include and exclude lists and patterns you should apply when
-backing up the file system. As this is an incremental backup, you should save
-only files modified since the time you started your last backup which, as you
-may recall, was 2000-11-19-06:43:38. Please let me know when you're done and
-how it went. Thank you.
-
-So, having been handed everything it needs to decide what to dump and where to
-store it, the File daemon doesn't need to have any further contact with the
-Director until the backup is complete providing there are no errors. If there
-are errors, the error messages will be delivered immediately to the Director.
-While the backup is proceeding, the File daemon will send the file coordinates
-and data for each file being backed up to the Storage daemon, which will in
-turn pass the file coordinates to the Director to put in the catalog.
-
-During a {\bf Verify} of the catalog, the situation is different, since the
-File daemon will have an exchange with the Director for each file, and will
-not contact the Storage daemon.
-
-A {\bf Restore} operation will be very similar to the {\bf Backup} except that
-during the {\bf Restore} the Storage daemon will not send storage coordinates
-to the Director since the Director presumably already has them. On the other
-hand, any error messages from either the Storage daemon or File daemon will
-normally be sent directly to the Directory (this, of course, depends on how
-the Message resource is defined).
-
-\section{Commands Received from the Director for a Backup}
-\index{Backup!Commands Received from the Director for a }
-\index{Commands Received from the Director for a Backup }
-\addcontentsline{toc}{subsection}{Commands Received from the Director for a
-Backup}
-
-To be written ...
-
-\section{Commands Received from the Director for a Restore}
-\index{Commands Received from the Director for a Restore }
-\index{Restore!Commands Received from the Director for a }
-\addcontentsline{toc}{subsection}{Commands Received from the Director for a
-Restore}
-
-To be written ...
+++ /dev/null
-#!/usr/bin/perl -w
-# Fixes various things within tex files.
-
-use strict;
-
-my %args;
-
-
-sub get_includes {
- # Get a list of include files from the top-level tex file.
- my (@list,$file);
-
- foreach my $filename (@_) {
- $filename or next;
- # Start with the top-level latex file so it gets checked too.
- push (@list,$filename);
-
- # Get a list of all the html files in the directory.
- open IF,"<$filename" or die "Cannot open input file $filename";
- while (<IF>) {
- chomp;
- push @list,"$1.tex" if (/\\include\{(.*?)\}/);
- }
-
- close IF;
- }
- return @list;
-}
-
-sub convert_files {
- my (@files) = @_;
- my ($linecnt,$filedata,$output,$itemcnt,$indentcnt,$cnt);
-
- $cnt = 0;
- foreach my $file (@files) {
- # Open the file and load the whole thing into $filedata. A bit wasteful but
- # easier to deal with, and we don't have a problem with speed here.
- $filedata = "";
- open IF,"<$file" or die "Cannot open input file $file";
- while (<IF>) {
- $filedata .= $_;
- }
- close IF;
-
- # We look for a line that starts with \item, and indent the two next lines (if not blank)
- # by three spaces.
- my $linecnt = 3;
- $indentcnt = 0;
- $output = "";
- # Process a line at a time.
- foreach (split(/\n/,$filedata)) {
- $_ .= "\n"; # Put back the return.
- # If this line is less than the third line past the \item command,
- # and the line isn't blank and doesn't start with whitespace
- # add three spaces to the start of the line. Keep track of the number
- # of lines changed.
- if ($linecnt < 3 and !/^\\item/) {
- if (/^[^\n\s]/) {
- $output .= " " . $_;
- $indentcnt++;
- } else {
- $output .= $_;
- }
- $linecnt++;
- } else {
- $linecnt = 3;
- $output .= $_;
- }
- /^\\item / and $linecnt = 1;
- }
-
-
- # This is an item line. We need to process it too. If inside a \begin{description} environment, convert
- # \item {\bf xxx} to \item [xxx] or \item [{xxx}] (if xxx contains '[' or ']'.
- $itemcnt = 0;
- $filedata = $output;
- $output = "";
- my ($before,$descrip,$this,$between);
-
- # Find any \begin{description} environment
- while ($filedata =~ /(\\begin[\s\n]*\{[\s\n]*description[\s\n]*\})(.*?)(\\end[\s\n]*\{[\s\n]*description[\s\n]*\})/s) {
- $output .= $` . $1;
- $filedata = $3 . $';
- $descrip = $2;
-
- # Search for \item {\bf xxx}
- while ($descrip =~ /\\item[\s\n]*\{[\s\n]*\\bf[\s\n]*/s) {
- $descrip = $';
- $output .= $`;
- ($between,$descrip) = find_matching_brace($descrip);
- if (!$descrip) {
- $linecnt = $output =~ tr/\n/\n/;
- print STDERR "Missing matching curly brace at line $linecnt in $file\n" if (!$descrip);
- }
-
- # Now do the replacement.
- $between = '{' . $between . '}' if ($between =~ /\[|\]/);
- $output .= "\\item \[$between\]";
- $itemcnt++;
- }
- $output .= $descrip;
- }
- $output .= $filedata;
-
- # If any hyphens or \item commnads were converted, save the file.
- if ($indentcnt or $itemcnt) {
- open OF,">$file" or die "Cannot open output file $file";
- print OF $output;
- close OF;
- print "$indentcnt indent", ($indentcnt == 1) ? "" : "s"," added in $file\n";
- print "$itemcnt item", ($itemcnt == 1) ? "" : "s"," Changed in $file\n";
- }
-
- $cnt += $indentcnt + $itemcnt;
- }
- return $cnt;
-}
-
-sub find_matching_brace {
- # Finds text up to the next matching brace. Assumes that the input text doesn't contain
- # the opening brace, but we want to find text up to a matching closing one.
- # Returns the text between the matching braces, followed by the rest of the text following
- # (which does not include the matching brace).
- #
- my $str = shift;
- my ($this,$temp);
- my $cnt = 1;
-
- while ($cnt) {
- # Ignore verbatim constructs involving curly braces, or if the character preceding
- # the curly brace is a backslash.
- if ($str =~ /\\verb\*?\{.*?\{|\\verb\*?\}.*?\}|\{|\}/s) {
- $this .= $`;
- $str = $';
- $temp = $&;
-
- if ((substr($this,-1,1) eq '\\') or
- $temp =~ /^\\verb/) {
- $this .= $temp;
- next;
- }
-
- $cnt += ($temp eq '{') ? 1 : -1;
- # If this isn't the matching curly brace ($cnt > 0), include the brace.
- $this .= $temp if ($cnt);
- } else {
- # No matching curly brace found.
- return ($this . $str,'');
- }
- }
- return ($this,$str);
-}
-
-sub check_arguments {
- # Checks command-line arguments for ones starting with -- puts them into
- # a hash called %args and removes them from @ARGV.
- my $args = shift;
- my $i;
-
- for ($i = 0; $i < $#ARGV; $i++) {
- $ARGV[$i] =~ /^\-+/ or next;
- $ARGV[$i] =~ s/^\-+//;
- $args{$ARGV[$i]} = "";
- delete ($ARGV[$i]);
-
- }
-}
-
-##################################################################
-# MAIN ####
-##################################################################
-
-my @includes;
-my $cnt;
-
-check_arguments(\%args);
-die "No Files given to Check\n" if ($#ARGV < 0);
-
-# Examine the file pointed to by the first argument to get a list of
-# includes to test.
-@includes = get_includes(@ARGV);
-
-$cnt = convert_files(@includes);
-print "No lines changed\n" unless $cnt;
+++ /dev/null
-%%
-%%
-
-\chapter{Bacula Developer Notes}
-\label{_ChapterStart10}
-\index{Bacula Developer Notes}
-\index{Notes!Bacula Developer}
-\addcontentsline{toc}{section}{Bacula Developer Notes}
-
-This document is intended mostly for developers and describes how you can
-contribute to the Bacula project and the the general framework of making
-Bacula source changes.
-
-\subsection{Contributions}
-\index{Contributions}
-\addcontentsline{toc}{subsubsection}{Contributions}
-
-Contributions to the Bacula project come in many forms: ideas,
-participation in helping people on the bacula-users email list, packaging
-Bacula binaries for the community, helping improve the documentation, and
-submitting code.
-
-Contributions in the form of submissions for inclusion in the project are
-broken into two groups. The first are contributions that are aids and not
-essential to Bacula. In general, these will be scripts or will go into the
-{\bf bacula/examples} directory. For these kinds of non-essential
-contributions there is no obligation to do a copyright assignment as
-described below. However, a copyright assignment would still be
-appreciated.
-
-The second class of contributions are those which will be integrated with
-Bacula and become an essential part (code, scripts, documentation, ...)
-Within this class of contributions, there are two hurdles to surmount. One
-is getting your patch accepted, and two is dealing with copyright issues.
-The following text describes some of the requirements for such code.
-
-\subsection{Patches}
-\index{Patches}
-\addcontentsline{toc}{subsubsection}{Patches}
-
-Subject to the copyright assignment described below, your patches should be
-sent in {\bf git format-patch} format relative to the current contents of the
-master branch of the Source Forge Git repository. Please attach the
-output file or files generated by the {\bf git format-patch} to the email
-rather than include them directory to avoid wrapping of the lines
-in the patch. Please be sure to use the Bacula
-indenting standard (see below) for source code. If you have checked out
-the source with Git, you can get a diff using.
-
-\begin{verbatim}
-git pull
-git format-patch -M
-\end{verbatim}
-
-If you plan on doing significant development work over a period of time,
-after having your first patch reviewed and approved, you will be eligible
-for having developer Git write access so that you can commit your changes
-directly to the Git repository. To do so, you will need a userid on Source
-Forge.
-
-\subsection{Copyrights}
-\index{Copyrights}
-\addcontentsline{toc}{subsubsection}{Copyrights}
-
-To avoid future problems concerning changing licensing or
-copyrights, all code contributions more than a hand full of lines
-must be in the Public Domain or have the copyright transferred to
-the Free Software Foundation Europe e.V. with a Fiduciary License
-Agreement (FLA) as the case for all the current code.
-
-Prior to November 2004, all the code was copyrighted by Kern Sibbald and
-John Walker. After November 2004, the code was copyrighted by Kern
-Sibbald, then on the 15th of November 2006, Kern transferred the copyright
-to the Free Software Foundation Europe e.V. In signing the FLA and
-transferring the copyright, you retain the right to use the code you have
-submitted as you want, and you ensure that Bacula will always remain Free
-and Open Source.
-
-Your name should be clearly indicated as the author of the code, and you
-must be extremely careful not to violate any copyrights or patents or use
-other people's code without acknowledging it. The purpose of this
-requirement is to avoid future copyright, patent, or intellectual property
-problems. Please read the LICENSE agreement in the main Bacula source code
-directory. When you sign the Fiduciary License Agreement (FLA) and send it
-in, you are agreeing to the terms of that LICENSE file.
-
-If you don't understand what we mean by future problems, please
-examine the difficulties Mozilla was having finding
-previous contributors at \elink{
-http://www.mozilla.org/MPL/missing.html}
-{http://www.mozilla.org/MPL/missing.html}. The other important issue is to
-avoid copyright, patent, or intellectual property violations as was
-(May 2003) claimed by SCO against IBM.
-
-Although the copyright will be held by the Free Software
-Foundation Europe e.V., each developer is expected to indicate
-that he wrote and/or modified a particular module (or file) and
-any other sources. The copyright assignment may seem a bit
-unusual, but in reality, it is not. Most large projects require
-this.
-
-If you have any doubts about this, please don't hesitate to ask. The
-objective is to assure the long term survival of the Bacula project.
-
-Items not needing a copyright assignment are: most small changes,
-enhancements, or bug fixes of 5-10 lines of code, which amount to
-less than 20% of any particular file.
-
-\subsection{Copyright Assignment -- Fiduciary License Agreement}
-\index{Copyright Assignment}
-\index{Assignment!Copyright}
-\addcontentsline{toc}{subsubsection}{Copyright Assignment -- Fiduciary License Agreement}
-
-Since this is not a commercial enterprise, and we prefer to believe in
-everyone's good faith, previously developers could assign the copyright by
-explicitly acknowledging that they do so in their first submission. This
-was sufficient if the developer is independent, or an employee of a
-not-for-profit organization or a university. However, in an effort to
-ensure that the Bacula code is really clean, beginning in August 2006, all
-previous and future developers with SVN write access will be asked to submit a
-copyright assignment (or Fiduciary License Agreement -- FLA),
-which means you agree to the LICENSE in the main source
-directory. It also means that you receive back the right to use
-the code that you have submitted.
-
-Any developer who wants to contribute and is employed by a company should
-either list the employer as the owner of the code, or get explicit
-permission from him to sign the copyright assignment. This is because in
-many countries, all work that an employee does whether on company time or
-in the employee's free time is considered to be Intellectual Property of
-the company. Obtaining official approval or an FLA from the company will
-avoid misunderstandings between the employee, the company, and the Bacula
-project. A good number of companies have already followed this procedure.
-
-The Fiduciary License Agreement is posted on the Bacula web site at:
-\elink{http://www.bacula.org/en/FLA-bacula.en.pdf}{http://www.bacula.org/en/FLA-bacula.en.pdf}
-
-The instructions for filling out this agreement are also at:
-\elink{http://www.bacula.org/?page=fsfe}{http://www.bacula.org/?page=fsfe}
-
-It should be filled out, then sent to:
-
-\begin{verbatim}
- Kern Sibbald
- Cotes-de-Montmoiret 9
- 1012 Lausanne
- Switzerland
-\end{verbatim}
-
-Please note that the above address is different from the officially
-registered office mentioned in the document. When you send in such a
-complete document, please notify me: kern at sibbald dot com, and
-please add your email address to the FLA so that I can contact you
-to confirm reception of the signed FLA.
-
-
-\section{The Development Cycle}
-\index{Developement Cycle}
-\index{Cycle!Developement}
-\addcontentsline{toc}{subsubsection}{Development Cycle}
-
-As discussed on the email lists, the number of contributions are
-increasing significantly. We expect this positive trend
-will continue. As a consequence, we have modified how we do
-development, and instead of making a list of all the features that we will
-implement in the next version, each developer signs up for one (maybe
-two) projects at a time, and when they are complete, and the code
-is stable, we will release a new version. The release cycle will probably
-be roughly six months.
-
-The difference is that with a shorter release cycle and fewer released
-feature, we will have more time to review the new code that is being
-contributed, and will be able to devote more time to a smaller number of
-projects (some prior versions had too many new features for us to handle
-correctly).
-
-Future release schedules will be much the same, and the
-number of new features will also be much the same providing that the
-contributions continue to come -- and they show no signs of let up :-)
-
-\index{Feature Requests}
-{\bf Feature Requests:} \\
-In addition, we have "formalizee" the feature requests a bit.
-
-Instead of me maintaining an informal list of everything I run into
-(kernstodo), we now maintain a "formal" list of projects. This
-means that all new feature requests, including those recently discussed on
-the email lists, must be formally submitted and approved.
-
-Formal submission of feature requests will take two forms: \\
-1. non-mandatory, but highly recommended is to discuss proposed new features
-on the mailing list.\\
-2. Formal submission of an Feature Request in a special format. We'll
-give an example of this below, but you can also find it on the web site
-under "Support -\gt{} Feature Requests". Since it takes a bit of time to
-properly fill out a Feature Request form, you probably should check on the
-email list first.
-
-Once the Feature Request is received by the keeper of the projects list, it
-will be sent to the Bacula project manager (Kern), and he will either
-accept it (90% of the time), send it back asking for clarification (10% of
-the time), send it to the email list asking for opinions, or reject it
-(very few cases).
-
-If it is accepted, it will go in the "projects" file (a simple ASCII file)
-maintained in the main Bacula source directory.
-
-{\bf Implementation of Feature Requests:}\\
-Any qualified developer can sign up for a project. The project must have
-an entry in the projects file, and the developer's name will appear in the
-Status field.
-
-{\bf How Feature Requests are accepted:}\\
-Acceptance of Feature Requests depends on several things: \\
-1. feedback from users. If it is negative, the Feature Request will probably not be
-accepted. \\
-2. the difficulty of the project. A project that is so
-difficult that we cannot imagine finding someone to implement probably won't
-be accepted. Obviously if you know how to implement it, don't hesitate
-to put it in your Feature Request \\
- 3. whether or not the Feature Request fits within the current strategy of
-Bacula (for example an Feature Request that requests changing the tape to
-tar format probably would not be accepted, ...).
-
-{\bf How Feature Requests are prioritized:}\\
-Once an Feature Request is accepted, it needs to be implemented. If you
-can find a developer for it, or one signs up for implementing it, then the
-Feature Request becomes top priority (at least for that developer).
-
-Between releases of Bacula, we will generally solicit Feature Request input
-for the next version, and by way of this email, we suggest that you send
-discuss and send in your Feature Requests for the next release. Please
-verify that the Feature Request is not in the current list (attached to this email).
-
-Once users have had several weeks to submit Feature Requests, the keeper of
-the projects list will organize them, and request users to vote on them.
-This will allow fixing prioritizing the Feature Requests. Having a
-priority is one thing, but getting it implement is another thing -- we are
-hoping that the Bacula community will take more responsibility for assuring
-the implementation of accepted Feature Requests.
-
-Feature Request format:
-\begin{verbatim}
-============= Empty Feature Request form ===========
-Item n: One line summary ...
- Date: Date submitted
- Origin: Name and email of originator.
- Status:
-
- What: More detailed explanation ...
-
- Why: Why it is important ...
-
- Notes: Additional notes or features (omit if not used)
-============== End Feature Request form ==============
-\end{verbatim}
-
-\begin{verbatim}
-============= Example Completed Feature Request form ===========
-Item 1: Implement a Migration job type that will move the job
- data from one device to another.
- Origin: Sponsored by Riege Sofware International GmbH. Contact:
- Daniel Holtkamp <holtkamp at riege dot com>
- Date: 28 October 2005
- Status: Partially coded in 1.37 -- much more to do. Assigned to
- Kern.
-
- What: The ability to copy, move, or archive data that is on a
- device to another device is very important.
-
- Why: An ISP might want to backup to disk, but after 30 days
- migrate the data to tape backup and delete it from
- disk. Bacula should be able to handle this
- automatically. It needs to know what was put where,
- and when, and what to migrate -- it is a bit like
- retention periods. Doing so would allow space to be
- freed up for current backups while maintaining older
- data on tape drives.
-
- Notes: Migration could be triggered by:
- Number of Jobs
- Number of Volumes
- Age of Jobs
- Highwater size (keep total size)
- Lowwater mark
-=================================================
-\end{verbatim}
-
-
-\section{Bacula Code Submissions and Projects}
-\index{Submissions and Projects}
-\addcontentsline{toc}{subsection}{Code Submissions and Projects}
-
-Getting code implemented in Bacula works roughly as follows:
-
-\begin{itemize}
-
-\item Kern is the project manager, but prefers not to be a "gate keeper".
- This means that the developers are expected to be self-motivated,
- and once they have experience submit directly to the Git
- repositories. However,
- it is a good idea to have your patches reviewed prior to submitting,
- and it is a bad idea to submit monster patches because no one will
- be able to properly review them. See below for more details on this.
-
-\item There are growing numbers of contributions (very good).
-
-\item Some contributions come in the form of relatively small patches,
- which Kern reviews, integrates, documents, tests, and maintains.
-
-\item All Bacula developers take full
- responsibility for writing the code, posting as patches so that we can
- review it as time permits, integrating it at an appropriate time,
- responding to our requests for tweaking it (name changes, ...),
- document it in the code, document it in the manual (even though
- their mother tongue is not English), test it, develop and commit
- regression scripts, and answer in a timely fashion all bug reports --
- even occasionally accepting additional bugs :-)
-
- This is a sustainable way of going forward with Bacula, and the
- direction that the project will be taking more and more. For
- example, in the past, we have had some very dedicated programmers
- who did major projects. However, some of these
- programmers due to outside obligations (job responsibilities change of
- job, school duties, ...) could not continue to maintain the code. In
- those cases, the code suffers from lack of maintenance, sometimes we
- patch it, sometimes not. In the end, if the code is not maintained, the
- code gets dropped from the project (there are two such contributions
- that are heading in that direction). When ever possible, we would like
- to avoid this, and ensure a continuation of the code and a sharing of
- the development, debugging, documentation, and maintenance
- responsibilities.
-\end{itemize}
-
-\section{Patches for Released Versions}
-\index{Patches for Released Versions}
-\addcontentsline{toc}{subsection}{Patches for Released Versions}
-If you fix a bug in a released version, you should, unless it is
-an absolutely trivial bug, create and release a patch file for the
-bug. The procedure is as follows:
-
-Fix the bug in the released branch and in the develpment master branch.
-
-Make a patch file for the branch and add the branch patch to
-the patches directory in both the branch and the trunk.
-The name should be 2.2.4-xxx.patch where xxx is unique, in this case it can
-be "restore", e.g. 2.2.4-restore.patch. Add to the top of the
-file a brief description and instructions for applying it -- see for example
-2.2.4-poll-mount.patch. The best way to create the patch file is as
-follows:
-
-\begin{verbatim}
- (edit) 2.2.4-restore.patch
- (input description)
- (end edit)
-
- git format-patch -M
- mv 0001-xxx 2.2.4-restore.patch
-\end{verbatim}
-
-check to make sure no extra junk got put into the patch file (i.e.
-it should have the patch for that bug only).
-
-If there is not a bug report on the problem, create one, then add the
-patch to the bug report.
-
-Then upload it to the 2.2.x release of bacula-patches.
-
-So, end the end, the patch file is:
-\begin{itemize}
-\item Attached to the bug report
-
-\item In Branch-2.2/bacula/patches/...
-
-\item In the trunk
-
-\item Loaded on Source Forge bacula-patches 2.2.x release. When
- you add it, click on the check box to send an Email so that all the
- users that are monitoring SF patches get notified.
-\end{itemize}
-
-
-\section{Bacula Git repositories}
-\index{Git}
-\addcontentsline{toc}{subsection}{Git repositories}
-As of September 2009, the Bacula source code has been split into
-three Git repositories. One is a repository that holds the
-main Bacula source code with directories {\bf bacula}, {\bf gui},
-and {\bf regress}. The second repository contains
-the directories {\bf docs} directory, and the third repository
-contains the {\bf rescue} directory. All three repositories are
-hosted on Source Forge.
-
-Previously everything was in a single SVN repository.
-We have split the SVN repository into three because Git
-offers significant advantages for ease of managing and integrating
-developer's changes. However, one of the disadvantages of Git is that you
-must work with the full repository, while SVN allows you to checkout
-individual directories. If we put everything into a single Git
-repository it would be far bigger than most developers would want
-to checkout, so we have separted the docs and rescue into their own
-repositories, and moved only the parts that are most actively
-worked on by the developers (bacula, gui, and regress) to a the
-Git Bacula repository.
-
-Bacula developers must now have a certain knowledege
-of Git.
-
-\section{Git Usage}
-\index{Git Usage}
-\addcontentsline{toc}{subsection}{Git Usage}
-
-Please note that if you are familiar with SVN, Git is similar,
-(and better), but there can be a few surprising differences that
-can lead to damaging the history of the repository (repo) if
-you attempt to force pushing data into the Git repo.
-
-The Bacula Git repo contains the subdirectories {\bf bacula}, {\bf gui},
-and {\bf regress}. With Git it is not possible to pull only a
-single directory, because of the hash code nature of Git, you
-must take all or nothing.
-
-For developers, the most important thing to remember about Git and
-the Source Forge repository is not to "force" a {\bf push} to the
-repository, and not to use the {\bf rebase} command on the {\bf
-master} branch of the repository. Doing so, will possibly rewrite
-the Git repository history and cause a lot of problems for the
-project.
-
-You may and should use {\bf rebase} on your own branches that you
-want to synchronize with the {\bf master} branch, but please
-do not use {\bf rebase} on the {\bf master} branch. The proper
-way of merging changes will be discussed below.
-
-You can get a full copy of the Source Forge Bacula Git repository with the
-following command:
-
-\begin{verbatim}
-git clone git://bacula.git.sourceforge.net/gitroot/bacula/bacula trunk
-\end{verbatim}
-
-This will put a read-only copy into the directory {\bf trunk}
-in your current directory, and {\bf trunk} will contain
-the subdirectories: {\bf bacula}, {\bf gui}, and {\bf regress}.
-
-If you have write permission, you can get a copy of the Git
-repo with:
-
-\begin{verbatim}
-git clone ssh://<userid>@bacula.git.sourceforge.net/gitroot/bacula/bacula trunk
-\end{verbatim}
-
-where you replace \verb+<userid>+ with your Source Forge login
-userid, and you must have previously uploaded your public ssh key
-to Source Forge.
-
-The above command needs to be done only once. Thereafter, you can:
-
-\begin{verbatim}
-cd trunk
-git pull
-\end{verbatim}
-
-As of August 2009, the size of the repository ({\bf trunk} in the above
-example) will be approximately 55 Megabytes. However, if you build
-from source in this directory and do a lot of updates and regression
-testing, the directory could become several hundred megabytes.
-
-\subsection{Learning Git}
-\index{Learning Git}
-If you want to learn more about Git, we recommend that you visit:\\
-\elink{http://book.git-scm.com/}{http://book.git-scm.com/}.
-
-Some of the differences between Git and SVN are:
-\begin{itemize}
-\item Your main Git directory is a full Git repository to which you can
- and must commit.
-\item The Git database is kept in the directory {\bf .git} at the
- top level of the directory.
-\item all the important Git configuration information is kept in the
- file {\bf .git/config} in ASCII format that is easy to manually edit.
-\item When you do a {\bf commit} the changes are put in {\bf .git}
- rather than in the external repository.
-\item You can upload your changes to the external repository using
- the command {\bf git push}.
-\item You can download all the current changes in the external repository
- and merge them into your {\bf master} branch using the command
- {\bf gGit pull}.
-\item The command {\bf git add} is used to add a new file to the
- repository AND to tell Git that you want a file that has changed
- to be in the next commit. This has lots of advantages, because
- a {\bf git commit} only commits those files that have been
- explicitly added.
-\item You can add and commit all files modifed in one command
- using {\bf git commit -a}.
-\item This extra use of {\bf add} allows you to make a number
- of changes then add only a few of the files and commit them,
- then add more files and commit them until you have committed
- everything. This has the advantage of allowing you to more
- easily group small changes and commit them.
-\item If you {\bf git pull} from the main repository and make
- some changes, and before you do a {\bf git push}, someone
- else pushes changes to the Git repository, you will probably
- get an error message such as:
-
-\begin{verbatim}
- git push
- To git@github.com:bacula/bacula.git
- ! [rejected] master -> master (non-fast forward)
- error: failed to push some refs to 'git@github.com:bacula/bacula.git'
-\end{verbatim}
-
- which is Git's way of telling you that the main repository has changed
- and that if you push your changes, they will not be integrated properly.
- As we have noted, you should never ask Git to force the push.
- See below for an explanation of why.
-\item To integrate (merge) your changes properly, you should always do
- a {\bf git pull} just prior to doing a {\bf git push}.
-\item If Git is unable to merge your changes or finds a conflict it
- will tell you and you must do conflict resolution, which is much
- easier in Git than in SVN.
-\item Resolving conflicts is described below in the {\bf github} section.
-\end{itemize}
-
-If you want to understand why it is not a good idea to force a
-push to the repository, look at the following picture:
-
-\includegraphics[width=0.85\textwidth]{\idir git-edit-commit.eps}
-
-The above graphic has three lines of circles. Each circle represents
-a commit, and time runs from the left to the right. The top line
-shows the repository just before you are going to do a push. Note the
-point at which you pulled is the circle on the left, your changes are
-represented by the circle labeled {\bf Your mods}. It is shown below
-to indicate that the changes are only in your local repository. Finally,
-there are pushes A and B that came after the time at which you pulled.
-
-If you were to force your changes into the repository, Git would place them
-immediately after the point at which you pulled them, so they would
-go before the pushes A and B. However, doing so would rewrite the history
-of the repository and make it very difficult for other users to synchronize
-since they would have to somehow wedge their changes at some point before the
-current HEAD of the repository. This situation is shown by the second line of
-pushes.
-
-What you really want to do is to put your changes after Push B (the current HEAD).
-This is shown in the third line of pushes. The best way to accomplish this is to
-work in a branch, pull the repository so you have your master equal to HEAD (in first
-line), then to rebase your branch on the current master and then commit it. The
-exact commands to accomplish this are shown in the next couple of sections.
-
-\subsection{Publishing your changes}
-\index{Publishing}
-Since Git is more complex than SVN, it takes a bit of time to learn how
-to use it properly, and if you are not careful, you can potentially create
-a new history in the repository. In addition, since Git is a distributed
-version control system, we prefer to receive a full branch submission rather
-than simply a patch. To accomplish this, you must create your changes in
-a branch, then {\bf push} them to some public repository -- it can be your
-own repository that you publish or another. To simplify this phase for you, we
-have created a publich Bacula Git repository on {\bf github} where you can
-push your branch containing changes you would like integrated into the Bacula
-source code.
-
-Once you have pushed your branch to {\bf github} or told us where we can pull
-from your public repository, one of the senior Bacula devlopers will fetch your
-changes, examine them, possibly make comments for changes they would like to
-see, and as the final step, the senior developer will commit it to the
-Bacula Source Forge Git repository.
-
-\subsection{github}
-\index{github}
-If you are going to submit code, you create a login on
-the Github website:\\
-\elink{http://github.com/}{http://github.com/}\\
-before you clone the repository.
-You must also upload your public ssh key. Please see the instructions for
-doing so at the above link. Then you notify one of the senior Bacula developers,
-who will authorize your Github user name as a committer to the Bacula repository. Finally,
-you clone the Bacula repository with:
-
-\begin{verbatim}
- git clone git@github.com:bacula/bacula.git <xxx>
-\end{verbatim}
-
-where you replace \verb+<xxx>+ with the name
-of a directory that you want Git to create to hold your local Bacula Git
-repository.
-
-Normally, you will work by creating a branch of the master branch of your
-repository, make your modifications, then make sure it is up to date, and finally
-push it to Github. Assuming you call the Bacula repository {\bf bacula}, you might
-use the following commands:
-
-\begin{verbatim}
-cd bacula
-git checkout master
-git pull
-git branch <your-name>/newbranch
-git checkout <your-name>/newbranch
-(edit, ...)
-git add <file-edited>
-git commit -m "<comment about commit>"
-...
-\end{verbatim}
-
-Note, we request you to create the branch name ({\bf \verb+<your-name>+/newbranch} with your Github
-login name. This guarantees that the branch name will be unique and
-easily identified as well.
-
-When you have completed working on your branch, you will do:
-
-\begin{verbatim}
-cd bacula
-git checkout <your-name>/newbranch
-git pull
-git rebase master
-\end{verbatim}
-
-If you have completed your edits before anyone has modified the repository,
-the {\bf git rebase master} will report that there was nothing to do. Otherwise,
-it will merge the changes that were made in the repository before your changes.
-If there are any conflicts, Git will tell you. Typically resolving conflicts with
-Git is relatively easy. You simply make a diff:
-
-\begin{verbatim}
-git diff
-\end{verbatim}
-
-Then edit each file that was listed in the {\bf git diff} to remove the
-conflict, which will be indicated by lines of:
-
-\begin{verbatim}
-<<<<<<< HEAD
-text
->>>>>>>>
-other text
-=====
-\end{verbatim}
-
-where {\bf text} is what is in the Bacula repository, and {\bf other text}
-is what you have changed.
-
-Once you have eliminated the conflict, the {\bf git diff} will show nothing,
-and you must do a:
-
-\begin{verbatim}
-git add <file-with-conflicts-fixed>
-\end{verbatim}
-
-Once you have fixed all the files with conflicts in the above manner, you enter:
-
-\begin{verbatim}
-git rebase --continue
-\end{verbatim}
-
-and your rebase will be complete.
-
-If for some reason, before doing the --continue, you want to abort the rebase and return to what you had, you enter:
-
-\begin{verbatim}
-git rebase --abort
-\end{verbatim}
-
-Finally to upload your branch, you do:
-
-\begin{verbatim}
-git push origin <your-name>/newbranch
-\end{verbatim}
-
-If you wish to delete it later, you can use:
-
-\begin{verbatim}
-git push origin :<your-name>/newbranch
-\end{verbatim}
-
-
-\section{Developing Bacula}
-\index{Developing Bacula}
-\index{Bacula!Developing}
-\addcontentsline{toc}{subsubsection}{Developing Bacula}
-
-Typically the simplest way to develop Bacula is to open one xterm window
-pointing to the source directory you wish to update; a second xterm window at
-the top source directory level, and a third xterm window at the bacula
-directory \lt{}top\gt{}/src/bacula. After making source changes in one of the
-directories, in the top source directory xterm, build the source, and start
-the daemons by entering:
-
-make and
-
-./startit then in the enter:
-
-./console or
-
-./gnome-console to start the Console program. Enter any commands for testing.
-For example: run kernsverify full.
-
-Note, the instructions here to use {\bf ./startit} are different from using a
-production system where the administrator starts Bacula by entering {\bf
-./bacula start}. This difference allows a development version of {\bf Bacula}
-to be run on a computer at the same time that a production system is running.
-The {\bf ./startit} strip starts {\bf Bacula} using a different set of
-configuration files, and thus permits avoiding conflicts with any production
-system.
-
-To make additional source changes, exit from the Console program, and in the
-top source directory, stop the daemons by entering:
-
-./stopit then repeat the process.
-
-\subsection{Debugging}
-\index{Debugging}
-\addcontentsline{toc}{subsubsection}{Debugging}
-
-Probably the first thing to do is to turn on debug output.
-
-A good place to start is with a debug level of 20 as in {\bf ./startit -d20}.
-The startit command starts all the daemons with the same debug level.
-Alternatively, you can start the appropriate daemon with the debug level you
-want. If you really need more info, a debug level of 60 is not bad, and for
-just about everything a level of 200.
-
-\subsection{Using a Debugger}
-\index{Using a Debugger}
-\index{Debugger!Using a}
-\addcontentsline{toc}{subsubsection}{Using a Debugger}
-
-If you have a serious problem such as a segmentation fault, it can usually be
-found quickly using a good multiple thread debugger such as {\bf gdb}. For
-example, suppose you get a segmentation violation in {\bf bacula-dir}. You
-might use the following to find the problem:
-
-\lt{}start the Storage and File daemons\gt{}
-cd dird
-gdb ./bacula-dir
-run -f -s -c ./dird.conf
-\lt{}it dies with a segmentation fault\gt{}
-where
-The {\bf -f} option is specified on the {\bf run} command to inhibit {\bf
-dird} from going into the background. You may also want to add the {\bf -s}
-option to the run command to disable signals which can potentially interfere
-with the debugging.
-
-As an alternative to using the debugger, each {\bf Bacula} daemon has a built
-in back trace feature when a serious error is encountered. It calls the
-debugger on itself, produces a back trace, and emails the report to the
-developer. For more details on this, please see the chapter in the main Bacula
-manual entitled ``What To Do When Bacula Crashes (Kaboom)''.
-
-\subsection{Memory Leaks}
-\index{Leaks!Memory}
-\index{Memory Leaks}
-\addcontentsline{toc}{subsubsection}{Memory Leaks}
-
-Because Bacula runs routinely and unattended on client and server machines, it
-may run for a long time. As a consequence, from the very beginning, Bacula
-uses SmartAlloc to ensure that there are no memory leaks. To make detection of
-memory leaks effective, all Bacula code that dynamically allocates memory MUST
-have a way to release it. In general when the memory is no longer needed, it
-should be immediately released, but in some cases, the memory will be held
-during the entire time that Bacula is executing. In that case, there MUST be a
-routine that can be called at termination time that releases the memory. In
-this way, we will be able to detect memory leaks. Be sure to immediately
-correct any and all memory leaks that are printed at the termination of the
-daemons.
-
-\subsection{Special Files}
-\index{Files!Special}
-\index{Special Files}
-\addcontentsline{toc}{subsubsection}{Special Files}
-
-Kern uses files named 1, 2, ... 9 with any extension as scratch files. Thus
-any files with these names are subject to being rudely deleted at any time.
-
-\subsection{When Implementing Incomplete Code}
-\index{Code!When Implementing Incomplete}
-\index{When Implementing Incomplete Code}
-\addcontentsline{toc}{subsubsection}{When Implementing Incomplete Code}
-
-Please identify all incomplete code with a comment that contains
-
-\begin{verbatim}
-***FIXME***
-\end{verbatim}
-
-where there are three asterisks (*) before and after the word
-FIXME (in capitals) and no intervening spaces. This is important as it allows
-new programmers to easily recognize where things are partially implemented.
-
-\subsection{Bacula Source File Structure}
-\index{Structure!Bacula Source File}
-\index{Bacula Source File Structure}
-\addcontentsline{toc}{subsubsection}{Bacula Source File Structure}
-
-The distribution generally comes as a tar file of the form {\bf
-bacula.x.y.z.tar.gz} where x, y, and z are the version, release, and update
-numbers respectively.
-
-Once you detar this file, you will have a directory structure as follows:
-
-\footnotesize
-\begin{verbatim}
-|
-Tar file:
-|- depkgs
- |- mtx (autochanger control program + tape drive info)
- |- sqlite (SQLite database program)
-
-Tar file:
-|- depkgs-win32
- |- pthreads (Native win32 pthreads library -- dll)
- |- zlib (Native win32 zlib library)
- |- wx (wxWidgets source code)
-
-Project bacula:
-|- bacula (main source directory containing configuration
- | and installation files)
- |- autoconf (automatic configuration files, not normally used
- | by users)
- |- intl (programs used to translate)
- |- platforms (OS specific installation files)
- |- redhat (Red Hat installation)
- |- solaris (Sun installation)
- |- freebsd (FreeBSD installation)
- |- irix (Irix installation -- not tested)
- |- unknown (Default if system not identified)
- |- po (translations of source strings)
- |- src (source directory; contains global header files)
- |- cats (SQL catalog database interface directory)
- |- console (bacula user agent directory)
- |- dird (Director daemon)
- |- filed (Unix File daemon)
- |- win32 (Win32 files to make bacula-fd be a service)
- |- findlib (Unix file find library for File daemon)
- |- gnome-console (GNOME version of console program)
- |- lib (General Bacula library)
- |- stored (Storage daemon)
- |- tconsole (Tcl/tk console program -- not yet working)
- |- testprogs (test programs -- normally only in Kern's tree)
- |- tools (Various tool programs)
- |- win32 (Native Win32 File daemon)
- |- baculafd (Visual Studio project file)
- |- compat (compatibility interface library)
- |- filed (links to src/filed)
- |- findlib (links to src/findlib)
- |- lib (links to src/lib)
- |- console (beginning of native console program)
- |- wx-console (wxWidget console Win32 specific parts)
- |- wx-console (wxWidgets console main source program)
-
-Project regress:
-|- regress (Regression scripts)
- |- bin (temporary directory to hold Bacula installed binaries)
- |- build (temporary directory to hold Bacula source)
- |- scripts (scripts and .conf files)
- |- tests (test scripts)
- |- tmp (temporary directory for temp files)
- |- working (temporary working directory for Bacula daemons)
-
-Project docs:
-|- docs (documentation directory)
- |- developers (Developer's guide)
- |- home-page (Bacula's home page source)
- |- manual (html document directory)
- |- manual-fr (French translation)
- |- manual-de (German translation)
- |- techlogs (Technical development notes);
-
-Project rescue:
-|- rescue (Bacula rescue CDROM)
- |- linux (Linux rescue CDROM)
- |- cdrom (Linux rescue CDROM code)
- ...
- |- solaris (Solaris rescue -- incomplete)
- |- freebsd (FreeBSD rescue -- incomplete)
-
-Project gui:
-|- gui (Bacula GUI projects)
- |- bacula-web (Bacula web php management code)
- |- bimagemgr (Web application for burning CDROMs)
-
-
-\end{verbatim}
-\normalsize
-
-\subsection{Header Files}
-\index{Header Files}
-\index{Files!Header}
-\addcontentsline{toc}{subsubsection}{Header Files}
-
-Please carefully follow the scheme defined below as it permits in general only
-two header file includes per C file, and thus vastly simplifies programming.
-With a large complex project like Bacula, it isn't always easy to ensure that
-the right headers are invoked in the right order (there are a few kludges to
-make this happen -- i.e. in a few include files because of the chicken and egg
-problem, certain references to typedefs had to be replaced with {\bf void} ).
-
-Every file should include {\bf bacula.h}. It pulls in just about everything,
-with very few exceptions. If you have system dependent ifdefing, please do it
-in {\bf baconfig.h}. The version number and date are kept in {\bf version.h}.
-
-Each of the subdirectories (console, cats, dird, filed, findlib, lib, stored,
-...) contains a single directory dependent include file generally the name of
-the directory, which should be included just after the include of {\bf
-bacula.h}. This file (for example, for the dird directory, it is {\bf dird.h})
-contains either definitions of things generally needed in this directory, or
-it includes the appropriate header files. It always includes {\bf protos.h}.
-See below.
-
-Each subdirectory contains a header file named {\bf protos.h}, which contains
-the prototypes for subroutines exported by files in that directory. {\bf
-protos.h} is always included by the main directory dependent include file.
-
-\subsection{Programming Standards}
-\index{Standards!Programming}
-\index{Programming Standards}
-\addcontentsline{toc}{subsubsection}{Programming Standards}
-
-For the most part, all code should be written in C unless there is a burning
-reason to use C++, and then only the simplest C++ constructs will be used.
-Note, Bacula is slowly evolving to use more and more C++.
-
-Code should have some documentation -- not a lot, but enough so that I can
-understand it. Look at the current code, and you will see that I document more
-than most, but am definitely not a fanatic.
-
-We prefer simple linear code where possible. Gotos are strongly discouraged
-except for handling an error to either bail out or to retry some code, and
-such use of gotos can vastly simplify the program.
-
-Remember this is a C program that is migrating to a {\bf tiny} subset of C++,
-so be conservative in your use of C++ features.
-
-\subsection{Do Not Use}
-\index{Use!Do Not}
-\index{Do Not Use}
-\addcontentsline{toc}{subsubsection}{Do Not Use}
-
-\begin{itemize}
- \item STL -- it is totally incomprehensible.
-\end{itemize}
-
-\subsection{Avoid if Possible}
-\index{Possible!Avoid if}
-\index{Avoid if Possible}
-\addcontentsline{toc}{subsubsection}{Avoid if Possible}
-
-\begin{itemize}
-\item Using {\bf void *} because this generally means that one must
- using casting, and in C++ casting is rather ugly. It is OK to use
- void * to pass structure address where the structure is not known
- to the routines accepting the packet (typically callback routines).
- However, declaring "void *buf" is a bad idea. Please use the
- correct types whenever possible.
-
-\item Using undefined storage specifications such as (short, int, long,
- long long, size\_t ...). The problem with all these is that the number of bytes
- they allocate depends on the compiler and the system. Instead use
- Bacula's types (int8\_t, uint8\_t, int32\_t, uint32\_t, int64\_t, and
- uint64\_t). This guarantees that the variables are given exactly the
- size you want. Please try at all possible to avoid using size\_t ssize\_t
- and the such. They are very system dependent. However, some system
- routines may need them, so their use is often unavoidable.
-
-\item Returning a malloc'ed buffer from a subroutine -- someone will forget
- to release it.
-
-\item Heap allocation (malloc) unless needed -- it is expensive. Use
- POOL\_MEM instead.
-
-\item Templates -- they can create portability problems.
-
-\item Fancy or tricky C or C++ code, unless you give a good explanation of
- why you used it.
-
-\item Too much inheritance -- it can complicate the code, and make reading it
- difficult (unless you are in love with colons)
-
-\end{itemize}
-
-\subsection{Do Use Whenever Possible}
-\index{Possible!Do Use Whenever}
-\index{Do Use Whenever Possible}
-\addcontentsline{toc}{subsubsection}{Do Use Whenever Possible}
-
-\begin{itemize}
-\item Locking and unlocking within a single subroutine.
-
-\item A single point of exit from all subroutines. A goto is
- perfectly OK to use to get out early, but only to a label
- named bail\_out, and possibly an ok\_out. See current code
- examples.
-
-\item Malloc and free within a single subroutine.
-
-\item Comments and global explanations on what your code or algorithm does.
-
-\end{itemize}
-
-\subsection{Indenting Standards}
-\index{Standards!Indenting}
-\index{Indenting Standards}
-\addcontentsline{toc}{subsubsection}{Indenting Standards}
-
-We find it very hard to read code indented 8 columns at a time.
-Even 4 at a time uses a lot of space, so we have adopted indenting
-3 spaces at every level. Note, indention is the visual appearance of the
-source on the page, while tabbing is replacing a series of up to 8 spaces from
-a tab character.
-
-The closest set of parameters for the Linux {\bf indent} program that will
-produce reasonably indented code are:
-
-\footnotesize
-\begin{verbatim}
--nbad -bap -bbo -nbc -br -brs -c36 -cd36 -ncdb -ce -ci3 -cli0
--cp36 -d0 -di1 -ndj -nfc1 -nfca -hnl -i3 -ip0 -l85 -lp -npcs
--nprs -npsl -saf -sai -saw -nsob -nss -nbc -ncs -nbfda
-\end{verbatim}
-\normalsize
-
-You can put the above in your .indent.pro file, and then just invoke indent on
-your file. However, be warned. This does not produce perfect indenting, and it
-will mess up C++ class statements pretty badly.
-
-Braces are required in all if statements (missing in some very old code). To
-avoid generating too many lines, the first brace appears on the first line
-(e.g. of an if), and the closing brace is on a line by itself. E.g.
-
-\footnotesize
-\begin{verbatim}
- if (abc) {
- some_code;
- }
-\end{verbatim}
-\normalsize
-
-Just follow the convention in the code. For example we I prefer non-indented cases.
-
-\footnotesize
-\begin{verbatim}
- switch (code) {
- case 'A':
- do something
- break;
- case 'B':
- again();
- break;
- default:
- break;
- }
-\end{verbatim}
-\normalsize
-
-Avoid using // style comments except for temporary code or turning off debug
-code. Standard C comments are preferred (this also keeps the code closer to
-C).
-
-Attempt to keep all lines less than 85 characters long so that the whole line
-of code is readable at one time. This is not a rigid requirement.
-
-Always put a brief description at the top of any new file created describing
-what it does and including your name and the date it was first written. Please
-don't forget any Copyrights and acknowledgments if it isn't 100\% your code.
-Also, include the Bacula copyright notice that is in {\bf src/c}.
-
-In general you should have two includes at the top of the an include for the
-particular directory the code is in, for includes are needed, but this should
-be rare.
-
-In general (except for self-contained packages), prototypes should all be put
-in {\bf protos.h} in each directory.
-
-Always put space around assignment and comparison operators.
-
-\footnotesize
-\begin{verbatim}
- a = 1;
- if (b >= 2) {
- cleanup();
- }
-\end{verbatim}
-\normalsize
-
-but your can compress things in a {\bf for} statement:
-
-\footnotesize
-\begin{verbatim}
- for (i=0; i < del.num_ids; i++) {
- ...
-\end{verbatim}
-\normalsize
-
-Don't overuse the inline if (?:). A full {\bf if} is preferred, except in a
-print statement, e.g.:
-
-\footnotesize
-\begin{verbatim}
- if (ua->verbose \&& del.num_del != 0) {
- bsendmsg(ua, _("Pruned %d %s on Volume %s from catalog.\n"), del.num_del,
- del.num_del == 1 ? "Job" : "Jobs", mr->VolumeName);
- }
-\end{verbatim}
-\normalsize
-
-Leave a certain amount of debug code (Dmsg) in code you submit, so that future
-problems can be identified. This is particularly true for complicated code
-likely to break. However, try to keep the debug code to a minimum to avoid
-bloating the program and above all to keep the code readable.
-
-Please keep the same style in all new code you develop. If you include code
-previously written, you have the option of leaving it with the old indenting
-or re-indenting it. If the old code is indented with 8 spaces, then please
-re-indent it to Bacula standards.
-
-If you are using {\bf vim}, simply set your tabstop to 8 and your shiftwidth
-to 3.
-
-\subsection{Tabbing}
-\index{Tabbing}
-\addcontentsline{toc}{subsubsection}{Tabbing}
-
-Tabbing (inserting the tab character in place of spaces) is as normal on all
-Unix systems -- a tab is converted space up to the next column multiple of 8.
-My editor converts strings of spaces to tabs automatically -- this results in
-significant compression of the files. Thus, you can remove tabs by replacing
-them with spaces if you wish. Please don't confuse tabbing (use of tab
-characters) with indenting (visual alignment of the code).
-
-\subsection{Don'ts}
-\index{Don'ts}
-\addcontentsline{toc}{subsubsection}{Don'ts}
-
-Please don't use:
-
-\footnotesize
-\begin{verbatim}
-strcpy()
-strcat()
-strncpy()
-strncat();
-sprintf()
-snprintf()
-\end{verbatim}
-\normalsize
-
-They are system dependent and un-safe. These should be replaced by the Bacula
-safe equivalents:
-
-\footnotesize
-\begin{verbatim}
-char *bstrncpy(char *dest, char *source, int dest_size);
-char *bstrncat(char *dest, char *source, int dest_size);
-int bsnprintf(char *buf, int32_t buf_len, const char *fmt, ...);
-int bvsnprintf(char *str, int32_t size, const char *format, va_list ap);
-\end{verbatim}
-\normalsize
-
-See src/lib/bsys.c for more details on these routines.
-
-Don't use the {\bf \%lld} or the {\bf \%q} printf format editing types to edit
-64 bit integers -- they are not portable. Instead, use {\bf \%s} with {\bf
-edit\_uint64()}. For example:
-
-\footnotesize
-\begin{verbatim}
- char buf[100];
- uint64_t num = something;
- char ed1[50];
- bsnprintf(buf, sizeof(buf), "Num=%s\n", edit_uint64(num, ed1));
-\end{verbatim}
-\normalsize
-
-Note: {\bf \%lld} is now permitted in Bacula code -- we have our
-own printf routines which handle it correctly. The edit\_uint64() subroutine
-can still be used if you wish, but over time, most of that old style will
-be removed.
-
-The edit buffer {\bf ed1} must be at least 27 bytes long to avoid overflow.
-See src/lib/edit.c for more details. If you look at the code, don't start
-screaming that I use {\bf lld}. I actually use subtle trick taught to me by
-John Walker. The {\bf lld} that appears in the editing routine is actually
-{\bf \#define} to a what is needed on your OS (usually ``lld'' or ``q'') and
-is defined in autoconf/configure.in for each OS. C string concatenation causes
-the appropriate string to be concatenated to the ``\%''.
-
-Also please don't use the STL or Templates or any complicated C++ code.
-
-\subsection{Message Classes}
-\index{Classes!Message}
-\index{Message Classes}
-\addcontentsline{toc}{subsubsection}{Message Classes}
-
-Currently, there are five classes of messages: Debug, Error, Job, Memory,
-and Queued.
-
-\subsection{Debug Messages}
-\index{Messages!Debug}
-\index{Debug Messages}
-\addcontentsline{toc}{subsubsection}{Debug Messages}
-
-Debug messages are designed to be turned on at a specified debug level and are
-always sent to STDOUT. There are designed to only be used in the development
-debug process. They are coded as:
-
-DmsgN(level, message, arg1, ...) where the N is a number indicating how many
-arguments are to be substituted into the message (i.e. it is a count of the
-number arguments you have in your message -- generally the number of percent
-signs (\%)). {\bf level} is the debug level at which you wish the message to
-be printed. message is the debug message to be printed, and arg1, ... are the
-arguments to be substituted. Since not all compilers support \#defines with
-varargs, you must explicitly specify how many arguments you have.
-
-When the debug message is printed, it will automatically be prefixed by the
-name of the daemon which is running, the filename where the Dmsg is, and the
-line number within the file.
-
-Some actual examples are:
-
-Dmsg2(20, ``MD5len=\%d MD5=\%s\textbackslash{}n'', strlen(buf), buf);
-
-Dmsg1(9, ``Created client \%s record\textbackslash{}n'', client->hdr.name);
-
-\subsection{Error Messages}
-\index{Messages!Error}
-\index{Error Messages}
-\addcontentsline{toc}{subsubsection}{Error Messages}
-
-Error messages are messages that are related to the daemon as a whole rather
-than a particular job. For example, an out of memory condition my generate an
-error message. They should be very rarely needed. In general, you should be
-using Job and Job Queued messages (Jmsg and Qmsg). They are coded as:
-
-EmsgN(error-code, level, message, arg1, ...) As with debug messages, you must
-explicitly code the of arguments to be substituted in the message. error-code
-indicates the severity or class of error, and it may be one of the following:
-
-\addcontentsline{lot}{table}{Message Error Code Classes}
-\begin{longtable}{lp{3in}}
-{{\bf M\_ABORT} } & {Causes the daemon to immediately abort. This should be
-used only in extreme cases. It attempts to produce a traceback. } \\
-{{\bf M\_ERROR\_TERM} } & {Causes the daemon to immediately terminate. This
-should be used only in extreme cases. It does not produce a traceback. } \\
-{{\bf M\_FATAL} } & {Causes the daemon to terminate the current job, but the
-daemon keeps running } \\
-{{\bf M\_ERROR} } & {Reports the error. The daemon and the job continue
-running } \\
-{{\bf M\_WARNING} } & {Reports an warning message. The daemon and the job
-continue running } \\
-{{\bf M\_INFO} } & {Reports an informational message.}
-
-\end{longtable}
-
-There are other error message classes, but they are in a state of being
-redesigned or deprecated, so please do not use them. Some actual examples are:
-
-
-Emsg1(M\_ABORT, 0, ``Cannot create message thread: \%s\textbackslash{}n'',
-strerror(status));
-
-Emsg3(M\_WARNING, 0, ``Connect to File daemon \%s at \%s:\%d failed. Retrying
-...\textbackslash{}n'', client-\gt{}hdr.name, client-\gt{}address,
-client-\gt{}port);
-
-Emsg3(M\_FATAL, 0, ``bdird\lt{}filed: bad response from Filed to \%s command:
-\%d \%s\textbackslash{}n'', cmd, n, strerror(errno));
-
-\subsection{Job Messages}
-\index{Job Messages}
-\index{Messages!Job}
-\addcontentsline{toc}{subsubsection}{Job Messages}
-
-Job messages are messages that pertain to a particular job such as a file that
-could not be saved, or the number of files and bytes that were saved. They
-Are coded as:
-\begin{verbatim}
-Jmsg(jcr, M\_FATAL, 0, "Text of message");
-\end{verbatim}
-A Jmsg with M\_FATAL will fail the job. The Jmsg() takes varargs so can
-have any number of arguments for substituted in a printf like format.
-Output from the Jmsg() will go to the Job report.
-<br>
-If the Jmsg is followed with a number such as Jmsg1(...), the number
-indicates the number of arguments to be substituted (varargs is not
-standard for \#defines), and what is more important is that the file and
-line number will be prefixed to the message. This permits a sort of debug
-from user's output.
-
-\subsection{Queued Job Messages}
-\index{Queued Job Messages}
-\index{Messages!Job}
-\addcontentsline{toc}{subsubsection}{Queued Job Messages}
-Queued Job messages are similar to Jmsg()s except that the message is
-Queued rather than immediately dispatched. This is necessary within the
-network subroutines and in the message editing routines. This is to prevent
-recursive loops, and to ensure that messages can be delivered even in the
-event of a network error.
-
-
-\subsection{Memory Messages}
-\index{Messages!Memory}
-\index{Memory Messages}
-\addcontentsline{toc}{subsubsection}{Memory Messages}
-
-Memory messages are messages that are edited into a memory buffer. Generally
-they are used in low level routines such as the low level device file dev.c in
-the Storage daemon or in the low level Catalog routines. These routines do not
-generally have access to the Job Control Record and so they return error
-essages reformatted in a memory buffer. Mmsg() is the way to do this.
-
-\subsection{Bugs Database}
-\index{Database!Bugs}
-\index{Bugs Database}
-\addcontentsline{toc}{subsubsection}{Bugs Database}
-We have a bugs database which is at:
-\elink{http://bugs.bacula.org}{http://bugs.bacula.org}, and as
-a developer you will need to respond to bugs, perhaps bugs in general
-if you have time, otherwise just bugs that correspond to code that
-you wrote.
-
-If you need to answer bugs, please be sure to ask the Project Manager
-(currently Kern) to give you Developer access to the bugs database. This
-allows you to modify statuses and close bugs.
-
-The first thing is if you want to take over a bug, rather than just make a
-note, you should assign the bug to yourself. This helps other developers
-know that you are the principal person to deal with the bug. You can do so
-by going into the bug and clicking on the {\bf Update Issue} button. Then
-you simply go to the {\bf Assigned To} box and select your name from the
-drop down box. To actually update it you must click on the {\bf Update
-Information} button a bit further down on the screen, but if you have other
-things to do such as add a Note, you might wait before clicking on the {\bf
-Update Information} button.
-
-Generally, we set the {\bf Status} field to either acknowledged, confirmed,
-or feedback when we first start working on the bug. Feedback is set when
-we expect that the user should give us more information.
-
-Normally, once you are reasonably sure that the bug is fixed, and a patch
-is made and attached to the bug report, and/or in the SVN, you can close
-the bug. If you want the user to test the patch, then leave the bug open,
-otherwise close it and set {\bf Resolution} to {\bf Fixed}. We generally
-close bug reports rather quickly, even without confirmation, especially if
-we have run tests and can see that for us the problem is fixed. However,
-in doing so, it avoids misunderstandings if you leave a note while you are
-closing the bug that says something to the following effect:
-We are closing this bug because ... If for some reason, it does not fix
-your problem, please feel free to reopen it, or to open a new bug report
-describing the problem".
-
-We do not recommend that you attempt to edit any of the bug notes that have
-been submitted, nor to delete them or make them private. In fact, if
-someone accidentally makes a bug note private, you should ask the reason
-and if at all possible (with his agreement) make the bug note public.
-
-If the user has not properly filled in most of the important fields
-(platorm, OS, Product Version, ...) please do not hesitate to politely ask
-him. Also, if the bug report is a request for a new feature, please
-politely send the user to the Feature Request menu item on www.bacula.org.
-The same applies to a support request (we answer only bugs), you might give
-the user a tip, but please politely refer him to the manual and the
-Getting Support page of www.bacula.org.
+++ /dev/null
-# This module does multiple indices, supporting the style of the LaTex 'index'
-# package.
-
-# Version Information:
-# 16-Feb-2005 -- Original Creation. Karl E. Cunningham
-# 14-Mar-2005 -- Clarified and Consolodated some of the code.
-# Changed to smoothly handle single and multiple indices.
-
-# Two LaTeX index formats are supported...
-# --- SINGLE INDEX ---
-# \usepackage{makeidx}
-# \makeindex
-# \index{entry1}
-# \index{entry2}
-# \index{entry3}
-# ...
-# \printindex
-#
-# --- MULTIPLE INDICES ---
-#
-# \usepackage{makeidx}
-# \usepackage{index}
-# \makeindex -- latex2html doesn't care but LaTeX does.
-# \newindex{ref1}{ext1}{ext2}{title1}
-# \newindex{ref2}{ext1}{ext2}{title2}
-# \newindex{ref3}{ext1}{ext2}{title3}
-# \index[ref1]{entry1}
-# \index[ref1]{entry2}
-# \index[ref3]{entry3}
-# \index[ref2]{entry4}
-# \index{entry5}
-# \index[ref3]{entry6}
-# ...
-# \printindex[ref1]
-# \printindex[ref2]
-# \printindex[ref3]
-# \printindex
-# ___________________
-#
-# For the multiple-index style, each index is identified by the ref argument to \newindex, \index,
-# and \printindex. A default index is allowed, which is indicated by omitting the optional
-# argument. The default index does not require a \newindex command. As \index commands
-# are encountered, their entries are stored according
-# to the ref argument. When the \printindex command is encountered, the stored index
-# entries for that argument are retrieved and printed. The title for each index is taken
-# from the last argument in the \newindex command.
-# While processing \index and \printindex commands, if no argument is given the index entries
-# are built into a default index. The title of the default index is simply "Index".
-# This makes the difference between single- and multiple-index processing trivial.
-#
-# Another method can be used by omitting the \printindex command and just using \include to
-# pull in index files created by the makeindex program. These files will start with
-# \begin{theindex}. This command is used to determine where to print the index. Using this
-# approach, the indices will be output in the same order as the newindex commands were
-# originally found (see below). Using a combination of \printindex and \include{indexfile} has not
-# been tested and may produce undesireable results.
-#
-# The index data are stored in a hash for later sorting and output. As \printindex
-# commands are handled, the order in which they were found in the tex filea is saved,
-# associated with the ref argument to \printindex.
-#
-# We use the original %index hash to store the index data into. We append a \002 followed by the
-# name of the index to isolate the entries in different indices from each other. This is necessary
-# so that different indices can have entries with the same name. For the default index, the \002 is
-# appended without the name.
-#
-# Since the index order in the output cannot be determined if the \include{indexfile}
-# command is used, the order will be assumed from the order in which the \newindex
-# commands were originally seen in the TeX files. This order is saved as well as the
-# order determined from any printindex{ref} commands. If \printindex commnads are used
-# to specify the index output, that order will be used. If the \include{idxfile} command
-# is used, the order of the original newindex commands will be used. In this case the
-# default index will be printed last since it doesn't have a corresponding \newindex
-# command and its order cannot be determined. Mixing \printindex and \include{idxfile}
-# commands in the same file is likely to produce less than satisfactory results.
-#
-#
-# The hash containing index data is named %indices. It contains the following data:
-#{
-# 'title' => {
-# $ref1 => $indextitle ,
-# $ref2 => $indextitle ,
-# ...
-# },
-# 'newcmdorder' => [ ref1, ref2, ..., * ], # asterisk indicates the position of the default index.
-# 'printindorder' => [ ref1, ref2, ..., * ], # asterisk indicates the position of the default index.
-#}
-
-
-# Globals to handle multiple indices.
-my %indices;
-
-# This tells the system to use up to 7 words in index entries.
-$WORDS_IN_INDEX = 10;
-
-# KEC 2-18-05
-# Handles the \newindex command. This is called if the \newindex command is
-# encountered in the LaTex source. Gets the index ref and title from the arguments.
-# Saves the index ref and title.
-# Note that we are called once to handle multiple \newindex commands that are
-# newline-separated.
-sub do_cmd_newindex {
- my $data = shift;
- # The data is sent to us as fields delimited by their ID #'s. We extract the
- # fields.
- foreach my $line (split("\n",$data)) {
- my @fields = split (/(?:\<\#\d+?\#\>)+/,$line);
-
- # The index name and title are the second and fourth fields in the data.
- if ($line =~ /^</ or $line =~ /^\\newindex/) {
- my ($indexref,$indextitle) = ($fields[1],$fields[4]);
- $indices{'title'}{$indexref} = $indextitle;
- push (@{$indices{'newcmdorder'}},$indexref);
- }
- }
-}
-
-
-# KEC -- Copied from makeidx.perl and modified to do multiple indices.
-# Processes an \index entry from the LaTex file.
-# Gets the optional argument from the index command, which is the name of the index
-# into which to place the entry.
-# Drops the brackets from the index_name
-# Puts the index entry into the html stream
-# Creates the tokenized index entry (which also saves the index entry info
-sub do_real_index {
- local($_) = @_;
- local($pat,$idx_entry,$index_name);
- # catches opt-arg from \index commands for index.sty
- $index_name = &get_next_optional_argument;
- $index_name = "" unless defined $index_name;
- # Drop leading and trailing brackets from the index name.
- $index_name =~ s/^\[|\]$//g;
-
- $idx_entry = &missing_braces unless (
- (s/$next_pair_pr_rx/$pat=$1;$idx_entry=$2;''/e)
- ||(s/$next_pair_rx/$pat=$1;$idx_entry=$2;''/e));
-
- if ($index_name and defined $idx_entry and
- !defined $indices{'title'}{$index_name}) {
- print STDERR "\nInvalid Index Name: \\index \[$index_name\]\{$idx_entry\}\n";
- }
-
- $idx_entry = &named_index_entry($pat, $idx_entry,$index_name);
- $idx_entry.$_;
-}
-
-# Creates and saves an index entry in the index hashes.
-# Modified to do multiple indices.
-# Creates an index_key that allows index entries to have the same characteristics but be in
-# different indices. This index_key is the regular key with the index name appended.
-# Save the index order for the entry in the %index_order hash.
-sub named_index_entry {
- local($br_id, $str, $index_name) = @_;
- my ($index_key);
- # escape the quoting etc characters
- # ! -> \001
- # @ -> \002
- # | -> \003
- $* = 1; $str =~ s/\n\s*/ /g; $* = 0; # remove any newlines
- # protect \001 occurring with images
- $str =~ s/\001/\016/g; # 0x1 to 0xF
- $str =~ s/\\\\/\011/g; # Double backslash -> 0xB
- $str =~ s/\\;SPMquot;/\012/g; # \;SPMquot; -> 0xC
- $str =~ s/;SPMquot;!/\013/g; # ;SPMquot; -> 0xD
- $str =~ s/!/\001/g; # Exclamation point -> 0x1
- $str =~ s/\013/!/g; # 0xD -> Exclaimation point
- $str =~ s/;SPMquot;@/\015/g; # ;SPMquot;@ to 0xF
- $str =~ s/@/\002/g; # At sign -> 0x2
- $str =~ s/\015/@/g; # 0xF to At sign
- $str =~ s/;SPMquot;\|/\017/g; # ;SMPquot;| to 0x11
- $str =~ s/\|/\003/g; # Vertical line to 0x3
- $str =~ s/\017/|/g; # 0x11 to vertical line
- $str =~ s/;SPMquot;(.)/\1/g; # ;SPMquot; -> whatever the next character is
- $str =~ s/\012/;SPMquot;/g; # 0x12 to ;SPMquot;
- $str =~ s/\011/\\\\/g; # 0x11 to double backslash
- local($key_part, $pageref) = split("\003", $str, 2);
-
- # For any keys of the form: blablabla!blablabla, which want to be split at the
- # exclamation point, replace the ! with a comma and a space. We don't do it
- # that way for this index.
- $key_part =~ s/\001/, /g;
- local(@keys) = split("\001", $key_part);
- # If TITLE is not yet available use $before.
- $TITLE = $saved_title if (($saved_title)&&(!($TITLE)||($TITLE eq $default_title)));
- $TITLE = $before unless $TITLE;
- # Save the reference
- local($words) = '';
- if ($SHOW_SECTION_NUMBERS) { $words = &make_idxnum; }
- elsif ($SHORT_INDEX) { $words = &make_shortidxname; }
- else { $words = &make_idxname; }
- local($super_key) = '';
- local($sort_key, $printable_key, $cur_key);
- foreach $key (@keys) {
- $key =~ s/\016/\001/g; # revert protected \001s
- ($sort_key, $printable_key) = split("\002", $key);
- #
- # RRM: 16 May 1996
- # any \label in the printable-key will have already
- # created a label where the \index occurred.
- # This has to be removed, so that the desired label
- # will be found on the Index page instead.
- #
- if ($printable_key =~ /tex2html_anchor_mark/ ) {
- $printable_key =~ s/><tex2html_anchor_mark><\/A><A//g;
- local($tmpA,$tmpB) = split("NAME=\"", $printable_key);
- ($tmpA,$tmpB) = split("\"", $tmpB);
- $ref_files{$tmpA}='';
- $index_labels{$tmpA} = 1;
- }
- #
- # resolve and clean-up the hyperlink index-entries
- # so they can be saved in an index.pl file
- #
- if ($printable_key =~ /$cross_ref_mark/ ) {
- local($label,$id,$ref_label);
- # $printable_key =~ s/$cross_ref_mark#(\w+)#(\w+)>$cross_ref_mark/
- $printable_key =~ s/$cross_ref_mark#([^#]+)#([^>]+)>$cross_ref_mark/
- do { ($label,$id) = ($1,$2);
- $ref_label = $external_labels{$label} unless
- ($ref_label = $ref_files{$label});
- '"' . "$ref_label#$label" . '">' .
- &get_ref_mark($label,$id)}
- /geo;
- }
- $printable_key =~ s/<\#[^\#>]*\#>//go;
- #RRM
- # recognise \char combinations, for a \backslash
- #
- $printable_key =~ s/\&\#;\'134/\\/g; # restore \\s
- $printable_key =~ s/\&\#;\`<BR> /\\/g; # ditto
- $printable_key =~ s/\&\#;*SPMquot;92/\\/g; # ditto
- #
- # $sort_key .= "@$printable_key" if !($printable_key); # RRM
- $sort_key .= "@$printable_key" if !($sort_key); # RRM
- $sort_key =~ tr/A-Z/a-z/;
- if ($super_key) {
- $cur_key = $super_key . "\001" . $sort_key;
- $sub_index{$super_key} .= $cur_key . "\004";
- } else {
- $cur_key = $sort_key;
- }
-
- # Append the $index_name to the current key with a \002 delimiter. This will
- # allow the same index entry to appear in more than one index.
- $index_key = $cur_key . "\002$index_name";
-
- $index{$index_key} .= "";
-
- #
- # RRM, 15 June 1996
- # if there is no printable key, but one is known from
- # a previous index-entry, then use it.
- #
- if (!($printable_key) && ($printable_key{$index_key}))
- { $printable_key = $printable_key{$index_key}; }
-# if (!($printable_key) && ($printable_key{$cur_key}))
-# { $printable_key = $printable_key{$cur_key}; }
- #
- # do not overwrite the printable_key if it contains an anchor
- #
- if (!($printable_key{$index_key} =~ /tex2html_anchor_mark/ ))
- { $printable_key{$index_key} = $printable_key || $key; }
-# if (!($printable_key{$cur_key} =~ /tex2html_anchor_mark/ ))
-# { $printable_key{$cur_key} = $printable_key || $key; }
-
- $super_key = $cur_key;
- }
- #
- # RRM
- # page-ranges, from |( and |) and |see
- #
- if ($pageref) {
- if ($pageref eq "\(" ) {
- $pageref = '';
- $next .= " from ";
- } elsif ($pageref eq "\)" ) {
- $pageref = '';
- local($next) = $index{$index_key};
-# local($next) = $index{$cur_key};
- # $next =~ s/[\|] *$//;
- $next =~ s/(\n )?\| $//;
- $index{$index_key} = "$next to ";
-# $index{$cur_key} = "$next to ";
- }
- }
-
- if ($pageref) {
- $pageref =~ s/\s*$//g; # remove trailing spaces
- if (!$pageref) { $pageref = ' ' }
- $pageref =~ s/see/<i>see <\/i> /g;
- #
- # RRM: 27 Dec 1996
- # check if $pageref corresponds to a style command.
- # If so, apply it to the $words.
- #
- local($tmp) = "do_cmd_$pageref";
- if (defined &$tmp) {
- $words = &$tmp("<#0#>$words<#0#>");
- $words =~ s/<\#[^\#]*\#>//go;
- $pageref = '';
- }
- }
- #
- # RRM: 25 May 1996
- # any \label in the pageref section will have already
- # created a label where the \index occurred.
- # This has to be removed, so that the desired label
- # will be found on the Index page instead.
- #
- if ($pageref) {
- if ($pageref =~ /tex2html_anchor_mark/ ) {
- $pageref =~ s/><tex2html_anchor_mark><\/A><A//g;
- local($tmpA,$tmpB) = split("NAME=\"", $pageref);
- ($tmpA,$tmpB) = split("\"", $tmpB);
- $ref_files{$tmpA}='';
- $index_labels{$tmpA} = 1;
- }
- #
- # resolve and clean-up any hyperlinks in the page-ref,
- # so they can be saved in an index.pl file
- #
- if ($pageref =~ /$cross_ref_mark/ ) {
- local($label,$id,$ref_label);
- # $pageref =~ s/$cross_ref_mark#(\w+)#(\w+)>$cross_ref_mark/
- $pageref =~ s/$cross_ref_mark#([^#]+)#([^>]+)>$cross_ref_mark/
- do { ($label,$id) = ($1,$2);
- $ref_files{$label} = ''; # ???? RRM
- if ($index_labels{$label}) { $ref_label = ''; }
- else { $ref_label = $external_labels{$label}
- unless ($ref_label = $ref_files{$label});
- }
- '"' . "$ref_label#$label" . '">' . &get_ref_mark($label,$id)}/geo;
- }
- $pageref =~ s/<\#[^\#>]*\#>//go;
-
- if ($pageref eq ' ') { $index{$index_key}='@'; }
- else { $index{$index_key} .= $pageref . "\n | "; }
- } else {
- local($thisref) = &make_named_href('',"$CURRENT_FILE#$br_id",$words);
- $thisref =~ s/\n//g;
- $index{$index_key} .= $thisref."\n | ";
- }
- #print "\nREF: $sort_key : $index_key :$index{$index_key}";
-
- #join('',"<A NAME=$br_id>$anchor_invisible_mark<\/A>",$_);
-
- "<A NAME=\"$br_id\">$anchor_invisible_mark<\/A>";
-}
-
-
-# KEC. -- Copied from makeidx.perl, then modified to do multiple indices.
-# Feeds the index entries to the output. This is called for each index to be built.
-#
-# Generates a list of lookup keys for index entries, from both %printable_keys
-# and %index keys.
-# Sorts the keys according to index-sorting rules.
-# Removes keys with a 0x01 token. (duplicates?)
-# Builds a string to go to the index file.
-# Adds the index entries to the string if they belong in this index.
-# Keeps track of which index is being worked on, so only the proper entries
-# are included.
-# Places the index just built in to the output at the proper place.
-{ my $index_number = 0;
-sub add_real_idx {
- print "\nDoing the index ... Index Number $index_number\n";
- local($key, @keys, $next, $index, $old_key, $old_html);
- my ($idx_ref,$keyref);
- # RRM, 15.6.96: index constructed from %printable_key, not %index
- @keys = keys %printable_key;
-
- while (/$idx_mark/) {
- # Get the index reference from what follows the $idx_mark and
- # remove it from the string.
- s/$idxmark\002(.*?)\002/$idxmark/;
- $idx_ref = $1;
- $index = '';
- # include non- makeidx index-entries
- foreach $key (keys %index) {
- next if $printable_key{$key};
- $old_key = $key;
- if ($key =~ s/###(.*)$//) {
- next if $printable_key{$key};
- push (@keys, $key);
- $printable_key{$key} = $key;
- if ($index{$old_key} =~ /HREF="([^"]*)"/i) {
- $old_html = $1;
- $old_html =~ /$dd?([^#\Q$dd\E]*)#/;
- $old_html = $1;
- } else { $old_html = '' }
- $index{$key} = $index{$old_key} . $old_html."</A>\n | ";
- };
- }
- @keys = sort makeidx_keysort @keys;
- @keys = grep(!/\001/, @keys);
- my $cnt = 0;
- foreach $key (@keys) {
- my ($keyref) = $key =~ /.*\002(.*)/;
- next unless ($idx_ref eq $keyref); # KEC.
- $index .= &add_idx_key($key);
- $cnt++;
- }
- print "$cnt Index Entries Added\n";
- $index = '<DD>'.$index unless ($index =~ /^\s*<D(D|T)>/);
- $index_number++; # KEC.
- if ($SHORT_INDEX) {
- print "(compact version with Legend)";
- local($num) = ( $index =~ s/\<D/<D/g );
- if ($num > 50 ) {
- s/$idx_mark/$preindex<HR><DL>\n$index\n<\/DL>$preindex/o;
- } else {
- s/$idx_mark/$preindex<HR><DL>\n$index\n<\/DL>/o;
- }
- } else {
- s/$idx_mark/<DL COMPACT>\n$index\n<\/DL>/o; }
- }
-}
-}
-
-# KEC. Copied from latex2html.pl and modified to support multiple indices.
-# The bibliography and the index should be treated as separate sections
-# in their own HTML files. The \bibliography{} command acts as a sectioning command
-# that has the desired effect. But when the bibliography is constructed
-# manually using the thebibliography environment, or when using the
-# theindex environment it is not possible to use the normal sectioning
-# mechanism. This subroutine inserts a \bibliography{} or a dummy
-# \textohtmlindex command just before the appropriate environments
-# to force sectioning.
-sub add_bbl_and_idx_dummy_commands {
- local($id) = $global{'max_id'};
-
- s/([\\]begin\s*$O\d+$C\s*thebibliography)/$bbl_cnt++; $1/eg;
- ## if ($bbl_cnt == 1) {
- s/([\\]begin\s*$O\d+$C\s*thebibliography)/$id++; "\\bibliography$O$id$C$O$id$C $1"/geo;
- #}
- $global{'max_id'} = $id;
- # KEC. Modified to global substitution to place multiple index tokens.
- s/[\\]begin\s*($O\d+$C)\s*theindex/\\textohtmlindex$1/go;
- # KEC. Modified to pick up the optional argument to \printindex
- s/[\\]printindex\s*(\[.*?\])?/
- do { (defined $1) ? "\\textohtmlindex $1" : "\\textohtmlindex []"; } /ego;
- &lib_add_bbl_and_idx_dummy_commands() if defined(&lib_add_bbl_and_idx_dummy_commands);
-}
-
-# KEC. Copied from latex2html.pl and modified to support multiple indices.
-# For each textohtmlindex mark found, determine the index titles and headers.
-# We place the index ref in the header so the proper index can be generated later.
-# For the default index, the index ref is blank.
-#
-# One problem is that this routine is called twice.. Once for processing the
-# command as originally seen, and once for processing the command when
-# doing the name for the index file. We can detect that by looking at the
-# id numbers (or ref) surrounding the \theindex command, and not incrementing
-# index_number unless a new id (or ref) is seen. This has the side effect of
-# having to unconventionally start the index_number at -1. But it works.
-#
-# Gets the title from the list of indices.
-# If this is the first index, save the title in $first_idx_file. This is what's referenced
-# in the navigation buttons.
-# Increment the index_number for next time.
-# If the indexname command is defined or a newcommand defined for indexname, do it.
-# Save the index TITLE in the toc
-# Save the first_idx_file into the idxfile. This goes into the nav buttons.
-# Build index_labels if needed.
-# Create the index headings and put them in the output stream.
-
-{ my $index_number = 0; # Will be incremented before use.
- my $first_idx_file; # Static
- my $no_increment = 0;
-
-sub do_cmd_textohtmlindex {
- local($_) = @_;
- my ($idxref,$idxnum,$index_name);
-
- # We get called from make_name with the first argument = "\001noincrement". This is a sign
- # to not increment $index_number the next time we are called. We get called twice, once
- # my make_name and once by process_command. Unfortunately, make_name calls us just to set the name
- # but doesn't use the result so we get called a second time by process_command. This works fine
- # except for cases where there are multiple indices except if they aren't named, which is the case
- # when the index is inserted by an include command in latex. In these cases we are only able to use
- # the index number to decide which index to draw from, and we don't know how to increment that index
- # number if we get called a variable number of times for the same index, as is the case between
- # making html (one output file) and web (multiple output files) output formats.
- if (/\001noincrement/) {
- $no_increment = 1;
- return;
- }
-
- # Remove (but save) the index reference
- s/^\s*\[(.*?)\]/{$idxref = $1; "";}/e;
-
- # If we have an $idxref, the index name was specified. In this case, we have all the
- # information we need to carry on. Otherwise, we need to get the idxref
- # from the $index_number and set the name to "Index".
- if ($idxref) {
- $index_name = $indices{'title'}{$idxref};
- } else {
- if (defined ($idxref = $indices{'newcmdorder'}->[$index_number])) {
- $index_name = $indices{'title'}{$idxref};
- } else {
- $idxref = '';
- $index_name = "Index";
- }
- }
-
- $idx_title = "Index"; # The name displayed in the nav bar text.
-
- # Only set $idxfile if we are at the first index. This will point the
- # navigation panel to the first index file rather than the last.
- $first_idx_file = $CURRENT_FILE if ($index_number == 0);
- $idxfile = $first_idx_file; # Pointer for the Index button in the nav bar.
- $toc_sec_title = $index_name; # Index link text in the toc.
- $TITLE = $toc_sec_title; # Title for this index, from which its filename is built.
- if (%index_labels) { &make_index_labels(); }
- if (($SHORT_INDEX) && (%index_segment)) { &make_preindex(); }
- else { $preindex = ''; }
- local $idx_head = $section_headings{'textohtmlindex'};
- local($heading) = join(''
- , &make_section_heading($TITLE, $idx_head)
- , $idx_mark, "\002", $idxref, "\002" );
- local($pre,$post) = &minimize_open_tags($heading);
- $index_number++ unless ($no_increment);
- $no_increment = 0;
- join('',"<BR>\n" , $pre, $_);
-}
-}
-
-# Returns an index key, given the key passed as the first argument.
-# Not modified for multiple indices.
-sub add_idx_key {
- local($key) = @_;
- local($index, $next);
- if (($index{$key} eq '@' )&&(!($index_printed{$key}))) {
- if ($SHORT_INDEX) { $index .= "<DD><BR>\n<DT>".&print_key."\n<DD>"; }
- else { $index .= "<DT><DD><BR>\n<DT>".&print_key."\n<DD>"; }
- } elsif (($index{$key})&&(!($index_printed{$key}))) {
- if ($SHORT_INDEX) {
- $next = "<DD>".&print_key."\n : ". &print_idx_links;
- } else {
- $next = "<DT>".&print_key."\n<DD>". &print_idx_links;
- }
- $index .= $next."\n";
- $index_printed{$key} = 1;
- }
-
- if ($sub_index{$key}) {
- local($subkey, @subkeys, $subnext, $subindex);
- @subkeys = sort(split("\004", $sub_index{$key}));
- if ($SHORT_INDEX) {
- $index .= "<DD>".&print_key unless $index_printed{$key};
- $index .= "<DL>\n";
- } else {
- $index .= "<DT>".&print_key."\n<DD>" unless $index_printed{$key};
- $index .= "<DL COMPACT>\n";
- }
- foreach $subkey (@subkeys) {
- $index .= &add_sub_idx_key($subkey) unless ($index_printed{$subkey});
- }
- $index .= "</DL>\n";
- }
- return $index;
-}
-
-1; # Must be present as the last line.
+++ /dev/null
-# This file serves as a place to put initialization code and constants to
-# affect the behavior of latex2html for generating the bacula manuals.
-
-# $LINKPOINT specifies what filename to use to link to when creating
-# index.html. Not that this is a hard link.
-$LINKPOINT='"$OVERALL_TITLE"';
-
-
-# The following must be the last line of this file.
-1;
+++ /dev/null
-%%
-%%
-
-\chapter{Bacula MD5 Algorithm}
-\label{MD5Chapter}
-\addcontentsline{toc}{section}{}
-
-\section{Command Line Message Digest Utility }
-\index{Utility!Command Line Message Digest }
-\index{Command Line Message Digest Utility }
-\addcontentsline{toc}{subsection}{Command Line Message Digest Utility}
-
-
-This page describes {\bf md5}, a command line utility usable on either Unix or
-MS-DOS/Windows, which generates and verifies message digests (digital
-signatures) using the MD5 algorithm. This program can be useful when
-developing shell scripts or Perl programs for software installation, file
-comparison, and detection of file corruption and tampering.
-
-\subsection{Name}
-\index{Name}
-\addcontentsline{toc}{subsubsection}{Name}
-
-{\bf md5} - generate / check MD5 message digest
-
-\subsection{Synopsis}
-\index{Synopsis }
-\addcontentsline{toc}{subsubsection}{Synopsis}
-
-{\bf md5} [ {\bf -c}{\it signature} ] [ {\bf -u} ] [ {\bf -d}{\it input\_text}
-| {\it infile} ] [ {\it outfile} ]
-
-\subsection{Description}
-\index{Description }
-\addcontentsline{toc}{subsubsection}{Description}
-
-A {\it message digest} is a compact digital signature for an arbitrarily long
-stream of binary data. An ideal message digest algorithm would never generate
-the same signature for two different sets of input, but achieving such
-theoretical perfection would require a message digest as long as the input
-file. Practical message digest algorithms compromise in favour of a digital
-signature of modest size created with an algorithm designed to make
-preparation of input text with a given signature computationally infeasible.
-Message digest algorithms have much in common with techniques used in
-encryption, but to a different end; verification that data have not been
-altered since the signature was published.
-
-Many older programs requiring digital signatures employed 16 or 32 bit {\it
-cyclical redundancy codes} (CRC) originally developed to verify correct
-transmission in data communication protocols, but these short codes, while
-adequate to detect the kind of transmission errors for which they were
-intended, are insufficiently secure for applications such as electronic
-commerce and verification of security related software distributions.
-
-The most commonly used present-day message digest algorithm is the 128 bit MD5
-algorithm, developed by Ron Rivest of the
-\elink{MIT}{http://web.mit.edu/}
-\elink{Laboratory for Computer Science}{http://www.lcs.mit.edu/} and
-\elink{RSA Data Security, Inc.}{http://www.rsa.com/} The algorithm, with a
-reference implementation, was published as Internet
-\elink{RFC 1321}{http://www.fourmilab.ch/md5/rfc1321.html} in April 1992, and
-was placed into the public domain at that time. Message digest algorithms such
-as MD5 are not deemed ``encryption technology'' and are not subject to the
-export controls some governments impose on other data security products.
-(Obviously, the responsibility for obeying the laws in the jurisdiction in
-which you reside is entirely your own, but many common Web and Mail utilities
-use MD5, and I am unaware of any restrictions on their distribution and use.)
-
-The MD5 algorithm has been implemented in numerous computer languages
-including C,
-\elink{Perl}{http://www.perl.org/}, and
-\elink{Java}{http://www.javasoft.com/}; if you're writing a program in such a
-language, track down a suitable subroutine and incorporate it into your
-program. The program described on this page is a {\it command line}
-implementation of MD5, intended for use in shell scripts and Perl programs (it
-is much faster than computing an MD5 signature directly in Perl). This {\bf
-md5} program was originally developed as part of a suite of tools intended to
-monitor large collections of files (for example, the contents of a Web site)
-to detect corruption of files and inadvertent (or perhaps malicious) changes.
-That task is now best accomplished with more comprehensive packages such as
-\elink{Tripwire}{ftp://coast.cs.purdue.edu/pub/COAST/Tripwire/}, but the
-command line {\bf md5} component continues to prove useful for verifying
-correct delivery and installation of software packages, comparing the contents
-of two different systems, and checking for changes in specific files.
-
-\subsection{Options}
-\index{Options }
-\addcontentsline{toc}{subsubsection}{Options}
-
-\begin{description}
-
-\item [{\bf -c}{\it signature} ]
- \index{-csignature }
- Computes the signature of the specified {\it infile} or the string supplied
-by the {\bf -d} option and compares it against the specified {\it signature}.
-If the two signatures match, the exit status will be zero, otherwise the exit
-status will be 1. No signature is written to {\it outfile} or standard
-output; only the exit status is set. The signature to be checked must be
-specified as 32 hexadecimal digits.
-
-\item [{\bf -d}{\it input\_text} ]
- \index{-dinput\_text }
- A signature is computed for the given {\it input\_text} (which must be quoted
-if it contains white space characters) instead of input from {\it infile} or
-standard input. If input is specified with the {\bf -d} option, no {\it
-infile} should be specified.
-
-\item [{\bf -u} ]
- Print how-to-call information.
- \end{description}
-
-\subsection{Files}
-\index{Files }
-\addcontentsline{toc}{subsubsection}{Files}
-
-If no {\it infile} or {\bf -d} option is specified or {\it infile} is a single
-``-'', {\bf md5} reads from standard input; if no {\it outfile} is given, or
-{\it outfile} is a single ``-'', output is sent to standard output. Input and
-output are processed strictly serially; consequently {\bf md5} may be used in
-pipelines.
-
-\subsection{Bugs}
-\index{Bugs }
-\addcontentsline{toc}{subsubsection}{Bugs}
-
-The mechanism used to set standard input to binary mode may be specific to
-Microsoft C; if you rebuild the DOS/Windows version of the program from source
-using another compiler, be sure to verify binary files work properly when read
-via redirection or a pipe.
-
-This program has not been tested on a machine on which {\tt int} and/or {\tt
-long} are longer than 32 bits.
-
-\section{
-\elink{Download md5.zip}{http://www.fourmilab.ch/md5/md5.zip} (Zipped
-archive)}
-\index{Archive!Download md5.zip Zipped }
-\index{Download md5.zip (Zipped archive) }
-\addcontentsline{toc}{subsection}{Download md5.zip (Zipped archive)}
-
-The program is provided as
-\elink{md5.zip}{http://www.fourmilab.ch/md5/md5.zip}, a
-\elink{Zipped}{http://www.pkware.com/} archive containing an ready-to-run
-Win32 command-line executable program, {\tt md5.exe} (compiled using Microsoft
-Visual C++ 5.0), and in source code form along with a {\tt Makefile} to build
-the program under Unix.
-
-\subsection{See Also}
-\index{ALSO!SEE }
-\index{See Also }
-\addcontentsline{toc}{subsubsection}{SEE ALSO}
-
-{\bf sum}(1)
-
-\subsection{Exit Status}
-\index{Status!Exit }
-\index{Exit Status }
-\addcontentsline{toc}{subsubsection}{Exit Status}
-
-{\bf md5} returns status 0 if processing was completed without errors, 1 if
-the {\bf -c} option was specified and the given signature does not match that
-of the input, and 2 if processing could not be performed at all due, for
-example, to a nonexistent input file.
-
-\subsection{Copying}
-\index{Copying }
-\addcontentsline{toc}{subsubsection}{Copying}
-
-\begin{quote}
-This software is in the public domain. Permission to use, copy, modify, and
-distribute this software and its documentation for any purpose and without
-fee is hereby granted, without any conditions or restrictions. This software
-is provided ``as is'' without express or implied warranty.
-\end{quote}
-
-\subsection{Acknowledgements}
-\index{Acknowledgements }
-\addcontentsline{toc}{subsubsection}{Acknowledgements}
-
-The MD5 algorithm was developed by Ron Rivest. The public domain C language
-implementation used in this program was written by Colin Plumb in 1993.
-{\it
-\elink{by John Walker}{http://www.fourmilab.ch/}
-January 6th, MIM }
+++ /dev/null
-%%
-%%
-
-\chapter{Storage Media Output Format}
-\label{_ChapterStart9}
-\index{Format!Storage Media Output}
-\index{Storage Media Output Format}
-\addcontentsline{toc}{section}{Storage Media Output Format}
-
-\section{General}
-\index{General}
-\addcontentsline{toc}{subsection}{General}
-
-This document describes the media format written by the Storage daemon. The
-Storage daemon reads and writes in units of blocks. Blocks contain records.
-Each block has a block header followed by records, and each record has a
-record header followed by record data.
-
-This chapter is intended to be a technical discussion of the Media Format and
-as such is not targeted at end users but rather at developers and system
-administrators that want or need to know more of the working details of {\bf
-Bacula}.
-
-\section{Definitions}
-\index{Definitions}
-\addcontentsline{toc}{subsection}{Definitions}
-
-\begin{description}
-
-\item [Block]
- \index{Block}
- A block represents the primitive unit of information that the Storage daemon
-reads and writes to a physical device. Normally, for a tape device, it will
-be the same as a tape block. The Storage daemon always reads and writes
-blocks. A block consists of block header information followed by records.
-Clients of the Storage daemon (the File daemon) normally never see blocks.
-However, some of the Storage tools (bls, bscan, bextract, ...) may be use
-block header information. In older Bacula tape versions, a block could
-contain records (see record definition below) from multiple jobs. However,
-all blocks currently written by Bacula are block level BB02, and a given
-block contains records for only a single job. Different jobs simply have
-their own private blocks that are intermingled with the other blocks from
-other jobs on the Volume (previously the records were intermingled within
-the blocks). Having only records from a single job in any give block
-permitted moving the VolumeSessionId and VolumeSessionTime (see below) from
-each record heading to the Block header. This has two advantages: 1. a block
-can be quickly rejected based on the contents of the header without reading
-all the records. 2. because there is on the average more than one record per
-block, less data is written to the Volume for each job.
-
-\item [Record]
- \index{Record}
- A record consists of a Record Header, which is managed by the Storage daemon
-and Record Data, which is the data received from the Client. A record is the
-primitive unit of information sent to and from the Storage daemon by the
-Client (File daemon) programs. The details are described below.
-
-\item [JobId]
- \index{JobId}
- A number assigned by the Director daemon for a particular job. This number
-will be unique for that particular Director (Catalog). The daemons use this
-number to keep track of individual jobs. Within the Storage daemon, the JobId
-may not be unique if several Directors are accessing the Storage daemon
-simultaneously.
-
-\item [Session]
- \index{Session}
- A Session is a concept used in the Storage daemon corresponds one to one to a
-Job with the exception that each session is uniquely identified within the
-Storage daemon by a unique SessionId/SessionTime pair (see below).
-
-\item [VolSessionId]
- \index{VolSessionId}
- A unique number assigned by the Storage daemon to a particular session (Job)
-it is having with a File daemon. This number by itself is not unique to the
-given Volume, but with the VolSessionTime, it is unique.
-
-\item [VolSessionTime]
- \index{VolSessionTime}
- A unique number assigned by the Storage daemon to a particular Storage daemon
-execution. It is actually the Unix time\_t value of when the Storage daemon
-began execution cast to a 32 bit unsigned integer. The combination of the
-{\bf VolSessionId} and the {\bf VolSessionTime} for a given Storage daemon is
-guaranteed to be unique for each Job (or session).
-
-\item [FileIndex]
- \index{FileIndex}
- A sequential number beginning at one assigned by the File daemon to the files
-within a job that are sent to the Storage daemon for backup. The Storage
-daemon ensures that this number is greater than zero and sequential. Note,
-the Storage daemon uses negative FileIndexes to flag Session Start and End
-Labels as well as End of Volume Labels. Thus, the combination of
-VolSessionId, VolSessionTime, and FileIndex uniquely identifies the records
-for a single file written to a Volume.
-
-\item [Stream]
- \index{Stream}
- While writing the information for any particular file to the Volume, there
-can be any number of distinct pieces of information about that file, e.g. the
-attributes, the file data, ... The Stream indicates what piece of data it
-is, and it is an arbitrary number assigned by the File daemon to the parts
-(Unix attributes, Win32 attributes, data, compressed data,\ ...) of a file
-that are sent to the Storage daemon. The Storage daemon has no knowledge of
-the details of a Stream; it simply represents a numbered stream of bytes. The
-data for a given stream may be passed to the Storage daemon in single record,
-or in multiple records.
-
-\item [Block Header]
- \index{Block Header}
- A block header consists of a block identification (``BB02''), a block length
-in bytes (typically 64,512) a checksum, and sequential block number. Each
-block starts with a Block Header and is followed by Records. Current block
-headers also contain the VolSessionId and VolSessionTime for the records
-written to that block.
-
-\item [Record Header]
- \index{Record Header}
- A record header contains the Volume Session Id, the Volume Session Time, the
-FileIndex, the Stream, and the size of the data record which follows. The
-Record Header is always immediately followed by a Data Record if the size
-given in the Header is greater than zero. Note, for Block headers of level
-BB02 (version 1.27 and later), the Record header as written to tape does not
-contain the Volume Session Id and the Volume Session Time as these two
-fields are stored in the BB02 Block header. The in-memory record header does
-have those fields for convenience.
-
-\item [Data Record]
- \index{Data Record}
- A data record consists of a binary stream of bytes and is always preceded by
-a Record Header. The details of the meaning of the binary stream of bytes are
-unknown to the Storage daemon, but the Client programs (File daemon) defines
-and thus knows the details of each record type.
-
-\item [Volume Label]
- \index{Volume Label}
- A label placed by the Storage daemon at the beginning of each storage volume.
-It contains general information about the volume. It is written in Record
-format. The Storage daemon manages Volume Labels, and if the client wants, he
-may also read them.
-
-\item [Begin Session Label]
- \index{Begin Session Label}
- The Begin Session Label is a special record placed by the Storage daemon on
-the storage medium as the first record of an append session job with a File
-daemon. This record is useful for finding the beginning of a particular
-session (Job), since no records with the same VolSessionId and VolSessionTime
-will precede this record. This record is not normally visible outside of the
-Storage daemon. The Begin Session Label is similar to the Volume Label except
-that it contains additional information pertaining to the Session.
-
-\item [End Session Label]
- \index{End Session Label}
- The End Session Label is a special record placed by the Storage daemon on the
-storage medium as the last record of an append session job with a File
-daemon. The End Session Record is distinguished by a FileIndex with a value
-of minus two (-2). This record is useful for detecting the end of a
-particular session since no records with the same VolSessionId and
-VolSessionTime will follow this record. This record is not normally visible
-outside of the Storage daemon. The End Session Label is similar to the Volume
-Label except that it contains additional information pertaining to the
-Session.
-\end{description}
-
-\section{Storage Daemon File Output Format}
-\index{Format!Storage Daemon File Output}
-\index{Storage Daemon File Output Format}
-\addcontentsline{toc}{subsection}{Storage Daemon File Output Format}
-
-The file storage and tape storage formats are identical except that tape
-records are by default blocked into blocks of 64,512 bytes, except for the
-last block, which is the actual number of bytes written rounded up to a
-multiple of 1024 whereas the last record of file storage is not rounded up.
-The default block size of 64,512 bytes may be overridden by the user (some
-older tape drives only support block sizes of 32K). Each Session written to
-tape is terminated with an End of File mark (this will be removed later).
-Sessions written to file are simply appended to the end of the file.
-
-\section{Overall Format}
-\index{Format!Overall}
-\index{Overall Format}
-\addcontentsline{toc}{subsection}{Overall Format}
-
-A Bacula output file consists of Blocks of data. Each block contains a block
-header followed by records. Each record consists of a record header followed
-by the record data. The first record on a tape will always be the Volume Label
-Record.
-
-No Record Header will be split across Bacula blocks. However, Record Data may
-be split across any number of Bacula blocks. Obviously this will not be the
-case for the Volume Label which will always be smaller than the Bacula Block
-size.
-
-To simplify reading tapes, the Start of Session (SOS) and End of Session (EOS)
-records are never split across blocks. If this is about to happen, Bacula will
-write a short block before writing the session record (actually, the SOS
-record should always be the first record in a block, excepting perhaps the
-Volume label).
-
-Due to hardware limitations, the last block written to the tape may not be
-fully written. If your drive permits backspace record, Bacula will backup over
-the last record written on the tape, re-read it and verify that it was
-correctly written.
-
-When a new tape is mounted Bacula will write the full contents of the
-partially written block to the new tape ensuring that there is no loss of
-data. When reading a tape, Bacula will discard any block that is not totally
-written, thus ensuring that there is no duplication of data. In addition,
-since Bacula blocks are sequentially numbered within a Job, it is easy to
-ensure that no block is missing or duplicated.
-
-\section{Serialization}
-\index{Serialization}
-\addcontentsline{toc}{subsection}{Serialization}
-
-All Block Headers, Record Headers, and Label Records are written using
-Bacula's serialization routines. These routines guarantee that the data is
-written to the output volume in a machine independent format.
-
-\section{Block Header}
-\index{Header!Block}
-\index{Block Header}
-\addcontentsline{toc}{subsection}{Block Header}
-
-The format of the Block Header (version 1.27 and later) is:
-
-\footnotesize
-\begin{verbatim}
- uint32_t CheckSum; /* Block check sum */
- uint32_t BlockSize; /* Block byte size including the header */
- uint32_t BlockNumber; /* Block number */
- char ID[4] = "BB02"; /* Identification and block level */
- uint32_t VolSessionId; /* Session Id for Job */
- uint32_t VolSessionTime; /* Session Time for Job */
-\end{verbatim}
-\normalsize
-
-The Block header is a fixed length and fixed format and is followed by Record
-Headers and Record Data. The CheckSum field is a 32 bit checksum of the block
-data and the block header but not including the CheckSum field. The Block
-Header is always immediately followed by a Record Header. If the tape is
-damaged, a Bacula utility will be able to recover as much information as
-possible from the tape by recovering blocks which are valid. The Block header
-is written using the Bacula serialization routines and thus is guaranteed to
-be in machine independent format. See below for version 2 of the block header.
-
-
-\section{Record Header}
-\index{Header!Record}
-\index{Record Header}
-\addcontentsline{toc}{subsection}{Record Header}
-
-Each binary data record is preceded by a Record Header. The Record Header is
-fixed length and fixed format, whereas the binary data record is of variable
-length. The Record Header is written using the Bacula serialization routines
-and thus is guaranteed to be in machine independent format.
-
-The format of the Record Header (version 1.27 or later) is:
-
-\footnotesize
-\begin{verbatim}
- int32_t FileIndex; /* File index supplied by File daemon */
- int32_t Stream; /* Stream number supplied by File daemon */
- uint32_t DataSize; /* size of following data record in bytes */
-\end{verbatim}
-\normalsize
-
-This record is followed by the binary Stream data of DataSize bytes, followed
-by another Record Header record and the binary stream data. For the definitive
-definition of this record, see record.h in the src/stored directory.
-
-Additional notes on the above:
-
-\begin{description}
-
-\item [The {\bf VolSessionId} ]
- \index{VolSessionId}
- is a unique sequential number that is assigned by the Storage Daemon to a
-particular Job. This number is sequential since the start of execution of the
-daemon.
-
-\item [The {\bf VolSessionTime} ]
- \index{VolSessionTime}
- is the time/date that the current execution of the Storage Daemon started. It
-assures that the combination of VolSessionId and VolSessionTime is unique for
-every jobs written to the tape, even if there was a machine crash between two
-writes.
-
-\item [The {\bf FileIndex} ]
- \index{FileIndex}
- is a sequential file number within a job. The Storage daemon requires this
-index to be greater than zero and sequential. Note, however, that the File
-daemon may send multiple Streams for the same FileIndex. In addition, the
-Storage daemon uses negative FileIndices to hold the Begin Session Label, the
-End Session Label, and the End of Volume Label.
-
-\item [The {\bf Stream} ]
- \index{Stream}
- is defined by the File daemon and is used to identify separate parts of the
-data saved for each file (Unix attributes, Win32 attributes, file data,
-compressed file data, sparse file data, ...). The Storage Daemon has no idea
-of what a Stream is or what it contains except that the Stream is required to
-be a positive integer. Negative Stream numbers are used internally by the
-Storage daemon to indicate that the record is a continuation of the previous
-record (the previous record would not entirely fit in the block).
-
-For Start Session and End Session Labels (where the FileIndex is negative),
-the Storage daemon uses the Stream field to contain the JobId. The current
-stream definitions are:
-
-\footnotesize
-\begin{verbatim}
-#define STREAM_UNIX_ATTRIBUTES 1 /* Generic Unix attributes */
-#define STREAM_FILE_DATA 2 /* Standard uncompressed data */
-#define STREAM_MD5_SIGNATURE 3 /* MD5 signature for the file */
-#define STREAM_GZIP_DATA 4 /* GZip compressed file data */
-/* Extended Unix attributes with Win32 Extended data. Deprecated. */
-#define STREAM_UNIX_ATTRIBUTES_EX 5 /* Extended Unix attr for Win32 EX */
-#define STREAM_SPARSE_DATA 6 /* Sparse data stream */
-#define STREAM_SPARSE_GZIP_DATA 7
-#define STREAM_PROGRAM_NAMES 8 /* program names for program data */
-#define STREAM_PROGRAM_DATA 9 /* Data needing program */
-#define STREAM_SHA1_SIGNATURE 10 /* SHA1 signature for the file */
-#define STREAM_WIN32_DATA 11 /* Win32 BackupRead data */
-#define STREAM_WIN32_GZIP_DATA 12 /* Gzipped Win32 BackupRead data */
-#define STREAM_MACOS_FORK_DATA 13 /* Mac resource fork */
-#define STREAM_HFSPLUS_ATTRIBUTES 14 /* Mac OS extra attributes */
-#define STREAM_UNIX_ATTRIBUTES_ACCESS_ACL 15 /* Standard ACL attributes on UNIX */
-#define STREAM_UNIX_ATTRIBUTES_DEFAULT_ACL 16 /* Default ACL attributes on UNIX */
-\end{verbatim}
-\normalsize
-
-\item [The {\bf DataSize} ]
- \index{DataSize}
- is the size in bytes of the binary data record that follows the Session
-Record header. The Storage Daemon has no idea of the actual contents of the
-binary data record. For standard Unix files, the data record typically
-contains the file attributes or the file data. For a sparse file the first
-64 bits of the file data contains the storage address for the data block.
-\end{description}
-
-The Record Header is never split across two blocks. If there is not enough
-room in a block for the full Record Header, the block is padded to the end
-with zeros and the Record Header begins in the next block. The data record, on
-the other hand, may be split across multiple blocks and even multiple physical
-volumes. When a data record is split, the second (and possibly subsequent)
-piece of the data is preceded by a new Record Header. Thus each piece of data
-is always immediately preceded by a Record Header. When reading a record, if
-Bacula finds only part of the data in the first record, it will automatically
-read the next record and concatenate the data record to form a full data
-record.
-
-\section{Version BB02 Block Header}
-\index{Version BB02 Block Header}
-\index{Header!Version BB02 Block}
-\addcontentsline{toc}{subsection}{Version BB02 Block Header}
-
-Each session or Job has its own private block. As a consequence, the SessionId
-and SessionTime are written once in each Block Header and not in the Record
-Header. So, the second and current version of the Block Header BB02 is:
-
-\footnotesize
-\begin{verbatim}
- uint32_t CheckSum; /* Block check sum */
- uint32_t BlockSize; /* Block byte size including the header */
- uint32_t BlockNumber; /* Block number */
- char ID[4] = "BB02"; /* Identification and block level */
- uint32_t VolSessionId; /* Applies to all records */
- uint32_t VolSessionTime; /* contained in this block */
-\end{verbatim}
-\normalsize
-
-As with the previous version, the BB02 Block header is a fixed length and
-fixed format and is followed by Record Headers and Record Data. The CheckSum
-field is a 32 bit CRC checksum of the block data and the block header but not
-including the CheckSum field. The Block Header is always immediately followed
-by a Record Header. If the tape is damaged, a Bacula utility will be able to
-recover as much information as possible from the tape by recovering blocks
-which are valid. The Block header is written using the Bacula serialization
-routines and thus is guaranteed to be in machine independent format.
-
-\section{Version 2 Record Header}
-\index{Version 2 Record Header}
-\index{Header!Version 2 Record}
-\addcontentsline{toc}{subsection}{Version 2 Record Header}
-
-Version 2 Record Header is written to the medium when using Version BB02 Block
-Headers. The memory representation of the record is identical to the old BB01
-Record Header, but on the storage medium, the first two fields, namely
-VolSessionId and VolSessionTime are not written. The Block Header is filled
-with these values when the First user record is written (i.e. non label
-record) so that when the block is written, it will have the current and unique
-VolSessionId and VolSessionTime. On reading each record from the Block, the
-VolSessionId and VolSessionTime is filled in the Record Header from the Block
-Header.
-
-\section{Volume Label Format}
-\index{Volume Label Format}
-\index{Format!Volume Label}
-\addcontentsline{toc}{subsection}{Volume Label Format}
-
-Tape volume labels are created by the Storage daemon in response to a {\bf
-label} command given to the Console program, or alternatively by the {\bf
-btape} program. created. Each volume is labeled with the following information
-using the Bacula serialization routines, which guarantee machine byte order
-independence.
-
-For Bacula versions 1.27 and later, the Volume Label Format is:
-
-\footnotesize
-\begin{verbatim}
- char Id[32]; /* Bacula 1.0 Immortal\n */
- uint32_t VerNum; /* Label version number */
- /* VerNum 11 and greater Bacula 1.27 and later */
- btime_t label_btime; /* Time/date tape labeled */
- btime_t write_btime; /* Time/date tape first written */
- /* The following are 0 in VerNum 11 and greater */
- float64_t write_date; /* Date this label written */
- float64_t write_time; /* Time this label written */
- char VolName[128]; /* Volume name */
- char PrevVolName[128]; /* Previous Volume Name */
- char PoolName[128]; /* Pool name */
- char PoolType[128]; /* Pool type */
- char MediaType[128]; /* Type of this media */
- char HostName[128]; /* Host name of writing computer */
- char LabelProg[32]; /* Label program name */
- char ProgVersion[32]; /* Program version */
- char ProgDate[32]; /* Program build date/time */
-\end{verbatim}
-\normalsize
-
-Note, the LabelType (Volume Label, Volume PreLabel, Session Start Label, ...)
-is stored in the record FileIndex field of the Record Header and does not
-appear in the data part of the record.
-
-\section{Session Label}
-\index{Label!Session}
-\index{Session Label}
-\addcontentsline{toc}{subsection}{Session Label}
-
-The Session Label is written at the beginning and end of each session as well
-as the last record on the physical medium. It has the following binary format:
-
-
-\footnotesize
-\begin{verbatim}
- char Id[32]; /* Bacula Immortal ... */
- uint32_t VerNum; /* Label version number */
- uint32_t JobId; /* Job id */
- uint32_t VolumeIndex; /* sequence no of vol */
- /* Prior to VerNum 11 */
- float64_t write_date; /* Date this label written */
- /* VerNum 11 and greater */
- btime_t write_btime; /* time/date record written */
- /* The following is zero VerNum 11 and greater */
- float64_t write_time; /* Time this label written */
- char PoolName[128]; /* Pool name */
- char PoolType[128]; /* Pool type */
- char JobName[128]; /* base Job name */
- char ClientName[128];
- /* Added in VerNum 10 */
- char Job[128]; /* Unique Job name */
- char FileSetName[128]; /* FileSet name */
- uint32_t JobType;
- uint32_t JobLevel;
-\end{verbatim}
-\normalsize
-
-In addition, the EOS label contains:
-
-\footnotesize
-\begin{verbatim}
- /* The remainder are part of EOS label only */
- uint32_t JobFiles;
- uint64_t JobBytes;
- uint32_t start_block;
- uint32_t end_block;
- uint32_t start_file;
- uint32_t end_file;
- uint32_t JobErrors;
-\end{verbatim}
-\normalsize
-
-In addition, for VerNum greater than 10, the EOS label contains (in addition
-to the above):
-
-\footnotesize
-\begin{verbatim}
- uint32_t JobStatus /* Job termination code */
-\end{verbatim}
-\normalsize
-
-: Note, the LabelType (Volume Label, Volume PreLabel, Session Start Label,
-...) is stored in the record FileIndex field and does not appear in the data
-part of the record. Also, the Stream field of the Record Header contains the
-JobId. This permits quick filtering without actually reading all the session
-data in many cases.
-
-\section{Overall Storage Format}
-\index{Format!Overall Storage}
-\index{Overall Storage Format}
-\addcontentsline{toc}{subsection}{Overall Storage Format}
-
-\footnotesize
-\begin{verbatim}
- Current Bacula Tape Format
- 6 June 2001
- Version BB02 added 28 September 2002
- Version BB01 is the old deprecated format.
- A Bacula tape is composed of tape Blocks. Each block
- has a Block header followed by the block data. Block
- Data consists of Records. Records consist of Record
- Headers followed by Record Data.
- :=======================================================:
- | |
- | Block Header (24 bytes) |
- | |
- |-------------------------------------------------------|
- | |
- | Record Header (12 bytes) |
- | |
- |-------------------------------------------------------|
- | |
- | Record Data |
- | |
- |-------------------------------------------------------|
- | |
- | Record Header (12 bytes) |
- | |
- |-------------------------------------------------------|
- | |
- | ... |
- Block Header: the first item in each block. The format is
- shown below.
- Partial Data block: occurs if the data from a previous
- block spills over to this block (the normal case except
- for the first block on a tape). However, this partial
- data block is always preceded by a record header.
- Record Header: identifies the Volume Session, the Stream
- and the following Record Data size. See below for format.
- Record data: arbitrary binary data.
- Block Header Format BB02
- :=======================================================:
- | CheckSum (uint32_t) |
- |-------------------------------------------------------|
- | BlockSize (uint32_t) |
- |-------------------------------------------------------|
- | BlockNumber (uint32_t) |
- |-------------------------------------------------------|
- | "BB02" (char [4]) |
- |-------------------------------------------------------|
- | VolSessionId (uint32_t) |
- |-------------------------------------------------------|
- | VolSessionTime (uint32_t) |
- :=======================================================:
- BBO2: Serves to identify the block as a
- Bacula block and also servers as a block format identifier
- should we ever need to change the format.
- BlockSize: is the size in bytes of the block. When reading
- back a block, if the BlockSize does not agree with the
- actual size read, Bacula discards the block.
- CheckSum: a checksum for the Block.
- BlockNumber: is the sequential block number on the tape.
- VolSessionId: a unique sequential number that is assigned
- by the Storage Daemon to a particular Job.
- This number is sequential since the start
- of execution of the daemon.
- VolSessionTime: the time/date that the current execution
- of the Storage Daemon started. It assures
- that the combination of VolSessionId and
- VolSessionTime is unique for all jobs
- written to the tape, even if there was a
- machine crash between two writes.
- Record Header Format BB02
- :=======================================================:
- | FileIndex (int32_t) |
- |-------------------------------------------------------|
- | Stream (int32_t) |
- |-------------------------------------------------------|
- | DataSize (uint32_t) |
- :=======================================================:
- FileIndex: a sequential file number within a job. The
- Storage daemon enforces this index to be
- greater than zero and sequential. Note,
- however, that the File daemon may send
- multiple Streams for the same FileIndex.
- The Storage Daemon uses negative FileIndices
- to identify Session Start and End labels
- as well as the End of Volume labels.
- Stream: defined by the File daemon and is intended to be
- used to identify separate parts of the data
- saved for each file (attributes, file data,
- ...). The Storage Daemon has no idea of
- what a Stream is or what it contains.
- DataSize: the size in bytes of the binary data record
- that follows the Session Record header.
- The Storage Daemon has no idea of the
- actual contents of the binary data record.
- For standard Unix files, the data record
- typically contains the file attributes or
- the file data. For a sparse file
- the first 64 bits of the data contains
- the storage address for the data block.
- Volume Label
- :=======================================================:
- | Id (32 bytes) |
- |-------------------------------------------------------|
- | VerNum (uint32_t) |
- |-------------------------------------------------------|
- | label_date (float64_t) |
- | label_btime (btime_t VerNum 11 |
- |-------------------------------------------------------|
- | label_time (float64_t) |
- | write_btime (btime_t VerNum 11 |
- |-------------------------------------------------------|
- | write_date (float64_t) |
- | 0 (float64_t) VerNum 11 |
- |-------------------------------------------------------|
- | write_time (float64_t) |
- | 0 (float64_t) VerNum 11 |
- |-------------------------------------------------------|
- | VolName (128 bytes) |
- |-------------------------------------------------------|
- | PrevVolName (128 bytes) |
- |-------------------------------------------------------|
- | PoolName (128 bytes) |
- |-------------------------------------------------------|
- | PoolType (128 bytes) |
- |-------------------------------------------------------|
- | MediaType (128 bytes) |
- |-------------------------------------------------------|
- | HostName (128 bytes) |
- |-------------------------------------------------------|
- | LabelProg (32 bytes) |
- |-------------------------------------------------------|
- | ProgVersion (32 bytes) |
- |-------------------------------------------------------|
- | ProgDate (32 bytes) |
- |-------------------------------------------------------|
- :=======================================================:
-
- Id: 32 byte Bacula identifier "Bacula 1.0 immortal\n"
- (old version also recognized:)
- Id: 32 byte Bacula identifier "Bacula 0.9 mortal\n"
- LabelType (Saved in the FileIndex of the Header record).
- PRE_LABEL -1 Volume label on unwritten tape
- VOL_LABEL -2 Volume label after tape written
- EOM_LABEL -3 Label at EOM (not currently implemented)
- SOS_LABEL -4 Start of Session label (format given below)
- EOS_LABEL -5 End of Session label (format given below)
- VerNum: 11
- label_date: Julian day tape labeled
- label_time: Julian time tape labeled
- write_date: Julian date tape first used (data written)
- write_time: Julian time tape first used (data written)
- VolName: "Physical" Volume name
- PrevVolName: The VolName of the previous tape (if this tape is
- a continuation of the previous one).
- PoolName: Pool Name
- PoolType: Pool Type
- MediaType: Media Type
- HostName: Name of host that is first writing the tape
- LabelProg: Name of the program that labeled the tape
- ProgVersion: Version of the label program
- ProgDate: Date Label program built
- Session Label
- :=======================================================:
- | Id (32 bytes) |
- |-------------------------------------------------------|
- | VerNum (uint32_t) |
- |-------------------------------------------------------|
- | JobId (uint32_t) |
- |-------------------------------------------------------|
- | write_btime (btime_t) VerNum 11 |
- |-------------------------------------------------------|
- | 0 (float64_t) VerNum 11 |
- |-------------------------------------------------------|
- | PoolName (128 bytes) |
- |-------------------------------------------------------|
- | PoolType (128 bytes) |
- |-------------------------------------------------------|
- | JobName (128 bytes) |
- |-------------------------------------------------------|
- | ClientName (128 bytes) |
- |-------------------------------------------------------|
- | Job (128 bytes) |
- |-------------------------------------------------------|
- | FileSetName (128 bytes) |
- |-------------------------------------------------------|
- | JobType (uint32_t) |
- |-------------------------------------------------------|
- | JobLevel (uint32_t) |
- |-------------------------------------------------------|
- | FileSetMD5 (50 bytes) VerNum 11 |
- |-------------------------------------------------------|
- Additional fields in End Of Session Label
- |-------------------------------------------------------|
- | JobFiles (uint32_t) |
- |-------------------------------------------------------|
- | JobBytes (uint32_t) |
- |-------------------------------------------------------|
- | start_block (uint32_t) |
- |-------------------------------------------------------|
- | end_block (uint32_t) |
- |-------------------------------------------------------|
- | start_file (uint32_t) |
- |-------------------------------------------------------|
- | end_file (uint32_t) |
- |-------------------------------------------------------|
- | JobErrors (uint32_t) |
- |-------------------------------------------------------|
- | JobStatus (uint32_t) VerNum 11 |
- :=======================================================:
- * => fields deprecated
- Id: 32 byte Bacula Identifier "Bacula 1.0 immortal\n"
- LabelType (in FileIndex field of Header):
- EOM_LABEL -3 Label at EOM
- SOS_LABEL -4 Start of Session label
- EOS_LABEL -5 End of Session label
- VerNum: 11
- JobId: JobId
- write_btime: Bacula time/date this tape record written
- write_date: Julian date tape this record written - deprecated
- write_time: Julian time tape this record written - deprecated.
- PoolName: Pool Name
- PoolType: Pool Type
- MediaType: Media Type
- ClientName: Name of File daemon or Client writing this session
- Not used for EOM_LABEL.
-\end{verbatim}
-\normalsize
-
-\section{Unix File Attributes}
-\index{Unix File Attributes}
-\index{Attributes!Unix File}
-\addcontentsline{toc}{subsection}{Unix File Attributes}
-
-The Unix File Attributes packet consists of the following:
-
-\lt{}File-Index\gt{} \lt{}Type\gt{}
-\lt{}Filename\gt{}@\lt{}File-Attributes\gt{}@\lt{}Link\gt{}
-@\lt{}Extended-Attributes@\gt{} where
-
-\begin{description}
-
-\item [@]
- represents a byte containing a binary zero.
-
-\item [FileIndex]
- \index{FileIndex}
- is the sequential file index starting from one assigned by the File daemon.
-
-\item [Type]
- \index{Type}
- is one of the following:
-
-\footnotesize
-\begin{verbatim}
-#define FT_LNKSAVED 1 /* hard link to file already saved */
-#define FT_REGE 2 /* Regular file but empty */
-#define FT_REG 3 /* Regular file */
-#define FT_LNK 4 /* Soft Link */
-#define FT_DIR 5 /* Directory */
-#define FT_SPEC 6 /* Special file -- chr, blk, fifo, sock */
-#define FT_NOACCESS 7 /* Not able to access */
-#define FT_NOFOLLOW 8 /* Could not follow link */
-#define FT_NOSTAT 9 /* Could not stat file */
-#define FT_NOCHG 10 /* Incremental option, file not changed */
-#define FT_DIRNOCHG 11 /* Incremental option, directory not changed */
-#define FT_ISARCH 12 /* Trying to save archive file */
-#define FT_NORECURSE 13 /* No recursion into directory */
-#define FT_NOFSCHG 14 /* Different file system, prohibited */
-#define FT_NOOPEN 15 /* Could not open directory */
-#define FT_RAW 16 /* Raw block device */
-#define FT_FIFO 17 /* Raw fifo device */
-\end{verbatim}
-\normalsize
-
-\item [Filename]
- \index{Filename}
- is the fully qualified filename.
-
-\item [File-Attributes]
- \index{File-Attributes}
- consists of the 13 fields of the stat() buffer in ASCII base64 format
-separated by spaces. These fields and their meanings are shown below. This
-stat() packet is in Unix format, and MUST be provided (constructed) for ALL
-systems.
-
-\item [Link]
- \index{Link}
- when the FT code is FT\_LNK or FT\_LNKSAVED, the item in question is a Unix
-link, and this field contains the fully qualified link name. When the FT code
-is not FT\_LNK or FT\_LNKSAVED, this field is null.
-
-\item [Extended-Attributes]
- \index{Extended-Attributes}
- The exact format of this field is operating system dependent. It contains
-additional or extended attributes of a system dependent nature. Currently,
-this field is used only on WIN32 systems where it contains a ASCII base64
-representation of the WIN32\_FILE\_ATTRIBUTE\_DATA structure as defined by
-Windows. The fields in the base64 representation of this structure are like
-the File-Attributes separated by spaces.
-\end{description}
-
-The File-attributes consist of the following:
-
-\addcontentsline{lot}{table}{File Attributes}
-\begin{longtable}{|p{0.6in}|p{0.7in}|p{1in}|p{1in}|p{1.4in}|}
- \hline
-\multicolumn{1}{|c|}{\bf Field No. } & \multicolumn{1}{c|}{\bf Stat Name }
-& \multicolumn{1}{c|}{\bf Unix } & \multicolumn{1}{c|}{\bf Win98/NT } &
-\multicolumn{1}{c|}{\bf MacOS } \\
- \hline
-\multicolumn{1}{|c|}{1 } & {st\_dev } & {Device number of filesystem } &
-{Drive number } & {vRefNum } \\
- \hline
-\multicolumn{1}{|c|}{2 } & {st\_ino } & {Inode number } & {Always 0 } &
-{fileID/dirID } \\
- \hline
-\multicolumn{1}{|c|}{3 } & {st\_mode } & {File mode } & {File mode } &
-{777 dirs/apps; 666 docs; 444 locked docs } \\
- \hline
-\multicolumn{1}{|c|}{4 } & {st\_nlink } & {Number of links to the file } &
-{Number of link (only on NTFS) } & {Always 1 } \\
- \hline
-\multicolumn{1}{|c|}{5 } & {st\_uid } & {Owner ID } & {Always 0 } &
-{Always 0 } \\
- \hline
-\multicolumn{1}{|c|}{6 } & {st\_gid } & {Group ID } & {Always 0 } &
-{Always 0 } \\
- \hline
-\multicolumn{1}{|c|}{7 } & {st\_rdev } & {Device ID for special files } &
-{Drive No. } & {Always 0 } \\
- \hline
-\multicolumn{1}{|c|}{8 } & {st\_size } & {File size in bytes } & {File
-size in bytes } & {Data fork file size in bytes } \\
- \hline
-\multicolumn{1}{|c|}{9 } & {st\_blksize } & {Preferred block size } &
-{Always 0 } & {Preferred block size } \\
- \hline
-\multicolumn{1}{|c|}{10 } & {st\_blocks } & {Number of blocks allocated }
-& {Always 0 } & {Number of blocks allocated } \\
- \hline
-\multicolumn{1}{|c|}{11 } & {st\_atime } & {Last access time since epoch }
-& {Last access time since epoch } & {Last access time -66 years } \\
- \hline
-\multicolumn{1}{|c|}{12 } & {st\_mtime } & {Last modify time since epoch }
-& {Last modify time since epoch } & {Last access time -66 years } \\
- \hline
-\multicolumn{1}{|c|}{13 } & {st\_ctime } & {Inode change time since epoch
-} & {File create time since epoch } & {File create time -66 years}
-\\ \hline
-
-\end{longtable}
-
-\section{Old Depreciated Tape Format}
-\index{Old Depreciated Tape Format}
-\index{Format!Old Depreciated Tape}
-\addcontentsline{toc}{subsection}{Old Depreciated Tape Format}
-
-The format of the Block Header (version 1.26 and earlier) is:
-
-\footnotesize
-\begin{verbatim}
- uint32_t CheckSum; /* Block check sum */
- uint32_t BlockSize; /* Block byte size including the header */
- uint32_t BlockNumber; /* Block number */
- char ID[4] = "BB01"; /* Identification and block level */
-\end{verbatim}
-\normalsize
-
-The format of the Record Header (version 1.26 or earlier) is:
-
-\footnotesize
-\begin{verbatim}
- uint32_t VolSessionId; /* Unique ID for this session */
- uint32_t VolSessionTime; /* Start time/date of session */
- int32_t FileIndex; /* File index supplied by File daemon */
- int32_t Stream; /* Stream number supplied by File daemon */
- uint32_t DataSize; /* size of following data record in bytes */
-\end{verbatim}
-\normalsize
-
-\footnotesize
-\begin{verbatim}
- Current Bacula Tape Format
- 6 June 2001
- Version BB01 is the old deprecated format.
- A Bacula tape is composed of tape Blocks. Each block
- has a Block header followed by the block data. Block
- Data consists of Records. Records consist of Record
- Headers followed by Record Data.
- :=======================================================:
- | |
- | Block Header |
- | (16 bytes version BB01) |
- |-------------------------------------------------------|
- | |
- | Record Header |
- | (20 bytes version BB01) |
- |-------------------------------------------------------|
- | |
- | Record Data |
- | |
- |-------------------------------------------------------|
- | |
- | Record Header |
- | (20 bytes version BB01) |
- |-------------------------------------------------------|
- | |
- | ... |
- Block Header: the first item in each block. The format is
- shown below.
- Partial Data block: occurs if the data from a previous
- block spills over to this block (the normal case except
- for the first block on a tape). However, this partial
- data block is always preceded by a record header.
- Record Header: identifies the Volume Session, the Stream
- and the following Record Data size. See below for format.
- Record data: arbitrary binary data.
- Block Header Format BB01 (deprecated)
- :=======================================================:
- | CheckSum (uint32_t) |
- |-------------------------------------------------------|
- | BlockSize (uint32_t) |
- |-------------------------------------------------------|
- | BlockNumber (uint32_t) |
- |-------------------------------------------------------|
- | "BB01" (char [4]) |
- :=======================================================:
- BBO1: Serves to identify the block as a
- Bacula block and also servers as a block format identifier
- should we ever need to change the format.
- BlockSize: is the size in bytes of the block. When reading
- back a block, if the BlockSize does not agree with the
- actual size read, Bacula discards the block.
- CheckSum: a checksum for the Block.
- BlockNumber: is the sequential block number on the tape.
- VolSessionId: a unique sequential number that is assigned
- by the Storage Daemon to a particular Job.
- This number is sequential since the start
- of execution of the daemon.
- VolSessionTime: the time/date that the current execution
- of the Storage Daemon started. It assures
- that the combination of VolSessionId and
- VolSessionTime is unique for all jobs
- written to the tape, even if there was a
- machine crash between two writes.
- Record Header Format BB01 (deprecated)
- :=======================================================:
- | VolSessionId (uint32_t) |
- |-------------------------------------------------------|
- | VolSessionTime (uint32_t) |
- |-------------------------------------------------------|
- | FileIndex (int32_t) |
- |-------------------------------------------------------|
- | Stream (int32_t) |
- |-------------------------------------------------------|
- | DataSize (uint32_t) |
- :=======================================================:
- VolSessionId: a unique sequential number that is assigned
- by the Storage Daemon to a particular Job.
- This number is sequential since the start
- of execution of the daemon.
- VolSessionTime: the time/date that the current execution
- of the Storage Daemon started. It assures
- that the combination of VolSessionId and
- VolSessionTime is unique for all jobs
- written to the tape, even if there was a
- machine crash between two writes.
- FileIndex: a sequential file number within a job. The
- Storage daemon enforces this index to be
- greater than zero and sequential. Note,
- however, that the File daemon may send
- multiple Streams for the same FileIndex.
- The Storage Daemon uses negative FileIndices
- to identify Session Start and End labels
- as well as the End of Volume labels.
- Stream: defined by the File daemon and is intended to be
- used to identify separate parts of the data
- saved for each file (attributes, file data,
- ...). The Storage Daemon has no idea of
- what a Stream is or what it contains.
- DataSize: the size in bytes of the binary data record
- that follows the Session Record header.
- The Storage Daemon has no idea of the
- actual contents of the binary data record.
- For standard Unix files, the data record
- typically contains the file attributes or
- the file data. For a sparse file
- the first 64 bits of the data contains
- the storage address for the data block.
- Volume Label
- :=======================================================:
- | Id (32 bytes) |
- |-------------------------------------------------------|
- | VerNum (uint32_t) |
- |-------------------------------------------------------|
- | label_date (float64_t) |
- |-------------------------------------------------------|
- | label_time (float64_t) |
- |-------------------------------------------------------|
- | write_date (float64_t) |
- |-------------------------------------------------------|
- | write_time (float64_t) |
- |-------------------------------------------------------|
- | VolName (128 bytes) |
- |-------------------------------------------------------|
- | PrevVolName (128 bytes) |
- |-------------------------------------------------------|
- | PoolName (128 bytes) |
- |-------------------------------------------------------|
- | PoolType (128 bytes) |
- |-------------------------------------------------------|
- | MediaType (128 bytes) |
- |-------------------------------------------------------|
- | HostName (128 bytes) |
- |-------------------------------------------------------|
- | LabelProg (32 bytes) |
- |-------------------------------------------------------|
- | ProgVersion (32 bytes) |
- |-------------------------------------------------------|
- | ProgDate (32 bytes) |
- |-------------------------------------------------------|
- :=======================================================:
-
- Id: 32 byte Bacula identifier "Bacula 1.0 immortal\n"
- (old version also recognized:)
- Id: 32 byte Bacula identifier "Bacula 0.9 mortal\n"
- LabelType (Saved in the FileIndex of the Header record).
- PRE_LABEL -1 Volume label on unwritten tape
- VOL_LABEL -2 Volume label after tape written
- EOM_LABEL -3 Label at EOM (not currently implemented)
- SOS_LABEL -4 Start of Session label (format given below)
- EOS_LABEL -5 End of Session label (format given below)
- label_date: Julian day tape labeled
- label_time: Julian time tape labeled
- write_date: Julian date tape first used (data written)
- write_time: Julian time tape first used (data written)
- VolName: "Physical" Volume name
- PrevVolName: The VolName of the previous tape (if this tape is
- a continuation of the previous one).
- PoolName: Pool Name
- PoolType: Pool Type
- MediaType: Media Type
- HostName: Name of host that is first writing the tape
- LabelProg: Name of the program that labeled the tape
- ProgVersion: Version of the label program
- ProgDate: Date Label program built
- Session Label
- :=======================================================:
- | Id (32 bytes) |
- |-------------------------------------------------------|
- | VerNum (uint32_t) |
- |-------------------------------------------------------|
- | JobId (uint32_t) |
- |-------------------------------------------------------|
- | *write_date (float64_t) VerNum 10 |
- |-------------------------------------------------------|
- | *write_time (float64_t) VerNum 10 |
- |-------------------------------------------------------|
- | PoolName (128 bytes) |
- |-------------------------------------------------------|
- | PoolType (128 bytes) |
- |-------------------------------------------------------|
- | JobName (128 bytes) |
- |-------------------------------------------------------|
- | ClientName (128 bytes) |
- |-------------------------------------------------------|
- | Job (128 bytes) |
- |-------------------------------------------------------|
- | FileSetName (128 bytes) |
- |-------------------------------------------------------|
- | JobType (uint32_t) |
- |-------------------------------------------------------|
- | JobLevel (uint32_t) |
- |-------------------------------------------------------|
- | FileSetMD5 (50 bytes) VerNum 11 |
- |-------------------------------------------------------|
- Additional fields in End Of Session Label
- |-------------------------------------------------------|
- | JobFiles (uint32_t) |
- |-------------------------------------------------------|
- | JobBytes (uint32_t) |
- |-------------------------------------------------------|
- | start_block (uint32_t) |
- |-------------------------------------------------------|
- | end_block (uint32_t) |
- |-------------------------------------------------------|
- | start_file (uint32_t) |
- |-------------------------------------------------------|
- | end_file (uint32_t) |
- |-------------------------------------------------------|
- | JobErrors (uint32_t) |
- |-------------------------------------------------------|
- | JobStatus (uint32_t) VerNum 11 |
- :=======================================================:
- * => fields deprecated
- Id: 32 byte Bacula Identifier "Bacula 1.0 immortal\n"
- LabelType (in FileIndex field of Header):
- EOM_LABEL -3 Label at EOM
- SOS_LABEL -4 Start of Session label
- EOS_LABEL -5 End of Session label
- VerNum: 11
- JobId: JobId
- write_btime: Bacula time/date this tape record written
- write_date: Julian date tape this record written - deprecated
- write_time: Julian time tape this record written - deprecated.
- PoolName: Pool Name
- PoolType: Pool Type
- MediaType: Media Type
- ClientName: Name of File daemon or Client writing this session
- Not used for EOM_LABEL.
-\end{verbatim}
-\normalsize
+++ /dev/null
-%%
-%%
-
-\chapter{Bacula Memory Management}
-\label{_ChapterStart7}
-\index{Management!Bacula Memory}
-\index{Bacula Memory Management}
-\addcontentsline{toc}{section}{Bacula Memory Management}
-
-\section{General}
-\index{General}
-\addcontentsline{toc}{subsection}{General}
-
-This document describes the memory management routines that are used in Bacula
-and is meant to be a technical discussion for developers rather than part of
-the user manual.
-
-Since Bacula may be called upon to handle filenames of varying and more or
-less arbitrary length, special attention needs to be used in the code to
-ensure that memory buffers are sufficiently large. There are four
-possibilities for memory usage within {\bf Bacula}. Each will be described in
-turn. They are:
-
-\begin{itemize}
-\item Statically allocated memory.
-\item Dynamically allocated memory using malloc() and free().
-\item Non-pooled memory.
-\item Pooled memory.
- \end{itemize}
-
-\subsection{Statically Allocated Memory}
-\index{Statically Allocated Memory}
-\index{Memory!Statically Allocated}
-\addcontentsline{toc}{subsubsection}{Statically Allocated Memory}
-
-Statically allocated memory is of the form:
-
-\footnotesize
-\begin{verbatim}
-char buffer[MAXSTRING];
-\end{verbatim}
-\normalsize
-
-The use of this kind of memory is discouraged except when you are 100\% sure
-that the strings to be used will be of a fixed length. One example of where
-this is appropriate is for {\bf Bacula} resource names, which are currently
-limited to 127 characters (MAX\_NAME\_LENGTH). Although this maximum size may
-change, particularly to accommodate Unicode, it will remain a relatively small
-value.
-
-\subsection{Dynamically Allocated Memory}
-\index{Dynamically Allocated Memory}
-\index{Memory!Dynamically Allocated}
-\addcontentsline{toc}{subsubsection}{Dynamically Allocated Memory}
-
-Dynamically allocated memory is obtained using the standard malloc() routines.
-As in:
-
-\footnotesize
-\begin{verbatim}
-char *buf;
-buf = malloc(256);
-\end{verbatim}
-\normalsize
-
-This kind of memory can be released with:
-
-\footnotesize
-\begin{verbatim}
-free(buf);
-\end{verbatim}
-\normalsize
-
-It is recommended to use this kind of memory only when you are sure that you
-know the memory size needed and the memory will be used for short periods of
-time -- that is it would not be appropriate to use statically allocated
-memory. An example might be to obtain a large memory buffer for reading and
-writing files. When {\bf SmartAlloc} is enabled, the memory obtained by
-malloc() will automatically be checked for buffer overwrite (overflow) during
-the free() call, and all malloc'ed memory that is not released prior to
-termination of the program will be reported as Orphaned memory.
-
-\subsection{Pooled and Non-pooled Memory}
-\index{Memory!Pooled and Non-pooled}
-\index{Pooled and Non-pooled Memory}
-\addcontentsline{toc}{subsubsection}{Pooled and Non-pooled Memory}
-
-In order to facility the handling of arbitrary length filenames and to
-efficiently handle a high volume of dynamic memory usage, we have implemented
-routines between the C code and the malloc routines. The first is called
-``Pooled'' memory, and is memory, which once allocated and then released, is
-not returned to the system memory pool, but rather retained in a Bacula memory
-pool. The next request to acquire pooled memory will return any free memory
-block. In addition, each memory block has its current size associated with the
-block allowing for easy checking if the buffer is of sufficient size. This
-kind of memory would normally be used in high volume situations (lots of
-malloc()s and free()s) where the buffer length may have to frequently change
-to adapt to varying filename lengths.
-
-The non-pooled memory is handled by routines similar to those used for pooled
-memory, allowing for easy size checking. However, non-pooled memory is
-returned to the system rather than being saved in the Bacula pool. This kind
-of memory would normally be used in low volume situations (few malloc()s and
-free()s), but where the size of the buffer might have to be adjusted
-frequently.
-
-\paragraph*{Types of Memory Pool:}
-
-Currently there are three memory pool types:
-
-\begin{itemize}
-\item PM\_NOPOOL -- non-pooled memory.
-\item PM\_FNAME -- a filename pool.
-\item PM\_MESSAGE -- a message buffer pool.
-\item PM\_EMSG -- error message buffer pool.
- \end{itemize}
-
-\paragraph*{Getting Memory:}
-
-To get memory, one uses:
-
-\footnotesize
-\begin{verbatim}
-void *get_pool_memory(pool);
-\end{verbatim}
-\normalsize
-
-where {\bf pool} is one of the above mentioned pool names. The size of the
-memory returned will be determined by the system to be most appropriate for
-the application.
-
-If you wish non-pooled memory, you may alternatively call:
-
-\footnotesize
-\begin{verbatim}
-void *get_memory(size_t size);
-\end{verbatim}
-\normalsize
-
-The buffer length will be set to the size specified, and it will be assigned
-to the PM\_NOPOOL pool (no pooling).
-
-\paragraph*{Releasing Memory:}
-
-To free memory acquired by either of the above two calls, use:
-
-\footnotesize
-\begin{verbatim}
-void free_pool_memory(void *buffer);
-\end{verbatim}
-\normalsize
-
-where buffer is the memory buffer returned when the memory was acquired. If
-the memory was originally allocated as type PM\_NOPOOL, it will be released to
-the system, otherwise, it will be placed on the appropriate Bacula memory pool
-free chain to be used in a subsequent call for memory from that pool.
-
-\paragraph*{Determining the Memory Size:}
-
-To determine the memory buffer size, use:
-
-\footnotesize
-\begin{verbatim}
-size_t sizeof_pool_memory(void *buffer);
-\end{verbatim}
-\normalsize
-
-\paragraph*{Resizing Pool Memory:}
-
-To resize pool memory, use:
-
-\footnotesize
-\begin{verbatim}
-void *realloc_pool_memory(void *buffer);
-\end{verbatim}
-\normalsize
-
-The buffer will be reallocated, and the contents of the original buffer will
-be preserved, but the address of the buffer may change.
-
-\paragraph*{Automatic Size Adjustment:}
-
-To have the system check and if necessary adjust the size of your pooled
-memory buffer, use:
-
-\footnotesize
-\begin{verbatim}
-void *check_pool_memory_size(void *buffer, size_t new-size);
-\end{verbatim}
-\normalsize
-
-where {\bf new-size} is the buffer length needed. Note, if the buffer is
-already equal to or larger than {\bf new-size} no buffer size change will
-occur. However, if a buffer size change is needed, the original contents of
-the buffer will be preserved, but the buffer address may change. Many of the
-low level Bacula subroutines expect to be passed a pool memory buffer and use
-this call to ensure the buffer they use is sufficiently large.
-
-\paragraph*{Releasing All Pooled Memory:}
-
-In order to avoid orphaned buffer error messages when terminating the program,
-use:
-
-\footnotesize
-\begin{verbatim}
-void close_memory_pool();
-\end{verbatim}
-\normalsize
-
-to free all unused memory retained in the Bacula memory pool. Note, any memory
-not returned to the pool via free\_pool\_memory() will not be released by this
-call.
-
-\paragraph*{Pooled Memory Statistics:}
-
-For debugging purposes and performance tuning, the following call will print
-the current memory pool statistics:
-
-\footnotesize
-\begin{verbatim}
-void print_memory_pool_stats();
-\end{verbatim}
-\normalsize
-
-an example output is:
-
-\footnotesize
-\begin{verbatim}
-Pool Maxsize Maxused Inuse
- 0 256 0 0
- 1 256 1 0
- 2 256 1 0
-\end{verbatim}
-\normalsize
+++ /dev/null
-%%
-%%
-
-\chapter{TCP/IP Network Protocol}
-\label{_ChapterStart5}
-\index{TCP/IP Network Protocol}
-\index{Protocol!TCP/IP Network}
-\addcontentsline{toc}{section}{TCP/IP Network Protocol}
-
-\section{General}
-\index{General}
-\addcontentsline{toc}{subsection}{General}
-
-This document describes the TCP/IP protocol used by Bacula to communicate
-between the various daemons and services. The definitive definition of the
-protocol can be found in src/lib/bsock.h, src/lib/bnet.c and
-src/lib/bnet\_server.c.
-
-Bacula's network protocol is basically a ``packet oriented'' protocol built on
-a standard TCP/IP streams. At the lowest level all packet transfers are done
-with read() and write() requests on system sockets. Pipes are not used as they
-are considered unreliable for large serial data transfers between various
-hosts.
-
-Using the routines described below (bnet\_open, bnet\_write, bnet\_recv, and
-bnet\_close) guarantees that the number of bytes you write into the socket
-will be received as a single record on the other end regardless of how many
-low level write() and read() calls are needed. All data transferred are
-considered to be binary data.
-
-\section{bnet and Threads}
-\index{Threads!bnet and}
-\index{Bnet and Threads}
-\addcontentsline{toc}{subsection}{bnet and Threads}
-
-These bnet routines work fine in a threaded environment. However, they assume
-that there is only one reader or writer on the socket at any time. It is
-highly recommended that only a single thread access any BSOCK packet. The
-exception to this rule is when the socket is first opened and it is waiting
-for a job to start. The wait in the Storage daemon is done in one thread and
-then passed to another thread for subsequent handling.
-
-If you envision having two threads using the same BSOCK, think twice, then you
-must implement some locking mechanism. However, it probably would not be
-appropriate to put locks inside the bnet subroutines for efficiency reasons.
-
-\section{bnet\_open}
-\index{Bnet\_open}
-\addcontentsline{toc}{subsection}{bnet\_open}
-
-To establish a connection to a server, use the subroutine:
-
-BSOCK *bnet\_open(void *jcr, char *host, char *service, int port, int *fatal)
-bnet\_open(), if successful, returns the Bacula sock descriptor pointer to be
-used in subsequent bnet\_send() and bnet\_read() requests. If not successful,
-bnet\_open() returns a NULL. If fatal is set on return, it means that a fatal
-error occurred and that you should not repeatedly call bnet\_open(). Any error
-message will generally be sent to the JCR.
-
-\section{bnet\_send}
-\index{Bnet\_send}
-\addcontentsline{toc}{subsection}{bnet\_send}
-
-To send a packet, one uses the subroutine:
-
-int bnet\_send(BSOCK *sock) This routine is equivalent to a write() except
-that it handles the low level details. The data to be sent is expected to be
-in sock-\gt{}msg and be sock-\gt{}msglen bytes. To send a packet, bnet\_send()
-first writes four bytes in network byte order than indicate the size of the
-following data packet. It returns:
-
-\footnotesize
-\begin{verbatim}
- Returns 0 on failure
- Returns 1 on success
-\end{verbatim}
-\normalsize
-
-In the case of a failure, an error message will be sent to the JCR contained
-within the bsock packet.
-
-\section{bnet\_fsend}
-\index{Bnet\_fsend}
-\addcontentsline{toc}{subsection}{bnet\_fsend}
-
-This form uses:
-
-int bnet\_fsend(BSOCK *sock, char *format, ...) and it allows you to send a
-formatted messages somewhat like fprintf(). The return status is the same as
-bnet\_send.
-
-\section{Additional Error information}
-\index{Information!Additional Error}
-\index{Additional Error information}
-\addcontentsline{toc}{subsection}{Additional Error information}
-
-Fro additional error information, you can call {\bf is\_bnet\_error(BSOCK
-*bsock)} which will return 0 if there is no error or non-zero if there is an
-error on the last transmission. The {\bf is\_bnet\_stop(BSOCK *bsock)}
-function will return 0 if there no errors and you can continue sending. It
-will return non-zero if there are errors or the line is closed (no more
-transmissions should be sent).
-
-\section{bnet\_recv}
-\index{Bnet\_recv}
-\addcontentsline{toc}{subsection}{bnet\_recv}
-
-To read a packet, one uses the subroutine:
-
-int bnet\_recv(BSOCK *sock) This routine is similar to a read() except that it
-handles the low level details. bnet\_read() first reads packet length that
-follows as four bytes in network byte order. The data is read into
-sock-\gt{}msg and is sock-\gt{}msglen bytes. If the sock-\gt{}msg is not large
-enough, bnet\_recv() realloc() the buffer. It will return an error (-2) if
-maxbytes is less than the record size sent. It returns:
-
-\footnotesize
-\begin{verbatim}
- * Returns number of bytes read
- * Returns 0 on end of file
- * Returns -1 on hard end of file (i.e. network connection close)
- * Returns -2 on error
-\end{verbatim}
-\normalsize
-
-It should be noted that bnet\_recv() is a blocking read.
-
-\section{bnet\_sig}
-\index{Bnet\_sig}
-\addcontentsline{toc}{subsection}{bnet\_sig}
-
-To send a ``signal'' from one daemon to another, one uses the subroutine:
-
-int bnet\_sig(BSOCK *sock, SIGNAL) where SIGNAL is one of the following:
-
-\begin{enumerate}
-\item BNET\_EOF - deprecated use BNET\_EOD
-\item BNET\_EOD - End of data stream, new data may follow
-\item BNET\_EOD\_POLL - End of data and poll all in one
-\item BNET\_STATUS - Request full status
-\item BNET\_TERMINATE - Conversation terminated, doing close()
-\item BNET\_POLL - Poll request, I'm hanging on a read
-\item BNET\_HEARTBEAT - Heartbeat Response requested
-\item BNET\_HB\_RESPONSE - Only response permitted to HB
-\item BNET\_PROMPT - Prompt for UA
- \end{enumerate}
-
-\section{bnet\_strerror}
-\index{Bnet\_strerror}
-\addcontentsline{toc}{subsection}{bnet\_strerror}
-
-Returns a formated string corresponding to the last error that occurred.
-
-\section{bnet\_close}
-\index{Bnet\_close}
-\addcontentsline{toc}{subsection}{bnet\_close}
-
-The connection with the server remains open until closed by the subroutine:
-
-void bnet\_close(BSOCK *sock)
-
-\section{Becoming a Server}
-\index{Server!Becoming a}
-\index{Becoming a Server}
-\addcontentsline{toc}{subsection}{Becoming a Server}
-
-The bnet\_open() and bnet\_close() routines described above are used on the
-client side to establish a connection and terminate a connection with the
-server. To become a server (i.e. wait for a connection from a client), use the
-routine {\bf bnet\_thread\_server}. The calling sequence is a bit complicated,
-please refer to the code in bnet\_server.c and the code at the beginning of
-each daemon as examples of how to call it.
-
-\section{Higher Level Conventions}
-\index{Conventions!Higher Level}
-\index{Higher Level Conventions}
-\addcontentsline{toc}{subsection}{Higher Level Conventions}
-
-Within Bacula, we have established the convention that any time a single
-record is passed, it is sent with bnet\_send() and read with bnet\_recv().
-Thus the normal exchange between the server (S) and the client (C) are:
-
-\footnotesize
-\begin{verbatim}
-S: wait for connection C: attempt connection
-S: accept connection C: bnet_send() send request
-S: bnet_recv() wait for request
-S: act on request
-S: bnet_send() send ack C: bnet_recv() wait for ack
-\end{verbatim}
-\normalsize
-
-Thus a single command is sent, acted upon by the server, and then
-acknowledged.
-
-In certain cases, such as the transfer of the data for a file, all the
-information or data cannot be sent in a single packet. In this case, the
-convention is that the client will send a command to the server, who knows
-that more than one packet will be returned. In this case, the server will
-enter a loop:
-
-\footnotesize
-\begin{verbatim}
-while ((n=bnet_recv(bsock)) > 0) {
- act on request
-}
-if (n < 0)
- error
-\end{verbatim}
-\normalsize
-
-The client will perform the following:
-
-\footnotesize
-\begin{verbatim}
-bnet_send(bsock);
-bnet_send(bsock);
-...
-bnet_sig(bsock, BNET_EOD);
-\end{verbatim}
-\normalsize
-
-Thus the client will send multiple packets and signal to the server when all
-the packets have been sent by sending a zero length record.
+++ /dev/null
-%%
-%%
-
-\chapter{Platform Support}
-\label{_PlatformChapter}
-\index{Support!Platform}
-\index{Platform Support}
-\addcontentsline{toc}{section}{Platform Support}
-
-\section{General}
-\index{General }
-\addcontentsline{toc}{subsection}{General}
-
-This chapter describes the requirements for having a
-supported platform (Operating System). In general, Bacula is
-quite portable. It supports 32 and 64 bit architectures as well
-as bigendian and littleendian machines. For full
-support, the platform (Operating System) must implement POSIX Unix
-system calls. However, for File daemon support only, a small
-compatibility library can be written to support almost any
-architecture.
-
-Currently Linux, FreeBSD, and Solaris are fully supported
-platforms, which means that the code has been tested on those
-machines and passes a full set of regression tests.
-
-In addition, the Windows File daemon is supported on most versions
-of Windows, and finally, there are a number of other platforms
-where the File daemon (client) is known to run: NetBSD, OpenBSD,
-Mac OSX, SGI, ...
-
-\section{Requirements to become a Supported Platform}
-\index{Requirements!Platform}
-\index{Platform Requirements}
-\addcontentsline{toc}{subsection}{Platform Requirements}
-
-As mentioned above, in order to become a fully supported platform, it
-must support POSIX Unix system calls. In addition, the following
-requirements must be met:
-
-\begin{itemize}
-\item The principal developer (currently Kern) must have
- non-root ssh access to a test machine running the platform.
-\item The ideal requirements and minimum requirements
- for this machine are given below.
-\item There must be a defined platform champion who is normally
- a system administrator for the machine that is available. This
- person need not be a developer/programmer but must be familiar
- with system administration of the platform.
-\item There must be at least one person designated who will
- run regression tests prior to each release. Releases occur
- approximately once every 6 months, but can be more frequent.
- It takes at most a day's effort to setup the regression scripts
- in the beginning, and after that, they can either be run daily
- or on demand before a release. Running the regression scripts
- involves only one or two command line commands and is fully
- automated.
-\item Ideally there are one or more persons who will package
- each Bacula release.
-\item Ideally there are one or more developers who can respond to
- and fix platform specific bugs.
-\end{itemize}
-
-Ideal requirements for a test machine:
-\begin{itemize}
-\item The principal developer will have non-root ssh access to
- the test machine at all times.
-\item The pricipal developer will have a root password.
-\item The test machine will provide approximately 200 MB of
- disk space for continual use.
-\item The test machine will have approximately 500 MB of free
- disk space for temporary use.
-\item The test machine will run the most common version of the OS.
-\item The test machine will have an autochanger of DDS-4 technology
- or later having two or more tapes.
-\item The test machine will have MySQL and/or PostgreSQL database
- access for account "bacula" available.
-\item The test machine will have sftp access.
-\item The test machine will provide an smtp server.
-\end{itemize}
-
-Minimum requirements for a test machine:
-\begin{itemize}
-\item The principal developer will have non-root ssh access to
- the test machine when requested approximately once a month.
-\item The pricipal developer not have root access.
-\item The test machine will provide approximately 80 MB of
- disk space for continual use.
-\item The test machine will have approximately 300 MB of free
- disk space for temporary use.
-\item The test machine will run the the OS.
-\item The test machine will have a tape drive of DDS-4 technology
- or later that can be scheduled for access.
-\item The test machine will not have MySQL and/or PostgreSQL database
- access.
-\item The test machine will have no sftp access.
-\item The test machine will provide no email access.
-\end{itemize}
-
-Bare bones test machine requirements:
-\begin{itemize}
-\item The test machine is available only to a designated
- test person (your own machine).
-\item The designated test person runs the regession
- tests on demand.
-\item The test machine has a tape drive available.
-\end{itemize}
+++ /dev/null
-%%
-%%
-
-\chapter{Bacula Porting Notes}
-\label{_ChapterStart1}
-\index{Notes!Bacula Porting}
-\index{Bacula Porting Notes}
-\addcontentsline{toc}{section}{Bacula Porting Notes}
-
-This document is intended mostly for developers who wish to port Bacula to a
-system that is not {\bf officially} supported.
-
-It is hoped that Bacula clients will eventually run on every imaginable system
-that needs backing up (perhaps even a Palm). It is also hoped that the Bacula
-Directory and Storage daemons will run on every system capable of supporting
-them.
-
-\section{Porting Requirements}
-\index{Requirements!Porting}
-\index{Porting Requirements}
-\addcontentsline{toc}{section}{Porting Requirements}
-
-In General, the following holds true:
-
-\begin{itemize}
-\item {\bf Bacula} has been compiled and run on Linux RedHat, FreeBSD, and
- Solaris systems.
-\item In addition, clients exist on Win32, and Irix
-\item It requires GNU C++ to compile. You can try with other compilers, but
- you are on your own. The Irix client is built with the Irix complier, but, in
- general, you will need GNU.
-\item Your compiler must provide support for 64 bit signed and unsigned
- integers.
-\item You will need a recent copy of the {\bf autoconf} tools loaded on your
- system (version 2.13 or later). The {\bf autoconf} tools are used to build
- the configuration program, but are not part of the Bacula source
-distribution.
-\item There are certain third party packages that Bacula needs. Except for
- MySQL, they can all be found in the {\bf depkgs} and {\bf depkgs1} releases.
-\item To build the Win32 binaries, we use Microsoft VC++ standard
- 2003. Please see the instructions in
- bacula-source/src/win32/README.win32 for more details. If you
- want to use VC++ Express, please see README.vc8. Our build is
- done under the most recent version of Cygwin, but Cygwin is
- not used in the Bacula binaries that are produced.
- Unfortunately, we do not have the resources to help you build
- your own version of the Win32 FD, so you are pretty much on
- your own. You can ask the bacula-devel list for help, but
- please don't expect much.
-\item {\bf Bacula} requires a good implementation of pthreads to work.
-\item The source code has been written with portability in mind and is mostly
- POSIX compatible. Thus porting to any POSIX compatible operating system
- should be relatively easy.
-\end{itemize}
-
-\section{Steps to Take for Porting}
-\index{Porting!Steps to Take for}
-\index{Steps to Take for Porting}
-\addcontentsline{toc}{section}{Steps to Take for Porting}
-
-\begin{itemize}
-\item The first step is to ensure that you have version 2.13 or later of the
- {\bf autoconf} tools loaded. You can skip this step, but making changes to
- the configuration program will be difficult or impossible.
-\item The run a {\bf ./configure} command in the main source directory and
- examine the output. It should look something like the following:
-
-\footnotesize
-\begin{verbatim}
-Configuration on Mon Oct 28 11:42:27 CET 2002:
- Host: i686-pc-linux-gnu -- redhat 7.3
- Bacula version: 1.27 (26 October 2002)
- Source code location: .
- Install binaries: /sbin
- Install config files: /etc/bacula
- C Compiler: gcc
- C++ Compiler: c++
- Compiler flags: -g -O2
- Linker flags:
- Libraries: -lpthread
- Statically Linked Tools: no
- Database found: no
- Database type: Internal
- Database lib:
- Job Output Email: root@localhost
- Traceback Email: root@localhost
- SMTP Host Address: localhost
- Director Port 9101
- File daemon Port 9102
- Storage daemon Port 9103
- Working directory /etc/bacula/working
- SQL binaries Directory
- Large file support: yes
- readline support: yes
- cweb support: yes /home/kern/bacula/depkgs/cweb
- TCP Wrappers support: no
- ZLIB support: yes
- enable-smartalloc: yes
- enable-gnome: no
- gmp support: yes
-\end{verbatim}
-\normalsize
-
-The details depend on your system. The first thing to check is that it
-properly identified your host on the {\bf Host:} line. The first part (added
-in version 1.27) is the GNU four part identification of your system. The part
-after the -- is your system and the system version. Generally, if your system
-is not yet supported, you must correct these.
-\item If the {\bf ./configure} does not function properly, you must determine
- the cause and fix it. Generally, it will be because some required system
- routine is not available on your machine.
-\item To correct problems with detection of your system type or with routines
- and libraries, you must edit the file {\bf
- \lt{}bacula-src\gt{}/autoconf/configure.in}. This is the ``source'' from
-which {\bf configure} is built. In general, most of the changes for your
-system will be made in {\bf autoconf/aclocal.m4} in the routine {\bf
-BA\_CHECK\_OPSYS} or in the routine {\bf BA\_CHECK\_OPSYS\_DISTNAME}. I have
-already added the necessary code for most systems, but if yours shows up as
-{\bf unknown} you will need to make changes. Then as mentioned above, you
-will need to set a number of system dependent items in {\bf configure.in} in
-the {\bf case} statement at approximately line 1050 (depending on the Bacula
-release).
-\item The items to in the case statement that corresponds to your system are
- the following:
-
-\begin{itemize}
-\item DISTVER -- set to the version of your operating system. Typically some
- form of {\bf uname} obtains it.
-\item TAPEDRIVE -- the default tape drive. Not too important as the user can
- set it as an option.
-\item PSCMD -- set to the {\bf ps} command that will provide the PID in the
- first field and the program name in the second field. If this is not set
- properly, the {\bf bacula stop} script will most likely not be able to stop
-Bacula in all cases.
-\item hostname -- command to return the base host name (non-qualified) of
- your system. This is generally the machine name. Not too important as the
- user can correct this in his configuration file.
-\item CFLAGS -- set any special compiler flags needed. Many systems need a
- special flag to make pthreads work. See cygwin for an example.
-\item LDFLAGS -- set any special loader flags. See cygwin for an example.
-\item PTHREAD\_LIB -- set for any special pthreads flags needed during
- linking. See freebsd as an example.
-\item lld -- set so that a ``long long int'' will be properly edited in a
- printf() call.
-\item llu -- set so that a ``long long unsigned'' will be properly edited in
- a printf() call.
-\item PFILES -- set to add any files that you may define is your platform
- subdirectory. These files are used for installation of automatic system
- startup of Bacula daemons.
-\end{itemize}
-
-\item To rebuild a new version of {\bf configure} from a changed {\bf
- autoconf/configure.in} you enter {\bf make configure} in the top level Bacula
- source directory. You must have done a ./configure prior to trying to rebuild
- the configure script or it will get into an infinite loop.
-\item If the {\bf make configure} gets into an infinite loop, ctl-c it, then
- do {\bf ./configure} (no options are necessary) and retry the {\bf make
- configure}, which should now work.
-\item To rebuild {\bf configure} you will need to have {\bf autoconf} version
- 2.57-3 or higher loaded. Older versions of autoconf will complain about
- unknown or bad options, and won't work.
-\item After you have a working {\bf configure} script, you may need to make a
- few system dependent changes to the way Bacula works. Generally, these are
- done in {\bf src/baconfig.h}. You can find a few examples of system dependent
-changes toward the end of this file. For example, on Irix systems, there is
-no definition for {\bf socklen\_t}, so it is made in this file. If your
-system has structure alignment requirements, check the definition of BALIGN
-in this file. Currently, all Bacula allocated memory is aligned on a {\bf
-double} boundary.
-\item If you are having problems with Bacula's type definitions, you might
- look at {\bf src/bc\_types.h} where all the types such as {\bf uint32\_t},
- {\bf uint64\_t}, etc. that Bacula uses are defined.
-\end{itemize}
+++ /dev/null
-/*
- * html2latex
- */
-
-available {
- sun4_sunos.4
- sun4_solaris.2
- rs_aix.3
- rs_aix.4
- sgi_irix
-}
-
-description {
- From Jeffrey Schaefer, Geometry Center. Translates HTML document to LaTeX
-}
-
-install {
- bin/html2latex /afs/rpi.edu/dept/acs/rpinfo/filters/GChtml2latex/html2latex
- bin/html2latex.tag /afs/rpi.edu/dept/acs/rpinfo/filters/GChtml2latex/html2latex.tag
- bin/html2latex-local.tag /afs/rpi.edu/dept/acs/rpinfo/filters/GChtml2latex/html2latex-local.tag
- bin/webtex2latex.tag /afs/rpi.edu/dept/acs/rpinfo/filters/GChtml2latex/webtex2latex.tag
- man/man1/html2latex.1 /afs/rpi.edu/dept/acs/rpinfo/filters/GChtml2latex/html2latex.1
-}
+++ /dev/null
-%%
-%%
-
-\addcontentsline{lof}{figure}{Smart Memory Allocation with Orphaned Buffer
-Detection}
-\includegraphics{\idir smartall.eps}
-
-\chapter{Smart Memory Allocation}
-\label{_ChapterStart4}
-\index{Detection!Smart Memory Allocation With Orphaned Buffer }
-\index{Smart Memory Allocation With Orphaned Buffer Detection }
-\addcontentsline{toc}{section}{Smart Memory Allocation With Orphaned Buffer
-Detection}
-
-Few things are as embarrassing as a program that leaks, yet few errors are so
-easy to commit or as difficult to track down in a large, complicated program
-as failure to release allocated memory. SMARTALLOC replaces the standard C
-library memory allocation functions with versions which keep track of buffer
-allocations and releases and report all orphaned buffers at the end of program
-execution. By including this package in your program during development and
-testing, you can identify code that loses buffers right when it's added and
-most easily fixed, rather than as part of a crisis debugging push when the
-problem is identified much later in the testing cycle (or even worse, when the
-code is in the hands of a customer). When program testing is complete, simply
-recompiling with different flags removes SMARTALLOC from your program,
-permitting it to run without speed or storage penalties.
-
-In addition to detecting orphaned buffers, SMARTALLOC also helps to find other
-common problems in management of dynamic storage including storing before the
-start or beyond the end of an allocated buffer, referencing data through a
-pointer to a previously released buffer, attempting to release a buffer twice
-or releasing storage not obtained from the allocator, and assuming the initial
-contents of storage allocated by functions that do not guarantee a known
-value. SMARTALLOC's checking does not usually add a large amount of overhead
-to a program (except for programs which use {\tt realloc()} extensively; see
-below). SMARTALLOC focuses on proper storage management rather than internal
-consistency of the heap as checked by the malloc\_debug facility available on
-some systems. SMARTALLOC does not conflict with malloc\_debug and both may be
-used together, if you wish. SMARTALLOC makes no assumptions regarding the
-internal structure of the heap and thus should be compatible with any C
-language implementation of the standard memory allocation functions.
-
-\subsection{ Installing SMARTALLOC}
-\index{SMARTALLOC!Installing }
-\index{Installing SMARTALLOC }
-\addcontentsline{toc}{subsection}{Installing SMARTALLOC}
-
-SMARTALLOC is provided as a Zipped archive,
-\elink{smartall.zip}{http://www.fourmilab.ch/smartall/smartall.zip}; see the
-download instructions below.
-
-To install SMARTALLOC in your program, simply add the statement:
-
-to every C program file which calls any of the memory allocation functions
-({\tt malloc}, {\tt calloc}, {\tt free}, etc.). SMARTALLOC must be used for
-all memory allocation with a program, so include file for your entire program,
-if you have such a thing. Next, define the symbol SMARTALLOC in the
-compilation before the inclusion of smartall.h. I usually do this by having my
-Makefile add the ``{\tt -DSMARTALLOC}'' option to the C compiler for
-non-production builds. You can define the symbol manually, if you prefer, by
-adding the statement:
-
-{\tt \#define SMARTALLOC}
-
-At the point where your program is all done and ready to relinquish control to
-the operating system, add the call:
-
-{\tt \ \ \ \ \ \ \ \ sm\_dump(}{\it datadump}{\tt );}
-
-where {\it datadump} specifies whether the contents of orphaned buffers are to
-be dumped in addition printing to their size and place of allocation. The data
-are dumped only if {\it datadump} is nonzero, so most programs will normally
-use ``{\tt sm\_dump(0);}''. If a mysterious orphaned buffer appears that can't
-be identified from the information this prints about it, replace the statement
-with ``{\tt sm\_dump(1)};''. Usually the dump of the buffer's data will
-furnish the additional clues you need to excavate and extirpate the elusive
-error that left the buffer allocated.
-
-Finally, add the files ``smartall.h'' and ``smartall.c'' from this release to
-your source directory, make dependencies, and linker input. You needn't make
-inclusion of smartall.c in your link optional; if compiled with SMARTALLOC not
-defined it generates no code, so you may always include it knowing it will
-waste no storage in production builds. Now when you run your program, if it
-leaves any buffers around when it's done, each will be reported by {\tt
-sm\_dump()} on stderr as follows:
-
-\footnotesize
-\begin{verbatim}
-Orphaned buffer: 120 bytes allocated at line 50 of gutshot.c
-\end{verbatim}
-\normalsize
-
-\subsection{ Squelching a SMARTALLOC}
-\index{SMARTALLOC!Squelching a }
-\index{Squelching a SMARTALLOC }
-\addcontentsline{toc}{subsection}{Squelching a SMARTALLOC}
-
-Usually, when you first install SMARTALLOC in an existing program you'll find
-it nattering about lots of orphaned buffers. Some of these turn out to be
-legitimate errors, but some are storage allocated during program
-initialisation that, while dynamically allocated, is logically static storage
-not intended to be released. Of course, you can get rid of the complaints
-about these buffers by adding code to release them, but by doing so you're
-adding unnecessary complexity and code size to your program just to silence
-the nattering of a SMARTALLOC, so an escape hatch is provided to eliminate the
-need to release these buffers.
-
-Normally all storage allocated with the functions {\tt malloc()}, {\tt
-calloc()}, and {\tt realloc()} is monitored by SMARTALLOC. If you make the
-function call:
-
-\footnotesize
-\begin{verbatim}
- sm_static(1);
-\end{verbatim}
-\normalsize
-
-you declare that subsequent storage allocated by {\tt malloc()}, {\tt
-calloc()}, and {\tt realloc()} should not be considered orphaned if found to
-be allocated when {\tt sm\_dump()} is called. I use a call on ``{\tt
-sm\_static(1);}'' before I allocate things like program configuration tables
-so I don't have to add code to release them at end of program time. After
-allocating unmonitored data this way, be sure to add a call to:
-
-\footnotesize
-\begin{verbatim}
- sm_static(0);
-\end{verbatim}
-\normalsize
-
-to resume normal monitoring of buffer allocations. Buffers allocated while
-{\tt sm\_static(1}) is in effect are not checked for having been orphaned but
-all the other safeguards provided by SMARTALLOC remain in effect. You may
-release such buffers, if you like; but you don't have to.
-
-\subsection{ Living with Libraries}
-\index{Libraries!Living with }
-\index{Living with Libraries }
-\addcontentsline{toc}{subsection}{Living with Libraries}
-
-Some library functions for which source code is unavailable may gratuitously
-allocate and return buffers that contain their results, or require you to pass
-them buffers which they subsequently release. If you have source code for the
-library, by far the best approach is to simply install SMARTALLOC in it,
-particularly since this kind of ill-structured dynamic storage management is
-the source of so many storage leaks. Without source code, however, there's no
-option but to provide a way to bypass SMARTALLOC for the buffers the library
-allocates and/or releases with the standard system functions.
-
-For each function {\it xxx} redefined by SMARTALLOC, a corresponding routine
-named ``{\tt actually}{\it xxx}'' is furnished which provides direct access to
-the underlying system function, as follows:
-
-\begin{quote}
-
-\begin{longtable}{ll}
-\multicolumn{1}{l }{\bf Standard function } & \multicolumn{1}{l }{\bf Direct
-access function } \\
-{{\tt malloc(}{\it size}{\tt )} } & {{\tt actuallymalloc(}{\it size}{\tt )}
-} \\
-{{\tt calloc(}{\it nelem}{\tt ,} {\it elsize}{\tt )} } & {{\tt
-actuallycalloc(}{\it nelem}, {\it elsize}{\tt )} } \\
-{{\tt realloc(}{\it ptr}{\tt ,} {\it size}{\tt )} } & {{\tt
-actuallyrealloc(}{\it ptr}, {\it size}{\tt )} } \\
-{{\tt free(}{\it ptr}{\tt )} } & {{\tt actuallyfree(}{\it ptr}{\tt )} }
-
-\end{longtable}
-
-\end{quote}
-
-For example, suppose there exists a system library function named ``{\tt
-getimage()}'' which reads a raster image file and returns the address of a
-buffer containing it. Since the library routine allocates the image directly
-with {\tt malloc()}, you can't use SMARTALLOC's {\tt free()}, as that call
-expects information placed in the buffer by SMARTALLOC's special version of
-{\tt malloc()}, and hence would report an error. To release the buffer you
-should call {\tt actuallyfree()}, as in this code fragment:
-
-\footnotesize
-\begin{verbatim}
- struct image *ibuf = getimage("ratpack.img");
- display_on_screen(ibuf);
- actuallyfree(ibuf);
-\end{verbatim}
-\normalsize
-
-Conversely, suppose we are to call a library function, ``{\tt putimage()}'',
-which writes an image buffer into a file and then releases the buffer with
-{\tt free()}. Since the system {\tt free()} is being called, we can't pass a
-buffer allocated by SMARTALLOC's allocation routines, as it contains special
-information that the system {\tt free()} doesn't expect to be there. The
-following code uses {\tt actuallymalloc()} to obtain the buffer passed to such
-a routine.
-
-\footnotesize
-\begin{verbatim}
- struct image *obuf =
- (struct image *) actuallymalloc(sizeof(struct image));
- dump_screen_to_image(obuf);
- putimage("scrdump.img", obuf); /* putimage() releases obuf */
-\end{verbatim}
-\normalsize
-
-It's unlikely you'll need any of the ``actually'' calls except under very odd
-circumstances (in four products and three years, I've only needed them once),
-but they're there for the rare occasions that demand them. Don't use them to
-subvert the error checking of SMARTALLOC; if you want to disable orphaned
-buffer detection, use the {\tt sm\_static(1)} mechanism described above. That
-way you don't forfeit all the other advantages of SMARTALLOC as you do when
-using {\tt actuallymalloc()} and {\tt actuallyfree()}.
-
-\subsection{ SMARTALLOC Details}
-\index{SMARTALLOC Details }
-\index{Details!SMARTALLOC }
-\addcontentsline{toc}{subsection}{SMARTALLOC Details}
-
-When you include ``smartall.h'' and define SMARTALLOC, the following standard
-system library functions are redefined with the \#define mechanism to call
-corresponding functions within smartall.c instead. (For details of the
-redefinitions, please refer to smartall.h.)
-
-\footnotesize
-\begin{verbatim}
- void *malloc(size_t size)
- void *calloc(size_t nelem, size_t elsize)
- void *realloc(void *ptr, size_t size)
- void free(void *ptr)
- void cfree(void *ptr)
-\end{verbatim}
-\normalsize
-
-{\tt cfree()} is a historical artifact identical to {\tt free()}.
-
-In addition to allocating storage in the same way as the standard library
-functions, the SMARTALLOC versions expand the buffers they allocate to include
-information that identifies where each buffer was allocated and to chain all
-allocated buffers together. When a buffer is released, it is removed from the
-allocated buffer chain. A call on {\tt sm\_dump()} is able, by scanning the
-chain of allocated buffers, to find all orphaned buffers. Buffers allocated
-while {\tt sm\_static(1)} is in effect are specially flagged so that, despite
-appearing on the allocated buffer chain, {\tt sm\_dump()} will not deem them
-orphans.
-
-When a buffer is allocated by {\tt malloc()} or expanded with {\tt realloc()},
-all bytes of newly allocated storage are set to the hexadecimal value 0x55
-(alternating one and zero bits). Note that for {\tt realloc()} this applies
-only to the bytes added at the end of buffer; the original contents of the
-buffer are not modified. Initializing allocated storage to a distinctive
-nonzero pattern is intended to catch code that erroneously assumes newly
-allocated buffers are cleared to zero; in fact their contents are random. The
-{\tt calloc()} function, defined as returning a buffer cleared to zero,
-continues to zero its buffers under SMARTALLOC.
-
-Buffers obtained with the SMARTALLOC functions contain a special sentinel byte
-at the end of the user data area. This byte is set to a special key value
-based upon the buffer's memory address. When the buffer is released, the key
-is tested and if it has been overwritten an assertion in the {\tt free}
-function will fail. This catches incorrect program code that stores beyond the
-storage allocated for the buffer. At {\tt free()} time the queue links are
-also validated and an assertion failure will occur if the program has
-destroyed them by storing before the start of the allocated storage.
-
-In addition, when a buffer is released with {\tt free()}, its contents are
-immediately destroyed by overwriting them with the hexadecimal pattern 0xAA
-(alternating bits, the one's complement of the initial value pattern). This
-will usually trip up code that keeps a pointer to a buffer that's been freed
-and later attempts to reference data within the released buffer. Incredibly,
-this is {\it legal} in the standard Unix memory allocation package, which
-permits programs to free() buffers, then raise them from the grave with {\tt
-realloc()}. Such program ``logic'' should be fixed, not accommodated, and
-SMARTALLOC brooks no such Lazarus buffer`` nonsense.
-
-Some C libraries allow a zero size argument in calls to {\tt malloc()}. Since
-this is far more likely to indicate a program error than a defensible
-programming stratagem, SMARTALLOC disallows it with an assertion.
-
-When the standard library {\tt realloc()} function is called to expand a
-buffer, it attempts to expand the buffer in place if possible, moving it only
-if necessary. Because SMARTALLOC must place its own private storage in the
-buffer and also to aid in error detection, its version of {\tt realloc()}
-always moves and copies the buffer except in the trivial case where the size
-of the buffer is not being changed. By forcing the buffer to move on every
-call and destroying the contents of the old buffer when it is released,
-SMARTALLOC traps programs which keep pointers into a buffer across a call on
-{\tt realloc()} which may move it. This strategy may prove very costly to
-programs which make extensive use of {\tt realloc()}. If this proves to be a
-problem, such programs may wish to use {\tt actuallymalloc()}, {\tt
-actuallyrealloc()}, and {\tt actuallyfree()} for such frequently-adjusted
-buffers, trading error detection for performance. Although not specified in
-the System V Interface Definition, many C library implementations of {\tt
-realloc()} permit an old buffer argument of NULL, causing {\tt realloc()} to
-allocate a new buffer. The SMARTALLOC version permits this.
-
-\subsection{ When SMARTALLOC is Disabled}
-\index{When SMARTALLOC is Disabled }
-\index{Disabled!When SMARTALLOC is }
-\addcontentsline{toc}{subsection}{When SMARTALLOC is Disabled}
-
-When SMARTALLOC is disabled by compiling a program with the symbol SMARTALLOC
-not defined, calls on the functions otherwise redefined by SMARTALLOC go
-directly to the system functions. In addition, compile-time definitions
-translate calls on the ''{\tt actually}...{\tt ()}`` functions into the
-corresponding library calls; ''{\tt actuallymalloc(100)}``, for example,
-compiles into ''{\tt malloc(100)}``. The two special SMARTALLOC functions,
-{\tt sm\_dump()} and {\tt sm\_static()}, are defined to generate no code
-(hence the null statement). Finally, if SMARTALLOC is not defined, compilation
-of the file smartall.c generates no code or data at all, effectively removing
-it from the program even if named in the link instructions.
-
-Thus, except for unusual circumstances, a program that works with SMARTALLOC
-defined for testing should require no changes when built without it for
-production release.
-
-\subsection{ The {\tt alloc()} Function}
-\index{Function!alloc }
-\index{Alloc() Function }
-\addcontentsline{toc}{subsection}{alloc() Function}
-
-Many programs I've worked on use very few direct calls to {\tt malloc()},
-using the identically declared {\tt alloc()} function instead. Alloc detects
-out-of-memory conditions and aborts, removing the need for error checking on
-every call of {\tt malloc()} (and the temptation to skip checking for
-out-of-memory).
-
-As a convenience, SMARTALLOC supplies a compatible version of {\tt alloc()} in
-the file alloc.c, with its definition in the file alloc.h. This version of
-{\tt alloc()} is sensitive to the definition of SMARTALLOC and cooperates with
-SMARTALLOC's orphaned buffer detection. In addition, when SMARTALLOC is
-defined and {\tt alloc()} detects an out of memory condition, it takes
-advantage of the SMARTALLOC diagnostic information to identify the file and
-line number of the call on {\tt alloc()} that failed.
-
-\subsection{ Overlays and Underhandedness}
-\index{Underhandedness!Overlays and }
-\index{Overlays and Underhandedness }
-\addcontentsline{toc}{subsection}{Overlays and Underhandedness}
-
-String constants in the C language are considered to be static arrays of
-characters accessed through a pointer constant. The arrays are potentially
-writable even though their pointer is a constant. SMARTALLOC uses the
-compile-time definition {\tt ./smartall.wml} to obtain the name of the file in
-which a call on buffer allocation was performed. Rather than reserve space in
-a buffer to save this information, SMARTALLOC simply stores the pointer to the
-compiled-in text of the file name. This works fine as long as the program does
-not overlay its data among modules. If data are overlayed, the area of memory
-which contained the file name at the time it was saved in the buffer may
-contain something else entirely when {\tt sm\_dump()} gets around to using the
-pointer to edit the file name which allocated the buffer.
-
-If you want to use SMARTALLOC in a program with overlayed data, you'll have to
-modify smartall.c to either copy the file name to a fixed-length field added
-to the {\tt abufhead} structure, or else allocate storage with {\tt malloc()},
-copy the file name there, and set the {\tt abfname} pointer to that buffer,
-then remember to release the buffer in {\tt sm\_free}. Either of these
-approaches are wasteful of storage and time, and should be considered only if
-there is no alternative. Since most initial debugging is done in non-overlayed
-environments, the restrictions on SMARTALLOC with data overlaying may never
-prove a problem. Note that conventional overlaying of code, by far the most
-common form of overlaying, poses no problems for SMARTALLOC; you need only be
-concerned if you're using exotic tools for data overlaying on MS-DOS or other
-address-space-challenged systems.
-
-Since a C language ''constant`` string can actually be written into, most C
-compilers generate a unique copy of each string used in a module, even if the
-same constant string appears many times. In modules that contain many calls on
-allocation functions, this results in substantial wasted storage for the
-strings that identify the file name. If your compiler permits optimization of
-multiple occurrences of constant strings, enabling this mode will eliminate
-the overhead for these strings. Of course, it's up to you to make sure
-choosing this compiler mode won't wreak havoc on some other part of your
-program.
-
-\subsection{ Test and Demonstration Program}
-\index{Test and Demonstration Program }
-\index{Program!Test and Demonstration }
-\addcontentsline{toc}{subsection}{Test and Demonstration Program}
-
-A test and demonstration program, smtest.c, is supplied with SMARTALLOC. You
-can build this program with the Makefile included. Please refer to the
-comments in smtest.c and the Makefile for information on this program. If
-you're attempting to use SMARTALLOC on a new machine or with a new compiler or
-operating system, it's a wise first step to check it out with smtest first.
-
-\subsection{ Invitation to the Hack}
-\index{Hack!Invitation to the }
-\index{Invitation to the Hack }
-\addcontentsline{toc}{subsection}{Invitation to the Hack}
-
-SMARTALLOC is not intended to be a panacea for storage management problems,
-nor is it universally applicable or effective; it's another weapon in the
-arsenal of the defensive professional programmer attempting to create reliable
-products. It represents the current state of evolution of expedient debug code
-which has been used in several commercial software products which have,
-collectively, sold more than third of a million copies in the retail market,
-and can be expected to continue to develop through time as it is applied to
-ever more demanding projects.
-
-The version of SMARTALLOC here has been tested on a Sun SPARCStation, Silicon
-Graphics Indigo2, and on MS-DOS using both Borland and Microsoft C. Moving
-from compiler to compiler requires the usual small changes to resolve disputes
-about prototyping of functions, whether the type returned by buffer allocation
-is {\tt char\ *} or {\tt void\ *}, and so forth, but following those changes
-it works in a variety of environments. I hope you'll find SMARTALLOC as useful
-for your projects as I've found it in mine.
-
-\section{
-\elink{}{http://www.fourmilab.ch/smartall/smartall.zip}
-\elink{Download smartall.zip}{http://www.fourmilab.ch/smartall/smartall.zip}
-(Zipped archive)}
-\index{Archive! Download smartall.zip Zipped }
-\index{ Download smartall.zip (Zipped archive) }
-\addcontentsline{toc}{section}{ Download smartall.zip (Zipped archive)}
-
-SMARTALLOC is provided as
-\elink{smartall.zip}{http://www.fourmilab.ch/smartall/smartall.zip}, a
-\elink{Zipped}{http://www.pkware.com/} archive containing source code,
-documentation, and a {\tt Makefile} to build the software under Unix.
-
-\subsection{ Copying}
-\index{Copying }
-\addcontentsline{toc}{subsection}{Copying}
-
-\begin{quote}
-SMARTALLOC is in the public domain. Permission to use, copy, modify, and
-distribute this software and its documentation for any purpose and without fee
-is hereby granted, without any conditions or restrictions. This software is
-provided ''as is`` without express or implied warranty.
-\end{quote}
-
-{\it
-\elink{by John Walker}{http://www.fourmilab.ch}
-October 30th, 1998 }
+++ /dev/null
-%%
-%%
-
-\chapter{Storage Daemon Design}
-\label{_ChapterStart3}
-\index{Storage Daemon Design }
-\index{Design!Storage Daemon }
-\addcontentsline{toc}{section}{Storage Daemon Design}
-
-This chapter is intended to be a technical discussion of the Storage daemon
-services and as such is not targeted at end users but rather at developers and
-system administrators that want or need to know more of the working details of
-{\bf Bacula}.
-
-This document is somewhat out of date.
-
-\section{SD Design Introduction}
-\index{Introduction!SD Design }
-\index{SD Design Introduction }
-\addcontentsline{toc}{section}{SD Design Introduction}
-
-The Bacula Storage daemon provides storage resources to a Bacula installation.
-An individual Storage daemon is associated with a physical permanent storage
-device (for example, a tape drive, CD writer, tape changer or jukebox, etc.),
-and may employ auxiliary storage resources (such as space on a hard disk file
-system) to increase performance and/or optimize use of the permanent storage
-medium.
-
-Any number of storage daemons may be run on a given machine; each associated
-with an individual storage device connected to it, and BACULA operations may
-employ storage daemons on any number of hosts connected by a network, local or
-remote. The ability to employ remote storage daemons (with appropriate
-security measures) permits automatic off-site backup, possibly to publicly
-available backup repositories.
-
-\section{SD Development Outline}
-\index{Outline!SD Development }
-\index{SD Development Outline }
-\addcontentsline{toc}{section}{SD Development Outline}
-
-In order to provide a high performance backup and restore solution that scales
-to very large capacity devices and networks, the storage daemon must be able
-to extract as much performance from the storage device and network with which
-it interacts. In order to accomplish this, storage daemons will eventually
-have to sacrifice simplicity and painless portability in favor of techniques
-which improve performance. My goal in designing the storage daemon protocol
-and developing the initial prototype storage daemon is to provide for these
-additions in the future, while implementing an initial storage daemon which is
-very simple and portable to almost any POSIX-like environment. This original
-storage daemon (and its evolved descendants) can serve as a portable solution
-for non-demanding backup requirements (such as single servers of modest size,
-individual machines, or small local networks), while serving as the starting
-point for development of higher performance configurable derivatives which use
-techniques such as POSIX threads, shared memory, asynchronous I/O, buffering
-to high-speed intermediate media, and support for tape changers and jukeboxes.
-
-
-\section{SD Connections and Sessions}
-\index{Sessions!SD Connections and }
-\index{SD Connections and Sessions }
-\addcontentsline{toc}{section}{SD Connections and Sessions}
-
-A client connects to a storage server by initiating a conventional TCP
-connection. The storage server accepts the connection unless its maximum
-number of connections has been reached or the specified host is not granted
-access to the storage server. Once a connection has been opened, the client
-may make any number of Query requests, and/or initiate (if permitted), one or
-more Append sessions (which transmit data to be stored by the storage daemon)
-and/or Read sessions (which retrieve data from the storage daemon).
-
-Most requests and replies sent across the connection are simple ASCII strings,
-with status replies prefixed by a four digit status code for easier parsing.
-Binary data appear in blocks stored and retrieved from the storage. Any
-request may result in a single-line status reply of ``{\tt 3201\ Notification\
-pending}'', which indicates the client must send a ``Query notification''
-request to retrieve one or more notifications posted to it. Once the
-notifications have been returned, the client may then resubmit the request
-which resulted in the 3201 status.
-
-The following descriptions omit common error codes, yet to be defined, which
-can occur from most or many requests due to events like media errors,
-restarting of the storage daemon, etc. These details will be filled in, along
-with a comprehensive list of status codes along with which requests can
-produce them in an update to this document.
-
-\subsection{SD Append Requests}
-\index{Requests!SD Append }
-\index{SD Append Requests }
-\addcontentsline{toc}{subsection}{SD Append Requests}
-
-\begin{description}
-
-\item [{append open session = \lt{}JobId\gt{} [ \lt{}Password\gt{} ] }]
- \index{SPAN class }
- A data append session is opened with the Job ID given by {\it JobId} with
-client password (if required) given by {\it Password}. If the session is
-successfully opened, a status of {\tt 3000\ OK} is returned with a ``{\tt
-ticket\ =\ }{\it number}'' reply used to identify subsequent messages in the
-session. If too many sessions are open, or a conflicting session (for
-example, a read in progress when simultaneous read and append sessions are
-not permitted), a status of ``{\tt 3502\ Volume\ busy}'' is returned. If no
-volume is mounted, or the volume mounted cannot be appended to, a status of
-``{\tt 3503\ Volume\ not\ mounted}'' is returned.
-
-\item [append data = \lt{}ticket-number\gt{} ]
- \index{SPAN class }
- If the append data is accepted, a status of {\tt 3000\ OK data address =
-\lt{}IPaddress\gt{} port = \lt{}port\gt{}} is returned, where the {\tt
-IPaddress} and {\tt port} specify the IP address and port number of the data
-channel. Error status codes are {\tt 3504\ Invalid\ ticket\ number} and {\tt
-3505\ Session\ aborted}, the latter of which indicates the entire append
-session has failed due to a daemon or media error.
-
-Once the File daemon has established the connection to the data channel
-opened by the Storage daemon, it will transfer a header packet followed by
-any number of data packets. The header packet is of the form:
-
-{\tt \lt{}file-index\gt{} \lt{}stream-id\gt{} \lt{}info\gt{}}
-
-The details are specified in the
-\ilink{Daemon Protocol}{_ChapterStart2} section of this
-document.
-
-\item [*append abort session = \lt{}ticket-number\gt{} ]
- \index{SPAN class }
- The open append session with ticket {\it ticket-number} is aborted; any blocks
-not yet written to permanent media are discarded. Subsequent attempts to
-append data to the session will receive an error status of {\tt 3505\
-Session\ aborted}.
-
-\item [append end session = \lt{}ticket-number\gt{} ]
- \index{SPAN class }
- The open append session with ticket {\it ticket-number} is marked complete; no
-further blocks may be appended. The storage daemon will give priority to
-saving any buffered blocks from this session to permanent media as soon as
-possible.
-
-\item [append close session = \lt{}ticket-number\gt{} ]
- \index{SPAN class }
- The append session with ticket {\it ticket} is closed. This message does not
-receive an {\tt 3000\ OK} reply until all of the content of the session are
-stored on permanent media, at which time said reply is given, followed by a
-list of volumes, from first to last, which contain blocks from the session,
-along with the first and last file and block on each containing session data
-and the volume session key identifying data from that session in lines with
-the following format:
-
-{\tt {\tt Volume = }\lt{}Volume-id\gt{} \lt{}start-file\gt{}
-\lt{}start-block\gt{} \lt{}end-file\gt{} \lt{}end-block\gt{}
-\lt{}volume-session-id\gt{}}where {\it Volume-id} is the volume label, {\it
-start-file} and {\it start-block} are the file and block containing the first
-data from that session on the volume, {\it end-file} and {\it end-block} are
-the file and block with the last data from the session on the volume and {\it
-volume-session-id} is the volume session ID for blocks from the session
-stored on that volume.
-\end{description}
-
-\subsection{SD Read Requests}
-\index{SD Read Requests }
-\index{Requests!SD Read }
-\addcontentsline{toc}{subsection}{SD Read Requests}
-
-\begin{description}
-
-\item [Read open session = \lt{}JobId\gt{} \lt{}Volume-id\gt{}
- \lt{}start-file\gt{} \lt{}start-block\gt{} \lt{}end-file\gt{}
- \lt{}end-block\gt{} \lt{}volume-session-id\gt{} \lt{}password\gt{} ]
-\index{SPAN class }
-where {\it Volume-id} is the volume label, {\it start-file} and {\it
-start-block} are the file and block containing the first data from that
-session on the volume, {\it end-file} and {\it end-block} are the file and
-block with the last data from the session on the volume and {\it
-volume-session-id} is the volume session ID for blocks from the session
-stored on that volume.
-
-If the session is successfully opened, a status of
-
-{\tt {\tt 3100\ OK Ticket\ =\ }{\it number}``}
-
-is returned with a reply used to identify subsequent messages in the session.
-If too many sessions are open, or a conflicting session (for example, an
-append in progress when simultaneous read and append sessions are not
-permitted), a status of ''{\tt 3502\ Volume\ busy}`` is returned. If no
-volume is mounted, or the volume mounted cannot be appended to, a status of
-''{\tt 3503\ Volume\ not\ mounted}`` is returned. If no block with the given
-volume session ID and the correct client ID number appears in the given first
-file and block for the volume, a status of ''{\tt 3505\ Session\ not\
-found}`` is returned.
-
-\item [Read data = \lt{}Ticket\gt{} \gt{} \lt{}Block\gt{} ]
- \index{SPAN class }
- The specified Block of data from open read session with the specified Ticket
-number is returned, with a status of {\tt 3000\ OK} followed by a ''{\tt
-Length\ =\ }{\it size}`` line giving the length in bytes of the block data
-which immediately follows. Blocks must be retrieved in ascending order, but
-blocks may be skipped. If a block number greater than the largest stored on
-the volume is requested, a status of ''{\tt 3201\ End\ of\ volume}`` is
-returned. If a block number greater than the largest in the file is
-requested, a status of ''{\tt 3401\ End\ of\ file}`` is returned.
-
-\item [Read close session = \lt{}Ticket\gt{} ]
- \index{SPAN class }
- The read session with Ticket number is closed. A read session may be closed
-at any time; you needn't read all its blocks before closing it.
-\end{description}
-
-{\it by
-\elink{John Walker}{http://www.fourmilab.ch/}
-January 30th, MM }
-
-\section{SD Data Structures}
-\index{SD Data Structures}
-\addcontentsline{toc}{section}{SD Data Structures}
-
-In the Storage daemon, there is a Device resource (i.e. from conf file)
-that describes each physical device. When the physical device is used it
-is controled by the DEVICE structure (defined in dev.h), and typically
-refered to as dev in the C++ code. Anyone writing or reading a physical
-device must ultimately get a lock on the DEVICE structure -- this controls
-the device. However, multiple Jobs (defined by a JCR structure src/jcr.h)
-can be writing a physical DEVICE at the same time (of course they are
-sequenced by locking the DEVICE structure). There are a lot of job
-dependent "device" variables that may be different for each Job such as
-spooling (one job may spool and another may not, and when a job is
-spooling, it must have an i/o packet open, each job has its own record and
-block structures, ...), so there is a device control record or DCR that is
-the primary way of interfacing to the physical device. The DCR contains
-all the job specific data as well as a pointer to the Device resource
-(DEVRES structure) and the physical DEVICE structure.
-
-Now if a job is writing to two devices (it could be writing two separate
-streams to the same device), it must have two DCRs. Today, the code only
-permits one. This won't be hard to change, but it is new code.
-
-Today three jobs (threads), two physical devices each job
- writes to only one device:
-
-\begin{verbatim}
- Job1 -> DCR1 -> DEVICE1
- Job2 -> DCR2 -> DEVICE1
- Job3 -> DCR3 -> DEVICE2
-\end{verbatim}
-
-To be implemented three jobs, three physical devices, but
- job1 is writing simultaneously to three devices:
-
-\begin{verbatim}
- Job1 -> DCR1 -> DEVICE1
- -> DCR4 -> DEVICE2
- -> DCR5 -> DEVICE3
- Job2 -> DCR2 -> DEVICE1
- Job3 -> DCR3 -> DEVICE2
-
- Job = job control record
- DCR = Job contorl data for a specific device
- DEVICE = Device only control data
-\end{verbatim}
-
+++ /dev/null
-%%
-%%
-
-%\author{Landon Fuller}
-%\title{Bacula TLS Additions}
-
-\chapter{TLS}
-\label{_Chapter_TLS}
-\index{TLS}
-
-Written by Landon Fuller
-
-\section{Introduction to TLS}
-\index{TLS Introduction}
-\index{Introduction!TLS}
-\addcontentsline{toc}{section}{TLS Introduction}
-
-This patch includes all the back-end code necessary to add complete TLS
-data encryption support to Bacula. In addition, support for TLS in
-Console/Director communications has been added as a proof of concept.
-Adding support for the remaining daemons will be straight-forward.
-Supported features of this patchset include:
-
-\begin{itemize}
-\item Client/Server TLS Requirement Negotiation
-\item TLSv1 Connections with Server and Client Certificate
-Validation
-\item Forward Secrecy Support via Diffie-Hellman Ephemeral Keying
-\end{itemize}
-
-This document will refer to both ``server'' and ``client'' contexts. These
-terms refer to the accepting and initiating peer, respectively.
-
-Diffie-Hellman anonymous ciphers are not supported by this patchset. The
-use of DH anonymous ciphers increases the code complexity and places
-explicit trust upon the two-way Cram-MD5 implementation. Cram-MD5 is
-subject to known plaintext attacks, and is should be considered
-considerably less secure than PKI certificate-based authentication.
-
-Appropriate autoconf macros have been added to detect and use OpenSSL. Two
-additional preprocessor defines have been added: \emph{HAVE\_TLS} and
-\emph{HAVE\_OPENSSL}. All changes not specific to OpenSSL rely on
-\emph{HAVE\_TLS}. OpenSSL-specific code is constrained to
-\emph{src/lib/tls.c} to facilitate the support of alternative TLS
-implementations.
-
-\section{New Configuration Directives}
-\index{TLS Configuration Directives}
-\index{Directives!TLS Configuration}
-\addcontentsline{toc}{section}{New Configuration Directives}
-
-Additional configuration directives have been added to both the Console and
-Director resources. These new directives are defined as follows:
-
-\begin{itemize}
-\item \underline{TLS Enable} \emph{(yes/no)}
-Enable TLS support.
-
-\item \underline{TLS Require} \emph{(yes/no)}
-Require TLS connections.
-
-\item \underline{TLS Certificate} \emph{(path)}
-Path to PEM encoded TLS certificate. Used as either a client or server
-certificate.
-
-\item \underline{TLS Key} \emph{(path)}
-Path to PEM encoded TLS private key. Must correspond with the TLS
-certificate.
-
-\item \underline{TLS Verify Peer} \emph{(yes/no)}
-Verify peer certificate. Instructs server to request and verify the
-client's x509 certificate. Any client certificate signed by a known-CA
-will be accepted unless the TLS Allowed CN configuration directive is used.
-Not valid in a client context.
-
-\item \underline{TLS Allowed CN} \emph{(string list)}
-Common name attribute of allowed peer certificates. If directive is
-specified, all client certificates will be verified against this list.
-This directive may be specified more than once. Not valid in a client
-context.
-
-\item \underline{TLS CA Certificate File} \emph{(path)}
-Path to PEM encoded TLS CA certificate(s). Multiple certificates are
-permitted in the file. One of \emph{TLS CA Certificate File} or \emph{TLS
-CA Certificate Dir} are required in a server context if \underline{TLS
-Verify Peer} is also specified, and are always required in a client
-context.
-
-\item \underline{TLS CA Certificate Dir} \emph{(path)}
-Path to TLS CA certificate directory. In the current implementation,
-certificates must be stored PEM encoded with OpenSSL-compatible hashes.
-One of \emph{TLS CA Certificate File} or \emph{TLS CA Certificate Dir} are
-required in a server context if \emph{TLS Verify Peer} is also specified,
-and are always required in a client context.
-
-\item \underline{TLS DH File} \emph{(path)}
-Path to PEM encoded Diffie-Hellman parameter file. If this directive is
-specified, DH ephemeral keying will be enabled, allowing for forward
-secrecy of communications. This directive is only valid within a server
-context. To generate the parameter file, you may use openssl:
-\footnotesize
-\begin{verbatim}
-openssl dhparam -out dh1024.pem -5 1024
-\end{verbatim}
-\normalsize
-\end{itemize}
-
-\section{TLS API Implementation}
-\index{TLS API Implimentation}
-\index{API Implimentation!TLS}
-\addcontentsline{toc}{section}{TLS API Implementation}
-
-To facilitate the use of additional TLS libraries, all OpenSSL-specific
-code has been implemented within \emph{src/lib/tls.c}. In turn, a generic
-TLS API is exported.
-
-\subsection{Library Initialization and Cleanup}
-\index{Library Initialization and Cleanup}
-\index{Initialization and Cleanup!Library}
-\addcontentsline{toc}{subsection}{Library Initialization and Cleanup}
-
-\footnotesize
-\begin{verbatim}
-int init_tls (void);
-\end{verbatim}
-\normalsize
-
-Performs TLS library initialization, including seeding of the PRNG. PRNG
-seeding has not yet been implemented for win32.
-
-\footnotesize
-\begin{verbatim}
-int cleanup_tls (void);
-\end{verbatim}
-\normalsize
-
-Performs TLS library cleanup.
-
-\subsection{Manipulating TLS Contexts}
-\index{TLS Context Manipulation}
-\index{Contexts!Manipulating TLS}
-\addcontentsline{toc}{subsection}{Manipulating TLS Contexts}
-
-\footnotesize
-\begin{verbatim}
-TLS_CONTEXT *new_tls_context (const char *ca_certfile,
- const char *ca_certdir, const char *certfile,
- const char *keyfile, const char *dhfile, bool verify_peer);
-\end{verbatim}
-\normalsize
-
-Allocates and initalizes a new opaque \emph{TLS\_CONTEXT} structure. The
-\emph{TLS\_CONTEXT} structure maintains default TLS settings from which
-\emph{TLS\_CONNECTION} structures are instantiated. In the future the
-\emph{TLS\_CONTEXT} structure may be used to maintain the TLS session
-cache. \emph{ca\_certfile} and \emph{ca\_certdir} arguments are used to
-initialize the CA verification stores. The \emph{certfile} and
-\emph{keyfile} arguments are used to initialize the local certificate and
-private key. If \emph{dhfile} is non-NULL, it is used to initialize
-Diffie-Hellman ephemeral keying. If \emph{verify\_peer} is \emph{true} ,
-client certificate validation is enabled.
-
-\footnotesize
-\begin{verbatim}
-void free_tls_context (TLS_CONTEXT *ctx);
-\end{verbatim}
-\normalsize
-
-Deallocated a previously allocated \emph{TLS\_CONTEXT} structure.
-
-\subsection{Performing Post-Connection Verification}
-\index{TLS Post-Connection Verification}
-\index{Verification!TLS Post-Connection}
-\addcontentsline{toc}{subsection}{Performing Post-Connection Verification}
-
-\footnotesize
-\begin{verbatim}
-bool tls_postconnect_verify_host (TLS_CONNECTION *tls, const char *host);
-\end{verbatim}
-\normalsize
-
-Performs post-connection verification of the peer-supplied x509
-certificate. Checks whether the \emph{subjectAltName} and
-\emph{commonName} attributes match the supplied \emph{host} string.
-Returns \emph{true} if there is a match, \emph{false} otherwise.
-
-\footnotesize
-\begin{verbatim}
-bool tls_postconnect_verify_cn (TLS_CONNECTION *tls, alist *verify_list);
-\end{verbatim}
-\normalsize
-
-Performs post-connection verification of the peer-supplied x509
-certificate. Checks whether the \emph{commonName} attribute matches any
-strings supplied via the \emph{verify\_list} parameter. Returns
-\emph{true} if there is a match, \emph{false} otherwise.
-
-\subsection{Manipulating TLS Connections}
-\index{TLS Connection Manipulation}
-\index{Connections!Manipulating TLS}
-\addcontentsline{toc}{subsection}{Manipulating TLS Connections}
-
-\footnotesize
-\begin{verbatim}
-TLS_CONNECTION *new_tls_connection (TLS_CONTEXT *ctx, int fd);
-\end{verbatim}
-\normalsize
-
-Allocates and initializes a new \emph{TLS\_CONNECTION} structure with
-context \emph{ctx} and file descriptor \emph{fd}.
-
-\footnotesize
-\begin{verbatim}
-void free_tls_connection (TLS_CONNECTION *tls);
-\end{verbatim}
-\normalsize
-
-Deallocates memory associated with the \emph{tls} structure.
-
-\footnotesize
-\begin{verbatim}
-bool tls_bsock_connect (BSOCK *bsock);
-\end{verbatim}
-\normalsize
-
-Negotiates a a TLS client connection via \emph{bsock}. Returns \emph{true}
-if successful, \emph{false} otherwise. Will fail if there is a TLS
-protocol error or an invalid certificate is presented
-
-\footnotesize
-\begin{verbatim}
-bool tls_bsock_accept (BSOCK *bsock);
-\end{verbatim}
-\normalsize
-
-Accepts a TLS client connection via \emph{bsock}. Returns \emph{true} if
-successful, \emph{false} otherwise. Will fail if there is a TLS protocol
-error or an invalid certificate is presented.
-
-\footnotesize
-\begin{verbatim}
-bool tls_bsock_shutdown (BSOCK *bsock);
-\end{verbatim}
-\normalsize
-
-Issues a blocking TLS shutdown request to the peer via \emph{bsock}. This function may not wait for the peer's reply.
-
-\footnotesize
-\begin{verbatim}
-int tls_bsock_writen (BSOCK *bsock, char *ptr, int32_t nbytes);
-\end{verbatim}
-\normalsize
-
-Writes \emph{nbytes} from \emph{ptr} via the \emph{TLS\_CONNECTION}
-associated with \emph{bsock}. Due to OpenSSL's handling of \emph{EINTR},
-\emph{bsock} is set non-blocking at the start of the function, and restored
-to its original blocking state before the function returns. Less than
-\emph{nbytes} may be written if an error occurs. The actual number of
-bytes written will be returned.
-
-\footnotesize
-\begin{verbatim}
-int tls_bsock_readn (BSOCK *bsock, char *ptr, int32_t nbytes);
-\end{verbatim}
-\normalsize
-
-Reads \emph{nbytes} from the \emph{TLS\_CONNECTION} associated with
-\emph{bsock} and stores the result in \emph{ptr}. Due to OpenSSL's
-handling of \emph{EINTR}, \emph{bsock} is set non-blocking at the start of
-the function, and restored to its original blocking state before the
-function returns. Less than \emph{nbytes} may be read if an error occurs.
-The actual number of bytes read will be returned.
-
-\section{Bnet API Changes}
-\index{Bnet API Changes}
-\index{API Changes!Bnet}
-\addcontentsline{toc}{section}{Bnet API Changes}
-
-A minimal number of changes were required in the Bnet socket API. The BSOCK
-structure was expanded to include an associated TLS\_CONNECTION structure,
-as well as a flag to designate the current blocking state of the socket.
-The blocking state flag is required for win32, where it does not appear
-possible to discern the current blocking state of a socket.
-
-\subsection{Negotiating a TLS Connection}
-\index{Negotiating a TLS Connection}
-\index{TLS Connection!Negotiating}
-\addcontentsline{toc}{subsection}{Negotiating a TLS Connection}
-
-\emph{bnet\_tls\_server()} and \emph{bnet\_tls\_client()} were both
-implemented using the new TLS API as follows:
-
-\footnotesize
-\begin{verbatim}
-int bnet_tls_client(TLS_CONTEXT *ctx, BSOCK * bsock);
-\end{verbatim}
-\normalsize
-
-Negotiates a TLS session via \emph{bsock} using the settings from
-\emph{ctx}. Returns 1 if successful, 0 otherwise.
-
-\footnotesize
-\begin{verbatim}
-int bnet_tls_server(TLS_CONTEXT *ctx, BSOCK * bsock, alist *verify_list);
-\end{verbatim}
-\normalsize
-
-Accepts a TLS client session via \emph{bsock} using the settings from
-\emph{ctx}. If \emph{verify\_list} is non-NULL, it is passed to
-\emph{tls\_postconnect\_verify\_cn()} for client certificate verification.
-
-\subsection{Manipulating Socket Blocking State}
-\index{Manipulating Socket Blocking State}
-\index{Socket Blocking State!Manipulating}
-\index{Blocking State!Socket!Manipulating}
-\addcontentsline{toc}{subsection}{Manipulating Socket Blocking State}
-
-Three functions were added for manipulating the blocking state of a socket
-on both Win32 and Unix-like systems. The Win32 code was written according
-to the MSDN documentation, but has not been tested.
-
-These functions are prototyped as follows:
-
-\footnotesize
-\begin{verbatim}
-int bnet_set_nonblocking (BSOCK *bsock);
-\end{verbatim}
-\normalsize
-
-Enables non-blocking I/O on the socket associated with \emph{bsock}.
-Returns a copy of the socket flags prior to modification.
-
-\footnotesize
-\begin{verbatim}
-int bnet_set_blocking (BSOCK *bsock);
-\end{verbatim}
-\normalsize
-
-Enables blocking I/O on the socket associated with \emph{bsock}. Returns a
-copy of the socket flags prior to modification.
-
-\footnotesize
-\begin{verbatim}
-void bnet_restore_blocking (BSOCK *bsock, int flags);
-\end{verbatim}
-\normalsize
-
-Restores blocking or non-blocking IO setting on the socket associated with
-\emph{bsock}. The \emph{flags} argument must be the return value of either
-\emph{bnet\_set\_blocking()} or \emph{bnet\_restore\_blocking()}.
-
-\pagebreak
-
-\section{Authentication Negotiation}
-\index{Authentication Negotiation}
-\index{Negotiation!TLS Authentication}
-\addcontentsline{toc}{section}{Authentication Negotiation}
-
-Backwards compatibility with the existing SSL negotiation hooks implemented
-in src/lib/cram-md5.c have been maintained. The
-\emph{cram\_md5\_get\_auth()} function has been modified to accept an
-integer pointer argument, tls\_remote\_need. The TLS requirement
-advertised by the remote host is returned via this pointer.
-
-After exchanging cram-md5 authentication and TLS requirements, both the
-client and server independently decide whether to continue:
-
-\footnotesize
-\begin{verbatim}
-if (!cram_md5_get_auth(dir, password, &tls_remote_need) ||
- !cram_md5_auth(dir, password, tls_local_need)) {
-[snip]
-/* Verify that the remote host is willing to meet our TLS requirements */
-if (tls_remote_need < tls_local_need && tls_local_need != BNET_TLS_OK &&
- tls_remote_need != BNET_TLS_OK) {
- sendit(_("Authorization problem:"
- " Remote server did not advertise required TLS support.\n"));
- auth_success = false;
- goto auth_done;
-}
-
-/* Verify that we are willing to meet the remote host's requirements */
-if (tls_remote_need > tls_local_need && tls_local_need != BNET_TLS_OK &&
- tls_remote_need != BNET_TLS_OK) {
- sendit(_("Authorization problem:"
- " Remote server requires TLS.\n"));
- auth_success = false;
- goto auth_done;
-}
-\end{verbatim}
-\normalsize
+++ /dev/null
-#!/usr/bin/perl -w
-#
-use strict;
-
-# Used to change the names of the image files generated by latex2html from imgxx.png
-# to meaningful names. Provision is made to go either from or to the meaningful names.
-# The meaningful names are obtained from a file called imagename_translations, which
-# is generated by extensions to latex2html in the make_image_file subroutine in
-# bacula.perl.
-
-# Opens the file imagename_translations and reads the contents into a hash.
-# The hash is creaed with the imgxx.png files as the key if processing TO
-# meaningful filenames, and with the meaningful filenames as the key if
-# processing FROM meaningful filenames.
-# Then opens the html file(s) indicated in the command-line arguments and
-# changes all image references according to the translations described in the
-# above file. Finally, it renames the image files.
-#
-# Original creation: 3-27-05 by Karl Cunningham.
-# Modified 5-21-05 to go FROM and TO meaningful filenames.
-#
-my $TRANSFILE = "imagename_translations";
-my $path;
-
-# Loads the contents of $TRANSFILE file into the hash referenced in the first
-# argument. The hash is loaded to translate old to new if $direction is 0,
-# otherwise it is loaded to translate new to old. In this context, the
-# 'old' filename is the meaningful name, and the 'new' filename is the
-# imgxx.png filename. It is assumed that the old image is the one that
-# latex2html has used as the source to create the imgxx.png filename.
-# The filename extension is taken from the file
-sub read_transfile {
- my ($trans,$direction) = @_;
-
- if (!open IN,"<$path$TRANSFILE") {
- print "WARNING: Cannot open image translation file $path$TRANSFILE for reading\n";
- print " Image filename translation aborted\n\n";
- exit 0;
- }
-
- while (<IN>) {
- chomp;
- my ($new,$old) = split(/\001/);
-
- # Old filenames will usually have a leading ./ which we don't need.
- $old =~ s/^\.\///;
-
- # The filename extension of the old filename must be made to match
- # the new filename because it indicates the encoding format of the image.
- my ($ext) = $new =~ /(\.[^\.]*)$/;
- $old =~ s/\.[^\.]*$/$ext/;
- if ($direction == 0) {
- $trans->{$new} = $old;
- } else {
- $trans->{$old} = $new;
- }
- }
- close IN;
-}
-
-# Translates the image names in the file given as the first argument, according to
-# the translations in the hash that is given as the second argument.
-# The file contents are read in entirely into a string, the string is processed, and
-# the file contents are then written. No particular care is taken to ensure that the
-# file is not lost if a system failure occurs at an inopportune time. It is assumed
-# that the html files being processed here can be recreated on demand.
-#
-# Links to other files are added to the %filelist for processing. That way,
-# all linked files will be processed (assuming they are local).
-sub translate_html {
- my ($filename,$trans,$filelist) = @_;
- my ($contents,$out,$this,$img,$dest);
- my $cnt = 0;
-
- # If the filename is an external link ignore it. And drop any file:// from
- # the filename.
- $filename =~ /^(http|ftp|mailto)\:/ and return 0;
- $filename =~ s/^file\:\/\///;
- # Load the contents of the html file.
- if (!open IF,"<$path$filename") {
- print "WARNING: Cannot open $path$filename for reading\n";
- print " Image Filename Translation aborted\n\n";
- exit 0;
- }
-
- while (<IF>) {
- $contents .= $_;
- }
- close IF;
-
- # Now do the translation...
- # First, search for an image filename.
- while ($contents =~ /\<\s*IMG[^\>]*SRC=\"/si) {
- $contents = $';
- $out .= $` . $&;
-
- # The next thing is an image name. Get it and translate it.
- $contents =~ /^(.*?)\"/s;
- $contents = $';
- $this = $&;
- $img = $1;
- # If the image is in our list of ones to be translated, do it
- # and feed the result to the output.
- $cnt += $this =~ s/$img/$trans->{$img}/ if (defined($trans->{$img}));
- $out .= $this;
- }
- $out .= $contents;
-
- # Now send the translated text to the html file, overwriting what's there.
- open OF,">$path$filename" or die "Cannot open $path$filename for writing\n";
- print OF $out;
- close OF;
-
- # Now look for any links to other files and add them to the list of files to do.
- while ($out =~ /\<\s*A[^\>]*HREF=\"(.*?)\"/si) {
- $out = $';
- $dest = $1;
- # Drop an # and anything after it.
- $dest =~ s/\#.*//;
- $filelist->{$dest} = '' if $dest;
- }
- return $cnt;
-}
-
-# REnames the image files spefified in the %translate hash.
-sub rename_images {
- my $translate = shift;
- my ($response);
-
- foreach (keys(%$translate)) {
- if (! $translate->{$_}) {
- print " WARNING: No destination Filename for $_\n";
- } else {
- $response = `mv -f $path$_ $path$translate->{$_} 2>&1`;
- $response and print "ERROR from system $response\n";
- }
- }
-}
-
-#################################################
-############# MAIN #############################
-################################################
-
-# %filelist starts out with keys from the @ARGV list. As files are processed,
-# any links to other files are added to the %filelist. A hash of processed
-# files is kept so we don't do any twice.
-
-# The first argument must be either --to_meaningful_names or --from_meaningful_names
-
-my (%translate,$search_regex,%filelist,%completed,$thisfile);
-my ($cnt,$direction);
-
-my $arg0 = shift(@ARGV);
-$arg0 =~ /^(--to_meaningful_names|--from_meaningful_names)$/ or
- die "ERROR: First argument must be either \'--to_meaningful_names\' or \'--from_meaningful_names\'\n";
-
-$direction = ($arg0 eq '--to_meaningful_names') ? 0 : 1;
-
-(@ARGV) or die "ERROR: Filename(s) to process must be given as arguments\n";
-
-# Use the first argument to get the path to the file of translations.
-my $tmp = $ARGV[0];
-($path) = $tmp =~ /(.*\/)/;
-$path = '' unless $path;
-
-read_transfile(\%translate,$direction);
-
-foreach (@ARGV) {
- # Strip the path from the filename, and use it later on.
- if (s/(.*\/)//) {
- $path = $1;
- } else {
- $path = '';
- }
- $filelist{$_} = '';
-
- while ($thisfile = (keys(%filelist))[0]) {
- $cnt += translate_html($thisfile,\%translate,\%filelist) if (!exists($completed{$thisfile}));
- delete($filelist{$thisfile});
- $completed{$thisfile} = '';
- }
- print "translate_images.pl: $cnt image filenames translated ",($direction)?"from":"to"," meaningful names\n";
-}
-
-rename_images(\%translate);
+++ /dev/null
-#
-#
-# Makefile for LaTeX
-#
-# To build everything do
-# make tex
-# make web
-# make html
-# make dvipdf
-#
-# or simply
-#
-# make
-#
-# for rapid development do:
-# make tex
-# make show
-#
-#
-# If you are having problems getting "make" to work, debugging it is
-# easier if can see the output from latex, which is normally redirected
-# to /dev/null. To see it, do the following:
-#
-# cd docs/manual
-# make tex
-# latex bacula.tex
-#
-# typically the latex command will stop indicating the error (e.g. a
-# missing \ in front of a _ or a missing { or ] ...
-#
-# The following characters must be preceded by a backslash
-# to be entered as printable characters:
-#
-# # $ % & ~ _ ^ \ { }
-#
-
-IMAGES=../../../images
-
-DOC=install
-
-first_rule: all
-
-all: tex web dvipdf mini-clean
-
-.SUFFIXES: .tex .html
-.PHONY:
-.DONTCARE:
-
-
-tex:
- @./update_version
- @echo "Making version `cat version.tex`"
- @cp -fp ${IMAGES}/hires/*.eps .
- @touch ${DOC}i-dir.tex ${DOC}i-fd.tex ${DOC}i-sd.tex \
- ${DOC}i-console.tex ${DOC}i-general.tex
- latex -interaction=batchmode ${DOC}.tex
- makeindex ${DOC}.idx -o ${DOC}.ind 2>/dev/null
- makeindex ${DOC}.ddx -o ${DOC}.dnd >/dev/null 2>/dev/null
- makeindex ${DOC}.fdx -o ${DOC}.fnd >/dev/null 2>/dev/null
- makeindex ${DOC}.sdx -o ${DOC}.snd >/dev/null 2>/dev/null
- makeindex ${DOC}.cdx -o ${DOC}.cnd >/dev/null 2>/dev/null
- latex -interaction=batchmode ${DOC}.tex
-
-pdf:
- @echo "Making pdfm"
- @cp -fp ${IMAGES}/hires/*.eps .
- dvipdfm -p a4 ${DOC}.dvi
-
-dvipdf:
- @echo "Making dvi to pdf"
- @cp -fp ${IMAGES}/hires/*.eps .
- dvipdf ${DOC}.dvi ${DOC}.pdf
-
-html:
- @echo " "
- @echo "Making html"
- @cp -fp ${IMAGES}/*.eps .
- @rm -f next.eps next.png prev.eps prev.png up.eps up.png
- @(if [ -f imagename_translations ] ; then \
- ./translate_images.pl --from_meaningful_names ${DOC}.html; \
- fi)
- latex2html -white -no_subdir -split 0 -toc_stars -white -notransparent \
- -init_file latex2html-init.pl ${DOC} >tex.out 2>&1
- ./translate_images.pl --to_meaningful_names ${DOC}.html
- @echo "Done making html"
-
-web:
- @echo "Making web"
- @mkdir -p ${DOC}
- @cp -fp ${IMAGES}/*.eps .
- @rm -f next.eps next.png prev.eps prev.png up.eps up.png
- @cp -fp ${IMAGES}/*.eps ${DOC}/
- @cp -fp ${IMAGES}/*.eps ${IMAGES}/*.png ${DOC}/
- @rm -f ${DOC}/xp-*.png
- @rm -f ${DOC}/next.eps ${DOC}/next.png ${DOC}/prev.eps ${DOC}/prev.png ${DOC}/up.eps ${DOC}/up.png
- @rm -rf ${DOC}/*.html
- latex2html -split 3 -local_icons -t "Bacula Installation and Configuration Guide" -long_titles 4 \
- -toc_stars -contents_in_nav -init_file latex2html-init.pl -white -notransparent ${DOC} >tex.out 2>&1
- ./translate_images.pl --to_meaningful_names ${DOC}/Bacula_Instal_Config_Guide.html
- @echo "Done making web"
-show:
- xdvi ${DOC}
-
-texcheck:
- ./check_tex.pl ${DOC}.tex
-
-main_configs:
- pic2graph -density 100 <main_configs.pic >main_configs.png
-
-mini-clean:
- @rm -f 1 2 3 *.tex~
- @rm -f *.gif *.jpg *.eps
- @rm -f *.aux *.cp *.fn *.ky *.log *.pg
- @rm -f *.backup *.ilg *.lof *.lot
- @rm -f *.cdx *.cnd *.ddx *.ddn *.fdx *.fnd *.ind *.sdx *.snd
- @rm -f *.dnd *.old *.out
- @rm -f ${DOC}/*.gif ${DOC}/*.jpg ${DOC}/*.eps
- @rm -f ${DOC}/*.aux ${DOC}/*.cp ${DOC}/*.fn ${DOC}/*.ky ${DOC}/*.log ${DOC}/*.pg
- @rm -f ${DOC}/*.backup ${DOC}/*.ilg ${DOC}/*.lof ${DOC}/*.lot
- @rm -f ${DOC}/*.cdx ${DOC}/*.cnd ${DOC}/*.ddx ${DOC}/*.ddn ${DOC}/*.fdx ${DOC}/*.fnd ${DOC}/*.ind ${DOC}/*.sdx ${DOC}/*.snd
- @rm -f ${DOC}/*.dnd ${DOC}/*.old ${DOC}/*.out
- @rm -f ${DOC}/WARNINGS
-
-
-clean:
- @rm -f 1 2 3 *.tex~
- @rm -f *.png *.gif *.jpg *.eps
- @rm -f *.pdf *.aux *.cp *.fn *.ky *.log *.pg
- @rm -f *.html *.backup *.ps *.dvi *.ilg *.lof *.lot
- @rm -f *.cdx *.cnd *.ddx *.ddn *.fdx *.fnd *.ind *.sdx *.snd
- @rm -f *.dnd imagename_translations
- @rm -f *.old WARNINGS *.out *.toc *.idx
- @rm -f ${DOC}i-*.tex
- @rm -rf ${DOC}
-
-
-distclean: clean
- @rm -f images.pl labels.pl internals.pl
- @rm -f Makefile version.tex
+++ /dev/null
-#
-#
-# Makefile for LaTeX
-#
-# To build everything do
-# make tex
-# make web
-# make html
-# make dvipdf
-#
-# or simply
-#
-# make
-#
-
-IMAGES=../../../images
-
-first_rule: bacula
-
-bacula: tex web html dvipdf
-
-.SUFFIXES: .tex .html
-.PHONY:
-.DONTCARE:
-
-
-tex:
- @cp -fp ${IMAGES}/hires/*.eps .
- touch install.idx installi-general.tex
- -latex -interaction=batchmode install.tex
- makeindex install.idx >/dev/null 2>/dev/null
- -latex -interaction=batchmode install.tex
-
-pdf:
- @echo "Making install pdf"
- @cp -fp ${IMAGES}/hires/*.eps .
- dvipdf install.dvi install.pdf
- @rm -f *.eps *.old
-
-dvipdf:
- @echo "Making install pdfm"
- @cp -fp ${IMAGES}/hires/*.eps .
- dvipdfm -p a4 install.dvi
- @rm -f *.eps *.old
-
-html:
- @echo "Making install html"
- @cp -fp ${IMAGES}/*.eps .
- @rm -f next.eps next.png prev.eps prev.png up.eps up.png
- @(if [ -f imagename_translations ] ; then \
- ./translate_images.pl --from_meaningful_names install.html; \
- fi)
- latex2html -white -no_subdir -split 0 -toc_stars -white -notransparent \
- install >/dev/null
- ./translate_images.pl --to_meaningful_names install.html
- @rm -f *.eps *.gif *.jpg *.old
-
-web:
- @echo "Making install web"
- @mkdir -p install
- @rm -f install/*
- @cp -fp ${IMAGES}/*.eps .
- @rm -f next.eps next.png prev.eps prev.png up.eps up.png
- @cp -fp ${IMAGES}/*.eps ${IMAGES}/*.png install/
- @rm -f install/next.eps install/next.png install/prev.eps install/prev.png install/up.eps install/up.png
- @(if [ -f install/imagename_translations ] ; then \
- ./translate_images.pl --to_meaningful_names install/Bacula_Users_Guide.html; \
- fi)
- @rm -rf install/*.html
- latex2html -split 3 -local_icons -t "Developer's Guide" \
- -long_titles 4 -contents_in_nav -toc_stars -white \
- -notransparent install >/dev/null
- ./translate_images.pl --to_meaningful_names install/install_Guide.html
- @cp -f install/install_Guide.html install/index.html
- @rm -f *.eps *.gif *.jpg install/*.eps *.old
- @rm -f install/idle.png
- @rm -f install/win32-*.png install/wx-console*.png install/xp-*.png
- @rm -f install/*.pl install/*.log install/*.aux install/*.idx
- @rm -f install/*.out WARNINGS
-
-texcheck:
- ./check_tex.pl install.tex
-
-main_configs:
- pic2graph -density 100 <main_configs.pic >main_configs.png
-
-clean:
- @rm -f 1 2 3
- @rm -f *.png *.gif *.jpg *.eps
- @rm -f *.pdf *.aux *.cp *.fn *.ky *.log *.pg
- @rm -f *.html *.backup *.pdf *.ps *.dvi *.ilg *.lof *.lot
- @rm -f *.cdx *.cnd *.ddx *.ddn *.fdx *.fnd *.ind *.sdx *.snd
- @rm -f *.dnd imagename_translations
- @rm -f *.old WARNINGS *.out *.toc *.idx
- @rm -f images.pl labels.pl internals.pl
- @rm -rf install
- @rm -f images.tex installi-general.tex
-
-
-distclean: clean
- @rm -f install.html install.pdf
+++ /dev/null
-%%
-\chapter{Autochanger Resource}
-\index[sd]{Autochanger Resource}
-\index[sd]{Resource!Autochanger}
-
-The Autochanger resource supports single or multiple drive
-autochangers by grouping one or more Device resources
-into one unit called an autochanger in Bacula (often referred to
-as a "tape library" by autochanger manufacturers).
-
-If you have an Autochanger, and you want it to function correctly,
-you {\bf must} have an Autochanger resource in your Storage
-conf file, and your Director's Storage directives that want to
-use an Autochanger {\bf must} refer to the Autochanger resource name.
-In previous versions of Bacula, the Director's Storage directives
-referred directly to Device resources that were autochangers.
-In version 1.38.0 and later, referring directly to Device resources
-will not work for Autochangers.
-
-\begin{description}
-\item [Name = \lt{}Autochanger-Name\gt{}]
- \index[sd]{Name}
- Specifies the Name of the Autochanger. This name is used in the
- Director's Storage definition to refer to the autochanger. This
- directive is required.
-
-\item [Device = \lt{}Device-name1, device-name2, ...\gt{}]
- Specifies the names of the Device resource or resources that correspond
- to the autochanger drive. If you have a multiple drive autochanger, you
- must specify multiple Device names, each one referring to a separate
- Device resource that contains a Drive Index specification that
- corresponds to the drive number base zero. You may specify multiple
- device names on a single line separated by commas, and/or you may
- specify multiple Device directives. This directive is required.
-
-\item [Changer Device = {\it name-string}]
- \index[sd]{Changer Device}
- The specified {\bf name-string} gives the system file name of the autochanger
- device name. If specified in this resource, the Changer Device name
- is not needed in the Device resource. If it is specified in the Device
- resource (see above), it will take precedence over one specified in
- the Autochanger resource.
-
-\item [Changer Command = {\it name-string}]
- \index[sd]{Changer Command }
- The {\bf name-string} specifies an external program to be called that will
- automatically change volumes as required by {\bf Bacula}. Most frequently,
- you will specify the Bacula supplied {\bf mtx-changer} script as follows.
- If it is specified here, it need not be specified in the Device
- resource. If it is also specified in the Device resource, it will take
- precedence over the one specified in the Autochanger resource.
-
-\end{description}
-
-The following is an example of a valid Autochanger resource definition:
-
-\footnotesize
-\begin{verbatim}
-Autochanger {
- Name = "DDS-4-changer"
- Device = DDS-4-1, DDS-4-2, DDS-4-3
- Changer Device = /dev/sg0
- Changer Command = "/etc/bacula/mtx-changer %c %o %S %a %d"
-}
-Device {
- Name = "DDS-4-1"
- Drive Index = 0
- Autochanger = yes
- ...
-}
-Device {
- Name = "DDS-4-2"
- Drive Index = 1
- Autochanger = yes
- ...
-Device {
- Name = "DDS-4-3"
- Drive Index = 2
- Autochanger = yes
- Autoselect = no
- ...
-}
-\end{verbatim}
-\normalsize
-
-Please note that it is important to include the {\bf Autochanger = yes} directive
-in each Device definition that belongs to an Autochanger. A device definition
-should not belong to more than one Autochanger resource. Also, your Device
-directive in the Storage resource of the Director's conf file should have
-the Autochanger's resource name rather than a name of one of the Devices.
-
-If you have a drive that physically belongs to an Autochanger but you don't want
-to have it automatically used when Bacula references the Autochanger for backups,
-for example, you want to reserve it for restores, you can add the directive:
-
-\footnotesize
-\begin{verbatim}
-Autoselect = no
-\end{verbatim}
-\normalsize
-
-to the Device resource for that drive. In that case, Bacula will not automatically
-select that drive when accessing the Autochanger. You can, still use the drive
-by referencing it by the Device name directly rather than the Autochanger name. An example
-of such a definition is shown above for the Device DDS-4-3, which will not be
-selected when the name DDS-4-changer is used in a Storage definition, but will
-be used if DDS-4-3 is used.
+++ /dev/null
-#!/usr/bin/perl -w
-# Finds potential problems in tex files, and issues warnings to the console
-# about what it finds. Takes a list of files as its only arguments,
-# and does checks on all the files listed. The assumption is that these are
-# valid (or close to valid) LaTeX files. It follows \include statements
-# recursively to pick up any included tex files.
-#
-#
-#
-# Currently the following checks are made:
-#
-# -- Multiple hyphens not inside a verbatim environment (or \verb). These
-# should be placed inside a \verb{} contruct so they will not be converted
-# to single hyphen by latex and latex2html.
-
-
-# Original creation 3-8-05 by Karl Cunningham karlc -at- keckec -dot- com
-#
-#
-
-use strict;
-
-# The following builds the test string to identify and change multiple
-# hyphens in the tex files. Several constructs are identified but only
-# multiple hyphens are changed; the others are fed to the output
-# unchanged.
-my $b = '\\\\begin\\*?\\s*\\{\\s*'; # \begin{
-my $e = '\\\\end\\*?\\s*\\{\\s*'; # \end{
-my $c = '\\s*\\}'; # closing curly brace
-
-# This captures entire verbatim environments. These are passed to the output
-# file unchanged.
-my $verbatimenv = $b . "verbatim" . $c . ".*?" . $e . "verbatim" . $c;
-
-# This captures \verb{..{ constructs. They are passed to the output unchanged.
-my $verb = '\\\\verb\\*?(.).*?\\1';
-
-# This captures multiple hyphens with a leading and trailing space. These are not changed.
-my $hyphsp = '\\s\\-{2,}\\s';
-
-# This identifies other multiple hyphens.
-my $hyphens = '\\-{2,}';
-
-# This identifies \hyperpage{..} commands, which should be ignored.
-my $hyperpage = '\\\\hyperpage\\*?\\{.*?\\}';
-
-# This builds the actual test string from the above strings.
-#my $teststr = "$verbatimenv|$verb|$tocentry|$hyphens";
-my $teststr = "$verbatimenv|$verb|$hyphsp|$hyperpage|$hyphens";
-
-
-sub get_includes {
- # Get a list of include files from the top-level tex file. The first
- # argument is a pointer to the list of files found. The rest of the
- # arguments is a list of filenames to check for includes.
- my $files = shift;
- my ($fileline,$includefile,$includes);
-
- while (my $filename = shift) {
- # Get a list of all the html files in the directory.
- open my $if,"<$filename" or die "Cannot open input file $filename\n";
- $fileline = 0;
- $includes = 0;
- while (<$if>) {
- chomp;
- $fileline++;
- # If a file is found in an include, process it.
- if (($includefile) = /\\include\s*\{(.*?)\}/) {
- $includes++;
- # Append .tex to the filename
- $includefile .= '.tex';
-
- # If the include file has already been processed, issue a warning
- # and don't do it again.
- my $found = 0;
- foreach (@$files) {
- if ($_ eq $includefile) {
- $found = 1;
- last;
- }
- }
- if ($found) {
- print "$includefile found at line $fileline in $filename was previously included\n";
- } else {
- # The file has not been previously found. Save it and
- # recursively process it.
- push (@$files,$includefile);
- get_includes($files,$includefile);
- }
- }
- }
- close IF;
- }
-}
-
-
-sub check_hyphens {
- my (@files) = @_;
- my ($filedata,$this,$linecnt,$before);
-
- # Build the test string to check for the various environments.
- # We only do the conversion if the multiple hyphens are outside of a
- # verbatim environment (either \begin{verbatim}...\end{verbatim} or
- # \verb{--}). Capture those environments and pass them to the output
- # unchanged.
-
- foreach my $file (@files) {
- # Open the file and load the whole thing into $filedata. A bit wasteful but
- # easier to deal with, and we don't have a problem with speed here.
- $filedata = "";
- open IF,"<$file" or die "Cannot open input file $file";
- while (<IF>) {
- $filedata .= $_;
- }
- close IF;
-
- # Set up to process the file data.
- $linecnt = 1;
-
- # Go through the file data from beginning to end. For each match, save what
- # came before it and what matched. $filedata now becomes only what came
- # after the match.
- # Chech the match to see if it starts with a multiple-hyphen. If so
- # warn the user. Keep track of line numbers so they can be output
- # with the warning message.
- while ($filedata =~ /$teststr/os) {
- $this = $&;
- $before = $`;
- $filedata = $';
- $linecnt += $before =~ tr/\n/\n/;
-
- # Check if the multiple hyphen is present outside of one of the
- # acceptable constructs.
- if ($this =~ /^\-+/) {
- print "Possible unwanted multiple hyphen found in line ",
- "$linecnt of file $file\n";
- }
- $linecnt += $this =~ tr/\n/\n/;
- }
- }
-}
-##################################################################
-# MAIN ####
-##################################################################
-
-my (@includes,$cnt);
-
-# Examine the file pointed to by the first argument to get a list of
-# includes to test.
-get_includes(\@includes,@ARGV);
-
-check_hyphens(@includes);
+++ /dev/null
-%%
-%%
-
-\chapter{Anpassen der Konfigurations-Dateien}
-\label{ConfigureChapter}
-\index[general]{Dateien!Anpassen der Konfigurations }
-\index[general]{Anpassen der Konfigurations-Dateien }
-
-Jedes einzelne der Bacula Programme liest beim Starten die angegebene Konfigurations-Datei ein,
-falls keine angegeben wird benutzt Bacula jeweils die Standard-Konfigurations-Dateien {\bf bacula-dir.conf}, {\bf
-bacula-fd.conf}, {\bf bacula-sd.conf}, oder {\bf console.conf} f\"{u}r den Director-Dienst, den Client-Dienst,
-den Storage-Dienst und f\"{u}r das Console-Programm.
-
-Jeder Dienst (Director,Client, Storage und Console) hat seine eigene Konfigurations-Datei die eine Reihe von
-Eintr\"{a}gen enth\"{a}lt. Die Eintr\"{a}ge sind sehr \"{a}hnlich, aber die angegebenen Parameter sind von
-Dienst zu Dienst unterschiedlich. Zum Beispiel wird in der Director-Dienst-Konfiguration mit dem Eintrag
-{\bf Director} der Name des Director-Dienstes, eine Reihe globaler Parameter, sowie das Director-Passwort festgelegt.
-Der {\bf Director}-Eintrag im Client-Dienst gibt an, welcher Director-Dienst diesen Client kontaktieren darf.
-
-Bevor Sie Bacula zum ersten mal starten, m\"{u}ssen Sie die Konfigurations-Dateien f\"{u}r jeden Dienst anpassen.
-Standard-Konfigurations-Dateien werden f\"{u}r jeden Dienst bei der Installation erzeugt, aber m\"{u}ssen Ihrem Computer
-angepasst werden. Einen \"{U}berblick \"{u}ber die Konfigurations-Eintr\"{a}ge sehen Sie hier:
-
-\addcontentsline{lof}{figure}{Bacula Objects}
-\includegraphics{\idir bacula-objects.eps}
-\\
-(vielen Dank an Aristides Maniatis f\"{u}r diese Graphik)
-\label{ResFormat}
-
-\section{Zeichens\"{a}tze}
-\index[general]{Zeichens\"{a}tze}
-Bacula wurde so entwickelt, dass es die meisten Zeichens\"{a}tze der Welt versteht,
-US ASCII, deutsch, französich, chinesisch, ..... Allerdings tut es dies, indem es
-alles in UTF-8 umwandelt und Bacula erwartet, dass alle Konfigurationsdateien
-(auch die auf Win32-Computern) als UTF-8-Format vorliegen. Normalerweise ist UTF-8
-der Standard-Zeichensatz auf Linux-Computern, aber eventuell nicht auf anderen
-Unix-Varianten oder auf Windows. Sie sollten also sicherstellen, dass die entsprechenden
-Umgebungsvariablen richtig gesetzt sind, befor Sie Bacula starten.
-
-Damit Bacula auch Konfigurations-Dateien mit fremden Zeichen korrekt lesen kann,
-muss die Umgebungsvariable {bf LANG} mit {\bf .UTF-8} enden, zum Beispiel {\bf en\_US.UTF-8}.
-Die Schreibweise kann bei verschiedenen Betriebssystemen variieren und ebenso kann auch die
-Umgebungsvariable anders hei{\ss}en. Auf neueren Win32-Computern k\"{o}nnen Sie beim speichern
-der Konfigurations-Dateien z.B. mit dem {\bf notepad} angeben, dass die Datei als UTF-8
-gespeichert werden soll.
-
-Bacula nimmt an, dass alle Dateinamen auf Linux und Unix im UTF-8-Format sind.
-Bei Windows sind sie Unicode (UTF-16) und werden automatisch in UTF-8 umgewandelt.
-
-\section{Konfigurations-Parameter-Format}
-\index[general]{Konfigurations-Parameter-Format }
-\index[general]{Format!Konfigurations-Parameter }
-
-Auch wenn Sie nicht jedes Detail \"{u}ber alle Paramter wissen m\"{u}ssen,
-ist ein grundlegendes Wissen des Konfigurations-Parameter-Formats erforderlich.
-Jeder Konfigurations-Eintrag in einer Ressource (innerhalb der geschweiften Klammern)
-ist zusammengesetzt aus dem Schl\"{u}sselwort gefolgt von einem Gleichheitszeichen,
-dem dann ein oder mehrere Werte folgen. Das Schl\"{u}sselwort muss einem der
-Bacula bekannten Konfigurations-Parameter entsprechen, wobei es gro{\ss}e oder kleine
-Buchstaben enthalten darf, sowie auch Leerzeichen.
-
-Jede Ressource muss einen Paramter {\bf Name} beinhalten und kann zus\"{a}tzlich
-eine optionale {\bf Description} enthalten. Der Name wird ben\"{o}tigt um die Ressource
-eindeutig zu bezeichnen. Die Description wird verwendet wenn die Ressource angezeigt wird,
-um eine leichtere Erkennung zu erm\"{o}glichen.
-Ein Beispiel:
-
-\footnotesize
-\begin{verbatim}
-Director {
- Name = "MeinDir"
- Description = "Bacula Director"
- WorkingDirectory = "$HOME/bacula/bin/working"
-}
-\end{verbatim}
-\normalsize
-
-Diese Ressource definiert einen Director mit dem Namen "MeinDir" und dem Arbeitsverzeichnis
-\$HOME/bacula/bin/working. Falls Sie Leerzeichen in einem Parameter verwenden wollen
-(rechts vom Gleichheitszeichen) m\"{u}ssen Sie den Eintrag in doppelte Anf\"{u}hrungszeichen setzen.
-Andernfalls sind Anf\"{u}hrungszeichen nicht n\"{o}tig.
-
-\label{Comments}
-\subsection{Kommentare}
-\index[general]{Kommentare}
-
-Wenn Bacula die Konfigurations-Dateien liest, werden leere Zeilen und alles hinter einem
-Rautezeichen (\#) bis zum Zeilenende ignoriert. Ein Semikolon (;) wird als logisches
-Zeilenende interprtiert und alles hinter dem Semikolon wird als n\"{a}chster
-Konfigurations-Eintrag betrachtet. Wenn ein Eintrag in einer eigenen Zeile steht,
-wird kein abschlie{\ss}endes Semikolon ben\"{o}tigt, in den Beispielen in diesem
-Handbuch werden Sie daher kaum Semikolons finden.
-
-
-\label{Case1}
-
-\subsection{Gro{\ss}/Kleinschreibung und Leerzeichen}
-\index[general]{Leerzeichen!Gro{\ss}/Kleinschreibung}
-\index[general]{Gro{\ss}/Kleinschreibung und Leerzeichen}
-
-Gro{\ss}/Kleinschreibung und Leerzeichen werden beim lesen der Schl\"{u}sselw\"{o}rter
-(dem Teil vor dem Gleichheitszeichen) komplett ignoriert.
-
-Das bedeutet, dass die Schl\"{u}sselw\"{o}rter {\bf name}, {\bf Name} und {\bf N a m e}
-alle identisch sind.
-
-Leerzeichen hinter dem Gleichheitszeichen, vor dem ersten Zeichen des Wertes
-werden auch ignoriert.
-
-Generell werden Leerzeichen innerhalb eines Wertes nicht ignoriert,
-wenn Leerzeichen im Wert vorhanden sind, muss der Wert in doppelte Anf\"{u}hrungszeichen
-gesetzt werden. Namen d\"{u}rfen bis zu 127 Zeichen enthalten. Ein Name darf aus allen
-ASCII-Zeichen bestehen. Innerhalb eine Zeichenkette die in doppelten Anf\"{u}hrungszeichen steht
-kann man mit dem Backslash (umgekehrter Schr\"{a}gstrich \textbackslash{}) ein Zeichen maskieren,
-damit es als es selbst dargestellt wird (praktisch um Anf\"{u}hrungszeichen und geschweifte Klammern
-einzuf\"{u}gen).
-
-Bitte beachten Sie, dass Bacula Ressource-Namen, sowie bestimmte andere Namen (z.B. Volume-Namen),
-nur aus Buchstaben, Zahlen und ein paar Sonderzeichen (Leerzeichen, Unterstrich,..) bestehen d\"{u}rfen.
-Alle anderen Zeichen sind nicht erlaubt.
-
-\label{Includes}
-\subsection{Einbinden anderer Konfigurations-Dateien}
-\index[general]{Einbinden anderer Konfigurations-Dateien }
-\index[general]{Dateien!Einbinden anderer Konfigurations }
-\index[general]{Benutzung von @ zum einbinden anderer Dateien}
-\index[general]{@{\bf Dateiname}}
-
-Falls Sie Ihre Konfiguration auf mehrere kleine Dateien aufteilen m\"{o}chten,
-k\"{o}nnen Sie das tun, indem Sie andere Konfigurations-Dateien mit @{\bf Dateiname} einbinden.
-Dabei muss @{\bf Dateiname} den absoluten Pfad und Dateinamen enthalten. Die Angabe @Dateiname
-darf an jeder Stelle stehen, wo auch eine Konfigurationsangabe stehen kann.
-
-\label{DataTypes}
-\subsection{grundlegende Datentypen}
-\index[general]{Datentypen!grundlegende }
-\index[general]{grundlegende Datentypen }
-
-Beim einlesen der Konfigurations-Parameter klassifiziert Bacula die Daten
-gem\"{a}{\ss} den unten aufgelisteten Datentypen. Wenn Sie dass das erstemal lesen,
-wird es Ihnen eventuell etwas kompliziert vorkommen, aber in Wahrheit ist es ganz einfach und logisch.
-
-\begin{description}
-
-\item [name]
- \index[fd]{name}
- Ein Schl\"{u}sselwort oder Name besteht aus alphanumerischen Zeichen,
-einschlie{\ss}lich Bindestrich, Unterstrich und Dollar-Zeichen. Das erste Zeichen eines {\bf Name}
-muss ein Buchstabe sein. Ein Name hat eine maximale L\"{a}nge von 127 Zeichen. Typischerweise stehen
-Schl\"{u}sselw\"{o}rter auf der linken Seite des Gleichheitszeichens (d.h. es sind
-Bacula-Schl\"{u}sselw\"{o}rter z.B. Konfigurations-Eintrag-Namen oder Parameter-Namen).
-Schl\"{u}sselw\"{o}rter d\"{u}rfen nicht in Anf\"{u}hrungszeichen stehen.
-
-\item [name-string]
- \index[fd]{name-string}
- Ein Name-String ist \"{a}hnlich einem Namen, au{\ss}er das er in Anf\"{u}hrungszeichen stehen darf
-und daher auch Lerrzeichen beinhalten kann. Ein Name-String darf 127 Zeichen lang sein und steht
-typischerweise auf der rechten Seite des Gleichheitszeichens (d.h. es sind Werte die zum einem
-Schl\"{u}sselwort geh\"{o}hren).
-
-\item [string]
- \index[fd]{string}
- Ein String ist eine Zeichenkette die, in Anf\"{u}hrungszeichen gestellt, jedes beliebige Zeichen enthalten darf.
-Ein String hat keine L\"{a}ngenbegrenzung. Strings sind typischerweise Werte die Dateinamen, Verzeichnisnamen oder
-Betriebssystem-Befehlen entsprechen. Ein Backslash (umgekehrter Schr\"{a}gstrich \textbackslash{}) maskiert das folgende
-Zeichen als sich selbst, dadurch kann man Anf\"{u}hrungszeichen innerhalb des Strings verwenden, oder auch den Backslash selbst.
-
-\item [directory]
- \index[dir]{directory}
- A directory is either a quoted or non-quoted string. A directory will be
-passed to your standard shell for expansion when it is scanned. Thus
-constructs such as {\bf \$HOME} are interpreted to be their correct values.
-
-\item [password]
- \index[dir]{password}
- Ist ein Bacula-Passwort und wird intern als MD5-Hash gespeichert.
-
-\item [integer]
- \index[dir]{integer}
- Eine 32-Bit Ganzzahl, positiv oder negativ.
-
-\item [positive integer]
- \index[dir]{positive integer }
- Eine positive 32Bit-Ganzzahl.
-
-\item [long integer]
- \index[dir]{long integer}
- Eine 64-Bit Ganzzahl. Typischerweise f\"{u}r Werte wie Bytes die \"{u}ber 4 Millionen
-betragen k\"{o}nnen und daher 64-Bit erfordern.
-
-\item [yes|no]
- \index[dir]{yes or no }
- Entweder ein Ja: {\bf yes} oder ein Nein: {bf no}.
-
-\label{Size1}
-\item [size]
-\index[dir]{size}
- Eine Gr\"{o}{\ss}e angegeben in Bytes. Typischerweise eine Flie{\ss}kommazahl in wissenschaftlicher Schreibweise,
-gefolgt von einem Modifikator. Intern als 64-Bit Ganzzahl gespeichert. Wenn ein Modofikator angegeben wird, muss er
-direkt und ohne Leerzeichen dem Wert folgen.
-Die folgenden Modifikatoren sind erlaubt:
-
-\begin{description}
-\item [k]
- 1,024 (Kilobytes)
-
-\item [kb]
- 1,000 (Kilobytes)
-
-\item [m]
- 1,048,576 (Megabytes)
-
-\item [mb]
- 1,000,000 (Megabytes)
-
-\item [g]
- 1,073,741,824 (Gigabytes)
-
-\item [gb]
- 1,000,000,000 (Gigabytes)
-\end{description}
-
-\label{Time}
-\item [time]
-\index[dir]{time}
- Eine Zeit oder ein Zeitraum in Sekunden. Intern als 64-Bit Ganzzahl gespeichert,
-allerdings in zwei Teilen: ein Nummern-Teil und ein Modifikator-Teil. Die Nummer kann eine
-Ganz- oder Flie{\ss}kommazahl sein. Wenn sie als Flie{\ss}kommazahl angegeben wird, wird auf
-den n\"{a}chsten Ganzzahl-Wert gerundet. Der Modifikator ist zwingend erforderlich und mu{\ss} dem Nummern-teil folgen
-(entweder durch Leerzeichen getrennt oder nicht). Die folgenden Modifikatoren sind erlaubt:
-
-\begin{description}
-
-\item [seconds]
- \index[dir]{seconds}
- Sekunden
-
-\item [minutes]
- \index[dir]{minutes}
- Minuten (60 Sekunden)
-
-\item [hours]
- \index[dir]{hours }
- Stunden (3600 Sekunden)
-
-\item [days]
- \index[dir]{days}
- Tage (3600*24 Sekunden)
-
-\item [weeks]
- \index[dir]{weeks}
- Wochen (3600*24*7 Sekunden)
-
-\item [months]
- \index[dir]{months }
- Monate (3600*24*30 Sekunden)
-
-\item [quarters]
- \index[dir]{quarters }
- Quartale (3600*24*91 Sekunden)
-
-\item [years]
- \index[dir]{years }
- Jahre (3600*24*365 Sekunden)
-\end{description}
-
-Jede Abk\"{u}rzung dieser Modifikatoren ist erlaubt (d.h. {\bf Sekunden} k\"{o}nnen als
-{\bf sec} oder {\bf s} angegeben werden). Ein {\bf m} wird als Monat angenommen.
-
-Die Angabe einer Zeit kann so viele Modifikatoren und Nummern enthalten, wie gew\"{u}nscht.
-Ein Beispiel:
-
-\footnotesize
-\begin{verbatim}
-1 week 2 days 3 hours 10 mins
-1 month 2 days 30 sec
-
-\end{verbatim}
-\normalsize
-
-sind g\"{u}ltige Zeitangaben.
-
-\end{description}
-
-\label{ResTypes}
-\section{Ressource Typen}
-\index[general]{Typen!Ressource }
-\index[general]{Ressource Typen }
-
-Die folgende Tabelle listet alle momentan von Bacula verwendeten Konfigurations-Eintr\"{a}ge auf.
-Sie zeigt, welche Eintr\"{a}ge bei welchem Dienst vorhanden sein m\"{u}{\ss}en. Die Standard-Konfigurations-Dateien
-beinhalten bereits mindestens ein Beispiel jedes ben\"{o}tigten Eintrags. Sie brauchen sich also keine Sorgen zu machen,
-dass Sie diese Eintr\"{a}ge alle von Hand erstellen m\"{u}{\ss}en.
-
-\addcontentsline{lot}{table}{Ressource Typen}
-\begin{longtable}{|l|l|l|l|l|}
- \hline
-\multicolumn{1}{|c| }{\bf Ressource } & \multicolumn{1}{c| }{\bf Director } &
-\multicolumn{1}{c| }{\bf Client } & \multicolumn{1}{c| }{\bf Storage } &
-\multicolumn{1}{c| }{\bf Console } \\
- \hline
-{Autochanger } & {Nein } & {Nein } & {Ja } & {Nein } \\
-\hline
-{Catalog } & {Ja } & {Nein } & {Nein } & {Nein } \\
- \hline
-{Client } & {Ja } & {Ja } & {Nein } & {Nein } \\
- \hline
-{Console } & {Ja } & {Nein } & {Nein } & {Ja } \\
- \hline
-{Device } & {Nein } & {Nein } & {Ja } & {Nein } \\
- \hline
-{Director } & {Ja } & {Ja } & {Ja } & {Ja } \\
- \hline
-{FileSet } & {Ja } & {Nein } & {Nein } & {Nein } \\
- \hline
-{Job } & {Ja } & {Nein } & {Nein } & {Nein } \\
- \hline
-{JobDefs } & {Ja } & {Nein } & {Nein } & {Nein } \\
- \hline
-{Message } & {Ja } & {Ja } & {Ja } & {Nein } \\
- \hline
-{Pool } & {Ja } & {Nein } & {Nein } & {Nein } \\
- \hline
-{Schedule } & {Ja } & {Nein } & {Nein } & {Nein } \\
- \hline
-{Storage } & {Ja } & {Nein } & {Ja } & {Nein }
-\\ \hline
-
-\end{longtable}
-
-\section{Namen, Passw\"{o}rter und Autorisation}
-\label{Names}
-\index[general]{Autorisation!Namen Passw\"{o}rter und }
-\index[general]{Namen, Passw\"{o}rter und Autorisation }
-\index[general]{Passw\"{o}rter}
-
-Damit ein Dienst mir einem anderen Kontakt aufnehmen darf, muss er sich mit einem Passwort autorisieren.
-In den meisten F\"{a}llen geh\"{o}hrt ein Passwort zu einem bestimmten Namen, es muss also der Name und das Passwort
-korrekt sein, um erfolgreich autorisiert zu werden. Passw\"{o}rter sind einfacher und beliebiger Text. Sie werden
-nicht durch einen speziellen Prozess generiert; benutzen Sie einfach zuf\"{a}lligen Text.
-
-Die Standard-Konfigurations-Dateien enthalten automatisch erzeugte Passw\"{o}rter, die eine erfolgreiche Autorisierung
-aller Dienste untereinander erlauben. Wenn Sie diese Passw\"{o}rter ver\"{a}ndern, m\"{u}{\ss}en Sie das auch auf der
-entsprechenden Gegenseite tun.
-
-Hier ist ein Bild, worauf Sie sehen k\"{o}nnen, welche Namen und Passw\"{o}rter in welchen Dateien und Konfigurations-Eintr\"{a}gen
-\"{u}bereinstimmen m\"{u}{\ss}en:
-
-\includegraphics{\idir Conf-Diagram.eps}
-
-Auf der linken Seite sehen Sie die Director-, Storage- und Client-Eintr\"{a}ge mit ihren Namen und Passw\"{o}rtern,
-dieses steht alles in der Konfiguration des Director-Dienstes in der Datei {\bf bacula-dir.conf}. Auf der rechten Seite
-sehen Sie die entsprechenden Eintr\"{a}ge in den Konfigurations-Dateien des Storage- und Client-Dienstes (SD und FD).
-
-Bitte beachten Sie, dass die Adresse {\bf fw-sd}, die in der Konfiguration des Storage-Dienstes steht, dem Client-Dienst
-symbolisch \"{u}bergeben wird. Der Client-Dienst muss diesen Namen dann in eine g\"{u}ltigen IP-Adresse aufl\"{o}sen k\"{o}nnen.
-Aus diesem Grund muss hier etweder eine IP-Adresse oder ein voll qualifizierter Rechnername stehen. Ein Name wie {\bf localhost}
-ist nicht g\"{u}ltig und wird auf dem Client auf den Namen des localhost des Clients aufge\"{o}st. Das Passwort des Client-Dienstes
-um sich am Storage-Dienst anzumelden ist tempor\"{a}r und wird dynamisch f\"{u}r jeden einzelnen Job erzeugt. Es steht also in keiner
-der .conf-Dateien.
-
-\section{detailierte Information f\"{u}r jeden Dienst}
-\index[general]{detailierte Information f\"{u}r jeden Dienst }
-\index[general]{Dienst!detailierte Information f\"{u}r jeden }
-
-Die Details f\"{u}r jeden Konfigurations-Eintrag und die darin g\"{u}ltigen Parameter sind in den folgenden Kapiteln beschrieben.
-
-Die folgenden Konfigurations-Dateien m\"{u}{\ss}en definiert werden:
-
-\begin{itemize}
-\item
- \ilink{bconsole.conf}{ConsoleConfChapter} -- um die Konfiguration f\"{u}r das Console-Programm zu definieren
-(die Benutzerschnittstelle zum Director-Dienst). Hier wird angegeben welche Director-Dienste verf\"{u}gbar sind, um mit ihnen zu arbeiten.
- \item
- \ilink{bacula-dir.conf}{DirectorChapter} -- um die Konfiguration des Director-Dienstes zu definieren. In dieser Datei geben Sie alle Storage- und
-Client-Dienste an.
-\item
- \ilink{bacula-fd.conf}{FiledConfChapter} -- um die Konfiguration des Clients zu definieren. Diese Datei wird auf jedem Backup-Client ben\"{o}tigt.
-\item
- \ilink{bacula-sd.conf}{StoredConfChapter} -- um die Konfiguration des Storage-Dienstes zu definieren. Normalerweise werden Sie einen Storage-Dienst
-haben, der Ihr Bandlaufwerk steuert. Wenn Sie mehrere Rechner mit angeschlossenen Bandlaufwerken haben, ben\"{o}tigen Sie nat\"{u}rlich einen Storage-Dienst
-pro Rechner.
-\end{itemize}
+++ /dev/null
-%%
-%%
-
-\chapter{Console Konfiguration}
-\label{ConsoleConfChapter}
-\index[general]{Konfiguration!Console}
-\index[general]{Console Konfiguration}
-
-\section{Allgemein}
-
-Die Console-Konfigurations-Datei ist die einfachste Konfigurations-Datei von allen.
-Normalerweise m\"{u}{\ss}en Sie in dieser Datei nicht au{\ss}er dem Passwort \"{a}ndern.
-Diese Datei enth\"{a}lt alle Informationen die n\"{o}tig sind, damit sich das Console-Programm
-zu dem Director-Dienst verbinden kann und darf.
-
-F\"{u}r eine allgemeine \"{U}bersicht der Syntax der Konfigurations-Dateien, sowie der verschiedenen Eintr\"{a}ge,
-einschlie{\ss}lich der Datentypen, sehen Sie sich bitte das Kapitel \ilink{Konfiguration}{ConfigureChapter} an.
-
-Die folgenden Console-Konfigurations-Parameter m\"{u}ssen definiert werden:
-
-\section{Der Director-Eintrag}
-\label{DirectorResource3}
-\index[general]{Director Eintrag}
-\index[general]{Eintrag!Director}
-
-Der Director-Eintrag enth\"{a}lt die notwendigen Parameter, um \"{u}ber das Console-Programm
-Zugriff auf den Director-Dienst zu haben. Sie k\"{o}nnen mehrere Director-Dienste in dieser Datei angeben,
-in dem Fall werden Sie beim starten der Console gefragt, zu welchem Director-Dienst Sie sich verbinden wollen.
-
-\begin{description}
-\item [Director]
- \index[console]{Director}
- Beginn des Director-Eintrags.
-
-\item [Name = \lt{}name\gt{}]
- \index[console]{Name}
- Der Name des Directors, wird nur zur Unterscheidung benutzt, wenn Sie mehrere Director-Dienste konfiguriert haben.
-
-\item [DIRPort = \lt{}port-number\gt{}]
- \index[dir]{DIRPort}
- gibt den Port an, auf dem der Director-Dienst l\"{a}uft. Wenn Sie die {\bf ./configure} Option
- {\bf \verb:--:with-base-port} angegeben haben, wird dieser Wert schon entsprechend gesetzt sein.
- Der Port mu{\ss} mit dem in der Director-Konfiguration angegebenen {\bf DIRport} identisch sein.
- Standardm\"{a}{\ss}ig wird der Port 9101 verwendet, so dass dieser Parameter normalerweise nicht gesetzt ist.
-
-\item [Address = \lt{}address\gt{}]
- \index[dir]{Address}
- die Adresse ist ein Rechnername, eine absolute Adresse (FQDN) oder die IP-Adresse auf der der Director-Dienst l\"{a}uft.
-
-\item [Password = \lt{}password\gt{}]
- \index[dir]{Password}
- das Passwort, dass benutzt wird um die Console beim Director-Dienst zu autorisieren.
- Das Passwort muss mit dem in der \ilink{Director-Konfiguration}{DirectorChapter} gesetzten Passwort identisch sein.
-\end{description}
-
-Ein Beispiel eines Director-Eintrags in der Console-Konfigurations-Datei:
-
-\footnotesize
-\begin{verbatim}
-Director {
- Name = HeadMan
- address = rufus.cats.com
- password = xyz1erploit
-}
-\end{verbatim}
-\normalsize
-
-\section{Der ConsoleFont-Eintrag}
-\index[general]{Eintrag!ConsoleFont}
-\index[general]{ConsoleFont Eintrag}
-
-Der ConsoleFont-Konfigurations-Eintrag ist nur in der GNOME-Version des Console-Programms verf\"{u}gbar.
-Er erlaubt Ihnen, die im Hauptfenster verwendete Schriftart auszuw\"{a}hlen.
-
-\begin{description}
-
-\item [ConsoleFont]
- \index[console]{ConsoleFont}
- Beginn des ConsoleFont-Eintrags.
-
-\item [Name = \lt{}name\gt{}]
- \index[console]{Name}
- Der Name des ConsoleFont-Eintrags.
-
-\item [Font = \lt{}Pango Font Name\gt{}]
- \index[console]{Font}
- Dieser Wert gibt den Namen der Schriftart im Pango-Format an.
- Ein Beispiel:
-
-\footnotesize
-\begin{verbatim}
-Font = "LucidaTypewriter 9"
-\end{verbatim}
-\normalsize
-
-\end{description}
-
-Vielen Dank an Phil Stracchino der diese Funktion in Bacula implementiert hat.
-
-Hier noch ein zweites Beispiel:
-\footnotesize
-\begin{verbatim}
-ConsoleFont {
- Name = Default
- Font = "Monospace 10"
-}
-\end{verbatim}
-\normalsize
-
-\section{Der Console-Eintrag}
-\label{ConsoleResource}
-\index[general]{Console-Eintrag}
-\index[general]{Eintrag!Console}
-
-Seit der Bacula-Version 1.33 gibt es drei verschiedene Console-Typen, die der Administrator oder Benutzer
-zur Verwaltung des Director-Dienstes verwenden kann. Diese drei verschiedenen Typen umfassen drei unterschiedliche
-Sicherheitslevel.
-
-\begin{itemize}
-\item Der erste Consolen-Typ ist die {\bf anonymous} oder {\bf default} Console, die alle Rechte hat.
- F\"{u}r diesen Typ ist kein spezieller Eintrag notwendig, da das Passwort in der Director-Konfiguration angegeben wird.
- Dieser Consolen-Typ war der erste, der in Versionen vor 1.33 vorhanden war und auch weiterhin zu Verf\"{u}gung steht.
- Normalerweise wird diese Console von Administratoren benutzt.
-
-\item Der zweite Consolen-Typ, den es seit Version 1.33 gibt, ist die {\bf named} oder {\bf restricted} Console.
- Diese Typ muss sowohl in der Director-Konfiguration, als auch in der Console-Konfigurations-Datei angegeben werden.
- Beide Namen und Passw\"{o}rter m\"{u}{\ss}en dabei in beiden Konfigurations-Dateien \"{u}bereinstimmen.
-
- Dieser zweite Consolen-Typ hat absolut keine Rechte, au{\ss}er denen, die in der Director-Konfiguration
- explizit zugewiesen werden. Die Director-Konfiguration legt also fest, was dieser Consolen-Typ darf.
-
- Damit k\"{o}nnen Sie also in der Director-Konfiguration diverse Consolen-Eintr\"{a}ge anlegen,
- die jeweils unterschiedliche Passw\"{o}rter und Namen haben und diese dann verschiedenen Benutzern zuweisen,
- die dann z.B. nur auf bestimmte Kommandos und Clients Zugriff haben. Standardm\"{a}{\ss}ig darf diese Console
- \"{u}berhaupt nichts -- keine Kommandos ausf\"{u}hren, absolut nichts. Sie m\"{u}ssen die Berechtigung f\"{u}r
- bestimmte Kommandos und Ressourcen in der Zugriffskontrollliste innerhalb der Director-Konfiguration erteilen.
- Dadurch hat der Administrator gezielte Kontrolle dar\"{u}ber, was er der Console bzw. dem Benutzer erlaubt.
-
-\item Der dritte Consolen-Typ ist \"{a}hnlich des zweiten, auch er ben\"{o}tigt eine Definition in der
- Director- und Consolen-Konfiguration. Bei diesem Typ ist es so, dass wenn der Consolen-Name, der im
- Parameter {\bf Name =} definiert ist, identisch mit dem Client-Namen ist, dem Benutzer erlaubt wird,
- das {\bf SetIP}-Kommando zu benutzen. Dieses Kommando erm\"{o}glicht dem Client, dem Director-Dienst
- mitzuteilen, unter welcher IP-Adresse der Client momentan zu erreichen ist. Dadurch k\"{o}nnen Rechner,
- die ihr Netzwerk mittels DHCP dynamisch konfigurieren, dem Director-Dienst ihre aktuelle IP-Adresse melden.
-
-\end{itemize}
-
-Der Consolen-Konfigurations-Eintrag ist optional, wenn er angegeben wird, haben Sie allerdings die M\"{o}glichkeit,
-Zugriffskontrolllisten anzulegen, um die entsprechende Console in ihren Rechten einzuschr\"{a}nken.
-Damit k\"{o}nnen Sie z.B. dem Benutzer nur Zugriff auf die Backup-Jobs seines Clients erlauben.
-
-Sie k\"{o}nnen beliebig viele Console-Eintr\"{a}ge in Ihrer Consolen-Konfiguration anlegen. Im allgemeinen wird dann
-immer der erste Eintrag verwendet. Wenn Sie allerdings mehrere Director-Dienste, mit entsprechenden Eintr\"{a}gen in
-Ihrer Consolen-Konfiguration, haben, m\"{u}ssen Sie beim starten der Console einen der Director-Dienste ausw\"{a}hlen.
-Lesen Sie bitte auch die Beschreibung des "Director"-Parameters in der Console-Konfiguration, der weiter unten
-beschrieben wird.
-
-\begin{description}
-\item [Console]
- \index[console]{Console}
- Beginn des Console-Eintrags.
-
-\item [Name = \lt{}name\gt{}]
- \index[console]{Name}
- Der Name der Console. Er wird benutzt um dieser Console in der Director-Konfiguration eine
- Zugriffskontrollliste zuzuweisen.
-
-\item [Password = \lt{}password\gt{}]
- \index[console]{Passwort}
- Wenn Sie hier ein Passwort angegeben, wird das Passwort aus dem Director-Eintrag ignoriert.
- Weiter unten finden Sie dazu Details.
-
-\item [Director = \lt{}director-resource-name\gt{}]
- Falls dieser Parameter angegeben wird, kann dieser Consolen-Eintrag \"{u}ber ein Auswahlmen\"{u}
- beim ersten starten der Console selektiert werden. Er bestimmt dann, mit welchen Namen und Passwort
- sich das Console-Programm bei welchen Director-Dienst anmeldet.
-
-\item [Heartbeat Interval = \lt{}time-interval\gt{}]
- \index[console]{Heartbeat Intervall}
- \index[console]{Parameter!Heartbeat}
- Dieser Parameter ist optional. Falls Sie ihn angeben, wird im Abstand des konfigurierten Intervalls (in Sekunden)
- ein \elink{keepalive}{http://de.wikipedia.org/wiki/Keepalive} zum Director-Dienst geschickt. Es ist nur auf Betriebssystemen
- implementiert, die die {\bf setsockopt} TCP\_KEEPIDLE unterst\"{u}tzen (Linux, ...).
- Der Standardwert ist null, d.h. es werden keine keepalives gesendet.
-
-\end{description}
-
-
-Ein Beispiel, wenn Sie folgendes in Ihrer Consolen-Konfigurations-Datei, bconsole.conf oder bwx-console.conf,
-definieren:
-
-\footnotesize
-\begin{verbatim}
-Director {
- Name = MyDirector
- DIRport = 9101
- Address = myserver
- Password = "XXXXXXXXXXX" # das dient hier nicht der Unkenntlichmachung.
-}
-
-
-Console {
- Name = restricted-user
- Password = "UntrustedUser"
-}
-\end{verbatim}
-\normalsize
-
-wobei das Passwort im Director-Konfigurations-Eintrag bewu{\ss}t falsch gesetzt ist
-und der Consolen-Eintrag einen Name besitzt, hier {\bf restricted-user}. Danach erstellen Sie in der Konfiguration
-des Director-Dienstes, auf die der Benutzer keinen Zugriff hat, folgende Consolen:
-
-\footnotesize
-\begin{verbatim}
-Console {
- Name = restricted-user
- Password = "UntrustedUser"
- JobACL = "Restricted Client Save"
- ClientACL = restricted-client
- StorageACL = main-storage
- ScheduleACL = *all*
- PoolACL = *all*
- FileSetACL = "Restricted Client's FileSet"
- CatalogACL = DefaultCatalog
- CommandACL = run
-}
-\end{verbatim}
-\normalsize
-
-dann wird der Benutzer beim Anmelden an den Director-Dienst als {\bf restricted-user} angemeldet.
-Der Benutzer wird nur Zugriff auf Jobs mit dem Namen {\bf Restricted Client Save},
-auf den Client {\bf restricted-client},
-auf den Storage {\bf main-storage},
-auf jeden Zeitplan (Schedule) und auf jeden Pool,
-ein FileSet namens {\bf Restricted Client's FileSet},
-den Katalog {\bf DefaultCatalog},
-sowie einzig und allein das Kommando {\bf run} haben.
-Mit anderen Worten, dieser Benutzer ist sehr eingeschr\"{a}nkt in dem, was er mit der Console
-sehen und tun kann.
-
-Das folgende Beispiel zeigt eine bconsole.conf-Datei, in der mehrere Director-Dienste,
-sowie verschiedene Consolen-Eintr\"{a}ge, abh\"{a}ngig vom Director, zu sehen sind:
-
-\footnotesize
-\begin{verbatim}
-Director {
- Name = MyDirector
- DIRport = 9101
- Address = myserver
- Password = "XXXXXXXXXXX" # das dient hier nicht der Unkenntlichmachung.
-}
-
-Director {
- Name = SecondDirector
- DIRport = 9101
- Address = secondserver
- Password = "XXXXXXXXXXX" # das dient hier nicht der Unkenntlichmachung.
-}
-
-Console {
- Name = restricted-user
- Password = "UntrustedUser"
- Director = MyDirector
-}
-
-Console {
- Name = restricted-user
- Password = "A different UntrustedUser"
- Director = SecondDirector
-}
-\end{verbatim}
-\normalsize
-
-Der zweite Director-Dienst, benannt als "secondserver", k\"{o}nnte diese Konfiguration besitzen:
-
-\footnotesize
-\begin{verbatim}
-Console {
- Name = restricted-user
- Password = "A different UntrustedUser"
- JobACL = "Restricted Client Save"
- ClientACL = restricted-client
- StorageACL = second-storage
- ScheduleACL = *all*
- PoolACL = *all*
- FileSetACL = "Restricted Client's FileSet"might
- CatalogACL = RestrictedCatalog
- CommandACL = run, restore
- WhereACL = "/"
-}
-\end{verbatim}
-\normalsize
-
-Im Unterschied zum ersten Director-Dienst, darf der Benutzer hier, neben einem anderem Storage, auch
-das Consolen-Kommando {\bf restore} ausf\"{u}hren (wobei er als {\bf Where} allerdings nur "/" angeben darf).
-
-
-\section{Console-Kommandos}
-\index[general]{Console-Kommandos}
-\index[general]{Kommandos!Console}
-
-F\"{u}r mehr Details zum arbeiten mit der Console und ihrer Kommandos,
-lesen Sie bitte das Kapitel \ilink{Bacula Console}{_ConsoleChapter} in diesem Handbuch.
-
-\section{Beispiel Console-Konfigurations-Datei}
-\label{SampleConfiguration2}
-\index[general]{Datei!Beispiel Console-Konfiguration}
-\index[general]{Beispiel Console-Konfigurations-Datei}
-
-Dies k\"{o}nnte ein Beispiel f\"{u}r eine Console-Konfigurations-Datei sein:
-
-\footnotesize
-\begin{verbatim}
-#
-# Bacula Console Configuration File
-#
-Director {
- Name = HeadMan
- address = "my_machine.my_domain.com"
- Password = Console_password
-}
-\end{verbatim}
-\normalsize
+++ /dev/null
-%%
-%%
-
-\chapter{Critical Items to Implement Before Production}
-\label{CriticalChapter}
-\index[general]{Production!Critical Items to Implement Before }
-\index[general]{Critical Items to Implement Before Production }
-
-We recommend you take your time before implementing a production a Bacula
-backup system since Bacula is a rather complex program, and if you make a
-mistake, you may suddenly find that you cannot restore your files in case
-of a disaster. This is especially true if you have not previously used a
-major backup product.
-
-If you follow the instructions in this chapter, you will have covered most of
-the major problems that can occur. It goes without saying that if you ever
-find that we have left out an important point, please inform us, so
-that we can document it to the benefit of everyone.
-
-\label{Critical}
-\section{Critical Items}
-\index[general]{Critical Items }
-\index[general]{Items!Critical }
-
-The following assumes that you have installed Bacula, you more or less
-understand it, you have at least worked through the tutorial or have
-equivalent experience, and that you have set up a basic production
-configuration. If you haven't done the above, please do so and then come back
-here. The following is a sort of checklist that points with perhaps a brief
-explanation of why you should do it. In most cases, you will find the
-details elsewhere in the manual. The order is more or less the order you
-would use in setting up a production system (if you already are in
-production, use the checklist anyway).
-
-\begin{itemize}
-\item Test your tape drive for compatibility with Bacula by using the test
- command in the \ilink{btape}{btape} program.
-\item Better than doing the above is to walk through the nine steps in the
- \ilink{Tape Testing}{TapeTestingChapter} chapter of the manual. It
- may take you a bit of time, but it will eliminate surprises.
-\item Test the end of tape handling of your tape drive by using the
- fill command in the \ilink{btape}{btape} program.
-\item If you are using a Linux 2.4 kernel, make sure that /lib/tls is disabled. Bacula
- does not work with this library. See the second point under
- \ilink{ Supported Operating Systems.}{SupportedOSes}
-\item Do at least one restore of files. If you backup multiple OS types
- (Linux, Solaris, HP, MacOS, FreeBSD, Win32, ...),
- restore files from each system type. The
- \ilink{Restoring Files}{RestoreChapter} chapter shows you how.
-\item Write a bootstrap file to a separate system for each backup job. The
- Write Bootstrap directive is described in the
- \ilink{Director Configuration}{writebootstrap} chapter of the
- manual, and more details are available in the
- \ilink{Bootstrap File}{BootstrapChapter} chapter. Also, the default
- bacula-dir.conf comes with a Write Bootstrap directive defined. This allows
- you to recover the state of your system as of the last backup.
-\item Backup your catalog. An example of this is found in the default
- bacula-dir.conf file. The backup script is installed by default and
- should handle any database, though you may want to make your own local
- modifications. See also \ilink{Backing Up Your Bacula Database -
- Security Considerations }{BackingUpBaculaSecurityConsiderations} for more
- information.
-\item Write a bootstrap file for the catalog. An example of this is found in
- the default bacula-dir.conf file. This will allow you to quickly restore your
- catalog in the event it is wiped out -- otherwise it is many excruciating
- hours of work.
-\item Make a copy of the bacula-dir.conf, bacula-sd.conf, and
- bacula-fd.conf files that you are using on your server. Put it in a safe
- place (on another machine) as these files can be difficult to
- reconstruct if your server dies.
-\item Make a Bacula Rescue CDROM! See the
- \ilink{Disaster Recovery Using a Bacula Rescue
- CDROM}{RescueChapter} chapter. It is trivial to make such a CDROM,
- and it can make system recovery in the event of a lost hard disk infinitely
- easier.
-\item Bacula assumes all filenames are in UTF-8 format. This is important
- when saving the filenames to the catalog. For Win32 machine, Bacula will
- automatically convert from Unicode to UTF-8, but on Unix, Linux, *BSD,
- and MacOS X machines, you must explicitly ensure that your locale is set
- properly. Typically this means that the {bf LANG} environment variable
- must end in {\bf .UTF-8}. An full example is {\bf en\_US.UTF-8}. The
- exact syntax may vary a bit from OS to OS, and exactly how you define it
- will also vary.
-
- On most modern Win32 machines, you can edit the conf files with {\bf
- notebook} and choose output encoding UTF-8.
-\end{itemize}
-
-\section{Recommended Items}
-\index[general]{Items!Recommended }
-\index[general]{Recommended Items }
-
-Although these items may not be critical, they are recommended and will help
-you avoid problems.
-
-\begin{itemize}
-\item Read the \ilink{Quick Start Guide to Bacula}{QuickStartChapter}
-\item After installing and experimenting with Bacula, read and work carefully
- through the examples in the
- \ilink{Tutorial}{TutorialChapter} chapter of this manual.
-\item Learn what each of the \ilink{Bacula Utility Programs}{_UtilityChapter}
- does.
-\item Set up reasonable retention periods so that your catalog does not grow
- to be too big. See the following three chapters:\\
- \ilink{Recycling your Volumes}{RecyclingChapter},\\
- \ilink{Basic Volume Management}{DiskChapter},\\
- \ilink{Using Pools to Manage Volumes}{PoolsChapter}.
-\item Perform a bare metal recovery using the Bacula Rescue CDROM. See the
- \ilink{Disaster Recovery Using a Bacula Rescue CDROM}{RescueChapter}
- chapter.
-\end{itemize}
-
-If you absolutely must implement a system where you write a different
-tape each night and take it offsite in the morning. We recommend that you do
-several things:
-\begin{itemize}
-\item Write a bootstrap file of your backed up data and a bootstrap file
- of your catalog backup to a floppy disk or a CDROM, and take that with
- the tape. If this is not possible, try to write those files to another
- computer or offsite computer, or send them as email to a friend. If none
- of that is possible, at least print the bootstrap files and take that
- offsite with the tape. Having the bootstrap files will make recovery
- much easier.
-\item It is better not to force Bacula to load a particular tape each day.
- Instead, let Bacula choose the tape. If you need to know what tape to
- mount, you can print a list of recycled and appendable tapes daily, and
- select any tape from that list. Bacula may propose a particular tape
- for use that it considers optimal, but it will accept any valid tape
- from the correct pool.
-\end{itemize}
+++ /dev/null
-%%
-%%
-
-\chapter{Configuring the Director}
-\label{DirectorChapter}
-\index[general]{Director!Configuring the}
-\index[general]{Configuring the Director}
-
-Of all the configuration files needed to run {\bf Bacula}, the Director's is
-the most complicated, and the one that you will need to modify the most often
-as you add clients or modify the FileSets.
-
-For a general discussion of configuration files and resources including the
-data types recognized by {\bf Bacula}. Please see the
-\ilink{Configuration}{ConfigureChapter} chapter of this manual.
-
-\section{Director Resource Types}
-\index[general]{Types!Director Resource}
-\index[general]{Director Resource Types}
-
-Director resource type may be one of the following:
-
-Job, JobDefs, Client, Storage, Catalog, Schedule, FileSet, Pool, Director, or
-Messages. We present them here in the most logical order for defining them:
-
-Note, everything revolves around a job and is tied to a job in one
-way or another.
-
-\begin{itemize}
-\item
- \ilink{Director}{DirectorResource4} -- to define the Director's
- name and its access password used for authenticating the Console program.
- Only a single Director resource definition may appear in the Director's
- configuration file. If you have either {\bf /dev/random} or {\bf bc} on your
- machine, Bacula will generate a random password during the configuration
- process, otherwise it will be left blank.
-\item
- \ilink{Job}{JobResource} -- to define the backup/restore Jobs
- and to tie together the Client, FileSet and Schedule resources to be used
- for each Job. Normally, you will Jobs of different names corresponding
- to each client (i.e. one Job per client, but a different one with a different name
- for each client).
-\item
- \ilink{JobDefs}{JobDefsResource} -- optional resource for
- providing defaults for Job resources.
-\item
- \ilink{Schedule}{ScheduleResource} -- to define when a Job is to
- be automatically run by {\bf Bacula's} internal scheduler. You
- may have any number of Schedules, but each job will reference only
- one.
-\item
- \ilink{FileSet}{FileSetResource} -- to define the set of files
- to be backed up for each Client. You may have any number of
- FileSets but each Job will reference only one.
-\item
- \ilink{Client}{ClientResource2} -- to define what Client is to be
- backed up. You will generally have multiple Client definitions. Each
- Job will reference only a single client.
-\item
- \ilink{Storage}{StorageResource2} -- to define on what physical
- device the Volumes should be mounted. You may have one or
- more Storage definitions.
-\item
- \ilink{Pool}{PoolResource} -- to define the pool of Volumes
- that can be used for a particular Job. Most people use a
- single default Pool. However, if you have a large number
- of clients or volumes, you may want to have multiple Pools.
- Pools allow you to restrict a Job (or a Client) to use
- only a particular set of Volumes.
-\item
- \ilink{Catalog}{CatalogResource} -- to define in what database to
- keep the list of files and the Volume names where they are backed up.
- Most people only use a single catalog. However, if you want to
- scale the Director to many clients, multiple catalogs can be helpful.
- Multiple catalogs require a bit more management because in general
- you must know what catalog contains what data. Currently, all
- Pools are defined in each catalog. This restriction will be removed
- in a later release.
-\item
- \ilink{Messages}{MessagesChapter} -- to define where error and
- information messages are to be sent or logged. You may define
- multiple different message resources and hence direct particular
- classes of messages to different users or locations (files, ...).
-\end{itemize}
-
-\section{The Director Resource}
-\label{DirectorResource4}
-\index[general]{Director Resource}
-\index[general]{Resource!Director}
-
-The Director resource defines the attributes of the Directors running on the
-network. In the current implementation, there is only a single Director
-resource, but the final design will contain multiple Directors to maintain
-index and media database redundancy.
-
-\begin{description}
-
-\item [Director]
- \index[dir]{Director}
- Start of the Director resource. One and only one director resource must be
-supplied.
-
-\item [Name = \lt{}name\gt{}]
- \index[dir]{Name}
- \index[dir]{Directive!Name}
- The director name used by the system administrator. This directive is
-required.
-
-\item [Description = \lt{}text\gt{}]
- \index[dir]{Description}
- \index[dir]{Directive!Description}
- The text field contains a description of the Director that will be displayed
-in the graphical user interface. This directive is optional.
-
-\item [Password = \lt{}UA-password\gt{}]
- \index[dir]{Password}
- \index[dir]{Directive!Password}
- Specifies the password that must be supplied for the default Bacula
- Console to be authorized. The same password must appear in the {\bf
- Director} resource of the Console configuration file. For added
- security, the password is never passed across the network but instead a
- challenge response hash code created with the password. This directive
- is required. If you have either {\bf /dev/random} or {\bf bc} on your
- machine, Bacula will generate a random password during the configuration
- process, otherwise it will be left blank and you must manually supply
- it.
-
- The password is plain text. It is not generated through any special
- process but as noted above, it is better to use random text for
- security reasons.
-
-\item [Messages = \lt{}Messages-resource-name\gt{}]
- \index[dir]{Messages}
- \index[dir]{Directive!Messages}
- The messages resource specifies where to deliver Director messages that are
- not associated with a specific Job. Most messages are specific to a job and
- will be directed to the Messages resource specified by the job. However,
- there are a few messages that can occur when no job is running. This
- directive is required.
-
-\item [Working Directory = \lt{}Directory\gt{}]
- \index[dir]{Working Directory}
- \index[dir]{Directive!Working Directory}
- This directive is mandatory and specifies a directory in which the Director
- may put its status files. This directory should be used only by Bacula but
- may be shared by other Bacula daemons. However, please note, if this
- directory is shared with other Bacula daemons (the File daemon and Storage
- daemon), you must ensure that the {\bf Name} given to each daemon is
- unique so that the temporary filenames used do not collide. By default
- the Bacula configure process creates unique daemon names by postfixing them
- with -dir, -fd, and -sd. Standard shell expansion of the {\bf
- Directory} is done when the configuration file is read so that values such
- as {\bf \$HOME} will be properly expanded. This directive is required.
- The working directory specified must already exist and be
- readable and writable by the Bacula daemon referencing it.
-
- If you have specified a Director user and/or a Director group on your
- ./configure line with {\bf {-}{-}with-dir-user} and/or
- {\bf {-}{-}with-dir-group} the Working Directory owner and group will
- be set to those values.
-
-\item [Pid Directory = \lt{}Directory\gt{}]
- \index[dir]{Pid Directory}
- \index[dir]{Directive!Pid Directory}
- This directive is mandatory and specifies a directory in which the Director
- may put its process Id file. The process Id file is used to shutdown
- Bacula and to prevent multiple copies of Bacula from running simultaneously.
- Standard shell expansion of the {\bf Directory} is done when the
- configuration file is read so that values such as {\bf \$HOME} will be
- properly expanded.
-
- The PID directory specified must already exist and be
- readable and writable by the Bacula daemon referencing it
-
- Typically on Linux systems, you will set this to: {\bf /var/run}. If you are
- not installing Bacula in the system directories, you can use the {\bf Working
- Directory} as defined above. This directive is required.
-
-\item [Scripts Directory = \lt{}Directory\gt{}]
- \index[dir]{Scripts Directory}
- \index[dir]{Directive!Scripts Directory}
- This directive is optional and, if defined, specifies a directory in
- which the Director will look for the Python startup script {\bf
- DirStartup.py}. This directory may be shared by other Bacula daemons.
- Standard shell expansion of the directory is done when the configuration
- file is read so that values such as {\bf \$HOME} will be properly
- expanded.
-
-\item [QueryFile = \lt{}Path\gt{}]
- \index[dir]{QueryFile}
- \index[dir]{Directive!QueryFile}
- This directive is mandatory and specifies a directory and file in which
- the Director can find the canned SQL statements for the {\bf Query}
- command of the Console. Standard shell expansion of the {\bf Path} is
- done when the configuration file is read so that values such as {\bf
- \$HOME} will be properly expanded. This directive is required.
-
-\label{DirMaxConJobs}
-\item [Maximum Concurrent Jobs = \lt{}number\gt{}]
-\index[dir]{Maximum Concurrent Jobs}
-\index[dir]{Directive!Maximum Concurrent Jobs}
-\index[general]{Simultaneous Jobs}
-\index[general]{Concurrent Jobs}
- where \lt{}number\gt{} is the maximum number of total Director Jobs that
- should run concurrently. The default is set to 1, but you may set it to a
- larger number.
-
- Please note that the Volume format becomes much more complicated with
- multiple simultaneous jobs, consequently, restores can take much longer if
- Bacula must sort through interleaved volume blocks from multiple simultaneous
- jobs. This can be avoided by having each simultaneously running job write to
- a different volume or by using data spooling, which will first spool the data
- to disk simultaneously, then write each spool file to the volume in
- sequence.
-
- There may also still be some cases where directives such as {\bf Maximum
- Volume Jobs} are not properly synchronized with multiple simultaneous jobs
- (subtle timing issues can arise), so careful testing is recommended.
-
- At the current time, there is no configuration parameter set to limit the
- number of console connections. A maximum of five simultaneous console
- connections are permitted.
-
-\item [FD Connect Timeout = \lt{}time\gt{}]
- \index[dir]{FD Connect Timeout}
- \index[dir]{Directive!FD Connect Timeout}
- where {\bf time} is the time that the Director should continue
- attempting to contact the File daemon to start a job, and after which
- the Director will cancel the job. The default is 30 minutes.
-
-\item [SD Connect Timeout = \lt{}time\gt{}]
- \index[dir]{SD Connect Timeout}
- \index[dir]{Directive!SD Connect Timeout}
- where {\bf time} is the time that the Director should continue
- attempting to contact the Storage daemon to start a job, and after which
- the Director will cancel the job. The default is 30 minutes.
-
-\item [DirAddresses = \lt{}IP-address-specification\gt{}]
- \index[dir]{DirAddresses}
- \index[dir]{Address}
- \index[general]{Address}
- \index[dir]{Directive!DirAddresses}
- Specify the ports and addresses on which the Director daemon will listen
- for Bacula Console connections. Probably the simplest way to explain
- this is to show an example:
-
-\footnotesize
-\begin{verbatim}
- DirAddresses = {
- ip = { addr = 1.2.3.4; port = 1205;}
- ipv4 = {
- addr = 1.2.3.4; port = http;}
- ipv6 = {
- addr = 1.2.3.4;
- port = 1205;
- }
- ip = {
- addr = 1.2.3.4
- port = 1205
- }
- ip = { addr = 1.2.3.4 }
- ip = { addr = 201:220:222::2 }
- ip = {
- addr = bluedot.thun.net
- }
-}
-\end{verbatim}
-\normalsize
-
-where ip, ip4, ip6, addr, and port are all keywords. Note, that the address
-can be specified as either a dotted quadruple, or IPv6 colon notation, or as
-a symbolic name (only in the ip specification). Also, port can be specified
-as a number or as the mnemonic value from the /etc/services file. If a port
-is not specified, the default will be used. If an ip section is specified,
-the resolution can be made either by IPv4 or IPv6. If ip4 is specified, then
-only IPv4 resolutions will be permitted, and likewise with ip6.
-
-Please note that if you use the DirAddresses directive, you must
-not use either a DirPort or a DirAddress directive in the same
-resource.
-
-\item [DirPort = \lt{}port-number\gt{}]
- \index[dir]{DirPort}
- \index[dir]{Directive!DirPort}
- Specify the port (a positive integer) on which the Director daemon will
- listen for Bacula Console connections. This same port number must be
- specified in the Director resource of the Console configuration file. The
- default is 9101, so normally this directive need not be specified. This
- directive should not be used if you specify DirAddresses (not plural)
- directive.
-
-\item [DirAddress = \lt{}IP-Address\gt{}]
- \index[dir]{DirAddress}
- \index[dir]{Directive!DirAddress}
- This directive is optional, but if it is specified, it will cause the
- Director server (for the Console program) to bind to the specified {\bf
- IP-Address}, which is either a domain name or an IP address specified as a
- dotted quadruple in string or quoted string format. If this directive is not
- specified, the Director will bind to any available address (the default).
- Note, unlike the DirAddresses specification noted above, this directive only
- permits a single address to be specified. This directive should not be used if you
- specify a DirAddresses (note plural) directive.
-
-
-
-\end{description}
-
-The following is an example of a valid Director resource definition:
-
-\footnotesize
-\begin{verbatim}
-Director {
- Name = HeadMan
- WorkingDirectory = "$HOME/bacula/bin/working"
- Password = UA_password
- PidDirectory = "$HOME/bacula/bin/working"
- QueryFile = "$HOME/bacula/bin/query.sql"
- Messages = Standard
-}
-\end{verbatim}
-\normalsize
-
-\section{The Job Resource}
-\label{JobResource}
-\index[general]{Resource!Job}
-\index[general]{Job Resource}
-
-The Job resource defines a Job (Backup, Restore, ...) that Bacula must
-perform. Each Job resource definition contains the name of a Client and
-a FileSet to backup, the Schedule for the Job, where the data
-are to be stored, and what media Pool can be used. In effect, each Job
-resource must specify What, Where, How, and When or FileSet, Storage,
-Backup/Restore/Level, and Schedule respectively. Note, the FileSet must
-be specified for a restore job for historical reasons, but it is no longer used.
-
-Only a single type ({\bf Backup}, {\bf Restore}, ...) can be specified for any
-job. If you want to backup multiple FileSets on the same Client or multiple
-Clients, you must define a Job for each one.
-
-Note, you define only a single Job to do the Full, Differential, and
-Incremental backups since the different backup levels are tied together by
-a unique Job name. Normally, you will have only one Job per Client, but
-if a client has a really huge number of files (more than several million),
-you might want to split it into to Jobs each with a different FileSet
-covering only part of the total files.
-
-
-\begin{description}
-
-\item [Job]
- \index[dir]{Job}
- \index[dir]{Directive!Job}
- Start of the Job resource. At least one Job resource is required.
-
-\item [Name = \lt{}name\gt{}]
- \index[dir]{Name}
- \index[dir]{Directive!Name}
- The Job name. This name can be specified on the {\bf Run} command in the
- console program to start a job. If the name contains spaces, it must be
- specified between quotes. It is generally a good idea to give your job the
- same name as the Client that it will backup. This permits easy
- identification of jobs.
-
- When the job actually runs, the unique Job Name will consist of the name you
- specify here followed by the date and time the job was scheduled for
- execution. This directive is required.
-
-\item [Enabled = \lt{}yes|no\gt{}]
- \index[dir]{Enable}
- \index[dir]{Directive!Enable}
- This directive allows you to enable or disable automatic execution
- via the scheduler of a Job.
-
-\item [Type = \lt{}job-type\gt{}]
- \index[dir]{Type}
- \index[dir]{Directive!Type}
- The {\bf Type} directive specifies the Job type, which may be one of the
- following: {\bf Backup}, {\bf Restore}, {\bf Verify}, or {\bf Admin}. This
- directive is required. Within a particular Job Type, there are also Levels
- as discussed in the next item.
-
-\begin{description}
-
-\item [Backup]
- \index[dir]{Backup}
- Run a backup Job. Normally you will have at least one Backup job for each
- client you want to save. Normally, unless you turn off cataloging, most all
- the important statistics and data concerning files backed up will be placed
- in the catalog.
-
-\item [Restore]
- \index[dir]{Restore}
- Run a restore Job. Normally, you will specify only one Restore job
- which acts as a sort of prototype that you will modify using the console
- program in order to perform restores. Although certain basic
- information from a Restore job is saved in the catalog, it is very
- minimal compared to the information stored for a Backup job -- for
- example, no File database entries are generated since no Files are
- saved.
-
- {\bf Restore} jobs cannot be
- automatically started by the scheduler as is the case for Backup, Verify
- and Admin jobs. To restore files, you must use the {\bf restore} command
- in the console.
-
-
-\item [Verify]
- \index[dir]{Verify}
- Run a verify Job. In general, {\bf verify} jobs permit you to compare the
- contents of the catalog to the file system, or to what was backed up. In
- addition, to verifying that a tape that was written can be read, you can
- also use {\bf verify} as a sort of tripwire intrusion detection.
-
-\item [Admin]
- \index[dir]{Admin}
- Run an admin Job. An {\bf Admin} job can be used to periodically run catalog
- pruning, if you do not want to do it at the end of each {\bf Backup} Job.
- Although an Admin job is recorded in the catalog, very little data is saved.
-\end{description}
-
-\label{Level}
-
-\item [Level = \lt{}job-level\gt{}]
-\index[dir]{Level}
-\index[dir]{Directive!Level}
- The Level directive specifies the default Job level to be run. Each
- different Job Type (Backup, Restore, ...) has a different set of Levels
- that can be specified. The Level is normally overridden by a different
- value that is specified in the {\bf Schedule} resource. This directive
- is not required, but must be specified either by a {\bf Level} directive
- or as an override specified in the {\bf Schedule} resource.
-
-For a {\bf Backup} Job, the Level may be one of the following:
-
-\begin{description}
-
-\item [Full]
-\index[dir]{Full}
- When the Level is set to Full all files in the FileSet whether or not
- they have changed will be backed up.
-
-\item [Incremental]
- \index[dir]{Incremental}
- When the Level is set to Incremental all files specified in the FileSet
- that have changed since the last successful backup of the the same Job
- using the same FileSet and Client, will be backed up. If the Director
- cannot find a previous valid Full backup then the job will be upgraded
- into a Full backup. When the Director looks for a valid backup record
- in the catalog database, it looks for a previous Job with:
-
-\begin{itemize}
-\item The same Job name.
-\item The same Client name.
-\item The same FileSet (any change to the definition of the FileSet such as
- adding or deleting a file in the Include or Exclude sections constitutes a
- different FileSet.
-\item The Job was a Full, Differential, or Incremental backup.
-\item The Job terminated normally (i.e. did not fail or was not canceled).
-\end{itemize}
-
- If all the above conditions do not hold, the Director will upgrade the
- Incremental to a Full save. Otherwise, the Incremental backup will be
- performed as requested.
-
- The File daemon (Client) decides which files to backup for an
- Incremental backup by comparing start time of the prior Job (Full,
- Differential, or Incremental) against the time each file was last
- "modified" (st\_mtime) and the time its attributes were last
- "changed"(st\_ctime). If the file was modified or its attributes
- changed on or after this start time, it will then be backed up.
-
- Some virus scanning software may change st\_ctime while
- doing the scan. For example, if the virus scanning program attempts to
- reset the access time (st\_atime), which Bacula does not use, it will
- cause st\_ctime to change and hence Bacula will backup the file during
- an Incremental or Differential backup. In the case of Sophos virus
- scanning, you can prevent it from resetting the access time (st\_atime)
- and hence changing st\_ctime by using the {\bf \verb:--:no-reset-atime}
- option. For other software, please see their manual.
-
- When Bacula does an Incremental backup, all modified files that are
- still on the system are backed up. However, any file that has been
- deleted since the last Full backup remains in the Bacula catalog, which
- means that if between a Full save and the time you do a restore, some
- files are deleted, those deleted files will also be restored. The
- deleted files will no longer appear in the catalog after doing another
- Full save. However, to remove deleted files from the catalog during an
- Incremental backup is quite a time consuming process and not currently
- implemented in Bacula.
-
- In addition, if you move a directory rather than copy it, the files in
- it do not have their modification time (st\_mtime) or their attribute
- change time (st\_ctime) changed. As a consequence, those files will
- probably not be backed up by an Incremental or Differential backup which
- depend solely on these time stamps. If you move a directory, and wish
- it to be properly backed up, it is generally preferable to copy it, then
- delete the original.
-
-\item [Differential]
- \index[dir]{Differential}
- When the Level is set to Differential
- all files specified in the FileSet that have changed since the last
- successful Full backup of the same Job will be backed up.
- If the Director cannot find a
- valid previous Full backup for the same Job, FileSet, and Client,
- backup, then the Differential job will be upgraded into a Full backup.
- When the Director looks for a valid Full backup record in the catalog
- database, it looks for a previous Job with:
-
-\begin{itemize}
-\item The same Job name.
-\item The same Client name.
-\item The same FileSet (any change to the definition of the FileSet such as
- adding or deleting a file in the Include or Exclude sections constitutes a
- different FileSet.
-\item The Job was a FULL backup.
-\item The Job terminated normally (i.e. did not fail or was not canceled).
-\end{itemize}
-
- If all the above conditions do not hold, the Director will upgrade the
- Differential to a Full save. Otherwise, the Differential backup will be
- performed as requested.
-
- The File daemon (Client) decides which files to backup for a
- differential backup by comparing the start time of the prior Full backup
- Job against the time each file was last "modified" (st\_mtime) and the
- time its attributes were last "changed" (st\_ctime). If the file was
- modified or its attributes were changed on or after this start time, it
- will then be backed up. The start time used is displayed after the {\bf
- Since} on the Job report. In rare cases, using the start time of the
- prior backup may cause some files to be backed up twice, but it ensures
- that no change is missed. As with the Incremental option, you should
- ensure that the clocks on your server and client are synchronized or as
- close as possible to avoid the possibility of a file being skipped.
- Note, on versions 1.33 or greater Bacula automatically makes the
- necessary adjustments to the time between the server and the client so
- that the times Bacula uses are synchronized.
-
- When Bacula does a Differential backup, all modified files that are
- still on the system are backed up. However, any file that has been
- deleted since the last Full backup remains in the Bacula catalog, which
- means that if between a Full save and the time you do a restore, some
- files are deleted, those deleted files will also be restored. The
- deleted files will no longer appear in the catalog after doing another
- Full save. However, to remove deleted files from the catalog during a
- Differential backup is quite a time consuming process and not currently
- implemented in Bacula. It is, however, a planned future feature.
-
- As noted above, if you move a directory rather than copy it, the
- files in it do not have their modification time (st\_mtime) or
- their attribute change time (st\_ctime) changed. As a
- consequence, those files will probably not be backed up by an
- Incremental or Differential backup which depend solely on these
- time stamps. If you move a directory, and wish it to be
- properly backed up, it is generally preferable to copy it, then
- delete the original. Alternatively, you can move the directory, then
- use the {\bf touch} program to update the timestamps.
-
- Every once and a while, someone asks why we need Differential
- backups as long as Incremental backups pickup all changed files.
- There are possibly many answers to this question, but the one
- that is the most important for me is that a Differential backup
- effectively merges
- all the Incremental and Differential backups since the last Full backup
- into a single Differential backup. This has two effects: 1. It gives
- some redundancy since the old backups could be used if the merged backup
- cannot be read. 2. More importantly, it reduces the number of Volumes
- that are needed to do a restore effectively eliminating the need to read
- all the volumes on which the preceding Incremental and Differential
- backups since the last Full are done.
-
-\end{description}
-
-For a {\bf Restore} Job, no level needs to be specified.
-
-For a {\bf Verify} Job, the Level may be one of the following:
-
-\begin{description}
-
-\item [InitCatalog]
-\index[dir]{InitCatalog}
- does a scan of the specified {\bf FileSet} and stores the file
- attributes in the Catalog database. Since no file data is saved, you
- might ask why you would want to do this. It turns out to be a very
- simple and easy way to have a {\bf Tripwire} like feature using {\bf
- Bacula}. In other words, it allows you to save the state of a set of
- files defined by the {\bf FileSet} and later check to see if those files
- have been modified or deleted and if any new files have been added.
- This can be used to detect system intrusion. Typically you would
- specify a {\bf FileSet} that contains the set of system files that
- should not change (e.g. /sbin, /boot, /lib, /bin, ...). Normally, you
- run the {\bf InitCatalog} level verify one time when your system is
- first setup, and then once again after each modification (upgrade) to
- your system. Thereafter, when your want to check the state of your
- system files, you use a {\bf Verify} {\bf level = Catalog}. This
- compares the results of your {\bf InitCatalog} with the current state of
- the files.
-
-\item [Catalog]
-\index[dir]{Catalog}
- Compares the current state of the files against the state previously
- saved during an {\bf InitCatalog}. Any discrepancies are reported. The
- items reported are determined by the {\bf verify} options specified on
- the {\bf Include} directive in the specified {\bf FileSet} (see the {\bf
- FileSet} resource below for more details). Typically this command will
- be run once a day (or night) to check for any changes to your system
- files.
-
- Please note! If you run two Verify Catalog jobs on the same client at
- the same time, the results will certainly be incorrect. This is because
- Verify Catalog modifies the Catalog database while running in order to
- track new files.
-
-\item [VolumeToCatalog]
-\index[dir]{VolumeToCatalog}
- This level causes Bacula to read the file attribute data written to the
- Volume from the last Job. The file attribute data are compared to the
- values saved in the Catalog database and any differences are reported.
- This is similar to the {\bf Catalog} level except that instead of
- comparing the disk file attributes to the catalog database, the
- attribute data written to the Volume is read and compared to the catalog
- database. Although the attribute data including the signatures (MD5 or
- SHA1) are compared, the actual file data is not compared (it is not in
- the catalog).
-
- Please note! If you run two Verify VolumeToCatalog jobs on the same
- client at the same time, the results will certainly be incorrect. This
- is because the Verify VolumeToCatalog modifies the Catalog database
- while running.
-
-\item [DiskToCatalog]
-\index[dir]{DiskToCatalog}
- This level causes Bacula to read the files as they currently are on
- disk, and to compare the current file attributes with the attributes
- saved in the catalog from the last backup for the job specified on the
- {\bf VerifyJob} directive. This level differs from the {\bf Catalog}
- level described above by the fact that it doesn't compare against a
- previous Verify job but against a previous backup. When you run this
- level, you must supply the verify options on your Include statements.
- Those options determine what attribute fields are compared.
-
- This command can be very useful if you have disk problems because it
- will compare the current state of your disk against the last successful
- backup, which may be several jobs.
-
- Note, the current implementation (1.32c) does not identify files that
- have been deleted.
-\end{description}
-
-\item [Verify Job = \lt{}Job-Resource-Name\gt{}]
- \index[dir]{Verify Job}
- \index[dir]{Directive!Verify Job}
- If you run a verify job without this directive, the last job run will be
- compared with the catalog, which means that you must immediately follow
- a backup by a verify command. If you specify a {\bf Verify Job} Bacula
- will find the last job with that name that ran. This permits you to run
- all your backups, then run Verify jobs on those that you wish to be
- verified (most often a {\bf VolumeToCatalog}) so that the tape just
- written is re-read.
-
-\item [JobDefs = \lt{}JobDefs-Resource-Name\gt{}]
-\index[dir]{JobDefs}
-\index[dir]{Directive!JobDefs}
- If a JobDefs-Resource-Name is specified, all the values contained in the
- named JobDefs resource will be used as the defaults for the current Job.
- Any value that you explicitly define in the current Job resource, will
- override any defaults specified in the JobDefs resource. The use of
- this directive permits writing much more compact Job resources where the
- bulk of the directives are defined in one or more JobDefs. This is
- particularly useful if you have many similar Jobs but with minor
- variations such as different Clients. A simple example of the use of
- JobDefs is provided in the default bacula-dir.conf file.
-
-\item [Bootstrap = \lt{}bootstrap-file\gt{}]
-\index[dir]{Bootstrap}
-\index[dir]{Directive!Bootstrap}
- The Bootstrap directive specifies a bootstrap file that, if provided,
- will be used during {\bf Restore} Jobs and is ignored in other Job
- types. The {\bf bootstrap} file contains the list of tapes to be used
- in a restore Job as well as which files are to be restored.
- Specification of this directive is optional, and if specified, it is
- used only for a restore job. In addition, when running a Restore job
- from the console, this value can be changed.
-
- If you use the {\bf Restore} command in the Console program, to start a
- restore job, the {\bf bootstrap} file will be created automatically from
- the files you select to be restored.
-
- For additional details of the {\bf bootstrap} file, please see
- \ilink{Restoring Files with the Bootstrap File}{BootstrapChapter} chapter
- of this manual.
-
-\label{writebootstrap}
-\item [Write Bootstrap = \lt{}bootstrap-file-specification\gt{}]
-\index[dir]{Write Bootstrap}
-\index[dir]{Directive!Write Bootstrap}
- The {\bf writebootstrap} directive specifies a file name where Bacula
- will write a {\bf bootstrap} file for each Backup job run. This
- directive applies only to Backup Jobs. If the Backup job is a Full
- save, Bacula will erase any current contents of the specified file
- before writing the bootstrap records. If the Job is an Incremental
- or Differential
- save, Bacula will append the current bootstrap record to the end of the
- file.
-
- Using this feature, permits you to constantly have a bootstrap file that
- can recover the current state of your system. Normally, the file
- specified should be a mounted drive on another machine, so that if your
- hard disk is lost, you will immediately have a bootstrap record
- available. Alternatively, you should copy the bootstrap file to another
- machine after it is updated. Note, it is a good idea to write a separate
- bootstrap file for each Job backed up including the job that backs up
- your catalog database.
-
- If the {\bf bootstrap-file-specification} begins with a vertical bar
- (|), Bacula will use the specification as the name of a program to which
- it will pipe the bootstrap record. It could for example be a shell
- script that emails you the bootstrap record.
-
- On versions 1.39.22 or greater, before opening the file or executing the
- specified command, Bacula performs
- \ilink{character substitution}{character substitution} like in RunScript
- directive. To automatically manage your bootstrap files, you can use
- this in your {\bf JobDefs} resources:
-\begin{verbatim}
-JobDefs {
- Write Bootstrap = "%c_%n.bsr"
- ...
-}
-\end{verbatim}
-
- For more details on using this file, please see the chapter entitled
- \ilink{The Bootstrap File}{BootstrapChapter} of this manual.
-
-\item [Client = \lt{}client-resource-name\gt{}]
-\index[dir]{Client}
-\index[dir]{Directive!Client}
- The Client directive specifies the Client (File daemon) that will be used in
- the current Job. Only a single Client may be specified in any one Job. The
- Client runs on the machine to be backed up, and sends the requested files to
- the Storage daemon for backup, or receives them when restoring. For
- additional details, see the
- \ilink{Client Resource section}{ClientResource2} of this chapter.
- This directive is required.
-
-\item [FileSet = \lt{}FileSet-resource-name\gt{}]
-\index[dir]{FileSet}
-\index[dir]{FileSet}
- The FileSet directive specifies the FileSet that will be used in the
- current Job. The FileSet specifies which directories (or files) are to
- be backed up, and what options to use (e.g. compression, ...). Only a
- single FileSet resource may be specified in any one Job. For additional
- details, see the \ilink{FileSet Resource section}{FileSetResource} of
- this chapter. This directive is required.
-
-\item [Messages = \lt{}messages-resource-name\gt{}]
-\index[dir]{Messages}
-\index[dir]{Directive!Messages}
- The Messages directive defines what Messages resource should be used for
- this job, and thus how and where the various messages are to be
- delivered. For example, you can direct some messages to a log file, and
- others can be sent by email. For additional details, see the
- \ilink{Messages Resource}{MessagesChapter} Chapter of this manual. This
- directive is required.
-
-\item [Pool = \lt{}pool-resource-name\gt{}]
-\index[dir]{Pool}
-\index[dir]{Directive!Pool}
- The Pool directive defines the pool of Volumes where your data can be
- backed up. Many Bacula installations will use only the {\bf Default}
- pool. However, if you want to specify a different set of Volumes for
- different Clients or different Jobs, you will probably want to use
- Pools. For additional details, see the \ilink{Pool Resource
- section}{PoolResource} of this chapter. This directive is required.
-
-\item [Full Backup Pool = \lt{}pool-resource-name\gt{}]
-\index[dir]{Full Backup Pool}
-\index[dir]{Directive!Full Backup Pool}
- The {\it Full Backup Pool} specifies a Pool to be used for Full backups.
- It will override any Pool specification during a Full backup. This
- directive is optional.
-
-\item [Differential Backup Pool = \lt{}pool-resource-name\gt{}]
-\index[dir]{Differential Backup Pool}
-\index[dir]{Directive!Differential Backup Pool}
- The {\it Differential Backup Pool} specifies a Pool to be used for
- Differential backups. It will override any Pool specification during a
- Differential backup. This directive is optional.
-
-\item [Incremental Backup Pool = \lt{}pool-resource-name\gt{}]
-\index[dir]{Incremental Backup Pool}
-\index[dir]{Directive!Incremental Backup Pool}
- The {\it Incremental Backup Pool} specifies a Pool to be used for
- Incremental backups. It will override any Pool specification during an
- Incremental backup. This directive is optional.
-
-\item [Schedule = \lt{}schedule-name\gt{}]
-\index[dir]{Schedule}
-\index[dir]{Directive!Schedule}
- The Schedule directive defines what schedule is to be used for the Job.
- The schedule in turn determines when the Job will be automatically
- started and what Job level (i.e. Full, Incremental, ...) is to be run.
- This directive is optional, and if left out, the Job can only be started
- manually using the Console program. Although you may specify only a
- single Schedule resource for any one job, the Schedule resource may
- contain multiple {\bf Run} directives, which allow you to run the Job at
- many different times, and each {\bf run} directive permits overriding
- the default Job Level Pool, Storage, and Messages resources. This gives
- considerable flexibility in what can be done with a single Job. For
- additional details, see the \ilink{Schedule Resource
- Chapter}{ScheduleResource} of this manual.
-
-
-\item [Storage = \lt{}storage-resource-name\gt{}]
-\index[dir]{Storage}
-\index[dir]{Directive!Storage}
- The Storage directive defines the name of the storage services where you
- want to backup the FileSet data. For additional details, see the
- \ilink{Storage Resource Chapter}{StorageResource2} of this manual.
- The Storage resource may also be specified in the Job's Pool resource,
- in which case the value in the Pool resource overrides any value
- in the Job. This Storage resource definition is not required by either
- the Job resource or in the Pool, but it must be specified in
- one or the other, if not an error will result.
-
-\item [Max Start Delay = \lt{}time\gt{}]
-\index[dir]{Max Start Delay}
-\index[dir]{Directive!Max Start Delay}
- The time specifies the maximum delay between the scheduled time and the
- actual start time for the Job. For example, a job can be scheduled to
- run at 1:00am, but because other jobs are running, it may wait to run.
- If the delay is set to 3600 (one hour) and the job has not begun to run
- by 2:00am, the job will be canceled. This can be useful, for example,
- to prevent jobs from running during day time hours. The default is 0
- which indicates no limit.
-
-\item [Max Run Time = \lt{}time\gt{}]
-\index[dir]{Max Run Time}
-\index[dir]{Directive!Max Run Time}
- The time specifies the maximum allowed time that a job may run, counted
- from when the job starts, ({\bf not} necessarily the same as when the
- job was scheduled). This directive is implemented in version 1.33 and
- later.
-
-\item [Max Wait Time = \lt{}time\gt{}]
-\index[dir]{Max Wait Time}
-\index[dir]{Directive!Max Wait Time}
- The time specifies the maximum allowed time that a job may block waiting
- for a resource (such as waiting for a tape to be mounted, or waiting for
- the storage or file daemons to perform their duties), counted from the
- when the job starts, ({\bf not} necessarily the same as when the job was
- scheduled). This directive is implemented only in version 1.33 and
- later.
-
-\item [Incremental Max Wait Time = \lt{}time\gt{}]
-\index[dir]{Incremental Max Wait Time}
-\index[dir]{Directive!Incremental Max Wait Time}
- The time specifies the maximum allowed time that an Incremental backup
- job may block waiting for a resource (such as waiting for a tape to be
- mounted, or waiting for the storage or file daemons to perform their
- duties), counted from the when the job starts, ({\bf not} necessarily
- the same as when the job was scheduled). Please note that if there is a
- {\bf Max Wait Time} it may also be applied to the job.
-
-\item [Differential Max Wait Time = \lt{}time\gt{}]
-\index[dir]{Differential Max Wait Time}
-\index[dir]{Directive!Differential Max Wait Time}
- The time specifies the maximum allowed time that a Differential backup
- job may block waiting for a resource (such as waiting for a tape to be
- mounted, or waiting for the storage or file daemons to perform their
- duties), counted from the when the job starts, ({\bf not} necessarily
- the same as when the job was scheduled). Please note that if there is a
- {\bf Max Wait Time} it may also be applied to the job.
-
-\label{PreferMountedVolumes}
-\item [Prefer Mounted Volumes = \lt{}yes|no\gt{}]
-\index[dir]{Prefer Mounted Volumes}
-\index[dir]{Directive!Prefer Mounted Volumes}
- If the Prefer Mounted Volumes directive is set to {\bf yes} (default
- yes), the Storage daemon is requested to select either an Autochanger or
- a drive with a valid Volume already mounted in preference to a drive
- that is not ready. This means that all jobs will attempt to append
- to the same Volume (providing the Volume is appropriate -- right Pool,
- ... for that job). If no drive with a suitable Volume is available, it
- will select the first available drive. Note, any Volume that has
- been requested to be mounted, will be considered valid as a mounted
- volume by another job. This if multiple jobs start at the same time
- and they all prefer mounted volumes, the first job will request the
- mount, and the other jobs will use the same volume.
-
- If the directive is set to {\bf no}, the Storage daemon will prefer
- finding an unused drive, otherwise, each job started will append to the
- same Volume (assuming the Pool is the same for all jobs). Setting
- Prefer Mounted Volumes to no can be useful for those sites
- with multiple drive autochangers that prefer to maximize backup
- throughput at the expense of using additional drives and Volumes.
- This means that the job will prefer to use an unused drive rather
- than use a drive that is already in use.
-
-\item [Prune Jobs = \lt{}yes|no\gt{}]
-\index[dir]{Prune Jobs}
-\index[dir]{Directive!Prune Jobs}
- Normally, pruning of Jobs from the Catalog is specified on a Client by
- Client basis in the Client resource with the {\bf AutoPrune} directive.
- If this directive is specified (not normally) and the value is {\bf
- yes}, it will override the value specified in the Client resource. The
- default is {\bf no}.
-
-
-\item [Prune Files = \lt{}yes|no\gt{}]
-\index[dir]{Prune Files}
-\index[dir]{Directive!Prune Files}
- Normally, pruning of Files from the Catalog is specified on a Client by
- Client basis in the Client resource with the {\bf AutoPrune} directive.
- If this directive is specified (not normally) and the value is {\bf
- yes}, it will override the value specified in the Client resource. The
- default is {\bf no}.
-
-\item [Prune Volumes = \lt{}yes|no\gt{}]
-\index[dir]{Prune Volumes}
-\index[dir]{Directive!Prune Volumes}
- Normally, pruning of Volumes from the Catalog is specified on a Client
- by Client basis in the Client resource with the {\bf AutoPrune}
- directive. If this directive is specified (not normally) and the value
- is {\bf yes}, it will override the value specified in the Client
- resource. The default is {\bf no}.
-
-\item [RunScript \{\lt{}body-of-runscript\gt{}\}]
- \index[dir]{RunScript}
- \index[dir]{Directive!Run Script}
-
- This directive is implemented in version 1.39.22 and later.
- The RunScript directive behaves like a resource in that it
- requires opening and closing braces around a number of directives
- that make up the body of the runscript.
-
- The specified {\bf Command} (see below for details) is run as an
- external program prior or after the current Job. This is optional.
-
- You can use following options may be specified in the body
- of the runscript:\\
-
-\begin{tabular}{|c|c|c|l}
-Options & Value & Default & Information \\
-\hline
-\hline
-Runs On Success & Yes/No & {\it Yes} & Run command if JobStatus is successful\\
-\hline
-Runs On Failure & Yes/No & {\it No} & Run command if JobStatus isn't successful\\
-\hline
-Runs On Client & Yes/No & {\it Yes} & Run command on client\\
-\hline
-Runs When & Before|After|Always & {\it Never} & When run commands\\
-\hline
-Fail Job On Error & Yes/No & {\it Yes} & Fail job if script returns
- something different from 0 \\
-\hline
-Command & & & Path to your script\\
-\hline
-\end{tabular}
- \\
-
- Any output sent by the command to standard output will be included in the
- Bacula job report. The command string must be a valid program name or name
- of a shell script.
-
- In addition, the command string is parsed then fed to the OS,
- which means that the path will be searched to execute your specified
- command, but there is no shell interpretation, as a consequence, if you
- invoke complicated commands or want any shell features such as redirection
- or piping, you must call a shell script and do it inside that script.
-
- Before submitting the specified command to the operating system, Bacula
- performs character substitution of the following characters:
-
-\label{character substitution}
-\footnotesize
-\begin{verbatim}
- %% = %
- %c = Client's name
- %d = Director's name
- %e = Job Exit Status
- %i = JobId
- %j = Unique Job id
- %l = Job Level
- %n = Job name
- %s = Since time
- %t = Job type (Backup, ...)
- %v = Volume name
-
-\end{verbatim}
-\normalsize
-
-The Job Exit Status code \%e edits the following values:
-
-\index[dir]{Exit Status}
-\begin{itemize}
-\item OK
-\item Error
-\item Fatal Error
-\item Canceled
-\item Differences
-\item Unknown term code
-\end{itemize}
-
- Thus if you edit it on a command line, you will need to enclose
- it within some sort of quotes.
-
-
-You can use these following shortcuts:\\
-
-\begin{tabular}{|c|c|c|c|c|c}
-Keyword & RunsOnSuccess & RunsOnFailure & FailJobOnError & Runs On Client & RunsWhen \\
-\hline
-Run Before Job & & & Yes & No & Before \\
-\hline
-Run After Job & Yes & No & & No & After \\
-\hline
-Run After Failed Job & No & Yes & & No & After \\
-\hline
-Client Run Before Job & & & Yes & Yes & Before \\
-\hline
-Client Run After Job & Yes & No & & Yes & After \\
-\end{tabular}
-
-Examples:
-\begin{verbatim}
-RunScript {
- RunsWhen = Before
- FailJobOnError = No
- Command = "/etc/init.d/apache stop"
-}
-
-RunScript {
- RunsWhen = After
- RunsOnFailure = yes
- Command = "/etc/init.d/apache start"
-}
-\end{verbatim}
-
- {\bf Special Windows Considerations}
-
- In addition, for a Windows client on version 1.33 and above, please take
- note that you must ensure a correct path to your script. The script or
- program can be a .com, .exe or a .bat file. If you just put the program
- name in then Bacula will search using the same rules that cmd.exe uses
- (current directory, Bacula bin directory, and PATH). It will even try the
- different extensions in the same order as cmd.exe.
- The command can be anything that cmd.exe or command.com will recognize
- as an executable file.
-
- However, if you have slashes in the program name then Bacula figures you
- are fully specifying the name, so you must also explicitly add the three
- character extension.
-
- The command is run in a Win32 environment, so Unix like commands will not
- work unless you have installed and properly configured Cygwin in addition
- to and separately from Bacula.
-
- The System \%Path\% will be searched for the command. (under the
- environment variable dialog you have have both System Environment and
- User Environment, we believe that only the System environment will be
- available to bacula-fd, if it is running as a service.)
-
- System environment variables can be referenced with \%var\% and
- used as either part of the command name or arguments.
-
- So if you have a script in the Bacula\\bin directory then the following lines
- should work fine:
-
-\footnotesize
-\begin{verbatim}
- Client Run Before Job = systemstate
-or
- Client Run Before Job = systemstate.bat
-or
- Client Run Before Job = "systemstate"
-or
- Client Run Before Job = "systemstate.bat"
-or
- ClientRunBeforeJob = "\"C:/Program Files/Bacula/systemstate.bat\""
-\end{verbatim}
-\normalsize
-
-The outer set of quotes is removed when the configuration file is parsed.
-You need to escape the inner quotes so that they are there when the code
-that parses the command line for execution runs so it can tell what the
-program name is.
-
-
-\footnotesize
-\begin{verbatim}
-ClientRunBeforeJob = "\"C:/Program Files/Software
- Vendor/Executable\" /arg1 /arg2 \"foo bar\""
-\end{verbatim}
-\normalsize
-
- The special characters
-\begin{verbatim}
-&<>()@^|
-\end{verbatim}
- will need to be quoted,
- if they are part of a filename or argument.
-
- If someone is logged in, a blank "command" window running the commands
- will be present during the execution of the command.
-
- Some Suggestions from Phil Stracchino for running on Win32 machines with
- the native Win32 File daemon:
-
- \begin{enumerate}
- \item You might want the ClientRunBeforeJob directive to specify a .bat
- file which runs the actual client-side commands, rather than trying
- to run (for example) regedit /e directly.
- \item The batch file should explicitly 'exit 0' on successful completion.
- \item The path to the batch file should be specified in Unix form:
-
- ClientRunBeforeJob = "c:/bacula/bin/systemstate.bat"
-
- rather than DOS/Windows form:
-
- ClientRunBeforeJob =
-
-"c:\textbackslash{}bacula\textbackslash{}bin\textbackslash{}systemstate.bat"
- INCORRECT
- \end{enumerate}
-
-For Win32, please note that there are certain limitations:
-
-ClientRunBeforeJob = "C:/Program Files/Bacula/bin/pre-exec.bat"
-
-Lines like the above do not work because there are limitations of
-cmd.exe that is used to execute the command.
-Bacula prefixes the string you supply with {\bf cmd.exe /c }. To test that
-your command works you should type {\bf cmd /c "C:/Program Files/test.exe"} at a
-cmd prompt and see what happens. Once the command is correct insert a
-backslash (\textbackslash{}) before each double quote ("), and
-then put quotes around the whole thing when putting it in
-the director's .conf file. You either need to have only one set of quotes
-or else use the short name and don't put quotes around the command path.
-
-Below is the output from cmd's help as it relates to the command line
-passed to the /c option.
-
-
- If /C or /K is specified, then the remainder of the command line after
- the switch is processed as a command line, where the following logic is
- used to process quote (") characters:
-
-\begin{enumerate}
-\item
- If all of the following conditions are met, then quote characters
- on the command line are preserved:
- \begin{itemize}
- \item no /S switch.
- \item exactly two quote characters.
- \item no special characters between the two quote characters,
- where special is one of:
-\begin{verbatim}
-&<>()@^|
-\end{verbatim}
- \item there are one or more whitespace characters between the
- the two quote characters.
- \item the string between the two quote characters is the name
- of an executable file.
- \end{itemize}
-
-\item Otherwise, old behavior is to see if the first character is
- a quote character and if so, strip the leading character and
- remove the last quote character on the command line, preserving
- any text after the last quote character.
-
-\end{enumerate}
-
-
-The following example of the use of the Client Run Before Job directive was
-submitted by a user:\\
-You could write a shell script to back up a DB2 database to a FIFO. The shell
-script is:
-
-\footnotesize
-\begin{verbatim}
- #!/bin/sh
- # ===== backupdb.sh
- DIR=/u01/mercuryd
-
- mkfifo $DIR/dbpipe
- db2 BACKUP DATABASE mercuryd TO $DIR/dbpipe WITHOUT PROMPTING &
- sleep 1
-\end{verbatim}
-\normalsize
-
-The following line in the Job resource in the bacula-dir.conf file:
-\footnotesize
-\begin{verbatim}
- Client Run Before Job = "su - mercuryd -c \"/u01/mercuryd/backupdb.sh '%t'
-'%l'\""
-\end{verbatim}
-\normalsize
-
-When the job is run, you will get messages from the output of the script
-stating that the backup has started. Even though the command being run is
-backgrounded with \&, the job will block until the "db2 BACKUP DATABASE"
-command, thus the backup stalls.
-
-To remedy this situation, the "db2 BACKUP DATABASE" line should be changed to
-the following:
-
-\footnotesize
-\begin{verbatim}
- db2 BACKUP DATABASE mercuryd TO $DIR/dbpipe WITHOUT PROMPTING > $DIR/backup.log
-2>&1 < /dev/null &
-\end{verbatim}
-\normalsize
-
-It is important to redirect the input and outputs of a backgrounded command to
-/dev/null to prevent the script from blocking.
-
-\item [Run Before Job = \lt{}command\gt{}]
-\index[dir]{Run Before Job}
-\index[dir]{Directive!Run Before Job}
-\index[dir]{Directive!Run Before Job}
-The specified {\bf command} is run as an external program prior to running the
-current Job. This directive is not required, but if it is defined, and if the
-exit code of the program run is non-zero, the current Bacula job will be
-canceled.
-
-\begin{verbatim}
-Run Before Job = "echo test"
-\end{verbatim}
- it's equivalent to :
-\begin{verbatim}
-RunScript {
- Command = "echo test"
- RunsOnClient = No
- RunsWhen = Before
-}
-\end{verbatim}
-
- Lutz Kittler has pointed out that using the RunBeforeJob directive can be a
- simple way to modify your schedules during a holiday. For example, suppose
- that you normally do Full backups on Fridays, but Thursday and Friday are
- holidays. To avoid having to change tapes between Thursday and Friday when
- no one is in the office, you can create a RunBeforeJob that returns a
- non-zero status on Thursday and zero on all other days. That way, the
- Thursday job will not run, and on Friday the tape you inserted on Wednesday
- before leaving will be used.
-
-\item [Run After Job = \lt{}command\gt{}]
-\index[dir]{Run After Job}
-\index[dir]{Directive!Run After Job}
- The specified {\bf command} is run as an external program if the current
- job terminates normally (without error or without being canceled). This
- directive is not required. If the exit code of the program run is
- non-zero, Bacula will print a warning message. Before submitting the
- specified command to the operating system, Bacula performs character
- substitution as described above for the {\bf RunScript} directive.
-
- An example of the use of this directive is given in the
- \ilink{Tips Chapter}{JobNotification} of this manual.
-
- See the {\bf Run After Failed Job} if you
- want to run a script after the job has terminated with any
- non-normal status.
-
-\item [Run After Failed Job = \lt{}command\gt{}]
-\index[dir]{Run After Job}
-\index[dir]{Directive!Run After Job}
- The specified {\bf command} is run as an external program after the current
- job terminates with any error status. This directive is not required. The
- command string must be a valid program name or name of a shell script. If
- the exit code of the program run is non-zero, Bacula will print a
- warning message. Before submitting the specified command to the
- operating system, Bacula performs character substitution as described above
- for the {\bf RunScript} directive. Note, if you wish that your script
- will run regardless of the exit status of the Job, you can use this :
-\begin{verbatim}
-RunScript {
- Command = "echo test"
- RunsWhen = After
- RunsOnFailure = yes
- RunsOnClient = no
- RunsOnSuccess = yes # default, you can drop this line
-}
-\end{verbatim}
-
- An example of the use of this directive is given in the
- \ilink{Tips Chapter}{JobNotification} of this manual.
-
-
-\item [Client Run Before Job = \lt{}command\gt{}]
-\index[dir]{Client Run Before Job}
-\index[dir]{Directive!Client Run Before Job}
- This directive is the same as {\bf Run Before Job} except that the
- program is run on the client machine. The same restrictions apply to
- Unix systems as noted above for the {\bf RunScript}.
-
-\item [Client Run After Job = \lt{}command\gt{}]
- \index[dir]{Client Run After Job}
- \index[dir]{Directive!Client Run After Job}
- The specified {\bf command} is run on the client machine as soon
- as data spooling is complete in order to allow restarting applications
- on the client as soon as possible. .
-
- Note, please see the notes above in {\bf RunScript}
- concerning Windows clients.
-
-\item [Rerun Failed Levels = \lt{}yes|no\gt{}]
- \index[dir]{Rerun Failed Levels}
- \index[dir]{Directive!Rerun Failed Levels}
- If this directive is set to {\bf yes} (default no), and Bacula detects that
- a previous job at a higher level (i.e. Full or Differential) has failed,
- the current job level will be upgraded to the higher level. This is
- particularly useful for Laptops where they may often be unreachable, and if
- a prior Full save has failed, you wish the very next backup to be a Full
- save rather than whatever level it is started as.
-
- There are several points that must be taken into account when using this
- directive: first, a failed job is defined as one that has not terminated
- normally, which includes any running job of the same name (you need to
- ensure that two jobs of the same name do not run simultaneously);
- secondly, the {\bf Ignore FileSet Changes} directive is not considered
- when checking for failed levels, which means that any FileSet change will
- trigger a rerun.
-
-\item [Spool Data = \lt{}yes|no\gt{}]
- \index[dir]{Spool Data}
- \index[dir]{Directive!Spool Data}
-
- If this directive is set to {\bf yes} (default no), the Storage daemon will
- be requested to spool the data for this Job to disk rather than write it
- directly to tape. Once all the data arrives or the spool files' maximum sizes
- are reached, the data will be despooled and written to tape. Spooling data
- prevents tape shoe-shine (start and stop) during
- Incremental saves. If you are writing to a disk file using this option
- will probably just slow down the backup jobs.
-
- NOTE: When this directive is set to yes, Spool Attributes is also
- automatically set to yes.
-
-\item [Spool Attributes = \lt{}yes|no\gt{}]
- \index[dir]{Spool Attributes}
- \index[dir]{Directive!Spool Attributes}
- \index[dir]{slow}
- \index[general]{slow}
- \index[dir]{Backups!slow}
- \index[general]{Backups!slow}
- The default is set to {\bf no}, which means that the File attributes are
- sent by the Storage daemon to the Director as they are stored on tape.
- However, if you want to avoid the possibility that database updates will
- slow down writing to the tape, you may want to set the value to {\bf
- yes}, in which case the Storage daemon will buffer the File attributes
- and Storage coordinates to a temporary file in the Working Directory,
- then when writing the Job data to the tape is completed, the attributes
- and storage coordinates will be sent to the Director.
-
- NOTE: When Spool Data is set to yes, Spool Attributes is also
- automatically set to yes.
-
-\item [Where = \lt{}directory\gt{}]
- \index[dir]{Where}
- \index[dir]{Directive!Where}
- This directive applies only to a Restore job and specifies a prefix to
- the directory name of all files being restored. This permits files to
- be restored in a different location from which they were saved. If {\bf
- Where} is not specified or is set to backslash ({\bf /}), the files will
- be restored to their original location. By default, we have set {\bf
- Where} in the example configuration files to be {\bf
- /tmp/bacula-restores}. This is to prevent accidental overwriting of
- your files.
-
-\item [Add Prefix = \lt{}directory\gt{}]
- \label{confaddprefix}
- \index[dir]{AddPrefix}
- \index[dir]{Directive!AddPrefix}
- This directive applies only to a Restore job and specifies a prefix to the
- directory name of all files being restored. This will use \ilink{File
- Relocation}{filerelocation} feature implemented in Bacula 2.1.8 or later.
-
-\item [Add Suffix = \lt{}extention\gt{}]
- \index[dir]{AddSuffix}
- \index[dir]{Directive!AddSuffix}
- This directive applies only to a Restore job and specifies a suffix to all
- files being restored. This will use \ilink{File Relocation}{filerelocation}
- feature implemented in Bacula 2.1.8 or later.
-
- Using \texttt{Add Suffix=.old}, \texttt{/etc/passwd} will be restored to
- \texttt{/etc/passwsd.old}
-
-\item [Strip Prefix = \lt{}directory\gt{}]
- \index[dir]{StripPrefix}
- \index[dir]{Directive!StripPrefix}
- This directive applies only to a Restore job and specifies a prefix to remove
- from the directory name of all files being restored. This will use the
- \ilink{File Relocation}{filerelocation} feature implemented in Bacula 2.1.8
- or later.
-
- Using \texttt{Strip Prefix=/etc}, \texttt{/etc/passwd} will be restored to
- \texttt{/passwd}
-
- Under Windows, if you want to restore \texttt{c:/files} to \texttt{d:/files},
- you can use :
-
-\begin{verbatim}
- Strip Prefix = c:
- Add Prefix = d:
-\end{verbatim}
-
-\item [RegexWhere = \lt{}expressions\gt{}]
- \index[dir]{RegexWhere}
- \index[dir]{Directive!RegexWhere}
- This directive applies only to a Restore job and specifies a regex filename
- manipulation of all files being restored. This will use \ilink{File
- Relocation}{filerelocation} feature implemented in Bacula 2.1.8 or later.
-
- For more informations about how use this option, see
- \ilink{this}{useregexwhere}.
-
-\item [Replace = \lt{}replace-option\gt{}]
- \index[dir]{Replace}
- \index[dir]{Directive!Replace}
- This directive applies only to a Restore job and specifies what happens
- when Bacula wants to restore a file or directory that already exists.
- You have the following options for {\bf replace-option}:
-
-\begin{description}
-
-\item [always]
- \index[dir]{always}
- when the file to be restored already exists, it is deleted and then
- replaced by the copy that was backed up.
-
-\item [ifnewer]
-\index[dir]{ifnewer}
- if the backed up file (on tape) is newer than the existing file, the
- existing file is deleted and replaced by the back up.
-
-\item [ifolder]
- \index[dir]{ifolder}
- if the backed up file (on tape) is older than the existing file, the
- existing file is deleted and replaced by the back up.
-
-\item [never]
- \index[dir]{never}
- if the backed up file already exists, Bacula skips restoring this file.
-\end{description}
-
-\item [Prefix Links=\lt{}yes|no\gt{}]
- \index[dir]{Prefix Links}
- \index[dir]{Directive!Prefix Links}
- If a {\bf Where} path prefix is specified for a recovery job, apply it
- to absolute links as well. The default is {\bf No}. When set to {\bf
- Yes} then while restoring files to an alternate directory, any absolute
- soft links will also be modified to point to the new alternate
- directory. Normally this is what is desired -- i.e. everything is self
- consistent. However, if you wish to later move the files to their
- original locations, all files linked with absolute names will be broken.
-
-\item [Maximum Concurrent Jobs = \lt{}number\gt{}]
- \index[dir]{Maximum Concurrent Jobs}
- \index[dir]{Directive!Maximum Concurrent Jobs}
- where \lt{}number\gt{} is the maximum number of Jobs from the current
- Job resource that can run concurrently. Note, this directive limits
- only Jobs with the same name as the resource in which it appears. Any
- other restrictions on the maximum concurrent jobs such as in the
- Director, Client, or Storage resources will also apply in addition to
- the limit specified here. The default is set to 1, but you may set it
- to a larger number. We strongly recommend that you read the WARNING
- documented under \ilink{ Maximum Concurrent Jobs}{DirMaxConJobs} in the
- Director's resource.
-
-\item [Reschedule On Error = \lt{}yes|no\gt{}]
- \index[dir]{Reschedule On Error}
- \index[dir]{Directive!Reschedule On Error}
- If this directive is enabled, and the job terminates in error, the job
- will be rescheduled as determined by the {\bf Reschedule Interval} and
- {\bf Reschedule Times} directives. If you cancel the job, it will not
- be rescheduled. The default is {\bf no} (i.e. the job will not be
- rescheduled).
-
- This specification can be useful for portables, laptops, or other
- machines that are not always connected to the network or switched on.
-
-\item [Reschedule Interval = \lt{}time-specification\gt{}]
- \index[dir]{Reschedule Interval}
- \index[dir]{Directive!Reschedule Interval}
- If you have specified {\bf Reschedule On Error = yes} and the job
- terminates in error, it will be rescheduled after the interval of time
- specified by {\bf time-specification}. See \ilink{the time
- specification formats}{Time} in the Configure chapter for details of
- time specifications. If no interval is specified, the job will not be
- rescheduled on error.
-
-\item [Reschedule Times = \lt{}count\gt{}]
- \index[dir]{Reschedule Times}
- \index[dir]{Directive!Reschedule Times}
- This directive specifies the maximum number of times to reschedule the
- job. If it is set to zero (the default) the job will be rescheduled an
- indefinite number of times.
-
-\item [Run = \lt{}job-name\gt{}]
- \index[dir]{Run}
- \index[dir]{Directive!Run}
- \index[dir]{Clone a Job}
- The Run directive (not to be confused with the Run option in a
- Schedule) allows you to start other jobs or to clone jobs. By using the
- cloning keywords (see below), you can backup
- the same data (or almost the same data) to two or more drives
- at the same time. The {\bf job-name} is normally the same name
- as the current Job resource (thus creating a clone). However, it
- may be any Job name, so one job may start other related jobs.
-
- The part after the equal sign must be enclosed in double quotes,
- and can contain any string or set of options (overrides) that you
- can specify when entering the Run command from the console. For
- example {\bf storage=DDS-4 ...}. In addition, there are two special
- keywords that permit you to clone the current job. They are {\bf level=\%l}
- and {\bf since=\%s}. The \%l in the level keyword permits
- entering the actual level of the current job and the \%s in the since
- keyword permits putting the same time for comparison as used on the
- current job. Note, in the case of the since keyword, the \%s must be
- enclosed in double quotes, and thus they must be preceded by a backslash
- since they are already inside quotes. For example:
-
-\begin{verbatim}
- run = "Nightly-backup level=%l since=\"%s\" storage=DDS-4"
-\end{verbatim}
-
- A cloned job will not start additional clones, so it is not
- possible to recurse.
-
- Please note that all cloned jobs, as specified in the Run directives are
- submitted for running before the original job is run (while it is being
- initialized). This means that any clone job will actually start before
- the original job, and may even block the original job from starting
- until the original job finishes unless you allow multiple simultaneous
- jobs. Even if you set a lower priority on the clone job, if no other
- jobs are running, it will start before the original job.
-
- If you are trying to prioritize jobs by using the clone feature (Run
- directive), you will find it much easier to do using a RunScript
- resource, or a RunBeforeJob directive.
-
-\label{Priority}
-\item [Priority = \lt{}number\gt{}]
- \index[dir]{Priority}
- \index[dir]{Directive!Priority}
- This directive permits you to control the order in which your jobs will
- be run by specifying a positive non-zero number. The higher the number,
- the lower the job priority. Assuming you are not running concurrent jobs,
- all queued jobs of priority 1 will run before queued jobs of priority 2
- and so on, regardless of the original scheduling order.
-
- The priority only affects waiting jobs that are queued to run, not jobs
- that are already running. If one or more jobs of priority 2 are already
- running, and a new job is scheduled with priority 1, the currently
- running priority 2 jobs must complete before the priority 1 job is run.
-
- The default priority is 10.
-
- If you want to run concurrent jobs you should
- keep these points in mind:
-
-\begin{itemize}
-\item See \ilink{Running Concurrent Jobs}{ConcurrentJobs} on how to setup
- concurrent jobs.
-
-\item Bacula concurrently runs jobs of only one priority at a time. It
- will not simultaneously run a priority 1 and a priority 2 job.
-
-\item If Bacula is running a priority 2 job and a new priority 1 job is
- scheduled, it will wait until the running priority 2 job terminates even
- if the Maximum Concurrent Jobs settings would otherwise allow two jobs
- to run simultaneously.
-
-\item Suppose that bacula is running a priority 2 job and a new priority 1
- job is scheduled and queued waiting for the running priority 2 job to
- terminate. If you then start a second priority 2 job, the waiting
- priority 1 job will prevent the new priority 2 job from running
- concurrently with the running priority 2 job. That is: as long as there
- is a higher priority job waiting to run, no new lower priority jobs will
- start even if the Maximum Concurrent Jobs settings would normally allow
- them to run. This ensures that higher priority jobs will be run as soon
- as possible.
-\end{itemize}
-
-If you have several jobs of different priority, it may not best to start
-them at exactly the same time, because Bacula must examine them one at a
-time. If by Bacula starts a lower priority job first, then it will run
-before your high priority jobs. If you experience this problem, you may
-avoid it by starting any higher priority jobs a few seconds before lower
-priority ones. This insures that Bacula will examine the jobs in the
-correct order, and that your priority scheme will be respected.
-
-\label{WritePartAfterJob}
-\item [Write Part After Job = \lt{}yes|no\gt{}]
-\index[dir]{Write Part After Job}
-\index[dir]{Directive!Write Part After Job}
- This directive is only implemented in version 1.37 and later.
- If this directive is set to {\bf yes} (default {\bf no}), a new part file
- will be created after the job is finished.
-
- It should be set to {\bf yes} when writing to devices that require mount
- (for example DVD), so you are sure that the current part, containing
- this job's data, is written to the device, and that no data is left in
- the temporary file on the hard disk. However, on some media, like DVD+R
- and DVD-R, a lot of space (about 10Mb) is lost every time a part is
- written. So, if you run several jobs each after another, you could set
- this directive to {\bf no} for all jobs, except the last one, to avoid
- wasting too much space, but to ensure that the data is written to the
- medium when all jobs are finished.
-
- This directive is ignored with tape and FIFO devices.
-
-\item [Heartbeat Interval = \lt{}time-interval\gt{}]
- \index[dir]{Heartbeat Interval}
- \index[dir]{Directive!Heartbeat}
- This directive is optional and if specified will cause the Director to
- set a keepalive interval (heartbeat) in seconds on each of the sockets
- it opens for the Client resource. This value will override any
- specified at the Director level. It is implemented only on systems
- (Linux, ...) that provide the {\bf setsockopt} TCP\_KEEPIDLE function.
- The default value is zero, which means no change is made to the socket.
-
-\end{description}
-
-The following is an example of a valid Job resource definition:
-
-\footnotesize
-\begin{verbatim}
-Job {
- Name = "Minou"
- Type = Backup
- Level = Incremental # default
- Client = Minou
- FileSet="Minou Full Set"
- Storage = DLTDrive
- Pool = Default
- Schedule = "MinouWeeklyCycle"
- Messages = Standard
-}
-\end{verbatim}
-\normalsize
-
-\section{The JobDefs Resource}
-\label{JobDefsResource}
-\index[general]{JobDefs Resource}
-\index[general]{Resource!JobDefs}
-
-The JobDefs resource permits all the same directives that can appear in a Job
-resource. However, a JobDefs resource does not create a Job, rather it can be
-referenced within a Job to provide defaults for that Job. This permits you to
-concisely define several nearly identical Jobs, each one referencing a JobDefs
-resource which contains the defaults. Only the changes from the defaults need to
-be mentioned in each Job.
-
-\section{The Schedule Resource}
-\label{ScheduleResource}
-\index[general]{Resource!Schedule}
-\index[general]{Schedule Resource}
-
-The Schedule resource provides a means of automatically scheduling a Job as
-well as the ability to override the default Level, Pool, Storage and Messages
-resources. If a Schedule resource is not referenced in a Job, the Job can only
-be run manually. In general, you specify an action to be taken and when.
-
-\begin{description}
-
-\item [Schedule]
-\index[dir]{Schedule}
-\index[dir]{Directive!Schedule}
- Start of the Schedule directives. No {\bf Schedule} resource is
- required, but you will need at least one if you want Jobs to be
- automatically started.
-
-\item [Name = \lt{}name\gt{}]
- \index[dir]{Name}
- \index[dir]{Directive!Name}
- The name of the schedule being defined. The Name directive is required.
-
-\item [Run = \lt{}Job-overrides\gt{} \lt{}Date-time-specification\gt{}]
- \index[dir]{Run}
- \index[dir]{Directive!Run}
- The Run directive defines when a Job is to be run, and what overrides if
- any to apply. You may specify multiple {\bf run} directives within a
- {\bf Schedule} resource. If you do, they will all be applied (i.e.
- multiple schedules). If you have two {\bf Run} directives that start at
- the same time, two Jobs will start at the same time (well, within one
- second of each other).
-
- The {\bf Job-overrides} permit overriding the Level, the Storage, the
- Messages, and the Pool specifications provided in the Job resource. In
- addition, the FullPool, the IncrementalPool, and the DifferentialPool
- specifications permit overriding the Pool specification according to
- what backup Job Level is in effect.
-
- By the use of overrides, you may customize a particular Job. For
- example, you may specify a Messages override for your Incremental
- backups that outputs messages to a log file, but for your weekly or
- monthly Full backups, you may send the output by email by using a
- different Messages override.
-
- {\bf Job-overrides} are specified as: {\bf keyword=value} where the
- keyword is Level, Storage, Messages, Pool, FullPool, DifferentialPool,
- or IncrementalPool, and the {\bf value} is as defined on the respective
- directive formats for the Job resource. You may specify multiple {\bf
- Job-overrides} on one {\bf Run} directive by separating them with one or
- more spaces or by separating them with a trailing comma. For example:
-
-\begin{description}
-
-\item [Level=Full]
- \index[dir]{Level}
- \index[dir]{Directive!Level}
- is all files in the FileSet whether or not they have changed.
-
-\item [Level=Incremental]
- \index[dir]{Level}
- \index[dir]{Directive!Level}
- is all files that have changed since the last backup.
-
-\item [Pool=Weekly]
- \index[dir]{Pool}
- \index[dir]{Directive!Pool}
- specifies to use the Pool named {\bf Weekly}.
-
-\item [Storage=DLT\_Drive]
- \index[dir]{Storage}
- \index[dir]{Directive!Storage}
- specifies to use {\bf DLT\_Drive} for the storage device.
-
-\item [Messages=Verbose]
- \index[dir]{Messages}
- \index[dir]{Directive!Messages}
- specifies to use the {\bf Verbose} message resource for the Job.
-
-\item [FullPool=Full]
- \index[dir]{FullPool}
- \index[dir]{Directive!FullPool}
- specifies to use the Pool named {\bf Full} if the job is a full backup, or
-is
-upgraded from another type to a full backup.
-
-\item [DifferentialPool=Differential]
- \index[dir]{DifferentialPool}
- \index[dir]{Directive!DifferentialPool}
- specifies to use the Pool named {\bf Differential} if the job is a
- differential backup.
-
-\item [IncrementalPool=Incremental]
- \index[dir]{IncrementalPool}
- \index[dir]{Directive!IncrementalPool}
- specifies to use the Pool named {\bf Incremental} if the job is an
-incremental backup.
-
-\item [SpoolData=yes|no]
- \index[dir]{SpoolData}
- \index[dir]{Directive!SpoolData}
- tells Bacula to request the Storage daemon to spool data to a disk file
- before writing it to the Volume (normally a tape). Thus the data is
- written in large blocks to the Volume rather than small blocks. This
- directive is particularly useful when running multiple simultaneous
- backups to tape. It prevents interleaving of the job data and reduces
- or eliminates tape drive stop and start commonly known as "shoe-shine".
-
-\item [SpoolSize={\it bytes}]
- \index[dir]{SpoolSize}
- \index[dir]{Directive!SpoolSize}
- where the bytes specify the maximum spool size for this job.
- The default is take from Device Maximum Spool Size limit.
- This directive is available only in Bacula version 2.3.5 or
- later.
-
-\item [WritePartAfterJob=yes|no]
- \index[dir]{WritePartAfterJob}
- \index[dir]{Directive!WritePartAfterJob}
- tells Bacula to request the Storage daemon to write the current part
- file to the device when the job is finished (see \ilink{Write Part After
- Job directive in the Job resource}{WritePartAfterJob}). Please note,
- this directive is implemented only in version 1.37 and later. The
- default is yes. We strongly recommend that you keep this set to yes
- otherwise, when the last job has finished one part will remain in the
- spool file and restore may or may not work.
-
-\end{description}
-
-{\bf Date-time-specification} determines when the Job is to be run. The
-specification is a repetition, and as a default Bacula is set to run a job at
-the beginning of the hour of every hour of every day of every week of every
-month of every year. This is not normally what you want, so you must specify
-or limit when you want the job to run. Any specification given is assumed to
-be repetitive in nature and will serve to override or limit the default
-repetition. This is done by specifying masks or times for the hour, day of the
-month, day of the week, week of the month, week of the year, and month when
-you want the job to run. By specifying one or more of the above, you can
-define a schedule to repeat at almost any frequency you want.
-
-Basically, you must supply a {\bf month}, {\bf day}, {\bf hour}, and {\bf
-minute} the Job is to be run. Of these four items to be specified, {\bf day}
-is special in that you may either specify a day of the month such as 1, 2,
-... 31, or you may specify a day of the week such as Monday, Tuesday, ...
-Sunday. Finally, you may also specify a week qualifier to restrict the
-schedule to the first, second, third, fourth, or fifth week of the month.
-
-For example, if you specify only a day of the week, such as {\bf Tuesday} the
-Job will be run every hour of every Tuesday of every Month. That is the {\bf
-month} and {\bf hour} remain set to the defaults of every month and all
-hours.
-
-Note, by default with no other specification, your job will run at the
-beginning of every hour. If you wish your job to run more than once in any
-given hour, you will need to specify multiple {\bf run} specifications each
-with a different minute.
-
-The date/time to run the Job can be specified in the following way in
-pseudo-BNF:
-
-\footnotesize
-\begin{verbatim}
-<void-keyword> = on
-<at-keyword> = at
-<week-keyword> = 1st | 2nd | 3rd | 4th | 5th | first |
- second | third | fourth | fifth
-<wday-keyword> = sun | mon | tue | wed | thu | fri | sat |
- sunday | monday | tuesday | wednesday |
- thursday | friday | saturday
-<week-of-year-keyword> = w00 | w01 | ... w52 | w53
-<month-keyword> = jan | feb | mar | apr | may | jun | jul |
- aug | sep | oct | nov | dec | january |
- february | ... | december
-<daily-keyword> = daily
-<weekly-keyword> = weekly
-<monthly-keyword> = monthly
-<hourly-keyword> = hourly
-<digit> = 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0
-<number> = <digit> | <digit><number>
-<12hour> = 0 | 1 | 2 | ... 12
-<hour> = 0 | 1 | 2 | ... 23
-<minute> = 0 | 1 | 2 | ... 59
-<day> = 1 | 2 | ... 31
-<time> = <hour>:<minute> |
- <12hour>:<minute>am |
- <12hour>:<minute>pm
-<time-spec> = <at-keyword> <time> |
- <hourly-keyword>
-<date-keyword> = <void-keyword> <weekly-keyword>
-<day-range> = <day>-<day>
-<month-range> = <month-keyword>-<month-keyword>
-<wday-range> = <wday-keyword>-<wday-keyword>
-<range> = <day-range> | <month-range> |
- <wday-range>
-<date> = <date-keyword> | <day> | <range>
-<date-spec> = <date> | <date-spec>
-<day-spec> = <day> | <wday-keyword> |
- <day-range> | <wday-range> |
- <daily-keyword>
-<day-spec> = <day> | <wday-keyword> |
- <day> | <wday-range> |
- <week-keyword> <wday-keyword> |
- <week-keyword> <wday-range>
-<month-spec> = <month-keyword> | <month-range> |
- <monthly-keyword>
-<date-time-spec> = <month-spec> <day-spec> <time-spec>
-\end{verbatim}
-\normalsize
-
-\end{description}
-
-Note, the Week of Year specification wnn follows the ISO standard definition
-of the week of the year, where Week 1 is the week in which the first Thursday
-of the year occurs, or alternatively, the week which contains the 4th of
-January. Weeks are numbered w01 to w53. w00 for Bacula is the week that
-precedes the first ISO week (i.e. has the first few days of the year if any
-occur before Thursday). w00 is not defined by the ISO specification. A week
-starts with Monday and ends with Sunday.
-
-According to the NIST (US National Institute of Standards and Technology),
-12am and 12pm are ambiguous and can be defined to anything. However,
-12:01am is the same as 00:01 and 12:01pm is the same as 12:01, so Bacula
-defines 12am as 00:00 (midnight) and 12pm as 12:00 (noon). You can avoid
-this abiguity (confusion) by using 24 hour time specifications (i.e. no
-am/pm). This is the definition in Bacula version 2.0.3 and later.
-
-An example schedule resource that is named {\bf WeeklyCycle} and runs a job
-with level full each Sunday at 2:05am and an incremental job Monday through
-Saturday at 2:05am is:
-
-\footnotesize
-\begin{verbatim}
-Schedule {
- Name = "WeeklyCycle"
- Run = Level=Full sun at 2:05
- Run = Level=Incremental mon-sat at 2:05
-}
-\end{verbatim}
-\normalsize
-
-An example of a possible monthly cycle is as follows:
-
-\footnotesize
-\begin{verbatim}
-Schedule {
- Name = "MonthlyCycle"
- Run = Level=Full Pool=Monthly 1st sun at 2:05
- Run = Level=Differential 2nd-5th sun at 2:05
- Run = Level=Incremental Pool=Daily mon-sat at 2:05
-}
-\end{verbatim}
-\normalsize
-
-The first of every month:
-
-\footnotesize
-\begin{verbatim}
-Schedule {
- Name = "First"
- Run = Level=Full on 1 at 2:05
- Run = Level=Incremental on 2-31 at 2:05
-}
-\end{verbatim}
-\normalsize
-
-Every 10 minutes:
-
-\footnotesize
-\begin{verbatim}
-Schedule {
- Name = "TenMinutes"
- Run = Level=Full hourly at 0:05
- Run = Level=Full hourly at 0:15
- Run = Level=Full hourly at 0:25
- Run = Level=Full hourly at 0:35
- Run = Level=Full hourly at 0:45
- Run = Level=Full hourly at 0:55
-}
-\end{verbatim}
-\normalsize
-
-\section{Technical Notes on Schedules}
-\index[general]{Schedules!Technical Notes on}
-\index[general]{Technical Notes on Schedules}
-
-Internally Bacula keeps a schedule as a bit mask. There are six masks and a
-minute field to each schedule. The masks are hour, day of the month (mday),
-month, day of the week (wday), week of the month (wom), and week of the year
-(woy). The schedule is initialized to have the bits of each of these masks
-set, which means that at the beginning of every hour, the job will run. When
-you specify a month for the first time, the mask will be cleared and the bit
-corresponding to your selected month will be selected. If you specify a second
-month, the bit corresponding to it will also be added to the mask. Thus when
-Bacula checks the masks to see if the bits are set corresponding to the
-current time, your job will run only in the two months you have set. Likewise,
-if you set a time (hour), the hour mask will be cleared, and the hour you
-specify will be set in the bit mask and the minutes will be stored in the
-minute field.
-
-For any schedule you have defined, you can see how these bits are set by doing
-a {\bf show schedules} command in the Console program. Please note that the
-bit mask is zero based, and Sunday is the first day of the week (bit zero).
-
-\input{fileset}
-
-\section{The Client Resource}
-\label{ClientResource2}
-\index[general]{Resource!Client}
-\index[general]{Client Resource}
-
-The Client resource defines the attributes of the Clients that are served by
-this Director; that is the machines that are to be backed up. You will need
-one Client resource definition for each machine to be backed up.
-
-\begin{description}
-
-\item [Client (or FileDaemon)]
- \index[dir]{Client (or FileDaemon)}
- \index[dir]{Directive!Client (or FileDaemon)}
- Start of the Client directives.
-
-\item [Name = \lt{}name\gt{}]
- \index[dir]{Name}
- \index[dir]{Directive!Name}
- The client name which will be used in the Job resource directive or in the
-console run command. This directive is required.
-
-\item [Address = \lt{}address\gt{}]
- \index[dir]{Address}
- \index[dir]{Directive!FD Address}
- \index[dir]{File Daemon Address}
- \index[dir]{Client Address}
- Where the address is a host name, a fully qualified domain name, or a
- network address in dotted quad notation for a Bacula File server daemon.
- This directive is required.
-
-\item [FD Port = \lt{}port-number\gt{}]
- \index[dir]{FD Port}
- \index[dir]{Directive!FD Port}
- Where the port is a port number at which the Bacula File server daemon can
- be contacted. The default is 9102.
-
-\item [Catalog = \lt{}Catalog-resource-name\gt{}]
- \index[dir]{Catalog}
- \index[dir]{Directive!Catalog}
- This specifies the name of the catalog resource to be used for this Client.
- This directive is required.
-
-\item [Password = \lt{}password\gt{}]
- \index[dir]{Password}
- \index[dir]{Directive!Password}
- This is the password to be used when establishing a connection with the File
- services, so the Client configuration file on the machine to be backed up
- must have the same password defined for this Director. This directive is
- required. If you have either {\bf /dev/random} {\bf bc} on your machine,
- Bacula will generate a random password during the configuration process,
- otherwise it will be left blank.
-
- The password is plain text. It is not generated through any special
- process, but it is preferable for security reasons to make the text
- random.
-
-\label{FileRetention}
-\item [File Retention = \lt{}time-period-specification\gt{}]
- \index[dir]{File Retention}
- \index[dir]{Directive!File Retention}
- The File Retention directive defines the length of time that Bacula will
- keep File records in the Catalog database after the End time of the
- Job corresponding to the File records.
- When this time period expires, and if
- {\bf AutoPrune} is set to {\bf yes} Bacula will prune (remove) File records
- that are older than the specified File Retention period. Note, this affects
- only records in the catalog database. It does not affect your archive
- backups.
-
- File records may actually be retained for a shorter period than you specify
- on this directive if you specify either a shorter {\bf Job Retention} or a
- shorter {\bf Volume Retention} period. The shortest retention period of the
- three takes precedence. The time may be expressed in seconds, minutes,
- hours, days, weeks, months, quarters, or years. See the
- \ilink{ Configuration chapter}{Time} of this manual for
- additional details of time specification.
-
- The default is 60 days.
-
-\label{JobRetention}
-\item [Job Retention = \lt{}time-period-specification\gt{}]
- \index[dir]{Job Retention}
- \index[dir]{Directive!Job Retention}
- The Job Retention directive defines the length of time that Bacula will keep
- Job records in the Catalog database after the Job End time. When
- this time period expires, and if {\bf AutoPrune} is set to {\bf yes}
- Bacula will prune (remove) Job records that are older than the specified
- File Retention period. As with the other retention periods, this
- affects only records in the catalog and not data in your archive backup.
-
- If a Job record is selected for pruning, all associated File and JobMedia
- records will also be pruned regardless of the File Retention period set.
- As a consequence, you normally will set the File retention period to be
- less than the Job retention period. The Job retention period can actually
- be less than the value you specify here if you set the {\bf Volume
- Retention} directive in the Pool resource to a smaller duration. This is
- because the Job retention period and the Volume retention period are
- independently applied, so the smaller of the two takes precedence.
-
- The Job retention period is specified as seconds, minutes, hours, days,
- weeks, months, quarters, or years. See the
- \ilink{ Configuration chapter}{Time} of this manual for
- additional details of time specification.
-
- The default is 180 days.
-
-\label{AutoPrune}
-\item [AutoPrune = \lt{}yes|no\gt{}]
- \index[dir]{AutoPrune}
- \index[dir]{Directive!AutoPrune}
- If AutoPrune is set to {\bf yes} (default), Bacula (version 1.20 or greater)
- will automatically apply the File retention period and the Job retention
- period for the Client at the end of the Job. If you set {\bf AutoPrune = no},
- pruning will not be done, and your Catalog will grow in size each time you
- run a Job. Pruning affects only information in the catalog and not data
- stored in the backup archives (on Volumes).
-
-\item [Maximum Concurrent Jobs = \lt{}number\gt{}]
- \index[dir]{Maximum Concurrent Jobs}
- \index[dir]{Directive!Maximum Concurrent Jobs}
- where \lt{}number\gt{} is the maximum number of Jobs with the current Client
- that can run concurrently. Note, this directive limits only Jobs for Clients
- with the same name as the resource in which it appears. Any other
- restrictions on the maximum concurrent jobs such as in the Director, Job, or
- Storage resources will also apply in addition to any limit specified here.
- The default is set to 1, but you may set it to a larger number. We strongly
- recommend that you read the WARNING documented under
- \ilink{ Maximum Concurrent Jobs}{DirMaxConJobs} in the Director's
- resource.
-
-\item [Priority = \lt{}number\gt{}]
- \index[dir]{Priority}
- \index[dir]{Directive!Priority}
- The number specifies the priority of this client relative to other clients
- that the Director is processing simultaneously. The priority can range from
- 1 to 1000. The clients are ordered such that the smaller number priorities
- are performed first (not currently implemented).
-\end{description}
-
- The following is an example of a valid Client resource definition:
-
-\footnotesize
-\begin{verbatim}
-Client {
- Name = Minimatou
- FDAddress = minimatou
- Catalog = MySQL
- Password = very_good
-}
-\end{verbatim}
-\normalsize
-
-\section{The Storage Resource}
-\label{StorageResource2}
-\index[general]{Resource!Storage}
-\index[general]{Storage Resource}
-
-The Storage resource defines which Storage daemons are available for use by
-the Director.
-
-\begin{description}
-
-\item [Storage]
- \index[dir]{Storage}
- \index[dir]{Directive!Storage}
- Start of the Storage resources. At least one storage resource must be
- specified.
-
-\item [Name = \lt{}name\gt{}]
- \index[dir]{Name}
- \index[dir]{Directive!Name}
- The name of the storage resource. This name appears on the Storage directive
- specified in the Job resource and is required.
-
-\item [Address = \lt{}address\gt{}]
- \index[dir]{Address}
- \index[dir]{Directive!SD Address}
- \index[dir]{Storage daemon Address}
- Where the address is a host name, a {\bf fully qualified domain name}, or an
- {\bf IP address}. Please note that the \lt{}address\gt{} as specified here
- will be transmitted to the File daemon who will then use it to contact the
- Storage daemon. Hence, it is {\bf not}, a good idea to use {\bf localhost} as
- the name but rather a fully qualified machine name or an IP address. This
- directive is required.
-
-\item [SD Port = \lt{}port\gt{}]
- \index[dir]{SD Port}
- \index[dir]{Directive!SD Port}
- Where port is the port to use to contact the storage daemon for information
- and to start jobs. This same port number must appear in the Storage resource
- of the Storage daemon's configuration file. The default is 9103.
-
-\item [Password = \lt{}password\gt{}]
- \index[dir]{Password}
- \index[dir]{Directive!Password}
- This is the password to be used when establishing a connection with the
- Storage services. This same password also must appear in the Director
- resource of the Storage daemon's configuration file. This directive is
- required. If you have either {\bf /dev/random} {\bf bc} on your machine,
- Bacula will generate a random password during the configuration process,
- otherwise it will be left blank.
-
- The password is plain text. It is not generated through any special
- process, but it is preferable for security reasons to use random text.
-
-\item [Device = \lt{}device-name\gt{}]
- \index[dir]{Device}
- \index[dir]{Directive!Device}
- This directive specifies the Storage daemon's name of the device
- resource to be used for the storage. If you are using an Autochanger,
- the name specified here should be the name of the Storage daemon's
- Autochanger resource rather than the name of an individual device. This
- name is not the physical device name, but the logical device name as
- defined on the {\bf Name} directive contained in the {\bf Device} or the
- {\bf Autochanger} resource definition of the {\bf Storage daemon}
- configuration file. You can specify any name you would like (even the
- device name if you prefer) up to a maximum of 127 characters in length.
- The physical device name associated with this device is specified in the
- {\bf Storage daemon} configuration file (as {\bf Archive Device}).
- Please take care not to define two different Storage resource directives
- in the Director that point to the same Device in the Storage daemon.
- Doing so may cause the Storage daemon to block (or hang) attempting to
- open the same device that is already open. This directive is required.
-
-\label{MediaType}
-\item [Media Type = \lt{}MediaType\gt{}]
- \index[dir]{Media Type}
- \index[dir]{Directive!Media Type}
- This directive specifies the Media Type to be used to store the data.
- This is an arbitrary string of characters up to 127 maximum that you
- define. It can be anything you want. However, it is best to make it
- descriptive of the storage media (e.g. File, DAT, "HP DLT8000", 8mm,
- ...). In addition, it is essential that you make the {\bf Media Type}
- specification unique for each storage media type. If you have two DDS-4
- drives that have incompatible formats, or if you have a DDS-4 drive and
- a DDS-4 autochanger, you almost certainly should specify different {\bf
- Media Types}. During a restore, assuming a {\bf DDS-4} Media Type is
- associated with the Job, Bacula can decide to use any Storage daemon
- that supports Media Type {\bf DDS-4} and on any drive that supports it.
-
- If you are writing to disk Volumes, you must make doubly sure that each
- Device resource defined in the Storage daemon (and hence in the
- Director's conf file) has a unique media type. Otherwise for Bacula
- versions 1.38 and older, your restores may not work because Bacula
- will assume that you can mount any Media Type with the same name on
- any Device associated with that Media Type. This is possible with
- tape drives, but with disk drives, unless you are very clever you
- cannot mount a Volume in any directory -- this can be done by creating
- an appropriate soft link.
-
- Currently Bacula permits only a single Media Type per Storage
- and Device definition. Consequently, if
- you have a drive that supports more than one Media Type, you can
- give a unique string to Volumes with different intrinsic Media
- Type (Media Type = DDS-3-4 for DDS-3 and DDS-4 types), but then
- those volumes will only be mounted on drives indicated with the
- dual type (DDS-3-4).
-
- If you want to tie Bacula to using a single Storage daemon or drive, you
- must specify a unique Media Type for that drive. This is an important
- point that should be carefully understood. Note, this applies equally
- to Disk Volumes. If you define more than one disk Device resource in
- your Storage daemon's conf file, the Volumes on those two devices are in
- fact incompatible because one can not be mounted on the other device
- since they are found in different directories. For this reason, you
- probably should use two different Media Types for your two disk Devices
- (even though you might think of them as both being File types). You can
- find more on this subject in the \ilink{Basic Volume
- Management}{DiskChapter} chapter of this manual.
-
- The {\bf MediaType} specified in the Director's Storage resource, {\bf
- must} correspond to the {\bf Media Type} specified in the {\bf Device}
- resource of the {\bf Storage daemon} configuration file. This directive
- is required, and it is used by the Director and the Storage daemon to
- ensure that a Volume automatically selected from the Pool corresponds to
- the physical device. If a Storage daemon handles multiple devices (e.g.
- will write to various file Volumes on different partitions), this
- directive allows you to specify exactly which device.
-
- As mentioned above, the value specified in the Director's Storage
- resource must agree with the value specified in the Device resource in
- the {\bf Storage daemon's} configuration file. It is also an additional
- check so that you don't try to write data for a DLT onto an 8mm device.
-
-\label{Autochanger1}
-\item [Autochanger = \lt{}yes|no\gt{}]
- \index[dir]{Autochanger}
- \index[dir]{Directive!Autochanger}
- If you specify {\bf yes} for this command (the default is {\bf no}),
- when you use the {\bf label} command or the {\bf add} command to create
- a new Volume, {\bf Bacula} will also request the Autochanger Slot
- number. This simplifies creating database entries for Volumes in an
- autochanger. If you forget to specify the Slot, the autochanger will
- not be used. However, you may modify the Slot associated with a Volume
- at any time by using the {\bf update volume} or {\bf update slots}
- command in the console program. When {\bf autochanger} is enabled, the
- algorithm used by Bacula to search for available volumes will be
- modified to consider only Volumes that are known to be in the
- autochanger's magazine. If no {\bf in changer} volume is found, Bacula
- will attempt recycling, pruning, ..., and if still no volume is found,
- Bacula will search for any volume whether or not in the magazine. By
- privileging in changer volumes, this procedure minimizes operator
- intervention. The default is {\bf no}.
-
- For the autochanger to be used, you must also specify {\bf Autochanger =
- yes} in the \ilink{Device Resource}{Autochanger} in the Storage daemon's
- configuration file as well as other important Storage daemon
- configuration information. Please consult the \ilink{Using
- Autochangers}{AutochangersChapter} manual of this chapter for the
- details of using autochangers.
-
-\item [Maximum Concurrent Jobs = \lt{}number\gt{}]
- \index[dir]{Maximum Concurrent Jobs}
- \index[dir]{Directive!Maximum Concurrent Jobs}
- where \lt{}number\gt{} is the maximum number of Jobs with the current
- Storage resource that can run concurrently. Note, this directive limits
- only Jobs for Jobs using this Storage daemon. Any other restrictions on
- the maximum concurrent jobs such as in the Director, Job, or Client
- resources will also apply in addition to any limit specified here. The
- default is set to 1, but you may set it to a larger number. However, if
- you set the Storage daemon's number of concurrent jobs greater than one,
- we recommend that you read the waring documented under \ilink{Maximum
- Concurrent Jobs}{DirMaxConJobs} in the Director's resource or simply
- turn data spooling on as documented in the \ilink{Data
- Spooling}{SpoolingChapter} chapter of this manual.
-
-\item [Heartbeat Interval = \lt{}time-interval\gt{}]
- \index[dir]{Heartbeat Interval}
- \index[dir]{Directive!Heartbeat}
- This directive is optional and if specified will cause the Director to
- set a keepalive interval (heartbeat) in seconds on each of the sockets
- it opens for the Storage resource. This value will override any
- specified at the Director level. It is implemented only on systems
- (Linux, ...) that provide the {\bf setsockopt} TCP\_KEEPIDLE function.
- The default value is zero, which means no change is made to the socket.
-
-\end{description}
-
-The following is an example of a valid Storage resource definition:
-
-\footnotesize
-\begin{verbatim}
-# Definition of tape storage device
-Storage {
- Name = DLTDrive
- Address = lpmatou
- Password = storage_password # password for Storage daemon
- Device = "HP DLT 80" # same as Device in Storage daemon
- Media Type = DLT8000 # same as MediaType in Storage daemon
-}
-\end{verbatim}
-\normalsize
-
-\section{The Pool Resource}
-\label{PoolResource}
-\index[general]{Resource!Pool}
-\index[general]{Pool Resource}
-
-The Pool resource defines the set of storage Volumes (tapes or files) to be
-used by Bacula to write the data. By configuring different Pools, you can
-determine which set of Volumes (media) receives the backup data. This permits,
-for example, to store all full backup data on one set of Volumes and all
-incremental backups on another set of Volumes. Alternatively, you could assign
-a different set of Volumes to each machine that you backup. This is most
-easily done by defining multiple Pools.
-
-Another important aspect of a Pool is that it contains the default attributes
-(Maximum Jobs, Retention Period, Recycle flag, ...) that will be given to a
-Volume when it is created. This avoids the need for you to answer a large
-number of questions when labeling a new Volume. Each of these attributes can
-later be changed on a Volume by Volume basis using the {\bf update} command in
-the console program. Note that you must explicitly specify which Pool Bacula
-is to use with each Job. Bacula will not automatically search for the correct
-Pool.
-
-Most often in Bacula installations all backups for all machines (Clients) go
-to a single set of Volumes. In this case, you will probably only use the {\bf
-Default} Pool. If your backup strategy calls for you to mount a different tape
-each day, you will probably want to define a separate Pool for each day. For
-more information on this subject, please see the
-\ilink{Backup Strategies}{StrategiesChapter} chapter of this
-manual.
-
-
-To use a Pool, there are three distinct steps. First the Pool must be defined
-in the Director's configuration file. Then the Pool must be written to the
-Catalog database. This is done automatically by the Director each time that it
-starts, or alternatively can be done using the {\bf create} command in the
-console program. Finally, if you change the Pool definition in the Director's
-configuration file and restart Bacula, the pool will be updated alternatively
-you can use the {\bf update pool} console command to refresh the database
-image. It is this database image rather than the Director's resource image
-that is used for the default Volume attributes. Note, for the pool to be
-automatically created or updated, it must be explicitly referenced by a Job
-resource.
-
-Next the physical media must be labeled. The labeling can either be done with
-the {\bf label} command in the {\bf console} program or using the {\bf btape}
-program. The preferred method is to use the {\bf label} command in the {\bf
-console} program.
-
-Finally, you must add Volume names (and their attributes) to the Pool. For
-Volumes to be used by Bacula they must be of the same {\bf Media Type} as the
-archive device specified for the job (i.e. if you are going to back up to a
-DLT device, the Pool must have DLT volumes defined since 8mm volumes cannot be
-mounted on a DLT drive). The {\bf Media Type} has particular importance if you
-are backing up to files. When running a Job, you must explicitly specify which
-Pool to use. Bacula will then automatically select the next Volume to use from
-the Pool, but it will ensure that the {\bf Media Type} of any Volume selected
-from the Pool is identical to that required by the Storage resource you have
-specified for the Job.
-
-If you use the {\bf label} command in the console program to label the
-Volumes, they will automatically be added to the Pool, so this last step is
-not normally required.
-
-It is also possible to add Volumes to the database without explicitly labeling
-the physical volume. This is done with the {\bf add} console command.
-
-As previously mentioned, each time Bacula starts, it scans all the Pools
-associated with each Catalog, and if the database record does not already
-exist, it will be created from the Pool Resource definition. {\bf Bacula}
-probably should do an {\bf update pool} if you change the Pool definition, but
-currently, you must do this manually using the {\bf update pool} command in
-the Console program.
-
-The Pool Resource defined in the Director's configuration file
-(bacula-dir.conf) may contain the following directives:
-
-\begin{description}
-
-\item [Pool]
- \index[dir]{Pool}
- \index[dir]{Directive!Pool}
- Start of the Pool resource. There must be at least one Pool resource
- defined.
-
-
-\item [Name = \lt{}name\gt{}]
- \index[dir]{Name}
- \index[dir]{Directive!Name}
- The name of the pool. For most applications, you will use the default
- pool name {\bf Default}. This directive is required.
-
-\label{MaxVolumes}
-\item [Maximum Volumes = \lt{}number\gt{}]
- \index[dir]{Maximum Volumes}
- \index[dir]{Directive!Maximum Volumes}
- This directive specifies the maximum number of volumes (tapes or files)
- contained in the pool. This directive is optional, if omitted or set to
- zero, any number of volumes will be permitted. In general, this
- directive is useful for Autochangers where there is a fixed number of
- Volumes, or for File storage where you wish to ensure that the backups
- made to disk files do not become too numerous or consume too much space.
-
-\item [Pool Type = \lt{}type\gt{}]
- \index[dir]{Pool Type}
- \index[dir]{Directive!Pool Type}
- This directive defines the pool type, which corresponds to the type of
- Job being run. It is required and may be one of the following:
-
-\begin{itemize}
- \item [Backup]
- \item [*Archive]
- \item [*Cloned]
- \item [*Migration]
- \item [*Copy]
- \item [*Save]
-\end{itemize}
- Note, only Backup is current implemented.
-
-\item [Storage = \lt{}storage-resource-name\gt{}]
-\index[dir]{Storage}
-\index[dir]{Directive!Storage}
- The Storage directive defines the name of the storage services where you
- want to backup the FileSet data. For additional details, see the
- \ilink{Storage Resource Chapter}{StorageResource2} of this manual.
- The Storage resource may also be specified in the Job resource,
- but the value, if any, in the Pool resource overrides any value
- in the Job. This Storage resource definition is not required by either
- the Job resource or in the Pool, but it must be specified in
- one or the other. If not configuration error will result.
-
-\item [Use Volume Once = \lt{}yes|no\gt{}]
- \index[dir]{Use Volume Once}
- \index[dir]{Directive!Use Volume Once}
- This directive if set to {\bf yes} specifies that each volume is to be
- used only once. This is most useful when the Media is a file and you
- want a new file for each backup that is done. The default is {\bf no}
- (i.e. use volume any number of times). This directive will most likely
- be phased out (deprecated), so you are recommended to use {\bf Maximum
- Volume Jobs = 1} instead.
-
- The value defined by this directive in the bacula-dir.conf file is the
- default value used when a Volume is created. Once the volume is
- created, changing the value in the bacula-dir.conf file will not change
- what is stored for the Volume. To change the value for an existing
- Volume you must use the {\bf update} command in the Console.
-
- Please see the notes below under {\bf Maximum Volume Jobs} concerning
- using this directive with multiple simultaneous jobs.
-
-\item [Maximum Volume Jobs = \lt{}positive-integer\gt{}]
- \index[dir]{Maximum Volume Jobs}
- \index[dir]{Directive!Maximum Volume Jobs}
- This directive specifies the maximum number of Jobs that can be written
- to the Volume. If you specify zero (the default), there is no limit.
- Otherwise, when the number of Jobs backed up to the Volume equals {\bf
- positive-integer} the Volume will be marked {\bf Used}. When the Volume
- is marked {\bf Used} it can no longer be used for appending Jobs, much
- like the {\bf Full} status but it can be recycled if recycling is
- enabled, and thus used again. By setting {\bf MaximumVolumeJobs} to
- one, you get the same effect as setting {\bf UseVolumeOnce = yes}.
-
- The value defined by this directive in the bacula-dir.conf
- file is the default value used when a Volume is created. Once the volume is
- created, changing the value in the bacula-dir.conf file will not change what
- is stored for the Volume. To change the value for an existing Volume you
- must use the {\bf update} command in the Console.
-
- If you are running multiple simultaneous jobs, this directive may not
- work correctly because when a drive is reserved for a job, this
- directive is not taken into account, so multiple jobs may try to
- start writing to the Volume. At some point, when the Media record is
- updated, multiple simultaneous jobs may fail since the Volume can no
- longer be written.
-
-\item [Maximum Volume Files = \lt{}positive-integer\gt{}]
- \index[dir]{Maximum Volume Files}
- \index[dir]{Directive!Maximum Volume Files}
- This directive specifies the maximum number of files that can be written
- to the Volume. If you specify zero (the default), there is no limit.
- Otherwise, when the number of files written to the Volume equals {\bf
- positive-integer} the Volume will be marked {\bf Used}. When the Volume
- is marked {\bf Used} it can no longer be used for appending Jobs, much
- like the {\bf Full} status but it can be recycled if recycling is
- enabled and thus used again. This value is checked and the {\bf Used}
- status is set only at the end of a job that writes to the particular
- volume.
-
- The value defined by this directive in the bacula-dir.conf file is the
- default value used when a Volume is created. Once the volume is
- created, changing the value in the bacula-dir.conf file will not change
- what is stored for the Volume. To change the value for an existing
- Volume you must use the {\bf update} command in the Console.
-
-\item [Maximum Volume Bytes = \lt{}size\gt{}]
- \index[dir]{Maximum Volume Bytes}
- \index[dir]{Directive!Maximum Volume Bytes}
- This directive specifies the maximum number of bytes that can be written
- to the Volume. If you specify zero (the default), there is no limit
- except the physical size of the Volume. Otherwise, when the number of
- bytes written to the Volume equals {\bf size} the Volume will be marked
- {\bf Used}. When the Volume is marked {\bf Used} it can no longer be
- used for appending Jobs, much like the {\bf Full} status but it can be
- recycled if recycling is enabled, and thus the Volume can be re-used
- after recycling. This value is checked and the {\bf Used} status set
- while the job is writing to the particular volume.
-
- This directive is particularly useful for restricting the size
- of disk volumes, and will work correctly even in the case of
- multiple simultaneous jobs writing to the volume.
-
- The value defined by this directive in the bacula-dir.conf file is the
- default value used when a Volume is created. Once the volume is
- created, changing the value in the bacula-dir.conf file will not change
- what is stored for the Volume. To change the value for an existing
- Volume you must use the {\bf update} command in the Console.
-
-\item [Volume Use Duration = \lt{}time-period-specification\gt{}]
- \index[dir]{Volume Use Duration}
- \index[dir]{Directive!Volume Use Duration}
- The Volume Use Duration directive defines the time period that the
- Volume can be written beginning from the time of first data write to the
- Volume. If the time-period specified is zero (the default), the Volume
- can be written indefinitely. Otherwise, the next time a job
- runs that wants to access this Volume, and the time period from the
- first write to the volume (the first Job written) exceeds the
- time-period-specification, the Volume will be marked {\bf Used}, which
- means that no more Jobs can be appended to the Volume, but it may be
- recycled if recycling is enabled. Using the command {\bf
- status dir} applies algorithms similar to running jobs, so
- during such a command, the Volume status may also be changed.
- Once the Volume is
- recycled, it will be available for use again.
-
- You might use this directive, for example, if you have a Volume used for
- Incremental backups, and Volumes used for Weekly Full backups. Once the
- Full backup is done, you will want to use a different Incremental
- Volume. This can be accomplished by setting the Volume Use Duration for
- the Incremental Volume to six days. I.e. it will be used for the 6
- days following a Full save, then a different Incremental volume will be
- used. Be careful about setting the duration to short periods such as 23
- hours, or you might experience problems of Bacula waiting for a tape
- over the weekend only to complete the backups Monday morning when an
- operator mounts a new tape.
-
- The use duration is checked and the {\bf Used} status is set only at the
- end of a job that writes to the particular volume, which means that even
- though the use duration may have expired, the catalog entry will not be
- updated until the next job that uses this volume is run. This
- directive is not intended to be used to limit volume sizes
- and will not work correctly (i.e. will fail jobs) if the use
- duration expires while multiple simultaneous jobs are writing
- to the volume.
-
- Please note that the value defined by this directive in the bacula-dir.conf
- file is the default value used when a Volume is created. Once the volume is
- created, changing the value in the bacula-dir.conf file will not change what
- is stored for the Volume. To change the value for an existing Volume you
- must use the
- \ilink{\bf update volume}{UpdateCommand} command in the Console.
-
-\item [Catalog Files = \lt{}yes|no\gt{}]
- \index[dir]{Catalog Files}
- \index[dir]{Directive!Catalog Files}
- This directive defines whether or not you want the names of the files
- that were saved to be put into the catalog. The default is {\bf yes}.
- The advantage of specifying {\bf Catalog Files = No} is that you will
- have a significantly smaller Catalog database. The disadvantage is that
- you will not be able to produce a Catalog listing of the files backed up
- for each Job (this is often called Browsing). Also, without the File
- entries in the catalog, you will not be able to use the Console {\bf
- restore} command nor any other command that references File entries.
-
-\label{PoolAutoPrune}
-\item [AutoPrune = \lt{}yes|no\gt{}]
- \index[dir]{AutoPrune}
- \index[dir]{Directive!AutoPrune}
- If AutoPrune is set to {\bf yes} (default), Bacula (version 1.20 or
- greater) will automatically apply the Volume Retention period when new
- Volume is needed and no appendable Volumes exist in the Pool. Volume
- pruning causes expired Jobs (older than the {\bf Volume Retention}
- period) to be deleted from the Catalog and permits possible recycling of
- the Volume.
-
-\label{VolRetention}
-\item [Volume Retention = \lt{}time-period-specification\gt{}]
- \index[dir]{Volume Retention}
- \index[dir]{Directive!Volume Retention}
- The Volume Retention directive defines the length of time that {\bf
- Bacula} will keep records associated with the Volume in
- the Catalog database after the End time of each Job written to the
- Volume. When this time period expires, and if {\bf AutoPrune} is set to
- {\bf yes} Bacula may prune (remove) Job records that are older than the
- specified Volume Retention period if it is necessary to free up a
- Volume. Recycling will not occur until it is absolutely necessary to
- free up a volume (i.e. no other writable volume exists).
- All File records associated with pruned Jobs are also
- pruned. The time may be specified as seconds, minutes, hours, days,
- weeks, months, quarters, or years. The {\bf Volume Retention} is
- applied independently of the {\bf Job Retention} and the {\bf File
- Retention} periods defined in the Client resource. This means that all
- the retentions periods are applied in turn and that the shorter period
- is the one that effectively takes precedence. Note, that when the {\bf
- Volume Retention} period has been reached, and it is necessary to obtain
- a new volume, Bacula will prune both the Job and the File records. This
- pruning could also occur during a {\bf status dir} command because it
- uses similar algorithms for finding the next available Volume.
-
- It is important to know that when the Volume Retention period expires,
- Bacula does not automatically recycle a Volume. It attempts to keep the
- Volume data intact as long as possible before over writing the Volume.
-
-
- By defining multiple Pools with different Volume Retention periods, you
- may effectively have a set of tapes that is recycled weekly, another
- Pool of tapes that is recycled monthly and so on. However, one must
- keep in mind that if your {\bf Volume Retention} period is too short, it
- may prune the last valid Full backup, and hence until the next Full
- backup is done, you will not have a complete backup of your system, and
- in addition, the next Incremental or Differential backup will be
- promoted to a Full backup. As a consequence, the minimum {\bf Volume
- Retention} period should be at twice the interval of your Full backups.
- This means that if you do a Full backup once a month, the minimum Volume
- retention period should be two months.
-
- The default Volume retention period is 365 days, and either the default
- or the value defined by this directive in the bacula-dir.conf file is
- the default value used when a Volume is created. Once the volume is
- created, changing the value in the bacula-dir.conf file will not change
- what is stored for the Volume. To change the value for an existing
- Volume you must use the {\bf update} command in the Console.
-
-\label{PoolRecyclePool}
-\item [RecyclePool = \lt{}pool-resource-name\gt{}]
- \index[dir]{RecyclePool}
- \index[dir]{Directive!RecyclePool}
- On versions 2.1.4 or greater, this directive defines to which pool
- the Volume will be placed (moved) when it is recycled. Without
- this directive, a Volume will remain in the same pool when it is
- recycled. With this directive, it can be moved automatically to any
- existing pool during a recycle. This directive is probably most
- useful when defined in the Scratch pool, so that volumes will
- be recycled back into the Scratch pool. For more on the see the
- \ilink{Scratch Pool}{TheScratchPool} section of this manual.
-
- Although this directive is called RecyclePool, the Volume in
- question is actually moved from its current pool to the one
- you specify on this directive when Bacula prunes the Volume and
- discovers that there are no records left in the catalog and hence
- marks it as {\bf Purged}.
-
-
-\label{PoolRecycle}
-\item [Recycle = \lt{}yes|no\gt{}]
- \index[dir]{Recycle}
- \index[dir]{Directive!Recycle}
- This directive specifies whether or not Purged Volumes may be recycled.
- If it is set to {\bf yes} (default) and Bacula needs a volume but finds
- none that are appendable, it will search for and recycle (reuse) Purged
- Volumes (i.e. volumes with all the Jobs and Files expired and thus
- deleted from the Catalog). If the Volume is recycled, all previous data
- written to that Volume will be overwritten. If Recycle is set to {\bf
- no}, the Volume will not be recycled, and hence, the data will remain
- valid. If you want to reuse (re-write) the Volume, and the recycle flag
- is no (0 in the catalog), you may manually set the recycle flag (update
- command) for a Volume to be reused.
-
- Please note that the value defined by this directive in the
- bacula-dir.conf file is the default value used when a Volume is created.
- Once the volume is created, changing the value in the bacula-dir.conf
- file will not change what is stored for the Volume. To change the value
- for an existing Volume you must use the {\bf update} command in the
- Console.
-
- When all Job and File records have been pruned or purged from the
- catalog for a particular Volume, if that Volume is marked as
- Append, Full, Used, or Error, it will then be marked as Purged. Only
- Volumes marked as Purged will be considered to be converted to the
- Recycled state if the {\bf Recycle} directive is set to {\bf yes}.
-
-
-\label{RecycleOldest}
-\item [Recycle Oldest Volume = \lt{}yes|no\gt{}]
- \index[dir]{Recycle Oldest Volume}
- \index[dir]{Directive!Recycle Oldest Volume}
- This directive instructs the Director to search for the oldest used
- Volume in the Pool when another Volume is requested by the Storage
- daemon and none are available. The catalog is then {\bf pruned}
- respecting the retention periods of all Files and Jobs written to this
- Volume. If all Jobs are pruned (i.e. the volume is Purged), then the
- Volume is recycled and will be used as the next Volume to be written.
- This directive respects any Job, File, or Volume retention periods that
- you may have specified, and as such it is {\bf much} better to use this
- directive than the Purge Oldest Volume.
-
- This directive can be useful if you have a fixed number of Volumes in the
- Pool and you want to cycle through them and you have specified the correct
- retention periods.
-
- However, if you use this directive and have only one
- Volume in the Pool, you will immediately recycle your Volume if you fill
- it and Bacula needs another one. Thus your backup will be totally invalid.
- Please use this directive with care. The default is {\bf no}.
-
-\label{RecycleCurrent}
-
-\item [Recycle Current Volume = \lt{}yes|no\gt{}]
- \index[dir]{Recycle Current Volume}
- \index[dir]{Directive!Recycle Current Volume}
- If Bacula needs a new Volume, this directive instructs Bacula to Prune
- the volume respecting the Job and File retention periods. If all Jobs
- are pruned (i.e. the volume is Purged), then the Volume is recycled and
- will be used as the next Volume to be written. This directive respects
- any Job, File, or Volume retention periods that you may have specified,
- and thus it is {\bf much} better to use it rather than the Purge Oldest
- Volume directive.
-
- This directive can be useful if you have: a fixed number of Volumes in
- the Pool, you want to cycle through them, and you have specified
- retention periods that prune Volumes before you have cycled through the
- Volume in the Pool.
-
- However, if you use this directive and have only one Volume in the Pool,
- you will immediately recycle your Volume if you fill it and Bacula needs
- another one. Thus your backup will be totally invalid. Please use this
- directive with care. The default is {\bf no}.
-
-\label{PurgeOldest}
-
-\item [Purge Oldest Volume = \lt{}yes|no\gt{}]
- \index[dir]{Purge Oldest Volume}
- \index[dir]{Directive!Purge Oldest Volume}
- This directive instructs the Director to search for the oldest used
- Volume in the Pool when another Volume is requested by the Storage
- daemon and none are available. The catalog is then {\bf purged}
- irrespective of retention periods of all Files and Jobs written to this
- Volume. The Volume is then recycled and will be used as the next Volume
- to be written. This directive overrides any Job, File, or Volume
- retention periods that you may have specified.
-
- This directive can be useful if you have a fixed number of Volumes in
- the Pool and you want to cycle through them and reusing the oldest one
- when all Volumes are full, but you don't want to worry about setting
- proper retention periods. However, by using this option you risk losing
- valuable data.
-
- Please be aware that {\bf Purge Oldest Volume} disregards all retention
- periods. If you have only a single Volume defined and you turn this
- variable on, that Volume will always be immediately overwritten when it
- fills! So at a minimum, ensure that you have a decent number of Volumes
- in your Pool before running any jobs. If you want retention periods to
- apply do not use this directive. To specify a retention period, use the
- {\bf Volume Retention} directive (see above).
-
- We {\bf highly} recommend against using this directive, because it is
- sure that some day, Bacula will recycle a Volume that contains current
- data. The default is {\bf no}.
-
-\item [Cleaning Prefix = \lt{}string\gt{}]
- \index[dir]{Cleaning Prefix}
- \index[dir]{Directive!Cleaning Prefix}
- This directive defines a prefix string, which if it matches the
- beginning of a Volume name during labeling of a Volume, the Volume will
- be defined with the VolStatus set to {\bf Cleaning} and thus Bacula will
- never attempt to use this tape. This is primarily for use with
- autochangers that accept barcodes where the convention is that barcodes
- beginning with {\bf CLN} are treated as cleaning tapes.
-
-\label{Label}
-\item [Label Format = \lt{}format\gt{}]
- \index[dir]{Label Format}
- \index[dir]{Directive!Label Format}
- This directive specifies the format of the labels contained in this
- pool. The format directive is used as a sort of template to create new
- Volume names during automatic Volume labeling.
-
- The {\bf format} should be specified in double quotes, and consists of
- letters, numbers and the special characters hyphen ({\bf -}), underscore
- ({\bf \_}), colon ({\bf :}), and period ({\bf .}), which are the legal
- characters for a Volume name. The {\bf format} should be enclosed in
- double quotes (").
-
- In addition, the format may contain a number of variable expansion
- characters which will be expanded by a complex algorithm allowing you to
- create Volume names of many different formats. In all cases, the
- expansion process must resolve to the set of characters noted above that
- are legal Volume names. Generally, these variable expansion characters
- begin with a dollar sign ({\bf \$}) or a left bracket ({\bf [}). If you
- specify variable expansion characters, you should always enclose the
- format with double quote characters ({\bf "}). For more details on
- variable expansion, please see the \ilink{Variable
- Expansion}{VarsChapter} Chapter of this manual.
-
- If no variable expansion characters are found in the string, the Volume
- name will be formed from the {\bf format} string appended with the
- number of volumes in the pool plus one, which will be edited as four
- digits with leading zeros. For example, with a {\bf Label Format =
- "File-"}, the first volumes will be named {\bf File-0001}, {\bf
- File-0002}, ...
-
- With the exception of Job specific variables, you can test your {\bf
- LabelFormat} by using the \ilink{ var command}{var} the Console Chapter
- of this manual.
-
- In almost all cases, you should enclose the format specification (part
- after the equal sign) in double quotes. Please note that this directive
- is deprecated and is replaced in version 1.37 and greater with a Python
- script for creating volume names.
-
-\end{description}
-
-In order for a Pool to be used during a Backup Job, the Pool must have at
-least one Volume associated with it. Volumes are created for a Pool using
-the {\bf label} or the {\bf add} commands in the {\bf Bacula Console},
-program. In addition to adding Volumes to the Pool (i.e. putting the
-Volume names in the Catalog database), the physical Volume must be labeled
-with a valid Bacula software volume label before {\bf Bacula} will accept
-the Volume. This will be automatically done if you use the {\bf label}
-command. Bacula can automatically label Volumes if instructed to do so,
-but this feature is not yet fully implemented.
-
-The following is an example of a valid Pool resource definition:
-
-\footnotesize
-\begin{verbatim}
-
-Pool {
- Name = Default
- Pool Type = Backup
-}
-\end{verbatim}
-\normalsize
-
-\subsection{The Scratch Pool}
-\label{TheScratchPool}
-\index[general]{Scratch Pool}
-In general, you can give your Pools any name you wish, but there is one
-important restriction: the Pool named {\bf Scratch}, if it exists behaves
-like a scratch pool of Volumes in that when Bacula needs a new Volume for
-writing and it cannot find one, it will look in the Scratch pool, and if
-it finds an available Volume, it will move it out of the Scratch pool into
-the Pool currently being used by the job.
-
-
-\section{The Catalog Resource}
-\label{CatalogResource}
-\index[general]{Resource!Catalog}
-\index[general]{Catalog Resource}
-
-The Catalog Resource defines what catalog to use for the current job.
-Currently, Bacula can only handle a single database server (SQLite, MySQL,
-PostgreSQL) that is defined when configuring {\bf Bacula}. However, there
-may be as many Catalogs (databases) defined as you wish. For example, you
-may want each Client to have its own Catalog database, or you may want
-backup jobs to use one database and verify or restore jobs to use another
-database.
-
-Since SQLite is compiled in, it always runs on the same machine
-as the Director and the database must be directly accessible (mounted) from
-the Director. However, since both MySQL and PostgreSQL are networked
-databases, they may reside either on the same machine as the Director
-or on a different machine on the network. See below for more details.
-
-\begin{description}
-
-\item [Catalog]
- \index[dir]{Catalog}
- \index[dir]{Directive!Catalog}
- Start of the Catalog resource. At least one Catalog resource must be
-defined.
-
-
-\item [Name = \lt{}name\gt{}]
- \index[dir]{Name}
- \index[dir]{Directive!Name}
- The name of the Catalog. No necessary relation to the database server
- name. This name will be specified in the Client resource directive
- indicating that all catalog data for that Client is maintained in this
- Catalog. This directive is required.
-
-\item [password = \lt{}password\gt{}]
- \index[dir]{password}
- \index[dir]{Directive!password}
- This specifies the password to use when logging into the database. This
- directive is required.
-
-\item [DB Name = \lt{}name\gt{}]
- \index[dir]{DB Name}
- \index[dir]{Directive!DB Name}
- This specifies the name of the database. If you use multiple catalogs
- (databases), you specify which one here. If you are using an external
- database server rather than the internal one, you must specify a name
- that is known to the server (i.e. you explicitly created the Bacula
- tables using this name. This directive is required.
-
-\item [user = \lt{}user\gt{}]
- \index[dir]{user}
- \index[dir]{Directive!user}
- This specifies what user name to use to log into the database. This
- directive is required.
-
-\item [DB Socket = \lt{}socket-name\gt{}]
- \index[dir]{DB Socket}
- \index[dir]{Directive!DB Socket}
- This is the name of a socket to use on the local host to connect to the
- database. This directive is used only by MySQL and is ignored by SQLite.
- Normally, if neither {\bf DB Socket} or {\bf DB Address} are specified, MySQL
- will use the default socket. If the DB Socket is specified, the
- MySQL server must reside on the same machine as the Director.
-
-\item [DB Address = \lt{}address\gt{}]
- \index[dir]{DB Address}
- \index[dir]{Directive!DB Address}
- This is the host address of the database server. Normally, you would specify
- this instead of {\bf DB Socket} if the database server is on another machine.
- In that case, you will also specify {\bf DB Port}. This directive is used
- only by MySQL and PostgreSQL and is ignored by SQLite if provided.
- This directive is optional.
-
-\item [DB Port = \lt{}port\gt{}]
- \index[dir]{DB Port}
- \index[dir]{Directive!DB Port}
- This defines the port to be used in conjunction with {\bf DB Address} to
- access the database if it is on another machine. This directive is used only
- by MySQL and PostgreSQL and is ignored by SQLite if provided. This
- directive is optional.
-
-%% \item [Multiple Connections = \lt{}yes|no\gt{}]
-%% \index[dir]{Multiple Connections}
-%% \index[dir]{Directive!Multiple Connections}
-%% By default, this directive is set to no. In that case, each job that uses
-the
-%% same Catalog will use a single connection to the catalog. It will be shared,
-%% and Bacula will allow only one Job at a time to communicate. If you set this
-%% directive to yes, Bacula will permit multiple connections to the database,
-%% and the database must be multi-thread capable. For SQLite and PostgreSQL,
-%% this is no problem. For MySQL, you must be *very* careful to have the
-%% multi-thread version of the client library loaded on your system. When this
-%% directive is set yes, each Job will have a separate connection to the
-%% database, and the database will control the interaction between the
-different
-%% Jobs. This can significantly speed up the database operations if you are
-%% running multiple simultaneous jobs. In addition, for SQLite and PostgreSQL,
-%% Bacula will automatically enable transactions. This can significantly speed
-%% up insertion of attributes in the database either for a single Job or
-%% multiple simultaneous Jobs.
-
-%% This directive has not been tested. Please test carefully before running it
-%% in production and report back your results.
-
-\end{description}
-
-The following is an example of a valid Catalog resource definition:
-
-\footnotesize
-\begin{verbatim}
-Catalog
-{
- Name = SQLite
- dbname = bacula;
- user = bacula;
- password = "" # no password = no security
-}
-\end{verbatim}
-\normalsize
-
-or for a Catalog on another machine:
-
-\footnotesize
-\begin{verbatim}
-Catalog
-{
- Name = MySQL
- dbname = bacula
- user = bacula
- password = ""
- DB Address = remote.acme.com
- DB Port = 1234
-}
-\end{verbatim}
-\normalsize
-
-\section{The Messages Resource}
-\label{MessagesResource2}
-\index[general]{Resource!Messages}
-\index[general]{Messages Resource}
-
-For the details of the Messages Resource, please see the
-\ilink{Messages Resource Chapter}{MessagesChapter} of this
-manual.
-
-\section{The Console Resource}
-\label{ConsoleResource1}
-\index[general]{Console Resource}
-\index[general]{Resource!Console}
-
-As of Bacula version 1.33 and higher, there are three different kinds of
-consoles, which the administrator or user can use to interact with the
-Director. These three kinds of consoles comprise three different security
-levels.
-
-\begin{itemize}
-\item The first console type is an {\bf anonymous} or {\bf default} console,
- which has full privileges. There is no console resource necessary for
- this type since the password is specified in the Director's resource and
- consequently such consoles do not have a name as defined on a {\bf Name
- =} directive. This is the kind of console that was initially
- implemented in versions prior to 1.33 and remains valid. Typically you
- would use it only for administrators.
-
-\item The second type of console, and new to version 1.33 and higher is a
- "named" console defined within a Console resource in both the Director's
- configuration file and in the Console's configuration file. Both the
- names and the passwords in these two entries must match much as is the
- case for Client programs.
-
- This second type of console begins with absolutely no privileges except
- those explicitly specified in the Director's Console resource. Thus you
- can have multiple Consoles with different names and passwords, sort of
- like multiple users, each with different privileges. As a default,
- these consoles can do absolutely nothing -- no commands whatsoever. You
- give them privileges or rather access to commands and resources by
- specifying access control lists in the Director's Console resource. The
- ACLs are specified by a directive followed by a list of access names.
- Examples of this are shown below.
-
-\item The third type of console is similar to the above mentioned one in that
- it requires a Console resource definition in both the Director and the
- Console. In addition, if the console name, provided on the {\bf Name =}
- directive, is the same as a Client name, that console is permitted to
- use the {\bf SetIP} command to change the Address directive in the
- Director's client resource to the IP address of the Console. This
- permits portables or other machines using DHCP (non-fixed IP addresses)
- to "notify" the Director of their current IP address.
-\end{itemize}
-
-The Console resource is optional and need not be specified. The following
-directives are permitted within the Director's configuration resource:
-
-\begin{description}
-
-\item [Name = \lt{}name\gt{}]
- \index[dir]{Name}
- \index[dir]{Directive!Name}
- The name of the console. This name must match the name specified in the
-Console's configuration resource (much as is the case with Client
-definitions).
-
-\item [Password = \lt{}password\gt{}]
- \index[dir]{Password}
- \index[dir]{Directive!Password}
- Specifies the password that must be supplied for a named Bacula Console
- to be authorized. The same password must appear in the {\bf Console}
- resource of the Console configuration file. For added security, the
- password is never actually passed across the network but rather a
- challenge response hash code created with the password. This directive
- is required. If you have either {\bf /dev/random} {\bf bc} on your
- machine, Bacula will generate a random password during the configuration
- process, otherwise it will be left blank.
-
- The password is plain text. It is not generated through any special
- process. However, it is preferable for security reasons to choose
- random text.
-
-\item [JobACL = \lt{}name-list\gt{}]
- \index[dir]{JobACL}
- \index[dir]{Directive!JobACL}
- This directive is used to specify a list of Job resource names that can
- be accessed by the console. Without this directive, the console cannot
- access any of the Director's Job resources. Multiple Job resource names
- may be specified by separating them with commas, and/or by specifying
- multiple JobACL directives. For example, the directive may be specified
- as:
-
-\footnotesize
-\begin{verbatim}
- JobACL = kernsave, "Backup client 1", "Backup client 2"
- JobACL = "RestoreFiles"
-
-\end{verbatim}
-\normalsize
-
-With the above specification, the console can access the Director's resources
-for the four jobs named on the JobACL directives, but for no others.
-
-\item [ClientACL = \lt{}name-list\gt{}]
- \index[dir]{ClientACL}
- \index[dir]{Directive!ClientACL}
- This directive is used to specify a list of Client resource names that can
-be
-accessed by the console.
-
-\item [StorageACL = \lt{}name-list\gt{}]
- \index[dir]{StorageACL}
- \index[dir]{Directive!StorageACL}
- This directive is used to specify a list of Storage resource names that can
-be accessed by the console.
-
-\item [ScheduleACL = \lt{}name-list\gt{}]
- \index[dir]{ScheduleACL}
- \index[dir]{Directive!ScheduleACL}
- This directive is used to specify a list of Schedule resource names that can
- be accessed by the console.
-
-\item [PoolACL = \lt{}name-list\gt{}]
- \index[dir]{PoolACL}
- \index[dir]{Directive!PoolACL}
- This directive is used to specify a list of Pool resource names that can be
- accessed by the console.
-
-\item [FileSetACL = \lt{}name-list\gt{}]
- \index[dir]{FileSetACL}
- \index[dir]{Directive!FileSetACL}
- This directive is used to specify a list of FileSet resource names that
- can be accessed by the console.
-
-\item [CatalogACL = \lt{}name-list\gt{}]
- \index[dir]{CatalogACL}
- \index[dir]{Directive!CatalogACL}
- This directive is used to specify a list of Catalog resource names that
- can be accessed by the console.
-
-\item [CommandACL = \lt{}name-list\gt{}]
- \index[dir]{CommandACL}
- \index[dir]{Directive!CommandACL}
- This directive is used to specify a list of of console commands that can
- be executed by the console.
-
-\item [WhereACL = \lt{}string\gt{}]
- \index[dir]{WhereACL}
- \index[dir]{Directive!WhereACL}
- This directive permits you to specify where a restricted console
- can restore files. If this directive is not specified, only the
- default restore location is permitted (normally {\bf
- /tmp/bacula-restores}. If {\bf *all*} is specified any path the
- user enters will be accepted (not very secure), any other
- value specified (there may be multiple WhereACL directives) will
- restrict the user to use that path. For example, on a Unix system,
- if you specify "/", the file will be restored to the original
- location. This directive is untested.
-
-\end{description}
-
-Aside from Director resource names and console command names, the special
-keyword {\bf *all*} can be specified in any of the above access control lists.
-When this keyword is present, any resource or command name (which ever is
-appropriate) will be accepted. For an example configuration file, please see
-the
-\ilink{Console Configuration}{ConsoleConfChapter} chapter of this
-manual.
-
-\section{The Counter Resource}
-\label{CounterResource}
-\index[general]{Resource!Counter}
-\index[general]{Counter Resource}
-
-The Counter Resource defines a counter variable that can be accessed by
-variable expansion used for creating Volume labels with the {\bf LabelFormat}
-directive. See the
-\ilink{LabelFormat}{Label} directive in this chapter for more
-details.
-
-\begin{description}
-
-\item [Counter]
- \index[dir]{Counter}
- \index[dir]{Directive!Counter}
- Start of the Counter resource. Counter directives are optional.
-
-\item [Name = \lt{}name\gt{}]
- \index[dir]{Name}
- \index[dir]{Directive!Name}
- The name of the Counter. This is the name you will use in the variable
-expansion to reference the counter value.
-
-\item [Minimum = \lt{}integer\gt{}]
- \index[dir]{Minimum}
- \index[dir]{Directive!Minimum}
- This specifies the minimum value that the counter can have. It also becomes
-the default. If not supplied, zero is assumed.
-
-\item [Maximum = \lt{}integer\gt{}]
- \index[dir]{Maximum}
- \index[dir]{Directive!Maximum}
- \index[dir]{Directive!Maximum}
- This is the maximum value value that the counter can have. If not specified
-or set to zero, the counter can have a maximum value of 2,147,483,648 (2 to
-the 31 power). When the counter is incremented past this value, it is reset
-to the Minimum.
-
-\item [*WrapCounter = \lt{}counter-name\gt{}]
- \index[dir]{*WrapCounter}
- \index[dir]{Directive!*WrapCounter}
- If this value is specified, when the counter is incremented past the
-maximum
-and thus reset to the minimum, the counter specified on the {\bf WrapCounter}
-is incremented. (This is not currently implemented).
-
-\item [Catalog = \lt{}catalog-name\gt{}]
- \index[dir]{Catalog}
- \index[dir]{Directive!Catalog}
- If this directive is specified, the counter and its values will be saved in
-the specified catalog. If this directive is not present, the counter will be
-redefined each time that Bacula is started.
-\end{description}
-
-\section{Example Director Configuration File}
-\label{SampleDirectorConfiguration}
-\index[general]{File!Example Director Configuration}
-\index[general]{Example Director Configuration File}
-
-An example Director configuration file might be the following:
-
-\footnotesize
-\begin{verbatim}
-#
-# Default Bacula Director Configuration file
-#
-# The only thing that MUST be changed is to add one or more
-# file or directory names in the Include directive of the
-# FileSet resource.
-#
-# For Bacula release 1.15 (5 March 2002) -- redhat
-#
-# You might also want to change the default email address
-# from root to your address. See the "mail" and "operator"
-# directives in the Messages resource.
-#
-Director { # define myself
- Name = rufus-dir
- QueryFile = "/home/kern/bacula/bin/query.sql"
- WorkingDirectory = "/home/kern/bacula/bin/working"
- PidDirectory = "/home/kern/bacula/bin/working"
- Password = "XkSfzu/Cf/wX4L8Zh4G4/yhCbpLcz3YVdmVoQvU3EyF/"
-}
-# Define the backup Job
-Job {
- Name = "NightlySave"
- Type = Backup
- Level = Incremental # default
- Client=rufus-fd
- FileSet="Full Set"
- Schedule = "WeeklyCycle"
- Storage = DLTDrive
- Messages = Standard
- Pool = Default
-}
-Job {
- Name = "Restore"
- Type = Restore
- Client=rufus-fd
- FileSet="Full Set"
- Where = /tmp/bacula-restores
- Storage = DLTDrive
- Messages = Standard
- Pool = Default
-}
-
-# List of files to be backed up
-FileSet {
- Name = "Full Set"
- Include {
- Options { signature=SHA1}
-#
-# Put your list of files here, one per line or include an
-# external list with:
-#
-# @file-name
-#
-# Note: / backs up everything
- File = /
-}
- Exclude {}
-}
-# When to do the backups
-Schedule {
- Name = "WeeklyCycle"
- Run = level=Full sun at 2:05
- Run = level=Incremental mon-sat at 2:05
-}
-# Client (File Services) to backup
-Client {
- Name = rufus-fd
- Address = rufus
- Catalog = MyCatalog
- Password = "MQk6lVinz4GG2hdIZk1dsKE/LxMZGo6znMHiD7t7vzF+"
- File Retention = 60d # sixty day file retention
- Job Retention = 1y # 1 year Job retention
- AutoPrune = yes # Auto apply retention periods
-}
-# Definition of DLT tape storage device
-Storage {
- Name = DLTDrive
- Address = rufus
- Password = "jMeWZvfikUHvt3kzKVVPpQ0ccmV6emPnF2cPYFdhLApQ"
- Device = "HP DLT 80" # same as Device in Storage daemon
- Media Type = DLT8000 # same as MediaType in Storage daemon
-}
-# Definition for a DLT autochanger device
-Storage {
- Name = Autochanger
- Address = rufus
- Password = "jMeWZvfikUHvt3kzKVVPpQ0ccmV6emPnF2cPYFdhLApQ"
- Device = "Autochanger" # same as Device in Storage daemon
- Media Type = DLT-8000 # Different from DLTDrive
- Autochanger = yes
-}
-# Definition of DDS tape storage device
-Storage {
- Name = SDT-10000
- Address = rufus
- Password = "jMeWZvfikUHvt3kzKVVPpQ0ccmV6emPnF2cPYFdhLApQ"
- Device = SDT-10000 # same as Device in Storage daemon
- Media Type = DDS-4 # same as MediaType in Storage daemon
-}
-# Definition of 8mm tape storage device
-Storage {
- Name = "8mmDrive"
- Address = rufus
- Password = "jMeWZvfikUHvt3kzKVVPpQ0ccmV6emPnF2cPYFdhLApQ"
- Device = "Exabyte 8mm"
- MediaType = "8mm"
-}
-# Definition of file storage device
-Storage {
- Name = File
- Address = rufus
- Password = "jMeWZvfikUHvt3kzKVVPpQ0ccmV6emPnF2cPYFdhLApQ"
- Device = FileStorage
- Media Type = File
-}
-# Generic catalog service
-Catalog {
- Name = MyCatalog
- dbname = bacula; user = bacula; password = ""
-}
-# Reasonable message delivery -- send most everything to
-# the email address and to the console
-Messages {
- Name = Standard
- mail = root@localhost = all, !skipped, !terminate
- operator = root@localhost = mount
- console = all, !skipped, !saved
-}
-
-# Default pool definition
-Pool {
- Name = Default
- Pool Type = Backup
- AutoPrune = yes
- Recycle = yes
-}
-#
-# Restricted console used by tray-monitor to get the status of the director
-#
-Console {
- Name = Monitor
- Password = "GN0uRo7PTUmlMbqrJ2Gr1p0fk0HQJTxwnFyE4WSST3MWZseR"
- CommandACL = status, .status
-}
-\end{verbatim}
-\normalsize
+++ /dev/null
-#
-# Avoid that @VERSION@ and @DATE@ are changed by configure
-# This file is sourced by update_version
-#
-echo "s%@VERSION@%${VERSION}%g" >${out}
-echo "s%@DATE@%${DATE}%g" >>${out}
+++ /dev/null
-%%
-%%
-
-\chapter{Client/File daemon Configuration}
-\label{FiledConfChapter}
-\index[general]{Configuration!Client/File daemon }
-\index[general]{Client/File daemon Configuration }
-
-The Client (or File Daemon) Configuration is one of the simpler ones to
-specify. Generally, other than changing the Client name so that error messages
-are easily identified, you will not need to modify the default Client
-configuration file.
-
-For a general discussion of configuration file and resources including the
-data types recognized by {\bf Bacula}, please see the
-\ilink{Configuration}{ConfigureChapter} chapter of this manual. The
-following Client Resource definitions must be defined:
-
-\begin{itemize}
-\item
- \ilink{Client}{ClientResource} -- to define what Clients are to
- be backed up.
-\item
- \ilink{Director}{DirectorResource} -- to define the Director's
- name and its access password.
-\item
- \ilink{Messages}{MessagesChapter} -- to define where error and
- information messages are to be sent.
-\end{itemize}
-
-\section{The Client Resource}
-\label{ClientResource}
-\index[general]{Resource!Client }
-\index[general]{Client Resource }
-
-The Client Resource (or FileDaemon) resource defines the name of the Client
-(as used by the Director) as well as the port on which the Client listens for
-Director connections.
-
-\begin{description}
-
-\item [Client (or FileDaemon)]
- \index[fd]{Client (or FileDaemon)}
- \index[fd]{Directive!Client (or FileDaemon)}
- Start of the Client records. There must be one and only one Client resource
- in the configuration file, since it defines the properties of the current
- client program.
-
-\item [Name = \lt{}name\gt{}]
- \index[fd]{Name}
- \index[fd]{Directive!Name}
- The client name that must be used by the Director when connecting. Generally,
- it is a good idea to use a name related to the machine so that error messages
- can be easily identified if you have multiple Clients. This directive is
- required.
-
-\item [Working Directory = \lt{}Directory\gt{}]
- \index[fd]{Working Directory}
- \index[fd]{Directive!Working Directory}
- This directive is mandatory and specifies a directory in which the File
- daemon may put its status files. This directory should be used only by {\bf
- Bacula}, but may be shared by other Bacula daemons provided the daemon
- names on the {\bf Name} definition are unique for each daemon. This directive
- is required.
-
- On Win32 systems, in some circumstances you may need to specify a drive
- letter in the specified working directory path. Also, please be sure
- that this directory is writable by the SYSTEM user otherwise restores
- may fail (the bootstrap file that is transferred to the File daemon from
- the Director is temporarily put in this directory before being passed
- to the Storage daemon).
-
-\item [Pid Directory = \lt{}Directory\gt{}]
- \index[fd]{Pid Directory}
- \index[fd]{Directive!Pid Directory}
- This directive is mandatory and specifies a directory in which the Director
- may put its process Id file files. The process Id file is used to shutdown
- Bacula and to prevent multiple copies of Bacula from running simultaneously.
- This record is required. Standard shell expansion of the {\bf Directory} is
- done when the configuration file is read so that values such as {\bf \$HOME}
- will be properly expanded.
-
- Typically on Linux systems, you will set this to: {\bf /var/run}. If you are
- not installing Bacula in the system directories, you can use the {\bf Working
- Directory} as defined above.
-
-\item [Heartbeat Interval = \lt{}time-interval\gt{}]
- \index[fd]{Heartbeat Interval}
- \index[fd]{Directive!Heartbeat Interval}
- \index[general]{Heartbeat Interval}
- \index[general]{Broken pipe}
- \index[general]{slow}
- \index[general]{Backups!slow}
- This record defines an interval of time. For each heartbeat that the
- File daemon receives from the Storage daemon, it will forward it to the
- Director. In addition, if no heartbeat has been received from the
- Storage daemon and thus forwarded the File daemon will send a heartbeat
- signal to the Director and to the Storage daemon to keep the channels
- active. The default interval is zero which disables the heartbeat.
- This feature is particularly useful if you have a router such as 3Com
- that does not follow Internet standards and times out a valid
- connection after a short duration despite the fact that keepalive is
- set. This usually results in a broken pipe error message.
-
- If you continue getting broken pipe error messages despite using the
- Heartbeat Interval, and you are using Windows, you should consider
- upgrading your ethernet driver. This is a known problem with NVidia
- NForce 3 drivers (4.4.2 17/05/2004), or try the following workaround
- suggested by Thomas Simmons for Win32 machines:
-
- Browse to:
- Start \gt{} Control Panel \gt{} Network Connections
-
- Right click the connection for the nvidia adapter and select properties.
- Under the General tab, click "Configure...". Under the Advanced tab set
- "Checksum Offload" to disabled and click OK to save the change.
-
- Lack of communications, or communications that get interrupted can
- also be caused by Linux firewalls where you have a rule that throttles
- connections or traffic.
-
-
-\item [Maximum Concurrent Jobs = \lt{}number\gt{}]
- \index[fd]{Maximum Concurrent Jobs}
- \index[fd]{Directive!Maximum Concurrent Jobs}
- where \lt{}number\gt{} is the maximum number of Jobs that should run
- concurrently. The default is set to 2, but you may set it to a larger
- number. Each contact from the Director (e.g. status request, job start
- request) is considered as a Job, so if you want to be able to do a {\bf
- status} request in the console at the same time as a Job is running, you
- will need to set this value greater than 1.
-
-\item [FDAddresses = \lt{}IP-address-specification\gt{}]
- \index[fd]{FDAddresses}
- \index[fd]{Directive!FDAddresses}
- Specify the ports and addresses on which the File daemon listens for
- Director connections. Probably the simplest way to explain is to show
- an example:
-
-\footnotesize
-\begin{verbatim}
- FDAddresses = {
- ip = { addr = 1.2.3.4; port = 1205; }
- ipv4 = {
- addr = 1.2.3.4; port = http; }
- ipv6 = {
- addr = 1.2.3.4;
- port = 1205;
- }
- ip = {
- addr = 1.2.3.4
- port = 1205
- }
- ip = { addr = 1.2.3.4 }
- ip = {
- addr = 201:220:222::2
- }
- ip = {
- addr = bluedot.thun.net
- }
- }
-\end{verbatim}
-\normalsize
-
-where ip, ip4, ip6, addr, and port are all keywords. Note, that the address
-can be specified as either a dotted quadruple, or IPv6 colon notation, or as
-a symbolic name (only in the ip specification). Also, port can be specified
-as a number or as the mnemonic value from the /etc/services file. If a port
-is not specified, the default will be used. If an ip section is specified,
-the resolution can be made either by IPv4 or IPv6. If ip4 is specified, then
-only IPv4 resolutions will be permitted, and likewise with ip6.
-
-\item [FDPort = \lt{}port-number\gt{}]
- \index[fd]{FDPort}
- \index[fd]{Directive!FDPort}
- This specifies the port number on which the Client listens for Director
- connections. It must agree with the FDPort specified in the Client resource
- of the Director's configuration file. The default is 9102.
-
-\item [FDAddress = \lt{}IP-Address\gt{}]
- \index[fd]{FDAddress}
- \index[fd]{Directive!FDAddress}
- This record is optional, and if it is specified, it will cause the File
- daemon server (for Director connections) to bind to the specified {\bf
- IP-Address}, which is either a domain name or an IP address specified as a
- dotted quadruple. If this record is not specified, the File daemon will bind
- to any available address (the default).
-
-\item [SDConnectTimeout = \lt{}time-interval\gt{}]
- \index[fd]{SDConnectTimeout}
- \index[fd]{Directive!SDConnectTimeout}
- This record defines an interval of time that the File daemon will try to
- connect to the Storage daemon. The default is 30 minutes. If no connection
- is made in the specified time interval, the File daemon cancels the Job.
-
-\item [Maximum Network Buffer Size = \lt{}bytes\gt{}]
- \index[fd]{Maximum Network Buffer Size}
- \index[fd]{Directive!Maximum Network Buffer Size}
- where \lt{}bytes\gt{} specifies the initial network buffer size to use with
- the File daemon. This size will be adjusted down if it is too large until it
- is accepted by the OS. Please use care in setting this value since if it is
- too large, it will be trimmed by 512 bytes until the OS is happy, which may
- require a large number of system calls. The default value is 65,536 bytes.
-
- Note, on certain Windows machines, there are reports that the
- transfer rates are very slow and this seems to be related to
- the default 65,536 size. On systems where the transfer rates
- seem abnormally slow compared to other systems, you might try
- setting the Maximum Network Buffer Size to 32,768 in both the
- File daemon and in the Storage daemon.
-
-\item [Heartbeat Interval = \lt{}time-interval\gt{}]
- \index[console]{Heartbeat Interval}
- \index[console]{Directive!Heartbeat}
- This directive is optional and if specified will cause the File daemon to
- set a keepalive interval (heartbeat) in seconds on each of the sockets
- to communicate with the Storage daemon. It is implemented only on systems
- (Linux, ...) that provide the {\bf setsockopt} TCP\_KEEPIDLE function.
- The default value is zero, which means no change is made to the socket.
-
-
-\item [PKI Encryption]
- See the \ilink{Data Encryption}{DataEncryption} chapter of this manual.
-
-\item [PKI Signatures]
- See the \ilink{Data Encryption}{DataEncryption} chapter of this manual.
-
-\item [PKI Keypair]
- See the \ilink{Data Encryption}{DataEncryption} chapter of this manual.
-
-\item [PKI Master Key]
- See the \ilink{Data Encryption}{DataEncryption} chapter of this manual.
-
-\end{description}
-
-The following is an example of a valid Client resource definition:
-
-\footnotesize
-\begin{verbatim}
-Client { # this is me
- Name = rufus-fd
- WorkingDirectory = $HOME/bacula/bin/working
- Pid Directory = $HOME/bacula/bin/working
-}
-\end{verbatim}
-\normalsize
-
-\section{The Director Resource}
-\label{DirectorResource}
-\index[general]{Director Resource }
-\index[general]{Resource!Director }
-
-The Director resource defines the name and password of the Directors that are
-permitted to contact this Client.
-
-\begin{description}
-
-\item [Director]
- \index[fd]{Director}
- \index[fd]{Directive!Director}
- Start of the Director records. There may be any number of Director resources
- in the Client configuration file. Each one specifies a Director that is
- allowed to connect to this Client.
-
-\item [Name = \lt{}name\gt{}]
- \index[fd]{Name}
- \index[fd]{Directive!Name}
- The name of the Director that may contact this Client. This name must be the
- same as the name specified on the Director resource in the Director's
- configuration file. Note, the case (upper/lower) of the characters in
- the name are significant (i.e. S is not the same as s). This directive
- is required.
-
-\item [Password = \lt{}password\gt{}]
- \index[fd]{Password}
- \index[fd]{Directive!Password}
- Specifies the password that must be supplied for a Director to be authorized.
-This password must be the same as the password specified in the Client
-resource in the Director's configuration file. This directive is required.
-
-\item [Monitor = \lt{}yes|no\gt{}]
- \index[fd]{Monitor}
- \index[fd]{Directive!Monitor}
- If Monitor is set to {\bf no} (default), this director will have full access
- to this Client. If Monitor is set to {\bf yes}, this director will only be
- able to fetch the current status of this Client.
-
- Please note that if this director is being used by a Monitor, we highly
- recommend to set this directive to {\bf yes} to avoid serious security
- problems.
-\end{description}
-
-Thus multiple Directors may be authorized to use this Client's services. Each
-Director will have a different name, and normally a different password as
-well.
-
-The following is an example of a valid Director resource definition:
-
-\footnotesize
-\begin{verbatim}
-#
-# List Directors who are permitted to contact the File daemon
-#
-Director {
- Name = HeadMan
- Password = very_good # password HeadMan must supply
-}
-Director {
- Name = Worker
- Password = not_as_good
- Monitor = Yes
-}
-\end{verbatim}
-\normalsize
-
-\section{The Message Resource}
-\label{MessagesResource3}
-\index[general]{Message Resource}
-\index[general]{Resource!Message }
-
-Please see the
-\ilink{Messages Resource}{MessagesChapter} Chapter of this
-manual for the details of the Messages Resource.
-
-There must be at least one Message resource in the Client configuration file.
-
-\section{Example Client Configuration File}
-\label{SampleClientConfiguration}
-\index[general]{Example Client Configuration File }
-\index[general]{File!Example Client Configuration }
-
-An example File Daemon configuration file might be the following:
-
-\footnotesize
-\begin{verbatim}
-#
-# Default Bacula File Daemon Configuration file
-#
-# For Bacula release 1.35.2 (16 August 2004) -- gentoo 1.4.16
-#
-# There is not much to change here except perhaps to
-# set the Director's name and File daemon's name
-# to something more appropriate for your site.
-#
-#
-# List Directors who are permitted to contact this File daemon
-#
-Director {
- Name = rufus-dir
- Password = "/LqPRkX++saVyQE7w7mmiFg/qxYc1kufww6FEyY/47jU"
-}
-#
-# Restricted Director, used by tray-monitor to get the
-# status of the file daemon
-#
-Director {
- Name = rufus-mon
- Password = "FYpq4yyI1y562EMS35bA0J0QC0M2L3t5cZObxT3XQxgxppTn"
- Monitor = yes
-}
-#
-# "Global" File daemon configuration specifications
-#
-FileDaemon { # this is me
- Name = rufus-fd
- WorkingDirectory = $HOME/bacula/bin/working
- Pid Directory = $HOME/bacula/bin/working
-}
-# Send all messages except skipped files back to Director
-Messages {
- Name = Standard
- director = rufus-dir = all, !skipped
-}
-\end{verbatim}
-\normalsize
+++ /dev/null
--%
-%%
-
-\section{The FileSet Resource}
-\label{FileSetResource}
-\index[general]{Resource!FileSet}
-\index[general]{FileSet Resource}
-
-The FileSet resource defines what files are to be included or excluded in a
-backup job. A {\bf FileSet} resource is required for each backup Job. It
-consists of a list of files or directories to be included, a list of files
-or directories to be excluded and the various backup options such as
-compression, encryption, and signatures that are to be applied to each
-file.
-
-Any change to the list of the included files will cause Bacula to
-automatically create a new FileSet (defined by the name and an MD5 checksum
-of the Include/Exclude contents). Each time a new FileSet is created,
-Bacula will ensure that the next backup is always a Full save.
-
-Bacula is designed to handle most character sets of the world,
-US ASCII, German, French, Chinese, ... However, it does this by
-encoding everything in UTF-8, and it expects all configuration files
-(including those read on Win32 machines) to be in UTF-8 format.
-UTF-8 is typically the default on Linux machines, but not on all
-Unix machines, nor on Windows, so you must take some care to ensure
-that your locale is set properly before starting Bacula.
-On most modern Win32 machines, you can edit the conf files with {\bf
-notebook} and choose output encoding UTF-8.
-
-To ensure that Bacula configuration files can be correctly read including
-foreign characters the {bf LANG} environment variable
-must end in {\bf .UTF-8}. An full example is {\bf en\_US.UTF-8}. The
-exact syntax may vary a bit from OS to OS, and exactly how you define
-it will also vary.
-
-Bacula assumes that all filenames are in UTF-8 format on Linux and
-Unix machines. On Win32 they are in Unicode (UTF-16), and will
-be automatically converted to UTF-8 format.
-
-
-\begin{description}
-
-\item [FileSet]
-\index[dir]{FileSet}
-\index[dir]{Directive!FileSet}
-Start of the FileSet resource. One {\bf FileSet} resource must be
-defined for each Backup job.
-
-\item [Name = \lt{}name\gt{}]
-\index[dir]{Name}
-\index[dir]{Directive!Name}
- The name of the FileSet resource. This directive is required.
-
-\item [Ignore FileSet Changes = \lt{}yes|no\gt{}]
-\index[dir]{Ignore FileSet Changes}
-\index[dir]{Directive!Ignore FileSet Changes}
- Normally, if you modify the FileSet Include or Exclude lists,
- the next backup will be forced to a Full so that Bacula can
- guarantee that any additions or deletions are properly saved.
-
- We strongly recommend against setting this directive to yes,
- since doing so may cause you to have an incomplete set of backups.
-
- If this directive is set to {\bf yes}, any changes you make to the
- FileSet Include or Exclude lists, will not force a Full during
- subsequent backups.
-
- The default is {\bf no}, in which case, if you change the Include or
- Exclude, Bacula will force a Full backup to ensure that everything is
- properly backed up.
-
-\item [Enable VSS = \lt{}yes|no\gt{}]
-\index[dir]{Enable VSS}
-\index[dir]{Directive!Enable VSS}
- If this directive is set to {\bf yes} the File daemon will be notified
- that the user wants to use a Volume Shadow Copy Service (VSS) backup
- for this job. The default is {\bf yes}. This directive is effective
- only for VSS enabled Win32 File daemons. It permits a consistent copy
- of open files to be made for cooperating writer applications, and for
- applications that are not VSS away, Bacula can at least copy open files.
- For more information, please see the
- \ilink{Windows}{VSS} chapter of this manual.
-
-\item [Include \{ Options \{\lt{}file-options\gt{}\} ...;
- \lt{}file-list\gt{} \} ]
-\index[dir]{Include \{ [ Options \{\lt{}file-options\gt{}\} ...]
- \lt{}file-list\gt{} \} }
-\index[dir]{Directive!Include}
-
-\item [Options \{ \lt{}file-options\gt{} \} ]
-\index[dir]{Options \{ \lt{}file-options\gt{} \} }
-
-\item [Exclude \{ \lt{}file-list\gt{} \}]
-\index[dir]{Exclude \{ \lt{}file-list\gt{} \} }
-\index[dir]{Directive!Exclude}
-
-\end{description}
-
-The Include resource must contain a list of directories and/or files to be
-processed in the backup job. Normally, all files found in all
-subdirectories of any directory in the Include File list will be backed up.
-Note, see below for the definition of \lt{}file-list\gt{}.
-The Include resource may also contain one or more Options resources that
-specify options such as compression to be applied to all or any subset of
-the files found when processing the file-list for backup. Please see
-below for more details concerning Options resources.
-
-There can be any number of {\bf Include} resources within the FileSet, each
-having its own list of directories or files to be backed up and the backup
-options defined by one or more Options resources. The {\bf file-list}
-consists of one file or directory name per line. Directory names should be
-specified without a trailing slash with Unix path notation.
-
-Windows users, please take note to specify directories (even c:/...) in
-Unix path notation. If you use Windows conventions, you will most likely
-not be able to restore your files due to the fact that the Windows
-path separator was defined as an escape character long before Windows
-existed, and Bacula adheres to that convention (i.e. \\ means the next character
-appears as itself).
-
-You should always specify a full path for every directory and file that you
-list in the FileSet. In addition, on Windows machines, you should {\bf
-always} prefix the directory or filename with the drive specification in
-lower case (e.g. {\bf c:/xxx}) using Unix directory name separators
-(forward slash).
-
-Bacula's default for processing directories is to recursively descend in
-the directory saving all files and subdirectories. Bacula will not by
-default cross filesystems (or mount points in Unix parlance). This means
-that if you specify the root partition (e.g. {\bf /}), Bacula will save
-only the root partition and not any of the other mounted filesystems.
-Similarly on Windows systems, you must explicitly specify each of the
-drives you want saved (e.g.
-{\bf c:/} and {\bf d:/} ...). In addition, at least for Windows systems, you
-will most likely want to enclose each specification within double quotes
-particularly if the directory (or file) name contains spaces. The {\bf df}
-command on Unix systems will show you which mount points you must specify to
-save everything. See below for an example.
-
-Take special care not to include a directory twice or Bacula will backup
-the same files two times wasting a lot of space on your archive device.
-Including a directory twice is very easy to do. For example:
-
-\footnotesize
-\begin{verbatim}
- Include {
- File = /
- File = /usr
- Options { compression=GZIP }
- }
-\end{verbatim}
-\normalsize
-
-on a Unix system where /usr is a subdirectory (rather than a mounted
-filesystem) will cause /usr to be backed up twice. In this case, on Bacula
-versions prior to 1.32f-5-09Mar04 due to a bug, you will not be able to
-restore hard linked files that were backed up twice.
-
-If you have used Bacula prior to version 1.36.3, you will note three things in
-the new FileSet syntax:
-
-\begin{enumerate}
-\item There is no equal sign (=) after the Include and before the opening
- brace (\{). The same is true for the Exclude.
-\item Each directory (or filename) to be included or excluded is preceded by a {\bf File
- =}. Previously they were simply listed on separate lines.
-\item The options that previously appeared on the Include line now must be
- specified within their own Options resource.
-\item The Exclude resource does not accept Options.
-\item When using wild-cards or regular expressions, directory names are
- always terminated with a slash (/) and filenames have no trailing slash.
-\end{enumerate}
-
-The Options resource is optional, but when specified, it will contain a
-list of {\bf keyword=value} options to be applied to the file-list.
-See below for the definition of file-list.
-Multiple Options resources may be specified one after another. As the
-files are found in the specified directories, the Options will applied to
-the filenames to determine if and how the file should be backed up. The
-wildcard and regular expression pattern matching parts of the
-Options resources are checked in the order they are specified in the
-FileSet until the first one that matches. Once one matches, the
-compression and other flags within the Options specification will
-apply to the pattern matched.
-
-A key point is that in the absence of an Option or no other Option is
-matched, every file is accepted for backing up. This means that if
-you want to exclude something, you must explicitly specify an Option
-with an {\bf exclude = yes} and some pattern matching.
-
-Once Bacula determines that the Options resource matches the file under
-consideration, that file will be saved without looking at any other Options
-resources that may be present. This means that any wild cards must appear
-before an Options resource without wild cards.
-
-If for some reason, Bacula checks all the Options resources to a file under
-consideration for backup, but there are no matches (generally because of wild
-cards that don't match), Bacula as a default will then backup the file. This
-is quite logical if you consider the case of no Options clause is specified,
-where you want everything to be backed up, and it is important to keep in mind
-when excluding as mentioned above.
-
-However, one additional point is that in the case that no match was found,
-Bacula will use the options found in the last Options resource. As a
-consequence, if you want a particular set of "default" options, you should put
-them in an Options resource after any other Options.
-
-It is a good idea to put all your wild-card and regex expressions inside
-double quotes to prevent conf file scanning problems.
-
-This is perhaps a bit overwhelming, so there are a number of examples included
-below to illustrate how this works.
-
-The directives within an Options resource may be one of the following:
-
-\begin{description}
-
-\item [compression=GZIP]
-\index[dir]{compression}
-\index[dir]{Directive!compression}
- All files saved will be software compressed using the GNU ZIP
- compression format. The compression is done on a file by file basis by
- the File daemon. If there is a problem reading the tape in a single
- record of a file, it will at most affect that file and none of the other
- files on the tape. Normally this option is {\bf not} needed if you have
- a modern tape drive as the drive will do its own compression. In fact,
- if you specify software compression at the same time you have hardware
- compression turned on, your files may actually take more space on the
- volume.
-
- Software compression is very important if you are writing your Volumes
- to a file, and it can also be helpful if you have a fast computer but a
- slow network, otherwise it is generally better to rely your tape drive's
- hardware compression. As noted above, it is not generally a good idea
- to do both software and hardware compression.
-
- Specifying {\bf GZIP} uses the default compression level 6 (i.e. {\bf
- GZIP} is identical to {\bf GZIP6}). If you want a different compression
- level (1 through 9), you can specify it by appending the level number
- with no intervening spaces to {\bf GZIP}. Thus {\bf compression=GZIP1}
- would give minimum compression but the fastest algorithm, and {\bf
- compression=GZIP9} would give the highest level of compression, but
- requires more computation. According to the GZIP documentation,
- compression levels greater than six generally give very little extra
- compression and are rather CPU intensive.
-
-\item [signature=SHA1]
-\index[dir]{signature}
-\index[dir]{SHA1}
-\index[dir]{Directive!signature}
- An SHA1 signature will be computed for all The SHA1 algorithm is
- purported to be some what slower than the MD5 algorithm, but at the same
- time is significantly better from a cryptographic point of view (i.e.
- much fewer collisions, much lower probability of being hacked.) It adds
- four more bytes than the MD5 signature. We strongly recommend that
- either this option or MD5 be specified as a default for all files.
- Note, only one of the two options MD5 or SHA1 can be computed for any
- file.
-
-\item [signature=MD5]
-\index[dir]{signature}
-\index[dir]{MD5}
-\index[dir]{Directive!signature}
- An MD5 signature will be computed for all files saved. Adding this
- option generates about 5\% extra overhead for each file saved. In
- addition to the additional CPU time, the MD5 signature adds 16 more
- bytes per file to your catalog. We strongly recommend that this option
- or the SHA1 option be specified as a default for all files.
-
-\item [verify=\lt{}options\gt{}]
-\index[dir]{verify}
-\index[dir]{Directive!verify}
- The options letters specified are used when running a {\bf Verify
- Level=Catalog} as well as the {\bf DiskToCatalog} level job. The options
- letters may be any combination of the following:
-
- \begin{description}
-
- \item {\bf i}
- compare the inodes
-
- \item {\bf p}
- compare the permission bits
-
- \item {\bf n}
- compare the number of links
-
- \item {\bf u}
- compare the user id
-
- \item {\bf g}
- compare the group id
-
- \item {\bf s}
- compare the size
-
- \item {\bf a}
- compare the access time
-
- \item {\bf m}
- compare the modification time (st\_mtime)
-
- \item {\bf c}
- compare the change time (st\_ctime)
-
- \item {\bf d}
- report file size decreases
-
- \item {\bf 5}
- compare the MD5 signature
-
- \item {\bf 1}
- compare the SHA1 signature
- \end{description}
-
- A useful set of general options on the {\bf Level=Catalog} or {\bf
- Level=DiskToCatalog} verify is {\bf pins5} i.e. compare permission bits,
- inodes, number of links, size, and MD5 changes.
-
-\item [onefs=yes|no]
-\index[dir]{onefs}
-\index[dir]{Directive!onefs}
- If set to {\bf yes} (the default), {\bf Bacula} will remain on a single
- file system. That is it will not backup file systems that are mounted
- on a subdirectory. If you are using a *nix system, you may not even be
- aware that there are several different filesystems as they are often
- automatically mounted by the OS (e.g. /dev, /net, /sys, /proc, ...).
- With Bacula 1.38.0 or later, it will inform you when it decides not to
- traverse into another filesystem. This can be very useful if you forgot
- to backup a particular partition. An example of the informational
- message in the job report is:
-
-\footnotesize
-\begin{verbatim}
-rufus-fd: /misc is a different filesystem. Will not descend from / into /misc
-rufus-fd: /net is a different filesystem. Will not descend from / into /net
-rufus-fd: /var/lib/nfs/rpc_pipefs is a different filesystem. Will not descend from /var/lib/nfs into /var/lib/nfs/rpc_pipefs
-rufus-fd: /selinux is a different filesystem. Will not descend from / into /selinux
-rufus-fd: /sys is a different filesystem. Will not descend from / into /sys
-rufus-fd: /dev is a different filesystem. Will not descend from / into /dev
-rufus-fd: /home is a different filesystem. Will not descend from / into /home
-\end{verbatim}
-\normalsize
-
- Note: in previous versions of Bacula, the above message was of the form:
-
-\footnotesize
-\begin{verbatim}
-Filesystem change prohibited. Will not descend into /misc
-\end{verbatim}
-\normalsize
-
- If you wish to backup multiple filesystems, you can explicitly
- list each filesystem you want saved. Otherwise, if you set the onefs option
- to {\bf no}, Bacula will backup all mounted file systems (i.e. traverse mount
- points) that are found within the {\bf FileSet}. Thus if you have NFS or
- Samba file systems mounted on a directory listed in your FileSet, they will
- also be backed up. Normally, it is preferable to set {\bf onefs=yes} and to
- explicitly name each filesystem you want backed up. Explicitly naming the
- filesystems you want backed up avoids the possibility of getting into a
- infinite loop recursing filesystems. Another possibility is to
- use {\bf onefs=no} and to set {\bf fstype=ext2, ...}.
- See the example below for more details.
-
- If you think that Bacula should be backing up a particular directory
- and it is not, and you have {\bf onefs=no} set, before you complain,
- please do:
-
-\footnotesize
-\begin{verbatim}
- stat /
- stat <filesystem>
-\end{verbatim}
-\normalsize
-
-where you replace {\bf filesystem} with the one in question. If the
-{\bf Device:} number is different for / and for your filesystem, then they
-are on different filesystems. E.g.
-\footnotesize
-\begin{verbatim}
-stat /
- File: `/'
- Size: 4096 Blocks: 16 IO Block: 4096 directory
-Device: 302h/770d Inode: 2 Links: 26
-Access: (0755/drwxr-xr-x) Uid: ( 0/ root) Gid: ( 0/ root)
-Access: 2005-11-10 12:28:01.000000000 +0100
-Modify: 2005-09-27 17:52:32.000000000 +0200
-Change: 2005-09-27 17:52:32.000000000 +0200
-
-stat /net
- File: `/home'
- Size: 4096 Blocks: 16 IO Block: 4096 directory
-Device: 308h/776d Inode: 2 Links: 7
-Access: (0755/drwxr-xr-x) Uid: ( 0/ root) Gid: ( 0/ root)
-Access: 2005-11-10 12:28:02.000000000 +0100
-Modify: 2005-11-06 12:36:48.000000000 +0100
-Change: 2005-11-06 12:36:48.000000000 +0100
-\end{verbatim}
-\normalsize
-
- Also be aware that even if you include {\bf /home} in your list
- of files to backup, as you most likely should, you will get the
- informational message that "/home is a different filesystem" when
- Bacula is processing the {\bf /} directory. This message does not
- indicate an error. This message means that while examining the
- {\bf File =} referred to in the second part of the message, Bacula will
- not descend into the directory mentioned in the first part of the message.
- However, it is possible that the separate filesystem will be backed up
- despite the message. For example, consider the following FileSet:
-
-\footnotesize
-\begin{verbatim}
- File = /
- File = /var
-\end{verbatim}
-\normalsize
-
- where {\bf /var} is a separate filesystem. In this example, you will get a
- message saying that Bacula will not decend from {\bf /} into {\bf /var}. But
- it is important to realise that Bacula will descend into {\bf /var} from the
- second File directive shown above. In effect, the warning is bogus,
- but it is supplied to alert you to possible omissions from your FileSet. In
- this example, {\bf /var} will be backed up. If you changed the FileSet such
- that it did not specify {\bf /var}, then {\bf /var} will not be backed up.
-
-
-
-
-\label{portable}
-\item [portable=yes|no]
-\index[dir]{portable}
-\index[dir]{Directive!portable}
- If set to {\bf yes} (default is {\bf no}), the Bacula File daemon will
- backup Win32 files in a portable format, but not all Win32 file
- attributes will be saved and restored. By default, this option is set
- to {\bf no}, which means that on Win32 systems, the data will be backed
- up using Windows API calls and on WinNT/2K/XP, all the security and
- ownership attributes will be properly backed up (and restored). However
- this format is not portable to other systems -- e.g. Unix, Win95/98/Me.
- When backing up Unix systems, this option is ignored, and unless you
- have a specific need to have portable backups, we recommend accept the
- default ({\bf no}) so that the maximum information concerning your files
- is saved.
-
-\item [recurse=yes|no]
-\index[dir]{recurse}
-\index[dir]{Directive!recurse}
- If set to {\bf yes} (the default), Bacula will recurse (or descend) into
- all subdirectories found unless the directory is explicitly excluded
- using an {\bf exclude} definition. If you set {\bf recurse=no}, Bacula
- will save the subdirectory entries, but not descend into the
- subdirectories, and thus will not save the files or directories
- contained in the subdirectories. Normally, you will want the default
- ({\bf yes}).
-
-\item [sparse=yes|no]
-\index[dir]{sparse}
-\index[dir]{Directive!sparse}
- Enable special code that checks for sparse files such as created by
- ndbm. The default is {\bf no}, so no checks are made for sparse files.
- You may specify {\bf sparse=yes} even on files that are not sparse file.
- No harm will be done, but there will be a small additional overhead to
- check for buffers of all zero, and a small additional amount of space on
- the output archive will be used to save the seek address of each
- non-zero record read.
-
- {\bf Restrictions:} Bacula reads files in 32K buffers. If the whole
- buffer is zero, it will be treated as a sparse block and not written to
- tape. However, if any part of the buffer is non-zero, the whole buffer
- will be written to tape, possibly including some disk sectors (generally
- 4098 bytes) that are all zero. As a consequence, Bacula's detection of
- sparse blocks is in 32K increments rather than the system block size.
- If anyone considers this to be a real problem, please send in a request
- for change with the reason.
-
- If you are not familiar with sparse files, an example is say a file
- where you wrote 512 bytes at address zero, then 512 bytes at address 1
- million. The operating system will allocate only two blocks, and the
- empty space or hole will have nothing allocated. However, when you read
- the sparse file and read the addresses where nothing was written, the OS
- will return all zeros as if the space were allocated, and if you backup
- such a file, a lot of space will be used to write zeros to the volume.
- Worse yet, when you restore the file, all the previously empty space
- will now be allocated using much more disk space. By turning on the
- {\bf sparse} option, Bacula will specifically look for empty space in
- the file, and any empty space will not be written to the Volume, nor
- will it be restored. The price to pay for this is that Bacula must
- search each block it reads before writing it. On a slow system, this
- may be important. If you suspect you have sparse files, you should
- benchmark the difference or set sparse for only those files that are
- really sparse.
-
-\label{readfifo}
-\item [readfifo=yes|no]
-\index[dir]{readfifo}
-\index[dir]{Directive!readfifo}
- If enabled, tells the Client to read the data on a backup and write the
- data on a restore to any FIFO (pipe) that is explicitly mentioned in the
- FileSet. In this case, you must have a program already running that
- writes into the FIFO for a backup or reads from the FIFO on a restore.
- This can be accomplished with the {\bf RunBeforeJob} directive. If this
- is not the case, Bacula will hang indefinitely on reading/writing the
- FIFO. When this is not enabled (default), the Client simply saves the
- directory entry for the FIFO.
-
- Unfortunately, when Bacula runs a RunBeforeJob, it waits until that
- script terminates, and if the script accesses the FIFO to write
- into the it, the Bacula job will block and everything will stall.
- However, Vladimir Stavrinov as supplied tip that allows this feature
- to work correctly. He simply adds the following to the beginning
- of the RunBeforeJob script:
-
-\begin{verbatim}
- exec > /dev/null
-\end{verbatim}
-
-\item [noatime=yes|no]
-\index[dir]{noatime}
-\index[dir]{Directive!noatime}
- If enabled, and if your Operating System supports the O\_NOATIME file
- open flag, Bacula will open all files to be backed up with this option.
- It makes it possible to read a file without updating the inode atime
- (and also without the inode ctime update which happens if you try to set
- the atime back to its previous value). It also prevents a race
- condition when two programs are reading the same file, but only one does
- not want to change the atime. It's most useful for backup programs and
- file integrity checkers (and bacula can fit on both categories).
-
- This option is particularly useful for sites where users are sensitive
- to their MailBox file access time. It replaces both the {\bf keepatime}
- option without the inconveniences of that option (see below).
-
- If your Operating System does not support this option, it will be
- silently ignored by Bacula.
-
-
-\item [mtimeonly=yes|no]
-\index[dir]{mtimeonly}
-\index[dir]{Directive!mtimeonly}
- If enabled, tells the Client that the selection of files during
- Incremental and Differential backups should based only on the st\_mtime
- value in the stat() packet. The default is {\bf no} which means that
- the selection of files to be backed up will be based on both the
- st\_mtime and the st\_ctime values. In general, it is not recommended
- to use this option.
-
-\item [keepatime=yes|no]
-\index[dir]{keepatime}
-\index[dir]{Directive!keepatime}
- The default is {\bf no}. When enabled, Bacula will reset the st\_atime
- (access time) field of files that it backs up to their value prior to
- the backup. This option is not generally recommended as there are very
- few programs that use st\_atime, and the backup overhead is increased
- because of the additional system call necessary to reset the times.
- However, for some files, such as mailboxes, when Bacula backs up the
- file, the user will notice that someone (Bacula) has accessed the
- file. In this, case keepatime can be useful.
- (I'm not sure this works on Win32).
-
- Note, if you use this feature, when Bacula resets the access time, the
- change time (st\_ctime) will automatically be modified by the system,
- so on the next incremental job, the file will be backed up even if
- it has not changed. As a consequence, you will probably also want
- to use {\bf mtimeonly = yes} as well as keepatime (thanks to
- Rudolf Cejka for this tip).
-
-\item [checkfilechanges=yes|no]
-\index[dir]{checkfilechanges}
-\index[dir]{Directive!checkfilechanges}
- On versions 2.0.4 or greater,
- if enabled, the Client will checks size, age of each file after
- their backup to see if they have changed during backup. If time
- or size mismatch, an error will raise.
-
-\begin{verbatim}
- zog-fd: Client1.2007-03-31_09.46.21 Error: /tmp/test mtime changed during backup.
-\end{verbatim}
-
- In general, it is recommended to use this option.
-
-\item [hardlinks=yes|no]
-\index[dir]{hardlinks}
-\index[dir]{Directive!hardlinks}
- When enabled (default), this directive will cause hard links to be
- backed up. However, the File daemon keeps track of hard linked files and
- will backup the data only once. The process of keeping track of the
- hard links can be quite expensive if you have lots of them (tens of
- thousands or more). This doesn't occur on normal Unix systems, but if
- you use a program like BackupPC, it can create hundreds of thousands, or
- even millions of hard links. Backups become very long and the File daemon
- will consume a lot of CPU power checking hard links. In such a case,
- set {\bf hardlinks=no} and hard links will not be backed up. Note, using
- this option will most likely backup more data and on a restore the file
- system will not be restored identically to the original.
-
-\item [wild=\lt{}string\gt{}]
-\index[dir]{wild}
-\index[dir]{Directive!wild}
- Specifies a wild-card string to be applied to the filenames and
- directory names. Note, if {\bf Exclude} is not enabled, the wild-card
- will select which files are to be included. If {\bf Exclude=yes} is
- specified, the wild-card will select which files are to be excluded.
- Multiple wild-card directives may be specified, and they will be applied
- in turn until the first one that matches. Note, if you exclude a
- directory, no files or directories below it will be matched.
-
- You may want to test your expressions prior to running your
- backup by using the bwild program. Please see the
- \ilink{Utilities}{bwild} chapter of this manual for
- more. You can also test your full FileSet definition by using
- the \ilink{estimate}{estimate} command in the Console
- chapter of this manual.
- It is recommended to enclose the string in double quotes.
-
-\item [wilddir=\lt{}string\gt{}]
-\index[dir]{wilddir}
-\index[dir]{Directive!wilddir}
- Specifies a wild-card string to be applied to directory names only. No
- filenames will be matched by this directive. Note, if {\bf Exclude} is
- not enabled, the wild-card will select directories to be
- included. If {\bf Exclude=yes} is specified, the wild-card will select
- which directories are to be excluded. Multiple wild-card directives may be
- specified, and they will be applied in turn until the first one that
- matches. Note, if you exclude a directory, no files or directories
- below it will be matched.
-
- It is recommended to enclose the string in double quotes.
-
- You may want to test your expressions prior to running your
- backup by using the bwild program. Please see the
- \ilink{Utilities}{bwild} chapter of this manual for
- more. You can also test your full FileSet definition by using
- the \ilink{estimate}{estimate} command in the Console
- chapter of this manual.
- An example of excluding with the WildDir option on Win32 machines is
- presented below.
-
-\item [wildfile=\lt{}string\gt{}]
-\index[dir]{wildfile}
-\index[dir]{Directive!wildfile}
- Specifies a wild-card string to be applied to non-directories. That
- is no directory entries will be matched by this directive.
- However, note that the match is done against the full path and filename,
- so your wild-card string must take into account that filenames
- are preceded by the full path.
- If {\bf Exclude}
- is not enabled, the wild-card will select which files are to be
- included. If {\bf Exclude=yes} is specified, the wild-card will select
- which files are to be excluded. Multiple wild-card directives may be
- specified, and they will be applied in turn until the first one that
- matches.
-
- It is recommended to enclose the string in double quotes.
-
- You may want to test your expressions prior to running your
- backup by using the bwild program. Please see the
- \ilink{Utilities}{bwild} chapter of this manual for
- more. You can also test your full FileSet definition by using
- the \ilink{estimate}{estimate} command in the Console
- chapter of this manual.
- An example of excluding with the WildFile option on Win32 machines is
- presented below.
-
-
-\item [regex=\lt{}string\gt{}]
-\index[dir]{regex}
-\index[dir]{Directive!regex}
- Specifies a POSIX extended regular expression to be applied to the
- filenames and directory names, which include the full path. If {\bf
- Exclude} is not enabled, the regex will select which files are to be
- included. If {\bf Exclude=yes} is specified, the regex will select
- which files are to be excluded. Multiple regex directives may be
- specified within an Options resource, and they will be applied in turn
- until the first one that matches. Note, if you exclude a directory, no
- files or directories below it will be matched.
-
- It is recommended to enclose the string in double quotes.
-
- The regex libraries differ from one operating system to
- another, and in addition, regular expressions are complicated,
- so you may want to test your expressions prior to running your
- backup by using the bregex program. Please see the
- \ilink{Utilities}{bwild} chapter of this manual for
- more. You can also test your full FileSet definition by using
- the \ilink{estimate}{estimate} command in the Console
- chapter of this manual.
-
-
-\item [regexfile=\lt{}string\gt{}]
-\index[dir]{regexfile}
-\index[dir]{Directive!regexfile}
- Specifies a POSIX extended regular expression to be applied to
- non-directories. No directories will be matched by this directive.
- However, note that the match is done against the full path and
- filename, so your regex string must take into account that filenames
- are preceded by the full path.
- If {\bf Exclude} is not enabled, the regex will select which files are
- to be included. If {\bf Exclude=yes} is specified, the regex will
- select which files are to be excluded. Multiple regex directives may be
- specified, and they will be applied in turn until the first one that
- matches.
-
- It is recommended to enclose the string in double quotes.
-
- The regex libraries differ from one operating system to
- another, and in addition, regular expressions are complicated,
- so you may want to test your expressions prior to running your
- backup by using the bregex program. Please see the
- \ilink{Utilities}{bregex} chapter of this manual for
- more.
-
-
-\item [regexdir=\lt{}string\gt{}]
-\index[dir]{regexdir}
-\index[dir]{Directive!regexdir}
- Specifies a POSIX extended regular expression to be applied to directory
- names only. No filenames will be matched by this directive. Note, if
- {\bf Exclude} is not enabled, the regex will select directories
- files are to be included. If {\bf Exclude=yes} is specified, the
- regex will select which files are to be excluded. Multiple
- regex directives may be specified, and they will be applied in turn
- until the first one that matches. Note, if you exclude a directory, no
- files or directories below it will be matched.
-
- It is recommended to enclose the string in double quotes.
-
- The regex libraries differ from one operating system to
- another, and in addition, regular expressions are complicated,
- so you may want to test your expressions prior to running your
- backup by using the bregex program. Please see the
- \ilink{Utilities}{bregex} chapter of this manual for
- more.
-
-
-\item [exclude=yes|no]
-\index[dir]{exclude}
-\index[dir]{Directive!exclude}
- The default is {\bf no}. When enabled, any files matched within the
- Options will be excluded from the backup.
-
-\label{ACLSupport}
-\item [aclsupport=yes|no]
-\index[dir]{aclsupport}
-\index[dir]{Directive!aclsupport}
- The default is {\bf no}. If this option is set to yes, and you have the
- POSIX {\bf libacl} installed on your system, Bacula will backup the file
- and directory UNIX Access Control Lists (ACL) as defined in IEEE Std
- 1003.1e draft 17 and "POSIX.1e" (abandoned). This feature is
- available on UNIX only and depends on the ACL library. Bacula is
- automatically compiled with ACL support if the {\bf libacl} library is
- installed on your system (shown in config.out). While restoring the
- files Bacula will try to restore the ACLs, if there is no ACL support
- available on the system, Bacula restores the files and directories but
- not the ACL information. Please note, if you backup an EXT3 or XFS
- filesystem with ACLs, then you restore them to a different filesystem
- (perhaps reiserfs) that does not have ACLs, the ACLs will be ignored.
-
-\item [ignore case=yes|no]
-\index[dir]{ignore case}
-\index[dir]{Directive!ignore case}
- The default is {\bf no}. On Windows systems, you will almost surely
- want to set this to {\bf yes}. When this directive is set to {\bf yes}
- all the case of character will be ignored in wild-card and regex
- comparisons. That is an uppercase A will match a lowercase a.
-
-\item [fstype=filesystem-type]
-\index[dir]{fstype}
-\index[dir]{Directive!fstype}
- This option allows you to select files and directories by the
- filesystem type. The permitted filesystem-type names are:
-
- ext2, jfs, ntfs, proc, reiserfs, xfs, usbdevfs, sysfs, smbfs,
- iso9660. For ext3 systems, use ext2.
-
- You may have multiple Fstype directives, and thus permit matching
- of multiple filesystem types within a single Options resource. If
- the type specified on the fstype directive does not match the
- filesystem for a particular directive, that directory will not be
- backed up. This directive can be used to prevent backing up
- non-local filesystems. Normally, when you use this directive, you
- would also set {\bf onefs=no} so that Bacula will traverse filesystems.
-
- This option is not implemented in Win32 systems.
-
-
-\item [hfsplussupport=yes|no]
-\index[dir]{hfsplussupport}
-\index[dir]{Directive!hfsplussupport}
- This option allows you to turn on support for Mac OSX HFS plus
- finder information.
-
-\item [strippath=\lt{}integer\gt{}]
-\index[dir]{strippath}
-\index[dir]{Directive!strippath}
- This option will cause {\bf integer} paths to be stripped from
- the front of the full path/filename being backed up. This can
- be useful if you are migrating data from another vendor or if
- you have taken a snapshot into some subdirectory. This directive
- can cause your filenames to be overlayed with regular backup data,
- so should be used only by experts and with great care.
-\end{description}
-
-{\bf \lt{}file-list\gt{}} is a list of directory and/or filename names
-specified with a {\bf File =} directive. To include names containing spaces,
-enclose the name between double-quotes. Wild-cards are not interpreted
-in file-lists. They can only be specified in Options resources.
-
-There are a number of special cases when specifying directories and files in a
-{\bf file-list}. They are:
-
-\begin{itemize}
-\item Any name preceded by an at-sign (@) is assumed to be the name of a
- file, which contains a list of files each preceded by a "File =". The
- named file is read once when the configuration file is parsed during the
- Director startup. Note, that the file is read on the Director's machine
- and not on the Client's. In fact, the @filename can appear anywhere
- within the conf file where a token would be read, and the contents of
- the named file will be logically inserted in the place of the @filename.
- What must be in the file depends on the location the @filename is
- specified in the conf file. For example:
-
-\footnotesize
-\begin{verbatim}
-Include {
- Options { compression=GZIP }
- @/home/files/my-files
-}
-\end{verbatim}
-\normalsize
-
-\item Any name beginning with a vertical bar (|) is assumed to be the name of
- a program. This program will be executed on the Director's machine at
- the time the Job starts (not when the Director reads the configuration
- file), and any output from that program will be assumed to be a list of
- files or directories, one per line, to be included.
-
- This allows you to have a job that, for example, includes all the local
- partitions even if you change the partitioning by adding a disk. The
- examples below show you how to do this. However, please note two
- things: \\
- 1. if you want the local filesystems, you probably should be
- using the new {\bf fstype} directive, which was added in version 1.36.3
- and set {\bf onefs=no}.
- \\
-
- 2. the exact syntax of the command needed in the examples below is very
- system dependent. For example, on recent Linux systems, you may need to
- add the -P option, on FreeBSD systems, the options will be different as
- well.
-
- In general, you will need to prefix your command or commands with a {\bf
- sh -c} so that they are invoked by a shell. This will not be the case
- if you are invoking a script as in the second example below. Also, you
- must take care to escape (precede with a \textbackslash{}) wild-cards,
- shell character, and to ensure that any spaces in your command are
- escaped as well. If you use a single quotes (') within a double quote
- ("), Bacula will treat everything between the single quotes as one field
- so it will not be necessary to escape the spaces. In general, getting
- all the quotes and escapes correct is a real pain as you can see by the
- next example. As a consequence, it is often easier to put everything in
- a file and simply use the file name within Bacula. In that case the
- {\bf sh -c} will not be necessary providing the first line of the file
- is {\bf \#!/bin/sh}.
-
- As an example:
-
-\footnotesize
-\begin{verbatim}
-
-Include {
- Options { signature = SHA1 }
- File = "|sh -c 'df -l | grep \"^/dev/hd[ab]\" | grep -v \".*/tmp\" \
- | awk \"{print \\$6}\"'"
-}
-\end{verbatim}
-\normalsize
-
- will produce a list of all the local partitions on a Red Hat Linux system.
- Note, the above line was split, but should normally be written on one line.
- Quoting is a real problem because you must quote for Bacula which consists of
- preceding every \textbackslash{} and every " with a \textbackslash{}, and
- you must also quote for the shell command. In the end, it is probably easier
- just to execute a small file with:
-
-
-\footnotesize
-\begin{verbatim}
-Include {
- Options {
- signature=MD5
- }
- File = "|my_partitions"
-}
-\end{verbatim}
-\normalsize
-
- where my\_partitions has:
-
-\footnotesize
-\begin{verbatim}
-#!/bin/sh
-df -l | grep "^/dev/hd[ab]" | grep -v ".*/tmp" \
- | awk "{print \$6}"
-\end{verbatim}
-\normalsize
-
- If the vertical bar (|) in front of my\_partitions is preceded by a
- backslash as in \textbackslash{}|, the program will be executed on the
- Client's machine instead of on the Director's machine.
- Please note that if the filename is given within quotes, you
- will need to use two slashes. An example, provided by John Donagher,
- that backs up all the local UFS partitions on a remote system is:
-
-\footnotesize
-\begin{verbatim}
-FileSet {
- Name = "All local partitions"
- Include {
- Options { signature=SHA1; onefs=yes; }
- File = "\\|bash -c \"df -klF ufs | tail +2 | awk '{print \$6}'\""
- }
-}
-\end{verbatim}
-\normalsize
-
- The above requires two backslash characters after the double quote (one
- preserves the next one). If you are a Linux user, just change the {\bf ufs}
- to {\bf ext3} (or your preferred filesystem type), and you will be in
- business.
-
- If you know what filesystems you have mounted on your system, e.g.
- for Red Hat Linux normally only ext2 and ext3, you can backup
- all local filesystems using something like:
-
-\footnotesize
-\begin{verbatim}
-
-Include {
- Options { signature = SHA1; onfs=no; fstype=ext2 }
- File = /
-}
-\end{verbatim}
-\normalsize
-
-
-\item Any file-list item preceded by a less-than sign (\lt{}) will be taken
- to be a file. This file will be read on the Director's machine (see
- below for doing it on the Client machine) at the time
- the Job starts, and the data will be assumed to be a list of directories or
- files, one per line, to be included. The names should start in column 1 and
- should not be quoted even if they contain spaces. This feature allows you to
- modify the external file and change what will be saved without stopping and
- restarting Bacula as would be necessary if using the @ modifier noted above.
- For example:
-
-\footnotesize
-\begin{verbatim}
-Include {
- Options { signature = SHA1 }
- File = "</home/files/local-filelist"
-}
-\end{verbatim}
-\normalsize
-
- If you precede the less-than sign (\lt{}) with a backslash as in
- \textbackslash{}\lt{}, the file-list will be read on the Client machine
- instead of on the Director's machine. Please note that if the filename
- is given within quotes, you will need to use two slashes.
-
-\footnotesize
-\begin{verbatim}
-Include {
- Options { signature = SHA1 }
- File = "\\</home/xxx/filelist-on-client"
-}
-\end{verbatim}
-\normalsize
-
-\item If you explicitly specify a block device such as {\bf /dev/hda1}, then
- Bacula (starting with version 1.28) will assume that this is a raw partition
- to be backed up. In this case, you are strongly urged to specify a {\bf
- sparse=yes} include option, otherwise, you will save the whole partition
- rather than just the actual data that the partition contains. For example:
-
-\footnotesize
-\begin{verbatim}
-Include {
- Options { signature=MD5; sparse=yes }
- File = /dev/hd6
-}
-\end{verbatim}
-\normalsize
-
- will backup the data in device /dev/hd6.
-
- Ludovic Strappazon has pointed out that this feature can be used to backup a
- full Microsoft Windows disk. Simply boot into the system using a Linux Rescue
- disk, then load a statically linked Bacula as described in the
- \ilink{ Disaster Recovery Using Bacula}{RescueChapter} chapter of
- this manual. Then save the whole disk partition. In the case of a disaster,
- you can then restore the desired partition by again booting with the rescue
- disk and doing a restore of the partition.
- \item If you explicitly specify a FIFO device name (created with mkfifo), and
- you add the option {\bf readfifo=yes} as an option, Bacula will read the FIFO
- and back its data up to the Volume. For example:
-
-\footnotesize
-\begin{verbatim}
-Include {
- Options {
- signature=SHA1
- readfifo=yes
- }
- File = /home/abc/fifo
-}
-\end{verbatim}
-\normalsize
-
- if {\bf /home/abc/fifo} is a fifo device, Bacula will open the fifo,
- read it, and store all data thus obtained on the Volume. Please note,
- you must have a process on the system that is writing into the fifo, or
- Bacula will hang, and after one minute of waiting, Bacula will give up
- and go on to the next file. The data read can be anything since Bacula
- treats it as a stream.
-
- This feature can be an excellent way to do a "hot" backup of a very
- large database. You can use the {\bf RunBeforeJob} to create the fifo
- and to start a program that dynamically reads your database and writes
- it to the fifo. Bacula will then write it to the Volume. Be sure to
- read the \ilink{readfifo section}{readfifo} that gives a
- tip to ensure that the RunBeforeJob does not block Bacula.
-
- During the restore operation, the inverse is true, after Bacula creates
- the fifo if there was any data stored with it (no need to explicitly
- list it or add any options), that data will be written back to the fifo.
- As a consequence, if any such FIFOs exist in the fileset to be restored,
- you must ensure that there is a reader program or Bacula will block, and
- after one minute, Bacula will time out the write to the fifo and move on
- to the next file.
-
-\item A file-list may not contain wild-cards. Use directives in the
- Options resource if you wish to specify wild-cards or regular expression
- matching.
-\end{itemize}
-
-\section{FileSet Examples}
-\index[general]{Examples!FileSet }
-\index[general]{FileSet Examples}
-
-The following is an example of a valid FileSet resource definition. Note,
-the first Include pulls in the contents of the file {\bf /etc/backup.list}
-when Bacula is started (i.e. the @), and that file must have each filename
-to be backed up preceded by a {\bf File =} and on a separate line.
-
-\footnotesize
-\begin{verbatim}
-FileSet {
- Name = "Full Set"
- Include {
- Options {
- Compression=GZIP
- signature=SHA1
- Sparse = yes
- }
- @/etc/backup.list
- }
- Include {
- Options {
- wildfile = "*.o"
- wildfile = "*.exe"
- Exclude = yes
- }
- File = /root/myfile
- File = /usr/lib/another_file
- }
-}
-\end{verbatim}
-\normalsize
-
-In the above example, all the files contained in /etc/backup.list will
-be compressed with GZIP compression, an SHA1 signature will be computed on the
-file's contents (its data), and sparse file handling will apply.
-
-The two directories /root/myfile and /usr/lib/another\_file will also be saved
-without any options, but all files in those directories with the extensions
-{\bf .o} and {\bf .exe} will be excluded.
-
-Let's say that you now want to exclude the directory /tmp. The simplest way
-to do so is to add an exclude directive that lists /tmp. The example
-above would then become:
-
-\footnotesize
-\begin{verbatim}
-FileSet {
- Name = "Full Set"
- Include {
- Options {
- Compression=GZIP
- signature=SHA1
- Sparse = yes
- }
- @/etc/backup.list
- }
- Include {
- Options {
- wildfile = "*.o"
- wildfile = "*.exe"
- Exclude = yes
- }
- File = /root/myfile
- File = /usr/lib/another_file
- }
- Exclude {
- File = /tmp
- }
-}
-\end{verbatim}
-\normalsize
-
-
-You can add wild-cards to the File directives listed in the Exclude
-directory, but you need to take care because if you exclude a directory,
-it and all files and directories below it will also be excluded.
-
-Now lets take a slight variation on the above and suppose
-you want to save all your whole filesystem except {\bf /tmp}.
-The problem that comes up is that Bacula will not normally
-cross from one filesystem to another.
-Doing a {\bf df} command, you get the following output:
-
-\footnotesize
-\begin{verbatim}
-[kern@rufus k]$ df
-Filesystem 1k-blocks Used Available Use% Mounted on
-/dev/hda5 5044156 439232 4348692 10% /
-/dev/hda1 62193 4935 54047 9% /boot
-/dev/hda9 20161172 5524660 13612372 29% /home
-/dev/hda2 62217 6843 52161 12% /rescue
-/dev/hda8 5044156 42548 4745376 1% /tmp
-/dev/hda6 5044156 2613132 2174792 55% /usr
-none 127708 0 127708 0% /dev/shm
-//minimatou/c$ 14099200 9895424 4203776 71% /mnt/mmatou
-lmatou:/ 1554264 215884 1258056 15% /mnt/matou
-lmatou:/home 2478140 1589952 760072 68% /mnt/matou/home
-lmatou:/usr 1981000 1199960 678628 64% /mnt/matou/usr
-lpmatou:/ 995116 484112 459596 52% /mnt/pmatou
-lpmatou:/home 19222656 2787880 15458228 16% /mnt/pmatou/home
-lpmatou:/usr 2478140 2038764 311260 87% /mnt/pmatou/usr
-deuter:/ 4806936 97684 4465064 3% /mnt/deuter
-deuter:/home 4806904 280100 4282620 7% /mnt/deuter/home
-deuter:/files 44133352 27652876 14238608 67% /mnt/deuter/files
-\end{verbatim}
-\normalsize
-
-And we see that there are a number of separate filesystems (/ /boot
-/home /rescue /tmp and /usr not to mention mounted systems).
-If you specify only {\bf /} in your Include list, Bacula will only save the
-Filesystem {\bf /dev/hda5}. To save all filesystems except {\bf /tmp} with
-out including any of the Samba or NFS mounted systems, and explicitly
-excluding a /tmp, /proc, .journal, and .autofsck, which you will not want to
-be saved and restored, you can use the following:
-
-\footnotesize
-\begin{verbatim}
-FileSet {
- Name = Include_example
- Include {
- Options {
- wilddir = /proc
- wilddir = /tmp
- wildfile = "/.journal"
- wildfile = "/.autofsck"
- exclude = yes
- }
- File = /
- File = /boot
- File = /home
- File = /rescue
- File = /usr
- }
-}
-\end{verbatim}
-\normalsize
-
-Since /tmp is on its own filesystem and it was not explicitly named in the
-Include list, it is not really needed in the exclude list. It is better to
-list it in the Exclude list for clarity, and in case the disks are changed so
-that it is no longer in its own partition.
-
-Now, lets assume you only want to backup .Z and .gz files and nothing
-else. This is a bit trickier because Bacula by default will select
-everything to backup, so we must exclude everything but .Z and .gz files.
-If we take the first example above and make the obvious modifications
-to it, we might come up with a FileSet that looks like this:
-
-\footnotesize
-\begin{verbatim}
-FileSet {
- Name = "Full Set"
- Include { !!!!!!!!!!!!
- Options { This
- wildfile = "*.Z" example
- wildfile = "*.gz" doesn't
- work
- } !!!!!!!!!!!!
- File = /myfile
- }
-}
-\end{verbatim}
-\normalsize
-
-The *.Z and *.gz files will indeed be backed up, but all other files
-that are not matched by the Options directives will automatically
-be backed up too (i.e. that is the default rule).
-
-To accomplish what we want, we must explicitly exclude all other files.
-We do this with the following:
-
-\footnotesize
-\begin{verbatim}
-FileSet {
- Name = "Full Set"
- Include {
- Options {
- wildfile = "*.Z"
- wildfile = "*.gz"
- }
- Options {
- Exclude = yes
- RegexFile = ".*"
- }
- File = /myfile
- }
-}
-\end{verbatim}
-\normalsize
-
-The "trick" here was to add a RegexFile expression that matches
-all files. It does not match directory names, so all directories in
-/myfile will be backed up (the directory entry) and any *.Z and *.gz
-files contained in them. If you know that certain directories do
-not contain any *.Z or *.gz files and you do not want the directory
-entries backed up, you will need to explicitly exclude those directories.
-Backing up a directory entries is not very expensive.
-
-Bacula uses the system regex library and some of them are
-different on different OSes. The above has been reported not to work
-on FreeBSD. This can be tested by using the {\bf estimate job=job-name
-listing} command in the console and adapting the RegexFile expression
-appropriately. In a future version of Bacula, we will supply our own
-Regex code to avoid such system dependencies.
-
-Please be aware that allowing Bacula to traverse or change file systems can be
-{\bf very} dangerous. For example, with the following:
-
-\footnotesize
-\begin{verbatim}
-FileSet {
- Name = "Bad example"
- Include {
- Options { onefs=no }
- File = /mnt/matou
- }
-}
-\end{verbatim}
-\normalsize
-
-you will be backing up an NFS mounted partition ({\bf /mnt/matou}), and since
-{\bf onefs} is set to {\bf no}, Bacula will traverse file systems. Now if {\bf
-/mnt/matou} has the current machine's file systems mounted, as is often the
-case, you will get yourself into a recursive loop and the backup will never
-end.
-
-As a final example, let's say that you have only one or two
-subdirectories of /home that you want to backup. For example,
-you want to backup only subdirectories beginning with the letter
-a and the letter b -- i.e. /home/a* and /home/b*. Now, you might first
-try:
-\footnotesize
-\begin{verbatim}
-FileSet {
- Name = "Full Set"
- Include {
- Options {
- wilddir = "/home/a*"
- wilddir = "/home/b*"
- }
- File = /home
- }
-}
-\end{verbatim}
-\normalsize
-
-The problem is that the above will include everything in /home. To get
-things to work correctly, you need to start with the idea of exclusion
-instead of inclusion. So, you could simply exclude all directories
-except the two you want to use:
-\footnotesize
-\begin{verbatim}
-FileSet {
- Name = "Full Set"
- Include {
- Options {
- RegexDir = "^/home/[c-z]"
- exclude = yes
- }
- File = /home
- }
-}
-\end{verbatim}
-\normalsize
-
-And assuming that all subdirectories start with a lowercase letter, this
-would work.
-
-An alternative would be to include the two subdirectories desired and
-exclude everything else:
-\footnotesize
-\begin{verbatim}
-FileSet {
- Name = "Full Set"
- Include {
- Options {
- wilddir = "/home/a*"
- wilddir = "/home/b*"
- }
- Options {
- RegexDir = ".*"
- exclude = yes
- }
- File = /home
- }
-}
-\end{verbatim}
-\normalsize
-
-\section{Backing up Raw Partitions}
-\index[general]{Backing up!Partitions }
-\index[general]{Backing up Raw Partitions }
-
-The following FileSet definition will backup a raw partition:
-
-\footnotesize
-\begin{verbatim}
-FileSet {
- Name = "RawPartition"
- Include {
- Options { sparse=yes }
- File = /dev/hda2
- }
-}
-\end{verbatim}
-\normalsize
-
-While backing up and restoring a raw partition, you should ensure that no
-other process including the system is writing to that partition. As a
-precaution, you are strongly urged to ensure that the raw partition is not
-mounted or is mounted read-only. If necessary, this can be done using the {\bf
-RunBeforeJob} directive.
-
-
-\section{Excluding Files and Directories}
-\index[general]{Directories!Excluding Files and }
-\index[general]{Excluding Files and Directories }
-
-You may also include full filenames or directory names in addition to using
-wild-cards and {\bf Exclude=yes} in the Options resource as specified above by
-simply including the files to be excluded in an Exclude resource within the
-FileSet. For example:
-
-\footnotesize
-\begin{verbatim}
-FileSet {
- Name = Exclusion_example
- Include {
- Options {
- Signature = SHA1
- }
- File = /
- File = /boot
- File = /home
- File = /rescue
- File = /usr
- }
- Exclude {
- File = /proc
- File = /tmp
- File = .journal
- File = .autofsck
- }
-}
-\end{verbatim}
-\normalsize
-
-\label{win32}
-\section{Windows FileSets}
-\index[general]{Windows FileSets }
-\index[general]{FileSets!Windows }
-If you are entering Windows file names, the directory path may be preceded by
-the drive and a colon (as in c:). However, the path separators must be
-specified in Unix convention (i.e. forward slash (/)). If you wish to include
-a quote in a file name, precede the quote with a backslash
-(\textbackslash{}). For example you might use the following
-for a Windows machine to backup the "My Documents" directory:
-
-\footnotesize
-\begin{verbatim}
-FileSet {
- Name = "Windows Set"
- Include {
- Options {
- WildFile = "*.obj"
- WildFile = "*.exe"
- exclude = yes
- }
- File = "c:/My Documents"
- }
-}
-\end{verbatim}
-\normalsize
-
-For exclude lists to work correctly on Windows, you must observe the following
-rules:
-
-\begin{itemize}
-\item Filenames are case sensitive, so you must use the correct case.
-\item To 2~exclude a directory, you must not have a trailing slash on the
- directory name.
-\item I2~f you have spaces in your filename, you must enclose the entire name
- in double-quote characters ("). Trying to use a backslash before the space
- will not work.
-\item If you are using the old Exclude syntax (noted below), you may not
- specify a drive letter in the exclude. The new syntax noted above
- should work fine including driver letters.
-\end{itemize}
-
-Thanks to Thiago Lima for summarizing the above items for us. If you are
-having difficulties getting includes or excludes to work, you might want to
-try using the {\bf estimate job=xxx listing} command documented in the
-\ilink{Console chapter}{estimate} of this manual.
-
-On Win32 systems, if you move a directory or file or rename a file into the
-set of files being backed up, and a Full backup has already been made, Bacula
-will not know there are new files to be saved during an Incremental or
-Differential backup (blame Microsoft, not me). To avoid this problem, please
-{\bf copy} any new directory or files into the backup area. If you do not have
-enough disk to copy the directory or files, move them, but then initiate a
-Full backup.
-
-
-\paragraph*{A Windows Example FileSet}
-\index[general]{FileSet!Windows Example }
-\index[general]{Windows Example FileSet }
-
-The following example was contributed by Russell Howe. Please note that
-for presentation purposes, the lines beginning with Data and Internet
-have been wrapped and should included on the previous line with one
-space.
-
-\footnotesize
-\begin{verbatim}
-This is my Windows 2000 fileset:
-FileSet {
- Name = "Windows 2000"
- Include {
- Options {
- signature = MD5
- Exclude = yes
- IgnoreCase = yes
- # Exclude Mozilla-based programs' file caches
- WildDir = "[A-Z]:/Documents and Settings/*/Application
-Data/*/Profiles/*/*/Cache"
- WildDir = "[A-Z]:/Documents and Settings/*/Application
-Data/*/Profiles/*/*/Cache.Trash"
- WildDir = "[A-Z]:/Documents and Settings/*/Application
-Data/*/Profiles/*/*/ImapMail"
-
- # Exclude user's registry files - they're always in use anyway.
- WildFile = "[A-Z]:/Documents and Settings/*/Local Settings/Application
-Data/Microsoft/Windows/usrclass.*"
- WildFile = "[A-Z]:/Documents and Settings/*/ntuser.*"
-
- # Exclude directories full of lots and lots of useless little files
- WildDir = "[A-Z]:/Documents and Settings/*/Cookies"
- WildDir = "[A-Z]:/Documents and Settings/*/Recent"
- WildDir = "[A-Z]:/Documents and Settings/*/Local Settings/History"
- WildDir = "[A-Z]:/Documents and Settings/*/Local Settings/Temp"
- WildDir = "[A-Z]:/Documents and Settings/*/Local Settings/Temporary
-Internet Files"
-
- # These are always open and unable to be backed up
- WildFile = "[A-Z]:/Documents and Settings/All Users/Application
-Data/Microsoft/Network/Downloader/qmgr[01].dat"
-
- # Some random bits of Windows we want to ignore
- WildFile = "[A-Z]:/WINNT/security/logs/scepol.log"
- WildDir = "[A-Z]:/WINNT/system32/config"
- WildDir = "[A-Z]:/WINNT/msdownld.tmp"
- WildDir = "[A-Z]:/WINNT/Internet Logs"
- WildDir = "[A-Z]:/WINNT/$Nt*Uninstall*"
- WildDir = "[A-Z]:/WINNT/sysvol"
- WildFile = "[A-Z]:/WINNT/cluster/CLUSDB"
- WildFile = "[A-Z]:/WINNT/cluster/CLUSDB.LOG"
- WildFile = "[A-Z]:/WINNT/NTDS/edb.log"
- WildFile = "[A-Z]:/WINNT/NTDS/ntds.dit"
- WildFile = "[A-Z]:/WINNT/NTDS/temp.edb"
- WildFile = "[A-Z]:/WINNT/ntfrs/jet/log/edb.log"
- WildFile = "[A-Z]:/WINNT/ntfrs/jet/ntfrs.jdb"
- WildFile = "[A-Z]:/WINNT/ntfrs/jet/temp/tmp.edb"
- WildFile = "[A-Z]:/WINNT/system32/CPL.CFG"
- WildFile = "[A-Z]:/WINNT/system32/dhcp/dhcp.mdb"
- WildFile = "[A-Z]:/WINNT/system32/dhcp/j50.log"
- WildFile = "[A-Z]:/WINNT/system32/dhcp/tmp.edb"
- WildFile = "[A-Z]:/WINNT/system32/LServer/edb.log"
- WildFile = "[A-Z]:/WINNT/system32/LServer/TLSLic.edb"
- WildFile = "[A-Z]:/WINNT/system32/LServer/tmp.edb"
- WildFile = "[A-Z]:/WINNT/system32/wins/j50.log"
- WildFile = "[A-Z]:/WINNT/system32/wins/wins.mdb"
- WildFile = "[A-Z]:/WINNT/system32/wins/winstmp.mdb"
-
- # Temporary directories & files
- WildDir = "[A-Z]:/WINNT/Temp"
- WildDir = "[A-Z]:/temp"
- WildFile = "*.tmp"
- WildDir = "[A-Z]:/tmp"
- WildDir = "[A-Z]:/var/tmp"
-
- # Recycle bins
- WildDir = "[A-Z]:/RECYCLER"
-
- # Swap files
- WildFile = "[A-Z]:/pagefile.sys"
-
- # These are programs and are easier to reinstall than restore from
- # backup
- WildDir = "[A-Z]:/cygwin"
- WildDir = "[A-Z]:/Program Files/Grisoft"
- WildDir = "[A-Z]:/Program Files/Java"
- WildDir = "[A-Z]:/Program Files/Java Web Start"
- WildDir = "[A-Z]:/Program Files/JavaSoft"
- WildDir = "[A-Z]:/Program Files/Microsoft Office"
- WildDir = "[A-Z]:/Program Files/Mozilla Firefox"
- WildDir = "[A-Z]:/Program Files/Mozilla Thunderbird"
- WildDir = "[A-Z]:/Program Files/mozilla.org"
- WildDir = "[A-Z]:/Program Files/OpenOffice*"
- }
-
- # Our Win2k boxen all have C: and D: as the main hard drives.
- File = "C:/"
- File = "D:/"
- }
-}
-\end{verbatim}
-\normalsize
-
-Note, the three line of the above Exclude were split to fit on the document
-page, they should be written on a single line in real use.
-
-\paragraph*{Windows NTFS Naming Considerations}
-\index[general]{Windows NTFS Naming Considerations }
-\index[general]{Considerations!Windows NTFS Naming }
-
-NTFS filenames containing Unicode characters should now be supported
-as of version 1.37.30 or later.
-
-\section{Testing Your FileSet}
-\index[general]{FileSet!Testing Your }
-\index[general]{Testing Your FileSet }
-
-If you wish to get an idea of what your FileSet will really backup or if your
-exclusion rules will work correctly, you can test it by using the {\bf
-estimate} command in the Console program. See the
-\ilink{estimate}{estimate} in the Console chapter of this
-manual.
-
-As an example, suppose you add the following test FileSet:
-
-\footnotesize
-\begin{verbatim}
-FileSet {
- Name = Test
- Include {
- File = /home/xxx/test
- Options {
- regex = ".*\.c$"
- }
- }
-}
-\end{verbatim}
-\normalsize
-
-You could then add some test files to the directory {\bf /home/xxx/test}
-and use the following command in the console:
-
-\footnotesize
-\begin{verbatim}
-estimate job=<any-job-name> listing client=<desired-client> fileset=Test
-\end{verbatim}
-\normalsize
-
-to give you a listing of all files that match.
+++ /dev/null
-#!/usr/bin/perl -w
-# Fixes various things within tex files.
-
-use strict;
-
-my %args;
-
-
-sub get_includes {
- # Get a list of include files from the top-level tex file.
- my (@list,$file);
-
- foreach my $filename (@_) {
- $filename or next;
- # Start with the top-level latex file so it gets checked too.
- push (@list,$filename);
-
- # Get a list of all the html files in the directory.
- open IF,"<$filename" or die "Cannot open input file $filename";
- while (<IF>) {
- chomp;
- push @list,"$1.tex" if (/\\include\{(.*?)\}/);
- }
-
- close IF;
- }
- return @list;
-}
-
-sub convert_files {
- my (@files) = @_;
- my ($linecnt,$filedata,$output,$itemcnt,$indentcnt,$cnt);
-
- $cnt = 0;
- foreach my $file (@files) {
- # Open the file and load the whole thing into $filedata. A bit wasteful but
- # easier to deal with, and we don't have a problem with speed here.
- $filedata = "";
- open IF,"<$file" or die "Cannot open input file $file";
- while (<IF>) {
- $filedata .= $_;
- }
- close IF;
-
- # We look for a line that starts with \item, and indent the two next lines (if not blank)
- # by three spaces.
- my $linecnt = 3;
- $indentcnt = 0;
- $output = "";
- # Process a line at a time.
- foreach (split(/\n/,$filedata)) {
- $_ .= "\n"; # Put back the return.
- # If this line is less than the third line past the \item command,
- # and the line isn't blank and doesn't start with whitespace
- # add three spaces to the start of the line. Keep track of the number
- # of lines changed.
- if ($linecnt < 3 and !/^\\item/) {
- if (/^[^\n\s]/) {
- $output .= " " . $_;
- $indentcnt++;
- } else {
- $output .= $_;
- }
- $linecnt++;
- } else {
- $linecnt = 3;
- $output .= $_;
- }
- /^\\item / and $linecnt = 1;
- }
-
-
- # This is an item line. We need to process it too. If inside a \begin{description} environment, convert
- # \item {\bf xxx} to \item [xxx] or \item [{xxx}] (if xxx contains '[' or ']'.
- $itemcnt = 0;
- $filedata = $output;
- $output = "";
- my ($before,$descrip,$this,$between);
-
- # Find any \begin{description} environment
- while ($filedata =~ /(\\begin[\s\n]*\{[\s\n]*description[\s\n]*\})(.*?)(\\end[\s\n]*\{[\s\n]*description[\s\n]*\})/s) {
- $output .= $` . $1;
- $filedata = $3 . $';
- $descrip = $2;
-
- # Search for \item {\bf xxx}
- while ($descrip =~ /\\item[\s\n]*\{[\s\n]*\\bf[\s\n]*/s) {
- $descrip = $';
- $output .= $`;
- ($between,$descrip) = find_matching_brace($descrip);
- if (!$descrip) {
- $linecnt = $output =~ tr/\n/\n/;
- print STDERR "Missing matching curly brace at line $linecnt in $file\n" if (!$descrip);
- }
-
- # Now do the replacement.
- $between = '{' . $between . '}' if ($between =~ /\[|\]/);
- $output .= "\\item \[$between\]";
- $itemcnt++;
- }
- $output .= $descrip;
- }
- $output .= $filedata;
-
- # If any hyphens or \item commnads were converted, save the file.
- if ($indentcnt or $itemcnt) {
- open OF,">$file" or die "Cannot open output file $file";
- print OF $output;
- close OF;
- print "$indentcnt indent", ($indentcnt == 1) ? "" : "s"," added in $file\n";
- print "$itemcnt item", ($itemcnt == 1) ? "" : "s"," Changed in $file\n";
- }
-
- $cnt += $indentcnt + $itemcnt;
- }
- return $cnt;
-}
-
-sub find_matching_brace {
- # Finds text up to the next matching brace. Assumes that the input text doesn't contain
- # the opening brace, but we want to find text up to a matching closing one.
- # Returns the text between the matching braces, followed by the rest of the text following
- # (which does not include the matching brace).
- #
- my $str = shift;
- my ($this,$temp);
- my $cnt = 1;
-
- while ($cnt) {
- # Ignore verbatim constructs involving curly braces, or if the character preceding
- # the curly brace is a backslash.
- if ($str =~ /\\verb\*?\{.*?\{|\\verb\*?\}.*?\}|\{|\}/s) {
- $this .= $`;
- $str = $';
- $temp = $&;
-
- if ((substr($this,-1,1) eq '\\') or
- $temp =~ /^\\verb/) {
- $this .= $temp;
- next;
- }
-
- $cnt += ($temp eq '{') ? 1 : -1;
- # If this isn't the matching curly brace ($cnt > 0), include the brace.
- $this .= $temp if ($cnt);
- } else {
- # No matching curly brace found.
- return ($this . $str,'');
- }
- }
- return ($this,$str);
-}
-
-sub check_arguments {
- # Checks command-line arguments for ones starting with -- puts them into
- # a hash called %args and removes them from @ARGV.
- my $args = shift;
- my $i;
-
- for ($i = 0; $i < $#ARGV; $i++) {
- $ARGV[$i] =~ /^\-+/ or next;
- $ARGV[$i] =~ s/^\-+//;
- $args{$ARGV[$i]} = "";
- delete ($ARGV[$i]);
-
- }
-}
-
-##################################################################
-# MAIN ####
-##################################################################
-
-my @includes;
-my $cnt;
-
-check_arguments(\%args);
-die "No Files given to Check\n" if ($#ARGV < 0);
-
-# Examine the file pointed to by the first argument to get a list of
-# includes to test.
-@includes = get_includes(@ARGV);
-
-$cnt = convert_files(@includes);
-print "No lines changed\n" unless $cnt;
+++ /dev/null
-# This module does multiple indices, supporting the style of the LaTex 'index'
-# package.
-
-# Version Information:
-# 16-Feb-2005 -- Original Creation. Karl E. Cunningham
-# 14-Mar-2005 -- Clarified and Consolodated some of the code.
-# Changed to smoothly handle single and multiple indices.
-
-# Two LaTeX index formats are supported...
-# --- SINGLE INDEX ---
-# \usepackage{makeidx}
-# \makeindex
-# \index{entry1}
-# \index{entry2}
-# \index{entry3}
-# ...
-# \printindex
-#
-# --- MULTIPLE INDICES ---
-#
-# \usepackage{makeidx}
-# \usepackage{index}
-# \makeindex -- latex2html doesn't care but LaTeX does.
-# \newindex{ref1}{ext1}{ext2}{title1}
-# \newindex{ref2}{ext1}{ext2}{title2}
-# \newindex{ref3}{ext1}{ext2}{title3}
-# \index[ref1]{entry1}
-# \index[ref1]{entry2}
-# \index[ref3]{entry3}
-# \index[ref2]{entry4}
-# \index{entry5}
-# \index[ref3]{entry6}
-# ...
-# \printindex[ref1]
-# \printindex[ref2]
-# \printindex[ref3]
-# \printindex
-# ___________________
-#
-# For the multiple-index style, each index is identified by the ref argument to \newindex, \index,
-# and \printindex. A default index is allowed, which is indicated by omitting the optional
-# argument. The default index does not require a \newindex command. As \index commands
-# are encountered, their entries are stored according
-# to the ref argument. When the \printindex command is encountered, the stored index
-# entries for that argument are retrieved and printed. The title for each index is taken
-# from the last argument in the \newindex command.
-# While processing \index and \printindex commands, if no argument is given the index entries
-# are built into a default index. The title of the default index is simply "Index".
-# This makes the difference between single- and multiple-index processing trivial.
-#
-# Another method can be used by omitting the \printindex command and just using \include to
-# pull in index files created by the makeindex program. These files will start with
-# \begin{theindex}. This command is used to determine where to print the index. Using this
-# approach, the indices will be output in the same order as the newindex commands were
-# originally found (see below). Using a combination of \printindex and \include{indexfile} has not
-# been tested and may produce undesireable results.
-#
-# The index data are stored in a hash for later sorting and output. As \printindex
-# commands are handled, the order in which they were found in the tex filea is saved,
-# associated with the ref argument to \printindex.
-#
-# We use the original %index hash to store the index data into. We append a \002 followed by the
-# name of the index to isolate the entries in different indices from each other. This is necessary
-# so that different indices can have entries with the same name. For the default index, the \002 is
-# appended without the name.
-#
-# Since the index order in the output cannot be determined if the \include{indexfile}
-# command is used, the order will be assumed from the order in which the \newindex
-# commands were originally seen in the TeX files. This order is saved as well as the
-# order determined from any printindex{ref} commands. If \printindex commnads are used
-# to specify the index output, that order will be used. If the \include{idxfile} command
-# is used, the order of the original newindex commands will be used. In this case the
-# default index will be printed last since it doesn't have a corresponding \newindex
-# command and its order cannot be determined. Mixing \printindex and \include{idxfile}
-# commands in the same file is likely to produce less than satisfactory results.
-#
-#
-# The hash containing index data is named %indices. It contains the following data:
-#{
-# 'title' => {
-# $ref1 => $indextitle ,
-# $ref2 => $indextitle ,
-# ...
-# },
-# 'newcmdorder' => [ ref1, ref2, ..., * ], # asterisk indicates the position of the default index.
-# 'printindorder' => [ ref1, ref2, ..., * ], # asterisk indicates the position of the default index.
-#}
-
-
-# Globals to handle multiple indices.
-my %indices;
-
-# This tells the system to use up to 7 words in index entries.
-$WORDS_IN_INDEX = 10;
-
-# KEC 2-18-05
-# Handles the \newindex command. This is called if the \newindex command is
-# encountered in the LaTex source. Gets the index ref and title from the arguments.
-# Saves the index ref and title.
-# Note that we are called once to handle multiple \newindex commands that are
-# newline-separated.
-sub do_cmd_newindex {
- my $data = shift;
- # The data is sent to us as fields delimited by their ID #'s. We extract the
- # fields.
- foreach my $line (split("\n",$data)) {
- my @fields = split (/(?:\<\#\d+?\#\>)+/,$line);
-
- # The index name and title are the second and fourth fields in the data.
- if ($line =~ /^</ or $line =~ /^\\newindex/) {
- my ($indexref,$indextitle) = ($fields[1],$fields[4]);
- $indices{'title'}{$indexref} = $indextitle;
- push (@{$indices{'newcmdorder'}},$indexref);
- }
- }
-}
-
-
-# KEC -- Copied from makeidx.perl and modified to do multiple indices.
-# Processes an \index entry from the LaTex file.
-# Gets the optional argument from the index command, which is the name of the index
-# into which to place the entry.
-# Drops the brackets from the index_name
-# Puts the index entry into the html stream
-# Creates the tokenized index entry (which also saves the index entry info
-sub do_real_index {
- local($_) = @_;
- local($pat,$idx_entry,$index_name);
- # catches opt-arg from \index commands for index.sty
- $index_name = &get_next_optional_argument;
- $index_name = "" unless defined $index_name;
- # Drop leading and trailing brackets from the index name.
- $index_name =~ s/^\[|\]$//g;
-
- $idx_entry = &missing_braces unless (
- (s/$next_pair_pr_rx/$pat=$1;$idx_entry=$2;''/e)
- ||(s/$next_pair_rx/$pat=$1;$idx_entry=$2;''/e));
-
- if ($index_name and defined $idx_entry and
- !defined $indices{'title'}{$index_name}) {
- print STDERR "\nInvalid Index Name: \\index \[$index_name\]\{$idx_entry\}\n";
- }
-
- $idx_entry = &named_index_entry($pat, $idx_entry,$index_name);
- $idx_entry.$_;
-}
-
-# Creates and saves an index entry in the index hashes.
-# Modified to do multiple indices.
-# Creates an index_key that allows index entries to have the same characteristics but be in
-# different indices. This index_key is the regular key with the index name appended.
-# Save the index order for the entry in the %index_order hash.
-sub named_index_entry {
- local($br_id, $str, $index_name) = @_;
- my ($index_key);
- # escape the quoting etc characters
- # ! -> \001
- # @ -> \002
- # | -> \003
- $* = 1; $str =~ s/\n\s*/ /g; $* = 0; # remove any newlines
- # protect \001 occurring with images
- $str =~ s/\001/\016/g; # 0x1 to 0xF
- $str =~ s/\\\\/\011/g; # Double backslash -> 0xB
- $str =~ s/\\;SPMquot;/\012/g; # \;SPMquot; -> 0xC
- $str =~ s/;SPMquot;!/\013/g; # ;SPMquot; -> 0xD
- $str =~ s/!/\001/g; # Exclamation point -> 0x1
- $str =~ s/\013/!/g; # 0xD -> Exclaimation point
- $str =~ s/;SPMquot;@/\015/g; # ;SPMquot;@ to 0xF
- $str =~ s/@/\002/g; # At sign -> 0x2
- $str =~ s/\015/@/g; # 0xF to At sign
- $str =~ s/;SPMquot;\|/\017/g; # ;SMPquot;| to 0x11
- $str =~ s/\|/\003/g; # Vertical line to 0x3
- $str =~ s/\017/|/g; # 0x11 to vertical line
- $str =~ s/;SPMquot;(.)/\1/g; # ;SPMquot; -> whatever the next character is
- $str =~ s/\012/;SPMquot;/g; # 0x12 to ;SPMquot;
- $str =~ s/\011/\\\\/g; # 0x11 to double backslash
- local($key_part, $pageref) = split("\003", $str, 2);
-
- # For any keys of the form: blablabla!blablabla, which want to be split at the
- # exclamation point, replace the ! with a comma and a space. We don't do it
- # that way for this index.
- $key_part =~ s/\001/, /g;
- local(@keys) = split("\001", $key_part);
- # If TITLE is not yet available use $before.
- $TITLE = $saved_title if (($saved_title)&&(!($TITLE)||($TITLE eq $default_title)));
- $TITLE = $before unless $TITLE;
- # Save the reference
- local($words) = '';
- if ($SHOW_SECTION_NUMBERS) { $words = &make_idxnum; }
- elsif ($SHORT_INDEX) { $words = &make_shortidxname; }
- else { $words = &make_idxname; }
- local($super_key) = '';
- local($sort_key, $printable_key, $cur_key);
- foreach $key (@keys) {
- $key =~ s/\016/\001/g; # revert protected \001s
- ($sort_key, $printable_key) = split("\002", $key);
- #
- # RRM: 16 May 1996
- # any \label in the printable-key will have already
- # created a label where the \index occurred.
- # This has to be removed, so that the desired label
- # will be found on the Index page instead.
- #
- if ($printable_key =~ /tex2html_anchor_mark/ ) {
- $printable_key =~ s/><tex2html_anchor_mark><\/A><A//g;
- local($tmpA,$tmpB) = split("NAME=\"", $printable_key);
- ($tmpA,$tmpB) = split("\"", $tmpB);
- $ref_files{$tmpA}='';
- $index_labels{$tmpA} = 1;
- }
- #
- # resolve and clean-up the hyperlink index-entries
- # so they can be saved in an index.pl file
- #
- if ($printable_key =~ /$cross_ref_mark/ ) {
- local($label,$id,$ref_label);
- # $printable_key =~ s/$cross_ref_mark#(\w+)#(\w+)>$cross_ref_mark/
- $printable_key =~ s/$cross_ref_mark#([^#]+)#([^>]+)>$cross_ref_mark/
- do { ($label,$id) = ($1,$2);
- $ref_label = $external_labels{$label} unless
- ($ref_label = $ref_files{$label});
- '"' . "$ref_label#$label" . '">' .
- &get_ref_mark($label,$id)}
- /geo;
- }
- $printable_key =~ s/<\#[^\#>]*\#>//go;
- #RRM
- # recognise \char combinations, for a \backslash
- #
- $printable_key =~ s/\&\#;\'134/\\/g; # restore \\s
- $printable_key =~ s/\&\#;\`<BR> /\\/g; # ditto
- $printable_key =~ s/\&\#;*SPMquot;92/\\/g; # ditto
- #
- # $sort_key .= "@$printable_key" if !($printable_key); # RRM
- $sort_key .= "@$printable_key" if !($sort_key); # RRM
- $sort_key =~ tr/A-Z/a-z/;
- if ($super_key) {
- $cur_key = $super_key . "\001" . $sort_key;
- $sub_index{$super_key} .= $cur_key . "\004";
- } else {
- $cur_key = $sort_key;
- }
-
- # Append the $index_name to the current key with a \002 delimiter. This will
- # allow the same index entry to appear in more than one index.
- $index_key = $cur_key . "\002$index_name";
-
- $index{$index_key} .= "";
-
- #
- # RRM, 15 June 1996
- # if there is no printable key, but one is known from
- # a previous index-entry, then use it.
- #
- if (!($printable_key) && ($printable_key{$index_key}))
- { $printable_key = $printable_key{$index_key}; }
-# if (!($printable_key) && ($printable_key{$cur_key}))
-# { $printable_key = $printable_key{$cur_key}; }
- #
- # do not overwrite the printable_key if it contains an anchor
- #
- if (!($printable_key{$index_key} =~ /tex2html_anchor_mark/ ))
- { $printable_key{$index_key} = $printable_key || $key; }
-# if (!($printable_key{$cur_key} =~ /tex2html_anchor_mark/ ))
-# { $printable_key{$cur_key} = $printable_key || $key; }
-
- $super_key = $cur_key;
- }
- #
- # RRM
- # page-ranges, from |( and |) and |see
- #
- if ($pageref) {
- if ($pageref eq "\(" ) {
- $pageref = '';
- $next .= " from ";
- } elsif ($pageref eq "\)" ) {
- $pageref = '';
- local($next) = $index{$index_key};
-# local($next) = $index{$cur_key};
- # $next =~ s/[\|] *$//;
- $next =~ s/(\n )?\| $//;
- $index{$index_key} = "$next to ";
-# $index{$cur_key} = "$next to ";
- }
- }
-
- if ($pageref) {
- $pageref =~ s/\s*$//g; # remove trailing spaces
- if (!$pageref) { $pageref = ' ' }
- $pageref =~ s/see/<i>see <\/i> /g;
- #
- # RRM: 27 Dec 1996
- # check if $pageref corresponds to a style command.
- # If so, apply it to the $words.
- #
- local($tmp) = "do_cmd_$pageref";
- if (defined &$tmp) {
- $words = &$tmp("<#0#>$words<#0#>");
- $words =~ s/<\#[^\#]*\#>//go;
- $pageref = '';
- }
- }
- #
- # RRM: 25 May 1996
- # any \label in the pageref section will have already
- # created a label where the \index occurred.
- # This has to be removed, so that the desired label
- # will be found on the Index page instead.
- #
- if ($pageref) {
- if ($pageref =~ /tex2html_anchor_mark/ ) {
- $pageref =~ s/><tex2html_anchor_mark><\/A><A//g;
- local($tmpA,$tmpB) = split("NAME=\"", $pageref);
- ($tmpA,$tmpB) = split("\"", $tmpB);
- $ref_files{$tmpA}='';
- $index_labels{$tmpA} = 1;
- }
- #
- # resolve and clean-up any hyperlinks in the page-ref,
- # so they can be saved in an index.pl file
- #
- if ($pageref =~ /$cross_ref_mark/ ) {
- local($label,$id,$ref_label);
- # $pageref =~ s/$cross_ref_mark#(\w+)#(\w+)>$cross_ref_mark/
- $pageref =~ s/$cross_ref_mark#([^#]+)#([^>]+)>$cross_ref_mark/
- do { ($label,$id) = ($1,$2);
- $ref_files{$label} = ''; # ???? RRM
- if ($index_labels{$label}) { $ref_label = ''; }
- else { $ref_label = $external_labels{$label}
- unless ($ref_label = $ref_files{$label});
- }
- '"' . "$ref_label#$label" . '">' . &get_ref_mark($label,$id)}/geo;
- }
- $pageref =~ s/<\#[^\#>]*\#>//go;
-
- if ($pageref eq ' ') { $index{$index_key}='@'; }
- else { $index{$index_key} .= $pageref . "\n | "; }
- } else {
- local($thisref) = &make_named_href('',"$CURRENT_FILE#$br_id",$words);
- $thisref =~ s/\n//g;
- $index{$index_key} .= $thisref."\n | ";
- }
- #print "\nREF: $sort_key : $index_key :$index{$index_key}";
-
- #join('',"<A NAME=$br_id>$anchor_invisible_mark<\/A>",$_);
-
- "<A NAME=\"$br_id\">$anchor_invisible_mark<\/A>";
-}
-
-
-# KEC. -- Copied from makeidx.perl, then modified to do multiple indices.
-# Feeds the index entries to the output. This is called for each index to be built.
-#
-# Generates a list of lookup keys for index entries, from both %printable_keys
-# and %index keys.
-# Sorts the keys according to index-sorting rules.
-# Removes keys with a 0x01 token. (duplicates?)
-# Builds a string to go to the index file.
-# Adds the index entries to the string if they belong in this index.
-# Keeps track of which index is being worked on, so only the proper entries
-# are included.
-# Places the index just built in to the output at the proper place.
-{ my $index_number = 0;
-sub add_real_idx {
- print "\nDoing the index ... Index Number $index_number\n";
- local($key, @keys, $next, $index, $old_key, $old_html);
- my ($idx_ref,$keyref);
- # RRM, 15.6.96: index constructed from %printable_key, not %index
- @keys = keys %printable_key;
-
- while (/$idx_mark/) {
- # Get the index reference from what follows the $idx_mark and
- # remove it from the string.
- s/$idxmark\002(.*?)\002/$idxmark/;
- $idx_ref = $1;
- $index = '';
- # include non- makeidx index-entries
- foreach $key (keys %index) {
- next if $printable_key{$key};
- $old_key = $key;
- if ($key =~ s/###(.*)$//) {
- next if $printable_key{$key};
- push (@keys, $key);
- $printable_key{$key} = $key;
- if ($index{$old_key} =~ /HREF="([^"]*)"/i) {
- $old_html = $1;
- $old_html =~ /$dd?([^#\Q$dd\E]*)#/;
- $old_html = $1;
- } else { $old_html = '' }
- $index{$key} = $index{$old_key} . $old_html."</A>\n | ";
- };
- }
- @keys = sort makeidx_keysort @keys;
- @keys = grep(!/\001/, @keys);
- my $cnt = 0;
- foreach $key (@keys) {
- my ($keyref) = $key =~ /.*\002(.*)/;
- next unless ($idx_ref eq $keyref); # KEC.
- $index .= &add_idx_key($key);
- $cnt++;
- }
- print "$cnt Index Entries Added\n";
- $index = '<DD>'.$index unless ($index =~ /^\s*<D(D|T)>/);
- $index_number++; # KEC.
- if ($SHORT_INDEX) {
- print "(compact version with Legend)";
- local($num) = ( $index =~ s/\<D/<D/g );
- if ($num > 50 ) {
- s/$idx_mark/$preindex<HR><DL>\n$index\n<\/DL>$preindex/o;
- } else {
- s/$idx_mark/$preindex<HR><DL>\n$index\n<\/DL>/o;
- }
- } else {
- s/$idx_mark/<DL COMPACT>\n$index\n<\/DL>/o; }
- }
-}
-}
-
-# KEC. Copied from latex2html.pl and modified to support multiple indices.
-# The bibliography and the index should be treated as separate sections
-# in their own HTML files. The \bibliography{} command acts as a sectioning command
-# that has the desired effect. But when the bibliography is constructed
-# manually using the thebibliography environment, or when using the
-# theindex environment it is not possible to use the normal sectioning
-# mechanism. This subroutine inserts a \bibliography{} or a dummy
-# \textohtmlindex command just before the appropriate environments
-# to force sectioning.
-sub add_bbl_and_idx_dummy_commands {
- local($id) = $global{'max_id'};
-
- s/([\\]begin\s*$O\d+$C\s*thebibliography)/$bbl_cnt++; $1/eg;
- ## if ($bbl_cnt == 1) {
- s/([\\]begin\s*$O\d+$C\s*thebibliography)/$id++; "\\bibliography$O$id$C$O$id$C $1"/geo;
- #}
- $global{'max_id'} = $id;
- # KEC. Modified to global substitution to place multiple index tokens.
- s/[\\]begin\s*($O\d+$C)\s*theindex/\\textohtmlindex$1/go;
- # KEC. Modified to pick up the optional argument to \printindex
- s/[\\]printindex\s*(\[.*?\])?/
- do { (defined $1) ? "\\textohtmlindex $1" : "\\textohtmlindex []"; } /ego;
- &lib_add_bbl_and_idx_dummy_commands() if defined(&lib_add_bbl_and_idx_dummy_commands);
-}
-
-# KEC. Copied from latex2html.pl and modified to support multiple indices.
-# For each textohtmlindex mark found, determine the index titles and headers.
-# We place the index ref in the header so the proper index can be generated later.
-# For the default index, the index ref is blank.
-#
-# One problem is that this routine is called twice.. Once for processing the
-# command as originally seen, and once for processing the command when
-# doing the name for the index file. We can detect that by looking at the
-# id numbers (or ref) surrounding the \theindex command, and not incrementing
-# index_number unless a new id (or ref) is seen. This has the side effect of
-# having to unconventionally start the index_number at -1. But it works.
-#
-# Gets the title from the list of indices.
-# If this is the first index, save the title in $first_idx_file. This is what's referenced
-# in the navigation buttons.
-# Increment the index_number for next time.
-# If the indexname command is defined or a newcommand defined for indexname, do it.
-# Save the index TITLE in the toc
-# Save the first_idx_file into the idxfile. This goes into the nav buttons.
-# Build index_labels if needed.
-# Create the index headings and put them in the output stream.
-
-{ my $index_number = 0; # Will be incremented before use.
- my $first_idx_file; # Static
- my $no_increment = 0;
-
-sub do_cmd_textohtmlindex {
- local($_) = @_;
- my ($idxref,$idxnum,$index_name);
-
- # We get called from make_name with the first argument = "\001noincrement". This is a sign
- # to not increment $index_number the next time we are called. We get called twice, once
- # my make_name and once by process_command. Unfortunately, make_name calls us just to set the name
- # but doesn't use the result so we get called a second time by process_command. This works fine
- # except for cases where there are multiple indices except if they aren't named, which is the case
- # when the index is inserted by an include command in latex. In these cases we are only able to use
- # the index number to decide which index to draw from, and we don't know how to increment that index
- # number if we get called a variable number of times for the same index, as is the case between
- # making html (one output file) and web (multiple output files) output formats.
- if (/\001noincrement/) {
- $no_increment = 1;
- return;
- }
-
- # Remove (but save) the index reference
- s/^\s*\[(.*?)\]/{$idxref = $1; "";}/e;
-
- # If we have an $idxref, the index name was specified. In this case, we have all the
- # information we need to carry on. Otherwise, we need to get the idxref
- # from the $index_number and set the name to "Index".
- if ($idxref) {
- $index_name = $indices{'title'}{$idxref};
- } else {
- if (defined ($idxref = $indices{'newcmdorder'}->[$index_number])) {
- $index_name = $indices{'title'}{$idxref};
- } else {
- $idxref = '';
- $index_name = "Index";
- }
- }
-
- $idx_title = "Index"; # The name displayed in the nav bar text.
-
- # Only set $idxfile if we are at the first index. This will point the
- # navigation panel to the first index file rather than the last.
- $first_idx_file = $CURRENT_FILE if ($index_number == 0);
- $idxfile = $first_idx_file; # Pointer for the Index button in the nav bar.
- $toc_sec_title = $index_name; # Index link text in the toc.
- $TITLE = $toc_sec_title; # Title for this index, from which its filename is built.
- if (%index_labels) { &make_index_labels(); }
- if (($SHORT_INDEX) && (%index_segment)) { &make_preindex(); }
- else { $preindex = ''; }
- local $idx_head = $section_headings{'textohtmlindex'};
- local($heading) = join(''
- , &make_section_heading($TITLE, $idx_head)
- , $idx_mark, "\002", $idxref, "\002" );
- local($pre,$post) = &minimize_open_tags($heading);
- $index_number++ unless ($no_increment);
- $no_increment = 0;
- join('',"<BR>\n" , $pre, $_);
-}
-}
-
-# Returns an index key, given the key passed as the first argument.
-# Not modified for multiple indices.
-sub add_idx_key {
- local($key) = @_;
- local($index, $next);
- if (($index{$key} eq '@' )&&(!($index_printed{$key}))) {
- if ($SHORT_INDEX) { $index .= "<DD><BR>\n<DT>".&print_key."\n<DD>"; }
- else { $index .= "<DT><DD><BR>\n<DT>".&print_key."\n<DD>"; }
- } elsif (($index{$key})&&(!($index_printed{$key}))) {
- if ($SHORT_INDEX) {
- $next = "<DD>".&print_key."\n : ". &print_idx_links;
- } else {
- $next = "<DT>".&print_key."\n<DD>". &print_idx_links;
- }
- $index .= $next."\n";
- $index_printed{$key} = 1;
- }
-
- if ($sub_index{$key}) {
- local($subkey, @subkeys, $subnext, $subindex);
- @subkeys = sort(split("\004", $sub_index{$key}));
- if ($SHORT_INDEX) {
- $index .= "<DD>".&print_key unless $index_printed{$key};
- $index .= "<DL>\n";
- } else {
- $index .= "<DT>".&print_key."\n<DD>" unless $index_printed{$key};
- $index .= "<DL COMPACT>\n";
- }
- foreach $subkey (@subkeys) {
- $index .= &add_sub_idx_key($subkey) unless ($index_printed{$subkey});
- }
- $index .= "</DL>\n";
- }
- return $index;
-}
-
-1; # Must be present as the last line.
+++ /dev/null
-/* Century Schoolbook font is very similar to Computer Modern Math: cmmi */
-.MATH { font-family: "Century Schoolbook", serif; }
-.MATH I { font-family: "Century Schoolbook", serif; font-style: italic }
-.BOLDMATH { font-family: "Century Schoolbook", serif; font-weight: bold }
-
-/* implement both fixed-size and relative sizes */
-SMALL.XTINY { font-size : xx-small }
-SMALL.TINY { font-size : x-small }
-SMALL.SCRIPTSIZE { font-size : smaller }
-SMALL.FOOTNOTESIZE { font-size : small }
-SMALL.SMALL { }
-BIG.LARGE { }
-BIG.XLARGE { font-size : large }
-BIG.XXLARGE { font-size : x-large }
-BIG.HUGE { font-size : larger }
-BIG.XHUGE { font-size : xx-large }
-
-/* heading styles */
-H1 { }
-H2 { }
-H3 { }
-H4 { }
-H5 { }
-
-/* mathematics styles */
-DIV.displaymath { } /* math displays */
-TD.eqno { } /* equation-number cells */
-
-
-/* document-specific styles come next */
+++ /dev/null
-[General]
-img_extIsRegExp=false
-img_extensions=.eps .jpg .jpeg .png .pdf .ps .fig .gif
-kileprversion=2
-kileversion=2.0
-lastDocument=install.tex
-masterDocument=
-name=Install
-pkg_extIsRegExp=false
-pkg_extensions=.cls .sty
-src_extIsRegExp=false
-src_extensions=.tex .ltx .latex .dtx .ins
-
-[Tools]
-MakeIndex=
-QuickBuild=
-
-[item:autochangerres.tex]
-archive=true
-column=111
-encoding=
-highlight=
-line=0
-open=false
-order=-1
-
-[item:configure.tex]
-archive=true
-column=0
-encoding=UTF-8
-highlight=LaTeX
-line=359
-open=false
-order=-1
-
-[item:consoleconf.tex]
-archive=true
-column=85
-encoding=
-highlight=
-line=0
-open=false
-order=-1
-
-[item:critical.tex]
-archive=true
-column=134217832
-encoding=
-highlight=
-line=0
-open=false
-order=-1
-
-[item:dirdconf.tex]
-archive=true
-column=0
-encoding=
-highlight=LaTeX
-line=0
-open=false
-order=2
-
-[item:filedconf.tex]
-archive=true
-column=143543216
-encoding=
-highlight=
-line=0
-open=false
-order=-1
-
-[item:fileset.tex]
-archive=true
-column=0
-encoding=
-highlight=
-line=0
-open=false
-order=-1
-
-[item:install.kilepr]
-archive=true
-column=0
-encoding=
-highlight=
-line=0
-open=false
-order=-1
-
-[item:install.tex]
-archive=true
-column=36
-encoding=UTF-8
-highlight=LaTeX
-line=57
-open=true
-order=0
-
-[item:installation.tex]
-archive=true
-column=2
-encoding=
-highlight=LaTeX
-line=0
-open=false
-order=1
-
-[item:messagesres.tex]
-archive=true
-column=0
-encoding=
-highlight=
-line=0
-open=false
-order=-1
-
-[item:monitorconf.tex]
-archive=true
-column=0
-encoding=
-highlight=
-line=0
-open=false
-order=-1
-
-[item:quickstart.tex]
-archive=true
-column=23
-encoding=UTF-8
-highlight=LaTeX
-line=156
-open=false
-order=-1
-
-[item:security.tex]
-archive=true
-column=0
-encoding=
-highlight=
-line=0
-open=false
-order=-1
-
-[item:storedconf.tex]
-archive=true
-column=0
-encoding=
-highlight=
-line=0
-open=false
-order=-1
-
-[item:version.tex]
-archive=true
-column=161
-encoding=
-highlight=
-line=0
-open=false
-order=-1
+++ /dev/null
-%%
-%%
-%% The following characters must be preceded by a backslash
-%% to be entered as printable characters:
-%%
-%% # $ % & ~ _ ^ \ { }
-%%
-
-\documentclass[10pt,a4paper]{book}
-
-\topmargin -0.5in
-\oddsidemargin 0.0in
-\evensidemargin 0.0in
-\textheight 10in
-\textwidth 6.5in
-
-\usepackage{html}
-\usepackage{float}
-\usepackage{graphicx}
-\usepackage{bacula}
-\usepackage{longtable}
-\usepackage{makeidx}
-\usepackage{index}
-\usepackage{setspace}
-\usepackage{hyperref}
-\usepackage{url}
-
-
-\makeindex
-\newindex{dir}{ddx}{dnd}{Director Index}
-\newindex{fd}{fdx}{fnd}{File Daemon Index}
-\newindex{sd}{sdx}{snd}{Storage Daemon Index}
-\newindex{console}{cdx}{cnd}{Console Index}
-\newindex{general}{idx}{ind}{General Index}
-
-\sloppy
-
-\begin{document}
-\sloppy
-
-\newfont{\bighead}{cmr17 at 36pt}
-\parskip 10pt
-\parindent 0pt
-
-\title{\includegraphics{\idir bacula-logo.eps} \\ \bigskip
- \Huge{Bacula Installation and Configuration Guide}
- \begin{center}
- \large{It comes in the night and sucks
- the essence from your computers. }
- \end{center}
-}
-
-
-\author{Kern Sibbald}
-\date{\vspace{1.0in}\today \\
- This manual documents Bacula version \input{version} \\
- \vspace{0.2in}
- Copyright \copyright 1999-2009, Free Software Foundation Europe
- e.V. \\
- \vspace{0.2in}
- Permission is granted to copy, distribute and/or modify this document under the terms of the
- GNU Free Documentation License, Version 1.2 published by the Free Software Foundation;
- with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
- A copy of the license is included in the section entitled "GNU Free Documentation License".
-}
-
-\maketitle
-
-\clearpage
-\tableofcontents
-\clearpage
-\listoffigures
-\clearpage
-\listoftables
-\clearpage
-
-\include{quickstart}
-\include{installation}
-\include{critical}
-\include{configure}
-\include{dirdconf}
-\include{filedconf}
-\include{storedconf}
-\include{messagesres}
-\include{consoleconf}
-\include{monitorconf}
-\include{security}
-\include{fdl}
-
-
-% The following line tells link_resolver.pl to not include these files:
-% nolinks developersi baculai-dir baculai-fd baculai-sd baculai-console baculai-main
-
-% pull in the index
-\clearpage
-\printindex[general]
-\printindex[dir]
-\printindex[fd]
-\printindex[sd]
-\printindex[console]
-
-\end{document}
+++ /dev/null
-%%
-%%
-
-\chapter{Bacula installieren}
-\label{InstallChapter}
-\index[general]{Installation!von Bacula }
-\index[general]{Bacula installieren }
-
-Normalerweise ben\"{o}tigen Sie ein Release mit Baculas Quellcode und, wenn ein Windows-Client benutzt werde soll, ein ausf\"{u}hrbares Release von Bacula f\"{u}r Windows. Entprechend Ihrer Konfigurationsoptionen ben\"{o}tigt Bacula bestimmte Pakete von Drittanbietern (wie z.B. {\bf SQLite}, {\bf MySQL} oder {\bf PostgreSQL}) zur Kompilierung. Um Ihnen die Arbeit zu erleichtern, haben wir einige dieser Softwarepakete als zwei {\bf depkgs}-Releases ver\"{o}ffentlicht (Dependency Packages). Dies kann Ihr Leben ungemein erleichtern, da Sie so mit allen notwendigen Pakaten versorgt anstatt gezwungen sind, sie selbst einzeln im Internet zu finden und zu installieren.
-
-\section{Source Release Files}
-\index[general]{Source Files}
-\index[general]{Release Files}
-
-Seit Baculas Version 1.38.0 ist der Quellcode in vier einzelne Tar-Dateien aufgeteilt, die jeweils einem Modul in Baculas CVS entsprechen. Im einzelnen sind dies:
-
-\begin{description}
-\item [bacula-1.38.0.tar.gz]
-Dies ist Baculas Quellcode. Mit jedem Release erh\"{o}ht sich die Versionsnummer.
-
-\item [bacula-docs-1.38.0.tar.gz]
-Diese Datei enth\"{a}lt eine Kopie des Verzeichnisses der Dokumente im CVS. Einige Dokumente sind vorkompiliert. F\"{u}r Englisch existiert ein HTML-Verzeichnis, ein einzelnes HTML-File und eine PDF-Datei. Die franz\"{o}sische und die deutsche Übersetzung sind in Arbeit, aber nicht kompiliert.
-
-\item [bacula-gui-1.38.0.tar.gz]
-Diese Datei enth\"{a}lt grafische Benutzeroberfl\"{a}chen, die nicht Bestandteil des Hauptprogrammes sind. Momentan sind dies ``bacula-web'' zur Generierung von Verwaltungsansichten Ihrer Bacula-Jobs innerhalb eines Web-Browsers und ``bimagemgr'', ein Dateibrowser, der verwendet wird, um aus Bacula-Volumes CD-Images zu brennen.
-
-\item [bacula-rescue-1.8.1.tar.gz]
-Dies ist der Code f\"{u}r die Bacula Rettungs-CD. Die Versionsnummer diese Paketes ist nicht an die Versionsummer von Bacula gebunden und wird sich daher unterscheiden. Mit diesem Code k\"{o}nnen Sie eine CD brennen, die unter anderem eine Beschreibung Ihrer Systemkonfiguration und die statisch gelinkte Version des File-D\"{a}mons enth\"{a}lt. Damit k\"{o}nnen Sie im Falle eines Festplattenausfalles mit Hilfe von Bacula Ihre Festplatten neu partitionieren, formatieren und Ihr System auf einfache Art wiederherstellen.
-
-\end{description}
-
-
-\label{upgrading1}
-
-\section{Bacula upgraden}
-\index[general]{Bacula!als Upgrade }
-\index[general]{Bacula upgraden }
-\index[general]{Upgrade }
-
-Wenn Sie Bacula von einer Version auf die n\"{a}chste upgraden, sollten Sie erst die ReleaseNotes aller Versionen zwischen Ihrer laufenden und jener, auf die sie upgraden wollen, sorgf\"{a}ltig lesen. Wenn die Bacula Catalog-Datenbank upgegraded wurde, m\"{u}ssen Sie entweder ganz von vorne anfangen und Ihre Datenbank neu initialisieren oder diese als ASCII-Datei sichern und dann mit dem Upgrade fortfahren.
-Dies geschieht normalerweise nachdem Bacula kompiliert und installiert ist durch Eingabe von:
-
-\begin{verbatim}
-cd <installed-scripts-dir> (default /etc/bacula)
-./update_bacula_tables
-\end{verbatim}
-
-Dieses Update-Skript finden Sie auch in Baculas Quellcode im Verzeichnis ``src/cats'':
-
-Gab es zwischen Ihrer Version und der aktuellen mehrere Datenbank-Upgrades, werden Sie jedes einzelne Datenbank Upgradeskript ausf\"{u}hren m\"{u}ssen. Um Ihnen dies zu erleichtern, sind alle alten Upgrade-Skripte im Verzeichnis {\bf upgradedb} des Quellcodes. Sie werden diese Skripte den Gegebenheiten Ihrer Systemkonfiguration anpassen m\"{u}ssen.
-
-Das letzte Upgrade-Skript (wenn vorhanden) wird dann so ausgef\"{u}hrt, wie es oben beschrieben ist.
-
-Wenn Sie von einer Hauptversion auf die n\"{a}chste upgraden, m\"{u}ssen alle Komponenten gleichzeitig ersetzt werden, da sich in der Regel das Übertragungs-Protokoll zwischen den D\"{a}monen \"{a}ndert. Innerhalb eines bestimmten Release (z.B. Version 1.32.x) wird sich das D\"{a}mon-Protokoll jedoch nicht \"{a}ndern solange nicht ein Bug oder ein Versehen zu beheben ist. Wenn das alles f\"{u}r Sie verwirrend ist, lesen Sie einfach die ReleaseNotes sehr sorgf\"{a}ltig. Es wird hier stehen, wenn alle D\"{a}monen gleichzeitig upgegraded werden m\"{u}ssen.
-
-Beachten Sie schlie{\ss}lich, dass es in der Regel nicht notwendig ist, vor dem Upgrade ein {\bf make uninstall} auszuf\"{u}hren. Tats\"{a}chlich werden Sie so sehr wahrscheinlich alle ihre Konfigurationsdateien zerst\"{o}ren, was verheerend sein k\"{o}nnte.
-Die normale Upgrade-Prozedur besteht einfach in der Eingabe von {\bf make install}.
-Im allgemeinen werden dabei keine Ihrer ``.conf''- oder ``.sql''-Dateien \"{u}berschrieben.
-
- Weiteres zum Upgraden lesen sie im Abschnitt \ilink{Upgrading Bacula Versions}{upgrading} im Kapitel ``Tips'' in diesem Handbuch.
-
-\section{Dependency-Packages}
-\label{Dependency}
-\index[general]{Dependency-Packages }
-\index[general]{Packages!Dependency }
-
-Wie oben erw\"{a}hnt, haben wir einige Pakete von Drittanbietern, die Bacula m\"{o}glicherweise ben\"{o}tigt, in den Releases {\bf depkgs} und {\bf depkgs1} zusammengefasst. Nat\"{u}rlich k\"{o}nnen Sie sich auch die neuesten Versionen von den Original-Autoren besorgen. Die Quellen der einzelnen Pakete stehen in der README-Datei jedes einzelnen Paketes. Beachten Sie jedoch, dass die Pakete der \textbf{depkgs}-Dateien von uns auf ihre Kompatibilit\"{a}t zu Bacula getestet wurden.
-
-Typischerweise hei{\ss}en die Dependency-Packages {\bf depkgs-ddMMMyy.tar.gz} und
-{\bf depkgs1-ddMMyy.tar.gz} wobei {\bf dd} der Tag, {\bf MMM} der Monat in abgek\"{u}rzter Form (z.B. ``Jan'') und {\bf yy} das Jahr ist, an dem es herausgegeben wurde. Ein aktuelles Beispiel ist: {\bf depkgs-07Apr02.tar.gz}. Um es zu installiern und zu kompilieren (wenn es ben\"{o}tigt wird) gehen Sie wie folgt vor:
-
-\begin{enumerate}
-\item Erstellen sie ein {\bf bacula}-Verzeichnis, in das Sie sowohl die Bacula-Quelldateien als auch das Dependency-Packages legen.
-\item Entpacken Sie das {\bf depkg} mit ``detar'' in das {\bf bacula}-Verzeichnis.
-\item cd bacula/depkgs
-\item make
- \end{enumerate}
-
-Die genaue Zusanmmensetzung der Dependency-Packages wird sich von Zeit zu Zeit \"{a}ndern. Momentan sehen sie so aus:
-
-\addcontentsline{lot}{table}{Dependency-Packages}
-\begin{longtable}{|l|l|l|l|}
- \hline
-\multicolumn{1}{|c| }{\bf Drittanbieterpaket } & \multicolumn{1}{c| }{\bf
-depkgs } & \multicolumn{1}{c| }{\bf depkgs1 } & \multicolumn{1}{c| }{\bf
-depkgs-win32 } \\
- \hline {SQLite } & \multicolumn{1}{c| }{X } & \multicolumn{1}{c| }{- } &
-\multicolumn{1}{c| }{- } \\
- \hline {mtx } & \multicolumn{1}{c| }{X } & \multicolumn{1}{c| }{- } &
-\multicolumn{1}{c| }{- } \\
- \hline {readline } & \multicolumn{1}{c| }{- } & \multicolumn{1}{c| }{X } &
-\multicolumn{1}{c| }{- } \\
- \hline {pthreads } & \multicolumn{1}{c| }{- } & \multicolumn{1}{c| }{- } &
-\multicolumn{1}{c| }{X } \\
- \hline {zlib } & \multicolumn{1}{c| }{- } & \multicolumn{1}{c| }{- } &
-\multicolumn{1}{c| }{X } \\
- \hline {wxWidgets } & \multicolumn{1}{c| }{- } & \multicolumn{1}{c| }{- } &
-\multicolumn{1}{c| }{X }
-\\ \hline
-
-\end{longtable}
-
-
-Beachten Sie, dass einige dieser Pakete recht umfangreich sind, so dass ihre Compilierung einige Zeit beanspruchen kann. Mit den obigen Anweisungen werden alle Pakete im entsprechenden Verzeichnis kompiliert. Bacula wird allerdings bei seine Kompilierung nur jene Teile verwenden, die es tats\"{a}chlich ben\"{o}tigt.
-
-Alternativ k\"{o}nnen Sie nur jene Pakete kompilieren, die Sie tats\"{a}chlich ben\"{o}tigen. Beispielsweise wird
-
-\footnotesize
-\begin{verbatim}
-cd bacula/depkgs
-make sqlite
-\end{verbatim}
-\normalsize
-
-nur das ``SQLite''-Paket konfigurieren und kompilieren.
-
-Sie sollten die ben\"{o}tigten Pakete aus {\bf depkgs} und/oder {\bf depkgs1} kompilieren bevor Sie Bacula konfigurieren und kompilieren, da Bacula diese w\"{a}hrend seiner eigenen Kompilierung ben\"{o}tigt.
-
-Auch wenn Sie SQLite nicht verwenden, k\"{o}nnte es sich f\"{u}r Sie lohnen {\bf mtx} zu kompilieren, da das enthaltenen {\bf tapeinfo}-Programm oft wertvolle Informationen \"{u}ber Ihr SCSI-Bandlaufwerk (z.B. Kompression, min./max. Blockgr\"{o}{\ss}e...) liefern kann.
-
-Das {\bf depkgs-win32}-Paket enth\"{a}lt den Qullcode der ``Pthreads''-, ``wxWidgets''- und ``zlib''-Bibliotheken, die das Win32-Clientprogramm verwendet. Man ben\"{o}tigt diese nur, wenn Sie das Win32-Programm selbst kompilieren wollen.
-
-\section{Unterst\"{u}tzte Betriebssysteme}
-\label{Systems}
-\index[general]{Betriebssysteme!Unterst\"{u}tzte }
-\index[general]{Unterst\"{u}tzte Betriebssysteme }
-
-Lesen sie bitte den Abschnitt
-\ilink{Unterst\"{u}tzte Betriebssysteme}{SupportedOSes} im Kapitel
-``QuickStart'' dieses Handbuches.
-
-\section{Bacula aus dem Quellcode kompilieren}
-\label{Building}
-\index[general]{Quellcode!Kompilation von Bacula aus dem }
-\index[general]{Bacula aus dem Quellcode kompilieren}
-
-Die Grundinstallation ist ziemlich einfach.
-
-\begin{enumerate}
-\item Installieren und kompilieren sie alle ben\"{o}tgten {\bf depkgs} wie oben beschrieben.
-\item Konfigurieren und installieren Sie ``MySQL'' oder ``PostgreSQL'' (wenn gew\"{u}nscht)
-\ilink{Installation und Konfiguration von MySQL Phase I}{_ChapterStart} oder
-\ilink{Installation und Konfiguration von PostgreSQL Phase I}{_ChapterStart10}. Wenn Sie f\"{u}r die Installation von ``MySQL'' ein RPM verwenden, m\"{u}ssen Sie auch {\bf mysql-devel} installieren, so dass die Header-Dateien verf\"{u}gbar sind, wenn Sie Bacula kompilieren. Zus\"{a}tzlich erfordert die MySQL Client-Bibliothek die gzip-Kompressionsbibliotheken {\bf libz.a} oder {\bf libz.so}. Wenn Sie RPM-Pakete verwenden, sind diese Bibliotheken im Paket {\bf zlib1g-dev}. Auf Debian-Systemen m\"{u}ssen Sie das {\bf zlib1g-dev}-Paket laden. Wenn Sie weder RPMs noch debs verwenden, m\"{u}ssen Sie die passenden Pakete f\"{u}r Ihr System selbst finden.
-Wenn auf Ihrem System schon MySQL oder PostgreSQL l\"{a}uft, k\"{o}nnen Sie diese Phase \"{u}berspringen, wenn Sie ``thread safe''-Bibliotheken kompiliert und die oben erw\"{a}hnten zus\"{a}tzlichen RPMs installiert haben.
-
-\item Anstatt ``MySQL'' und ``PostgreSQL'' k\"{o}nnen Sie auch SQLite konfigurieren und installieren \ilink{Installation und Konfiguration von SQLite}{_ChapterStart33}. Dessen Quellcode ist Teil des {\bf depkgs}-Paketes.
-\item Entpacken sie Baculas Quellcode vorzugsweise in das {\bf bacula}-Verzeichnis, welches oben erw\"{a}hnt wurde.
-\item Wechseln ({\bf cd}) Sie in das Verzeichnis mit dem Quellcode.
-\item F\"{u}hren Sie \textbf{./configure} aus (mit den entsprechenden Konfigurationsoptionen, die weiter unten n\"{a}her beschrieben sind.
-\item Pr\"{u}fen Sie die Ausgabe des \textbf{./configure}-Befehls sehr sorgf\"{a}ltig, besonders die Ausgaben zum Installationsverzeichnis der Programm- und der Konfigurationsdateien. Sind diese nicht korrekt, wiederholen Sie \textbf{./configure} bis sie stimmen. Die Ausgabe des ./configure-Befehls ist in der Datei {\bf config.out} abgespeichert und kann jederzeit wieder angesehen werden, ohne \textbf{./configure} neu zu starten, indem man {\bf cat config.out} eingibt.
-\item Wenn Sie Optionen \"{a}ndern, nachdem \textbf{./configure} gelaufen war und Sie es neu starten m\"{u}ssen, geben Sie vorher das folgende ein.
-
-\footnotesize
-\begin{verbatim}
- make distclean
-\end{verbatim}
-\normalsize
-
-Damit gehen Sie sicher, dass Sie wirklich von vorne anfangen und keine Mischung der verschiedenen Optionen haben. Dies liegt daran, dass \textbf{./configure} einen Gro{\ss}teil der Informationen zwischenspeichert. {\bf make distclean} ist auch sehr wichtig, wenn Sie die Quellverzeichnisse auf einen anderen Rechner verlagern. Schl\"{a}gt der Befehl fehl, ignorieren Sie das einfach und machen mit
-
-\item make
-
-weiter.
-
-Wenn es hierbei Fehlermeldungen beim Linken in das Verzeichnis (src/stored) des Storage-D\"{a}mon gibt, liegt es vielleicht daran, dass sie die statischen Bibliotheken in Ihrem System nicht geladen sind. Diese Problem bemerkte ich auf einem Solaris-System. Verwenden sie den {\bf ./configure}-Befehl ohne die Option {\bf \verb{--{enable-static-tools} um den Fehler zu beheben.
-
-\item make install
-
-\item
-Wenn Sie ein Bacula-Neuling sind, empfehlen wir \textbf{dringend}, den n\"{a}chsten Schritt zu \"{u}berspringen und die Vorgabe-Konfigurationsdateien zu verwenden. Probieren Sie damit das Beispiel im n\"{a}chsten Kapitel aus und \"{a}ndern sie danach Ihre Konfigurationsdateien, so dass sie Ihren eigenen Anforderungen entsprechen.
-
-\item Passen Sie die Konfigurationsdateien aller drei D\"{a}monprozesse und die des Console-Programms an. Einzelheiten hierzu im Abschnitt \ilink{Setting Up Bacula Configuration Files}{_ChapterStart16} des Kapitels ``Konfiguration'' in diesem Handbuch. Wir empfehlen Ihnen, an den beigef\"{u}gten Vorgabe-Konfigurationsdateien zun\"{a}chst nur soviel zu \"{a}ndern wie unbedingt notwendig ist. Eine endg\"{u}ltige Anpassung ist immer noch m\"{o}glich, wenn Bacula zuverl\"{a}ssig l\"{a}uft. Passen Sie bitte auf, wenn sie die (zuf\"{a}llig generierten) Passw\"{o}rter und die {\bf Name}n ver\"{a}ndern. Aus Sicherheitsgr\"{u}nden m\"{u}ssen diese in den Konfigurationsdateien \"{u}bereinstimmen.
-
-\item Erzeugen Sie die Datenbank und die Tabellen f\"{u}r Bacula in MySQL (wenn sie MySQL verwenden)(\ilink{MySQL installieren und Konfigurieren Phase II}{mysql_phase2}, in PostgreSQL (\ilink{PostgreSQL installieren und Konfigurieren Phase II}{PostgreSQL_phase2}) oder gegebenenfalls in SQLite (\ilink{SQLite installieren und Konfigurieren Phase II}{phase2}).
-
-\item Starten Sie Bacula ({\bf ./bacula start}). Im n\"{a}chsten Kapitel wird dies im einzelnen erkl\"{a}rt.
-\item Kommunizieren Sie mit Bacula \"{u}ber das Console-Programm.
-
-\item Folgen Sie f\"{u}r die letzten beiden Punkte den Anweisungen im Kapitel \ilink{Running Bacula}{_ChapterStart1} diese Handbuches, wo Sie eine einfache Sicherung und eine Wiederherstellung durchf\"{u}hren. Tun Sie dies bevor Sie die Konfiguratinsdateien in gr\"{o}{\ss}erem Umfang ver\"{a}ndern, so dass Sie sicher sein k\"{o}nnen, dass Bacula funktioniert und Sie damit vertraut sind. Danach wird es einfacher sein, die Konfigurationsdateien anzupassen.
-
-\item Wenn Sie nach der Installation beschlie{\ss}en, mit Bacula ``umzuziehen'', d.h. es in anderen Verzeichnissen installieren zu wollen, gehen Sie wie folgt vor:
-
-\footnotesize
-\begin{verbatim}
- make uninstall
- make distclean
- ./configure (mit-den-neuen-Optionen)
- make
- make install
-\end{verbatim}
-\normalsize
-
-\end{enumerate}
-
-Wenn alles gut geht, wird der {\bf ./configure}-Prozess Ihr laufendes Betriebssystem korrekt erkennen und den Quellcode entsprechend konfigurieren. Momentan werden FreeBSD, Linux (Red Hat) und Solaris unterst\"{u}tzt. Von MacOS X 10.3 wird berichtet, dass der Client nur dann darauf l\"{a}uft, wenn die readline-Unterst\"{u}tzung deaktiviert ist.
-
-Wenn Sie Bacula auf mehr als einem System installieren, k\"{o}nnen Sie einfach den Verzeichnisbaum des Quellcodes auf den anderen Rechner \"{u}bertragen und ein ``make install'' ausf\"{u}hren. Gibt es jedoch Unterschiede in den Bibliotheken, den Betriebssystemversionen oder soll es auf einem anderen Betriebssystem installiert werden, sollten Sie mit der originalen tar-Datei beginnen. Wenn Sie die Verzeichnisstruktur des Quellcodes \"{u}bertragen und den ./configure-Befehl schon ausgef\"{u}hrt haben, m\"{u}ssen Sie unbedingt
-
-\footnotesize
-\begin{verbatim}
-make distclean
-\end{verbatim}
-\normalsize
-
-ausf\"{u}hren, bevor Sie ``./configure'' erneut aufrufen. Dies liegt daran, dass ``GNU autoconf'' die Konfiguration zwischenspeichert und wenn Sie beispielsweise die Konfiguration eines Linux-Rechners auf einem Solaris-System wiederverwenden, k\"{o}nnen Sie sicher sein, dass die Kompilierung fehlschl\"{a}gt. Um dies zu vermeiden starten Sie entweder mit der tar-Datei oder f\"{u}hren ``make distclean'' aus, wie oben erw\"{a}hnt.
-
-Gew\"{o}hnlich werden Sie einen etwas komplizierteren {\bf configure}-Befehl absetzen wollen, um sicher zu gehen, dass die von Ihnen gew\"{u}nschten Module kompiliert werden und alles in den richtigen Verzeichnissen abgelegt wird.
-
-Auf RedHat zum Beispiel k\"{o}nnte ``./configure'' so aussehen:
-
-\footnotesize
-\begin{verbatim}
-CFLAGS="-g -Wall" \
- ./configure \
- --sbindir=$HOME/bacula/bin \
- --sysconfdir=$HOME/bacula/bin \
- --with-pid-dir=$HOME/bacula/bin/working \
- --with-subsys-dir=$HOME/bacula/bin/working \
- --with-mysql=$HOME/mysql \
- --with-working-dir=$HOME/bacula/bin/working \
- --with-dump-email=$USER
-\end{verbatim}
-\normalsize
-
-
-Beachten Sie bitte, dass der Vorteil der Verwendung der obigen Konfiguration f\"{u}r den Anfang darin liegt, dass hierbei alles in ein einziges Verzeichnis geschrieben wird, welches sp\"{a}ter gel\"{o}scht werden kann, wenn Sie die Beispiele des n\"{a}chsten Kapitels ausgef\"{u}hrt und gelernt haben wie Bacula funktioniert. Ausserdem kann das Obige auch ohne root-Rechte installiert und ausgef\"{u}hrt werden.
-
-Um den Entwicklern die Arbeit zu erleichtern, haben wir dem Verzeichnis {\bf examples} ein {\bf defaultconfig}-Skript beigef\"{u}gt. Diese Skript enth\"{a}lt alle Statements, die man normalerweise benutzt und jeder Entwickler oder Benutzer kann sie nach seinen Bed\"{u}rfnissen ver\"{a}ndern. In diesem Verzeichnis sind auch andere n\"{u}tzliche Beispiele.
-
-Die \textbf{./configure}-Schalter {\bf \verb{--{enable-conio} oder {\bf \verb{--{enable-readline} sind n\"{u}tzlich, da man dadurch eine Kommandozeilen-History und ein Editorfunktionen f\"{u}r die Kommandozeile des Console-Programms erh\"{a}lt. Wenn Sie eine dieser Optionen verwenden, ben\"{o}tigen Sie beim Linken entweder das {\bf termcap}- oder das {\bf ncurses}-Paket. Auf manchen Systemen wie z.B. ``SuSE'' ist die termcap-Bibliothek nicht im Verzeichnis der Standard-Bibliotheken. Daher kann diese Option wirkungslos sein oder Sie erhalten folgende Fehlermeldung
-
-\footnotesize
-\begin{verbatim}
-/usr/lib/gcc-lib/i586-suse-linux/3.3.1/.../ld:
-cannot find -ltermcap
-collect2: ld returned 1 exit status
-\end{verbatim}
-\normalsize
-
-w\"{a}hrend Sie die Bacula-Console kompilieren. In diesem Fall m\"{u}sssen Sie die {\bf
-LDFLAGS}-Umgebungsvariable vor der Kompilierung wie folgt setzen:
-
-\footnotesize
-\begin{verbatim}
-export LDFLAGS="-L/usr/lib/termcap"
-\end{verbatim}
-\normalsize
-
-Die gleichen Erfordernisse an die Systembibliothek gelten, wenn sie die ``Readline''-Subroutinen f\"{u}r das Editieren und die History der Kommandozeile benutzen wollen oder eine MySQL-Bibliothek, die Verschl\"{u}sselung erfordert. Wenn Sie Verschl\"{u}sselung ben\"{o}tigen, k\"{o}nnen Sie entweder die entsprechenden zus\"{a}tzlichen Bibliotheks-Pfade wie oben gezeigt setzen oder wie unten gezeigt direkt in der Befehlzeile des Befehls mit angeben.
-
-\footnotesize
-\begin{verbatim}
-LDFLAGS="-lssl -lcyrpto" \
- ./configure \
- <Ihre-Optionen>
-\end{verbatim}
-\normalsize
-
-Auf manchen Systemen wie Mandriva neigt ``readline'' dazu, die Eingaben zu verst\"{u}mmeln, was es v\"{o}llig unbrauchbar macht. Wenn das bei Ihnen geschieht, w\"{a}hlen Sie die Option ab oder, wenn Sie Version 1.33 oder h\"{o}her verwenden, versuchen Sie mit der Option \verb{--{enable-conio den eingebauten ``readline''-Ersatz zu verwenden. Auch hierzu werden Sie entweder die ``termcap''- oder ``ncurses''-Bibliothek ben\"{o}tigen, doch es ist unwahrscheinlich, dass das {\bf conio}-Paket Ihre Eingaben dann verst\"{u}mmelt.
-
-``readline'' wird ab Version 1.34. nicht weiter unterst\"{u}tzt. Der Code ist noch verf\"{u}gbar und wenn Benutzer daf\"{u}r Patches schicken, wird es mir ein Vergn\"{u}gen sein, diese einzubauen. Da jedoch jede Version von ``readline'' mit den Vorg\"{a}ngerversionen inkompatibel zu sein scheint und zwischen den Systemen wesentliche Unterschiede bestehen, kann ich es mir nicht mehr l\"{a}nger leisten, es zu unterst\"{u}tzen.
-
-\section{Welches Datenbanksystem soll verwendet werden?}
-\label{DB}
-\index[general]{Welches Datenbanksystem soll verwendet werden? }
-\index[general]{verwenden!Welches Datenbanksystem }
-
-Vor der Kompilierung von Bacula m\"{u}ssen Sie sich entscheiden, ob Sie SQLite, MySQL oder
-PostgreSQL verwenden werden. Wenn bei Ihnen nicht sowieso schon MySQl oder PostgrSQL l\"{a}uft, empfehlen wir versuchsweise mit SQLite zu beginnen. Dies wird Ihnen die Einrichtung wesentlich erleichtern, da SQLite in Bacula hineinkompiliert wird und keine Administration erfordert. Es hat hat eine ganz ordentliche Performanz und ist f\"{u}r kleine bis mittlere Installationen gut geeignet (maximal 10 bis 20 Rechner).
-Allerdings sollten wir erw\"{a}hnen, dass einige unserer Benutzer mit SQLite unerkl\"{a}rliche Datenbankkorruptionen hatten. F\"{u}r ein Produktiv-System empfehlen wir daher die Installation von MySQL oder PostgreSQL:
-
-Wenn Sie f\"{u}r den Bacula-Catalog MySQL verwenden wollen, lesen Sie bitte das Kapitel \ilink{MySQL installieren und konigurieren}{_ChapterStart} in diesem Handbuch. Sie werden hierzu MySQL installieren m\"{u}ssen, bevor Sie Bacula konfigurieren. MySQL ist ein Datenbanksystem von hoher Qualit\"{a}t, das sehr effizient arbeitet und f\"{u}r Installationen jeder Gr\"{o}{\ss}e geeignet ist. Seine Einrichtung und Administration sind ein wenig komplizierter als die von SQLite, da es einige Besonderheiten wie userids und Passw\"{o}rter bietet. Es l\"{a}uft als eigenst\"{a}ndiger Prozess, ist wirklich professionell und kommt mit Datenbanken jeder Gr\"{o}{\ss}e zurecht.
-
-Wenn Sie PostgreSQL als Bacula-Catalog verwenden wollen, lesen Sie bitte das Kapitel \ilink{PostgreSQL installieren und konfigurieren}{_ChapterStart10} in diesem Handbuch. Bevor Bacula konfiguriert wird, muss PostgreSQl installiert sein. Es ist MySQL sehr \"{a}hnlich, dabei aber eher etwas mehr SQL92-kompatibel und hat viele Features wie ``Transaktionen'', ``Stored Procedures'' und \"{a}hnliches. Man braucht eine gewisses Erfahrung, um es zu installieren und zu warten.
-
-Wenn Sie als Bacula Catalog SQLite verwenden wollen, lesen Sie bitte das Kapitel \ilink{SQLite installieren und konfigurieren}{_ChapterStart33} in diesem Handbuch.
-
-\section{Quick Start}
-\index[general]{Quick Start }
-\index[general]{Start!Quick }
-
-Unten werden nun einige Optionen und wichtige Vor\"{u}berlegungen ausgef\"{u}hrt, die Sie jedoch f\"{u}r den Moment \"{u}berspringen k\"{o}nnen, wenn Sie mit der vereinfachten Konfiguration, wie sie oben gezeigt wurde, keine Probleme hatten.
-
-Falls der ``./configure''-Prozess bestimmte Bibliotheken (z.B. ``libintl'') nicht findet, vergewissern Sie sich, dass das entsprechende Paket auf Ihrem Rechner installiert ist. Wenn das Paket an einem Ort installiert ist, denn Bacula nicht erwartet, kann in der Regel mit einem der im Folgenden aufgef\"{u}hrten Optionsschalter ein Suchpfad \"{u}bergeben werden. "./configure {-}{-}help" liefert eine Liste aller Optionen. Das letzte Mittel ist, ein Feature durch einen entsprechenden Optionschalter zu deaktivieren (z.B. ``{-}{-}disable-nls'').
-
-Wenn Sie richtig loslegen wollen, empfehlen wir, zum n\"{a}chsten Kapitel weitergehen und das Beispielprogramm zum Laufen zu bringen. Es wird Sie viel \"{u}ber Bacula lehren und kann zum Ausprobieren in ein einzelnes Verzeichnis installiert (um es auf einfache Art wieder l\"{o}schen zu k\"{o}nnen) und ohne root-Rechte betrieben werden. Wenn irgendwelche Probleme auftreten oder Sie richtig installieren wollen, kehren Sie zu diesem Kapitel zur\"{u}ck und lesen Sie die Einzelheiten, die nun folgen.
-
-\section{Konfigurationsoptionen}
-\label{Options}
-\index[general]{Optionen!der Konfiguration }
-\index[general]{Konfigurationsoptionen }
-
-Um Ihre Installation anzupassen, hat der {\bf configure}-Befehl die folgenden Kommandozeilen-Schalter.
-
-\begin{description}
-
-\item [{-}{-}sysbindir=\lt{}Pfad/zu/den/Programmdateien\gt{}]
- \index[general]{--sysbindir }
-Legt fest, in welches Verzeichnis die Bacula Programmdateien bei Ausf\"{u}hrung des {\bf make install}-Befehls installiert werden.
-
-\item [{-}{-}sysconfdir=\lt{}Pfad/zu/den/Konfigurationsdateien\gt{}]
- \index[general]{--sysconfdir }
- Legt fest, in welches Verzeichnis die Bacula Konfigurationsdateien bei Ausf\"{u}hrung des {\bf make install}-Befehls installiert werden.
-
-\item [ {-}{-}mandir=\lt{}path\gt{}]
- \index[general]{{-}{-}mandir}
-Vorgabem\"{a}{\ss}ig installiert Bacula eine einfache Unix-manpage in ``/usr/share/man''. Soll die manpage an einen anderen Ort, k\"{o}nnen Sie mit dieser Option einen Pfad setzen. Beachten Sie bitte, dass die Bacula-Handb\"{u}cher (HTML- und PDF-Dateien) Bestandteil eines eigenen tar-Files sind, das nicht Bestandteil des Quellcode-Releases ist.
-
-\item [ {-}{-}datadir=\lt{}path\gt{}]
- \index[general]{{-}{-}datadir}
-Wenn Sie Bacula oder Teile davon \"{u}bersetzen wollen, k\"{o}nnen Sie die ``{\bf
- {-}{-}datadir}''-Option verwenden um den Speicherort der ``po''-Dateien festzulegen. Die ``po''-Dateien m\"{u}ssen ``von Hand'' installiert werden, da Bacula dies (noch) nicht automatisch tut.
-
-\item [{-}{-}enable-smartalloc ]
- \index[general]{--enable-smartalloc }
- Damit wird der ``Smartalloc orphaned buffer detection code'' mit eingebunden. Diese Option ist dringend empfohlen. Da wir nie ohne diese Option kompilieren, werden Sie vielleicht Probleme haben, wenn sie nicht gesetzt ist. Wir empfehlen dringend, diesen Schalter gesetzt zu lassen, da er hilft, Memory-Leaks zu entdecken. Dieser Konfigurationsparameter wird bei der Kompilierung von Bacula benutzt.
-
-\item [{-}{-}enable-gnome ]
- \index[general]{--enable-gnome }
- Ist auf Ihrem Computer GNOME installiert und wollen Sie das grafische GNOME-Interface benutzen, setzen Sie diesen Schalter. Dadurch wird alles im Verzeichnis {\bf src/gnome-console} kompiliert.
-
-\item [{-}{-}enable-wx-console ]
- \index[general]{--enable-wx-console }
- Wenn auf Ihrem Rechner wxWidgets installiert ist und sie das grafische wxWidgets Console-Interface benutzen wollen, m\"{u}ssen Sie diesen Schalter setzen. Hierdurch wird alles im Verzeichnis {\bf src/wx-console} kompiliert. Dies kann auch f\"{u}r Benutzer hilfreich sein, die eine grafische Konsole benutzen, aber GNOME nicht installieren wollen, da wxWidgets mit GTK+-, Motif- und sogar X11-Bibliotheken l\"{a}uft
-
-\item [{-}{-}enable-tray-monitor ]
- \index[general]{--enable-tray-monitor }
-Wenn Sie auf Ihrem Rechner GTK installiert haben und eine grafische Umgebung oder einen Window-Manager benutzen, der dem Standard f\"{u}r die System-Tray von FreeDesktop entspricht (wie KDE oder GNOME) und wenn sie Ihre GUI benutzen wollen, um die Bacula-D\"{a}monen zu \"{u}berwachen, sollten sie diesen Schalter setzen. Ist er gesetzt, wird alles im Verzeichnis {\bf src/tray-monitor} kompiliert.
-
-\item [{-}{-}enable-static-tools]
- \index[general]{--enable-static-tools }
-Durch Setzen dieses Schalters werden die Hilfsprogramme des Storage-D\"{a}mons ({\bf bls}, {\bf bextract}, and {\bf bscan}) statisch gelinkt. Dadurch kann man sie auch verwenden, ohne dass die gemeinsamen Bibliotheken geladen sind. Wenn beim Linken Probleme im Verzeichnis {\bf src/stored} auftreten, sollten sie sich vergewissern, dass diese Option nicht gesetzt ist. Sie k\"{o}nnen durch Setzen des Schalters {\bf \verb{--{disable-static-tools} das statische Linken auch explizit unterdr\"{u}cken.
-
-\item [{-}{-}enable-static-fd]
- \index[general]{--enable-static-fd }
-Durch diese Option kompiliert der make-Prozess zus\"{a}tzlich zum Standard File-D\"{a}mon einen statischen Bacula File-D\"{a}mon. Diese statische Version hat alle ben\"{o}tigten Bibliotheken statisch gelinkt und wird f\"{u}r eine Notfallwiederherstellung auf einer leeren Festplatte verwendet. Diese Option kann meistens durch den Befehl {\bf make static-bacula-fd} ersetzt werden, den man im Verzeichnis {\bf src/filed} ausf\"{u}hren kann. Daneben ist auch die unten beschriebene Option {\bf \verb{--{enable-client-only} n\"{u}tzlich, wenn man nur einen einzelnen Client kompilieren will und die \"{u}brigen Programmteile nicht.
-
-Wird ein statisches Programm gelinkt, ben\"{o}tigt der Linker alle verwendeten Bibliotheken in statischen Versionen. Benutzer, die diese Option h\"{a}ufiger verwenden, werden auch h\"{a}ufiger Linker-Fehler haben. Als Erstes sollte man dann \"{u}berpr\"{u}fen, ob auf dem System eine statische ``glibc''-Bibliothek installiert ist. Als n\"{a}chstes sollte man `./configure'' ohne die Optionen {\bf {-}{-}openssl} und {\bf {-}{-}with-python} aufrufen, da hierbei zus\"{a}tzliche Bibliotheken ben\"{o}tigt werden. Man kann diese Optionen verwenden, doch muss man dann zus\"{a}tzliche statische Bibliotheken laden.
-
-\item [{-}{-}enable-static-sd]
- \index[general]{--enable-static-sd }
-Damit wird zus\"{a}tzlich zum Standard-Storage-D\"{a}mon ein statischer Storage-D\"{a}mon kompiliert. Die statische Version hat die Bibliotheksfunktionen fest eingebaut und ist bei der Datenwiederherstellung im Notfall hilfreich.
-
-Wird ein statisches Programm gelinkt, ben\"{o}tigt der Linker alle verwendeten Bibliotheken in statischen Versionen. Benutzer, die diese Option h\"{a}ufiger verwenden, werden auch h\"{a}ufiger Linker-Fehler haben. Als Erstes sollte man dann \"{u}berpr\"{u}fen, ob auf dem System eine statische ``glibc''-Bibliothek installiert ist. Als n\"{a}chstes sollte man `./configure'' ohne die Optionen {\bf {-}{-}openssl} und {\bf {-}{-}with-python} aufrufen, da hierbei zus\"{a}tzliche Bibliotheken ben\"{o}tigt werden. Man kann diese Optionen verwenden, doch muss man dann zus\"{a}tzliche statische Bibliotheken laden.
-
-\item [{-}{-}enable-static-dir]
- \index[general]{--enable-static-dir }
-Damit wird zus\"{a}tzlich zum Standard-Director ein statischer Director kompiliert. Die statische Version hat die Bibliotheksfunktionen fest eingebaut und ist bei der Datenwiederherstellung im Notfall hilfreich.
-
-Wird ein statisches Programm gelinkt, ben\"{o}tigt der Linker alle verwendeten Bibliotheken in statischen Versionen. Benutzer, die diese Option h\"{a}ufiger verwenden, werden auch h\"{a}ufiger Linker-Fehler haben. Als Erstes sollte man dann \"{u}berpr\"{u}fen, ob auf dem System eine statische ``glibc''-Bibliothek installiert ist. Als n\"{a}chstes sollte man `./configure'' ohne die Optionen {\bf {-}{-}openssl} und {\bf {-}{-}with-python} aufrufen, da hierbei zus\"{a}tzliche Bibliotheken ben\"{o}tigt werden. Man kann diese Optionen verwenden, doch muss man dann zus\"{a}tzliche statische Bibliotheken laden.
-
-\item [{-}{-}enable-static-cons]
- \index[general]{--enable-static-cons }
-Damit werden zus\"{a}tzlich zur Standard-Console eine statische Console und statische GNOME-Console kompiliert. Die statischen Versionen haben die Bibliotheksfunktionen fest eingebaut und sind bei der Datenwiederherstellung im Notfall hilfreich.
-
-Wird ein statisches Programm gelinkt, ben\"{o}tigt der Linker alle verwendeten Bibliotheken in statischen Versionen. Benutzer, die diese Option h\"{a}ufiger verwenden, werden auch h\"{a}ufiger Linker-Fehler haben. Als Erstes sollte man dann \"{u}berpr\"{u}fen, ob auf dem System eine statische ``glibc''-Bibliothek installiert ist. Als n\"{a}chstes sollte man `./configure'' ohne die Optionen {\bf {-}{-}openssl} und {\bf {-}{-}with-python} aufrufen, da hierbei zus\"{a}tzliche Bibliotheken ben\"{o}tigt werden. Man kann diese Optionen verwenden, doch muss man dann zus\"{a}tzliche statische Bibliotheken laden.
-
-\item [{-}{-}enable-client-only]
- \index[general]{--enable-client-only }
-Durch Setzen dieses Schalters werden nur der File-D\"{a}mon und die von ihm ben\"{o}tigten Bibliotheken kompiliert. Keiner der anderen D\"{a}monen, nicht die Sicherungswerkzeuge oder die Console werden kompiliert. Daher wird mit dem Befehl {\bf make install} auch nur der File-D\"{a}mon installiert. Um alle D\"{a}monen zu kompilieren, m\"{u}ssen Sie eine Konfiguration ohne diese Option verwenden. Mit dieser Option wird die Kompilierung nur eines Client-Prozesses auf einem Client-Rechner sehr erleichtert.
-
-Wird ein statisches Programm gelinkt, ben\"{o}tigt der Linker alle verwendeten Bibliotheken in statischen Versionen. Benutzer, die diese Option h\"{a}ufiger verwenden, werden auch h\"{a}ufiger Linker-Fehler haben. Als Erstes sollte man dann \"{u}berpr\"{u}fen, ob auf dem System eine statische ``glibc''-Bibliothek installiert ist. Als n\"{a}chstes sollte man `./configure'' ohne die Optionen {\bf {-}{-}openssl} und {\bf {-}{-}with-python} aufrufen, da hierbei zus\"{a}tzliche Bibliotheken ben\"{o}tigt werden. Man kann diese Optionen verwenden, doch muss man dann zus\"{a}tzliche statische Bibliotheken laden.
-
-\item [{-}{-}enable-largefile]
- \index[general]{--enable-largefile }
-Mit diesem Schalter (voreingestellt) wird Bacula mit der Unterst\"{u}tzung f\"{u}r 64 Bit breite Adressen kompiliert, sofern dies Ihr Rechner unterst\"{u}tzt. Damit kann Bacula Dateien lesen und schreiben, die gr\"{o}{\ss}er sind als 2 GBytes. Dieses Feature kann durch setzen des Schalters {\bf \verb{--{disable-largefile} abgew\"{a}hlt werden. Damit sind nur 32 Bit breite Adressen m\"{o}glich.
-
-\item [ {-}{-}disable-nls]
- \index[general]{{-}{-}disable-nls}
-Vorgabem\"{a}{\ss}ig verwendet Bacula ``GNU Native Language Support''-Bibliotheken (NLS). Auf manchen Rechnern sind diese Bibliotheken nicht verf\"{u}gbar oder funktionieren nicht richtig (beonders auf nicht-Linux Implementierungen). In diesen F\"{a}llen kann man durch Setzen von {\bf {-}{-}disable-nls} die Verwendung dieser Bibliotheken unterbinden. In diesem Fall benutzt Bacula Englisch.
-
-\item [{-}{-}with-sqlite=\lt{}Pfad/zu/SQLite\gt{}]
- \index[general]{--with-sqlite }
-Mit dieser Option wird die Benutzung eines SQlite-Datenbanksystems erm\"{o}glicht. Da Bacula an einem Standard-Speicherort ({\bf depkgs/sqlite}) sucht, wird der Pfad {\bf sqlite-path} normalerweise nicht angegeben. N\"{a}heres hierzu im Kapitel \ilink{SQLite installieren and konfigurieren }{_ChapterStart33} in diesem Handbuch.
-Beachten Sie auch den Hiinweis zur Option ``{-}{-}with-postgresql''.
-
-\item [ {-}{-}with-sqlite3=\lt{}Pfad/zu/sqlite3\gt{}]
- \index[general]{{-}{-}with-sqlite3 }
-Dies erlaubt die Verwendung von SQLite in der Version 3.x. Der Pfad ({\bf sqlite3-path}) muss normalerweise nicht gesetzt werden, da Bacula die ben\"{o}tigten Komponenten an den Standardspeicherorten ({\bf depkgs/sqlite3}) sucht. Im Kapitel \ilink{SQLite installieren und konfigurieren}{_ChapterStart33} dieses Handbuches finden sie weitere Einzelheiten.
-
-\item [{-}{-}with-mysql=\lt{}Pfad/zu/MySQL\gt{}]
- \index[general]{--with-mysql }
-Mit dieser Option werden die Catalog-Dienste f\"{u}r Bacula kompiliert. Sie setzt voraus, dass MySQL bereits auf Ihrem Rechner l\"{a}uft, und erwartet, dass es im Verzeichnis, das Sie mit der Pfadangabe ({\bf mysql-path}) angeben, installiert ist. Wenn dieser Schalter nicht gesetzt ist, wird Bacula automatisch den Code der internen Bacula-Datenbank einbeziehen. Nach M\"{o}glichkeit empfehlen wir, diesen Schalter zu setzen. Wenn Sie ihn verwenden, installieren Sie bitte zuerst MySQL und lesen das Kapitel \ilink{MySQL installieren and konfigurieren }{_ChapterStart} in diesem Handbuch bevor Sie mit der Konfiguration fortfahren.
-
-\item [{-}{-}with-postgresql=\lt{}Pfad/zu/PostgreSQL\gt{}]
- \index[general]{--with-postgresql }
-Dieser Schalter erfordert die Angabe des Pfades zum PostgreSQL-Programmverzeichnis, da Bacula ihn nicht von selbst finden kann. Zur Kompilierung mit PostgreSQL verwendet man einfach {\bf {-}{-}with-postgresql}.
-
-Um Bacula richtig zu konfigurieren, muss eine der vier unterst\"{u}tzten Datenbank-Optionen spezifiziert sein. Entweder also
-``{-}{-}with-sqlite'', ``{-}{-}with-sqlite3'', ``{-}{-}with-mysql'' oder `{-}{-}with-postgresql''. Andernfalls wird der ``./configure''-Prozess fehlschlagen.
-
-\item [ {-}{-}with-openssl=\lt{}path\gt{}]
-Diese Schalter wird ben\"{o}tigt, wenn Bacula TLS (ssl) verwenden soll. In der Regel muss der Pfad nicht spezifiziert werden, da der Konfigurationsprozess die OpenSSL-Bibliotheken an deren Standardorten sucht. Wenn OpenSSL aktiviert ist, gestattet Bacula eine sichere Kommunikation zwischen seinen D\"{a}monprozessen. Weitere Informationen zur Verwendung von TLS im Kapitel \ilink{Bacula TLS}{_ChapterStart61} in diesem Handbuch.
-
-\item [ {-}{-}with-python=\lt{}Pfad/zu/Python\gt{}]
- \index[general]{{-}{-}with-python }
-Mit diese Option wird die Bacula-Unterst\"{u}tzung f\"{u}r Python aktiviert. Wird kein Pfad mit angegeben, sucht der Konfigurationsprozess Bibliotheken an den Standard-Installationsorten von Python 2.2., 2.3 und 2.4. Wird die Bibliothek nicht gefunden, muss die Option mit dem Pfad zum Verzeichnis Ihrer Python-Bibliotheken aufgerufen werden. Im Kapitel \ilink{Python}{_ChapterStart60} sind Einzelheiten dazu, wie man Python-Scripting verwenden kann.
-
-\item [ {-}{-}with-libintl-prefix=\lt{}DIR\gt{}]
- \index[general]{{-}{-}with-libintl-prefix}
-Mit dieser Option durchsucht Bacula die Verzeichnisse ``DIR/include'' und ``DIR/lib'' nach den ``libintl''-Headern und -Bibliotheken, die es f\"{u}r den ``Native Language Support'' (NLS) ben\"{o}tigt.
-
-\item [{-}{-}enable-conio]
- \index[general]{--enable-conio }
-Teilt Bacula mit, die kleine, leichtgewichtige, ``readline'' ersetzende Routine zu kompilieren. Diese ist im allgemeinen sehr viel einfacher zu konfigurieren als ``readline'', ben\"{o}tigt aber entweder die ``termcap''- oder ``ncurses''-Bibliothek.
-
-\item [{-}{-}with-readline=\lt{}Pfad/zu/readline\gt{}]
- \index[general]{--with-readline }
-Teilt Bacula mit, wo {\bf readline} installiert ist. Sofern es Teil der Standard-Bibliothek ist, findet Bacula normalerweise ``readline''. Wird es nicht gefunden, und ist der Schalter \verb{--{with-readline gesetzt, wird readline deaktiviert. Diese Option betrifft Baculas Kompilierung. Mit Readline ist im der Console-Programm eine History und ein Editieren der Kommandozeile m\"{o}glich. Readline wird nicht mehr unterst\"{u}tzt. Sie sind daher bei Problemen auf sich allein gestellt.
-
-\item [ {-}{-}enable-readline]
- \index[general]{--enable-readline }
-Damit wird Bacula mitgeteilt, die Readline-Unterst\"{u}tung zu erm\"{o}glichen. Das Paket scheint sich in inkompatibler Weise von Version zu Version zu \"{a}ndern. Daher ist wegen der Vielzahl der Konfigurationsprobleme dieser Schalter normalerweise nicht gesetzt.
-
-\item [{-}{-}with-tcp-wrappers=\lt{}Pfad/zur/TCP-Wrapper/Bibliothek\gt{}]
- \index[general]{--with-tcp-wrappers }
-Damit wird spezifiziert, dass Bacula mit TCP-Wrappern (man hosts\_access(5)) kompiliert werden soll. Die Angabe des Pfades ist optional, da Bacula die Bibliotheken an den Standard-Speicherorten findet. Diese Option betrifft Baculas Kompilierung. Wenn Sie bei der Spezifikation der Einschr\"{a}nkungen in ihren {\bf /etc/hosts.allow}- und {\bf /etc/hosts.deny}-Dateien die {\bf twist}-Option (hosts\_options(5)) verwenden, wird sich der Bacula-Prozess beenden.
-Beachten Sie bitte, dass Sie beim Einrichten Ihrer {\bf /etc/hosts.allow}- und {\bf /etc/hosts.deny}-Dateien die infrage kommenden Bacula-D\"{a}monen mit deren Namen aus der Konfigurationsdatei und nicht mit deren jeweiligen Programmnamen bezeichnen.
-
-Weitere Informationen zur Konfiguration und zum Test der TCP-Wrapper im Abschnitt \ilink{TCP Wrapper konfigurieren und testen}{wrappers} des Kapitels zur Sicherheit.
-
-\item [{-}{-}with-working-dir=\lt{}Pfad/zum/Arbeitsverzeichnis\gt{} ]
- \index[general]{--with-working-dir }
-Die Angabe dieser Option ist zwingend und spezifizert das Verzeichnis, in welches Bacula zwischen seinen Ausf\"{u}hrungen seine Dateien sichert. Wenn z.B. die interne Datenbank verwendet wird, werden deren Dateien hier abgelegt. Diese Option wird nur benutzt, um die Konfigurationsdateien der D\"{a}monen zu ver\"{a}ndern. Das Gleiche erreichen Sie, wenn Sie die Konfigurationsdateien nachtr\"{a}glich \"{a}ndern. Das Arbeitsverzeichnis wird bei der Installation nicht automatisch erstellt, so dass Sie sicherstellen m\"{u}ssen, dass es vor der ersten Benutzung von Bacula vorhanden ist.
-
-\item [{-}{-}with-base-port=\lt{}Port=Nummer\gt{}]
- \index[general]{--with-base-port }
-Um funktioniern zu k\"{o}nnen, ben\"{o}tigt Bacula drei TCP/IC-Ports (einen f\"{u}r die Bacula-Console, einen f\"{u}r den Storage-D\"{a}mon und einen f\"{u}r den File-D\"{a}mon). Die Direktive {\bf \verb{--{with-baseport} weist automatisch drei Port Nummern zu, die mit der Basisadresse beginnen, die Sie spezifizieren. Auch in den sich ergebenden Konfigurationsdateien k\"{o}nnen Sie die Portnummern \"{a}ndern. Sie m\"{u}ssen jedoch aufpassen, dass die Nummern in allen drei Konfigurationsdateien genau \"{u}bereinstimmen. Der Vorgabe-Basisport hat die Nummer 9101. Damit sind die Ports 9101 bis 9103 zugewiesen. Diese Portnummern (9101, 9102, 9103) wurden von der IANA Bacula offiziell zugeteilt. Durch Setzen dieser Option ver\"{a}ndern Sie nur die Konfigurationsdateien. Diese k\"{o}nnen Sie auch nach der Installation noch ver\"{a}ndern.
-
-\item [{-}{-}with-dump-email=\lt{}E-mail-Adresse\gt{}]
- \index[general]{--with-dump-email }
-Dieser Schalter spezifiziert die E-Mail-Adresse an die alle ``core dumps'' gesendet werden und wird normalerweise nur von Entwicklern verwendet.
-
-\item [{-}{-}with-pid-dir=\lt{}Pfad\gt{} ]
- \index[general]{--with-pid-dir }
-Damit wird jenes Verzeichnis spezifiziert, in welchem Bacula die Datei mit den Prozess-IDs w\"{a}hrend seiner Ausf\"{u}hrung ablegt. Vorgabem\"{a}{\ss}ig ist dies {\bf /var/run}. Diese Verzeichnis wird bei der Installation nicht angelegt. Daher sollten Sie sicher sein, dass es vorhanden ist, bevor Sie Bacula zum ersten Mal verwenden.
-
-\item [{-}{-}with-subsys-dir=\lt{}Pfad\gt{}]
- \index[general]{--with-subsys-dir }
-Dieser Schalter spezifiziert den Ort, an dem Bacula die Subsystem-Lock Datei w\"{a}hrend seiner Ausf\"{u}hrung ablegt. Vorgabe ist {\bf /var/run/subsys}. Stellen Sie sicher, dass sie hierf\"{u}r und das {\bf sbindir}-Verzeichnis nicht das gleiche Verzeichnis spezifizieren. Dieses Verzeichnis wird nur innerhalb der Autostart-Skripten verwendet. Das ``subsys''-Verzeichnis wird bei Baculas Installation nicht erstellt, so dass Sie selbst sicherstellen m\"{u}ssen, dass es erstellt ist, bevor Sie Bacula verwenden.
-
-\item [{-}{-}with-dir-password=\lt{}Passwort\gt{}]
- \index[general]{--with-dir-password }
-Mit diesem Schalter kann ein Passwort f\"{u}r den Zugang (in der Regel \"{u}ber das Console-Programm) zum Director spezifiziert werden. Ist der Schalter nicht gesetzt, generiert der Konfigurationsprozess ein zuf\"{a}lliges Passwort.
-
-\item [{-}{-}with-fd-password=\lt{}Passwort\gt{} ]
- \index[general]{--with-fd-password }
-Mit diesem Schalter kann ein Passwort f\"{u}r den Zugang zum File-D\"{a}mon spezifiziert werden (normalerweise vom Director aufgerufen). Wenn es nicht spezifiziert wurde, generiert der Konfigurationsprozess ein zuf\"{a}lliges Passwort.
-
-\item [{-}{-}with-sd-password=\lt{}Passwort\gt{} ]
- \index[general]{--with-sd-password }
-Mit diesem Schalter kann ein Passwort f\"{u}r den Zugang zum Storage-D\"{a}mon spezifiziert werden (normalerweise vom Director aufgerufen). Wenn es nicht spezifiziert wurde, generiert der Konfigurationsprozess ein zuf\"{a}lliges Passwort.
-
-\item [{-}{-}with-dir-user=\lt{}User\gt{} ]
- \index[general]{--with-dir-user }
-
-Durch Setzen dieses Schalters kann die User-ID festgelegt werden unter welcher der Director l\"{a}uft. Der Director-Prozess muss als root gestartet werden, doch muss er nicht unter root laufen. Nach den ersten Initialisierungen kann er dem User \"{u}bergeben werden, dessen ID Sie hier spezifizieren.
-
-\item [ {-}{-}with-dir-group=\lt{}Group\gt{} ]
- \index[general]{--with-dir-group }
-
-Durch Setzen dieses Schalters kann die Group-ID festgelegt werden unter welcher der Director l\"{a}uft. Der Director-Prozess muss als root gestartet werden, doch muss er nicht unter root laufen. Nach den ersten Initialisierungen kann er der Gruppe \"{u}bergeben werden, deren ID Sie hier spezifizieren.
-
-\item [{-}{-}with-sd-user=\lt{}User\gt{} ]
- \index[general]{--with-sd-user }
-Mit diesem Schalter kann die User-ID festgelegt werden unter welcher der Storage-D\"{a}mon l\"{a}uft. Der Storage-D\"{a}mon muss als root gestartet werden, doch muss er nicht unter root laufen. Nach den ersten Initialisierungen kann er dem User \"{u}bergeben werden, dessen ID Sie hier spezifizieren. Wenn Sie diese Option verwenden, m\"{u}ssen Sie auch sicherstellen, dass der Storageprozess alle Ger\"{a}te(Bandlaufwerke, usw.) verwenden darf, die er ben\"{o}tigt.
-
-\item [{-}{-}with-sd-group=\lt{}Group\gt{} ]
- \index[general]{--with-sd-group }
-Durch Setzen dieses Schalters kann die Group-ID festgelegt werden unter welcher der Storage-D\"{a}mon l\"{a}uft. Der Storage-D\"{a}mon muss als root gestartet werden, doch muss er nicht unter root laufen. Nach den ersten Initialisierungen kann er der Gruppe \"{u}bergeben werden, deren ID Sie hier spezifizieren.
-
-\item [{-}{-}with-fd-user=\lt{}User\gt{} ]
- \index[general]{--with-fd-user }
-Durch Setzen dieses Schalters kann die User-ID festgelegt werden unter welcher der File-D\"{a}mon l\"{a}uft. Der File-D\"{a}mon muss als root gestartet werden und muss in den meisten F\"{a}llen auch unter root laufen. In ganz besonderen F\"{a}llen kann mit dieser Option der File-D\"{a}mon-Prozess nach den ersten Initialisierungen einem User \"{u}bergeben werden, dessen ID Sie hier spezifizieren.
-
-\item [{-}{-}with-fd-group=\lt{}Group\gt{} ]
- \index[general]{--with-fd-group }
-Durch Setzen dieses Schalters kann die Group-ID festgelegt werden unter welcher der File-D\"{a}mon l\"{a}uft. Der File-D\"{a}mon muss als root gestartet werden und muss in den meisten F\"{a}llen auch unter root laufen. Trotzdem kann der File-D\"{a}mon-Prozess nach den ersten Initialisierungen der Gruppe \"{u}bergeben werden, deren ID Sie hier spezifizieren.
-
-\end{description}
-
-Beachten Sie bitte, dass durch Eingabe von {\bf ./configure \verb{--{help} noch viele andere Optionen angezeigt werden, diese aber bislang nicht implementiert sind.
-
-\section{Optionen, die wir f\"{u}r die meisten Systeme empfehlen}
-\index[general]{Systeme!Empfohlenen Optionen f\"{u}r die meisten }
-\index[general]{Optionen, die wir f\"{u}r die meisten Systeme empfehlen }
-
-Wir empfehlen f\"{u}r die meisten Systeme mit folgenden Optionen zu beginnen:
-
-\footnotesize
-\begin{verbatim}
-./configure \
- --enable-smartalloc \
- --sbindir=$HOME/bacula/bin \
- --sysconfdir=$HOME/bacula/bin \
- --with-pid-dir=$HOME/bacula/bin/working \
- --with-subsys-dir=$HOME/bacula/bin/working \
- --with-mysql=$HOME/mysql \
- --with-working-dir=$HOME/bacula/working
-\end{verbatim}
-\normalsize
-
-Wenn Sie Bacula lieber in ein Installationsverzeichnis installieren wollen, als es aus seinem Kompilationsverzeichnis heraus zu betreiben (wie es Entwickler tun) m\"{u}ssen Sie den Schalter \verb{--{sbindir and \verb{--{sysconfdir mit den entsprechenden Pfaden verwenden. Dies ist nicht notwendig, wenn Sie ``make install'' nicht verwenden, wie es meistens bei der Programm-Entwicklung der Fall ist. Der Installationsprozess erzeugt die mit ``sbindir'' und ``sysconfdir'' angegebenen Verzeichnisse, aber nicht jene, die als ``pid-dir'', ``subsys-dir'' oder ``working-dir'' spezifiziert wurden. Sie m\"{u}ssen selbst sicherstellen, dass diese existieren, bevor Bacula das erste Mal l\"{a}uft. Es folgt ein Beispiel daf\"{u}r wie Kern das tut.
-
-\section{RedHat}
-\index[general]{RedHat }
-
-Bei der Verwendung von SQLite:
-
-\footnotesize
-\begin{verbatim}
-
-CFLAGS="-g -Wall" ./configure \
- --sbindir=$HOME/bacula/bin \
- --sysconfdir=$HOME/bacula/bin \
- --enable-smartalloc \
- --with-sqlite=$HOME/bacula/depkgs/sqlite \
- --with-working-dir=$HOME/bacula/working \
- --with-pid-dir=$HOME/bacula/bin/working \
- --with-subsys-dir=$HOME/bacula/bin/working \
- --enable-gnome \
- --enable-conio
-\end{verbatim}
-\normalsize
-
-oder
-
-\footnotesize
-\begin{verbatim}
-
-CFLAGS="-g -Wall" ./configure \
- --sbindir=$HOME/bacula/bin \
- --sysconfdir=$HOME/bacula/bin \
- --enable-smartalloc \
- --with-mysql=$HOME/mysql \
- --with-working-dir=$HOME/bacula/working
- --with-pid-dir=$HOME/bacula/bin/working \
- --with-subsys-dir=$HOME/bacula/bin/working
- --enable-gnome \
- --enable-conio
-\end{verbatim}
-\normalsize
-
-oder, zum Schluss, eine vollst\"{a}ndig traditionelle RedHat-Linux Installation:
-
-\footnotesize
-\begin{verbatim}
-CFLAGS="-g -Wall" ./configure \
- --prefix=/usr \
- --sbindir=/usr/sbin \
- --sysconfdir=/etc/bacula \
- --with-scriptdir=/etc/bacula \
- --enable-smartalloc \
- --enable-gnome \
- --with-mysql \
- --with-working-dir=/var/bacula \
- --with-pid-dir=/var/run \
- --enable-conio
-\end{verbatim}
-\normalsize
-Beachten Sie bitte, dass Bacula davon ausgeht, dass die Verzeichnisse
-/var/bacula, /var/run, und /var/lock/subsys bereits existieren und es diese
-w\"{a}hrend der Installation nicht automatisch erzeugt.
-
-Beachten Sie bitte, dass bei Benutzung einer AMD64 CPU, die unter 64 bit CentOS4 l\"{a}uft, mit gcc (GCC) 4.0.1 20050727 (Red Hat 4.0.1-5) ein Compiler Bug auftritt, so dass Code erzeugt wird, der eine Segmentverletzung verusacht. Typischerweise macht sich dies zuerst beim Storage-D\"{a}mon bemerkbar. Eine L\"{o}sung ist es, Bacula ohne Optimierung zu kompilieren (normalerweise ist dies -O2).
-
-\section{Solaris}
-\index[general]{Solaris }
-
-Um Bacula aus den Quellcodedateien zu erzeugen, muss auf dem Solaris-System bereits das folgende installiert sein (das ist es standardm\"{a}{\ss}ig nicht):
-libiconv, gcc 3.3.2, stdc++, libgcc (wegen der stdc++- und gcc\_s-Bibliotheken), make 3.8 oder neuer.
-
-M\"{o}glicherweise muss die PATH-Umgebungsvariable um ``/usr/local/bin'' und ``/usr/ccs/bin'' (wegen ar) erg\"{a}nzt werden
-
-\footnotesize
-\begin{verbatim}
-#!/bin/sh
-CFLAGS="-g" ./configure \
- --sbindir=$HOME/bacula/bin \
- --sysconfdir=$HOME/bacula/bin \
- --with-mysql=$HOME/mysql \
- --enable-smartalloc \
- --with-pid-dir=$HOME/bacula/bin/working \
- --with-subsys-dir=$HOME/bacula/bin/working \
- --with-working-dir=$HOME/bacula/working
-\end{verbatim}
-\normalsize
-
-Wie oben schon erw\"{a}hnt, erzeugt der Installationsprozess die mit ``sbindir'' und ``sysconfdir'' bezeichneten Verzeichnisse, falls sie nicht schon vorhanden sind. Die Verzeichnisse ``pid-dir'', ``subsys-dir'' und ``working-dir'' werden nicht automatisch erzeugt. Vergewissern Sie sich daher, dass sie existieren, bevor Bacula zum ersten Mal laufen soll.
-
-Beachten Sie bitte, dass Sie m\"{o}glicherweise die folgenden Pakete installieren m\"{u}ssen, um Bacula kompilieren zu k\"{o}nnen:
-\footnotesize
-\begin{verbatim}
-SUNWbinutils,
-SUNWarc,
-SUNWhea,
-SUNWGcc,
-SUNWGnutls
-SUNWGnutls-devel
-SUNWGmake
-SUNWgccruntime
-SUNWlibgcrypt
-SUNWzlib
-SUNWzlibs
-SUNWbinutilsS
-SUNWGmakeS
-SUNWlibm
-
-export
-PATH=/usr/bin::/usr/ccs/bin:/etc:/usr/openwin/bin:/usr/local/bin:/usr/sfw/bin:/opt/sfw/bin:/usr/ucb:/usr/sbin
-\end{verbatim}
-\normalsize
-
-\section{FreeBSD}
-\index[general]{FreeBSD }
-
-Unter \elink{The FreeBSD Diary}{http://www.freebsddiary.org/bacula.php} gibt es eine detailierte Beschreibung wie Bacula unter diesem Betriebssystem intalliert wird. Benutzer von FreeBSD, die eine Version von vor 4.9-STABLE (Montag, 29. Dezember 2003, 15:18:01 UTC) verwenden, sollten das Kapitel \ilink{Test der Bandlaufwerke}{FreeBSDTapes} in diesem Handbuch lesen. Darin sind \textbf{wichtige} Informationen, wie man das Bandlaufwerk so konfiguriert, dass es mit Bacula zusammenarbeitet.
-
-Wenn Sie Bacula zusammen mit MySQL verwenden, sollten Sie darauf achten, MySQL eher mit den Thread-Bibliotheken von FreeBSD als mit denen von Linux zu kompilieren, weil Bacula selbst normalerweise so kompiliert wird. Eine Mischung von Beiden wird m\"{o}glicherweise nicht funktionieren.
-
-\section{Win32}
-\index[general]{Win32 }
-Um die Win32-Version des File-Client zu installieren, lesen Sie bitte das Kapitel \ilink{Win32 Installation}{_ChapterStart7} in diesem Handbuch.
-
-\section{Windows-Systeme mit installiertem CYGWIN}
-\label{Win32}
-\index[general]{Windows-Systeme mit installiertem CYGWIN }
-\index[general]{CYGWIN!Windows-Systeme mit installiertem }
-
-Seit der Version 1.34 verwendet Bacula f\"{u}r den Win32-File-D\"{a}mon CYGWIN nicht mehr. Er wird allerdings immer noch in einer CYGWIN-Umgebung kompiliert - m\"{o}glicherweise funktioniert das aber auch mit dem Visual C -Studio allein. Wenn Sie den Win32-File-D\"{a}mon selbst kompilieren wollen, ben\"{o}tigen sie Microsoft C++ in der Version 6.0 oder h\"{o}her. F\"{u}r Bacula in den Versionen vor 1.3 wurde CYGWIN verwendet. Einzelheiten zur Kompilierung stehen in der README-Datei im Verzeichnis ``src/win32''.
-
-Beachten Sie, dass, obwohl sich fast alle Elemente von Bacula unter Windows kompilieren lassen, nur der File-D\"{a}mon getestet und verwendet wurde.
-
-Beachten Sie auf jeden Fall die Installationsanweisungen des Kapitels \ilink{Win32-Installation}{_ChapterStart7} in diesem Dokument.
-
-\section{Kerns Konfigurations-Skript}
-\index[general]{Skript!Kerns Konfigurations }
-\index[general]{Kerns Konfigurations-Skript }
-
-Dieses Skript verwende ich f\"{u}r meinen ``produktiven'' Linux-Rechner:
-
-\footnotesize
-\begin{verbatim}
-#!/bin/sh
-# This is Kern's configure script for Bacula
-CFLAGS="-g -Wall" \
- ./configure \
- --sbindir=$HOME/bacula/bin \
- --sysconfdir=$HOME/bacula/bin \
- --enable-smartalloc \
- --enable-gnome \
- --with-pid-dir=$HOME/bacula/bin/working \
- --with-subsys-dir=$HOME/bacula/bin/working \
- --with-mysql=$HOME/mysql \
- --with-working-dir=$HOME/bacula/bin/working \
- --with-dump-email=$USER \
- --with-smtp-host=mail.your-site.com \
- --with-baseport=9101
-exit 0
-\end{verbatim}
-\normalsize
-
-Beachten Sie bitte, dass ich 9101 als Basis-Port definiere. Dadurch verwendet Bacula Port 9101 f\"{u}r die Director-Console, Port 9102 f\"{u}r die File-D\"{a}monen und Port 9103 f\"{u}r die Storage-D\"{a}monen. Diese Ports m\"{u}ssten auf allen Systemen verf\"{u}gbar sein, da sie von der IANA (Internet Assigned Numbers Authority) offiziell f\"{u}r Bacula reserviert wurden. Wir raten dringend, nur diese Ports zu verwenden, um Konflikte mit anderen Programmen zu vermeiden. Wenn Sie die Option {\bf \verb{--{with-baseport} nicht verwenden, ist dies die Voreinstellung.
-
-Eventuell k\"{o}nnen Sie auch noch das Folgende in Ihre {\bf /etc/services}-Datei eintragen, was das Erkennen der Verbindungen, die Bacula verwendet, erleichtert (z.B. mit netstat -a):
-
-\footnotesize
-\begin{verbatim}
-bacula-dir 9101/tcp
-bacula-fd 9102/tcp
-bacula-sd 9103/tcp
-\end{verbatim}
-\normalsize
-
-\section{Bacula installieren}
-\index[general]{installieren!Bacula }
-\index[general]{Bacula installieren }
-
-Bevor man die Konfigurations-Dateien bearbeitet, wird man Bacula in dessen Zielverzeichnisse installieren wollen. Dies geschieht mit:
-
-\footnotesize
-\begin{verbatim}
-make install
-\end{verbatim}
-\normalsize
-
-Wenn Bacula zuvor schon installiert worden war, werden die Programmdateien \"{u}berschrieben werden, die Konfigurationsdateien jedoch erhalten bleiben. An die Namen der ``neuen'' Konfigurationsdateien wird ein {\bf .new} angeh\"{a}ngt. Wenn Sie Bacula bereits installiert und betrieben hatten, werden Sie diese normalerweise verwerfen wollen oder ignorieren.
-
-\section{Einen File-D\"{a}mon oder Client-Prozess kompilieren}
-\index[general]{Kompilierung!eines File-D\"{a}mons oder Client-Prozesses }
-\index[general]{Einen File-D\"{a}mon oder Client-Prozess kompilieren }
-
-Wenn der Director und Storage-D\"{a}mon bei Ihnen auf einem Rechner l\"{a}uft und Sie die Daten eines anderen Rechners sichern wollen, brauchen Sie auf diesem Rechner eine Kopie des File-D\"{a}mons. Sind der Rechner und das Betriebsystem gleich, gen\"{u}gt es, die Programmdatei {\bf bacula-fd} und die Konfigurationsdatei {\bf bacula-fd.conf} zu kopieren und dann den Name und das Passwort in der Konfigurationsdatei anzupassen, sodass diese eindeutig sind. Die entsprechenden Erweiterungen muss man auch in der Konfigurationsdatei des Directors ({\bf bacula-dir.conf}) machen.
-
-Ist die Rechnerachitektur und/oder das Betriebsystem verschieden, so muss der File-D\"{a}mon auf dem Client-Rechner kompiliert werden. Man verwendet hierzu den gleichen {\bf ./configure}-Befehl wie f\"{u}r das Hauptprogramm und beginnt in einer neuen Kopie des Quellcode-Verzeichnisses oder indem man vor dem {\bf ./configure} ein {\bf make\ distclean} ausf\"{u}hrt.
-
-Da der File-D\"{a}mon nicht mit der Datenbank arbeitet, k\"{o}nnen die Optionen {\bf \verb{--{with-mysql} oder {\bf \verb{--{with-sqlite} entfernt werden. Durch die Verwendung des Schalters {\bf \verb{--{enable-client-only} werden nur die ben\"{o}tigten Bibliotheken und die Client-Programme erzeugt. Dadurch ist es nicht notwendig, die Datenbank-Programme zu installieren, nur um den File-D\"{a}mon zu erzeugen. Geben Sie zum Schluss einfach {\bf make} ein. Damit wird nur das Client-Programm erzeugt.
-
-\label{autostart}
-\section{Auto-Start der D\"{a}mon-Prozesse}
-\index[general]{D\"{a}mon-Prozesse!Auto-Start der }
-\index[general]{Auto-Start der D\"{a}mon-Prozesse }
-
-Sollen die D\"{a}mon-Prozesse beim Booten Ihres Systems automatisch gestartet bzw. beendet werden (was sinnvoll ist), ist ein weiterer Schritt erforderlich. Als erstes muss der ``./configure''-Prozess Ihr System erkennen - es muss also unterst\"{u}tzt werden und darf nicht als {\bf unknown} erkannt sein. Dann m\"{u}ssen die plattformspezifischen Dateien wie folgt installiert werden:
-
-\footnotesize
-\begin{verbatim}
-(become root)
-make install-autostart
-\end{verbatim}
-\normalsize
-
-Die M\"{o}glichkeit des Auto-Starts ist nur f\"{u}r Systeme implementiert, die wir offiziell unterst\"{u}tzen (momentan FreeBSD, RedHat/Fedora-Linux und Solaris) und wurde bislang nur auf Fedora-Linux vollst\"{a}ndig getestet.
-
-Mit dem Befehl {\bf make install-autostart} werden die entsprechenden Start-Skripte zusammen mit den notwendigen symbolischen Links installiert. Unter RedHat-Linux sind diese Skripte in den Verzeichnisssen {\bf /etc/rc.d/init.d/bacula-dir}, {\bf /etc/rc.d/init.d/bacula-fd} und {\bf /etc/rc.d/init.d/bacula-sd}. Der genaue Speicherort h\"{a}ngt vom verwendeten Beriebssystem ab.
-
-Wenn nur der File-D\"{a}mon installiert werden soll, k\"{o}nnen Sie dies mit folgendem Befehl tun:
-
-\footnotesize
-\begin{verbatim}
-make install-autostart-fd
-\end{verbatim}
-\normalsize
-
-\section{Weitere Hinweise zur Kompilierung}
-\index[general]{Kompilierung!Weitere Hinweise zur }
-\index[general]{Weitere Hinweise zur Kompilierung }
-
-Um eine Programmdatei in einem beliebigen Verzeichnis zu erzeugen, geben Sie einfach das folgende ein:
-
-\footnotesize
-\begin{verbatim}
-make
-\end{verbatim}
-\normalsize
-
-Um alle Objekt- und Programmdateien (auch die mit ``1'', ``2'' oder ``3'' bezeichneten Dateien, die Kern als tempor\"{a}re Dateien verwendet) geben Sie folgendes ein:
-
-\footnotesize
-\begin{verbatim}
-make clean
-\end{verbatim}
-\normalsize
-
-Um wirklich alles f\"{u}r eine Distribution zu bereinigen:
-
-\footnotesize
-\begin{verbatim}
-make distclean
-\end{verbatim}
-\normalsize
-
-Beachten Sie bitte, dass dies alle Makefiles l\"{o}scht und normalerweise auf der obersten Verzeichnisebene ausgef\"{u}hrt wird, um den Quellcode f\"{u}r eine Distribution vorzubereiten. Um dies r\"{u}ckg\"{a}ngig zu machen, muss {\bf ./configure} auch von der obersten Verzeichnisebene ausgef\"{u}hrt werden, da alle Makefiles gel\"{o}scht sind.
-
-Um einem Unterverzeichnis eine neue Datei hinzuzuf\"{u}gen, muss die Datei ``Makefile.in'' in jenem Verzeichnis bearbeitet werden. Danach gen\"{u}gt es, {\bf make} einzugeben. In den meisten F\"{a}llen erzeugt der make-Befehl ein neues Makefile aus ``Makefile.in''. In manchen F\"{a}llen muss der {\bf make}-Befehl wiederholt werden. In extremen F\"{a}llen wechselt man in die oberste Verzeichnisebene und gibt ein: {\bf make Makefiles}.
-
-Um Abh\"{a}ngigkeiten hinzuzuf\"{u}gen:
-
-\footnotesize
-\begin{verbatim}
-make depend
-\end{verbatim}
-\normalsize
-
-Mit {\bf make depend} werden die Abh\"{a}ngigkeiten der Header-Dateien aller Objekt-Dateien dem Makefile und der Datei ``Makefile.in" hinzugef\"{u}gt. Dieser Befehl sollte in allen Verzeichnissen ausgef\"{u}hrt werden, in welchen Sie die Abh\"{a}ngigkeiten \"{a}ndern. Normalerweise muss der Befehl nur ausgef\"{u}hrt werden, wenn sie Quell- oder Header-Dateien hinzuf\"{u}gen oder l\"{o}schen. {\bf make depend} wird normalerweise w\"{a}hrend des Konfigurations-Prozesses automatisch aufgerufen.
-
-Um zu installieren:
-
-\footnotesize
-\begin{verbatim}
-make install
-\end{verbatim}
-\normalsize
-
-Dieser Befehl wird verwendet, wenn Sie Bacula als Backup-System installieren wollen, nicht aber wenn Sie an Bacula selbst programmieren.
-Nach Ausf\"{u}hren des Befehls {\bf make install} werden die folgenden Dateien auf Ihrem System installiert (mehr oder weniger). Welche Dateien und Verzeichnisse es im einzelnen sind, h\"{a}ngt von Ihrem {\bf ./configure}-Befehl ab (wird z.B. GNOME nicht konfiguriert, wird auch ``gnome-console'' und ``gnome-console.conf'' nicht installiert. Wenn Sie SQLite anstatt MySQL verwenden, werden einige der Dateien andere sein).
-
-\footnotesize
-\begin{verbatim}
-bacula
-bacula-dir
-bacula-dir.conf
-bacula-fd
-bacula-fd.conf
-bacula-sd
-bacula-sd.conf
-bacula-tray-monitor
-tray-monitor.conf
-bextract
-bls
-bscanBacula
-btape
-btraceback
-btraceback.gdb
-bconsole
-bconsole.conf
-create_mysql_database
-dbcheck
-delete_catalog_backup
-drop_bacula_tables
-drop_mysql_tables
-fd
-gnome-console
-gnome-console.conf
-make_bacula_tables
-make_catalog_backup
-make_mysql_tables
-mtx-changer
-query.sql
-bsmtp
-startmysql
-stopmysqlBacula
-wx-console
-wx-console.conf
-\end{verbatim}
-\normalsize
-
-\label{monitor}
-
-\section{Die Installation des Tray-Monitors}
-\index[general]{Tray-Monitors!Die Installation des }
-\index[general]{Die Installation des Tray-Monitors }
-
-Wenn Sie den Konfigurationsschalter {\bf \verb{--{enable-tray-monitor} verwendet und {\bf make install} ausgef\"{u}hrt haben, ist der Tray-Monitor schon installiert.
-
-Da Sie Ihre grafische Umgebung nicht als root betreiben (wenn doch, sollten sie das abstellen), m\"{u}ssen Sie den Usern Leserechte auf {\bf tray-monitor.conf} und Ausf\"{u}hrungsrechte f\"{u}r {\bf bacula-tray-monitor} geben. Dies ist kein Sicherheitsrisiko.
-
-Melden Sie sich bei Ihrer grafischen Umgebung an (KDE, Gnome oder eine andere), starten sie den {\bf bacula-tray-monitor} als gew\"{o}hnlicher Benutzer und achten Sie darauf, ob das Cassetten-Icon irgendwo auf Ihrem Bildschirm erscheint (gew\"{o}hnlich in der Task-Leiste). Tut es das nicht, werfen Sie einen Blick auf die unten aufgef\"{u}hrten Anweisungen entsprechend Ihrer Umgebung oder Ihres Window-Managers.
-
-\subsubsection*{GNOME}
-\index[general]{GNOME }
-
-Ein System-Tray oder einen ``Benachrichtigungs-Bereich'' (um die GNOME-Terminologie zu verwenden), wird von GNOME seit der Version 2.2 unterst\"{u}tzt. Um sie zu aktivieren, klicken Sie rechts auf Ihre Kontrollleiste, \"{o}ffnen das Men\"{u} {\bf Add to this Panel}, dann auf {\bf Utility} und klicken schlie{\ss}lich auf {\bf Notification Area}.
-
-\subsubsection*{KDE}
-\index[general]{KDE }
-
-Seit der Version 3.1 unterst\"{u}tzt KDE das System-Tray. Um es zu aktivieren, klicken Sie Ihre Kontrollleiste rechts, \"{o}ffnen das Men\"{u} {\bf Zur Kontrollleiste hinzuf\"{u}gen}, dann auf {\bf Miniprogramm} und klicken schlie{\ss}lich auf {\bf Systemabschnitt der Kontrollleiste}.
-
-\subsubsection*{Andere Fenster-Manager}
-\index[general]{Fenster-Manager!Andere }
-\index[general]{Andere Fenster-Manager }
-
-Lesen Sie die Dokumentation um zu erfahren, ob der Freedesktop System-Tray-Standard von Ihrem Fenster-Manager unterst\"{u}tzt wird und - wenn vorhanden - wie er aktiviert wird.
-
-\section{Die Bacula Konfigurations-Dateien bearbeiten}
-\index[general]{Die Bacula Konfigurations-Dateien bearbeiten }
-\index[general]{Bearbeiten!Die Bacula Konfigurations-Dateien }
-
-Schlagen Sie im Kapitel \ilink{Bacula konfigurieren}{_ChapterStart16} dieses Handbuches nach, wie sie die Konfigurationsdateien von Bacula einrichten.
+++ /dev/null
-# This file serves as a place to put initialization code and constants to
-# affect the behavior of latex2html for generating the bacula manuals.
-
-# $LINKPOINT specifies what filename to use to link to when creating
-# index.html. Not that this is a hard link.
-$LINKPOINT='"$OVERALL_TITLE"';
-
-
-# The following must be the last line of this file.
-1;
+++ /dev/null
-%%
-%%
-
-\chapter{Messages Resource}
-\label{MessagesChapter}
-\index[general]{Resource!Messages}
-\index[general]{Messages Resource}
-
-The Messages resource defines how messages are to be handled and destinations
-to which they should be sent.
-
-Even though each daemon has a full message handler, within the File daemon and
-the Storage daemon, you will normally choose to send all the appropriate
-messages back to the Director. This permits all the messages associated with a
-single Job to be combined in the Director and sent as a single email message
-to the user, or logged together in a single file.
-
-Each message that Bacula generates (i.e. that each daemon generates) has an
-associated type such as INFO, WARNING, ERROR, FATAL, etc. Using the message
-resource, you can specify which message types you wish to see and where they
-should be sent. In addition, a message may be sent to multiple destinations.
-For example, you may want all error messages both logged as well as sent to
-you in an email. By defining multiple messages resources, you can have
-different message handling for each type of Job (e.g. Full backups versus
-Incremental backups).
-
-In general, messages are attached to a Job and are included in the Job report.
-There are some rare cases, where this is not possible, e.g. when no job is
-running, or if a communications error occurs between a daemon and the
-director. In those cases, the message may remain in the system, and should be
-flushed at the end of the next Job. However, since such messages are not
-attached to a Job, any that are mailed will be sent to {\bf
-/usr/lib/sendmail}. On some systems, such as FreeBSD, if your sendmail is in a
-different place, you may want to link it to the the above location.
-
-The records contained in a Messages resource consist of a {\bf destination}
-specification followed by a list of {\bf message-types} in the format:
-
-\begin{description}
-
-\item [destination = message-type1, message-type2, message-type3, ... ]
-\index[dir]{destination}
-\end{description}
-
-or for those destinations that need and address specification (e.g. email):
-
-\begin{description}
-
-\item [destination = address = message-type1, message-type2,
- message-type3, ... ]
-\index[dir]{destination}
-
- Where {\bf destination} is one of a predefined set of keywords that define
- where the message is to be sent ({\bf stdout}, {\bf file}, ...), {\bf
- message-type} is one of a predefined set of keywords that define the type of
- message generated by {\bf Bacula} ({\bf ERROR}, {\bf WARNING}, {\bf FATAL},
- ...), and {\bf address} varies according to the {\bf destination} keyword, but
- is typically an email address or a filename.
-\end{description}
-
-The following are the list of the possible record definitions that can be used
-in a message resource.
-
-\begin{description}
-
-\item [Messages]
-\index[dir]{Messages}
- Start of the Messages records.
-
-\item [Name = \lt{}name\gt{}]
-\index[dir]{Name}
- The name of the Messages resource. The name you specify here will be used to
- tie this Messages resource to a Job and/or to the daemon.
-
-\label{mailcommand}
-\item [MailCommand = \lt{}command\gt{}]
-\index[dir]{MailCommand}
- In the absence of this resource, Bacula will send all mail using the
- following command:
-
-{\bf mail -s "Bacula Message" \lt{}recipients\gt{}}
-
-In many cases, depending on your machine, this command may not work. Using
-the {\bf MailCommand}, you can specify exactly how to send the mail. During
-the processing of the {\bf command}, normally specified as a quoted string,
-the following substitutions will be used:
-
-\begin{itemize}
-\item \%\% = \%
-\item \%c = Client's name
-\item \%d = Director's name
-\item \%e = Job Exit code (OK, Error, ...)
-\item \%i = Job Id
-\item \%j = Unique Job name
-\item \%l = Job level
-\item \%n = Job name
-\item \%r = Recipients
-\item \%t = Job type (e.g. Backup, ...)
- \end{itemize}
-
-The following is the command I (Kern) use. Note, the whole command should
-appear on a single line in the configuration file rather than split as is
-done here for presentation:
-
-{\bf mailcommand = "/home/kern/bacula/bin/bsmtp -h mail.example.com -f
-\textbackslash{}"\textbackslash{}(Bacula\textbackslash{})
-\%r\textbackslash{}" -s \textbackslash{}"Bacula: \%t \%e of \%c
-\%l\textbackslash{}" \%r"}
-
-Note, the {\bf bsmtp} program is provided as part of {\bf Bacula}. For
-additional details, please see the
-\ilink{ bsmtp -- Customizing Your Email Messages}{bsmtp} section of
-the Bacula Utility Programs chapter of this manual. Please test any {\bf
-mailcommand} that you use to ensure that your bsmtp gateway accepts the
-addressing form that you use. Certain programs such as Exim can be very
-selective as to what forms are permitted particularly in the from part.
-
-\item [OperatorCommand = \lt{}command\gt{}]
-\index[fd]{OperatorCommand}
- This resource specification is similar to the {\bf MailCommand} except that
- it is used for Operator messages. The substitutions performed for the {\bf
- MailCommand} are also done for this command. Normally, you will set this
- command to the same value as specified for the {\bf MailCommand}.
-
-\item [\lt{}destination\gt{} = \lt{}message-type1\gt{},
- \lt{}message-type2\gt{}, ...]
- \index[fd]{\lt{}destination\gt{}}
-
-Where {\bf destination} may be one of the following:
-
-\begin{description}
-
-\item [stdout]
- \index[fd]{stdout}
- Send the message to standard output.
-
-\item [stderr]
- \index[fd]{stderr}
- Send the message to standard error.
-
-\item [console]
- \index[console]{console}
- Send the message to the console (Bacula Console). These messages are held
-until the console program connects to the Director.
-\end{description}
-
-\item {\bf \lt{}destination\gt{} = \lt{}address\gt{} =
- \lt{}message-type1\gt{}, \lt{}message-type2\gt{}, ...}
- \index[console]{\lt{}destination\gt{}}
-
-Where {\bf address} depends on the {\bf destination}.
-
-The {\bf destination} may be one of the following:
-
-\begin{description}
-
-\item [director]
- \index[dir]{director}
- \index[general]{director}
- Send the message to the Director whose name is given in the {\bf address}
- field. Note, in the current implementation, the Director Name is ignored, and
- the message is sent to the Director that started the Job.
-
-\item [file]
-\index[dir]{file}
-\index[general]{file}
- Send the message to the filename given in the {\bf address} field. If the
- file already exists, it will be overwritten.
-
-\item [append]
-\index[dir]{append}
-\index[general]{append}
- Append the message to the filename given in the {\bf address} field. If the
- file already exists, it will be appended to. If the file does not exist, it
- will be created.
-
-\item [syslog]
-\index[general]{syslog}
- Send the message to the system log (syslog) using the facility specified in
- the {\bf address} field. Note, for the moment, the {\bf address} field is
- ignored and the message is always sent to the LOG\_DAEMON facility with
- level LOG\_ERR. See {\bf man 3 syslog} for more details. Example:
-\begin{verbatim}
- syslog = all, !skipped
-\end{verbatim}
-
-\item [mail]
- \index[general]{mail}
- Send the message to the email addresses that are given as a comma
- separated list in the {\bf address} field. Mail messages are grouped
- together during a job and then sent as a single email message when the
- job terminates. The advantage of this destination is that you are
- notified about every Job that runs. However, if you backup five or ten
- machines every night, the volume of email messages can be important.
- Some users use filter programs such as {\bf procmail} to automatically
- file this email based on the Job termination code (see {\bf
- mailcommand}).
-
-\item [mail on error]
- \index[general]{mail on error}
- Send the message to the email addresses that are given as a comma
- separated list in the {\bf address} field if the Job terminates with an
- error condition. MailOnError messages are grouped together during a job
- and then sent as a single email message when the job terminates. This
- destination differs from the {\bf mail} destination in that if the Job
- terminates normally, the message is totally discarded (for this
- destination). If the Job terminates in error, it is emailed. By using
- other destinations such as {\bf append} you can ensure that even if the
- Job terminates normally, the output information is saved.
-
-\item [mail on success]
- \index[general]{mail on success}
- Send the message to the email addresses that are given as a comma
- separated list in the {\bf address} field if the Job terminates
- normally (no error condition). MailOnSuccess messages are grouped
- together during a job and then sent as a single email message when the
- job terminates. This destination differs from the {\bf mail}
- destination in that if the Job terminates abnormally, the message is
- totally discarded (for this destination). If the Job terminates in
- normally, it is emailed.
-
-\item [operator]
- \index[general]{operator}
- Send the message to the email addresses that are specified as a comma
- separated list in the {\bf address} field. This is similar to {\bf
- mail} above, except that each message is sent as received. Thus there
- is one email per message. This is most useful for {\bf mount} messages
- (see below).
-
-\item [console]
- \index[general]{console}
- Send the message to the Bacula console.
-
-\item [stdout]
- \index[general]{stdout}
- Send the message to the standard output (normally not used).
-
-\item [stderr]
- \index[general]{stderr}
- Send the message to the standard error output (normally not used).
-
-\item [catalog]
- \index[general]{catalog}
- Send the message to the Catalog database. The message will be
- written to the table named {\bf Log} and a timestamp field will
- also be added. This permits Job Reports and other messages to
- be recorded in the Catalog so that they can be accessed by
- reporting software. Bacula will prune the Log records associated
- with a Job when the Job records are pruned. Otherwise, Bacula
- never uses these records internally, so this destination is only
- used for special purpose programs (e.g. {\bf bweb}).
-
-\end{description}
-
- For any destination, the {\bf message-type} field is a comma separated
- list of the following types or classes of messages:
-
-\begin{description}
-
-\item [info]
- \index[general]{info}
- General information messages.
-
-\item [warning]
- \index[general]{warning}
- Warning messages. Generally this is some unusual condition but not expected
- to be serious.
-
-\item [error]
- \index[general]{error}
- Non-fatal error messages. The job continues running. Any error message should
- be investigated as it means that something went wrong.
-
-\item [fatal]
- \index[general]{fatal}
- Fatal error messages. Fatal errors cause the job to terminate.
-
-\item [terminate]
- \index[general]{terminate}
- Message generated when the daemon shuts down.
-
-\item [notsaved]
- \index[fd]{notsaved}
- \index[general]{notsaved}
- Files not saved because of some error. Usually because the file cannot be
- accessed (i.e. it does not exist or is not mounted).
-
-\item [skipped]
- \index[fd]{skipped}
- \index[general]{skipped}
- Files that were skipped because of a user supplied option such as an
- incremental backup or a file that matches an exclusion pattern. This is
- not considered an error condition such as the files listed for the {\bf
- notsaved} type because the configuration file explicitly requests these
- types of files to be skipped. For example, any unchanged file during an
- incremental backup, or any subdirectory if the no recursion option is
- specified.
-
-\item [mount]
- \index[dir]{mount}
- \index[general]{mount}
- Volume mount or intervention requests from the Storage daemon. These
- requests require a specific operator intervention for the job to
- continue.
-
-\item [restored]
- \index[fd]{restored}
- \index[general]{restored}
- The {\bf ls} style listing generated for each file restored is sent to
- this message class.
-
-\item [all]
- \index[general]{all}
- All message types.
-
-\item [security]
- \index[general]{security}
- Security info/warning messages principally from unauthorized
- connection attempts.
-
-\item [alert]
- \index[general]{alert}
- Alert messages. These are messages generated by tape alerts.
-
-\item [volmgmt]
- \index[general]{volmgmt}
- Volume management messages. Currently there are no volume mangement
- messages generated.
-\end{description}
-
-\end{description}
-
-The following is an example of a valid Messages resource definition, where
-all messages except files explicitly skipped or daemon termination messages
-are sent by email to enforcement@sec.com. In addition all mount messages
-are sent to the operator (i.e. emailed to enforcement@sec.com). Finally
-all messages other than explicitly skipped files and files saved are sent
-to the console:
-
-\footnotesize
-\begin{verbatim}
-Messages {
- Name = Standard
- mail = enforcement@sec.com = all, !skipped, !terminate
- operator = enforcement@sec.com = mount
- console = all, !skipped, !saved
-}
-\end{verbatim}
-\normalsize
-
-With the exception of the email address (changed to avoid junk mail from
-robot's), an example Director's Messages resource is as follows. Note, the {\bf
-mailcommand} and {\bf operatorcommand} are on a single line -- they had to be
-split for this manual:
-
-\footnotesize
-\begin{verbatim}
-Messages {
- Name = Standard
- mailcommand = "bacula/bin/bsmtp -h mail.example.com \
- -f \"\(Bacula\) %r\" -s \"Bacula: %t %e of %c %l\" %r"
- operatorcommand = "bacula/bin/bsmtp -h mail.example.com \
- -f \"\(Bacula\) %r\" -s \"Bacula: Intervention needed \
- for %j\" %r"
- MailOnError = security@example.com = all, !skipped, \
- !terminate
- append = "bacula/bin/log" = all, !skipped, !terminate
- operator = security@example.com = mount
- console = all, !skipped, !saved
-}
-\end{verbatim}
-\normalsize
+++ /dev/null
-%%
-%%
-
-\chapter{Monitor Configuration}
-\label{_MonitorChapter}
-\index[general]{Monitor Configuration }
-\index[general]{Configuration!Monitor }
-
-The Monitor configuration file is a stripped down version of the Director
-configuration file, mixed with a Console configuration file. It simply
-contains the information necessary to contact Directors, Clients, and Storage
-daemons you want to monitor.
-
-For a general discussion of configuration file and resources including the
-data types recognized by {\bf Bacula}, please see the
-\ilink{Configuration}{ConfigureChapter} chapter of this manual.
-
-The following Monitor Resource definition must be defined:
-
-\begin{itemize}
-\item
- \ilink{Monitor}{MonitorResource} -- to define the Monitor's
- name used to connect to all the daemons and the password used to connect to
-the Directors. Note, you must not define more than one Monitor resource in
-the Monitor configuration file.
-\item At least one
- \ilink{Client}{ClientResource1},
- \ilink{Storage}{StorageResource1} or
-\ilink{Director}{DirectorResource2} resource, to define the
-daemons to monitor.
-\end{itemize}
-
-\section{The Monitor Resource}
-\label{MonitorResource}
-\index[general]{Monitor Resource }
-\index[general]{Resource!Monitor }
-
-The Monitor resource defines the attributes of the Monitor running on the
-network. The parameters you define here must be configured as a Director
-resource in Clients and Storages configuration files, and as a Console
-resource in Directors configuration files.
-
-\begin{description}
-
-\item [Monitor]
- \index[fd]{Monitor }
- Start of the Monitor records.
-
-\item [Name = \lt{}name\gt{}]
- \index[fd]{Name }
- Specify the Director name used to connect to Client and Storage, and the
-Console name used to connect to Director. This record is required.
-
-\item [Password = \lt{}password\gt{}]
- \index[fd]{Password }
- Where the password is the password needed for Directors to accept the Console
-connection. This password must be identical to the {\bf Password} specified
-in the {\bf Console} resource of the
-\ilink{Director's configuration}{DirectorChapter} file. This
-record is required if you wish to monitor Directors.
-
-\item [Refresh Interval = \lt{}time\gt{}]
- \index[fd]{Refresh Interval }
- Specifies the time to wait between status requests to each daemon. It can't
-be set to less than 1 second, or more than 10 minutes, and the default value
-is 5 seconds.
-% TODO: what is format of the time?
-% TODO: should the digits in this definition be spelled out? should
-% TODO: this say "time-period-specification" above??)
-\end{description}
-
-\section{The Director Resource}
-\label{DirectorResource2}
-\index[general]{Director Resource }
-\index[general]{Resource!Director }
-
-The Director resource defines the attributes of the Directors that are
-monitored by this Monitor.
-
-As you are not permitted to define a Password in this resource, to avoid
-obtaining full Director privileges, you must create a Console resource in the
-\ilink{Director's configuration}{DirectorChapter} file, using the
-Console Name and Password defined in the Monitor resource. To avoid security
-problems, you should configure this Console resource to allow access to no
-other daemons, and permit the use of only two commands: {\bf status} and {\bf
-.status} (see below for an example).
-
-You may have multiple Director resource specifications in a single Monitor
-configuration file.
-
-\begin{description}
-
-\item [Director]
- \index[fd]{Director }
- Start of the Director records.
-
-\item [Name = \lt{}name\gt{}]
- \index[fd]{Name }
- The Director name used to identify the Director in the list of monitored
-daemons. It is not required to be the same as the one defined in the Director's
-configuration file. This record is required.
-
-\item [DIRPort = \lt{}port-number\gt{}]
- \index[fd]{DIRPort }
- Specify the port to use to connect to the Director. This value will most
-likely already be set to the value you specified on the {\bf
-\verb:--:with-base-port} option of the {\bf ./configure} command. This port must be
-identical to the {\bf DIRport} specified in the {\bf Director} resource of
-the
-\ilink{Director's configuration}{DirectorChapter} file. The
-default is 9101 so this record is not normally specified.
-
-\item [Address = \lt{}address\gt{}]
- \index[fd]{Address }
- Where the address is a host name, a fully qualified domain name, or a network
-address used to connect to the Director. This record is required.
-\end{description}
-
-\section{The Client Resource}
-\label{ClientResource1}
-\index[general]{Resource!Client }
-\index[general]{Client Resource }
-
-The Client resource defines the attributes of the Clients that are monitored
-by this Monitor.
-
-You must create a Director resource in the
-\ilink{Client's configuration}{FiledConfChapter} file, using the
-Director Name defined in the Monitor resource. To avoid security problems, you
-should set the {\bf Monitor} directive to {\bf Yes} in this Director resource.
-
-
-You may have multiple Director resource specifications in a single Monitor
-configuration file.
-
-\begin{description}
-
-\item [Client (or FileDaemon)]
- \index[fd]{Client (or FileDaemon) }
- Start of the Client records.
-
-\item [Name = \lt{}name\gt{}]
- \index[fd]{Name }
- The Client name used to identify the Director in the list of monitored
-daemons. It is not required to be the same as the one defined in the Client's
-configuration file. This record is required.
-
-\item [Address = \lt{}address\gt{}]
- \index[fd]{Address }
- Where the address is a host name, a fully qualified domain name, or a network
-address in dotted quad notation for a Bacula File daemon. This record is
-required.
-
-\item [FD Port = \lt{}port-number\gt{}]
- \index[fd]{FD Port }
- Where the port is a port number at which the Bacula File daemon can be
-contacted. The default is 9102.
-
-\item [Password = \lt{}password\gt{}]
- \index[fd]{Password }
- This is the password to be used when establishing a connection with the File
-services, so the Client configuration file on the machine to be backed up
-must have the same password defined for this Director. This record is
-required.
-\end{description}
-
-\section{The Storage Resource}
-\label{StorageResource1}
-\index[general]{Resource!Storage }
-\index[general]{Storage Resource }
-
-The Storage resource defines the attributes of the Storages that are monitored
-by this Monitor.
-
-You must create a Director resource in the
-\ilink{Storage's configuration}{StoredConfChapter} file, using the
-Director Name defined in the Monitor resource. To avoid security problems, you
-should set the {\bf Monitor} directive to {\bf Yes} in this Director resource.
-
-
-You may have multiple Director resource specifications in a single Monitor
-configuration file.
-
-\begin{description}
-
-\item [Storage]
- \index[fd]{Storage }
- Start of the Storage records.
-
-\item [Name = \lt{}name\gt{}]
- \index[fd]{Name }
- The Storage name used to identify the Director in the list of monitored
-daemons. It is not required to be the same as the one defined in the Storage's
-configuration file. This record is required.
-
-\item [Address = \lt{}address\gt{}]
- \index[fd]{Address }
- Where the address is a host name, a fully qualified domain name, or a network
-address in dotted quad notation for a Bacula Storage daemon. This record is
-required.
-
-\item [SD Port = \lt{}port\gt{}]
- \index[fd]{SD Port }
- Where port is the port to use to contact the storage daemon for information
-and to start jobs. This same port number must appear in the Storage resource
-of the Storage daemon's configuration file. The default is 9103.
-
-\item [Password = \lt{}password\gt{}]
- \index[sd]{Password }
- This is the password to be used when establishing a connection with the
-Storage services. This same password also must appear in the Director
-resource of the Storage daemon's configuration file. This record is required.
-
-\end{description}
-
-\section{Tray Monitor Security}
-\index[general]{Tray Monitor Security}
-
-There is no security problem in relaxing the permissions on
-tray-monitor.conf as long as FD, SD and DIR are configured properly, so
-the passwords contained in this file only gives access to the status of
-the daemons. It could be a security problem if you consider the status
-information as potentially dangerous (I don't think it is the case).
-
-Concerning Director's configuration: \\
-In tray-monitor.conf, the password in the Monitor resource must point to
-a restricted console in bacula-dir.conf (see the documentation). So, if
-you use this password with bconsole, you'll only have access to the
-status of the director (commands status and .status).
-It could be a security problem if there is a bug in the ACL code of the
-director.
-
-Concerning File and Storage Daemons' configuration:\\
-In tray-monitor.conf, the Name in the Monitor resource must point to a
-Director resource in bacula-fd/sd.conf, with the Monitor directive set
-to Yes (once again, see the documentation).
-It could be a security problem if there is a bug in the code which check
-if a command is valid for a Monitor (this is very unlikely as the code
-is pretty simple).
-
-
-\section{Sample Tray Monitor configuration}
-\label{SampleConfiguration1}
-\index[general]{Sample Tray Monitor configuration}
-
-An example Tray Monitor configuration file might be the following:
-
-\footnotesize
-\begin{verbatim}
-#
-# Bacula Tray Monitor Configuration File
-#
-Monitor {
- Name = rufus-mon # password for Directors
- Password = "GN0uRo7PTUmlMbqrJ2Gr1p0fk0HQJTxwnFyE4WSST3MWZseR"
- RefreshInterval = 10 seconds
-}
-
-Client {
- Name = rufus-fd
- Address = rufus
- FDPort = 9102 # password for FileDaemon
- Password = "FYpq4yyI1y562EMS35bA0J0QC0M2L3t5cZObxT3XQxgxppTn"
-}
-Storage {
- Name = rufus-sd
- Address = rufus
- SDPort = 9103 # password for StorageDaemon
- Password = "9usxgc307dMbe7jbD16v0PXlhD64UVasIDD0DH2WAujcDsc6"
-}
-Director {
- Name = rufus-dir
- DIRport = 9101
- address = rufus
-}
-\end{verbatim}
-\normalsize
-
-\subsection{Sample File daemon's Director record.}
-\index[general]{Sample File daemon's Director record. }
-\index[general]{Record!Sample File daemon's Director }
-
-Click
-\ilink{here to see the full example.}{SampleClientConfiguration}
-
-
-\footnotesize
-\begin{verbatim}
-#
-# Restricted Director, used by tray-monitor to get the
-# status of the file daemon
-#
-Director {
- Name = rufus-mon
- Password = "FYpq4yyI1y562EMS35bA0J0QC0M2L3t5cZObxT3XQxgxppTn"
- Monitor = yes
-}
-\end{verbatim}
-\normalsize
-
-\subsection{Sample Storage daemon's Director record.}
-\index[general]{Record!Sample Storage daemon's Director }
-\index[general]{Sample Storage daemon's Director record. }
-
-Click
-\ilink{here to see the full example.}{SampleConfiguration}
-
-\footnotesize
-\begin{verbatim}
-#
-# Restricted Director, used by tray-monitor to get the
-# status of the storage daemon
-#
-Director {
- Name = rufus-mon
- Password = "9usxgc307dMbe7jbD16v0PXlhD64UVasIDD0DH2WAujcDsc6"
- Monitor = yes
-}
-\end{verbatim}
-\normalsize
-
-\subsection{Sample Director's Console record.}
-\index[general]{Record!Sample Director's Console }
-\index[general]{Sample Director's Console record. }
-
-Click
-\ilink{here to see the full
-example.}{SampleDirectorConfiguration}
-
-\footnotesize
-\begin{verbatim}
-#
-# Restricted console used by tray-monitor to get the status of the director
-#
-Console {
- Name = Monitor
- Password = "GN0uRo7PTUmlMbqrJ2Gr1p0fk0HQJTxwnFyE4WSST3MWZseR"
- CommandACL = status, .status
-}
-\end{verbatim}
-\normalsize
+++ /dev/null
-%%
-%%
-
-
-\chapter{Mit Bacula beginnen}
-\label{QuickStartChapter}
-\index[general]{Mit Bacula beginnen }
-
-Wenn Sie wie ich sind, wollen Sie dass Bacula sofort l\"{a}uft, damit Sie ein Gefühl für das Programm bekommen und sich erst sp\"{a}ter mit den Details befassen. Dieses Kapitel m\"{o}chte genau dieses erreichen: Das Programm ohne die ganzen Einzelheiten rasch zum Laufen zu bringen. Wenn Sie den Abschnitt über Pools, Volumes und Labels überspringen wollen, k\"{o}nnen Sie ihn sp\"{a}ter immer noch nachholen, aber lesen Sie bitte bis zum Ende des Kapitels und beachten Sie die Anweisungen zum Test Ihres Bandlaufwerkes genau.
-
-Wir gehen davon aus, dass Sie es geschafft haben, Bacula zu kompilieren und zu installieren. Wenn nicht, werfen sie vielleicht zuerst einen Blick auf die
-\ilink{System-Anforderungen}{SysReqs} und dann auf das Kapitel
-\ilink{Bacula kompilieren und installieren}{_ChapterStart17} in diesem Handbuch.
-
-\label{JobsandSchedules}
-\section{Jobs und Zeitpl\"{a}ne verstehen}
-\index[general]{Jobs!verstehen}
-\index[general]{Zeitpl\"{a}ne!verstehen}
-
-Um Bacula so anpassungsf\"{a}hig wie m\"{o}glich zu machen, bestehen die Anweisungen, die sein Verhalten bestimmen, aus verschiedenen Teilen. Die wichtigste Direktive ist die Job-Resource, welche jeweils eine Sicherungsaufgabe beschreibt. Ein Sicherungs-Job besteht im allgemeinen aus einem FileSet, einem (Sicherungs-)Client und einem Zeitplan mit einer oder mehreren Arten und Zeiten der Sicherung, einem Pool und zus\"{a}tzlichen Instruktionen. Mit anderen Worten: Mit dem FileSet wird bestimmt was gesichert werden soll, mit dem Client, wer sichern soll, der Zeitplan bestimmt wann dies geschehen soll und der Pool wohin gesichert werden soll (z.B. auf welches Volume).
-Typischerweise bestimmt jeweils eine Kombination FileSet/Client einen Job. Die meisten der Direktiven wie FileSets, Pools und Zeitpl\"{a}ne k\"{o}nnen für mehrere Jobs verwendet werden und so beliebig kombiniert werden. Sie k\"{o}nnten z.B. zwei verschiedene Job-Definitionen (resources) haben, welche die Daten verschiedener Server sichern, dabei aber den gleichen Zeitplan, das gleiche FileSet (auf beiden Rechnern werden die gleichen Verzeichnisse gesichert) und vielleicht sogar die gleichen Pools nutzen. Der Zeitplan wird festlegen, welche Art der Sicherung wann l\"{a}uft (z.B. Montags eine Vollsicherung, an den übrigen Wochentage inkrementielle Sicherung) und wenn mehr als ein Job den gleichen Zeitplan hat, wird die Job-Priorit\"{a}t bestimmen, welcher Job tats\"{a}chlich als erster l\"{a}uft. Wenn Sie viele Jobs haben, werden Sie m\"{o}glicherweise JobDefs benutzen wollen, in denen Sie Vorgaben für alle Jobs festlegen, die dann in den einzelnen Job-Resourcen individuell angepasst werden k\"{o}nnen, es Ihnen aber ersparen, für jeden Job die gleichen Parameter zu definieren. Zus\"{a}tzlich zu den durch die FileSets festgelegten zu sichernden Dateien sollte es auch einen Job geben, der Ihre Catalog-Dateien sichert.
-
-Schlie{\ss}lich gibt es neben den Sicherungs-Jobs Wiederherstellungs-Jobs, Verifikationen und administrative Jobs, die andere Direktiven erfordern.
-
-\label{PoolsVolsLabels}
-\section{Pools, Volumes und Labels verstehen}
-\index[general]{Verstehen!von Pools, Volumes und Labels}
-\index[general]{Pools, Volumes und Labels verstehen }
-
-Wenn Sie bisher Programme wie {\bf tar} zur Datensicherung verwendet haben, werden Ihnen Begriffe Pools, Volumes und Label auf den ersten Blick vielleicht etwas verwirrend vorkommen. Ein Volume ist ein einzelnes physikalisches Band (oder m\"{o}glicherweise eine einzelne Datei), auf die Bacula die Daten Ihrer Sicherung schreibt. Pools sind Gruppen von Volumes, so dass eine Sicherung nicht auf die Gr\"{o}{\ss}e eines einzelnen Volumes (die L\"{a}nge eines Bandes) beschr\"{a}nkt ist. Daher werden Sie bei der Definition eines Job eher einen Pool anstatt einzelner Volumes spezifizieren. Bacula wird das n\"{a}chste verfügbare Volume dem Pool entnehmen und Sie auffordern, es zu mounten.
-
-W\"{a}hrend die grundlegenden Eigenschaften eines Pools in der Pool-Resource des Directors festgelegt sind, werden die Daten der realen Pools im Bacula-Catalog gehalten. Er enth\"{a}lt alle Informationen der Pool-Resourcen und auch die Informationen über alle Volumes, die einem Pool zugefügt wurden. Ein Volume wird normalerweise mit dem {\bf label}-Befehl des Konsolen-Proramms dem Pool hinzugefügt.
-
-Für jedes Volume h\"{a}lt Bacula eine ziehmliche Menge von Catalog-Informationen vor, wie z.B. den Zeitpunkt des ersten Lesens/Beschreibens, den Zeitpunkt des letzten Lesens/Beschreibens, die Anzahl der Dateien, die es enth\"{a}lt, die Anzahl der Mounts, usw.
-
-Bevor Bacula ein Volume beschreibt, muss das physikalische Volume eine digitale Kennzeichnung erhalten, damit Bacula sicher sein kann, dass das richtige Volumen gemountet ist. Dies erledigt normalerweise der {\bf label}-Befehl des Konsolen-Programms.
-
-Das Vorgehen, zuerst eine Pool zu schaffen, dann Volumes hinzuzufügen und die Volumes digital zu kennzeichnen, mag zu Anfang mühselig erscheinen, ist aber ganz einfach und erlaubt es, mehrere Volumes zu verwenden (anstatt auf die Speicherkapazi\"{a}t eines Bandes beschr\"{a}nkt zu sein). Durch Pools wird man bei der Sicherung auch ausgesprochen flexibel. Man kann sich z.B einen ``t\"{a}glichen'' Pool für inkrementielle und einen ``w\"{o}chentlichen'' Pool für Vollsicherungen anlegen. Sind bei der Definition der Sicherungsjobs die richtigen Pools angegeben, wird Bacula niemals einen Tagesjob in ein Volume des w\"{o}chentlichen Pools schreiben oder umgekehrt und Ihnen stets sagen, wann welches Band ben\"{o}tigt wird.
-
-Weiteres zu Pools im Abschnitt \ilink{Pool-Resource}{PoolResource} des Kapitels ``Director-Konfiguration''. Auch in diesem Kapitel werden wir sp\"{a}ter auf dieses Thema zurückkommen.
-
-\section{Baculas Konfigurations-Dateien einrichten}
-\label{config}
-\index[general]{Baculas Konfigurations-Dateien einrichten }
-\index[general]{einrichten!von Baculas Konfigurations-Dateien }
-
-Wenn Sie Bacula zum ersten Mal verwenden, müssen Sie, nachdem Sie den entsprechenden {\bf ./configure}-Befehl, ein {\bf make} und ein {\bf make install} ausgeführt haben, gültige Konfigurationsdateien für den Director, den File-D\"{a}mon, den Storage-D\"{a}mon und die Console erstellen. Wenn Sie sich nach unseren Empfehlungen gerichtet haben, finden Sie in Ihrem Installationsverzeichnis sowohl Vorgabe-Konfigurationsdateien als auch die ausführbaren Dateien der D\"{a}monen. In jedem Fall sind die Programmdateien in jenem Verzeichnis, welches bei der Ausführung des {\bf ./configure}-Befehls mit der Option {\bf \verb{--{sbindir} und die Konfigurationsdateien in jenem Verzeichnis, welches mit der {\bf \verb{--{sysconfdir}-Option angegeben wurde.
-
-
-Wenn Sie Bacula zum ersten Mal installieren, werden Sie etwas Zeit brauchen, um die Konfigurationsdateien so zu ver\"{a}ndern, dass Sie zu Ihrer Umgebung passen. Das wird mit sich bringen, dass Sie Bacula einige Male starten und wieder beenden müssen bis alles stimmt. Verzweifeln Sie nicht! Sind die Konfigurationsdateien einmal erstellt, werden Sie diese nur noch selten \"{a}ndern und auch Bacula nicht sehr oft starten oder stoppen müssen. Die meiste Arbeit wird darin bestehen, B\"{a}nder zu wechseln, wenn sie voll sind.
-
-\subsection{Die Konfiguration des Console-Programms}
-\index[general]{Konfiguration des Console-Programms }
-\index[general]{Console-Programm!die Konfiguration des }
-
-Das Condsole-Programm wird vom Administrator benutzt, um mit dem Director-Prozess zu interagiern und Jobs manuell zu starten und zu beenden oder Informationen zu einzelnen Jobs zu erhalten.
-
-Die Konfigurationsdatei der Console ist in jenem Verzeichnis, das mit der {\bf
-\verb{--{sysconfdir}-Option bei der Ausführung des {\bf ./configure}-Befehl spezifiziert wurde und hei{\ss}t vorgabem\"{a}{\ss}ig {\bf console.conf}.
-
-Wenn Sie auch die GNOME-Console mit der {\bf \verb{--{enable-gnome}-Option kompiliert haben, finden Sie auch hierfür eine Vorgabe-Konfigurationsdatei die {\bf gnome-console.conf} hei{\ss}t.
-
-Gleiches gilt für die wxWidgets-Console, die mit der {\bf
-\verb{--{enable-wx-console}-Option kompiliert wird und deren Vorgabe-Konfigurationdsdatei {\bf wx-console.conf} ist.
-
-Benutzen Sie Bacula zum ersten Mal, wüssen Sie diese Dateien nicht \"{a}ndern, da brauchbare Vorgabewerte schon gesetzt sind
-
-\subsubsection*{Die Konfiguration des Monitor-Programms}
-\index[general]{Monitor-Programm!die Konfiguration des }
-\index[general]{Konfiguration des Monitor-Programms }
-
-Das Monitor-Programm erscheint typischerweise als Icon in der Kontrollleiste. Wird dieses zu einem Fenster vergr\"{o}{\ss}ert, liefert es dem Administrator Informationen über den Director, den Sicherungsstatus des lokalen Rechners oder jeden anderen konfigurierten D\"{a}mon-Prozess.
-
-\addcontentsline{lof}{figure}{Bacula Tray Monitor}
-\includegraphics{\idir Bacula-tray-monitor.eps}
-
-Die Abbildung zeigt ein Fenster des Tray-Monitors, der für drei D\"{a}mon-Prozesse konfiguriert wurde. Wenn man auf die Schaltfl\"{a}chen in der oberen rechten Ecke des Fensters klickt, sieht man den Zustand jedes einzelnen Prozesses. Die Abbildung zeigt den Zustand des momentan ausgew\"{a}hlten Storage-D\"{a}mons (MainSD).
-
-Die Konfigurationsdatei des Monitor-Programms befindet sich in jenem Verzeichnis, das bei Ausführung des {\bf ./configure}-Befehls mit der Option {\bf \verb{--{sysconfdir} angegeben wurde. In der Regel müssen Sie als Erstbenutzer die Berechtigung für diese Datei \"{a}ndern, um Benutzern, die keine root-Rechte haben, zu erlauben, den Monitor zu starten, da diese Anwendung unter dem gleichen Benutzer laufen muss wie die grafische Umgebung (vergessen Sie nicht, nicht-root-Benutzern die Ausführung von {\bf bacula-tray-monitor} zu erlauben). Solange Sie die Vorgabewerte verwenden, ist dies kein Sicherheitsproblem.
-
-\subsubsection*{Die Konfiguration des File-D\"{a}mon}
-\index[general]{File-D\"{a}mon!die Konfiguration des}
-\index[general]{Konfiguration des File-D\"{a}mon }
-
-Der File-D\"{a}mon ist ein Programm, das auf jedem (Client-)Rechner l\"{a}uft. Auf Anforderung des Directors sucht er die zu sichernden Dateien und schickt sie (bzw. ihre Daten) an den Storage-D\"{a}mon.
-
-Die Konfigurationsdatei des File-D\"{a}mon ist in jenem Verzeichnis, das bei Ausführung des {\bf ./configure}-Befehls mit der Option {\bf \verb{--{sysconfdir} angegeben wurde. Vorgabem\"{a}{\ss}ig hei{\ss}t diese Datei {\bf bacula-fd.conf}. Normalerweise muss für erste Versuche hier nichts ge\"{a}ndert werden, da vernünftige Vorgabewerte gesetzt sind. Will man allerdings die Daten von mehreren Rechnern sichern, muss auf jedem dieser Rechner ein File-D\"{a}mon mit einer eigenen Konfigurationsdatei installiert sein. Die Daten aller dieser File-D\"{a}mons müssen in der Konfigurationsdatei des Directors erscheinen.
-
-\subsubsection*{Die Konfiguration des Directors}
-\index[general]{Director!die Konfiguration des }
-\index[general]{Die Konfiguration des Directors}
-
-Der Director ist das zentrale Steuerungsprogramm aller anderen D\"{a}mon-Prozesse. Er terminiert und überwacht alle Sicherungsjobs.
-
-Die Konfigurationsdatei des Directors liegt in jenem Verzeichnis, das durch die Option {\bf \verb{--{sysconfdir} bei der Ausführung des {\bf ./configure}-Befehls angegeben wurde. Der Name dieser Konfigurationsdatei ist normalerweise {\bf bacula-dir.conf}.
-
-Im Allgemeinen muss darin nur die Ressource ``FileSet'' ge\"{a}ndert werden, so dass ihre {\bf Include}-Direktive mindestens eine Zeile mit einem gültigen Verzeichnis (oder einer Datei) enth\"{a}lt, die/das zu sichern ist.
-
-Wenn Sie kein DLT-Bandlaufwerk haben, werden Sie m\"{o}glicherweise die Storage-Resource \"{a}ndern wollen, so dass diese Ihrem tats\"{a}chlichen Sicherungsger\"{a}t mehr entspricht. Sie k\"{o}nnen hier immer die tats\"{a}chlichen Namen verwenden und k\"{o}nnen diese auch beliebig zuweisen, doch müssen sie mit jenen übereinstimmen, die in der Konfigurationsdatei des Storage-D\"{a}mon angegeben sind.
-
-M\"{o}glicherweise wollen Sie auch die E-Mailadresse zur Benachrichtigung von der Vorgabe {\bf root} auf Ihre eigene \"{a}ndern.
-
-Schlie{\ss}lich brauchen Sie, wenn Sie mehrere Rechner sichern wollen, für jedes System einen eigenen File-D\"{a}mon bzw. Client und müssen seinen Namen, seine Adresse und ein Passwort spezifizieren. Wir meinen, dass es die Fehlersuche sehr erleichtert, wenn wir den D\"{a}monen den Namen des Rechners geben und ein {\bf -fd} anh\"{a}ngen. Wenn Ihr Rechner also z.B. {\bf foobaz} hei{\ss}t, würden Sie den File-D\"{a}mon {\bf foobaz-fd} nennen. Der Director k\"{o}nnte {\bf foobaz-dir} hei{\ss}en und der Storage-D\"{a}mon {\bf foobaz-sd}.
-Jede Ihrer Bacula-Komponenten \textbf{muss} einen eindeutigen Namen haben. Wenn Sie alle gleich benennen, werden Sie - abgesehen davon, dass sie nicht wissen werden, welcher D\"{a}mon Ihnen welche Botschaft schickt - eigenartige Fehlermeldungen erhalten, da die Namen ihrer Tempor\"{a}rdateien nicht eindeutig sind, sofern sie das gleiche Arbeitsverzeichnis benutzen.
-
-\subsubsection*{Die Konfiguration des Storage-D\"{a}mon}
-\index[general]{Daemon!Configuring the Storage }
-\index[general]{Die Konfiguration des Storage-D\"{a}mon}
-
-Auf Veranlassung des Director-Prozesses ist der Storage-D\"{a}mon für die Übernahme der Daten vom File-D\"{a}mon und ihrer Speicherung auf dem Sicherungsmedium verantwortlich, bzw. im Falle einer Wiederherstellung für das Finden und die Übergabe der Daten an den File-D\"{a}mon.
-
-Die Konfigurationsdatei der Storage-D\"{a}mons ist in dem Verzeichnis, das bei Ausführung des {\bf ./configure}-Befehls mit der {\bf \verb{--{sysconfdir}-Option angegeben wurde und hei{\ss}t vorgabem\"{a}{\ss}ig {\bf bacula-sd.conf}. Bearbeiten Sie diese Datei, damit sie die korrekten Archivierungsger\"{a}tenamen für jedes Ihrer Bandger\"{a}te enth\"{a}lt. Wenn bei der Konfiguration Ihr System richtig erkannt wurde, werden sie schon richtig gesetzt sein. Die Namen dieser Storage-Resourcen und der Media Type müssen mit jenen übereinstimmen, die in der Konfigurationsdatei des Directors stehen. Wenn Sie in eine Datei anstatt auf ein Band sichern wollen, muss als Archive-Ger\"{a}t ein Verzeichnis angegeben sein, in dem dann die Volumes erzeugt werden und schlie{\ss}lich die Dateien, sobald ein Volume gelabelt wird.
-
-\label{ConfigTesting}
-\section{Test der Konfigurationsdateien}
-\index[general]{Test der Konfigurationsdateien}
-\index[general]{Konfigurationsdateien!Test der }
-
-Sie k\"{o}nnen die Konfigurationsdateien auf korrekte Syntax testen, indem sie den entsprechenden D\"{a}mon mit der {\bf -t}-Option starten. Der D\"{a}mon wird die Konfigurationsdatei abarbeiten, gegebenenfalls eine Fehlermeldung ausgeben und sich dann beenden. Das folgende Beispiel geht davon aus, dass die Programm- und die Konfigurationsdateien im gleichen Verzeichnis installiert sind.
-
-\footnotesize
-\begin{verbatim}
-cd <installation-directory>
-./bacula-dir -t -c bacula-dir.conf
-./bacula-fd -t -c bacula-fd.conf
-./bacula-sd -t -c bacula-sd.conf
-./bconsole -t -c bconsole.conf
-./gnome-console -t -c gnome-console.conf
-./wx-console -t -c wx-console.conf
-su <normal user> -c "./bacula-tray-monitor -t -c tray-monitor.conf"
-\end{verbatim}
-\normalsize
-
-Hiermit werden alle Konfigurationsdateien der wichtigsten Programme getestet. Sind diese in Ordnung, beendet sich das Programm, ohne irgendetwas auszugeben. Beachten sie bitte, dass je nach gew\"{a}hlten Konfigurationsoptionen einige oder sogar alle der letzten drei Befehle auf Ihrem System nicht verfügbar sein werden. Wenn Sie die ausführbaren Dateien in die üblichen Unix-Verzeichnisse statt in ein einziges Verzeichnis installiert haben, müssen Sie die obigen Befehle entsprechend anpassen (das ``./'' vor dem Befehlsname weglassen und den Pfad vor den Namen der Konfigurationsdatei angeben).
-
-\label{TapeTesting}
-
-\section{Test der Kompatibilit\"{a}t von Bacula mit Ihrem Bandlaufwerk}
-\index[general]{Bandlaufwerk! Kompatibilit\"{a}tstest}
-\index[general]{Test der Kompatibilit\"{a}t von Bacula mit Ihrem Bandlaufwerk }
-
-Bevor Sie viel Zeit mit Bacula verschwenden, um schlie{\ss}lich herauszufinden, dass das Programm doch nicht mit Ihrem Bandlaufwerk zusammenarbeitet, lesen Sie bitte das Kapitel \ilink{btape -- Test Ihres Bandlaufwerkes}{_ChapterStart27} in diesem Handbuch.
-
-Wenn Sie ein neueres SCSI-Bandlaufwerk unter Linux oder Solaris benutzen, wird Bacula vermutlich funktionieren, aber probieren Sie das lieber vorher aus. Benutzer von FreeBSD (und m\"{o}glicherweise andere xBSD-Varianten) müssen das oben erw\"{a}hnte Kapitel lesen. Für FreeBSD gibt es unter \elink{The FreeBSD Diary}{http://www.freebsddiary.org/bacula.php} eine eingehende Beschreibung, wie man Bacula auf Ihrem System zum Laufen bringt. Benutzer von FreeBSD in einer Version vor 4.9-STABLE vom Montag, dem 29.12.2003, 15:18:01, die vorhaben ein Bandlaufwerk zu verwenden, sollten ausserdem die Datei {\bf platforms/freebsd/pthreads-fix.txt} in Baculas Hauptverzeichnis lesen. Darin sind wichtige Informationen zur Kompatibilit\"{a}t von Bacula und Ihrem System.
-
-\label{notls}
-
-\section{Das /lib/tls Verzeichnis entfernen}
-\index[general]{Das /lib/tls Verzeichnis entfernen }
-
-Die neue Pthreads-Bibliothek {\bf /lib/tls}, welche standardm\"{a}{\ss}ig von neueren ``RedHat''-Systemen (Kernelversion 2.4.x) installiert wird, ist fehlerhaft. Dieses Verzeichnis muss entfernt oder umbenannt werden, bevor Bacula dann nach einem Neustart lauff\"{a}hig ist. Geschieht dies nicht, wird sich Bacula nach etwa einer Woche Laufzeit entweder für l\"{a}ngere Zeitspannen oder dauerhaft blockieren. Man wird hier wohl eher die entsprechende Umgebungsvariable überschreiben, anstatt das Verzeichnis /lib/tls zu entfernen. Mehr zu diesem Problem im Kapitel \ilink{Unterstützte Betriebssysteme}{SupportedOSes}.
-
-Auf Systemen mit Kernel-Version 2.6.x scheint dieses Problem nicht aufzutreten.
-
-\label{Running1}
-
-\section{Bacula in Betrieb}
-\index[general]{Bacula in Betrieb }
-
-Der vielleicht wichtigste Teil beim Betrieb on Bacula ist die F\"{a}higkeit, Dateien wiederherzustellen. Wenn Sie dies nicht wenigstens einmal ausprobiert haben, bevor Sie tats\"{a}chlich gezwungen sind, es zu tun, werden Sie viel mehr unter Druck stehen und dazu neigen, Fehler zu machen, als wenn sie diesen Vorgang schon einmal getestet haben.
-
-Um eine Vorstellung davon zu bekommen, wie man Bacula in kurzer Zeit zum Laufen bringt empfehlen wir \textbf{dringend}, das Beispiel im Kapitel \ilink{Running Bacula Chapter}{_ChapterStart1} in diesem Handbuch nachzuvollziehen, wo im einzelnen erkl\"{a}rt wird, wie man Bacula laufen l\"{a}sst.
-
-\section{Log Rotation}
-\index[general]{Rotation!Log }
-\index[general]{Log Rotation }
-
-Wenn Sie die vorgegebene {\bf bacula-dir.conf} oder eine Abwandlung davon benutzen, werden Sie bemerken, dass alle Ausgaben von Bacula in eine Datei gespeichert werden. Um zu verhindern, dass diese Datei ohne Grenze w\"{a}chst, empfehlen wir, die Datei {\bf logrotate} aus dem Verzeichnis {\bf scripts/logrotate} nach {\bf /etc/logrotate.d/bacula} zu kopieren. Dadurch wird die Logdatei einmal im Monat rotiert und h\"{o}chstens fünf Monate lang erhalten. Um die Logrotation Ihren Wünschen anzupassen, k\"{o}nnen Sie diese Datei bearbeiten.
-
-\section{Log Watch}
-\index[general]{Watch!Log}
-\index[general]{Log Watch}
-Auf manchen Systemen wie RedHat und Fedora l\"{a}uft jede Nacht ein Logwatch-Programm, das Ihre Log-Dateien analysiert und per E-Mail berichtet. Wenn Sie die Ausgaben Ihrer Bacula-Sicherungsjobs diesen Berichten hinzufügen wollen, werfen sie einen Blick in das Verzeichnis {\bf scripts/logwatch}. In der {\bf README}-Datei in diesem Verzeichnis wird kurz erkl\"{a}rt, wie man es installiert und welche Ausgaben zu erwarten sind.
-
-\section{Disaster Recovery}
-\index[general]{Recovery!Disaster }
-\index[general]{Disaster Recovery }
-
-Wenn sie vorhaben, Bacula eher als Werkzeug zur Wiederherstellung Ihres Systems im Notfall, als nur dazu zu verwenden, besch\"{a}digte oder verlorengegangene Dateien wiederherzustellen, werden sie vielleicht das Kapitel \ilink{Disaster Recovery Using Bacula Chapter}{_ChapterStart38} in diesem Handbuch lesen wollen.
-
-Auf jeden Fall raten wir Ihnen dringend, die Wiederherstellung einiger gesicherte Dateien zu testen anstatt zu warten, bis ein Notfall eintritt.
+++ /dev/null
-%%
-%%
-
-\chapter{Bacula Security Issues}
-\label{SecurityChapter}
-\index[general]{Bacula Security Issues}
-\index[general]{Security}
-\index[general]{Issues!Bacula Security}
-
-\begin{itemize}
-\item Security means being able to restore your files, so read the
- \ilink{Critical Items Chapter}{Critical} of this manual.
-\item The Clients ({\bf bacula-fd}) must run as root to be able to access all
- the system files.
-\item It is not necessary to run the Director as root.
-\item It is not necessary to run the Storage daemon as root, but you must
- ensure that it can open the tape drives, which are often restricted to root
- access by default. In addition, if you do not run the Storage daemon as root,
- it will not be able to automatically set your tape drive parameters on most
- OSes since these functions, unfortunately require root access.
-\item You should restrict access to the Bacula configuration files, so that
- the passwords are not world-readable. The {\bf Bacula} daemons are password
- protected using CRAM-MD5 (i.e. the password is not sent across the network).
- This will ensure that not everyone can access the daemons. It is a reasonably
- good protection, but can be cracked by experts.
-\item If you are using the recommended ports 9101, 9102, and 9103, you will
- probably want to protect these ports from external access using a firewall
- and/or using tcp wrappers ({\bf etc/hosts.allow}).
-\item By default, all data that is sent across the network is unencrypted.
- However, Bacula does support TLS (transport layer security) and can
- encrypt transmitted data. Please read the
- \ilink{TLS (SSL) Communications Encryption}{CommEncryption}
- section of this manual.
-\item You should ensure that the Bacula working directories are readable and
- writable only by the Bacula daemons.
-\item If you are using {\bf MySQL} it is not necessary for it to run with
- {\bf root} permission.
-\item The default Bacula {\bf grant-mysql-permissions} script grants all
- permissions to use the MySQL database without a password. If you want
- security, please tighten this up!
-\item Don't forget that Bacula is a network program, so anyone anywhere on
- the network with the console program and the Director's password can access
- Bacula and the backed up data.
-\item You can restrict what IP addresses Bacula will bind to by using the
- appropriate {\bf DirAddress}, {\bf FDAddress}, or {\bf SDAddress} records in
- the respective daemon configuration files.
-\item Be aware that if you are backing up your database using the default
- script, if you have a password on your database, it will be passed as
- a command line option to that script, and any user will be able to see
- this information. If you want it to be secure, you will need to pass it
- by an environment variable or a secure file.
-
- See also \ilink{Backing Up Your Bacula
- Database - Security Considerations }{BackingUpBaculaSecurityConsiderations}
- for more information.
-\end{itemize}
-
-
-\section{Backward Compatibility}
-\index[general]{Backward Compatibility}
-One of the major goals of Bacula is to ensure that you can restore
-tapes (I'll use the word tape to include disk Volumes) that you wrote years
-ago. This means that each new version of Bacula should be able to read old
-format tapes. The first problem you will have is to ensure that the
-hardware is still working some years down the road, and the second
-problem will be to ensure that the media will still be good, then
-your OS must be able to interface to the device, and finally Bacula
-must be able to recognize old formats. All the problems except the
-last are ones that we cannot solve, but by careful planning you can.
-
-Since the very beginning of Bacula (January 2000) until today (December
-2005), there have been two major Bacula tape formats. The second format
-was introduced in version 1.27 in November of 2002, and it has not
-changed since then. In principle, Bacula can still read the original
-format, but I haven't tried it lately so who knows ...
-
-Though the tape format is fixed, the kinds of data that we can put on the
-tapes are extensible, and that is how we added new features
-such as ACLs, Win32 data, encrypted data, ... Obviously, an older
-version of Bacula would not know how to read these newer data streams,
-but each newer version of Bacula should know how to read all the
-older streams.
-
-If you want to be 100% sure that you can read old tapes, you
-should:
-
-1. Try reading old tapes from time to time -- e.g. at least once
-a year.
-
-2. Keep statically linked copies of every version of Bacula that you use
-in production then if for some reason, we botch up old tape compatibility, you
-can always pull out an old copy of Bacula ...
-
-The second point is probably overkill but if you want to be sure, it may
-save you someday.
-
-
-
-\label{wrappers}
-\section{Configuring and Testing TCP Wrappers}
-\index[general]{Configuring and Testing TCP Wrappers}
-\index[general]{TCP Wrappers}
-\index[general]{Wrappers!TCP}
-\index[general]{libwrappers}
-
-TCP Wrappers are implemented if you turn them on when configuring
-({\bf ./configure \verb:--:with-tcp-wrappers}).
-With this code enabled, you may control who may access your
-daemons. This control is done by modifying the file: {\bf
-/etc/hosts.allow}. The program name that {\bf Bacula} uses when
-applying these access restrictions is the name you specify in the
-daemon configuration file (see below for examples).
-You must not use the {\bf twist} option in your {\bf
-/etc/hosts.allow} or it will terminate the Bacula daemon when a
-connection is refused.
-
-The exact name of the package you need loaded to build with TCP wrappers
-depends on the system. For example,
-on SuSE, the TCP wrappers libraries needed to link Bacula are
-contained in the tcpd-devel package. On Red Hat, the package is named
-tcp\_wrappers.
-
-Dan Langille has provided the following information on configuring and
-testing TCP wrappers with Bacula.
-
-If you read hosts\_options(5), you will see an option called twist. This
-option replaces the current process by an instance of the specified shell
-command. Typically, something like this is used:
-
-\footnotesize
-\begin{verbatim}
-ALL : ALL \
- : severity auth.info \
- : twist /bin/echo "You are not welcome to use %d from %h."
-\end{verbatim}
-\normalsize
-
-The libwrap code tries to avoid {\bf twist} if it runs in a resident process,
-but that test will not protect the first hosts\_access() call. This will
-result in the process (e.g. bacula-fd, bacula-sd, bacula-dir) being terminated
-if the first connection to their port results in the twist option being
-invoked. The potential, and I stress potential, exists for an attacker to
-prevent the daemons from running. This situation is eliminated if your
-/etc/hosts.allow file contains an appropriate rule set. The following example
-is sufficient:
-
-\footnotesize
-\begin{verbatim}
-undef-fd : localhost : allow
-undef-sd : localhost : allow
-undef-dir : localhost : allow
-undef-fd : ALL : deny
-undef-sd : ALL : deny
-undef-dir : ALL : deny
-\end{verbatim}
-\normalsize
-
-You must adjust the names to be the same as the Name directives found
-in each of the daemon configuration files. They are, in general, not the
-same as the binary daemon names. It is not possible to use the
-daemon names because multiple daemons may be running on the same machine
-but with different configurations.
-
-In these examples, the Director is undef-dir, the
-Storage Daemon is undef-sd, and the File Daemon is undef-fd. Adjust to suit
-your situation. The above example rules assume that the SD, FD, and DIR all
-reside on the same box. If you have a remote FD client, then the following
-rule set on the remote client will suffice:
-
-\footnotesize
-\begin{verbatim}
-undef-fd : director.example.org : allow
-undef-fd : ALL : deny
-\end{verbatim}
-\normalsize
-
-where director.example.org is the host which will be contacting the client
-(ie. the box on which the Bacula Director daemon runs). The use of "ALL :
-deny" ensures that the twist option (if present) is not invoked. To properly
-test your configuration, start the daemon(s), then attempt to connect from an
-IP address which should be able to connect. You should see something like
-this:
-
-\footnotesize
-\begin{verbatim}
-$ telnet undef 9103
-Trying 192.168.0.56...
-Connected to undef.example.org.
-Escape character is '^]'.
-Connection closed by foreign host.
-$
-\end{verbatim}
-\normalsize
-
-This is the correct response. If you see this:
-
-\footnotesize
-\begin{verbatim}
-$ telnet undef 9103
-Trying 192.168.0.56...
-Connected to undef.example.org.
-Escape character is '^]'.
-You are not welcome to use undef-sd from xeon.example.org.
-Connection closed by foreign host.
-$
-\end{verbatim}
-\normalsize
-
-then twist has been invoked and your configuration is not correct and you need
-to add the deny statement. It is important to note that your testing must
-include restarting the daemons after each connection attempt. You can also
-tcpdchk(8) and tcpdmatch(8) to validate your /etc/hosts.allow rules. Here is a
-simple test using tcpdmatch:
-
-\footnotesize
-\begin{verbatim}
-$ tcpdmatch undef-dir xeon.example.org
-warning: undef-dir: no such process name in /etc/inetd.conf
-client: hostname xeon.example.org
-client: address 192.168.0.18
-server: process undef-dir
-matched: /etc/hosts.allow line 40
-option: allow
-access: granted
-\end{verbatim}
-\normalsize
-
-If you are running Bacula as a standalone daemon, the warning above can be
-safely ignored. Here is an example which indicates that your rules are missing
-a deny statement and the twist option has been invoked.
-
-\footnotesize
-\begin{verbatim}
-$ tcpdmatch undef-dir 10.0.0.1
-warning: undef-dir: no such process name in /etc/inetd.conf
-client: address 10.0.0.1
-server: process undef-dir
-matched: /etc/hosts.allow line 91
-option: severity auth.info
-option: twist /bin/echo "You are not welcome to use
- undef-dir from 10.0.0.1."
-access: delegated
-\end{verbatim}
-\normalsize
-
-\section{Running as non-root}
-\index[general]{Running as non-root }
-
-Security advice from Dan Langille:
-% TODO: don't use specific name
-
-% TODO: don't be too specific on operating system
-
-% TODO: maybe remove personalization?
-
-It is a good idea to run daemons with the lowest possible privileges. In
-other words, if you can, don't run applications as root which do not have to
-be root. The Storage Daemon and the Director Daemon do not need to be root.
-The File Daemon needs to be root in order to access all files on your system.
-In order to run as non-root, you need to create a user and a group. Choosing
-{\tt bacula} as both the user name and the group name sounds like a good idea
-to me.
-
-The FreeBSD port creates this user and group for you.
-Here is what those entries looked like on my FreeBSD laptop:
-
-\footnotesize
-\begin{verbatim}
-bacula:*:1002:1002::0:0:Bacula Daemon:/var/db/bacula:/sbin/nologin
-\end{verbatim}
-\normalsize
-
-I used vipw to create this entry. I selected a User ID and Group ID of 1002
-as they were unused on my system.
-
-I also created a group in /etc/group:
-
-\footnotesize
-\begin{verbatim}
-bacula:*:1002:
-\end{verbatim}
-\normalsize
-
-The bacula user (as opposed to the Bacula daemon) will have a home directory
-of {\tt /var/db/bacula} which is the default location for the Bacula
-database.
-
-Now that you have both a bacula user and a bacula group, you can secure the
-bacula home directory by issuing this command:
-
-\footnotesize
-\begin{verbatim}
-chown -R bacula:bacula /var/db/bacula/
-\end{verbatim}
-\normalsize
-
-This ensures that only the bacula user can access this directory. It also
-means that if we run the Director and the Storage daemon as bacula, those
-daemons also have restricted access. This would not be the case if they were
-running as root.
-
-It is important to note that the storage daemon actually needs to be in the
-operator group for normal access to tape drives etc (at least on a FreeBSD
-system, that's how things are set up by default) Such devices are normally
-chown root:operator. It is easier and less error prone to make Bacula a
-member of that group than it is to play around with system permissions.
-
-Starting the Bacula daemons
-
-To start the bacula daemons on a FreeBSD system, issue the following command:
-
-\footnotesize
-\begin{verbatim}
-/usr/local/etc/rc.d/bacula-dir start
-/usr/local/etc/rc.d/bacula-sd start
-/usr/local/etc/rc.d/bacula-fd start
-\end{verbatim}
-\normalsize
-
-To confirm they are all running:
-
-\footnotesize
-\begin{verbatim}
-$ ps auwx | grep bacula
-root 63418 0.0 0.3 1856 1036 ?? Ss 4:09PM 0:00.00
- /usr/local/sbin/bacula-fd -v -c /usr/local/etc/bacula-fd.conf
-bacula 63416 0.0 0.3 2040 1172 ?? Ss 4:09PM 0:00.01
- /usr/local/sbin/bacula-sd -v -c /usr/local/etc/bacula-sd.conf
-bacula 63422 0.0 0.4 2360 1440 ?? Ss 4:09PM 0:00.00
- /usr/local/sbin/bacula-dir -v -c /usr/local/etc/bacula-dir.conf
-\end{verbatim}
-\normalsize
+++ /dev/null
-/*
- * html2latex
- */
-
-available {
- sun4_sunos.4
- sun4_solaris.2
- rs_aix.3
- rs_aix.4
- sgi_irix
-}
-
-description {
- From Jeffrey Schaefer, Geometry Center. Translates HTML document to LaTeX
-}
-
-install {
- bin/html2latex /afs/rpi.edu/dept/acs/rpinfo/filters/GChtml2latex/html2latex
- bin/html2latex.tag /afs/rpi.edu/dept/acs/rpinfo/filters/GChtml2latex/html2latex.tag
- bin/html2latex-local.tag /afs/rpi.edu/dept/acs/rpinfo/filters/GChtml2latex/html2latex-local.tag
- bin/webtex2latex.tag /afs/rpi.edu/dept/acs/rpinfo/filters/GChtml2latex/webtex2latex.tag
- man/man1/html2latex.1 /afs/rpi.edu/dept/acs/rpinfo/filters/GChtml2latex/html2latex.1
-}
+++ /dev/null
-%%
-%%
-
-\chapter{Storage Daemon Configuration}
-\label{StoredConfChapter}
-\index[general]{Storage Daemon Configuration}
-\index[general]{Configuration!Storage Daemon}
-
-The Storage Daemon configuration file has relatively few resource definitions.
-However, due to the great variation in backup media and system capabilities,
-the storage daemon must be highly configurable. As a consequence, there are
-quite a large number of directives in the Device Resource definition that
-allow you to define all the characteristics of your Storage device (normally a
-tape drive). Fortunately, with modern storage devices, the defaults are
-sufficient, and very few directives are actually needed.
-
-Examples of {\bf Device} resource directives that are known to work for a
-number of common tape drives can be found in the {\bf
-\lt{}bacula-src\gt{}/examples/devices} directory, and most will also be listed
-here.
-
-For a general discussion of configuration file and resources including the
-data types recognized by {\bf Bacula}, please see the
-\ilink{Configuration}{ConfigureChapter} chapter of this manual. The
-following Storage Resource definitions must be defined:
-
-\begin{itemize}
-\item
- \ilink{Storage}{StorageResource} -- to define the name of the
- Storage daemon.
-\item
- \ilink{Director}{DirectorResource1} -- to define the Director's
- name and his access password.
-\item
- \ilink{Device}{DeviceResource} -- to define the
- characteristics of your storage device (tape drive).
-\item
- \ilink{Messages}{MessagesChapter} -- to define where error and
- information messages are to be sent.
-\end{itemize}
-
-\section{Storage Resource}
-\label{StorageResource}
-\index[general]{Resource!Storage}
-\index[general]{Storage Resource}
-
-In general, the properties specified under the Storage resource define global
-properties of the Storage daemon. Each Storage daemon configuration file must
-have one and only one Storage resource definition.
-
-\begin{description}
-
-\item [Name = \lt{}Storage-Daemon-Name\gt{}]
- \index[sd]{Name}
- \index[sd]{Directive!Name}
- Specifies the Name of the Storage daemon. This directive is required.
-
-\item [Working Directory = \lt{}Directory\gt{}]
- \index[sd]{Working Directory}
- \index[sd]{Directive!Working Directory}
- This directive is mandatory and specifies a directory in which the Storage
- daemon may put its status files. This directory should be used only by {\bf
- Bacula}, but may be shared by other Bacula daemons provided the names
- given to each daemon are unique. This directive is
- required
-
-\item [Pid Directory = \lt{}Directory\gt{}]
- \index[sd]{Pid Directory}
- \index[sd]{Directive!Pid Directory}
- This directive is mandatory and specifies a directory in which the Director
- may put its process Id file files. The process Id file is used to shutdown
- Bacula and to prevent multiple copies of Bacula from running simultaneously.
- This directive is required. Standard shell expansion of the {\bf Directory}
- is done when the configuration file is read so that values such as {\bf
- \$HOME} will be properly expanded.
-
- Typically on Linux systems, you will set this to: {\bf /var/run}. If you are
- not installing Bacula in the system directories, you can use the {\bf Working
- Directory} as defined above.
-
-\item [Heartbeat Interval = \lt{}time-interval\gt{}]
- \index[sd]{Heartbeat Interval}
- \index[sd]{Directive!Heartbeat Interval}
- \index[general]{Heartbeat Interval}
- \index[general]{Broken pipe}
- This directive defines an interval of time in seconds. When
- the Storage daemon is waiting for the operator to mount a
- tape, each time interval, it will send a heartbeat signal to
- the File daemon. The default interval is zero which disables
- the heartbeat. This feature is particularly useful if you
- have a router such as 3Com that does not follow Internet
- standards and times out an valid connection after a short
- duration despite the fact that keepalive is set. This usually
- results in a broken pipe error message.
-
-\item [Client Connect Wait = \lt{}time-interval\gt{}]
- \index[sd]{Connect Wait}
- \index[sd]{Directive!Connect Wait}
- \index[general]{Client Connect Wait}
- This directive defines an interval of time in seconds that
- the Storage daemon will wait for a Client (the File daemon)
- to connect. The default is 30 seconds. Be aware that the
- longer the Storage daemon waits for a Client, the more
- resources will be tied up.
-
-\item [Maximum Concurrent Jobs = \lt{}number\gt{}]
- \index[sd]{Maximum Concurrent Jobs}
- \index[sd]{Directive!Maximum Concurrent Jobs}
- where \lt{}number\gt{} is the maximum number of Jobs that should run
- concurrently. The default is set to 10, but you may set it to a larger
- number. Each contact from the Director (e.g. status request, job start
- request) is considered as a Job, so if you want to be able to do a {\bf
- status} request in the console at the same time as a Job is running, you
- will need to set this value greater than 1. To run simultaneous Jobs,
- you will need to set a number of other directives in the Director's
- configuration file. Which ones you set depend on what you want, but you
- will almost certainly need to set the {\bf Maximum Concurrent Jobs} in
- the Storage resource in the Director's configuration file and possibly
- those in the Job and Client resources.
-
-\item [SDAddresses = \lt{}IP-address-specification\gt{}]
- \index[sd]{SDAddresses}
- \index[sd]{Directive!SDAddresses}
- Specify the ports and addresses on which the Storage daemon will listen
- for Director connections. Normally, the default is sufficient and you
- do not need to specify this directive. Probably the simplest way to
- explain how this directive works is to show an example:
-
-\footnotesize
-\begin{verbatim}
- SDAddresses = { ip = {
- addr = 1.2.3.4; port = 1205; }
- ipv4 = {
- addr = 1.2.3.4; port = http; }
- ipv6 = {
- addr = 1.2.3.4;
- port = 1205;
- }
- ip = {
- addr = 1.2.3.4
- port = 1205
- }
- ip = {
- addr = 1.2.3.4
- }
- ip = {
- addr = 201:220:222::2
- }
- ip = {
- addr = bluedot.thun.net
- }
-}
-\end{verbatim}
-\normalsize
-
-where ip, ip4, ip6, addr, and port are all keywords. Note, that the address
-can be specified as either a dotted quadruple, or IPv6 colon notation, or as
-a symbolic name (only in the ip specification). Also, port can be specified
-as a number or as the mnemonic value from the /etc/services file. If a port
-is not specified, the default will be used. If an ip section is specified,
-the resolution can be made either by IPv4 or IPv6. If ip4 is specified, then
-only IPv4 resolutions will be permitted, and likewise with ip6.
-
-Using this directive, you can replace both the SDPort and SDAddress
-directives shown below.
-
-\item [SDPort = \lt{}port-number\gt{}]
- \index[sd]{SDPort}
- \index[sd]{Directive!SDPort}
- Specifies port number on which the Storage daemon listens for Director
- connections. The default is 9103.
-
-\item [SDAddress = \lt{}IP-Address\gt{}]
- \index[sd]{SDAddress}
- \index[sd]{Directive!SDAddress}
- This directive is optional, and if it is specified, it will cause the
- Storage daemon server (for Director and File daemon connections) to bind
- to the specified {\bf IP-Address}, which is either a domain name or an
- IP address specified as a dotted quadruple. If this directive is not
- specified, the Storage daemon will bind to any available address (the
- default).
-
-\end{description}
-
-The following is a typical Storage daemon Storage definition.
-
-\footnotesize
-\begin{verbatim}
-#
-# "Global" Storage daemon configuration specifications appear
-# under the Storage resource.
-#
-Storage {
- Name = "Storage daemon"
- Address = localhost
- WorkingDirectory = "~/bacula/working"
- Pid Directory = "~/bacula/working"
-}
-\end{verbatim}
-\normalsize
-
-\section{Director Resource}
-\label{DirectorResource1}
-\index[general]{Director Resource}
-\index[general]{Resource!Director}
-
-The Director resource specifies the Name of the Director which is permitted
-to use the services of the Storage daemon. There may be multiple Director
-resources. The Director Name and Password must match the corresponding
-values in the Director's configuration file.
-
-\begin{description}
-
-\item [Name = \lt{}Director-Name\gt{}]
- \index[sd]{Name}
- \index[sd]{Directive!Name}
- Specifies the Name of the Director allowed to connect to the Storage daemon.
- This directive is required.
-
-\item [Password = \lt{}Director-password\gt{}]
- \index[sd]{Password}
- \index[sd]{Directive!Password}
- Specifies the password that must be supplied by the above named Director.
- This directive is required.
-
-\item [Monitor = \lt{}yes|no\gt{}]
- \index[sd]{Monitor}
- \index[sd]{Directive!Monitor}
- If Monitor is set to {\bf no} (default), this director will have full
- access to this Storage daemon. If Monitor is set to {\bf yes}, this
- director will only be able to fetch the current status of this Storage
- daemon.
-
- Please note that if this director is being used by a Monitor, we highly
- recommend to set this directive to {\bf yes} to avoid serious security
- problems.
-
-\end{description}
-
-The following is an example of a valid Director resource definition:
-
-\footnotesize
-\begin{verbatim}
-Director {
- Name = MainDirector
- Password = my_secret_password
-}
-\end{verbatim}
-\normalsize
-
-\label{DeviceResource}
-\section{Device Resource}
-\index[general]{Resource!Device}
-\index[general]{Device Resource}
-
-The Device Resource specifies the details of each device (normally a tape
-drive) that can be used by the Storage daemon. There may be multiple
-Device resources for a single Storage daemon. In general, the properties
-specified within the Device resource are specific to the Device.
-
-\begin{description}
-
-\item [Name = {\it Device-Name}]
- \index[sd]{Name}
- \index[sd]{Directive!Name}
- Specifies the Name that the Director will use when asking to backup or
- restore to or from to this device. This is the logical Device name, and may
- be any string up to 127 characters in length. It is generally a good idea to
- make it correspond to the English name of the backup device. The physical
- name of the device is specified on the {\bf Archive Device} directive
- described below. The name you specify here is also used in your Director's
- conf file on the
- \ilink{Device directive}{StorageResource2} in its Storage
- resource.
-
-\item [Archive Device = {\it name-string}]
- \index[sd]{Archive Device}
- \index[sd]{Directive!Archive Device}
- The specified {\bf name-string} gives the system file name of the storage
- device managed by this storage daemon. This will usually be the device file
- name of a removable storage device (tape drive), for example "{\bf
- /dev/nst0}" or "{\bf /dev/rmt/0mbn}". For a DVD-writer, it will be for
- example {\bf /dev/hdc}. It may also be a directory name if you are archiving
- to disk storage. In this case, you must supply the full absolute path to the
- directory. When specifying a tape device, it is preferable that the
- "non-rewind" variant of the device file name be given. In addition, on
- systems such as Sun, which have multiple tape access methods, you must be
- sure to specify to use Berkeley I/O conventions with the device. The {\bf b}
- in the Solaris (Sun) archive specification {\bf /dev/rmt/0mbn} is what is
- needed in this case. Bacula does not support SysV tape drive behavior.
-
- As noted above, normally the Archive Device is the name of a tape drive, but
- you may also specify an absolute path to an existing directory. If the Device
- is a directory Bacula will write to file storage in the specified directory,
- and the filename used will be the Volume name as specified in the Catalog.
- If you want to write into more than one directory (i.e. to spread the load to
- different disk drives), you will need to define two Device resources, each
- containing an Archive Device with a different directory.
- \label{SetupFifo}
- In addition to a tape device name or a directory name, Bacula will accept the
- name of a FIFO. A FIFO is a special kind of file that connects two programs
- via kernel memory. If a FIFO device is specified for a backup operation, you
- must have a program that reads what Bacula writes into the FIFO. When the
- Storage daemon starts the job, it will wait for {\bf MaximumOpenWait} seconds
- for the read program to start reading, and then time it out and terminate
- the job. As a consequence, it is best to start the read program at the
- beginning of the job perhaps with the {\bf RunBeforeJob} directive. For this
- kind of device, you never want to specify {\bf AlwaysOpen}, because you want
- the Storage daemon to open it only when a job starts, so you must explicitly
- set it to {\bf No}. Since a FIFO is a one way device, Bacula will not attempt
- to read a label of a FIFO device, but will simply write on it. To create a
- FIFO Volume in the catalog, use the {\bf add} command rather than the {\bf
- label} command to avoid attempting to write a label.
-
-\footnotesize
-\begin{verbatim}
-Device {
- Name = FifoStorage
- Media Type = Fifo
- Device Type = Fifo
- Archive Device = /tmp/fifo
- LabelMedia = yes
- Random Access = no
- AutomaticMount = no
- RemovableMedia = no
- MaximumOpenWait = 60
- AlwaysOpen = no
-}
-\end{verbatim}
-\normalsize
-
- During a restore operation, if the Archive Device is a FIFO, Bacula will
- attempt to read from the FIFO, so you must have an external program that
- writes into the FIFO. Bacula will wait {\bf MaximumOpenWait} seconds for the
- program to begin writing and will then time it out and terminate the job. As
- noted above, you may use the {\bf RunBeforeJob} to start the writer program
- at the beginning of the job.
-
- The Archive Device directive is required.
-
-\item [Device Type = {\it type-specification}]
- \index[sd]{Device Type}
- \index[sd]{Directive!Device Type}
- The Device Type specification allows you to explicitly tell Bacula
- what kind of device you are defining. It the {\it type-specification}
- may be one of the following:
- \begin{description}
- \item [File]
- Tells Bacula that the device is a file. It may either be a
- file defined on fixed medium or a removable filesystem such as
- USB. All files must be random access devices.
- \item [Tape]
- The device is a tape device and thus is sequential access. Tape devices
- are controlled using ioctl() calls.
- \item [Fifo]
- The device is a first-in-first out sequential access read-only
- or write-only device.
- \item [DVD]
- The device is a DVD. DVDs are sequential access for writing, but
- random access for reading.
- \end{description}
-
- The Device Type directive is not required, and if not specified, Bacula
- will attempt to guess what kind of device has been specified using the
- Archive Device specification supplied. There are several advantages to
- explicitly specifying the Device Type. First, on some systems, block and
- character devices have the same type, which means that on those systems,
- Bacula is unlikely to be able to correctly guess that a device is a DVD.
- Secondly, if you explicitly specify the Device Type, the mount point
- need not be defined until the device is opened. This is the case with
- most removable devices such as USB that are mounted by the HAL daemon.
- If the Device Type is not explicitly specified, then the mount point
- must exist when the Storage daemon starts.
-
- This directive was implemented in Bacula version 1.38.6.
-
-
-\item [Media Type = {\it name-string}]
- \index[sd]{Media Type}
- \index[sd]{Directive!Media Type}
- The specified {\bf name-string} names the type of media supported by this
- device, for example, "DLT7000". Media type names are arbitrary in that you
- set them to anything you want, but they must be known to the volume
- database to keep track of which storage daemons can read which volumes. In
- general, each different storage type should have a unique Media Type
- associated with it. The same {\bf name-string} must appear in the
- appropriate Storage resource definition in the Director's configuration
- file.
-
- Even though the names you assign are arbitrary (i.e. you choose the name
- you want), you should take care in specifying them because the Media Type
- is used to determine which storage device Bacula will select during
- restore. Thus you should probably use the same Media Type specification
- for all drives where the Media can be freely interchanged. This is not
- generally an issue if you have a single Storage daemon, but it is with
- multiple Storage daemons, especially if they have incompatible media.
-
- For example, if you specify a Media Type of "DDS-4" then during the
- restore, Bacula will be able to choose any Storage Daemon that handles
- "DDS-4". If you have an autochanger, you might want to name the Media Type
- in a way that is unique to the autochanger, unless you wish to possibly use
- the Volumes in other drives. You should also ensure to have unique Media
- Type names if the Media is not compatible between drives. This
- specification is required for all devices.
-
- In addition, if you are using disk storage, each Device resource will
- generally have a different mount point or directory. In order for
- Bacula to select the correct Device resource, each one must have a
- unique Media Type.
-
-\label{Autochanger}
-\item [Autochanger = {\it Yes|No}]
- \index[sd]{Autochanger}
- \index[sd]{Directive!Autochanger}
- If {\bf Yes}, this device belongs to an automatic tape changer, and you
- must specify an {\bf Autochanger} resource that points to the {\bf
- Device} resources. You must also specify a
- {\bf Changer Device}. If the Autochanger directive is set to {\bf
- No} (default), the volume must be manually changed. You should also
- have an identical directive to the
- \ilink{Storage resource}{Autochanger1} in the Director's
- configuration file so that when labeling tapes you are prompted for the slot.
-
-\item [Changer Device = {\it name-string}]
- \index[sd]{Changer Device}
- \index[sd]{Directive!Changer Device}
- The specified {\bf name-string} must be the {\bf generic SCSI} device
- name of the autochanger that corresponds to the normal read/write
- {\bf Archive Device} specified in the Device resource. This
- generic SCSI device name should be specified if you have an autochanger
- or if you have a standard tape drive and want to use the
- {\bf Alert Command} (see below). For example, on Linux systems, for
- an Archive Device name of {\bf /dev/nst0}, you would specify {\bf
- /dev/sg0} for the Changer Device name. Depending on your exact
- configuration, and the number of autochangers or the type of
- autochanger, what you specify here can vary. This directive is
- optional. See the \ilink{ Using Autochangers}{AutochangersChapter} chapter
- of this manual for more details of using this and the following
- autochanger directives.
-
-\item [Changer Command = {\it name-string}]
- \index[sd]{Changer Command}
- \index[sd]{Directive!Changer Command}
- The {\bf name-string} specifies an external program to be called that will
- automatically change volumes as required by {\bf Bacula}. Normally,
- this directive will be specified only in the {\bf AutoChanger} resource,
- which is then used for all devices. However, you may also specify
- the different {\bf Changer Command} in each Device resource.
- Most frequently,
- you will specify the Bacula supplied {\bf mtx-changer} script as follows:
-
-\footnotesize
-\begin{verbatim}
-Changer Command = "/path/mtx-changer %c %o %S %a %d"
-\end{verbatim}
-\normalsize
-
- and you will install the {\bf mtx} on your system (found in the {\bf depkgs}
- release). An example of this command is in the default bacula-sd.conf file.
- For more details on the substitution characters that may be specified to
- configure your autochanger please see the
- \ilink{Autochangers}{AutochangersChapter} chapter of this manual.
- For FreeBSD users, you might want to see one of the several {\bf chio}
- scripts in {\bf examples/autochangers}.
-
-\item [Alert Command = {\it name-string}]
- \index[sd]{Alert Command}
- The {\bf name-string} specifies an external program to be called at the
- completion of each Job after the device is released. The purpose of this
- command is to check for Tape Alerts, which are present when something is
- wrong with your tape drive (at least for most modern tape drives). The same
- substitution characters that may be specified in the Changer Command may also
- be used in this string. For more information, please see the
- \ilink{Autochangers}{AutochangersChapter} chapter of this manual.
-
-
- Note, it is not necessary to have an autochanger to use this command. The
- example below uses the {\bf tapeinfo} program that comes with the {\bf mtx}
- package, but it can be used on any tape drive. However, you will need to
- specify a {\bf Changer Device} directive in your Device resource (see above)
- so that the generic SCSI device name can be edited into the command (with the
- \%c).
-
- An example of the use of this command to print Tape Alerts in the Job report
- is:
-
-\footnotesize
-\begin{verbatim}
-Alert Command = "sh -c 'tapeinfo -f %c | grep TapeAlert'"
-
-\end{verbatim}
-\normalsize
-
-and an example output when there is a problem could be:
-
-\footnotesize
-\begin{verbatim}
-bacula-sd Alert: TapeAlert[32]: Interface: Problem with SCSI interface
- between tape drive and initiator.
-
-\end{verbatim}
-\normalsize
-
-\item [Drive Index = {\it number}]
- \index[sd]{Drive Index}
- \index[sd]{Directive!Drive Index}
- The {\bf Drive Index} that you specify is passed to the {\bf
- mtx-changer} script and is thus passed to the {\bf mtx} program. By
- default, the Drive Index is zero, so if you have only one drive in your
- autochanger, everything will work normally. However, if you have
- multiple drives, you must specify multiple Bacula Device resources (one
- for each drive). The first Device should have the Drive Index set to 0,
- and the second Device Resource should contain a Drive Index set to 1,
- and so on. This will then permit you to use two or more drives in your
- autochanger. As of Bacula version 1.38.0, using the {\bf Autochanger}
- resource, Bacula will automatically ensure that only one drive at a time
- uses the autochanger script, so you no longer need locking scripts as in
- the past -- the default mtx-changer script works for any number of
- drives.
-
-\item [Autoselect = {\it Yes|No}]
- \index[sd]{Autoselect}
- \index[sd]{Directive!Autoselect}
- If this directive is set to {\bf yes} (default), and the Device
- belongs to an autochanger, then when the Autochanger is referenced
- by the Director, this device can automatically be selected. If this
- directive is set to {\bf no}, then the Device can only be referenced
- by directly using the Device name in the Director. This is useful
- for reserving a drive for something special such as a high priority
- backup or restore operations.
-
-\item [Maximum Changer Wait = {\it time}]
- \index[sd]{Maximum Changer Wait}
- \index[sd]{Directive!Maximum Changer Wait}
- This directive specifies the maximum time in seconds for Bacula to wait
- for an autochanger to change the volume. If this time is exceeded,
- Bacula will invalidate the Volume slot number stored in the catalog and
- try again. If no additional changer volumes exist, Bacula will ask the
- operator to intervene. The default is 5 minutes.
-% TODO: if this is the format, then maybe "5 minutes" should be in
-% TODO: quotes? define style. see others.
-
-\item [Maximum Rewind Wait = {\it time}]
- \index[sd]{Maximum Rewind Wait}
- \index[sd]{Directive!Maximum Rewind Wait}
- This directive specifies the maximum time in seconds for Bacula to wait
- for a rewind before timing out. If this time is exceeded,
- Bacula will cancel the job. The default is 5 minutes.
-
-\item [Maximum Open Wait = {\it time}]
- \index[sd]{Maximum Open Wait}
- \index[sd]{Directive!Maximum Open Wait}
- This directive specifies the maximum time in seconds for Bacula to wait
- for a open before timing out. If this time is exceeded,
- Bacula will cancel the job. The default is 5 minutes.
-
-\item [Always Open = {\it Yes|No}]
- \index[sd]{Always Open}
- \index[sd]{Directive!Always Open}
- If {\bf Yes} (default), Bacula will always keep the device open unless
- specifically {\bf unmounted} by the Console program. This permits
- Bacula to ensure that the tape drive is always available, and properly
- positioned. If you set
- {\bf AlwaysOpen} to {\bf no} {\bf Bacula} will only open the drive when
- necessary, and at the end of the Job if no other Jobs are using the
- drive, it will be freed. The next time Bacula wants to append to a tape
- on a drive that was freed, Bacula will rewind the tape and position it to
- the end. To avoid unnecessary tape positioning and to minimize
- unnecessary operator intervention, it is highly recommended that {\bf
- Always Open = yes}. This also ensures that the drive is available when
- Bacula needs it.
-
- If you have {\bf Always Open = yes} (recommended) and you want to use the
- drive for something else, simply use the {\bf unmount} command in the Console
- program to release the drive. However, don't forget to remount the drive with
- {\bf mount} when the drive is available or the next Bacula job will block.
-
- For File storage, this directive is ignored. For a FIFO storage device, you
- must set this to {\bf No}.
-
- Please note that if you set this directive to {\bf No} Bacula will release
- the tape drive between each job, and thus the next job will rewind the tape
- and position it to the end of the data. This can be a very time consuming
- operation. In addition, with this directive set to no, certain multiple
- drive autochanger operations will fail. We strongly recommend to keep
- {\bf Always Open} set to {\bf Yes}
-
-\item [Volume Poll Interval = {\it time}]
- \index[sd]{Volume Poll Interval}
- \index[sd]{Directive!Volume Poll Interval}
- If the time specified on this directive is non-zero, after asking the
- operator to mount a new volume Bacula will periodically poll (or read) the
- drive at the specified interval to see if a new volume has been mounted. If
- the time interval is zero (the default), no polling will occur. This
- directive can be useful if you want to avoid operator intervention via the
- console. Instead, the operator can simply remove the old volume and insert
- the requested one, and Bacula on the next poll will recognize the new tape
- and continue. Please be aware that if you set this interval too small, you
- may excessively wear your tape drive if the old tape remains in the drive,
- since Bacula will read it on each poll. This can be avoided by ejecting the
- tape using the {\bf Offline On Unmount} and the {\bf Close on Poll}
- directives.
- However, if you are using a Linux 2.6 kernel or other OSes
- such as FreeBSD or Solaris, the Offline On Unmount will leave the drive
- with no tape, and Bacula will not be able to properly open the drive and
- may fail the job. For more information on this problem, please see the
- \ilink{description of Offline On Unmount}{NoTapeInDrive} in the Tape
- Testing chapter.
-
-\item [Close on Poll= {\it Yes|No}]
- \index[sd]{Close on Poll}
- \index[sd]{Directive!Close on Poll}
- If {\bf Yes}, Bacula close the device (equivalent to an unmount except no
- mount is required) and reopen it at each poll. Normally this is not too
- useful unless you have the {\bf Offline on Unmount} directive set, in which
- case the drive will be taken offline preventing wear on the tape during any
- future polling. Once the operator inserts a new tape, Bacula will recognize
- the drive on the next poll and automatically continue with the backup.
- Please see above more more details.
-
-\item [Maximum Open Wait = {\it time}]
- \index[sd]{Maximum Open Wait}
- \index[sd]{Directive!Maximum Open Wait}
- This directive specifies the maximum amount of time in seconds that
- Bacula will wait for a device that is busy. The default is 5 minutes.
- If the device cannot be obtained, the current Job will be terminated in
- error. Bacula will re-attempt to open the drive the next time a Job
- starts that needs the the drive.
-
-\label{removablemedia}
-\item [Removable media = {\it Yes|No}]
- \index[sd]{Removable media}
- \index[sd]{Directive!Removable media}
- If {\bf Yes}, this device supports removable media (for example, tapes
- or CDs). If {\bf No}, media cannot be removed (for example, an
- intermediate backup area on a hard disk). If {\bf Removable media} is
- enabled on a File device (as opposed to a tape) the Storage daemon will
- assume that device may be something like a USB device that can be
- removed or a simply a removable harddisk. When attempting to open
- such a device, if the Volume is not found (for File devices, the Volume
- name is the same as the Filename), then the Storage daemon will search
- the entire device looking for likely Volume names, and for each one
- found, it will ask the Director if the Volume can be used. If so,
- the Storage daemon will use the first such Volume found. Thus it
- acts somewhat like a tape drive -- if the correct Volume is not found,
- it looks at what actually is found, and if it is an appendable Volume,
- it will use it.
-
- If the removable medium is not automatically mounted (e.g. udev), then
- you might consider using additional Storage daemon device directives
- such as {\bf Requires Mount}, {\bf Mount Point}, {\bf Mount Command},
- and {\bf Unmount Command}, all of which can be used in conjunction with
- {\bf Removable Media}.
-
-
-\item [Random access = {\it Yes|No}]
- \index[sd]{Random access}
- \index[sd]{Directive!Random access}
- If {\bf Yes}, the archive device is assumed to be a random access medium
- which supports the {\bf lseek} (or {\bf lseek64} if Largefile is enabled
- during configuration) facility. This should be set to {\bf Yes} for all
- file systems such as DVD, USB, and fixed files. It should be set to
- {\bf No} for non-random access devices such as tapes and named pipes.
-
-
-\item [Requires Mount = {\it Yes|No}]
- \index[sd]{Requires Mount }
- When this directive is enabled, the Storage daemon will submit
- a {\bf Mount Command} before attempting to open the device.
- You must set this directive to {\bf yes} for DVD-writers and removable
- file systems such as USB devices that are not automatically mounted
- by the operating system when plugged in or opened by Bacula.
- It should be set to {\bf no} for
- all other devices such as tapes and fixed filesystems. It should also
- be set to {\bf no} for any removable device that is automatically
- mounted by the operating system when opened (e.g. USB devices mounted
- by udev or hotplug). This directive
- indicates if the device requires to be mounted using the {\bf Mount
- Command}. To be able to write a DVD, the following directives must also
- be defined: {\bf Mount Point}, {\bf Mount Command}, {\bf Unmount
- Command} and {\bf Write Part Command}.
-
-\item [Mount Point = {\it directory}]
- \index[sd]{Mount Point}
- Directory where the device can be mounted.
- This directive is used only
- for devices that have {\bf Requires Mount} enabled such as DVD or
- USB file devices.
-
-\item [Mount Command = {\it name-string}]
- \index[sd]{Mount Command}
- This directive specifies the command that must be executed to mount
- devices such as DVDs and many USB devices. For DVDs, the
- device is written directly, but the mount command is necessary in
- order to determine the free space left on the DVD. Before the command is
- executed, \%a is replaced with the Archive Device, and \%m with the Mount
- Point.
-
- Most frequently, for a DVD, you will define it as follows:
-
-\footnotesize
-\begin{verbatim}
- Mount Command = "/bin/mount -t iso9660 -o ro %a %m"
-\end{verbatim}
-\normalsize
-
-However, if you have defined a mount point in /etc/fstab, you might be
-able to use a mount command such as:
-
-\footnotesize
-\begin{verbatim}
- Mount Command = "/bin/mount /media/dvd"
-\end{verbatim}
-\normalsize
-
-See the \ilink {Edit Codes}{mountcodes} section below for more details of
-the editing codes that can be used in this directive.
-
-
-\item [Unmount Command = {\it name-string}]
- \index[sd]{Unmount Command}
- This directive specifies the command that must be executed to unmount
- devices such as DVDs and many USB devices. Before the command is
- executed, \%a is replaced with the Archive Device, and \%m with the Mount
- Point.
-
- Most frequently, you will define it as follows:
-
-\footnotesize
-\begin{verbatim}
- Unmount Command = "/bin/umount %m"
-\end{verbatim}
-\normalsize
-
-See the \ilink {Edit Codes}{mountcodes} section below for more details of
-the editing codes that can be used in this directive.
-
-
-\item [Minimum block size = {\it size-in-bytes}]
- \index[sd]{Minimum block size}
- \index[sd]{Directive!Minimum block size}
- On most modern tape drives, you will not need or want to specify this
- directive, and if you do so, it will be to make Bacula use fixed block
- sizes. This statement applies only to non-random access devices (e.g.
- tape drives). Blocks written by the storage daemon to a non-random
- archive device will never be smaller than the given {\bf size-in-bytes}.
- The Storage daemon will attempt to efficiently fill blocks with data
- received from active sessions but will, if necessary, add padding to a
- block to achieve the required minimum size.
-
- To force the block size to be fixed, as is the case for some non-random
- access devices (tape drives), set the {\bf Minimum block size} and the
- {\bf Maximum block size} to the same value (zero included). The default
- is that both the minimum and maximum block size are zero and the default
- block size is 64,512 bytes.
-
- For example, suppose you want a fixed block size of 100K bytes, then you
- would specify:
-
-\footnotesize
-\begin{verbatim}
-
- Minimum block size = 100K
- Maximum block size = 100K
-
-\end{verbatim}
-\normalsize
-
- Please note that if you specify a fixed block size as shown above, the tape
- drive must either be in variable block size mode, or if it is in fixed block
- size mode, the block size (generally defined by {\bf mt}) {\bf must} be
- identical to the size specified in Bacula -- otherwise when you attempt to
- re-read your Volumes, you will get an error.
-
- If you want the block size to be variable but with a 64K minimum and 200K
- maximum (and default as well), you would specify:
-
-\footnotesize
-\begin{verbatim}
-
- Minimum block size = 64K
- Maximum blocksize = 200K
-
-\end{verbatim}
-\normalsize
-
-\item [Maximum block size = {\it size-in-bytes}]
- \index[sd]{Maximum block size}
- \index[sd]{Directive!Maximum block size}
- On most modern tape drives, you will not need to specify this directive.
- If you do so, it will most likely be to use fixed block sizes (see
- Minimum block size above). The Storage daemon will always attempt to
- write blocks of the specified {\bf size-in-bytes} to the archive device.
- As a consequence, this statement specifies both the default block size
- and the maximum block size. The size written never exceed the given
- {\bf size-in-bytes}. If adding data to a block would cause it to exceed
- the given maximum size, the block will be written to the archive device,
- and the new data will begin a new block.
-
- If no value is specified or zero is specified, the Storage daemon will
- use a default block size of 64,512 bytes (126 * 512).
-
-\item [Hardware End of Medium = {\it Yes|No}]
- \index[sd]{Hardware End of Medium}
- \index[sd]{Directive!Hardware End of Medium}
- If {\bf No}, the archive device is not required to support end of medium
- ioctl request, and the storage daemon will use the forward space file
- function to find the end of the recorded data. If {\bf Yes}, the archive
- device must support the {\tt ioctl} {\tt MTEOM} call, which will position the
- tape to the end of the recorded data. In addition, your SCSI driver must keep
- track of the file number on the tape and report it back correctly by the
- {\bf MTIOCGET} ioctl. Note, some SCSI drivers will correctly forward space to
- the end of the recorded data, but they do not keep track of the file number.
- On Linux machines, the SCSI driver has a {\bf fast-eod} option, which if set
- will cause the driver to lose track of the file number. You should ensure
- that this option is always turned off using the {\bf mt} program.
-
- Default setting for Hardware End of Medium is {\bf Yes}. This function is
- used before appending to a tape to ensure that no previously written data is
- lost. We recommend if you have a non-standard or unusual tape drive that you
- use the {\bf btape} program to test your drive to see whether or not it
- supports this function. All modern (after 1998) tape drives support this
- feature.
-
-\item [Fast Forward Space File = {\it Yes|No}]
- \index[sd]{Fast Forward Space File}
- \index[sd]{Directive!Fast Forward Space File}
- If {\bf No}, the archive device is not required to support keeping track of
- the file number ({\bf MTIOCGET} ioctl) during forward space file. If {\bf
- Yes}, the archive device must support the {\tt ioctl} {\tt MTFSF} call, which
- virtually all drivers support, but in addition, your SCSI driver must keep
- track of the file number on the tape and report it back correctly by the
- {\bf MTIOCGET} ioctl. Note, some SCSI drivers will correctly forward space,
- but they do not keep track of the file number or more seriously, they do not
- report end of medium.
-
- Default setting for Fast Forward Space File is {\bf Yes}.
-
-\item [Use MTIOCGET = {\it Yes|No}]
- \index[sd]{Use MTIOCGET}
- \index[sd]{Directive!Use MTIOCGET}
- If {\bf No}, the operating system is not required to support keeping track of
- the file number and reporting it in the ({\bf MTIOCGET} ioctl). The default
- is {\bf Yes}. If you must set this to No, Bacula will do the proper file
- position determination, but it is very unfortunate because it means that
- tape movement is very inefficient.
- Fortunately, this operation system deficiency seems to be the case only
- on a few *BSD systems. Operating systems known to work correctly are
- Solaris, Linux and FreeBSD.
-
-\item [BSF at EOM = {\it Yes|No}]
- \index[sd]{BSF at EOM}
- \index[sd]{Directive!BSF at EOM}
- If {\bf No}, the default, no special action is taken by Bacula with the End
- of Medium (end of tape) is reached because the tape will be positioned after
- the last EOF tape mark, and Bacula can append to the tape as desired.
- However, on some systems, such as FreeBSD, when Bacula reads the End of
- Medium (end of tape), the tape will be positioned after the second EOF tape
- mark (two successive EOF marks indicated End of Medium). If Bacula appends
- from that point, all the appended data will be lost. The solution for such
- systems is to specify {\bf BSF at EOM} which causes Bacula to backspace over
- the second EOF mark. Determination of whether or not you need this directive
- is done using the {\bf test} command in the {\bf btape} program.
-
-\item [TWO EOF = {\it Yes|No}]
- \index[sd]{TWO EOF}
- \index[sd]{Directive!TWO EOF}
- If {\bf Yes}, Bacula will write two end of file marks when terminating a tape
--- i.e. after the last job or at the end of the medium. If {\bf No}, the
-default, Bacula will only write one end of file to terminate the tape.
-
-\item [Backward Space Record = {\it Yes|No}]
- \index[sd]{Backward Space Record}
- \index[sd]{Directive!Backward Space Record}
- If {\it Yes}, the archive device supports the {\tt MTBSR ioctl} to backspace
- records. If {\it No}, this call is not used and the device must be rewound
- and advanced forward to the desired position. Default is {\bf Yes} for non
- random-access devices. This function if enabled is used at the end of a
- Volume after writing the end of file and any ANSI/IBM labels to determine whether
- or not the last block was written correctly. If you turn this function off,
- the test will not be done. This causes no harm as the re-read process is
- precautionary rather than required.
-
-\item [Backward Space File = {\it Yes|No}]
- \index[sd]{Backward Space File}
- \index[sd]{Directive!Backward Space File}
- If {\it Yes}, the archive device supports the {\bf MTBSF} and {\bf MTBSF
- ioctl}s to backspace over an end of file mark and to the start of a file. If
- {\it No}, these calls are not used and the device must be rewound and
- advanced forward to the desired position. Default is {\bf Yes} for non
- random-access devices.
-
-\item [Forward Space Record = {\it Yes|No}]
- \index[sd]{Forward Space Record}
- \index[sd]{Directive!Forward Space Record}
- If {\it Yes}, the archive device must support the {\bf MTFSR ioctl} to
- forward space over records. If {\bf No}, data must be read in order to
- advance the position on the device. Default is {\bf Yes} for non
- random-access devices.
-
-\item [Forward Space File = {\it Yes|No}]
- \index[sd]{Forward Space File}
- \index[sd]{Directive!Forward Space File}
- If {\bf Yes}, the archive device must support the {\tt MTFSF ioctl} to
- forward space by file marks. If {\it No}, data must be read to advance the
- position on the device. Default is {\bf Yes} for non random-access devices.
-
-\item [Offline On Unmount = {\it Yes|No}]
- \index[sd]{Offline On Unmount}
- \index[sd]{Directive!Offline On Unmount}
- The default for this directive is {\bf No}. If {\bf Yes} the archive device
- must support the {\tt MTOFFL ioctl} to rewind and take the volume offline. In
- this case, Bacula will issue the offline (eject) request before closing the
- device during the {\bf unmount} command. If {\bf No} Bacula will not attempt
- to offline the device before unmounting it. After an offline is issued, the
- cassette will be ejected thus {\bf requiring operator intervention} to
- continue, and on some systems require an explicit load command to be issued
- ({\bf mt -f /dev/xxx load}) before the system will recognize the tape. If you
- are using an autochanger, some devices require an offline to be issued prior
- to changing the volume. However, most devices do not and may get very
- confused.
-
- If you are using a Linux 2.6 kernel or other OSes
- such as FreeBSD or Solaris, the Offline On Unmount will leave the drive
- with no tape, and Bacula will not be able to properly open the drive and
- may fail the job. For more information on this problem, please see the
- \ilink{description of Offline On Unmount}{NoTapeInDrive} in the Tape
- Testing chapter.
-
-
-\item [Maximum Volume Size = {\it size}]
- \index[sd]{Maximum Volume Size}
- \index[sd]{Directive!Maximum Volume Size}
- No more than {\bf size} bytes will be written onto a given volume on the
- archive device. This directive is used mainly in testing Bacula to
- simulate a small Volume. It can also be useful if you wish to limit the
- size of a File Volume to say less than 2GB of data. In some rare cases
- of really antiquated tape drives that do not properly indicate when the
- end of a tape is reached during writing (though I have read about such
- drives, I have never personally encountered one). Please note, this
- directive is deprecated (being phased out) in favor of the {\bf Maximum
- Volume Bytes} defined in the Director's configuration file.
-
-\item [Maximum File Size = {\it size}]
- \index[sd]{Maximum File Size}
- \index[sd]{Directive!Maximum File Size}
- No more than {\bf size} bytes will be written into a given logical file
- on the volume. Once this size is reached, an end of file mark is
- written on the volume and subsequent data are written into the next
- file. Breaking long sequences of data blocks with file marks permits
- quicker positioning to the start of a given stream of data and can
- improve recovery from read errors on the volume. The default is one
- Gigabyte. This directive creates EOF marks only on tape media.
- However, regardless of the medium type (tape, disk, DVD, ...) each time
- a the Maximum File Size is exceeded, a record is put into the catalog
- database that permits seeking to that position on the medium for
- restore operations. If you set this to a small value (e.g. 1MB),
- you will generate lots of database records (JobMedia) and may
- significantly increase CPU/disk overhead.
-
- Note, this directive does not limit the size of Volumes that Bacula
- will create regardless of whether they are tape or disk volumes. It
- changes only the number of EOF marks on a tape and the number of
- block positioning records (see below) that are generated. If you
- want to limit the size of all Volumes for a particular device, use
- the {\bf Maximum Volume Size} directive (above), or use the
- {\bf Maximum Volume Bytes} directive in the Director's Pool resource,
- which does the same thing but on a Pool (Volume) basis.
-
-\item [Block Positioning = {\it yes|no}]
- \index[sd]{Block Positioning}
- \index[sd]{Directive!Block Positioning}
- This directive tells Bacula not to use block positioning when doing restores.
- Turning this directive off can cause Bacula to be {\bf extremely} slow
- when restoring files. You might use this directive if you wrote your
- tapes with Bacula in variable block mode (the default), but your drive
- was in fixed block mode. The default is {\bf yes}.
-
-\item [Maximum Network Buffer Size = {\it bytes}]
- \index[sd]{Maximum Network Buffer Size}
- \index[sd]{Directive!Maximum Network Buffer Size}
- where {\it bytes} specifies the initial network buffer size to use with the
- File daemon. This size will be adjusted down if it is too large until
- it is accepted by the OS. Please use care in setting this value since if
- it is too large, it will be trimmed by 512 bytes until the OS is happy,
- which may require a large number of system calls. The default value is
- 32,768 bytes.
-
- The default size was chosen to be relatively large but not too big in
- the case that you are transmitting data over Internet. It is clear that
- on a high speed local network, you can increase this number and improve
- performance. For example, some users have found that if you use a value
- of 65,536 bytes they get five to ten times the throughput. Larger values for
- most users don't seem to improve performance. If you are interested
- in improving your backup speeds, this is definitely a place to
- experiment. You will probably also want to make the corresponding change
- in each of your File daemons conf files.
-
-
-\item [Maximum Spool Size = {\it bytes}]
- \index[sd]{Maximum Spool Size}
- \index[sd]{Directive!Maximum Spool Size}
- where the bytes specify the maximum spool size for all jobs that are running.
- The default is no limit.
-
-\item [Maximum Job Spool Size = {\it bytes}]
- \index[sd]{Maximum Job Spool Size}
- \index[sd]{Directive!Maximum Job Spool Size}
- where the bytes specify the maximum spool size for any one job that is
- running. The default is no limit.
- This directive is implemented only in version 1.37 and later.
-
-\item [Spool Directory = {\it directory}]
- \index[sd]{Spool Directory}
- \index[sd]{Directive!Spool Directory}
- specifies the name of the directory to be used to store the spool files for
- this device. This directory is also used to store temporary part files when
- writing to a device that requires mount (DVD). The default is to use the
- working directory.
-
-\item [Maximum Part Size = {\it bytes}]
- \index[sd]{Maximum Part Size}
- \index[sd]{Directive!Maximum Part Size}
- This is the maximum size of a volume part file. The default is no limit.
- This directive is implemented only in version 1.37 and later.
-
- If the device requires mount, it is transferred to the device when this size
- is reached. In this case, you must take care to have enough disk space left
- in the spool directory.
-
- Otherwise, it is left on the hard disk.
-
- It is ignored for tape and FIFO devices.
-
-
-\end{description}
-
-\label{mountcodes}
-\section{Edit Codes for Mount and Unmount Directives}
-\index[general]{Directives!Edit Codes}
-\index[general]{Edit Codes for Mount and Unmount Directives }
-
-Before submitting the {\bf Mount Command}, {\bf Unmount Command},
-{\bf Write Part Command}, or {\bf Free Space Command} directives
-to the operating system, Bacula performs character substitution of the
-following characters:
-
-\footnotesize
-\begin{verbatim}
- %% = %
- %a = Archive device name
- %e = erase (set if cannot mount and first part)
- %n = part number
- %m = mount point
- %v = last part name (i.e. filename)
-\end{verbatim}
-\normalsize
-
-
-\section{Devices that require a mount (DVD)}
-\index[general]{Devices that require a mount (DVD)}
-\index[general]{DVD!Devices that require a mount}
-
-All the directives in this section are implemented only in
-Bacula version 1.37 and later and hence are available in version 1.38.6.
-
-As of version 1.39.5, the directives
-"Requires Mount", "Mount Point", "Mount Command", and "Unmount Command"
-apply to removable filesystems such as USB in addition to DVD.
-
-\begin{description}
-
-\item [Requires Mount = {\it Yes|No}]
- \index[sd]{Requires Mount}
- \index[sd]{Directive!Requires Mount}
- You must set this directive to {\bf yes} for DVD-writers, and to {\bf no} for
- all other devices (tapes/files). This directive indicates if the device
- requires to be mounted to be read, and if it must be written in a special way.
- If it set, {\bf Mount Point}, {\bf Mount Command}, {\bf Unmount Command} and
- {\bf Write Part Command} directives must also be defined.
-
-\item [Mount Point = {\it directory}]
- \index[sd]{Mount Point}
- \index[sd]{Directive!Mount Point}
- Directory where the device can be mounted.
-
-\item [Mount Command = {\it name-string}]
- \index[sd]{Mount Command}
- \index[sd]{Directive!Mount Command}
- Command that must be executed to mount the device. Before the command is
- executed, \%a is replaced with the Archive Device, and \%m with the Mount
- Point.
-
- Most frequently, you will define it as follows:
-
-\footnotesize
-\begin{verbatim}
- Mount Command = "/bin/mount -t iso9660 -o ro %a %m"
-\end{verbatim}
-\normalsize
-
-\item [Unmount Command = {\it name-string}]
- \index[sd]{Unmount Command}
- \index[sd]{Directive!Unmount Command}
- Command that must be executed to unmount the device. Before the command is
- executed, \%a is replaced with the Archive Device, and \%m with the Mount
- Point.
-
- Most frequently, you will define it as follows:
-
-\footnotesize
-\begin{verbatim}
- Unmount Command = "/bin/umount %m"
-\end{verbatim}
-\normalsize
-
-\item [Write Part Command = {\it name-string}]
- \index[sd]{Write Part Command}
- \index[sd]{Directive!Write Part Command}
- Command that must be executed to write a part to the device. Before the
- command is executed, \%a is replaced with the Archive Device, \%m with the
- Mount Point, \%e is replaced with 1 if we are writing the first part,
- and with 0 otherwise, and \%v with the current part filename.
-
- For a DVD, you will most frequently specify the Bacula supplied {\bf
- dvd-handler} script as follows:
-
-\footnotesize
-\begin{verbatim}
- Write Part Command = "/path/dvd-handler %a write %e %v"
-\end{verbatim}
-\normalsize
-
- Where {\bf /path} is the path to your scripts install directory, and
- dvd-handler is the Bacula supplied script file.
- This command will already be present, but commented out,
- in the default bacula-sd.conf file. To use it, simply remove
- the comment (\#) symbol.
-
-
-\item [Free Space Command = {\it name-string}]
- \index[sd]{Free Space Command}
- \index[sd]{Directive!Free Space Command}
- Command that must be executed to check how much free space is left on the
- device. Before the command is executed,\%a is replaced with the Archive
- Device, \%m with the Mount Point, \%e is replaced with 1 if we are writing
- the first part, and with 0 otherwise, and \%v with the current part filename.
-
- For a DVD, you will most frequently specify the Bacula supplied {\bf
- dvd-handler} script as follows:
-
-\footnotesize
-\begin{verbatim}
- Free Space Command = "/path/dvd-handler %a free"
-\end{verbatim}
-\normalsize
-
- Where {\bf /path} is the path to your scripts install directory, and
- dvd-handler is the Bacula supplied script file.
- If you want to specify your own command, please look at the code of
- dvd-handler to see what output Bacula expects from this command.
- This command will already be present, but commented out,
- in the default bacula-sd.conf file. To use it, simply remove
- the comment (\#) symbol.
-
- If you do not set it, Bacula will expect there is always free space on the
- device.
-
-\end{description}
-
-%% This pulls in the Autochanger resource from another file.
-\label{AutochangerRes}
-\label{AutochangerResource1}
-\input{autochangerres}
-
-
-
-
-\section{Capabilities}
-\index[general]{Capabilities}
-
-\begin{description}
-
-\item [Label media = {\it Yes|No}]
- \index[sd]{Label media}
- \index[sd]{Directive!Label media}
- If {\bf Yes}, permits this device to automatically label blank media
- without an explicit operator command. It does so by using an internal
- algorithm as defined on the \ilink{Label Format}{Label} record in each
- Pool resource. If this is {\bf No} as by default, Bacula will label
- tapes only by specific operator command ({\bf label} in the Console) or
- when the tape has been recycled. The automatic labeling feature is most
- useful when writing to disk rather than tape volumes.
-
-\item [Automatic mount = {\it Yes|No}]
- \index[sd]{Automatic mount}
- \index[sd]{Directive!Automatic mount}
- If {\bf Yes} (the default), permits the daemon to examine the device to
- determine if it contains a Bacula labeled volume. This is done
- initially when the daemon is started, and then at the beginning of each
- job. This directive is particularly important if you have set
- {\bf Always Open = no} because it permits Bacula to attempt to read the
- device before asking the system operator to mount a tape. However,
- please note that the tape must be mounted before the job begins.
-
-\end{description}
-
-\section{Messages Resource}
-\label{MessagesResource1}
-\index[general]{Resource!Messages}
-\index[general]{Messages Resource}
-
-For a description of the Messages Resource, please see the
-\ilink{Messages Resource}{MessagesChapter} Chapter of this
-manual.
-
-\section{Sample Storage Daemon Configuration File}
-\label{SampleConfiguration}
-\index[general]{File!Sample Storage Daemon Configuration}
-\index[general]{Sample Storage Daemon Configuration File}
-
-A example Storage Daemon configuration file might be the following:
-
-\footnotesize
-\begin{verbatim}
-#
-# Default Bacula Storage Daemon Configuration file
-#
-# For Bacula release 1.37.2 (07 July 2005) -- gentoo 1.4.16
-#
-# You may need to change the name of your tape drive
-# on the "Archive Device" directive in the Device
-# resource. If you change the Name and/or the
-# "Media Type" in the Device resource, please ensure
-# that bacula-dir.conf has corresponding changes.
-#
-Storage { # definition of myself
- Name = rufus-sd
- Address = rufus
- WorkingDirectory = "$HOME/bacula/bin/working"
- Pid Directory = "$HOME/bacula/bin/working"
- Maximum Concurrent Jobs = 20
-}
-#
-# List Directors who are permitted to contact Storage daemon
-#
-Director {
- Name = rufus-dir
- Password = "ZF9Ctf5PQoWCPkmR3s4atCB0usUPg+vWWyIo2VS5ti6k"
-}
-#
-# Restricted Director, used by tray-monitor to get the
-# status of the storage daemon
-#
-Director {
- Name = rufus-mon
- Password = "9usxgc307dMbe7jbD16v0PXlhD64UVasIDD0DH2WAujcDsc6"
- Monitor = yes
-}
-#
-# Devices supported by this Storage daemon
-# To connect, the Director's bacula-dir.conf must have the
-# same Name and MediaType.
-#
-Autochanger {
- Name = Autochanger
- Device = Drive-1
- Device = Drive-2
- Changer Command = "/home/kern/bacula/bin/mtx-changer %c %o %S %a %d"
- Changer Device = /dev/sg0
-}
-
-Device {
- Name = Drive-1 #
- Drive Index = 0
- Media Type = DLT-8000
- Archive Device = /dev/nst0
- AutomaticMount = yes; # when device opened, read it
- AlwaysOpen = yes;
- RemovableMedia = yes;
- RandomAccess = no;
- AutoChanger = yes
- Alert Command = "sh -c 'tapeinfo -f %c |grep TapeAlert|cat'"
-}
-
-Device {
- Name = Drive-2 #
- Drive Index = 1
- Media Type = DLT-8000
- Archive Device = /dev/nst1
- AutomaticMount = yes; # when device opened, read it
- AlwaysOpen = yes;
- RemovableMedia = yes;
- RandomAccess = no;
- AutoChanger = yes
- Alert Command = "sh -c 'tapeinfo -f %c |grep TapeAlert|cat'"
-}
-
-Device {
- Name = "HP DLT 80"
- Media Type = DLT8000
- Archive Device = /dev/nst0
- AutomaticMount = yes; # when device opened, read it
- AlwaysOpen = yes;
- RemovableMedia = yes;
-}
-#Device {
-# Name = SDT-7000 #
-# Media Type = DDS-2
-# Archive Device = /dev/nst0
-# AutomaticMount = yes; # when device opened, read it
-# AlwaysOpen = yes;
-# RemovableMedia = yes;
-#}
-#Device {
-# Name = Floppy
-# Media Type = Floppy
-# Archive Device = /mnt/floppy
-# RemovableMedia = yes;
-# Random Access = Yes;
-# AutomaticMount = yes; # when device opened, read it
-# AlwaysOpen = no;
-#}
-#Device {
-# Name = FileStorage
-# Media Type = File
-# Archive Device = /tmp
-# LabelMedia = yes; # lets Bacula label unlabeled media
-# Random Access = Yes;
-# AutomaticMount = yes; # when device opened, read it
-# RemovableMedia = no;
-# AlwaysOpen = no;
-#}
-#Device {
-# Name = "NEC ND-1300A"
-# Media Type = DVD
-# Archive Device = /dev/hda
-# LabelMedia = yes; # lets Bacula label unlabeled media
-# Random Access = Yes;
-# AutomaticMount = yes; # when device opened, read it
-# RemovableMedia = yes;
-# AlwaysOpen = no;
-# MaximumPartSize = 800M;
-# RequiresMount = yes;
-# MountPoint = /mnt/cdrom;
-# MountCommand = "/bin/mount -t iso9660 -o ro %a %m";
-# UnmountCommand = "/bin/umount %m";
-# SpoolDirectory = /tmp/backup;
-# WritePartCommand = "/etc/bacula/dvd-handler %a write %e %v"
-# FreeSpaceCommand = "/etc/bacula/dvd-handler %a free"
-#}
-#
-# A very old Exabyte with no end of media detection
-#
-#Device {
-# Name = "Exabyte 8mm"
-# Media Type = "8mm"
-# Archive Device = /dev/nst0
-# Hardware end of medium = No;
-# AutomaticMount = yes; # when device opened, read it
-# AlwaysOpen = Yes;
-# RemovableMedia = yes;
-#}
-#
-# Send all messages to the Director,
-# mount messages also are sent to the email address
-#
-Messages {
- Name = Standard
- director = rufus-dir = all
- operator = root = mount
-}
-\end{verbatim}
-\normalsize
+++ /dev/null
-#!/usr/bin/perl -w
-#
-use strict;
-
-# Used to change the names of the image files generated by latex2html from imgxx.png
-# to meaningful names. Provision is made to go either from or to the meaningful names.
-# The meaningful names are obtained from a file called imagename_translations, which
-# is generated by extensions to latex2html in the make_image_file subroutine in
-# bacula.perl.
-
-# Opens the file imagename_translations and reads the contents into a hash.
-# The hash is creaed with the imgxx.png files as the key if processing TO
-# meaningful filenames, and with the meaningful filenames as the key if
-# processing FROM meaningful filenames.
-# Then opens the html file(s) indicated in the command-line arguments and
-# changes all image references according to the translations described in the
-# above file. Finally, it renames the image files.
-#
-# Original creation: 3-27-05 by Karl Cunningham.
-# Modified 5-21-05 to go FROM and TO meaningful filenames.
-#
-my $TRANSFILE = "imagename_translations";
-my $path;
-
-# Loads the contents of $TRANSFILE file into the hash referenced in the first
-# argument. The hash is loaded to translate old to new if $direction is 0,
-# otherwise it is loaded to translate new to old. In this context, the
-# 'old' filename is the meaningful name, and the 'new' filename is the
-# imgxx.png filename. It is assumed that the old image is the one that
-# latex2html has used as the source to create the imgxx.png filename.
-# The filename extension is taken from the file
-sub read_transfile {
- my ($trans,$direction) = @_;
-
- if (!open IN,"<$path$TRANSFILE") {
- print "WARNING: Cannot open image translation file $path$TRANSFILE for reading\n";
- print " Image filename translation aborted\n\n";
- exit 0;
- }
-
- while (<IN>) {
- chomp;
- my ($new,$old) = split(/\001/);
-
- # Old filenames will usually have a leading ./ which we don't need.
- $old =~ s/^\.\///;
-
- # The filename extension of the old filename must be made to match
- # the new filename because it indicates the encoding format of the image.
- my ($ext) = $new =~ /(\.[^\.]*)$/;
- $old =~ s/\.[^\.]*$/$ext/;
- if ($direction == 0) {
- $trans->{$new} = $old;
- } else {
- $trans->{$old} = $new;
- }
- }
- close IN;
-}
-
-# Translates the image names in the file given as the first argument, according to
-# the translations in the hash that is given as the second argument.
-# The file contents are read in entirely into a string, the string is processed, and
-# the file contents are then written. No particular care is taken to ensure that the
-# file is not lost if a system failure occurs at an inopportune time. It is assumed
-# that the html files being processed here can be recreated on demand.
-#
-# Links to other files are added to the %filelist for processing. That way,
-# all linked files will be processed (assuming they are local).
-sub translate_html {
- my ($filename,$trans,$filelist) = @_;
- my ($contents,$out,$this,$img,$dest);
- my $cnt = 0;
-
- # If the filename is an external link ignore it. And drop any file:// from
- # the filename.
- $filename =~ /^(http|ftp|mailto)\:/ and return 0;
- $filename =~ s/^file\:\/\///;
- # Load the contents of the html file.
- if (!open IF,"<$path$filename") {
- print "WARNING: Cannot open $path$filename for reading\n";
- print " Image Filename Translation aborted\n\n";
- exit 0;
- }
-
- while (<IF>) {
- $contents .= $_;
- }
- close IF;
-
- # Now do the translation...
- # First, search for an image filename.
- while ($contents =~ /\<\s*IMG[^\>]*SRC=\"/si) {
- $contents = $';
- $out .= $` . $&;
-
- # The next thing is an image name. Get it and translate it.
- $contents =~ /^(.*?)\"/s;
- $contents = $';
- $this = $&;
- $img = $1;
- # If the image is in our list of ones to be translated, do it
- # and feed the result to the output.
- $cnt += $this =~ s/$img/$trans->{$img}/ if (defined($trans->{$img}));
- $out .= $this;
- }
- $out .= $contents;
-
- # Now send the translated text to the html file, overwriting what's there.
- open OF,">$path$filename" or die "Cannot open $path$filename for writing\n";
- print OF $out;
- close OF;
-
- # Now look for any links to other files and add them to the list of files to do.
- while ($out =~ /\<\s*A[^\>]*HREF=\"(.*?)\"/si) {
- $out = $';
- $dest = $1;
- # Drop an # and anything after it.
- $dest =~ s/\#.*//;
- $filelist->{$dest} = '' if $dest;
- }
- return $cnt;
-}
-
-# REnames the image files spefified in the %translate hash.
-sub rename_images {
- my $translate = shift;
- my ($response);
-
- foreach (keys(%$translate)) {
- if (! $translate->{$_}) {
- print " WARNING: No destination Filename for $_\n";
- } else {
- $response = `mv -f $path$_ $path$translate->{$_} 2>&1`;
- $response and print "ERROR from system $response\n";
- }
- }
-}
-
-#################################################
-############# MAIN #############################
-################################################
-
-# %filelist starts out with keys from the @ARGV list. As files are processed,
-# any links to other files are added to the %filelist. A hash of processed
-# files is kept so we don't do any twice.
-
-# The first argument must be either --to_meaningful_names or --from_meaningful_names
-
-my (%translate,$search_regex,%filelist,%completed,$thisfile);
-my ($cnt,$direction);
-
-my $arg0 = shift(@ARGV);
-$arg0 =~ /^(--to_meaningful_names|--from_meaningful_names)$/ or
- die "ERROR: First argument must be either \'--to_meaningful_names\' or \'--from_meaningful_names\'\n";
-
-$direction = ($arg0 eq '--to_meaningful_names') ? 0 : 1;
-
-(@ARGV) or die "ERROR: Filename(s) to process must be given as arguments\n";
-
-# Use the first argument to get the path to the file of translations.
-my $tmp = $ARGV[0];
-($path) = $tmp =~ /(.*\/)/;
-$path = '' unless $path;
-
-read_transfile(\%translate,$direction);
-
-foreach (@ARGV) {
- # Strip the path from the filename, and use it later on.
- if (s/(.*\/)//) {
- $path = $1;
- } else {
- $path = '';
- }
- $filelist{$_} = '';
-
- while ($thisfile = (keys(%filelist))[0]) {
- $cnt += translate_html($thisfile,\%translate,\%filelist) if (!exists($completed{$thisfile}));
- delete($filelist{$thisfile});
- $completed{$thisfile} = '';
- }
- print "translate_images.pl: $cnt image filenames translated ",($direction)?"from":"to"," meaningful names\n";
-}
-
-rename_images(\%translate);
+++ /dev/null
-#
-#
-# Makefile for LaTeX
-#
-# To build everything do
-# make tex
-# make web
-# make html
-# make dvipdf
-#
-# or simply
-#
-# make
-#
-# for rapid development do:
-# make tex
-# make show
-#
-#
-# If you are having problems getting "make" to work, debugging it is
-# easier if can see the output from latex, which is normally redirected
-# to /dev/null. To see it, do the following:
-#
-# cd docs/manual
-# make tex
-# latex bacula.tex
-#
-# typically the latex command will stop indicating the error (e.g. a
-# missing \ in front of a _ or a missing { or ] ...
-#
-# The following characters must be preceded by a backslash
-# to be entered as printable characters:
-#
-# # $ % & ~ _ ^ \ { }
-#
-
-IMAGES=../../../images
-
-DOC=misc
-
-first_rule: all
-
-all: tex web dvipdf mini-clean
-
-.SUFFIXES: .tex .html
-.PHONY:
-.DONTCARE:
-
-
-tex:
- @./update_version
- @echo "Making version `cat version.tex`"
- @cp -fp ${IMAGES}/hires/*.eps .
- @touch ${DOC}i-dir.tex ${DOC}i-fd.tex ${DOC}i-sd.tex \
- ${DOC}i-console.tex ${DOC}i-general.tex
- latex -interaction=batchmode ${DOC}.tex
- makeindex ${DOC}.idx -o ${DOC}.ind 2>/dev/null
- latex -interaction=batchmode ${DOC}.tex
-
-pdf:
- @echo "Making pdfm"
- @cp -fp ${IMAGES}/hires/*.eps .
- dvipdfm -p a4 ${DOC}.dvi
-
-dvipdf:
- @echo "Making dvi to pdf"
- @cp -fp ${IMAGES}/hires/*.eps .
- dvipdf ${DOC}.dvi ${DOC}.pdf
-
-html:
- @echo " "
- @echo "Making html"
- @cp -fp ${IMAGES}/*.eps .
- @rm -f next.eps next.png prev.eps prev.png up.eps up.png
- @(if [ -f imagename_translations ] ; then \
- ./translate_images.pl --from_meaningful_names ${DOC}.html; \
- fi)
- latex2html -white -no_subdir -split 0 -toc_stars -white \
- -init_file latex2html-init.pl ${DOC} >tex.out 2>&1
- ./translate_images.pl --to_meaningful_names ${DOC}.html
- (cd ${DOC}; for i in *.png ; do cp -fp ../${IMAGES}/$${i} . 2>/dev/null; done)
- @echo "Done making html"
-
-web:
- @echo "Making web"
- @mkdir -p ${DOC}
- @cp -fp ${IMAGES}/*.eps .
- @rm -f next.eps next.png prev.eps prev.png up.eps up.png
- @cp -fp ${IMAGES}/*.eps ${DOC}/
- @cp -fp ${IMAGES}/*.eps ${IMAGES}/*.png ${DOC}/
- @rm -f ${DOC}/xp-*.png
- @rm -f ${DOC}/next.eps ${DOC}/next.png ${DOC}/prev.eps ${DOC}/prev.png ${DOC}/up.eps ${DOC}/up.png
- @rm -rf ${DOC}/*.html
- latex2html -split 3 -local_icons -t "Miscellaneous Guide" -long_titles 4 \
- -toc_stars -contents_in_nav -init_file latex2html-init.pl -white ${DOC} >tex.out 2>&1
- ./translate_images.pl --to_meaningful_names ${DOC}/Miscel_Guide.html
- (cd ${DOC}; for i in *.png ; do cp -fp ../${IMAGES}/$${i} . 2>/dev/null; done)
- @echo "Done making web"
-show:
- xdvi ${DOC}
-
-texcheck:
- ./check_tex.pl ${DOC}.tex
-
-main_configs:
- pic2graph -density 100 <main_configs.pic >main_configs.png
-
-mini-clean:
- @rm -f 1 2 3 *.tex~
- @rm -f *.gif *.jpg *.eps
- @rm -f *.aux *.cp *.fn *.ky *.log *.pg
- @rm -f *.backup *.ilg *.lof *.lot
- @rm -f *.cdx *.cnd *.ddx *.ddn *.fdx *.fnd *.ind *.sdx *.snd
- @rm -f *.dnd *.old *.out
- @rm -f ${DOC}/*.gif ${DOC}/*.jpg ${DOC}/*.eps
- @rm -f ${DOC}/*.aux ${DOC}/*.cp ${DOC}/*.fn ${DOC}/*.ky ${DOC}/*.log ${DOC}/*.pg
- @rm -f ${DOC}/*.backup ${DOC}/*.ilg ${DOC}/*.lof ${DOC}/*.lot
- @rm -f ${DOC}/*.cdx ${DOC}/*.cnd ${DOC}/*.ddx ${DOC}/*.ddn ${DOC}/*.fdx ${DOC}/*.fnd ${DOC}/*.ind ${DOC}/*.sdx ${DOC}/*.snd
- @rm -f ${DOC}/*.dnd ${DOC}/*.old ${DOC}/*.out
- @rm -f ${DOC}/WARNINGS
-
-
-clean:
- @rm -f 1 2 3 *.tex~
- @rm -f *.png *.gif *.jpg *.eps
- @rm -f *.pdf *.aux *.cp *.fn *.ky *.log *.pg
- @rm -f *.html *.backup *.ps *.dvi *.ilg *.lof *.lot
- @rm -f *.cdx *.cnd *.ddx *.ddn *.fdx *.fnd *.ind *.sdx *.snd
- @rm -f *.dnd imagename_translations
- @rm -f *.old WARNINGS *.out *.toc *.idx
- @rm -f ${DOC}i-*.tex
- @rm -rf ${DOC}
-
-
-distclean: clean
- @rm -f images.pl labels.pl internals.pl
- @rm -f Makefile version.tex
+++ /dev/null
-\newfont{\bighead}{cmr17 at 36pt}
-\parskip 10pt
-\parindent 0pt
-
-\title{\includegraphics{\idir bacula-logo.eps} \\ \bigskip
- \Huge{Bacula}$^{\normalsize \textregistered}$ \Huge{Miscellaneous Guide}
- \begin{center}
- \large{It comes in the night and sucks
- the essence from your computers. }
- \end{center}
-}
-
-
-\author{Kern Sibbald}
-\date{\vspace{1.0in}\today \\
- This manual documents Bacula version \fullversion \\
- \vspace{0.2in}
- Copyright {\copyright} 1999-2009, Free Software Foundation Europe
- e.V. \\
- Bacula {\textregistered} is a registered trademark of Kern Sibbald.\\
- \vspace{0.2in}
- Permission is granted to copy, distribute and/or modify this document under the terms of the
- GNU Free Documentation License, Version 1.2 published by the Free Software Foundation;
- with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
- A copy of the license is included in the section entitled "GNU Free Documentation License".
-}
-
-\maketitle
+++ /dev/null
-#
-# Avoid that @VERSION@ and @DATE@ are changed by configure
-# This file is sourced by update_version
-#
-echo "s%@VERSION@%${VERSION}%g" >${out}
-echo "s%@DATE@%${DATE}%g" >>${out}
+++ /dev/null
-%%
-%%
-
-\chapter{DVD Volumes}
-\label{_DVDChapterStart}
-\index[general]{DVD Volumes}
-\index[general]{Writing DVDs}
-\index[general]{DVD Writing}
-\index[general]{Volumes!DVD}
-
-Bacula allows you to specify that you want to write to DVD. However,
-this feature is implemented only in version 1.37 or later.
-You may in fact write to DVD+RW, DVD+R, DVD-R, or DVD-RW
-media. The actual process used by Bacula is to first write
-the image to a spool directory, then when the Volume reaches
-a certain size or, at your option, at the end of a Job, Bacula
-will transfer the image from the spool directory to the
-DVD. The actual work of transferring the image is done
-by a script {\bf dvd-handler}, and the heart of that
-script is a program called {\bf growisofs} which allows
-creating or adding to a DVD ISO filesystem.
-
-You must have {\bf dvd+rw-tools} loaded on your system for DVD writing to
-work. Please note that the original {\bf dvd+rw-tools} package does {\bf
-NOT} work with Bacula. You must apply a patch which can be found in the
-{\bf patches} directory of Bacula sources with the name
-{\bf dvd+rw-tools-5.21.4.10.8.bacula.patch} for version 5.21 of the tools,
-or patch {bf dvd+rw-tools-6.1.bacula.patch} if you have version 6.1
-on your system. Unfortunately, this requires you to build the dvd\_rw-tools
-from source.
-
-Note, some Linux distros such as Debian dvd+rw-tools-7.0-4 package already
-have the patch applied, so please check.
-
-The fact that Bacula cannot use the OS to write directly
-to the DVD makes the whole process a bit more error prone than
-writing to a disk or a tape, but nevertheless, it does work if you
-use some care to set it up properly. However, at the current time
-(version 1.39.30 -- 12 December 2006) we still consider this code to be
-BETA quality. As a consequence, please do careful testing before relying
-on DVD backups in production.
-
-The remainder of this chapter explains the various directives that you can
-use to control the DVD writing.
-
-\label{DVDdirectives}
-\section{DVD Specific SD Directives}
-\index[general]{Directives!DVD}
-\index[general]{DVD Specific SD Directives }
-
-The following directives are added to the Storage daemon's
-Device resource.
-
-\begin{description}
-
-\item [Requires Mount = {\it Yes|No}]
- \index[general]{Requires Mount }
- You must set this directive to {\bf yes} for DVD-writers, and to {\bf no} for
- all other devices (tapes/files). This directive indicates if the device
- requires to be mounted using the {\bf Mount Command}.
- To be able to write a DVD, the following directives must also be
- defined: {\bf Mount Point}, {\bf Mount Command}, {\bf Unmount Command} and
- {\bf Write Part Command}.
-
-\item [Mount Point = {\it directory}]
- \index[general]{Mount Point}
- Directory where the device can be mounted.
-
-\item [Mount Command = {\it name-string}]
- \index[general]{Mount Command}
- Command that must be executed to mount the device. Although the
- device is written directly, the mount command is necessary in
- order to determine the free space left on the DVD. Before the command is
- executed, \%a is replaced with the Archive Device, and \%m with the Mount
- Point.
-
- Most frequently, you will define it as follows:
-
-\footnotesize
-\begin{verbatim}
- Mount Command = "/bin/mount -t iso9660 -o ro %a %m"
-\end{verbatim}
-\normalsize
-
-However, if you have defined a mount point in /etc/fstab, you might be
-able to use a mount command such as:
-
-\footnotesize
-\begin{verbatim}
- Mount Command = "/bin/mount /media/dvd"
-\end{verbatim}
-\normalsize
-
-
-\item [Unmount Command = {\it name-string}]
- \index[general]{Unmount Command}
- Command that must be executed to unmount the device. Before the command is
- executed, \%a is replaced with the Archive Device, and \%m with the Mount
- Point.
-
- Most frequently, you will define it as follows:
-
-\footnotesize
-\begin{verbatim}
- Unmount Command = "/bin/umount %m"
-\end{verbatim}
-\normalsize
-
-\item [Write Part Command = {\it name-string}]
- \index[general]{Write Part Command }
- Command that must be executed to write a part to the device. Before the
- command is executed, \%a is replaced with the Archive Device, \%m with the
- Mount Point, \%e is replaced with 1 if we are writing the first part,
- and with 0 otherwise, and \%v with the current part filename.
-
- For a DVD, you will most frequently specify the Bacula supplied {\bf
- dvd-handler} script as follows:
-
-\footnotesize
-\begin{verbatim}
- Write Part Command = "/path/dvd-handler %a write %e %v"
-\end{verbatim}
-\normalsize
-
- Where {\bf /path} is the path to your scripts install directory, and
- dvd-handler is the Bacula supplied script file.
- This command will already be present, but commented out,
- in the default bacula-sd.conf file. To use it, simply remove
- the comment (\#) symbol.
-
-
-\item [Free Space Command = {\it name-string}]
- \index[general]{Free Space Command }
- Command that must be executed to check how much free space is left on the
- device. Before the command is executed,\%a is replaced with the Archive
- Device.
-
- For a DVD, you will most frequently specify the Bacula supplied {\bf
- dvd-handler} script as follows:
-
-\footnotesize
-\begin{verbatim}
- Free Space Command = "/path/dvd-handler %a free"
-\end{verbatim}
-\normalsize
-
- Where {\bf /path} is the path to your scripts install directory, and
- dvd-handler is the Bacula supplied script file.
- If you want to specify your own command, please look at the code in
- dvd-handler to see what output Bacula expects from this command.
- This command will already be present, but commented out,
- in the default bacula-sd.conf file. To use it, simply remove
- the comment (\#) symbol.
-
- If you do not set it, Bacula will expect there is always free space on the
- device.
-
-\end{description}
-
-In addition to the directives specified above, you must also
-specify the other standard Device resource directives. Please see the
-sample DVD Device resource in the default bacula-sd.conf file. Be sure
-to specify the raw device name for {\bf Archive Device}. It should
-be a name such as {\bf /dev/cdrom} or {\bf /media/cdrecorder} or
-{\bf /dev/dvd} depending on your system. It will not be a name such
-as {\bf /mnt/cdrom}.
-
-Finally, for {\bf growisofs} to work, it must be able to lock
-a certain amount of memory in RAM. If you have restrictions on
-this function, you may have failures. Under {\bf bash}, you can
-set this with the following command:
-
-\footnotesize
-\begin{verbatim}
-ulimit -l unlimited
-\end{verbatim}
-\normalsize
-
-\section{Edit Codes for DVD Directives}
-\index[general]{Directives!DVD Edit Codes}
-\index[general]{Edit Codes for DVD Directives }
-
-Before submitting the {\bf Mount Command}, {\bf Unmount Command},
-{\bf Write Part Command}, or {\bf Free Space Command} directives
-to the operating system, Bacula performs character substitution of the
-following characters:
-
-\footnotesize
-\begin{verbatim}
- %% = %
- %a = Archive device name
- %e = erase (set if cannot mount and first part)
- %n = part number
- %m = mount point
- %v = last part name (i.e. filename)
-\end{verbatim}
-\normalsize
-
-
-
-\section{DVD Specific Director Directives}
-\index[general]{Directives!DVD}
-\index[general]{DVD Specific Director Directives }
-
-The following directives are added to the Director's Job resource.
-
-\label{WritePartAfterJob}
-\begin{description}
-\item [Write Part After Job = \lt{}yes|no\gt{}]
- \index[general]{Write Part After Job }
- If this directive is set to {\bf yes} (default {\bf no}), the
- Volume written to a temporary spool file for the current Job will
- be written to the DVD as a new part file
- will be created after the job is finished.
-
- It should be set to {\bf yes} when writing to devices that require a mount
- (for example DVD), so you are sure that the current part, containing
- this job's data, is written to the device, and that no data is left in
- the temporary file on the hard disk. However, on some media, like DVD+R
- and DVD-R, a lot of space (about 10Mb) is lost everytime a part is
- written. So, if you run several jobs each after another, you could set
- this directive to {\bf no} for all jobs, except the last one, to avoid
- wasting too much space, but to ensure that the data is written to the
- medium when all jobs are finished.
-
- This directive is ignored for devices other than DVDs.
-\end{description}
-
-
-
-\label{DVDpoints}
-\section{Other Points}
-\index[general]{Points!Other }
-\index[general]{Other Points }
-
-\begin{itemize}
-\item Please be sure that you have any automatic DVD mounting
- disabled before running Bacula -- this includes auto mounting
- in /etc/fstab, hotplug, ... If the DVD is automatically
- mounted by the OS, it will cause problems when Bacula tries
- to mount/unmount the DVD.
-\item Please be sure that you the directive {\bf Write Part After Job}
- set to {\bf yes}, otherwise the last part of the data to be
- written will be left in the DVD spool file and not written to
- the DVD. The DVD will then be unreadable until this last part
- is written. If you have a series of jobs that are run one at
- a time, you can turn this off until the last job is run.
-\item The current code is not designed to have multiple simultaneous
- jobs writing to the DVD. As a consequence, please ensure that
- only one DVD backup job runs at any time.
-\item Writing and reading of DVD+RW seems to work quite reliably
- provided you are using the patched dvd+rw-mediainfo programs.
- On the other hand, we do not have enough information to ensure
- that DVD-RW or other forms of DVDs work correctly.
-\item DVD+RW supports only about 1000 overwrites. Every time you
- mount the filesystem read/write will count as one write. This can
- add up quickly, so it is best to mount your DVD+RW filesystem read-only.
- Bacula does not need the DVD to be mounted read-write, since it uses
- the raw device for writing.
-\item Reformatting DVD+RW 10-20 times can apparently make the medium
- unusable. Normally you should not have to format or reformat
- DVD+RW media. If it is necessary, current versions of growisofs will
- do so automatically.
-\item We have had several problems writing to DVD-RWs (this does NOT
- concern DVD+RW), because these media have two writing-modes: {\bf
- Incremental Sequential} and {\bf Restricted Overwrite}. Depending on
- your device and the media you use, one of these modes may not work
- correctly (e.g. {\bf Incremental Sequential} does not work with my NEC
- DVD-writer and Verbatim DVD-RW).
-
- To retrieve the current mode of a DVD-RW, run:
-\begin{verbatim}
- dvd+rw-mediainfo /dev/xxx
-\end{verbatim}
- where you replace xxx with your DVD device name.
-
- {\bf Mounted Media} line should give you the information.
-
- To set the device to {\bf Restricted Overwrite} mode, run:
-\begin{verbatim}
- dvd+rw-format /dev/xxx
-\end{verbatim}
- If you want to set it back to the default {\bf Incremental Sequential} mode, run:
-\begin{verbatim}
- dvd+rw-format -blank /dev/xxx
-\end{verbatim}
-
-\item Bacula only accepts to write to blank DVDs. To quickly blank a DVD+/-RW, run
- this command:
-\begin{verbatim}
- dd if=/dev/zero bs=1024 count=512 | growisofs -Z /dev/xxx=/dev/fd/0
-\end{verbatim}
- Then, try to mount the device, if it cannot be mounted, it will be considered
- as blank by Bacula, if it can be mounted, try a full blank (see below).
-
-\item If you wish to blank completely a DVD+/-RW, use the following:
-\begin{verbatim}
- growisofs -Z /dev/xxx=/dev/zero
-\end{verbatim}
- where you replace xxx with your DVD device name. However, note that this
- blanks the whole DVD, which takes quite a long time (16 minutes on mine).
-\item DVD+RW and DVD-RW support only about 1000 overwrites (i.e. don't use the
-same medium for years if you don't want to have problems...).
-
-To write to the DVD the first time use:
-\begin{verbatim}
- growisofs -Z /dev/xxx filename
-\end{verbatim}
-
-To add additional files (more parts use):
-
-\begin{verbatim}
- growisofs -M /dev/xxx filename
-\end{verbatim}
-
-The option {\bf -use-the-force-luke=4gms} was added in growisofs 5.20 to
-override growisofs' behavior of always checking for the 4GB limit.
-Normally, this option is recommended for all Linux 2.6.8 kernels or
-greater, since these newer kernels can handle writing more than 4GB.
-See below for more details on this subject.
-
-\item For more information about DVD writing, please look at the
-\elink{dvd+rw-tools homepage}{http://fy.chalmers.se/~appro/linux/DVD+RW/}.
-
-\item According to bug \#912, bscan cannot read multi-volume DVDs. This is
-on our TODO list, but unless someone submits a patch it is not likely to be
-done any time in the near future. (9 Sept 2007).
-
-\end{itemize}
+++ /dev/null
-% TODO: maybe get rid of centering
-
-\chapter{GNU Free Documentation License}
-\index[general]{GNU Free Documentation License}
-\index[general]{License!GNU Free Documentation}
-
-\label{label_fdl}
-
- \begin{center}
-
- Version 1.2, November 2002
-
-
- Copyright \copyright 2000,2001,2002 Free Software Foundation, Inc.
-
- \bigskip
-
- 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-
- \bigskip
-
- Everyone is permitted to copy and distribute verbatim copies
- of this license document, but changing it is not allowed.
-\end{center}
-
-
-\begin{center}
-{\bf\large Preamble}
-\end{center}
-
-The purpose of this License is to make a manual, textbook, or other
-functional and useful document "free" in the sense of freedom: to
-assure everyone the effective freedom to copy and redistribute it,
-with or without modifying it, either commercially or noncommercially.
-Secondarily, this License preserves for the author and publisher a way
-to get credit for their work, while not being considered responsible
-for modifications made by others.
-
-This License is a kind of "copyleft", which means that derivative
-works of the document must themselves be free in the same sense. It
-complements the GNU General Public License, which is a copyleft
-license designed for free software.
-
-We have designed this License in order to use it for manuals for free
-software, because free software needs free documentation: a free
-program should come with manuals providing the same freedoms that the
-software does. But this License is not limited to software manuals;
-it can be used for any textual work, regardless of subject matter or
-whether it is published as a printed book. We recommend this License
-principally for works whose purpose is instruction or reference.
-
-
-\begin{center}
-{\Large\bf 1. APPLICABILITY AND DEFINITIONS}
-\end{center}
-
-This License applies to any manual or other work, in any medium, that
-contains a notice placed by the copyright holder saying it can be
-distributed under the terms of this License. Such a notice grants a
-world-wide, royalty-free license, unlimited in duration, to use that
-work under the conditions stated herein. The \textbf{"Document"}, below,
-refers to any such manual or work. Any member of the public is a
-licensee, and is addressed as \textbf{"you"}. You accept the license if you
-copy, modify or distribute the work in a way requiring permission
-under copyright law.
-
-A \textbf{"Modified Version"} of the Document means any work containing the
-Document or a portion of it, either copied verbatim, or with
-modifications and/or translated into another language.
-
-A \textbf{"Secondary Section"} is a named appendix or a front-matter section of
-the Document that deals exclusively with the relationship of the
-publishers or authors of the Document to the Document's overall subject
-(or to related matters) and contains nothing that could fall directly
-within that overall subject. (Thus, if the Document is in part a
-textbook of mathematics, a Secondary Section may not explain any
-mathematics.) The relationship could be a matter of historical
-connection with the subject or with related matters, or of legal,
-commercial, philosophical, ethical or political position regarding
-them.
-
-The \textbf{"Invariant Sections"} are certain Secondary Sections whose titles
-are designated, as being those of Invariant Sections, in the notice
-that says that the Document is released under this License. If a
-section does not fit the above definition of Secondary then it is not
-allowed to be designated as Invariant. The Document may contain zero
-Invariant Sections. If the Document does not identify any Invariant
-Sections then there are none.
-
-The \textbf{"Cover Texts"} are certain short passages of text that are listed,
-as Front-Cover Texts or Back-Cover Texts, in the notice that says that
-the Document is released under this License. A Front-Cover Text may
-be at most 5 words, and a Back-Cover Text may be at most 25 words.
-
-A \textbf{"Transparent"} copy of the Document means a machine-readable copy,
-represented in a format whose specification is available to the
-general public, that is suitable for revising the document
-straightforwardly with generic text editors or (for images composed of
-pixels) generic paint programs or (for drawings) some widely available
-drawing editor, and that is suitable for input to text formatters or
-for automatic translation to a variety of formats suitable for input
-to text formatters. A copy made in an otherwise Transparent file
-format whose markup, or absence of markup, has been arranged to thwart
-or discourage subsequent modification by readers is not Transparent.
-An image format is not Transparent if used for any substantial amount
-of text. A copy that is not "Transparent" is called \textbf{"Opaque"}.
-
-Examples of suitable formats for Transparent copies include plain
-ASCII without markup, Texinfo input format, LaTeX input format, SGML
-or XML using a publicly available DTD, and standard-conforming simple
-HTML, PostScript or PDF designed for human modification. Examples of
-transparent image formats include PNG, XCF and JPG. Opaque formats
-include proprietary formats that can be read and edited only by
-proprietary word processors, SGML or XML for which the DTD and/or
-processing tools are not generally available, and the
-machine-generated HTML, PostScript or PDF produced by some word
-processors for output purposes only.
-
-The \textbf{"Title Page"} means, for a printed book, the title page itself,
-plus such following pages as are needed to hold, legibly, the material
-this License requires to appear in the title page. For works in
-formats which do not have any title page as such, "Title Page" means
-the text near the most prominent appearance of the work's title,
-preceding the beginning of the body of the text.
-
-A section \textbf{"Entitled XYZ"} means a named subunit of the Document whose
-title either is precisely XYZ or contains XYZ in parentheses following
-text that translates XYZ in another language. (Here XYZ stands for a
-specific section name mentioned below, such as \textbf{"Acknowledgements"},
-\textbf{"Dedications"}, \textbf{"Endorsements"}, or \textbf{"History"}.)
-To \textbf{"Preserve the Title"}
-of such a section when you modify the Document means that it remains a
-section "Entitled XYZ" according to this definition.
-
-The Document may include Warranty Disclaimers next to the notice which
-states that this License applies to the Document. These Warranty
-Disclaimers are considered to be included by reference in this
-License, but only as regards disclaiming warranties: any other
-implication that these Warranty Disclaimers may have is void and has
-no effect on the meaning of this License.
-
-
-\begin{center}
-{\Large\bf 2. VERBATIM COPYING}
-\end{center}
-
-You may copy and distribute the Document in any medium, either
-commercially or noncommercially, provided that this License, the
-copyright notices, and the license notice saying this License applies
-to the Document are reproduced in all copies, and that you add no other
-conditions whatsoever to those of this License. You may not use
-technical measures to obstruct or control the reading or further
-copying of the copies you make or distribute. However, you may accept
-compensation in exchange for copies. If you distribute a large enough
-number of copies you must also follow the conditions in section 3.
-
-You may also lend copies, under the same conditions stated above, and
-you may publicly display copies.
-
-
-\begin{center}
-{\Large\bf 3. COPYING IN QUANTITY}
-\end{center}
-
-
-If you publish printed copies (or copies in media that commonly have
-printed covers) of the Document, numbering more than 100, and the
-Document's license notice requires Cover Texts, you must enclose the
-copies in covers that carry, clearly and legibly, all these Cover
-Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
-the back cover. Both covers must also clearly and legibly identify
-you as the publisher of these copies. The front cover must present
-the full title with all words of the title equally prominent and
-visible. You may add other material on the covers in addition.
-Copying with changes limited to the covers, as long as they preserve
-the title of the Document and satisfy these conditions, can be treated
-as verbatim copying in other respects.
-
-If the required texts for either cover are too voluminous to fit
-legibly, you should put the first ones listed (as many as fit
-reasonably) on the actual cover, and continue the rest onto adjacent
-pages.
-
-If you publish or distribute Opaque copies of the Document numbering
-more than 100, you must either include a machine-readable Transparent
-copy along with each Opaque copy, or state in or with each Opaque copy
-a computer-network location from which the general network-using
-public has access to download using public-standard network protocols
-a complete Transparent copy of the Document, free of added material.
-If you use the latter option, you must take reasonably prudent steps,
-when you begin distribution of Opaque copies in quantity, to ensure
-that this Transparent copy will remain thus accessible at the stated
-location until at least one year after the last time you distribute an
-Opaque copy (directly or through your agents or retailers) of that
-edition to the public.
-
-It is requested, but not required, that you contact the authors of the
-Document well before redistributing any large number of copies, to give
-them a chance to provide you with an updated version of the Document.
-
-
-\begin{center}
-{\Large\bf 4. MODIFICATIONS}
-\end{center}
-
-You may copy and distribute a Modified Version of the Document under
-the conditions of sections 2 and 3 above, provided that you release
-the Modified Version under precisely this License, with the Modified
-Version filling the role of the Document, thus licensing distribution
-and modification of the Modified Version to whoever possesses a copy
-of it. In addition, you must do these things in the Modified Version:
-
-\begin{itemize}
-\item[A.]
- Use in the Title Page (and on the covers, if any) a title distinct
- from that of the Document, and from those of previous versions
- (which should, if there were any, be listed in the History section
- of the Document). You may use the same title as a previous version
- if the original publisher of that version gives permission.
-
-\item[B.]
- List on the Title Page, as authors, one or more persons or entities
- responsible for authorship of the modifications in the Modified
- Version, together with at least five of the principal authors of the
- Document (all of its principal authors, if it has fewer than five),
- unless they release you from this requirement.
-
-\item[C.]
- State on the Title page the name of the publisher of the
- Modified Version, as the publisher.
-
-\item[D.]
- Preserve all the copyright notices of the Document.
-
-\item[E.]
- Add an appropriate copyright notice for your modifications
- adjacent to the other copyright notices.
-
-\item[F.]
- Include, immediately after the copyright notices, a license notice
- giving the public permission to use the Modified Version under the
- terms of this License, in the form shown in the Addendum below.
-
-\item[G.]
- Preserve in that license notice the full lists of Invariant Sections
- and required Cover Texts given in the Document's license notice.
-
-\item[H.]
- Include an unaltered copy of this License.
-
-\item[I.]
- Preserve the section Entitled "History", Preserve its Title, and add
- to it an item stating at least the title, year, new authors, and
- publisher of the Modified Version as given on the Title Page. If
- there is no section Entitled "History" in the Document, create one
- stating the title, year, authors, and publisher of the Document as
- given on its Title Page, then add an item describing the Modified
- Version as stated in the previous sentence.
-
-\item[J.]
- Preserve the network location, if any, given in the Document for
- public access to a Transparent copy of the Document, and likewise
- the network locations given in the Document for previous versions
- it was based on. These may be placed in the "History" section.
- You may omit a network location for a work that was published at
- least four years before the Document itself, or if the original
- publisher of the version it refers to gives permission.
-
-\item[K.]
- For any section Entitled "Acknowledgements" or "Dedications",
- Preserve the Title of the section, and preserve in the section all
- the substance and tone of each of the contributor acknowledgements
- and/or dedications given therein.
-
-\item[L.]
- Preserve all the Invariant Sections of the Document,
- unaltered in their text and in their titles. Section numbers
- or the equivalent are not considered part of the section titles.
-
-\item[M.]
- Delete any section Entitled "Endorsements". Such a section
- may not be included in the Modified Version.
-
-\item[N.]
- Do not retitle any existing section to be Entitled "Endorsements"
- or to conflict in title with any Invariant Section.
-
-\item[O.]
- Preserve any Warranty Disclaimers.
-\end{itemize}
-
-If the Modified Version includes new front-matter sections or
-appendices that qualify as Secondary Sections and contain no material
-copied from the Document, you may at your option designate some or all
-of these sections as invariant. To do this, add their titles to the
-list of Invariant Sections in the Modified Version's license notice.
-These titles must be distinct from any other section titles.
-
-You may add a section Entitled "Endorsements", provided it contains
-nothing but endorsements of your Modified Version by various
-parties--for example, statements of peer review or that the text has
-been approved by an organization as the authoritative definition of a
-standard.
-
-You may add a passage of up to five words as a Front-Cover Text, and a
-passage of up to 25 words as a Back-Cover Text, to the end of the list
-of Cover Texts in the Modified Version. Only one passage of
-Front-Cover Text and one of Back-Cover Text may be added by (or
-through arrangements made by) any one entity. If the Document already
-includes a cover text for the same cover, previously added by you or
-by arrangement made by the same entity you are acting on behalf of,
-you may not add another; but you may replace the old one, on explicit
-permission from the previous publisher that added the old one.
-
-The author(s) and publisher(s) of the Document do not by this License
-give permission to use their names for publicity for or to assert or
-imply endorsement of any Modified Version.
-
-
-\begin{center}
-{\Large\bf 5. COMBINING DOCUMENTS}
-\end{center}
-
-
-You may combine the Document with other documents released under this
-License, under the terms defined in section 4 above for modified
-versions, provided that you include in the combination all of the
-Invariant Sections of all of the original documents, unmodified, and
-list them all as Invariant Sections of your combined work in its
-license notice, and that you preserve all their Warranty Disclaimers.
-
-The combined work need only contain one copy of this License, and
-multiple identical Invariant Sections may be replaced with a single
-copy. If there are multiple Invariant Sections with the same name but
-different contents, make the title of each such section unique by
-adding at the end of it, in parentheses, the name of the original
-author or publisher of that section if known, or else a unique number.
-Make the same adjustment to the section titles in the list of
-Invariant Sections in the license notice of the combined work.
-
-In the combination, you must combine any sections Entitled "History"
-in the various original documents, forming one section Entitled
-"History"; likewise combine any sections Entitled "Acknowledgements",
-and any sections Entitled "Dedications". You must delete all sections
-Entitled "Endorsements".
-
-\begin{center}
-{\Large\bf 6. COLLECTIONS OF DOCUMENTS}
-\end{center}
-
-You may make a collection consisting of the Document and other documents
-released under this License, and replace the individual copies of this
-License in the various documents with a single copy that is included in
-the collection, provided that you follow the rules of this License for
-verbatim copying of each of the documents in all other respects.
-
-You may extract a single document from such a collection, and distribute
-it individually under this License, provided you insert a copy of this
-License into the extracted document, and follow this License in all
-other respects regarding verbatim copying of that document.
-
-
-\begin{center}
-{\Large\bf 7. AGGREGATION WITH INDEPENDENT WORKS}
-\end{center}
-
-
-A compilation of the Document or its derivatives with other separate
-and independent documents or works, in or on a volume of a storage or
-distribution medium, is called an "aggregate" if the copyright
-resulting from the compilation is not used to limit the legal rights
-of the compilation's users beyond what the individual works permit.
-When the Document is included in an aggregate, this License does not
-apply to the other works in the aggregate which are not themselves
-derivative works of the Document.
-
-If the Cover Text requirement of section 3 is applicable to these
-copies of the Document, then if the Document is less than one half of
-the entire aggregate, the Document's Cover Texts may be placed on
-covers that bracket the Document within the aggregate, or the
-electronic equivalent of covers if the Document is in electronic form.
-Otherwise they must appear on printed covers that bracket the whole
-aggregate.
-
-
-\begin{center}
-{\Large\bf 8. TRANSLATION}
-\end{center}
-
-
-Translation is considered a kind of modification, so you may
-distribute translations of the Document under the terms of section 4.
-Replacing Invariant Sections with translations requires special
-permission from their copyright holders, but you may include
-translations of some or all Invariant Sections in addition to the
-original versions of these Invariant Sections. You may include a
-translation of this License, and all the license notices in the
-Document, and any Warranty Disclaimers, provided that you also include
-the original English version of this License and the original versions
-of those notices and disclaimers. In case of a disagreement between
-the translation and the original version of this License or a notice
-or disclaimer, the original version will prevail.
-
-If a section in the Document is Entitled "Acknowledgements",
-"Dedications", or "History", the requirement (section 4) to Preserve
-its Title (section 1) will typically require changing the actual
-title.
-
-
-\begin{center}
-{\Large\bf 9. TERMINATION}
-\end{center}
-
-
-You may not copy, modify, sublicense, or distribute the Document except
-as expressly provided for under this License. Any other attempt to
-copy, modify, sublicense or distribute the Document is void, and will
-automatically terminate your rights under this License. However,
-parties who have received copies, or rights, from you under this
-License will not have their licenses terminated so long as such
-parties remain in full compliance.
-
-
-\begin{center}
-{\Large\bf 10. FUTURE REVISIONS OF THIS LICENSE}
-\end{center}
-
-
-The Free Software Foundation may publish new, revised versions
-of the GNU Free Documentation License from time to time. Such new
-versions will be similar in spirit to the present version, but may
-differ in detail to address new problems or concerns. See
-http://www.gnu.org/copyleft/.
-
-Each version of the License is given a distinguishing version number.
-If the Document specifies that a particular numbered version of this
-License "or any later version" applies to it, you have the option of
-following the terms and conditions either of that specified version or
-of any later version that has been published (not as a draft) by the
-Free Software Foundation. If the Document does not specify a version
-number of this License, you may choose any version ever published (not
-as a draft) by the Free Software Foundation.
-
-
-\begin{center}
-{\Large\bf ADDENDUM: How to use this License for your documents}
-% TODO: this is too long for table of contents
-\end{center}
-
-To use this License in a document you have written, include a copy of
-the License in the document and put the following copyright and
-license notices just after the title page:
-
-\bigskip
-\begin{quote}
- Copyright \copyright YEAR YOUR NAME.
- Permission is granted to copy, distribute and/or modify this document
- under the terms of the GNU Free Documentation License, Version 1.2
- or any later version published by the Free Software Foundation;
- with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
- A copy of the license is included in the section entitled "GNU
- Free Documentation License".
-\end{quote}
-\bigskip
-
-If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts,
-replace the "with...Texts." line with this:
-
-\bigskip
-\begin{quote}
- with the Invariant Sections being LIST THEIR TITLES, with the
- Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST.
-\end{quote}
-\bigskip
-
-If you have Invariant Sections without Cover Texts, or some other
-combination of the three, merge those two alternatives to suit the
-situation.
-
-If your document contains nontrivial examples of program code, we
-recommend releasing these examples in parallel under your choice of
-free software license, such as the GNU General Public License,
-to permit their use in free software.
-
-%---------------------------------------------------------------------
+++ /dev/null
-%%
-%%
-
-\section*{GNU General Public License}
-\label{GplChapter}
-\index[general]{GNU General Public License }
-\index[general]{License!GNU General Public }
-
-\elink{image of a Philosophical
-GNU}{http://www.gnu.org/graphics/philosophicalgnu.html}
-
-\begin{itemize}
-\item
- \elink{What to do if you see a possible GPL
- violation}{http://www.gnu.org/copyleft/gpl-violation.html}
-\item
- \elink{Translations of the
- GPL}{http://www.gnu.org/copyleft/copyleft.html\#translations}
-\end{itemize}
-
-
-\section{Table of Contents}
-\index[general]{Table of Contents }
-\index[general]{Contents!Table of }
-
-\begin{itemize}
-\item
- \label{TOC1}
- \ilink{GNU GENERAL PUBLIC LICENSE}{SEC1}
-
-\begin{itemize}
-\item
- \label{TOC2}
- \ilink{Preamble}{SEC2}
-\item
- \label{TOC3}
- \ilink{TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND
-MODIFICATION}{SEC3}
-\item
- \label{TOC4}
- \ilink{How to Apply These Terms to Your New Programs}{SEC4}
-\end{itemize}
-
-\end{itemize}
-
-
-\section{GNU GENERAL PUBLIC LICENSE}
-\label{SEC1}
-\index[general]{GNU GENERAL PUBLIC LICENSE }
-\index[general]{LICENSE!GNU GENERAL PUBLIC }
-
-Version 2, June 1991
-
-\footnotesize
-\begin{verbatim}
-Copyright (C) 1989, 1991 Free Software Foundation, Inc.
-51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-Everyone is permitted to copy and distribute verbatim copies
-of this license document, but changing it is not allowed.
-\end{verbatim}
-\normalsize
-
-\section{Preamble}
-\label{SEC2}
-\index[general]{Preamble }
-
-The licenses for most software are designed to take away your freedom to share
-and change it. By contrast, the GNU General Public License is intended to
-guarantee your freedom to share and change free software\verb:--:to make sure the
-software is free for all its users. This General Public License applies to
-most of the Free Software Foundation's software and to any other program whose
-authors commit to using it. (Some other Free Software Foundation software is
-covered by the GNU Library General Public License instead.) You can apply it
-to your programs, too.
-
-When we speak of free software, we are referring to freedom, not price. Our
-General Public Licenses are designed to make sure that you have the freedom to
-distribute copies of free software (and charge for this service if you wish),
-that you receive source code or can get it if you want it, that you can change
-the software or use pieces of it in new free programs; and that you know you
-can do these things.
-
-To protect your rights, we need to make restrictions that forbid anyone to
-deny you these rights or to ask you to surrender the rights. These
-restrictions translate to certain responsibilities for you if you distribute
-copies of the software, or if you modify it.
-
-For example, if you distribute copies of such a program, whether gratis or for
-a fee, you must give the recipients all the rights that you have. You must
-make sure that they, too, receive or can get the source code. And you must
-show them these terms so they know their rights.
-
-We protect your rights with two steps: (1) copyright the software, and (2)
-offer you this license which gives you legal permission to copy, distribute
-and/or modify the software.
-
-Also, for each author's protection and ours, we want to make certain that
-everyone understands that there is no warranty for this free software. If the
-software is modified by someone else and passed on, we want its recipients to
-know that what they have is not the original, so that any problems introduced
-by others will not reflect on the original authors' reputations.
-
-Finally, any free program is threatened constantly by software patents. We
-wish to avoid the danger that redistributors of a free program will
-individually obtain patent licenses, in effect making the program proprietary.
-To prevent this, we have made it clear that any patent must be licensed for
-everyone's free use or not licensed at all.
-
-The precise terms and conditions for copying, distribution and modification
-follow.
-
-\section{TERMS AND CONDITIONS}
-\label{SEC3}
-\index[general]{CONDITIONS!TERMS AND }
-\index[general]{TERMS AND CONDITIONS }
-
-TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
-
-{\bf 0.} This License applies to any program or other work which contains a
-notice placed by the copyright holder saying it may be distributed under the
-terms of this General Public License. The "Program", below, refers to any
-such program or work, and a "work based on the Program" means either the
-Program or any derivative work under copyright law: that is to say, a work
-containing the Program or a portion of it, either verbatim or with
-modifications and/or translated into another language. (Hereinafter,
-translation is included without limitation in the term "modification".) Each
-licensee is addressed as "you".
-
-Activities other than copying, distribution and modification are not covered
-by this License; they are outside its scope. The act of running the Program is
-not restricted, and the output from the Program is covered only if its
-contents constitute a work based on the Program (independent of having been
-made by running the Program). Whether that is true depends on what the Program
-does.
-
-{\bf 1.} You may copy and distribute verbatim copies of the Program's source
-code as you receive it, in any medium, provided that you conspicuously and
-appropriately publish on each copy an appropriate copyright notice and
-disclaimer of warranty; keep intact all the notices that refer to this License
-and to the absence of any warranty; and give any other recipients of the
-Program a copy of this License along with the Program.
-
-You may charge a fee for the physical act of transferring a copy, and you may
-at your option offer warranty protection in exchange for a fee.
-
-{\bf 2.} You may modify your copy or copies of the Program or any portion of
-it, thus forming a work based on the Program, and copy and distribute such
-modifications or work under the terms of Section 1 above, provided that you
-also meet all of these conditions:
-
-\begin{itemize}
-\item {\bf a)} You must cause the modified files to carry prominent notices
- stating that you changed the files and the date of any change.
-
-\item {\bf b)} You must cause any work that you distribute or publish, that
- in whole or in part contains or is derived from the Program or any part
- thereof, to be licensed as a whole at no charge to all third parties under
- the terms of this License.
-
-\item {\bf c)} If the modified program normally reads commands interactively
- when run, you must cause it, when started running for such interactive use in
- the most ordinary way, to print or display an announcement including an
- appropriate copyright notice and a notice that there is no warranty (or else,
- saying that you provide a warranty) and that users may redistribute the
- program under these conditions, and telling the user how to view a copy of
- this License. (Exception: if the Program itself is interactive but does not
- normally print such an announcement, your work based on the Program is not
- required to print an announcement.)
-\end{itemize}
-
-These requirements apply to the modified work as a whole. If identifiable
-sections of that work are not derived from the Program, and can be reasonably
-considered independent and separate works in themselves, then this License,
-and its terms, do not apply to those sections when you distribute them as
-separate works. But when you distribute the same sections as part of a whole
-which is a work based on the Program, the distribution of the whole must be on
-the terms of this License, whose permissions for other licensees extend to the
-entire whole, and thus to each and every part regardless of who wrote it.
-
-Thus, it is not the intent of this section to claim rights or contest your
-rights to work written entirely by you; rather, the intent is to exercise the
-right to control the distribution of derivative or collective works based on
-the Program.
-
-In addition, mere aggregation of another work not based on the Program with
-the Program (or with a work based on the Program) on a volume of a storage or
-distribution medium does not bring the other work under the scope of this
-License.
-
-{\bf 3.} You may copy and distribute the Program (or a work based on it, under
-Section 2) in object code or executable form under the terms of Sections 1 and
-2 above provided that you also do one of the following:
-
-\begin{itemize}
-\item {\bf a)} Accompany it with the complete corresponding machine-readable
- source code, which must be distributed under the terms of Sections 1 and 2
- above on a medium customarily used for software interchange; or,
-
-\item {\bf b)} Accompany it with a written offer, valid for at least three
- years, to give any third party, for a charge no more than your cost of
- physically performing source distribution, a complete machine-readable copy of
- the corresponding source code, to be distributed under the terms of Sections
- 1 and 2 above on a medium customarily used for software interchange; or,
-
-\item {\bf c)} Accompany it with the information you received as to the offer
- to distribute corresponding source code. (This alternative is allowed only
- for noncommercial distribution and only if you received the program in object
- code or executable form with such an offer, in accord with Subsection b
- above.)
-\end{itemize}
-
-The source code for a work means the preferred form of the work for making
-modifications to it. For an executable work, complete source code means all
-the source code for all modules it contains, plus any associated interface
-definition files, plus the scripts used to control compilation and
-installation of the executable. However, as a special exception, the source
-code distributed need not include anything that is normally distributed (in
-either source or binary form) with the major components (compiler, kernel, and
-so on) of the operating system on which the executable runs, unless that
-component itself accompanies the executable.
-
-If distribution of executable or object code is made by offering access to
-copy from a designated place, then offering equivalent access to copy the
-source code from the same place counts as distribution of the source code,
-even though third parties are not compelled to copy the source along with the
-object code.
-
-{\bf 4.} You may not copy, modify, sublicense, or distribute the Program
-except as expressly provided under this License. Any attempt otherwise to
-copy, modify, sublicense or distribute the Program is void, and will
-automatically terminate your rights under this License. However, parties who
-have received copies, or rights, from you under this License will not have
-their licenses terminated so long as such parties remain in full compliance.
-
-{\bf 5.} You are not required to accept this License, since you have not
-signed it. However, nothing else grants you permission to modify or distribute
-the Program or its derivative works. These actions are prohibited by law if
-you do not accept this License. Therefore, by modifying or distributing the
-Program (or any work based on the Program), you indicate your acceptance of
-this License to do so, and all its terms and conditions for copying,
-distributing or modifying the Program or works based on it.
-
-{\bf 6.} Each time you redistribute the Program (or any work based on the
-Program), the recipient automatically receives a license from the original
-licensor to copy, distribute or modify the Program subject to these terms and
-conditions. You may not impose any further restrictions on the recipients'
-exercise of the rights granted herein. You are not responsible for enforcing
-compliance by third parties to this License.
-
-{\bf 7.} If, as a consequence of a court judgment or allegation of patent
-infringement or for any other reason (not limited to patent issues),
-conditions are imposed on you (whether by court order, agreement or otherwise)
-that contradict the conditions of this License, they do not excuse you from
-the conditions of this License. If you cannot distribute so as to satisfy
-simultaneously your obligations under this License and any other pertinent
-obligations, then as a consequence you may not distribute the Program at all.
-For example, if a patent license would not permit royalty-free redistribution
-of the Program by all those who receive copies directly or indirectly through
-you, then the only way you could satisfy both it and this License would be to
-refrain entirely from distribution of the Program.
-
-If any portion of this section is held invalid or unenforceable under any
-particular circumstance, the balance of the section is intended to apply and
-the section as a whole is intended to apply in other circumstances.
-
-It is not the purpose of this section to induce you to infringe any patents or
-other property right claims or to contest validity of any such claims; this
-section has the sole purpose of protecting the integrity of the free software
-distribution system, which is implemented by public license practices. Many
-people have made generous contributions to the wide range of software
-distributed through that system in reliance on consistent application of that
-system; it is up to the author/donor to decide if he or she is willing to
-distribute software through any other system and a licensee cannot impose that
-choice.
-
-This section is intended to make thoroughly clear what is believed to be a
-consequence of the rest of this License.
-
-{\bf 8.} If the distribution and/or use of the Program is restricted in
-certain countries either by patents or by copyrighted interfaces, the original
-copyright holder who places the Program under this License may add an explicit
-geographical distribution limitation excluding those countries, so that
-distribution is permitted only in or among countries not thus excluded. In
-such case, this License incorporates the limitation as if written in the body
-of this License.
-
-{\bf 9.} The Free Software Foundation may publish revised and/or new versions
-of the General Public License from time to time. Such new versions will be
-similar in spirit to the present version, but may differ in detail to address
-new problems or concerns.
-
-Each version is given a distinguishing version number. If the Program
-specifies a version number of this License which applies to it and "any later
-version", you have the option of following the terms and conditions either of
-that version or of any later version published by the Free Software
-Foundation. If the Program does not specify a version number of this License,
-you may choose any version ever published by the Free Software Foundation.
-
-{\bf 10.} If you wish to incorporate parts of the Program into other free
-programs whose distribution conditions are different, write to the author to
-ask for permission. For software which is copyrighted by the Free Software
-Foundation, write to the Free Software Foundation; we sometimes make
-exceptions for this. Our decision will be guided by the two goals of
-preserving the free status of all derivatives of our free software and of
-promoting the sharing and reuse of software generally.
-
-{\bf NO WARRANTY}
-
-{\bf 11.} BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
-FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
-OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE
-THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR
-IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
-MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO
-THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM
-PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR
-CORRECTION.
-
-{\bf 12.} IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
-WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
-REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
-INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
-OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO
-LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR
-THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
-EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
-DAMAGES.
-
-END OF TERMS AND CONDITIONS
-
-\section{How to Apply These Terms to Your New Programs}
-\label{SEC4}
-\index[general]{Programs!How to Apply These Terms to Your New }
-\index[general]{How to Apply These Terms to Your New Programs }
-
-If you develop a new program, and you want it to be of the greatest possible
-use to the public, the best way to achieve this is to make it free software
-which everyone can redistribute and change under these terms.
-
-To do so, attach the following notices to the program. It is safest to attach
-them to the start of each source file to most effectively convey the exclusion
-of warranty; and each file should have at least the "copyright" line and a
-pointer to where the full notice is found.
-
-\footnotesize
-\begin{verbatim}
-{\em one line to give the program's name and an idea of what it does.}
-Copyright (C) {\em yyyy} {\em name of author}
-This program is free software; you can redistribute it and/or
-modify it under the terms of the GNU General Public License
-as published by the Free Software Foundation; either version 2
-of the License, or (at your option) any later version.
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-GNU General Public License for more details.
-You should have received a copy of the GNU General Public License
-along with this program; if not, write to the Free Software
-Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
-02110-1301 USA
-\end{verbatim}
-\normalsize
-
-Also add information on how to contact you by electronic and paper mail.
-
-If the program is interactive, make it output a short notice like this when it
-starts in an interactive mode:
-
-\footnotesize
-\begin{verbatim}
-Gnomovision version 69, Copyright (C) {\em year} {\em name of author}
-Gnomovision comes with ABSOLUTELY NO WARRANTY; for details
-type `show w'. This is free software, and you are welcome
-to redistribute it under certain conditions; type `show c'
-for details.
-\end{verbatim}
-\normalsize
-
-The hypothetical commands {\tt `show w'} and {\tt `show c'} should show the
-appropriate parts of the General Public License. Of course, the commands you
-use may be called something other than {\tt `show w'} and {\tt `show c'}; they
-could even be mouse-clicks or menu items\verb:--:whatever suits your program.
-
-You should also get your employer (if you work as a programmer) or your
-school, if any, to sign a "copyright disclaimer" for the program, if
-necessary. Here is a sample; alter the names:
-
-\footnotesize
-\begin{verbatim}
-Yoyodyne, Inc., hereby disclaims all copyright
-interest in the program `Gnomovision'
-(which makes passes at compilers) written
-by James Hacker.
-{\em signature of Ty Coon}, 1 April 1989
-Ty Coon, President of Vice
-\end{verbatim}
-\normalsize
-
-This General Public License does not permit incorporating your program into
-proprietary programs. If your program is a subroutine library, you may
-consider it more useful to permit linking proprietary applications with the
-library. If this is what you want to do, use the GNU Library General Public
-License instead of this License.
-Return to
-\elink{GNU's home page}{http://www.gnu.org/home.html}.
-
-FSF \& GNU inquiries \& questions to
-\elink{gnu@gnu.org}{mailto:gnu@gnu.org}. Other
-\elink{ways to contact}{http://www.gnu.org/home.html\#ContactInfo} the FSF.
-
-Comments on these web pages to
-\elink{webmasters@www.gnu.org}{mailto:webmasters@www.gnu.org}, send other
-questions to
-\elink{gnu@gnu.org}{mailto:gnu@gnu.org}.
-
-Copyright notice above.
-Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
-Boston, MA 02110-1301 USA
-
-Updated: 3 Jan 2000 rms
+++ /dev/null
-# This file serves as a place to put initialization code and constants to
-# affect the behavior of latex2html for generating the bacula manuals.
-
-# $LINKPOINT specifies what filename to use to link to when creating
-# index.html. Not that this is a hard link.
-$LINKPOINT='"$OVERALL_TITLE"';
-
-
-# The following must be the last line of this file.
-1;
+++ /dev/null
-%%
-%%
-
-\section*{GNU Lesser General Public License}
-\label{LesserChapter}
-\index[general]{GNU Lesser General Public License }
-\index[general]{License!GNU Lesser General Public }
-
-\elink{image of a Philosophical GNU}
-{\url{http://www.gnu.org/graphics/philosophicalgnu.html}} [
-\elink{English}{\url{http://www.gnu.org/copyleft/lesser.html}} |
-\elink{Japanese}{\url{http://www.gnu.org/copyleft/lesser.ja.html}} ]
-
-\begin{itemize}
-\item
- \elink{Why you shouldn't use the Lesser GPL for your next
- library}{\url{http://www.gnu.org/philosophy/why-not-lgpl.html}}
-\item
- \elink{What to do if you see a possible LGPL
- violation}{\url{http://www.gnu.org/copyleft/gpl-violation.html}}
-\item
- \elink{Translations of the LGPL}
-{\url{http://www.gnu.org/copyleft/copyleft.html\#translationsLGPL}}
-\item The GNU Lesser General Public License as a
- \elink{text file}{\url{http://www.gnu.org/copyleft/lesser.txt}}
-\item The GNU Lesser General Public License as a
- \elink{Texinfo}{\url{http://www.gnu.org/copyleft/lesser.texi}} file
- \end{itemize}
-
-
-This GNU Lesser General Public License counts as the successor of the GNU
-Library General Public License. For an explanation of why this change was
-necessary, read the
-\elink{Why you shouldn't use the Lesser GPL for your next
-library}{\url{http://www.gnu.org/philosophy/why-not-lgpl.html}} article.
-
-\section{Table of Contents}
-\index[general]{Table of Contents }
-\index[general]{Contents!Table of }
-
-\begin{itemize}
-\item
- \label{TOC12}
- \ilink{GNU LESSER GENERAL PUBLIC LICENSE}{SEC12}
-
-\begin{itemize}
-\item
- \label{TOC23}
- \ilink{Preamble}{SEC23}
-\item
- \label{TOC34}
- \ilink{TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND
-MODIFICATION}{SEC34}
-\item
- \label{TOC45}
- \ilink{How to Apply These Terms to Your New Libraries}{SEC45}
-\end{itemize}
-
-\end{itemize}
-
-
-\section{GNU LESSER GENERAL PUBLIC LICENSE}
-\label{SEC12}
-\index[general]{LICENSE!GNU LESSER GENERAL PUBLIC }
-\index[general]{GNU LESSER GENERAL PUBLIC LICENSE }
-
-Version 2.1, February 1999
-
-\footnotesize
-\begin{verbatim}
-Copyright (C) 1991, 1999 Free Software Foundation, Inc.
-51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-Everyone is permitted to copy and distribute verbatim copies
-of this license document, but changing it is not allowed.
-[This is the first released version of the Lesser GPL. It also counts
- as the successor of the GNU Library Public License, version 2, hence
- the version number 2.1.]
-\end{verbatim}
-\normalsize
-
-\section{Preamble}
-\label{SEC23}
-\index[general]{Preamble }
-
-The licenses for most software are designed to take away your freedom to share
-and change it. By contrast, the GNU General Public Licenses are intended to
-guarantee your freedom to share and change free software\verb:--:to make sure the
-software is free for all its users.
-
-This license, the Lesser General Public License, applies to some specially
-designated software packages\verb:--:typically libraries\verb:--:of the Free Software
-Foundation and other authors who decide to use it. You can use it too, but we
-suggest you first think carefully about whether this license or the ordinary
-General Public License is the better strategy to use in any particular case,
-based on the explanations below.
-
-When we speak of free software, we are referring to freedom of use, not price.
-Our General Public Licenses are designed to make sure that you have the
-freedom to distribute copies of free software (and charge for this service if
-you wish); that you receive source code or can get it if you want it; that you
-can change the software and use pieces of it in new free programs; and that
-you are informed that you can do these things.
-
-To protect your rights, we need to make restrictions that forbid distributors
-to deny you these rights or to ask you to surrender these rights. These
-restrictions translate to certain responsibilities for you if you distribute
-copies of the library or if you modify it.
-
-For example, if you distribute copies of the library, whether gratis or for a
-fee, you must give the recipients all the rights that we gave you. You must
-make sure that they, too, receive or can get the source code. If you link
-other code with the library, you must provide complete object files to the
-recipients, so that they can relink them with the library after making changes
-to the library and recompiling it. And you must show them these terms so they
-know their rights.
-
-We protect your rights with a two-step method: (1) we copyright the library,
-and (2) we offer you this license, which gives you legal permission to copy,
-distribute and/or modify the library.
-
-To protect each distributor, we want to make it very clear that there is no
-warranty for the free library. Also, if the library is modified by someone
-else and passed on, the recipients should know that what they have is not the
-original version, so that the original author's reputation will not be
-affected by problems that might be introduced by others.
-
-Finally, software patents pose a constant threat to the existence of any free
-program. We wish to make sure that a company cannot effectively restrict the
-users of a free program by obtaining a restrictive license from a patent
-holder. Therefore, we insist that any patent license obtained for a version of
-the library must be consistent with the full freedom of use specified in this
-license.
-
-Most GNU software, including some libraries, is covered by the ordinary GNU
-General Public License. This license, the GNU Lesser General Public License,
-applies to certain designated libraries, and is quite different from the
-ordinary General Public License. We use this license for certain libraries in
-order to permit linking those libraries into non-free programs.
-
-When a program is linked with a library, whether statically or using a shared
-library, the combination of the two is legally speaking a combined work, a
-derivative of the original library. The ordinary General Public License
-therefore permits such linking only if the entire combination fits its
-criteria of freedom. The Lesser General Public License permits more lax
-criteria for linking other code with the library.
-
-We call this license the "Lesser" General Public License because it does
-Less to protect the user's freedom than the ordinary General Public License.
-It also provides other free software developers Less of an advantage over
-competing non-free programs. These disadvantages are the reason we use the
-ordinary General Public License for many libraries. However, the Lesser
-license provides advantages in certain special circumstances.
-
-For example, on rare occasions, there may be a special need to encourage the
-widest possible use of a certain library, so that it becomes a de-facto
-standard. To achieve this, non-free programs must be allowed to use the
-library. A more frequent case is that a free library does the same job as
-widely used non-free libraries. In this case, there is little to gain by
-limiting the free library to free software only, so we use the Lesser General
-Public License.
-
-In other cases, permission to use a particular library in non-free programs
-enables a greater number of people to use a large body of free software. For
-example, permission to use the GNU C Library in non-free programs enables many
-more people to use the whole GNU operating system, as well as its variant, the
-GNU/Linux operating system.
-
-Although the Lesser General Public License is Less protective of the users'
-freedom, it does ensure that the user of a program that is linked with the
-Library has the freedom and the wherewithal to run that program using a
-modified version of the Library.
-
-The precise terms and conditions for copying, distribution and modification
-follow. Pay close attention to the difference between a "work based on the
-library" and a "work that uses the library". The former contains code
-derived from the library, whereas the latter must be combined with the library
-in order to run.
-
-\section{TERMS AND CONDITIONS}
-\label{SEC34}
-\index[general]{CONDITIONS!TERMS AND }
-\index[general]{TERMS AND CONDITIONS }
-
-TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
-
-{\bf 0.} This License Agreement applies to any software library or other
-program which contains a notice placed by the copyright holder or other
-authorized party saying it may be distributed under the terms of this Lesser
-General Public License (also called "this License"). Each licensee is
-addressed as "you".
-
-A "library" means a collection of software functions and/or data prepared so
-as to be conveniently linked with application programs (which use some of
-those functions and data) to form executables.
-
-The "Library", below, refers to any such software library or work which has
-been distributed under these terms. A "work based on the Library" means
-either the Library or any derivative work under copyright law: that is to say,
-a work containing the Library or a portion of it, either verbatim or with
-modifications and/or translated straightforwardly into another language.
-(Hereinafter, translation is included without limitation in the term
-"modification".)
-
-"Source code" for a work means the preferred form of the work for making
-modifications to it. For a library, complete source code means all the source
-code for all modules it contains, plus any associated interface definition
-files, plus the scripts used to control compilation and installation of the
-library.
-
-Activities other than copying, distribution and modification are not covered
-by this License; they are outside its scope. The act of running a program
-using the Library is not restricted, and output from such a program is covered
-only if its contents constitute a work based on the Library (independent of
-the use of the Library in a tool for writing it). Whether that is true depends
-on what the Library does and what the program that uses the Library does.
-
-{\bf 1.} You may copy and distribute verbatim copies of the Library's complete
-source code as you receive it, in any medium, provided that you conspicuously
-and appropriately publish on each copy an appropriate copyright notice and
-disclaimer of warranty; keep intact all the notices that refer to this License
-and to the absence of any warranty; and distribute a copy of this License
-along with the Library.
-
-You may charge a fee for the physical act of transferring a copy, and you may
-at your option offer warranty protection in exchange for a fee.
-
-{\bf 2.} You may modify your copy or copies of the Library or any portion of
-it, thus forming a work based on the Library, and copy and distribute such
-modifications or work under the terms of Section 1 above, provided that you
-also meet all of these conditions:
-
-\begin{itemize}
-\item {\bf a)} The modified work must itself be a software library.
-\item {\bf b)} You must cause the files modified to carry prominent notices
- stating that you changed the files and the date of any change.
-\item {\bf c)} You must cause the whole of the work to be licensed at no
- charge to all third parties under the terms of this License.
-\item {\bf d)} If a facility in the modified Library refers to a function or
- a table of data to be supplied by an application program that uses the
- facility, other than as an argument passed when the facility is invoked, then
-you must make a good faith effort to ensure that, in the event an application
-does not supply such function or table, the facility still operates, and
-performs whatever part of its purpose remains meaningful.
-
-(For example, a function in a library to compute square roots has a purpose
-that is entirely well-defined independent of the application. Therefore,
-Subsection 2d requires that any application-supplied function or table used
-by this function must be optional: if the application does not supply it, the
-square root function must still compute square roots.)
-
-These requirements apply to the modified work as a whole. If identifiable
-sections of that work are not derived from the Library, and can be reasonably
-considered independent and separate works in themselves, then this License,
-and its terms, do not apply to those sections when you distribute them as
-separate works. But when you distribute the same sections as part of a whole
-which is a work based on the Library, the distribution of the whole must be
-on the terms of this License, whose permissions for other licensees extend to
-the entire whole, and thus to each and every part regardless of who wrote
-it.
-
-Thus, it is not the intent of this section to claim rights or contest your
-rights to work written entirely by you; rather, the intent is to exercise the
-right to control the distribution of derivative or collective works based on
-the Library.
-
-In addition, mere aggregation of another work not based on the Library with
-the Library (or with a work based on the Library) on a volume of a storage or
-distribution medium does not bring the other work under the scope of this
-License.
-\end{itemize}
-
-{\bf 3.} You may opt to apply the terms of the ordinary GNU General Public
-License instead of this License to a given copy of the Library. To do this,
-you must alter all the notices that refer to this License, so that they refer
-to the ordinary GNU General Public License, version 2, instead of to this
-License. (If a newer version than version 2 of the ordinary GNU General Public
-License has appeared, then you can specify that version instead if you wish.)
-Do not make any other change in these notices.
-
-Once this change is made in a given copy, it is irreversible for that copy, so
-the ordinary GNU General Public License applies to all subsequent copies and
-derivative works made from that copy.
-
-This option is useful when you wish to copy part of the code of the Library
-into a program that is not a library.
-
-{\bf 4.} You may copy and distribute the Library (or a portion or derivative
-of it, under Section 2) in object code or executable form under the terms of
-Sections 1 and 2 above provided that you accompany it with the complete
-corresponding machine-readable source code, which must be distributed under
-the terms of Sections 1 and 2 above on a medium customarily used for software
-interchange.
-
-If distribution of object code is made by offering access to copy from a
-designated place, then offering equivalent access to copy the source code from
-the same place satisfies the requirement to distribute the source code, even
-though third parties are not compelled to copy the source along with the
-object code.
-
-{\bf 5.} A program that contains no derivative of any portion of the Library,
-but is designed to work with the Library by being compiled or linked with it,
-is called a "work that uses the Library". Such a work, in isolation, is not
-a derivative work of the Library, and therefore falls outside the scope of
-this License.
-
-However, linking a "work that uses the Library" with the Library creates an
-executable that is a derivative of the Library (because it contains portions
-of the Library), rather than a "work that uses the library". The executable
-is therefore covered by this License. Section 6 states terms for distribution
-of such executables.
-
-When a "work that uses the Library" uses material from a header file that is
-part of the Library, the object code for the work may be a derivative work of
-the Library even though the source code is not. Whether this is true is
-especially significant if the work can be linked without the Library, or if
-the work is itself a library. The threshold for this to be true is not
-precisely defined by law.
-
-If such an object file uses only numerical parameters, data structure layouts
-and accessors, and small macros and small inline functions (ten lines or less
-in length), then the use of the object file is unrestricted, regardless of
-whether it is legally a derivative work. (Executables containing this object
-code plus portions of the Library will still fall under Section 6.)
-
-Otherwise, if the work is a derivative of the Library, you may distribute the
-object code for the work under the terms of Section 6. Any executables
-containing that work also fall under Section 6, whether or not they are linked
-directly with the Library itself.
-
-{\bf 6.} As an exception to the Sections above, you may also combine or link a
-"work that uses the Library" with the Library to produce a work containing
-portions of the Library, and distribute that work under terms of your choice,
-provided that the terms permit modification of the work for the customer's own
-use and reverse engineering for debugging such modifications.
-
-You must give prominent notice with each copy of the work that the Library is
-used in it and that the Library and its use are covered by this License. You
-must supply a copy of this License. If the work during execution displays
-copyright notices, you must include the copyright notice for the Library among
-them, as well as a reference directing the user to the copy of this License.
-Also, you must do one of these things:
-
-\begin{itemize}
-\item {\bf a)} Accompany the work with the complete corresponding
- machine-readable source code for the Library including whatever changes were
- used in the work (which must be distributed under Sections 1 and 2 above);
-and, if the work is an executable linked with the Library, with the complete
-machine-readable "work that uses the Library", as object code and/or source
-code, so that the user can modify the Library and then relink to produce a
-modified executable containing the modified Library. (It is understood that
-the user who changes the contents of definitions files in the Library will
-not necessarily be able to recompile the application to use the modified
-definitions.)
-\item {\bf b)} Use a suitable shared library mechanism for linking with the
- Library. A suitable mechanism is one that (1) uses at run time a copy of the
- library already present on the user's computer system, rather than copying
-library functions into the executable, and (2) will operate properly with a
-modified version of the library, if the user installs one, as long as the
-modified version is interface-compatible with the version that the work was
-made with.
-\item {\bf c)} Accompany the work with a written offer, valid for at least
- three years, to give the same user the materials specified in Subsection 6a,
- above, for a charge no more than the cost of performing this distribution.
-\item {\bf d)} If distribution of the work is made by offering access to copy
- from a designated place, offer equivalent access to copy the above specified
- materials from the same place.
-\item {\bf e)} Verify that the user has already received a copy of these
- materials or that you have already sent this user a copy.
- \end{itemize}
-
-For an executable, the required form of the "work that uses the Library"
-must include any data and utility programs needed for reproducing the
-executable from it. However, as a special exception, the materials to be
-distributed need not include anything that is normally distributed (in either
-source or binary form) with the major components (compiler, kernel, and so on)
-of the operating system on which the executable runs, unless that component
-itself accompanies the executable.
-
-It may happen that this requirement contradicts the license restrictions of
-other proprietary libraries that do not normally accompany the operating
-system. Such a contradiction means you cannot use both them and the Library
-together in an executable that you distribute.
-
-{\bf 7.} You may place library facilities that are a work based on the Library
-side-by-side in a single library together with other library facilities not
-covered by this License, and distribute such a combined library, provided that
-the separate distribution of the work based on the Library and of the other
-library facilities is otherwise permitted, and provided that you do these two
-things:
-
-\begin{itemize}
-\item {\bf a)} Accompany the combined library with a copy of the same work
- based on the Library, uncombined with any other library facilities. This must
- be distributed under the terms of the Sections above.
-\item {\bf b)} Give prominent notice with the combined library of the fact
- that part of it is a work based on the Library, and explaining where to find
- the accompanying uncombined form of the same work.
-\end{itemize}
-
-{\bf 8.} You may not copy, modify, sublicense, link with, or distribute the
-Library except as expressly provided under this License. Any attempt otherwise
-to copy, modify, sublicense, link with, or distribute the Library is void, and
-will automatically terminate your rights under this License. However, parties
-who have received copies, or rights, from you under this License will not have
-their licenses terminated so long as such parties remain in full compliance.
-
-{\bf 9.} You are not required to accept this License, since you have not
-signed it. However, nothing else grants you permission to modify or distribute
-the Library or its derivative works. These actions are prohibited by law if
-you do not accept this License. Therefore, by modifying or distributing the
-Library (or any work based on the Library), you indicate your acceptance of
-this License to do so, and all its terms and conditions for copying,
-distributing or modifying the Library or works based on it.
-
-{\bf 10.} Each time you redistribute the Library (or any work based on the
-Library), the recipient automatically receives a license from the original
-licensor to copy, distribute, link with or modify the Library subject to these
-terms and conditions. You may not impose any further restrictions on the
-recipients' exercise of the rights granted herein. You are not responsible for
-enforcing compliance by third parties with this License.
-
-{\bf 11.} If, as a consequence of a court judgment or allegation of patent
-infringement or for any other reason (not limited to patent issues),
-conditions are imposed on you (whether by court order, agreement or otherwise)
-that contradict the conditions of this License, they do not excuse you from
-the conditions of this License. If you cannot distribute so as to satisfy
-simultaneously your obligations under this License and any other pertinent
-obligations, then as a consequence you may not distribute the Library at all.
-For example, if a patent license would not permit royalty-free redistribution
-of the Library by all those who receive copies directly or indirectly through
-you, then the only way you could satisfy both it and this License would be to
-refrain entirely from distribution of the Library.
-
-If any portion of this section is held invalid or unenforceable under any
-particular circumstance, the balance of the section is intended to apply, and
-the section as a whole is intended to apply in other circumstances.
-
-It is not the purpose of this section to induce you to infringe any patents or
-other property right claims or to contest validity of any such claims; this
-section has the sole purpose of protecting the integrity of the free software
-distribution system which is implemented by public license practices. Many
-people have made generous contributions to the wide range of software
-distributed through that system in reliance on consistent application of that
-system; it is up to the author/donor to decide if he or she is willing to
-distribute software through any other system and a licensee cannot impose that
-choice.
-
-This section is intended to make thoroughly clear what is believed to be a
-consequence of the rest of this License.
-
-{\bf 12.} If the distribution and/or use of the Library is restricted in
-certain countries either by patents or by copyrighted interfaces, the original
-copyright holder who places the Library under this License may add an explicit
-geographical distribution limitation excluding those countries, so that
-distribution is permitted only in or among countries not thus excluded. In
-such case, this License incorporates the limitation as if written in the body
-of this License.
-
-{\bf 13.} The Free Software Foundation may publish revised and/or new versions
-of the Lesser General Public License from time to time. Such new versions will
-be similar in spirit to the present version, but may differ in detail to
-address new problems or concerns.
-
-Each version is given a distinguishing version number. If the Library
-specifies a version number of this License which applies to it and "any later
-version", you have the option of following the terms and conditions either of
-that version or of any later version published by the Free Software
-Foundation. If the Library does not specify a license version number, you may
-choose any version ever published by the Free Software Foundation.
-
-{\bf 14.} If you wish to incorporate parts of the Library into other free
-programs whose distribution conditions are incompatible with these, write to
-the author to ask for permission. For software which is copyrighted by the
-Free Software Foundation, write to the Free Software Foundation; we sometimes
-make exceptions for this. Our decision will be guided by the two goals of
-preserving the free status of all derivatives of our free software and of
-promoting the sharing and reuse of software generally.
-
-{\bf NO WARRANTY}
-
-{\bf 15.} BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
-FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
-OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE
-THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR
-IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
-MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO
-THE QUALITY AND PERFORMANCE OF THE LIBRARY IS WITH YOU. SHOULD THE LIBRARY
-PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR
-CORRECTION.
-
-{\bf 16.} IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
-WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
-REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
-INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
-OUT OF THE USE OR INABILITY TO USE THE LIBRARY (INCLUDING BUT NOT LIMITED TO
-LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR
-THIRD PARTIES OR A FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE),
-EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
-DAMAGES.
-
-END OF TERMS AND CONDITIONS
-
-\section{How to Apply These Terms to Your New Libraries}
-\label{SEC45}
-\index[general]{Libraries!How to Apply These Terms to Your New }
-\index[general]{How to Apply These Terms to Your New Libraries }
-
-
-If you develop a new library, and you want it to be of the greatest possible
-use to the public, we recommend making it free software that everyone can
-redistribute and change. You can do so by permitting redistribution under
-these terms (or, alternatively, under the terms of the ordinary General Public
-License).
-
-To apply these terms, attach the following notices to the library. It is
-safest to attach them to the start of each source file to most effectively
-convey the exclusion of warranty; and each file should have at least the
-"copyright" line and a pointer to where the full notice is found.
-
-\footnotesize
-\begin{verbatim}
-{\it one line to give the library's name and an idea of what it does.}
-Copyright (C) {\it year} {\it name of author}
-This library is free software; you can redistribute it and/or
-modify it under the terms of the GNU Lesser General Public
-License as published by the Free Software Foundation; either
-version 2.1 of the License, or (at your option) any later version.
-This library is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
-Lesser General Public License for more details.
-You should have received a copy of the GNU Lesser General Public
-License along with this library; if not, write to the Free Software
-Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
-USA
-\end{verbatim}
-\normalsize
-
-Also add information on how to contact you by electronic and paper mail.
-
-You should also get your employer (if you work as a programmer) or your
-school, if any, to sign a "copyright disclaimer" for the library, if
-necessary. Here is a sample; alter the names:
-
-\footnotesize
-\begin{verbatim}
-Yoyodyne, Inc., hereby disclaims all copyright interest in
-the library "Frob" (a library for tweaking knobs) written
-by James Random Hacker.
-{\it signature of Ty Coon}, 1 April 1990
-Ty Coon, President of Vice
-\end{verbatim}
-\normalsize
-
-That's all there is to it!
-Return to
-\elink{GNU's home page}{\url{http://www.gnu.org/home.html}}.
-
-FSF \& GNU inquiries \& questions to
-\elink{gnu@gnu.org}{mailto:gnu@gnu.org}. Other
-\elink{ways to contact}{\url{http://www.gnu.org/home.html\#ContactInfo}} the FSF.
-
-Comments on these web pages to
-\elink{webmasters@www.gnu.org}{mailto:webmasters@www.gnu.org}, send other
-questions to
-\elink{gnu@gnu.org}{mailto:gnu@gnu.org}.
-
-Copyright notice above.
-Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
-Boston, MA 02110-1301 USA
-USA
-
-Updated: 27 Nov 2000 paulv
+++ /dev/null
-%%
-%%
-
-\chapter{Bacula Copyright, Trademark, and Licenses}
-\label{LicenseChapter}
-\index[general]{Licenses!Bacula Copyright Trademark}
-\index[general]{Bacula Copyright, Trademark, and Licenses}
-
-There are a number of different licenses that are used in Bacula.
-If you have a printed copy of this manual, the details of each of
-the licenses referred to in this chapter can be found in the
-online version of the manual at
-\elink{http://www.bacula.org}{\url{http://www.bacula.org}}.
-
-\section{FDL}
-\index[general]{FDL }
-
-The GNU Free Documentation License (FDL) is used for this manual,
-which is a free and open license. This means that you may freely
-reproduce it and even make changes to it. However, rather than
-distribute your own version of this manual, we would much prefer
-if you would send any corrections or changes to the Bacula project.
-
-The most recent version of the manual can always be found online
-at \elink{http://www.bacula.org}{\url{http://www.bacula.org}}.
-
-\section{GPL}
-\index[general]{GPL }
-
-The vast bulk of the source code is released under the
-\ilink{GNU General Public License version 2.}{GplChapter}.
-
-Most of this code is copyrighted: Copyright \copyright 2000-2009
-Free Software Foundation Europe e.V.
-
-Portions may be copyrighted by other people. These files are released
-under different licenses which are compatible with the Bacula GPLv2 license.
-
-\section{LGPL}
-\index[general]{LGPL }
-
-Some of the Bacula library source code is released under the
-\ilink{GNU Lesser General Public License.}{LesserChapter} This
-permits third parties to use these parts of our code in their proprietary
-programs to interface to Bacula.
-
-\section{Public Domain}
-\index[general]{Domain!Public }
-\index[general]{Public Domain }
-
-Some of the Bacula code, or code that Bacula references, has been released
-to the public domain. E.g. md5.c, SQLite.
-
-\section{Trademark}
-\index[general]{Trademark }
-
-Bacula\raisebox{.6ex}{\textsuperscript{\textregistered}} is a registered
-trademark of Kern Sibbald.
-
-We have trademarked the Bacula name to ensure that any program using the
-name Bacula will be exactly compatible with the program that we have
-released. The use of the name Bacula is restricted to software systems
-that agree exactly with the program presented here. If you have made
-modifications to the Bacula source code that alter in any significant
-way the way the program functions, you may not distribute it using the
-Bacula name.
-
-\section{Fiduciary License Agreement}
-\index[general]{Fiduciary License Agreement }
-Developers who have contributed significant changes to the Bacula code
-should have signed a Fiduciary License Agreement (FLA), which
-guarantees them the right to use the code they have developed, and also
-ensures that the Free Software Foundation Europe (and thus the Bacula
-project) has the rights to the code. This Fiduciary License Agreement
-is found on the Bacula web site at:
-
-\elink{http://www.bacula.org/en/FLA-bacula.en.pdf}{\url{http://www.bacula.org/en/FLA-bacula.en.pdf}}
-
-and if you are submitting code, you should fill it out then sent to:
-
-\begin{quote}
- Kern Sibbald \\
- Cotes-de-Montmoiret 9 \\
- 1012 Lausanne \\
- Switzerland \\
-\end{quote}
-
-When you send in such a
-complete document, please notify me: kern at sibbald dot com.
-
-
-\section{Disclaimer}
-\index[general]{Disclaimer }
-
-NO WARRANTY
-
-BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE
-PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE
-STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE
-PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED,
-INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
-FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND
-PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE,
-YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
-
-IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY
-COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE
-PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
-GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE
-OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR
-DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR
-A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH
-HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
+++ /dev/null
-[General]
-img_extIsRegExp=false
-img_extensions=.eps .jpg .jpeg .png .pdf .ps .fig .gif
-kileprversion=2
-kileversion=2.0
-lastDocument=stunnel.tex
-masterDocument=misc.tex
-name=Misc
-pkg_extIsRegExp=false
-pkg_extensions=.cls .sty
-src_extIsRegExp=false
-src_extensions=.tex .ltx .latex .dtx .ins
-
-[Tools]
-MakeIndex=
-QuickBuild=
-
-[item:coverpage.tex]
-archive=true
-column=33
-encoding=UTF-8
-highlight=LaTeX
-line=0
-open=false
-order=-1
-
-[item:dvd.tex]
-archive=true
-column=0
-encoding=UTF-8
-highlight=LaTeX
-line=56
-open=false
-order=-1
-
-[item:fdl.tex]
-archive=true
-column=0
-encoding=
-highlight=
-line=0
-open=false
-order=-1
-
-[item:gpl.tex]
-archive=true
-column=0
-encoding=
-highlight=
-line=0
-open=false
-order=-1
-
-[item:lesser.tex]
-archive=true
-column=0
-encoding=
-highlight=
-line=0
-open=false
-order=-1
-
-[item:license.tex]
-archive=true
-column=0
-encoding=
-highlight=
-line=0
-open=false
-order=-1
-
-[item:misc.tex]
-archive=true
-column=59
-encoding=UTF-8
-highlight=LaTeX
-line=45
-open=true
-order=0
-
-[item:projects.tex]
-archive=true
-column=0
-encoding=
-highlight=
-line=0
-open=false
-order=-1
-
-[item:python.tex]
-archive=true
-column=0
-encoding=
-highlight=
-line=0
-open=false
-order=-1
-
-[item:stunnel.tex]
-archive=true
-column=0
-encoding=UTF-8
-highlight=LaTeX
-line=0
-open=true
-order=1
-
-[item:vars.tex]
-archive=true
-column=0
-encoding=UTF-8
-highlight=LaTeX
-line=48
-open=false
-order=-1
-
-[item:version.tex]
-archive=true
-column=0
-encoding=
-highlight=
-line=0
-open=false
-order=-1
+++ /dev/null
-%%
-%%
-%% The following characters must be preceded by a backslash
-%% to be entered as printable characters:
-%%
-%% # $ % & ~ _ ^ \ { }
-%%
-
-\documentclass[10pt,a4paper]{book}
-
-\topmargin -0.5in
-\oddsidemargin 0.0in
-\evensidemargin 0.0in
-\textheight 10in
-\textwidth 6.5in
-
-
-\usepackage{html}
-\usepackage{float}
-\usepackage{graphicx}
-\usepackage{bacula}
-\usepackage{longtable}
-\usepackage{makeidx}
-\usepackage{index}
-\usepackage{setspace}
-\usepackage{hyperref}
-% \usepackage[linkcolor=black,colorlinks=true]{hyperref}
-\usepackage{url}
-
-\makeindex
-\newindex{general}{idx}{ind}{General Index}
-
-\sloppy
-
-\begin{document}
-\sloppy
-
-\include{coverpage}
-
-\clearpage
-\pagenumbering{roman}
-\tableofcontents
-\clearpage
-
-\pagestyle{myheadings}
-\markboth{Bacula Version \version}{Bacula Version \version}
-\pagenumbering{arabic}
-\include{python}
-\include{vars}
-\include{stunnel}
-\include{dvd}
-\include{projects}
-\include{license}
-\include{fdl}
-\include{gpl}
-\include{lesser}
-
-
-% pull in the index
-\clearpage
-\printindex[general]
-
-\end{document}
+++ /dev/null
-%%
-%%
-
-\chapter{Bacula Projects}
-\label{ProjectsChapter}
-\index[general]{Projects!Bacula }
-\index[general]{Bacula Projects }
-
-Once a new major version of Bacula is released, the Bacula
-users will vote on a list of new features. This vote is used
-as the main element determining what new features will be
-implemented for the next version. Generally, the development time
-for a new release is between four to nine months. Sometimes it may be
-a bit longer, but in that case, there will be a number of bug fix
-updates to the currently released version.
-
-For the current list of project, please see the projects page in the CVS
-at: \elink{http://cvs.sourceforge.net/viewcvs.py/*checkout*/bacula/bacula/projects}
-{http://cvs.sourceforge.net/viewcvs.py/*checkout*/bacula/bacula/projects}
-see the {\bf projects} file in the main source directory. The projects
-file is updated approximately once every six months.
-
-Separately from the project list, Kern maintains a current list of
-tasks as well as ideas, feature requests, and occasionally design
-notes. This list is updated roughly weekly (sometimes more often).
-For a current list of tasks you can see {\bf kernstodo} in the Source Forge
-CVS at \elink{http://cvs.sourceforge.net/viewcvs.py/*checkout*/bacula/bacula/kernstodo}
-{http://cvs.sourceforge.net/viewcvs.py/*checkout*/bacula/bacula/kernstodo}.
+++ /dev/null
-%%
-%%
-
-\chapter{Python Scripting}
-\label{PythonChapter}
-\index[general]{Python Scripting}
-\index[general]{Scripting!Python}
-
-You may be asking what Python is and why a scripting language is
-needed in Bacula. The answer to the first question is that Python
-is an Object Oriented scripting language with features similar
-to those found in Perl, but the syntax of the language is much
-cleaner and simpler. The answer to why have scripting in Bacula is to
-give the user more control over the whole backup process. Probably
-the simplest example is when Bacula needs a new Volume name, with
-a scripting language such as Python, you can generate any name
-you want, based on the current state of Bacula.
-
-\section{Python Configuration}
-\index[general]{Python Configuration}
-\index[general]{Configuration!Python}
-
-Python must be enabled during the configuration process by adding
-a \verb:--:with-python, and possibly specifying an alternate
-directory if your Python is not installed in a standard system
-location. If you are using RPMs you will need the python-devel package
-installed.
-
-When Python is configured, it becomes an integral part of Bacula and
-runs in Bacula's address space, so even though it is an interpreted
-language, it is very efficient.
-
-When the Director starts, it looks to see if you have a {\bf
-Scripts Directory} Directive defined (normal default {\bf
-/etc/bacula/scripts}, if so, it looks in that directory for a file named
-{\bf DirStartUp.py}. If it is found, Bacula will pass this file to Python
-for execution. The {\bf Scripts Directory} is a new directive that you add
-to the Director resource of your bacula-dir.conf file.
-
-Note: Bacula does not install Python scripts by default because these
-scripts are for you to program. This means that with a default
-installation with Python enabled, Bacula will print the following error
-message:
-
-\begin{verbatim}
-09-Jun 15:14 bacula-dir: ERROR in pythonlib.c:131 Could not import
-Python script /etc/bacula/scripts/DirStartUp. Python disabled.
-\end{verbatim}
-
-The source code directory {\bf examples/python} contains sample scripts
-for DirStartUp.py, SDStartUp.py, and FDStartUp.py that you might want
-to use as a starting point. Normally, your scripts directory (at least
-where you store the Python scripts) should be writable by Bacula, because
-Python will attempt to write a compiled version of the scripts (e.g.
-DirStartUp.pyc) back to that directory.
-
-When starting with the sample scripts, you can delete any part that
-you will not need, but you should keep all the Bacula Event and Job Event
-definitions. If you do not want a particular event, simply replace the
-existing code with a {\bf noop = 1}.
-
-\section{Bacula Events}
-\index[general]{Bacula Events}
-\index[general]{Events}
-A Bacula event is a point in the Bacula code where Bacula
-will call a subroutine (actually a method) that you have
-defined in the Python StartUp script. Events correspond
-to some significant event such as a Job Start, a Job End,
-Bacula needs a new Volume Name, ... When your script is
-called, it will have access to all the Bacula variables
-specific to the Job (attributes of the Job Object), and
-it can even call some of the Job methods (subroutines)
-or set new values in the Job attributes, such as the
-Priority. You will see below how the events are used.
-
-\section{Python Objects}
-\index[general]{Python Objects}
-\index[general]{Objects!Python}
-
-There are four Python objects that you will need to work with:
-\begin{description}
-\item [The Bacula Object]
- The Bacula object is created by the Bacula daemon (the Director
- in the present case) when the daemon starts. It is available to
- the Python startup script, {\bf DirStartup.py}, by importing the
- Bacula definitions with {\bf import bacula}. The methods
- available with this object are described below.
-
-\item [The Bacula Events Class]
- You create this class in the startup script, and you pass
- it to the Bacula Object's {\bf set\_events} method. The
- purpose of the Bacula Events Class is to define what global
- or daemon events you want to monitor. When one of those events
- occurs, your Bacula Events Class will be called at the method
- corresponding to the event. There are currently three events,
- JobStart, JobEnd, and Exit, which are described in detail below.
-
-\item [The Job Object]
- When a Job starts, and assuming you have defined a JobStart method
- in your Bacula Events Class, Bacula will create a Job Object. This
- object will be passed to the JobStart event. The Job Object has a
- has good number of read-only members or attributes providing many
- details of the Job, and it also has a number of writable attributes
- that allow you to pass information into the Job. These attributes
- are described below.
-
-\item [The Job Events Class]
- You create this class in the JobStart method of your Bacula Events
- class, and it allows you to define which of the possible Job Object
- events you want to see. You must pass an instance of your Job Events
- class to the Job Object set\_events() method.
- Normally, you will probably only have one
- Job Events Class, which will be instantiated for each Job. However,
- if you wish to see different events in different Jobs, you may have
- as many Job Events classes as you wish.
-\end{description}
-
-
-The first thing the startup script must do is to define what global Bacula
-events (daemon events), it wants to see. This is done by creating a
-Bacula Events class, instantiating it, then passing it to the
-{\bf set\_events} method. There are three possible
-events.
-
-\begin{description}
-\item [JobStart]
- \index[general]{JobStart}
- This Python method, if defined, will be called each time a Job is started.
- The method is passed the class instantiation object as the first argument,
- and the Bacula Job object as the second argument. The Bacula Job object
- has several built-in methods, and you can define which ones you
- want called. If you do not define this method, you will not be able
- to interact with Bacula jobs.
-
-\item [JobEnd]
- This Python method, if defined, will be called each time a Job terminates.
- The method is passed the class instantiation object as the first argument,
- and the Bacula Job object as the second argument.
-
-\item [Exit]
- This Python method, if defined, will be called when the Director terminates.
- The method is passed the class instantiation object as the first argument.
-\end{description}
-
-Access to the Bacula variables and methods is done with:
-
- import bacula
-
-The following are the read-only attributes provided by the bacula object.
-\begin{description}
-\item [Name]
-\item [ConfigFile]
-\item [WorkingDir]
-\item [Version] string consisting of "Version Build-date"
-\end{description}
-
-
-A simple definition of the Bacula Events Class might be the following:
-
-\footnotesize
-\begin{verbatim}
-import sys, bacula
-class BaculaEvents:
- def JobStart(self, job):
- ...
-\end{verbatim}
-\normalsize
-
-Then to instantiate the class and pass it to Bacula, you
-would do:
-
-\footnotesize
-\begin{verbatim}
-bacula.set_events(BaculaEvents()) # register Bacula Events wanted
-\end{verbatim}
-\normalsize
-
-And at that point, each time a Job is started, your BaculaEvents JobStart
-method will be called.
-
-Now to actually do anything with a Job, you must define which Job events
-you want to see, and this is done by defining a JobEvents class containing
-the methods you want called. Each method name corresponds to one of the
-Job Events that Bacula will generate.
-
-A simple Job Events class might look like the following:
-
-\footnotesize
-\begin{verbatim}
-class JobEvents:
- def NewVolume(self, job):
- ...
-\end{verbatim}
-\normalsize
-
-Here, your JobEvents class method NewVolume will be called each time
-the Job needs a new Volume name. To actually register the events defined
-in your class with the Job, you must instantiate the JobEvents class and
-set it in the Job {\bf set\_events} variable. Note, this is a bit different
-from how you registered the Bacula events. The registration process must
-be done in the Bacula JobStart event (your method). So, you would modify
-Bacula Events (not the Job events) as follows:
-
-\footnotesize
-\begin{verbatim}
-import sys, bacula
-class BaculaEvents:
- def JobStart(self, job):
- events = JobEvents() # create instance of Job class
- job.set_events(events) # register Job events desired
- ...
-\end{verbatim}
-\normalsize
-
-When a job event is triggered, the appropriate event definition is
-called in the JobEvents class. This is the means by which your Python
-script or code gets control. Once it has control, it may read job
-attributes, or set them. See below for a list of read-only attributes,
-and those that are writable.
-
-In addition, the Bacula {\bf job} object in the Director has
-a number of methods (subroutines) that can be called. They
-are:
-\begin{description}
-\item [set\_events] The set\_events method takes a single
- argument, which is the instantiation of the Job Events class
- that contains the methods that you want called. The method
- names that will be called must correspond to the Bacula
- defined events. You may define additional methods but Bacula
- will not use them.
-\item [run] The run method takes a single string
- argument, which is the run command (same as in the Console)
- that you want to submit to start a new Job. The value
- returned by the run method is the JobId of the job that
- started, or -1 if there was an error.
-\item [write] The write method is used to be able to send
- print output to the Job Report. This will be described later.
-\item[cancel] The cancel method takes a single integer argument,
- which is a JobId. If JobId is found, it will be canceled.
-\item [DoesVolumeExist] The DoesVolumeExist method takes a single
- string argument, which is the Volume name, and returns
- 1 if the volume exists in the Catalog and 0 if the volume
- does not exist.
-\end{description}
-
-The following attributes are read/write within the Director
-for the {\bf job} object.
-
-\begin{description}
-\item [Priority] Read or set the Job priority.
- Note, that setting a Job Priority is effective only before
- the Job actually starts.
-\item [Level] This attribute contains a string representing the Job
- level, e.g. Full, Differential, Incremental, ... if read.
- The level can also be set.
-\end{description}
-
-The following read-only attributes are available within the Director
-for the {\bf job} object.
-
-\begin{description}
-\item [Type] This attribute contains a string representing the Job
- type, e.g. Backup, Restore, Verify, ...
-\item [JobId] This attribute contains an integer representing the
- JobId.
-\item [Client] This attribute contains a string with the name of the
- Client for this job.
-\item [NumVols] This attribute contains an integer with the number of
- Volumes in the Pool being used by the Job.
-\item [Pool] This attribute contains a string with the name of the Pool
- being used by the Job.
-\item [Storage] This attribute contains a string with the name of the
- Storage resource being used by the Job.
-\item [Catalog] This attribute contains a string with the name of the
- Catalog resource being used by the Job.
-\item [MediaType] This attribute contains a string with the name of the
- Media Type associated with the Storage resource being used by the Job.
-\item [Job] This attribute contains a string containing the name of the
- Job resource used by this job (not unique).
-\item [JobName] This attribute contains a string representing the full
- unique Job name.
-\item [JobStatus] This attribute contains a single character string
- representing the current Job status. The status may change
- during execution of the job. It may take on the following
- values:
- \begin{description}
- \item [C] Created, not yet running
- \item [R] Running
- \item [B] Blocked
- \item [T] Completed successfully
- \item [E] Terminated with errors
- \item [e] Non-fatal error
- \item [f] Fatal error
- \item [D] Verify found differences
- \item [A] Canceled by user
- \item [F] Waiting for Client
- \item [S] Waiting for Storage daemon
- \item [m] Waiting for new media
- \item [M] Waiting for media mount
- \item [s] Waiting for storage resource
- \item [j] Waiting for job resource
- \item [c] Waiting for client resource
- \item [d] Waiting on maximum jobs
- \item [t] Waiting on start time
- \item [p] Waiting on higher priority jobs
- \end{description}
-
-\item [Priority] This attribute contains an integer with the priority
- assigned to the job.
-\item [CatalogRes] tuple consisting of (DBName, Address, User,
- Password, Socket, Port, Database Vendor) taken from the Catalog resource
- for the Job with the exception of Database Vendor, which is
- one of the following: MySQL, PostgreSQL, SQLite, Internal,
- depending on what database you configured.
-\item [VolumeName]
- After a Volume has been purged, this attribute will contain the
- name of that Volume. At other times, this value may have no meaning.
-\end{description}
-
-The following write-only attributes are available within the
-Director:
-
-\begin{description}
-\item [JobReport] Send line to the Job Report.
-\item [VolumeName] Set a new Volume name. Valid only during the
- NewVolume event.
-\end{description}
-
-\section{Python Console Command}
-\index[general]{Python Console Command}
-\index[general]{Console Command!Python}
-
-There is a new Console command named {\bf python}. It takes
-a single argument {\bf restart}. Example:
-\begin{verbatim}
- python restart
-\end{verbatim}
-
-This command restarts the Python interpreter in the Director.
-This can be useful when you are modifying the DirStartUp script,
-because normally Python will cache it, and thus the
-script will be read one time.
-
-\section{Debugging Python Scripts}
-\index[general]{Debugging Python Scripts}
-In general, you debug your Python scripts by using print statements.
-You can also develop your script or important parts of it as a
-separate file using the Python interpreter to run it. Once you
-have it working correctly, you can then call the script from
-within the Bacula Python script (DirStartUp.py).
-
-If you are having problems loading DirStartUp.py, you will probably
-not get any error messages because Bacula can only print Python
-error messages after the Python interpreter is started. However, you
-may be able to see the error messages by starting Bacula in
-a shell window with the {\bf -d1} option on the command line. That
-should cause the Python error messages to be printed in the shell
-window.
-
-If you are getting error messages such as the following when
-loading DirStartUp.py:
-
-\begin{verbatim}
- Traceback (most recent call last):
- File "/etc/bacula/scripts/DirStartUp.py", line 6, in ?
- import time, sys, bacula
- ImportError: /usr/lib/python2.3/lib-dynload/timemodule.so: undefined
- symbol: PyInt_FromLong
- bacula-dir: pythonlib.c:134 Python Import error.
-\end{verbatim}
-
-It is because the DirStartUp script is calling a dynamically loaded
-module (timemodule.so in the above case) that then tries to use
-Python functions exported from the Python interpreter (in this case
-PyInt\_FromLong). The way Bacula is currently linked with Python does
-not permit this. The solution to the problem is to put such functions
-(in this case the import of time into a separate Python script, which
-will do your calculations and return the values you want. Then call
-(not import) this script from the Bacula DirStartUp.py script, and
-it all should work as you expect.
-
-
-
-
-
-\section{Python Example}
-\index[general]{Python Example}
-\index[general]{Example!Python}
-
-An example script for the Director startup file is provided in
-{\bf examples/python/DirStartup.py} as follows:
-
-\footnotesize
-\begin{verbatim}
-#
-# Bacula Python interface script for the Director
-#
-
-# You must import both sys and bacula
-import sys, bacula
-
-# This is the list of Bacula daemon events that you
-# can receive.
-class BaculaEvents(object):
- def __init__(self):
- # Called here when a new Bacula Events class is
- # is created. Normally not used
- noop = 1
-
- def JobStart(self, job):
- """
- Called here when a new job is started. If you want
- to do anything with the Job, you must register
- events you want to receive.
- """
- events = JobEvents() # create instance of Job class
- events.job = job # save Bacula's job pointer
- job.set_events(events) # register events desired
- sys.stderr = events # send error output to Bacula
- sys.stdout = events # send stdout to Bacula
- jobid = job.JobId; client = job.Client
- numvols = job.NumVols
- job.JobReport="Python Dir JobStart: JobId=%d Client=%s NumVols=%d\n" % (jobid,client,numvols)
-
- # Bacula Job is going to terminate
- def JobEnd(self, job):
- jobid = job.JobId
- client = job.Client
- job.JobReport="Python Dir JobEnd output: JobId=%d Client=%s.\n" % (jobid, client)
-
- # Called here when the Bacula daemon is going to exit
- def Exit(self, job):
- print "Daemon exiting."
-
-bacula.set_events(BaculaEvents()) # register daemon events desired
-
-"""
- These are the Job events that you can receive.
-"""
-class JobEvents(object):
- def __init__(self):
- # Called here when you instantiate the Job. Not
- # normally used
- noop = 1
-
- def JobInit(self, job):
- # Called when the job is first scheduled
- noop = 1
-
- def JobRun(self, job):
- # Called just before running the job after initializing
- # This is the point to change most Job parameters.
- # It is equivalent to the JobRunBefore point.
- noop = 1
-
- def NewVolume(self, job):
- # Called when Bacula wants a new Volume name. The Volume
- # name returned, if any, must be stored in job.VolumeName
- jobid = job.JobId
- client = job.Client
- numvol = job.NumVols;
- print job.CatalogRes
- job.JobReport = "JobId=%d Client=%s NumVols=%d" % (jobid, client, numvol)
- job.JobReport="Python before New Volume set for Job.\n"
- Vol = "TestA-%d" % numvol
- job.JobReport = "Exists=%d TestA-%d" % (job.DoesVolumeExist(Vol), numvol)
- job.VolumeName="TestA-%d" % numvol
- job.JobReport="Python after New Volume set for Job.\n"
- return 1
-
- def VolumePurged(self, job):
- # Called when a Volume is purged. The Volume name can be referenced
- # with job.VolumeName
- noop = 1
-
-
-
-\end{verbatim}
-\normalsize
+++ /dev/null
-%%
-%%
-
-\chapter{Using Stunnel to Encrypt Communications}
-\label{StunnelChapter}
-\index[general]{Using Stunnel to Encrypt Communications to Clients }
-
-Prior to version 1.37, Bacula did not have built-in communications encryption.
-Please see the \ilink {TLS chapter}{CommEncryption} if you are using Bacula
-1.37 or greater.
-
-Without too much effort, it is possible to encrypt the communications
-between any of the daemons. This chapter will show you how to use {\bf
-stunnel} to encrypt communications to your client programs. We assume the
-Director and the Storage daemon are running on one machine that will be called
-{\bf server} and the Client or File daemon is running on a different machine
-called {\bf client}. Although the details may be slightly different, the same
-principles apply whether you are encrypting between Unix, Linux, or Win32
-machines. This example was developed between two Linux machines running
-stunnel version 4.04-4 on a Red Hat Enterprise 3.0 system.
-
-\section{Communications Ports Used}
-\index[general]{Used!Communications Ports }
-\index[general]{Communications Ports Used }
-
-First, you must know that with the standard Bacula configuration, the Director
-will contact the File daemon on port 9102. The File daemon then contacts the
-Storage daemon using the address and port parameters supplied by the Director.
-The standard port used will be 9103. This is the typical server/client view of
-the world, the File daemon is a server to the Director (i.e. listens for the
-Director to contact it), and the Storage daemon is a server to the File
-daemon.
-
-\section{Encryption}
-\index[general]{Encryption }
-
-The encryption is accomplished between the Director and the File daemon by
-using an stunnel on the Director's machine (server) to encrypt the data and to
-contact an stunnel on the File daemon's machine (client), which decrypts the
-data and passes it to the client.
-
-Between the File daemon and the Storage daemon, we use an stunnel on the File
-daemon's machine to encrypt the data and another stunnel on the Storage
-daemon's machine to decrypt the data.
-
-As a consequence, there are actually four copies of stunnel running, two on the
-server and two on the client. This may sound a bit complicated, but it really
-isn't. To accomplish this, we will need to construct four separate conf files
-for stunnel, and we will need to make some minor modifications to the
-Director's conf file. None of the other conf files need to be changed.
-
-\section{A Picture}
-\index[general]{Picture }
-
-Since pictures usually help a lot, here is an overview of what we will be
-doing. Don't worry about all the details of the port numbers and such for the
-moment.
-
-\footnotesize
-\begin{verbatim}
- File daemon (client):
- stunnel-fd1.conf
- |===========|
- Port 29102 >----| Stunnel 1 |-----> Port 9102
- |===========|
- stunnel-fd2.conf
- |===========|
- Port 9103 >----| Stunnel 2 |-----> server:29103
- |===========|
- Director (server):
- stunnel-dir.conf
- |===========|
- Port 29102 >----| Stunnel 3 |-----> client:29102
- |===========|
- stunnel-sd.conf
- |===========|
- Port 29103 >----| Stunnel 4 |-----> 9103
- |===========|
-\end{verbatim}
-\normalsize
-
-\section{Certificates}
-\index[general]{Certificates }
-
-In order for stunnel to function as a server, which it does in our diagram for
-Stunnel 1 and Stunnel 4, you must have a certificate and the key. It is
-possible to keep the two in separate files, but normally, you keep them in one
-single .pem file. You may create this certificate yourself in which case, it
-will be self-signed, or you may have it signed by a CA.
-
-If you want your clients to verify that the server is in fact valid (Stunnel 2
-and Stunnel 3), you will need to have the server certificates signed by a CA
-(Certificate Authority), and you will need to have the CA's public certificate
-(contains the CA's public key).
-
-Having a CA signed certificate is {\bf highly} recommended if you are using
-your client across the Internet, otherwise you are exposed to the man in the
-middle attack and hence loss of your data.
-
-See below for how to create a self-signed certificate.
-
-\section{Securing the Data Channel}
-\index[general]{Channel!Securing the Data }
-\index[general]{Securing the Data Channel }
-
-To simplify things a bit, let's for the moment consider only the data channel.
-That is the connection between the File daemon and the Storage daemon, which
-takes place on port 9103. In fact, in a minimalist solution, this is the only
-connection that needs to be encrypted, because it is the one that transports your
-data. The connection between the Director and the File daemon is simply a
-control channel used to start the job and get the job status.
-
-Normally the File daemon will contact the Storage daemon on port 9103
-(supplied by the Director), so we need an stunnel that listens on port 9103 on
-the File daemon's machine, encrypts the data and sends it to the Storage
-daemon. This is depicted by Stunnel 2 above. Note that this stunnel is
-listening on port 9103 and sending to server:29103. We use port 29103 on the
-server because if we would send the data to port 9103, it would go directly to the
-Storage daemon, which doesn't understand encrypted data. On the server
-machine, we run Stunnel 4, which listens on port 29103, decrypts the data and
-sends it to the Storage daemon, which is listening on port 9103.
-
-\section{Data Channel Configuration}
-\index[general]{Modification of bacula-dir.conf for the Data Channel }
-\index[general]{baculoa-dir.conf!Modification for the Data Channel }
-
-The Storage resource of the bacula-dir.conf normally looks something like the
-following:
-
-\footnotesize
-\begin{verbatim}
-Storage {
- Name = File
- Address = server
- SDPort = 9103
- Password = storage_password
- Device = File
- Media Type = File
-}
-\end{verbatim}
-\normalsize
-
-Notice that this is running on the server machine, and it points the File
-daemon back to server:9103, which is where our Storage daemon is listening. We
-modify this to be:
-
-\footnotesize
-\begin{verbatim}
-Storage {
- Name = File
- Address = localhost
- SDPort = 9103
- Password = storage_password
- Device = File
- Media Type = File
-}
-\end{verbatim}
-\normalsize
-
-This causes the File daemon to send the data to the stunnel running on
-localhost (the client machine). We could have used client as the address as
-well.
-
-\section{Stunnel Configuration for the Data Channel}
-\index[general]{Stunnel Configuration for the Data Channel }
-
-In the diagram above, we see above Stunnel 2 that we use stunnel-fd2.conf on the
-client. A pretty much minimal config file would look like the following:
-
-\footnotesize
-\begin{verbatim}
-client = yes
-[29103]
-accept = localhost:9103
-connect = server:29103
-\end{verbatim}
-\normalsize
-
-The above config file does encrypt the data but it does not require a
-certificate, so it is subject to the man in the middle attack. The file I
-actually used, stunnel-fd2.conf, looked like this:
-
-\footnotesize
-\begin{verbatim}
-#
-# Stunnel conf for Bacula client -> SD
-#
-pid = /home/kern/bacula/bin/working/stunnel.pid
-#
-# A cert is not mandatory here. If verify=2, a
-# cert signed by a CA must be specified, and
-# either CAfile or CApath must point to the CA's
-# cert
-#
-cert = /home/kern/stunnel/stunnel.pem
-CAfile = /home/kern/ssl/cacert.pem
-verify = 2
-client = yes
-# debug = 7
-# foreground = yes
-[29103]
-accept = localhost:9103
-connect = server:29103
-\end{verbatim}
-\normalsize
-
-You will notice that I specified a pid file location because I ran stunnel
-under my own userid so I could not use the default, which requires root
-permission. I also specified a certificate that I have as well as verify level
-2 so that the certificate is required and verified, and I must supply the
-location of the CA (Certificate Authority) certificate so that the stunnel
-certificate can be verified. Finally, you will see that there are two lines
-commented out, which when enabled, produce a lot of nice debug info in the
-command window.
-
-If you do not have a signed certificate (stunnel.pem), you need to delete the
-cert, CAfile, and verify lines.
-
-Note that the stunnel.pem, is actually a private key and a certificate in a
-single file. These two can be kept and specified individually, but keeping
-them in one file is more convenient.
-
-The config file, stunnel-sd.conf, needed for Stunnel 4 on the server machine
-is:
-
-\footnotesize
-\begin{verbatim}
-#
-# Bacula stunnel conf for Storage daemon
-#
-pid = /home/kern/bacula/bin/working/stunnel.pid
-#
-# A cert is mandatory here, it may be self signed
-# If it is self signed, the client may not use
-# verify
-#
-cert = /home/kern/stunnel/stunnel.pem
-client = no
-# debug = 7
-# foreground = yes
-[29103]
-accept = 29103
-connect = 9103
-\end{verbatim}
-\normalsize
-
-\section{Starting and Testing the Data Encryption}
-\index[general]{Starting and Testing the Data Encryption }
-\index[general]{Encryption!Starting and Testing the Data }
-
-It will most likely be the simplest to implement the Data Channel encryption
-in the following order:
-
-\begin{itemize}
-\item Setup and run Bacula backing up some data on your client machine
- without encryption.
-\item Stop Bacula.
-\item Modify the Storage resource in the Director's conf file.
-\item Start Bacula
-\item Start stunnel on the server with:
-
- \footnotesize
-\begin{verbatim}
- stunnel stunnel-sd.conf
-
-\end{verbatim}
-\normalsize
-
-\item Start stunnel on the client with:
-
- \footnotesize
-\begin{verbatim}
- stunnel stunnel-fd2.conf
-
-\end{verbatim}
-\normalsize
-
-\item Run a job.
-\item If it doesn't work, turn debug on in both stunnel conf files, restart
- the stunnels, rerun the job, repeat until it works.
- \end{itemize}
-
-\section{Encrypting the Control Channel}
-\index[general]{Channel!Encrypting the Control }
-\index[general]{Encrypting the Control Channel }
-
-The Job control channel is between the Director and the File daemon, and as
-mentioned above, it is not really necessary to encrypt, but it is good
-practice to encrypt it as well. The two stunnels that are used in this case
-will be Stunnel 1 and Stunnel 3 in the diagram above. Stunnel 3 on the server
-might normally listen on port 9102, but if you have a local File daemon, this
-will not work, so we make it listen on port 29102. It then sends the data to
-client:29102. Again we use port 29102 so that the stunnel on the client
-machine can decrypt the data before passing it on to port 9102 where the File
-daemon is listening.
-
-\section{Control Channel Configuration}
-\index[general]{Control Channel Configuration }
-
-We need to modify the standard Client resource, which would normally look
-something like:
-
-\footnotesize
-\begin{verbatim}
-Client {
- Name = client-fd
- Address = client
- FDPort = 9102
- Catalog = BackupDB
- Password = "xxx"
-}
-\end{verbatim}
-\normalsize
-
-to be:
-
-\footnotesize
-\begin{verbatim}
-Client {
- Name = client-fd
- Address = localhost
- FDPort = 29102
- Catalog = BackupDB
- Password = "xxx"
-}
-\end{verbatim}
-\normalsize
-
-This will cause the Director to send the control information to
-localhost:29102 instead of directly to the client.
-
-\section{Stunnel Configuration for the Control Channel}
-\index[general]{Config Files for stunnel to Encrypt the Control Channel }
-
-The stunnel config file, stunnel-dir.conf, for the Director's machine would
-look like the following:
-
-\footnotesize
-\begin{verbatim}
-#
-# Bacula stunnel conf for the Directory to contact a client
-#
-pid = /home/kern/bacula/bin/working/stunnel.pid
-#
-# A cert is not mandatory here. If verify=2, a
-# cert signed by a CA must be specified, and
-# either CAfile or CApath must point to the CA's
-# cert
-#
-cert = /home/kern/stunnel/stunnel.pem
-CAfile = /home/kern/ssl/cacert.pem
-verify = 2
-client = yes
-# debug = 7
-# foreground = yes
-[29102]
-accept = localhost:29102
-connect = client:29102
-\end{verbatim}
-\normalsize
-
-and the config file, stunnel-fd1.conf, needed to run stunnel on the Client
-would be:
-
-\footnotesize
-\begin{verbatim}
-#
-# Bacula stunnel conf for the Directory to contact a client
-#
-pid = /home/kern/bacula/bin/working/stunnel.pid
-#
-# A cert is not mandatory here. If verify=2, a
-# cert signed by a CA must be specified, and
-# either CAfile or CApath must point to the CA's
-# cert
-#
-cert = /home/kern/stunnel/stunnel.pem
-CAfile = /home/kern/ssl/cacert.pem
-verify = 2
-client = yes
-# debug = 7
-# foreground = yes
-[29102]
-accept = localhost:29102
-connect = client:29102
-\end{verbatim}
-\normalsize
-
-\section{Starting and Testing the Control Channel}
-\index[general]{Starting and Testing the Control Channel }
-\index[general]{Channel!Starting and Testing the Control }
-
-It will most likely be the simplest to implement the Control Channel
-encryption in the following order:
-
-\begin{itemize}
-\item Stop Bacula.
-\item Modify the Client resource in the Director's conf file.
-\item Start Bacula
-\item Start stunnel on the server with:
-
- \footnotesize
-\begin{verbatim}
- stunnel stunnel-dir.conf
-
-\end{verbatim}
-\normalsize
-
-\item Start stunnel on the client with:
-
- \footnotesize
-\begin{verbatim}
- stunnel stunnel-fd1.conf
-
-\end{verbatim}
-\normalsize
-
-\item Run a job.
-\item If it doesn't work, turn debug on in both stunnel conf files, restart
- the stunnels, rerun the job, repeat until it works.
- \end{itemize}
-
-\section{Using stunnel to Encrypt to a Second Client}
-\index[general]{Using stunnel to Encrypt to a Second Client }
-\index[general]{Client!Using stunnel to Encrypt to a Second }
-
-On the client machine, you can just duplicate the setup that you have on the
-first client file for file and it should work fine.
-
-In the bacula-dir.conf file, you will want to create a second client pretty
-much identical to how you did for the first one, but the port number must be
-unique. We previously used:
-
-\footnotesize
-\begin{verbatim}
-Client {
- Name = client-fd
- Address = localhost
- FDPort = 29102
- Catalog = BackupDB
- Password = "xxx"
-}
-\end{verbatim}
-\normalsize
-
-so for the second client, we will, of course, have a different name, and we
-will also need a different port. Remember that we used port 29103 for the
-Storage daemon, so for the second client, we can use port 29104, and the
-Client resource would look like:
-
-\footnotesize
-\begin{verbatim}
-Client {
- Name = client2-fd
- Address = localhost
- FDPort = 29104
- Catalog = BackupDB
- Password = "yyy"
-}
-\end{verbatim}
-\normalsize
-
-Now, fortunately, we do not need a third stunnel to on the Director's machine,
-we can just add the new port to the config file, stunnel-dir.conf, to make:
-
-\footnotesize
-\begin{verbatim}
-#
-# Bacula stunnel conf for the Directory to contact a client
-#
-pid = /home/kern/bacula/bin/working/stunnel.pid
-#
-# A cert is not mandatory here. If verify=2, a
-# cert signed by a CA must be specified, and
-# either CAfile or CApath must point to the CA's
-# cert
-#
-cert = /home/kern/stunnel/stunnel.pem
-CAfile = /home/kern/ssl/cacert.pem
-verify = 2
-client = yes
-# debug = 7
-# foreground = yes
-[29102]
-accept = localhost:29102
-connect = client:29102
-[29104]
-accept = localhost:29102
-connect = client2:29102
-\end{verbatim}
-\normalsize
-
-There are no changes necessary to the Storage daemon or the other stunnel so
-that this new client can talk to our Storage daemon.
-
-\section{Creating a Self-signed Certificate}
-\index[general]{Creating a Self-signed Certificate }
-\index[general]{Certificate!Creating a Self-signed }
-
-You may create a self-signed certificate for use with stunnel that will permit
-you to make it function, but will not allow certificate validation. The .pem
-file containing both the certificate and the key can be made with the
-following, which I put in a file named {\bf makepem}:
-
-\footnotesize
-\begin{verbatim}
-#!/bin/sh
-#
-# Simple shell script to make a .pem file that can be used
-# with stunnel and Bacula
-#
-OPENSSL=openssl
- umask 77
- PEM1="/bin/mktemp openssl.XXXXXX"
- PEM2="/bin/mktemp openssl.XXXXXX"
- ${OPENSSL} req -newkey rsa:1024 -keyout $PEM1 -nodes \
- -x509 -days 365 -out $PEM2
- cat $PEM1 > stunnel.pem
- echo "" >>stunnel.pem
- cat $PEM2 >>stunnel.pem
- rm $PEM1 $PEM2
-\end{verbatim}
-\normalsize
-
-The above script will ask you a number of questions. You may simply answer
-each of them by entering a return, or if you wish you may enter your own data.
-
-
-\section{Getting a CA Signed Certificate}
-\index[general]{Certificate!Getting a CA Signed }
-\index[general]{Getting a CA Signed Certificate }
-
-The process of getting a certificate that is signed by a CA is quite a bit
-more complicated. You can purchase one from quite a number of PKI vendors, but
-that is not at all necessary for use with Bacula.
-
-To get a CA signed
-certificate, you will either need to find a friend that has setup his own CA
-or to become a CA yourself, and thus you can sign all your own certificates.
-The book OpenSSL by John Viega, Matt Mesier \& Pravir Chandra from O'Reilly
-explains how to do it, or you can read the documentation provided in the
-Open-source PKI Book project at Source Forge:
-\elink{
-http://ospkibook.sourceforge.net/docs/OSPKI-2.4.7/OSPKI-html/ospki-book.htm}
-{http://ospkibook.sourceforge.net/docs/OSPKI-2.4.7/OSPKI-html/ospki-book.htm}.
-Note, this link may change.
-
-\section{Using ssh to Secure the Communications}
-\index[general]{Communications!Using ssh to Secure the }
-\index[general]{Using ssh to Secure the Communications }
-
-Please see the script {\bf ssh-tunnel.sh} in the {\bf examples} directory. It
-was contributed by Stephan Holl.
+++ /dev/null
-#!/usr/bin/perl -w
-#
-use strict;
-
-# Used to change the names of the image files generated by latex2html from imgxx.png
-# to meaningful names. Provision is made to go either from or to the meaningful names.
-# The meaningful names are obtained from a file called imagename_translations, which
-# is generated by extensions to latex2html in the make_image_file subroutine in
-# bacula.perl.
-
-# Opens the file imagename_translations and reads the contents into a hash.
-# The hash is creaed with the imgxx.png files as the key if processing TO
-# meaningful filenames, and with the meaningful filenames as the key if
-# processing FROM meaningful filenames.
-# Then opens the html file(s) indicated in the command-line arguments and
-# changes all image references according to the translations described in the
-# above file. Finally, it renames the image files.
-#
-# Original creation: 3-27-05 by Karl Cunningham.
-# Modified 5-21-05 to go FROM and TO meaningful filenames.
-#
-my $TRANSFILE = "imagename_translations";
-my $path;
-
-# Loads the contents of $TRANSFILE file into the hash referenced in the first
-# argument. The hash is loaded to translate old to new if $direction is 0,
-# otherwise it is loaded to translate new to old. In this context, the
-# 'old' filename is the meaningful name, and the 'new' filename is the
-# imgxx.png filename. It is assumed that the old image is the one that
-# latex2html has used as the source to create the imgxx.png filename.
-# The filename extension is taken from the file
-sub read_transfile {
- my ($trans,$direction) = @_;
-
- if (!open IN,"<$path$TRANSFILE") {
- print "WARNING: Cannot open image translation file $path$TRANSFILE for reading\n";
- print " Image filename translation aborted\n\n";
- exit 0;
- }
-
- while (<IN>) {
- chomp;
- my ($new,$old) = split(/\001/);
-
- # Old filenames will usually have a leading ./ which we don't need.
- $old =~ s/^\.\///;
-
- # The filename extension of the old filename must be made to match
- # the new filename because it indicates the encoding format of the image.
- my ($ext) = $new =~ /(\.[^\.]*)$/;
- $old =~ s/\.[^\.]*$/$ext/;
- if ($direction == 0) {
- $trans->{$new} = $old;
- } else {
- $trans->{$old} = $new;
- }
- }
- close IN;
-}
-
-# Translates the image names in the file given as the first argument, according to
-# the translations in the hash that is given as the second argument.
-# The file contents are read in entirely into a string, the string is processed, and
-# the file contents are then written. No particular care is taken to ensure that the
-# file is not lost if a system failure occurs at an inopportune time. It is assumed
-# that the html files being processed here can be recreated on demand.
-#
-# Links to other files are added to the %filelist for processing. That way,
-# all linked files will be processed (assuming they are local).
-sub translate_html {
- my ($filename,$trans,$filelist) = @_;
- my ($contents,$out,$this,$img,$dest);
- my $cnt = 0;
-
- # If the filename is an external link ignore it. And drop any file:// from
- # the filename.
- $filename =~ /^(http|ftp|mailto)\:/ and return 0;
- $filename =~ s/^file\:\/\///;
- # Load the contents of the html file.
- if (!open IF,"<$path$filename") {
- print "WARNING: Cannot open $path$filename for reading\n";
- print " Image Filename Translation aborted\n\n";
- exit 0;
- }
-
- while (<IF>) {
- $contents .= $_;
- }
- close IF;
-
- # Now do the translation...
- # First, search for an image filename.
- while ($contents =~ /\<\s*IMG[^\>]*SRC=\"/si) {
- $contents = $';
- $out .= $` . $&;
-
- # The next thing is an image name. Get it and translate it.
- $contents =~ /^(.*?)\"/s;
- $contents = $';
- $this = $&;
- $img = $1;
- # If the image is in our list of ones to be translated, do it
- # and feed the result to the output.
- $cnt += $this =~ s/$img/$trans->{$img}/ if (defined($trans->{$img}));
- $out .= $this;
- }
- $out .= $contents;
-
- # Now send the translated text to the html file, overwriting what's there.
- open OF,">$path$filename" or die "Cannot open $path$filename for writing\n";
- print OF $out;
- close OF;
-
- # Now look for any links to other files and add them to the list of files to do.
- while ($out =~ /\<\s*A[^\>]*HREF=\"(.*?)\"/si) {
- $out = $';
- $dest = $1;
- # Drop an # and anything after it.
- $dest =~ s/\#.*//;
- $filelist->{$dest} = '' if $dest;
- }
- return $cnt;
-}
-
-# REnames the image files spefified in the %translate hash.
-sub rename_images {
- my $translate = shift;
- my ($response);
-
- foreach (keys(%$translate)) {
- if (! $translate->{$_}) {
- print " WARNING: No destination Filename for $_\n";
- } else {
- $response = `mv -f $path$_ $path$translate->{$_} 2>&1`;
- $response and print "ERROR from system $response\n";
- }
- }
-}
-
-#################################################
-############# MAIN #############################
-################################################
-
-# %filelist starts out with keys from the @ARGV list. As files are processed,
-# any links to other files are added to the %filelist. A hash of processed
-# files is kept so we don't do any twice.
-
-# The first argument must be either --to_meaningful_names or --from_meaningful_names
-
-my (%translate,$search_regex,%filelist,%completed,$thisfile);
-my ($cnt,$direction);
-
-my $arg0 = shift(@ARGV);
-$arg0 =~ /^(--to_meaningful_names|--from_meaningful_names)$/ or
- die "ERROR: First argument must be either \'--to_meaningful_names\' or \'--from_meaningful_names\'\n";
-
-$direction = ($arg0 eq '--to_meaningful_names') ? 0 : 1;
-
-(@ARGV) or die "ERROR: Filename(s) to process must be given as arguments\n";
-
-# Use the first argument to get the path to the file of translations.
-my $tmp = $ARGV[0];
-($path) = $tmp =~ /(.*\/)/;
-$path = '' unless $path;
-
-read_transfile(\%translate,$direction);
-
-foreach (@ARGV) {
- # Strip the path from the filename, and use it later on.
- if (s/(.*\/)//) {
- $path = $1;
- } else {
- $path = '';
- }
- $filelist{$_} = '';
-
- while ($thisfile = (keys(%filelist))[0]) {
- $cnt += translate_html($thisfile,\%translate,\%filelist) if (!exists($completed{$thisfile}));
- delete($filelist{$thisfile});
- $completed{$thisfile} = '';
- }
- print "translate_images.pl: $cnt image filenames translated ",($direction)?"from":"to"," meaningful names\n";
-}
-
-rename_images(\%translate);
+++ /dev/null
-%%
-%%
-
-\chapter{Variable Expansion}
-\label{VarsChapter}
-\index[general]{Variable Expansion }
-\index[general]{Expansion!Variable }
-
-% TODO: does the following mean that this should not be in book?
-
-Please note that as of version 1.37, the Variable Expansion
-is deprecated and replaced by Python scripting (not yet
-documented).
-
-Variable expansion is somewhat similar to Unix shell variable expansion.
-Currently (version 1.31), it is used only in format labels, but in the future,
-it will most likely be used in more places.
-
-\section{General Functionality}
-\index[general]{Functionality!General }
-\index[general]{General Functionality }
-
-This is basically a string expansion capability that permits referencing
-variables, indexing arrays, conditional replacement of variables, case
-conversion, substring selection, regular expression matching and replacement,
-character class replacement, padding strings, repeated expansion in a user
-controlled loop, support of arithmetic expressions in the loop start, step and
-end conditions, and recursive expansion.
-
-When using variable expansion characters in a Volume Label Format record, the
-format should always be enclosed in double quotes ({\bf "}).
-
-For example, {\bf \$\{HOME\}} will be replaced by your home directory as
-defined in the environment. If you have defined the variable {\bf xxx} to be
-{\bf Test}, then the reference {\bf \$\{xxx:p/7/Y/r\}} will right pad the
-contents of {\bf xxx} to a length of seven characters filling with the
-character {\bf Y} giving {\bf YYYTest}.
-
-\section{Bacula Variables}
-\index[general]{Bacula Variables }
-\index[general]{Variables!Bacula }
-
-Within Bacula, there are three main classes of variables with some minor
-variations within the classes. The classes are:
-
-\begin{description}
-
-\item [Counters]
- \index[general]{Counters }
- Counters are defined by the {\bf Counter} resources in the Director's conf
-file. The counter can either be a temporary counter that lasts for the
-duration of Bacula's execution, or it can be a variable that is stored in
-the catalog, and thus retains its value from one Bacula execution to another.
-Counter variables may be incremented by postfixing a plus sign ({\bf +} after
-the variable name).
-
-\item [Internal Variables]
- \index[general]{Internal Variables }
- Internal variables are read-only, and may be related to the current job (i.e.
-Job name), or maybe special variables such as the date and time. The
-following variables are available:
-
-\begin{itemize}
-\item [Year] -- the full year
-\item [Month] -- the current month 1-12
-\item [Day] -- the day of the month 1-31
-\item [Hour] -- the hour 0-24
-\item [Minute] -- the current minute 0-59
-\item [Second] -- the current second 0-59
-\item [WeekDay] -- the current day of the week 0-6 with 0 being Sunday
-\item [Job] -- the job name
-\item [general] -- the Director's name
-\item [Level] -- the Job Level
-\item [Type] -- the Job type
-\item [JobId] -- the JobId
-\item [JobName] -- the unique job name composed of Job and date
-\item [Storage] -- the Storage daemon's name
-\item [Client] -- the Client's name
-\item [NumVols] -- the current number of Volumes in the Pool
-\item [Pool] -- the Pool name
-\item [Catalog] -- the Catalog name
-\item [MediaType] -- the Media Type
- \end{itemize}
-
-\item [Environment Variables]
- \index[general]{Environment Variables }
- Environment variables are read-only, and must be defined in the environment
-prior to executing Bacula. Environment variables may be either scalar or an
-array, where the elements of the array are referenced by subscripting the
-variable name (e.g. {\bf \$\{Months[3]\}}). Environment variable arrays are
-defined by separating the elements with a vertical bar ({\bf |}), thus {\bf
-set Months="Jan|Feb|Mar|Apr|..."} defines an environment variable named
-{\bf Month} that will be treated as an array, and the reference {\bf
-\$\{Months[3]\}} will yield {\bf Mar}. The elements of the array can have
-differing lengths.
-\end{description}
-
-\section{Full Syntax}
-\index[general]{Syntax!Full }
-\index[general]{Full Syntax }
-
-Since the syntax is quite extensive, below, you will find the pseudo BNF. The
-special characters have the following meaning:
-
-\footnotesize
-\begin{verbatim}
- ::= definition
- ( ) grouping if the parens are not quoted
- | separates alternatives
- '/' literal / (or any other character)
- CAPS a character or character sequence
- * preceding item can be repeated zero or more times
- ? preceding item can appear zero or one time
- + preceding item must appear one or more times
-\end{verbatim}
-\normalsize
-
-And the pseudo BNF describing the syntax is:
-
-\footnotesize
-\begin{verbatim}
- input ::= ( TEXT
- | variable
- | INDEX_OPEN input INDEX_CLOSE (loop_limits)?
- )*
- variable ::= DELIM_INIT (name|expression)
- name ::= (NAME_CHARS)+
- expression ::= DELIM_OPEN
- (name|variable)+
- (INDEX_OPEN num_exp INDEX_CLOSE)?
- (':' command)*
- DELIM_CLOSE
- command ::= '-' (TEXT_EXP|variable)+
- | '+' (TEXT_EXP|variable)+
- | 'o' NUMBER ('-'|',') (NUMBER)?
- | '#'
- | '*' (TEXT_EXP|variable)+
- | 's' '/' (TEXT_PATTERN)+
- '/' (variable|TEXT_SUBST)*
- '/' ('m'|'g'|'i'|'t')*
- | 'y' '/' (variable|TEXT_SUBST)+
- '/' (variable|TEXT_SUBST)*
- '/'
- | 'p' '/' NUMBER
- '/' (variable|TEXT_SUBST)*
- '/' ('r'|'l'|'c')
- | '%' (name|variable)+
- ('(' (TEXT_ARGS)? ')')?
- | 'l'
- | 'u'
- num_exp ::= operand
- | operand ('+'|'-'|'*'|'/'|'%') num_exp
- operand ::= ('+'|'-')? NUMBER
- | INDEX_MARK
- | '(' num_exp ')'
- | variable
- loop_limits ::= DELIM_OPEN
- (num_exp)? ',' (num_exp)? (',' (num_exp)?)?
- DELIM_CLOSE
- NUMBER ::= ('0'|...|'9')+
- TEXT_PATTERN::= (^('/'))+
- TEXT_SUBST ::= (^(DELIM_INIT|'/'))+
- TEXT_ARGS ::= (^(DELIM_INIT|')'))+
- TEXT_EXP ::= (^(DELIM_INIT|DELIM_CLOSE|':'|'+'))+
- TEXT ::= (^(DELIM_INIT|INDEX_OPEN|INDEX_CLOSE))+
- DELIM_INIT ::= '$'
- DELIM_OPEN ::= '{'
- DELIM_CLOSE ::= '}'
- INDEX_OPEN ::= '['
- INDEX_CLOSE ::= ']'
- INDEX_MARK ::= '#'
- NAME_CHARS ::= 'a'|...|'z'|'A'|...|'Z'|'0'|...|'9'
-\end{verbatim}
-\normalsize
-
-\section{Semantics}
-\index[general]{Semantics }
-
-The items listed in {\bf command} above, which always follow a colon ({\bf :})
-have the following meanings:
-
-\footnotesize
-\begin{verbatim}
- - perform substitution if variable is empty
- + perform substitution if variable is not empty
- o cut out substring of the variable value
- # length of the variable value
- * substitute empty string if the variable value is not empty,
- otherwise substitute the trailing parameter
- s regular expression search and replace. The trailing
- options are: m = multiline, i = case insensitive,
- g = global, t = plain text (no regexp)
- y transpose characters from class A to class B
- p pad variable to l = left, r = right or c = center,
- with second value.
- % special function call (none implemented)
- l lower case the variable value
- u upper case the variable value
-\end{verbatim}
-\normalsize
-
-The {\bf loop\_limits} are start, step, and end values.
-
-A counter variable name followed immediately by a plus ({\bf +}) will cause
-the counter to be incremented by one.
-
-\section{Examples}
-\index[general]{Examples }
-
-To create an ISO date:
-
-\footnotesize
-\begin{verbatim}
- DLT-${Year}-${Month:p/2/0/r}-${Day:p/2/0/r}
-\end{verbatim}
-\normalsize
-
-on 20 June 2003 would give {\bf DLT-2003-06-20}
-
-If you set the environment variable {\bf mon} to
-
-\footnotesize
-\begin{verbatim}
- January|February|March|April|May|...
- File-${mon[${Month}]}/${Day}/${Year}
-\end{verbatim}
-\normalsize
-
-on the first of March would give {\bf File-March/1/2003 }
+++ /dev/null
-#
-#
-# Makefile for LaTeX
-#
-# To build everything do
-# make tex
-# make web
-# make html
-# make dvipdf
-#
-# or simply
-#
-# make
-#
-# for rapid development do:
-# make tex
-# make show
-#
-#
-# If you are having problems getting "make" to work, debugging it is
-# easier if can see the output from latex, which is normally redirected
-# to /dev/null. To see it, do the following:
-#
-# cd docs/manual
-# make tex
-# latex bacula.tex
-#
-# typically the latex command will stop indicating the error (e.g. a
-# missing \ in front of a _ or a missing { or ] ...
-#
-# The following characters must be preceded by a backslash
-# to be entered as printable characters:
-#
-# # $ % & ~ _ ^ \ { }
-#
-
-IMAGES=../../../images
-
-DOC=problems
-
-first_rule: all
-
-all: tex web dvipdf mini-clean
-
-.SUFFIXES: .tex .html
-.PHONY:
-.DONTCARE:
-
-
-tex:
- @./update_version
- @echo "Making version `cat version.tex`"
- @cp -fp ${IMAGES}/hires/*.eps .
- @touch ${DOC}i-dir.tex ${DOC}i-fd.tex ${DOC}i-sd.tex \
- ${DOC}i-console.tex ${DOC}i-general.tex
- latex -interaction=batchmode ${DOC}.tex
- makeindex ${DOC}.idx -o ${DOC}.ind 2>/dev/null
- latex -interaction=batchmode ${DOC}.tex
-
-pdf:
- @echo "Making pdfm"
- @cp -fp ${IMAGES}/hires/*.eps .
- dvipdfm -p a4 ${DOC}.dvi
-
-dvipdf:
- @echo "Making dvi to pdf"
- @cp -fp ${IMAGES}/hires/*.eps .
- dvipdf ${DOC}.dvi ${DOC}.pdf
-
-html:
- @echo " "
- @echo "Making html"
- @cp -fp ${IMAGES}/*.eps .
- @rm -f next.eps next.png prev.eps prev.png up.eps up.png
- @(if [ -f imagename_translations ] ; then \
- ./translate_images.pl --from_meaningful_names ${DOC}.html; \
- fi)
- latex2html -white -no_subdir -split 0 -toc_stars -white -notransparent \
- -init_file latex2html-init.pl ${DOC} >tex.out 2>&1
- ./translate_images.pl --to_meaningful_names ${DOC}.html
- @echo "Done making html"
-
-web:
- @echo "Making web"
- @mkdir -p ${DOC}
- @cp -fp ${IMAGES}/*.eps .
- @rm -f next.eps next.png prev.eps prev.png up.eps up.png
- @cp -fp ${IMAGES}/*.eps ${DOC}/
- @cp -fp ${IMAGES}/*.eps ${IMAGES}/*.png ${DOC}/
- @rm -f ${DOC}/xp-*.png
- @rm -f ${DOC}/next.eps ${DOC}/next.png ${DOC}/prev.eps ${DOC}/prev.png ${DOC}/up.eps ${DOC}/up.png
- @rm -rf ${DOC}/*.html
- latex2html -split 3 -local_icons -t "Bacula Problem Resolution Guide" -long_titles 4 \
- -toc_stars -contents_in_nav -init_file latex2html-init.pl -white -notransparent ${DOC} >tex.out 2>&1
- ./translate_images.pl --to_meaningful_names ${DOC}/Bacula_Proble*.html
- @echo "Done making web"
-show:
- xdvi ${DOC}
-
-texcheck:
- ./check_tex.pl ${DOC}.tex
-
-main_configs:
- pic2graph -density 100 <main_configs.pic >main_configs.png
-
-mini-clean:
- @rm -f 1 2 3 *.tex~
- @rm -f *.gif *.jpg *.eps
- @rm -f *.aux *.cp *.fn *.ky *.log *.pg
- @rm -f *.backup *.ilg *.lof *.lot
- @rm -f *.cdx *.cnd *.ddx *.ddn *.fdx *.fnd *.ind *.sdx *.snd
- @rm -f *.dnd *.old *.out
- @rm -f ${DOC}/*.gif ${DOC}/*.jpg ${DOC}/*.eps
- @rm -f ${DOC}/*.aux ${DOC}/*.cp ${DOC}/*.fn ${DOC}/*.ky ${DOC}/*.log ${DOC}/*.pg
- @rm -f ${DOC}/*.backup ${DOC}/*.ilg ${DOC}/*.lof ${DOC}/*.lot
- @rm -f ${DOC}/*.cdx ${DOC}/*.cnd ${DOC}/*.ddx ${DOC}/*.ddn ${DOC}/*.fdx ${DOC}/*.fnd ${DOC}/*.ind ${DOC}/*.sdx ${DOC}/*.snd
- @rm -f ${DOC}/*.dnd ${DOC}/*.old ${DOC}/*.out
- @rm -f ${DOC}/WARNINGS
- @rm -f ${DOC}i-*.tex
-
-
-clean:
- @rm -f 1 2 3 *.tex~
- @rm -f *.png *.gif *.jpg *.eps
- @rm -f *.pdf *.aux *.cp *.fn *.ky *.log *.pg
- @rm -f *.html *.backup *.ps *.dvi *.ilg *.lof *.lot
- @rm -f *.cdx *.cnd *.ddx *.ddn *.fdx *.fnd *.ind *.sdx *.snd
- @rm -f *.dnd imagename_translations
- @rm -f *.old WARNINGS *.out *.toc *.idx
- @rm -f ${DOC}i-*.tex
- @rm -rf ${DOC}
-
-
-distclean: clean
- @rm -f images.pl labels.pl internals.pl
- @rm -f Makefile version.tex
+++ /dev/null
-#!/usr/bin/perl -w
-# Finds potential problems in tex files, and issues warnings to the console
-# about what it finds. Takes a list of files as its only arguments,
-# and does checks on all the files listed. The assumption is that these are
-# valid (or close to valid) LaTeX files. It follows \include statements
-# recursively to pick up any included tex files.
-#
-#
-#
-# Currently the following checks are made:
-#
-# -- Multiple hyphens not inside a verbatim environment (or \verb). These
-# should be placed inside a \verb{} contruct so they will not be converted
-# to single hyphen by latex and latex2html.
-
-
-# Original creation 3-8-05 by Karl Cunningham karlc -at- keckec -dot- com
-#
-#
-
-use strict;
-
-# The following builds the test string to identify and change multiple
-# hyphens in the tex files. Several constructs are identified but only
-# multiple hyphens are changed; the others are fed to the output
-# unchanged.
-my $b = '\\\\begin\\*?\\s*\\{\\s*'; # \begin{
-my $e = '\\\\end\\*?\\s*\\{\\s*'; # \end{
-my $c = '\\s*\\}'; # closing curly brace
-
-# This captures entire verbatim environments. These are passed to the output
-# file unchanged.
-my $verbatimenv = $b . "verbatim" . $c . ".*?" . $e . "verbatim" . $c;
-
-# This captures \verb{..{ constructs. They are passed to the output unchanged.
-my $verb = '\\\\verb\\*?(.).*?\\1';
-
-# This captures multiple hyphens with a leading and trailing space. These are not changed.
-my $hyphsp = '\\s\\-{2,}\\s';
-
-# This identifies other multiple hyphens.
-my $hyphens = '\\-{2,}';
-
-# This identifies \hyperpage{..} commands, which should be ignored.
-my $hyperpage = '\\\\hyperpage\\*?\\{.*?\\}';
-
-# This builds the actual test string from the above strings.
-#my $teststr = "$verbatimenv|$verb|$tocentry|$hyphens";
-my $teststr = "$verbatimenv|$verb|$hyphsp|$hyperpage|$hyphens";
-
-
-sub get_includes {
- # Get a list of include files from the top-level tex file. The first
- # argument is a pointer to the list of files found. The rest of the
- # arguments is a list of filenames to check for includes.
- my $files = shift;
- my ($fileline,$includefile,$includes);
-
- while (my $filename = shift) {
- # Get a list of all the html files in the directory.
- open my $if,"<$filename" or die "Cannot open input file $filename\n";
- $fileline = 0;
- $includes = 0;
- while (<$if>) {
- chomp;
- $fileline++;
- # If a file is found in an include, process it.
- if (($includefile) = /\\include\s*\{(.*?)\}/) {
- $includes++;
- # Append .tex to the filename
- $includefile .= '.tex';
-
- # If the include file has already been processed, issue a warning
- # and don't do it again.
- my $found = 0;
- foreach (@$files) {
- if ($_ eq $includefile) {
- $found = 1;
- last;
- }
- }
- if ($found) {
- print "$includefile found at line $fileline in $filename was previously included\n";
- } else {
- # The file has not been previously found. Save it and
- # recursively process it.
- push (@$files,$includefile);
- get_includes($files,$includefile);
- }
- }
- }
- close IF;
- }
-}
-
-
-sub check_hyphens {
- my (@files) = @_;
- my ($filedata,$this,$linecnt,$before);
-
- # Build the test string to check for the various environments.
- # We only do the conversion if the multiple hyphens are outside of a
- # verbatim environment (either \begin{verbatim}...\end{verbatim} or
- # \verb{--}). Capture those environments and pass them to the output
- # unchanged.
-
- foreach my $file (@files) {
- # Open the file and load the whole thing into $filedata. A bit wasteful but
- # easier to deal with, and we don't have a problem with speed here.
- $filedata = "";
- open IF,"<$file" or die "Cannot open input file $file";
- while (<IF>) {
- $filedata .= $_;
- }
- close IF;
-
- # Set up to process the file data.
- $linecnt = 1;
-
- # Go through the file data from beginning to end. For each match, save what
- # came before it and what matched. $filedata now becomes only what came
- # after the match.
- # Chech the match to see if it starts with a multiple-hyphen. If so
- # warn the user. Keep track of line numbers so they can be output
- # with the warning message.
- while ($filedata =~ /$teststr/os) {
- $this = $&;
- $before = $`;
- $filedata = $';
- $linecnt += $before =~ tr/\n/\n/;
-
- # Check if the multiple hyphen is present outside of one of the
- # acceptable constructs.
- if ($this =~ /^\-+/) {
- print "Possible unwanted multiple hyphen found in line ",
- "$linecnt of file $file\n";
- }
- $linecnt += $this =~ tr/\n/\n/;
- }
- }
-}
-##################################################################
-# MAIN ####
-##################################################################
-
-my (@includes,$cnt);
-
-# Examine the file pointed to by the first argument to get a list of
-# includes to test.
-get_includes(\@includes,@ARGV);
-
-check_hyphens(@includes);
+++ /dev/null
-#
-# Avoid that @VERSION@ and @DATE@ are changed by configure
-# This file is sourced by update_version
-#
-echo "s%@VERSION@%${VERSION}%g" >${out}
-echo "s%@DATE@%${DATE}%g" >>${out}
+++ /dev/null
-%%
-%%
-% TODO: maybe merge all this FAQ in with the appropriate section?
-% TODO: and use detailed indexing to help reader
-
-\chapter{Bacula Frequently Asked Questions}
-\label{FaqChapter}
-\index[general]{Questions!Bacula Frequently Asked }
-\index[general]{Bacula Frequently Asked Questions }
-
-These are questions that have been submitted over time by the
-Bacula users. The following
-FAQ is very useful, but it is not always up to date
-with newer information, so after reading it, if you don't find what you
-want, you might try the Bacula wiki maintained by Frank Sweetser, which
-contains more than just a FAQ:
-\elink{http://wiki.bacula.org}{\url{http://wiki.bacula.org}}
-or go directly to the FAQ at:
-\elink{http://wiki.bacula.org/doku.php?id=faq}
-{\url{http://wiki.bacula.org/doku.php?id=faq}}.
-
-Please also see
-\ilink{the bugs section}{BugsChapter} of this document for a list
-of known bugs and solutions.
-
-\begin{description}
-\label{what}
-\section{What is Bacula?}
-\item [What is {\bf Bacula}? ]
- \index[general]{What is Bacula? }
- {\bf Bacula} is a network backup and restore program.
-
-\section{Does Bacula support Windows?}
-\item [Does Bacula support Windows?]
-\index[general]{Does Bacula support Windows? }
- Yes, Bacula compiles and runs on Windows machines (Win98, WinMe, WinXP,
- WinNT, Win2003, and Win2000). We provide a binary version of the Client
- (bacula-fd), but have not tested the Director nor the Storage daemon.
- Note, Win95 is no longer supported because it doesn't have the
- GetFileAttributesExA API call.
-
-
-\label{lang}
-\section{What language is Bacula written in?}
-\item [What language is Bacula written in?]
-\index[general]{What language is Bacula written in? }
- It is written in C++, but it is mostly C code using only a limited set of
- the C++ extensions over C. Thus Bacula is completely compiled using the
- C++ compiler. There are several modules, including the Win32 interface, that
- are written using the object oriented C++ features. Over time, we are slowly
- adding a larger subset of C++.
-
-\label{run}
-\section{On what machines does Bacula run?}
-\item [On what machines does Bacula run? ]
- \index[general]{On what machines does Bacula run? }
- {\bf Bacula} builds and executes on Red Hat Linux (versions RH7.1-RHEL
- 4.0, Fedora, SuSE, Gentoo, Debian, Mandriva, ...), FreeBSD, Solaris,
- Alpha, SGI (client), NetBSD, OpenBSD, Mac OS X (client), and Win32.
-
- Bacula has been my only backup tool for over seven years backing up 8
- machines nightly (6 Linux boxes running SuSE, previously
- Red Hat and Fedora, a WinXP machine, and a WinNT machine).
-
-
-\label{stable}
-\section{Is Bacula Stable?}
-\item [Is Bacula Stable? ]
-\index[general]{Is Bacula Stable? }
- Yes, it is remarkably stable, but remember, there are still a lot of
- unimplemented or partially implemented features. With a program of this
- size (150,000+ lines of C++ code not including the SQL programs) there
- are bound to be bugs. The current test environment (a twisted pair
- local network and a HP DLT backup tape) is not exactly ideal, so
- additional testing on other sites is necessary. The File daemon has
- never crashed -- running months at a time with no intervention. The
- Storage daemon is remarkably stable with most of the problems arising
- during labeling or switching tapes. Storage daemon crashes are rare
- but running multiple drives and simultaneous jobs sometimes (rarely)
- problems.
- The Director, given the multitude of functions it fulfills is also
- relatively stable. In a production environment, it rarely if ever
- crashes. Of the three daemons, the Director is the most prone to having
- problems. Still, it frequently runs several months with no problems.
-
- There are a number of reasons for this stability.
-
- \begin{enumerate}
- \item The program is constantly checking the chain of allocated
- memory buffers to ensure that no overruns have occurred. \\
- \item All memory leaks (orphaned buffers) are reported each time the
- program terminates.\\
- \item Any signal (segmentation fault, ...) generates a
- traceback that is emailed to the developer. This permits quick
- resolution of bugs even if they only show up rarely in a production
- system.\\
- \item There is a reasonably comprehensive set of regression tests
- that avoids re-creating the most common errors in new versions of
- Bacula.
- \end{enumerate}
-
-\label{AuthorizationErrors}
-\section{I'm Getting Authorization Errors. What is Going On? }
-\item [I'm Getting Authorization Errors. What is Going On? ]
-\index[general]{Authorization Errors}
-\index[general]{Concurrent Jobs}
- For security reasons, Bacula requires that both the File daemon and the
- Storage daemon know the name of the Director as well as its password. As a
- consequence, if you change the Director's name or password, you must make
- the corresponding change in the Storage daemon's and in the File daemon's
- configuration files.
-
- During the authorization process, the Storage daemon and File daemon
- also require that the Director authenticates itself, so both ends
- require the other to have the correct name and password.
-
- If you have edited the conf files and modified any name or any password,
- and you are getting authentication errors, then your best bet is to go
- back to the original conf files generated by the Bacula installation
- process. Make only the absolutely necessary modifications to these
- files -- e.g. add the correct email address. Then follow the
- instructions in the \ilink{ Running Bacula}{TutorialChapter} chapter of
- this manual. You will run a backup to disk and a restore. Only when
- that works, should you begin customization of the conf files.
-
- Another reason that you can get authentication errors is if you are
- running Multiple Concurrent Jobs in the Director, but you have not set
- them in the File daemon or the Storage daemon. Once you reach their
- limit, they will reject the connection producing authentication (or
- connection) errors.
-
- If you are having problems connecting to a Windows machine that
- previously worked, you might try restarting the Bacula service since
- Windows frequently encounters networking connection problems.
-
- Some users report that authentication fails if there is not a proper
- reverse DNS lookup entry for the machine. This seems to be a
- requirement of gethostbyname(), which is what Bacula uses to translate
- names into IP addresses. If you cannot add a reverse DNS entry, or you
- don't know how to do so, you can avoid the problem by specifying an IP
- address rather than a machine name in the appropriate Bacula conf file.
-
- Here is a picture that indicates what names/passwords in which
- files/Resources must match up:
-
- \includegraphics{\idir Conf-Diagram.eps}
-
- In the left column, you will find the Director, Storage, and Client
- resources, with their names and passwords -- these are all in {\bf
- bacula-dir.conf}. The right column is where the corresponding values
- should be found in the Console, Storage daemon (SD), and File daemon (FD)
- configuration files.
-
- Another thing to check is to ensure that the Bacula component you are
- trying to access has {\bf Maximum Concurrent Jobs} set large enough to
- handle each of the Jobs and the Console that want to connect
- simultaneously. Once the maximum connections has been reached, each
- Bacula component will reject all new connections.
-
- Finally, make sure you have no {\bf hosts.allow} or {\bf hosts.deny}
- file that is not permitting access to the site trying to connect.
-
-\label{AccessProblems}
-\section{Bacula Runs Fine but Cannot Access a Client on a Different Machine.
- Why? }
-\item [Bacula Runs Fine but Cannot Access a Client on a Different Machine.
- Why? ]
-\index[general]{Cannot Access a Client}
- There are several reasons why Bacula could not contact a client on a
- different machine. They are:
-
-\begin{itemize}
-\item It is a Windows Client, and the client died because of an improper
- configuration file. Check that the Bacula icon is in the system tray and the
- the menu items work. If the client has died, the icon will disappear only
- when you move the mouse over the icon.
-\item The Client address or port is incorrect or not resolved by DNS. See if
- you can ping the client machine using the same address as in the Client
- record.
-\item You have a firewall, and it is blocking traffic on port 9102 between
- the Director's machine and the Client's machine (or on port 9103 between the
- Client and the Storage daemon machines).
-\item Your password or names are not correct in both the Director and the
- Client machine. Try configuring everything identical to how you run the
- client on the same machine as the Director, but just change the Address. If
- that works, make the other changes one step at a time until it works.
-\item You may also be having problems between your File daemon and your
- Storage daemon. The name you use in the Storage resource of your
- Director's conf file must be known (resolvable) by the File daemon,
- because it is passed symbolically to the File daemon, which then
- resolves it to get an IP address used to contact the Storage daemon.
-\item You may have a {\bf hosts.allow} or {\bf hosts.deny} file that is
- not permitting access.
-\end{itemize}
-
-\label{startover}
-\section{My Catalog is Full of Test Runs, How Can I Start Over?}
-\item [My Catalog is Full of Test Runs, How Can I Start Over? ]
- \index[general]{My Catalog is Full of Test Runs, How Can I Start Over? }
- If you are using MySQL do the following:
-
-\footnotesize
-\begin{verbatim}
- cd <bacula-source>/src/cats
- ./drop_mysql_tables
- ./make_mysql_tables
-
-\end{verbatim}
-\normalsize
-
-If you are using SQLite, do the following:
-
-\footnotesize
-\begin{verbatim}
- Delete bacula.db from your working directory.
- cd <bacula-source>/src/cats
- ./drop_sqlite_tables
- ./make_sqlite_tables
-
-\end{verbatim}
-\normalsize
-
-Then write an EOF on each tape you used with {\bf Bacula} using:
-
-\footnotesize
-\begin{verbatim}
-mt -f /dev/st0 rewind
-mt -f /dev/st0 weof
-\end{verbatim}
-\normalsize
-
-where you need to adjust the device name for your system.
-
-\label{restorehang}
-\section{I Run a Restore Job and Bacula Hangs. What do I do?}
-\item [I Run a Restore Job and Bacula Hangs. What do I do?]
-\index[general]{I Run a Restore Job and Bacula Hangs. What do I do? }
- On Bacula version 1.25 and prior, it expects you to have the correct
- tape mounted prior to a restore. On Bacula version 1.26 and higher, it
- will ask you for the tape, and if the wrong one is mounted, it will
- inform you.
-
- If you have previously done an {\bf unmount} command, all Storage daemon
- sessions (jobs) will be completely blocked from using the drive
- unmounted, so be sure to do a {\bf mount} after your unmount. If in
- doubt, do a second {\bf mount}, it won't cause any harm.
-
-\label{windowstart}
-\section{I Cannot Get My Windows Client to Start Automatically? }
-\item [I Cannot Get My Windows Client to Start Automatically? ]
-\index[general]{Windows Auto Start}
- You are probably having one of two problems: either the Client is dying
- due to an incorrect configuration file, or you didn't do the
- Installation commands necessary to install it as a Windows Service.
-
- For the first problem, see the next FAQ question. For the second
- problem, please review the \ilink{ Windows Installation
- instructions}{Win32Chapter} in this manual.
-
-\label{windowsdie}
-\section{My Windows Client Immediately Dies When I Start It}
-\item [My Windows Client Immediately Dies When I Start It]
-\index[general]{Windows Client Dies}
-The most common problem is either that the configuration file is not where
-it expects it to be, or that there is an error in the configuration file.
-You must have the configuration file in {\bf
-c:\textbackslash{}bacula\textbackslash{}bin\textbackslash{}bacula-fd.conf}.
-
-To {\bf see} what is going on when the File daemon starts on Windows, do the
-following:
-
-\footnotesize
-\begin{verbatim}
- Start a DOS shell Window.
- cd c:\bacula\bin
- bacula-fd -d100 -c c:\bacula\bin\bacula-fd.conf
-
-\end{verbatim}
-\normalsize
-
-This will cause the FD to write a file {\bf bacula.trace} in the current
-directory, which you can examine and thereby determine the problem.
-
-\label{scroll}
-\item [When I Start the Console, the Error Messages Fly By. How can I see
- them? ]
-\index[general]{Error Messages}
- Either use a shell window with a scroll bar, or use the gnome-console.
- In any case, you probably should be logging all output to a file, and
- then you can simply view the file using an editor or the {\bf less}
- program. To log all output, I have the following in my Director's
- Message resource definition:
-
-\footnotesize
-\begin{verbatim}
- append = "/home/kern/bacula/bin/log" = all, !skipped
-
-\end{verbatim}
-\normalsize
-
-Obviously you will want to change the filename to be appropriate for your
-system.
-
-\label{nobackup}
-\section{My backups are not working on my Windows
- Client. What should I do?}
-\item [I didn't realize that the backups were not working on my Windows
- Client. What should I do? ]
-\index[general]{Backups Failing}
-You should be sending yourself an email message for each job. This will avoid
-the possibility of not knowing about a failed backup. To do so put something
-like:
-
-\footnotesize
-\begin{verbatim}
- Mail = yourname@yourdomain = all, !skipped
-
-\end{verbatim}
-\normalsize
-
-in your Director's message resource. You should then receive one email for
-each Job that ran. When you are comfortable with what is going on (it took
-me 9 months), you might change that to:
-
-\footnotesize
-\begin{verbatim}
- MailOnError = yourname@yourdomain = all, !skipped
-
-\end{verbatim}
-\normalsize
-
-then you only get email messages when a Job errors as is the case for your
-Windows machine.
-
-You should also be logging the Director's messages, please see the previous
-FAQ for how to do so.
-
-\label{sched}
-\section{All my Jobs are scheduled for the same time. Will this cause
- problems?}
-\item [All my Jobs are scheduled for the same time. Will this cause
- problems? ]
-\index[general]{Schedule problems}
- No, not at all. Bacula will schedule all the Jobs at the same time, but
- will run them one after another unless you have increased the number of
- simultaneous jobs in the configuration files for the Director, the File
- daemon, and the Storage daemon. The appropriate configuration record is
- {\bf Maximum Concurrent Jobs = nn}. At the current time, we recommend
- that you leave this set to {\bf 1} for the Director.
-
-\label{disk}
-\section{Can Bacula Backup My System To Files instead of Tape?}
-\item [Can Bacula Backup My System To Files instead of Tape? ]
-\index[general]{Backup to Disk}
- Yes, in principle, Bacula can backup to any storage medium as long as
- you have correctly defined that medium in the Storage daemon's Device
- resource. For an example of how to backup to files, please see the
- \ilink{Pruning Example}{PruningExample} in the Recycling chapter of this
- manual. Also, there is a whole chapter devoted to \ilink{Basic Volume
- Management}{DiskChapter}. This chapter was originally written to
- explain how to write to disk, but was expanded to include volume
- management. It is, however, still quite a good chapter to read.
-
-\label{testbackup}
-\section{Can I use a dummy device to test the backup?}
- Yes, to have a {\sl Virtual} device which just consumes data, you can use a
- FIFO device (see \ilink{Stored configuration}{SetupFifo}).
- It's useful to test a backup.
-\footnotesize
-\begin{verbatim}
-Device {
- Name = NULL
- Media Type = NULL
- Device Type = Fifo
- Archive Device = /dev/null
- LabelMedia = yes
- Random Access = no
- AutomaticMount = no
- RemovableMedia = no
- MaximumOpenWait = 60
- AlwaysOpen = no
-}
-\end{verbatim}
-\normalsize
-
-\label{bigfiles}
-\section{Can Bacula Backup and Restore Files Bigger than 2 Gigabytes?}
-\item [Can Bacula Backup and Restore Files Bigger than 2 Gigabytes?]
-\index[general]{Large file support}
-If your operating system permits it, and you are running Bacula version
-1.26 or later, the answer is yes. To the best of our knowledge all client
-system supported by Bacula can handle files bigger 2 Gigabytes.
-
-\label{cancel}
-\section{I want to stop a job.}
-%% Is there a better way than "./bacula stop" to stop it?}
-\item [I Started A Job then Decided I Really Did Not Want to Run It. Is
- there a better way than {\bf ./bacula stop} to stop it?]
-\index[general]{Cancelling jobs}
- Yes, you normally should use the Console command {\bf cancel} to cancel
- a Job that is either scheduled or running. If the Job is scheduled, it
- will be marked for cancellation and will be canceled when it is
- scheduled to start. If it is running, it will normally terminate after
- a few minutes. If the Job is waiting on a tape mount, you may need to
- do a {\bf mount} command before it will be canceled.
-
-\label{trademark}
-\section{Why have You Trademarked the Name Bacula?}
-\item [Why have You Trademarked the Name
- Bacula\raisebox{.6ex}{{\footnotesize \textsuperscript{\textregistered}}}?]
-\index[general]{Bacula Trademark}
-We have trademarked the name Bacula to ensure that all media written by any
-program named Bacula will always be compatible. Anyone may use the name
-Bacula, even in a derivative product as long as it remains totally compatible
-in all respects with the program defined here.
-
-\label{docversion}
-\section{Why is the Online Document for Version 1.39 but the Released Version is 1.38?}
-\item [Why is the Online Document for Version 1.39 of Bacula when the
- Current Version is 1.38?]
-\index[general]{Multiple manuals}
-As Bacula is being developed, the document is also being enhanced, more
-often than not it has clarifications of existing features that can be very
-useful to our users, so we publish the very latest document. Fortunately
-it is rare that there are confusions with new features.
-
-If you want to read a document that pertains only to a specific version,
-please use the one distributed in the source code. The web site also has
-online versions of both the released manual and the current development
-manual.
-
-\label{sure}
-\section{Does Bacula really save and restore all files?}
-\item [How Can I Be Sure that Bacula Really Saves and Restores All Files? ]
-\index[general]{Checking Restores}
- It is really quite simple, but took me a while to figure
- out how to "prove" it. First make a Bacula Rescue disk, see the
- \ilink{Disaster Recovery Using Bacula}{RescueChapter} chapter
- of this manual.
- Second, you run a full backup of all your files on all partitions.
- Third, you run an Verify InitCatalog Job on the same FileSet, which
- effectively makes a record of all the files on your system. Fourth, you
- run a Verify Catalog job and assure yourself that nothing has changed
- (well, between an InitCatalog and Catalog one doesn't expect anything).
- Then do the unthinkable, write zeros on your MBR (master boot record)
- wiping out your hard disk. Now, restore your whole system using your
- Bacula Rescue disk and the Full backup you made, and finally re-run the
- Verify Catalog job. You will see that with the exception of the
- directory modification and access dates and the files changed during the
- boot, your system is identical to what it was before you wiped your hard
- disk.
- Alternatively you could do the wiping and restoring to another computer
- of the same type.
-
-\label{upgrade}
-\section{I want an Incremental but Bacula runs it as a Full backup. Why?}
-\item [I did a Full backup last week, but now in running an Incremental,
- Bacula says it did not find a FULL backup, so it did a FULL backup. Why?]
-\index[general]{FULL backup not found}
- Before doing an Incremental or a Differential
- backup, Bacula checks to see if there was a prior Full backup of the
- same Job that terminated successfully. If so, it uses the date that
- full backup started as the time for comparing if files have changed. If
- Bacula does not find a successful full backup, it proceeds to do one.
- Perhaps you canceled the full backup, or it terminated in error. In
- such cases, the full backup will not be successful. You can check by
- entering {\bf list jobs} and look to see if there is a prior Job with
- the same Name that has Level F and JobStatus T (normal termination).
-
- Another reason why Bacula may not find a suitable Full backup is that
- every time you change the FileSet, Bacula will require a new Full
- backup. This is necessary to ensure that all files are properly backed
- up in the case where you have added more files to the FileSet.
- Beginning with version 1.31, the FileSets are also dated when they are
- created, and this date is displayed with the name when you are listing
- or selecting a FileSet. For more on backup levels see below.
-
- See also {\bf Ignore FileSet Changes} in the
- \ilink{FileSet Resource definition}{FileSetResource} in the Director
- chapter of this document.
-
-\label{filenamelengths}
-\section{Do you really handle unlimited path lengths?}
-\item [How Can You Claim to Handle Unlimited Path and Filename Lengths
- when All Other Programs Have Fixed Limits?]
-\index[general]{Path and Filename Lengths}
- Most of those other programs have been around for a long time, in fact
- since the beginning of Unix, which means that they were designed for
- rather small fixed length path and filename lengths. Over the years,
- these restrictions have been relaxed allowing longer names. Bacula on
- the other hand was designed in 2000, and so from the start, Path and
- Filenames have been kept in buffers that start at 256 bytes in length,
- but can grow as needed to handle any length. Most of the work is
- carried out by lower level routines making the coding rather easy.
-
- Note that due to limitations Win32 path and filenames cannot exceed
- 260 characters. By using Win32 Unicode functions, we will remove this
- restriction in later versions of Bacula.
-
-\label{unique}
-\section{What Is the Really Unique Feature of Bacula?}
-\item [What Is the Really Unique Feature of Bacula?]
-\index[general]{Unique Feature of Bacula}
- Well, it is hard to come up with unique features when backup programs
- for Unix machines have been around since the 1960s. That said, I
- believe that Bacula is the first and only program to use a standard SQL
- interface to catalog its database. Although this adds a bit of
- complexity and possibly overhead, it provides an amazingly rich set of
- features that are easy to program and enhance. The current code has
- barely scratched the surface in this regard (version 1.38).
-
- The second feature, which gives a lot of power and flexibility to Bacula
- is the Bootstrap record definition.
-
- The third unique feature, which is currently (1.30) unimplemented, and
- thus can be called vaporware :-), is Base level saves. When
- implemented, this will enormously reduce tape usage.
-
-\label{sequence}
-\section{How can I force one job to run after another?}
-\item [If I Run Multiple Simultaneous Jobs, How Can I Force One
- Particular Job to Run After Another Job? ]
-\index[general]{Multiple Simultaneous Jobs}
-Yes, you can set Priorities on your jobs so that they run in the order you
-specify. Please see:
-\ilink{the Priority record}{Priority} in the Job resource.
-
-\label{nomail}
-\section{I Am Not Getting Email Notification, What Can I Do? }
-\item [I Am Not Getting Email Notification, What Can I Do? ]
-\index[general]{No Email Notification}
- The most common problem is that you have not specified a fully qualified
- email address and your bsmtp server is rejecting the mail. The next
- most common problem is that your bsmtp server doesn't like the syntax on
- the From part of the message. For more details on this and other
- problems, please see the \ilink{ Getting Email Notification to
- Work}{email} section of the Tips chapter of this manual. The section
- \ilink{ Getting Notified of Job Completion}{notification} of the Tips
- chapter may also be useful. For more information on the {\bf bsmtp}
- mail program, please see \ilink{bsmtp in the Volume Utility Tools
- chapter}{bsmtp} of this manual.
-
-\label{periods}
-\section{My retention periods don't work}
-\item [I Change Recycling, Retention Periods, or File Sizes in my Pool
- Resource and they Still Don't Work.]
-\index[general]{Recycling}
-\index[general]{Retention Periods}
-\index[general]{Pool changes}
- The different variables associated with a Pool are defined in the Pool
- Resource, but are actually read by Bacula from the Catalog database. On
- Bacula versions prior to 1.30, after changing your Pool Resource, you must
- manually update the corresponding values in the Catalog by using the {\bf
- update pool} command in the Console program. In Bacula version 1.30, Bacula
- does this for you automatically every time it starts.
-
- When Bacula creates a Media record (Volume), it uses many default values from
- the Pool record. If you subsequently change the Pool record, the new values
- will be used as a default for the next Volume that is created, but if you
- want the new values to apply to existing Volumes, you must manually update
- the Volume Catalog entry using the {\bf update volume} command in the Console
- program.
-
-\label{CompressionNotWorking}
-\section{Why aren't my files compressed?}
-\item [I Have Configured Compression On, But None of My Files Are
- Compressed. Why?]
-\index[general]{Compression}
- There are two kinds of compression. One is tape compression. This is done by
- the tape drive hardware, and you either enable or disable it with system
- tools such as {\bf mt}. This compression works independently of Bacula,
- and when it is enabled, you should not use the Bacula software
- compression.
-
- Bacula also has software compression code in the File daemons, which you
- normally need to enable only when backing up to file Volumes. There are
- two conditions necessary to enable the Bacula software compression.
-
-\begin{enumerate}
-\item You must have the zip development libraries loaded on your system
- when building Bacula and Bacula must find this library, normally {\bf
- /usr/lib/libz.a}. On Red Hat systems, this library is provided by the
- {\bf zlib-devel} rpm.
-
- If the library is found by Bacula during the {\bf ./configure} it will
- be mentioned in the {\bf config.out} line by:
-
-\footnotesize
-\begin{verbatim}
- ZLIB support: yes
-
-\end{verbatim}
-\normalsize
-
-\item You must add the {\bf compression=gzip} option on your Include
- statement in the Director's configuration file.
-\end{enumerate}
-
-\label{NewTape}
-\item [Bacula is Asking for a New Tape After 2 GB of Data but My Tape
- holds 33 GB. Why?]
-\index[general]{Tape capacity}
-There are several reasons why Bacula will request a new tape.
-
-\begin{itemize}
-\item There is an I/O error on the tape. Bacula prints an error message and
- requests a new tape. Bacula does not attempt to continue writing after an
- I/O error.
-\item Bacula encounters and end of medium on the tape. This is not always
- distinguishable from an I/O error.
-\item You have specifically set some size limitation on the tape. For example
- the {\bf Maximum Volume Bytes} or {\bf Maximum Volume Files} in the
- Director's Pool resource, or {\bf Maximum Volume Size} in the Storage
- daemon's Device resource.
-\end{itemize}
-
-\label{LevelChanging}
-\section{Incremental backups are not working}
-\item [Bacula is Not Doing the Right Thing When I Request an Incremental
- Backup. Why?]
-\index[general]{Incremental backups}
- As explained in one of the previous questions, Bacula will automatically
- upgrade an Incremental or Differential job to a Full backup if it cannot
- find a prior Full backup or a suitable Full backup. For the gory
- details on how/when Bacula decides to upgrade levels please see the
- \ilink{Level record}{Level} in the Director's configuration chapter of
- this manual.
-
- If after reading the above mentioned section, you believe that Bacula is not
- correctly handling the level (Differential/Incremental), please send us the
- following information for analysis:
-
-\begin{itemize}
-\item Your Director's configuration file.
-\item The output from {\bf list jobs} covering the period where you are
- having the problem.
-\item The Job report output from the prior Full save (not critical).
-\item An {\bf llist jobid=nnn} where nnn is the JobId of the prior Full save.
-
-\item The Job report output from the save that is doing the wrong thing (not
- critical).
-\item An {\bf llist jobid=nnn} where nnn is the JobId of the job that was not
- correct.
-\item An explanation of what job went wrong and why you think it did.
- \end{itemize}
-
-The above information can allow us to analyze what happened, without it,
-there is not much we can do.
-
-\label{WaitForever}
-\section{I am waiting forever for a backup of an offsite machine}
-\item [I am Backing Up an Offsite Machine with an Unreliable Connection.
- The Director Waits Forever for the Client to Contact the SD. What Can I
- Do?]
-\index[general]{Backing Up Offsite Machines}
- Bacula was written on the assumption that it will have a good TCP/IP
- connection between all the daemons. As a consequence, the current
- Bacula doesn't deal with faulty connections very well. This situation
- is slowly being corrected over time.
-
- There are several things you can do to improve the situation.
-
-\begin{itemize}
-\item Upgrade to version 1.32 and use the new SDConnectTimeout record. For
- example, set:
-
-\footnotesize
-\begin{verbatim}
- SD Connect Timeout = 5 min
-
-\end{verbatim}
-\normalsize
-
-in the FileDaemon resource.
-\item Run these kinds of jobs after all other jobs.
- \end{itemize}
-
-\label{sshHanging}
-\section{SSH hangs forever after starting Bacula}
-\item [When I ssh into a machine and start Bacula then attempt to exit,
- ssh hangs forever.]
-\index[general]{ssh hangs}
- This happens because Bacula leaves stdin, stdout, and stderr open for
- debug purposes. To avoid it, the simplest thing to do is to redirect
- the output of those files to {\bf /dev/null} or another file in your
- startup script (the Red Hat autostart scripts do this automatically).
- For example, you start the Director with:
-
-\footnotesize
-\begin{verbatim}
- bacula-dir -c bacula-dir.conf ... >/dev/null 0>\&1 2>\&1
-
-\end{verbatim}
-\normalsize
-
-and likewise for the other daemons.
-
-\label{RetentionPeriods}
-\section{I'm confused by retention periods}
-\item [I'm confused by the different Retention periods: File Retention,
- Job Retention, Volume Retention. Why are there so many?]
-\index[general]{Retention Periods}
- Yes, this certainly can be confusing. The basic reason for so many is
- to allow flexibility. The File records take quite a lot of space in the
- catalog, so they are typically records you want to remove rather
- quickly. The Job records, take very little space, and they can be
- useful even without the File records to see what Jobs actually ran and
- when. One must understand that if the File records are removed from the
- catalog, you cannot use the {\bf restore} command to restore an
- individual file since Bacula no longer knows where it is. However, as
- long as the Volume Retention period has not expired, the data will still
- be on the tape, and can be recovered from the tape.
-
- For example, I keep a 30 day retention period for my Files to keep my
- catalog from getting too big, but I keep my tapes for a minimum of one
- year, just in case.
-
-\label{MaxVolumeSize}
-\section{MaxVolumeSize is ignored}
-\item [Why Does Bacula Ignore the MaxVolumeSize Set in my Pool?]
-\index[general]{MaxVolumeSize}
- The MaxVolumeSize that Bacula uses comes from the Media record, so most
- likely you changed your Pool, which is used as the default for creating
- Media records, {\bf after} you created your Volume. Check what is in
- the Media record by doing:
-
-\footnotesize
-\begin{verbatim}
-llist Volume=xxx
-\end{verbatim}
-\normalsize
-
-If it doesn't have the right value, you can use:
-
-\footnotesize
-\begin{verbatim}
-update Volume=xxx
-\end{verbatim}
-\normalsize
-
-to change it.
-
-\label{ConnectionRefused}
-\section{I get a Connection refused when connecting to my Client}
-\item [In connecting to my Client, I get "ERR:Connection Refused. Packet
- Size too big from File daemon:192.168.1.4:9102" Why?]
-\index[general]{ERR:Connection Refused}
- This is typically a communications error resulting from one of the
- following:
-
-
-\begin{itemize}
-\item Old versions of Bacula, usually a Win32 client, where two threads were
- using the same I/O packet. Fixed in more recent versions. Please upgrade.
-\item Some other program such as an HP Printer using the same port (9102 in
- this case).
-\end{itemize}
-
-If it is neither of the above, please submit a bug report at
-\elink{bugs.bacula.org}{http://bugs.bacula.org}.
-
-Another solution might be to run the daemon with the debug option by:
-
-\footnotesize
-\begin{verbatim}
- Start a DOS shell Window.
- cd c:\bacula\bin
- bacula-fd -d100 -c c:\bacula\bin\bacula-fd.conf
-
-\end{verbatim}
-\normalsize
-
-This will cause the FD to write a file {\bf bacula.trace} in the current
-directory, which you can examine to determine the problem.
-
-\section{Long running jobs die with Pipe Error}
-\item [During long running jobs my File daemon dies with Pipe Error, or
- some other communications error. Why?]
-\index[general]{Communications Errors}
-\index[general]{Pipe Errors}
-\index[general]{slow}
-\index[general]{Backups!slow}
- There are a number of reasons why a connection might break.
- Most often, it is a router between your two computers that times out
- inactive lines (not respecting the keepalive feature that Bacula uses).
- In that case, you can use the {\bf Heartbeat Interval} directive in
- both the Storage daemon and the File daemon.
-
- In at least one case, the problem has been a bad driver for a Win32
- NVidia NForce 3 ethernet card with driver (4.4.2 17/05/2004).
- In this case, a good driver is (4.8.2.0 06/04/2005). Moral of
- the story, make sure you have the latest ethernet drivers
- loaded, or use the following workaround as suggested by Thomas
- Simmons for Win32 machines:
-
- Browse to:
- Start \gt{} Control Panel \gt{} Network Connections
-
- Right click the connection for the nvidia adapter and select properties.
- Under the General tab, click "Configure...". Under the Advanced tab set
- "Checksum Offload" to disabled and click OK to save the change.
-
- Lack of communications, or communications that get interrupted can
- also be caused by Linux firewalls where you have a rule that throttles
- connections or traffic. For example, if you have:
-
-\footnotesize
-\begin{verbatim}
-iptables -t filter -A INPUT -m limit --limit 3/second --limit-burst 3 -j DROP
-\end{verbatim}
-\normalsize
-
- you will want to add the following rules {\bf before} the above rule:
-\footnotesize
-\begin{verbatim}
-iptables -t filter -A INPUT --dport 9101 -j ACCEPT
-iptables -t filter -A INPUT --dport 9102 -j ACCEPT
-iptables -t filter -A INPUT --dport 9103 -j ACCEPT
-\end{verbatim}
-\normalsize
- This will ensure that any Bacula traffic will not get terminated because
- of high usage rates.
-
-\section{How do I tell the Job which Volume to use?}
-\item[I can't figure out how to tell the job which volume to use]
- \index[general]{What tape to mount}
- This is an interesting statement. I now see that a number of people new to
- Bacula have the same problem as you, probably from using programs like tar.
-
- In fact, you do not tell Bacula what tapes to use. It is the inverse. Bacula
- tells you want tapes it wants. You put tapes at its disposition and it
- chooses.
-
- Now, if you *really* want to be tricky and try to tell Bacula what to do, it
- will be reasonable if for example you mount a valid tape that it can use on a
- drive, it will most likely go ahead and use it. It also has a documented
- algorithm for choosing tapes -- but you are asking for problems ...
-
- So, the trick is to invert your concept of things and put Bacula in charge of
- handling the tapes. Once you do that, you will be fine. If you want to
- anticipate what it is going to do, you can generally figure it out correctly
- and get what you want.
-
- If you start with the idea that you are going to force or tell Bacula to use
- particular tapes or you insist on trying to run in that kind of mode, you will
- probably not be too happy.
-
- I don't want to worry about what tape has what data. That is what Bacula is
- designed for.
-
- If you have an application where you *really* need to remove a tape each day
- and insert a new one, it can be done the directives exist to accomplish that.
- In such a case, one little "trick" to knowing what tape Bacula will want at
- 2am while you are asleep is to run a tiny job at 4pm while you are still at
- work that backs up say one directory, or even one file. You will quickly find
- out what tape it wants, and you can mount it before you go home ...
-
-\label{Password generation}
-\section{Password generation}
-\item [How do I generate a password?]
-\index[general]{MaxVolumeSize}
-
- Each daemon needs a password. This password occurs in the configuration
- file for that daemon and in the bacula-dir.conf file. These passwords are
- plain text. There is no special generation procedure. Most people just
- use random text.
-
- Passwords are never sent over the wire in plain text. They are always
- encrypted.
-
- Security surrounding these passwords is best left security to your
- operating system. Passwords are not encrypted within Bacula
- configuration files.
-
-\end{description}
-
+++ /dev/null
-% TODO: maybe get rid of centering
-
-\chapter{GNU Free Documentation License}
-\index[general]{GNU Free Documentation License}
-\index[general]{License!GNU Free Documentation}
-
-\label{label_fdl}
-
- \begin{center}
-
- Version 1.2, November 2002
-
-
- Copyright \copyright 2000,2001,2002 Free Software Foundation, Inc.
-
- \bigskip
-
- 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-
- \bigskip
-
- Everyone is permitted to copy and distribute verbatim copies
- of this license document, but changing it is not allowed.
-\end{center}
-
-
-\begin{center}
-{\bf\large Preamble}
-\end{center}
-
-The purpose of this License is to make a manual, textbook, or other
-functional and useful document "free" in the sense of freedom: to
-assure everyone the effective freedom to copy and redistribute it,
-with or without modifying it, either commercially or noncommercially.
-Secondarily, this License preserves for the author and publisher a way
-to get credit for their work, while not being considered responsible
-for modifications made by others.
-
-This License is a kind of "copyleft", which means that derivative
-works of the document must themselves be free in the same sense. It
-complements the GNU General Public License, which is a copyleft
-license designed for free software.
-
-We have designed this License in order to use it for manuals for free
-software, because free software needs free documentation: a free
-program should come with manuals providing the same freedoms that the
-software does. But this License is not limited to software manuals;
-it can be used for any textual work, regardless of subject matter or
-whether it is published as a printed book. We recommend this License
-principally for works whose purpose is instruction or reference.
-
-
-\begin{center}
-{\Large\bf 1. APPLICABILITY AND DEFINITIONS}
-\end{center}
-
-This License applies to any manual or other work, in any medium, that
-contains a notice placed by the copyright holder saying it can be
-distributed under the terms of this License. Such a notice grants a
-world-wide, royalty-free license, unlimited in duration, to use that
-work under the conditions stated herein. The \textbf{"Document"}, below,
-refers to any such manual or work. Any member of the public is a
-licensee, and is addressed as \textbf{"you"}. You accept the license if you
-copy, modify or distribute the work in a way requiring permission
-under copyright law.
-
-A \textbf{"Modified Version"} of the Document means any work containing the
-Document or a portion of it, either copied verbatim, or with
-modifications and/or translated into another language.
-
-A \textbf{"Secondary Section"} is a named appendix or a front-matter section of
-the Document that deals exclusively with the relationship of the
-publishers or authors of the Document to the Document's overall subject
-(or to related matters) and contains nothing that could fall directly
-within that overall subject. (Thus, if the Document is in part a
-textbook of mathematics, a Secondary Section may not explain any
-mathematics.) The relationship could be a matter of historical
-connection with the subject or with related matters, or of legal,
-commercial, philosophical, ethical or political position regarding
-them.
-
-The \textbf{"Invariant Sections"} are certain Secondary Sections whose titles
-are designated, as being those of Invariant Sections, in the notice
-that says that the Document is released under this License. If a
-section does not fit the above definition of Secondary then it is not
-allowed to be designated as Invariant. The Document may contain zero
-Invariant Sections. If the Document does not identify any Invariant
-Sections then there are none.
-
-The \textbf{"Cover Texts"} are certain short passages of text that are listed,
-as Front-Cover Texts or Back-Cover Texts, in the notice that says that
-the Document is released under this License. A Front-Cover Text may
-be at most 5 words, and a Back-Cover Text may be at most 25 words.
-
-A \textbf{"Transparent"} copy of the Document means a machine-readable copy,
-represented in a format whose specification is available to the
-general public, that is suitable for revising the document
-straightforwardly with generic text editors or (for images composed of
-pixels) generic paint programs or (for drawings) some widely available
-drawing editor, and that is suitable for input to text formatters or
-for automatic translation to a variety of formats suitable for input
-to text formatters. A copy made in an otherwise Transparent file
-format whose markup, or absence of markup, has been arranged to thwart
-or discourage subsequent modification by readers is not Transparent.
-An image format is not Transparent if used for any substantial amount
-of text. A copy that is not "Transparent" is called \textbf{"Opaque"}.
-
-Examples of suitable formats for Transparent copies include plain
-ASCII without markup, Texinfo input format, LaTeX input format, SGML
-or XML using a publicly available DTD, and standard-conforming simple
-HTML, PostScript or PDF designed for human modification. Examples of
-transparent image formats include PNG, XCF and JPG. Opaque formats
-include proprietary formats that can be read and edited only by
-proprietary word processors, SGML or XML for which the DTD and/or
-processing tools are not generally available, and the
-machine-generated HTML, PostScript or PDF produced by some word
-processors for output purposes only.
-
-The \textbf{"Title Page"} means, for a printed book, the title page itself,
-plus such following pages as are needed to hold, legibly, the material
-this License requires to appear in the title page. For works in
-formats which do not have any title page as such, "Title Page" means
-the text near the most prominent appearance of the work's title,
-preceding the beginning of the body of the text.
-
-A section \textbf{"Entitled XYZ"} means a named subunit of the Document whose
-title either is precisely XYZ or contains XYZ in parentheses following
-text that translates XYZ in another language. (Here XYZ stands for a
-specific section name mentioned below, such as \textbf{"Acknowledgements"},
-\textbf{"Dedications"}, \textbf{"Endorsements"}, or \textbf{"History"}.)
-To \textbf{"Preserve the Title"}
-of such a section when you modify the Document means that it remains a
-section "Entitled XYZ" according to this definition.
-
-The Document may include Warranty Disclaimers next to the notice which
-states that this License applies to the Document. These Warranty
-Disclaimers are considered to be included by reference in this
-License, but only as regards disclaiming warranties: any other
-implication that these Warranty Disclaimers may have is void and has
-no effect on the meaning of this License.
-
-
-\begin{center}
-{\Large\bf 2. VERBATIM COPYING}
-\end{center}
-
-You may copy and distribute the Document in any medium, either
-commercially or noncommercially, provided that this License, the
-copyright notices, and the license notice saying this License applies
-to the Document are reproduced in all copies, and that you add no other
-conditions whatsoever to those of this License. You may not use
-technical measures to obstruct or control the reading or further
-copying of the copies you make or distribute. However, you may accept
-compensation in exchange for copies. If you distribute a large enough
-number of copies you must also follow the conditions in section 3.
-
-You may also lend copies, under the same conditions stated above, and
-you may publicly display copies.
-
-
-\begin{center}
-{\Large\bf 3. COPYING IN QUANTITY}
-\end{center}
-
-
-If you publish printed copies (or copies in media that commonly have
-printed covers) of the Document, numbering more than 100, and the
-Document's license notice requires Cover Texts, you must enclose the
-copies in covers that carry, clearly and legibly, all these Cover
-Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
-the back cover. Both covers must also clearly and legibly identify
-you as the publisher of these copies. The front cover must present
-the full title with all words of the title equally prominent and
-visible. You may add other material on the covers in addition.
-Copying with changes limited to the covers, as long as they preserve
-the title of the Document and satisfy these conditions, can be treated
-as verbatim copying in other respects.
-
-If the required texts for either cover are too voluminous to fit
-legibly, you should put the first ones listed (as many as fit
-reasonably) on the actual cover, and continue the rest onto adjacent
-pages.
-
-If you publish or distribute Opaque copies of the Document numbering
-more than 100, you must either include a machine-readable Transparent
-copy along with each Opaque copy, or state in or with each Opaque copy
-a computer-network location from which the general network-using
-public has access to download using public-standard network protocols
-a complete Transparent copy of the Document, free of added material.
-If you use the latter option, you must take reasonably prudent steps,
-when you begin distribution of Opaque copies in quantity, to ensure
-that this Transparent copy will remain thus accessible at the stated
-location until at least one year after the last time you distribute an
-Opaque copy (directly or through your agents or retailers) of that
-edition to the public.
-
-It is requested, but not required, that you contact the authors of the
-Document well before redistributing any large number of copies, to give
-them a chance to provide you with an updated version of the Document.
-
-
-\begin{center}
-{\Large\bf 4. MODIFICATIONS}
-\end{center}
-
-You may copy and distribute a Modified Version of the Document under
-the conditions of sections 2 and 3 above, provided that you release
-the Modified Version under precisely this License, with the Modified
-Version filling the role of the Document, thus licensing distribution
-and modification of the Modified Version to whoever possesses a copy
-of it. In addition, you must do these things in the Modified Version:
-
-\begin{itemize}
-\item[A.]
- Use in the Title Page (and on the covers, if any) a title distinct
- from that of the Document, and from those of previous versions
- (which should, if there were any, be listed in the History section
- of the Document). You may use the same title as a previous version
- if the original publisher of that version gives permission.
-
-\item[B.]
- List on the Title Page, as authors, one or more persons or entities
- responsible for authorship of the modifications in the Modified
- Version, together with at least five of the principal authors of the
- Document (all of its principal authors, if it has fewer than five),
- unless they release you from this requirement.
-
-\item[C.]
- State on the Title page the name of the publisher of the
- Modified Version, as the publisher.
-
-\item[D.]
- Preserve all the copyright notices of the Document.
-
-\item[E.]
- Add an appropriate copyright notice for your modifications
- adjacent to the other copyright notices.
-
-\item[F.]
- Include, immediately after the copyright notices, a license notice
- giving the public permission to use the Modified Version under the
- terms of this License, in the form shown in the Addendum below.
-
-\item[G.]
- Preserve in that license notice the full lists of Invariant Sections
- and required Cover Texts given in the Document's license notice.
-
-\item[H.]
- Include an unaltered copy of this License.
-
-\item[I.]
- Preserve the section Entitled "History", Preserve its Title, and add
- to it an item stating at least the title, year, new authors, and
- publisher of the Modified Version as given on the Title Page. If
- there is no section Entitled "History" in the Document, create one
- stating the title, year, authors, and publisher of the Document as
- given on its Title Page, then add an item describing the Modified
- Version as stated in the previous sentence.
-
-\item[J.]
- Preserve the network location, if any, given in the Document for
- public access to a Transparent copy of the Document, and likewise
- the network locations given in the Document for previous versions
- it was based on. These may be placed in the "History" section.
- You may omit a network location for a work that was published at
- least four years before the Document itself, or if the original
- publisher of the version it refers to gives permission.
-
-\item[K.]
- For any section Entitled "Acknowledgements" or "Dedications",
- Preserve the Title of the section, and preserve in the section all
- the substance and tone of each of the contributor acknowledgements
- and/or dedications given therein.
-
-\item[L.]
- Preserve all the Invariant Sections of the Document,
- unaltered in their text and in their titles. Section numbers
- or the equivalent are not considered part of the section titles.
-
-\item[M.]
- Delete any section Entitled "Endorsements". Such a section
- may not be included in the Modified Version.
-
-\item[N.]
- Do not retitle any existing section to be Entitled "Endorsements"
- or to conflict in title with any Invariant Section.
-
-\item[O.]
- Preserve any Warranty Disclaimers.
-\end{itemize}
-
-If the Modified Version includes new front-matter sections or
-appendices that qualify as Secondary Sections and contain no material
-copied from the Document, you may at your option designate some or all
-of these sections as invariant. To do this, add their titles to the
-list of Invariant Sections in the Modified Version's license notice.
-These titles must be distinct from any other section titles.
-
-You may add a section Entitled "Endorsements", provided it contains
-nothing but endorsements of your Modified Version by various
-parties--for example, statements of peer review or that the text has
-been approved by an organization as the authoritative definition of a
-standard.
-
-You may add a passage of up to five words as a Front-Cover Text, and a
-passage of up to 25 words as a Back-Cover Text, to the end of the list
-of Cover Texts in the Modified Version. Only one passage of
-Front-Cover Text and one of Back-Cover Text may be added by (or
-through arrangements made by) any one entity. If the Document already
-includes a cover text for the same cover, previously added by you or
-by arrangement made by the same entity you are acting on behalf of,
-you may not add another; but you may replace the old one, on explicit
-permission from the previous publisher that added the old one.
-
-The author(s) and publisher(s) of the Document do not by this License
-give permission to use their names for publicity for or to assert or
-imply endorsement of any Modified Version.
-
-
-\begin{center}
-{\Large\bf 5. COMBINING DOCUMENTS}
-\end{center}
-
-
-You may combine the Document with other documents released under this
-License, under the terms defined in section 4 above for modified
-versions, provided that you include in the combination all of the
-Invariant Sections of all of the original documents, unmodified, and
-list them all as Invariant Sections of your combined work in its
-license notice, and that you preserve all their Warranty Disclaimers.
-
-The combined work need only contain one copy of this License, and
-multiple identical Invariant Sections may be replaced with a single
-copy. If there are multiple Invariant Sections with the same name but
-different contents, make the title of each such section unique by
-adding at the end of it, in parentheses, the name of the original
-author or publisher of that section if known, or else a unique number.
-Make the same adjustment to the section titles in the list of
-Invariant Sections in the license notice of the combined work.
-
-In the combination, you must combine any sections Entitled "History"
-in the various original documents, forming one section Entitled
-"History"; likewise combine any sections Entitled "Acknowledgements",
-and any sections Entitled "Dedications". You must delete all sections
-Entitled "Endorsements".
-
-\begin{center}
-{\Large\bf 6. COLLECTIONS OF DOCUMENTS}
-\end{center}
-
-You may make a collection consisting of the Document and other documents
-released under this License, and replace the individual copies of this
-License in the various documents with a single copy that is included in
-the collection, provided that you follow the rules of this License for
-verbatim copying of each of the documents in all other respects.
-
-You may extract a single document from such a collection, and distribute
-it individually under this License, provided you insert a copy of this
-License into the extracted document, and follow this License in all
-other respects regarding verbatim copying of that document.
-
-
-\begin{center}
-{\Large\bf 7. AGGREGATION WITH INDEPENDENT WORKS}
-\end{center}
-
-
-A compilation of the Document or its derivatives with other separate
-and independent documents or works, in or on a volume of a storage or
-distribution medium, is called an "aggregate" if the copyright
-resulting from the compilation is not used to limit the legal rights
-of the compilation's users beyond what the individual works permit.
-When the Document is included in an aggregate, this License does not
-apply to the other works in the aggregate which are not themselves
-derivative works of the Document.
-
-If the Cover Text requirement of section 3 is applicable to these
-copies of the Document, then if the Document is less than one half of
-the entire aggregate, the Document's Cover Texts may be placed on
-covers that bracket the Document within the aggregate, or the
-electronic equivalent of covers if the Document is in electronic form.
-Otherwise they must appear on printed covers that bracket the whole
-aggregate.
-
-
-\begin{center}
-{\Large\bf 8. TRANSLATION}
-\end{center}
-
-
-Translation is considered a kind of modification, so you may
-distribute translations of the Document under the terms of section 4.
-Replacing Invariant Sections with translations requires special
-permission from their copyright holders, but you may include
-translations of some or all Invariant Sections in addition to the
-original versions of these Invariant Sections. You may include a
-translation of this License, and all the license notices in the
-Document, and any Warranty Disclaimers, provided that you also include
-the original English version of this License and the original versions
-of those notices and disclaimers. In case of a disagreement between
-the translation and the original version of this License or a notice
-or disclaimer, the original version will prevail.
-
-If a section in the Document is Entitled "Acknowledgements",
-"Dedications", or "History", the requirement (section 4) to Preserve
-its Title (section 1) will typically require changing the actual
-title.
-
-
-\begin{center}
-{\Large\bf 9. TERMINATION}
-\end{center}
-
-
-You may not copy, modify, sublicense, or distribute the Document except
-as expressly provided for under this License. Any other attempt to
-copy, modify, sublicense or distribute the Document is void, and will
-automatically terminate your rights under this License. However,
-parties who have received copies, or rights, from you under this
-License will not have their licenses terminated so long as such
-parties remain in full compliance.
-
-
-\begin{center}
-{\Large\bf 10. FUTURE REVISIONS OF THIS LICENSE}
-\end{center}
-
-
-The Free Software Foundation may publish new, revised versions
-of the GNU Free Documentation License from time to time. Such new
-versions will be similar in spirit to the present version, but may
-differ in detail to address new problems or concerns. See
-http://www.gnu.org/copyleft/.
-
-Each version of the License is given a distinguishing version number.
-If the Document specifies that a particular numbered version of this
-License "or any later version" applies to it, you have the option of
-following the terms and conditions either of that specified version or
-of any later version that has been published (not as a draft) by the
-Free Software Foundation. If the Document does not specify a version
-number of this License, you may choose any version ever published (not
-as a draft) by the Free Software Foundation.
-
-
-\begin{center}
-{\Large\bf ADDENDUM: How to use this License for your documents}
-% TODO: this is too long for table of contents
-\end{center}
-
-To use this License in a document you have written, include a copy of
-the License in the document and put the following copyright and
-license notices just after the title page:
-
-\bigskip
-\begin{quote}
- Copyright \copyright YEAR YOUR NAME.
- Permission is granted to copy, distribute and/or modify this document
- under the terms of the GNU Free Documentation License, Version 1.2
- or any later version published by the Free Software Foundation;
- with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
- A copy of the license is included in the section entitled "GNU
- Free Documentation License".
-\end{quote}
-\bigskip
-
-If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts,
-replace the "with...Texts." line with this:
-
-\bigskip
-\begin{quote}
- with the Invariant Sections being LIST THEIR TITLES, with the
- Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST.
-\end{quote}
-\bigskip
-
-If you have Invariant Sections without Cover Texts, or some other
-combination of the three, merge those two alternatives to suit the
-situation.
-
-If your document contains nontrivial examples of program code, we
-recommend releasing these examples in parallel under your choice of
-free software license, such as the GNU General Public License,
-to permit their use in free software.
-
-%---------------------------------------------------------------------
+++ /dev/null
-%%
-%%
-
-\chapter{Dealing with Firewalls}
-\label{FirewallsChapter}
-\index[general]{Dealing with Firewalls }
-\index[general]{Firewalls!Dealing with }
-
-If you have a firewall or a DMZ installed on your computer, you may experience
-difficulties contacting one or more of the Clients to back them up. This is
-especially true if you are trying to backup a Client across the Internet.
-
-\section{Technical Details}
-\index[general]{Technical Details }
-\index[general]{Details!Technical }
-
-If you are attempting to do this, the sequence of network events in Bacula to
-do a backup are the following:
-
-\footnotesize
-\begin{verbatim}
-Console -> DIR:9101
-DIR -> SD:9103
-DIR -> FD:9102
-FD -> SD:9103
-\end{verbatim}
-\normalsize
-
-Where hopefully it is obvious that DIR represents the Director, FD the File
-daemon or client, and SD the Storage daemon. The numbers that follow those
-names are the standard ports used by Bacula, and the -\gt{} represents the
-left side making a connection to the right side (i.e. the right side is the
-"server" or is listening on the specified port), and the left side is the
-"client" that initiates the conversation.
-
-Note, port 9103 serves both the Director and the File daemon, each having its
-own independent connection.
-
-If you are running {\bf iptables}, you might add something like:
-
-\footnotesize
-\begin{verbatim}
--A FW-1-INPUT -m state --state NEW -m tcp -p tcp --dport 9101:9103 -j ACCEPT
-\end{verbatim}
-\normalsize
-
-on your server, and
-
-\footnotesize
-\begin{verbatim}
--A FW-1-INPUT -m state --state NEW -m tcp -p tcp --dport 9102 -j ACCEPT
-\end{verbatim}
-\normalsize
-
-on your client. In both cases, I assume that the machine is allowed to
-initiate connections on any port. If not, you will need to allow outgoing
-connections on ports 9102 and 9103 on your server and 9103 on your client.
-Thanks to Raymond Norton for this tip.
-
-\section{A Concrete Example}
-\index[general]{Example!Concrete }
-\index[general]{Concrete Example }
-
-The following discussion was originally written by
-Jesse Guardiani because he has 'internal' and 'external' requiring the
-Director and the Client to use different IP addresses. His original
-solution was to define two different Storage resources in the Director's
-conf file each pointing to the same Storage daemon but with different
-IP addresses. In Bacula 1.38.x this no longer works, because Bacula makes
-a one-to-one association between a Storage daemon resource and a Device (such
-as an Autochanger). As a consequence, I have modified his original
-text to a method that I believe will work, but is as of yet untested
-(KES - July 2006).
-
-My bacula server is on the 192.168.1.0/24 network at IP address 192.168.1.52.
-For the sake of discussion we will refer to this network as the 'internal'
-network because it connects to the internet through a NAT'd firewall. We will
-call the network on the public (internet) side of the NAT'd firewall the
-'external' network. Also, for the sake of discussion we will call my bacula
-server:
-
-\footnotesize
-\begin{verbatim}
- server.int.mydomain.tld
-\end{verbatim}
-\normalsize
-
-when a fully qualified domain name is required, or simply:
-
-\footnotesize
-\begin{verbatim}
- server
-\end{verbatim}
-\normalsize
-
-if a hostname is adequate. We will call the various bacula daemons running on
-the server.int.mydomain.tld machine:
-
-\footnotesize
-\begin{verbatim}
- server-fd
- server-sd
- server-dir
-\end{verbatim}
-\normalsize
-
-In addition, I have two clients that I want to back up with Bacula. The first
-client is on the internal network. Its fully qualified domain name is:
-
-\footnotesize
-\begin{verbatim}
- private1.int.mydomain.tld
-\end{verbatim}
-\normalsize
-
-And its hostname is:
-
-\footnotesize
-\begin{verbatim}
- private1
-\end{verbatim}
-\normalsize
-
-This machine is a client and therefore runs just one bacula daemon:
-
-\footnotesize
-\begin{verbatim}
- private1-fd
-\end{verbatim}
-\normalsize
-
-The second client is on the external network. Its fully qualified domain name
-is:
-
-\footnotesize
-\begin{verbatim}
- public1.mydomain.tld
-\end{verbatim}
-\normalsize
-
-And its hostname is:
-
-\footnotesize
-\begin{verbatim}
- public1
-\end{verbatim}
-\normalsize
-
-This machine also runs just one bacula daemon:
-
-\footnotesize
-\begin{verbatim}
- public1-fd
-\end{verbatim}
-\normalsize
-
-Finally, I have a NAT firewall/gateway with two network interfaces. The first
-interface is on the internal network and serves as a gateway to the internet
-for all the machines attached to the internal network (For example,
-server.int.mydomain.tld and private1.int.mydomain.tld). The second interface
-is on the external (internet) network. The external interface has been
-assigned the name:
-
-\footnotesize
-\begin{verbatim}
- firewall.mydomain.tld
-\end{verbatim}
-\normalsize
-
-Remember:
-
-\footnotesize
-\begin{verbatim}
- *.int.mydomain.tld = internal network
- *.mydomain.tld = external network
-\end{verbatim}
-\normalsize
-
-\subsection{The Bacula Configuration Files for the Above}
-\index[general]{Above!Bacula Configuration Files for the }
-\index[general]{Bacula Configuration Files for the Above }
-
-server-sd manages a 4 tape AIT autoloader. All of my backups are written to
-server-sd. I have just *one* Device resource in my server-sd.conf file:
-
-\footnotesize
-\begin{verbatim}
-Autochanger {
- Name = "autochanger1";\
- Device = Drive0
- Changer Device = /dev/ch0;
- Changer Command = "/usr/local/sbin/chio-bacula %c %o %S %a";
-}
-Device {
- Name = Drive0
- DriveIndex = 0
- Media Type = AIT-1;
- Archive Device = /dev/nrsa1;
- Label Media = yes;
- AutoChanger = yes;
- AutomaticMount = yes; # when device opened, read it
- AlwaysOpen = yes;
- Hardware End of Medium = No
- Fast Forward Space File = No
- BSF at EOM = yes
-}
-\end{verbatim}
-\normalsize
-
-(note, please see
-\ilink{the Tape Testing}{FreeBSDTapes} chapter of this manual
-for important FreeBSD information.) However, unlike previously, there
-is only one Storage definition in my server-dir.conf file:
-
-\footnotesize
-\begin{verbatim}
-Storage {
- Name = "autochanger1" # Storage device for backing up
- Address = Storage-server
- SDPort = 9103
- Password = "mysecretpassword"
- Device = "autochanger1"
- Media Type = AIT-1
- Autochanger = yes
-}
-\end{verbatim}
-\normalsize
-
-Note that the Storage resource uses neither of the two addresses to
-the Storage daemon -- neither server.int.mydomain.tld nor
-firewall.mydomain.tld, but instead uses the address Storage-server.
-
-What is key is that in the internal net, Storage-server is resolved
-to server.int.mydomain.tld, either with an entry in /etc/hosts, or by
-creating and appropriate DNS entry, and on the external net (the Client
-machine), Storage-server is resolved to firewall.mydomain.tld.
-
-
-In addition to the above, I have two Client resources defined in
-server-dir.conf:
-
-\footnotesize
-\begin{verbatim}
-Client {
- Name = private1-fd
- Address = private1.int.mydomain.tld
- FDPort = 9102
- Catalog = MyCatalog
- Password = "mysecretpassword" # password for FileDaemon
-}
-Client {
- Name = public1-fd
- Address = public1.mydomain.tld
- FDPort = 9102
- Catalog = MyCatalog
- Password = "mysecretpassword" # password for FileDaemon
-}
-\end{verbatim}
-\normalsize
-
-And finally, to tie it all together, I have two Job resources defined in
-server-dir.conf:
-
-\footnotesize
-\begin{verbatim}
-Job {
- Name = "Private1-Backup"
- Type = Backup
- Client = private1-fd
- FileSet = "Private1"
- Schedule = "WeeklyCycle"
- Storage = "autochanger1-int"
- Messages = Standard
- Pool = "Weekly"
- Write Bootstrap = "/var/db/bacula/Private1-Backup.bsr"
- Priority = 12
-}
-Job {
- Name = "Public1-Backup"
- Type = Backup
- Client = public1-fd
- FileSet = "Public1"
- Schedule = "WeeklyCycle"
- Storage = "autochanger1-ext"
- Messages = Standard
- Pool = "Weekly"
- Write Bootstrap = "/var/db/bacula/Public1-Backup.bsr"
- Priority = 13
-}
-\end{verbatim}
-\normalsize
-
-It is important to notice that because the 'Private1-Backup' Job is intended
-to back up a machine on the internal network so it resolves Storage-server
-to contact the Storage daemon via the internal net.
-On the other hand, the 'Public1-Backup' Job is intended to
-back up a machine on the external network, so it resolves Storage-server
-to contact the Storage daemon via the external net.
-
-I have left the Pool, Catalog, Messages, FileSet, Schedule, and Director
-resources out of the above server-dir.conf examples because they are not
-pertinent to the discussion.
-
-\subsection{How Does It Work?}
-\index[general]{How Does It Work? }
-\index[general]{Work!How Does It }
-
-If I want to run a backup of private1.int.mydomain.tld and store that backup
-using server-sd then my understanding of the order of events is this:
-
-\begin{enumerate}
-\item I execute my Bacula 'console' command on server.int.mydomain.tld.
-\item console connects to server-dir.
-\item I tell console to 'run' backup Job 'Private1-Backup'.
-\item console relays this command to server-dir.
-\item server-dir connects to private1-fd at private1.int.mydomain.tld:9102
-\item server-dir tells private1-fd to start sending the files defined in the
- 'Private1-Backup' Job's FileSet resource to the Storage resource
- 'autochanger1', which we have defined in server-dir.conf as having the
-address:port of Storage-server, which is mapped by DNS to server.int.mydomain.tld.
-\item private1-fd connects to server.int.mydomain.tld:9103 and begins sending
- files.
- \end{enumerate}
-
-Alternatively, if I want to run a backup of public1.mydomain.tld and store
-that backup using server-sd then my understanding of the order of events is
-this:
-
-\begin{enumerate}
-\item I execute my Bacula 'console' command on server.int.mydomain.tld.
-\item console connects to server-dir.
-\item I tell console to 'run' backup Job 'Public1-Backup'.
-\item console relays this command to server-dir.
-\item server-dir connects, through the NAT'd firewall, to public1-fd at
- public1.mydomain.tld:9102
-\item server-dir tells public1-fd to start sending the files defined in the
- 'Public1-Backup' Job's FileSet resource to the Storage resource
- 'autochanger1', which we have defined in server-dir.conf as having the
- same address:port as above of Storage-server, but which on this machine
- is resolved to firewall.mydomain.tld:9103.
-\item public1-fd connects to firewall.mydomain.tld:9103 and begins sending
- files.
- \end{enumerate}
-
-\subsection{Important Note}
-\index[general]{Important Note }
-\index[general]{Note!Important }
-
-In order for the above 'Public1-Backup' Job to succeed,
-firewall.mydomain.tld:9103 MUST be forwarded using the firewall's
-configuration software to server.int.mydomain.tld:9103. Some firewalls call
-this 'Server Publication'. Others may call it 'Port Forwarding'.
-
-\subsection{Firewall Problems}
-\index[general]{Firewall Problems}
-\index[general]{Problems!Firewalls}
-Either a firewall or a router may decide to timeout and terminate
-open connections if they are not active for a short time. By Internet
-standards the period should be two hours, and should be indefinitely
-extended if KEEPALIVE is set as is the case by Bacula. If your firewall
-or router does not respect these rules, you may find Bacula connections
-terminated. In that case, the first thing to try is turning on the
-{\bf Heart Beat Interval} both in the File daemon and the Storage daemon
-and set an interval of say five minutes.
-
-Also, if you have denial of service rate limiting in your firewall, this
-too can cause Bacula disconnects since Bacula can at times use very high
-access rates. To avoid this, you should implement default accept
-rules for the Bacula ports involved before the rate limiting rules.
-
-Finally, if you have a Windows machine, it will most likely by default
-disallow connections to the Bacula Windows File daemon. See the
-Windows chapter of this manual for additional details.
+++ /dev/null
-#!/usr/bin/perl -w
-# Fixes various things within tex files.
-
-use strict;
-
-my %args;
-
-
-sub get_includes {
- # Get a list of include files from the top-level tex file.
- my (@list,$file);
-
- foreach my $filename (@_) {
- $filename or next;
- # Start with the top-level latex file so it gets checked too.
- push (@list,$filename);
-
- # Get a list of all the html files in the directory.
- open IF,"<$filename" or die "Cannot open input file $filename";
- while (<IF>) {
- chomp;
- push @list,"$1.tex" if (/\\include\{(.*?)\}/);
- }
-
- close IF;
- }
- return @list;
-}
-
-sub convert_files {
- my (@files) = @_;
- my ($linecnt,$filedata,$output,$itemcnt,$indentcnt,$cnt);
-
- $cnt = 0;
- foreach my $file (@files) {
- # Open the file and load the whole thing into $filedata. A bit wasteful but
- # easier to deal with, and we don't have a problem with speed here.
- $filedata = "";
- open IF,"<$file" or die "Cannot open input file $file";
- while (<IF>) {
- $filedata .= $_;
- }
- close IF;
-
- # We look for a line that starts with \item, and indent the two next lines (if not blank)
- # by three spaces.
- my $linecnt = 3;
- $indentcnt = 0;
- $output = "";
- # Process a line at a time.
- foreach (split(/\n/,$filedata)) {
- $_ .= "\n"; # Put back the return.
- # If this line is less than the third line past the \item command,
- # and the line isn't blank and doesn't start with whitespace
- # add three spaces to the start of the line. Keep track of the number
- # of lines changed.
- if ($linecnt < 3 and !/^\\item/) {
- if (/^[^\n\s]/) {
- $output .= " " . $_;
- $indentcnt++;
- } else {
- $output .= $_;
- }
- $linecnt++;
- } else {
- $linecnt = 3;
- $output .= $_;
- }
- /^\\item / and $linecnt = 1;
- }
-
-
- # This is an item line. We need to process it too. If inside a \begin{description} environment, convert
- # \item {\bf xxx} to \item [xxx] or \item [{xxx}] (if xxx contains '[' or ']'.
- $itemcnt = 0;
- $filedata = $output;
- $output = "";
- my ($before,$descrip,$this,$between);
-
- # Find any \begin{description} environment
- while ($filedata =~ /(\\begin[\s\n]*\{[\s\n]*description[\s\n]*\})(.*?)(\\end[\s\n]*\{[\s\n]*description[\s\n]*\})/s) {
- $output .= $` . $1;
- $filedata = $3 . $';
- $descrip = $2;
-
- # Search for \item {\bf xxx}
- while ($descrip =~ /\\item[\s\n]*\{[\s\n]*\\bf[\s\n]*/s) {
- $descrip = $';
- $output .= $`;
- ($between,$descrip) = find_matching_brace($descrip);
- if (!$descrip) {
- $linecnt = $output =~ tr/\n/\n/;
- print STDERR "Missing matching curly brace at line $linecnt in $file\n" if (!$descrip);
- }
-
- # Now do the replacement.
- $between = '{' . $between . '}' if ($between =~ /\[|\]/);
- $output .= "\\item \[$between\]";
- $itemcnt++;
- }
- $output .= $descrip;
- }
- $output .= $filedata;
-
- # If any hyphens or \item commnads were converted, save the file.
- if ($indentcnt or $itemcnt) {
- open OF,">$file" or die "Cannot open output file $file";
- print OF $output;
- close OF;
- print "$indentcnt indent", ($indentcnt == 1) ? "" : "s"," added in $file\n";
- print "$itemcnt item", ($itemcnt == 1) ? "" : "s"," Changed in $file\n";
- }
-
- $cnt += $indentcnt + $itemcnt;
- }
- return $cnt;
-}
-
-sub find_matching_brace {
- # Finds text up to the next matching brace. Assumes that the input text doesn't contain
- # the opening brace, but we want to find text up to a matching closing one.
- # Returns the text between the matching braces, followed by the rest of the text following
- # (which does not include the matching brace).
- #
- my $str = shift;
- my ($this,$temp);
- my $cnt = 1;
-
- while ($cnt) {
- # Ignore verbatim constructs involving curly braces, or if the character preceding
- # the curly brace is a backslash.
- if ($str =~ /\\verb\*?\{.*?\{|\\verb\*?\}.*?\}|\{|\}/s) {
- $this .= $`;
- $str = $';
- $temp = $&;
-
- if ((substr($this,-1,1) eq '\\') or
- $temp =~ /^\\verb/) {
- $this .= $temp;
- next;
- }
-
- $cnt += ($temp eq '{') ? 1 : -1;
- # If this isn't the matching curly brace ($cnt > 0), include the brace.
- $this .= $temp if ($cnt);
- } else {
- # No matching curly brace found.
- return ($this . $str,'');
- }
- }
- return ($this,$str);
-}
-
-sub check_arguments {
- # Checks command-line arguments for ones starting with -- puts them into
- # a hash called %args and removes them from @ARGV.
- my $args = shift;
- my $i;
-
- for ($i = 0; $i < $#ARGV; $i++) {
- $ARGV[$i] =~ /^\-+/ or next;
- $ARGV[$i] =~ s/^\-+//;
- $args{$ARGV[$i]} = "";
- delete ($ARGV[$i]);
-
- }
-}
-
-##################################################################
-# MAIN ####
-##################################################################
-
-my @includes;
-my $cnt;
-
-check_arguments(\%args);
-die "No Files given to Check\n" if ($#ARGV < 0);
-
-# Examine the file pointed to by the first argument to get a list of
-# includes to test.
-@includes = get_includes(@ARGV);
-
-$cnt = convert_files(@includes);
-print "No lines changed\n" unless $cnt;
+++ /dev/null
-# This module does multiple indices, supporting the style of the LaTex 'index'
-# package.
-
-# Version Information:
-# 16-Feb-2005 -- Original Creation. Karl E. Cunningham
-# 14-Mar-2005 -- Clarified and Consolodated some of the code.
-# Changed to smoothly handle single and multiple indices.
-
-# Two LaTeX index formats are supported...
-# --- SINGLE INDEX ---
-# \usepackage{makeidx}
-# \makeindex
-# \index{entry1}
-# \index{entry2}
-# \index{entry3}
-# ...
-# \printindex
-#
-# --- MULTIPLE INDICES ---
-#
-# \usepackage{makeidx}
-# \usepackage{index}
-# \makeindex -- latex2html doesn't care but LaTeX does.
-# \newindex{ref1}{ext1}{ext2}{title1}
-# \newindex{ref2}{ext1}{ext2}{title2}
-# \newindex{ref3}{ext1}{ext2}{title3}
-# \index[ref1]{entry1}
-# \index[ref1]{entry2}
-# \index[ref3]{entry3}
-# \index[ref2]{entry4}
-# \index{entry5}
-# \index[ref3]{entry6}
-# ...
-# \printindex[ref1]
-# \printindex[ref2]
-# \printindex[ref3]
-# \printindex
-# ___________________
-#
-# For the multiple-index style, each index is identified by the ref argument to \newindex, \index,
-# and \printindex. A default index is allowed, which is indicated by omitting the optional
-# argument. The default index does not require a \newindex command. As \index commands
-# are encountered, their entries are stored according
-# to the ref argument. When the \printindex command is encountered, the stored index
-# entries for that argument are retrieved and printed. The title for each index is taken
-# from the last argument in the \newindex command.
-# While processing \index and \printindex commands, if no argument is given the index entries
-# are built into a default index. The title of the default index is simply "Index".
-# This makes the difference between single- and multiple-index processing trivial.
-#
-# Another method can be used by omitting the \printindex command and just using \include to
-# pull in index files created by the makeindex program. These files will start with
-# \begin{theindex}. This command is used to determine where to print the index. Using this
-# approach, the indices will be output in the same order as the newindex commands were
-# originally found (see below). Using a combination of \printindex and \include{indexfile} has not
-# been tested and may produce undesireable results.
-#
-# The index data are stored in a hash for later sorting and output. As \printindex
-# commands are handled, the order in which they were found in the tex filea is saved,
-# associated with the ref argument to \printindex.
-#
-# We use the original %index hash to store the index data into. We append a \002 followed by the
-# name of the index to isolate the entries in different indices from each other. This is necessary
-# so that different indices can have entries with the same name. For the default index, the \002 is
-# appended without the name.
-#
-# Since the index order in the output cannot be determined if the \include{indexfile}
-# command is used, the order will be assumed from the order in which the \newindex
-# commands were originally seen in the TeX files. This order is saved as well as the
-# order determined from any printindex{ref} commands. If \printindex commnads are used
-# to specify the index output, that order will be used. If the \include{idxfile} command
-# is used, the order of the original newindex commands will be used. In this case the
-# default index will be printed last since it doesn't have a corresponding \newindex
-# command and its order cannot be determined. Mixing \printindex and \include{idxfile}
-# commands in the same file is likely to produce less than satisfactory results.
-#
-#
-# The hash containing index data is named %indices. It contains the following data:
-#{
-# 'title' => {
-# $ref1 => $indextitle ,
-# $ref2 => $indextitle ,
-# ...
-# },
-# 'newcmdorder' => [ ref1, ref2, ..., * ], # asterisk indicates the position of the default index.
-# 'printindorder' => [ ref1, ref2, ..., * ], # asterisk indicates the position of the default index.
-#}
-
-
-# Globals to handle multiple indices.
-my %indices;
-
-# This tells the system to use up to 7 words in index entries.
-$WORDS_IN_INDEX = 10;
-
-# KEC 2-18-05
-# Handles the \newindex command. This is called if the \newindex command is
-# encountered in the LaTex source. Gets the index ref and title from the arguments.
-# Saves the index ref and title.
-# Note that we are called once to handle multiple \newindex commands that are
-# newline-separated.
-sub do_cmd_newindex {
- my $data = shift;
- # The data is sent to us as fields delimited by their ID #'s. We extract the
- # fields.
- foreach my $line (split("\n",$data)) {
- my @fields = split (/(?:\<\#\d+?\#\>)+/,$line);
-
- # The index name and title are the second and fourth fields in the data.
- if ($line =~ /^</ or $line =~ /^\\newindex/) {
- my ($indexref,$indextitle) = ($fields[1],$fields[4]);
- $indices{'title'}{$indexref} = $indextitle;
- push (@{$indices{'newcmdorder'}},$indexref);
- }
- }
-}
-
-
-# KEC -- Copied from makeidx.perl and modified to do multiple indices.
-# Processes an \index entry from the LaTex file.
-# Gets the optional argument from the index command, which is the name of the index
-# into which to place the entry.
-# Drops the brackets from the index_name
-# Puts the index entry into the html stream
-# Creates the tokenized index entry (which also saves the index entry info
-sub do_real_index {
- local($_) = @_;
- local($pat,$idx_entry,$index_name);
- # catches opt-arg from \index commands for index.sty
- $index_name = &get_next_optional_argument;
- $index_name = "" unless defined $index_name;
- # Drop leading and trailing brackets from the index name.
- $index_name =~ s/^\[|\]$//g;
-
- $idx_entry = &missing_braces unless (
- (s/$next_pair_pr_rx/$pat=$1;$idx_entry=$2;''/e)
- ||(s/$next_pair_rx/$pat=$1;$idx_entry=$2;''/e));
-
- if ($index_name and defined $idx_entry and
- !defined $indices{'title'}{$index_name}) {
- print STDERR "\nInvalid Index Name: \\index \[$index_name\]\{$idx_entry\}\n";
- }
-
- $idx_entry = &named_index_entry($pat, $idx_entry,$index_name);
- $idx_entry.$_;
-}
-
-# Creates and saves an index entry in the index hashes.
-# Modified to do multiple indices.
-# Creates an index_key that allows index entries to have the same characteristics but be in
-# different indices. This index_key is the regular key with the index name appended.
-# Save the index order for the entry in the %index_order hash.
-sub named_index_entry {
- local($br_id, $str, $index_name) = @_;
- my ($index_key);
- # escape the quoting etc characters
- # ! -> \001
- # @ -> \002
- # | -> \003
- $* = 1; $str =~ s/\n\s*/ /g; $* = 0; # remove any newlines
- # protect \001 occurring with images
- $str =~ s/\001/\016/g; # 0x1 to 0xF
- $str =~ s/\\\\/\011/g; # Double backslash -> 0xB
- $str =~ s/\\;SPMquot;/\012/g; # \;SPMquot; -> 0xC
- $str =~ s/;SPMquot;!/\013/g; # ;SPMquot; -> 0xD
- $str =~ s/!/\001/g; # Exclamation point -> 0x1
- $str =~ s/\013/!/g; # 0xD -> Exclaimation point
- $str =~ s/;SPMquot;@/\015/g; # ;SPMquot;@ to 0xF
- $str =~ s/@/\002/g; # At sign -> 0x2
- $str =~ s/\015/@/g; # 0xF to At sign
- $str =~ s/;SPMquot;\|/\017/g; # ;SMPquot;| to 0x11
- $str =~ s/\|/\003/g; # Vertical line to 0x3
- $str =~ s/\017/|/g; # 0x11 to vertical line
- $str =~ s/;SPMquot;(.)/\1/g; # ;SPMquot; -> whatever the next character is
- $str =~ s/\012/;SPMquot;/g; # 0x12 to ;SPMquot;
- $str =~ s/\011/\\\\/g; # 0x11 to double backslash
- local($key_part, $pageref) = split("\003", $str, 2);
-
- # For any keys of the form: blablabla!blablabla, which want to be split at the
- # exclamation point, replace the ! with a comma and a space. We don't do it
- # that way for this index.
- $key_part =~ s/\001/, /g;
- local(@keys) = split("\001", $key_part);
- # If TITLE is not yet available use $before.
- $TITLE = $saved_title if (($saved_title)&&(!($TITLE)||($TITLE eq $default_title)));
- $TITLE = $before unless $TITLE;
- # Save the reference
- local($words) = '';
- if ($SHOW_SECTION_NUMBERS) { $words = &make_idxnum; }
- elsif ($SHORT_INDEX) { $words = &make_shortidxname; }
- else { $words = &make_idxname; }
- local($super_key) = '';
- local($sort_key, $printable_key, $cur_key);
- foreach $key (@keys) {
- $key =~ s/\016/\001/g; # revert protected \001s
- ($sort_key, $printable_key) = split("\002", $key);
- #
- # RRM: 16 May 1996
- # any \label in the printable-key will have already
- # created a label where the \index occurred.
- # This has to be removed, so that the desired label
- # will be found on the Index page instead.
- #
- if ($printable_key =~ /tex2html_anchor_mark/ ) {
- $printable_key =~ s/><tex2html_anchor_mark><\/A><A//g;
- local($tmpA,$tmpB) = split("NAME=\"", $printable_key);
- ($tmpA,$tmpB) = split("\"", $tmpB);
- $ref_files{$tmpA}='';
- $index_labels{$tmpA} = 1;
- }
- #
- # resolve and clean-up the hyperlink index-entries
- # so they can be saved in an index.pl file
- #
- if ($printable_key =~ /$cross_ref_mark/ ) {
- local($label,$id,$ref_label);
- # $printable_key =~ s/$cross_ref_mark#(\w+)#(\w+)>$cross_ref_mark/
- $printable_key =~ s/$cross_ref_mark#([^#]+)#([^>]+)>$cross_ref_mark/
- do { ($label,$id) = ($1,$2);
- $ref_label = $external_labels{$label} unless
- ($ref_label = $ref_files{$label});
- '"' . "$ref_label#$label" . '">' .
- &get_ref_mark($label,$id)}
- /geo;
- }
- $printable_key =~ s/<\#[^\#>]*\#>//go;
- #RRM
- # recognise \char combinations, for a \backslash
- #
- $printable_key =~ s/\&\#;\'134/\\/g; # restore \\s
- $printable_key =~ s/\&\#;\`<BR> /\\/g; # ditto
- $printable_key =~ s/\&\#;*SPMquot;92/\\/g; # ditto
- #
- # $sort_key .= "@$printable_key" if !($printable_key); # RRM
- $sort_key .= "@$printable_key" if !($sort_key); # RRM
- $sort_key =~ tr/A-Z/a-z/;
- if ($super_key) {
- $cur_key = $super_key . "\001" . $sort_key;
- $sub_index{$super_key} .= $cur_key . "\004";
- } else {
- $cur_key = $sort_key;
- }
-
- # Append the $index_name to the current key with a \002 delimiter. This will
- # allow the same index entry to appear in more than one index.
- $index_key = $cur_key . "\002$index_name";
-
- $index{$index_key} .= "";
-
- #
- # RRM, 15 June 1996
- # if there is no printable key, but one is known from
- # a previous index-entry, then use it.
- #
- if (!($printable_key) && ($printable_key{$index_key}))
- { $printable_key = $printable_key{$index_key}; }
-# if (!($printable_key) && ($printable_key{$cur_key}))
-# { $printable_key = $printable_key{$cur_key}; }
- #
- # do not overwrite the printable_key if it contains an anchor
- #
- if (!($printable_key{$index_key} =~ /tex2html_anchor_mark/ ))
- { $printable_key{$index_key} = $printable_key || $key; }
-# if (!($printable_key{$cur_key} =~ /tex2html_anchor_mark/ ))
-# { $printable_key{$cur_key} = $printable_key || $key; }
-
- $super_key = $cur_key;
- }
- #
- # RRM
- # page-ranges, from |( and |) and |see
- #
- if ($pageref) {
- if ($pageref eq "\(" ) {
- $pageref = '';
- $next .= " from ";
- } elsif ($pageref eq "\)" ) {
- $pageref = '';
- local($next) = $index{$index_key};
-# local($next) = $index{$cur_key};
- # $next =~ s/[\|] *$//;
- $next =~ s/(\n )?\| $//;
- $index{$index_key} = "$next to ";
-# $index{$cur_key} = "$next to ";
- }
- }
-
- if ($pageref) {
- $pageref =~ s/\s*$//g; # remove trailing spaces
- if (!$pageref) { $pageref = ' ' }
- $pageref =~ s/see/<i>see <\/i> /g;
- #
- # RRM: 27 Dec 1996
- # check if $pageref corresponds to a style command.
- # If so, apply it to the $words.
- #
- local($tmp) = "do_cmd_$pageref";
- if (defined &$tmp) {
- $words = &$tmp("<#0#>$words<#0#>");
- $words =~ s/<\#[^\#]*\#>//go;
- $pageref = '';
- }
- }
- #
- # RRM: 25 May 1996
- # any \label in the pageref section will have already
- # created a label where the \index occurred.
- # This has to be removed, so that the desired label
- # will be found on the Index page instead.
- #
- if ($pageref) {
- if ($pageref =~ /tex2html_anchor_mark/ ) {
- $pageref =~ s/><tex2html_anchor_mark><\/A><A//g;
- local($tmpA,$tmpB) = split("NAME=\"", $pageref);
- ($tmpA,$tmpB) = split("\"", $tmpB);
- $ref_files{$tmpA}='';
- $index_labels{$tmpA} = 1;
- }
- #
- # resolve and clean-up any hyperlinks in the page-ref,
- # so they can be saved in an index.pl file
- #
- if ($pageref =~ /$cross_ref_mark/ ) {
- local($label,$id,$ref_label);
- # $pageref =~ s/$cross_ref_mark#(\w+)#(\w+)>$cross_ref_mark/
- $pageref =~ s/$cross_ref_mark#([^#]+)#([^>]+)>$cross_ref_mark/
- do { ($label,$id) = ($1,$2);
- $ref_files{$label} = ''; # ???? RRM
- if ($index_labels{$label}) { $ref_label = ''; }
- else { $ref_label = $external_labels{$label}
- unless ($ref_label = $ref_files{$label});
- }
- '"' . "$ref_label#$label" . '">' . &get_ref_mark($label,$id)}/geo;
- }
- $pageref =~ s/<\#[^\#>]*\#>//go;
-
- if ($pageref eq ' ') { $index{$index_key}='@'; }
- else { $index{$index_key} .= $pageref . "\n | "; }
- } else {
- local($thisref) = &make_named_href('',"$CURRENT_FILE#$br_id",$words);
- $thisref =~ s/\n//g;
- $index{$index_key} .= $thisref."\n | ";
- }
- #print "\nREF: $sort_key : $index_key :$index{$index_key}";
-
- #join('',"<A NAME=$br_id>$anchor_invisible_mark<\/A>",$_);
-
- "<A NAME=\"$br_id\">$anchor_invisible_mark<\/A>";
-}
-
-
-# KEC. -- Copied from makeidx.perl, then modified to do multiple indices.
-# Feeds the index entries to the output. This is called for each index to be built.
-#
-# Generates a list of lookup keys for index entries, from both %printable_keys
-# and %index keys.
-# Sorts the keys according to index-sorting rules.
-# Removes keys with a 0x01 token. (duplicates?)
-# Builds a string to go to the index file.
-# Adds the index entries to the string if they belong in this index.
-# Keeps track of which index is being worked on, so only the proper entries
-# are included.
-# Places the index just built in to the output at the proper place.
-{ my $index_number = 0;
-sub add_real_idx {
- print "\nDoing the index ... Index Number $index_number\n";
- local($key, @keys, $next, $index, $old_key, $old_html);
- my ($idx_ref,$keyref);
- # RRM, 15.6.96: index constructed from %printable_key, not %index
- @keys = keys %printable_key;
-
- while (/$idx_mark/) {
- # Get the index reference from what follows the $idx_mark and
- # remove it from the string.
- s/$idxmark\002(.*?)\002/$idxmark/;
- $idx_ref = $1;
- $index = '';
- # include non- makeidx index-entries
- foreach $key (keys %index) {
- next if $printable_key{$key};
- $old_key = $key;
- if ($key =~ s/###(.*)$//) {
- next if $printable_key{$key};
- push (@keys, $key);
- $printable_key{$key} = $key;
- if ($index{$old_key} =~ /HREF="([^"]*)"/i) {
- $old_html = $1;
- $old_html =~ /$dd?([^#\Q$dd\E]*)#/;
- $old_html = $1;
- } else { $old_html = '' }
- $index{$key} = $index{$old_key} . $old_html."</A>\n | ";
- };
- }
- @keys = sort makeidx_keysort @keys;
- @keys = grep(!/\001/, @keys);
- my $cnt = 0;
- foreach $key (@keys) {
- my ($keyref) = $key =~ /.*\002(.*)/;
- next unless ($idx_ref eq $keyref); # KEC.
- $index .= &add_idx_key($key);
- $cnt++;
- }
- print "$cnt Index Entries Added\n";
- $index = '<DD>'.$index unless ($index =~ /^\s*<D(D|T)>/);
- $index_number++; # KEC.
- if ($SHORT_INDEX) {
- print "(compact version with Legend)";
- local($num) = ( $index =~ s/\<D/<D/g );
- if ($num > 50 ) {
- s/$idx_mark/$preindex<HR><DL>\n$index\n<\/DL>$preindex/o;
- } else {
- s/$idx_mark/$preindex<HR><DL>\n$index\n<\/DL>/o;
- }
- } else {
- s/$idx_mark/<DL COMPACT>\n$index\n<\/DL>/o; }
- }
-}
-}
-
-# KEC. Copied from latex2html.pl and modified to support multiple indices.
-# The bibliography and the index should be treated as separate sections
-# in their own HTML files. The \bibliography{} command acts as a sectioning command
-# that has the desired effect. But when the bibliography is constructed
-# manually using the thebibliography environment, or when using the
-# theindex environment it is not possible to use the normal sectioning
-# mechanism. This subroutine inserts a \bibliography{} or a dummy
-# \textohtmlindex command just before the appropriate environments
-# to force sectioning.
-sub add_bbl_and_idx_dummy_commands {
- local($id) = $global{'max_id'};
-
- s/([\\]begin\s*$O\d+$C\s*thebibliography)/$bbl_cnt++; $1/eg;
- ## if ($bbl_cnt == 1) {
- s/([\\]begin\s*$O\d+$C\s*thebibliography)/$id++; "\\bibliography$O$id$C$O$id$C $1"/geo;
- #}
- $global{'max_id'} = $id;
- # KEC. Modified to global substitution to place multiple index tokens.
- s/[\\]begin\s*($O\d+$C)\s*theindex/\\textohtmlindex$1/go;
- # KEC. Modified to pick up the optional argument to \printindex
- s/[\\]printindex\s*(\[.*?\])?/
- do { (defined $1) ? "\\textohtmlindex $1" : "\\textohtmlindex []"; } /ego;
- &lib_add_bbl_and_idx_dummy_commands() if defined(&lib_add_bbl_and_idx_dummy_commands);
-}
-
-# KEC. Copied from latex2html.pl and modified to support multiple indices.
-# For each textohtmlindex mark found, determine the index titles and headers.
-# We place the index ref in the header so the proper index can be generated later.
-# For the default index, the index ref is blank.
-#
-# One problem is that this routine is called twice.. Once for processing the
-# command as originally seen, and once for processing the command when
-# doing the name for the index file. We can detect that by looking at the
-# id numbers (or ref) surrounding the \theindex command, and not incrementing
-# index_number unless a new id (or ref) is seen. This has the side effect of
-# having to unconventionally start the index_number at -1. But it works.
-#
-# Gets the title from the list of indices.
-# If this is the first index, save the title in $first_idx_file. This is what's referenced
-# in the navigation buttons.
-# Increment the index_number for next time.
-# If the indexname command is defined or a newcommand defined for indexname, do it.
-# Save the index TITLE in the toc
-# Save the first_idx_file into the idxfile. This goes into the nav buttons.
-# Build index_labels if needed.
-# Create the index headings and put them in the output stream.
-
-{ my $index_number = 0; # Will be incremented before use.
- my $first_idx_file; # Static
- my $no_increment = 0;
-
-sub do_cmd_textohtmlindex {
- local($_) = @_;
- my ($idxref,$idxnum,$index_name);
-
- # We get called from make_name with the first argument = "\001noincrement". This is a sign
- # to not increment $index_number the next time we are called. We get called twice, once
- # my make_name and once by process_command. Unfortunately, make_name calls us just to set the name
- # but doesn't use the result so we get called a second time by process_command. This works fine
- # except for cases where there are multiple indices except if they aren't named, which is the case
- # when the index is inserted by an include command in latex. In these cases we are only able to use
- # the index number to decide which index to draw from, and we don't know how to increment that index
- # number if we get called a variable number of times for the same index, as is the case between
- # making html (one output file) and web (multiple output files) output formats.
- if (/\001noincrement/) {
- $no_increment = 1;
- return;
- }
-
- # Remove (but save) the index reference
- s/^\s*\[(.*?)\]/{$idxref = $1; "";}/e;
-
- # If we have an $idxref, the index name was specified. In this case, we have all the
- # information we need to carry on. Otherwise, we need to get the idxref
- # from the $index_number and set the name to "Index".
- if ($idxref) {
- $index_name = $indices{'title'}{$idxref};
- } else {
- if (defined ($idxref = $indices{'newcmdorder'}->[$index_number])) {
- $index_name = $indices{'title'}{$idxref};
- } else {
- $idxref = '';
- $index_name = "Index";
- }
- }
-
- $idx_title = "Index"; # The name displayed in the nav bar text.
-
- # Only set $idxfile if we are at the first index. This will point the
- # navigation panel to the first index file rather than the last.
- $first_idx_file = $CURRENT_FILE if ($index_number == 0);
- $idxfile = $first_idx_file; # Pointer for the Index button in the nav bar.
- $toc_sec_title = $index_name; # Index link text in the toc.
- $TITLE = $toc_sec_title; # Title for this index, from which its filename is built.
- if (%index_labels) { &make_index_labels(); }
- if (($SHORT_INDEX) && (%index_segment)) { &make_preindex(); }
- else { $preindex = ''; }
- local $idx_head = $section_headings{'textohtmlindex'};
- local($heading) = join(''
- , &make_section_heading($TITLE, $idx_head)
- , $idx_mark, "\002", $idxref, "\002" );
- local($pre,$post) = &minimize_open_tags($heading);
- $index_number++ unless ($no_increment);
- $no_increment = 0;
- join('',"<BR>\n" , $pre, $_);
-}
-}
-
-# Returns an index key, given the key passed as the first argument.
-# Not modified for multiple indices.
-sub add_idx_key {
- local($key) = @_;
- local($index, $next);
- if (($index{$key} eq '@' )&&(!($index_printed{$key}))) {
- if ($SHORT_INDEX) { $index .= "<DD><BR>\n<DT>".&print_key."\n<DD>"; }
- else { $index .= "<DT><DD><BR>\n<DT>".&print_key."\n<DD>"; }
- } elsif (($index{$key})&&(!($index_printed{$key}))) {
- if ($SHORT_INDEX) {
- $next = "<DD>".&print_key."\n : ". &print_idx_links;
- } else {
- $next = "<DT>".&print_key."\n<DD>". &print_idx_links;
- }
- $index .= $next."\n";
- $index_printed{$key} = 1;
- }
-
- if ($sub_index{$key}) {
- local($subkey, @subkeys, $subnext, $subindex);
- @subkeys = sort(split("\004", $sub_index{$key}));
- if ($SHORT_INDEX) {
- $index .= "<DD>".&print_key unless $index_printed{$key};
- $index .= "<DL>\n";
- } else {
- $index .= "<DT>".&print_key."\n<DD>" unless $index_printed{$key};
- $index .= "<DL COMPACT>\n";
- }
- foreach $subkey (@subkeys) {
- $index .= &add_sub_idx_key($subkey) unless ($index_printed{$subkey});
- }
- $index .= "</DL>\n";
- }
- return $index;
-}
-
-1; # Must be present as the last line.
+++ /dev/null
-%%
-%%
-
-\chapter{What To Do When Bacula Crashes (Kaboom)}
-\label{KaboomChapter}
-\index[general]{Kaboom!What To Do When Bacula Crashes }
-\index[general]{What To Do When Bacula Crashes (Kaboom) }
-
-If you are running on a Linux system, and you have a set of working
-configuration files, it is very unlikely that {\bf Bacula} will crash. As with
-all software, however, it is inevitable that someday, it may crash,
-particularly if you are running on another operating system or using a new or
-unusual feature.
-
-This chapter explains what you should do if one of the three {\bf Bacula}
-daemons (Director, File, Storage) crashes. When we speak of crashing, we
-mean that the daemon terminates abnormally because of an error. There are
-many cases where Bacula detects errors (such as PIPE errors) and will fail
-a job. These are not considered crashes. In addition, under certain
-conditions, Bacula will detect a fatal in the configuration, such as
-lack of permission to read/write the working directory. In that case,
-Bacula will force itself to crash with a SEGFAULT. However, before
-crashing, Bacula will normally display a message indicating why.
-For more details, please read on.
-
-
-\section{Traceback}
-\index[general]{Traceback}
-
-Each of the three Bacula daemons has a built-in exception handler which, in
-case of an error, will attempt to produce a traceback. If successful the
-traceback will be emailed to you.
-
-For this to work, you need to ensure that a few things are setup correctly on
-your system:
-
-\begin{enumerate}
-\item You must have a version of Bacula built with debug information turned
- on and not stripped of debugging symbols.
-
-\item You must have an installed copy of {\bf gdb} (the GNU debugger), and it
- must be on {\bf Bacula's} path. On some systems such as Solaris, {\bf
- gdb} may be replaced by {\bf dbx}.
-
-\item The Bacula installed script file {\bf btraceback} must be in the same
- directory as the daemon which dies, and it must be marked as executable.
-
-\item The script file {\bf btraceback.gdb} must have the correct path to it
- specified in the {\bf btraceback} file.
-
-\item You must have a {\bf mail} program which is on {\bf Bacula's} path.
- By default, this {\bf mail} program is set to {\bf bsmtp}, so it must
- be correctly configured.
-
-\item If you run either the Director or Storage daemon under a non-root
- userid, you will most likely need to modify the {\bf btraceback} file
- to do something like {\bf sudo} (raise to root priority) for the
- call to {\bf gdb} so that it has the proper permissions to debug
- Bacula.
-\end{enumerate}
-
-If all the above conditions are met, the daemon that crashes will produce a
-traceback report and email it to you. If the above conditions are not true,
-you can either run the debugger by hand as described below, or you may be able
-to correct the problems by editing the {\bf btraceback} file. I recommend not
-spending too much time on trying to get the traceback to work as it can be
-very difficult.
-
-The changes that might be needed are to add a correct path to the {\bf gdb}
-program, correct the path to the {\bf btraceback.gdb} file, change the {\bf
-mail} program or its path, or change your email address. The key line in the
-{\bf btraceback} file is:
-
-\footnotesize
-\begin{verbatim}
-gdb -quiet -batch -x /home/kern/bacula/bin/btraceback.gdb \
- $1 $2 2>\&1 | bsmtp -s "Bacula traceback" your-address@xxx.com
-\end{verbatim}
-\normalsize
-
-Since each daemon has the same traceback code, a single btraceback file is
-sufficient if you are running more than one daemon on a machine.
-
-\section{Testing The Traceback}
-\index[general]{Traceback!Testing The }
-\index[general]{Testing The Traceback }
-
-To "manually" test the traceback feature, you simply start {\bf Bacula} then
-obtain the {\bf PID} of the main daemon thread (there are multiple threads).
-The output produced here will look different depending on what OS and what
-version of the kernel you are running.
-Unfortunately, the output had to be split to fit on this page:
-
-\footnotesize
-\begin{verbatim}
-[kern@rufus kern]$ ps fax --columns 132 | grep bacula-dir
- 2103 ? S 0:00 /home/kern/bacula/k/src/dird/bacula-dir -c
- /home/kern/bacula/k/src/dird/dird.conf
- 2104 ? S 0:00 \_ /home/kern/bacula/k/src/dird/bacula-dir -c
- /home/kern/bacula/k/src/dird/dird.conf
- 2106 ? S 0:00 \_ /home/kern/bacula/k/src/dird/bacula-dir -c
- /home/kern/bacula/k/src/dird/dird.conf
- 2105 ? S 0:00 \_ /home/kern/bacula/k/src/dird/bacula-dir -c
- /home/kern/bacula/k/src/dird/dird.conf
-\end{verbatim}
-\normalsize
-
-which in this case is 2103. Then while Bacula is running, you call the program
-giving it the path to the Bacula executable and the {\bf PID}. In this case,
-it is:
-
-\footnotesize
-\begin{verbatim}
-./btraceback /home/kern/bacula/k/src/dird 2103
-\end{verbatim}
-\normalsize
-
-It should produce an email showing you the current state of the daemon (in
-this case the Director), and then exit leaving {\bf Bacula} running as if
-nothing happened. If this is not the case, you will need to correct the
-problem by modifying the {\bf btraceback} script.
-
-Typical problems might be that {\bf gdb} or {\bf dbx} for Solaris is not on
-the default path. Fix this by specifying the full path to it in the {\bf
-btraceback} file. Another common problem is that you haven't modified the
-script so that the {\bf bsmtp} program has an appropriate smtp server or
-the proper syntax for your smtp server. If you use the {\bf mail} program
-and it is not on the default path, it will also fail. On some systems, it
-is preferable to use {\bf Mail} rather than {\bf mail}.
-
-\section{Getting A Traceback On Other Systems}
-\index[general]{Getting A Traceback On Other Systems}
-\index[general]{Systems!Getting A Traceback On Other}
-
-It should be possible to produce a similar traceback on systems other than
-Linux, either using {\bf gdb} or some other debugger. Solaris with {\bf dbx}
-loaded works quite fine. On other systems, you will need to modify the {\bf
-btraceback} program to invoke the correct debugger, and possibly correct the
-{\bf btraceback.gdb} script to have appropriate commands for your debugger. If
-anyone succeeds in making this work with another debugger, please send us a
-copy of what you modified. Please keep in mind that for any debugger to
-work, it will most likely need to run as root, so you may need to modify
-the {\bf btraceback} script accordingly.
-
-\label{ManuallyDebugging}
-\section{Manually Running Bacula Under The Debugger}
-\index[general]{Manually Running Bacula Under The Debugger}
-\index[general]{Debugger!Manually Running Bacula Under The}
-
-If for some reason you cannot get the automatic traceback, or if you want to
-interactively examine the variable contents after a crash, you can run Bacula
-under the debugger. Assuming you want to run the Storage daemon under the
-debugger (the technique is the same for the other daemons, only the name
-changes), you would do the following:
-
-\begin{enumerate}
-\item Start the Director and the File daemon. If the Storage daemon also
- starts, you will need to find its PID as shown above (ps fax | grep
- bacula-sd) and kill it with a command like the following:
-
-\footnotesize
-\begin{verbatim}
- kill -15 PID
-\end{verbatim}
-\normalsize
-
-where you replace {\bf PID} by the actual value.
-
-\item At this point, the Director and the File daemon should be running but
- the Storage daemon should not.
-
-\item cd to the directory containing the Storage daemon
-
-\item Start the Storage daemon under the debugger:
-
- \footnotesize
-\begin{verbatim}
- gdb ./bacula-sd
-\end{verbatim}
-\normalsize
-
-\item Run the Storage daemon:
-
- \footnotesize
-\begin{verbatim}
- run -s -f -c ./bacula-sd.conf
-\end{verbatim}
-\normalsize
-
-You may replace the {\bf ./bacula-sd.conf} with the full path to the Storage
-daemon's configuration file.
-
-\item At this point, Bacula will be fully operational.
-
-\item In another shell command window, start the Console program and do what
- is necessary to cause Bacula to die.
-
-\item When Bacula crashes, the {\bf gdb} shell window will become active and
- {\bf gdb} will show you the error that occurred.
-
-\item To get a general traceback of all threads, issue the following command:
-
-
-\footnotesize
-\begin{verbatim}
- thread apply all bt
-\end{verbatim}
-\normalsize
-
-After that you can issue any debugging command.
-\end{enumerate}
-
-\section{Getting Debug Output from Bacula}
-\index[general]{Getting Debug Output from Bacula }
-Each of the daemons normally has debug compiled into the program, but
-disabled. There are two ways to enable the debug output. One is to add the
-{\bf -d nnn} option on the command line when starting the debugger. The {\bf
-nnn} is the debug level, and generally anything between 50 and 200 is
-reasonable. The higher the number, the more output is produced. The output is
-written to standard output.
-
-The second way of getting debug output is to dynamically turn it on using the
-Console using the {\bf setdebug} command. The full syntax of the command is:
-
-\footnotesize
-\begin{verbatim}
- setdebug level=nnn client=client-name storage=storage-name dir
-\end{verbatim}
-\normalsize
-
-If none of the options are given, the command will prompt you. You can
-selectively turn on/off debugging in any or all the daemons (i.e. it is not
-necessary to specify all the components of the above command).
+++ /dev/null
-# This file serves as a place to put initialization code and constants to
-# affect the behavior of latex2html for generating the bacula manuals.
-
-# $LINKPOINT specifies what filename to use to link to when creating
-# index.html. Not that this is a hard link.
-$LINKPOINT='"$OVERALL_TITLE"';
-
-
-# The following must be the last line of this file.
-1;
+++ /dev/null
-[General]
-img_extIsRegExp=false
-img_extensions=.eps .jpg .jpeg .png .pdf .ps .fig .gif
-kileprversion=2
-kileversion=2.0
-lastDocument=problems.tex
-masterDocument=
-name=Problems
-pkg_extIsRegExp=false
-pkg_extensions=.cls .sty
-src_extIsRegExp=false
-src_extensions=.tex .ltx .latex .dtx .ins
-
-[Tools]
-MakeIndex=
-QuickBuild=
-
-[item:faq.tex]
-archive=true
-column=0
-encoding=UTF-8
-highlight=LaTeX
-line=146
-open=false
-order=4
-
-[item:fdl.tex]
-archive=true
-column=1179666
-encoding=
-highlight=
-line=0
-open=false
-order=-1
-
-[item:firewalls.tex]
-archive=true
-column=2
-encoding=UTF-8
-highlight=LaTeX
-line=0
-open=false
-order=3
-
-[item:kaboom.tex]
-archive=true
-column=0
-encoding=UTF-8
-highlight=LaTeX
-line=0
-open=false
-order=2
-
-[item:problems.kilepr]
-archive=true
-column=0
-encoding=UTF-8
-highlight=None
-line=0
-open=false
-order=-1
-
-[item:problems.tex]
-archive=true
-column=36
-encoding=UTF-8
-highlight=LaTeX
-line=53
-open=true
-order=0
-
-[item:tapetesting.tex]
-archive=true
-column=2
-encoding=UTF-8
-highlight=LaTeX
-line=0
-open=false
-order=1
-
-[item:version.tex]
-archive=true
-column=0
-encoding=UTF-8
-highlight=LaTeX
-line=0
-open=false
-order=5
+++ /dev/null
-%%
-%%
-%% The following characters must be preceded by a backslash
-%% to be entered as printable characters:
-%%
-%% # $ % & ~ _ ^ \ { }
-%%
-
-\documentclass[10pt,a4paper]{book}
-
-\topmargin -0.5in
-\oddsidemargin 0.0in
-\evensidemargin 0.0in
-\textheight 10in
-\textwidth 6.5in
-
-\usepackage{html}
-\usepackage{float}
-\usepackage{graphicx}
-\usepackage{bacula}
-\usepackage{longtable}
-\usepackage{makeidx}
-\usepackage{index}
-\usepackage{setspace}
-\usepackage{hyperref}
-\usepackage{url}
-%\usepackage{german}
-
-\makeindex
-\newindex{general}{idx}{ind}{General Index}
-
-\sloppy
-
-\begin{document}
-\sloppy
-
-\newfont{\bighead}{cmr17 at 36pt}
-\parskip 10pt
-\parindent 0pt
-
-\title{\includegraphics{\idir bacula-logo.eps} \\ \bigskip
- \Huge{Bacula Fehlerdiagnose Handbuch}
- \begin{center}
- \large{It comes in the night and sucks
- the essence from your computers. }
- \end{center}
-}
-
-
-\author{Kern Sibbald}
-\date{\vspace{1.0in}\today \\
- This manual documents Bacula version \input{version} \\
- \vspace{0.2in}
- Copyright \copyright 1999-2009, Free Software Foundation Europe
- e.V. \\
- \vspace{0.2in}
- Permission is granted to copy, distribute and/or modify this document under the terms of the
- GNU Free Documentation License, Version 1.2 published by the Free Software Foundation;
- with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
- A copy of the license is included in the section entitled "GNU Free Documentation License".
-}
-
-\maketitle
-
-\clearpage
-\tableofcontents
-\clearpage
-\listoffigures
-\clearpage
-\listoftables
-\clearpage
-
-\include{faq}
-\include{tips}
-\include{tapetesting}
-\include{firewalls}
-\include{kaboom}
-\include{fdl}
-
-
-% The following line tells link_resolver.pl to not include these files:
-% nolinks developersi baculai-dir baculai-fd baculai-sd baculai-console baculai-main
-
-% pull in the index
-\clearpage
-\printindex[general]
-
-\end{document}
+++ /dev/null
-%%
-%%
-
-\chapter{Bacula RPM Packaging FAQ}
-\label{RpmFaqChapter}
-\index[general]{FAQ!Bacula\textsuperscript{\textregistered} - RPM Packaging }
-\index[general]{Bacula\textsuperscript{\textregistered} - RPM Packaging FAQ }
-
-\begin{enumerate}
-\item
- \ilink{How do I build Bacula for platform xxx?}{faq1}
-\item
- \ilink{How do I control which database support gets built?}{faq2}
-
-\item
- \ilink{What other defines are used?}{faq3}
-\item
- \ilink{I'm getting errors about not having permission when I try to build the
- packages. Do I need to be root?}{faq4}
-\item
- \ilink{I'm building my own rpms but on all platforms and compiles I get an
- unresolved dependency for something called
- /usr/afsws/bin/pagsh.}{faq5}
-\item
- \ilink{I'm building my own rpms because you don't publish for my platform.
- Can I get my packages released to sourceforge for other people to use?}{faq6}
-\item
- \ilink{Is there an easier way than sorting out all these command line options?}{faq7}
-\item
- \ilink{I just upgraded from 1.36.x to 1.38.x and now my director daemon won't start. It appears to start but dies silently and I get a "connection refused" error when starting the console. What is wrong?}{faq8}
-\item
- \ilink{There are a lot of rpm packages. Which packages do I need for what?}{faq9}
-\end{enumerate}
-
-\section{Answers}
-\index[general]{Answers }
-
-\begin{enumerate}
-\item
- \label{faq1}
- {\bf How do I build Bacula for platform xxx?}
- The bacula spec file contains defines to build for several platforms:
- Red Hat 7.x (rh7), Red Hat 8.0 (rh8), Red Hat 9 (rh9), Fedora Core (fc1,
- fc3, fc4, fc5, fc6, fc7), Whitebox Enterprise Linux 3.0 (wb3), Red Hat Enterprise Linux
- (rhel3, rhel4, rhel5), Mandrake 10.x (mdk), Mandriva 2006.x (mdv) CentOS (centos3, centos4, centos5)
- Scientific Linux (sl3, sl4, sl5) and SuSE (su9, su10, su102, su103). The package build is controlled by a mandatory define set at the beginning of the file. These defines basically just control the dependency information that gets coded into the finished rpm package as well
- as any special configure options required. The platform define may be edited
- in the spec file directly (by default all defines are set to 0 or "not set").
- For example, to build the Red Hat 7.x package find the line in the spec file
- which reads
-
-\footnotesize
-\begin{verbatim}
- %define rh7 0
-
-\end{verbatim}
-\normalsize
-
-and edit it to read
-
-\footnotesize
-\begin{verbatim}
- %define rh7 1
-
-\end{verbatim}
-\normalsize
-
-Alternately you may pass the define on the command line when calling rpmbuild:
-
-
-\footnotesize
-\begin{verbatim}
- rpmbuild -ba --define "build_rh7 1" bacula.spec
- rpmbuild --rebuild --define build_rh7 1" bacula-x.x.x-x.src.rpm
-
-\end{verbatim}
-\normalsize
-
-\item
- \label{faq2}
- {\bf How do I control which database support gets built?}
- Another mandatory build define controls which database support is compiled,
- one of build\_sqlite, build\_mysql or build\_postgresql. To get the MySQL
- package and support either set the
-
-\footnotesize
-\begin{verbatim}
- %define mysql 0
- OR
- %define mysql4 0
- OR
- %define mysql5 0
-
-\end{verbatim}
-\normalsize
-
-to
-
-\footnotesize
-\begin{verbatim}
- %define mysql 1
- OR
- %define mysql4 1
- OR
- %define mysql5 1
-
-\end{verbatim}
-\normalsize
-
-in the spec file directly or pass it to rpmbuild on the command line:
-
-\footnotesize
-\begin{verbatim}
- rpmbuild -ba --define "build_rh7 1" --define "build_mysql 1" bacula.spec
- rpmbuild -ba --define "build_rh7 1" --define "build_mysql4 1" bacula.spec
- rpmbuild -ba --define "build_rh7 1" --define "build_mysql5 1" bacula.spec
-
-\end{verbatim}
-\normalsize
-
-\item
- \label{faq3}
- {\bf What other defines are used?}
- Three other building defines of note are the depkgs\_version, docs\_version and
- \_rescuever identifiers. These two defines are set with each release and must
- match the version of those sources that are being used to build the packages.
- You would not ordinarily need to edit these. See also the Build Options section
- below for other build time options that can be passed on the command line.
-\item
- \label{faq4}
- {\bf I'm getting errors about not having permission when I try to build the
- packages. Do I need to be root?}
- No, you do not need to be root and, in fact, it is better practice to
- build rpm packages as a non-root user. Bacula packages are designed to
- be built by a regular user but you must make a few changes on your
- system to do this. If you are building on your own system then the
- simplest method is to add write permissions for all to the build
- directory (/usr/src/redhat/, /usr/src/RPM or /usr/src/packages).
- To accomplish this, execute the following command as root:
-
-\footnotesize
-\begin{verbatim}
- chmod -R 777 /usr/src/redhat
- chmod -R 777 /usr/src/RPM
- chmod -R 777 /usr/src/packages
-
-\end{verbatim}
-\normalsize
-
-If you are working on a shared system where you can not use the method
-above then you need to recreate the appropriate above directory tree with all
-of its subdirectories inside your home directory. Then create a file named
-
-{\tt .rpmmacros}
-
-in your home directory (or edit the file if it already exists)
-and add the following line:
-
-\footnotesize
-\begin{verbatim}
- %_topdir /home/myuser/redhat
- %_tmppath /tmp
-
-\end{verbatim}
-\normalsize
-
-Another handy directive for the .rpmmacros file if you wish to suppress the
-creation of debug rpm packages is:
-
-\footnotesize
-\begin{verbatim}
- %debug_package %{nil}
-
-\end{verbatim}
-
-\normalsize
-
-\item
- \label{faq5}
- {\bf I'm building my own rpms but on all platforms and compiles I get an
- unresolved dependency for something called /usr/afsws/bin/pagsh.} This
- is a shell from the OpenAFS (Andrew File System). If you are seeing
- this then you chose to include the docs/examples directory in your
- package. One of the example scripts in this directory is a pagsh
- script. Rpmbuild, when scanning for dependencies, looks at the shebang
- line of all packaged scripts in addition to checking shared libraries.
- To avoid this do not package the examples directory. If you are seeing this
- problem you are building a very old bacula package as the examples have been
- removed from the doc packaging.
-
-\item
- \label{faq6}
- {\bf I'm building my own rpms because you don't publish for my platform.
- Can I get my packages released to sourceforge for other people to use?} Yes,
- contributions from users are accepted and appreciated. Please examine the
- directory platforms/contrib-rpm in the source code for further information.
-
-\item
- \label{faq7}
- {\bf Is there an easier way than sorting out all these command line options?} Yes,
- there is a gui wizard shell script which you can use to rebuild the src rpm package.
- Look in the source archive for platforms/contrib-rpm/rpm\_wizard.sh. This script will
- allow you to specify build options using GNOME dialog screens. It requires zenity.
-
-\item
- \label{faq8}
- {\bf I just upgraded from 1.36.x to 1.38.x and now my director daemon
-won't start. It appears to start but dies silently and I get a "connection
-refused" error when starting the console. What is wrong?} Beginning with
-1.38 the rpm packages are configured to run the director and storage
-daemons as a non-root user. The file daemon runs as user root and group
-bacula, the storage daemon as user bacula and group disk, and the director
-as user bacula and group bacula. If you are upgrading you will need to
-change some file permissions for things to work. Execute the following
-commands as root:
-
-\footnotesize
-\begin{verbatim}
- chown bacula.bacula /var/bacula/*
- chown root.bacula /var/bacula/bacula-fd.9102.state
- chown bacula.disk /var/bacula/bacula-sd.9103.state
-
-\end{verbatim}
-\normalsize
-
-Further, if you are using File storage volumes rather than tapes those
-files will also need to have ownership set to user bacula and group bacula.
-
-\item
- \label{faq9}
- {\bf There are a lot of rpm packages. Which packages do I need for
-what?} For a bacula server you need to select the packsge based upon your
-preferred catalog database: one of bacula-mysql, bacula-postgresql or
-bacula-sqlite. If your system does not provide an mtx package you also
-need bacula-mtx to satisfy that dependancy. For a client machine you need
-only install bacula-client. Optionally, for either server or client
-machines, you may install a graphical console bacula-gconsole and/or
-bacula-wxconsole. The Bacula Administration Tool is installed with the
-bacula-bat package. One last package, bacula-updatedb is required only when
-upgrading a server more than one database revision level.
-
-
-
-\item {\bf Support for RHEL3/4/5, CentOS 3/4/5, Scientific Linux 3/4/5 and x86\_64}
- The examples below show
- explicit build support for RHEL4 and CentOS 4. Build support
- for x86\_64 has also been added.
-\end{enumerate}
-
-\footnotesize
-\begin{verbatim}
-Build with one of these 3 commands:
-
-rpmbuild --rebuild \
- --define "build_rhel4 1" \
- --define "build_sqlite 1" \
- bacula-1.38.3-1.src.rpm
-
-rpmbuild --rebuild \
- --define "build_rhel4 1" \
- --define "build_postgresql 1" \
- bacula-1.38.3-1.src.rpm
-
-rpmbuild --rebuild \
- --define "build_rhel4 1" \
- --define "build_mysql4 1" \
- bacula-1.38.3-1.src.rpm
-
-For CentOS substitute '--define "build_centos4 1"' in place of rhel4.
-For Scientific Linux substitute '--define "build_sl4 1"' in place of rhel4.
-
-For 64 bit support add '--define "build_x86_64 1"'
-\end{verbatim}
-\normalsize
-
-\section{Build Options}
-\index[general]{Build Options}
-The spec file currently supports building on the following platforms:
-\footnotesize
-\begin{verbatim}
-Red Hat builds
---define "build_rh7 1"
---define "build_rh8 1"
---define "build_rh9 1"
-
-Fedora Core build
---define "build_fc1 1"
---define "build_fc3 1"
---define "build_fc4 1"
---define "build_fc5 1"
---define "build_fc6 1"
---define "build_fc7 1"
-
-Whitebox Enterprise build
---define "build_wb3 1"
-
-Red Hat Enterprise builds
---define "build_rhel3 1"
---define "build_rhel4 1"
---define "build_rhel5 1"
-
-CentOS build
---define "build_centos3 1"
---define "build_centos4 1"
---define "build_centos5 1"
-
-Scientific Linux build
---define "build_sl3 1"
---define "build_sl4 1"
---define "build_sl5 1"
-
-SuSE build
---define "build_su9 1"
---define "build_su10 1"
---define "build_su102 1"
---define "build_su103 1"
-
-Mandrake 10.x build
---define "build_mdk 1"
-
-Mandriva build
---define "build_mdv 1"
-
-MySQL support:
-for mysql 3.23.x support define this
---define "build_mysql 1"
-if using mysql 4.x define this,
-currently: Mandrake 10.x, Mandriva 2006.0, SuSE 9.x & 10.0, FC4 & RHEL4
---define "build_mysql4 1"
-if using mysql 5.x define this,
-currently: SuSE 10.1 & FC5
---define "build_mysql5 1"
-
-PostgreSQL support:
---define "build_postgresql 1"
-
-Sqlite support:
---define "build_sqlite 1"
-
-Build the client rpm only in place of one of the above database full builds:
---define "build_client_only 1"
-
-X86-64 support:
---define "build_x86_64 1"
-
-Supress build of bgnome-console:
---define "nobuild_gconsole 1"
-
-Build the WXWindows console:
-requires wxGTK >= 2.6
---define "build_wxconsole 1"
-
-Build the Bacula Administration Tool:
-requires QT >= 4.2
---define "build_bat 1"
-
-Build python scripting support:
---define "build_python 1"
-
-Modify the Packager tag for third party packages:
---define "contrib_packager Your Name <youremail@site.org>"
-
-\end{verbatim}
-\normalsize
-
-\section{RPM Install Problems}
-\index[general]{RPM Install Problems}
-In general the RPMs, once properly built should install correctly.
-However, when attempting to run the daemons, a number of problems
-can occur:
-\begin{itemize}
-\item [Wrong /var/bacula Permissions]
- By default, the Director and Storage daemon do not run with
- root permission. If the /var/bacula is owned by root, then it
- is possible that the Director and the Storage daemon will not
- be able to access this directory, which is used as the Working
- Directory. To fix this, the easiest thing to do is:
-\begin{verbatim}
- chown bacula:bacula /var/bacula
-\end{verbatim}
- Note: as of 1.38.8 /var/bacula is installed root:bacula with
- permissions 770.
-\item [The Storage daemon cannot Access the Tape drive]
- This can happen in some older RPM releases where the Storage
- daemon ran under userid bacula, group bacula. There are two
- ways of fixing this: the best is to modify the /etc/init.d/bacula-sd
- file so that it starts the Storage daemon with group "disk".
- The second way to fix the problem is to change the permissions
- of your tape drive (usually /dev/nst0) so that Bacula can access it.
- You will probably need to change the permissions of the SCSI control
- device as well, which is usually /dev/sg0. The exact names depend
- on your configuration, please see the Tape Testing chapter for
- more information on devices.
-\end{itemize}
-
+++ /dev/null
-/*
- * html2latex
- */
-
-available {
- sun4_sunos.4
- sun4_solaris.2
- rs_aix.3
- rs_aix.4
- sgi_irix
-}
-
-description {
- From Jeffrey Schaefer, Geometry Center. Translates HTML document to LaTeX
-}
-
-install {
- bin/html2latex /afs/rpi.edu/dept/acs/rpinfo/filters/GChtml2latex/html2latex
- bin/html2latex.tag /afs/rpi.edu/dept/acs/rpinfo/filters/GChtml2latex/html2latex.tag
- bin/html2latex-local.tag /afs/rpi.edu/dept/acs/rpinfo/filters/GChtml2latex/html2latex-local.tag
- bin/webtex2latex.tag /afs/rpi.edu/dept/acs/rpinfo/filters/GChtml2latex/webtex2latex.tag
- man/man1/html2latex.1 /afs/rpi.edu/dept/acs/rpinfo/filters/GChtml2latex/html2latex.1
-}
+++ /dev/null
-%%
-%%
-
-\chapter{Testing Your Tape Drive With Bacula}
-\label{TapeTestingChapter}
-\index[general]{Testing Your Tape Drive With Bacula}
-
-This chapter is concerned with testing and configuring your tape drive to make
-sure that it will work properly with Bacula using the {\bf btape} program.
-\label{summary}
-
-\section{Get Your Tape Drive Working}
-
-In general, you should follow the following steps to get your tape drive to
-work with Bacula. Start with a tape mounted in your drive. If you have an
-autochanger, load a tape into the drive. We use {\bf /dev/nst0} as the tape
-drive name, you will need to adapt it according to your system.
-
-Do not proceed to the next item until you have succeeded with the previous
-one.
-
-\begin{enumerate}
-\item Make sure that Bacula (the Storage daemon) is not running
- or that you have {\bf unmount}ed the drive you will use
- for testing.
-
-\item Use tar to write to, then read from your drive:
-
- \footnotesize
-\begin{verbatim}
- mt -f /dev/nst0 rewind
- tar cvf /dev/nst0 .
- mt -f /dev/nst0 rewind
- tar tvf /dev/nst0
-
-\end{verbatim}
-\normalsize
-
-\item Make sure you have a valid and correct Device resource corresponding
- to your drive. For Linux users, generally, the default one works. For
- FreeBSD users, there are two possible Device configurations (see below).
- For other drives and/or OSes, you will need to first ensure that your
- system tape modes are properly setup (see below), then possibly modify
- you Device resource depending on the output from the btape program (next
- item). When doing this, you should consult the \ilink{Storage Daemon
- Configuration}{StoredConfChapter} of this manual.
-
-\item If you are using a Fibre Channel to connect your tape drive to
- Bacula, please be sure to disable any caching in the NSR (network
- storage router, which is a Fibre Channel to SCSI converter).
-
-\item Run the btape {\bf test} command:
-
- \footnotesize
-\begin{verbatim}
- ./btape -c bacula-sd.conf /dev/nst0
- test
-
-\end{verbatim}
-\normalsize
-
- It isn't necessary to run the autochanger part of the test at this time,
- but do not go past this point until the basic test succeeds. If you do
- have an autochanger, please be sure to read the \ilink{Autochanger
- chapter}{AutochangersChapter} of this manual.
-
-\item Run the btape {\bf fill} command, preferably with two volumes. This
- can take a long time. If you have an autochanger and it is configured, Bacula
- will automatically use it. If you do not have it configured, you can manually
- issue the appropriate {\bf mtx} command, or press the autochanger buttons to
- change the tape when requested to do so.
-
-\item FreeBSD users, if you have a pre-5.0 system run the {\bf tapetest}
- program, and make sure your system is patched if necessary. The tapetest
- program can be found in the platform/freebsd directory. The instructions
- for its use are at the top of the file.
-
-\item Run Bacula, and backup a reasonably small directory, say 60
- Megabytes. Do three successive backups of this directory.
-
-\item Stop Bacula, then restart it. Do another full backup of the same
- directory. Then stop and restart Bacula.
-
-\item Do a restore of the directory backed up, by entering the following
- restore command, being careful to restore it to an alternate location:
-
-
-\footnotesize
-\begin{verbatim}
- restore select all done
- yes
-
-\end{verbatim}
-\normalsize
-
- Do a {\bf diff} on the restored directory to ensure it is identical to the
- original directory. If you are going to backup multiple different systems
- (Linux, Windows, Mac, Solaris, FreeBSD, ...), be sure you test the restore
- on each system type.
-
-\item If you have an autochanger, you should now go back to the btape program
- and run the autochanger test:
-
-\footnotesize
-\begin{verbatim}
- ./btape -c bacula-sd.conf /dev/nst0
- auto
-
-\end{verbatim}
-\normalsize
-
- Adjust your autochanger as necessary to ensure that it works correctly. See
- the Autochanger chapter of this manual for a complete discussion of testing
- your autochanger.
-
-\item We strongly recommend that you use a dedicated SCSI
- controller for your tape drives. Scanners are known to induce
- serious problems with the SCSI bus, causing it to reset. If the
- SCSI bus is reset while Bacula has the tape drive open, it will
- most likely be fatal to your tape since the drive will rewind.
- These kinds of problems show up in the system log. For example,
- the following was most likely caused by a scanner:
-
-\footnotesize
-\begin{verbatim}
-Feb 14 17:29:55 epohost kernel: (scsi0:A:2:0): No or incomplete CDB sent to device.
-Feb 14 17:29:55 epohost kernel: scsi0: Issued Channel A Bus Reset. 1 SCBs aborted
-\end{verbatim}
-\normalsize
-
-\end{enumerate}
-
-If you have reached this point, you stand a good chance of having everything
-work. If you get into trouble at any point, {\bf carefully} read the
-documentation given below. If you cannot get past some point, ask the {\bf
-bacula-users} email list, but specify which of the steps you have successfully
-completed. In particular, you may want to look at the
-\ilink{ Tips for Resolving Problems}{problems1} section below.
-
-
-\label{NoTapeInDrive}
-\subsection{Problems When no Tape in Drive}
-\index[general]{Problems When no Tape in Drive}
-When Bacula was first written the Linux 2.4 kernel permitted opening the
-drive whether or not there was a tape in the drive. Thus the Bacula code is
-based on the concept that if the drive cannot be opened, there is a serious
-problem, and the job is failed.
-
-With version 2.6 of the Linux kernel, if there is no tape in the drive, the
-OS will wait two minutes (default) and then return a failure, and consequently,
-Bacula version 1.36 and below will fail the job. This is important to keep
-in mind, because if you use an option such as {\bf Offline on Unmount =
-yes}, there will be a point when there is no tape in the drive, and if
-another job starts or if Bacula asks the operator to mount a tape, when
-Bacula attempts to open the drive (about a 20 minute delay), it will fail
-and Bacula will fail the job.
-
-In version 1.38.x, the Bacula code partially gets around this problem -- at
-least in the initial open of the drive. However, functions like Polling
-the drive do not work correctly if there is no tape in the drive.
-Providing you do not use {\bf Offline on Unmount = yes}, you should not
-experience job failures as mentioned above. If you do experience such
-failures, you can also increase the {\bf Maximum Open Wait} time interval,
-which will give you more time to mount the next tape before the job is
-failed.
-
-\subsection{Specifying the Configuration File}
-\index[general]{File!Specifying the Configuration}
-\index[general]{Specifying the Configuration File}
-
-Starting with version 1.27, each of the tape utility programs including the
-{\bf btape} program requires a valid Storage daemon configuration file
-(actually, the only part of the configuration file that {\bf btape} needs is
-the {\bf Device} resource definitions). This permits {\bf btape} to find the
-configuration parameters for your archive device (generally a tape drive).
-Without those parameters, the testing and utility programs do not know how to
-properly read and write your drive. By default, they use {\bf bacula-sd.conf}
-in the current directory, but you may specify a different configuration file
-using the {\bf -c} option.
-
-\subsection{Specifying a Device Name For a Tape}
-\index[general]{Tape!Specifying a Device Name For a}
-\index[general]{Specifying a Device Name For a Tape}
-
-{\bf btape} {\bf device-name} where the Volume can be found. In the case of a
-tape, this is the physical device name such as {\bf /dev/nst0} or {\bf
-/dev/rmt/0ubn} depending on your system that you specify on the Archive Device
-directive. For the program to work, it must find the identical name in the
-Device resource of the configuration file. If the name is not found in the
-list of physical names, the utility program will compare the name you entered
-to the Device names (rather than the Archive device names).
-
-When specifying a tape device, it is preferable that the "non-rewind"
-variant of the device file name be given. In addition, on systems such as
-Sun, which have multiple tape access methods, you must be sure to specify
-to use Berkeley I/O conventions with the device. The
-{\bf b} in the Solaris (Sun) archive specification {\bf /dev/rmt/0mbn} is
-what is needed in this case. Bacula does not support SysV tape drive
-behavior.
-
-See below for specifying Volume names.
-
-\subsection{Specifying a Device Name For a File}
-\index[general]{File!Specifying a Device Name For a}
-\index[general]{Specifying a Device Name For a File}
-
-If you are attempting to read or write an archive file rather than a tape, the
-{\bf device-name} should be the full path to the archive location including
-the filename. The filename (last part of the specification) will be stripped
-and used as the Volume name, and the path (first part before the filename)
-must have the same entry in the configuration file. So, the path is equivalent
-to the archive device name, and the filename is equivalent to the volume name.
-
-
-\section{btape}
-\label{btape1}
-\index[general]{Btape}
-
-This program permits a number of elementary tape operations via a tty command
-interface. The {\bf test} command, described below, can be very useful for
-testing tape drive compatibility problems. Aside from initial testing of tape
-drive compatibility with {\bf Bacula}, {\bf btape} will be mostly used by
-developers writing new tape drivers.
-
-{\bf btape} can be dangerous to use with existing {\bf Bacula} tapes because
-it will relabel a tape or write on the tape if so requested regardless of
-whether or not the tape contains valuable data, so please be careful and use
-it only on blank tapes.
-
-To work properly, {\bf btape} needs to read the Storage daemon's configuration
-file. As a default, it will look for {\bf bacula-sd.conf} in the current
-directory. If your configuration file is elsewhere, please use the {\bf -c}
-option to specify where.
-
-The physical device name or the Device resource name must be specified on the
-command line, and this same device name must be present in the Storage
-daemon's configuration file read by {\bf btape}
-
-\footnotesize
-\begin{verbatim}
-Usage: btape [options] device_name
- -b <file> specify bootstrap file
- -c <file> set configuration file to file
- -d <nn> set debug level to nn
- -p proceed inspite of I/O errors
- -s turn off signals
- -v be verbose
- -? print this message.
-\end{verbatim}
-\normalsize
-
-\subsection{Using btape to Verify your Tape Drive}
-\index[general]{Using btape to Verify your Tape Drive}
-\index[general]{Drive!Using btape to Verify your Tape}
-
-An important reason for this program is to ensure that a Storage daemon
-configuration file is defined so that Bacula will correctly read and write
-tapes.
-
-It is highly recommended that you run the {\bf test} command before running
-your first Bacula job to ensure that the parameters you have defined for your
-storage device (tape drive) will permit {\bf Bacula} to function properly. You
-only need to mount a blank tape, enter the command, and the output should be
-reasonably self explanatory. For example:
-
-\footnotesize
-\begin{verbatim}
-(ensure that Bacula is not running)
-./btape -c /usr/bin/bacula/bacula-sd.conf /dev/nst0
-\end{verbatim}
-\normalsize
-
-The output will be:
-
-\footnotesize
-\begin{verbatim}
-Tape block granularity is 1024 bytes.
-btape: btape.c:376 Using device: /dev/nst0
-*
-\end{verbatim}
-\normalsize
-
-Enter the test command:
-
-\footnotesize
-\begin{verbatim}
-test
-\end{verbatim}
-\normalsize
-
-The output produced should be something similar to the following: I've cut the
-listing short because it is frequently updated to have new tests.
-
-\footnotesize
-\begin{verbatim}
-=== Append files test ===
-This test is essential to Bacula.
-I'm going to write one record in file 0,
- two records in file 1,
- and three records in file 2
-btape: btape.c:387 Rewound /dev/nst0
-btape: btape.c:855 Wrote one record of 64412 bytes.
-btape: btape.c:857 Wrote block to device.
-btape: btape.c:410 Wrote EOF to /dev/nst0
-btape: btape.c:855 Wrote one record of 64412 bytes.
-btape: btape.c:857 Wrote block to device.
-btape: btape.c:855 Wrote one record of 64412 bytes.
-btape: btape.c:857 Wrote block to device.
-btape: btape.c:410 Wrote EOF to /dev/nst0
-btape: btape.c:855 Wrote one record of 64412 bytes.
-btape: btape.c:857 Wrote block to device.
-btape: btape.c:855 Wrote one record of 64412 bytes.
-btape: btape.c:857 Wrote block to device.
-btape: btape.c:855 Wrote one record of 64412 bytes.
-btape: btape.c:857 Wrote block to device.
-btape: btape.c:410 Wrote EOF to /dev/nst0
-btape: btape.c:387 Rewound /dev/nst0
-btape: btape.c:693 Now moving to end of media.
-btape: btape.c:427 Moved to end of media
-We should be in file 3. I am at file 3. This is correct!
-Now the important part, I am going to attempt to append to the tape.
-...
-=== End Append files test ===
-\end{verbatim}
-\normalsize
-
-If you do not successfully complete the above test, please resolve the
-problem(s) before attempting to use {\bf Bacula}. Depending on your tape
-drive, the test may recommend that you add certain records to your
-configuration. We strongly recommend that you do so and then re-run the above
-test to insure it works the first time.
-
-Some of the suggestions it provides for resolving the problems may or may not
-be useful. If at all possible avoid using fixed blocking. If the test suddenly
-starts to print a long series of:
-
-\footnotesize
-\begin{verbatim}
-Got EOF on tape.
-Got EOF on tape.
-...
-\end{verbatim}
-\normalsize
-
-then almost certainly, you are running your drive in fixed block mode rather
-than variable block mode. See below for more help of resolving fix
-versus variable block problems.
-
-It is also possible that you have your drive
-set in SysV tape drive mode. The drive must use BSD tape conventions.
-See the section above on setting your {\bf Archive device} correctly.
-
-For FreeBSD users, please see the notes below for doing further testing of
-your tape drive.
-
-\label{SCSITricks}
-\subsection{Linux SCSI Tricks}
-\index[general]{Tricks!Linux SCSI}
-\index[general]{Linux SCSI Tricks}
-
-You can find out what SCSI devices you have by doing:
-
-\footnotesize
-\begin{verbatim}
-lsscsi
-\end{verbatim}
-\normalsize
-
-Typical output is:
-
-\footnotesize
-\begin{verbatim}
-[0:0:0:0] disk ATA ST3160812AS 3.AD /dev/sda
-[2:0:4:0] tape HP Ultrium 2-SCSI F6CH /dev/st0
-[2:0:5:0] tape HP Ultrium 2-SCSI F6CH /dev/st1
-[2:0:6:0] mediumx OVERLAND LXB 0107 -
-[2:0:9:0] tape HP Ultrium 1-SCSI E50H /dev/st2
-[2:0:10:0] mediumx OVERLAND LXB 0107 -
-\end{verbatim}
-\normalsize
-
-There are two drives in one autochanger: /dev/st0 and /dev/st1
-and a third tape drive at /dev/st2. For using them with Bacula, one
-would normally reference them as /dev/nst0 ... /dev/nst2. Not also,
-there are two different autochangers identified as "mediumx OVERLAND LXB".
-They can be addressed via their /dev/sgN designation, which can be
-obtained by counting from the beginning as 0 to each changer. In the
-above case, the two changers are located on /dev/sg3 and /dev/sg5. The one
-at /dev/sg3, controls drives /dev/nst0 and /dev/nst1; and the one at
-/dev/sg5 controles drive /dev/nst2.
-
-If you do not have the {\bf lsscsi} command, you can obtain the same
-information as follows:
-
-\footnotesize
-\begin{verbatim}
-cat /proc/scsi/scsi
-\end{verbatim}
-\normalsize
-
-For the above example with the three drives and two autochangers,
-I get:
-
-\footnotesize
-\begin{verbatim}
-Attached devices:
-Host: scsi0 Channel: 00 Id: 00 Lun: 00
- Vendor: ATA Model: ST3160812AS Rev: 3.AD
- Type: Direct-Access ANSI SCSI revision: 05
-Host: scsi2 Channel: 00 Id: 04 Lun: 00
- Vendor: HP Model: Ultrium 2-SCSI Rev: F6CH
- Type: Sequential-Access ANSI SCSI revision: 03
-Host: scsi2 Channel: 00 Id: 05 Lun: 00
- Vendor: HP Model: Ultrium 2-SCSI Rev: F6CH
- Type: Sequential-Access ANSI SCSI revision: 03
-Host: scsi2 Channel: 00 Id: 06 Lun: 00
- Vendor: OVERLAND Model: LXB Rev: 0107
- Type: Medium Changer ANSI SCSI revision: 02
-Host: scsi2 Channel: 00 Id: 09 Lun: 00
- Vendor: HP Model: Ultrium 1-SCSI Rev: E50H
- Type: Sequential-Access ANSI SCSI revision: 03
-Host: scsi2 Channel: 00 Id: 10 Lun: 00
- Vendor: OVERLAND Model: LXB Rev: 0107
- Type: Medium Changer ANSI SCSI revision: 02
-\end{verbatim}
-\normalsize
-
-
-As an additional example, I get the following (on a different machine from the
-above example):
-
-\footnotesize
-\begin{verbatim}
-Attached devices:
-Host: scsi2 Channel: 00 Id: 01 Lun: 00
- Vendor: HP Model: C5713A Rev: H107
- Type: Sequential-Access ANSI SCSI revision: 02
-Host: scsi2 Channel: 00 Id: 04 Lun: 00
- Vendor: SONY Model: SDT-10000 Rev: 0110
- Type: Sequential-Access ANSI SCSI revision: 02
-\end{verbatim}
-\normalsize
-
-The above represents first an autochanger and second a simple
-tape drive. The HP changer (the first entry) uses the same SCSI channel
-for data and for control, so in Bacula, you would use:
-\footnotesize
-\begin{verbatim}
-Archive Device = /dev/nst0
-Changer Device = /dev/sg0
-\end{verbatim}
-\normalsize
-
-If you want to remove the SDT-10000 device, you can do so as root with:
-
-\footnotesize
-\begin{verbatim}
-echo "scsi remove-single-device 2 0 4 0">/proc/scsi/scsi
-\end{verbatim}
-\normalsize
-
-and you can put add it back with:
-
-\footnotesize
-\begin{verbatim}
-echo "scsi add-single-device 2 0 4 0">/proc/scsi/scsi
-\end{verbatim}
-\normalsize
-
-where the 2 0 4 0 are the Host, Channel, Id, and Lun as seen on the output
-from {\bf cat /proc/scsi/scsi}. Note, the Channel must be specified as
-numeric.
-
-Below is a slightly more complicated output, which is a single autochanger
-with two drives, and which operates the changer on a different channel
-from from the drives:
-
-\footnotesize
-\begin{verbatim}
-Attached devices:
-Host: scsi0 Channel: 00 Id: 00 Lun: 00
- Vendor: ATA Model: WDC WD1600JD-75H Rev: 08.0
- Type: Direct-Access ANSI SCSI revision: 05
-Host: scsi2 Channel: 00 Id: 04 Lun: 00
- Vendor: HP Model: Ultrium 2-SCSI Rev: F6CH
- Type: Sequential-Access ANSI SCSI revision: 03
-Host: scsi2 Channel: 00 Id: 05 Lun: 00
- Vendor: HP Model: Ultrium 2-SCSI Rev: F6CH
- Type: Sequential-Access ANSI SCSI revision: 03
-Host: scsi2 Channel: 00 Id: 06 Lun: 00
- Vendor: OVERLAND Model: LXB Rev: 0106
- Type: Medium Changer ANSI SCSI revision: 02
-\end{verbatim}
-\normalsize
-
-The above tape drives are accessed on /dev/nst0 and /dev/nst1, while
-the control channel for those two drives is /dev/sg3.
-
-
-
-\label{problems1}
-\section{Tips for Resolving Problems}
-\index[general]{Problems!Tips for Resolving}
-\index[general]{Tips for Resolving Problems}
-
-\label{CannotRestore}
-\subsection{Bacula Saves But Cannot Restore Files}
-\index[general]{Files!Bacula Saves But Cannot Restore}
-\index[general]{Bacula Saves But Cannot Restore Files}
-
-If you are getting error messages such as:
-
-\footnotesize
-\begin{verbatim}
-Volume data error at 0:1! Wanted block-id: "BB02", got "". Buffer discarded
-\end{verbatim}
-\normalsize
-
-It is very likely that Bacula has tried to do block positioning and ended up
-at an invalid block. This can happen if your tape drive is in fixed block mode
-while Bacula's default is variable blocks. Note that in such cases, Bacula is
-perfectly able to write to your Volumes (tapes), but cannot position to read
-them.
-
-There are two possible solutions.
-
-\begin{enumerate}
-\item The first and best is to always ensure that your drive is in variable
- block mode. Note, it can switch back to fixed block mode on a reboot or if
- another program uses the drive. So on such systems you need to modify the
- Bacula startup files to explicitly set:
-
-\footnotesize
-\begin{verbatim}
-mt -f /dev/nst0 defblksize 0
-\end{verbatim}
-\normalsize
-
-or whatever is appropriate on your system. Note, if you are running a Linux
-system, and the above command does not work, it is most likely because you
-have not loaded the appropriate {\bf mt} package, which is often called
-{\bf mt\_st}, but may differ according to your distribution.
-
-\item The second possibility, especially, if Bacula wrote while the drive was
- in fixed block mode, is to turn off block positioning in Bacula. This is done
- by adding:
-
-\footnotesize
-\begin{verbatim}
-Block Positioning = no
-\end{verbatim}
-\normalsize
-
-to the Device resource. This is not the recommended procedure because it can
-enormously slow down recovery of files, but it may help where all else
-fails. This directive is available in version 1.35.5 or later (and not yet
-tested).
-\end{enumerate}
-
-If you are getting error messages such as:
-\footnotesize
-\begin{verbatim}
-Volume data error at 0:0!
-Block checksum mismatch in block=0 len=32625 calc=345678 blk=123456
-\end{verbatim}
-\normalsize
-
-You are getting tape read errors, and this is most likely due to
-one of the following things:
-\begin{enumerate}
-\item An old or bad tape.
-\item A dirty drive that needs cleaning (particularly for DDS drives).
-\item A loose SCSI cable.
-\item Old firmware in your drive. Make sure you have the latest firmware
- loaded.
-\item Computer memory errors.
-\item Over-clocking your CPU.
-\item A bad SCSI card.
-\end{enumerate}
-
-
-\label{opendevice}
-\subsection{Bacula Cannot Open the Device}
-\index[general]{Device!Bacula Cannot Open the}
-\index[general]{Bacula Cannot Open the Device}
-
-If you get an error message such as:
-
-\footnotesize
-\begin{verbatim}
-dev open failed: dev.c:265 stored: unable to open
-device /dev/nst0:> ERR=No such device or address
-\end{verbatim}
-\normalsize
-
-the first time you run a job, it is most likely due to the fact that you
-specified the incorrect device name on your {\bf Archive Device}.
-
-If Bacula works fine with your drive, then all off a sudden you get error
-messages similar to the one shown above, it is quite possible that your driver
-module is being removed because the kernel deems it idle. This is done via
-{\bf crontab} with the use of {\bf rmmod -a}. To fix the problem, you can
-remove this entry from {\bf crontab}, or you can manually {\bf modprob} your
-driver module (or add it to the local startup script). Thanks to Alan Brown
-for this tip.
-\label{IncorrectFiles}
-
-\subsection{Incorrect File Number}
-\index[general]{Number!Incorrect File}
-\index[general]{Incorrect File Number}
-
-When Bacula moves to the end of the medium, it normally uses the {\bf
-ioctl(MTEOM)} function. Then Bacula uses the {\bf ioctl(MTIOCGET)} function to
-retrieve the current file position from the {\bf mt\_fileno} field. Some SCSI
-tape drivers will use a fast means of seeking to the end of the medium and in
-doing so, they will not know the current file position and hence return a {\bf
--1}. As a consequence, if you get {\bf "This is NOT correct!"} in the
-positioning tests, this may be the cause. You must correct this condition in
-order for Bacula to work.
-
-There are two possible solutions to the above problem of incorrect file
-number:
-
-\begin{itemize}
-\item Figure out how to configure your SCSI driver to keep track of the file
- position during the MTEOM request. This is the preferred solution.
-\item Modify the {\bf Device} resource of your {\bf bacula-sd.conf} file to
- include:
-
-\footnotesize
-\begin{verbatim}
-Hardware End of File = no
-\end{verbatim}
-\normalsize
-
-This will cause Bacula to use the MTFSF request to seek to the end of the
-medium, and Bacula will keep track of the file number itself.
-\end{itemize}
-
-\label{IncorrectBlocks}
-\subsection{Incorrect Number of Blocks or Positioning Errors}
-\index[general]{Testing!Incorrect Number of Blocks or Positioning Errors}
-\index[general]{Incorrect Number of Blocks or Positioning Errors}
-
-{\bf Bacula's} preferred method of working with tape drives (sequential
-devices) is to run in variable block mode, and this is what is set by default.
-You should first ensure that your tape drive is set for variable block mode
-(see below).
-
-If your tape drive is in fixed block mode and you have told Bacula to use
-different fixed block sizes or variable block sizes (default), you will get
-errors when Bacula attempts to forward space to the correct block (the kernel
-driver's idea of tape blocks will not correspond to Bacula's).
-
-All modern tape drives support variable tape blocks, but some older drives (in
-particular the QIC drives) as well as the ATAPI ide-scsi driver run only in
-fixed block mode. The Travan tape drives also apparently must run in fixed
-block mode (to be confirmed).
-
-Even in variable block mode, with the exception of the first record on the
-second or subsequent volume of a multi-volume backup, Bacula will write blocks
-of a fixed size. However, in reading a tape, Bacula will assume that for each
-read request, exactly one block from the tape will be transferred. This the
-most common way that tape drives work and is well supported by {\bf Bacula}.
-
-Drives that run in fixed block mode can cause serious problems for Bacula if
-the drive's block size does not correspond exactly to {\bf Bacula's} block
-size. In fixed block size mode, drivers may transmit a partial block or
-multiple blocks for a single read request. From {\bf Bacula's} point of view,
-this destroys the concept of tape blocks. It is much better to run in variable
-block mode, and almost all modern drives (the OnStream is an exception) run in
-variable block mode. In order for Bacula to run in fixed block mode, you must
-include the following records in the Storage daemon's Device resource
-definition:
-
-\footnotesize
-\begin{verbatim}
-Minimum Block Size = nnn
-Maximum Block Size = nnn
-\end{verbatim}
-\normalsize
-
-where {\bf nnn} must be the same for both records and must be identical to the
-driver's fixed block size.
-
-We recommend that you avoid this configuration if at all possible by using
-variable block sizes.
-
-If you must run with fixed size blocks, make sure they are not 512 bytes. This
-is too small and the overhead that Bacula has with each record will become
-excessive. If at all possible set any fixed block size to something like
-64,512 bytes or possibly 32,768 if 64,512 is too large for your drive. See
-below for the details on checking and setting the default drive block size.
-
-To recover files from tapes written in fixed block mode, see below.
-
-\label{TapeModes}
-\subsection{Ensuring that the Tape Modes Are Properly Set -- {\bf Linux
-Only}}
-\index[general]{Ensuring that the Tape Modes Are Properly Set -- Linux Only}
-
-If you have a modern SCSI tape drive and you are having problems with the {\bf
-test} command as noted above, it may be that some program has set one or more
-of your SCSI driver's options to non-default values. For example, if your
-driver is set to work in SysV manner, Bacula will not work correctly because
-it expects BSD behavior. To reset your tape drive to the default values, you
-can try the following, but {\bf ONLY} if you have a SCSI tape drive on a {\bf
-Linux} system:
-
-\footnotesize
-\begin{verbatim}
-become super user
-mt -f /dev/nst0 rewind
-mt -f /dev/nst0 stoptions buffer-writes async-writes read-ahead
-\end{verbatim}
-\normalsize
-
-The above commands will clear all options and then set those specified. None
-of the specified options are required by Bacula, but a number of other options
-such as SysV behavior must not be set. Bacula does not support SysV tape
-behavior. On systems other than Linux, you will need to consult your {\bf mt}
-man pages or documentation to figure out how to do the same thing. This should
-not really be necessary though -- for example, on both Linux and Solaris
-systems, the default tape driver options are compatible with Bacula.
-On Solaris systems, you must take care to specify the correct device
-name on the {\bf Archive device} directive. See above for more details.
-
-You may also want to ensure that no prior program has set the default block
-size, as happened to one user, by explicitly turning it off with:
-
-\footnotesize
-\begin{verbatim}
-mt -f /dev/nst0 defblksize 0
-\end{verbatim}
-\normalsize
-
-If you are running a Linux
-system, and the above command does not work, it is most likely because you
-have not loaded the appropriate {\bf mt} package, which is often called
-{\bf mt\_st}, but may differ according to your distribution.
-
-If you would like to know what options you have set before making any of the
-changes noted above, you can now view them on Linux systems, thanks to a tip
-provided by Willem Riede. Do the following:
-
-\footnotesize
-\begin{verbatim}
-become super user
-mt -f /dev/nst0 stsetoptions 0
-grep st0 /var/log/messages
-\end{verbatim}
-\normalsize
-
-and you will get output that looks something like the following:
-
-\footnotesize
-\begin{verbatim}
-kernel: st0: Mode 0 options: buffer writes: 1, async writes: 1, read ahead: 1
-kernel: st0: can bsr: 0, two FMs: 0, fast mteom: 0, auto lock: 0,
-kernel: st0: defs for wr: 0, no block limits: 0, partitions: 0, s2 log: 0
-kernel: st0: sysv: 0 nowait: 0
-\end{verbatim}
-\normalsize
-
-Note, I have chopped off the beginning of the line with the date and machine
-name for presentation purposes.
-
-Some people find that the above settings only last until the next reboot, so
-please check this otherwise you may have unexpected problems.
-
-Beginning with Bacula version 1.35.8, if Bacula detects that you are running
-in variable block mode, it will attempt to set your drive appropriately. All
-OSes permit setting variable block mode, but some OSes do not permit setting
-the other modes that Bacula needs to function properly.
-
-\label{compression}
-\subsection{Tape Hardware Compression and Blocking Size}
-\index[general]{Tape Hardware Compression and Blocking Size}
-\index[general]{Size!Tape Hardware Compression and Blocking Size}
-
-As far as I can tell, there is no way with the {\bf mt} program to check if
-your tape hardware compression is turned on or off. You can, however, turn it
-on by using (on Linux):
-
-\footnotesize
-\begin{verbatim}
-become super user
-mt -f /dev/nst0 defcompression 1
-\end{verbatim}
-\normalsize
-
-and of course, if you use a zero instead of the one at the end, you will turn
-it off.
-
-If you have built the {\bf mtx} program in the {\bf depkgs} package, you can
-use tapeinfo to get quite a bit of information about your tape drive even if
-it is not an autochanger. This program is called using the SCSI control
-device. On Linux for tape drive /dev/nst0, this is usually /dev/sg0, while on
-FreeBSD for /dev/nsa0, the control device is often /dev/pass2. For example on
-my DDS-4 drive (/dev/nst0), I get the following:
-
-\footnotesize
-\begin{verbatim}
-tapeinfo -f /dev/sg0
-Product Type: Tape Drive
-Vendor ID: 'HP '
-Product ID: 'C5713A '
-Revision: 'H107'
-Attached Changer: No
-MinBlock:1
-MaxBlock:16777215
-SCSI ID: 5
-SCSI LUN: 0
-Ready: yes
-BufferedMode: yes
-Medium Type: Not Loaded
-Density Code: 0x26
-BlockSize: 0
-\end{verbatim}
-\normalsize
-
-where the {\bf DataCompEnabled: yes} means that tape hardware compression is
-turned on. You can turn it on and off (yes|no) by using the {\bf mt}
-commands given above. Also, this output will tell you if the {\bf BlockSize}
-is non-zero and hence set for a particular block size. Bacula is not likely to
-work in such a situation because it will normally attempt to write blocks of
-64,512 bytes, except the last block of the job which will generally be
-shorter. The first thing to try is setting the default block size to zero
-using the {\bf mt -f /dev/nst0 defblksize 0} command as shown above.
-On FreeBSD, this would be something like: {\bf mt -f /dev/nsa0 blocksize 0}.
-
-On some operating systems with some tape drives, the amount of data that
-can be written to the tape and whether or not compression is enabled is
-determined by the density usually the {\bf mt -f /dev/nst0 setdensity xxx} command.
-Often {\bf mt -f /dev/nst0 status} will print out the current
-density code that is used with the drive. Most systems, but unfortunately
-not all, set the density to the maximum by default. On some systems, you
-can also get a list of all available density codes with:
-{\bf mt -f /dev/nst0 densities} or a similar {\bf mt} command.
-Note, for DLT and SDLT devices, no-compression versus compression is very
-often controlled by the density code. On FreeBSD systems, the compression
-mode is set using {\bf mt -f /dev/nsa0 comp xxx} where xxx is the
-mode you want. In general, see {\bf man mt} for the options available on
-your system.
-
-Note, some of the above {\bf mt} commands may not be persistent depending
-on your system configuration. That is they may be reset if a program
-other than Bacula uses the drive or, as is frequently the case, on reboot
-of your system.
-
-If your tape drive requires fixed block sizes (very unusual), you can use the
-following records:
-
-\footnotesize
-\begin{verbatim}
-Minimum Block Size = nnn
-Maximum Block Size = nnn
-\end{verbatim}
-\normalsize
-
-in your Storage daemon's Device resource to force Bacula to write fixed size
-blocks (where you sent nnn to be the same for both of the above records). This
-should be done only if your drive does not support variable block sizes, or
-you have some other strong reasons for using fixed block sizes. As mentioned
-above, a small fixed block size of 512 or 1024 bytes will be very inefficient.
-Try to set any fixed block size to something like 64,512 bytes or larger if
-your drive will support it.
-
-Also, note that the {\bf Medium Type} field of the output of {\bf tapeinfo}
-reports {\bf Not Loaded}, which is not correct. As a consequence, you should
-ignore that field as well as the {\bf Attached Changer} field.
-
-To recover files from tapes written in fixed block mode, see below.
-\label{FreeBSDTapes}
-
-\subsection{Tape Modes on FreeBSD}
-\index[general]{FreeBSD!Tape Modes on}
-\index[general]{Tape Modes on FreeBSD}
-
-On most FreeBSD systems such as 4.9 and most tape drives, Bacula should run
-with:
-
-\footnotesize
-\begin{verbatim}
-mt -f /dev/nsa0 seteotmodel 2
-mt -f /dev/nsa0 blocksize 0
-mt -f /dev/nsa0 comp enable
-\end{verbatim}
-\normalsize
-
-You might want to put those commands in a startup script to make sure your
-tape driver is properly initialized before running Bacula, because
-depending on your system configuration, these modes may be reset if a
-program other than Bacula uses the drive or when your system is rebooted.
-
-Then according to what the {\bf btape test} command returns, you will probably
-need to set the following (see below for an alternative):
-
-\footnotesize
-\begin{verbatim}
- Hardware End of Medium = no
- BSF at EOM = yes
- Backward Space Record = no
- Backward Space File = no
- Fast Forward Space File = no
- TWO EOF = yes
-\end{verbatim}
-\normalsize
-
-Then be sure to run some append tests with Bacula where you start and stop
-Bacula between appending to the tape, or use {\bf btape} version 1.35.1 or
-greater, which includes simulation of stopping/restarting Bacula.
-
-Please see the file {\bf platforms/freebsd/pthreads-fix.txt} in the main
-Bacula directory concerning {\bf important} information concerning
-compatibility of Bacula and your system. A much more optimal Device
-configuration is shown below, but does not work with all tape drives. Please
-test carefully before putting either into production.
-
-Note, for FreeBSD 4.10-RELEASE, using a Sony TSL11000 L100 DDS4 with an
-autochanger set to variable block size and DCLZ compression, Brian McDonald
-reports that to get Bacula to append correctly between Bacula executions,
-the correct values to use are:
-
-\footnotesize
-\begin{verbatim}
-mt -f /dev/nsa0 seteotmodel 1
-mt -f /dev/nsa0 blocksize 0
-mt -f /dev/nsa0 comp enable
-\end{verbatim}
-\normalsize
-
-and
-
-\footnotesize
-\begin{verbatim}
- Hardware End of Medium = no
- BSF at EOM = no
- Backward Space Record = no
- Backward Space File = no
- Fast Forward Space File = yes
- TWO EOF = no
-\end{verbatim}
-\normalsize
-
-This has been confirmed by several other people using different hardware. This
-configuration is the preferred one because it uses one EOF and no backspacing
-at the end of the tape, which works much more efficiently and reliably with
-modern tape drives.
-
-Finally, here is a Device configuration that Danny Butroyd reports to work
-correctly with the Overland Powerloader tape library using LT0-2 and
-FreeBSD 5.4-Stable:
-
-\footnotesize
-\begin{verbatim}
-# Overland Powerloader LT02 - 17 slots single drive
-Device {
- Name = Powerloader
- Media Type = LT0-2
- Archive Device = /dev/nsa0
- AutomaticMount = yes;
- AlwaysOpen = yes;
- RemovableMedia = yes;
- RandomAccess = no;
- Changer Command = "/usr/local/sbin/mtx-changer %c %o %S %a %d"
- Changer Device = /dev/pass2
- AutoChanger = yes
- Alert Command = "sh -c 'tapeinfo -f %c |grep TapeAlert|cat'"
-
- # FreeBSD Specific Settings
- Offline On Unmount = no
- Hardware End of Medium = no
- BSF at EOM = yes
- Backward Space Record = no
- Fast Forward Space File = no
- TWO EOF = yes
-}
-
-The following Device resource works fine with Dell PowerVault 110T and
-120T devices on both FreeBSD 5.3 and on NetBSD 3.0. It also works
-with Sony AIT-2 drives on FreeBSD.
-\footnotesize
-\begin{verbatim}
-Device {
- ...
- # FreeBSD/NetBSD Specific Settings
- Hardware End of Medium = no
- BSF at EOM = yes
- Backward Space Record = no
- Fast Forward Space File = yes
- TWO EOF = yes
-}
-\end{verbatim}
-\normalsize
-
-On FreeBSD version 6.0, it is reported that you can even set
-Backward Space Record = yes.
-
-
-
-\subsection{Finding your Tape Drives and Autochangers on FreeBSD}
-\index[general]{FreeBSD!Finding Tape Drives and Autochangers}
-\index[general]{Finding Tape Drives and Autochangers on FreeBSD}
-
-On FreeBSD, you can do a {\bf camcontrol devlist} as root to determine what
-drives and autochangers you have. For example,
-
-\footnotesize
-\begin{verbatim}
-undef# camcontrol devlist
- at scbus0 target 2 lun 0 (pass0,sa0)
- at scbus0 target 4 lun 0 (pass1,sa1)
- at scbus0 target 4 lun 1 (pass2)
-\end{verbatim}
-\normalsize
-
-from the above, you can determine that there is a tape drive on {\bf /dev/sa0}
-and another on {\bf /dev/sa1} in addition since there is a second line for the
-drive on {\bf /dev/sa1}, you know can assume that it is the control device for
-the autochanger (i.e. {\bf /dev/pass2}). It is also the control device name to
-use when invoking the tapeinfo program. E.g.
-
-\footnotesize
-\begin{verbatim}
-tapeinfo -f /dev/pass2
-\end{verbatim}
-\normalsize
-
-\label{onstream}
-
-\subsection{Using the OnStream driver on Linux Systems}
-\index[general]{Using the OnStream driver on Linux Systems}
-\index[general]{Systems!Using the OnStream driver on Linux}
-
-Bacula version 1.33 (not 1.32x) is now working and ready for testing with the
-OnStream kernel osst driver version 0.9.14 or above. Osst is available from:
-\elink{http://sourceforge.net/projects/osst/}
-{http://sourceforge.net/projects/osst/}.
-
-To make Bacula work you must first load the new driver then, as root, do:
-
-\footnotesize
-\begin{verbatim}
- mt -f /dev/nosst0 defblksize 32768
-\end{verbatim}
-\normalsize
-
-Also you must add the following to your Device resource in your Storage
-daemon's conf file:
-
-\footnotesize
-\begin{verbatim}
- Minimum Block Size = 32768
- Maximum Block Size = 32768
-\end{verbatim}
-\normalsize
-
-Here is a Device specification provided by Michel Meyers that is known to
-work:
-
-\footnotesize
-\begin{verbatim}
-Device {
- Name = "Onstream DI-30"
- Media Type = "ADR-30"
- Archive Device = /dev/nosst0
- Minimum Block Size = 32768
- Maximum Block Size = 32768
- Hardware End of Medium = yes
- BSF at EOM = no
- Backward Space File = yes
- Fast Forward Space File = yes
- Two EOF = no
- AutomaticMount = yes
- AlwaysOpen = yes
- Removable Media = yes
-}
-\end{verbatim}
-\normalsize
-
-\section{Hardware Compression on EXB-8900}
-\index[general]{Hardware Compression on EXB-8900}
-\index[general]{EXB-8900!Hardware Compression}
-
-To active, check, or disable the hardware compression feature
-on an EXB-8900, use the exabyte MammothTool. You can get it here:
-\elink{http://www.exabyte.com/support/online/downloads/index.cfm}
-{http://www.exabyte.com/support/online/downloads/index.cfm}.
-There is a Solaris version of this tool. With option -C 0 or 1 you
-can disable or activate compression. Start this tool without any
-options for a small reference.
-
-\label{fill}
-\subsection{Using btape to Simulate Filling a Tape}
-\index[general]{Using btape to Simulate Filling a Tape}
-\index[general]{Tape!Using btape to Simulate Filling}
-
-Because there are often problems with certain tape drives or systems when end
-of tape conditions occur, {\bf btape} has a special command {\bf fill} that
-causes it to write random data to a tape until the tape fills. It then writes
-at least one more Bacula block to a second tape. Finally, it reads back both
-tapes to ensure that the data has been written in a way that Bacula can
-recover it. Note, there is also a single tape option as noted below, which you
-should use rather than the two tape test. See below for more details.
-
-This can be an extremely time consuming process (here it is about 6 hours) to
-fill a full tape. Note, that btape writes random data to the tape when it is
-filling it. This has two consequences: 1. it takes a bit longer to generate
-the data, especially on slow CPUs. 2. the total amount of data is
-approximately the real physical capacity of your tape, regardless of whether
-or not the tape drive compression is on or off. This is because random data
-does not compress very much.
-
-To begin this test, you enter the {\bf fill} command and follow the
-instructions. There are two options: the simple single tape option and the
-multiple tape option. Please use only the simple single tape option because
-the multiple tape option still doesn't work totally correctly. If the single
-tape option does not succeed, you should correct the problem before using
-Bacula.
-\label{RecoveringFiles}
-
-\section{Recovering Files Written With Fixed Block Sizes}
-\index[general]{Recovering Files Written With Fixed Block Sizes}
-
-If you have been previously running your tape drive in fixed block mode
-(default 512) and Bacula with variable blocks (default), then in version
-1.32f-x and 1.34 and above, Bacula will fail to recover files because it does
-block spacing, and because the block sizes don't agree between your tape drive
-and Bacula it will not work.
-
-The long term solution is to run your drive in variable block mode as
-described above. However, if you have written tapes using fixed block sizes,
-this can be a bit of a pain. The solution to the problem is: while you are
-doing a restore command using a tape written in fixed block size, ensure that
-your drive is set to the fixed block size used while the tape was written.
-Then when doing the {\bf restore} command in the Console program, do not
-answer the prompt {\bf yes/mod/no}. Instead, edit the bootstrap file (the
-location is listed in the prompt) using any ASCII editor. Remove all {\bf
-VolBlock} lines in the file. When the file is re-written, answer the question,
-and Bacula will run without using block positioning, and it should recover
-your files.
-
-\label{BlockModes}
-\section{Tape Blocking Modes}
-\index[general]{Modes!Tape Blocking}
-\index[general]{Tape Blocking Modes}
-
-SCSI tapes may either be written in {\bf variable} or {\bf fixed} block sizes.
-Newer drives support both modes, but some drives such as the QIC devices
-always use fixed block sizes. Bacula attempts to fill and write complete
-blocks (default 65K), so that in normal mode (variable block size), Bacula
-will always write blocks of the same size except the last block of a Job. If
-Bacula is configured to write fixed block sizes, it will pad the last block of
-the Job to the correct size. Bacula expects variable tape block size drives to
-behave as follows: Each write to the drive results in a single record being
-written to the tape. Each read returns a single record. If you request less
-bytes than are in the record, only those number of bytes will be returned, but
-the entire logical record will have been read (the next read will retrieve the
-next record). Thus data from a single write is always returned in a single
-read, and sequentially written records are returned by sequential reads.
-
-Bacula expects fixed block size tape drives to behave as follows: If a write
-length is greater than the physical block size of the drive, the write will be
-written as two blocks each of the fixed physical size. This single write may
-become multiple physical records on the tape. (This is not a good situation).
-According to the documentation, one may never write an amount of data that is
-not the exact multiple of the blocksize (it is not specified if an error
-occurs or if the the last record is padded). When reading, it is my
-understanding that each read request reads one physical record from the tape.
-Due to the complications of fixed block size tape drives, you should avoid
-them if possible with Bacula, or you must be ABSOLUTELY certain that you use
-fixed block sizes within Bacula that correspond to the physical block size of
-the tape drive. This will ensure that Bacula has a one to one correspondence
-between what it writes and the physical record on the tape.
-
-Please note that Bacula will not function correctly if it writes a block and
-that block is split into two or more physical records on the tape. Bacula
-assumes that each write causes a single record to be written, and that it can
-sequentially recover each of the blocks it has written by using the same
-number of sequential reads as it had written.
-
-\section{Details of Tape Modes}
-\index[general]{Modes!Details}
-\index[general]{Details of Tape Modes}
-Rudolf Cejka has provided the following information concerning
-certain tape modes and MTEOM.
-
-\begin{description}
-\item[Tape level]
- It is always possible to position filemarks or blocks, whereas
- positioning to the end-of-data is only optional feature, however it is
- implemented very often. SCSI specification also talks about optional
- sequential filemarks, setmarks and sequential setmarks, but these are not
- implemented so often. Modern tape drives keep track of file positions in
- built-in chip (AIT, LTO) or at the beginning of the tape (SDLT), so there
- is not any speed difference, if end-of-data or filemarks is used (I have
- heard, that LTO-1 from all 3 manufacturers do not use its chip for file
- locations, but a tape as in SDLT case, and I'm not sure about LTO-2 and
- LTO-3 case). However there is a big difference, that end-of-data ignores
- file position, whereas filemarks returns the real number of skipped
- files, so OS can track current file number just in filemarks case.
-
-\item[OS level]
- Solaris does use just SCSI SPACE Filemarks, it does not support SCSI
- SPACE End-of-data. When MTEOM is called, Solaris does use SCSI SPACE
- Filemarks with count = 1048576 for fast mode, and combination of SCSI
- SPACE Filemarks with count = 1 with SCSI SPACE Blocks with count = 1 for
- slow mode, so EOD mark on the tape on some older tape drives is not
- skipped. File number is always tracked for MTEOM.
-
- Linux does support both SCSI SPACE Filemarks and End-of-data: When MTEOM
- is called in MT\_ST\_FAST\_MTEOM mode, SCSI SPACE End-of-data is used.
- In the other case, SCSI SPACE Filemarks with count =
- 8388607 is used.
- There is no real slow mode like in Solaris - I just expect, that for
- older tape drives Filemarks may be slower than End-of-data, but not so
- much as in Solaris slow mode. File number is tracked for MTEOM just
- without MT\_ST\_FAST\_MTEOM - when MT\_ST\_FAST\_MTEOM is used, it is not.
-
- FreeBSD does support both SCSI SPACE Filemarks and End-of-data, but when
- MTEOD (MTEOM) is called, SCSI SPACE End-of-data is always used. FreeBSD
- never use SCSI SPACE Filemarks for MTEOD. File number is never tracked
- for MTEOD.
-
-\item[Bacula level]
- When {\bf Hardware End of Medium = Yes} is used, MTEOM is called, but it
- does not mean, that hardware End-of-data must be used. When Hardware End
- of Medium = No, if Fast Forward Space File = Yes, MTFSF with count =
- 32767 is used, else Block Read with count = 1 with Forward Space File
- with count = 1 is used, which is really very slow.
-
-\item [Hardware End of Medium = Yes|No]
- The name of this option is misleading and is the source of confusion,
- because it is not the hardware EOM, what is really switched here.
-
- If I use Yes, OS must not use SCSI SPACE End-of-data, because Bacula
- expects, that there is tracked file number, which is not supported by
- SCSI specification. Instead, the OS have to use SCSI SPACE Filemarks.
-
- If I use No, an action depends on Fast Forward Space File.
-
- When I set {\bf Hardware End of Medium = no}
- and {\bf Fast Forward Space File = no}
- file positioning was very slow
- on my LTO-3 (about ten to 100 minutes), but
-
- with {\bf Hardware End of Medium = no} and
-{\bf Fast Forward Space File = yes}, the time is ten to
-100 times faster (about one to two minutes).
-
-\end{description}
-
-\section{Autochanger Errors}
-\index[general]{Errors!Autochanger}
-\index[general]{Autochanger Errors}
-
-If you are getting errors such as:
-
-\footnotesize
-\begin{verbatim}
-3992 Bad autochanger "load slot 1, drive 1": ERR=Child exited with code 1.
-\end{verbatim}
-\normalsize
-
-and you are running your Storage daemon as non-root, then most likely
-you are having permissions problems with the control channel. Running
-as root, set permissions on /dev/sgX so that the userid and group of
-your Storage daemon can access the device. You need to ensure that you
-all access to the proper control device, and if you don't have any
-SCSI disk drives (including SATA drives), you might want to change
-the permissions on /dev/sg*.
-
-\section{Syslog Errors}
-\index[general]{Errors!Syslog}
-\index[general]{Syslog Errors}
-
-If you are getting errors such as:
-
-\footnotesize
-\begin{verbatim}
-: kernel: st0: MTSETDRVBUFFER only allowed for root
-\end{verbatim}
-\normalsize
-
-you are most likely running your Storage daemon as non-root, and
-Bacula is attempting to set the correct OS buffering to correspond
-to your Device resource. Most OSes allow only root to issue this
-ioctl command. In general, the message can be ignored providing
-you are sure that your OS parameters are properly configured as
-described earlier in this manual. If you are running your Storage daemon
-as root, you should not be getting these system log messages, and if
-you are, something is probably wrong.
+++ /dev/null
-%%
-%%
-
-\chapter{Tips and Suggestions}
-\label{TipsChapter}
-\index[general]{Tips and Suggestions }
-\index[general]{Suggestions!Tips and }
-\label{examples}
-\index[general]{Examples }
-
-There are a number of example scripts for various things that can be found in
-the {\bf example} subdirectory and its subdirectories of the Bacula source
-distribution.
-
-For additional tips, please see the \elink{Bacula
-wiki}{\url{http://wiki.bacula.org}}.
-
-\section{Upgrading Bacula Versions}
-\label{upgrading}
-\index[general]{Upgrading Bacula Versions }
-\index[general]{Versions!Upgrading Bacula }
-\index[general]{Upgrading}
-
-The first thing to do before upgrading from one version to another is to
-ensure that you don't overwrite or delete your production (current) version
-of Bacula until you have tested that the new version works.
-
-If you have installed Bacula into a single directory, this is simple: simply
-make a copy of your Bacula directory.
-
-If you have done a more typical Unix installation where the binaries are
-placed in one directory and the configuration files are placed in another,
-then the simplest way is to configure your new Bacula to go into a single
-file. Alternatively, make copies of all your binaries and especially your
-conf files.
-
-Whatever your situation may be (one of the two just described), you should
-probably start with the {\bf defaultconf} script that can be found in the {\bf
-examples} subdirectory. Copy this script to the main Bacula directory, modify
-it as necessary (there should not need to be many modifications), configure
-Bacula, build it, install it, then stop your production Bacula, copy all the
-{\bf *.conf} files from your production Bacula directory to the test Bacula
-directory, start the test version, and run a few test backups. If all seems
-good, then you can proceed to install the new Bacula in place of or possibly
-over the old Bacula.
-
-When installing a new Bacula you need not worry about losing the changes you
-made to your configuration files as the installation process will not
-overwrite them providing that you do not do a {\bf make uninstall}.
-
-If the new version of Bacula requires an upgrade to the database,
-you can upgrade it with the script {\bf update\_bacula\_tables}, which
-will be installed in your scripts directory (default {\bf /etc/bacula}),
-or alternatively, you can find it in the
-{\bf \lt{}bacula-source\gt{}/src/cats} directory.
-
-\section{Getting Notified of Job Completion}
-\label{notification}
-\index[general]{Getting Notified of Job Completion }
-\index[general]{Completion!Getting Notified of Job }
-
-One of the first things you should do is to ensure that you are being properly
-notified of the status of each Job run by Bacula, or at a minimum of each Job
-that terminates with an error.
-
-Until you are completely comfortable with {\bf Bacula}, we recommend that you
-send an email to yourself for each Job that is run. This is most easily
-accomplished by adding an email notification address in the {\bf Messages}
-resource of your Director's configuration file. An email is automatically
-configured in the default configuration files, but you must ensure that the
-default {\bf root} address is replaced by your email address.
-
-For additional examples of how to configure a Bacula, please take a look at the
-{\bf .conf} files found in the {\bf examples} sub-directory. We recommend the
-following configuration (where you change the paths and email address to
-correspond to your setup). Note, the {\bf mailcommand} and {\bf
-operatorcommand} should be on a single line. They were split here for
-presentation:
-
-\footnotesize
-\begin{verbatim}
-Messages {
- Name = Standard
- mailcommand = "/home/bacula/bin/bsmtp -h localhost
- -f \"\(Bacula\) %r\"
- -s \"Bacula: %t %e of %c %l\" %r"
- operatorcommand = "/home/bacula/bin/bsmtp -h localhost
- -f \"\(Bacula\) %r\"
- -s \"Bacula: Intervention needed for %j\" %r"
- Mail = your-email-address = all, !skipped, !terminate
- append = "/home/bacula/bin/log" = all, !skipped, !terminate
- operator = your-email-address = mount
- console = all, !skipped, !saved
-}
-\end{verbatim}
-\normalsize
-
-You will need to ensure that the {\bf /home/bacula/bin} path on the {\bf
-mailcommand} and the {\bf operatorcommand} lines point to your {\bf Bacula}
-binary directory where the {\bf bsmtp} program will be installed. You will
-also want to ensure that the {\bf your-email-address} is replaced by your
-email address, and finally, you will also need to ensure that the {\bf
-/home/bacula/bin/log} points to the file where you want to log all messages.
-
-With the above Messages resource, you will be notified by email of every Job
-that ran, all the output will be appended to the {\bf log} file you specify,
-all output will be directed to the console program, and all mount messages
-will be emailed to you. Note, some messages will be sent to multiple
-destinations.
-
-The form of the mailcommand is a bit complicated, but it allows you to
-distinguish whether the Job terminated in error or terminated normally. Please
-see the
-\ilink{Mail Command}{mailcommand} section of the Messages
-Resource chapter of this manual for the details of the substitution characters
-used above.
-
-Once you are totally comfortable with Bacula as I am, or if you have a large
-number of nightly Jobs as I do (eight), you will probably want to change the
-{\bf Mail} command to {\bf Mail On Error} which will generate an email message
-only if the Job terminates in error. If the Job terminates normally, no email
-message will be sent, but the output will still be appended to the log file as
-well as sent to the Console program.
-
-\section{Getting Email Notification to Work}
-\label{email}
-\index[general]{Work!Getting Email Notification to }
-\index[general]{Getting Email Notification to Work }
-
-The section above describes how to get email notification of job status.
-Occasionally, however, users have problems receiving any email at all. In that
-case, the things to check are the following:
-
-\begin{itemize}
-\item Ensure that you have a valid email address specified on your {\bf Mail}
- record in the Director's Messages resource. The email address should be fully
- qualified. Simply using {\bf root} generally will not work, rather you should
-use {\bf root@localhost} or better yet your full domain.
-\item Ensure that you do not have a {\bf Mail} record in the Storage daemon's
- or File daemon's configuration files. The only record you should have is {\bf
- director}:
-
-\footnotesize
-\begin{verbatim}
- director = director-name = all
-
-\end{verbatim}
-\normalsize
-
-\item If all else fails, try replacing the {\bf mailcommand} with
-
- \footnotesize
-\begin{verbatim}
-mailcommand = "mail -s test your@domain.com"
-\end{verbatim}
-\normalsize
-
-\item Once the above is working, assuming you want to use {\bf bsmtp}, submit
- the desired bsmtp command by hand and ensure that the email is delivered,
- then put that command into {\bf Bacula}. Small differences in things such as
-the parenthesis around the word Bacula can make a big difference to some
-bsmtp programs. For example, you might start simply by using:
-
-\footnotesize
-\begin{verbatim}
-mailcommand = "/home/bacula/bin/bsmtp -f \"root@localhost\" %r"
-\end{verbatim}
-\normalsize
-
-\end{itemize}
-
-\section{Getting Notified that Bacula is Running}
-\label{JobNotification}
-\index[general]{Running!Getting Notified that Bacula is }
-\index[general]{Getting Notified that Bacula is Running }
-
-If like me, you have setup Bacula so that email is sent only when a Job has
-errors, as described in the previous section of this chapter, inevitably, one
-day, something will go wrong and {\bf Bacula} can stall. This could be because
-Bacula crashes, which is vary rare, or more likely the network has caused {\bf
-Bacula} to {\bf hang} for some unknown reason.
-
-To avoid this, you can use the {\bf RunAfterJob} command in the Job resource
-to schedule a Job nightly, or weekly that simply emails you a message saying
-that Bacula is still running. For example, I have setup the following Job in
-my Director's configuration file:
-
-\footnotesize
-\begin{verbatim}
-Schedule {
- Name = "Watchdog"
- Run = Level=Full sun-sat at 6:05
-}
-Job {
- Name = "Watchdog"
- Type = Admin
- Client=Watchdog
- FileSet="Verify Set"
- Messages = Standard
- Storage = DLTDrive
- Pool = Default
- Schedule = "Watchdog"
- RunAfterJob = "/home/kern/bacula/bin/watchdog %c %d"
-}
-Client {
- Name = Watchdog
- Address = rufus
- FDPort = 9102
- Catalog = Verify
- Password = ""
- File Retention = 1day
- Job Retention = 1 month
- AutoPrune = yes
-}
-\end{verbatim}
-\normalsize
-
-Where I established a schedule to run the Job nightly. The Job itself is type
-{\bf Admin} which means that it doesn't actually do anything, and I've defined
-a FileSet, Pool, Storage, and Client, all of which are not really used (and
-probably don't need to be specified). The key aspect of this Job is the
-command:
-
-\footnotesize
-\begin{verbatim}
- RunAfterJob = "/home/kern/bacula/bin/watchdog %c %d"
-\end{verbatim}
-\normalsize
-
-which runs my "watchdog" script. As an example, I have added the Job codes
-\%c and \%d which will cause the Client name and the Director's name to be
-passed to the script. For example, if the Client's name is {\bf Watchdog} and
-the Director's name is {\bf main-dir} then referencing \$1 in the script would
-get {\bf Watchdog} and referencing \$2 would get {\bf main-dir}. In this case,
-having the script know the Client and Director's name is not really useful,
-but in other situations it may be.
-
-You can put anything in the watchdog script. In my case, I like to monitor the
-size of my catalog to be sure that {\bf Bacula} is really pruning it. The
-following is my watchdog script:
-
-\footnotesize
-\begin{verbatim}
-#!/bin/sh
-cd /home/kern/mysql/var/bacula
-du . * |
-/home/kern/bacula/bin/bsmtp \
- -f "\(Bacula\) abuse@whitehouse.com" -h mail.yyyy.com \
- -s "Bacula running" abuse@whitehouse.com
-\end{verbatim}
-\normalsize
-
-If you just wish to send yourself a message, you can do it with:
-
-\footnotesize
-\begin{verbatim}
-#!/bin/sh
-cd /home/kern/mysql/var/bacula
-/home/kern/bacula/bin/bsmtp \
- -f "\(Bacula\) abuse@whitehouse.com" -h mail.yyyy.com \
- -s "Bacula running" abuse@whitehouse.com <<END-OF-DATA
-Bacula is still running!!!
-END-OF-DATA
-\end{verbatim}
-\normalsize
-
-\section{Maintaining a Valid Bootstrap File}
-\label{bootstrap}
-\index[general]{Maintaining a Valid Bootstrap File }
-\index[general]{File!Maintaining a Valid Bootstrap }
-
-By using a
-\ilink{ WriteBootstrap}{writebootstrap} record in each of your
-Director's Job resources, you can constantly maintain a
-\ilink{bootstrap}{BootstrapChapter} file that will enable you to
-recover the state of your system as of the last backup without having the
-Bacula catalog. This permits you to more easily recover from a disaster that
-destroys your Bacula catalog.
-
-When a Job resource has a {\bf WriteBootstrap} record, Bacula will maintain
-the designated file (normally on another system but mounted by NFS) with up to
-date information necessary to restore your system. For example, in my
-Director's configuration file, I have the following record:
-
-\footnotesize
-\begin{verbatim}
- Write Bootstrap = "/mnt/deuter/files/backup/client-name.bsr"
-\end{verbatim}
-\normalsize
-
-where I replace {\bf client-name} by the actual name of the client that is
-being backed up. Thus, Bacula automatically maintains one file for each of my
-clients. The necessary bootstrap information is appended to this file during
-each {\bf Incremental} backup, and the file is totally rewritten during each
-{\bf Full} backup.
-
-Note, one disadvantage of writing to an NFS mounted volume as I do is
-that if the other machine goes down, the OS will wait forever on the fopen()
-call that Bacula makes. As a consequence, Bacula will completely stall until
-the machine exporting the NFS mounts comes back up. A possible solution to this
-problem was provided by Andrew Hilborne, and consists of using the {\bf soft}
-option instead of the {\bf hard} option when mounting the NFS volume, which is
-typically done in {\bf /etc/fstab}/. The NFS documentation explains these
-options in detail. However, I found that with the {\bf soft} option
-NFS disconnected frequently causing even more problems.
-
-If you are starting off in the middle of a cycle (i.e. with Incremental
-backups) rather than at the beginning (with a Full backup), the {\bf
-bootstrap} file will not be immediately valid as it must always have the
-information from a Full backup as the first record. If you wish to synchronize
-your bootstrap file immediately, you can do so by running a {\bf restore}
-command for the client and selecting a full restore, but when the restore
-command asks for confirmation to run the restore Job, you simply reply no,
-then copy the bootstrap file that was written to the location specified on the
-{\bf Write Bootstrap} record. The restore bootstrap file can be found in {\bf
-restore.bsr} in the working directory that you defined. In the example given
-below for the client {\bf rufus}, my input is shown in bold. Note, the JobId
-output has been partially truncated to fit on the page here:
-
-\footnotesize
-\begin{verbatim}
-(in the Console program)
-*restore
-First you select one or more JobIds that contain files
-to be restored. You will then be presented several methods
-of specifying the JobIds. Then you will be allowed to
-select which files from those JobIds are to be restored.
-To select the JobIds, you have the following choices:
- 1: List last 20 Jobs run
- 2: List Jobs where a given File is saved
- 3: Enter list of JobIds to select
- 4: Enter SQL list command
- 5: Select the most recent backup for a client
- 6: Cancel
-Select item: (1-6): 5
-The defined Client resources are:
- 1: Minimatou
- 2: Rufus
- 3: Timmy
-Select Client (File daemon) resource (1-3): 2
-The defined FileSet resources are:
- 1: Other Files
-Item 1 selected automatically.
-+-------+------+-------+---------+---------+------+-------+------------+
-| JobId | Levl | Files | StrtTim | VolName | File | SesId | VolSesTime |
-+-------+------+-------+---------+---------+------+-------+------------+
-| 2 | F | 84 | ... | test1 | 0 | 1 | 1035645259 |
-+-------+------+-------+---------+---------+------+-------+------------+
-You have selected the following JobId: 2
-Building directory tree for JobId 2 ...
-The defined Storage resources are:
- 1: File
-Item 1 selected automatically.
-You are now entering file selection mode where you add and
-remove files to be restored. All files are initially added.
-Enter "done" to leave this mode.
-cwd is: /
-$ done
-84 files selected to restore.
-Run Restore job
-JobName: kernsrestore
-Bootstrap: /home/kern/bacula/working/restore.bsr
-Where: /tmp/bacula-restores
-FileSet: Other Files
-Client: Rufus
-Storage: File
-JobId: *None*
-OK to run? (yes/mod/no): no
-quit
-(in a shell window)
-cp ../working/restore.bsr /mnt/deuter/files/backup/rufus.bsr
-\end{verbatim}
-\normalsize
-
-\section{Rejected Volumes After a Crash}
-\label{RejectedVolumes}
-\index[general]{Crash!Rejected Volumes After a }
-\index[general]{Rejected Volumes After a Crash }
-
-Bacula keeps a count of the number of files on each Volume in its Catalog
-database so that before appending to a tape, it can verify that the number of
-files are correct, and thus prevent overwriting valid data. If the Director or
-the Storage daemon crashes before the job has completed, the tape will contain
-one more file than is noted in the Catalog, and the next time you attempt to
-use the same Volume, Bacula will reject it due to a mismatch between the
-physical tape (Volume) and the catalog.
-
-The easiest solution to this problem is to label a new tape and start fresh.
-If you wish to continue appending to the current tape, you can do so by using
-the {\bf update} command in the console program to change the {\bf Volume
-Files} entry in the catalog. A typical sequence of events would go like the
-following:
-
-\footnotesize
-\begin{verbatim}
-- Bacula crashes
-- You restart Bacula
-\end{verbatim}
-\normalsize
-
-Bacula then prints:
-
-\footnotesize
-\begin{verbatim}
-17-Jan-2003 16:45 rufus-dir: Start Backup JobId 13,
- Job=kernsave.2003-01-17_16.45.46
-17-Jan-2003 16:45 rufus-sd: Volume test01 previously written,
- moving to end of data.
-17-Jan-2003 16:46 rufus-sd: kernsave.2003-01-17_16.45.46 Error:
- I cannot write on this volume because:
- The number of files mismatch! Volume=11 Catalog=10
-17-Jan-2003 16:46 rufus-sd: Job kernsave.2003-01-17_16.45.46 waiting.
- Cannot find any appendable volumes.
-Please use the "label" command to create a new Volume for:
- Storage: SDT-10000
- Media type: DDS-4
- Pool: Default
-\end{verbatim}
-\normalsize
-
-(note, lines wrapped for presentation)
-The key here is the line that reads:
-
-\footnotesize
-\begin{verbatim}
- The number of files mismatch! Volume=11 Catalog=10
-\end{verbatim}
-\normalsize
-
-It says that Bacula found eleven files on the volume, but that the catalog
-says there should be ten. When you see this, you can be reasonably sure that
-the SD was interrupted while writing before it had a chance to update the
-catalog. As a consequence, you can just modify the catalog count to eleven,
-and even if the catalog contains references to files saved in file 11,
-everything will be OK and nothing will be lost. Note that if the SD had
-written several file marks to the volume, the difference between the Volume
-count and the Catalog count could be larger than one, but this is unusual.
-
-If on the other hand the catalog is marked as having more files than Bacula
-found on the tape, you need to consider the possible negative consequences of
-modifying the catalog. Please see below for a more complete discussion of
-this.
-
-Continuing with the example of {\bf Volume = 11 Catalog = 10}, to enable to
-Bacula to append to the tape, you do the following:
-
-\footnotesize
-\begin{verbatim}
-update
-Update choice:
- 1: Volume parameters
- 2: Pool from resource
- 3: Slots from autochanger
-Choose catalog item to update (1-3): 1
-Defined Pools:
- 1: Default
- 2: File
-Select the Pool (1-2):
-+-------+---------+--------+---------+-----------+------+----------+------+-----+
-| MedId | VolName | MedTyp | VolStat | VolBytes | Last | VolReten | Recy | Slt |
-+-------+---------+--------+---------+-----------+------+----------+------+-----+
-| 1 | test01 | DDS-4 | Error | 352427156 | ... | 31536000 | 1 | 0 |
-+-------+---------+--------+---------+-----------+------+----------+------+-----+
-Enter MediaId or Volume name: 1
-\end{verbatim}
-\normalsize
-
-(note table output truncated for presentation) First, you chose to update the
-Volume parameters by entering a {\bf 1}. In the volume listing that follows,
-notice how the VolStatus is {\bf Error}. We will correct that after changing
-the Volume Files. Continuing, you respond 1,
-
-\footnotesize
-\begin{verbatim}
-Updating Volume "test01"
-Parameters to modify:
- 1: Volume Status
- 2: Volume Retention Period
- 3: Volume Use Duration
- 4: Maximum Volume Jobs
- 5: Maximum Volume Files
- 6: Maximum Volume Bytes
- 7: Recycle Flag
- 8: Slot
- 9: Volume Files
- 10: Pool
- 11: Done
-Select parameter to modify (1-11): 9
-Warning changing Volume Files can result
-in loss of data on your Volume
-Current Volume Files is: 10
-Enter new number of Files for Volume: 11
-New Volume Files is: 11
-Updating Volume "test01"
-Parameters to modify:
- 1: Volume Status
- 2: Volume Retention Period
- 3: Volume Use Duration
- 4: Maximum Volume Jobs
- 5: Maximum Volume Files
- 6: Maximum Volume Bytes
- 7: Recycle Flag
- 8: Slot
- 9: Volume Files
- 10: Pool
- 11: Done
-Select parameter to modify (1-10): 1
-\end{verbatim}
-\normalsize
-
-Here, you have selected {\bf 9} in order to update the Volume Files, then you
-changed it from {\bf 10} to {\bf 11}, and you now answer {\bf 1} to change the
-Volume Status.
-
-\footnotesize
-\begin{verbatim}
-Current Volume status is: Error
-Possible Values are:
- 1: Append
- 2: Archive
- 3: Disabled
- 4: Full
- 5: Used
- 6: Read-Only
-Choose new Volume Status (1-6): 1
-New Volume status is: Append
-Updating Volume "test01"
-Parameters to modify:
- 1: Volume Status
- 2: Volume Retention Period
- 3: Volume Use Duration
- 4: Maximum Volume Jobs
- 5: Maximum Volume Files
- 6: Maximum Volume Bytes
- 7: Recycle Flag
- 8: Slot
- 9: Volume Files
- 10: Pool
- 11: Done
-Select parameter to modify (1-11): 11
-Selection done.
-\end{verbatim}
-\normalsize
-
-At this point, you have changed the Volume Files from {\bf 10} to {\bf 11} to
-account for the last file that was written but not updated in the database,
-and you changed the Volume Status back to {\bf Append}.
-
-This was a lot of words to describe something quite simple.
-
-The {\bf Volume Files} option exists only in version 1.29 and later, and you
-should be careful using it. Generally, if you set the value to that which
-Bacula said is on the tape, you will be OK, especially if the value is one
-more than what is in the catalog.
-
-Now lets consider the case:
-
-\footnotesize
-\begin{verbatim}
- The number of files mismatch! Volume=10 Catalog=12
-\end{verbatim}
-\normalsize
-
-Here the Bacula found fewer files on the volume than what is marked in the
-catalog. Now, in this case, you should hesitate a lot before modifying the count
-in the catalog, because if you force the catalog from 12 to 10, Bacula will
-start writing after the file 10 on the tape, possibly overwriting valid data,
-and if you ever try to restore any of the files that the catalog has marked as
-saved on Files 11 and 12, all chaos will break out. In this case, you will
-probably be better off using a new tape. In fact, you might want to see what
-files the catalog claims are actually stored on that Volume, and back them up
-to another tape and recycle this tape.
-
-\section{Security Considerations}
-\label{security}
-\index[general]{Considerations!Security }
-\index[general]{Security Considerations }
-
-Only the File daemon needs to run with root permission (so that it can access
-all files). As a consequence, you may run your Director, Storage daemon, and
-MySQL or PostgreSQL database server as non-root processes. Version 1.30 has
-the {\bf -u} and the {\bf -g} options that allow you to specify a userid and
-groupid on the command line to be used after Bacula starts.
-
-As of version 1.33, thanks to Dan Langille, it is easier to configure the
-Bacula Director and Storage daemon to run as non-root.
-
-You should protect the Bacula port addresses (normally 9101, 9102, and 9103)
-from outside access by a firewall or other means of protection to prevent
-unauthorized use of your daemons.
-
-You should ensure that the configuration files are not world readable since
-they contain passwords that allow access to the daemons. Anyone who can access
-the Director using a console program can restore any file from a backup
-Volume.
-
-You should protect your Catalog database. If you are using SQLite, make sure
-that the working directory is readable only by root (or your Bacula userid),
-and ensure that {\bf bacula.db} has permissions {\bf -rw-r\verb:--:r\verb:--:} (i.e. 640) or
-more strict. If you are using MySQL or PostgreSQL, please note that the Bacula
-setup procedure leaves the database open to anyone. At a minimum, you should
-assign the user {\bf bacula} a userid and add it to your Director's
-configuration file in the appropriate Catalog resource.
-
-If you use the make\_catalog\_backup script provided by Bacula, remember that
-you should take care when supplying passwords on the command line. Read the
-\ilink{Backing Up Your Bacula
-Database - Security Considerations }{BackingUpBaculaSecurityConsiderations}
-section for more information.
-
-\section{Creating Holiday Schedules}
-\label{holiday}
-\index[general]{Schedules!Creating Holiday }
-\index[general]{Creating Holiday Schedules }
-
-If you normally change tapes every day or at least every Friday, but Thursday
-is a holiday, you can use a trick proposed by Lutz Kittler to ensure that no
-job runs on Thursday so that you can insert Friday's tape and be sure it will
-be used on Friday. To do so, define a {\bf RunJobBefore} script that normally
-returns zero, so that the Bacula job will normally continue. You can then
-modify the script to return non-zero on any day when you do not want Bacula to
-run the job.
-
-\section{Automatic Labeling Using Your Autochanger}
-\label{autolabel}
-\index[general]{Automatic Labeling Using Your Autochanger }
-\index[general]{Autochanger!Automatic Labeling Using Your }
-
-If you have an autochanger but it does not support barcodes, using a "trick"
-you can make Bacula automatically label all the volumes in your autochanger's
-magazine.
-
-First create a file containing one line for each slot in your autochanger that
-has a tape to be labeled. The line will contain the slot number a colon (:)
-then the Volume name you want to use. For example, create a file named {\bf
-volume-list}, which contains:
-
-\footnotesize
-\begin{verbatim}
-1:Volume001
-2:TestVolume02
-5:LastVolume
-\end{verbatim}
-\normalsize
-
-The records do not need to be in any order and you don't need to mention all
-the slots. Normally, you will have a consistent set of Volume names and a
-sequential set of numbers for each slot you want labeled. In the example
-above, I've left out slots 3 and 4 just as an example. Now, modify your {\bf
-mtx-changer} script and comment out all the lines in the {\bf list)} case by
-putting a \# in column 1. Then add the following two lines:
-
-\footnotesize
-\begin{verbatim}
- cat <absolute-path>/volume-list
- exit 0
-\end{verbatim}
-\normalsize
-
-so that the whole case looks like:
-
-\footnotesize
-\begin{verbatim}
- list)
-#
-# commented out lines
- cat <absolute-path>/volume-list
- exit 0
- ;;
-\end{verbatim}
-\normalsize
-
-where you replace \lt{}absolute-path\gt{} with the full path to the
-volume-list file. Then using the console, you enter the following command:
-
-\footnotesize
-\begin{verbatim}
- label barcodes
-\end{verbatim}
-\normalsize
-
-and Bacula will proceed to mount the autochanger Volumes in the list and label
-them with the Volume names you have supplied. Bacula will think that the list
-was provided by the autochanger barcodes, but in reality, it was you who
-supplied the \lt{}barcodes\gt{}.
-
-If it seems to work, when it finishes, enter:
-
-\footnotesize
-\begin{verbatim}
- list volumes
-\end{verbatim}
-\normalsize
-
-and you should see all the volumes nicely created.
-
-\section{Backing Up Portables Using DHCP}
-\label{DNS}
-\index[general]{DHCP!Backing Up Portables Using }
-\index[general]{Backing Up Portables Using DHCP }
-
-You may want to backup laptops or portables that are not always connected to
-the network. If you are using DHCP to assign an IP address to those machines
-when they connect, you will need to use the Dynamic Update capability of DNS
-to assign a name to those machines that can be used in the Address field of
-the Client resource in the Director's conf file.
-
-\section{Going on Vacation}
-\label{Vacation}
-\index[general]{Vacation!Going on }
-\index[general]{Going on Vacation }
-
-At some point, you may want to be absent for a week or two and you want to
-make sure Bacula has enough tape left so that the backups will complete. You
-start by doing a {\bf list volumes} in the Console program:
-
-\footnotesize
-\begin{verbatim}
-list volumes
-
-Using default Catalog name=BackupDB DB=bacula
-Pool: Default
-+---------+---------------+-----------+-----------+----------------+-
-| MediaId | VolumeName | MediaType | VolStatus | VolBytes |
-+---------+---------------+-----------+-----------+----------------+-
-| 23 | DLT-30Nov02 | DLT8000 | Full | 54,739,278,128 |
-| 24 | DLT-21Dec02 | DLT8000 | Full | 56,331,524,629 |
-| 25 | DLT-11Jan03 | DLT8000 | Full | 67,863,514,895 |
-| 26 | DLT-02Feb03 | DLT8000 | Full | 63,439,314,216 |
-| 27 | DLT-03Mar03 | DLT8000 | Full | 66,022,754,598 |
-| 28 | DLT-04Apr03 | DLT8000 | Full | 60,792,559,924 |
-| 29 | DLT-28Apr03 | DLT8000 | Full | 62,072,494,063 |
-| 30 | DLT-17May03 | DLT8000 | Full | 65,901,767,839 |
-| 31 | DLT-07Jun03 | DLT8000 | Used | 56,558,490,015 |
-| 32 | DLT-28Jun03 | DLT8000 | Full | 64,274,871,265 |
-| 33 | DLT-19Jul03 | DLT8000 | Full | 64,648,749,480 |
-| 34 | DLT-08Aug03 | DLT8000 | Full | 64,293,941,255 |
-| 35 | DLT-24Aug03 | DLT8000 | Append | 9,999,216,782 |
-+---------+---------------+-----------+-----------+----------------+
-\end{verbatim}
-\normalsize
-
-Note, I have truncated the output for presentation purposes. What is
-significant, is that I can see that my current tape has almost 10 Gbytes of
-data, and that the average amount of data I get on my tapes is about 60
-Gbytes. So if I go on vacation now, I don't need to worry about tape capacity
-(at least not for short absences).
-
-Equally significant is the fact that I did go on vacation the 28th of June
-2003, and when I did the {\bf list volumes} command, my current tape at that
-time, DLT-07Jun03 MediaId 31, had 56.5 Gbytes written. I could see that the
-tape would fill shortly. Consequently, I manually marked it as {\bf Used} and
-replaced it with a fresh tape that I labeled as DLT-28Jun03, thus assuring
-myself that the backups would all complete without my intervention.
-
-\section{Exclude Files on Windows Regardless of Case}
-\label{Case}
-\index[general]{Exclude Files on Windows Regardless of Case}
-% TODO: should this be put in the win32 chapter?
-% TODO: should all these tips be placed in other chapters?
-
-This tip was submitted by Marc Brueckner who wasn't sure of the case of some
-of his files on Win32, which is case insensitive. The problem is that Bacula
-thinks that {\bf /UNIMPORTANT FILES} is different from {\bf /Unimportant
-Files}. Marc was aware that the file exclusion permits wild-cards. So, he
-specified:
-
-\footnotesize
-\begin{verbatim}
-"/[Uu][Nn][Ii][Mm][Pp][Oo][Rr][Tt][Aa][Nn][Tt] [Ff][Ii][Ll][Ee][Ss]"
-\end{verbatim}
-\normalsize
-
-As a consequence, the above exclude works for files of any case.
-
-Please note that this works only in Bacula Exclude statement and not in
-Include.
-
-\section{Executing Scripts on a Remote Machine}
-\label{RemoteExecution}
-\index[general]{Machine!Executing Scripts on a Remote }
-\index[general]{Executing Scripts on a Remote Machine }
-
-This tip also comes from Marc Brueckner. (Note, this tip is probably outdated
-by the addition of {\bf ClientRunBeforJob} and {\bf ClientRunAfterJob} Job
-records, but the technique still could be useful.) First I thought the "Run
-Before Job" statement in the Job-resource is for executing a script on the
-remote machine (the machine to be backed up). (Note, this is possible as mentioned
-above by using {\bf ClientRunBeforJob} and {\bf ClientRunAfterJob}).
-It could be useful to execute
-scripts on the remote machine e.g. for stopping databases or other services
-while doing the backup. (Of course I have to start the services again when the
-backup has finished) I found the following solution: Bacula could execute
-scripts on the remote machine by using ssh. The authentication is done
-automatically using a private key. First you have to generate a keypair. I've
-done this by:
-
-\footnotesize
-\begin{verbatim}
-ssh-keygen -b 4096 -t dsa -f Bacula_key
-\end{verbatim}
-\normalsize
-
-This statement may take a little time to run. It creates a public/private key
-pair with no passphrase. You could save the keys in /etc/bacula. Now you have
-two new files : Bacula\_key which contains the private key and Bacula\_key.pub
-which contains the public key.
-
-Now you have to append the Bacula\_key.pub file to the file authorized\_keys
-in the \textbackslash{}root\textbackslash{}.ssh directory of the remote
-machine. Then you have to add (or uncomment) the line
-
-\footnotesize
-\begin{verbatim}
-AuthorizedKeysFile %h/.ssh/authorized_keys
-\end{verbatim}
-\normalsize
-
-to the sshd\_config file on the remote machine. Where the \%h stands for the
-home-directory of the user (root in this case).
-
-Assuming that your sshd is already running on the remote machine, you can now
-enter the following on the machine where Bacula runs:
-
-\footnotesize
-\begin{verbatim}
-ssh -i Bacula_key -l root <machine-name-or-ip-address> "ls -la"
-\end{verbatim}
-\normalsize
-
-This should execute the "ls -la" command on the remote machine.
-
-Now you could add lines like the following to your Director's conf file:
-
-\footnotesize
-\begin{verbatim}
-...
-Run Before Job = ssh -i /etc/bacula/Bacula_key 192.168.1.1 \
- "/etc/init.d/database stop"
-Run After Job = ssh -i /etc/bacula/Bacula_key 192.168.1.1 \
- "/etc/init.d/database start"
-...
-\end{verbatim}
-\normalsize
-
-Even though Bacula version 1.32 and later has a ClientRunBeforeJob, the ssh method still
-could be useful for updating all the Bacula clients on several remote machines
-in a single script.
-
-\section{Recycling All Your Volumes}
-\label{recycle}
-\index[general]{Recycling All Your Volumes }
-\index[general]{Volumes!Recycling All Your }
-
-This tip comes from Phil Stracchino.
-
-If you decide to blow away your catalog and start over, the simplest way to
-re-add all your prelabeled tapes with a minimum of fuss (provided you don't
-care about the data on the tapes) is to add the tape labels using the console
-{\bf add} command, then go into the catalog and manually set the VolStatus of
-every tape to {\bf Recycle}.
-
-The SQL command to do this is very simple, either use your vendor's
-command line interface (mysql, postgres, sqlite, ...) or use the sql
-command in the Bacula console:
-
-\footnotesize
-\begin{verbatim}
-update Media set VolStatus='Recycle';
-\end{verbatim}
-\normalsize
-
-Bacula will then ignore the data already stored on the tapes and just re-use
-each tape without further objection.
-
-\section{Backing up ACLs on ext3 or XFS filesystems}
-\label{ACLs}
-\index[general]{Filesystems!Backing up ACLs on ext3 or XFS }
-\index[general]{Backing up ACLs on ext3 or XFS filesystems }
-
-This tip comes from Volker Sauer.
-
-Note, this tip was given prior to implementation of ACLs in Bacula (version
-1.34.5). It is left here because dumping/displaying ACLs can still be useful
-in testing/verifying that Bacula is backing up and restoring your ACLs
-properly. Please see the
-\ilink{aclsupport}{ACLSupport} FileSet option in the
-configuration chapter of this manual.
-
-For example, you could dump the ACLs to a file with a script similar to the
-following:
-
-\footnotesize
-\begin{verbatim}
-#!/bin/sh
-BACKUP_DIRS="/foo /bar"
-STORE_ACL=/root/acl-backup
-umask 077
-for i in $BACKUP_DIRS; do
- cd $i /usr/bin/getfacl -R --skip-base .>$STORE_ACL/${i//\//_}
-done
-\end{verbatim}
-\normalsize
-
-Then use Bacula to backup {\bf /root/acl-backup}.
-
-The ACLs could be restored using Bacula to the {\bf /root/acl-backup} file,
-then restored to your system using:
-
-\footnotesize
-\begin{verbatim}
-setfacl --restore/root/acl-backup
-\end{verbatim}
-\normalsize
-
-\section{Total Automation of Bacula Tape Handling}
-\label{automate}
-\index[general]{Handling!Total Automation of Bacula Tape }
-\index[general]{Total Automation of Bacula Tape Handling }
-
-This tip was provided by Alexander Kuehn.
-
-\elink{Bacula}{\url{http://www.bacula.org/}} is a really nice backup program except
-that the manual tape changing requires user interaction with the bacula
-console.
-
-Fortunately I can fix this.
-NOTE!!! This suggestion applies for people who do *NOT* have tape autochangers
-and must change tapes manually.!!!!!
-
-Bacula supports a variety of tape changers through the use of mtx-changer
-scripts/programs. This highly flexible approach allowed me to create
-\elink{this shell script}{\url{http://www.bacula.org/en/rel-manual/mtx-changer.txt}} which does the following:
-% TODO: We need to include this in book appendix and point to it.
-% TODO:
-Whenever a new tape is required it sends a mail to the operator to insert the
-new tape. Then it waits until a tape has been inserted, sends a mail again to
-say thank you and let's bacula continue its backup.
-So you can schedule and run backups without ever having to log on or see the
-console.
-To make the whole thing work you need to create a Device resource which looks
-something like this ("Archive Device", "Maximum Changer Wait", "Media
-Type" and "Label media" may have different values):
-
-\footnotesize
-\begin{verbatim}
-Device {
- Name=DDS3
- Archive Device = # use yours not mine! ;)/dev/nsa0
- Changer Device = # not really required/dev/nsa0
- Changer Command = "# use this (maybe change the path)!
- /usr/local/bin/mtx-changer %o %a %S"
- Maximum Changer Wait = 3d # 3 days in seconds
- AutomaticMount = yes; # mount on start
- AlwaysOpen = yes; # keep device locked
- Media Type = DDS3 # it's just a name
- RemovableMedia = yes; #
- Offline On Unmount = Yes; # keep this too
- Label media = Yes; #
-}
-\end{verbatim}
-\normalsize
-
-As the script has to emulate the complete wisdom of a mtx-changer it has an
-internal "database" containing where which tape is stored, you can see this on
-the following line:
-
-\footnotesize
-\begin{verbatim}
-labels="VOL-0001 VOL-0002 VOL-0003 VOL-0004 VOL-0005 VOL-0006
-VOL-0007 VOL-0008 VOL-0009 VOL-0010 VOL-0011 VOL-0012"
-\end{verbatim}
-\normalsize
-
-The above should be all on one line, and it effectively tells Bacula that
-volume "VOL-0001" is located in slot 1 (which is our lowest slot), that
-volume "VOL-0002" is located in slot 2 and so on..
-The script also maintains a logfile (/var/log/mtx.log) where you can monitor
-its operation.
-
-\section{Running Concurrent Jobs}
-\label{ConcurrentJobs}
-\index[general]{Jobs!Running Concurrent}
-\index[general]{Running Concurrent Jobs}
-\index[general]{Concurrent Jobs}
-
-Bacula can run multiple concurrent jobs, but the default configuration files
-do not enable it. Using the {\bf Maximum Concurrent Jobs} directive, you
-can configure how many and which jobs can be run simultaneously.
-The Director's default value for {\bf Maximum Concurrent Jobs} is "1".
-
-To initially setup concurrent jobs you need to define {\bf Maximum Concurrent Jobs} in
-the Director's configuration file (bacula-dir.conf) in the
-Director, Job, Client, and Storage resources.
-
-Additionally the File daemon, and the Storage daemon each have their own
-{\bf Maximum Concurrent Jobs} directive that sets the overall maximum
-number of concurrent jobs the daemon will run. The default for both the
-File daemon and the Storage daemon is "20".
-
-For example, if you want two different jobs to run simultaneously backing up
-the same Client to the same Storage device, they will run concurrently only if
-you have set {\bf Maximum Concurrent Jobs} greater than one in the Director
-resource, the Client resource, and the Storage resource in bacula-dir.conf.
-
-We recommend that you read the \ilink{Data
-Spooling}{SpoolingChapter} of this manual first, then test your multiple
-concurrent backup including restore testing before you put it into
-production.
-
-Below is a super stripped down bacula-dir.conf file showing you the four
-places where the the file must be modified to allow the same job {\bf
-NightlySave} to run up to four times concurrently. The change to the Job
-resource is not necessary if you want different Jobs to run at the same time,
-which is the normal case.
-
-\footnotesize
-\begin{verbatim}
-#
-# Bacula Director Configuration file -- bacula-dir.conf
-#
-Director {
- Name = rufus-dir
- Maximum Concurrent Jobs = 4
- ...
-}
-Job {
- Name = "NightlySave"
- Maximum Concurrent Jobs = 4
- Client = rufus-fd
- Storage = File
- ...
-}
-Client {
- Name = rufus-fd
- Maximum Concurrent Jobs = 4
- ...
-}
-Storage {
- Name = File
- Maximum Concurrent Jobs = 4
- ...
-}
-\end{verbatim}
-\normalsize
+++ /dev/null
-#!/usr/bin/perl -w
-#
-use strict;
-
-# Used to change the names of the image files generated by latex2html from imgxx.png
-# to meaningful names. Provision is made to go either from or to the meaningful names.
-# The meaningful names are obtained from a file called imagename_translations, which
-# is generated by extensions to latex2html in the make_image_file subroutine in
-# bacula.perl.
-
-# Opens the file imagename_translations and reads the contents into a hash.
-# The hash is creaed with the imgxx.png files as the key if processing TO
-# meaningful filenames, and with the meaningful filenames as the key if
-# processing FROM meaningful filenames.
-# Then opens the html file(s) indicated in the command-line arguments and
-# changes all image references according to the translations described in the
-# above file. Finally, it renames the image files.
-#
-# Original creation: 3-27-05 by Karl Cunningham.
-# Modified 5-21-05 to go FROM and TO meaningful filenames.
-#
-my $TRANSFILE = "imagename_translations";
-my $path;
-
-# Loads the contents of $TRANSFILE file into the hash referenced in the first
-# argument. The hash is loaded to translate old to new if $direction is 0,
-# otherwise it is loaded to translate new to old. In this context, the
-# 'old' filename is the meaningful name, and the 'new' filename is the
-# imgxx.png filename. It is assumed that the old image is the one that
-# latex2html has used as the source to create the imgxx.png filename.
-# The filename extension is taken from the file
-sub read_transfile {
- my ($trans,$direction) = @_;
-
- if (!open IN,"<$path$TRANSFILE") {
- print "WARNING: Cannot open image translation file $path$TRANSFILE for reading\n";
- print " Image filename translation aborted\n\n";
- exit 0;
- }
-
- while (<IN>) {
- chomp;
- my ($new,$old) = split(/\001/);
-
- # Old filenames will usually have a leading ./ which we don't need.
- $old =~ s/^\.\///;
-
- # The filename extension of the old filename must be made to match
- # the new filename because it indicates the encoding format of the image.
- my ($ext) = $new =~ /(\.[^\.]*)$/;
- $old =~ s/\.[^\.]*$/$ext/;
- if ($direction == 0) {
- $trans->{$new} = $old;
- } else {
- $trans->{$old} = $new;
- }
- }
- close IN;
-}
-
-# Translates the image names in the file given as the first argument, according to
-# the translations in the hash that is given as the second argument.
-# The file contents are read in entirely into a string, the string is processed, and
-# the file contents are then written. No particular care is taken to ensure that the
-# file is not lost if a system failure occurs at an inopportune time. It is assumed
-# that the html files being processed here can be recreated on demand.
-#
-# Links to other files are added to the %filelist for processing. That way,
-# all linked files will be processed (assuming they are local).
-sub translate_html {
- my ($filename,$trans,$filelist) = @_;
- my ($contents,$out,$this,$img,$dest);
- my $cnt = 0;
-
- # If the filename is an external link ignore it. And drop any file:// from
- # the filename.
- $filename =~ /^(http|ftp|mailto)\:/ and return 0;
- $filename =~ s/^file\:\/\///;
- # Load the contents of the html file.
- if (!open IF,"<$path$filename") {
- print "WARNING: Cannot open $path$filename for reading\n";
- print " Image Filename Translation aborted\n\n";
- exit 0;
- }
-
- while (<IF>) {
- $contents .= $_;
- }
- close IF;
-
- # Now do the translation...
- # First, search for an image filename.
- while ($contents =~ /\<\s*IMG[^\>]*SRC=\"/si) {
- $contents = $';
- $out .= $` . $&;
-
- # The next thing is an image name. Get it and translate it.
- $contents =~ /^(.*?)\"/s;
- $contents = $';
- $this = $&;
- $img = $1;
- # If the image is in our list of ones to be translated, do it
- # and feed the result to the output.
- $cnt += $this =~ s/$img/$trans->{$img}/ if (defined($trans->{$img}));
- $out .= $this;
- }
- $out .= $contents;
-
- # Now send the translated text to the html file, overwriting what's there.
- open OF,">$path$filename" or die "Cannot open $path$filename for writing\n";
- print OF $out;
- close OF;
-
- # Now look for any links to other files and add them to the list of files to do.
- while ($out =~ /\<\s*A[^\>]*HREF=\"(.*?)\"/si) {
- $out = $';
- $dest = $1;
- # Drop an # and anything after it.
- $dest =~ s/\#.*//;
- $filelist->{$dest} = '' if $dest;
- }
- return $cnt;
-}
-
-# REnames the image files spefified in the %translate hash.
-sub rename_images {
- my $translate = shift;
- my ($response);
-
- foreach (keys(%$translate)) {
- if (! $translate->{$_}) {
- print " WARNING: No destination Filename for $_\n";
- } else {
- $response = `mv -f $path$_ $path$translate->{$_} 2>&1`;
- $response and print "ERROR from system $response\n";
- }
- }
-}
-
-#################################################
-############# MAIN #############################
-################################################
-
-# %filelist starts out with keys from the @ARGV list. As files are processed,
-# any links to other files are added to the %filelist. A hash of processed
-# files is kept so we don't do any twice.
-
-# The first argument must be either --to_meaningful_names or --from_meaningful_names
-
-my (%translate,$search_regex,%filelist,%completed,$thisfile);
-my ($cnt,$direction);
-
-my $arg0 = shift(@ARGV);
-$arg0 =~ /^(--to_meaningful_names|--from_meaningful_names)$/ or
- die "ERROR: First argument must be either \'--to_meaningful_names\' or \'--from_meaningful_names\'\n";
-
-$direction = ($arg0 eq '--to_meaningful_names') ? 0 : 1;
-
-(@ARGV) or die "ERROR: Filename(s) to process must be given as arguments\n";
-
-# Use the first argument to get the path to the file of translations.
-my $tmp = $ARGV[0];
-($path) = $tmp =~ /(.*\/)/;
-$path = '' unless $path;
-
-read_transfile(\%translate,$direction);
-
-foreach (@ARGV) {
- # Strip the path from the filename, and use it later on.
- if (s/(.*\/)//) {
- $path = $1;
- } else {
- $path = '';
- }
- $filelist{$_} = '';
-
- while ($thisfile = (keys(%filelist))[0]) {
- $cnt += translate_html($thisfile,\%translate,\%filelist) if (!exists($completed{$thisfile}));
- delete($filelist{$thisfile});
- $completed{$thisfile} = '';
- }
- print "translate_images.pl: $cnt image filenames translated ",($direction)?"from":"to"," meaningful names\n";
-}
-
-rename_images(\%translate);
+++ /dev/null
-#
-#
-# Makefile for LaTeX
-#
-# To build everything do
-# make tex
-# make web
-# make html
-# make dvipdf
-#
-# or simply
-#
-# make
-#
-# for rapid development do:
-# make tex
-# make show
-#
-#
-# If you are having problems getting "make" to work, debugging it is
-# easier if can see the output from latex, which is normally redirected
-# to /dev/null. To see it, do the following:
-#
-# cd docs/manual
-# make tex
-# latex bacula.tex
-#
-# typically the latex command will stop indicating the error (e.g. a
-# missing \ in front of a _ or a missing { or ] ...
-#
-# The following characters must be preceded by a backslash
-# to be entered as printable characters:
-#
-# # $ % & ~ _ ^ \ { }
-#
-
-IMAGES=../../../images
-
-DOC=utility
-
-first_rule: all
-
-all: tex web dvipdf mini-clean
-
-.SUFFIXES: .tex .html
-.PHONY:
-.DONTCARE:
-
-
-tex:
- @./update_version
- @echo "Making version `cat version.tex`"
- @cp -fp ${IMAGES}/hires/*.eps .
- @touch ${DOC}i-dir.tex ${DOC}i-fd.tex ${DOC}i-sd.tex \
- ${DOC}i-console.tex ${DOC}i-general.tex
- latex -interaction=batchmode ${DOC}.tex
- makeindex ${DOC}.idx -o ${DOC}.ind 2>/dev/null
- latex -interaction=batchmode ${DOC}.tex
-
-pdf:
- @echo "Making pdfm"
- @cp -fp ${IMAGES}/hires/*.eps .
- dvipdfm -p a4 ${DOC}.dvi
-
-dvipdf:
- @echo "Making dvi to pdf"
- @cp -fp ${IMAGES}/hires/*.eps .
- dvipdf ${DOC}.dvi ${DOC}.pdf
-
-html:
- @echo " "
- @echo "Making html"
- @cp -fp ${IMAGES}/*.eps .
- @rm -f next.eps next.png prev.eps prev.png up.eps up.png
- @(if [ -f imagename_translations ] ; then \
- ./translate_images.pl --from_meaningful_names ${DOC}.html; \
- fi)
- latex2html -white -no_subdir -split 0 -toc_stars -white -notransparent \
- -init_file latex2html-init.pl ${DOC} >tex.out 2>&1
- ./translate_images.pl --to_meaningful_names ${DOC}.html
- @echo "Done making html"
-
-web:
- @echo "Making web"
- @mkdir -p ${DOC}
- @cp -fp ${IMAGES}/*.eps .
- @rm -f next.eps next.png prev.eps prev.png up.eps up.png
- @cp -fp ${IMAGES}/*.eps ${DOC}/
- @cp -fp ${IMAGES}/*.eps ${IMAGES}/*.png ${DOC}/
- @rm -f ${DOC}/xp-*.png
- @rm -f ${DOC}/next.eps ${DOC}/next.png ${DOC}/prev.eps ${DOC}/prev.png ${DOC}/up.eps ${DOC}/up.png
- @rm -rf ${DOC}/*.html
- latex2html -split 3 -local_icons -t "Bacula Utility Programs" -long_titles 4 \
- -toc_stars -contents_in_nav -init_file latex2html-init.pl -white -notransparent ${DOC} >tex.out 2>&1
- ./translate_images.pl --to_meaningful_names ${DOC}/Bacula_Utilit*.html
- @echo "Done making web"
-show:
- xdvi ${DOC}
-
-texcheck:
- ./check_tex.pl ${DOC}.tex
-
-main_configs:
- pic2graph -density 100 <main_configs.pic >main_configs.png
-
-mini-clean:
- @rm -f 1 2 3 *.tex~
- @rm -f *.gif *.jpg *.eps
- @rm -f *.aux *.cp *.fn *.ky *.log *.pg
- @rm -f *.backup *.ilg *.lof *.lot
- @rm -f *.cdx *.cnd *.ddx *.ddn *.fdx *.fnd *.ind *.sdx *.snd
- @rm -f *.dnd *.old *.out
- @rm -f ${DOC}/*.gif ${DOC}/*.jpg ${DOC}/*.eps
- @rm -f ${DOC}/*.aux ${DOC}/*.cp ${DOC}/*.fn ${DOC}/*.ky ${DOC}/*.log ${DOC}/*.pg
- @rm -f ${DOC}/*.backup ${DOC}/*.ilg ${DOC}/*.lof ${DOC}/*.lot
- @rm -f ${DOC}/*.cdx ${DOC}/*.cnd ${DOC}/*.ddx ${DOC}/*.ddn ${DOC}/*.fdx ${DOC}/*.fnd ${DOC}/*.ind ${DOC}/*.sdx ${DOC}/*.snd
- @rm -f ${DOC}/*.dnd ${DOC}/*.old ${DOC}/*.out
- @rm -f ${DOC}/WARNINGS
-
-
-clean:
- @rm -f 1 2 3 *.tex~
- @rm -f *.png *.gif *.jpg *.eps
- @rm -f *.pdf *.aux *.cp *.fn *.ky *.log *.pg
- @rm -f *.html *.backup *.ps *.dvi *.ilg *.lof *.lot
- @rm -f *.cdx *.cnd *.ddx *.ddn *.fdx *.fnd *.ind *.sdx *.snd
- @rm -f *.dnd imagename_translations
- @rm -f *.old WARNINGS *.out *.toc *.idx
- @rm -f ${DOC}i-*.tex
- @rm -rf ${DOC}
-
-
-distclean: clean
- @rm -f images.pl labels.pl internals.pl
- @rm -f Makefile version.tex
+++ /dev/null
-%%
-%%
-%% The following characters must be preceded by a backslash
-%% to be entered as printable characters:
-%%
-%% # $ % & ~ _ ^ \ { }
-%%
-
-\section{bimagemgr}
-\label{bimagemgr}
-\index[general]{Bimagemgr }
-
-{\bf bimagemgr} ist ein Hilfsmittel f\"{u}r diejenigen, die Ihre Backups auf
-Festplatten-Volumes speichern und diese Volumes auf CDR brennen wollen.
-Es hat eine Web-basierte Bedienoberfl\"{a}che und ist in Perl programmiert.
-Es wird benutzt, um zu kontrollieren, wann die Notwendigkeit besteht, eine
-Volume-Datei auf eine CD zu brennen.
-Es ben\"{o}tigt:
-
-\begin{itemize}
-\item Einen Web-Server der auf derselben Maschine wie Bacula l\"{a}uft
-\item Einen auf dem Bacula-Server installierten und konfigurierten CD-Rekorder
-\item Das cdr-tools-Paket muss installiert sein
-\item perl, perl-DBI Modul, und entweder das DBD-MySQL, DBD-SQLite oder DBD-PostgreSQL Modul
-\end{itemize}
-
-DVD-Brenner werden von bimagemgr zur Zeit nicht unterst\"{u}tzt, das ist aber f\"{u}r
-zuk\"{u}nftige Versionen geplant.
-
-\subsection{bimagemgr Installation}
-\index[general]{bimagemgr!Installation }
-\index[general]{bimagemgr Installation }
-
-Installation aus dem tar.gz:
-% TODO: use itemized list for this?
-1. Pr\"{u}fen und anpassen des Makefile, um es auf Ihre Computer-Konfiguration abzustimmen.
-2. Editieren der Datei config.pm ,um sie auf Ihre Konfiguration abzustimmen.
-3. F\"{u}hren Sie 'make install' als root aus.
-4. Passen Sie in Ihrer httpd.conf das Timeout an. Der Web-Server darf die Verbindung nicht schliessen,
-solange der Brennvorgang nicht abgeschlossen ist. Der ben\"{o}tigte Wert, den Sie als Timeout
-konfigurieren m\"{u}ssen, h\"{a}ngt von der Geschwindigkeit Ihres CD-Brenners ab, oder ob Sie \"{u}ber das Netzwerk brennen. In den meisten F\"{a}llen reichen 1000 Sekunden als Timeout. Den httpd neu starten.
-5. Stellen Sie sicher, dass das Kommando cdrecord als "setuid root" installiert ist.
-% TODO: I am pretty sure cdrecord can be used without setuid root
-% TODO: as long as devices are setup correctly
-
-Installation eines rpm-Paketes:
-% TODO: use itemized list for this?
-1. Installieren Sie das rpm-Paket f\"{u}r Ihre Plattform.
-2. Editieren Sie die Datei /cgi-bin/config.pm, um sie an Ihre Konfiguration abzupassen.
-3. Passen Sie in Ihrer httpd.conf das Timeout an. Der Web-Server darf die Verbindung nicht schliessen,
-solange der Brennvorgang nicht abgeschlossen ist. Der ben\"{o}tigte Wert, den Sie als Timeout
-konfigurieren m\"{u}ssen, h\"{a}ngt von der Geschwindigkeit Ihres CD-Brenners ab, oder ob Sie \"{u}ber das Netzwerk brennen. In den meisten F\"{a}llen reichen 1000 Sekunden als Timeout. Den httpd neu starten.
-4. Stellen Sie sicher, dass das Kommando cdrecord als "setuid root" installiert ist.
-
-Zugriff auf die Volume-Dateien:
-Die Volume-Dateien haben standardm\"{a}{\ss}ig die Zugriffsrechte 640 gesetzt
-und k\"{o}nnen nur von Benutzer root gelesen werden.
-Die empfohlene Methode ist die folgende (das funktioniert nur, wenn bacula und bimagemgr
-auf demselben Computer laufen wie der Web-Server):
-
-F\"{u}r Bacula-Versionen 1.34 oder 1.36 installiert aus dem tar.gz -
-% TODO: use itemized list for this?
-1. Erstellen Sie eine neu Gruppe namens bacula und f\"{u}gen Sie den Benutzer apache dieser Gruppe
-hinzu (bei RedHat und Mandrake, bei SuSE ist es der Benutzer wwwrun, bei debian www-data)
-2. \"{A}ndern Sie den Eigent\"{u}mer aller Volume-Dateien auf root.bacula.
-3. Passen Sie das Script /etc/init.d/bacula an und setzen Sie SD\_USER=root und SD\_GROUP=bacula.
-Starten Sie Bacula neu.
-
-Anmerkung: Schritt Nr. 3 sollte auch in /etc/init.d/bacula-sd gemacht werden,
-aber die Dateien aus Bacula-Versionen vor 1.36 unterst\"{u}tzen dies nicht.
-In diesem Fall kann es n\"{o}tig sein den Computer neu zu starten,
-um '/etc/bacula/bacula restart' auszuf\"{u}hren.
-
-F\"{u}r Bacula-Versionen 1.38 installiert aus dem tar.gz
-% TODO: use itemized list for this?
-1. Ihr configure-Aufruf sollte dies beinhalten:
-% TODO: fix formatting here
- --with-dir-user=bacula
- --with-dir-group=bacula
- --with-sd-user=bacula
- --with-sd-group=disk
- --with-fd-user=root
- --with-fd-group=bacula
-2. F\"{u}gen Sie den Benutzer apache der Gruppe bacula hinzu
-(bei RedHat und Mandrake, bei SuSE ist es der Benutzer wwwrun, bei debian www-data)
-3. Kontrollieren/\"{A}ndern Sie den Eigent\"{u}mer aller Volume-Dateien auf root.bacula
-
-F\"{u}r Bacul-Versionen 1.36 oder 1.38 mit rpm installiert -
-% TODO: use itemized list for this?
-1. F\"{u}gen Sie den Benutzer apache der Gruppe bacula hinzu
-(bei RedHat und Mandrake, bei SuSE ist es der Benutzer wwwrun, bei debian www-data)
-2. Kontrollieren/\"{A}ndern Sie den Eigent\"{u}mer aller Volume-Dateien auf root.bacula
-
-Wenn bimagemgr mit einem rpm-Paket Version gr\"{o}{\ss}er 1.38.9 installiert wird,
-wird der Web-Server-Benutzer automatisch der Gruppe bacula hinzugef\"{u}gt.
-Stellen Sie sicher, dass Sie die Datei config.pm nach der Installation anpassen.
-
-bimagemgr kann jetzt alle Volume-Dateien lesen, aber sie sind nicht durch alle Benutzer lesbar.
-
-Wenn Sie bimagemgr auf einen anderen Computer installieren (nicht empfohlen),
-m\"{u}ssen Sie die Zugriffsrechte aller Volume-Dateien auf 644 \"{a}ndern,
-damit Sie \"{u}ber nfs oder andere Mittel darauf zugreifen k\"{o}nnen.
-Beachten Sie, dass bei diesem Vorgehen die Volume-Dateien f\"{u}r alle Benutzer lesbar sind
-und Sie den Schutz der Dateien anders sicherstellen.
-
-\subsection{bimagemgr Benutzung}
-\index[general]{bimagemgr!Benutzung }
-\index[general]{bimagemgr Benutzung }
-
-Rufen Sie das Programm mit Ihrem Web-Browser auf, z.B. {\tt http://localhost/cgi-bin/bimagemgr.pl},
-dann sollten Sie eine Darstellung \"{a}hnlich der unten im Bild 1 abgebildeten sehen.
-% TODO: use tex to say figure number
-Das Programm wird die Bacula-Datenbank abfragen und alle Volume-Dateien mit dem Datum
-des letzten Schreibvorgangs und dem Zeitpunkt darstellen, wo das Volume zum letzten
-Mal auf CD gebrannt wurde. Wenn ein Volume auf CD gebrannt werden muss (letzter Schreibvorgang
-ist neuer als der letzte Brennvorgang), wird ein "Brennen"-Knopf in der rechten Spalte angezeigt.
-
-\addcontentsline{lof}{figure}{Bacula CD Image Manager}
-\includegraphics{\idir bimagemgr1.eps} \\Figure 1
-% TODO: use tex to say figure number
-
-Legen Sie eine leere CD in Ihren CD-Brenner und klicken Sie auf den "Brennen"-Knopf.
-Dann \"{o}ffnet sich ein PopUp-Fenster, wie im Bild 2, das den Brennvorgang anzeigt.
-% TODO: use tex to say figure number
-
-\addcontentsline{lof}{figure}{Bacula CD Image Brennfortschritt-Fenster}
-\includegraphics{\idir bimagemgr2.eps} \\Figure 2
-% TODO: use tex to say figure number
-
-Wenn der Brennvorgang abgeschlo{\ss}en ist, zeigt das PopUp-Fenster die Ausgaben von cdrecord
-an (siehe Bild 3).
-% TODO: use tex to say figure number
-Schlie{\ss}en Sie das PopUp-Fenster und laden Sie die Hauptseite neu.
-Das Datum des letzten Brennvorgangs wird aktualisiert und der "Brennen"-Knopf verschwindet.
-Sollte das Brennen fehlgeschlagen sein, k\"{o}nnen Sie das Datum des letzten Brennvorgangs
-zur\"{u}cksetzen, indem Sie auf den Link "Reset" des Volumes klicken.
-
-\addcontentsline{lof}{figure}{Bacula CD Image Brennergebnis}
-\includegraphics{\idir bimagemgr3.eps} \\Figure 3
-% TODO: use tex to say figure number
-
-In der untersten Zeile des Hauptfensters sind zwei weitere Kn\"{o}pfe,
-mit "Burn Catalog" und "Blank CDRW" beschriftet.
-"Burn Catalog" schreibt eine Kopie Ihrer Katalog-Datenbank auf eine CD.
-Falls Sie CDRW-Medien benutzen, k\"{o}nnen Sie mit "Blank CDRW" ein Medium l\"{o}schen
-bevor Sie es wiederverwenden.
-Regelm\"{a}ssiges speichern Ihrer Volume-Dateien und Ihrer Katalog-Datenbank mit bimagemgr auf CD's
-stellt sicher, dass Sie jederzeit im Falle eines Datenverlustes auf Ihrem Bacula-Server
-diesen einfach wiederherstellen k\"{o}nnen.
+++ /dev/null
-#!/usr/bin/perl -w
-# Finds potential problems in tex files, and issues warnings to the console
-# about what it finds. Takes a list of files as its only arguments,
-# and does checks on all the files listed. The assumption is that these are
-# valid (or close to valid) LaTeX files. It follows \include statements
-# recursively to pick up any included tex files.
-#
-#
-#
-# Currently the following checks are made:
-#
-# -- Multiple hyphens not inside a verbatim environment (or \verb). These
-# should be placed inside a \verb{} contruct so they will not be converted
-# to single hyphen by latex and latex2html.
-
-
-# Original creation 3-8-05 by Karl Cunningham karlc -at- keckec -dot- com
-#
-#
-
-use strict;
-
-# The following builds the test string to identify and change multiple
-# hyphens in the tex files. Several constructs are identified but only
-# multiple hyphens are changed; the others are fed to the output
-# unchanged.
-my $b = '\\\\begin\\*?\\s*\\{\\s*'; # \begin{
-my $e = '\\\\end\\*?\\s*\\{\\s*'; # \end{
-my $c = '\\s*\\}'; # closing curly brace
-
-# This captures entire verbatim environments. These are passed to the output
-# file unchanged.
-my $verbatimenv = $b . "verbatim" . $c . ".*?" . $e . "verbatim" . $c;
-
-# This captures \verb{..{ constructs. They are passed to the output unchanged.
-my $verb = '\\\\verb\\*?(.).*?\\1';
-
-# This captures multiple hyphens with a leading and trailing space. These are not changed.
-my $hyphsp = '\\s\\-{2,}\\s';
-
-# This identifies other multiple hyphens.
-my $hyphens = '\\-{2,}';
-
-# This identifies \hyperpage{..} commands, which should be ignored.
-my $hyperpage = '\\\\hyperpage\\*?\\{.*?\\}';
-
-# This builds the actual test string from the above strings.
-#my $teststr = "$verbatimenv|$verb|$tocentry|$hyphens";
-my $teststr = "$verbatimenv|$verb|$hyphsp|$hyperpage|$hyphens";
-
-
-sub get_includes {
- # Get a list of include files from the top-level tex file. The first
- # argument is a pointer to the list of files found. The rest of the
- # arguments is a list of filenames to check for includes.
- my $files = shift;
- my ($fileline,$includefile,$includes);
-
- while (my $filename = shift) {
- # Get a list of all the html files in the directory.
- open my $if,"<$filename" or die "Cannot open input file $filename\n";
- $fileline = 0;
- $includes = 0;
- while (<$if>) {
- chomp;
- $fileline++;
- # If a file is found in an include, process it.
- if (($includefile) = /\\include\s*\{(.*?)\}/) {
- $includes++;
- # Append .tex to the filename
- $includefile .= '.tex';
-
- # If the include file has already been processed, issue a warning
- # and don't do it again.
- my $found = 0;
- foreach (@$files) {
- if ($_ eq $includefile) {
- $found = 1;
- last;
- }
- }
- if ($found) {
- print "$includefile found at line $fileline in $filename was previously included\n";
- } else {
- # The file has not been previously found. Save it and
- # recursively process it.
- push (@$files,$includefile);
- get_includes($files,$includefile);
- }
- }
- }
- close IF;
- }
-}
-
-
-sub check_hyphens {
- my (@files) = @_;
- my ($filedata,$this,$linecnt,$before);
-
- # Build the test string to check for the various environments.
- # We only do the conversion if the multiple hyphens are outside of a
- # verbatim environment (either \begin{verbatim}...\end{verbatim} or
- # \verb{--}). Capture those environments and pass them to the output
- # unchanged.
-
- foreach my $file (@files) {
- # Open the file and load the whole thing into $filedata. A bit wasteful but
- # easier to deal with, and we don't have a problem with speed here.
- $filedata = "";
- open IF,"<$file" or die "Cannot open input file $file";
- while (<IF>) {
- $filedata .= $_;
- }
- close IF;
-
- # Set up to process the file data.
- $linecnt = 1;
-
- # Go through the file data from beginning to end. For each match, save what
- # came before it and what matched. $filedata now becomes only what came
- # after the match.
- # Chech the match to see if it starts with a multiple-hyphen. If so
- # warn the user. Keep track of line numbers so they can be output
- # with the warning message.
- while ($filedata =~ /$teststr/os) {
- $this = $&;
- $before = $`;
- $filedata = $';
- $linecnt += $before =~ tr/\n/\n/;
-
- # Check if the multiple hyphen is present outside of one of the
- # acceptable constructs.
- if ($this =~ /^\-+/) {
- print "Possible unwanted multiple hyphen found in line ",
- "$linecnt of file $file\n";
- }
- $linecnt += $this =~ tr/\n/\n/;
- }
- }
-}
-##################################################################
-# MAIN ####
-##################################################################
-
-my (@includes,$cnt);
-
-# Examine the file pointed to by the first argument to get a list of
-# includes to test.
-get_includes(\@includes,@ARGV);
-
-check_hyphens(@includes);
+++ /dev/null
-#
-# Avoid that @VERSION@ and @DATE@ are changed by configure
-# This file is sourced by update_version
-#
-echo "s%@VERSION@%${VERSION}%g" >${out}
-echo "s%@DATE@%${DATE}%g" >>${out}
+++ /dev/null
-% TODO: maybe get rid of centering
-
-\chapter{GNU Free Documentation License}
-\index[general]{GNU Free Documentation License}
-\index[general]{License!GNU Free Documentation}
-
-\label{label_fdl}
-
- \begin{center}
-
- Version 1.2, November 2002
-
-
- Copyright \copyright 2000,2001,2002 Free Software Foundation, Inc.
-
- \bigskip
-
- 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-
- \bigskip
-
- Everyone is permitted to copy and distribute verbatim copies
- of this license document, but changing it is not allowed.
-\end{center}
-
-
-\begin{center}
-{\bf\large Preamble}
-\end{center}
-
-The purpose of this License is to make a manual, textbook, or other
-functional and useful document "free" in the sense of freedom: to
-assure everyone the effective freedom to copy and redistribute it,
-with or without modifying it, either commercially or noncommercially.
-Secondarily, this License preserves for the author and publisher a way
-to get credit for their work, while not being considered responsible
-for modifications made by others.
-
-This License is a kind of "copyleft", which means that derivative
-works of the document must themselves be free in the same sense. It
-complements the GNU General Public License, which is a copyleft
-license designed for free software.
-
-We have designed this License in order to use it for manuals for free
-software, because free software needs free documentation: a free
-program should come with manuals providing the same freedoms that the
-software does. But this License is not limited to software manuals;
-it can be used for any textual work, regardless of subject matter or
-whether it is published as a printed book. We recommend this License
-principally for works whose purpose is instruction or reference.
-
-
-\begin{center}
-{\Large\bf 1. APPLICABILITY AND DEFINITIONS}
-\end{center}
-
-This License applies to any manual or other work, in any medium, that
-contains a notice placed by the copyright holder saying it can be
-distributed under the terms of this License. Such a notice grants a
-world-wide, royalty-free license, unlimited in duration, to use that
-work under the conditions stated herein. The \textbf{"Document"}, below,
-refers to any such manual or work. Any member of the public is a
-licensee, and is addressed as \textbf{"you"}. You accept the license if you
-copy, modify or distribute the work in a way requiring permission
-under copyright law.
-
-A \textbf{"Modified Version"} of the Document means any work containing the
-Document or a portion of it, either copied verbatim, or with
-modifications and/or translated into another language.
-
-A \textbf{"Secondary Section"} is a named appendix or a front-matter section of
-the Document that deals exclusively with the relationship of the
-publishers or authors of the Document to the Document's overall subject
-(or to related matters) and contains nothing that could fall directly
-within that overall subject. (Thus, if the Document is in part a
-textbook of mathematics, a Secondary Section may not explain any
-mathematics.) The relationship could be a matter of historical
-connection with the subject or with related matters, or of legal,
-commercial, philosophical, ethical or political position regarding
-them.
-
-The \textbf{"Invariant Sections"} are certain Secondary Sections whose titles
-are designated, as being those of Invariant Sections, in the notice
-that says that the Document is released under this License. If a
-section does not fit the above definition of Secondary then it is not
-allowed to be designated as Invariant. The Document may contain zero
-Invariant Sections. If the Document does not identify any Invariant
-Sections then there are none.
-
-The \textbf{"Cover Texts"} are certain short passages of text that are listed,
-as Front-Cover Texts or Back-Cover Texts, in the notice that says that
-the Document is released under this License. A Front-Cover Text may
-be at most 5 words, and a Back-Cover Text may be at most 25 words.
-
-A \textbf{"Transparent"} copy of the Document means a machine-readable copy,
-represented in a format whose specification is available to the
-general public, that is suitable for revising the document
-straightforwardly with generic text editors or (for images composed of
-pixels) generic paint programs or (for drawings) some widely available
-drawing editor, and that is suitable for input to text formatters or
-for automatic translation to a variety of formats suitable for input
-to text formatters. A copy made in an otherwise Transparent file
-format whose markup, or absence of markup, has been arranged to thwart
-or discourage subsequent modification by readers is not Transparent.
-An image format is not Transparent if used for any substantial amount
-of text. A copy that is not "Transparent" is called \textbf{"Opaque"}.
-
-Examples of suitable formats for Transparent copies include plain
-ASCII without markup, Texinfo input format, LaTeX input format, SGML
-or XML using a publicly available DTD, and standard-conforming simple
-HTML, PostScript or PDF designed for human modification. Examples of
-transparent image formats include PNG, XCF and JPG. Opaque formats
-include proprietary formats that can be read and edited only by
-proprietary word processors, SGML or XML for which the DTD and/or
-processing tools are not generally available, and the
-machine-generated HTML, PostScript or PDF produced by some word
-processors for output purposes only.
-
-The \textbf{"Title Page"} means, for a printed book, the title page itself,
-plus such following pages as are needed to hold, legibly, the material
-this License requires to appear in the title page. For works in
-formats which do not have any title page as such, "Title Page" means
-the text near the most prominent appearance of the work's title,
-preceding the beginning of the body of the text.
-
-A section \textbf{"Entitled XYZ"} means a named subunit of the Document whose
-title either is precisely XYZ or contains XYZ in parentheses following
-text that translates XYZ in another language. (Here XYZ stands for a
-specific section name mentioned below, such as \textbf{"Acknowledgements"},
-\textbf{"Dedications"}, \textbf{"Endorsements"}, or \textbf{"History"}.)
-To \textbf{"Preserve the Title"}
-of such a section when you modify the Document means that it remains a
-section "Entitled XYZ" according to this definition.
-
-The Document may include Warranty Disclaimers next to the notice which
-states that this License applies to the Document. These Warranty
-Disclaimers are considered to be included by reference in this
-License, but only as regards disclaiming warranties: any other
-implication that these Warranty Disclaimers may have is void and has
-no effect on the meaning of this License.
-
-
-\begin{center}
-{\Large\bf 2. VERBATIM COPYING}
-\end{center}
-
-You may copy and distribute the Document in any medium, either
-commercially or noncommercially, provided that this License, the
-copyright notices, and the license notice saying this License applies
-to the Document are reproduced in all copies, and that you add no other
-conditions whatsoever to those of this License. You may not use
-technical measures to obstruct or control the reading or further
-copying of the copies you make or distribute. However, you may accept
-compensation in exchange for copies. If you distribute a large enough
-number of copies you must also follow the conditions in section 3.
-
-You may also lend copies, under the same conditions stated above, and
-you may publicly display copies.
-
-
-\begin{center}
-{\Large\bf 3. COPYING IN QUANTITY}
-\end{center}
-
-
-If you publish printed copies (or copies in media that commonly have
-printed covers) of the Document, numbering more than 100, and the
-Document's license notice requires Cover Texts, you must enclose the
-copies in covers that carry, clearly and legibly, all these Cover
-Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
-the back cover. Both covers must also clearly and legibly identify
-you as the publisher of these copies. The front cover must present
-the full title with all words of the title equally prominent and
-visible. You may add other material on the covers in addition.
-Copying with changes limited to the covers, as long as they preserve
-the title of the Document and satisfy these conditions, can be treated
-as verbatim copying in other respects.
-
-If the required texts for either cover are too voluminous to fit
-legibly, you should put the first ones listed (as many as fit
-reasonably) on the actual cover, and continue the rest onto adjacent
-pages.
-
-If you publish or distribute Opaque copies of the Document numbering
-more than 100, you must either include a machine-readable Transparent
-copy along with each Opaque copy, or state in or with each Opaque copy
-a computer-network location from which the general network-using
-public has access to download using public-standard network protocols
-a complete Transparent copy of the Document, free of added material.
-If you use the latter option, you must take reasonably prudent steps,
-when you begin distribution of Opaque copies in quantity, to ensure
-that this Transparent copy will remain thus accessible at the stated
-location until at least one year after the last time you distribute an
-Opaque copy (directly or through your agents or retailers) of that
-edition to the public.
-
-It is requested, but not required, that you contact the authors of the
-Document well before redistributing any large number of copies, to give
-them a chance to provide you with an updated version of the Document.
-
-
-\begin{center}
-{\Large\bf 4. MODIFICATIONS}
-\end{center}
-
-You may copy and distribute a Modified Version of the Document under
-the conditions of sections 2 and 3 above, provided that you release
-the Modified Version under precisely this License, with the Modified
-Version filling the role of the Document, thus licensing distribution
-and modification of the Modified Version to whoever possesses a copy
-of it. In addition, you must do these things in the Modified Version:
-
-\begin{itemize}
-\item[A.]
- Use in the Title Page (and on the covers, if any) a title distinct
- from that of the Document, and from those of previous versions
- (which should, if there were any, be listed in the History section
- of the Document). You may use the same title as a previous version
- if the original publisher of that version gives permission.
-
-\item[B.]
- List on the Title Page, as authors, one or more persons or entities
- responsible for authorship of the modifications in the Modified
- Version, together with at least five of the principal authors of the
- Document (all of its principal authors, if it has fewer than five),
- unless they release you from this requirement.
-
-\item[C.]
- State on the Title page the name of the publisher of the
- Modified Version, as the publisher.
-
-\item[D.]
- Preserve all the copyright notices of the Document.
-
-\item[E.]
- Add an appropriate copyright notice for your modifications
- adjacent to the other copyright notices.
-
-\item[F.]
- Include, immediately after the copyright notices, a license notice
- giving the public permission to use the Modified Version under the
- terms of this License, in the form shown in the Addendum below.
-
-\item[G.]
- Preserve in that license notice the full lists of Invariant Sections
- and required Cover Texts given in the Document's license notice.
-
-\item[H.]
- Include an unaltered copy of this License.
-
-\item[I.]
- Preserve the section Entitled "History", Preserve its Title, and add
- to it an item stating at least the title, year, new authors, and
- publisher of the Modified Version as given on the Title Page. If
- there is no section Entitled "History" in the Document, create one
- stating the title, year, authors, and publisher of the Document as
- given on its Title Page, then add an item describing the Modified
- Version as stated in the previous sentence.
-
-\item[J.]
- Preserve the network location, if any, given in the Document for
- public access to a Transparent copy of the Document, and likewise
- the network locations given in the Document for previous versions
- it was based on. These may be placed in the "History" section.
- You may omit a network location for a work that was published at
- least four years before the Document itself, or if the original
- publisher of the version it refers to gives permission.
-
-\item[K.]
- For any section Entitled "Acknowledgements" or "Dedications",
- Preserve the Title of the section, and preserve in the section all
- the substance and tone of each of the contributor acknowledgements
- and/or dedications given therein.
-
-\item[L.]
- Preserve all the Invariant Sections of the Document,
- unaltered in their text and in their titles. Section numbers
- or the equivalent are not considered part of the section titles.
-
-\item[M.]
- Delete any section Entitled "Endorsements". Such a section
- may not be included in the Modified Version.
-
-\item[N.]
- Do not retitle any existing section to be Entitled "Endorsements"
- or to conflict in title with any Invariant Section.
-
-\item[O.]
- Preserve any Warranty Disclaimers.
-\end{itemize}
-
-If the Modified Version includes new front-matter sections or
-appendices that qualify as Secondary Sections and contain no material
-copied from the Document, you may at your option designate some or all
-of these sections as invariant. To do this, add their titles to the
-list of Invariant Sections in the Modified Version's license notice.
-These titles must be distinct from any other section titles.
-
-You may add a section Entitled "Endorsements", provided it contains
-nothing but endorsements of your Modified Version by various
-parties--for example, statements of peer review or that the text has
-been approved by an organization as the authoritative definition of a
-standard.
-
-You may add a passage of up to five words as a Front-Cover Text, and a
-passage of up to 25 words as a Back-Cover Text, to the end of the list
-of Cover Texts in the Modified Version. Only one passage of
-Front-Cover Text and one of Back-Cover Text may be added by (or
-through arrangements made by) any one entity. If the Document already
-includes a cover text for the same cover, previously added by you or
-by arrangement made by the same entity you are acting on behalf of,
-you may not add another; but you may replace the old one, on explicit
-permission from the previous publisher that added the old one.
-
-The author(s) and publisher(s) of the Document do not by this License
-give permission to use their names for publicity for or to assert or
-imply endorsement of any Modified Version.
-
-
-\begin{center}
-{\Large\bf 5. COMBINING DOCUMENTS}
-\end{center}
-
-
-You may combine the Document with other documents released under this
-License, under the terms defined in section 4 above for modified
-versions, provided that you include in the combination all of the
-Invariant Sections of all of the original documents, unmodified, and
-list them all as Invariant Sections of your combined work in its
-license notice, and that you preserve all their Warranty Disclaimers.
-
-The combined work need only contain one copy of this License, and
-multiple identical Invariant Sections may be replaced with a single
-copy. If there are multiple Invariant Sections with the same name but
-different contents, make the title of each such section unique by
-adding at the end of it, in parentheses, the name of the original
-author or publisher of that section if known, or else a unique number.
-Make the same adjustment to the section titles in the list of
-Invariant Sections in the license notice of the combined work.
-
-In the combination, you must combine any sections Entitled "History"
-in the various original documents, forming one section Entitled
-"History"; likewise combine any sections Entitled "Acknowledgements",
-and any sections Entitled "Dedications". You must delete all sections
-Entitled "Endorsements".
-
-\begin{center}
-{\Large\bf 6. COLLECTIONS OF DOCUMENTS}
-\end{center}
-
-You may make a collection consisting of the Document and other documents
-released under this License, and replace the individual copies of this
-License in the various documents with a single copy that is included in
-the collection, provided that you follow the rules of this License for
-verbatim copying of each of the documents in all other respects.
-
-You may extract a single document from such a collection, and distribute
-it individually under this License, provided you insert a copy of this
-License into the extracted document, and follow this License in all
-other respects regarding verbatim copying of that document.
-
-
-\begin{center}
-{\Large\bf 7. AGGREGATION WITH INDEPENDENT WORKS}
-\end{center}
-
-
-A compilation of the Document or its derivatives with other separate
-and independent documents or works, in or on a volume of a storage or
-distribution medium, is called an "aggregate" if the copyright
-resulting from the compilation is not used to limit the legal rights
-of the compilation's users beyond what the individual works permit.
-When the Document is included in an aggregate, this License does not
-apply to the other works in the aggregate which are not themselves
-derivative works of the Document.
-
-If the Cover Text requirement of section 3 is applicable to these
-copies of the Document, then if the Document is less than one half of
-the entire aggregate, the Document's Cover Texts may be placed on
-covers that bracket the Document within the aggregate, or the
-electronic equivalent of covers if the Document is in electronic form.
-Otherwise they must appear on printed covers that bracket the whole
-aggregate.
-
-
-\begin{center}
-{\Large\bf 8. TRANSLATION}
-\end{center}
-
-
-Translation is considered a kind of modification, so you may
-distribute translations of the Document under the terms of section 4.
-Replacing Invariant Sections with translations requires special
-permission from their copyright holders, but you may include
-translations of some or all Invariant Sections in addition to the
-original versions of these Invariant Sections. You may include a
-translation of this License, and all the license notices in the
-Document, and any Warranty Disclaimers, provided that you also include
-the original English version of this License and the original versions
-of those notices and disclaimers. In case of a disagreement between
-the translation and the original version of this License or a notice
-or disclaimer, the original version will prevail.
-
-If a section in the Document is Entitled "Acknowledgements",
-"Dedications", or "History", the requirement (section 4) to Preserve
-its Title (section 1) will typically require changing the actual
-title.
-
-
-\begin{center}
-{\Large\bf 9. TERMINATION}
-\end{center}
-
-
-You may not copy, modify, sublicense, or distribute the Document except
-as expressly provided for under this License. Any other attempt to
-copy, modify, sublicense or distribute the Document is void, and will
-automatically terminate your rights under this License. However,
-parties who have received copies, or rights, from you under this
-License will not have their licenses terminated so long as such
-parties remain in full compliance.
-
-
-\begin{center}
-{\Large\bf 10. FUTURE REVISIONS OF THIS LICENSE}
-\end{center}
-
-
-The Free Software Foundation may publish new, revised versions
-of the GNU Free Documentation License from time to time. Such new
-versions will be similar in spirit to the present version, but may
-differ in detail to address new problems or concerns. See
-http://www.gnu.org/copyleft/.
-
-Each version of the License is given a distinguishing version number.
-If the Document specifies that a particular numbered version of this
-License "or any later version" applies to it, you have the option of
-following the terms and conditions either of that specified version or
-of any later version that has been published (not as a draft) by the
-Free Software Foundation. If the Document does not specify a version
-number of this License, you may choose any version ever published (not
-as a draft) by the Free Software Foundation.
-
-
-\begin{center}
-{\Large\bf ADDENDUM: How to use this License for your documents}
-% TODO: this is too long for table of contents
-\end{center}
-
-To use this License in a document you have written, include a copy of
-the License in the document and put the following copyright and
-license notices just after the title page:
-
-\bigskip
-\begin{quote}
- Copyright \copyright YEAR YOUR NAME.
- Permission is granted to copy, distribute and/or modify this document
- under the terms of the GNU Free Documentation License, Version 1.2
- or any later version published by the Free Software Foundation;
- with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
- A copy of the license is included in the section entitled "GNU
- Free Documentation License".
-\end{quote}
-\bigskip
-
-If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts,
-replace the "with...Texts." line with this:
-
-\bigskip
-\begin{quote}
- with the Invariant Sections being LIST THEIR TITLES, with the
- Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST.
-\end{quote}
-\bigskip
-
-If you have Invariant Sections without Cover Texts, or some other
-combination of the three, merge those two alternatives to suit the
-situation.
-
-If your document contains nontrivial examples of program code, we
-recommend releasing these examples in parallel under your choice of
-free software license, such as the GNU General Public License,
-to permit their use in free software.
-
-%---------------------------------------------------------------------
+++ /dev/null
-#!/usr/bin/perl -w
-# Fixes various things within tex files.
-
-use strict;
-
-my %args;
-
-
-sub get_includes {
- # Get a list of include files from the top-level tex file.
- my (@list,$file);
-
- foreach my $filename (@_) {
- $filename or next;
- # Start with the top-level latex file so it gets checked too.
- push (@list,$filename);
-
- # Get a list of all the html files in the directory.
- open IF,"<$filename" or die "Cannot open input file $filename";
- while (<IF>) {
- chomp;
- push @list,"$1.tex" if (/\\include\{(.*?)\}/);
- }
-
- close IF;
- }
- return @list;
-}
-
-sub convert_files {
- my (@files) = @_;
- my ($linecnt,$filedata,$output,$itemcnt,$indentcnt,$cnt);
-
- $cnt = 0;
- foreach my $file (@files) {
- # Open the file and load the whole thing into $filedata. A bit wasteful but
- # easier to deal with, and we don't have a problem with speed here.
- $filedata = "";
- open IF,"<$file" or die "Cannot open input file $file";
- while (<IF>) {
- $filedata .= $_;
- }
- close IF;
-
- # We look for a line that starts with \item, and indent the two next lines (if not blank)
- # by three spaces.
- my $linecnt = 3;
- $indentcnt = 0;
- $output = "";
- # Process a line at a time.
- foreach (split(/\n/,$filedata)) {
- $_ .= "\n"; # Put back the return.
- # If this line is less than the third line past the \item command,
- # and the line isn't blank and doesn't start with whitespace
- # add three spaces to the start of the line. Keep track of the number
- # of lines changed.
- if ($linecnt < 3 and !/^\\item/) {
- if (/^[^\n\s]/) {
- $output .= " " . $_;
- $indentcnt++;
- } else {
- $output .= $_;
- }
- $linecnt++;
- } else {
- $linecnt = 3;
- $output .= $_;
- }
- /^\\item / and $linecnt = 1;
- }
-
-
- # This is an item line. We need to process it too. If inside a \begin{description} environment, convert
- # \item {\bf xxx} to \item [xxx] or \item [{xxx}] (if xxx contains '[' or ']'.
- $itemcnt = 0;
- $filedata = $output;
- $output = "";
- my ($before,$descrip,$this,$between);
-
- # Find any \begin{description} environment
- while ($filedata =~ /(\\begin[\s\n]*\{[\s\n]*description[\s\n]*\})(.*?)(\\end[\s\n]*\{[\s\n]*description[\s\n]*\})/s) {
- $output .= $` . $1;
- $filedata = $3 . $';
- $descrip = $2;
-
- # Search for \item {\bf xxx}
- while ($descrip =~ /\\item[\s\n]*\{[\s\n]*\\bf[\s\n]*/s) {
- $descrip = $';
- $output .= $`;
- ($between,$descrip) = find_matching_brace($descrip);
- if (!$descrip) {
- $linecnt = $output =~ tr/\n/\n/;
- print STDERR "Missing matching curly brace at line $linecnt in $file\n" if (!$descrip);
- }
-
- # Now do the replacement.
- $between = '{' . $between . '}' if ($between =~ /\[|\]/);
- $output .= "\\item \[$between\]";
- $itemcnt++;
- }
- $output .= $descrip;
- }
- $output .= $filedata;
-
- # If any hyphens or \item commnads were converted, save the file.
- if ($indentcnt or $itemcnt) {
- open OF,">$file" or die "Cannot open output file $file";
- print OF $output;
- close OF;
- print "$indentcnt indent", ($indentcnt == 1) ? "" : "s"," added in $file\n";
- print "$itemcnt item", ($itemcnt == 1) ? "" : "s"," Changed in $file\n";
- }
-
- $cnt += $indentcnt + $itemcnt;
- }
- return $cnt;
-}
-
-sub find_matching_brace {
- # Finds text up to the next matching brace. Assumes that the input text doesn't contain
- # the opening brace, but we want to find text up to a matching closing one.
- # Returns the text between the matching braces, followed by the rest of the text following
- # (which does not include the matching brace).
- #
- my $str = shift;
- my ($this,$temp);
- my $cnt = 1;
-
- while ($cnt) {
- # Ignore verbatim constructs involving curly braces, or if the character preceding
- # the curly brace is a backslash.
- if ($str =~ /\\verb\*?\{.*?\{|\\verb\*?\}.*?\}|\{|\}/s) {
- $this .= $`;
- $str = $';
- $temp = $&;
-
- if ((substr($this,-1,1) eq '\\') or
- $temp =~ /^\\verb/) {
- $this .= $temp;
- next;
- }
-
- $cnt += ($temp eq '{') ? 1 : -1;
- # If this isn't the matching curly brace ($cnt > 0), include the brace.
- $this .= $temp if ($cnt);
- } else {
- # No matching curly brace found.
- return ($this . $str,'');
- }
- }
- return ($this,$str);
-}
-
-sub check_arguments {
- # Checks command-line arguments for ones starting with -- puts them into
- # a hash called %args and removes them from @ARGV.
- my $args = shift;
- my $i;
-
- for ($i = 0; $i < $#ARGV; $i++) {
- $ARGV[$i] =~ /^\-+/ or next;
- $ARGV[$i] =~ s/^\-+//;
- $args{$ARGV[$i]} = "";
- delete ($ARGV[$i]);
-
- }
-}
-
-##################################################################
-# MAIN ####
-##################################################################
-
-my @includes;
-my $cnt;
-
-check_arguments(\%args);
-die "No Files given to Check\n" if ($#ARGV < 0);
-
-# Examine the file pointed to by the first argument to get a list of
-# includes to test.
-@includes = get_includes(@ARGV);
-
-$cnt = convert_files(@includes);
-print "No lines changed\n" unless $cnt;
+++ /dev/null
-# This module does multiple indices, supporting the style of the LaTex 'index'
-# package.
-
-# Version Information:
-# 16-Feb-2005 -- Original Creation. Karl E. Cunningham
-# 14-Mar-2005 -- Clarified and Consolodated some of the code.
-# Changed to smoothly handle single and multiple indices.
-
-# Two LaTeX index formats are supported...
-# --- SINGLE INDEX ---
-# \usepackage{makeidx}
-# \makeindex
-# \index{entry1}
-# \index{entry2}
-# \index{entry3}
-# ...
-# \printindex
-#
-# --- MULTIPLE INDICES ---
-#
-# \usepackage{makeidx}
-# \usepackage{index}
-# \makeindex -- latex2html doesn't care but LaTeX does.
-# \newindex{ref1}{ext1}{ext2}{title1}
-# \newindex{ref2}{ext1}{ext2}{title2}
-# \newindex{ref3}{ext1}{ext2}{title3}
-# \index[ref1]{entry1}
-# \index[ref1]{entry2}
-# \index[ref3]{entry3}
-# \index[ref2]{entry4}
-# \index{entry5}
-# \index[ref3]{entry6}
-# ...
-# \printindex[ref1]
-# \printindex[ref2]
-# \printindex[ref3]
-# \printindex
-# ___________________
-#
-# For the multiple-index style, each index is identified by the ref argument to \newindex, \index,
-# and \printindex. A default index is allowed, which is indicated by omitting the optional
-# argument. The default index does not require a \newindex command. As \index commands
-# are encountered, their entries are stored according
-# to the ref argument. When the \printindex command is encountered, the stored index
-# entries for that argument are retrieved and printed. The title for each index is taken
-# from the last argument in the \newindex command.
-# While processing \index and \printindex commands, if no argument is given the index entries
-# are built into a default index. The title of the default index is simply "Index".
-# This makes the difference between single- and multiple-index processing trivial.
-#
-# Another method can be used by omitting the \printindex command and just using \include to
-# pull in index files created by the makeindex program. These files will start with
-# \begin{theindex}. This command is used to determine where to print the index. Using this
-# approach, the indices will be output in the same order as the newindex commands were
-# originally found (see below). Using a combination of \printindex and \include{indexfile} has not
-# been tested and may produce undesireable results.
-#
-# The index data are stored in a hash for later sorting and output. As \printindex
-# commands are handled, the order in which they were found in the tex filea is saved,
-# associated with the ref argument to \printindex.
-#
-# We use the original %index hash to store the index data into. We append a \002 followed by the
-# name of the index to isolate the entries in different indices from each other. This is necessary
-# so that different indices can have entries with the same name. For the default index, the \002 is
-# appended without the name.
-#
-# Since the index order in the output cannot be determined if the \include{indexfile}
-# command is used, the order will be assumed from the order in which the \newindex
-# commands were originally seen in the TeX files. This order is saved as well as the
-# order determined from any printindex{ref} commands. If \printindex commnads are used
-# to specify the index output, that order will be used. If the \include{idxfile} command
-# is used, the order of the original newindex commands will be used. In this case the
-# default index will be printed last since it doesn't have a corresponding \newindex
-# command and its order cannot be determined. Mixing \printindex and \include{idxfile}
-# commands in the same file is likely to produce less than satisfactory results.
-#
-#
-# The hash containing index data is named %indices. It contains the following data:
-#{
-# 'title' => {
-# $ref1 => $indextitle ,
-# $ref2 => $indextitle ,
-# ...
-# },
-# 'newcmdorder' => [ ref1, ref2, ..., * ], # asterisk indicates the position of the default index.
-# 'printindorder' => [ ref1, ref2, ..., * ], # asterisk indicates the position of the default index.
-#}
-
-
-# Globals to handle multiple indices.
-my %indices;
-
-# This tells the system to use up to 7 words in index entries.
-$WORDS_IN_INDEX = 10;
-
-# KEC 2-18-05
-# Handles the \newindex command. This is called if the \newindex command is
-# encountered in the LaTex source. Gets the index ref and title from the arguments.
-# Saves the index ref and title.
-# Note that we are called once to handle multiple \newindex commands that are
-# newline-separated.
-sub do_cmd_newindex {
- my $data = shift;
- # The data is sent to us as fields delimited by their ID #'s. We extract the
- # fields.
- foreach my $line (split("\n",$data)) {
- my @fields = split (/(?:\<\#\d+?\#\>)+/,$line);
-
- # The index name and title are the second and fourth fields in the data.
- if ($line =~ /^</ or $line =~ /^\\newindex/) {
- my ($indexref,$indextitle) = ($fields[1],$fields[4]);
- $indices{'title'}{$indexref} = $indextitle;
- push (@{$indices{'newcmdorder'}},$indexref);
- }
- }
-}
-
-
-# KEC -- Copied from makeidx.perl and modified to do multiple indices.
-# Processes an \index entry from the LaTex file.
-# Gets the optional argument from the index command, which is the name of the index
-# into which to place the entry.
-# Drops the brackets from the index_name
-# Puts the index entry into the html stream
-# Creates the tokenized index entry (which also saves the index entry info
-sub do_real_index {
- local($_) = @_;
- local($pat,$idx_entry,$index_name);
- # catches opt-arg from \index commands for index.sty
- $index_name = &get_next_optional_argument;
- $index_name = "" unless defined $index_name;
- # Drop leading and trailing brackets from the index name.
- $index_name =~ s/^\[|\]$//g;
-
- $idx_entry = &missing_braces unless (
- (s/$next_pair_pr_rx/$pat=$1;$idx_entry=$2;''/e)
- ||(s/$next_pair_rx/$pat=$1;$idx_entry=$2;''/e));
-
- if ($index_name and defined $idx_entry and
- !defined $indices{'title'}{$index_name}) {
- print STDERR "\nInvalid Index Name: \\index \[$index_name\]\{$idx_entry\}\n";
- }
-
- $idx_entry = &named_index_entry($pat, $idx_entry,$index_name);
- $idx_entry.$_;
-}
-
-# Creates and saves an index entry in the index hashes.
-# Modified to do multiple indices.
-# Creates an index_key that allows index entries to have the same characteristics but be in
-# different indices. This index_key is the regular key with the index name appended.
-# Save the index order for the entry in the %index_order hash.
-sub named_index_entry {
- local($br_id, $str, $index_name) = @_;
- my ($index_key);
- # escape the quoting etc characters
- # ! -> \001
- # @ -> \002
- # | -> \003
- $* = 1; $str =~ s/\n\s*/ /g; $* = 0; # remove any newlines
- # protect \001 occurring with images
- $str =~ s/\001/\016/g; # 0x1 to 0xF
- $str =~ s/\\\\/\011/g; # Double backslash -> 0xB
- $str =~ s/\\;SPMquot;/\012/g; # \;SPMquot; -> 0xC
- $str =~ s/;SPMquot;!/\013/g; # ;SPMquot; -> 0xD
- $str =~ s/!/\001/g; # Exclamation point -> 0x1
- $str =~ s/\013/!/g; # 0xD -> Exclaimation point
- $str =~ s/;SPMquot;@/\015/g; # ;SPMquot;@ to 0xF
- $str =~ s/@/\002/g; # At sign -> 0x2
- $str =~ s/\015/@/g; # 0xF to At sign
- $str =~ s/;SPMquot;\|/\017/g; # ;SMPquot;| to 0x11
- $str =~ s/\|/\003/g; # Vertical line to 0x3
- $str =~ s/\017/|/g; # 0x11 to vertical line
- $str =~ s/;SPMquot;(.)/\1/g; # ;SPMquot; -> whatever the next character is
- $str =~ s/\012/;SPMquot;/g; # 0x12 to ;SPMquot;
- $str =~ s/\011/\\\\/g; # 0x11 to double backslash
- local($key_part, $pageref) = split("\003", $str, 2);
-
- # For any keys of the form: blablabla!blablabla, which want to be split at the
- # exclamation point, replace the ! with a comma and a space. We don't do it
- # that way for this index.
- $key_part =~ s/\001/, /g;
- local(@keys) = split("\001", $key_part);
- # If TITLE is not yet available use $before.
- $TITLE = $saved_title if (($saved_title)&&(!($TITLE)||($TITLE eq $default_title)));
- $TITLE = $before unless $TITLE;
- # Save the reference
- local($words) = '';
- if ($SHOW_SECTION_NUMBERS) { $words = &make_idxnum; }
- elsif ($SHORT_INDEX) { $words = &make_shortidxname; }
- else { $words = &make_idxname; }
- local($super_key) = '';
- local($sort_key, $printable_key, $cur_key);
- foreach $key (@keys) {
- $key =~ s/\016/\001/g; # revert protected \001s
- ($sort_key, $printable_key) = split("\002", $key);
- #
- # RRM: 16 May 1996
- # any \label in the printable-key will have already
- # created a label where the \index occurred.
- # This has to be removed, so that the desired label
- # will be found on the Index page instead.
- #
- if ($printable_key =~ /tex2html_anchor_mark/ ) {
- $printable_key =~ s/><tex2html_anchor_mark><\/A><A//g;
- local($tmpA,$tmpB) = split("NAME=\"", $printable_key);
- ($tmpA,$tmpB) = split("\"", $tmpB);
- $ref_files{$tmpA}='';
- $index_labels{$tmpA} = 1;
- }
- #
- # resolve and clean-up the hyperlink index-entries
- # so they can be saved in an index.pl file
- #
- if ($printable_key =~ /$cross_ref_mark/ ) {
- local($label,$id,$ref_label);
- # $printable_key =~ s/$cross_ref_mark#(\w+)#(\w+)>$cross_ref_mark/
- $printable_key =~ s/$cross_ref_mark#([^#]+)#([^>]+)>$cross_ref_mark/
- do { ($label,$id) = ($1,$2);
- $ref_label = $external_labels{$label} unless
- ($ref_label = $ref_files{$label});
- '"' . "$ref_label#$label" . '">' .
- &get_ref_mark($label,$id)}
- /geo;
- }
- $printable_key =~ s/<\#[^\#>]*\#>//go;
- #RRM
- # recognise \char combinations, for a \backslash
- #
- $printable_key =~ s/\&\#;\'134/\\/g; # restore \\s
- $printable_key =~ s/\&\#;\`<BR> /\\/g; # ditto
- $printable_key =~ s/\&\#;*SPMquot;92/\\/g; # ditto
- #
- # $sort_key .= "@$printable_key" if !($printable_key); # RRM
- $sort_key .= "@$printable_key" if !($sort_key); # RRM
- $sort_key =~ tr/A-Z/a-z/;
- if ($super_key) {
- $cur_key = $super_key . "\001" . $sort_key;
- $sub_index{$super_key} .= $cur_key . "\004";
- } else {
- $cur_key = $sort_key;
- }
-
- # Append the $index_name to the current key with a \002 delimiter. This will
- # allow the same index entry to appear in more than one index.
- $index_key = $cur_key . "\002$index_name";
-
- $index{$index_key} .= "";
-
- #
- # RRM, 15 June 1996
- # if there is no printable key, but one is known from
- # a previous index-entry, then use it.
- #
- if (!($printable_key) && ($printable_key{$index_key}))
- { $printable_key = $printable_key{$index_key}; }
-# if (!($printable_key) && ($printable_key{$cur_key}))
-# { $printable_key = $printable_key{$cur_key}; }
- #
- # do not overwrite the printable_key if it contains an anchor
- #
- if (!($printable_key{$index_key} =~ /tex2html_anchor_mark/ ))
- { $printable_key{$index_key} = $printable_key || $key; }
-# if (!($printable_key{$cur_key} =~ /tex2html_anchor_mark/ ))
-# { $printable_key{$cur_key} = $printable_key || $key; }
-
- $super_key = $cur_key;
- }
- #
- # RRM
- # page-ranges, from |( and |) and |see
- #
- if ($pageref) {
- if ($pageref eq "\(" ) {
- $pageref = '';
- $next .= " from ";
- } elsif ($pageref eq "\)" ) {
- $pageref = '';
- local($next) = $index{$index_key};
-# local($next) = $index{$cur_key};
- # $next =~ s/[\|] *$//;
- $next =~ s/(\n )?\| $//;
- $index{$index_key} = "$next to ";
-# $index{$cur_key} = "$next to ";
- }
- }
-
- if ($pageref) {
- $pageref =~ s/\s*$//g; # remove trailing spaces
- if (!$pageref) { $pageref = ' ' }
- $pageref =~ s/see/<i>see <\/i> /g;
- #
- # RRM: 27 Dec 1996
- # check if $pageref corresponds to a style command.
- # If so, apply it to the $words.
- #
- local($tmp) = "do_cmd_$pageref";
- if (defined &$tmp) {
- $words = &$tmp("<#0#>$words<#0#>");
- $words =~ s/<\#[^\#]*\#>//go;
- $pageref = '';
- }
- }
- #
- # RRM: 25 May 1996
- # any \label in the pageref section will have already
- # created a label where the \index occurred.
- # This has to be removed, so that the desired label
- # will be found on the Index page instead.
- #
- if ($pageref) {
- if ($pageref =~ /tex2html_anchor_mark/ ) {
- $pageref =~ s/><tex2html_anchor_mark><\/A><A//g;
- local($tmpA,$tmpB) = split("NAME=\"", $pageref);
- ($tmpA,$tmpB) = split("\"", $tmpB);
- $ref_files{$tmpA}='';
- $index_labels{$tmpA} = 1;
- }
- #
- # resolve and clean-up any hyperlinks in the page-ref,
- # so they can be saved in an index.pl file
- #
- if ($pageref =~ /$cross_ref_mark/ ) {
- local($label,$id,$ref_label);
- # $pageref =~ s/$cross_ref_mark#(\w+)#(\w+)>$cross_ref_mark/
- $pageref =~ s/$cross_ref_mark#([^#]+)#([^>]+)>$cross_ref_mark/
- do { ($label,$id) = ($1,$2);
- $ref_files{$label} = ''; # ???? RRM
- if ($index_labels{$label}) { $ref_label = ''; }
- else { $ref_label = $external_labels{$label}
- unless ($ref_label = $ref_files{$label});
- }
- '"' . "$ref_label#$label" . '">' . &get_ref_mark($label,$id)}/geo;
- }
- $pageref =~ s/<\#[^\#>]*\#>//go;
-
- if ($pageref eq ' ') { $index{$index_key}='@'; }
- else { $index{$index_key} .= $pageref . "\n | "; }
- } else {
- local($thisref) = &make_named_href('',"$CURRENT_FILE#$br_id",$words);
- $thisref =~ s/\n//g;
- $index{$index_key} .= $thisref."\n | ";
- }
- #print "\nREF: $sort_key : $index_key :$index{$index_key}";
-
- #join('',"<A NAME=$br_id>$anchor_invisible_mark<\/A>",$_);
-
- "<A NAME=\"$br_id\">$anchor_invisible_mark<\/A>";
-}
-
-
-# KEC. -- Copied from makeidx.perl, then modified to do multiple indices.
-# Feeds the index entries to the output. This is called for each index to be built.
-#
-# Generates a list of lookup keys for index entries, from both %printable_keys
-# and %index keys.
-# Sorts the keys according to index-sorting rules.
-# Removes keys with a 0x01 token. (duplicates?)
-# Builds a string to go to the index file.
-# Adds the index entries to the string if they belong in this index.
-# Keeps track of which index is being worked on, so only the proper entries
-# are included.
-# Places the index just built in to the output at the proper place.
-{ my $index_number = 0;
-sub add_real_idx {
- print "\nDoing the index ... Index Number $index_number\n";
- local($key, @keys, $next, $index, $old_key, $old_html);
- my ($idx_ref,$keyref);
- # RRM, 15.6.96: index constructed from %printable_key, not %index
- @keys = keys %printable_key;
-
- while (/$idx_mark/) {
- # Get the index reference from what follows the $idx_mark and
- # remove it from the string.
- s/$idxmark\002(.*?)\002/$idxmark/;
- $idx_ref = $1;
- $index = '';
- # include non- makeidx index-entries
- foreach $key (keys %index) {
- next if $printable_key{$key};
- $old_key = $key;
- if ($key =~ s/###(.*)$//) {
- next if $printable_key{$key};
- push (@keys, $key);
- $printable_key{$key} = $key;
- if ($index{$old_key} =~ /HREF="([^"]*)"/i) {
- $old_html = $1;
- $old_html =~ /$dd?([^#\Q$dd\E]*)#/;
- $old_html = $1;
- } else { $old_html = '' }
- $index{$key} = $index{$old_key} . $old_html."</A>\n | ";
- };
- }
- @keys = sort makeidx_keysort @keys;
- @keys = grep(!/\001/, @keys);
- my $cnt = 0;
- foreach $key (@keys) {
- my ($keyref) = $key =~ /.*\002(.*)/;
- next unless ($idx_ref eq $keyref); # KEC.
- $index .= &add_idx_key($key);
- $cnt++;
- }
- print "$cnt Index Entries Added\n";
- $index = '<DD>'.$index unless ($index =~ /^\s*<D(D|T)>/);
- $index_number++; # KEC.
- if ($SHORT_INDEX) {
- print "(compact version with Legend)";
- local($num) = ( $index =~ s/\<D/<D/g );
- if ($num > 50 ) {
- s/$idx_mark/$preindex<HR><DL>\n$index\n<\/DL>$preindex/o;
- } else {
- s/$idx_mark/$preindex<HR><DL>\n$index\n<\/DL>/o;
- }
- } else {
- s/$idx_mark/<DL COMPACT>\n$index\n<\/DL>/o; }
- }
-}
-}
-
-# KEC. Copied from latex2html.pl and modified to support multiple indices.
-# The bibliography and the index should be treated as separate sections
-# in their own HTML files. The \bibliography{} command acts as a sectioning command
-# that has the desired effect. But when the bibliography is constructed
-# manually using the thebibliography environment, or when using the
-# theindex environment it is not possible to use the normal sectioning
-# mechanism. This subroutine inserts a \bibliography{} or a dummy
-# \textohtmlindex command just before the appropriate environments
-# to force sectioning.
-sub add_bbl_and_idx_dummy_commands {
- local($id) = $global{'max_id'};
-
- s/([\\]begin\s*$O\d+$C\s*thebibliography)/$bbl_cnt++; $1/eg;
- ## if ($bbl_cnt == 1) {
- s/([\\]begin\s*$O\d+$C\s*thebibliography)/$id++; "\\bibliography$O$id$C$O$id$C $1"/geo;
- #}
- $global{'max_id'} = $id;
- # KEC. Modified to global substitution to place multiple index tokens.
- s/[\\]begin\s*($O\d+$C)\s*theindex/\\textohtmlindex$1/go;
- # KEC. Modified to pick up the optional argument to \printindex
- s/[\\]printindex\s*(\[.*?\])?/
- do { (defined $1) ? "\\textohtmlindex $1" : "\\textohtmlindex []"; } /ego;
- &lib_add_bbl_and_idx_dummy_commands() if defined(&lib_add_bbl_and_idx_dummy_commands);
-}
-
-# KEC. Copied from latex2html.pl and modified to support multiple indices.
-# For each textohtmlindex mark found, determine the index titles and headers.
-# We place the index ref in the header so the proper index can be generated later.
-# For the default index, the index ref is blank.
-#
-# One problem is that this routine is called twice.. Once for processing the
-# command as originally seen, and once for processing the command when
-# doing the name for the index file. We can detect that by looking at the
-# id numbers (or ref) surrounding the \theindex command, and not incrementing
-# index_number unless a new id (or ref) is seen. This has the side effect of
-# having to unconventionally start the index_number at -1. But it works.
-#
-# Gets the title from the list of indices.
-# If this is the first index, save the title in $first_idx_file. This is what's referenced
-# in the navigation buttons.
-# Increment the index_number for next time.
-# If the indexname command is defined or a newcommand defined for indexname, do it.
-# Save the index TITLE in the toc
-# Save the first_idx_file into the idxfile. This goes into the nav buttons.
-# Build index_labels if needed.
-# Create the index headings and put them in the output stream.
-
-{ my $index_number = 0; # Will be incremented before use.
- my $first_idx_file; # Static
- my $no_increment = 0;
-
-sub do_cmd_textohtmlindex {
- local($_) = @_;
- my ($idxref,$idxnum,$index_name);
-
- # We get called from make_name with the first argument = "\001noincrement". This is a sign
- # to not increment $index_number the next time we are called. We get called twice, once
- # my make_name and once by process_command. Unfortunately, make_name calls us just to set the name
- # but doesn't use the result so we get called a second time by process_command. This works fine
- # except for cases where there are multiple indices except if they aren't named, which is the case
- # when the index is inserted by an include command in latex. In these cases we are only able to use
- # the index number to decide which index to draw from, and we don't know how to increment that index
- # number if we get called a variable number of times for the same index, as is the case between
- # making html (one output file) and web (multiple output files) output formats.
- if (/\001noincrement/) {
- $no_increment = 1;
- return;
- }
-
- # Remove (but save) the index reference
- s/^\s*\[(.*?)\]/{$idxref = $1; "";}/e;
-
- # If we have an $idxref, the index name was specified. In this case, we have all the
- # information we need to carry on. Otherwise, we need to get the idxref
- # from the $index_number and set the name to "Index".
- if ($idxref) {
- $index_name = $indices{'title'}{$idxref};
- } else {
- if (defined ($idxref = $indices{'newcmdorder'}->[$index_number])) {
- $index_name = $indices{'title'}{$idxref};
- } else {
- $idxref = '';
- $index_name = "Index";
- }
- }
-
- $idx_title = "Index"; # The name displayed in the nav bar text.
-
- # Only set $idxfile if we are at the first index. This will point the
- # navigation panel to the first index file rather than the last.
- $first_idx_file = $CURRENT_FILE if ($index_number == 0);
- $idxfile = $first_idx_file; # Pointer for the Index button in the nav bar.
- $toc_sec_title = $index_name; # Index link text in the toc.
- $TITLE = $toc_sec_title; # Title for this index, from which its filename is built.
- if (%index_labels) { &make_index_labels(); }
- if (($SHORT_INDEX) && (%index_segment)) { &make_preindex(); }
- else { $preindex = ''; }
- local $idx_head = $section_headings{'textohtmlindex'};
- local($heading) = join(''
- , &make_section_heading($TITLE, $idx_head)
- , $idx_mark, "\002", $idxref, "\002" );
- local($pre,$post) = &minimize_open_tags($heading);
- $index_number++ unless ($no_increment);
- $no_increment = 0;
- join('',"<BR>\n" , $pre, $_);
-}
-}
-
-# Returns an index key, given the key passed as the first argument.
-# Not modified for multiple indices.
-sub add_idx_key {
- local($key) = @_;
- local($index, $next);
- if (($index{$key} eq '@' )&&(!($index_printed{$key}))) {
- if ($SHORT_INDEX) { $index .= "<DD><BR>\n<DT>".&print_key."\n<DD>"; }
- else { $index .= "<DT><DD><BR>\n<DT>".&print_key."\n<DD>"; }
- } elsif (($index{$key})&&(!($index_printed{$key}))) {
- if ($SHORT_INDEX) {
- $next = "<DD>".&print_key."\n : ". &print_idx_links;
- } else {
- $next = "<DT>".&print_key."\n<DD>". &print_idx_links;
- }
- $index .= $next."\n";
- $index_printed{$key} = 1;
- }
-
- if ($sub_index{$key}) {
- local($subkey, @subkeys, $subnext, $subindex);
- @subkeys = sort(split("\004", $sub_index{$key}));
- if ($SHORT_INDEX) {
- $index .= "<DD>".&print_key unless $index_printed{$key};
- $index .= "<DL>\n";
- } else {
- $index .= "<DT>".&print_key."\n<DD>" unless $index_printed{$key};
- $index .= "<DL COMPACT>\n";
- }
- foreach $subkey (@subkeys) {
- $index .= &add_sub_idx_key($subkey) unless ($index_printed{$subkey});
- }
- $index .= "</DL>\n";
- }
- return $index;
-}
-
-1; # Must be present as the last line.
+++ /dev/null
-# This file serves as a place to put initialization code and constants to
-# affect the behavior of latex2html for generating the bacula manuals.
-
-# $LINKPOINT specifies what filename to use to link to when creating
-# index.html. Not that this is a hard link.
-$LINKPOINT='"$OVERALL_TITLE"';
-
-
-# The following must be the last line of this file.
-1;
+++ /dev/null
-%%
-%%
-
-\chapter{Volume Utility Tools}
-\label{_UtilityChapter}
-\index[general]{Volume Utility Tools}
-\index[general]{Tools!Volume Utility}
-
-This document describes the utility programs written to aid Bacula users and
-developers in dealing with Volumes external to Bacula.
-
-\section{Specifying the Configuration File}
-\index[general]{Specifying the Configuration File}
-
-Starting with version 1.27, each of the following programs requires a valid
-Storage daemon configuration file (actually, the only part of the
-configuration file that these programs need is the {\bf Device} resource
-definitions). This permits the programs to find the configuration parameters
-for your archive device (generally a tape drive). By default, they read {\bf
-bacula-sd.conf} in the current directory, but you may specify a different
-configuration file using the {\bf -c} option.
-
-
-\section{Specifying a Device Name For a Tape}
-\index[general]{Tape!Specifying a Device Name For a}
-\index[general]{Specifying a Device Name For a Tape}
-
-Each of these programs require a {\bf device-name} where the Volume can be
-found. In the case of a tape, this is the physical device name such as {\bf
-/dev/nst0} or {\bf /dev/rmt/0ubn} depending on your system. For the program to
-work, it must find the identical name in the Device resource of the
-configuration file. See below for specifying Volume names.
-
-Please note that if you have Bacula running and you ant to use
-one of these programs, you will either need to stop the Storage daemon, or
-{\bf unmount} any tape drive you want to use, otherwise the drive
-will {\bf busy} because Bacula is using it.
-
-
-\section{Specifying a Device Name For a File}
-\index[general]{File!Specifying a Device Name For a}
-\index[general]{Specifying a Device Name For a File}
-
-If you are attempting to read or write an archive file rather than a tape, the
-{\bf device-name} should be the full path to the archive location including
-the filename. The filename (last part of the specification) will be stripped
-and used as the Volume name, and the path (first part before the filename)
-must have the same entry in the configuration file. So, the path is equivalent
-to the archive device name, and the filename is equivalent to the volume name.
-
-
-\section{Specifying Volumes}
-\index[general]{Volumes!Specifying}
-\index[general]{Specifying Volumes}
-
-In general, you must specify the Volume name to each of the programs below
-(with the exception of {\bf btape}). The best method to do so is to specify a
-{\bf bootstrap} file on the command line with the {\bf -b} option. As part of
-the bootstrap file, you will then specify the Volume name or Volume names if
-more than one volume is needed. For example, suppose you want to read tapes
-{\bf tape1} and {\bf tape2}. First construct a {\bf bootstrap} file named say,
-{\bf list.bsr} which contains:
-
-\footnotesize
-\begin{verbatim}
-Volume=test1|test2
-\end{verbatim}
-\normalsize
-
-where each Volume is separated by a vertical bar. Then simply use:
-
-\footnotesize
-\begin{verbatim}
-./bls -b list.bsr /dev/nst0
-\end{verbatim}
-\normalsize
-
-In the case of Bacula Volumes that are on files, you may simply append volumes
-as follows:
-
-\footnotesize
-\begin{verbatim}
-./bls /tmp/test1\|test2
-\end{verbatim}
-\normalsize
-
-where the backslash (\textbackslash{}) was necessary as a shell escape to
-permit entering the vertical bar (|).
-
-And finally, if you feel that specifying a Volume name is a bit complicated
-with a bootstrap file, you can use the {\bf -V} option (on all programs except
-{\bf bcopy}) to specify one or more Volume names separated by the vertical bar
-(|). For example,
-
-\footnotesize
-\begin{verbatim}
-./bls -V Vol001 /dev/nst0
-\end{verbatim}
-\normalsize
-
-You may also specify an asterisk (*) to indicate that the program should
-accept any volume. For example:
-
-\footnotesize
-\begin{verbatim}
-./bls -V* /dev/nst0
-\end{verbatim}
-\normalsize
-
-\section{bls}
-\label{bls}
-\index[general]{bls}
-\index[general]{program!bls}
-
-{\bf bls} can be used to do an {\bf ls} type listing of a {\bf Bacula} tape or
-file. It is called:
-
-\footnotesize
-\begin{verbatim}
-Usage: bls [options] <device-name>
- -b <file> specify a bootstrap file
- -c <file> specify a config file
- -d <level> specify debug level
- -e <file> exclude list
- -i <file> include list
- -j list jobs
- -k list blocks
- (no j or k option) list saved files
- -L dump label
- -p proceed inspite of errors
- -v be verbose
- -V specify Volume names (separated by |)
- -? print this message
-\end{verbatim}
-\normalsize
-
-For example, to list the contents of a tape:
-
-\footnotesize
-\begin{verbatim}
-./bls -V Volume-name /dev/nst0
-\end{verbatim}
-\normalsize
-
-Or to list the contents of a file:
-
-\footnotesize
-\begin{verbatim}
-./bls /tmp/Volume-name
-or
-./bls -V Volume-name /tmp
-\end{verbatim}
-\normalsize
-
-Note that, in the case of a file, the Volume name becomes the filename, so in
-the above example, you will replace the {\bf xxx} with the name of the volume
-(file) you wrote.
-
-Normally if no options are specified, {\bf bls} will produce the equivalent
-output to the {\bf ls -l} command for each file on the tape. Using other
-options listed above, it is possible to display only the Job records, only the
-tape blocks, etc. For example:
-
-\footnotesize
-\begin{verbatim}
-
-./bls /tmp/File002
-bls: butil.c:148 Using device: /tmp
-drwxrwxr-x 3 k k 4096 02-10-19 21:08 /home/kern/bacula/k/src/dird/
-drwxrwxr-x 2 k k 4096 02-10-10 18:59 /home/kern/bacula/k/src/dird/CVS/
--rw-rw-r-- 1 k k 54 02-07-06 18:02 /home/kern/bacula/k/src/dird/CVS/Root
--rw-rw-r-- 1 k k 16 02-07-06 18:02 /home/kern/bacula/k/src/dird/CVS/Repository
--rw-rw-r-- 1 k k 1783 02-10-10 18:59 /home/kern/bacula/k/src/dird/CVS/Entries
--rw-rw-r-- 1 k k 97506 02-10-18 21:07 /home/kern/bacula/k/src/dird/Makefile
--rw-r--r-- 1 k k 3513 02-10-18 21:02 /home/kern/bacula/k/src/dird/Makefile.in
--rw-rw-r-- 1 k k 4669 02-07-06 18:02 /home/kern/bacula/k/src/dird/README-config
--rw-r--r-- 1 k k 4391 02-09-14 16:51 /home/kern/bacula/k/src/dird/authenticate.c
--rw-r--r-- 1 k k 3609 02-07-07 16:41 /home/kern/bacula/k/src/dird/autoprune.c
--rw-rw-r-- 1 k k 4418 02-10-18 21:03 /home/kern/bacula/k/src/dird/bacula-dir.conf
-...
--rw-rw-r-- 1 k k 83 02-08-31 19:19 /home/kern/bacula/k/src/dird/.cvsignore
-bls: Got EOF on device /tmp
-84 files found.
-\end{verbatim}
-\normalsize
-
-\subsection{Listing Jobs}
-\index[general]{Listing Jobs with bls}
-\index[general]{bls!Listing Jobs}
-
-If you are listing a Volume to determine what Jobs to restore, normally the
-{\bf -j} option provides you with most of what you will need as long as you
-don't have multiple clients. For example,
-
-\footnotesize
-\begin{verbatim}
-./bls -j -V Test1 -c stored.conf DDS-4
-bls: butil.c:258 Using device: "DDS-4" for reading.
-11-Jul 11:54 bls: Ready to read from volume "Test1" on device "DDS-4" (/dev/nst0).
-Volume Record: File:blk=0:1 SessId=4 SessTime=1121074625 JobId=0 DataLen=165
-Begin Job Session Record: File:blk=0:2 SessId=4 SessTime=1121074625 JobId=1 Level=F Type=B
-Begin Job Session Record: File:blk=0:3 SessId=5 SessTime=1121074625 JobId=5 Level=F Type=B
-Begin Job Session Record: File:blk=0:6 SessId=3 SessTime=1121074625 JobId=2 Level=F Type=B
-Begin Job Session Record: File:blk=0:13 SessId=2 SessTime=1121074625 JobId=4 Level=F Type=B
-End Job Session Record: File:blk=0:99 SessId=3 SessTime=1121074625 JobId=2 Level=F Type=B
- Files=168 Bytes=1,732,978 Errors=0 Status=T
-End Job Session Record: File:blk=0:101 SessId=2 SessTime=1121074625 JobId=4 Level=F Type=B
- Files=168 Bytes=1,732,978 Errors=0 Status=T
-End Job Session Record: File:blk=0:108 SessId=5 SessTime=1121074625 JobId=5 Level=F Type=B
- Files=168 Bytes=1,732,978 Errors=0 Status=T
-End Job Session Record: File:blk=0:109 SessId=4 SessTime=1121074625 JobId=1 Level=F Type=B
- Files=168 Bytes=1,732,978 Errors=0 Status=T
-11-Jul 11:54 bls: End of Volume at file 1 on device "DDS-4" (/dev/nst0), Volume "Test1"
-11-Jul 11:54 bls: End of all volumes.
-\end{verbatim}
-\normalsize
-
-shows a full save followed by two incremental saves.
-
-Adding the {\bf -v} option will display virtually all information that is
-available for each record:
-
-\subsection{Listing Blocks}
-\index[general]{Listing Blocks with bls}
-\index[general]{bls!Listing Blocks}
-
-Normally, except for debugging purposes, you will not need to list Bacula
-blocks (the "primitive" unit of Bacula data on the Volume). However, you can
-do so with:
-
-\footnotesize
-\begin{verbatim}
-./bls -k /tmp/File002
-bls: butil.c:148 Using device: /tmp
-Block: 1 size=64512
-Block: 2 size=64512
-...
-Block: 65 size=64512
-Block: 66 size=19195
-bls: Got EOF on device /tmp
-End of File on device
-\end{verbatim}
-\normalsize
-
-By adding the {\bf -v} option, you can get more information, which can be
-useful in knowing what sessions were written to the volume:
-
-\footnotesize
-\begin{verbatim}
-./bls -k -v /tmp/File002
-Volume Label:
-Id : Bacula 0.9 mortal
-VerNo : 10
-VolName : File002
-PrevVolName :
-VolFile : 0
-LabelType : VOL_LABEL
-LabelSize : 147
-PoolName : Default
-MediaType : File
-PoolType : Backup
-HostName :
-Date label written: 2002-10-19 at 21:16
-Block: 1 blen=64512 First rec FI=VOL_LABEL SessId=1 SessTim=1035062102 Strm=0 rlen=147
-Block: 2 blen=64512 First rec FI=6 SessId=1 SessTim=1035062102 Strm=DATA rlen=4087
-Block: 3 blen=64512 First rec FI=12 SessId=1 SessTim=1035062102 Strm=DATA rlen=5902
-Block: 4 blen=64512 First rec FI=19 SessId=1 SessTim=1035062102 Strm=DATA rlen=28382
-...
-Block: 65 blen=64512 First rec FI=83 SessId=1 SessTim=1035062102 Strm=DATA rlen=1873
-Block: 66 blen=19195 First rec FI=83 SessId=1 SessTim=1035062102 Strm=DATA rlen=2973
-bls: Got EOF on device /tmp
-End of File on device
-\end{verbatim}
-\normalsize
-
-Armed with the SessionId and the SessionTime, you can extract just about
-anything.
-
-If you want to know even more, add a second {\bf -v} to the command line to
-get a dump of every record in every block.
-
-\footnotesize
-\begin{verbatim}
-./bls -k -v -v /tmp/File002
-bls: block.c:79 Dump block 80f8ad0: size=64512 BlkNum=1
- Hdrcksum=b1bdfd6d cksum=b1bdfd6d
-bls: block.c:92 Rec: VId=1 VT=1035062102 FI=VOL_LABEL Strm=0 len=147 p=80f8b40
-bls: block.c:92 Rec: VId=1 VT=1035062102 FI=SOS_LABEL Strm=-7 len=122 p=80f8be7
-bls: block.c:92 Rec: VId=1 VT=1035062102 FI=1 Strm=UATTR len=86 p=80f8c75
-bls: block.c:92 Rec: VId=1 VT=1035062102 FI=2 Strm=UATTR len=90 p=80f8cdf
-bls: block.c:92 Rec: VId=1 VT=1035062102 FI=3 Strm=UATTR len=92 p=80f8d4d
-bls: block.c:92 Rec: VId=1 VT=1035062102 FI=3 Strm=DATA len=54 p=80f8dbd
-bls: block.c:92 Rec: VId=1 VT=1035062102 FI=3 Strm=MD5 len=16 p=80f8e07
-bls: block.c:92 Rec: VId=1 VT=1035062102 FI=4 Strm=UATTR len=98 p=80f8e2b
-bls: block.c:92 Rec: VId=1 VT=1035062102 FI=4 Strm=DATA len=16 p=80f8ea1
-bls: block.c:92 Rec: VId=1 VT=1035062102 FI=4 Strm=MD5 len=16 p=80f8ec5
-bls: block.c:92 Rec: VId=1 VT=1035062102 FI=5 Strm=UATTR len=96 p=80f8ee9
-bls: block.c:92 Rec: VId=1 VT=1035062102 FI=5 Strm=DATA len=1783 p=80f8f5d
-bls: block.c:92 Rec: VId=1 VT=1035062102 FI=5 Strm=MD5 len=16 p=80f9668
-bls: block.c:92 Rec: VId=1 VT=1035062102 FI=6 Strm=UATTR len=95 p=80f968c
-bls: block.c:92 Rec: VId=1 VT=1035062102 FI=6 Strm=DATA len=32768 p=80f96ff
-bls: block.c:92 Rec: VId=1 VT=1035062102 FI=6 Strm=DATA len=32768 p=8101713
-bls: block.c:79 Dump block 80f8ad0: size=64512 BlkNum=2
- Hdrcksum=9acc1e7f cksum=9acc1e7f
-bls: block.c:92 Rec: VId=1 VT=1035062102 FI=6 Strm=contDATA len=4087 p=80f8b40
-bls: block.c:92 Rec: VId=1 VT=1035062102 FI=6 Strm=DATA len=31970 p=80f9b4b
-bls: block.c:92 Rec: VId=1 VT=1035062102 FI=6 Strm=MD5 len=16 p=8101841
-...
-\end{verbatim}
-\normalsize
-
-\section{bextract}
-\label{bextract}
-\index[general]{Bextract}
-\index[general]{program!bextract}
-
-If you find yourself using {\bf bextract}, you probably have done
-something wrong. For example, if you are trying to recover a file
-but are having problems, please see the \ilink {Restoring When Things Go
-Wrong}{database_restore} section of the Restore chapter of this manual.
-
-Normally, you will restore files by running a {\bf Restore} Job from the {\bf
-Console} program. However, {\bf bextract} can be used to extract a single file
-or a list of files from a Bacula tape or file. In fact, {\bf bextract} can be
-a useful tool to restore files to an empty system assuming you are able to
-boot, you have statically linked {\bf bextract} and you have an appropriate
-{\bf bootstrap} file.
-
-Please note that some of the current limitations of bextract are:
-
-\begin{enumerate}
-\item It cannot restore access control lists (ACL) that have been
- backed up along with the file data.
-\item It cannot restore Win32 non-portable streams (typically default).
-\item It cannot restore encrypted files.
-\item The command line length is relatively limited,
- which means that you cannot enter a huge number of volumes. If you need to
- enter more volumes than the command line supports, please use a bootstrap
- file (see below).
-\end{enumerate}
-
-
-It is called:
-
-\footnotesize
-\begin{verbatim}
-
-Usage: bextract [-d debug_level] <device-name> <directory-to-store-files>
- -b <file> specify a bootstrap file
- -dnn set debug level to nn
- -e <file> exclude list
- -i <file> include list
- -p proceed inspite of I/O errors
- -V specify Volume names (separated by |)
- -? print this message
-\end{verbatim}
-\normalsize
-
-where {\bf device-name} is the Archive Device (raw device name or full
-filename) of the device to be read, and {\bf directory-to-store-files} is a
-path prefix to prepend to all the files restored.
-
-NOTE: On Windows systems, if you specify a prefix of say d:/tmp, any file that
-would have been restored to {\bf c:/My Documents} will be restored to {\bf
-d:/tmp/My Documents}. That is, the original drive specification will be
-stripped. If no prefix is specified, the file will be restored to the original
-drive.
-
-\subsection{Extracting with Include or Exclude Lists}
-\index[general]{Lists!Extracting with Include or Exclude}
-\index[general]{Extracting with Include or Exclude Lists}
-
-Using the {\bf -e} option, you can specify a file containing a list of files
-to be excluded. Wildcards can be used in the exclusion list. This option will
-normally be used in conjunction with the {\bf -i} option (see below). Both the
-{\bf -e} and the {\bf -i} options may be specified at the same time as the
-{\bf -b} option. The bootstrap filters will be applied first, then the include
-list, then the exclude list.
-
-Likewise, and probably more importantly, with the {\bf -i} option, you can
-specify a file that contains a list (one file per line) of files and
-directories to include to be restored. The list must contain the full filename
-with the path. If you specify a path name only, all files and subdirectories
-of that path will be restored. If you specify a line containing only the
-filename (e.g. {\bf my-file.txt}) it probably will not be extracted because
-you have not specified the full path.
-
-For example, if the file {\bf include-list} contains:
-
-\footnotesize
-\begin{verbatim}
-/home/kern/bacula
-/usr/local/bin
-\end{verbatim}
-\normalsize
-
-Then the command:
-
-\footnotesize
-\begin{verbatim}
-./bextract -i include-list -V Volume /dev/nst0 /tmp
-\end{verbatim}
-\normalsize
-
-will restore from the Bacula archive {\bf /dev/nst0} all files and directories
-in the backup from {\bf /home/kern/bacula} and from {\bf /usr/local/bin}. The
-restored files will be placed in a file of the original name under the
-directory {\bf /tmp} (i.e. /tmp/home/kern/bacula/... and
-/tmp/usr/local/bin/...).
-
-\subsection{Extracting With a Bootstrap File}
-\index[general]{File!Extracting With a Bootstrap}
-\index[general]{Extracting With a Bootstrap File}
-
-The {\bf -b} option is used to specify a {\bf bootstrap} file containing the
-information needed to restore precisely the files you want. Specifying a {\bf
-bootstrap} file is optional but recommended because it gives you the most
-control over which files will be restored. For more details on the {\bf
-bootstrap} file, please see
-\ilink{Restoring Files with the Bootstrap File}{BootstrapChapter}
-chapter of this document. Note, you may also use a bootstrap file produced by
-the {\bf restore} command. For example:
-
-\footnotesize
-\begin{verbatim}
-./bextract -b bootstrap-file /dev/nst0 /tmp
-\end{verbatim}
-\normalsize
-
-The bootstrap file allows detailed specification of what files you want
-restored (extracted). You may specify a bootstrap file and include and/or
-exclude files at the same time. The bootstrap conditions will first be
-applied, and then each file record seen will be compared to the include and
-exclude lists.
-
-\subsection{Extracting From Multiple Volumes}
-\index[general]{Volumes!Extracting From Multiple}
-\index[general]{Extracting From Multiple Volumes}
-
-If you wish to extract files that span several Volumes, you can specify the
-Volume names in the bootstrap file or you may specify the Volume names on the
-command line by separating them with a vertical bar. See the section above
-under the {\bf bls} program entitled {\bf Listing Multiple Volumes} for more
-information. The same techniques apply equally well to the {\bf bextract}
-program or read the \ilink{Bootstrap}{BootstrapChapter}
-chapter of this document.
-
-\section{bscan}
-\label{bscan}
-\index[general]{bscan}
-\index[general]{program!bscan}
-
-If you find yourself using this program, you have probably done something
-wrong. For example, the best way to recover a lost or damaged Bacula
-database is to reload the database by using the bootstrap file that
-was written when you saved it (default bacula-dir.conf file).
-
-The {\bf bscan} program can be used to re-create a database (catalog)
-records from the backup information written to one or more Volumes.
-This is normally
-needed only if one or more Volumes have been pruned or purged from your
-catalog so that the records on the Volume are no longer in the catalog, or
-for Volumes that you have archived.
-
-With some care, it can also be used to synchronize your existing catalog with
-a Volume. Although we have never seen a case of bscan damaging a
-catalog, since bscan modifies your catalog, we recommend that
-you do a simple ASCII backup of your database before running {\bf bscan} just
-to be sure. See \ilink{Compacting Your Database}{CompactingMySQL} for
-the details of making a copy of your database.
-
-{\bf bscan} can also be useful in a disaster recovery situation, after the
-loss of a hard disk, if you do not have a valid {\bf bootstrap} file for
-reloading your system, or if a Volume has been recycled but not overwritten,
-you can use {\bf bscan} to re-create your database, which can then be used to
-{\bf restore} your system or a file to its previous state.
-
-It is called:
-
-\footnotesize
-\begin{verbatim}
-
-Usage: bscan [options] <bacula-archive>
- -b bootstrap specify a bootstrap file
- -c <file> specify configuration file
- -d <nn> set debug level to nn
- -m update media info in database
- -n <name> specify the database name (default bacula)
- -u <user> specify database user name (default bacula)
- -P <password> specify database password (default none)
- -h <host> specify database host (default NULL)
- -p proceed inspite of I/O errors
- -r list records
- -s synchronize or store in database
- -v verbose
- -V <Volumes> specify Volume names (separated by |)
- -w <dir> specify working directory (default from conf file)
- -? print this message
-\end{verbatim}
-\normalsize
-
-If you are using MySQL or PostgreSQL, there is no need to supply a working
-directory since in that case, bscan knows where the databases are. However, if
-you have provided security on your database, you may need to supply either the
-database name ({\bf -b} option), the user name ({\bf -u} option), and/or the
-password ({\bf -p}) options.
-
-NOTE: before {\bf bscan} can work, it needs at least a bare bones valid
-database. If your database exists but some records are missing because
-they were pruned, then you are all set. If your database was lost or
-destroyed, then you must first ensure that you have the SQL program running
-(MySQL or PostgreSQL), then you must create the Bacula database (normally
-named bacula), and you must create the Bacula tables using the scripts in
-the {\bf cats} directory. This is explained in the
-\ilink{Installation}{CreateDatabase} chapter of the manual. Finally, before
-scanning into an empty database, you must start and stop the Director with
-the appropriate bacula-dir.conf file so that it can create the Client and
-Storage records which are not stored on the Volumes. Without these
-records, scanning is unable to connect the Job records to the proper
-client.
-
-Forgetting for the moment the extra complications of a full rebuild of
-your catalog, let's suppose that you did a backup to Volumes "Vol001"
-and "Vol002", then sometime later all records of one or both those
-Volumes were pruned or purged from the
-database. By using {\bf bscan} you can recreate the catalog entries for
-those Volumes and then use the {\bf restore} command in the Console to restore
-whatever you want. A command something like:
-
-\footnotesize
-\begin{verbatim}
-bscan -c bacula-sd.conf -v -V Vol001\|Vol002 /dev/nst0
-\end{verbatim}
-\normalsize
-
-will give you an idea of what is going to happen without changing
-your catalog. Of course, you may need to change the path to the Storage
-daemon's conf file, the Volume name, and your tape (or disk) device name. This
-command must read the entire tape, so if it has a lot of data, it may take a
-long time, and thus you might want to immediately use the command listed
-below. Note, if you are writing to a disk file, replace the device name with
-the path to the directory that contains the Volumes. This must correspond to
-the Archive Device in the conf file.
-
-Then to actually write or store the records in the catalog, add the {\bf -s}
-option as follows:
-
-\footnotesize
-\begin{verbatim}
- bscan -s -m -c bacula-sd.conf -v -V Vol001\|Vol002 /dev/nst0
-\end{verbatim}
-\normalsize
-
-When writing to the database, if bscan finds existing records, it will
-generally either update them if something is wrong or leave them alone. Thus
-if the Volumes you are scanning are all or partially in the catalog already, no
-harm will be done to that existing data. Any missing data will simply be
-added.
-
-If you have multiple tapes, you should scan them with:
-
-\footnotesize
-\begin{verbatim}
- bscan -s -m -c bacula-sd.conf -v -V Vol001\|Vol002\|Vol003 /dev/nst0
-\end{verbatim}
-\normalsize
-
-Since there is a limit on the command line length (511 bytes) accepted
-by {\bf bscan}, if you have too many Volumes, you will need to manually
-create a bootstrap file. See the \ilink{Bootstrap}{BootstrapChapter}
-chapter of this manual for more details, in particular the section
-entitled \ilink{Bootstrap for bscan}{bscanBootstrap}.
-
-You should, always try to specify the tapes in the order they are written.
-However, bscan can handle scanning tapes that are not sequential. Any
-incomplete records at the end of the tape will simply be ignored in that
-case. If you are simply repairing an existing catalog, this may be OK, but
-if you are creating a new catalog from scratch, it will leave your database
-in an incorrect state. If you do not specify all necessary Volumes on a
-single bscan command, bscan will not be able to correctly restore the
-records that span two volumes. In other words, it is much better to
-specify two or three volumes on a single bscan command rather than run
-bscan two or three times, each with a single volume.
-
-
-Note, the restoration process using bscan is not identical to the original
-creation of the catalog data. This is because certain data such as Client
-records and other non-essential data such
-as volume reads, volume mounts, etc is not stored on the Volume, and thus is
-not restored by bscan. The results of bscanning are, however, perfectly valid,
-and will permit restoration of any or all the files in the catalog using the
-normal Bacula console commands. If you are starting with an empty catalog
-and expecting bscan to reconstruct it, you may be a bit disappointed, but
-at a minimum, you must ensure that your bacula-dir.conf file is the same
-as what it previously was -- that is, it must contain all the appropriate
-Client resources so that they will be recreated in your new database {\bf
-before} running bscan. Normally when the Director starts, it will recreate
-any missing Client records in the catalog. Another problem you will have
-is that even if the Volumes (Media records) are recreated in the database,
-they will not have their autochanger status and slots properly set. As a
-result, you will need to repair that by using the {\bf update slots}
-command. There may be other considerations as well. Rather than
-bscanning, you should always attempt to recover you previous catalog
-backup.
-
-
-\subsection{Using bscan to Compare a Volume to an existing Catalog}
-\index[general]{Catalog!Using bscan to Compare a Volume to an existing}
-\index[general]{Using bscan to Compare a Volume to an existing Catalog}
-
-If you wish to compare the contents of a Volume to an existing catalog without
-changing the catalog, you can safely do so if and only if you do {\bf not}
-specify either the {\bf -m} or the {\bf -s} options. However, at this time
-(Bacula version 1.26), the comparison routines are not as good or as thorough
-as they should be, so we don't particularly recommend this mode other than for
-testing.
-
-\subsection{Using bscan to Recreate a Catalog from a Volume}
-\index[general]{Volume!Using bscan to Recreate a Catalog from a Volume}
-\index[general]{Using bscan to Recreate a Catalog from a Volume}
-
-This is the mode for which {\bf bscan} is most useful. You can either {\bf
-bscan} into a freshly created catalog, or directly into your existing catalog
-(after having made an ASCII copy as described above). Normally, you should
-start with a freshly created catalog that contains no data.
-
-Starting with a single Volume named {\bf TestVolume1}, you run a command such
-as:
-
-\footnotesize
-\begin{verbatim}
-./bscan -V TestVolume1 -v -s -m -c bacula-sd.conf /dev/nst0
-\end{verbatim}
-\normalsize
-
-If there is more than one volume, simply append it to the first one separating
-it with a vertical bar. You may need to precede the vertical bar with a
-forward slash escape the shell -- e.g. {\bf
-TestVolume1\textbackslash{}|TestVolume2}. The {\bf -v} option was added for
-verbose output (this can be omitted if desired). The {\bf -s} option that
-tells {\bf bscan} to store information in the database. The physical device
-name {\bf /dev/nst0} is specified after all the options.
-
-{\bf} For example, after having done a full backup of a directory, then two
-incrementals, I reinitialized the SQLite database as described above, and
-using the bootstrap.bsr file noted above, I entered the following command:
-
-\footnotesize
-\begin{verbatim}
-./bscan -b bootstrap.bsr -v -s -c bacula-sd.conf /dev/nst0
-\end{verbatim}
-\normalsize
-
-which produced the following output:
-
-\footnotesize
-\begin{verbatim}
-bscan: bscan.c:182 Using Database: bacula, User: bacula
-bscan: bscan.c:673 Created Pool record for Pool: Default
-bscan: bscan.c:271 Pool type "Backup" is OK.
-bscan: bscan.c:632 Created Media record for Volume: TestVolume1
-bscan: bscan.c:298 Media type "DDS-4" is OK.
-bscan: bscan.c:307 VOL_LABEL: OK for Volume: TestVolume1
-bscan: bscan.c:693 Created Client record for Client: Rufus
-bscan: bscan.c:769 Created new JobId=1 record for original JobId=2
-bscan: bscan.c:717 Created FileSet record "Kerns Files"
-bscan: bscan.c:819 Updated Job termination record for new JobId=1
-bscan: bscan.c:905 Created JobMedia record JobId 1, MediaId 1
-bscan: Got EOF on device /dev/nst0
-bscan: bscan.c:693 Created Client record for Client: Rufus
-bscan: bscan.c:769 Created new JobId=2 record for original JobId=3
-bscan: bscan.c:708 Fileset "Kerns Files" already exists.
-bscan: bscan.c:819 Updated Job termination record for new JobId=2
-bscan: bscan.c:905 Created JobMedia record JobId 2, MediaId 1
-bscan: Got EOF on device /dev/nst0
-bscan: bscan.c:693 Created Client record for Client: Rufus
-bscan: bscan.c:769 Created new JobId=3 record for original JobId=4
-bscan: bscan.c:708 Fileset "Kerns Files" already exists.
-bscan: bscan.c:819 Updated Job termination record for new JobId=3
-bscan: bscan.c:905 Created JobMedia record JobId 3, MediaId 1
-bscan: Got EOF on device /dev/nst0
-bscan: bscan.c:652 Updated Media record at end of Volume: TestVolume1
-bscan: bscan.c:428 End of Volume. VolFiles=3 VolBlocks=57 VolBytes=10,027,437
-\end{verbatim}
-\normalsize
-
-The key points to note are that {\bf bscan} prints a line when each major
-record is created. Due to the volume of output, it does not print a line for
-each file record unless you supply the {\bf -v} option twice or more on the
-command line.
-
-In the case of a Job record, the new JobId will not normally be the same as
-the original Jobid. For example, for the first JobId above, the new JobId is
-1, but the original JobId is 2. This is nothing to be concerned about as it is
-the normal nature of databases. {\bf bscan} will keep everything straight.
-
-Although {\bf bscan} claims that it created a Client record for Client: Rufus
-three times, it was actually only created the first time. This is normal.
-
-You will also notice that it read an end of file after each Job (Got EOF on
-device ...). Finally the last line gives the total statistics for the bscan.
-
-If you had added a second {\bf -v} option to the command line, Bacula would
-have been even more verbose, dumping virtually all the details of each Job
-record it encountered.
-
-Now if you start Bacula and enter a {\bf list jobs} command to the console
-program, you will get:
-
-\footnotesize
-\begin{verbatim}
-+-------+----------+------------------+------+-----+----------+----------+---------+
-| JobId | Name | StartTime | Type | Lvl | JobFiles | JobBytes | JobStat |
-+-------+----------+------------------+------+-----+----------+----------+---------+
-| 1 | kernsave | 2002-10-07 14:59 | B | F | 84 | 4180207 | T |
-| 2 | kernsave | 2002-10-07 15:00 | B | I | 15 | 2170314 | T |
-| 3 | kernsave | 2002-10-07 15:01 | B | I | 33 | 3662184 | T |
-+-------+----------+------------------+------+-----+----------+----------+---------+
-\end{verbatim}
-\normalsize
-
-which corresponds virtually identically with what the database contained
-before it was re-initialized and restored with bscan. All the Jobs and Files
-found on the tape are restored including most of the Media record. The Volume
-(Media) records restored will be marked as {\bf Full} so that they cannot be
-rewritten without operator intervention.
-
-It should be noted that {\bf bscan} cannot restore a database to the exact
-condition it was in previously because a lot of the less important information
-contained in the database is not saved to the tape. Nevertheless, the
-reconstruction is sufficiently complete, that you can run {\bf restore}
-against it and get valid results.
-
-An interesting aspect of restoring a catalog backup using {\bf bscan} is
-that the backup was made while Bacula was running and writing to a tape. At
-the point the backup of the catalog is made, the tape Bacula is writing to
-will have say 10 files on it, but after the catalog backup is made, there
-will be 11 files on the tape Bacula is writing. This there is a difference
-between what is contained in the backed up catalog and what is actually on
-the tape. If after restoring a catalog, you attempt to write on the same
-tape that was used to backup the catalog, Bacula will detect the difference
-in the number of files registered in the catalog compared to what is on the
-tape, and will mark the tape in error.
-
-There are two solutions to this problem. The first is possibly the simplest
-and is to mark the volume as Used before doing any backups. The second is
-to manually correct the number of files listed in the Media record of the
-catalog. This procedure is documented elsewhere in the manual and involves
-using the {\bf update volume} command in {\bf bconsole}.
-
-\subsection{Using bscan to Correct the Volume File Count}
-\index[general]{Using bscan to Correct the Volume File Count}
-\index[general]{Count!Using bscan to Correct the Volume File Count}
-
-If the Storage daemon crashes during a backup Job, the catalog will not be
-properly updated for the Volume being used at the time of the crash. This
-means that the Storage daemon will have written say 20 files on the tape, but
-the catalog record for the Volume indicates only 19 files.
-
-Bacula refuses to write on a tape that contains a different number of files
-from what is in the catalog. To correct this situation, you may run a {\bf
-bscan} with the {\bf -m} option (but {\bf without} the {\bf -s} option) to
-update only the final Media record for the Volumes read.
-
-\subsection{After bscan}
-\index[general]{After bscan}
-\index[general]{Bscan!After}
-
-If you use {\bf bscan} to enter the contents of the Volume into an existing
-catalog, you should be aware that the records you entered may be immediately
-pruned during the next job, particularly if the Volume is very old or had been
-previously purged. To avoid this, after running {\bf bscan}, you can manually
-set the volume status (VolStatus) to {\bf Read-Only} by using the {\bf update}
-command in the catalog. This will allow you to restore from the volume without
-having it immediately purged. When you have restored and backed up the data,
-you can reset the VolStatus to {\bf Used} and the Volume will be purged from
-the catalog.
-
-\section{bcopy}
-\label{bcopy}
-\index[general]{Bcopy}
-\index[general]{program!bcopy}
-
-The {\bf bcopy} program can be used to copy one {\bf Bacula} archive file to
-another. For example, you may copy a tape to a file, a file to a tape, a file
-to a file, or a tape to a tape. For tape to tape, you will need two tape
-drives. (a later version is planned that will buffer it to disk). In the
-process of making the copy, no record of the information written to the new
-Volume is stored in the catalog. This means that the new Volume, though it
-contains valid backup data, cannot be accessed directly from existing catalog
-entries. If you wish to be able to use the Volume with the Console restore
-command, for example, you must first bscan the new Volume into the catalog.
-
-\subsection{bcopy Command Options}
-\index[general]{Options!bcopy Command}
-\index[general]{Bcopy Command Options}
-
-\footnotesize
-\begin{verbatim}
-Usage: bcopy [-d debug_level] <input-archive> <output-archive>
- -b bootstrap specify a bootstrap file
- -c <file> specify configuration file
- -dnn set debug level to nn
- -i specify input Volume names (separated by |)
- -o specify output Volume names (separated by |)
- -p proceed inspite of I/O errors
- -v verbose
- -w dir specify working directory (default /tmp)
- -? print this message
-\end{verbatim}
-\normalsize
-
-By using a {\bf bootstrap} file, you can copy parts of a Bacula archive file
-to another archive.
-
-One of the objectives of this program is to be able to recover as much data as
-possible from a damaged tape. However, the current version does not yet have
-this feature.
-
-As this is a new program, any feedback on its use would be appreciated. In
-addition, I only have a single tape drive, so I have never been able to test
-this program with two tape drives.
-
-\section{btape}
-\label{btape}
-\index[general]{Btape}
-\index[general]{program!btape}
-
-This program permits a number of elementary tape operations via a tty command
-interface. It works only with tapes and not with other kinds of Bacula
-storage media (DVD, File, ...). The {\bf test} command, described below,
-can be very useful for testing older tape drive compatibility problems.
-Aside from initial testing of tape drive compatibility with {\bf Bacula},
-{\bf btape} will be mostly used by developers writing new tape drivers.
-
-{\bf btape} can be dangerous to use with existing {\bf Bacula} tapes because
-it will relabel a tape or write on the tape if so requested regardless that
-the tape may contain valuable data, so please be careful and use it only on
-blank tapes.
-
-To work properly, {\bf btape} needs to read the Storage daemon's configuration
-file. As a default, it will look for {\bf bacula-sd.conf} in the current
-directory. If your configuration file is elsewhere, please use the {\bf -c}
-option to specify where.
-
-The physical device name must be specified on the command line, and this
-same device name must be present in the Storage daemon's configuration file
-read by {\bf btape}
-
-\footnotesize
-\begin{verbatim}
-Usage: btape <options> <device_name>
- -b <file> specify bootstrap file
- -c <file> set configuration file to file
- -d <nn> set debug level to nn
- -p proceed inspite of I/O errors
- -s turn off signals
- -v be verbose
- -? print this message.
-\end{verbatim}
-\normalsize
-
-\subsection{Using btape to Verify your Tape Drive}
-\index[general]{Using btape to Verify your Tape Drive}
-\index[general]{Drive!Using btape to Verify your Tape}
-
-An important reason for this program is to ensure that a Storage daemon
-configuration file is defined so that Bacula will correctly read and write
-tapes.
-
-It is highly recommended that you run the {\bf test} command before running
-your first Bacula job to ensure that the parameters you have defined for your
-storage device (tape drive) will permit {\bf Bacula} to function properly. You
-only need to mount a blank tape, enter the command, and the output should be
-reasonably self explanatory. Please see the
-\ilink{Tape Testing}{TapeTestingChapter} Chapter of this manual for
-the details.
-
-\subsection{btape Commands}
-\index[general]{Btape Commands}
-\index[general]{Commands!btape}
-
-The full list of commands are:
-
-\footnotesize
-\begin{verbatim}
- Command Description
- ======= ===========
- autochanger test autochanger
- bsf backspace file
- bsr backspace record
- cap list device capabilities
- clear clear tape errors
- eod go to end of Bacula data for append
- eom go to the physical end of medium
- fill fill tape, write onto second volume
- unfill read filled tape
- fsf forward space a file
- fsr forward space a record
- help print this command
- label write a Bacula label to the tape
- load load a tape
- quit quit btape
- rawfill use write() to fill tape
- readlabel read and print the Bacula tape label
- rectest test record handling functions
- rewind rewind the tape
- scan read() tape block by block to EOT and report
- scanblocks Bacula read block by block to EOT and report
- status print tape status
- test General test Bacula tape functions
- weof write an EOF on the tape
- wr write a single Bacula block
- rr read a single record
- qfill quick fill command
-\end{verbatim}
-\normalsize
-
-The most useful commands are:
-
-\begin{itemize}
-\item test -- test writing records and EOF marks and reading them back.
-\item fill -- completely fill a volume with records, then write a few records
- on a second volume, and finally, both volumes will be read back.
- This command writes blocks containing random data, so your drive will
- not be able to compress the data, and thus it is a good test of
- the real physical capacity of your tapes.
-\item readlabel -- read and dump the label on a Bacula tape.
-\item cap -- list the device capabilities as defined in the configuration
- file and as perceived by the Storage daemon.
- \end{itemize}
-
-The {\bf readlabel} command can be used to display the details of a Bacula
-tape label. This can be useful if the physical tape label was lost or damaged.
-
-
-In the event that you want to relabel a {\bf Bacula}, you can simply use the
-{\bf label} command which will write over any existing label. However, please
-note for labeling tapes, we recommend that you use the {\bf label} command in
-the {\bf Console} program since it will never overwrite a valid Bacula tape.
-
-\section{Other Programs}
-\index[general]{Programs!Other}
-\index[general]{Other Programs}
-
-The following programs are general utility programs and in general do not need
-a configuration file nor a device name.
-
-\section{bsmtp}
-\label{bsmtp}
-\index[general]{Bsmtp}
-\index[general]{program!bsmtp}
-
-{\bf bsmtp} is a simple mail transport program that permits more flexibility
-than the standard mail programs typically found on Unix systems. It can even
-be used on Windows machines.
-
-It is called:
-
-\footnotesize
-\begin{verbatim}
-Usage: bsmtp [-f from] [-h mailhost] [-s subject] [-c copy] [recipient ...]
- -c set the Cc: field
- -dnn set debug level to nn
- -f set the From: field
- -h use mailhost:port as the bsmtp server
- -l limit the lines accepted to nn
- -s set the Subject: field
- -? print this message.
-\end{verbatim}
-\normalsize
-
-If the {\bf -f} option is not specified, {\bf bsmtp} will use your userid. If
-the option {\bf -h} is not specified {\bf bsmtp} will use the value in the environment
-variable {\bf bsmtpSERVER} or if there is none {\bf localhost}. By default
-port 25 is used.
-
-If a line count limit is set with the {\bf -l} option, {\bf bsmtp} will
-not send an email with a body text exceeding that number of lines. This
-is especially useful for large restore job reports where the list of
-files restored might produce very long mails your mail-server would
-refuse or crash. However, be aware that you will probably suppress the
-job report and any error messages unless you check the log file written
-by the Director (see the messages resource in this manual for details).
-
-
-{\bf recipients} is a space separated list of email recipients.
-
-The body of the email message is read from standard input.
-
-An example of the use of {\bf bsmtp} would be to put the following statement
-in the {\bf Messages} resource of your {\bf bacula-dir.conf} file. Note, these
-commands should appear on a single line each.
-
-\footnotesize
-\begin{verbatim}
- mailcommand = "/home/bacula/bin/bsmtp -h mail.domain.com -f \"\(Bacula\) %r\"
- -s \"Bacula: %t %e of %c %l\" %r"
- operatorcommand = "/home/bacula/bin/bsmtp -h mail.domain.com -f \"\(Bacula\) %r\"
- -s \"Bacula: Intervention needed for %j\" %r"
-\end{verbatim}
-\normalsize
-
-Where you replace {\bf /home/bacula/bin} with the path to your {\bf Bacula}
-binary directory, and you replace {\bf mail.domain.com} with the fully
-qualified name of your bsmtp (email) server, which normally listens on port
-25. For more details on the substitution characters (e.g. \%r) used in the
-above line, please see the documentation of the
-\ilink{ MailCommand in the Messages Resource}{mailcommand}
-chapter of this manual.
-
-It is HIGHLY recommended that you test one or two cases by hand to make sure
-that the {\bf mailhost} that you specified is correct and that it will accept
-your email requests. Since {\bf bsmtp} always uses a TCP connection rather
-than writing in the spool file, you may find that your {\bf from} address is
-being rejected because it does not contain a valid domain, or because your
-message is caught in your spam filtering rules. Generally, you should specify
-a fully qualified domain name in the {\bf from} field, and depending on
-whether your bsmtp gateway is Exim or Sendmail, you may need to modify the
-syntax of the from part of the message. Please test.
-
-When running {\bf bsmtp} by hand, you will need to terminate the message by
-entering a ctl-d in column 1 of the last line.
-% TODO: is "column" the correct terminology for this?
-
-If you are getting incorrect dates (e.g. 1970) and you are
-running with a non-English language setting, you might try adding
-a LANG=''en\_US'' immediately before the bsmtp call.
-
-\section{dbcheck}
-\label{dbcheck}
-\index[general]{Dbcheck}
-\index[general]{program!dbcheck}
-{\bf dbcheck} is a simple program that will search for logical
-inconsistencies in the Bacula tables in your database, and optionally fix them.
-It is a database maintenance routine, in the sense that it can
-detect and remove unused rows, but it is not a database repair
-routine. To repair a database, see the tools furnished by the
-database vendor. Normally dbcheck should never need to be run,
-but if Bacula has crashed or you have a lot of Clients, Pools, or
-Jobs that you have removed, it could be useful.
-
-The {\bf dbcheck} program can be found in
-the {\bf \lt{}bacula-source\gt{}/src/tools} directory of the source
-distribution. Though it is built with the make process, it is not normally
-"installed".
-
-It is called:
-
-\footnotesize
-\begin{verbatim}
-Usage: dbcheck [-c config] [-C catalog name] [-d debug_level]
-<working-directory> <bacula-database> <user> <password> [<dbhost>]
- -b batch mode
- -C catalog name in the director conf file
- -c director conf filename
- -dnn set debug level to nn
- -f fix inconsistencies
- -v verbose
- -? print this message
-\end{verbatim}
-\normalsize
-
-If the {\bf -c} option is given with the Director's conf file, there is no
-need to enter any of the command line arguments, in particular the working
-directory as dbcheck will read them from the file.
-
-If the {\bf -f} option is specified, {\bf dbcheck} will repair ({\bf fix}) the
-inconsistencies it finds. Otherwise, it will report only.
-
-If the {\bf -b} option is specified, {\bf dbcheck} will run in batch mode, and
-it will proceed to examine and fix (if -f is set) all programmed inconsistency
-checks. If the {\bf -b} option is not specified, {\bf dbcheck} will enter
-interactive mode and prompt with the following:
-
-\footnotesize
-\begin{verbatim}
-Hello, this is the database check/correct program.
-Please select the function you want to perform.
- 1) Toggle modify database flag
- 2) Toggle verbose flag
- 3) Repair bad Filename records
- 4) Repair bad Path records
- 5) Eliminate duplicate Filename records
- 6) Eliminate duplicate Path records
- 7) Eliminate orphaned Jobmedia records
- 8) Eliminate orphaned File records
- 9) Eliminate orphaned Path records
- 10) Eliminate orphaned Filename records
- 11) Eliminate orphaned FileSet records
- 12) Eliminate orphaned Client records
- 13) Eliminate orphaned Job records
- 14) Eliminate all Admin records
- 15) Eliminate all Restore records
- 16) All (3-15)
- 17) Quit
-Select function number:
-\end{verbatim}
-\normalsize
-
-By entering 1 or 2, you can toggle the modify database flag (-f option) and
-the verbose flag (-v). It can be helpful and reassuring to turn off the modify
-database flag, then select one or more of the consistency checks (items 3
-through 9) to see what will be done, then toggle the modify flag on and re-run
-the check.
-
-The inconsistencies examined are the following:
-
-\begin{itemize}
-\item Duplicate filename records. This can happen if you accidentally run two
- copies of Bacula at the same time, and they are both adding filenames
- simultaneously. It is a rare occurrence, but will create an inconsistent
- database. If this is the case, you will receive error messages during Jobs
- warning of duplicate database records. If you are not getting these error
- messages, there is no reason to run this check.
-\item Repair bad Filename records. This checks and corrects filenames that
- have a trailing slash. They should not.
-\item Repair bad Path records. This checks and corrects path names that do
- not have a trailing slash. They should.
-\item Duplicate path records. This can happen if you accidentally run two
- copies of Bacula at the same time, and they are both adding filenames
- simultaneously. It is a rare occurrence, but will create an inconsistent
- database. See the item above for why this occurs and how you know it is
- happening.
-\item Orphaned JobMedia records. This happens when a Job record is deleted
- (perhaps by a user issued SQL statement), but the corresponding JobMedia
- record (one for each Volume used in the Job) was not deleted. Normally, this
- should not happen, and even if it does, these records generally do not take
- much space in your database. However, by running this check, you can
- eliminate any such orphans.
-\item Orphaned File records. This happens when a Job record is deleted
- (perhaps by a user issued SQL statement), but the corresponding File record
- (one for each Volume used in the Job) was not deleted. Note, searching for
- these records can be {\bf very} time consuming (i.e. it may take hours) for a
- large database. Normally this should not happen as Bacula takes care to
- prevent it. Just the same, this check can remove any orphaned File records.
- It is recommended that you run this once a year since orphaned File records
- can take a large amount of space in your database. You might
- want to ensure that you have indexes on JobId, FilenameId, and
- PathId for the File table in your catalog before running this
- command.
-\item Orphaned Path records. This condition happens any time a directory is
- deleted from your system and all associated Job records have been purged.
- During standard purging (or pruning) of Job records, Bacula does not check
- for orphaned Path records. As a consequence, over a period of time, old
- unused Path records will tend to accumulate and use space in your database.
- This check will eliminate them. It is recommended that you run this
- check at least once a year.
-\item Orphaned Filename records. This condition happens any time a file is
- deleted from your system and all associated Job records have been purged.
- This can happen quite frequently as there are quite a large number of files
- that are created and then deleted. In addition, if you do a system update or
- delete an entire directory, there can be a very large number of Filename
- records that remain in the catalog but are no longer used.
-
- During standard purging (or pruning) of Job records, Bacula does not check
- for orphaned Filename records. As a consequence, over a period of time, old
- unused Filename records will accumulate and use space in your database. This
- check will eliminate them. It is strongly recommended that you run this check
- at least once a year, and for large database (more than 200 Megabytes), it is
- probably better to run this once every 6 months.
-\item Orphaned Client records. These records can remain in the database long
- after you have removed a client.
-\item Orphaned Job records. If no client is defined for a job or you do not
- run a job for a long time, you can accumulate old job records. This option
- allow you to remove jobs that are not attached to any client (and thus
- useless).
-\item All Admin records. This command will remove all Admin records,
- regardless of their age.
-\item All Restore records. This command will remove all Restore records,
- regardless of their age.
-\end{itemize}
-
-By the way, I personally run dbcheck only where I have messed up
-my database due to a bug in developing Bacula code, so normally
-you should never need to run dbcheck in spite of the
-recommendations given above, which are given so that users don't
-waste their time running dbcheck too often.
-
-\section{bregex}
-\label{bregex}
-\index[general]{bregex}
-\index[general]{program!bregex}
-
-{\bf bregex} is a simple program that will allow you to test
-regular expressions against a file of data. This can be useful
-because the regex libraries on most systems differ, and in
-addition, regex expressions can be complicated.
-
-{\bf bregex} is found in the src/tools directory and it is
-normally installed with your system binaries. To run it, use:
-
-\begin{verbatim}
-Usage: bregex [-d debug_level] -f <data-file>
- -f specify file of data to be matched
- -l suppress line numbers
- -n print lines that do not match
- -? print this message.
-\end{verbatim}
-
-The \lt{}data-file\gt{} is a filename that contains lines
-of data to be matched (or not) against one or more patterns.
-When the program is run, it will prompt you for a regular
-expression pattern, then apply it one line at a time against
-the data in the file. Each line that matches will be printed
-preceded by its line number. You will then be prompted again
-for another pattern.
-
-Enter an empty line for a pattern to terminate the program. You
-can print only lines that do not match by using the -n option,
-and you can suppress printing of line numbers with the -l option.
-
-This program can be useful for testing regex expressions to be
-applied against a list of filenames.
-
-\section{bwild}
-\label{bwild}
-\index[general]{bwild}
-\index[general]{program!bwild}
-
-{\bf bwild} is a simple program that will allow you to test
-wild-card expressions against a file of data.
-
-{\bf bwild} is found in the src/tools directory and it is
-normally installed with your system binaries. To run it, use:
-
-\begin{verbatim}
-Usage: bwild [-d debug_level] -f <data-file>
- -f specify file of data to be matched
- -l suppress line numbers
- -n print lines that do not match
- -? print this message.
-\end{verbatim}
-
-The \lt{}data-file\gt{} is a filename that contains lines
-of data to be matched (or not) against one or more patterns.
-When the program is run, it will prompt you for a wild-card
-pattern, then apply it one line at a time against
-the data in the file. Each line that matches will be printed
-preceded by its line number. You will then be prompted again
-for another pattern.
-
-Enter an empty line for a pattern to terminate the program. You
-can print only lines that do not match by using the -n option,
-and you can suppress printing of line numbers with the -l option.
-
-This program can be useful for testing wild expressions to be
-applied against a list of filenames.
-
-\section{testfind}
-\label{testfind}
-\index[general]{Testfind}
-\index[general]{program!testfind}
-
-{\bf testfind} permits listing of files using the same search engine that is
-used for the {\bf Include} resource in Job resources. Note, much of the
-functionality of this program (listing of files to be included) is present in
-the
-\ilink{estimate command}{estimate} in the Console program.
-
-The original use of testfind was to ensure that Bacula's file search engine
-was correct and to print some statistics on file name and path length.
-However, you may find it useful to see what bacula would do with a given {\bf
-Include} resource. The {\bf testfind} program can be found in the {\bf
-\lt{}bacula-source\gt{}/src/tools} directory of the source distribution.
-Though it is built with the make process, it is not normally "installed".
-
-It is called:
-
-\footnotesize
-\begin{verbatim}
-Usage: testfind [-d debug_level] [-] [pattern1 ...]
- -a print extended attributes (Win32 debug)
- -dnn set debug level to nn
- - read pattern(s) from stdin
- -? print this message.
-Patterns are used for file inclusion -- normally directories.
-Debug level>= 1 prints each file found.
-Debug level>= 10 prints path/file for catalog.
-Errors are always printed.
-Files/paths truncated is a number with len> 255.
-Truncation is only in the catalog.
-\end{verbatim}
-\normalsize
-
-Where a pattern is any filename specification that is valid within an {\bf
-Include} resource definition. If none is specified, {\bf /} (the root
-directory) is assumed. For example:
-
-\footnotesize
-\begin{verbatim}
-./testfind /bin
-\end{verbatim}
-\normalsize
-
-Would print the following:
-
-\footnotesize
-\begin{verbatim}
-Dir: /bin
-Reg: /bin/bash
-Lnk: /bin/bash2 -> bash
-Lnk: /bin/sh -> bash
-Reg: /bin/cpio
-Reg: /bin/ed
-Lnk: /bin/red -> ed
-Reg: /bin/chgrp
-...
-Reg: /bin/ipcalc
-Reg: /bin/usleep
-Reg: /bin/aumix-minimal
-Reg: /bin/mt
-Lnka: /bin/gawk-3.1.0 -> /bin/gawk
-Reg: /bin/pgawk
-Total files : 85
-Max file length: 13
-Max path length: 5
-Files truncated: 0
-Paths truncated: 0
-\end{verbatim}
-\normalsize
-
-Even though {\bf testfind} uses the same search engine as {\bf Bacula}, each
-directory to be listed, must be entered as a separate command line entry or
-entered one line at a time to standard input if the {\bf -} option was
-specified.
-
-Specifying a debug level of one (i.e. {\bf -d1}) on the command line will
-cause {\bf testfind} to print the raw filenames without showing the Bacula
-internal file type, or the link (if any). Debug levels of 10 or greater cause
-the filename and the path to be separated using the same algorithm that is
-used when putting filenames into the Catalog database.
+++ /dev/null
-%%
-%%
-
-\chapter{Bacula RPM Packaging FAQ}
-\label{RpmFaqChapter}
-\index[general]{FAQ!Bacula\textsuperscript{\textregistered} - RPM Packaging }
-\index[general]{Bacula\textsuperscript{\textregistered} - RPM Packaging FAQ }
-
-\begin{enumerate}
-\item
- \ilink{How do I build Bacula for platform xxx?}{faq1}
-\item
- \ilink{How do I control which database support gets built?}{faq2}
-
-\item
- \ilink{What other defines are used?}{faq3}
-\item
- \ilink{I'm getting errors about not having permission when I try to build the
- packages. Do I need to be root?}{faq4}
-\item
- \ilink{I'm building my own rpms but on all platforms and compiles I get an
- unresolved dependency for something called
- /usr/afsws/bin/pagsh.}{faq5}
-\item
- \ilink{I'm building my own rpms because you don't publish for my platform.
- Can I get my packages released to sourceforge for other people to use?}{faq6}
-\item
- \ilink{Is there an easier way than sorting out all these command line options?}{faq7}
-\item
- \ilink{I just upgraded from 1.36.x to 1.38.x and now my director daemon won't start. It appears to start but dies silently and I get a "connection refused" error when starting the console. What is wrong?}{faq8}
-\item
- \ilink{There are a lot of rpm packages. Which packages do I need for what?}{faq9}
-\end{enumerate}
-
-\section{Answers}
-\index[general]{Answers }
-
-\begin{enumerate}
-\item
- \label{faq1}
- {\bf How do I build Bacula for platform xxx?}
- The bacula spec file contains defines to build for several platforms:
- Red Hat 7.x (rh7), Red Hat 8.0 (rh8), Red Hat 9 (rh9), Fedora Core (fc1,
- fc3, fc4, fc5, fc6, fc7, fc8), Whitebox Enterprise Linux 3.0 (wb3), Red Hat Enterprise Linux
- (rhel3, rhel4, rhel5), Mandrake 10.x (mdk), Mandriva 2006.x (mdv) CentOS (centos3, centos4, centos5)
- Scientific Linux (sl3, sl4, sl5) and SuSE (su9, su10, su102, su103, su110). The package build is controlled by a mandatory define set at the beginning of the file. These defines basically just control the dependency information that gets coded into the finished rpm package as well
- as any special configure options required. The platform define may be edited
- in the spec file directly (by default all defines are set to 0 or "not set").
- For example, to build the Red Hat 7.x package find the line in the spec file
- which reads
-
-\footnotesize
-\begin{verbatim}
- %define rh7 0
-
-\end{verbatim}
-\normalsize
-
-and edit it to read
-
-\footnotesize
-\begin{verbatim}
- %define rh7 1
-
-\end{verbatim}
-\normalsize
-
-Alternately you may pass the define on the command line when calling rpmbuild:
-
-
-\footnotesize
-\begin{verbatim}
- rpmbuild -ba --define "build_rh7 1" bacula.spec
- rpmbuild --rebuild --define build_rh7 1" bacula-x.x.x-x.src.rpm
-
-\end{verbatim}
-\normalsize
-
-\item
- \label{faq2}
- {\bf How do I control which database support gets built?}
- Another mandatory build define controls which database support is compiled,
- one of build\_sqlite, build\_mysql or build\_postgresql. To get the MySQL
- package and support either set the
-
-\footnotesize
-\begin{verbatim}
- %define mysql 0
- OR
- %define mysql4 0
- OR
- %define mysql5 0
-
-\end{verbatim}
-\normalsize
-
-to
-
-\footnotesize
-\begin{verbatim}
- %define mysql 1
- OR
- %define mysql4 1
- OR
- %define mysql5 1
-
-\end{verbatim}
-\normalsize
-
-in the spec file directly or pass it to rpmbuild on the command line:
-
-\footnotesize
-\begin{verbatim}
- rpmbuild -ba --define "build_rh7 1" --define "build_mysql 1" bacula.spec
- rpmbuild -ba --define "build_rh7 1" --define "build_mysql4 1" bacula.spec
- rpmbuild -ba --define "build_rh7 1" --define "build_mysql5 1" bacula.spec
-
-\end{verbatim}
-\normalsize
-
-\item
- \label{faq3}
- {\bf What other defines are used?}
- Three other building defines of note are the depkgs\_version, docs\_version and
- \_rescuever identifiers. These two defines are set with each release and must
- match the version of those sources that are being used to build the packages.
- You would not ordinarily need to edit these. See also the Build Options section
- below for other build time options that can be passed on the command line.
-\item
- \label{faq4}
- {\bf I'm getting errors about not having permission when I try to build the
- packages. Do I need to be root?}
- No, you do not need to be root and, in fact, it is better practice to
- build rpm packages as a non-root user. Bacula packages are designed to
- be built by a regular user but you must make a few changes on your
- system to do this. If you are building on your own system then the
- simplest method is to add write permissions for all to the build
- directory (/usr/src/redhat/, /usr/src/RPM or /usr/src/packages).
- To accomplish this, execute the following command as root:
-
-\footnotesize
-\begin{verbatim}
- chmod -R 777 /usr/src/redhat
- chmod -R 777 /usr/src/RPM
- chmod -R 777 /usr/src/packages
-
-\end{verbatim}
-\normalsize
-
-If you are working on a shared system where you can not use the method
-above then you need to recreate the appropriate above directory tree with all
-of its subdirectories inside your home directory. Then create a file named
-
-{\tt .rpmmacros}
-
-in your home directory (or edit the file if it already exists)
-and add the following line:
-
-\footnotesize
-\begin{verbatim}
- %_topdir /home/myuser/redhat
- %_tmppath /tmp
-
-\end{verbatim}
-\normalsize
-
-Another handy directive for the .rpmmacros file if you wish to suppress the
-creation of debug rpm packages is:
-
-\footnotesize
-\begin{verbatim}
- %debug_package %{nil}
-
-\end{verbatim}
-
-\normalsize
-
-\item
- \label{faq5}
- {\bf I'm building my own rpms but on all platforms and compiles I get an
- unresolved dependency for something called /usr/afsws/bin/pagsh.} This
- is a shell from the OpenAFS (Andrew File System). If you are seeing
- this then you chose to include the docs/examples directory in your
- package. One of the example scripts in this directory is a pagsh
- script. Rpmbuild, when scanning for dependencies, looks at the shebang
- line of all packaged scripts in addition to checking shared libraries.
- To avoid this do not package the examples directory. If you are seeing this
- problem you are building a very old bacula package as the examples have been
- removed from the doc packaging.
-
-\item
- \label{faq6}
- {\bf I'm building my own rpms because you don't publish for my platform.
- Can I get my packages released to sourceforge for other people to use?} Yes,
- contributions from users are accepted and appreciated. Please examine the
- directory platforms/contrib-rpm in the source code for further information.
-
-\item
- \label{faq7}
- {\bf Is there an easier way than sorting out all these command line options?} Yes,
- there is a gui wizard shell script which you can use to rebuild the src rpm package.
- Look in the source archive for platforms/contrib-rpm/rpm\_wizard.sh. This script will
- allow you to specify build options using GNOME dialog screens. It requires zenity.
-
-\item
- \label{faq8}
- {\bf I just upgraded from 1.36.x to 1.38.x and now my director daemon
-won't start. It appears to start but dies silently and I get a "connection
-refused" error when starting the console. What is wrong?} Beginning with
-1.38 the rpm packages are configured to run the director and storage
-daemons as a non-root user. The file daemon runs as user root and group
-bacula, the storage daemon as user bacula and group disk, and the director
-as user bacula and group bacula. If you are upgrading you will need to
-change some file permissions for things to work. Execute the following
-commands as root:
-
-\footnotesize
-\begin{verbatim}
- chown bacula.bacula /var/bacula/*
- chown root.bacula /var/bacula/bacula-fd.9102.state
- chown bacula.disk /var/bacula/bacula-sd.9103.state
-
-\end{verbatim}
-\normalsize
-
-Further, if you are using File storage volumes rather than tapes those
-files will also need to have ownership set to user bacula and group bacula.
-
-\item
- \label{faq9}
- {\bf There are a lot of rpm packages. Which packages do I need for
-what?} For a bacula server you need to select the packsge based upon your
-preferred catalog database: one of bacula-mysql, bacula-postgresql or
-bacula-sqlite. If your system does not provide an mtx package you also
-need bacula-mtx to satisfy that dependancy. For a client machine you need
-only install bacula-client. Optionally, for either server or client
-machines, you may install a graphical console bacula-gconsole and/or
-bacula-wxconsole. The Bacula Administration Tool is installed with the
-bacula-bat package. One last package, bacula-updatedb is required only when
-upgrading a server more than one database revision level.
-
-
-
-\item {\bf Support for RHEL3/4/5, CentOS 3/4/5, Scientific Linux 3/4/5 and x86\_64}
- The examples below show
- explicit build support for RHEL4 and CentOS 4. Build support
- for x86\_64 has also been added.
-\end{enumerate}
-
-\footnotesize
-\begin{verbatim}
-Build with one of these 3 commands:
-
-rpmbuild --rebuild \
- --define "build_rhel4 1" \
- --define "build_sqlite 1" \
- bacula-1.38.3-1.src.rpm
-
-rpmbuild --rebuild \
- --define "build_rhel4 1" \
- --define "build_postgresql 1" \
- bacula-1.38.3-1.src.rpm
-
-rpmbuild --rebuild \
- --define "build_rhel4 1" \
- --define "build_mysql4 1" \
- bacula-1.38.3-1.src.rpm
-
-For CentOS substitute '--define "build_centos4 1"' in place of rhel4.
-For Scientific Linux substitute '--define "build_sl4 1"' in place of rhel4.
-
-For 64 bit support add '--define "build_x86_64 1"'
-\end{verbatim}
-\normalsize
-
-\section{Build Options}
-\index[general]{Build Options}
-The spec file currently supports building on the following platforms:
-\footnotesize
-\begin{verbatim}
-Red Hat builds
---define "build_rh7 1"
---define "build_rh8 1"
---define "build_rh9 1"
-
-Fedora Core build
---define "build_fc1 1"
---define "build_fc3 1"
---define "build_fc4 1"
---define "build_fc5 1"
---define "build_fc6 1"
---define "build_fc7 1"
---define "build_fc8 1"
---define "build_fc9 1"
-
-Whitebox Enterprise build
---define "build_wb3 1"
-
-Red Hat Enterprise builds
---define "build_rhel3 1"
---define "build_rhel4 1"
---define "build_rhel5 1"
-
-CentOS build
---define "build_centos3 1"
---define "build_centos4 1"
---define "build_centos5 1"
-
-Scientific Linux build
---define "build_sl3 1"
---define "build_sl4 1"
---define "build_sl5 1"
-
-SuSE build
---define "build_su9 1"
---define "build_su10 1"
---define "build_su102 1"
---define "build_su103 1"
---define "build_su110 1"
---define "build_su111 1"
-
-Mandrake 10.x build
---define "build_mdk 1"
-
-Mandriva build
---define "build_mdv 1"
-
-MySQL support:
-for mysql 3.23.x support define this
---define "build_mysql 1"
-if using mysql 4.x define this,
-currently: Mandrake 10.x, Mandriva 2006.0, SuSE 9.x & 10.0, FC4 & RHEL4
---define "build_mysql4 1"
-if using mysql 5.x define this,
-currently: SuSE 10.1 & FC5
---define "build_mysql5 1"
-
-PostgreSQL support:
---define "build_postgresql 1"
-
-Sqlite support:
---define "build_sqlite 1"
-
-Build the client rpm only in place of one of the above database full builds:
---define "build_client_only 1"
-
-X86-64 support:
---define "build_x86_64 1"
-
-Supress build of bgnome-console:
---define "nobuild_gconsole 1"
-
-Build the WXWindows console:
-requires wxGTK >= 2.6
---define "build_wxconsole 1"
-
-Build the Bacula Administration Tool:
-requires QT >= 4.2
---define "build_bat 1"
-
-Build python scripting support:
---define "build_python 1"
-
-Modify the Packager tag for third party packages:
---define "contrib_packager Your Name <youremail@site.org>"
-
-Install most files to /opt/bacula directory:
---define "single_dir_install 1"
-
-Supress building the rescue files:
---define "nobuild_rescue 1"
-
-\end{verbatim}
-\normalsize
-
-\section{RPM Install Problems}
-\index[general]{RPM Install Problems}
-In general the RPMs, once properly built should install correctly.
-However, when attempting to run the daemons, a number of problems
-can occur:
-\begin{itemize}
-\item [Wrong /var/bacula Permissions]
- By default, the Director and Storage daemon do not run with
- root permission. If the /var/bacula is owned by root, then it
- is possible that the Director and the Storage daemon will not
- be able to access this directory, which is used as the Working
- Directory. To fix this, the easiest thing to do is:
-\begin{verbatim}
- chown bacula:bacula /var/bacula
-\end{verbatim}
- Note: as of 1.38.8 /var/bacula is installed root:bacula with
- permissions 770.
-\item [The Storage daemon cannot Access the Tape drive]
- This can happen in some older RPM releases where the Storage
- daemon ran under userid bacula, group bacula. There are two
- ways of fixing this: the best is to modify the /etc/init.d/bacula-sd
- file so that it starts the Storage daemon with group "disk".
- The second way to fix the problem is to change the permissions
- of your tape drive (usually /dev/nst0) so that Bacula can access it.
- You will probably need to change the permissions of the SCSI control
- device as well, which is usually /dev/sg0. The exact names depend
- on your configuration, please see the Tape Testing chapter for
- more information on devices.
-\end{itemize}
-
+++ /dev/null
-/*
- * html2latex
- */
-
-available {
- sun4_sunos.4
- sun4_solaris.2
- rs_aix.3
- rs_aix.4
- sgi_irix
-}
-
-description {
- From Jeffrey Schaefer, Geometry Center. Translates HTML document to LaTeX
-}
-
-install {
- bin/html2latex /afs/rpi.edu/dept/acs/rpinfo/filters/GChtml2latex/html2latex
- bin/html2latex.tag /afs/rpi.edu/dept/acs/rpinfo/filters/GChtml2latex/html2latex.tag
- bin/html2latex-local.tag /afs/rpi.edu/dept/acs/rpinfo/filters/GChtml2latex/html2latex-local.tag
- bin/webtex2latex.tag /afs/rpi.edu/dept/acs/rpinfo/filters/GChtml2latex/webtex2latex.tag
- man/man1/html2latex.1 /afs/rpi.edu/dept/acs/rpinfo/filters/GChtml2latex/html2latex.1
-}
+++ /dev/null
-#!/usr/bin/perl -w
-#
-use strict;
-
-# Used to change the names of the image files generated by latex2html from imgxx.png
-# to meaningful names. Provision is made to go either from or to the meaningful names.
-# The meaningful names are obtained from a file called imagename_translations, which
-# is generated by extensions to latex2html in the make_image_file subroutine in
-# bacula.perl.
-
-# Opens the file imagename_translations and reads the contents into a hash.
-# The hash is creaed with the imgxx.png files as the key if processing TO
-# meaningful filenames, and with the meaningful filenames as the key if
-# processing FROM meaningful filenames.
-# Then opens the html file(s) indicated in the command-line arguments and
-# changes all image references according to the translations described in the
-# above file. Finally, it renames the image files.
-#
-# Original creation: 3-27-05 by Karl Cunningham.
-# Modified 5-21-05 to go FROM and TO meaningful filenames.
-#
-my $TRANSFILE = "imagename_translations";
-my $path;
-
-# Loads the contents of $TRANSFILE file into the hash referenced in the first
-# argument. The hash is loaded to translate old to new if $direction is 0,
-# otherwise it is loaded to translate new to old. In this context, the
-# 'old' filename is the meaningful name, and the 'new' filename is the
-# imgxx.png filename. It is assumed that the old image is the one that
-# latex2html has used as the source to create the imgxx.png filename.
-# The filename extension is taken from the file
-sub read_transfile {
- my ($trans,$direction) = @_;
-
- if (!open IN,"<$path$TRANSFILE") {
- print "WARNING: Cannot open image translation file $path$TRANSFILE for reading\n";
- print " Image filename translation aborted\n\n";
- exit 0;
- }
-
- while (<IN>) {
- chomp;
- my ($new,$old) = split(/\001/);
-
- # Old filenames will usually have a leading ./ which we don't need.
- $old =~ s/^\.\///;
-
- # The filename extension of the old filename must be made to match
- # the new filename because it indicates the encoding format of the image.
- my ($ext) = $new =~ /(\.[^\.]*)$/;
- $old =~ s/\.[^\.]*$/$ext/;
- if ($direction == 0) {
- $trans->{$new} = $old;
- } else {
- $trans->{$old} = $new;
- }
- }
- close IN;
-}
-
-# Translates the image names in the file given as the first argument, according to
-# the translations in the hash that is given as the second argument.
-# The file contents are read in entirely into a string, the string is processed, and
-# the file contents are then written. No particular care is taken to ensure that the
-# file is not lost if a system failure occurs at an inopportune time. It is assumed
-# that the html files being processed here can be recreated on demand.
-#
-# Links to other files are added to the %filelist for processing. That way,
-# all linked files will be processed (assuming they are local).
-sub translate_html {
- my ($filename,$trans,$filelist) = @_;
- my ($contents,$out,$this,$img,$dest);
- my $cnt = 0;
-
- # If the filename is an external link ignore it. And drop any file:// from
- # the filename.
- $filename =~ /^(http|ftp|mailto)\:/ and return 0;
- $filename =~ s/^file\:\/\///;
- # Load the contents of the html file.
- if (!open IF,"<$path$filename") {
- print "WARNING: Cannot open $path$filename for reading\n";
- print " Image Filename Translation aborted\n\n";
- exit 0;
- }
-
- while (<IF>) {
- $contents .= $_;
- }
- close IF;
-
- # Now do the translation...
- # First, search for an image filename.
- while ($contents =~ /\<\s*IMG[^\>]*SRC=\"/si) {
- $contents = $';
- $out .= $` . $&;
-
- # The next thing is an image name. Get it and translate it.
- $contents =~ /^(.*?)\"/s;
- $contents = $';
- $this = $&;
- $img = $1;
- # If the image is in our list of ones to be translated, do it
- # and feed the result to the output.
- $cnt += $this =~ s/$img/$trans->{$img}/ if (defined($trans->{$img}));
- $out .= $this;
- }
- $out .= $contents;
-
- # Now send the translated text to the html file, overwriting what's there.
- open OF,">$path$filename" or die "Cannot open $path$filename for writing\n";
- print OF $out;
- close OF;
-
- # Now look for any links to other files and add them to the list of files to do.
- while ($out =~ /\<\s*A[^\>]*HREF=\"(.*?)\"/si) {
- $out = $';
- $dest = $1;
- # Drop an # and anything after it.
- $dest =~ s/\#.*//;
- $filelist->{$dest} = '' if $dest;
- }
- return $cnt;
-}
-
-# REnames the image files spefified in the %translate hash.
-sub rename_images {
- my $translate = shift;
- my ($response);
-
- foreach (keys(%$translate)) {
- if (! $translate->{$_}) {
- print " WARNING: No destination Filename for $_\n";
- } else {
- $response = `mv -f $path$_ $path$translate->{$_} 2>&1`;
- $response and print "ERROR from system $response\n";
- }
- }
-}
-
-#################################################
-############# MAIN #############################
-################################################
-
-# %filelist starts out with keys from the @ARGV list. As files are processed,
-# any links to other files are added to the %filelist. A hash of processed
-# files is kept so we don't do any twice.
-
-# The first argument must be either --to_meaningful_names or --from_meaningful_names
-
-my (%translate,$search_regex,%filelist,%completed,$thisfile);
-my ($cnt,$direction);
-
-my $arg0 = shift(@ARGV);
-$arg0 =~ /^(--to_meaningful_names|--from_meaningful_names)$/ or
- die "ERROR: First argument must be either \'--to_meaningful_names\' or \'--from_meaningful_names\'\n";
-
-$direction = ($arg0 eq '--to_meaningful_names') ? 0 : 1;
-
-(@ARGV) or die "ERROR: Filename(s) to process must be given as arguments\n";
-
-# Use the first argument to get the path to the file of translations.
-my $tmp = $ARGV[0];
-($path) = $tmp =~ /(.*\/)/;
-$path = '' unless $path;
-
-read_transfile(\%translate,$direction);
-
-foreach (@ARGV) {
- # Strip the path from the filename, and use it later on.
- if (s/(.*\/)//) {
- $path = $1;
- } else {
- $path = '';
- }
- $filelist{$_} = '';
-
- while ($thisfile = (keys(%filelist))[0]) {
- $cnt += translate_html($thisfile,\%translate,\%filelist) if (!exists($completed{$thisfile}));
- delete($filelist{$thisfile});
- $completed{$thisfile} = '';
- }
- print "translate_images.pl: $cnt image filenames translated ",($direction)?"from":"to"," meaningful names\n";
-}
-
-rename_images(\%translate);
+++ /dev/null
-[General]
-img_extIsRegExp=false
-img_extensions=.eps .jpg .jpeg .png .pdf .ps .fig .gif
-kileprversion=2
-kileversion=2.0
-lastDocument=utility.tex
-masterDocument=
-name=Utility
-pkg_extIsRegExp=false
-pkg_extensions=.cls .sty
-src_extIsRegExp=false
-src_extensions=.tex .ltx .latex .dtx .ins
-
-[Tools]
-MakeIndex=
-QuickBuild=
-
-[item:fdl.tex]
-archive=true
-column=34
-encoding=
-highlight=LaTeX
-line=0
-open=false
-order=1
-
-[item:progs.tex]
-archive=true
-column=0
-encoding=
-highlight=LaTeX
-line=0
-open=false
-order=0
-
-[item:rpm-faq.tex]
-archive=true
-column=0
-encoding=
-highlight=
-line=0
-open=false
-order=-1
-
-[item:utility.kilepr]
-archive=true
-column=103
-encoding=
-highlight=
-line=0
-open=false
-order=-1
-
-[item:utility.tex]
-archive=true
-column=36
-encoding=UTF-8
-highlight=LaTeX
-line=53
-open=true
-order=0
-
-[item:version.tex]
-archive=true
-column=0
-encoding=
-highlight=
-line=0
-open=false
-order=-1
+++ /dev/null
-%%
-%%
-%% The following characters must be preceded by a backslash
-%% to be entered as printable characters:
-%%
-%% # $ % & ~ _ ^ \ { }
-%%
-
-\documentclass[10pt,a4paper]{book}
-
-\topmargin -0.5in
-\oddsidemargin 0.0in
-\evensidemargin 0.0in
-\textheight 10in
-\textwidth 6.5in
-
-\usepackage{html}
-\usepackage{float}
-\usepackage{graphicx}
-\usepackage{bacula}
-\usepackage{longtable}
-\usepackage{makeidx}
-\usepackage{index}
-\usepackage{setspace}
-\usepackage{hyperref}
-\usepackage{url}
-
-
-\makeindex
-\newindex{general}{idx}{ind}{General Index}
-
-\sloppy
-
-\begin{document}
-\sloppy
-
-\newfont{\bighead}{cmr17 at 36pt}
-\parskip 10pt
-\parindent 0pt
-
-\title{\includegraphics{\idir bacula-logo.eps} \\ \bigskip
- \Huge{Bacula Utility Programs}
- \begin{center}
- \large{It comes in the night and sucks
- the essence from your computers. }
- \end{center}
-}
-
-
-\author{Kern Sibbald}
-\date{\vspace{1.0in}\today \\
- This manual documents Bacula version \input{version} \\
- \vspace{0.2in}
- Copyright \copyright 1999-2009, Free Software Foundation Europe
- e.V. \\
- \vspace{0.2in}
- Permission is granted to copy, distribute and/or modify this document under the terms of the
- GNU Free Documentation License, Version 1.2 published by the Free Software Foundation;
- with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
- A copy of the license is included in the section entitled "GNU Free Documentation License".
-}
-
-\maketitle
-
-\clearpage
-\tableofcontents
-\clearpage
-\listoffigures
-\clearpage
-\listoftables
-\clearpage
-
-\include{progs}
-\include{bimagemgr-chapter}
-\include{rpm-faq}
-\include{fdl}
-
-
-% The following line tells link_resolver.pl to not include these files:
-% nolinks developersi baculai-dir baculai-fd baculai-sd baculai-console baculai-main
-
-% pull in the index
-\clearpage
-\printindex[general]
-
-\end{document}
tex:
- @./update_version
+ @../../update_version
@echo "Making version `cat version.tex`"
@cp -fp ${IMAGES}/hires/*.eps .
@touch ${DOC}i-dir.tex ${DOC}i-fd.tex ${DOC}i-sd.tex \
tex:
- @./update_version
+ @../../update_version
@echo "Making version `cat version.tex`"
@cp -fp ${IMAGES}/hires/*.eps .
@touch ${DOC}i-dir.tex ${DOC}i-fd.tex ${DOC}i-sd.tex \
--- /dev/null
+#
+# Avoid that @VERSION@ and @DATE@ are changed by configure
+# This file is sourced by update_version
+#
+echo "s%@VERSION@%${VERSION}%g" >${out}
+echo "s%@DATE@%${DATE}%g" >>${out}
tex:
- @./update_version
+ @../../update_version
@echo "Making version `cat version.tex`"
@cp -fp ${IMAGES}/hires/*.eps .
@touch ${DOC}i-dir.tex ${DOC}i-fd.tex ${DOC}i-sd.tex \
+++ /dev/null
-#
-# Avoid that @VERSION@ and @DATE@ are changed by configure
-# This file is sourced by update_version
-#
-echo "s%@VERSION@%${VERSION}%g" >${out}
-echo "s%@DATE@%${DATE}%g" >>${out}
tex:
+ @../../update_version
@cp -fp ${IMAGES}/hires/*.eps .
touch ${DOC}.idx ${DOC}i-general.tex
-latex -interaction=batchmode ${DOC}.tex
+++ /dev/null
-#
-# Avoid that @VERSION@ and @DATE@ are changed by configure
-# This file is sourced by update_version
-#
-echo "s%@VERSION@%${VERSION}%g" >${out}
-echo "s%@DATE@%${DATE}%g" >>${out}
tex:
- @./update_version
+ @../../update_version
@echo "Making version `cat version.tex`"
@cp -fp ${IMAGES}/hires/*.eps .
@touch ${DOC}i-dir.tex ${DOC}i-fd.tex ${DOC}i-sd.tex \
+++ /dev/null
-#
-# Avoid that @VERSION@ and @DATE@ are changed by configure
-# This file is sourced by update_version
-#
-echo "s%@VERSION@%${VERSION}%g" >${out}
-echo "s%@DATE@%${DATE}%g" >>${out}
tex:
- @./update_version
+ @../../update_version
@echo "Making version `cat version.tex`"
@cp -fp ${IMAGES}/hires/*.eps .
@touch ${DOC}i-dir.tex ${DOC}i-fd.tex ${DOC}i-sd.tex \
+++ /dev/null
-#
-# Avoid that @VERSION@ and @DATE@ are changed by configure
-# This file is sourced by update_version
-#
-echo "s%@VERSION@%${VERSION}%g" >${out}
-echo "s%@DATE@%${DATE}%g" >>${out}
tex:
- @./update_version
+ @../../update_version
@echo "Making version `cat version.tex`"
@cp -fp ${IMAGES}/hires/*.eps .
@touch ${DOC}i-dir.tex ${DOC}i-fd.tex ${DOC}i-sd.tex \
+++ /dev/null
-#
-# Avoid that @VERSION@ and @DATE@ are changed by configure
-# This file is sourced by update_version
-#
-echo "s%@VERSION@%${VERSION}%g" >${out}
-echo "s%@DATE@%${DATE}%g" >>${out}
tex:
- @./update_version
+ @../../update_version
@echo "Making version `cat version.tex`"
@cp -fp ${IMAGES}/hires/*.eps .
@touch ${DOC}i-dir.tex ${DOC}i-fd.tex ${DOC}i-sd.tex \
+++ /dev/null
-#
-# Avoid that @VERSION@ and @DATE@ are changed by configure
-# This file is sourced by update_version
-#
-echo "s%@VERSION@%${VERSION}%g" >${out}
-echo "s%@DATE@%${DATE}%g" >>${out}
tex:
- @./update_version
+ @../../update_version
@echo "Making version `cat version.tex`"
@cp -fp ${IMAGES}/hires/*.eps .
@touch ${DOC}i-dir.tex ${DOC}i-fd.tex ${DOC}i-sd.tex \
tex:
+ @../../update_version
@cp -fp ${IMAGES}/hires/*.eps .
touch ${DOC}.idx ${DOC}i-general.tex
-latex -interaction=batchmode ${DOC}.tex
tex:
- @./update_version
+ @../../update_version
@echo "Making version `cat version.tex`"
@cp -fp ${IMAGES}/hires/*.eps .
@touch ${DOC}i-dir.tex ${DOC}i-fd.tex ${DOC}i-sd.tex \
tex:
- @./update_version
+ @../../update_version
@echo "Making version `cat version.tex`"
@cp -fp ${IMAGES}/hires/*.eps .
@touch ${DOC}i-dir.tex ${DOC}i-fd.tex ${DOC}i-sd.tex \
tex:
- @./update_version
+ @../../update_version
@echo "Making version `cat version.tex`"
@cp -fp ${IMAGES}/hires/*.eps .
@touch ${DOC}i-dir.tex ${DOC}i-fd.tex ${DOC}i-sd.tex \
tex:
- @./update_version
+ @../../update_version
@echo "Making version `cat version.tex`"
@cp -fp ${IMAGES}/hires/*.eps .
@touch ${DOC}i-dir.tex ${DOC}i-fd.tex ${DOC}i-sd.tex \
tex:
- @./update_version
+ @../../update_version
@echo "Making version `cat version.tex`"
@cp -fp ${IMAGES}/hires/*.eps .
@touch ${DOC}i-dir.tex ${DOC}i-fd.tex ${DOC}i-sd.tex \
tex:
+ @../../update_version
@cp -fp ${IMAGES}/hires/*.eps .
touch ${DOC}.idx ${DOC}i-general.tex
-latex -interaction=batchmode ${DOC}.tex
tex:
- @./update_version
+ @../../update_version
@echo "Making version `cat version.tex`"
@cp -fp ${IMAGES}/hires/*.eps .
@touch ${DOC}i-dir.tex ${DOC}i-fd.tex ${DOC}i-sd.tex \
tex:
- @./update_version
+ @../../update_version
@echo "Making version `cat version.tex`"
@cp -fp ${IMAGES}/hires/*.eps .
@touch ${DOC}i-dir.tex ${DOC}i-fd.tex ${DOC}i-sd.tex \
tex:
- @./update_version
+ @../../update_version
@echo "Making version `cat version.tex`"
@cp -fp ${IMAGES}/hires/*.eps .
@touch ${DOC}i-dir.tex ${DOC}i-fd.tex ${DOC}i-sd.tex \
tex:
- @./update_version
+ @../../update_version
@echo "Making version `cat version.tex`"
@cp -fp ${IMAGES}/hires/*.eps .
@touch ${DOC}i-dir.tex ${DOC}i-fd.tex ${DOC}i-sd.tex \
out=/tmp/$$
VERSION=`sed -n -e 's/^.*VERSION.*"\(.*\)"$/\1/p' @bacula@/src/version.h`
DATE=`sed -n -e 's/^.*[ \t]*BDATE.*"\(.*\)"$/\1/p' @bacula@/src/version.h`
-. ./do_echo
+. @BUILD_DIR@/manuals/do_echo
sed -f ${out} @BUILD_DIR@/manuals/version.tex.in >version.tex
rm -f ${out}
exit 1
fi
cwd=`pwd`
-echo $cwd
lang=$1
+src=$cwd/manuals/${lang}
+
+dest=bacula:/var/www/bacula/3.1.x-manuals/${lang}
+
for i in console developers main misc problems utility; do
echo " "
- echo "Sending: $cwd/manuals/${lang}/$i"
- echo "To: /var/www/bacula/3.1.x-manuals/${lang}/$i"
- (cd $cwd/manuals/${lang}/$i; \
- scp -r -P 2020 $i/ bacula.org:/var/www/bacula/3.1.x-manuals/${lang}/$i/; \
- scp -P 2020 $i.pdf bacula.org:/var/www/bacula/3.1.x-manuals/${lang}/$i/)
+ echo "Sending: $src/$i"
+ echo "To: $dest/$i"
+ rsync -avz --delete -e ssh $src/$i/ $dest/$i/
+ rsync -avz --delete -e ssh $src/$i/$i.pdf $dest/$i/
done
-# rsync --stats -c -r . bacula.org:/var/www/bacula/3.1.x-manuals/en/catalog/catalog
projects / bacula / docs / commitdiff