From: Kern Sibbald Date: Thu, 20 Feb 2014 19:27:45 +0000 (+0100) Subject: Commit two patches from Philippe to cleanup the manuals X-Git-Tag: Release-7.0.0~23 X-Git-Url: https://git.sur5r.net/?p=bacula%2Fdocs;a=commitdiff_plain;h=a44246354b5915e45ccdac8c19ac0eea46f6aa16 Commit two patches from Philippe to cleanup the manuals --- diff --git a/docs/Makefile.in b/docs/Makefile.in index 43771b19..36845e37 100644 --- a/docs/Makefile.in +++ b/docs/Makefile.in @@ -45,6 +45,27 @@ all: done @echo "All manuals built ..." + +external-references: + @echo " " + @echo -n "Building external references file..." + @find ${en_dirs} -mindepth 0 -maxdepth 1 -name "*tex" -exec grep -q '\label' {} \; -print| awk -F/ '{ print "\\externaldocument[" $$3 "-]{../"$$3"/"$$4"}"}'|sed -e 's/.tex//g' > `pwd`/latex/external-references.tex + @for I in ${en_dirs}; \ + do (cd $$I; echo "==>Entering directory `pwd`"; \ + $(MAKE) $@ || (echo ""; echo ""; echo " ====== Error in `pwd` ======"; \ + echo ""; echo ""; exit 1;)); \ + done + @echo "External references for all manuals built." + +pdftex: external-references + @for I in ${en_dirs}; \ + do (cd $$I; echo "==>Entering directory `pwd`"; \ + $(MAKE) $@ || (echo ""; echo ""; echo " ====== Error in `pwd` ======"; \ + echo ""; echo ""; exit 1;)); \ + done + @echo "All manuals built ..." + + bacula-web: (cd bacula-web; make) diff --git a/docs/images/bat.svg b/docs/images/bat.svg deleted file mode 100644 index 038d10ed..00000000 --- a/docs/images/bat.svg +++ /dev/null @@ -1,449 +0,0 @@ - - - - - - - - image/svg+xml - - Bacula bat vectorized - 2009-04-27 - - - Philippe Chauvat - - - - - Creative Commons - - - - - Philippe Chauvat - - - Vectorized from BAT bitmap version - - - bat bacula - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/images/duplicate-real.svg b/docs/images/duplicate-real.svg deleted file mode 100644 index 12ea80d8..00000000 --- a/docs/images/duplicate-real.svg +++ /dev/null @@ -1,1138 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - image/svg+xml - - - - - - - - - - - - JobA 1st - - - JobA 2nd - - - - A duplicate job in the sense we use it here means a second or subsequent job with the same name starts. - Allow Duplicate Jobs - Yes - no - - - - Run - - Cancel LowerLevel Duplicates - - Yes - no - - - Cancel RunningDuplicates - yes - - No - - Cancel 1st - - Run 2nd - - Cancel QueuedDuplicates - yes - No - - - - Cancel 2nd - - is 1st queued(not yet running) - no - - - level(2nd) > level(1st)ex: Full > Incremental - - Cancel 2nd - yes - - - no - yes - - - level(1st) > level(2nd)ex: Full > Incremental - - Cancel 1stRun 2nd - - - yes - no - - diff --git a/docs/latex/ChangeLog b/docs/latex/ChangeLog new file mode 100644 index 00000000..2303a12d --- /dev/null +++ b/docs/latex/ChangeLog @@ -0,0 +1,4 @@ +2014-02-03 Philippe Chauvat + + * README: Creation. + diff --git a/docs/latex/README b/docs/latex/README new file mode 100644 index 00000000..8d00f460 --- /dev/null +++ b/docs/latex/README @@ -0,0 +1,7 @@ +This directory is intended to contain specific class, data, informations +about the "new" layout documentation for the bacula.org manuals. + +A copy of the latex book class is built which will include a front page. +This front page is located into the images/svg directory (source file) and +the result is pushed to images/pdf directory. If you want to know more about this +please read the README file in the images/svg directory. diff --git a/docs/latex/borgmanual.cls b/docs/latex/borgmanual.cls new file mode 100644 index 00000000..90fa7506 --- /dev/null +++ b/docs/latex/borgmanual.cls @@ -0,0 +1,789 @@ +%% +%% This is file `borgmanual.cls', +%% This file is a modified copy of the book.cls class. +%% +%% The original source files were: +%% +%% classes.dtx (with options: `book') +%% +%% This is a generated file. +%% +%% Copyright 1993 1994 1995 1996 1997 1998 1999 2000 2001 +%% The LaTeX3 Project and any individual authors listed elsewhere +%% in this file. +%% +%% This file was generated from file(s) of the LaTeX base system. +%% -------------------------------------------------------------- +%% +%% It may be distributed and/or modified under the +%% conditions of the LaTeX Project Public License, either version 1.2 +%% of this license or (at your option) any later version. +%% The latest version of this license is in +%% http://www.latex-project.org/lppl.txt +%% and version 1.2 or later is part of all distributions of LaTeX +%% version 1999/12/01 or later. +%% +%% This file may only be distributed together with a copy of the LaTeX +%% base system. You may however distribute the LaTeX base system without +%% such generated files. +%% +%% The list of all files belonging to the LaTeX base distribution is +%% given in the file `manifest.txt'. See also `legal.txt' for additional +%% information. +%% +%% \CharacterTable +%% {Upper-case \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z +%% Lower-case \a\b\c\d\e\f\g\h\i\j\k\l\m\n\o\p\q\r\s\t\u\v\w\x\y\z +%% Digits \0\1\2\3\4\5\6\7\8\9 +%% Exclamation \! Double quote \" Hash (number) \# +%% Dollar \$ Percent \% Ampersand \& +%% Acute accent \' Left paren \( Right paren \) +%% Asterisk \* Plus \+ Comma \, +%% Minus \- Point \. Solidus \/ +%% Colon \: Semicolon \; Less than \< +%% Equals \= Greater than \> Question mark \? +%% Commercial at \@ Left bracket \[ Backslash \\ +%% Right bracket \] Circumflex \^ Underscore \_ +%% Grave accent \` Left brace \{ Vertical bar \| +%% Right brace \} Tilde \~} +\NeedsTeXFormat{LaTeX2e}[1995/12/01] +\ProvidesClass{borgmanual} + [2014/03/02 v1.0 + Standard bacula.org Book LaTeX document class] +\usepackage{eso-pic,atxy,graphicx,color,ifthen} +\definecolor{bluebat}{cmyk}{0.38, 0.17, 0.0, 0.27} +\AtBeginDocument{\setlength\parindent{0pt}} +\newcommand\@ptsize{} +\newif\if@restonecol +\newif\if@titlepage +\@titlepagetrue +\newif\if@openright +\newif\if@mainmatter\@mainmattertrue +\newif\if@appendix +\@appendixfalse +\if@compatibility\else +\DeclareOption{a4paper} + {\setlength\paperheight {297mm}% + \setlength\paperwidth {210mm}} +\DeclareOption{a5paper} + {\setlength\paperheight {210mm}% + \setlength\paperwidth {148mm}} +\DeclareOption{b5paper} + {\setlength\paperheight {250mm}% + \setlength\paperwidth {176mm}} +\DeclareOption{letterpaper} + {\setlength\paperheight {11in}% + \setlength\paperwidth {8.5in}} +\DeclareOption{legalpaper} + {\setlength\paperheight {14in}% + \setlength\paperwidth {8.5in}} +\DeclareOption{executivepaper} + {\setlength\paperheight {10.5in}% + \setlength\paperwidth {7.25in}} +\DeclareOption{landscape} + {\setlength\@tempdima {\paperheight}% + \setlength\paperheight {\paperwidth}% + \setlength\paperwidth {\@tempdima}} +\fi +\if@compatibility + \renewcommand\@ptsize{0} +\else +\DeclareOption{10pt}{\renewcommand\@ptsize{0}} +\fi +\DeclareOption{11pt}{\renewcommand\@ptsize{1}} +\DeclareOption{12pt}{\renewcommand\@ptsize{2}} +\if@compatibility\else +\DeclareOption{oneside}{\@twosidefalse \@mparswitchfalse} +\fi +\DeclareOption{twoside}{\@twosidetrue \@mparswitchtrue} +\DeclareOption{draft}{\setlength\overfullrule{5pt}} +\if@compatibility\else +\DeclareOption{final}{\setlength\overfullrule{0pt}} +\fi +\DeclareOption{titlepage}{\@titlepagetrue} +\if@compatibility\else +\DeclareOption{notitlepage}{\@titlepagefalse} +\fi +\if@compatibility +\@openrighttrue +\else +\DeclareOption{openright}{\@openrighttrue} +\DeclareOption{openany}{\@openrightfalse} +\fi +\if@compatibility\else +\DeclareOption{onecolumn}{\@twocolumnfalse} +\fi +\DeclareOption{twocolumn}{\@twocolumntrue} +\DeclareOption{leqno}{\input{leqno.clo}} +\DeclareOption{fleqn}{\input{fleqn.clo}} +\DeclareOption{openbib}{% + \AtEndOfPackage{% + \renewcommand\@openbib@code{% + \advance\leftmargin\bibindent + \itemindent -\bibindent + \listparindent \itemindent + \parsep \z@ + }% + \renewcommand\newblock{\par}}% +} +\ExecuteOptions{a4paper,10pt,twoside,onecolumn,final,openright} +\ProcessOptions +\def\borgcoverpage{borg-coverpage} +\def\borgoddpage{borg-odd} +\def\borgevenpage{borg-even} +\input{bk1\@ptsize.clo} +\setlength\lineskip{1\p@} +\setlength\normallineskip{1\p@} +\renewcommand\baselinestretch{} +\setlength\parskip{0\p@ \@plus \p@} +\@lowpenalty 51 +\@medpenalty 151 +\@highpenalty 301 + + +\newcommand\BackgroundPic{% + \put(0,0){% + \parbox[b][\paperheight]{\paperwidth}{% + \vfill% + \centering% + \if@appendix% + \else + \ifodd\c@page% + \includegraphics[width=\paperwidth,height=\paperheight,keepaspectratio]{\borgoddpage}% + \else% + \includegraphics[width=\paperwidth,height=\paperheight,keepaspectratio]{\borgevenpage}% + \fi + \fi + \vfill + } + } +} + +\setcounter{topnumber}{2} +\renewcommand\topfraction{.7} +\setcounter{bottomnumber}{1} +\renewcommand\bottomfraction{.3} +\setcounter{totalnumber}{3} +\renewcommand\textfraction{.2} +\renewcommand\floatpagefraction{.5} +\setcounter{dbltopnumber}{2} +\renewcommand\dbltopfraction{.7} +\renewcommand\dblfloatpagefraction{.5} + +\if@twoside + \def\ps@headings{% + \let\@oddfoot\@empty\let\@evenfoot\@empty + \def\@evenhead{\thepage\hfil\slshape\leftmark}% + \def\@oddhead{{\slshape\rightmark}\hfil\thepage}% + \let\@mkboth\markboth + \def\chaptermark##1{% + \markboth {\MakeUppercase{% + \ifnum \c@secnumdepth >\m@ne + \if@mainmatter + \@chapapp\ \thechapter. \ % + \fi + \fi + ##1}}{}}% + \def\sectionmark##1{% + \markright {\MakeUppercase{% + \ifnum \c@secnumdepth >\z@ + \thesection. \ % + \fi + ##1}}}} +\else + \def\ps@headings{% + \let\@oddfoot\@empty + \def\@oddhead{{\slshape\rightmark}\hfil\thepage}% + \let\@mkboth\markboth + \def\chaptermark##1{% + \markright {\MakeUppercase{% + \ifnum \c@secnumdepth >\m@ne + \if@mainmatter + \@chapapp\ \thechapter. \ % + \fi + \fi + ##1}}}} +\fi +\def\ps@myheadings{% + \let\@oddfoot\@empty\let\@evenfoot\@empty + \def\@evenhead{\thepage\hfil\slshape\leftmark}% + \def\@oddhead{{\slshape\rightmark}\hfil\thepage}% + \let\@mkboth\@gobbletwo + \let\chaptermark\@gobble + \let\sectionmark\@gobble + } +\if@titlepage +\newcommand\maketitle{ + \begin{titlepage}% + \thispagestyle{empty} + \atxy(0mm,0mm){\includegraphics{\borgcoverpage}} + \let\footnotesize\small + \let\footnoterule\relax + \let \footnote \thanks + \atxy(56mm,120mm){% + \begin{minipage}{137mm}% + \begin{center}% + {\Huge \@title \par}% + \vskip 2em% + {\large + \lineskip .5em% + \begin{tabular}[t]{c}% + \@author + \end{tabular}\par}% + \vskip 0.5em% + {\large \@date \par}% % Set date in \large size. + \end{center}\par + \end{minipage}% +} + \@thanks + \vfil\null + \end{titlepage}% + \AddToShipoutPicture{\BackgroundPic} + \setcounter{footnote}{0}% + \global\let\thanks\relax + \global\let\maketitle\relax + \global\let\@thanks\@empty + \global\let\@author\@empty + \global\let\@date\@empty + \global\let\@title\@empty + \global\let\title\relax + \global\let\author\relax + \global\let\date\relax + \global\let\and\relax +} +\else +\newcommand\maketitle{\par + \begingroup + \renewcommand\thefootnote{\@fnsymbol\c@footnote}% + \def\@makefnmark{\rlap{\@textsuperscript{\normalfont\@thefnmark}}}% + \long\def\@makefntext##1{\parindent 1em\noindent + \hb@xt@1.8em{% + \hss\@textsuperscript{\normalfont\@thefnmark}}##1}% + \if@twocolumn + \ifnum \col@number=\@ne + \@maketitle + \else + \twocolumn[\@maketitle]% + \fi + \else +% \newpage + \global\@topnum\z@ % Prevents figures from going at top of page. + \@maketitle + \fi + \thispagestyle{empty}\@thanks + \endgroup + \setcounter{footnote}{0}% + \global\let\thanks\relax + \global\let\maketitle\relax + \global\let\@maketitle\relax + \global\let\@thanks\@empty +% \global\let\@author\@empty + \global\let\@date\@empty +% \global\let\@title\@empty + \global\let\title\relax + \global\let\author\relax + \global\let\date\relax + \global\let\and\relax +} +\def\@maketitle{% +% \newpage + \null + \vskip 2em% + \begin{center}% + \let \footnote \thanks + {\LARGE \@title \par}% + \vskip 1.5em% + {\large + \lineskip .5em% + \begin{tabular}[t]{c}% + \@author + \end{tabular}\par}% + \vskip 1em% + {\large \@date}% + \end{center}% + \par + \vskip 1.5em +} +\fi + +\newcommand*\chaptermark[1]{} +\setcounter{secnumdepth}{2} +\newcounter {part} +\newcounter {chapter} +\newcounter {section}[chapter] +\newcounter {subsection}[section] +\newcounter {subsubsection}[subsection] +\newcounter {paragraph}[subsubsection] +\newcounter {subparagraph}[paragraph] +\renewcommand \thepart {\@Roman\c@part} +\renewcommand \thechapter {\@arabic\c@chapter} +\renewcommand \thesection {\thechapter.\@arabic\c@section} +\renewcommand\thesubsection {\thesection.\@arabic\c@subsection} +\renewcommand\thesubsubsection{\thesubsection .\@arabic\c@subsubsection} +\renewcommand\theparagraph {\thesubsubsection.\@arabic\c@paragraph} +\renewcommand\thesubparagraph {\theparagraph.\@arabic\c@subparagraph} +\newcommand\@chapapp{\chaptername} +\newcommand\frontmatter{% + \cleardoublepage + \@mainmatterfalse + \pagenumbering{roman}} +\newcommand\mainmatter{% + \cleardoublepage + \@mainmattertrue + \pagenumbering{arabic}} +\newcommand\backmatter{% + \if@openright + \cleardoublepage + \else + \clearpage + \fi + \@mainmatterfalse} +\newcommand\part{% + \if@openright + \cleardoublepage + \else + \clearpage + \fi + \thispagestyle{plain}% + \if@twocolumn + \onecolumn + \@tempswatrue + \else + \@tempswafalse + \fi + \null\vfil + \secdef\@part\@spart} + +\def\@part[#1]#2{% + \ifnum \c@secnumdepth >-2\relax + \refstepcounter{part}% + \addcontentsline{toc}{part}{\thepart\hspace{1em}#1}% + \else + \addcontentsline{toc}{part}{#1}% + \fi + \markboth{}{}% + {\centering + \interlinepenalty \@M + \normalfont + \ifnum \c@secnumdepth >-2\relax + \huge\bfseries \partname\nobreakspace\thepart + \par + \vskip 20\p@ + \fi + \Huge \bfseries #2\par}% + \@endpart} +\def\@spart#1{% + {\centering + \interlinepenalty \@M + \normalfont + \Huge \bfseries #1\par}% + \@endpart} +\def\@endpart{\vfil\newpage + \if@twoside + \if@openright + \null +% \thispagestyle{empty}% + \newpage + \fi + \fi + \if@tempswa + \twocolumn + \fi} +\newcommand\chapter{\if@openright\cleardoublepage\else\clearpage\fi + \thispagestyle{plain}% + \global\@topnum\z@ + \@afterindentfalse + \secdef\@chapter\@schapter} +\def\@chapter[#1]#2{\ifnum \c@secnumdepth >\m@ne + \if@mainmatter + \refstepcounter{chapter}% + \typeout{\@chapapp\space\thechapter.}% + \addcontentsline{toc}{chapter}% + {\protect\numberline{\thechapter}#1}% + \else + \addcontentsline{toc}{chapter}{#1}% + \fi + \else + \addcontentsline{toc}{chapter}{#1}% + \fi + \chaptermark{#1}% + \addtocontents{lof}{\protect\addvspace{10\p@}}% + \addtocontents{lot}{\protect\addvspace{10\p@}}% + \if@twocolumn + \@topnewpage[\@makechapterhead{#2}]% + \else + \@makechapterhead{#2}% + \@afterheading + \fi} +\def\@makechapterhead#1{% + \vspace*{50\p@}% + {\parindent \z@ \raggedright \normalfont + \ifnum \c@secnumdepth >\m@ne + \if@mainmatter + \huge\bfseries \@chapapp\space \thechapter + \par\nobreak + \vskip 20\p@ + \fi + \fi + \interlinepenalty\@M + \Huge \bfseries \textcolor{bluebat}{#1}\par\nobreak + \vskip 40\p@ + }} +\def\@schapter#1{\if@twocolumn + \@topnewpage[\@makeschapterhead{#1}]% + \else + \@makeschapterhead{#1}% + \@afterheading + \fi} +\def\@makeschapterhead#1{% + \vspace*{50\p@}% + {\parindent \z@ \raggedright + \normalfont + \interlinepenalty\@M + \Huge \bfseries +#1 +\par\nobreak + \vskip 40\p@ + }} +\newcommand\section{\@startsection {section}{1}{\z@}% + {-3.5ex \@plus -1ex \@minus -.2ex}% + {2.3ex \@plus.2ex}% + {\normalfont\Large\bfseries}} +\newcommand\subsection{\@startsection{subsection}{2}{\z@}% + {-3.25ex\@plus -1ex \@minus -.2ex}% + {1.5ex \@plus .2ex}% + {\normalfont\large\bfseries}} +\newcommand\subsubsection{\@startsection{subsubsection}{3}{\z@}% + {-3.25ex\@plus -1ex \@minus -.2ex}% + {1.5ex \@plus .2ex}% + {\normalfont\normalsize\bfseries}} +\newcommand\paragraph{\@startsection{paragraph}{4}{\z@}% + {3.25ex \@plus1ex \@minus.2ex}% + {-1em}% + {\normalfont\normalsize\bfseries}} +\newcommand\subparagraph{\@startsection{subparagraph}{5}{\parindent}% + {3.25ex \@plus1ex \@minus .2ex}% + {-1em}% + {\normalfont\normalsize\bfseries}} +\if@twocolumn + \setlength\leftmargini {2em} +\else + \setlength\leftmargini {2.5em} +\fi +\leftmargin \leftmargini +\setlength\leftmarginii {2.2em} +\setlength\leftmarginiii {1.87em} +\setlength\leftmarginiv {1.7em} +\if@twocolumn + \setlength\leftmarginv {.5em} + \setlength\leftmarginvi {.5em} +\else + \setlength\leftmarginv {1em} + \setlength\leftmarginvi {1em} +\fi +\setlength \labelsep {.5em} +\setlength \labelwidth{\leftmargini} +\addtolength\labelwidth{-\labelsep} +\@beginparpenalty -\@lowpenalty +\@endparpenalty -\@lowpenalty +\@itempenalty -\@lowpenalty +\renewcommand\theenumi{\@arabic\c@enumi} +\renewcommand\theenumii{\@alph\c@enumii} +\renewcommand\theenumiii{\@roman\c@enumiii} +\renewcommand\theenumiv{\@Alph\c@enumiv} +\newcommand\labelenumi{\theenumi.} +\newcommand\labelenumii{(\theenumii)} +\newcommand\labelenumiii{\theenumiii.} +\newcommand\labelenumiv{\theenumiv.} +\renewcommand\p@enumii{\theenumi} +\renewcommand\p@enumiii{\theenumi(\theenumii)} +\renewcommand\p@enumiv{\p@enumiii\theenumiii} +\newcommand\labelitemi{\textbullet} +\newcommand\labelitemii{\normalfont\bfseries \textendash} +\newcommand\labelitemiii{\textasteriskcentered} +\newcommand\labelitemiv{\textperiodcentered} +\newenvironment{description} + {\list{}{\labelwidth\z@ \itemindent-\leftmargin + \let\makelabel\descriptionlabel}} + {\endlist} +\newcommand*\descriptionlabel[1]{\hspace\labelsep + \normalfont\bfseries #1} +\newenvironment{verse} + {\let\\\@centercr + \list{}{\itemsep \z@ + \itemindent -1.5em% + \listparindent\itemindent + \rightmargin \leftmargin + \advance\leftmargin 1.5em}% + \item\relax} + {\endlist} +\newenvironment{quotation} + {\list{}{\listparindent 1.5em% + \itemindent \listparindent + \rightmargin \leftmargin + \parsep \z@ \@plus\p@}% + \item\relax} + {\endlist} +\newenvironment{quote} + {\list{}{\rightmargin\leftmargin}% + \item\relax} + {\endlist} +\if@compatibility +\newenvironment{titlepage} + {% + \cleardoublepage + \if@twocolumn + \@restonecoltrue\onecolumn + \else + \@restonecolfalse\newpage + \fi + \thispagestyle{empty}% + \setcounter{page}\z@ + }% + {\if@restonecol\twocolumn \else\newpage \fi + } +\else +\newenvironment{titlepage} + {% + \cleardoublepage + \if@twocolumn + \@restonecoltrue\onecolumn + \else + \@restonecolfalse\newpage + \fi + \thispagestyle{empty} % + \setcounter{page}\@ne + }% + {\if@restonecol\twocolumn \else\newpage \fi + \if@twoside\else + \setcounter{page}\@ne + \fi + } +\fi +\newcommand\appendix{\par + \setcounter{chapter}{0}% + \setcounter{section}{0}% + \gdef\@chapapp{\appendixname}% + \gdef\thechapter{\@Alph\c@chapter} +} +\setlength\arraycolsep{5\p@} +\setlength\tabcolsep{6\p@} +\setlength\arrayrulewidth{.4\p@} +\setlength\doublerulesep{2\p@} +\setlength\tabbingsep{\labelsep} +\skip\@mpfootins = \skip\footins +\setlength\fboxsep{3\p@} +\setlength\fboxrule{.4\p@} +\@addtoreset {equation}{chapter} +\renewcommand\theequation + {\ifnum \c@chapter>\z@ \thechapter.\fi \@arabic\c@equation} +\newcounter{figure}[chapter] +\renewcommand \thefigure + {\ifnum \c@chapter>\z@ \thechapter.\fi \@arabic\c@figure} +\def\fps@figure{tbp} +\def\ftype@figure{1} +\def\ext@figure{lof} +\def\fnum@figure{\figurename\nobreakspace\thefigure} +\newenvironment{figure} + {\@float{figure}} + {\end@float} +\newenvironment{figure*} + {\@dblfloat{figure}} + {\end@dblfloat} +\newcounter{table}[chapter] +\renewcommand \thetable + {\ifnum \c@chapter>\z@ \thechapter.\fi \@arabic\c@table} +\def\fps@table{tbp} +\def\ftype@table{2} +\def\ext@table{lot} +\def\fnum@table{\tablename\nobreakspace\thetable} +\newenvironment{table} + {\@float{table}} + {\end@float} +\newenvironment{table*} + {\@dblfloat{table}} + {\end@dblfloat} +\newlength\abovecaptionskip +\newlength\belowcaptionskip +\setlength\abovecaptionskip{10\p@} +\setlength\belowcaptionskip{10\p@} +\long\def\@makecaption#1#2{% + \vskip\abovecaptionskip + \sbox\@tempboxa{#1: #2}% + \ifdim \wd\@tempboxa >\hsize + #1: #2\par + \else + \global \@minipagefalse + \hb@xt@\hsize{\hfil\box\@tempboxa\hfil}% + \fi + \vskip\belowcaptionskip} +\DeclareOldFontCommand{\rm}{\normalfont\rmfamily}{\mathrm} +\DeclareOldFontCommand{\sf}{\normalfont\sffamily}{\mathsf} +\DeclareOldFontCommand{\tt}{\normalfont\ttfamily}{\mathtt} +\DeclareOldFontCommand{\bf}{\normalfont\bfseries}{\mathbf} +\DeclareOldFontCommand{\it}{\normalfont\itshape}{\mathit} +\DeclareOldFontCommand{\sl}{\normalfont\slshape}{\@nomath\sl} +\DeclareOldFontCommand{\sc}{\normalfont\scshape}{\@nomath\sc} +\DeclareRobustCommand*\cal{\@fontswitch\relax\mathcal} +\DeclareRobustCommand*\mit{\@fontswitch\relax\mathnormal} +\newcommand\@pnumwidth{1.55em} +\newcommand\@tocrmarg{2.55em} +\newcommand\@dotsep{4.5} +\setcounter{tocdepth}{2} +\newcommand\tableofcontents{% + \if@twocolumn + \@restonecoltrue\onecolumn + \else + \@restonecolfalse + \fi + \chapter*{\contentsname + \@mkboth{% + \MakeUppercase\contentsname}{\MakeUppercase\contentsname}}% + \@starttoc{toc}% + \if@restonecol\twocolumn\fi + } +\newcommand*\l@part[2]{% + \ifnum \c@tocdepth >-2\relax + \addpenalty{-\@highpenalty}% + \addvspace{2.25em \@plus\p@}% + \setlength\@tempdima{3em}% + \begingroup + \parindent \z@ \rightskip \@pnumwidth + \parfillskip -\@pnumwidth + {\leavevmode + \large \bfseries #1\hfil \hb@xt@\@pnumwidth{\hss #2}}\par + \nobreak + \global\@nobreaktrue + \everypar{\global\@nobreakfalse\everypar{}}% + \endgroup + \fi} +\newcommand*\l@chapter[2]{% + \ifnum \c@tocdepth >\m@ne + \addpenalty{-\@highpenalty}% + \vskip 1.0em \@plus\p@ + \setlength\@tempdima{1.5em}% + \begingroup + \parindent \z@ \rightskip \@pnumwidth + \parfillskip -\@pnumwidth + \leavevmode \bfseries + \advance\leftskip\@tempdima + \hskip -\leftskip + #1\nobreak\hfil \nobreak\hb@xt@\@pnumwidth{\hss #2}\par + \penalty\@highpenalty + \endgroup + \fi} +\newcommand*\l@section{\@dottedtocline{1}{1.5em}{2.3em}} +\newcommand*\l@subsection{\@dottedtocline{2}{3.8em}{3.2em}} +\newcommand*\l@subsubsection{\@dottedtocline{3}{7.0em}{4.1em}} +\newcommand*\l@paragraph{\@dottedtocline{4}{10em}{5em}} +\newcommand*\l@subparagraph{\@dottedtocline{5}{12em}{6em}} +\newcommand\listoffigures{% + \if@twocolumn + \@restonecoltrue\onecolumn + \else + \@restonecolfalse + \fi + \chapter*{\listfigurename}% + \@mkboth{\MakeUppercase\listfigurename}% + {\MakeUppercase\listfigurename}% + \@starttoc{lof}% + \if@restonecol\twocolumn\fi + } +\newcommand*\l@figure{\@dottedtocline{1}{1.5em}{2.3em}} +\newcommand\listoftables{% + \if@twocolumn + \@restonecoltrue\onecolumn + \else + \@restonecolfalse + \fi + \chapter*{\listtablename}% + \@mkboth{% + \MakeUppercase\listtablename}% + {\MakeUppercase\listtablename}% + \@starttoc{lot}% + \if@restonecol\twocolumn\fi + } +\let\l@table\l@figure +\newdimen\bibindent +\setlength\bibindent{1.5em} +\newenvironment{thebibliography}[1] + {\chapter*{\bibname}% + \@mkboth{\MakeUppercase\bibname}{\MakeUppercase\bibname}% + \list{\@biblabel{\@arabic\c@enumiv}}% + {\settowidth\labelwidth{\@biblabel{#1}}% + \leftmargin\labelwidth + \advance\leftmargin\labelsep + \@openbib@code + \usecounter{enumiv}% + \let\p@enumiv\@empty + \renewcommand\theenumiv{\@arabic\c@enumiv}}% + \sloppy + \clubpenalty4000 + \@clubpenalty \clubpenalty + \widowpenalty4000% + \sfcode`\.\@m} + {\def\@noitemerr + {\@latex@warning{Empty `thebibliography' environment}}% + \endlist} +\newcommand\newblock{\hskip .11em\@plus.33em\@minus.07em} +\let\@openbib@code\@empty +\newenvironment{theindex} + {\if@twocolumn + \@restonecolfalse + \else + \@restonecoltrue + \fi + \columnseprule \z@ + \columnsep 35\p@ + \twocolumn[\@makeschapterhead{\indexname}]% + \@mkboth{\MakeUppercase\indexname}% + {\MakeUppercase\indexname}% + \thispagestyle{plain}\parindent\z@ + \parskip\z@ \@plus .3\p@\relax + \let\item\@idxitem} + {\if@restonecol\onecolumn\else\clearpage\fi} +\newcommand\@idxitem{\par\hangindent 40\p@} +\newcommand\subitem{\@idxitem \hspace*{20\p@}} +\newcommand\subsubitem{\@idxitem \hspace*{30\p@}} +\newcommand\indexspace{\par \vskip 10\p@ \@plus5\p@ \@minus3\p@\relax} +\renewcommand\footnoterule{% + \kern-3\p@ + \hrule\@width.4\columnwidth + \kern2.6\p@} +\@addtoreset{footnote}{chapter} +\newcommand\@makefntext[1]{% + \parindent 1em% + \noindent + \hb@xt@1.8em{\hss\@makefnmark}#1} +\newcommand\contentsname{Contents} +\newcommand\listfigurename{List of Figures} +\newcommand\listtablename{List of Tables} +\newcommand\bibname{Bibliography} +\newcommand\indexname{Index} +\newcommand\figurename{Figure} +\newcommand\tablename{Table} +\newcommand\partname{Part} +\newcommand\chaptername{Chapter} +\newcommand\appendixname{Appendix} +\def\today{\ifcase\month\or + January\or February\or March\or April\or May\or June\or + July\or August\or September\or October\or November\or December\fi + \space\number\day, \number\year} +\setlength\columnsep{10\p@} +\setlength\columnseprule{0\p@} +\pagestyle{headings} +\pagenumbering{arabic} +\if@twoside +\else + \raggedbottom +\fi +\if@twocolumn + \twocolumn + \sloppy + \flushbottom +\else + \onecolumn +\fi +\endinput +%% +%% End of file `borgmanual.cls'. diff --git a/docs/latex/external-references.tex b/docs/latex/external-references.tex new file mode 100644 index 00000000..db550cff --- /dev/null +++ b/docs/latex/external-references.tex @@ -0,0 +1,90 @@ +\externaldocument[console-]{../console/fdl} +\externaldocument[console-]{../console/bconsole} +\externaldocument[developers-]{../developers/gui-interface} +\externaldocument[developers-]{../developers/storage} +\externaldocument[developers-]{../developers/fdl} +\externaldocument[developers-]{../developers/platformsupport} +\externaldocument[developers-]{../developers/git} +\externaldocument[developers-]{../developers/mempool} +\externaldocument[developers-]{../developers/regression} +\externaldocument[developers-]{../developers/generaldevel} +\externaldocument[developers-]{../developers/catalog} +\externaldocument[developers-]{../developers/director} +\externaldocument[developers-]{../developers/mediaformat} +\externaldocument[developers-]{../developers/file} +\externaldocument[developers-]{../developers/tls-techdoc} +\externaldocument[developers-]{../developers/daemonprotocol} +\externaldocument[developers-]{../developers/porting} +\externaldocument[developers-]{../developers/netprotocol} +\externaldocument[developers-]{../developers/smartall} +\externaldocument[developers-]{../developers/md5} +\externaldocument[main-]{../main/mysql} +\externaldocument[main-]{../main/tls} +\externaldocument[main-]{../main/disk} +\externaldocument[main-]{../main/state} +\externaldocument[main-]{../main/fdl} +\externaldocument[main-]{../main/critical} +\externaldocument[main-]{../main/basejob} +\externaldocument[main-]{../main/gpl} +\externaldocument[main-]{../main/main} +\externaldocument[main-]{../main/statistics} +\externaldocument[main-]{../main/consoleconf} +\externaldocument[main-]{../main/configure} +\externaldocument[main-]{../main/monitorconf} +\externaldocument[main-]{../main/bugs} +\externaldocument[main-]{../main/filedconf} +\externaldocument[main-]{../main/dataencryption} +\externaldocument[main-]{../main/thanks} +\externaldocument[main-]{../main/license} +\externaldocument[main-]{../main/general} +\externaldocument[main-]{../main/recycling} +\externaldocument[main-]{../main/win32} +\externaldocument[main-]{../main/fileset} +\externaldocument[main-]{../main/ansi-labels} +\externaldocument[main-]{../main/rescue} +\externaldocument[main-]{../main/install} +\externaldocument[main-]{../main/security} +\externaldocument[main-]{../main/dirdconf} +\externaldocument[main-]{../main/strategies} +\externaldocument[main-]{../main/verify} +\externaldocument[main-]{../main/tutorial} +\externaldocument[main-]{../main/lesser} +\externaldocument[main-]{../main/bootstrap} +\externaldocument[main-]{../main/autochangers} +\externaldocument[main-]{../main/migration} +\externaldocument[main-]{../main/supporteddrives} +\externaldocument[main-]{../main/restore} +\externaldocument[main-]{../main/postgresql} +\externaldocument[main-]{../main/requirements} +\externaldocument[main-]{../main/catmaintenance} +\externaldocument[main-]{../main/sqlite} +\externaldocument[main-]{../main/pkg-install} +\externaldocument[main-]{../main/messagesres} +\externaldocument[main-]{../main/storedconf} +\externaldocument[main-]{../main/quickstart} +\externaldocument[main-]{../main/spooling} +\externaldocument[main-]{../main/newfeatures} +\externaldocument[main-]{../main/supportedchangers} +\externaldocument[main-]{../main/pools} +\externaldocument[main-]{../main/supportedoses} +\externaldocument[misc-]{../misc/stunnel} +\externaldocument[misc-]{../misc/python} +\externaldocument[misc-]{../misc/fdl} +\externaldocument[misc-]{../misc/gpl} +\externaldocument[misc-]{../misc/internaldb} +\externaldocument[misc-]{../misc/license} +\externaldocument[misc-]{../misc/dvd} +\externaldocument[misc-]{../misc/lesser} +\externaldocument[misc-]{../misc/vars} +\externaldocument[misc-]{../misc/projects} +\externaldocument[problems-]{../problems/rpm-faq} +\externaldocument[problems-]{../problems/fdl} +\externaldocument[problems-]{../problems/firewalls} +\externaldocument[problems-]{../problems/tapetesting} +\externaldocument[problems-]{../problems/kaboom} +\externaldocument[problems-]{../problems/faq} +\externaldocument[problems-]{../problems/tips} +\externaldocument[utility-]{../utility/rpm-faq} +\externaldocument[utility-]{../utility/bimagemgr-chapter} +\externaldocument[utility-]{../utility/fdl} +\externaldocument[utility-]{../utility/progs} diff --git a/docs/latex/ls-R b/docs/latex/ls-R new file mode 100644 index 00000000..0b0942a6 --- /dev/null +++ b/docs/latex/ls-R @@ -0,0 +1,9 @@ +% ls-R -- filename database for kpathsea; do not change this line. +./: +.: +borgmanual.cls +borgmanual.cls~ +ChangeLog +ls-R +README + diff --git a/docs/manuals/bacula.sty.in b/docs/manuals/bacula.sty.in index 5407da30..de8c1c71 100644 --- a/docs/manuals/bacula.sty.in +++ b/docs/manuals/bacula.sty.in @@ -29,21 +29,74 @@ %% %% \ProvidesPackage{bacula}[2008/10/03] +\usepackage{ltxtable,varioref} +\usepackage{babel,xr-hyper} +\usepackage{xr} +\input{external-references} %% %% %% define images directory -- KES 15Aug08 -\def\idir{@BUILD_DIR@/images/} %% images directory +%\def\idir{@BUILD_DIR@/images/} %% images directory +\def\idir{} +\newcolumntype{Y}{>{\centering\arraybackslash}X} +%% LaTeX GraphicPath directive is able to manage this. +%% manuals/_lang_/_manual_name/ +\graphicspath{{../../../images/pdf/}{../../../images/png/}{../../../images/jpeg/}{../../../images/}{../../../images/eps/}{../../../images/hires/}} +%% In tex files: do _not_ put the filename extension +%% Below, define the precedence for filetypes +\include{graphicspolicy} +%% Some definition for external references. +\def\mbacula{Bacula Community} +\def\miscman{\mbacula{} Misc Manual} +\def\consoleman{\mbacula{} Console Manual} +\def\mainman{\mbacula{} Main Manual} +\def\devman{\mbacula{} Developers Manual} +\def\utilityman{\mbacula{} Utility programs} +\def\problemsman{\mbacula{} Problem Resolution Guide} +%% +%% eXternal References macro: borgxrlink +%%% #1: Text to display +%%% #2: Label defined +%%% #3: manual: main, console, misc, developers +%%% #4: text as reference level. will be displayed ``as is'' +%%% +%%% Example: +%%% \borgxrlink{Console Configuration}{ConsoleConfChapter}{main}{chapter} +%%% will display +%%% Console Configuration chapter (chapter 30 on page 269) +\newcommand*{\borgxrlink}[4]{% + \href{../#3/#3}{\textbf{#1}} #4 (#4 \vref{#3-#2}) +} +%% +%% Same for pointing to document. +%% \borgxrlinkdocument{Text}{label}{manual}{type-of-reference} +%% Will display +%% Text (chapter XX on page YY) +\newcommand*{\borgxrlinkdocument}[4]{% + \href{../#3/#3}{\textbf{#1}} (#4 \vref{#3-#2}) +} + +\usepackage{multirow} +\def\arraystretch{1.5} +\pdfminorversion=4 + \def\version{@VERSION@} %% \newcommand*{\elink}[2]{% - \htmladdnormallink{#1}{#2}% + %\htmladdnormallink{#1}{#2}% + \href{#2}{#1} } %% \newcommand*{\ilink}[2]{% - \htmlref{#1}{#2}% + \htmlref{\textcolor{black}{#1}}{#2}% +% #1 (cf. \vref{#2})%\htmlref{#1}{#2}% +} +\newcommand*{\borgref}[1]{% + %% displays 'the_reference on page p' + \vref{#1} } %% \newcommand{\dq}{\verb+"+} diff --git a/docs/manuals/en/console/Makefile.in b/docs/manuals/en/console/Makefile.in index ef4fe269..f5979cba 100644 --- a/docs/manuals/en/console/Makefile.in +++ b/docs/manuals/en/console/Makefile.in @@ -41,22 +41,49 @@ MAINDOC=Bacula_Console_Operators_Gu.html first_rule: all -all: tex web dvipdf mini-clean +all: tex pdftex web mini-clean .SUFFIXES: .tex .html .PHONY: .DONTCARE: +updateversion: + @/bin/bash ../../update_version -tex: - @../../update_version +epscovers: + @(cd ../../../images/svg ; make eps) + +pdfcovers: + @echo "" + @echo "Making covers for $(DOC)" + @(cd ../../../images/svg ; make pdf) + @echo "Covers done." + @echo "" + +external-references: pdfcovers + @echo " " + @echo "Building external references for $(DOC)" + @echo "\DeclareGraphicsExtensions{.pdf,.png,.jpg,.jpeg,.eps}\n" > graphicspolicy.tex + @export TEXINPUTS=.:../../../latex//: ; pdflatex $(DOC) + @echo "$(DOC) external references done." + +pdftex: updateversion pdfcovers + @echo "" + @echo "Making PDF manual with PDFLATEX compile..." + @echo "\DeclareGraphicsExtensions{.pdf,.png,.jpg,.jpeg,.eps}\n" > graphicspolicy.tex + @export TEXINPUTS=.:../../../latex//: ; pdflatex $(DOC); makeindex ${DOC}.idx -o ${DOC}.ind 2>/dev/null ; pdflatex $(DOC); pdflatex $(DOC) + @echo "Done" + + +tex: updateversion epscovers @echo "Making version `cat version.tex`" - @cp -fp ${IMAGES}/hires/*.eps . + @echo "\DeclareGraphicsExtensions{.eps, .png,.jpg,.jpeg}" > graphicspolicy.tex @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 + latex -interaction=batchmode ${DOC}.tex pdf: @echo "Making pdfm" @@ -126,6 +153,7 @@ mini-clean: clean: + @rm graphicspolicy.tex @rm -f 1 2 3 *.tex~ @rm -f *.png *.gif *.jpg *.eps @rm -f *.pdf *.aux *.cp *.fn *.ky *.log *.pg diff --git a/docs/manuals/en/console/bconsole.tex b/docs/manuals/en/console/bconsole.tex index c1637b7c..6870a6e0 100644 --- a/docs/manuals/en/console/bconsole.tex +++ b/docs/manuals/en/console/bconsole.tex @@ -40,8 +40,8 @@ command line option (see below). This file allows default configuration of the Console, and at the current time, the only Resource Record defined is the Director resource, which gives the Console the name and address of the Director. For more information on configuration of the Console -program, please see the \ilink{Console Configuration -File}{ConsoleConfChapter} Chapter of this document. +program, please see the \borgxrlink{Console Configuration}{ConsoleConfChapter} +{main}{chapter} of the \mainman{}. \section{Running the Console Program} \index[general]{Running the Console Program} @@ -845,8 +845,8 @@ python restart This can be helpful for testing because once the Director starts and the Python interpreter is initialized, there is no other way to make it accept any changes to the startup script {\bf DirStartUp.py}. For more - details on Python scripting, please see the \ilink{Python - Scripting}{PythonChapter} chapter of this manual. + details on Python scripting, please see the \borgxrlink{Python Scripting} + {PythonChapter}{misc}{chapter} of the \miscman{}. \item [query] \index[general]{query} @@ -970,8 +970,8 @@ restore storage=\lt{}storage-name\gt{} client=\lt{}backup-client-name\gt{} specified, you will be prompted. The {\bf all} specification tells the restore command to restore all files. If it is not specified, you will be prompted for the files to restore. For details of the {\bf restore} - command, please see the \ilink{Restore Chapter}{RestoreChapter} of this - manual. + command, please see the \borgxrlink{Restore}{RestoreChapter}{main}{chapter} + of the \mainman{}. The client keyword initially specifies the client from which the backup was made and the client to which the restore will be make. However, diff --git a/docs/manuals/en/console/console.tex b/docs/manuals/en/console/console.tex index 69079dfd..cfeb1964 100644 --- a/docs/manuals/en/console/console.tex +++ b/docs/manuals/en/console/console.tex @@ -6,7 +6,7 @@ %% # $ % & ~ _ ^ \ { } %% -\documentclass[10pt,a4paper]{book} +\documentclass[10pt,a4paper,english,titlepage]{borgmanual} \topmargin -0.5in \oddsidemargin 0.0in @@ -33,25 +33,16 @@ \begin{document} \sloppy - -\newfont{\bighead}{cmr17 at 36pt} -\parskip 10pt -\parindent 0pt - -\title{\includegraphics{\idir bacula-logo.eps} \\ \bigskip - \Huge{Bacula Console and Operators Guide} - \begin{center} - \large{The Leading Open Source Backup Solution. } - \end{center} -} +\title{Bacula$^{\normalsize \textregistered}$ Console and Operators Guide} \author{Kern Sibbald} \date{\vspace{1.0in}\today \\ This manual documents Bacula version \input{version} \\ \vspace{0.2in} - Copyright \copyright 1999-2010, Free Software Foundation Europe + Copyright {\copyright} 1999-2010, 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; diff --git a/docs/manuals/en/developers/Makefile.in b/docs/manuals/en/developers/Makefile.in index 3994aa8a..b5035c1d 100644 --- a/docs/manuals/en/developers/Makefile.in +++ b/docs/manuals/en/developers/Makefile.in @@ -19,20 +19,48 @@ DOC=developers first_rule: all -all: tex web pdf mini-clean +all: tex pdftex web mini-clean .SUFFIXES: .tex .html .PHONY: .DONTCARE: -tex: - @../../update_version - @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 +updateversion: + @/bin/bash ../../update_version + +epscovers: + @(cd ../../../images/svg ; make eps) + +pdfcovers: + @echo "" + @echo "Making covers for $(DOC)" + @(cd ../../../images/svg ; make pdf) + @echo "Covers done." + @echo "" + +external-references: pdfcovers + @echo " " + @echo "Building external references for $(DOC)" + @echo "\DeclareGraphicsExtensions{.pdf,.png,.jpg,.jpeg,.eps}\n" > graphicspolicy.tex + @export TEXINPUTS=.:../../../latex//: ; pdflatex $(DOC) + @echo "$(DOC) external references done." + +pdftex: updateversion pdfcovers + @echo "" + @echo "Making PDF manual with PDFLATEX compile..." + @echo "\DeclareGraphicsExtensions{.pdf,.png,.jpg,.jpeg,.eps}\n" > graphicspolicy.tex + @export TEXINPUTS=.:../../../latex//: ; pdflatex $(DOC); makeindex ${DOC}.idx -o ${DOC}.ind 2>/dev/null ; pdflatex $(DOC); pdflatex $(DOC) + @echo "Done" + + +tex: updateversion epscovers + @echo "Making version `cat version.tex`" + @echo "\DeclareGraphicsExtensions{.eps,.png,.jpg,.jpeg}\n" > graphicspolicy.tex + @touch ${DOC}.tex ${DOC}i-general.tex + latex -interaction=batchmode ${DOC}.tex + makeindex ${DOC}.idx -o ${DOC}.ind 2>/dev/null + latex -interaction=batchmode ${DOC}.tex ; latex -interaction=batchmode ${DOC}.tex pdf: @echo "Making ${DOC} pdf" @@ -107,6 +135,7 @@ mini-clean: @rm -f ${DOC}/WARNINGS clean: + @rm graphicspolicy.tex @rm -f 1 2 3 @rm -f *.png *.gif *.jpg *.eps @rm -f *.pdf *.aux *.cp *.fn *.ky *.log *.pg diff --git a/docs/manuals/en/developers/catalog.tex b/docs/manuals/en/developers/catalog.tex index bcdedfbd..ddfb6da9 100644 --- a/docs/manuals/en/developers/catalog.tex +++ b/docs/manuals/en/developers/catalog.tex @@ -67,8 +67,8 @@ long path and filenames. \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. +\borgxrlink{Installing and Configuring MySQL}{MySqlChapter}{main}{chapter} of +the \mainman{}. \subsection{Installing and Configuring PostgreSQL} \index[general]{PostgreSQL!Installing and Configuring } @@ -76,8 +76,8 @@ this manual. \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. +\borgxrlink{Installing and Configuring PostgreSQL}{PostgreSqlChapter}{main}{chapter} + of the \mainman{}. \subsection{Installing and Configuring SQLite} \index[general]{Installing and Configuring SQLite } @@ -85,17 +85,15 @@ chapter of this manual. \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. +\borgxrlink{Installing and Configuring SQLite}{SqlLiteChapter}{main}{chapter} of +the \mainman{}. \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. +Please see the \borgxrlink{Internal Bacula Database}{sec:InternalBaculaDatabase}{misc}{section} of the \miscman{} for more details. \subsection{Database Table Design} \index[general]{Design!Database Table } diff --git a/docs/manuals/en/developers/coverpage.tex b/docs/manuals/en/developers/coverpage.tex index b7bd2373..553b1423 100644 --- a/docs/manuals/en/developers/coverpage.tex +++ b/docs/manuals/en/developers/coverpage.tex @@ -2,13 +2,7 @@ \parskip 10pt \parindent 0pt -\title{\includegraphics{\idir bacula-logo.eps} \\ \bigskip - \Huge{Bacula}$^{\normalsize \textregistered}$ \Huge{Developer's Guide} - \begin{center} - \large{The Leading Open Source Backup Solution. } - \end{center} -} - +\title{Bacula$^{\normalsize \textregistered}$ Developer's Guide} \author{Kern Sibbald} \date{\vspace{1.0in}\today \\ diff --git a/docs/manuals/en/developers/developers.tex b/docs/manuals/en/developers/developers.tex index 902fa8c8..16f30869 100644 --- a/docs/manuals/en/developers/developers.tex +++ b/docs/manuals/en/developers/developers.tex @@ -6,7 +6,8 @@ %% # $ % & ~ _ ^ \ { } %% -\documentclass[10pt,a4paper]{book} +\documentclass[10pt,a4paper,english,titlepage]{borgmanual} +%\documentclass[10pt,a4paper]{book} \topmargin -0.5in \oddsidemargin 0.0in @@ -38,9 +39,27 @@ \begin{document} \sloppy +\newfont{\bighead}{cmr17 at 36pt} +\parskip 10pt +\parindent 0pt -\include{coverpage} +\title{Bacula$^{\normalsize \textregistered}$ Developer's Guide} +\author{Kern Sibbald} +\date{\vspace{1.0in}\today \\ + This manual documents Bacula version \input{version} \\ + \vspace{0.2in} + Copyright {\copyright} 1999-2010, 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 \clearpage \pagenumbering{roman} \tableofcontents diff --git a/docs/manuals/en/developers/git.tex b/docs/manuals/en/developers/git.tex index 2a0f992f..e3ae5cf8 100644 --- a/docs/manuals/en/developers/git.tex +++ b/docs/manuals/en/developers/git.tex @@ -387,8 +387,9 @@ git branch -D newbranch 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} - +\begin{center} +\includegraphics[width=0.65\linewidth]{git-edit-commit} +\end{center} 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 diff --git a/docs/manuals/en/developers/gui-interface.tex b/docs/manuals/en/developers/gui-interface.tex index 9bb2a135..93260001 100644 --- a/docs/manuals/en/developers/gui-interface.tex +++ b/docs/manuals/en/developers/gui-interface.tex @@ -113,7 +113,7 @@ directories. \begin{figure}[htbp] \centering - \includegraphics[width=12cm]{\idir bat-brestore} + \includegraphics[width=\linewidth]{bat-brestore} \label{fig:batbrestore} \caption{Bat Brestore Panel} \end{figure} diff --git a/docs/manuals/en/developers/porting.tex b/docs/manuals/en/developers/porting.tex index 278f0e5d..e8412a47 100644 --- a/docs/manuals/en/developers/porting.tex +++ b/docs/manuals/en/developers/porting.tex @@ -1,7 +1,7 @@ %% %% -\chapter{Bacula Porting Notes} +\chapter{Bacula Porting Notes}\label{PortingChapter} \label{_ChapterStart1} \index{Notes!Bacula Porting} \index{Bacula Porting Notes} diff --git a/docs/manuals/en/developers/smartall.tex b/docs/manuals/en/developers/smartall.tex index 9bb13845..8bb1e0dc 100644 --- a/docs/manuals/en/developers/smartall.tex +++ b/docs/manuals/en/developers/smartall.tex @@ -1,9 +1,6 @@ %% %% -\addcontentsline{lof}{figure}{Smart Memory Allocation with Orphaned Buffer -Detection} -\includegraphics{\idir smartall.eps} \chapter{Smart Memory Allocation} \label{_ChapterStart4} @@ -11,6 +8,9 @@ Detection} \index{Smart Memory Allocation With Orphaned Buffer Detection } \addcontentsline{toc}{section}{Smart Memory Allocation With Orphaned Buffer Detection} +\addcontentsline{lof}{figure}{Smart Memory Allocation with Orphaned Buffer +Detection} +\includegraphics[width=\linewidth]{smartall} 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 diff --git a/docs/manuals/en/main/Makefile.in b/docs/manuals/en/main/Makefile.in index b437006a..530b6867 100644 --- a/docs/manuals/en/main/Makefile.in +++ b/docs/manuals/en/main/Makefile.in @@ -40,25 +40,48 @@ MAINDOC=Bacula_Main_Reference.html first_rule: all -all: tex web dvipdf mini-clean +all: tex pdftex web mini-clean .SUFFIXES: .tex .html .PHONY: .DONTCARE: +updateversion: + @/bin/bash ../../update_version -tex: - @../../update_version +epscovers: + @(cd ../../../images/svg ; make eps) + +pdfcovers: + @echo "" + @echo "Making covers for $(DOC)" + @(cd ../../../images/svg ; make pdf) + @echo "Covers done." + @echo "" + +external-references: pdfcovers + @echo " " + @echo "Building external references for $(DOC)" + @echo "\DeclareGraphicsExtensions{.pdf,.png,.jpg,.jpeg,.eps}\n" > graphicspolicy.tex + @export TEXINPUTS=.:../../../latex//: ; pdflatex $(DOC) + @echo "$(DOC) external references done." + +pdftex: updateversion pdfcovers + @echo "" + @echo "Making PDF manual with PDFLATEX compile..." + @echo "\DeclareGraphicsExtensions{.pdf,.png,.jpg,.jpeg,.eps}" > graphicspolicy.tex + @export TEXINPUTS=.:../../../latex//: ; pdflatex $(DOC); makeindex ${DOC}.idx -o ${DOC}.ind 2>/dev/null ; pdflatex $(DOC); pdflatex $(DOC) + @echo "Done" + + +tex: updateversion epscovers @echo "Making version `cat version.tex`" - @cp -fp ${IMAGES}/hires/*.eps . + @echo "\DeclareGraphicsExtensions{.png,.jpg,.jpeg,.eps}" > graphicspolicy.tex @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 latex -interaction=batchmode ${DOC}.tex pdf: @@ -127,6 +150,7 @@ mini-clean: clean: + @rm graphicspolicy.tex @rm -f 1 2 3 *.tex~ @rm -f *.png *.gif *.jpg *.eps @rm -f *.pdf *.aux *.cp *.fn *.ky *.log *.pg diff --git a/docs/manuals/en/main/autochangers.tex b/docs/manuals/en/main/autochangers.tex index 8df9e710..b247fcf5 100644 --- a/docs/manuals/en/main/autochangers.tex +++ b/docs/manuals/en/main/autochangers.tex @@ -140,8 +140,9 @@ $ lsscsi -g \normalsize For more detailed information on what SCSI devices you have please see -the \ilink{Linux SCSI Tricks}{SCSITricks} section of the Tape Testing -chapter of this manual. +the \borgxrlink{Linux SCSI Tricks}{SCSITricks}{problems}{section} of the + \borgxrlink{Tape Testing}{TapeTestingChapter}{problems}{chapter} of the + \problemsman{}. Under FreeBSD, you can use: @@ -685,7 +686,7 @@ drive before starting Bacula. This problem is corrected in Bacula versions 1.32f-5 and later. Please see the -\ilink{ Tape Testing}{FreeBSDTapes} chapter of this manual for +\borgxrlink{Tape Testing}{FreeBSDTapes}{problems}{chapter} of the \problemsman{} for {\bf important} information concerning your tape drive before doing the autochanger testing. \label{AutochangerTesting} diff --git a/docs/manuals/en/main/configure.tex b/docs/manuals/en/main/configure.tex index 4a2dece6..97a9d195 100644 --- a/docs/manuals/en/main/configure.tex +++ b/docs/manuals/en/main/configure.tex @@ -27,7 +27,9 @@ the installation process, but you will need to modify them to correspond to your system. An overall view of the resources can be seen in the following: \addcontentsline{lof}{figure}{Bacula Objects} -\includegraphics{\idir bacula-objects.eps} +\begin{center} +\includegraphics[width=0.8\linewidth]{bacula-objects} +\end{center} \label{ResFormat} \section{Character Sets} @@ -366,7 +368,9 @@ will need to take care to keep them consistent. Here is sort of a picture of what names/passwords in which files/Resources must match up: -\includegraphics{\idir Conf-Diagram.eps} +\begin{center} +\includegraphics[width=0.8\linewidth]{Conf-Diagram} +\end{center} 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}. In diff --git a/docs/manuals/en/main/consoleconf.tex b/docs/manuals/en/main/consoleconf.tex index 21ba0992..7125d091 100644 --- a/docs/manuals/en/main/consoleconf.tex +++ b/docs/manuals/en/main/consoleconf.tex @@ -332,7 +332,7 @@ Console { \index[general]{Commands!Console} For more details on running the console and its commands, please see the -\ilink{Bacula Console}{_ConsoleChapter} chapter of this manual. +\borgxrlink{Bacula Console}{_ConsoleChapter}{console}{chapter} of the \consoleman{}. \section{Sample Console Configuration File} \label{SampleConfiguration2} diff --git a/docs/manuals/en/main/coverpage.tex b/docs/manuals/en/main/coverpage.tex index be59c5b0..03d5394b 100644 --- a/docs/manuals/en/main/coverpage.tex +++ b/docs/manuals/en/main/coverpage.tex @@ -3,12 +3,7 @@ \parskip 10pt \parindent 0pt -\title{\includegraphics{\idir bacula-logo.eps} \\ \bigskip - \Huge{Bacula}$^{\normalsize \textregistered}$ \Huge{Bacula Main Reference} - \begin{center} - \large{The Leading Open Source Backup Solution. } - \end{center} -} +\title{Bacula$^{\normalsize \textregistered}$ Main Reference} \author{Kern Sibbald} diff --git a/docs/manuals/en/main/critical.tex b/docs/manuals/en/main/critical.tex index 3636ed71..2677149d 100644 --- a/docs/manuals/en/main/critical.tex +++ b/docs/manuals/en/main/critical.tex @@ -34,12 +34,12 @@ 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. + command in the See the \borgxrlink{btape}{btape}{utility}{section} of the \utilityman{}. \item Better than doing the above is to walk through the nine steps in the - \ilink{Tape Testing}{TapeTestingChapter} chapter of the manual. It + \borgxrlink{Tape Testing}{TapeTestingChapter}{problems}{chapter} of the \problemsman{}. 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. + \texttt{fill} command in the \borgxrlink{btape program}{btape}{utility}{section} (Part of the \utilityman{}) \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} @@ -98,7 +98,7 @@ you avoid problems. \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} +\item Learn what each of the \borgxrlinkdocument{Bacula Utility Programs}{_UtilityChapter}{utility}{chapter} does. \item Set up reasonable retention periods so that your catalog does not grow to be too big. See the following three chapters:\\ diff --git a/docs/manuals/en/main/dirdconf.tex b/docs/manuals/en/main/dirdconf.tex index edf6c8ff..7e79e372 100644 --- a/docs/manuals/en/main/dirdconf.tex +++ b/docs/manuals/en/main/dirdconf.tex @@ -249,8 +249,8 @@ in the graphical user interface. This directive is optional. \footnotesize \begin{verbatim} - DirAddresses = { - ip = { addr = 1.2.3.4; port = 1205;} + DirAddresses = { + ip = {addr = 1.2.3.4; port = 1205;} ipv4 = { addr = 1.2.3.4; port = http;} ipv6 = { @@ -261,8 +261,8 @@ in the graphical user interface. This directive is optional. addr = 1.2.3.4 port = 1205 } - ip = { addr = 1.2.3.4 } - ip = { addr = 201:220:222::2 } + ip = {addr = 1.2.3.4 } + ip = {addr = 201:220:222::2 } ip = { addr = bluedot.thun.net } @@ -328,7 +328,7 @@ resource. capacity planning, billings, etc. See \ilink{Statistics chapter} for additional information. - See the \ilink{ Configuration chapter}{Time} of this manual for additional + See the \ilink{Configuration chapter}{Time} of this manual for additional details of time specification. The default is 5 years. @@ -980,7 +980,7 @@ during working hours. We can see it like \texttt{Max Start Delay + Max Run \begin{figure}[htbp] \centering - \includegraphics[width=13cm]{\idir different_time.eps} + \includegraphics[width=\linewidth]{different_time} \caption{Job time control directives} \label{fig:differenttime} \end{figure} @@ -1104,27 +1104,7 @@ use. The speed parameter should be specified in k/s, kb/s, m/s or mb/s. 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|\textsl{AfterVSS} & {\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 -Console & & & Console command\\ -\hline -\end{tabular} - \\ +\LTXtable{\linewidth}{table_runscript} 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 @@ -1186,20 +1166,7 @@ Status code \%e edits the following values: 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} - +\LTXtable{\linewidth}{table_runscriptshortcuts} Examples: \begin{verbatim} RunScript { @@ -1444,7 +1411,7 @@ RunScript { 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. + \borgxrlink{Tips}{JobNotification}{problems}{chapter} of the \problemsman{}. See the {\bf Run After Failed Job} if you want to run a script after the job has terminated with any @@ -1472,7 +1439,7 @@ RunScript { \end{verbatim} An example of the use of this directive is given in the - \ilink{Tips Chapter}{JobNotification} of this manual. + \borgxrlink{Tips}{JobNotification}{problems}{chapter} of the \problemsman{}. \item [Client Run Before Job = \lt{}command\gt{}] @@ -1670,7 +1637,7 @@ RunScript { 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 + documented under \ilink{Maximum Concurrent Jobs}{DirMaxConJobs} in the Director's resource. \item [Reschedule On Error = \lt{}yes\vb{}no\gt{}] @@ -1708,7 +1675,7 @@ RunScript { \begin{figure}[htbp] \centering - \includegraphics[width=13cm]{\idir duplicate-real.eps} + \includegraphics[width=\linewidth]{duplicate-real} \caption{Allow Duplicate Jobs usage} \label{fig:allowduplicatejobs} \end{figure} @@ -1829,8 +1796,8 @@ runs longer than expected because no tapes are available. keep these points in mind: \begin{itemize} -\item See \ilink{Running Concurrent Jobs}{ConcurrentJobs} on how to setup - concurrent jobs. +\item See \borgxrlink{Running Concurrent Jobs}{ConcurrentJobs}{problems}{section} on how to setup + concurrent jobs in the \problemsman{}. \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. @@ -2299,7 +2266,7 @@ console run command. This directive is required. 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 + \ilink{Configuration chapter}{Time} of this manual for additional details of time specification. The default is 60 days. @@ -2327,7 +2294,7 @@ console run command. This directive is required. 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 + \ilink{Configuration chapter}{Time} of this manual for additional details of time specification. The default is 180 days. @@ -2853,7 +2820,7 @@ The Pool Resource defined in the Director's configuration file 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. + \borgxrlink{update volume}{UpdateCommand}{console}{command} in the \consoleman{}. \item [Catalog Files = \lt{}yes\vb{}no\gt{}] \index[dir]{Catalog Files} @@ -3158,8 +3125,8 @@ Job { 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. + variable expansion, please see the \borgxrlink{Variable + Expansion}{VarsChapter}{misc}{chapter} of the \miscman{}. If no variable expansion characters are found in the string, the Volume name will be formed from the {\bf format} string appended with the @@ -3171,8 +3138,8 @@ Job { 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. + LabelFormat} by using the \borgxrlink{var}{var}{console}{command} in the + \consoleman{}. In almost all cases, you should enclose the format specification (part after the equal sign) in double quotes. Please note that this directive @@ -3598,7 +3565,7 @@ An example Director configuration file might be the following: # from root to your address. See the "mail" and "operator" # directives in the Messages resource. # -Director { # define myself +Director { # define myself Name = rufus-dir QueryFile = "/home/kern/bacula/bin/query.sql" WorkingDirectory = "/home/kern/bacula/bin/working" @@ -3632,7 +3599,7 @@ Job { FileSet { Name = "Full Set" Include { - Options { signature=SHA1} + Options {signature=SHA1} # # Put your list of files here, one per line or include an # external list with: diff --git a/docs/manuals/en/main/disk.tex b/docs/manuals/en/main/disk.tex index 52fa4a83..ec4fab81 100644 --- a/docs/manuals/en/main/disk.tex +++ b/docs/manuals/en/main/disk.tex @@ -76,8 +76,7 @@ until you run out of disk space. This problem is addressed below. In addition, if you want to use concurrent jobs that write to several different volumes at the same time, you will need to understand a number of other details. An example of such a configuration is given -at the end of this chapter under \ilink{Concurrent Disk -Jobs}{ConcurrentDiskJobs}. +at the end of this chapter under \ilink{Concurrent Disk Jobs}{ConcurrentDiskJobs}. \subsection{Pool Options to Limit the Volume Usage} \index[general]{Usage!Pool Options to Limit the Volume } @@ -165,7 +164,7 @@ information from environment variables and special Bacula Counter variables. In version 1.37 and later, it is probably much better to use Python scripting and the NewVolume event since generating Volume labels in a Python script is much easier than trying to figure out Counter variables. See the -\ilink{Python Scripting}{PythonChapter} chapter of this manual for more +\borgxrlink{Python Scripting}{PythonChapter}{misc}{chapter} of the \miscman{} details. Please note that automatic Volume labeling can also be used with tapes, but diff --git a/docs/manuals/en/main/fileset.tex b/docs/manuals/en/main/fileset.tex index 41175e86..3d99df73 100644 --- a/docs/manuals/en/main/fileset.tex +++ b/docs/manuals/en/main/fileset.tex @@ -667,10 +667,9 @@ Change: 2005-11-06 12:36:48.000000000 +0100 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. + \borgxrlink{Utilities}{bwild}{utility}{chapter} of the \utilityman{} for + more information. You can also test your full FileSet definition by using + the \borgxrlink{estimate}{estimate}{console}{command} in the \consoleman{}. It is recommended to enclose the string in double quotes. \item [wilddir=\lt{}string\gt{}] @@ -689,10 +688,9 @@ Change: 2005-11-06 12:36:48.000000000 +0100 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. + \borgxrlink{Utilities}{bwild}{utility}{chapter} of the \utilityman{} for + more information. You can also test your full FileSet definition by using + the \borgxrlink{estimate}{estimate}{console}{command} in the \consoleman{}. An example of excluding with the WildDir option on Win32 machines is presented below. @@ -715,14 +713,12 @@ Change: 2005-11-06 12:36:48.000000000 +0100 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 + \borgxrlink{Utilities}{bwild}{utility}{chapter} of the \utilityman{} for + more information. You can also test your full FileSet definition by using + the \borgxrlink{estimate}{estimate}{console}{command} in the \consoleman{}. + 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} @@ -741,10 +737,9 @@ Change: 2005-11-06 12:36:48.000000000 +0100 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. + \borgxrlink{Utilities}{bwild}{utility}{chapter} of the \utilityman{} for + more information. You can also test your full FileSet definition by using + the \borgxrlink{estimate}{estimate}{console}{command} in the \consoleman{}. You find yourself using a lot of Regex statements, which will cost quite a lot of CPU time, we recommend you simplify them if you can, or better yet @@ -771,8 +766,7 @@ Change: 2005-11-06 12:36:48.000000000 +0100 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. + \borgxrlink{bregex}{bregex}{utility}{command} of the \utilityman{} more. \item [regexdir=\lt{}string\gt{}] @@ -793,8 +787,7 @@ Change: 2005-11-06 12:36:48.000000000 +0100 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. + \borgxrlink{bregex}{bregex}{utility}{command} of the \utilityman{} more. \item [exclude=yes\vb{}no] @@ -1691,7 +1684,7 @@ rules: 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. +\borgxrlink{estimate}{estimate}{console}{command} of \consoleman{}. 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 @@ -1824,8 +1817,7 @@ as of version 1.37.30 or later. 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. +\borgxrlink{estimate}{estimate}{console}{command} of \consoleman{}. As an example, suppose you add the following test FileSet: diff --git a/docs/manuals/en/main/general.tex b/docs/manuals/en/main/general.tex index dc8740bf..9d71bd10 100644 --- a/docs/manuals/en/main/general.tex +++ b/docs/manuals/en/main/general.tex @@ -58,7 +58,9 @@ Director, Console, File, Storage, and Monitor services. \addcontentsline{lof}{figure}{Bacula Applications} -\includegraphics{\idir bacula-applications.eps} +\begin{center} +\includegraphics[width=0.8\linewidth]{bacula-applications} +\end{center} (thanks to Aristedes Maniatis for this graphic and the one below) % TODO: move the thanks to Credits section in preface @@ -88,7 +90,7 @@ Director, Console, File, Storage, and Monitor services. with an interactive file restore. It also has most of the capabilities of the shell console, allows command completion with tabulation, and gives you instant help about the command you are typing. For more - details see the \ilink{Bacula Console Design Document}{_ConsoleChapter}. + details see the \borgxrlinkdocument{Bacula Console Design Document}{_ConsoleChapter}{console}{Chapter}. \subsection*{Bacula File} \label{FDDef} @@ -146,7 +148,7 @@ Director, Console, File, Storage, and Monitor services. The packages for MySQL and PostgreSQL are available for several operating systems. Alternatively, installing from the - source is quite easy, see the \ilink{ Installing and Configuring + source is quite easy, see the \ilink{Installing and Configuring MySQL}{MySqlChapter} chapter of this document for the details. For more information on MySQL, please see: \elink{www.mysql.com}{http://www.mysql.com}. Or see the \ilink{ @@ -155,7 +157,7 @@ Director, Console, File, Storage, and Monitor services. see: \elink{www.postgresql.org}{http://www.postgresql.org}. Configuring and building SQLite is even easier. For the details of - configuring SQLite, please see the \ilink{ Installing and Configuring + configuring SQLite, please see the \ilink{Installing and Configuring SQLite}{SqlLiteChapter} chapter of this document. \subsection*{Bacula Monitor} @@ -180,7 +182,9 @@ up and how, you must create a number of configuration files containing resources (or objects). The following presents an overall picture of this: \addcontentsline{lof}{figure}{Bacula Objects} -\includegraphics{\idir bacula-objects.eps} +\begin{center} +\includegraphics[width=0.8\linewidth]{bacula-objects} +\end{center} \section{Conventions Used in this Document} \index[general]{Conventions Used in this Document } @@ -196,7 +200,7 @@ partially implemented. If you are reading this manual as supplied in a released version of the software, the above paragraph holds true. If you are reading the online version of the manual, -\elink{ www.bacula.org}{http://www.bacula.org}, please bear in +\elink{www.bacula.org}{http://www.bacula.org}, please bear in mind that this version describes the current version in development (in the CVS) that may contain features not in the released version. Just the same, it generally lags behind the code a bit. @@ -216,7 +220,7 @@ proceed to the chapter on \ilink{Installing Bacula}{InstallChapter}, then \ilink{How to Configure Bacula}{ConfigureChapter}, and finally the chapter on -\ilink{ Running Bacula}{TutorialChapter}. +\ilink{Running Bacula}{TutorialChapter}. \section{Terminology} \index[general]{Terminology } @@ -475,8 +479,8 @@ chapter on easily restored. This function is particularly useful if certain Volumes or Jobs have exceeded their retention period and have been pruned or purged from the Catalog. Scanning data from Volumes into the - Catalog is done by using the {\bf bscan} program. See the \ilink{ bscan - section}{bscan} of the Bacula Utilities Chapter of this manual for more + Catalog is done by using the {\bf bscan} program. See the \borgxrlink{bscan} +{bscan}{utility}{section} of the \utilityman{} for more details. \item [Volume] @@ -495,7 +499,7 @@ chapter on Bacula is a backup, restore and verification program and is not a complete disaster recovery system in itself, but it can be a key part of one if you plan carefully and follow the instructions included in the -\ilink{ Disaster Recovery}{RescueChapter} Chapter of this manual. +\ilink{Disaster Recovery}{RescueChapter} Chapter of this manual. With proper planning, as mentioned in the Disaster Recovery chapter, Bacula can be a central component of your disaster recovery system. For @@ -519,4 +523,6 @@ Services for a backup job. Each block represents in general a separate process information. It also maintains the Catalog. \addcontentsline{lof}{figure}{Interactions between Bacula Services} -\includegraphics{\idir flow.eps} +\begin{center} +\includegraphics[width=0.8\linewidth]{flow} +\end{center} diff --git a/docs/manuals/en/main/main.tex b/docs/manuals/en/main/main.tex index 18ddd62f..f5eb04c2 100644 --- a/docs/manuals/en/main/main.tex +++ b/docs/manuals/en/main/main.tex @@ -6,7 +6,8 @@ %% # $ % & ~ _ ^ \ { } %% -\documentclass[10pt,a4paper]{book} +\documentclass[10pt,a4paper,english,titlepage]{borgmanual} +%\documentclass[10pt,a4paper]{book} \topmargin -0.5in \oddsidemargin 0.0in @@ -14,7 +15,6 @@ \textheight 10in \textwidth 6.5in - \usepackage{html} \usepackage{float} \usepackage{graphicx} @@ -27,6 +27,7 @@ % \usepackage[linkcolor=black,colorlinks=true]{hyperref} \usepackage{url} + \makeindex \newindex{dir}{ddx}{dnd}{Director Index} \newindex{fd}{fdx}{fnd}{File Daemon Index} @@ -39,8 +40,23 @@ \begin{document} \sloppy -\include{coverpage} - +\title{Bacula$^{\normalsize \textregistered}$ Main Reference} + +\author{Kern Sibbald} +\date{\vspace{1.0in}\today \\ + This manual documents Bacula version \input{version} \\ + \vspace{0.2in} + Copyright {\copyright} 1999-2010, 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 \clearpage \pagenumbering{roman} \tableofcontents diff --git a/docs/manuals/en/main/messagesres.tex b/docs/manuals/en/main/messagesres.tex index a3027533..454cc6aa 100644 --- a/docs/manuals/en/main/messagesres.tex +++ b/docs/manuals/en/main/messagesres.tex @@ -125,7 +125,7 @@ done here for presentation: 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 +\borgxrlink{bsmtp -- Customizing Your Email Messages}{bsmtp}{utility}{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 diff --git a/docs/manuals/en/main/newfeatures.tex b/docs/manuals/en/main/newfeatures.tex index 843a8c34..8c5308f0 100644 --- a/docs/manuals/en/main/newfeatures.tex +++ b/docs/manuals/en/main/newfeatures.tex @@ -52,7 +52,7 @@ it works like the GZIP compression (just replace {\bf compression=GZIP} with For example: \begin{verbatim} Include { - Options { compression=LZO } + Options {compression=LZO } File = /home File = /data } @@ -87,14 +87,14 @@ the tray monitor menu. \begin{figure}[htbp] \centering - \includegraphics[width=10cm]{\idir tray-monitor} + \includegraphics[width=0.8\linewidth]{tray-monitor} \label{fig:traymonitor} \caption{New tray monitor} \end{figure} \begin{figure}[htbp] \centering - \includegraphics[width=10cm]{\idir tray-monitor1} + \includegraphics[width=0.8\linewidth]{tray-monitor1} \label{fig:traymonitor1} \caption{Run a Job through the new tray monitor} \end{figure} @@ -159,7 +159,7 @@ directories. \begin{figure}[htbp] \centering - \includegraphics[width=12cm]{\idir bat-brestore} + \includegraphics[width=0.8\linewidth]{bat-brestore} \label{fig:batbrestore} \caption{Bat Brestore Panel} \end{figure} @@ -1128,7 +1128,7 @@ able to filter by Pool, Media Type, Location,\dots And sort the result directly in the table. The old ``Media'' view is now known as ``Pool''. \begin{figure}[htbp] \centering - \includegraphics[width=13cm]{\idir bat-mediaview.eps} + \includegraphics[width=0.8\linewidth]{bat-mediaview} \label{fig:mediaview} \end{figure} @@ -1137,10 +1137,10 @@ in the table. The old ``Media'' view is now known as ``Pool''. 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}.) +Volume. (cf figure \vref{fig:mediainfo}.) \begin{figure}[htbp] \centering - \includegraphics[width=13cm]{\idir bat11.eps} + \includegraphics[width=0.8\linewidth]{bat11} \caption{Media information} \label{fig:mediainfo} \end{figure} @@ -1149,10 +1149,10 @@ Volume. (cf \ref{fig:mediainfo}.) 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}.) +figure \vref{fig:jobinfo}.) \begin{figure}[htbp] \centering - \includegraphics[width=13cm]{\idir bat12.eps} + \includegraphics[width=0.8\linewidth]{bat12} \caption{Job information} \label{fig:jobinfo} \end{figure} @@ -1160,10 +1160,10 @@ information panel), you can access a detailed overview of your Job. (cf \subsubsection{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}.) +access a detailed overview of your Autochanger. (cf figure \vref{fig:jobinfo}.) \begin{figure}[htbp] \centering - \includegraphics[width=13cm]{\idir bat13.eps} + \includegraphics[width=0.8\linewidth]{bat13} \caption{Autochanger content} \label{fig:achcontent} \end{figure} @@ -2850,7 +2850,9 @@ 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} +\begin{center} +\includegraphics[width=\linewidth]{different_time} +\end{center} \subsubsection{Statistics Enhancements} \index[general]{Statistics Enhancements} diff --git a/docs/manuals/en/main/quickstart.tex b/docs/manuals/en/main/quickstart.tex index b43e1402..5ac9bd62 100644 --- a/docs/manuals/en/main/quickstart.tex +++ b/docs/manuals/en/main/quickstart.tex @@ -150,7 +150,9 @@ status information about the Director or the backup status on the local workstation or any other Bacula daemon that is configured. \addcontentsline{lof}{figure}{Bacula Tray Monitor} -\includegraphics{\idir Bacula-tray-monitor.eps} +\begin{center} +\includegraphics[width=0.8\linewidth]{Bacula-tray-monitor} +\end{center} % TODO: image may be too wide for 6" wide printed page. The image shows a tray-monitor configured for three daemons. By clicking on diff --git a/docs/manuals/en/main/recycling.tex b/docs/manuals/en/main/recycling.tex index 444d2c0c..5892eb35 100644 --- a/docs/manuals/en/main/recycling.tex +++ b/docs/manuals/en/main/recycling.tex @@ -110,9 +110,9 @@ 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). +the oldest jobs to save space. Manual pruning is done with the +\borgxrlink{prune}{ManualPruning}{console}{command} in the \consoleman{} + (thanks to Bryce Denney for the above explanation). \section{Pruning Directives} \index[general]{Pruning Directives } diff --git a/docs/manuals/en/main/restore.tex b/docs/manuals/en/main/restore.tex index 8481e0f1..8c1533fc 100644 --- a/docs/manuals/en/main/restore.tex +++ b/docs/manuals/en/main/restore.tex @@ -14,7 +14,7 @@ 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 +\borgxrlink{bextract}{bextract}{utility}{command} in the \utilityman{}. 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 @@ -25,7 +25,7 @@ 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. +\borgxrlink{bscan}{bscan}{utility}{command} in the \utilityman{}. 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 @@ -714,22 +714,9 @@ You can use several expressions separated by a commas. \subsection*{Examples} -\begin{tabular}{|c|c|c|l|} -\hline -Orignal filename & New filename & RegexWhere & Comments \\ -\hline -\hline -\texttt{c:/system.ini} & \texttt{c:/system.old.ini} & \texttt{/.ini\$/.old.ini/} & \$ matches end of name\\ -\hline -\texttt{/prod/u01/pdata/} & \texttt{/rect/u01/rdata} & \texttt{/prod/rect/,/pdata/rdata/} & uses two regexp\\ -\hline -\texttt{/prod/u01/pdata/} & \texttt{/rect/u01/rdata} & \texttt{!/prod/!/rect/!,/pdata/rdata/} & use \texttt{!} as separator\\ -\hline -\texttt{C:/WINNT} & \texttt{d:/WINNT} & \texttt{/c:/d:/i} & case insensitive pattern match \\ -\hline - -\end{tabular} - +\begin{small} +\LTXtable{\linewidth}{table_regexp} +\end{small} %\subsubsection{Using group} % %Like with Perl or Sed, you can make submatch with \texttt{()}, @@ -1143,7 +1130,7 @@ Bacula}{RescueChapter} chapter of this manual. 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 + running the \borgxrlink{dbcheck}{dbcheck}{utility}{command}\footnote{\utilityman{}} 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. @@ -1298,10 +1285,10 @@ FileIndex=1-1 \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 + Either you use the \borgxrlink{bscan}{bscan}{utility}{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 + depending on the size of the tape, or you can use the \borgxrlink{bls}{bls}{utility}{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. @@ -1473,7 +1460,7 @@ There are basically three steps to take: \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. +see the \borgxrlink{bscan}{bscan}{utility}{section} of the \utilityman{}. + \end{description} diff --git a/docs/manuals/en/main/storedconf.tex b/docs/manuals/en/main/storedconf.tex index bc59512a..bc919090 100644 --- a/docs/manuals/en/main/storedconf.tex +++ b/docs/manuals/en/main/storedconf.tex @@ -611,8 +611,8 @@ writing to multiple drives with multiple Jobs that all use the same Pool. 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. + \borgxrlink{description of Offline On Unmount}{NoTapeInDrive}{problems}{subsection} + in the \borgxrlink{Tape Testing}{TapeTestingChapter}{problems}{chapter} of the \problemsman{}. \item [Close on Poll= {\it yes\vb{}no}] \index[sd]{Close on Poll} @@ -931,8 +931,8 @@ the editing codes that can be used in this directive. 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. + \borgxrlink{description of Offline On Unmount}{NoTapeInDrive}{problems}{subsection} + in the \borgxrlink{Tape Testing}{TapeTestingChapter}{problems}{chapter} of the \problemsman{}. \item [Maximum Concurrent Jobs = \lt{}number\gt{}] \index[sd]{Device Maximum Concurrent Jobs} diff --git a/docs/manuals/en/main/supportedchangers.tex b/docs/manuals/en/main/supportedchangers.tex index c7e57dcd..513f6d5d 100644 --- a/docs/manuals/en/main/supportedchangers.tex +++ b/docs/manuals/en/main/supportedchangers.tex @@ -26,51 +26,5 @@ The home page for the {\bf mtx} project can be found at: \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} +\LTXtable{\linewidth}{table_supportedchangers} diff --git a/docs/manuals/en/main/supporteddrives.tex b/docs/manuals/en/main/supporteddrives.tex index 5eda0d24..a1d4bc69 100644 --- a/docs/manuals/en/main/supporteddrives.tex +++ b/docs/manuals/en/main/supporteddrives.tex @@ -44,36 +44,7 @@ following drives are known to work with Bacula. A dash in a column means unknown: \addcontentsline{lot}{table}{Supported Tape Drives} -\begin{longtable}{|p{2.0in}|l|l|p{2.5in}|l|} - \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 Capacity } \\ - \hline {- } & {ADIC } & {DLT } & {Adic Scalar 100 DLT } & {100GB } \\ - \hline {- } & {ADIC } & {DLT } & {Adic Fastor 22 DLT } & {- } \\ - \hline {FreeBSD 5.4-RELEASE-p1 amd64 } & {Certance} & {LTO } & {AdicCertance CL400 LTO Ultrium 2 } & {200GB } \\ - \hline {- } & {- } & {DDS } & {Compaq DDS 2,3,4 } & {- } \\ - \hline {SuSE 8.1 Pro} & {Compaq} & {AIT } & {Compaq AIT 35 LVD } & {35/70GB } \\ - \hline {- } & {HP } & {Travan 4 } & {Colorado T4000S } & {- } \\ - \hline {- } & {HP } & {DLT } & {HP DLT drives } & {- } \\ - \hline {- } & {HP } & {LTO } & {HP LTO Ultrium drives } & {- } \\ - \hline {- } & {IBM} & {??} & {3480, 3480XL, 3490, 3490E, 3580 and 3590 drives} & {- } \\ - \hline {FreeBSD 4.10 RELEASE } & {HP } & {DAT } & {HP StorageWorks DAT72i } & {- } \\ - \hline {- } & {Overland } & {LTO } & {LoaderXpress LTO } & {- } \\ - \hline {- } & {Overland } & {- } & {Neo2000 } & {- } \\ - \hline {- } & {OnStream } & {- } & {OnStream drives (see below) } & {- } \\ - \hline {FreeBSD 4.11-Release} & {Quantum } & {SDLT } & {SDLT320 } & {160/320GB } \\ - \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 patched RELEASE } & {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 {Solaris } & {Tandberg } & {- } & {Tandberg SLR75 } & {- } \\ - \hline - -\end{longtable} +\LTXtable{\linewidth}{table_tapedrives} There is a list of \ilink{supported autochangers}{Models} in the Supported Autochangers chapter of this document, where you will find other tape drives @@ -101,9 +72,9 @@ Unless you have patched the pthreads library on FreeBSD 4.11 systems, you will lose data when Bacula spans tapes. This is because the unpatched pthreads library fails to return a warning status to Bacula that the end of the tape is near. This problem is fixed in FreeBSD systems released after 4.11. Please see the -\ilink{Tape Testing Chapter}{FreeBSDTapes} of this manual for -{\bf important} information on how to configure your tape drive for -compatibility with Bacula. +\borgxrlink{Tape testing}{FreeBSDTapes}{problems}{section} of \problemsman{} +for {\bf important} information on how to configure your tape drive for +compatibility with \mbacula{}. \section{Supported Autochangers} \index[general]{Autochangers!Supported } @@ -138,24 +109,4 @@ The Media Type is what is designated by the manufacturers and you are not required to use (but you may) the same name in your Bacula conf resources. -\begin{tabular}{|c|c|c|c} -Media Type & Drive Type & Media Capacity & Transfer Rate \\ \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 Ultrium 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} +\LTXtable{\linewidth}{table_ltodltspec} diff --git a/docs/manuals/en/main/supportedoses.tex b/docs/manuals/en/main/supportedoses.tex index b77799e8..2d6ff96c 100644 --- a/docs/manuals/en/main/supportedoses.tex +++ b/docs/manuals/en/main/supportedoses.tex @@ -66,8 +66,7 @@ \item For FreeBSD older than version 5.0, please see some {\bf important} considerations in the - \ilink{ Tape Modes on FreeBSD}{FreeBSDTapes} section of the - Tape Testing chapter of this manual. + \borgxrlink{Tape Modes on FreeBSD}{FreeBSDTapes}{problems}{section} of \problemsman{}. \item MS Windows Director and Storage daemon are available in the binary Client installer @@ -75,8 +74,8 @@ \item For MacOSX see \elink{http://fink.sourceforge.net/ for obtaining the packages}{http://fink.sourceforge.net/} \end{itemize} -See the Porting chapter of the Bacula Developer's Guide for information on -porting to other systems. +See the \borgxrlink{Porting}{PortingChapter}{developers}{chapter} of the \devman{} for + information on porting to other systems. If you have a older Red Hat Linux system running the 2.4.x kernel and you have the directory {\bf /lib/tls} installed on your system (normally by default), diff --git a/docs/manuals/en/main/table_ltodltspec.tex b/docs/manuals/en/main/table_ltodltspec.tex new file mode 100644 index 00000000..61072011 --- /dev/null +++ b/docs/manuals/en/main/table_ltodltspec.tex @@ -0,0 +1,37 @@ +\begin{longtable}{|X|c|c|c|} +\hline +\multicolumn{1}{|c|}{\textbf{Media Type}} +& \multicolumn{1}{c|}{\textbf{Drive Type}} +& \multicolumn{1}{c|}{\textbf{Media Capacity}} +& \multicolumn{1}{c|}{\textbf{Transfer Rate}} \\ +\hline +\endfirsthead +\hline +\multicolumn{1}{|c|}{\textbf{Media Type}} +& \multicolumn{1}{c|}{\textbf{Drive Type}} +& \multicolumn{1}{c|}{\textbf{Media Capacity}} +& \multicolumn{1}{c|}{\textbf{Transfer Rate}} \\ +\hline +\endhead +\endfoot +\hline +\endlastfoot +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 Ultrium 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 \\ +\end{longtable} diff --git a/docs/manuals/en/main/table_regexp.tex b/docs/manuals/en/main/table_regexp.tex new file mode 100644 index 00000000..e717c963 --- /dev/null +++ b/docs/manuals/en/main/table_regexp.tex @@ -0,0 +1,26 @@ +\begin{longtable}{|l|l|X|l|} +\hline +\multicolumn{1}{|c|}{\textbf{Orignal filename}} +& \multicolumn{1}{c|}{\textbf{New filename}} +& \multicolumn{1}{c|}{\textbf{RegexWhere}} +& \multicolumn{1}{c|}{\textbf{Comments}} \\ +\hline +\endfirsthead +\hline +\multicolumn{1}{|c|}{\textbf{Orignal filename}} +& \multicolumn{1}{c|}{\textbf{New filename}} +& \multicolumn{1}{c|}{\textbf{RegexWhere}} +& \multicolumn{1}{c|}{\textbf{Comments}} \\ +\hline +\endhead +\hline +\endlastfoot +\endfoot +\texttt{c:/system.ini} & \texttt{c:/system.old.ini} & \texttt{/.ini\$/.old.ini/} & \$ matches end of name\\ +\hline +\texttt{/prod/u01/pdata/} & \texttt{/rect/u01/rdata} & \texttt{/prod/rect/,/pdata/rdata/} & uses two regexp\\ +\hline +\texttt{/prod/u01/pdata/} & \texttt{/rect/u01/rdata} & \texttt{!/prod/!/rect/!,/pdata/rdata/} & use \texttt{!} as separator\\ +\hline +\texttt{C:/WINNT} & \texttt{d:/WINNT} & \texttt{/c:/d:/i} & case insensitive pattern match \\ +\end{longtable} diff --git a/docs/manuals/en/main/table_restoreportabilitystatus.tex b/docs/manuals/en/main/table_restoreportabilitystatus.tex new file mode 100644 index 00000000..58fc3c2e --- /dev/null +++ b/docs/manuals/en/main/table_restoreportabilitystatus.tex @@ -0,0 +1,43 @@ +\begin{longtable}{|l|l|X|} + \hline + \multicolumn{1}{|c|}{\bf Backup OS} & + \multicolumn{1}{c|}{\bf Restore OS} & + \multicolumn{1}{c|}{\bf Results} \\ + \endfirsthead + \hline + \multicolumn{1}{|c|}{\bf Backup OS} & + \multicolumn{1}{c|}{\bf Restore OS} & + \multicolumn{1}{c|}{\bf Results} \\ + \endhead + \multicolumn{3}{c}{\emph{Cont. on next page}} \\ + \endfoot + \hline + \caption{WinNT/2K/XP Restore Portability Status} \\ + \endlastfoot + \hline \multicolumn{3}{|l|}{\textbf{\emph{Win Me}}} \\ + \hline {WinMe} & {WinMe} & {Works} \\ + \hline {WinMe} & {WinNT} & {Works (SYSTEM permissions)} \\ + \hline {WinMe} & {WinXP} & {Works (SYSTEM permissions)} \\ + \hline {WinMe} & {Linux} & {Works (SYSTEM permissions)} \\ + \hline \multicolumn{3}{|l|}{\textbf{\emph{Win XP}}} \\ + \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 \multicolumn{3}{|l|}{\textbf{\emph{Win NT}}} \\ + \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 \multicolumn{3}{|l|}{\textbf{\emph{Linux}}} \\ + \hline {Linux} & {Linux} & {Works} \\ + \hline {Linux} & {WinNT} & {Works (SYSTEM permissions)} \\ + \hline {Linux} & {WinMe} & {Works} \\ + \hline {Linux} & {WinXP} & {Works (SYSTEM permissions)} \\ +\end{longtable} + diff --git a/docs/manuals/en/main/table_runscript.tex b/docs/manuals/en/main/table_runscript.tex new file mode 100644 index 00000000..7ae60b99 --- /dev/null +++ b/docs/manuals/en/main/table_runscript.tex @@ -0,0 +1,33 @@ +\begin{longtable}{|X|X|X|X|} +\hline +\multicolumn{1}{|c|}{\textbf{Options}} +& \multicolumn{1}{c|}{\textbf{Value}} +& \multicolumn{1}{c|}{\textbf{Default}} +& \multicolumn{1}{c|}{\textbf{Information}} \\ +\endfirsthead +\hline +\multicolumn{1}{|c|}{\textbf{Options}} +& \multicolumn{1}{c|}{\textbf{Value}} +& \multicolumn{1}{c|}{\textbf{Default}} +& \multicolumn{1}{c|}{\textbf{Information}} \\ +\endhead +\hline +\endfoot +\hline +\endlastfoot +\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 | \textsl{AfterVSS} & {\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 +Console & & & Console command\\ +\end{longtable} diff --git a/docs/manuals/en/main/table_runscriptshortcuts.tex b/docs/manuals/en/main/table_runscriptshortcuts.tex new file mode 100644 index 00000000..59daf0e5 --- /dev/null +++ b/docs/manuals/en/main/table_runscriptshortcuts.tex @@ -0,0 +1,35 @@ +\begin{longtable}{|l|Y|Y|Y|Y|Y|} +\hline +\multicolumn{1}{|c|}{\centering\textbf{Keyword}} +& \multicolumn{1}{Y|}{\textbf{Runs on Success}} +& \multicolumn{1}{Y|}{\textbf{Runs on Failure}} +& \multicolumn{1}{Y|}{\textbf{Fail job on Error}} +& \multicolumn{1}{Y|}{\textbf{Runs on Client}} +& \multicolumn{1}{Y|}{\textbf{Runs When}} +\\ +\hline +\endhead +\hline +\multicolumn{1}{|c|}{\textbf{Keyword}} +& \multicolumn{1}{Y|}{\textbf{Runs on Success}} +& \multicolumn{1}{Y|}{\textbf{Runs on Failure}} +& \multicolumn{1}{Y|}{\textbf{Fail job on Error}} +& \multicolumn{1}{Y|}{\textbf{Runs on Client}} +& \multicolumn{1}{Y|}{\textbf{Runs When}} +\\ +\hline +\endfirsthead +\hline +\endfoot +\hline +\endlastfoot +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{longtable} diff --git a/docs/manuals/en/main/table_supportedchangers.tex b/docs/manuals/en/main/table_supportedchangers.tex new file mode 100644 index 00000000..b47ba2e5 --- /dev/null +++ b/docs/manuals/en/main/table_supportedchangers.tex @@ -0,0 +1,64 @@ +\begin{longtable}{|p{2cm}|p{2cm}|p{2cm}|X|c|p{2cm}|} + \hline + \multicolumn{1}{|c|}{\bf O.S.} + & \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 +\endfirsthead +\hline + \multicolumn{1}{|c|}{\bf O.S.} + & \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 +\endhead +\endfoot +\hline +\endlastfoot +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 \\ +\end{longtable} + diff --git a/docs/manuals/en/main/table_tapedrives.tex b/docs/manuals/en/main/table_tapedrives.tex new file mode 100644 index 00000000..3c73151d --- /dev/null +++ b/docs/manuals/en/main/table_tapedrives.tex @@ -0,0 +1,43 @@ +\begin{longtable}[h]{|p{2cm}|c|c|X|c|} + \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 Capacity} \\ + \hline + \endfirsthead + \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 Capacity } \\ + \hline + \endhead + \endfoot + \hline + \endlastfoot + -- & ADIC & DLT & Adic Scalar 100 DLT & 100GB \\ + \hline -- & ADIC & DLT & Adic Fastor 22 DLT & -- \\ + \hline FreeBSD 5.4-RELEASE-p1 amd64 & Certance & LTO & AdicCertance CL400 LTO Ultrium 2 & 200GB \\ + \hline -- & -- & DDS & Compaq DDS 2,3,4 & -- \\ + \hline SuSE 8.1 Pro & Compaq & AIT & Compaq AIT 35 LVD & 35/70GB \\ + \hline -- & HP & Travan 4 & Colorado T4000S & -- \\ + \hline -- & HP & DLT & HP DLT drives & -- \\ + \hline -- & HP & LTO & HP LTO Ultrium drives & -- \\ + \hline -- & IBM & ?? & 3480, 3480XL, 3490, 3490E, 3580 and 3590 drives & -- \\ + \hline FreeBSD 4.10 RELEASE & HP & DAT & HP StorageWorks DAT72i & -- \\ + \hline -- & Overland & LTO & LoaderXpress LTO & -- \\ + \hline -- & Overland & -- & Neo2000 & -- \\ + \hline -- & OnStream & -- & OnStream drives (see below) & -- \\ + \hline FreeBSD 4.11-Release & Quantum & SDLT & SDLT320 & 160/320GB \\ + \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 patched RELEASE & 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 Solaris & Tandberg & -- & Tandberg SLR75 & -- \\ +\end{longtable} diff --git a/docs/manuals/en/main/tutorial.tex b/docs/manuals/en/main/tutorial.tex index 1dd8bd0a..ea39f7f4 100644 --- a/docs/manuals/en/main/tutorial.tex +++ b/docs/manuals/en/main/tutorial.tex @@ -49,7 +49,7 @@ Each of these steps is described in more detail below. Before running Bacula for the first time in production, we recommend that you run the {\bf test} command in the {\bf btape} program as described in the -\ilink{Utility Program Chapter}{btape} of this manual. This will +\borgxrlink{Utility Program}{btape}{utility}{chapter} of the \utilityman{}. This will help ensure that Bacula functions correctly with your tape drive. If you have a modern HP, Sony, or Quantum DDS or DLT tape drive running on Linux or Solaris, you can probably skip this test as Bacula is well tested with these @@ -217,7 +217,7 @@ files ]; from catalog \normalsize Details of the console program's commands are explained in the -\ilink{Console Chapter}{_ConsoleChapter} of this manual. +\borgxrlink{Console}{_ConsoleChapter}{console}{chapter} of the \consoleman{}. \section{Running a Job} \label{Running} @@ -852,8 +852,7 @@ Client's file for additional security. For some important tips on changing names and passwords, and a diagram of what names and passwords must match, please see -\ilink{Authorization Errors}{AuthorizationErrors} in the FAQ chapter -of this manual. +\borgxrlink{Authorization Errors}{AuthorizationErrors}{problems}{chapter} in the \problemsman{}. \section{When The Tape Fills} \label{FullTape} @@ -1354,4 +1353,4 @@ attributes used when creating a Volume). It is also possible to add media to the pool without physically labeling the Volumes. This can be done with the {\bf add} command. For more information, please see the -\ilink{Console Chapter}{_ConsoleChapter} of this manual. +\borgxrlink{Console}{_ConsoleChapter}{console}{chapter} of the \consoleman{}. diff --git a/docs/manuals/en/main/win32.tex b/docs/manuals/en/main/win32.tex index f36dc8a2..f190dc42 100644 --- a/docs/manuals/en/main/win32.tex +++ b/docs/manuals/en/main/win32.tex @@ -70,19 +70,22 @@ Bacula, so we don't recommend that option. icon. The actual name of the icon will vary from one release version to another. -\includegraphics{\idir win32-nsis.eps} bacula-win32-5.xx.0.exe +\includegraphics{win32-nsis} bacula-win32-5.xx.0.exe \item Once launched, the installer wizard will ask you if you want to install Bacula. \addcontentsline{lof}{figure}{Windows Client Setup Wizard} -\includegraphics{\idir win32-welcome.eps} +\begin{center} +\includegraphics[width=0.8\linewidth]{win32-welcome} +\end{center} \item Next you will be asked to select the installation type. \addcontentsline{lof}{figure}{Windows Installation Type} -\includegraphics{\idir win32-installation-type.eps} - +\begin{center} +\includegraphics[width=0.8\linewidth]{win32-installation-type} +\end{center} \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 @@ -91,7 +94,10 @@ Bacula, so we don't recommend that option. following: \addcontentsline{lof}{figure}{Windows Component Selection Dialog} -\includegraphics{\idir win32-pkg.eps} +\begin{center} +\includegraphics[width=0.8\linewidth]{win32-pkg} +\end{center} + \index[general]{Upgrading} \item If you are installing for the first time, you will be asked to @@ -106,35 +112,39 @@ Bacula, so we don't recommend that option. \addcontentsline{lof}{figure}{Windows Configure} -\includegraphics{\idir win32-config.eps} - +\begin{center} +\includegraphics[width=0.8\linewidth]{win32-config} +\end{center} + \item While the various files are being loaded, you will see the following dialog: \addcontentsline{lof}{figure}{Windows Install Progress} - \includegraphics{\idir win32-installing.eps} - +\begin{center} + \includegraphics[width=0.8\linewidth]{win32-installing} +\end{center} \item Finally, the finish dialog will appear: \addcontentsline{lof}{figure}{Windows Client Setup Completed} - \includegraphics{\idir win32-finish.eps} - +\begin{center} + \includegraphics[width=0.8\linewidth]{win32-finish} +\end{center} \ \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 +ready to serve files, an icon \includegraphics{idle} 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}\\ +\includegraphics{tray-icon}; right click on it and a menu will appear.\\ +\includegraphics{menu}\\ 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}, +cassette icon will change from white to green \includegraphics{running}, and if there is an error, the holes in the cassette icon will change to red -\includegraphics{\idir error.eps}. +\includegraphics{error}. 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 @@ -386,37 +396,7 @@ Windows 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: Windows data stream not supported. } \\ - \hline {WinXP} & {WinMe} & {Works if {\bf Portable=yes} specified during backup.} \\ - \hline {WinXP} & {Linux} & {Error: Windows 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: Windows data stream not supported. } \\ - \hline {WinNT} & {WinMe} & {Works if {\bf Portable=yes} specified during backup.}\\ - \hline {WinNT} & {Linux} & {Error: Windows 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} +\LTXtable{\linewidth}{table_restoreportabilitystatus} Note: with Bacula versions 1.39.x and later, non-portable Windows data can be restore to any machine. @@ -581,7 +561,7 @@ 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 Windows Systems}{Windows33} for the latest +\ilink{Disaster Recovery of Windows Systems}{Windows33} for the latest suggestion, which looks very promising. It looks like Bart PE Builder, which creates a Windows PE (Pre-installation @@ -678,7 +658,9 @@ 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} +\begin{center} +\includegraphics{access-is-denied} +\end{center} If you encounter this message, the following steps will change the permissions to allow full access. @@ -690,17 +672,22 @@ to allow full access. \item If the following message appears, you can ignore it, and click on {\bf OK}. -\includegraphics{\idir view-only.eps} - +\begin{center} +\includegraphics{view-only} +\end{center} You should see something like this: -\includegraphics{\idir properties-security.eps} +\begin{center} +\includegraphics{properties-security} +\end{center} \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} +\begin{center} +\includegraphics{properties-security-advanced-owner} +\end{center} \item ensure the "Replace owner on subcontainers and objects" box is checked \item click on OK @@ -709,7 +696,9 @@ You should see something like this: the directory permissions with permissions granting you Full Control?", click on Yes. -\includegraphics{\idir confirm.eps} +\begin{center} +\includegraphics[width=0.8\linewidth]{confirm} +\end{center} \item Click on OK to close the Properties tab \end{enumerate} diff --git a/docs/manuals/en/misc/Makefile.in b/docs/manuals/en/misc/Makefile.in index a70a83e4..e4638a08 100644 --- a/docs/manuals/en/misc/Makefile.in +++ b/docs/manuals/en/misc/Makefile.in @@ -41,22 +41,49 @@ MAINDOC=Bacula_Miscellaneous_Guide.html first_rule: all -all: tex web dvipdf mini-clean +all: tex pdftex web mini-clean .SUFFIXES: .tex .html .PHONY: .DONTCARE: +updateversion: + @/bin/bash ../../update_version -tex: - @../../update_version +epscovers: + @(cd ../../../images/svg ; make eps) + +pdfcovers: + @echo "" + @echo "Making covers for $(DOC)" + @(cd ../../../images/svg ; make pdf) + @echo "Covers done." + @echo "" + +external-references: pdfcovers + @echo " " + @echo "Building external references for $(DOC)" + @echo "\DeclareGraphicsExtensions{.pdf,.png,.jpg,.jpeg,.eps}\n" > graphicspolicy.tex + @export TEXINPUTS=.:../../../latex//: ; pdflatex $(DOC) + @echo "$(DOC) external references done." + +pdftex: updateversion pdfcovers + @echo "" + @echo "Making PDF manual with PDFLATEX compile..." + @echo "\DeclareGraphicsExtensions{.pdf,.png,.jpg,.jpeg,.eps}\n" > graphicspolicy.tex + @export TEXINPUTS=.:../../../latex//: ; pdflatex $(DOC); makeindex ${DOC}.idx -o ${DOC}.ind 2>/dev/null ; pdflatex $(DOC); pdflatex $(DOC) + @echo "Done" + + +tex: updateversion epscovers @echo "Making version `cat version.tex`" - @cp -fp ${IMAGES}/hires/*.eps . + @echo "\DeclareGraphicsExtensions{.png,.jpg,.jpeg,.eps}" > graphicspolicy.tex @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 + latex -interaction=batchmode ${DOC}.tex pdf: @echo "Making pdfm" @@ -123,6 +150,7 @@ mini-clean: clean: + @rm graphicspolicy.tex @rm -f 1 2 3 *.tex~ @rm -f *.png *.gif *.jpg *.eps @rm -f *.pdf *.aux *.cp *.fn *.ky *.log *.pg diff --git a/docs/manuals/en/misc/coverpage.tex b/docs/manuals/en/misc/coverpage.tex index 30315910..a7764618 100644 --- a/docs/manuals/en/misc/coverpage.tex +++ b/docs/manuals/en/misc/coverpage.tex @@ -2,12 +2,7 @@ \parskip 10pt \parindent 0pt -\title{\includegraphics{\idir bacula-logo.eps} \\ \bigskip - \Huge{Bacula}$^{\normalsize \textregistered}$ \Huge{Bacula Miscellaneous Guide} - \begin{center} - \large{The Leading Open Source Backup Solution. } - \end{center} -} +\title{Bacula$^{\normalsize \textregistered}$ Miscellaneous Guide} \author{Kern Sibbald} diff --git a/docs/manuals/en/misc/internaldb.tex b/docs/manuals/en/misc/internaldb.tex index 65cd0ea0..156f76ac 100644 --- a/docs/manuals/en/misc/internaldb.tex +++ b/docs/manuals/en/misc/internaldb.tex @@ -9,7 +9,7 @@ do not } \index[general]{The internal database is not supported, please do not use it. } -\section{Internal Bacula Database} +\section{Internal Bacula Database}\label{sec:InternalBaculaDatabase} \index[general]{Internal Bacula Database } \index[general]{Database!Internal Bacula } diff --git a/docs/manuals/en/misc/misc.tex b/docs/manuals/en/misc/misc.tex index 11408118..f91cfe2d 100644 --- a/docs/manuals/en/misc/misc.tex +++ b/docs/manuals/en/misc/misc.tex @@ -6,7 +6,8 @@ %% # $ % & ~ _ ^ \ { } %% -\documentclass[10pt,a4paper]{book} +\documentclass[10pt,a4paper,english,titlepage]{borgmanual} +%\documentclass[10pt,a4paper]{book} \topmargin -0.5in \oddsidemargin 0.0in @@ -35,8 +36,28 @@ \begin{document} \sloppy -\include{coverpage} +\newfont{\bighead}{cmr17 at 36pt} +\parskip 10pt +\parindent 0pt +\title{Bacula$^{\normalsize \textregistered}$ Miscellaneous Guide} + + +\author{Kern Sibbald} +\date{\vspace{1.0in}\today \\ + This manual documents Bacula version \input{version} \\ + \vspace{0.2in} + Copyright {\copyright} 1999-2010, 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 \clearpage \pagenumbering{roman} \tableofcontents diff --git a/docs/manuals/en/problems/Makefile.in b/docs/manuals/en/problems/Makefile.in index f8ebad0c..7b9b3672 100644 --- a/docs/manuals/en/problems/Makefile.in +++ b/docs/manuals/en/problems/Makefile.in @@ -41,22 +41,49 @@ MAINDOC=Bacula_Problem_Resolution_G.html first_rule: all -all: tex web dvipdf mini-clean +all: tex pdftex web mini-clean .SUFFIXES: .tex .html .PHONY: .DONTCARE: +updateversion: + @/bin/bash ../../update_version -tex: - @../../update_version +epscovers: + @(cd ../../../images/svg ; make eps) + +pdfcovers: + @echo "" + @echo "Making covers for $(DOC)" + @(cd ../../../images/svg ; make pdf) + @echo "Covers done." + @echo "" + +external-references: pdfcovers + @echo " " + @echo "Building external references for $(DOC)" + @echo "\DeclareGraphicsExtensions{.pdf,.png,.jpg,.jpeg,.eps}\n" > graphicspolicy.tex + @export TEXINPUTS=.:../../../latex//: ; pdflatex $(DOC) + @echo "$(DOC) external references done." + +pdftex: updateversion pdfcovers + @echo "" + @echo "Making PDF manual with PDFLATEX compile..." + @echo "\DeclareGraphicsExtensions{.pdf,.png,.jpg,.jpeg,.eps}\n" > graphicspolicy.tex + @export TEXINPUTS=.:../../../latex//: ; pdflatex $(DOC); makeindex ${DOC}.idx -o ${DOC}.ind 2>/dev/null ; pdflatex $(DOC); pdflatex $(DOC) + @echo "Done" + + +tex: updateversion epscovers @echo "Making version `cat version.tex`" - @cp -fp ${IMAGES}/hires/*.eps . + @echo "\DeclareGraphicsExtensions{.png,.jpg,.jpeg,.eps}" > graphicspolicy.tex @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 + latex -interaction=batchmode ${DOC}.tex pdf: @echo "Making pdfm" @@ -127,6 +154,7 @@ mini-clean: clean: + @rm graphicspolicy.tex @rm -f 1 2 3 *.tex~ @rm -f *.png *.gif *.jpg *.eps @rm -f *.pdf *.aux *.cp *.fn *.ky *.log *.pg diff --git a/docs/manuals/en/problems/faq.tex b/docs/manuals/en/problems/faq.tex index 2fff751a..2b0b305a 100644 --- a/docs/manuals/en/problems/faq.tex +++ b/docs/manuals/en/problems/faq.tex @@ -119,8 +119,8 @@ of known bugs and solutions. 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 + instructions in the \borgxrlink{Running Bacula}{TutorialChapter}{main}{chapter} of + the \mainman{}. 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 @@ -143,7 +143,7 @@ of known bugs and solutions. Here is a picture that indicates what names/passwords in which files/Resources must match up: - \includegraphics{\idir Conf-Diagram.eps} + \includegraphics{Conf-Diagram} In the left column, you will find the Director, Storage, and Client resources, with their names and passwords -- these are all in {\bf @@ -254,8 +254,7 @@ where you need to adjust the device name for your system. 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. + problem, please review the \borgxrlink{Windows Installation Instructions}{Win32Chapter}{main}{chapter} in the\mainman{}. \label{windowsdie} \section{My Windows Client Immediately Dies When I Start It} @@ -355,17 +354,17 @@ FAQ for how to do so. 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 + \borgxrlink{Pruning Example}{PruningExample}{main}{chapter} of the \mainman{}. + Also, there is a whole chapter devoted to \borgxrlink{Basic Volume + Management}{DiskChapter}{main}{chapter} in the \mainman{}. 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. + FIFO device (see \borgxrlink{Stored configuration}{SetupFifo}{main}{chapter} + in the \mainman{}). It's useful to test a backup. \footnotesize \begin{verbatim} Device { @@ -476,8 +475,7 @@ manual. 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. + \borgxrlink{FileSet Resource definition}{FileSetResource}{main}{chapter} in the \mainman{}. \label{filenamelengths} \section{Do you really handle unlimited path lengths?} @@ -523,7 +521,8 @@ manual. \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. +\borgxrlink{the Priority record}{Priority}{main}{chapter} of the \mainman{} in +the Job resource. \label{nomail} \section{I Am Not Getting Email Notification, What Can I Do? } @@ -537,8 +536,8 @@ specify. Please see: 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. + mail program, please see \borgxrlink{bsmtp}{bsmtp}{utility}{command} in the + \utilityman{}. \label{periods} \section{My retention periods don't work} @@ -623,8 +622,7 @@ There are several reasons why Bacula will request a new tape. 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. + \borgxrlink{Level record}{Level}{main}{chapter} in the \mainman{}. If after reading the above mentioned section, you believe that Bacula is not correctly handling the level (Differential/Incremental), please send us the diff --git a/docs/manuals/en/problems/problems.tex b/docs/manuals/en/problems/problems.tex index 08b33035..a955666a 100644 --- a/docs/manuals/en/problems/problems.tex +++ b/docs/manuals/en/problems/problems.tex @@ -6,7 +6,8 @@ %% # $ % & ~ _ ^ \ { } %% -\documentclass[10pt,a4paper]{book} +\documentclass[10pt,a4paper,english,titlepage]{borgmanual} +%\documentclass[10pt,a4paper]{book} \topmargin -0.5in \oddsidemargin 0.0in @@ -38,12 +39,7 @@ \parskip 10pt \parindent 0pt -\title{\includegraphics{\idir bacula-logo.eps} \\ \bigskip - \Huge{Bacula Problem Resolution Guide} - \begin{center} - \large{The Leading Open Source Backup Solution. } - \end{center} -} +\title{Bacula$^{\normalsize \textregistered}$ Problem Resolution Guide} \author{Kern Sibbald} diff --git a/docs/manuals/en/problems/tapetesting.tex b/docs/manuals/en/problems/tapetesting.tex index 710f90e7..fb68b91e 100644 --- a/docs/manuals/en/problems/tapetesting.tex +++ b/docs/manuals/en/problems/tapetesting.tex @@ -42,8 +42,8 @@ one. 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). When doing this, you should consult the \borgxrlink{Storage Daemon + Configuration}{StoredConfChapter}{main}{chapter} of the \mainman{}. \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 @@ -61,8 +61,8 @@ one. 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. + have an autochanger, please be sure to read the \borgxrlink{Autochanger + chapter}{AutochangersChapter}{main}{chapter} of the \mainman{}. \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 diff --git a/docs/manuals/en/problems/tips.tex b/docs/manuals/en/problems/tips.tex index f13da7a0..59ea698f 100644 --- a/docs/manuals/en/problems/tips.tex +++ b/docs/manuals/en/problems/tips.tex @@ -111,9 +111,8 @@ 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. +\borgxrlink{Mail}{mailcommand}{main}{command} in the \mainman{} 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 @@ -269,10 +268,9 @@ END-OF-DATA \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 +By using a \borgxrlinkdocument{WriteBootstrap}{writebootstrap}{main}{chapter} record in each of your +Director's Job resources (\mainman{}), you can constantly maintain a +\borgxrlinkdocument{bootstrap}{BootstrapChapter}{main}{chapter} 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. diff --git a/docs/manuals/en/utility/Makefile.in b/docs/manuals/en/utility/Makefile.in index afca4830..181b81be 100644 --- a/docs/manuals/en/utility/Makefile.in +++ b/docs/manuals/en/utility/Makefile.in @@ -41,22 +41,49 @@ MAINDOC=Bacula_Utility_Programs.html first_rule: all -all: tex web dvipdf mini-clean +all: tex pdftex web mini-clean .SUFFIXES: .tex .html .PHONY: .DONTCARE: +updateversion: + @/bin/bash ../../update_version -tex: - @../../update_version +epscovers: + @(cd ../../../images/svg ; make eps) + +pdfcovers: + @echo "" + @echo "Making covers for $(DOC)" + @(cd ../../../images/svg ; make pdf) + @echo "Covers done." + @echo "" + +external-references: pdfcovers + @echo " " + @echo "Building external references for $(DOC)" + @echo "\DeclareGraphicsExtensions{.pdf,.png,.jpg,.jpeg,.eps}\n" > graphicspolicy.tex + @export TEXINPUTS=.:../../../latex//: ; pdflatex $(DOC) + @echo "$(DOC) external references done." + +pdftex: updateversion pdfcovers + @echo "" + @echo "Making PDF manual with PDFLATEX compile..." + @echo "\DeclareGraphicsExtensions{.pdf,.png,.jpg,.jpeg,.eps}\n" > graphicspolicy.tex + @export TEXINPUTS=.:../../../latex//: ; pdflatex $(DOC); makeindex ${DOC}.idx -o ${DOC}.ind 2>/dev/null ; pdflatex $(DOC); pdflatex $(DOC) + @echo "Done" + + +tex: updateversion epscovers @echo "Making version `cat version.tex`" - @cp -fp ${IMAGES}/hires/*.eps . + @echo "\DeclareGraphicsExtensions{.png,.jpg,.jpeg,.eps}" > graphicspolicy.tex @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 + latex -interaction=batchmode ${DOC}.tex pdf: @echo "Making pdfm" @@ -127,6 +154,7 @@ mini-clean: clean: + @rm graphicspolicy.tex @rm -f 1 2 3 *.tex~ @rm -f *.png *.gif *.jpg *.eps @rm -f *.pdf *.aux *.cp *.fn *.ky *.log *.pg diff --git a/docs/manuals/en/utility/bimagemgr-chapter.tex b/docs/manuals/en/utility/bimagemgr-chapter.tex index 7ae67a7e..5dd17d97 100644 --- a/docs/manuals/en/utility/bimagemgr-chapter.tex +++ b/docs/manuals/en/utility/bimagemgr-chapter.tex @@ -124,7 +124,9 @@ needs to be burned (last written is newer than last burn date) a "Burn" button will be displayed in the rightmost column. \addcontentsline{lof}{figure}{Bacula CD Image Manager} -\includegraphics{\idir bimagemgr1.eps} \\Figure 1 +\begin{center} +\includegraphics[width=0.8\linewidth]{bimagemgr1} \\Figure 1 +\end{center} % TODO: use tex to say figure number Place a blank CDR disk in your recorder and click the "Burn" button. This will @@ -132,7 +134,9 @@ cause a pop up window as shown in Figure 2 to display the burn progress. % TODO: use tex to say figure number \addcontentsline{lof}{figure}{Bacula CD Image Burn Progress Window} -\includegraphics{\idir bimagemgr2.eps} \\Figure 2 +\begin{center} +\includegraphics[width=0.8\linewidth]{bimagemgr2} \\Figure 2 +\end{center} % TODO: use tex to say figure number When the burn finishes the pop up window will display the results of cdrecord @@ -143,7 +147,9 @@ disappear. Should you have a failed burn you can reset the last burn date of that volume by clicking its "Reset" link. \addcontentsline{lof}{figure}{Bacula CD Image Burn Results} -\includegraphics{\idir bimagemgr3.eps} \\Figure 3 +\begin{center} +\includegraphics[width=0.8\linewidth]{bimagemgr3} \\Figure 3 +\end{center} % TODO: use tex to say figure number In the bottom row of the main display window are two more buttons labeled diff --git a/docs/manuals/en/utility/progs.tex b/docs/manuals/en/utility/progs.tex index 88ed2b00..70c18aa3 100644 --- a/docs/manuals/en/utility/progs.tex +++ b/docs/manuals/en/utility/progs.tex @@ -1070,9 +1070,8 @@ 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. +above line, please see the documentation of the \borgxrlink{Mail Command in + the Messages Resource}{mailcommand}{main}{chapter} of the \mainman{}. 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 diff --git a/docs/manuals/en/utility/utility.tex b/docs/manuals/en/utility/utility.tex index 9c3a0d2f..d1e4d9a0 100644 --- a/docs/manuals/en/utility/utility.tex +++ b/docs/manuals/en/utility/utility.tex @@ -6,7 +6,8 @@ %% # $ % & ~ _ ^ \ { } %% -\documentclass[10pt,a4paper]{book} +\documentclass[10pt,a4paper,english,titlepage]{borgmanual} +%\documentclass[10pt,a4paper]{book} \topmargin -0.5in \oddsidemargin 0.0in @@ -38,13 +39,7 @@ \parskip 10pt \parindent 0pt -\title{\includegraphics{\idir bacula-logo.eps} \\ \bigskip - \Huge{Bacula Utility Programs} - \begin{center} - \large{The Leading Open Source Backup Solution. } - \end{center} -} - +\title{Bacula$^{\normalsize \textregistered}$ Utility Programs} \author{Kern Sibbald} \date{\vspace{1.0in}\today \\