Commit two patches from Philippe to cleanup the manuals

[bacula/docs] / docs / manuals / en / console / bconsole.tex

diff --git a/docs/manuals/en/console/bconsole.tex b/docs/manuals/en/console/bconsole.tex
index c46820dc632f8525637d844c50c3a51c2c49381c..6870a6e04ddfe4bf99eb49c8c301f0a4fdf5a760 100644 (file)
--- a/docs/manuals/en/console/bconsole.tex
+++ b/docs/manuals/en/console/bconsole.tex
@@ -18,11 +18,6 @@ authorized users to interact with Bacula. You can determine the status of a
 particular job, examine the contents of the Catalog as well as perform certain
 tape manipulations with the Console program.
 
-In addition, there is a bwx-console built with wxWidgets that allows a graphic
-restore of files. As of version 1.34.1 it is in an early stage of development,
-but it already is quite useful. Unfortunately, it has not been enhanced for
-some time now.
-
 Since the Console program interacts with the Director through the network, your
 Console and Director programs do not necessarily need to run on the same
 machine. 
@@ -45,8 +40,8 @@ command line option (see below). This file allows default configuration
 of the Console, and at the current time, the only Resource Record defined
 is the Director resource, which gives the Console the name and address of
 the Director.  For more information on configuration of the Console
-program, please see the \ilink{Console Configuration
-File}{ConsoleConfChapter} Chapter of this document.
+program, please see the \borgxrlink{Console Configuration}{ConsoleConfChapter}
+{main}{chapter} of the \mainman{}.
 
 \section{Running the Console Program}
 \index[general]{Running the Console Program}
@@ -249,6 +244,8 @@ order ...
   Used in the show, list, and llist commands. Takes no arguments.
 \item [select]
   Used in the restore command. Takes no argument.
+\item[limit]
+  Used in the setbandwidth command. Takes integer in KB/s unit.
 \item [storages]
   Used in the show command. Takes no arguments.
 \item [schedules]
@@ -616,6 +613,8 @@ label storage=xxx pool=yyy slots=1-5,10 barcodes
        In the above, you can add "limit=nn" to limit the output to
        nn jobs.
    
+   list joblog jobid=<id> (list job output if recorded in the catalog)
+
    list jobmedia
    
    list jobmedia jobid=<id>
@@ -846,8 +845,8 @@ python restart
    This can be helpful for testing because once the Director starts and the
    Python interpreter is initialized, there is no other way to make it
    accept any changes to the startup script {\bf DirStartUp.py}.  For more
-   details on Python scripting, please see the \ilink{Python
-   Scripting}{PythonChapter} chapter of this manual.
+   details on Python scripting, please see the \borgxrlink{Python Scripting}
+   {PythonChapter}{misc}{chapter} of the \miscman{}.
 
 \item [query]
    \index[general]{query}
@@ -963,6 +962,7 @@ release storage=\lt{}storage-name\gt{}
 restore storage=\lt{}storage-name\gt{} client=\lt{}backup-client-name\gt{} 
   where=\lt{}path\gt{} pool=\lt{}pool-name\gt{} fileset=\lt{}fileset-name\gt{} 
   restoreclient=\lt{}restore-client-name\gt{}
+  restorejob=\lt{}job-name\gt{}
   select current all done  
 
    Where {\bf current}, if specified, tells the restore command to
@@ -970,14 +970,20 @@ restore storage=\lt{}storage-name\gt{} client=\lt{}backup-client-name\gt{}
    specified, you will be prompted.  The {\bf all} specification tells the
    restore command to restore all files.  If it is not specified, you will
    be prompted for the files to restore.  For details of the {\bf restore}
-   command, please see the \ilink{Restore Chapter}{RestoreChapter} of this
-   manual.
+   command, please see the \borgxrlink{Restore}{RestoreChapter}{main}{chapter}
+   of the \mainman{}.
 
    The client keyword initially specifies the client from which the backup
    was made and the client to which the restore will be make.  However,
    if the restoreclient keyword is specified, then the restore is written
    to that client.
 
+   The restore job rarely needs to be specified, as bacula installations
+   commonly only have a single restore job configured. However, for certain
+   cases, such as a varying list of RunScript specifications, multiple
+   restore jobs may be configured. The restorejob argument allows the
+   selection of one of these jobs.
+
 \item [run]
    \index[general]{run}
    This command allows you to schedule jobs  to be run immediately. The full form
@@ -1057,6 +1063,12 @@ The spooldata argument of the run command cannot be modified through the menu
 and is only accessible by setting its value on the intial command line. If
 no spooldata flag is set, the job, storage or schedule flag is used.
 
+\item[setbandwidth] 
+  \index[general]{setbandwidth}
+  This command is used to limit the bandwidth of a running job or a client.
+
+setbandwidth limit=<nb> [ jobid=<id> | client=<cli> ]
+
 \item [setdebug]
    \index[general]{setdebug}
    \index[general]{setdebug}
@@ -1082,6 +1094,16 @@ setdebug level=nn [trace=0/1 client=\lt{}client-name\gt{} | dir | director |
    \index[general]{setip}
    Sets new client address -- if authorized.
 
+   A console is authorized to use the {\bf SetIP} command only if it has a
+   Console resource definition in both the Director and the Console.  In
+   addition, if the console name, provided on the {\bf Name =} directive,
+   must be the same as a Client name, the user of that console is permitted
+   to use the {\bf SetIP} command to change the Address directive in the
+   Director's client resource to the IP address of the Console.  This
+   permits portables or other machines using DHCP (non-fixed IP addresses)
+   to "notify" the Director of their current IP address.
+
+
 
 \item [show]
    \index[general]{show}
@@ -1363,7 +1385,12 @@ you will be using only one database so  this will be done automatically. In
 the case that you are using  more than one database, you can use this command
 to switch from  one to another.  
 
-use \lt{}database-name\gt{} 
+\footnotesize
+\begin{verbatim}
+       use [catalog=name-of-catalog]
+\end{verbatim}
+\normalsize
+
 
 \item [var]
    \label{var}