tweak

manuals/en/main/Makefile

@@ -82,9 +82,8 @@ autogenerated/*.tex: autogenerated/bareos-dir-config-schema.json
 
 check: bareos-manual-main-reference.pdf
 	@# hyperlink: multiline: pdfTeX warning .* has been reference$d but does not exist
-	@# TODO: add \|pdfTeX warning .* has been reference
 	@# defDirective multiline: Warning: defDirective{Dir}{Director}{PluginNames} has no matching resourceDirec$tive and will be ignored.
-	@if ! grep "LaTeX Warning: Hyper reference .* undefined on input\|LaTeX Warning: There were undefined references.\|Warning: defDirective" $(LOG); then echo "CHECK: OK"; true; else echo "CHECK: FAILED: undefined references"; false; fi
+	@if ! grep "LaTeX Warning: Hyper reference .* undefined on input\|LaTeX Warning: There were undefined references.\|pdfTeX warning .* has been reference\|Warning: defDirective" $(LOG); then echo "CHECK: OK"; true; else echo "CHECK: FAILED: undefined references"; false; fi
 
 clean:
 	rm -f *.4ct *.4dx *.4ix *.4tc *.aux *.dvi *.htidx *.htind *.idx *.log *.out *.pdf *.toc *.idv *.lg *.tmp *.xref html/* bareos-manual-main-reference.html bareos-manual-main-reference.css

manuals/en/main/bareos.sty

@@ -280,7 +280,7 @@ Version $>=$ #3%
     \csedef{resourceDirectiveVersion}{#7}%
 }%
 \xdirective{#1}{#2}{#3}{\resourceDirectiveParameter}{#5}{#6}{\resourceDirectiveVersion}{%
-    \ifthenelse{\isempty{#8}}{}{%
+\ifthenelse{\isempty{#8}}{}{%
 #8
 
 }%

manuals/en/main/dirdconf.tex

@@ -490,62 +490,33 @@ \section{Catalog Resource}
 \input{director-resource-catalog-definitions.tex}
 \input{autogenerated/director-resource-catalog-description.tex}
 
-% \begin{description}
-
-%% \item [Multiple Connections = {\textless}yes{\textbar}no{\textgreater}] \hfill \\
-%% \index[dir]{Multiple Connections}
-%% \index[dir]{Directive!Multiple Connections}
-%% By default, this  directive is set to no. In that case, each job that uses the
-%% same Catalog will use a single connection to the catalog. It will  be shared,
-%% and Bareos will allow only one Job at a time to  communicate. If you set this
-%% directive to yes, Bareos will  permit multiple connections to the database,
-%% and the database  must be multi-thread capable. For SQLite and PostgreSQL,
-%% this is  no problem. For MySQL, you must be *very* careful to have the
-%% multi-thread version of the client library loaded on your system.  When this
-%% directive is set yes, each Job will have a separate  connection to the
-%% database, and the database will control the  interaction between the different
-%% Jobs. This can significantly  speed up the database operations if you are
-%% running multiple  simultaneous jobs. In addition, for SQLite and PostgreSQL,
-%% Bareos  will automatically enable transactions. This can significantly  speed
-%% up insertion of attributes in the database either for  a single Job or
-%% multiple simultaneous Jobs.
-
-%% This directive has not been tested. Please test carefully  before running it
-%% in production and report back your results.
-
-% \end{description}
-
 The following is an example of a valid Catalog resource definition:
 
-\footnotesize
-\begin{verbatim}
+\begin{bconfig}{Catalog Resource for Sqlite}
 Catalog
 {
   Name = SQLite
-  dbdriver = sqlite
-  dbname = bareos;
-  dbuser = bareos;
-  dbpassword = ""                       # no password = no security
+  DB Driver = sqlite
+  DB Name = bareos;
+  DB User = bareos;
+  DB Password = ""
 }
-\end{verbatim}
-\normalsize
+\end{bconfig}
 
 or for a Catalog on another machine:
 
-\footnotesize
-\begin{verbatim}
+\begin{bconfig}{Catalog Resource for remote MySQL}
 Catalog
 {
   Name = MySQL
-  db Driver = mysql
-  db Name = bareos
-  db User = bareos
-  db Password = ""
-  db Address = remote.acme.com
-  db Port = 1234
+  DB Driver = mysql
+  DB Name = bareos
+  DB User = bareos
+  DB Password = "secret"
+  DB Address = remote.example.com
+  DB Port = 1234
 }
-\end{verbatim}
-\normalsize
+\end{bconfig}
 
 \section{Messages Resource}
 \label{DirectorResourceMessages}
@@ -610,7 +581,7 @@ \section{Console Resource}
 keyword {\bf all} can be specified in any of the above access control lists.
 When this keyword is present, any resource or command name (which ever is
 appropriate) will be accepted. For an example configuration file, please see
-the \ilink{Console Configuration}{ConsoleConfChapter} chapter of this manual.
+the \nameref{ConsoleConfChapter} chapter of this manual.
 
 \section{Counter Resource}
 \label{DirectorResourceCounter}
@@ -632,7 +603,4 @@ \section{Example Director Configuration File}
 
 See below an example of a full Director configuration file:
 
-{
-\footnotesize
-\verbatiminput{bareos-dir.conf.in}
-}
+\bconfigInput{bareos-dir.conf.in}

manuals/en/main/director-resource-catalog-definitions.tex

@@ -1,12 +1,13 @@
 \defDirective{Dir}{Catalog}{Address}{}{}{%
+Alias for \linkResourceDirective{Dir}{Catalog}{DB Address}.
 }
 
 \defDirective{Dir}{Catalog}{DB Address}{}{}{%
 This is the host address  of the database server. Normally, you would specify
-this instead  of {\bf DB Socket} if the database server is on another machine.
-In that case, you will also specify {\bf DB Port}. This directive  is used
+this instead  of \linkResourceDirective{Dir}{Catalog}{DB Socket} if the database server is on another machine.
+In that case, you will also specify \linkResourceDirective{Dir}{Catalog}{DB Port}. 
+This directive  is used
 only by MySQL and PostgreSQL and is ignored by SQLite if provided.
-This directive is optional.
 }
 
 \defDirective{Dir}{Catalog}{DB Driver}{postgresql {\textbar} mysql {\textbar} sqlite}{}{%
@@ -22,20 +23,20 @@
 }
 
 \defDirective{Dir}{Catalog}{DB Password}{}{}{%
-This specifies the password to use when logging into the database.
+This specifies the password to use when login into the database.
 }
 
 \defDirective{Dir}{Catalog}{DB Port}{}{}{%
-This defines the port to  be used in conjunction with {\bf DB Address} to
+This defines the port to  be used in conjunction with \linkResourceDirective{Dir}{Catalog}{DB Address} to
 access the  database if it is on another machine. This directive is used  only
-by MySQL and PostgreSQL and is ignored by SQLite if provided.  This
-directive is optional.
+by MySQL and PostgreSQL and is ignored by SQLite if provided.
 }
 
 \defDirective{Dir}{Catalog}{DB Socket}{}{}{%
 This is the name of  a socket to use on the local host to connect to the
 database. This directive is used only by MySQL and is ignored by  SQLite.
-Normally, if neither {\bf DB Socket} or {\bf DB Address}  are specified, MySQL
+Normally, if neither \linkResourceDirective{Dir}{Catalog}{DB Socket} 
+or \linkResourceDirective{Dir}{Catalog}{DB Address}  are specified, MySQL
 will use the default socket. If the DB Socket is specified, the
 MySQL server must reside on the same machine as the Director.
 }
@@ -51,7 +52,8 @@
 This directive allows you to override at runtime if the Batch insert should
 be enabled or disabled. Normally this is determined by querying the database
 library if it is thread-safe. If you think that disabling Batch insert will make
-your backup run faster you may disable it using this option and set it to {\bf Yes}
+your backup run faster you may disable it using this option and set it to 
+\parameter{Yes}.
 }
 
 \defDirective{Dir}{Catalog}{Idle Timeout}{}{}{%
@@ -79,19 +81,39 @@
 }
 
 \defDirective{Dir}{Catalog}{Multiple Connections}{}{}{%
+%% By default, this  directive is set to no. In that case, each job that uses the
+%% same Catalog will use a single connection to the catalog. It will  be shared,
+%% and Bareos will allow only one Job at a time to  communicate. If you set this
+%% directive to yes, Bareos will  permit multiple connections to the database,
+%% and the database  must be multi-thread capable. For SQLite and PostgreSQL,
+%% this is  no problem. For MySQL, you must be *very* careful to have the
+%% multi-thread version of the client library loaded on your system.  When this
+%% directive is set yes, each Job will have a separate  connection to the
+%% database, and the database will control the  interaction between the different
+%% Jobs. This can significantly  speed up the database operations if you are
+%% running multiple  simultaneous jobs. In addition, for SQLite and PostgreSQL,
+%% Bareos  will automatically enable transactions. This can significantly  speed
+%% up insertion of attributes in the database either for  a single Job or
+%% multiple simultaneous Jobs.
+%%
+%% This directive has not been tested. Please test carefully  before running it
+%% in production and report back your results.
+Not yet implemented.
 }
 
 \defDirective{Dir}{Catalog}{Name}{}{}{%
 The name of the Catalog.  No necessary relation to the database server
 name.  This name will be specified in the Client resource directive
 indicating that all catalog data for that Client is maintained in this
-Catalog.  This directive is required.
+Catalog.
 }
 
 \defDirective{Dir}{Catalog}{Password}{}{}{%
+Alias for \linkResourceDirective{Dir}{Catalog}{DB Password}.
 }
 
 \defDirective{Dir}{Catalog}{User}{}{}{%
+Alias for \linkResourceDirective{Dir}{Catalog}{DB User}.
 }
 
 \defDirective{Dir}{Catalog}{Validate Timeout}{}{}{%

manuals/en/main/director-resource-console-definitions.tex

@@ -46,8 +46,7 @@
 challenge response hash code created with the password.  This directive
 is required.
 
-The password is plain text.  It is not generated through any special
-process.  However, it is preferable for security reasons to choose
+The password is plain text.  It is preferable for security reasons to choose
 random text.
 }
 
@@ -94,6 +93,9 @@
 }
 
 \defDirective{Dir}{Console}{TLS Enable}{}{}{%
+Bareos can be configured to encrypt all its network traffic.
+See chapter \nameref{TlsDirectives} to see,
+how the Bareos Director (and the other components) must be configured to use TLS.
 }
 
 \defDirective{Dir}{Console}{TLS Key}{}{}{%

manuals/en/main/director-resource-counter-definitions.tex

@@ -26,7 +26,8 @@
 
 \defDirective{Dir}{Counter}{Wrap Counter}{}{}{%
 If this value  is specified, when the counter is incremented past the
-maximum and thus reset to the minimum, the counter specified on the  {\bf WrapCounter}
+maximum and thus reset to the minimum, the counter specified on the  
+\linkResourceDirective{Dir}{Counter}{Wrap Counter}
 is incremented. (This is currently not implemented).
 }
 

manuals/scripts/generate-resoure-descriptions.py

@@ -177,17 +177,19 @@ def getResourceDirectives(self, resourcename):
                 'directive': self.convertCamelCase2Spaces( directive ),
                 'datatype': self.getLatexDatatypeRef( data['datatype'] ),
                 'default': self.getLatexDefaultValue( data ),
+                'alias': "",
                 'deprecated': "",
                 'required': '',
             }
 
-            deprecated=""
+            if data.get( 'alias' ):
+                strings['alias']="\\textit{This directive is an alias.}"
             if data.get( 'deprecated' ):
                 strings['deprecated']="deprecated"
             if data.get( 'required' ):
                 strings['required']="required"
 
-            result+="\\resourceDirective{%(daemon)s}{%(resource)s}{%(directive)s}{%(datatype)s}{%(required)s}{%(default)s}{%(deprecated)s}{}\n\n" % ( strings )
+            result+="\\resourceDirective{%(daemon)s}{%(resource)s}{%(directive)s}{%(datatype)s}{%(required)s}{%(default)s}{%(deprecated)s}{%(alias)s}\n\n" % ( strings )
         result+="\\end{description}\n\n"
         return result