Skip to content
This repository has been archived by the owner on Mar 19, 2021. It is now read-only.

Commit

Permalink
Updated general index
Browse files Browse the repository at this point in the history
Signed-off-by: Joerg Steffens <joerg.steffens@bareos.com>
  • Loading branch information
Kristian authored and joergsteffens committed May 2, 2016
1 parent 1fb4575 commit 654d98c
Show file tree
Hide file tree
Showing 25 changed files with 48 additions and 58 deletions.
2 changes: 1 addition & 1 deletion manuals/en/main/ansi-labels.tex
@@ -1,7 +1,7 @@

\section{Tape Labels: ANSI or IBM}
\label{AnsiLabelsChapter}
\index[general]{Labels!Tape}
\index[general]{Label!Tape Labels}
\index[general]{Tape!Label!ANSI}
\index[general]{Tape!Label!IBM}

Expand Down
10 changes: 4 additions & 6 deletions manuals/en/main/autochangers.tex
Expand Up @@ -4,7 +4,7 @@
\chapter{Autochanger Support}
\label{AutochangersChapter}
\index[general]{Support!Autochanger}
\index[general]{Autochanger Support}
\index[general]{Autochanger!Support}

Bareos provides autochanger support for reading and writing tapes. In
order to work with an autochanger, Bareos requires a number of things, each of
Expand Down Expand Up @@ -252,7 +252,6 @@ \section{Multiple Devices}

\label{ConfigRecords}
\section{Device Configuration Records}
\index[general]{Records!Device Configuration}
\index[general]{Device Configuration Records}

Configuration of autochangers within Bareos is done in the Device resource of
Expand Down Expand Up @@ -438,7 +437,7 @@ \section{A Multi-drive Example Configuration File}

\section{Specifying Slots When Labeling}
\index[general]{Specifying Slots When Labeling}
\index[general]{Labeling!Specifying Slots When}
\index[general]{Label!Specifying Slots When Labeling}
\label{SpecifyingSlots}

If you add an {\bf Autochanger = yes} record to the Storage resource in your
Expand Down Expand Up @@ -489,7 +488,7 @@ \section{Specifying Slots When Labeling}


\section{Changing Cartridges}
\index[general]{Changing Cartridges}
\index[general]{Cartridges!Changing}
If you wish to insert or remove cartridges in your autochanger or
you manually run the {\bf mtx} program, you must first tell Bareos
to release the autochanger by doing:
Expand Down Expand Up @@ -815,8 +814,7 @@ \section{Use bconsole to display Autochanger content}


\section{Bareos Autochanger Interface}
\index[general]{Interface!Autochanger}
\index[general]{Autochanger Interface}
\index[general]{Autochanger!Interface}
\label{autochanger-interface}

Bareos calls the autochanger script that you specify on the {\bf Changer
Expand Down
5 changes: 2 additions & 3 deletions manuals/en/main/bareos-manual-main-reference.tex
Expand Up @@ -133,7 +133,7 @@ \part{Introduction and Tutorial}
\chapter{Installing Bareos}
\label{InstallChapter}
\index[general]{Bareos!Installing}
\index[general]{Installing Bareos}
\index[general]{Installation!Linux}

\input{install} % install

Expand All @@ -153,7 +153,6 @@ \chapter{Updating Bareos}

\chapter{Getting Started with Bareos}
\label{QuickStartChapter}
\index[general]{Getting Started with Bareos}

\input{quickstart} % install

Expand Down Expand Up @@ -277,7 +276,7 @@ \chapter{Release Notes}

\chapter{Bareos Copyright, Trademark, and Licenses}
\label{LicenseChapter}
\index[general]{Licenses!Bareos Copyright Trademark}
\index[general]{License!Bareos Copyright Trademark Licenses}
\index[general]{Bareos Copyright, Trademark, and Licenses}

\input{license}
Expand Down
2 changes: 1 addition & 1 deletion manuals/en/main/bareos-sd-resource-device-definitions.tex
Expand Up @@ -477,7 +477,7 @@
}

\defDirective{Sd}{Device}{Label Media}{}{}{%
\index[general]{Label Media}%
\index[general]{Label!Label Media}%
If {\bf Yes}, permits this device to automatically label blank media
without an explicit operator command. It does so by using an internal
algorithm as defined on the \linkResourceDirective{Dir}{Pool}{Label Format} record in each
Expand Down
1 change: 0 additions & 1 deletion manuals/en/main/bootstrap.tex
Expand Up @@ -24,7 +24,6 @@ \chapter{The Bootstrap File}
any text editor.

\section{Bootstrap File Format}
\index[general]{Format!Bootstrap}
\index[general]{Bootstrap!File Format}

The general format of a {\bf bootstrap} file is:
Expand Down
10 changes: 7 additions & 3 deletions manuals/en/main/catmaintenance.tex
Expand Up @@ -605,6 +605,7 @@ \subsection*{Setting Retention Periods}

\item [File Retention = {\textless}time-period-specification{\textgreater}]
\index[general]{File Retention}
\index[general]{Retention!File}
The File Retention record defines the length of time that Bareos will keep
File records in the Catalog database. When this time period expires, and if
{\bf AutoPrune} is set to {\bf yes}, Bareos will prune (remove) File records
Expand All @@ -631,7 +632,8 @@ \subsection*{Setting Retention Periods}
The default File retention period is 60 days.

\item [Job Retention = {\textless}time-period-specification{\textgreater}]
\index[general]{Job Retention}
\index[general]{Job!Retention}
\index[general]{Retention!Job}
The Job Retention record defines the length of time that {\bf Bareos}
will keep Job records in the Catalog database. When this time period
expires, and if {\bf AutoPrune} is set to {\bf yes} Bareos will prune
Expand All @@ -658,6 +660,7 @@ \subsection*{Setting Retention Periods}

\item [AutoPrune = {\textless}yes/no{\textgreater}]
\index[general]{AutoPrune}
\index[general]{Job!Retention!AutoPrune}
If AutoPrune is set to {\bf yes} (default), Bareos will automatically apply
the File retention period and the Job retention period for the Client at the
end of the Job.
Expand Down Expand Up @@ -1294,8 +1297,9 @@ \section{Compacting Your SQLite Database}
}

\section{Backing Up Your Bareos Database}
\index[general]{Backing Up Your Bareos Database}
\index[general]{Database!Backing Up Your Bareos}
\index[general]{Backup!Bareos database}
\index[general]{Backup!Catalog}
\index[general]{Database!Backup Bareos database}
\label{BackingUpBareos}

If ever the machine on which your Bareos database crashes, and you need to
Expand Down
3 changes: 1 addition & 2 deletions manuals/en/main/compile.tex
Expand Up @@ -73,7 +73,6 @@ \section{Source Release Files}

\label{upgrading1}
\section{Upgrading Bareos}
\index[general]{Bareos!Upgrading}
\index[general]{Upgrading Bareos}
\index[general]{Upgrading}

Expand Down Expand Up @@ -1473,8 +1472,8 @@ \section{One File Configure Script}
\normalsize

\section{Installing Bareos}
\index[general]{Bareos!Installing}
\index[general]{Installing Bareos}
\index[general]{Installation!Linux}

Before setting up your configuration files, you will want to install Bareos in
its final location. Simply enter:
Expand Down
1 change: 0 additions & 1 deletion manuals/en/main/configure.tex
Expand Up @@ -72,7 +72,6 @@ \section{Character Sets}

\section{Resource Directive Format}
\index[general]{Resource Directive Format}
\index[general]{Format!Resource Directive}

Although, you won't need to know the details of all the directives a basic
knowledge of Bareos resource directives is essential. Each directive contained
Expand Down
2 changes: 0 additions & 2 deletions manuals/en/main/critical.tex
Expand Up @@ -20,7 +20,6 @@ \chapter{Critical Items to Implement Before Production}
\label{Critical}
\section{Critical Items}
\index[general]{Critical Items}
\index[general]{Items!Critical}

The following assumes that you have installed Bareos, you more or less
understand it, you have at least worked through the tutorial or have
Expand Down Expand Up @@ -82,7 +81,6 @@ \section{Critical Items}
\end{itemize}

\section{Recommended Items}
\index[general]{Items!Recommended}
\index[general]{Recommended Items}

Although these items may not be critical, they are recommended and will help
Expand Down
3 changes: 2 additions & 1 deletion manuals/en/main/dataencryption.tex
Expand Up @@ -107,7 +107,7 @@ \section{Encryption Technical Details}


\section{Generating Private/Public Encryption Keys}
\index[general]{Generating Private/Public Encryption Keypairs}
\index[general]{Encryption!Generating Private/Public Encryption Keypairs}

Generate a Master Key Pair with:

Expand Down Expand Up @@ -151,6 +151,7 @@ \section{Example Data Encryption Configurations (bareos-fd.conf)}

\section{Decrypting with a Master Key}
\index[general]{Decrypting with a Master Key}
\index[general]{Encryption!Decrypting with a Master Key}

It is preferable to retain a secure, non-encrypted copy of the
client's own encryption keypair. However, should you lose the
Expand Down
4 changes: 2 additions & 2 deletions manuals/en/main/dirdconf-fileset.tex
Expand Up @@ -257,8 +257,8 @@ \subsection{FileSet Include Ressource}
\normalsize
\item
\index[general]{Backing up!Partitions}
\index[general]{Backing up Raw Partitions}
\index[general]{Backup!Partitions}
\index[general]{Backup!Raw Partitions}
If you explicitly specify a block device such as {\bf /dev/hda1}, then
Bareos will assume that this is a raw partition
to be backed up. In this case, you are strongly urged to specify a {\bf
Expand Down
8 changes: 4 additions & 4 deletions manuals/en/main/dirdconf.tex
Expand Up @@ -113,7 +113,7 @@ \section{Job Resource}
\label{DirectorResourceJob}
\label{JobResource}
\index[general]{Resource!Job}
\index[general]{Job Resource}
\index[general]{Job!Resource}

The Job resource defines a Job (Backup, Restore, ...) that Bareos must
perform. Each Job resource definition contains the name of a Client and
Expand Down Expand Up @@ -167,7 +167,7 @@ \section{Job Resource}

\section{JobDefs Resource}
\label{DirectorResourceJobDefs}
\index[general]{JobDefs Resource}
\index[general]{Job!JobDefs Resource}
\index[general]{Resource!JobDefs}

The JobDefs resource permits all the same directives that can appear in a Job
Expand All @@ -184,7 +184,7 @@ \section{JobDefs Resource}
\section{Schedule Resource}
\label{DirectorResourceSchedule}
\index[general]{Resource!Schedule}
\index[general]{Schedule Resource}
\index[general]{Schedule!Resource}

The Schedule resource provides a means of automatically scheduling a Job as
well as the ability to override the default Level, Pool, Storage and Messages
Expand Down Expand Up @@ -296,7 +296,7 @@ \section{Schedule Resource}
\end{bconfig}

\subsection{Technical Notes on Schedules}
\index[general]{Schedules!Technical Notes}
\index[general]{Schedule!Technical Notes on Schedules}

Internally Bareos keeps a schedule as a bit mask. There are six masks and a
minute field to each schedule. The masks are hour, day of the month (mday),
Expand Down
11 changes: 5 additions & 6 deletions manuals/en/main/disk.tex
Expand Up @@ -3,8 +3,7 @@

%\chapter{Basic Volume Management}
\label{DiskChapter}
\index[general]{Volume Management}
\index[general]{Management!Volume}
\index[general]{Volume!Management}
\index[general]{Disk Volumes}

This chapter presents most all the features needed to do Volume management.
Expand All @@ -21,8 +20,8 @@

\label{Concepts}
\section{Key Concepts and Resource Records}
\index[general]{Volume!Management!Key Concepts and Resource Records}
\index[general]{Key Concepts and Resource Records}
\index[general]{Records!Key Concepts and Resource}

Getting Bareos to write to disk rather than tape in the simplest case is
rather easy. In the Storage daemon's configuration file, you simply define an
Expand Down Expand Up @@ -151,8 +150,8 @@ \subsection{Pool Options to Limit the Volume Usage}

\label{AutomaticLabeling}
\subsection{Automatic Volume Labeling}
\index[general]{Automatic Volume Labeling}
\index[general]{Labeling!Automatic Volume}
\index[general]{Automatic!Volume Labeling}
\index[general]{Label!Automatic Volume Labeling}

Use of the above records brings up another problem -- that of labeling your
Volumes. For automated disk backup, you can either manually label each of your
Expand Down Expand Up @@ -501,7 +500,7 @@ \subsection{An Example}
\section{Backing up to Multiple Disks}
\label{MultipleDisks}
\index[general]{Disks!Backing up to Multiple}
\index[general]{Backing up to Multiple Disks}
\index[general]{Backup!to Multiple Disks}

Bareos can, of course, use multiple disks, but in general, each disk must be a
separate Device specification in the Storage daemon's conf file, and you must
Expand Down
1 change: 1 addition & 0 deletions manuals/en/main/filedconf.tex
Expand Up @@ -5,6 +5,7 @@ \chapter{Client/File Daemon Configuration}
\label{FiledConfChapter}
\index[general]{Configuration!Client/File daemon}
\index[general]{Client/File daemon Configuration}
\index[general]{File Daemon|see{Client/File daemon Configuration}}

The Client (or File Daemon) Configuration is one of the simpler ones to
specify. Generally, other than changing the Client name so that error messages
Expand Down
9 changes: 3 additions & 6 deletions manuals/en/main/general.tex
Expand Up @@ -59,7 +59,6 @@ \section{Who Needs Bareos?}
available under the GNU AGPLv3 software license.

\section{Bareos Components or Services}
\index[general]{Bareos Components or Services}

Bareos is made up of the following five major components or services:
Director, Console, File, Storage, and Monitor services.
Expand Down Expand Up @@ -205,7 +204,6 @@ \section{Bareos Packages}

\section{Bareos Configuration}
\index[general]{Configuration!Bareos}
\index[general]{Bareos Configuration}

In order for Bareos to understand your system, what clients you want backed
up and how, you must create a number of configuration files containing
Expand All @@ -216,8 +214,7 @@ \section{Bareos Configuration}
%\includegraphics{\idir bareos-objects}

\section{Conventions Used in this Document}
\index[general]{Conventions Used in this Document}
\index[general]{Document!Conventions Used in this}
\index[general]{Document Conventions}

Bareos is in a state of evolution, and as a consequence, this manual
will not always agree with the code. If an item in this manual is preceded by
Expand Down Expand Up @@ -333,8 +330,8 @@ \section{Terminology}
Bareos so that the user never needs to be concerned about them. The
attributes do not include the file's data.

\item [File Daemon]
\index[general]{File Daemon}
\item [File daemon]
\index[general]{File daemon}
The daemon running on the client computer to be backed up. This is also
referred to as the File services, and sometimes as the Client services or the
FD.
Expand Down
2 changes: 1 addition & 1 deletion manuals/en/main/howto.tex
Expand Up @@ -25,7 +25,7 @@ \section{Use a dummy device to test the backup}


\section{Backup Of Third Party Databases}
\index[general]{Backup Of Third Party Databases}
\index[general]{Backup!of Third Party Databases}
\index[general]{Database!Backup Of Third Party}
\label{BackupOtherDBs}

Expand Down
2 changes: 1 addition & 1 deletion manuals/en/main/migration.tex
Expand Up @@ -80,7 +80,7 @@ \chapter{Migration and Copy}
rather than simultaneously.

\section{Important Migration Considerations}
\index[general]{Important Migration Considerations}
\index[general]{Migration!Important Migration Considerations}
\begin{itemize}
\item Each Pool into which you migrate Jobs or Volumes {\bf must}
contain Volumes of only one \linkResourceDirective{Dir}{Storage}{Media Type}.
Expand Down
4 changes: 2 additions & 2 deletions manuals/en/main/plugins.tex
Expand Up @@ -96,15 +96,15 @@ \subsection{LDAP Plugin}
\subsection{Cephfs Plugin}
\index[general]{Plugin!ceph!cephfs}
\index[general]{Ceph!Cephfs!Plugin}
\index[general]{Ceph!Cephfs Plugin}
Opposite to the \ilink{Rados Backend}{SdBackendRados} that is used to store data on a CEPH Object Store,
this plugin is intended to backup a CEPH Object Store via the Cephfs interface to other media.
The package \package{bareos-filedaemon-ceph-plugin} (\sinceVersion{Fd}{Cephfs Plugin}{15.2.0}) contains an example configuration file, that must be adapted to your envirnoment.
\subsection{Rados Plugin}
\index[general]{Plugin!ceph!rados}
\index[general]{Ceph!Rados!Plugin}
\index[general]{Ceph!Rados Plugin}
Opposite to the \ilink{Rados Backend}{SdBackendRados} that is used to store data on a CEPH Object Store,
this plugin is intended to backup a CEPH Object Store via the Rados interface to other media.
Expand Down
6 changes: 2 additions & 4 deletions manuals/en/main/quickstart.tex
@@ -1,6 +1,5 @@
\section{Understanding Jobs and Schedules}
\index[general]{Jobs!Understanding}
\index[general]{Schedules!Understanding}
\index[general]{Schedule!Understanding Schedules}
\label{JobsandSchedules}

In order to make Bareos as flexible as possible, the directions given
Expand Down Expand Up @@ -31,7 +30,7 @@ \section{Understanding Jobs and Schedules}
\section{Understanding Pools, Volumes and Labels}
\index[general]{Pools!Understanding}
\index[general]{Volumes!Understanding}
\index[general]{Labels!Understanding}
\index[general]{Label!Understanding Labels}
\label{PoolsVolsLabels}

If you have been using a program such as {\bf tar} to backup your system,
Expand Down Expand Up @@ -252,7 +251,6 @@ \section{Testing Compatibility with Your Tape Drive}


\section{Running Bareos}
\index[general]{Bareos!Running}
\index[general]{Running Bareos}
\label{Running1}

Expand Down

0 comments on commit 654d98c

Please sign in to comment.