improvements

Signed-off-by: Marco van Wieringen <marco.van.wieringen@bareos.com>

.gitignore

@@ -1,12 +1,9 @@
-Makefile
-*/Makefile
 *.sty
 *.dvi
 *.idx
 *.maf
 *.toc
 *.mtc*
-*/version.tex
 manuals/en/*/version.tex
 manuals/*/*/version.tex
 manuals/*/utility/utilityi*
@@ -36,6 +33,5 @@ manuals/*/problems/problems.pdf
 manuals/*/problems/problems/
 manuals/*/utility/utility.pdf
 manuals/*/utility/utility/
-version.tex
 bsysmanual
 manuals/en/images

manuals/en/main/autochangers.tex

@@ -267,8 +267,8 @@ \section{Device Configuration Records}
 
 \item [Autochanger = {\it Yes|No} ]
    \index[sd]{Autochanger  }
-   The {\bf Autochanger} record specifies that the current device  is or is not
-an autochanger. The default is {\bf no}. \TODO{check}
+   The {\bf Autochanger} record specifies if the current device belongs to an
+autochanger ressource. The default is {\bf no}.
 
 \item [Changer Device = {\textless}device-name{\textgreater}]
    \index[sd]{Changer Device  }
@@ -448,9 +448,8 @@ \section{Specifying Slots When Labeling}
 
 You must also set
 {\bf Autochanger = yes} in the Storage daemon's Device resource
-as we have described above in
-order for the autochanger to be used.
-\TODO{check: why not in the example?}
+as we have described above in order for the autochanger to be used.
+%\TODO{check: why not in the example?}
 Please see the
 \ilink{Storage Resource}{Autochanger1} in the Director's chapter
 and the
@@ -665,6 +664,7 @@ \section{Testing Autochanger and Adapting mtx-changer script}
 \index[general]{Adapting Your mtx-changer script}
 \label{AutochangerTesting}
 
+\TODO{move to troubleshooting}
 Before attempting to use the autochanger with Bareos, it is preferable to
 "hand-test" that the changer works. To do so, we suggest you do the
 following commands:

manuals/en/main/bootstrap.tex

@@ -6,6 +6,8 @@ \chapter{The Bootstrap File}
 \index[general]{File!Bootstrap }
 \index[general]{Bootstrap File }
 
+\TODO{rewrite by Philipp Storz}
+
 The information in this chapter is provided so that you may either create your
 own bootstrap files, or so that you can edit a bootstrap file produced by
 Bareos. However, normally the bootstrap file will be automatically created

manuals/en/main/catmaintenance.tex

@@ -101,7 +101,7 @@ \subsection{Compacting Your MySQL Database}
 \index[general]{Database!Compacting Your MySQL }
 \index[general]{Compacting Your MySQL Database }
 
-\TODO{check cleaner approaches}
+\TODO{check cleaner approaches (Sebastian?)}
 
 Over time, as noted above, your database will tend to grow. I've noticed that
 even though Bareos regularly prunes files, {\bf MySQL} does not effectively
@@ -374,7 +374,7 @@ \section{Performance Issues Indexes}
 \index[general]{Database Performance Issues Indexes}
 \index[general]{Performance!Database}
 
-\TODO{verify}
+\TODO{verify Stephan}
 One of the most important considerations for improving performance on
 the Bareos database is to ensure that it has all the appropriate indexes.
 Several users have reported finding that their database did not have

manuals/en/main/configure.tex

@@ -140,9 +140,7 @@ \subsection{Including other Configuration Files}
 @|"sh -c 'for f in /etc/bareos/clientdefs/*.conf ; do echo @${f} ; done'"
 \end{verbatim}
 
-\subsection{Variable Expansion}
-    \label{VarsChapter}
-    \TODO{to be written}
+
 
 \subsection{Recognized Primitive Data Types}
 \index[general]{Types!Recognized Primitive Data }
@@ -302,10 +300,132 @@ \subsection{Recognized Primitive Data Types}
 
 \end{description}
 
-\label{ResTypes}
+\subsection{Variable Expansion}
+    \label{VarsChapter}
+
+Depending on the type of directive, Bareos will expand following variables:
+
+\paragraph{Variable Expansion on Media Labels}
+
+When labeling a new media, following Bareos internal variables can be used:
+
+\begin{tabular}{p{2cm}p{7cm}}
+\textbf{Internal Variable} & \textbf{Description} \\
+\variable{Year} & Year \\
+\variable{Month} & Month: 1-12 \\
+\variable{Day} & Day: 1-31 \\
+\variable{Hour} & Hour: 0-24 \\
+\variable{Minute} & Minute: 0-59 \\
+\variable{Second} & Second: 0-59 \\
+\variable{WeekDay} & Day of the week: 0-6, using 0 for Sunday\\
+\variable{Job} & Name of the Job \\
+\variable{Dir} & Name of the Director \\
+\variable{Level} & Job Level \\
+\variable{Type} & Job Type \\
+\variable{JobId} & JobId \\
+\variable{JobName} & unique name of a job\\
+\variable{Storage} & Name of the Storage Daemon\\
+\variable{Client} &  Name of the Clients \\
+\variable{NumVols} & Numbers of volumes in the pool\\
+\variable{Pool} &  Name of the Pool  \\
+\variable{Catalog} &  Name of the Catalog\\
+\variable{MediaType} &  Type of the media
+\end{tabular}
+
+Additional, normal environment variables can be used, e.g.
+\variable{HOME} oder \variable{HOSTNAME}.
+
+\paragraph{Variable Expansion on RunScripts}
+
+At the configuration of RunScripts following variables can be used:
+
+\begin{tabular}{p{2cm}p{7cm}}
+\textbf{Variable} & \textbf{Description} \\
+\parameter{\%c} & Client's Name\\
+\parameter{\%d} & Director's Name\\
+\parameter{\%e} & Job Exit Code\\
+\parameter{\%i} & JobId\\
+\parameter{\%j} & Unique JobId\\
+\parameter{\%l} & Job Level\\
+\parameter{\%n} & Unadorned Job Name\\
+\parameter{\%r} & Recipients\\
+\parameter{\%s} & Since Time\\
+\parameter{\%b} & Job Bytes \\
+\parameter{\%f} & Job Files \\
+\parameter{\%t} & Job Type (Backup, ...)\\
+\parameter{\%v} & Volume Name (only on Director)
+\end{tabular}
+
+
+
+\paragraph{Variable Expansion in Autochanger Commands}
+
+At the configuration of autochanger commands following variables can be used:
+
+
+\begin{tabular}{p{2cm}p{7cm}}
+\textbf{Variable} & \textbf{Description} \\
+\parameter{\%a} & Archive Device Name\\
+\parameter{\%c} & Changer Device Name\\
+\parameter{\%d} & Changer Drive Index\\
+\parameter{\%f} & Client's Name\\
+\parameter{\%j} & Job Name\\
+\parameter{\%o} & Command\\
+\parameter{\%s} & Slot Base 0\\
+\parameter{\%S} & Slot Base 1\\
+\parameter{\%v} & Volume Name
+\end{tabular}
+
+
+
+\paragraph{Variable Expansion in Mount Commands}
+
+At the configuration of mount commands following variables can be used:
+
+
+
+\begin{tabular}{p{2cm}p{7cm}}
+\textbf{Variable} & \textbf{Description} \\
+\parameter{\%a} & Archive Device Name\\
+\parameter{\%e} & Erase\\
+\parameter{\%n} & Part Number\\
+\parameter{\%m} & Mount Point\\
+\parameter{\%v} & Last Part Name
+\end{tabular}
+
+
+
+
+
+
+
+\paragraph{Variable Expansion in Mail and Operator Commands}
+
+At the configuration of mail and operator commands following variables can be used:
+
+\begin{tabular}{p{2cm}p{7cm}}
+\textbf{Variable} & \textbf{Description} \\
+\parameter{\%c} & Client's Name\\
+\parameter{\%d} & Director's Name\\
+\parameter{\%e} & Job Exit Code\\
+\parameter{\%i} & JobId\\
+\parameter{\%j} & Unique Job Id\\
+\parameter{\%l} & Job Level\\
+\parameter{\%n} & Unadorned Job Name\\
+\parameter{\%s} & Since Time\\
+\parameter{\%t} & Job Type (Backup, ...)\\
+\parameter{\%r} & Recipients\\
+\parameter{\%v} & Volume Name\\
+\parameter{\%b} & Job Bytes\\
+\parameter{\%F} & Job Files
+\end{tabular}
+
+
+
 \section{Resource Types}
 \index[general]{Types!Resource }
 \index[general]{Resource Types }
+\label{ResTypes}
 
 The following table lists all current Bareos resource types. It shows what
 resources must be defined for each service (daemon). The default configuration

manuals/en/main/dataencryption.tex

@@ -15,16 +15,16 @@ \chapter{Data Encryption}
 It is very important to specify what this implementation does NOT
 do:
 \begin{itemize}
-\item There is one important restore problem to be aware of, namely, it's
-  possible for the director to restore new keys or a Bareos configuration
-  file to the client, and thus force later backups to be made with a
-  compromised key and/or with no encryption at all.  You can avoid this by
-  not changing the location of the keys in your Bareos File daemon
-  configuration file, and not changing your File daemon keys.  If you do
-  change either one, you must ensure that no restore is done that restores
-  the old configuration or the old keys.  In general, the worst effect of
-  this will be that you can no longer connect the File daemon.\TODO{what does this sentence mean?}
-    \TODO{refer to SElinux?}
+% \item There is one important restore problem to be aware of, namely, it's
+%   possible for the director to restore new keys or a Bareos configuration
+%   file to the client, and thus force later backups to be made with a
+%   compromised key and/or with no encryption at all.  You can avoid this by
+%   not changing the location of the keys in your Bareos File daemon
+%   configuration file, and not changing your File daemon keys.  If you do
+%   change either one, you must ensure that no restore is done that restores
+%   the old configuration or the old keys.  In general, the worst effect of
+%   this will be that you can no longer connect the File daemon.\TODO{what does this sentence mean?}
+%     \TODO{refer to SElinux?}
 
 \item The implementation does not encrypt file metadata such as file path
   names, permissions, and ownership. Extended attributes are also currently

manuals/en/main/dirdconf-fileset.tex

@@ -1782,7 +1782,7 @@ \subsection{Windows FileSets}
 Full backup.
 
 
-\paragraph*{Example File for Windows}
+\paragraph*{Example Fileset for Windows}
 \index[general]{FileSet!Windows Example}
 \index[general]{Windows Example FileSet}
 
@@ -1889,6 +1889,27 @@ \subsection{Windows FileSets}
 \end{verbatim}
 \normalsize
 
+\begin{verbatim}
+FileSet {
+  Name = "Windows All Drives"
+  Enable VSS = yes
+  Include {
+    Options {
+      Signature = MD5
+      Drive Type = fixed
+      IgnoreCase = yes
+      WildFile = "[A-Z]:/pagefile.sys"
+      WildDir = "[A-Z]:/RECYCLER"
+      WildDir = "[A-Z]:/$RECYCLE.BIN"
+      WildDir = "[A-Z]:/System Volume Information"
+      Exclude = yes
+    }
+    File = /
+  }
+}
+\end{verbatim}
+
+
 Note, the three line of the above Exclude were split to fit on the document
 page, they should be written on a single line in real use.
 

manuals/en/main/dirdconf.tex

@@ -760,8 +760,8 @@ \section{Job Resource}
 will compare the current state of your disk against the last successful
 backup, which may be several jobs.
 
-\TODO{Note, the current implementation (1.32c) does not identify files that
-have been deleted.}
+Note, the current implementation does not identify files that
+have been deleted.
 \end{description}
 
 \item [Accurate = {\textless}yes{\textbar}no{\textgreater}] \hfill \\
@@ -3705,7 +3705,8 @@ \section{Example Director Configuration File}
 
 An example Director configuration file might be the following:
 
-\TODO{replace with Bareos default config?}
+\TODO{replace with Bareos default config? https://github.com/bareos/bareos/blob/master/src/defaultconfigs/diskonly/bareos-dir.conf.in }
+
 \footnotesize
 \begin{verbatim}
 #

manuals/en/main/disk.tex

@@ -108,7 +108,7 @@ \subsection{Pool Options to Limit the Volume Usage}
    volume could take quite a bit of time.  Also, if you ever have a partial
    hard disk failure, you are more likely to be able to recover more data
    if they are in smaller Volumes.
-    \TODO{still valid?}
+    \TODO{still valid? Philipp thinks not but ask marco.}
 
 \item To limit the use time (i.e. write the Volume for a maximum of five days),
    use:

manuals/en/main/filedconf.tex

@@ -60,13 +60,13 @@ \section{Client Resource}
 % \index[fd]{Directive!Working Directory}
 This directive is optional and specifies a directory in which the File
 daemon  may put its status files.
-\TODO{This directory should be used only  by {\bf
-Bareos}, but may be shared by other Bareos daemons provided the daemon
-names on the {\bf Name} definition are unique for each daemon.}
+%\TODO{This directory should be used only by {\bf
+%Bareos}, but may be shared by other Bareos daemons provided the daemon
+%names on the {\bf Name} definition are unique for each daemon.}
 
 The bareos file daemon uses a platform specific default value, that is defined at compile time.
 For Linux systems, the default is \path|/var/lib/bareos/|.
-\TODO{for Windows systems it is ?}
+For Windows systems it is \%TEMP\%.
 
 On Win32 systems, in some circumstances you may need to specify a drive
 letter in the specified working directory path.  Also, please be sure
@@ -83,7 +83,6 @@ \section{Client Resource}
 The bareos file daemon uses a platform specific default value,
 that is defined at compile time.
 Typically on Linux systems, it is set to \path|/var/lib/bareos/| or \path|/var/run/|.
-\TODO{?}
 
 % Standard shell expansion of the {\bf directory}  is
 % done when the configuration file is read so that values such  as {\bf \$HOME}
@@ -229,10 +228,10 @@ \section{Client Resource}
 \directive{fd}{Compatible}{yes{\textbar}no}{}{{yes}}
 This directive enables the compatible mode of the file daemon. In
 this mode the file daemon will try to be as compatible to a native
-Bareos file daemon as possible. Enabling this option may mean that
+Bacula file daemon as possible. Enabling this option means that
 certain new options available in Bareos cannot be used as they would
 lead to data not being able to be restored by a Native Bareos file daemon.
-\TODO{still true with bareos? when to choose false?}
+When you want to use bareos-only features, you have to set it to false.
 
 \item [Maximum Bandwidth Per Job = {\textless}speed{\textgreater}] \hfill \\
 \index[fd]{Maximum Bandwidth Per Job}