diff --git a/manuals/en/main/README.document-conventions.txt b/manuals/en/main/README.document-conventions.txt index 74e698f..b9a2a10 100644 --- a/manuals/en/main/README.document-conventions.txt +++ b/manuals/en/main/README.document-conventions.txt @@ -64,3 +64,10 @@ Console!Command (for bconsole commands) Restore (Restoring) Catalog (Bareos Catalog, Bareos Database) Problem (Troubleshooting) + +Using \index: +\index[index]{first!second!third} + +There are 4 indexes: general, dir, sd, fd, console, monitor. +The default is general. Maybe the other indexes will get integrated into general. +It is possible to define a hierachie of index words, seperated by "!". diff --git a/manuals/en/main/main.tex b/manuals/en/main/main.tex index a2fbe86..c686913 100644 --- a/manuals/en/main/main.tex +++ b/manuals/en/main/main.tex @@ -112,8 +112,6 @@ \part{Tasks and Concepts} \include{restore} -\include{utilities} - \chapter{Volume Management} \include{disk} \include{recycling} @@ -179,6 +177,8 @@ \chapter{Operating Systems} %\include{postgresql} % catalog %\include{sqlite} % catalog +\include{programs} + \include{bootstrap} \include{backward-compability} diff --git a/manuals/en/main/utilities.tex b/manuals/en/main/programs.tex similarity index 97% rename from manuals/en/main/utilities.tex rename to manuals/en/main/programs.tex index 733dffa..1c04989 100644 --- a/manuals/en/main/utilities.tex +++ b/manuals/en/main/programs.tex @@ -1,13 +1,11 @@ -\chapter{Bareos Utilities} +\chapter{Bareos Programs} \label{_UtilityChapter} - \index[general]{Volume Utility Tools} - \index[general]{Tools!Volume Utility} This document describes the utility programs written to aid Bareos users and developers in dealing with Volumes external to Bareos adn to perform other useful tasks. -\section{Specifying Parameter} +\section{Parameter} \subsection{Specifying the Configuration File} \index[general]{Specifying the Configuration File} @@ -107,7 +105,39 @@ \subsection{Specifying Volumes} \end{verbatim} \normalsize -\section{bls} + +\section{Bareos Daemons} + +\subsection{bareos-dir} +\index[general]{Command!bareos-dir} +\index[dir]{Command Line Options} + +Bareos Director. +\TODO{Bareos Director describe command line arguments} + +\subsection{bareos-sd} +\index[general]{Command!bareos-sd} +\index[sd]{Command Line Options} + +Baroes Storage Daemon +\TODO{Bareos Storage Daemon describe command line arguments} + + +\subsection{bareos-fd} +\index[general]{Command!bareos-fd} +\index[fd]{Command Line Options} + +Baroes File Daemon +\TODO{Bareos File Daemon describe command line arguments} + + + +\section{Volume Utility Commands} + \index[general]{Volume Utility Tools} + \index[general]{Tools!Volume Utility} + + +\subsection{bls} \label{bls} \index[general]{bls} \index[general]{Command!bls} @@ -182,7 +212,7 @@ \section{bls} \normalsize -\subsection{Show Label Information} +\subsubsection{Show Label Information} \index[general]{bls!Label} Using the \parameter{-L} the label information of a Volume is shown: @@ -207,7 +237,7 @@ \subsection{Show Label Information} \end{commandOut} -\subsection{Listing Jobs} +\subsubsection{Listing Jobs} \index[general]{Listing Jobs with bls} \index[general]{bls!Listing Jobs} @@ -243,7 +273,7 @@ \subsection{Listing Jobs} Adding the {\bf -v} option will display virtually all information that is available for each record. -\subsection{Listing Blocks} +\subsubsection{Listing Blocks} \index[general]{Listing Blocks with bls} \index[general]{bls!Listing Blocks} @@ -320,7 +350,7 @@ \subsection{Listing Blocks} \end{verbatim} \normalsize -\section{bextract} +\subsection{bextract} \label{bextract} \index[general]{bextract} \index[general]{Command!bextract} @@ -377,7 +407,7 @@ \section{bextract} stripped. If no prefix is specified, the file will be restored to the original drive. -\subsection{Extracting with Include or Exclude Lists} +\subsubsection{Extracting with Include or Exclude Lists} Using the {\bf -e} option, you can specify a file containing a list of files to be excluded. Wildcards can be used in the exclusion list. This option will @@ -417,7 +447,7 @@ \subsection{Extracting with Include or Exclude Lists} directory {\bf /tmp} (i.e. /tmp/etc/bareos/... and /tmp/usr/sbin/...). -\subsection{Extracting With a Bootstrap File} +\subsubsection{Extracting With a Bootstrap File} The {\bf -b} option is used to specify a {\bf bootstrap} file containing the information needed to restore precisely the files you want. Specifying a {\bf @@ -440,7 +470,7 @@ \subsection{Extracting With a Bootstrap File} applied, and then each file record seen will be compared to the include and exclude lists. -\subsection{Extracting From Multiple Volumes} +\subsubsection{Extracting From Multiple Volumes} If you wish to extract files that span several Volumes, you can specify the Volume names in the bootstrap file or you may specify the Volume names on the @@ -450,7 +480,7 @@ \subsection{Extracting From Multiple Volumes} program or read the \ilink{Bootstrap}{BootstrapChapter} chapter of this document. -\section{bscan} +\subsection{bscan} \label{bscan} \index[general]{bscan} \index[general]{Command!bscan} @@ -626,7 +656,7 @@ \section{bscan} backup. -\subsection{Using bscan to Compare a Volume to an existing Catalog} +\subsubsection{Using bscan to Compare a Volume to an existing Catalog} \index[general]{Catalog!Using bscan to Compare a Volume to an existing} If you wish to compare the contents of a Volume to an existing catalog without @@ -636,7 +666,7 @@ \subsection{Using bscan to Compare a Volume to an existing Catalog} as they should be, so we don't particularly recommend this mode other than for testing. -\subsection{Using bscan to Recreate a Catalog from a Volume} +\subsubsection{Using bscan to Recreate a Catalog from a Volume} \index[general]{Catalog!Recreate Using bscan} \index[general]{bscan!Recreate Catalog} @@ -769,7 +799,7 @@ \subsection{Using bscan to Recreate a Catalog from a Volume} catalog. This procedure is documented elsewhere in the manual and involves using the {\bf update volume} command in {\bf bconsole}. -\subsection{Using bscan to Correct the Volume File Count} +\subsubsection{Using bscan to Correct the Volume File Count} \index[general]{bscan!Correct Volume File Count} \index[general]{Volume!File Count} @@ -783,8 +813,8 @@ \subsection{Using bscan to Correct the Volume File Count} bscan} with the {\bf -m} option (but {\bf without} the {\bf -s} option) to update only the final Media record for the Volumes read. -\subsection{After bscan} -\index[general]{bscan!After} +\subsubsection{After bscan} +\index[general]{bscan!after} If you use {\bf bscan} to enter the contents of the Volume into an existing catalog, you should be aware that the records you entered may be immediately @@ -796,7 +826,7 @@ \subsection{After bscan} you can reset the VolStatus to {\bf Used} and the Volume will be purged from the catalog. -\section{bcopy} +\subsection{bcopy} \label{bcopy} \index[general]{bcopy} \index[general]{Command!bcopy} @@ -837,7 +867,7 @@ \section{bcopy} addition, I only have a single tape drive, so I have never been able to test this program with two tape drives. -\section{btape} +\subsection{btape} \label{btape} \index[general]{btape} \index[general]{Command!btape} @@ -877,7 +907,7 @@ \section{btape} \end{verbatim} \normalsize -\subsection{Using btape to Verify your Tape Drive} +\subsubsection{Using btape to Verify your Tape Drive} \index[general]{Drive!Verify using btape} An important reason for this program is to ensure that a Storage daemon @@ -892,7 +922,7 @@ \subsection{Using btape to Verify your Tape Drive} \ilink{Tape Testing}{TapeTestingChapter} Chapter of this manual for the details. -\subsection{btape Commands} +\subsubsection{btape Commands} The full list of commands are: @@ -953,7 +983,7 @@ \subsection{btape Commands} note for labeling tapes, we recommend that you use the {\bf label} command in the {\bf Console} program since it will never overwrite a valid Bareos tape. -\subsubsection*{Testing your Tape Drive} +\paragraph{Testing your Tape Drive} \label{sec:btapespeed} To determine the best configuration of your tape drive, you can run the new