From b2cf1aa39724bf2b2b290b59445793de430bc327 Mon Sep 17 00:00:00 2001 From: Marco van Wieringen Date: Tue, 29 Oct 2013 16:59:38 +0100 Subject: [PATCH] Update usage messages for all utility programs. In the years that have passed new options have been added to several utility programs. Lets add them to the documentation. Fixes #238: bscan documentation misses the database type parameter --- manuals/en/main/programs.tex | 142 +++++++++++++++++++++-------------- 1 file changed, 87 insertions(+), 55 deletions(-) diff --git a/manuals/en/main/programs.tex b/manuals/en/main/programs.tex index 83ad0e5..d7f4b60 100644 --- a/manuals/en/main/programs.tex +++ b/manuals/en/main/programs.tex @@ -213,8 +213,11 @@ \subsection{bls} \begin{verbatim} Usage: bls [options] -b specify a bootstrap file - -c specify a config file - -d specify debug level + -c specify a Storage configuration file + -D specify a director name specified in the Storage + configuration file for the Key Encryption Key selection + -d set debug level to + -dt print timestamp in debug output -e exclude list -i include list -j list jobs @@ -450,13 +453,18 @@ \subsection{bextract} \footnotesize \begin{verbatim} -Usage: bextract [-d debug_level] +Usage: bextract -b specify a bootstrap file - -dnn set debug level to nn + -c specify a Storage configuration file + -D specify a director name specified in the Storage + configuration file for the Key Encryption Key selection + -d set debug level to + -dt print timestamp in debug output -e exclude list -i include list -p proceed inspite of I/O errors - -V specify Volume names (separated by |) + -v verbose + -V specify Volume names (separated by |) -? print this message \end{verbatim} \normalsize @@ -584,24 +592,33 @@ \subsection{bscan} \begin{verbatim} Usage: bscan [options] - -b bootstrap specify a bootstrap file - -c specify configuration file - -d set debug level to nn - -m update media info in database - -n specify the database name (default Bareos) - -u specify database user name (default Bareos) - -P specify database password (default none) - -h specify database host (default NULL) - -p proceed inspite of I/O errors - -r list records - -s synchronize or store in database - -v verbose - -V specify Volume names (separated by |) - -w specify working directory (default from conf file) - -? print this message + -B specify the database driver name (default NULL) + -b bootstrap specify a bootstrap file + -c specify configuration file + -d set debug level to nn + -dt print timestamp in debug output + -m update media info in database + -D specify a director name specified in the Storage + configuration file for the Key Encryption Key selection + -n specify the database name (default Bareos) + -u specify database user name (default Bareos) + -P specify database password (default none) + -h specify database host (default NULL) + -t specify database port (default 0) + -p proceed inspite of I/O errors + -r list records + -s synchronize or store in database + -S show scan progress periodically + -v verbose + -V specify Volume names (separated by |) + -w specify working directory (default from conf file) + -? print this message \end{verbatim} \normalsize +As Bareos supports loading its database backend dynamically you need to specify +the right database driver to use using the {\bf -B} option. + If you are using MySQL or PostgreSQL, there is no need to supply a working directory since in that case, bscan knows where the databases are. However, if you have provided security on your database, you may need to supply either the @@ -908,15 +925,18 @@ \subsection{bcopy} \footnotesize \begin{verbatim} Usage: bcopy [-d debug_level] - -b bootstrap specify a bootstrap file - -c specify configuration file - -dnn set debug level to nn - -i specify input Volume names (separated by |) - -o specify output Volume names (separated by |) - -p proceed inspite of I/O errors - -v verbose - -w dir specify working directory (default /tmp) - -? print this message + -b bootstrap specify a bootstrap file + -c specify configuration file + -D specify a director name specified in the Storage + configuration file for the Key Encryption Key selection + -dnn set debug level to nn + -dt print timestamp in debug output + -i specify input Volume names (separated by |) + -o specify output Volume names (separated by |) + -p proceed inspite of I/O errors + -v verbose + -w dir specify working directory (default /tmp) + -? print this message \end{verbatim} \normalsize @@ -961,13 +981,16 @@ \subsection{btape} \footnotesize \begin{verbatim} Usage: btape - -b specify bootstrap file - -c set configuration file to file - -d set debug level to nn - -p proceed inspite of I/O errors - -s turn off signals - -v be verbose - -? print this message. + -b specify bootstrap file + -c set configuration file to file + -D specify a director name specified in the Storage + configuration file for the Key Encryption Key selection + -d set debug level to nn + -dt print timestamp in debug output + -p proceed inspite of I/O errors + -s turn off signals + -v be verbose + -? print this message. \end{verbatim} \normalsize @@ -1118,13 +1141,19 @@ \subsection{bsmtp} \footnotesize \begin{verbatim} -Usage: bsmtp [-f from] [-h mailhost] [-s subject] [-c copy] [recipient ...] +Usage: bsmtp [-f from] [-h mailhost] [-s subject] [-c copy] [recipient ...t + -4 forces bsmtp to use IPv4 addresses only. + -6 forces bsmtp to use IPv6 addresses only. + -8 set charset to UTF-8 + -a use any ip protocol for address resolution -c set the Cc: field - -dnn set debug level to nn + -d set debug level to + -dt print a timestamp in debug output -f set the From: field - -h use mailhost:port as the bsmtp server - -l limit the lines accepted to nn + -h use mailhost:port as the SMTP server -s set the Subject: field + -r set the Reply-To: field + -l set the maximum number of lines to send (default: unlimited) -? print this message. \end{verbatim} \normalsize @@ -1217,20 +1246,23 @@ \subsection{bareos-dbcheck} \footnotesize \begin{verbatim} -Usage: dbcheck [-c config ] [-B] [-C catalog name] [-d debug_level] - [] [] - -b batch mode - -C catalog name in the director conf file - -c Director conf filename - -B print catalog configuration and exit - -d set debug level to - -dt print timestamp in debug output - -f fix inconsistencies - -v verbose - -? print this message +Usage: dbcheck [-c config ] [-B] [-C catalog name] [-d debug level] [-D driver name] [] [] + -b batch mode + -C catalog name in the director conf file + -c Director conf filename + -B print catalog configuration and exit + -d set debug level to + -dt print a timestamp in debug output + -D specify the database driver name (default NULL) + -f fix inconsistencies + -v verbose + -? print this message \end{verbatim} \normalsize +As Bareos supports loading its database backend dynamically you need to specify +the right database driver to use using the {\bf -D} option. + If the \textbf{-B} option is specified, bareos-dbcheck will print out catalog information in a simple text based format. This is useful to backup it in a secure way. @@ -1537,7 +1569,7 @@ \subsection{bpluginfo} \index[general]{bpluginfo} \index[general]{Command!bpluginfo} -The main purpose of bpluginfo is to display different information about Bareos plugin. You can - use it to check a plugin name, author, license and short description. You can use -f option to - display API implemented by the plugin. Some plugins may require additional '-a' option for val- - idating a Bareos Daemons API. In most cases it is not required. +The main purpose of bpluginfo is to display different information about Bareos plugin. You can +use it to check a plugin name, author, license and short description. You can use -f option to +display API implemented by the plugin. Some plugins may require additional '-a' option for val- +idating a Bareos Daemons API. In most cases it is not required.