From: Bastian Friedrich <bastian.friedrich@collax.com>
Date: Tue, 11 Dec 2012 12:28:56 +0000 (+0100)
Subject: Add restorejob documentation
X-Git-Url: https://git.sur5r.net/?a=commitdiff_plain;h=7a839ccb6ff71b2006f4e461b9636147e3e09965;p=bacula%2Fdocs

Add restorejob documentation
---

diff --git a/docs/manuals/en/console/bconsole.tex b/docs/manuals/en/console/bconsole.tex
index d0cecf17..fb1c2bf7 100644
--- a/docs/manuals/en/console/bconsole.tex
+++ b/docs/manuals/en/console/bconsole.tex
@@ -951,7 +951,7 @@ release storage=<storage-name>
    to be restored.  This mode is somewhat similar to the standard Unix {\bf
    restore} program's interactive file selection mode.
 \begin{lstlisting}
-restore storage=<storage-name> client=<backup-client-name> where=<path> pool=<pool-name> fileset=<fileset-name> restoreclient=<restore-client-name> select current all done
+restore storage=<storage-name> client=<backup-client-name> where=<path> pool=<pool-name> fileset=<fileset-name> restoreclient=<restore-client-name> restorejob=<job-name> select current all done
 \end{lstlisting}
    Where {\bf current}, if specified, tells the restore command to
    automatically select a restore to the most current backup.  If not
@@ -966,6 +966,12 @@ restore storage=<storage-name> client=<backup-client-name> where=<path> pool=<po
    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
diff --git a/docs/manuals/en/main/restore.tex b/docs/manuals/en/main/restore.tex
index 589515cf..b8ecb5db 100644
--- a/docs/manuals/en/main/restore.tex
+++ b/docs/manuals/en/main/restore.tex
@@ -631,6 +631,12 @@ The full list of possible command line arguments are:
 \item {\bf add\_suffix=.old} -- add a suffix to all your files.
 \item {\bf regexwhere=!a.pdf!a.bkp.pdf!} -- do complex filename manipulation
   like with sed unix command. Will overwrite other filename manipulation.
+\item {\bf restorejob=jobname} -- Pre-chooses a restore job. Bacula can be
+  configured with multiple restore jobs ("Type = Restore" in the job
+  definition). This allows the specification of different restore properties,
+  including a set of RunScripts. When more than one job of this type is
+  configured, during restore, Bacula will ask for a user selection
+  interactively, or use the given restorejob.
 \end{bsysitemize}
 
 \label{restorefilerelocation}