From: Eric Bollengier <eric@zogi.(none)>
Date: Mon, 16 Nov 2009 11:35:42 +0000 (+0100)
Subject: Add some doc about tab-completion
X-Git-Tag: Release-5.0.0~39^2~3
X-Git-Url: https://git.sur5r.net/?a=commitdiff_plain;h=721884d232f18ebe5810cbc0ca003d00793b0b9d;p=bacula%2Fdocs

Add some doc about tab-completion
---

diff --git a/docs/manuals/en/main/newfeatures.tex b/docs/manuals/en/main/newfeatures.tex
index 5a1d990d..5dc7919d 100644
--- a/docs/manuals/en/main/newfeatures.tex
+++ b/docs/manuals/en/main/newfeatures.tex
@@ -45,7 +45,8 @@ your incremental jobs use another Storage Daemon with lots of disks, Bacula
 will switch automatically from one Storage Daemon to an other within the same
 Restore job.
 
-You must upgrade your File Daemon to version 3.1.3 or greater to use this feature.
+You must upgrade your File Daemon to version 3.1.3 or greater to use this
+feature.
 
 This project was funded by Bacula Systems with the help of Equiinet.
 
@@ -183,7 +184,16 @@ and size.
 
 If you build \texttt{bconsole} with readline support, you will be able to use
 the new auto-completion mode. This mode supports all commands, gives help
-inside command, and lists resources when required.
+inside command, and lists resources when required. It works also in the restore
+mode.
+
+To use this feature, you should have readline development package loaded on
+your system, and use the following option in configure.
+\begin{verbatim}
+./configure --with-readline=/usr/include/readline --disable-conio ...
+\end{verbatim}
+
+The new bconsole won't be able to tab-complete with older directors.
 
 \section{Bvfs API}
 \label{sec:bvfs}
@@ -192,9 +202,9 @@ To help developers of restore GUI interfaces, we have added new \textsl{dot
   commands} that permit browsing the catalog in a very simple way.
 
 \begin{itemize}
-\item \texttt{.bvfs\_update [jobid=x,y,z]} This command is required to update the
-  Bvfs cache in the catalog. You need to run it before any access to the Bvfs
-  layer.
+\item \texttt{.bvfs\_update [jobid=x,y,z]} This command is required to update
+  the Bvfs cache in the catalog. You need to run it before any access to the
+  Bvfs layer.
 
 \item \texttt{.bvfs\_lsdirs jobid=x,y,z path=/path | pathid=101} This command
   will list all directories in the specified \texttt{path} or