diff --git a/manuals/en/main/ansi-labels.tex b/manuals/en/main/ansi-labels.tex index 4186504..b16421d 100644 --- a/manuals/en/main/ansi-labels.tex +++ b/manuals/en/main/ansi-labels.tex @@ -33,26 +33,23 @@ \section{Tape Labels: ANSI or IBM} \subsection{Director Pool Directive} \begin{description} -\directive{dir}{Label Type}{ANSI{\textbar}IBM{\textbar}Bareos}{}{Bareos} - This directive is implemented in the Director Pool resource and in the SD Device +\xdirective{dir}{Label Type}{ANSI{\textbar}IBM{\textbar}Bareos}{required}{Bareos}{}{This directive is implemented in the Director Pool resource and in the SD Device resource. If it is specified in the SD Device resource, it will take - precedence over the value passed from the Director to the SD. + precedence over the value passed from the Director to the SD.} \end{description} \subsection{Storage Daemon Device Directives} \begin{description} -\directive{sd}{Label Type}{ANSI{\textbar}IBM{\textbar}Bareos}{}{} - This directive is implemented in the Director Pool resource and in the SD Device +\xdirective{sd}{Label Type}{ANSI{\textbar}IBM{\textbar}Bareos}{}{}{}{This directive is implemented in the Director Pool resource and in the SD Device resource. If it is specified in the the SD Device resource, it will take - precedence over the value passed from the Director to the SD. + precedence over the value passed from the Director to the SD.} -\directive{sd}{Check Label}{yes{\textbar}no}{}{no} - This directive is implemented in the the SD Device resource. If you intend +\xdirective{sd}{Check Label}{yes{\textbar}no}{}{no}{}{This directive is implemented in the the SD Device resource. If you intend to read ANSI or IBM labels, this *must* be set. Even if the volume is not ANSI labeled, you can set this to yes, and Bareos will check the label type. Without this directive set to yes, Bareos will assume that labels are of Bareos type and will not check for ANSI or IBM labels. In other words, if there is a possibility of Bareos encountering an - ANSI/IBM label, you must set this to yes. + ANSI/IBM label, you must set this to yes.} \end{description} diff --git a/manuals/en/main/bareos.sty b/manuals/en/main/bareos.sty index c5b13b0..6ffeb3c 100644 --- a/manuals/en/main/bareos.sty +++ b/manuals/en/main/bareos.sty @@ -60,27 +60,80 @@ %% \newcommand{\warning}[1]{Please note! \textit{#1}} %% -\newcommand{\sinceVersion}[3]{ - \index[#1]{#2}Included since version #3 - \index[general]{#3!#2} +\newcommand{\sinceVersion}[3]{Version $>=$ #3.% + \index[#1]{#2}% + \index[general]{#3!#2}% } \newcommand{\betaSince}[3]{\index[#1]{#2}Included as beta since version #3. Don't use in productive environment!} \newcommand{\deprecatedSince}[3]{This option is deprecated since version #3} \newcommand{\removedSince}[3]{This option is removed since version #3} -\newcommand{\directive}[5]{ -% 1: config file +% \newenvironment{directives}[1] +% {% +% \def\configfile{#1} +% \begin{itemize} +% }{% +% \end{itemize} +% } + +% \newcommand{\xdirective}[5]{ +% %% 1: config file (dir | sd | fd) +% % 2: directive name +% % 3: directive type/value +% % 4: "required" | "" +% % 5: default value +% % 6: since version +% \item [#1 = {\textless}#2{\textgreater}] +% \hfill +% \ifthenelse{\isempty{#4}}{}{(default: #4)} +% \ifthenelse{\isempty{#3}}{}{(#3)} +% \hfill \\ +% \index[\configfile]{#1} +% \index[\configfile]{Directive!#1} +% \ifthenelse{\isempty{#5}}{}{\sinceVersion{\configfile}{#1}{#5}} +% } + +% deprecated. use xdirective instead. +\newcommand{\directive}[6]{ +% 1: config file (dir | sd | fd) % 2: directive name -% 3: directory type/value +% 3: directive type/value % 4: "required" | "" % 5: default value +% 6: since version \item [#2 = {\textless}#3{\textgreater}] \hfill \ifthenelse{\isempty{#5}}{}{(default: #5)} \ifthenelse{\isempty{#4}}{}{(#4)} + \ifthenelse{\isempty{#6}}{}{\sinceVersion{#1}{#2}{#6}} \hfill \\ -\index[#1]{#2}\index[#1]{Directive!#2}} -% \directive{}{}{}{required}{} + \index[#1]{#2} + \index[#1]{Directive!#2} +} + +\newcommand{\xdirective}[7]{ +% 1: config file (dir | sd | fd) +% 2: directive name +% 3: directive type/value +% 4: "required" | "" +% 5: default value +% 6: since version +% 7: description +\item [#2 = {\textless}#3{\textgreater}]% + \hfill% + \ifthenelse{\isempty{#5}}{}{(default: #5)}% + \ifthenelse{\isempty{#4}}{}{(#4)}% + \hfill \\% + \index[#1]{#2}% + \index[#1]{Directive!#2}% +#7\ \\% + \ifthenelse{\isempty{#6}}{}{% + \sinceVersion{#1}{#2}{#6}% + %\marginpar{#6} + }% +} +% \xdirective{dir|sd|fd}{name}{type}{required}{default}{version}{} +% \xdirective{}{}{}{required}{}{}{} % \floatstyle{boxed} @@ -152,7 +205,7 @@ basicstyle=\ttfamily, columns=fullflexible, %label=config:#1, - caption=#1, + caption=#1, captionpos=b, } }{} diff --git a/manuals/en/main/dirdconf-fileset.tex b/manuals/en/main/dirdconf-fileset.tex index c79da42..0c55a70 100644 --- a/manuals/en/main/dirdconf-fileset.tex +++ b/manuals/en/main/dirdconf-fileset.tex @@ -24,13 +24,13 @@ \section{FileSet Resource} Start of the FileSet resource. One {\bf FileSet} resource must be defined for each Backup job. -\directive{dir}{Name}{name}{required}{} +\directive{dir}{Name}{name}{required}{}{} The name of the FileSet resource. This directive is required. -\directive{dir}{Description}{text}{}{} +\directive{dir}{Description}{text}{}{}{} Information only. -\directive{dir}{Enable VSS}{yes{\textbar}no}{}{yes (on Windows)} +\directive{dir}{Enable VSS}{yes{\textbar}no}{}{yes (on Windows)}{} If this directive is set to {\bf yes} the File daemon will be notified that the user wants to use a Volume Shadow Copy Service (VSS) backup for this job. This directive is effective only on the Windows File Daemon. @@ -44,7 +44,7 @@ \section{FileSet Resource} \ilink{Windows}{VSS} chapter of this manual. -\directive{dir}{Ignore FileSet Changes}{yes{\textbar}no}{}{no} +\directive{dir}{Ignore FileSet Changes}{yes{\textbar}no}{}{no}{} Normally, if you modify the FileSet Include or Exclude lists, the next backup will be forced to a Full so that Bareos can guarantee that any additions or deletions are properly saved. @@ -60,10 +60,10 @@ \section{FileSet Resource} Exclude, Bareos will force a Full backup to ensure that everything is properly backed up. -\directive{dir}{Include}{$\ldots$}{}{} +\directive{dir}{Include}{$\ldots$}{}{}{} Describe the files, that should get included to a backup, see section about the \ilink{Include Ressource}{fileset-include}. -\directive{dir}{Exclude}{$\ldots$}{}{} +\directive{dir}{Exclude}{$\ldots$}{}{}{} Describe the files, that should get excluded from a backup, see section about the \ilink{Exclude Ressource}{fileset-exclude}. \end{description} @@ -100,7 +100,7 @@ \subsection{FileSet Include Ressource} \begin{description} -\directive{dir}{File}{ filename \textbar\ dirname \textbar\ \textbar command \textbar\ \textbackslash\textless includefile-client \textbar\ \textless includefile-server }{}{} +\directive{dir}{File}{ filename \textbar\ dirname \textbar\ \textbar command \textbar\ \textbackslash\textless includefile-client \textbar\ \textless includefile-server }{}{}{} The file list consists of one file or directory name per line. Directory names should be specified without a trailing slash with Unix path notation. @@ -360,7 +360,7 @@ \subsection{FileSet Include Ressource} -\directive{dir}{Exclude Dir Containing}{filename}{}{} +\directive{dir}{Exclude Dir Containing}{filename}{}{}{} This directive can be added to the Include section of the FileSet resource. If the specified filename ({\bf filename-string}) is found on the Client in any directory to be backed up, the whole directory will be ignored (not backed up). @@ -406,7 +406,7 @@ \subsection{FileSet Include Ressource} files, directories, etc). -\directive{dir}{Plugin}{plugin-name:plugin-parameter1:plugin-parameter2:$\ldots$}{}{} +\directive{dir}{Plugin}{plugin-name:plugin-parameter1:plugin-parameter2:$\ldots$}{}{}{} \label{directive-fileset-plugin} Instead of only specifying files, a file set can also use plugins. Plugins are additional libraries that handle specific requirements. @@ -425,7 +425,7 @@ \subsection{FileSet Include Ressource} Note: It is also possible to define more than one plugin directive in a FileSet to do several database dumps at once. -\directive{dir}{Options}{$\ldots$}{}{} +\directive{dir}{Options}{$\ldots$}{}{}{} See the \ilink{File Set Options}{fileset-options} section. \end{description} @@ -1333,7 +1333,7 @@ \subsection{FileSet Exclude Ressource} FileSet Exclude-Ressources very similar to Include-Ressources, except that they only allow following directives: \begin{description} -\directive{dir}{File}{ filename \textbar\ dirname \textbar\ \textbar command \textbar\ \textbackslash\textless includefile-client \textbar\ \textless includefile-server }{}{} +\directive{dir}{File}{ filename \textbar\ dirname \textbar\ \textbar command \textbar\ \textbackslash\textless includefile-client \textbar\ \textless includefile-server }{}{}{} Files to exclude are descripted in the same way as at the \ilink{Include ressource}{fileset-include}. \end{description} diff --git a/manuals/en/main/dirdconf.tex b/manuals/en/main/dirdconf.tex index f7dc26a..9e09447 100644 --- a/manuals/en/main/dirdconf.tex +++ b/manuals/en/main/dirdconf.tex @@ -203,7 +203,7 @@ \section{Director Resource} that provide the {\bf setsockopt} TCP\_KEEPIDLE function (Linux, ...). The default value is zero, which means no change is made to the socket. -\directive{dir}{Maximum Concurrent Jobs}{number}{}{1} +\directive{dir}{Maximum Concurrent Jobs}{number}{}{1}{} \label{DirMaxConJobs} %\item [Maximum Concurrent Jobs = {\textless}number{\textgreater}] \hfill \\ \index[dir]{Maximum Concurrent Jobs} @@ -3367,20 +3367,20 @@ \section{Catalog Resource} indicating that all catalog data for that Client is maintained in this Catalog. This directive is required. -\directive{dir}{dbdriver}{postgresql {\textbar} mysql {\textbar} sqlite}{required}{} +\directive{dir}{dbdriver}{postgresql {\textbar} mysql {\textbar} sqlite}{required}{}{} Selects the database type to use. -\directive{dir}{dbname}{name}{required}{} +\directive{dir}{dbname}{name}{required}{}{} This specifies the name of the database. If you use multiple catalogs (databases), you specify which one here. If you are using an external database server rather than the internal one, you must specify a name that is known to the server (i.e. you explicitly created the Bareos tables using this name). -\directive{dir}{dbuser}{user}{required}{} +\directive{dir}{dbuser}{user}{required}{}{} This specifies what user name to use to log into the database. -\directive{dir}{dbpassword}{password}{required}{} +\directive{dir}{dbpassword}{password}{required}{}{} This specifies the password to use when logging into the database. diff --git a/manuals/en/main/filedconf.tex b/manuals/en/main/filedconf.tex index 1cbf94f..57d00a6 100644 --- a/manuals/en/main/filedconf.tex +++ b/manuals/en/main/filedconf.tex @@ -57,7 +57,7 @@ \section{Client Resource} can be easily identified if you have multiple Clients. This directive is required. -\directive{fd}{Working Directory}{directory}{}{{\it platform specific}} +\directive{fd}{Working Directory}{directory}{}{{\it platform specific}}{} % \item [Working Directory = {\textless}Directory{\textgreater}] \hfill \\ % \index[fd]{Working Directory} % \index[fd]{Directive!Working Directory} @@ -78,7 +78,7 @@ \section{Client Resource} the Director is temporarily put in this directory before being passed to the Storage daemon). -\directive{fd}{Pid Directory}{directory}{}{{\it platform specific}} +\directive{fd}{Pid Directory}{directory}{}{{\it platform specific}}{} This directive specifies a directory in which the File Daemon may put its process Id file files. The process Id file is used to shutdown Bareos and to prevent multiple copies of Bareos from running simultaneously. @@ -92,12 +92,12 @@ \section{Client Resource} % will be properly expanded. -\directive{fd}{Plugin Directory}{directory}{}{{\it platform specific}} +\directive{fd}{Plugin Directory}{directory}{}{{\it platform specific}}{} This directive specifies a directory in which the File Daemon searches for plugins with the name {\bf {\textless}pluginname{\textgreater}-fd.so} which it will load at startup. Typically on Linux systems, it is set to \path|/usr/lib/bareos/plugins/| or \path|/usr/lib64/bareos/plugins/|. -\directive{fd}{Heartbeat Interval}{time-interval}{}{{0}} +\directive{fd}{Heartbeat Interval}{time-interval}{}{{0}}{} \index[general]{Heartbeat Interval} \index[general]{Broken pipe} \index[general]{slow} @@ -131,7 +131,7 @@ \section{Client Resource} % also be caused by Linux firewalls where you have a rule that throttles % connections or traffic. -\directive{fd}{Maximum Concurrent Jobs}{number}{}{{2}} +\directive{fd}{Maximum Concurrent Jobs}{number}{}{{2}}{} where {\textless}number{\textgreater} is the maximum number of Jobs that should run concurrently. The default is set to 2, but you may set it to a larger number. Each contact from the Director (e.g. status request, job start @@ -190,7 +190,7 @@ \section{Client Resource} the resolution can be made either by IPv4 or IPv6. If ip4 is specified, then only IPv4 resolutions will be permitted, and likewise with ip6. -\directive{fd}{FD Port}{port-number}{}{{9102}} +\directive{fd}{FD Port}{port-number}{}{{9102}}{} This specifies the port number on which the Client listens for Director connections. It must agree with the FDPort specified in the Client resource of the Director's configuration file. @@ -228,7 +228,7 @@ \section{Client Resource} setting the Maximum Network Buffer Size to 32,768 in both the File daemon and in the Storage daemon. -\directive{fd}{Compatible}{yes{\textbar}no}{}{{yes}} +\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 Bacula file daemon as possible. Enabling this option means that diff --git a/manuals/en/main/migration.tex b/manuals/en/main/migration.tex index a3b060c..ffc929c 100644 --- a/manuals/en/main/migration.tex +++ b/manuals/en/main/migration.tex @@ -90,7 +90,7 @@ \section{Migration and Copy Job Resource Directives} are used to define a Migration job. \begin{description} -\directive{dir}{Pool}{pool-name}{required}{} +\directive{dir}{Pool}{pool-name}{required}{}{} The Pool specified in the Migration control Job is not a new directive for the Job resource, but it is particularly important because it determines what Pool will be examined @@ -101,7 +101,7 @@ \section{Migration and Copy Job Resource Directives} directove must contain a {\bf Next Pool = ...} directive to define the Pool to which the data will be migrated. -\directive{dir}{Type}{Migrate{\textbar}Copy}{required}{} +\directive{dir}{Type}{Migrate{\textbar}Copy}{required}{}{} \begin{description} \item [Migrate] defines the job that is run as being a @@ -128,7 +128,7 @@ \section{Migration and Copy Job Resource Directives} subsequently be used for restoration. \end{description} -\directive{dir}{Selection Type}{selection-type-keyword}{required}{} +\directive{dir}{Selection Type}{selection-type-keyword}{required}{}{} The {\textless}selection-type-keyword{\textgreater} determines how the migration job will go about selecting what JobIds to migrate. In most cases, it is used in conjunction with a {\bf Selection Pattern} to give you fine @@ -211,7 +211,7 @@ \section{Migration and Copy Job Resource Directives} \end{description} -\directive{dir}{Selection Pattern}{quoted-string}{}{} +\directive{dir}{Selection Pattern}{quoted-string}{}{}{} The Selection Patterns permitted for each Selection-type-keyword are described above. @@ -225,7 +225,7 @@ \section{Migration and Copy Job Resource Directives} For the SQLQuery keyword, this pattern must be a valid SELECT SQL statement that returns JobIds. -\directive{dir}{Purge Migration Job}{yes{\textbar}no}{}{no} +\directive{dir}{Purge Migration Job}{yes{\textbar}no}{}{no}{} This directive may be added to the Migration Job definition in the Director configuration file to purge the job migrated at the end of a migration. diff --git a/manuals/en/main/monitorconf.tex b/manuals/en/main/monitorconf.tex index 186a970..05f8266 100644 --- a/manuals/en/main/monitorconf.tex +++ b/manuals/en/main/monitorconf.tex @@ -54,7 +54,7 @@ \section{Monitor Resource} in the {\bf Console} resource of the \ilink{Director's configuration}{DirectorChapter} file. This record is required if you wish to monitor Directors. -\directive{monitor}{Refresh Interval}{time}{}{5 seconds} +\directive{monitor}{Refresh Interval}{time}{}{5 seconds}{} Specifies the time to wait between status requests to each daemon. It can't be set to less than 1 second, or more than 10 minutes, and the default value is 5 seconds. @@ -94,7 +94,7 @@ \section{Director Resource} daemons. It is not required to be the same as the one defined in the Director's configuration file. This record is required. -\directive{monitor}{DIRPort}{port-number}{}{9101} +\directive{monitor}{DIRPort}{port-number}{}{9101}{} Specify the port to use to connect to the Director. This port must be identical to the {\bf DIRport} specified in the {\bf Director} resource of the diff --git a/manuals/en/main/storedconf-autochangerres.tex b/manuals/en/main/storedconf-autochangerres.tex index b393a4e..ac7c105 100644 --- a/manuals/en/main/storedconf-autochangerres.tex +++ b/manuals/en/main/storedconf-autochangerres.tex @@ -17,11 +17,11 @@ \section{Autochanger Resource} use an Autochanger must refer to the Autochanger resource name. \begin{description} -\directive{sd}{Name}{name}{required}{} +\directive{sd}{Name}{name}{required}{}{} Specifies the Name of the Autochanger. This name is used in the Director's Storage definition to refer to the autochanger. -\directive{sd}{Device}{device-name1, device-name2, ...}{required}{} +\directive{sd}{Device}{device-name1, device-name2, ...}{required}{}{} Specifies the names of the Device resource or resources that correspond to the autochanger drive. If you have a multiple drive autochanger, you must specify multiple Device names, each one referring to a separate @@ -30,14 +30,14 @@ \section{Autochanger Resource} device names on a single line separated by commas, and/or you may specify multiple Device directives. -\directive{sd}{Changer Device}{device}{}{} +\directive{sd}{Changer Device}{device}{}{}{} The specified {\bf name-string} gives the system file name of the autochanger device name. If specified in this resource, the Changer Device name is not needed in the Device resource. If it is specified in the Device resource (see above), it will take precedence over one specified in the Autochanger resource. -\directive{sd}{Changer Command}{command}{}{} +\directive{sd}{Changer Command}{command}{}{}{} The command specifies an external program to be called that will automatically change volumes as required by Bareos. Most frequently, you will specify the Bareos supplied \command{mtx-changer} script as follows. diff --git a/manuals/en/main/storedconf.tex b/manuals/en/main/storedconf.tex index f8499b6..bbf14af 100644 --- a/manuals/en/main/storedconf.tex +++ b/manuals/en/main/storedconf.tex @@ -54,16 +54,16 @@ \section{Storage Resource} \begin{description} -\directive{sd}{Name}{name}{required}{} +\directive{sd}{Name}{name}{required}{}{} Specifies the Name of the Storage daemon. -\directive{sd}{Working Directory}{directory}{required}{{\it platform specific}} +\directive{sd}{Working Directory}{directory}{required}{{\it platform specific}}{} This directive specifies a directory in which the Storage daemon may put its status files. This directory should be used only by {\bf Bareos}, but may be shared by other Bareos daemons provided the names given to each daemon are unique. -\directive{sd}{Pid Directory}{directory}{required}{{\it platform specific}} +\directive{sd}{Pid Directory}{directory}{required}{{\it platform specific}}{} This directive specifies a directory in which the Storage Daemon may put its process Id file files. The process Id file is used to shutdown Bareos and to prevent multiple copies of Bareos from running simultaneously. @@ -76,14 +76,14 @@ \section{Storage Resource} % \index[sd]{Directive!Subsys Directory} % This directive is currently unused. -\directive{sd}{Plugin Directory}{directory}{required}{{\it platform specific}} +\directive{sd}{Plugin Directory}{directory}{required}{{\it platform specific}}{} This directive specifies a directory in which the Storage Daemon searches for plugins with the name {\bf {\textless}pluginname{\textgreater}-sd.so} which it will load at startup. -%\directive{sd}{Scripts Directory}{directory}{required}{{\it platform specific}} +%\directive{sd}{Scripts Directory}{directory}{required}{{\it platform specific}}{} %This directive is currently unused. -\directive{sd}{Heartbeat Interval}{time-interval}{required}{0} +\directive{sd}{Heartbeat Interval}{time-interval}{required}{0}{} \index[general]{Heartbeat Interval} \index[general]{Broken pipe} This directive defines an interval of time in seconds. When @@ -96,7 +96,7 @@ \section{Storage Resource} duration despite the fact that keepalive is set. This usually results in a broken pipe error message. -\directive{sd}{Client Connect Wait}{time-interval}{required}{30 minutes} +\directive{sd}{Client Connect Wait}{time-interval}{required}{30 minutes}{} \index[general]{Client Connect Wait} This directive defines an interval of time in seconds that the Storage daemon will wait for a Client (the File daemon) @@ -104,7 +104,7 @@ \section{Storage Resource} longer the Storage daemon waits for a Client, the more resources will be tied up. -\directive{sd}{Maximum Concurrent Jobs}{number}{required}{10} +\directive{sd}{Maximum Concurrent Jobs}{number}{required}{10}{} where {\textless}number{\textgreater} is the maximum number of Jobs that may run concurrently. The default is set to 10, but you may set it to a larger number. Each contact from the Director (e.g. status request, job start @@ -117,7 +117,7 @@ \section{Storage Resource} the Storage resource in the Director's configuration file and possibly those in the Job and Client resources. -\directive{sd}{SD Adress}{IP-address}{}{} +\directive{sd}{SD Adress}{IP-address}{}{}{} This directive is optional, and if it is specified, it will cause the Storage daemon server (for Director and File daemon connections) to bind to the specified {\bf IP-Address}, which is either a domain name or an @@ -125,7 +125,7 @@ \section{Storage Resource} specified, the Storage daemon will bind to any available address (the default). -\directive{sd}{SD Adresses}{IP-address-specification}{}{} +\directive{sd}{SD Adresses}{IP-address-specification}{}{}{} Specify the ports and addresses on which the Storage daemon will listen for Director connections. Normally, the default is sufficient and you do not need to specify this directive. Probably the simplest way to @@ -169,11 +169,11 @@ \section{Storage Resource} Using this directive, you can replace both the SDPort and SDAddress directives shown below. -\directive{sd}{SD Port}{port-number}{required}{9103} +\directive{sd}{SD Port}{port-number}{required}{9103}{} Specifies port number on which the Storage daemon listens for Director connections. -\directive{sd}{Compatible}{yes{\textbar}no}{required}{yes} +\directive{sd}{Compatible}{yes{\textbar}no}{required}{yes}{} This directive enables the compatible mode of the storage daemon. In this mode the storage daemon will try to write the storage data in a compatible way with Bareos of which Bareos is a fork. This only works @@ -182,17 +182,17 @@ \section{Storage Resource} daemon but might not be understood by any of the Bareos components (dir/sd/fd). -\directive{sd}{NDMP Enable}{yes{\textbar}no}{}{} +\directive{sd}{NDMP Enable}{yes{\textbar}no}{}{}{} This directive enables the Native NDMP Tape Agent. -\directive{sd}{NDMP Snooping}{yes{\textbar}no}{}{} +\directive{sd}{NDMP Snooping}{yes{\textbar}no}{}{}{} This directive enables the Snooping and pretty printing of NDMP protocol information in debugging mode. -\directive{sd}{NDMP Loglevel}{level}{}{} +\directive{sd}{NDMP Loglevel}{level}{}{}{} This directive sets the loglevel for the NDMP protocol library. -\directive{sd}{NDMP Address}{IP-address}{}{} +\directive{sd}{NDMP Address}{IP-address}{}{}{} This directive is optional, and if it is specified, it will cause the Storage daemon server (for NDMP Tape Server connections) to bind to the specified {\bf IP-Address}, which is either a domain name or an @@ -200,17 +200,16 @@ \section{Storage Resource} specified, the Storage daemon will bind to any available address (the default). -\directive{sd}{NDMP Addresses}{IP-address-specification}{}{} +\directive{sd}{NDMP Addresses}{IP-address-specification}{}{}{} Specify the ports and addresses on which the Storage daemon will listen for NDMP Tape Server connections. Normally, the default is sufficient and you do not need to specify this directive. -\directive{sd}{NDMP Port}{port-specification}{}{10000} +\directive{sd}{NDMP Port}{port-specification}{}{10000}{} Specifies port number on which the Storage daemon listens for NDMP Tape Server connections. -\directive{sd}{AutoXflateOnReplication}{yes{\textbar}no}{required}{yes} -This directive controls the autoxflate-sd plugin when replicating data inside one or +\xdirective{sd}{AutoXflateOnReplication}{yes{\textbar}no}{required}{yes}{13.4}{This directive controls the autoxflate-sd plugin when replicating data inside one or between two storage daemons (Migration/Copy Jobs). Normally the storage daemon will use the autoinflate/autodeflate setting of the device when reading and writing data to it which could mean that while reading it inflates the compressed data @@ -218,14 +217,12 @@ \section{Storage Resource} be exactly the same e.g. don't perform any on the fly uncompression and compression while doing the replication of data you can set this option to no and it will override any setting on the device for doing auto inflation/deflation when doing -data replication. This will not have any impact on any normal backup or restore jobs. - +data replication. This will not have any impact on any normal backup or restore jobs.} \end{description} The following is a typical Storage daemon Storage definition. -\footnotesize -\begin{verbatim} +\begin{bconfig}{Storage daemon Storage definition} # # "Global" Storage daemon configuration specifications appear # under the Storage resource. @@ -234,8 +231,7 @@ \section{Storage Resource} Name = "Storage daemon" Address = localhost } -\end{verbatim} -\normalsize +\end{bconfig} \section{Director Resource} \label{DirectorResource1} @@ -355,7 +351,7 @@ \section{Device Resource} \begin{description} -\directive{sd}{Name}{name}{required}{} +\directive{sd}{Name}{name}{required}{}{} Specifies the Name that the Director will use when asking to backup or restore to or from to this device. This is the logical Device name, and may be any string up to 127 characters in length. It is generally a good idea to @@ -366,7 +362,7 @@ \section{Device Resource} \ilink{Device directive}{StorageResource2} in its Storage resource. -\directive{sd}{Archive Device}{device {\textbar} directory {\textbar} fifo}{required}{} +\directive{sd}{Archive Device}{device {\textbar} directory {\textbar} fifo}{required}{}{} Specifies where to read and write the backup data. The type of the Archive Device can be specified by the {\bf Device Type} directive. If Device Type is not specified, Bareos tries to guess the Device Type @@ -430,7 +426,7 @@ \section{Device Resource} \end{description} -\directive{sd}{Device Type}{tape {\textbar} file {\textbar} fifo}{}{} +\directive{sd}{Device Type}{tape {\textbar} file {\textbar} fifo}{}{}{} The Device Type specification allows you to explicitly tell Bareos what kind of device you are defining. It the {\bf type-specification} may be one of the following: @@ -607,7 +603,7 @@ \section{Device Resource} for reserving a drive for something special such as a high priority backup or restore operations. -\directive{sd}{Maximum Concurrent Jobs}{number}{}{} +\directive{sd}{Maximum Concurrent Jobs}{number}{}{}{} {\bf Maximum Concurrent Jobs} is a directive that permits setting the maximum number of Jobs that can run concurrently on a specified Device. Using this directive, it is possible to have different Jobs using multiple drives, because @@ -640,7 +636,7 @@ \section{Device Resource} for a open before timing out. If this time is exceeded, Bareos will cancel the job. The default is 5 minutes. -\directive{sd}{Always Open}{yes{\textbar}no}{}{no} +\directive{sd}{Always Open}{yes{\textbar}no}{}{no}{} If {\bf Yes}, Bareos will always keep the device open unless specifically {\bf unmounted} by the Console program. This permits Bareos to ensure that the tape drive is always available, and properly @@ -828,7 +824,7 @@ \section{Device Resource} please note that the tape must be mounted before the job begins. -\directive{sd}{Block Checksum}{yes{\textbar}no}{}{yes} +\directive{sd}{Block Checksum}{yes{\textbar}no}{}{yes}{} You may turn off the Block Checksum (CRC32) code that Bareos uses when writing blocks to a Volume. Doing so can reduce the Storage daemon CPU usage slightly. It will also permit Bareos to read a Volume that has corrupted @@ -838,7 +834,7 @@ \section{Device Resource} drives or for disk Volumes where doing so may allow corrupted data to go undetected. -\directive{sd}{Minimum block size}{size-in-bytes}{}{0} +\directive{sd}{Minimum block size}{size-in-bytes}{}{0}{} This statement applies only to non-random access devices (e.g. tape drives). Blocks written by the storage daemon to a non-random archive device will never be smaller than the given {\bf size-in-bytes}. @@ -875,7 +871,7 @@ \section{Device Resource} \end{bconfig} -\directive{sd}{Maximum block size}{size-in-bytes}{}{64512} +\directive{sd}{Maximum block size}{size-in-bytes}{}{64512}{} The Storage daemon will always attempt to write blocks of the specified {\bf size-in-bytes} to the archive device. As a consequence, this statement specifies both the default block size @@ -899,7 +895,7 @@ \section{Device Resource} \warning{If your are using LTO drives, changing the block size after labeling the tape will result into unreadable tapes. So normally you will not change the block size in an existing configuration.} -\directive{sd}{Hardware End of Medium}{yes{\textbar}no}{}{yes} +\directive{sd}{Hardware End of Medium}{yes{\textbar}no}{}{yes}{} All modern (after 1998) tape drives should support this feature. In doubt, use the {\bf btape} program to test your drive to see whether or not it supports this function. @@ -916,7 +912,7 @@ \section{Device Resource} number. You should ensure that this option is always turned off using the {\bf mt} program. -\directive{sd}{Fast Forward Space File}{yes{\textbar}no}{}{yes} +\directive{sd}{Fast Forward Space File}{yes{\textbar}no}{}{yes}{} If {\bf No}, the archive device is not required to support keeping track of the file number ({\bf MTIOCGET} ioctl) during forward space file. If {\bf Yes}, the archive device must support the {\tt ioctl} {\tt MTFSF} call, which @@ -926,7 +922,7 @@ \section{Device Resource} but they do not keep track of the file number or more seriously, they do not report end of medium. -\directive{sd}{Use MTIOCGET}{yes{\textbar}no}{}{yes} +\directive{sd}{Use MTIOCGET}{yes{\textbar}no}{}{yes}{} If {\bf No}, the operating system is not required to support keeping track of the file number and reporting it in the ({\bf MTIOCGET} ioctl). If you must set this to No, Bareos will do the proper file @@ -936,7 +932,7 @@ \section{Device Resource} on a few *BSD systems. Operating systems known to work correctly are Solaris, Linux and FreeBSD. -\directive{sd}{BSF at EOM}{yes{\textbar}no}{}{no} +\directive{sd}{BSF at EOM}{yes{\textbar}no}{}{no}{} If {\bf No}, the default, no special action is taken by Bareos with the End of Medium (end of tape) is reached because the tape will be positioned after the last EOF tape mark, and Bareos can append to the tape as desired. @@ -948,7 +944,7 @@ \section{Device Resource} the second EOF mark. Determination of whether or not you need this directive is done using the {\bf test} command in the {\bf btape} program. -\directive{sd}{Two EOF}{yes{\textbar}no}{}{no} +\directive{sd}{Two EOF}{yes{\textbar}no}{}{no}{} If {\bf Yes}, Bareos will write two end of file marks when terminating a tape -- i.e. after the last job or at the end of the medium. If {\bf No}, the default, Bareos will only write one end of file to terminate the tape. @@ -1146,10 +1142,7 @@ \section{Device Resource} writing to a device that requires mount (USB). The default is to use the working directory. -\item [AutoDeflate = {\textless}in{\textbar}out{\textbar}both{\textgreater}] \hfill \\ -\index[sd]{AutoDeflate} -\index[sd]{Directive!AutoDeflate} -This is a parameter used by the autoxflate-sd plugin which allow you to transform +\xdirective{sd}{AutoDeflate}{in{\textbar}out{\textbar}both}{}{}{13.4}{This is a parameter used by the autoxflate-sd plugin which allow you to transform a non compressed piece of data into a compressed piece of data on the storage daemon. e.g. Storage Daemon compression. You can either enable compression on the client and use the CPU cyclces there to compress your data with one of the supported @@ -1174,31 +1167,22 @@ \section{Device Resource} the compression/decompression itself and you have enough network bandwidth. Or when your filesystem doesn't have the option to transparently compress data you write to it but you want the data to be compressed when written. +} -\item [AutoDeflateAlgorithm = {\textless}GZIP{\textbar}LZO{\textbar}LZFAST{\textbar}LZ4{\textbar}LZ4HC{\textgreater}] \hfill \\ -\index[sd]{AutoDeflateAlgorithm} -\index[sd]{Directive!AutoDeflateAlgorithm} -This option specifies the compression algorithm used for the autodeflate option +\xdirective{sd}{AutoDeflateAlgorithm}{GZIP{\textbar}LZO{\textbar}LZFAST{\textbar}LZ4{\textbar}LZ4HC}{}{}{13.4}{This option specifies the compression algorithm used for the autodeflate option which is performed by the autoxflate-sd plugin. The algorithms supported are: - \begin{itemize} -\item GZIP - gzip level 1 -9 +\item GZIP - gzip level 1--9 \item LZO \item LZFAST \item LZ4 \item LZ4HC -\end{itemize} +\end{itemize}} -\item [AutoDeflateLevel = {\textless}{\textgreater}] \hfill \\ -\index[sd]{AutoDeflateLevel} -\index[sd]{Directive!AutoDeflateLevel} -This option specifies the level to be used when compressing when you select a -compression algorithm that has different levels. +\xdirective{sd}{AutoDeflateLevel}{0--9}{}{}{13.4}{This option specifies the level to be used when compressing when you select a +compression algorithm that has different levels.} -\item [AutoInflate = {\textless}in{\textbar}out{\textbar}both{\textgreater}] \hfill \\ -\index[sd]{AutoInflate} -\index[sd]{Directive!AutoInflate} -This is a parameter used by the autoxflate-sd plugin which allow you to transform +\xdirective{sd}{AutoInflate}{in{\textbar}out{\textbar}both}{}{}{13.4}{This is a parameter used by the autoxflate-sd plugin which allow you to transform a compressed piece of data into a non compressed piece of data on the storage daemon. e.g. Storage Daemon decompression. You can either enable decompression on the client and use the CPU cyclces there to decompress your data with one of the supported @@ -1217,8 +1201,7 @@ \section{Device Resource} less data over the network. It also allows you to restore data in a compression format that the client might not support but the storage daemon does. This only works on normal compressed datastreams not on encrypted datastreams or meta data -streams. - +streams.} \end{description} \subsection{Edit Codes for Mount and Unmount Directives} diff --git a/manuals/en/main/tls.tex b/manuals/en/main/tls.tex index ce1abe6..780ba56 100644 --- a/manuals/en/main/tls.tex +++ b/manuals/en/main/tls.tex @@ -40,19 +40,19 @@ \section{TLS Configuration Directives} These new directives are defined as follows: \begin{description} -\directive{dir}{TLS Enable}{yes{\textbar}no}{}{no} +\directive{dir}{TLS Enable}{yes{\textbar}no}{}{no}{} Enable TLS support. If TLS is not enabled, none of the other TLS directives have any effect. In other words, even if you set {\bf TLS Require = yes} you need to have TLS enabled or TLS will not be used. -\directive{dir}{TLS Require}{yes{\textbar}no}{}{no} +\directive{dir}{TLS Require}{yes{\textbar}no}{}{no}{} Require TLS connections. This directive is ignored unless {\bf TLS Enable} is set to {\bf yes}. If TLS is not required, and TLS is enabled, then Bareos will connect with other daemons either with or without TLS depending on what the other daemon requests. If TLS is enabled and TLS is required, then Bareos will refuse any connection that does not use TLS. -\directive{dir}{TLS Certificate}{filename}{}{} +\directive{dir}{TLS Certificate}{filename}{}{}{} The full path and filename of a PEM encoded TLS certificate. It can be used as either a client or server certificate. PEM stands for Privacy Enhanced Mail, but in this context refers to how the certificates are @@ -60,11 +60,11 @@ \section{TLS Configuration Directives} text based rather than binary. They may also contain encrypted information. -\directive{dir}{TLS Key}{filename}{}{} +\directive{dir}{TLS Key}{filename}{}{}{} The full path and filename of a PEM encoded TLS private key. It must correspond to the TLS certificate. -\directive{dir}{TLS Verify Peer}{yes{\textbar}no}{}{} +\directive{dir}{TLS Verify Peer}{yes{\textbar}no}{}{}{} Verify peer certificate. Instructs server to request and verify the client's x509 certificate. Any client certificate signed by a known-CA will be accepted unless the TLS Allowed CN configuration directive is used, @@ -72,13 +72,13 @@ \section{TLS Configuration Directives} Common Name specified. This directive is valid only for a server and not in a client context. -\directive{dir}{TLS Allowed CN}{stringlist}{}{} +\directive{dir}{TLS Allowed CN}{stringlist}{}{}{} Common name attribute of allowed peer certificates. If this directive is specified, all server certificates will be verified against this list. This can be used to ensure that only the CA-approved Director may connect. This directive may be specified more than once. -\directive{dir}{TLS CA Certificate File}{filename}{}{} +\directive{dir}{TLS CA Certificate File}{filename}{}{}{} The full path and filename specifying a PEM encoded TLS CA certificate(s). Multiple certificates are permitted in the file. One of \emph{TLS CA Certificate File} or \emph{TLS @@ -86,7 +86,7 @@ \section{TLS Configuration Directives} Verify Peer} (see above) is also specified, and are always required in a client context. -\directive{dir}{TLS CA Certificate Dir}{directory}{}{} +\directive{dir}{TLS CA Certificate Dir}{directory}{}{}{} Full path to TLS CA certificate directory. In the current implementation, certificates must be stored PEM encoded with OpenSSL-compatible hashes, which is the subject name's hash and an extension of {\bf .0}. @@ -94,7 +94,7 @@ \section{TLS Configuration Directives} required in a server context if \emph{TLS Verify Peer} is also specified, and are always required in a client context. -\directive{dir}{TLS DH File}{filename}{}{} +\directive{dir}{TLS DH File}{filename}{}{}{} Path to PEM encoded Diffie-Hellman parameter file. If this directive is specified, DH key exchange will be used for the ephemeral keying, allowing for forward secrecy of communications. DH key exchange adds an additional