From: Eric Bollengier <eric@baculasystems.com>
Date: Wed, 5 Feb 2014 08:32:13 +0000 (+0100)
Subject: Add documentation about new debug options
X-Git-Url: https://git.sur5r.net/?a=commitdiff_plain;h=4eeb93897c618807884339dd3f68341301773cc1;p=bacula%2Fdocs

Add documentation about new debug options
---

diff --git a/docs/manuals/en/main/newbsfeatures.tex b/docs/manuals/en/main/newbsfeatures.tex
index 3b2ecdad..1eb39db9 100644
--- a/docs/manuals/en/main/newbsfeatures.tex
+++ b/docs/manuals/en/main/newbsfeatures.tex
@@ -7,10 +7,10 @@ In addition to the features in this chapter, the Enterprise version
 includes all the Community features described in the Community new Features
 chapter.
 
-\section{Bacula Enterprise 6.7.0}
+\section{Bacula Enterprise 7.0}
 
 \subsection{Data Encryption Cipher Configuration}
-Bacula Enterprise version 6.7.0 and later now allows to configure the data
+Bacula Enterprise version 7.0 and later now allows to configure the data
 encryption cipher and the digest algorithm. The cipher was forced to AES 128,
 and it is now possible to choose between the following ciphers:
 
@@ -36,7 +36,7 @@ refer to OpenSSL documentation to know about pro and cons on these options.
 
 \subsubsection*{.api version 2}
 
-In Bacula Enterprise version 6.7.0 and later, we introduced a new .api version
+In Bacula Enterprise version 7.0 and later, we introduced a new .api version
 to help external tools to parse various Bacula outputs.
 
 The \texttt{api\_opts} option can use the following arguments:
@@ -57,6 +57,59 @@ job=AJob
 ...
 \end{lstlisting}
 
+\subsubsection*{New Debug Options}
+
+In Bacula Enterprise version 7.0 and later, we introduced new options to
+the \texttt{setdebug} command.
+
+\smallskip{}
+
+If the \texttt{options} parameter is set, the following arguments can be
+used to control debug functions.
+
+\begin{itemize}
+\item [0] clear debug flags
+\item [i] Turn off, ignore bwrite() errors on restore on File Daemon
+\item [d] Turn off decomp of BackupRead() streams on File Daemon
+\item [t] Turn on timestamp in traces
+\item [T] Turn off timestamp in traces
+\item [c] Truncate trace file if trace file is activated
+\item [l] Turn on recoding events on P() and V()
+\item [p] Turn on the display of the event ring when doing a bactrace
+\end{itemize}
+
+\smallskip{}
+
+The following command will truncate the trace file and will turn on timestamps
+in the trace file.
+
+\begin{lstlisting}
+* setdebug level=10 trace=1 options=ct fd
+\end{lstlisting}
+
+\smallskip{}
+
+It is now possible to use \textsl{class} of debug messages called \texttt{tags}
+to control the debug output of Bacula daemons.
+
+\begin{itemize}
+\item [all] Display all debug messages
+\item [bvfs] Display BVFS debug messages
+\item [sql] Display SQL related debug messages
+\item [memory] Display memory and poolmem allocation messages
+\item [scheduler] Display scheduler related debug messages
+\end{itemize}
+
+\begin{lstlisting}
+* setdebug level=10 tags=bvfs,sql,memory
+* setdebug level=10 tags=!bvfs
+\end{lstlisting}
+
+The \texttt{tags} option is composed of a list of tags, tags are separated by
+``,'' or ``+'' or ``-'' or ``!''. To disable a specific tag, use ``-'' or ``!''
+in front of the tag. Note that more tags will come in future versions.
+
+
 \section{Bacula Enterprise 6.6.0}
 \subsection{Comm Line Compression}
 Bacula Enterprise version 6.6.0 and later now includes communication