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

Add restorejob documentation
---

diff --git a/docs/manuals/en/console/bconsole.tex b/docs/manuals/en/console/bconsole.tex
index 8861a22c..c1637b7c 100644
--- a/docs/manuals/en/console/bconsole.tex
+++ b/docs/manuals/en/console/bconsole.tex
@@ -962,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
@@ -977,6 +978,12 @@ restore storage=\lt{}storage-name\gt{} client=\lt{}backup-client-name\gt{}
    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 855fe3df..8481e0f1 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{itemize}
 
 \label{restorefilerelocation}