]> git.sur5r.net Git - bacula/docs/commitdiff
Adjust the "Alphabetic List of Console Commands"
authorDan Langille <dan@langille.org>
Mon, 12 Jan 2009 05:42:47 +0000 (05:42 +0000)
committerDan Langille <dan@langille.org>
Mon, 12 Jan 2009 05:42:47 +0000 (05:42 +0000)
- sort them in alphabetical order
- add some missing command (e.g. gui, time, trace)

docs/manuals/en/console/bconsole.tex

index e7e4f0c00ca830f90741fedb097313ee45988198..c5dfdae0e43fe7e619ef30e122826f0df652fe8d 100644 (file)
@@ -477,6 +477,16 @@ As an example, you might do:
    There is currently no way to get an estimate of the real file size that 
    would be found should the sparse option be enabled.
                                    
+\item [exit]
+   \index[general]{exit}
+   This command terminates the console program.  
+
+\item [gui]
+   \index[general]{gui}
+   Invoke the non-interactive gui mode.
+\begin{verbatim}
+gui [on|off]
+\end{verbatim}
 
 \item [help]
    \index[general]{help}
@@ -747,6 +757,10 @@ label storage=xxx pool=yyy slots=1-5,10 barcodes
 \item [messages]
    \index[general]{messages}
    This command causes any pending  console messages to be immediately displayed.
+
+\item [memory]
+   \index[general]{memory}
+   Print current memory usage.
  
 
 \item [mount]
@@ -771,19 +785,6 @@ mount [ jobid=\lt{}id\gt{} |  job=\lt{}job-name\gt{} ]
    the Volume unless you have explicitly {\bf unmount}ed it in  the Console
    program. 
 
-\item[python]
-   \index[general]{python}
-  The python command takes a single argument {\bf restart}:
-
-python restart
-
-   This causes the Python interpreter in the Director to be reinitialized.
-   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.
-
 \label{ManualPruning}
 \item [prune]
    \index[general]{prune}
@@ -822,6 +823,60 @@ For the {\bf purge} command to work on Volume Catalog database  records the
 
 The actual data written to the Volume will be unaffected by  this command.  
 
+\item[python]
+   \index[general]{python}
+  The python command takes a single argument {\bf restart}:
+
+python restart
+
+   This causes the Python interpreter in the Director to be reinitialized.
+   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.
+
+\item [query]
+   \index[general]{query}
+   This command reads a predefined SQL query from  the query file (the name and
+   location of the  query file is defined with the QueryFile resource record in 
+   the Director's configuration file). You are prompted to select  a query from
+   the file, and possibly enter one or more parameters,  then the command is
+   submitted to the Catalog database SQL engine.  
+
+The following queries are currently available (version 2.2.7):  
+
+\footnotesize
+\begin{verbatim}
+Available queries:
+1: List up to 20 places where a File is saved regardless of the directory
+2: List where the most recent copies of a file are saved
+3: List last 20 Full Backups for a Client
+4: List all backups for a Client after a specified time
+5: List all backups for a Client
+6: List Volume Attributes for a selected Volume
+7: List Volumes used by selected JobId
+8: List Volumes to Restore All Files
+9: List Pool Attributes for a selected Pool
+10: List total files/bytes by Job
+11: List total files/bytes by Volume
+12: List Files for a selected JobId
+13: List Jobs stored on a selected MediaId
+14: List Jobs stored for a given Volume name
+15: List Volumes Bacula thinks are in changer
+16: List Volumes likely to need replacement from age or errors
+Choose a query (1-16):
+\end{verbatim}
+\normalsize
+
+\item [quit]
+   \index[general]{quit}
+   This command terminates the console program. The  console program sends the
+   {\bf quit} request to the Director  and waits for acknowledgment. If the
+   Director is busy doing  a previous command for you that has not terminated, it
+   may  take some time. You may quit immediately by issuing the  {\bf .quit}
+   command (i.e. quit preceded by a period).  
+
 \item [relabel]
    \index[general]{relabel}
    \index[general]{relabel}
@@ -1010,6 +1065,11 @@ setdebug level=nn [trace=0/1 client=\lt{}client-name\gt{} | dir | director |
    appended to the trace file.  You must explicitly delete the file when
    you are done.
 
+\item [setip]
+   \index[general]{setip}
+   Sets new client address -- if authorized.
+
+
 \item [show]
    \index[general]{show}
    \index[general]{show}
@@ -1173,6 +1233,18 @@ the user unmounted the device. The real problem for the Job I started
 using the "File" device is that the device is blocked waiting for
 media -- that is Bacula needs you to label a Volume.
 
+\item [time]
+   \index[general]{time}
+   Prints the current time.
+
+\item [trace]
+   \index[general]{trace}
+   Turn on/off trace to file.
+
+\item [umount]
+   \index[general]{umount}
+   For old-time Unix guys.  See the unmount command for full details.
+
 \item [unmount]
    \index[general]{unmount}
    This command causes the indicated Bacula Storage  daemon to unmount the
@@ -1295,51 +1367,6 @@ use \lt{}database-name\gt{}
    \index[general]{version}
    The command prints the Director's version.  
 
-\item [quit]
-   \index[general]{quit}
-   This command terminates the console program. The  console program sends the
-   {\bf quit} request to the Director  and waits for acknowledgment. If the
-   Director is busy doing  a previous command for you that has not terminated, it
-   may  take some time. You may quit immediately by issuing the  {\bf .quit}
-   command (i.e. quit preceded by a period).  
-
-\item [query]
-   \index[general]{query}
-   This command reads a predefined SQL query from  the query file (the name and
-   location of the  query file is defined with the QueryFile resource record in 
-   the Director's configuration file). You are prompted to select  a query from
-   the file, and possibly enter one or more parameters,  then the command is
-   submitted to the Catalog database SQL engine.  
-
-The following queries are currently available (version 2.2.7):  
-
-\footnotesize
-\begin{verbatim}
-Available queries:
-1: List up to 20 places where a File is saved regardless of the directory
-2: List where the most recent copies of a file are saved
-3: List last 20 Full Backups for a Client
-4: List all backups for a Client after a specified time
-5: List all backups for a Client
-6: List Volume Attributes for a selected Volume
-7: List Volumes used by selected JobId
-8: List Volumes to Restore All Files
-9: List Pool Attributes for a selected Pool
-10: List total files/bytes by Job
-11: List total files/bytes by Volume
-12: List Files for a selected JobId
-13: List Jobs stored on a selected MediaId
-14: List Jobs stored for a given Volume name
-15: List Volumes Bacula thinks are in changer
-16: List Volumes likely to need replacement from age or errors
-Choose a query (1-16):
-\end{verbatim}
-\normalsize
-
-\item [exit]
-   \index[general]{exit}
-   This command terminates the console program.  
-
 \item [wait]
    \index[general]{wait}
    The wait command causes the Director to pause  until there are no jobs