diff --git a/docs/manuals/en/new_main_reference/replace.sh b/docs/manuals/en/new_main_reference/replace.sh index 13f9bb868b2..b47e5560da0 100755 --- a/docs/manuals/en/new_main_reference/replace.sh +++ b/docs/manuals/en/new_main_reference/replace.sh @@ -45,6 +45,29 @@ perl -i -pe 's#:raw-latex:`\\command\{(.*?)\}`#:program:`\1`#g' *.rst # rename sec: to sec- as : has special meaning in sphinx sed -i -E 's#sec:#section-#g' *.rst +#:raw-latex:`\index[general]{Windows!File Daemon!Command Line Options}` +# -> +#:index:`triple: ` +perl -i -pe 's#:raw-latex:`\\index\[(.*?)\]\{(.*?)!(.*?)!(.*?)\}`#:index:`triple: <\2;\3;\4>`#g' *.rst + + +#:raw-latex:`\index[general]{Problem!Windows}` +# -> +#:index:`pair: ` +perl -i -pe 's#:raw-latex:`\\index\[(.*?)\]\{(.*?)!(.*?)\}`#:index:`pair: <\2;\3>`#g' *.rst + +# index +#:raw-latex:`\index[general]{Version numbers}` +# -> +#:index:`Version numbers` +perl -i -pe 's#:raw-latex:`\\index\[(.*?)\]\{(.*)\}`#:index:`\2`#g' *.rst + + + + +#sed -i -E 's|^( *):raw-latex:`\\index\[(.*?)\]\{(.*)!(.*)\}`|\1.. index:: \n triple: \4 \n\1.. _`\2`:\n\1|g' *.rst + +#sed -i -E 's|^(.*):raw-latex:`\\index\[(.*?)]\{(.*)\}`|\1.. index:: single: \3 \n\1.. _`\3`:\n\1|g' *.rst @@ -136,21 +159,6 @@ sed -i -E 's#sec:#section-#g' *.rst #sed -i -E 's|:raw-latex:`\\trademark\{(.*)\}`|*\1*|g' *.rst # ## -## INDEX -## -# -##sed -i -E 's|:raw-latex:`\\index\[general\]\{(.*)!(.*)\}`|\n.. index:: \n triple: General; \1; \2|g' *.rst -#sed -i -E 's|^( *):raw-latex:`\\index\[general\]\{(.*)!(.*)\}`|\1.. index:: \n triple: General; \2; \3 \n\1.. _`\2`:\n\1|g' *.rst -# -# -##sed -i -E 's|:raw-latex:`\\index\[general\]\{(.*)!(.*)\}`|.. _`\1`:\n|g' *.rst -# -#sed -i -E 's|^(.*):raw-latex:`\\index\[general\]\{(.*)\}`|\1.. index:: General; \2 \n\1.. _`\2`:\n\1|g' *.rst -##sed -i -E 's|:raw-latex:`\\index\[general\]\{(.*)\}`|.. _`\1`:|g' *.rst -# -#sed -i -E 's|:raw-latex:`\\index\[sd\]\{(.*)\}`|.. index:: SD; \1 |g' *.rst -# -## ## LABEL AND REFERENCES ## # diff --git a/docs/manuals/en/new_main_reference/source/always-incremental.rst b/docs/manuals/en/new_main_reference/source/always-incremental.rst index 8e584621215..c112d82967d 100644 --- a/docs/manuals/en/new_main_reference/source/always-incremental.rst +++ b/docs/manuals/en/new_main_reference/source/always-incremental.rst @@ -3,7 +3,7 @@ Always Incremental Backup Scheme ================================ -:raw-latex:`\index[general]{Always Incremental}` +:index:`Always Incremental` Always Incremental Backups are available since Bareos :raw-latex:`\sinceVersion{dir}{Always Incremental}{16.2.4}`. @@ -11,7 +11,7 @@ Always Incremental Backups are available since Bareos Conventional Backup Scheme Drawbacks ------------------------------------ -:raw-latex:`\index[general]{Retention}` +:index:`Retention` To better understand the advantages of the Always Incremental Backup scheme, we first analyze the way that the conventional Incremental - diff --git a/docs/manuals/en/new_main_reference/source/autochangers.rst b/docs/manuals/en/new_main_reference/source/autochangers.rst index c16897da6f3..6936cc26d92 100644 --- a/docs/manuals/en/new_main_reference/source/autochangers.rst +++ b/docs/manuals/en/new_main_reference/source/autochangers.rst @@ -3,8 +3,8 @@ Autochanger Support =================== -:raw-latex:`\index[general]{Support!Autochanger}` -:raw-latex:`\index[general]{Autochanger!Support}` +:index:`pair: ` +:index:`pair: ` Bareos provides autochanger support for reading and writing tapes. In order to work with an autochanger, Bareos requires a number of things, @@ -88,9 +88,9 @@ Volume. Knowing What SCSI Devices You Have ---------------------------------- -:raw-latex:`\index[general]{SCSI devices}` -:raw-latex:`\index[general]{Devices!SCSI}` -:raw-latex:`\index[general]{Devices!Detecting}` +:index:`SCSI devices` +:index:`pair: ` +:index:`pair: ` Linux ~~~~~ @@ -206,7 +206,7 @@ On Solaris, the changer device will typically be some file under Slots ----- -:raw-latex:`\index[general]{Slots}` +:index:`Slots` .. _`Slots`: Slots @@ -242,8 +242,8 @@ You can check if the Slot number and InChanger flag by: Multiple Devices ---------------- -:raw-latex:`\index[general]{Devices!Multiple}` -:raw-latex:`\index[general]{Multiple Devices}` +:index:`pair: ` +:index:`Multiple Devices` Some autochangers have more than one read/write device (drive). The :ref:`Autochanger resource ` permits you to @@ -273,7 +273,7 @@ This will cause the Storage daemon to maximize the use of drives. Device Configuration Records ---------------------------- -:raw-latex:`\index[general]{Device Configuration Records}` +:index:`Device Configuration Records` Configuration of autochangers within Bareos is done in the Device resource of the Storage daemon. @@ -293,8 +293,8 @@ Following records control how Bareos uses the autochanger: Specifying Slots When Labeling ------------------------------ -:raw-latex:`\index[general]{Specifying Slots When Labeling}` -:raw-latex:`\index[general]{Label!Specifying Slots When Labeling}` +:index:`Specifying Slots When Labeling` +:index:`pair: ` .. _`SpecifyingSlots`: SpecifyingSlots @@ -352,7 +352,7 @@ tape and will not be mounted. Changing Cartridges ------------------- -:raw-latex:`\index[general]{Cartridges!Changing}` If you wish to insert +:index:`pair: ` If you wish to insert or remove cartridges in your autochanger or you manually run the **mtx** program, you must first tell Bareos to release the autochanger by doing: @@ -378,7 +378,7 @@ while it has the drive mounted. Dealing with Multiple Magazines ------------------------------- -:raw-latex:`\index[general]{Magazines!Dealing with Multiple}` +:index:`pair: ` If you have several magazines or if you insert or remove cartridges from a magazine, you should notify Bareos of this. By doing so, Bareos will @@ -497,7 +497,7 @@ several alternatives. Update Slots Command -------------------- -:raw-latex:`\index[general]{Console!Command!update slots}` +:index:`triple: ` .. _`updateslots`: updateslots @@ -563,7 +563,7 @@ the above command will not find any Volume names so will do nothing. Using the Autochanger --------------------- -:raw-latex:`\index[general]{Autochanger!Using the}` +:index:`pair: ` .. _`using`: using @@ -709,8 +709,8 @@ like the following: Barcode Support --------------- -:raw-latex:`\index[general]{Support!Barcode}` -:raw-latex:`\index[general]{Barcode Support}` +:index:`pair: ` +:index:`Barcode Support` .. _`Barcodes`: Barcodes @@ -766,7 +766,7 @@ command to synchronize autochanger content with your catalog. Bareos Autochanger Interface ---------------------------- -:raw-latex:`\index[general]{Autochanger!Interface}` +:index:`pair: ` .. _`autochanger-interface`: autochanger-interface @@ -812,10 +812,10 @@ an error message and request the tape be manually mounted on the drive. Tapespeed and blocksizes ------------------------ -:raw-latex:`\index[general]{Tuning!Tape}` -:raw-latex:`\index[general]{Tuning!blocksize}` -:raw-latex:`\index[general]{Tape!speed}` -:raw-latex:`\index[general]{Blocksize!optimize}` +:index:`pair: ` +:index:`pair: ` +:index:`pair: ` +:index:`pair: ` .. _`Tapespeed and blocksizes`: Tapespeed and blocksizes @@ -994,10 +994,10 @@ Here, the block was written with 1M block size but we only read 64k. Direct access to Volumes with with non-default block sizes ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -:raw-latex:`\index[general]{bls!block size}` -:raw-latex:`\index[general]{bextract!block size}` -:raw-latex:`\index[general]{Command!bls!block size}` -:raw-latex:`\index[general]{Command!bextract!block size}` +:index:`pair: ` +:index:`pair: ` +:index:`triple: ` +:index:`triple: ` :program:`bls` and :program:`bextract` can directly access Bareos volumes without catalog database. This means that diff --git a/docs/manuals/en/new_main_reference/source/basejob.rst b/docs/manuals/en/new_main_reference/source/basejob.rst index bd050337197..6d3617c1b11 100644 --- a/docs/manuals/en/new_main_reference/source/basejob.rst +++ b/docs/manuals/en/new_main_reference/source/basejob.rst @@ -1,8 +1,8 @@ File Deduplication using Base Jobs ================================== -:raw-latex:`\index[general]{Base Jobs}` -:raw-latex:`\index[general]{File Deduplication}` +:index:`Base Jobs` +:index:`File Deduplication` .. _`basejobs`: basejobs A base job is sort of like a Full save diff --git a/docs/manuals/en/new_main_reference/source/bconsole.rst b/docs/manuals/en/new_main_reference/source/bconsole.rst index 7bec9d0ebde..9353ced7f9b 100644 --- a/docs/manuals/en/new_main_reference/source/bconsole.rst +++ b/docs/manuals/en/new_main_reference/source/bconsole.rst @@ -3,9 +3,9 @@ Bareos Console ============== -:raw-latex:`\index[general]{Bareos Console}` -:raw-latex:`\index[general]{bconsole}` -:raw-latex:`\index[general]{Command!bconsole}` +:index:`Bareos Console` +:index:`bconsole` +:index:`pair: ` The **Bareos Console** (:program:`bconsole`) is a program that allows the user or the System Administrator, to interact with the @@ -29,8 +29,8 @@ program, indicates that the new tape is mounted. Console Configuration --------------------- -:raw-latex:`\index[general]{Configuration!Console}` -:raw-latex:`\index[general]{Configuration!bconsole}` +:index:`pair: ` +:index:`pair: ` When the Console starts, it reads a standard Bareos configuration file named **bconsole.conf** unless you specify the **-c** command line @@ -47,7 +47,7 @@ Running the Console Program The console program can be run with the following options: -:raw-latex:`\index[console]{Command Line Options}` +:index:`Command Line Options` :: @@ -128,7 +128,7 @@ line length. Exit the Console Program ~~~~~~~~~~~~~~~~~~~~~~~~ -:raw-latex:`\index[general]{Command!bconsole!exit}` +:index:`triple: ` Normally, you simply enter **quit** or **exit** and the Console program will terminate. However, it waits until the Director acknowledges the @@ -149,7 +149,7 @@ cancel at the next prompt. Running the Console from a Shell Script ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -:raw-latex:`\index[general]{Console!Running from a Shell}` +:index:`pair: ` .. _`scripting`: scripting @@ -250,7 +250,7 @@ and restore ran correctly, the output files are checked with: Console Keywords ---------------- -:raw-latex:`\index[general]{Console!Keywords}` +:index:`pair: ` Unless otherwise specified, each of the following keywords takes an argument, which is specified after the keyword following an equal sign. @@ -434,7 +434,7 @@ Console Commands The following commands are currently implemented: add - :raw-latex:`\index[general]{Console!Command!add|textbf}` This + :index:`triple: ` This command is used to add Volumes to an existing Pool. That is, it creates the Volume name in the catalog and inserts into the Pool in the catalog, but does not attempt to access the physical Volume. @@ -466,7 +466,7 @@ add characters in a Volume name. autodisplay - :raw-latex:`\index[general]{Console!Command!autodisplay on/off}` + :index:`triple: ` This command accepts **on** or **off** as an argument, and turns auto-display of messages on or off respectively. The default for the console program is **off**, which means that you will be notified @@ -479,7 +479,7 @@ autodisplay received. automount - :raw-latex:`\index[general]{Console!Command!automount on/off}` This + :index:`triple: ` This command accepts **on** or **off** as the argument, and turns auto-mounting of the Volume after a **label** command on or off respectively. The default is **on**. If **automount** is turned off, @@ -487,7 +487,7 @@ automount use it. cancel - :raw-latex:`\index[general]{Console!Command!cancel jobid}` This + :index:`triple: ` This command is used to cancel a job and accepts **jobid=nnn** or **job=xxx** as an argument where nnn is replaced by the JobId and xxx is replaced by the job name. If you do not specify a keyword, @@ -549,7 +549,7 @@ cancel running without the need to restart the whole storage daemon. create - :raw-latex:`\index[general]{Console!Command!create pool}` This + :index:`triple: ` This command is not normally used as the Pool records are automatically created by the Director when it starts based on what it finds in the configuration. If needed, this command can be used, to create a Pool @@ -591,7 +591,7 @@ configure .. _`section-bcommandConfigureAdd`: section-bcommandConfigureAdd - :raw-latex:`\index[general]{Console!Command!configure add}` + :index:`triple: ` This command allows to add resources during runtime. Usage: @@ -682,7 +682,7 @@ configure .. _`section-bcommandConfigureExport`: section-bcommandConfigureExport - :raw-latex:`\index[general]{Console!Command!configure export}` + :index:`triple: ` This command allows to export the :raw-latex:`\resourcetype{Fd}{Director}` resource for clients @@ -709,7 +709,7 @@ configure :raw-latex:`\sinceVersion{console}{configure export}{16.2.4}`. delete - :raw-latex:`\index[general]{Console!Command!delete}` The delete + :index:`triple: ` The delete command is used to delete a Volume, Pool or Job record from the Catalog as well as all associated catalog Volume records that were created. This command operates only on the Catalog database and has @@ -743,7 +743,7 @@ delete of jobids. disable - :raw-latex:`\index[general]{Console!Command!disable}` This command + :index:`triple: ` This command permits you to disable a Job for automatic scheduling. The job may have been previously enabled with the Job resource **Enabled** directive or using the console **enable** command. The next time the @@ -759,7 +759,7 @@ disable disable job= enable - :raw-latex:`\index[general]{Console!Command!enable}` This command + :index:`triple: ` This command permits you to enable a Job for automatic scheduling. The job may have been previously disabled with the Job resource **Enabled** directive or using the console **disable** command. The next time @@ -779,7 +779,7 @@ enable .. _`estimate`: estimate estimate - :raw-latex:`\index[general]{Console!Command!estimate}` Using this + :index:`triple: ` Using this command, you can get an idea how many files will be backed up, or if you are unsure about your Include statements in your FileSet, you can test them without doing an actual backup. The default is to @@ -836,11 +836,11 @@ estimate option be enabled. exit - :raw-latex:`\index[general]{Console!Command!exit}` This command + :index:`triple: ` This command terminates the console program. export - :raw-latex:`\index[general]{Console!Command!export}` The export + :index:`triple: ` The export command is used to export tapes from an autochanger. Most Automatic Tapechangers offer special slots for importing new tape cartridges or exporting written tape cartridges. This can happen without having @@ -907,16 +907,16 @@ export /usr/sbin/bsmtp -h localhost -f root@localhost -s 'Remove Tape %V' root@localhost \"" gui - :raw-latex:`\index[general]{Console!Command!gui}` Invoke the + :index:`triple: ` Invoke the non-interactive gui mode. This command is only used when :program:`bconsole` is commanded by an external program. help - :raw-latex:`\index[general]{Console!Command!help}` This command + :index:`triple: ` This command displays the list of commands available. import - :raw-latex:`\index[general]{Console!Command!import}` The import + :index:`triple: ` The import command is used to import tapes into an autochanger. Most Automatic Tapechangers offer special slots for importing new tape cartridges or exporting written tape cartridges. This can happen without having @@ -979,8 +979,8 @@ import 3308 Successfully transfered volume from slot 37 to 20. label - :raw-latex:`\index[general]{Console!Command!label}` - :raw-latex:`\index[general]{Console!Command!relabel}` This command + :index:`triple: ` + :index:`triple: ` This command is used to label physical volumes. The full form of this command is: :: @@ -1091,7 +1091,7 @@ label label storage=xxx pool=yyy slots=1-5,10 barcodes list - :raw-latex:`\index[general]{Console!Command!list}` The list command + :index:`triple: ` The list command lists the requested contents of the Catalog. The various fields of each record are listed on a single line. The various forms of the list command are: @@ -1182,7 +1182,7 @@ list conf file, you use the Console command **show clients**. llist - :raw-latex:`\index[general]{Console!Command!llist}` The llist or + :index:`triple: ` The llist or "long list" command takes all the same arguments that the list command described above does. The difference is that the llist command list the full contents of each database record selected. It @@ -1230,15 +1230,15 @@ llist LabelFormat: File messages - :raw-latex:`\index[general]{Console!Command!messages}` This command + :index:`triple: ` This command causes any pending console messages to be immediately displayed. memory - :raw-latex:`\index[general]{Console!Command!memory}` Print current + :index:`triple: ` Print current memory usage. mount - :raw-latex:`\index[general]{Console!Command!mount}` The mount + :index:`triple: ` The mount command is used to get Bareos to read a volume on a physical device. It is a way to tell Bareos that you have mounted a tape and that Bareos should examine the tape. This command is normally used only @@ -1263,7 +1263,7 @@ mount :raw-latex:`\bcommand{unmount}{}`ed it in the Console program. move - :raw-latex:`\index[general]{Console!Command!move}` The move command + :index:`triple: ` The move command allows to move volumes between slots in an autochanger without having to leave the bconsole. @@ -1283,7 +1283,7 @@ move 3308 Successfully transfered volume from slot 32 to 33. prune - :raw-latex:`\index[general]{Console!Command!prune}` + :index:`triple: ` .. _`ManualPruning`: ManualPruning The Prune command allows you to @@ -1309,7 +1309,7 @@ prune take place. purge - :raw-latex:`\index[general]{Console!Command!purge}` + :index:`triple: ` .. _`bcommandPurge`: bcommandPurge The Purge command will delete @@ -1353,7 +1353,7 @@ purge the |bareosSd|. resolve - :raw-latex:`\index[general]{Console!Command!resolve}` In the + :index:`triple: ` In the configuration files, Addresses can (and normally should) be specified as DNS names. As the different components of Bareos will establish network connections to other Bareos components, it is @@ -1375,7 +1375,7 @@ resolve bareos-sd resolves www.bareos.com to host[ipv4:84.44.166.242] query - :raw-latex:`\index[general]{Console!Command!query}` + :index:`triple: ` .. _`section-bcommandQuery`: section-bcommandQuery This command reads a @@ -1386,7 +1386,7 @@ query command is submitted to the Catalog database SQL engine. quit - :raw-latex:`\index[general]{quit}` This command terminates the + :index:`quit` This command terminates the console program. The console program sends the **quit** request to the Director and waits for acknowledgment. If the Director is busy doing a previous command for you that has not terminated, it may @@ -1394,7 +1394,7 @@ quit command (i.e. quit preceded by a period). relabel - :raw-latex:`\index[general]{Console!Command!relabel}` This command + :index:`triple: ` This command is used to label physical volumes. The full form of this command is: @@ -1416,7 +1416,7 @@ relabel written on the Volume is lost and cannot be recovered. release - :raw-latex:`\index[general]{Console!Command!release}` This command + :index:`triple: ` This command is used to cause the Storage daemon to release (and rewind) the current tape in the drive, and to re-read the Volume label the next time the tape is used. @@ -1439,7 +1439,7 @@ release completely release (close) the device. reload - :raw-latex:`\index[general]{Console!Command!reload}` The reload + :index:`triple: ` The reload command causes the Director to re-read its configuration file and apply the new values. The new values will take effect immediately for all new jobs. However, if you change schedules, be aware that @@ -1463,7 +1463,7 @@ reload restart the Director at the next convenient opportunity. rerun - :raw-latex:`\index[general]{Console!Command!rerun}` The rerun + :index:`triple: ` The rerun command allows you to re-run a Job with exactly the same setting as the original Job. In Bareos, the job configuration is often altered by job overrides. These overrides alter the configuration of the job @@ -1489,9 +1489,9 @@ rerun or number of hours respectively for rerunning. restore - :raw-latex:`\index[general]{Restore}` - :raw-latex:`\index[general]{Console!Command!restore}` - :raw-latex:`\index[general]{Console!File Selection}` + :index:`Restore` + :index:`triple: ` + :index:`pair: ` .. _`bcommandRestore`: bcommandRestore The restore command allows you @@ -1535,7 +1535,7 @@ restore :ref:`Restore chapter `. run - :raw-latex:`\index[general]{Console!Command!run}` This command + :index:`triple: ` This command allows you to schedule jobs to be run immediately. The full form of the command is: @@ -1569,7 +1569,7 @@ run schedule flag is used. setbandwidth - :raw-latex:`\index[general]{Console!Command!setbandwidth}` This + :index:`triple: ` This command (:raw-latex:`\sinceVersion{console}{setbandwidth}{12.4.1}`) is used to limit the bandwidth of a running job or a client. @@ -1582,10 +1582,10 @@ setdebug .. _`bcommandSetdebug`: bcommandSetdebug - :raw-latex:`\index[general]{Console!Command!setdebug}` - :raw-latex:`\index[general]{Debug!setdebug}` - :raw-latex:`\index[general]{Debug!Windows}` - :raw-latex:`\index[general]{Windows!Debug}` This command is used to + :index:`triple: ` + :index:`pair: ` + :index:`pair: ` + :index:`pair: ` This command is used to set the debug level in each daemon. The form of this command is: :: @@ -1626,7 +1626,7 @@ setip .. _`bcommandSetIP`: bcommandSetIP - :raw-latex:`\index[general]{Console!Command!setip}` Sets new client + :index:`triple: ` Sets new client address – if authorized. A console is authorized to use the **SetIP** command only if it has @@ -1640,7 +1640,7 @@ setip their current IP address. show - :raw-latex:`\index[general]{Console!Command!show}` The show command + :index:`triple: ` The show command will list the Director’s resource records as defined in the Director’s configuration. This command is used mainly for debugging purposes by developers. The following keywords are accepted on the @@ -1650,7 +1650,7 @@ show the contents of the catalog. sqlquery - :raw-latex:`\index[general]{Console!Command!sqlquery}` The sqlquery + :index:`triple: ` The sqlquery command puts the Console program into SQL query mode where each line you enter is concatenated to the previous line until a semicolon (;) is seen. The semicolon terminates the command, which is then passed @@ -1670,7 +1670,7 @@ sqlquery or SQLite documentation. status - :raw-latex:`\index[general]{Console!Command!status}` + :index:`triple: ` This command will display the status of all components. For the director, it will display the next jobs that are scheduled during @@ -1931,17 +1931,17 @@ status default value for the Subscriptions directive is zero. time - :raw-latex:`\index[general]{Console!Command!time}` The time command + :index:`triple: ` The time command shows the current date, time and weekday. trace - :raw-latex:`\index[general]{Console!Command!trace}` Turn on/off + :index:`triple: ` Turn on/off trace to file. truncate - :raw-latex:`\index[general]{Console!Command!truncate}` - :raw-latex:`\index[general]{Disk!Freeing disk space}` - :raw-latex:`\index[sd]{Disk!Freeing disk space}` + :index:`triple: ` + :index:`pair: ` + :index:`pair: ` .. _`bcommandTruncate`: bcommandTruncate @@ -1971,11 +1971,11 @@ truncate :raw-latex:`\sinceVersion{dir}{truncate command}{16.2.5}`. umount - :raw-latex:`\index[general]{Console!Command!umount}` Alias for + :index:`triple: ` Alias for :raw-latex:`\bcommand{unmount}{}`. unmount - :raw-latex:`\index[general]{Console!Command!unmount}` This command + :index:`triple: ` This command causes the indicated Bareos Storage daemon to unmount the specified device. The forms of the command are the same as the mount command: @@ -1998,7 +1998,7 @@ unmount :raw-latex:`\bcommand{release}{}` instead. update - :raw-latex:`\index[general]{Console!Command!update}` + :index:`triple: ` .. _`UpdateCommand`: UpdateCommand This command will update the @@ -2099,7 +2099,7 @@ update stats [days=] use - :raw-latex:`\index[general]{Console!Command!use}` This command + :index:`triple: ` This command allows you to specify which Catalog database to use. Normally, you will be using only one database so this will be done automatically. In the case that you are using more than one database, you can use @@ -2114,7 +2114,7 @@ var .. _`var`: var - :raw-latex:`\index[general]{Console!Command!var}` This command takes + :index:`triple: ` This command takes a string or quoted string and does variable expansion on it mostly the same way variable expansion is done on the :raw-latex:`\linkResourceDirective{Dir}{Pool}{Label Format}` string. @@ -2125,11 +2125,11 @@ var are used in place of Job specific variables. version - :raw-latex:`\index[general]{Console!Command!version}` The command + :index:`triple: ` The command prints the Director’s version. wait - :raw-latex:`\index[general]{Console!Command!wait}` The wait command + :index:`triple: ` The wait command causes the Director to pause until there are no jobs running. This command is useful in a batch situation such as regression testing where you wish to start a job and wait until that job completes @@ -2148,7 +2148,7 @@ wait Special dot (.) Commands ~~~~~~~~~~~~~~~~~~~~~~~~ -:raw-latex:`\index[general]{Console!Command!. commands}` +:index:`triple: ` There is a list of commands that are prefixed with a period (.). These commands are intended to be used either by batch programs or graphical @@ -2169,11 +2169,11 @@ these commands are implemented only in the TTY console program and not in the Bat Console. These commands are: @input - :raw-latex:`\index[general]{Console!Command!\at{}input {\textless}filename{\textgreater}}` + :index:`triple: ` Read and execute the commands contained in the file specified. @output - :raw-latex:`\index[general]{Console!Command!\at{}output {\textless}filename{\textgreater} {\textless}w{\textbar}a{\textgreater}}` + :index:`triple: ` Send all following output to the filename specified either overwriting the file (w) or appending to the file (a). To redirect the output to the terminal, simply enter **@output** without a @@ -2195,39 +2195,39 @@ in the Bat Console. These commands are: \normalsize @tee - :raw-latex:`\index[general]{Console!Command!\at{}tee {\textless}filename{\textgreater} {\textless}w{\textbar}a{\textgreater}}` + :index:`triple: ` Send all subsequent output to both the specified file and the terminal. It is turned off by specifying **@tee** or **@output** without a filename. @sleep - :raw-latex:`\index[general]{Console!Command!\at{}sleep {\textless}seconds{\textgreater}}` + :index:`triple: ` Sleep the specified number of seconds. @time - :raw-latex:`\index[general]{Console!Command!\at{}time}` Print the + :index:`triple: ` Print the current time and date. @version - :raw-latex:`\index[general]{Console!Command!\at{}version}` Print the + :index:`triple: ` Print the console’s version. @quit - :raw-latex:`\index[general]{Console!Command!\at{}quit}` quit + :index:`triple: ` quit @exit - :raw-latex:`\index[general]{Console!Command!\at{}exit}` quit + :index:`triple: ` quit @# anything - :raw-latex:`\index[general]{Console!Command!\at{}\# anything}` + :index:`triple: ` Comment @help - :raw-latex:`\index[general]{Console!Command!\at{}help}` Get the list + :index:`triple: ` Get the list of every special @ commands. @separator - :raw-latex:`\index[general]{Console!Command!\at{}separator}` When + :index:`triple: ` When using bconsole with readline, you can set the command separator to one of those characters to write commands who require multiple input on one line, or to put multiple commands on a single line. @@ -2243,7 +2243,7 @@ in the Bat Console. These commands are: Adding Volumes to a Pool ------------------------ -:raw-latex:`\index[general]{Console!Adding a Volume to a Pool}` +:index:`pair: ` .. raw:: latex diff --git a/docs/manuals/en/new_main_reference/source/bootstrap.rst b/docs/manuals/en/new_main_reference/source/bootstrap.rst index 80e2cd83591..cb60a00038b 100644 --- a/docs/manuals/en/new_main_reference/source/bootstrap.rst +++ b/docs/manuals/en/new_main_reference/source/bootstrap.rst @@ -3,8 +3,8 @@ The Bootstrap File ================== -:raw-latex:`\index[general]{File!Bootstrap}` -:raw-latex:`\index[general]{Bootstrap!File}` +:index:`pair: ` +:index:`pair: ` .. raw:: latex @@ -28,7 +28,7 @@ any text editor. Bootstrap File Format --------------------- -:raw-latex:`\index[general]{Bootstrap!File Format}` +:index:`pair: ` The general format of a **bootstrap** file is: @@ -73,7 +73,7 @@ The full set of permitted keywords presented in the order in which they are matched against the Volume records are: Volume - :raw-latex:`\index[general]{Bootstrap!Volume}` The value field + :index:`pair: ` The value field specifies what Volume the following commands apply to. Each Volume specification becomes the current Volume, to which all the following commands apply until a new current Volume (if any) is specified. If @@ -81,13 +81,13 @@ Volume lease one Volume specification is required. Count - :raw-latex:`\index[general]{Bootstrap!Count}` The value is the total + :index:`pair: ` The value is the total number of files that will be restored for this Volume. This allows the Storage daemon to know when to stop reading the Volume. This value is optional. VolFile - :raw-latex:`\index[general]{Bootstrap!VolFile}` The value is a file + :index:`pair: ` The value is a file number, a list of file numbers, or a range of file numbers to match on the current Volume. The file number represents the physical file on the Volume where the data is stored. For a tape volume, this @@ -95,26 +95,26 @@ VolFile the tape is past the last specified file, reading will stop. VolBlock - :raw-latex:`\index[general]{Bootstrap!VolBlock}` The value is a + :index:`pair: ` The value is a block number, a list of block numbers, or a range of block numbers to match on the current Volume. The block number represents the physical block within the file on the Volume where the data is stored. VolSessionTime - :raw-latex:`\index[general]{Bootstrap!VolSessionTime}` The value + :index:`pair: ` The value specifies a Volume Session Time to be matched from the current volume. VolSessionId - :raw-latex:`\index[general]{Bootstrap!VolSessionId}` The value + :index:`pair: ` The value specifies a VolSessionId, a list of volume session ids, or a range of volume session ids to be matched from the current Volume. Each VolSessionId and VolSessionTime pair corresponds to a unique Job that is backed up on the Volume. JobId - :raw-latex:`\index[general]{Bootstrap!JobId}` The value specifies a + :index:`pair: ` The value specifies a JobId, list of JobIds, or range of JobIds to be selected from the current Volume. Note, the JobId may not be unique if you have multiple Directors, or if you have reinitialized your database. The @@ -123,7 +123,7 @@ JobId files. Job - :raw-latex:`\index[general]{Bootstrap!Job}` The value specifies a + :index:`pair: ` The value specifies a Job name or list of Job names to be matched on the current Volume. The Job corresponds to a unique VolSessionId and VolSessionTime pair. However, the Job is perhaps a bit more readable by humans. @@ -133,7 +133,7 @@ Job restore files. Client - :raw-latex:`\index[general]{Bootstrap!Client}` The value specifies a + :index:`pair: ` The value specifies a Client name or list of Clients to will be matched on the current Volume. Standard regular expressions (wildcards) may be used to match Client names. The Client filter works only if you do not run @@ -141,7 +141,7 @@ Client Bareos to restore files. FileIndex - :raw-latex:`\index[general]{Bootstrap!FileIndex}` The value + :index:`pair: ` The value specifies a FileIndex, list of FileIndexes, or range of FileIndexes to be selected from the current Volume. Each file (data) stored on a Volume within a Session has a unique FileIndex. For each Session, @@ -159,7 +159,7 @@ FileIndex is required. FileRegex - :raw-latex:`\index[general]{Bootstrap!FileRegex}` The value is a + :index:`pair: ` The value is a regular expression. When specified, only matching filenames will be restored. @@ -168,12 +168,12 @@ FileRegex FileRegex=^/etc/passwd(.old)? Slot - :raw-latex:`\index[general]{Bootstrap!Slot}` The value specifies the + :index:`pair: ` The value specifies the autochanger slot. There may be only a single **Slot** specification for each Volume. Stream - :raw-latex:`\index[general]{Bootstrap!Stream}` The value specifies a + :index:`pair: ` The value specifies a Stream, a list of Streams, or a range of Streams to be selected from the current Volume. Unless you really know what you are doing (the internals of Bareos), you should avoid this specification. This @@ -369,8 +369,8 @@ and the following bootstrap file would restore those files: Automatic Generation of Bootstrap Files --------------------------------------- -:raw-latex:`\index[general]{Files!Automatic Generation of Bootstrap}` -:raw-latex:`\index[general]{Bootstrap!Automatic Generation}` +:index:`pair: ` +:index:`pair: ` One thing that is probably worth knowing: the bootstrap files that are generated automatically at the end of the job are not as optimized as @@ -415,10 +415,10 @@ question. Bootstrap for bscan ------------------- -:raw-latex:`\index[general]{bscan}` -:raw-latex:`\index[general]{bscan!bootstrap}` -:raw-latex:`\index[general]{Bootstrap!bscan}` -:raw-latex:`\index[general]{Command!bscan}` +:index:`bscan` +:index:`pair: ` +:index:`pair: ` +:index:`pair: ` .. _`bscanBootstrap`: bscanBootstrap @@ -447,8 +447,8 @@ names. An example might be: Bootstrap Example ----------------- -:raw-latex:`\index[general]{Example!Bootstrap}` -:raw-latex:`\index[general]{Bootstrap!Example}` +:index:`pair: ` +:index:`pair: ` If you want to extract or copy a single Job, you can do it by selecting by JobId (code not tested) or better yet, if you know the VolSessionTime diff --git a/docs/manuals/en/new_main_reference/source/catmaintenance.rst b/docs/manuals/en/new_main_reference/source/catmaintenance.rst index b2e5515c077..3af5ffe4aa7 100644 --- a/docs/manuals/en/new_main_reference/source/catmaintenance.rst +++ b/docs/manuals/en/new_main_reference/source/catmaintenance.rst @@ -3,8 +3,8 @@ Catalog Maintenance =================== -:raw-latex:`\index[general]{Maintenance!Catalog}` -:raw-latex:`\index[general]{Catalog Maintenance}` +:index:`pair: ` +:index:`Catalog Maintenance` Catalog Database ---------------- @@ -31,8 +31,8 @@ PostgreSQL example can be found in dbconfig-common (Debian) ~~~~~~~~~~~~~~~~~~~~~~~~ -:raw-latex:`\index[general]{Platform!Debian!dbconfig-common}` -:raw-latex:`\index[general]{Platform!Ubuntu!dbconfig-common}` +:index:`triple: ` +:index:`triple: ` .. _`section-dbconfig`: section-dbconfig @@ -735,8 +735,8 @@ Retention Periods Database Size ~~~~~~~~~~~~~ -:raw-latex:`\index[general]{Size!Database}` -:raw-latex:`\index[general]{Database Size}` +:index:`pair: ` +:index:`Database Size` As mentioned above, if you do not do automatic pruning, your Catalog will grow each time you run a Job. Normally, you should decide how long @@ -800,8 +800,8 @@ database size will remain constant. Setting Retention Periods ~~~~~~~~~~~~~~~~~~~~~~~~~ -:raw-latex:`\index[general]{Setting Retention Periods}` -:raw-latex:`\index[general]{Periods!Setting Retention}` +:index:`Setting Retention Periods` +:index:`pair: ` .. _`Retention`: Retention @@ -891,8 +891,8 @@ chapter of this manual. Job Statistics ^^^^^^^^^^^^^^ -:raw-latex:`\index[general]{Statistics}` -:raw-latex:`\index[general]{Job!Statistics}` +:index:`Statistics` +:index:`pair: ` Bareos catalog contains lot of information about your IT infrastructure, how many files, their size, the number of video or music files etc. @@ -960,13 +960,13 @@ You can use the following Job resource in your nightly PostgreSQL ---------- -:raw-latex:`\index[general]{Database!PostgreSQL}` -:raw-latex:`\index[general]{PostgreSQL}` +:index:`pair: ` +:index:`PostgreSQL` Compacting Your PostgreSQL Database ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -:raw-latex:`\index[general]{Database!PostgreSQL!Compacting}` +:index:`triple: ` .. _`CompactingPostgres`: CompactingPostgres @@ -1198,8 +1198,8 @@ following must be done: Repairing Your PostgreSQL Database ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -:raw-latex:`\index[general]{Database!Repairing Your PostgreSQL}` -:raw-latex:`\index[general]{Repairing Your PostgreSQL Database}` +:index:`pair: ` +:index:`Repairing Your PostgreSQL Database` The same considerations apply as for :ref:`RepairingMySQL`. Consult the PostgreSQL documents @@ -1211,13 +1211,13 @@ For Bareos specific problems, consider using MySQL/MariaDB ------------- -:raw-latex:`\index[general]{Database!MySQL}` -:raw-latex:`\index[general]{MySQL}` +:index:`pair: ` +:index:`MySQL` MySQL/MariaDB Support ~~~~~~~~~~~~~~~~~~~~~ -:raw-latex:`\index[general]{MariaDB|see{MySQL}}` +:index:`MariaDB|see{MySQL}` .. _`section-MysqlSupport`: section-MysqlSupport @@ -1240,7 +1240,7 @@ that a distribution provides. Compacting Your MySQL Database ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -:raw-latex:`\index[general]{Database!MySQL!Compacting}` +:index:`triple: ` .. _`CompactingMySQL`: CompactingMySQL @@ -1293,8 +1293,8 @@ for details. Repairing Your MySQL Database ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -:raw-latex:`\index[general]{Database!Repairing Your MySQL}` -:raw-latex:`\index[general]{Repairing Your MySQL Database}` +:index:`pair: ` +:index:`Repairing Your MySQL Database` .. _`RepairingMySQL`: RepairingMySQL @@ -1327,8 +1327,8 @@ partition. MySQL Table is Full ~~~~~~~~~~~~~~~~~~~ -:raw-latex:`\index[general]{Database!MySQL Table is Full}` -:raw-latex:`\index[general]{MySQL Table is Full}` +:index:`pair: ` +:index:`MySQL Table is Full` If you are running into the error **The table ’File’ is full ...**, it is probably because on version 4.x MySQL, the table is limited by @@ -1371,8 +1371,8 @@ be the source of your problem, and you can modify it with: MySQL Server Has Gone Away ~~~~~~~~~~~~~~~~~~~~~~~~~~ -:raw-latex:`\index[general]{Database!MySQL Server Has Gone Away}` -:raw-latex:`\index[general]{MySQL Server Has Gone Away}` If you are +:index:`pair: ` +:index:`MySQL Server Has Gone Away` If you are having problems with the MySQL server disconnecting or with messages saying that your MySQL server has gone away, then please read the MySQL documentation, which can be found at: @@ -1618,9 +1618,9 @@ must be increased. A value of 300 should be sufficient. Backing Up Your Bareos Database ------------------------------- -:raw-latex:`\index[general]{Backup!Bareos database}` -:raw-latex:`\index[general]{Backup!Catalog}` -:raw-latex:`\index[general]{Database!Backup Bareos database}` +:index:`pair: ` +:index:`pair: ` +:index:`pair: ` .. _`BackingUpBareos`: BackingUpBareos diff --git a/docs/manuals/en/new_main_reference/source/configure.rst b/docs/manuals/en/new_main_reference/source/configure.rst index ccbeb121f8c..aea296e51ee 100644 --- a/docs/manuals/en/new_main_reference/source/configure.rst +++ b/docs/manuals/en/new_main_reference/source/configure.rst @@ -3,7 +3,7 @@ Customizing the Configuration ============================= -:raw-latex:`\index[general]{Customizing the Configuration}` +:index:`Customizing the Configuration` Each Bareos component (Director, Client, Storage, Console) has its own configuration containing a set of resource definitions. These resources @@ -48,8 +48,8 @@ The following configuration files must be present: Configuration Path Layout ------------------------- -:raw-latex:`\index[general]{Configuration!Directories}` -:raw-latex:`\index[general]{Configuration!Subdirectories}` +:index:`pair: ` +:index:`pair: ` When a Bareos component starts, it reads its configuration. In Bareos :math:`<` 16.2.2 only configuration files (which optionally can include @@ -401,7 +401,7 @@ Bareos programs can work with Character Sets ~~~~~~~~~~~~~~ -:raw-latex:`\index[general]{Character Sets}` Bareos is designed to +:index:`Character Sets` Bareos is designed to handle most character sets of the world, US ASCII, German, French, Chinese, ... However, it does this by encoding everything in UTF-8, and it expects all configuration files (including those read on Win32 @@ -410,7 +410,7 @@ machines, but not on all Unix machines, nor on Windows, so you must take some care to ensure that your locale is set properly before starting Bareos. -:raw-latex:`\index[general]{Windows!Configuration Files!UTF-8}` To +:index:`triple: ` To ensure that Bareos configuration files can be correctly read including foreign characters, the **LANG** environment variable must end in **.UTF-8**. A full example is **en_US.UTF-8**. The exact syntax may vary @@ -428,7 +428,7 @@ automatically converted to UTF-8 format. Comments ~~~~~~~~ -:raw-latex:`\index[general]{Configuration!Comments}` +:index:`pair: ` When reading a configuration, blank lines are ignored and everything after a hash sign (#) until the end of the line is taken to be a @@ -448,9 +448,9 @@ semicolons. Including other Configuration Files ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -:raw-latex:`\index[general]{Including other Configuration Files}` -:raw-latex:`\index[general]{Files!Including other Configuration}` -:raw-latex:`\index[general]{Configuration!Including Files}` +:index:`Including other Configuration Files` +:index:`pair: ` +:index:`pair: ` If you wish to break your configuration file into smaller pieces, you can do so by including other files using the syntax @@ -496,7 +496,7 @@ with care. Resource -------- -:raw-latex:`\index[general]{Configuration!Resource}` +:index:`pair: ` A resource is defined as the resource type (see :ref:`ResTypes`), followed by an open brace (``{``), a @@ -537,7 +537,7 @@ defines the Director resource with the name :raw-latex:`\parameter{bareos-dir}` and a query file :raw-latex:`\file{/usr/lib/bareos/scripts/query.sql}`. -:raw-latex:`\index[general]{Configuration!Naming Convention}` +:index:`pair: ` When naming resources, for some resource types naming conventions should be applied: @@ -626,8 +626,8 @@ expected manner (write 1 instead of 01). Data Types ^^^^^^^^^^ -:raw-latex:`\index[general]{Configuration!Data Types}` -:raw-latex:`\index[general]{Data Type}` +:index:`pair: ` +:index:`Data Type` .. _`DataTypes`: DataTypes @@ -635,7 +635,7 @@ When parsing the resource directives, Bareos classifies the data according to the types listed below. acl - :raw-latex:`\index[general]{Data Type!acl}` + :index:`pair: ` .. _`DataTypeAcl`: DataTypeAcl This directive defines what is @@ -713,7 +713,7 @@ acl Command ACL = *all*, !sqlquery auth-type - :raw-latex:`\index[general]{Data Type!auth-type}` + :index:`pair: ` .. _`DataTypeAuthType`: DataTypeAuthType Specifies the authentication @@ -733,7 +733,7 @@ auth-type - Use MD5 hashing integer - :raw-latex:`\index[general]{Data Type!integer}` + :index:`pair: ` .. _`DataTypeInteger`: DataTypeInteger A 32 bit integer value. It may @@ -743,7 +743,7 @@ integer :ref:`section-Quotes`. long integer - :raw-latex:`\index[general]{Data Type!long integer}` + :index:`pair: ` .. _`DataTypeLongInteger`: DataTypeLongInteger A 64 bit integer value. @@ -754,7 +754,7 @@ long integer :ref:`section-Quotes`. job protocol - :raw-latex:`\index[general]{Data Type!job protocol}` + :index:`pair: ` .. _`DataTypeJobProtocol`: DataTypeJobProtocol @@ -778,7 +778,7 @@ job protocol :ref:`section-NdmpNative`. name - :raw-latex:`\index[general]{Data Type!name}` + :index:`pair: ` .. _`DataTypeName`: DataTypeName A keyword or name consisting of @@ -792,14 +792,14 @@ name underscore, ...). All other characters and punctuation are invalid. password - :raw-latex:`\index[general]{Data Type!password}` + :index:`pair: ` .. _`DataTypePassword`: DataTypePassword This is a Bareos password and it is stored internally in MD5 hashed format. path - :raw-latex:`\index[general]{Data Type!path}` + :index:`pair: ` .. _`DataTypeDirectory`: DataTypeDirectory A path is either a quoted or @@ -809,7 +809,7 @@ path reference to a file or a directory. positive integer - :raw-latex:`\index[general]{Data Type!positive integer}` + :index:`pair: ` .. _`DataTypePositiveInteger`: DataTypePositiveInteger A 32 bit positive @@ -819,7 +819,7 @@ positive integer :ref:`section-Quotes`. speed - :raw-latex:`\index[general]{Data Type!speed}` + :index:`pair: ` .. _`DataTypeSpeed`: DataTypeSpeed The speed parameter can be @@ -829,7 +829,7 @@ speed :ref:`section-Quotes`. string - :raw-latex:`\index[general]{Data Type!string}` + :index:`pair: ` .. _`DataTypeString`: DataTypeString A quoted string containing @@ -841,7 +841,7 @@ string backslash. Likewise to include a backslash. string-list - :raw-latex:`\index[general]{Data Type!string list}` + :index:`pair: ` .. _`DataTypeStringList`: DataTypeStringList Multiple strings, specified @@ -849,7 +849,7 @@ string-list commas (**,**). strname - :raw-latex:`\index[general]{Data Type!strname}` + :index:`pair: ` .. _`DataTypeStrname`: DataTypeStrname is similar to a @@ -857,7 +857,7 @@ strname thus contain additional characters including spaces. net-address - :raw-latex:`\index[general]{Data Type!net-address}` + :index:`pair: ` .. _`DataTypeNetAddress`: DataTypeNetAddress is either a domain name or @@ -868,7 +868,7 @@ net-address possible to specify :raw-latex:`\dtNetAddresses` (plural). net-addresses - :raw-latex:`\index[general]{Data Type!net-addresses}` + :index:`pair: ` .. _`DataTypeNetAddresses`: DataTypeNetAddresses Specify a set of @@ -908,7 +908,7 @@ net-addresses permitted, and likewise with ip6. net-port - :raw-latex:`\index[general]{Data Type!net-port}` + :index:`pair: ` .. _`DataTypeNetPort`: DataTypeNetPort Specify a network port (a @@ -918,14 +918,14 @@ net-port :ref:`section-Quotes`. resource - :raw-latex:`\index[general]{Data Type!resource}` + :index:`pair: ` .. _`DataTypeRes`: DataTypeRes A resource defines a relation to the name of another resource. size - :raw-latex:`\index[general]{Data Type!size}` + :index:`pair: ` .. _`DataTypeSize}` :raw-latex:`\label{Size1`: DataTypeSize}` :raw-latex:`\label{Size1 A size @@ -957,7 +957,7 @@ size :ref:`section-Quotes`. time - :raw-latex:`\index[general]{Data Type!time}` + :index:`pair: ` .. _`DataTypeTime}` :raw-latex:`\label{Time`: DataTypeTime}` :raw-latex:`\label{Time A time @@ -970,28 +970,28 @@ time The following modifiers are permitted: seconds - :raw-latex:`\index[dir]{seconds}` + :index:`seconds` minutes - :raw-latex:`\index[dir]{minutes}` (60 seconds) + :index:`minutes` (60 seconds) hours - :raw-latex:`\index[dir]{hours}` (3600 seconds) + :index:`hours` (3600 seconds) days - :raw-latex:`\index[dir]{days}` (3600*24 seconds) + :index:`days` (3600*24 seconds) weeks - :raw-latex:`\index[dir]{weeks}` (3600*24*7 seconds) + :index:`weeks` (3600*24*7 seconds) months - :raw-latex:`\index[dir]{months}` (3600*24*30 seconds) + :index:`months` (3600*24*30 seconds) quarters - :raw-latex:`\index[dir]{quarters}` (3600*24*91 seconds) + :index:`quarters` (3600*24*91 seconds) years - :raw-latex:`\index[dir]{years}` (3600*24*365 seconds) + :index:`years` (3600*24*365 seconds) Any abbreviation of these modifiers is also permitted (i.e. **seconds** may be specified as **sec** or **s**). A specification @@ -1019,7 +1019,7 @@ time :ref:`section-Quotes`. audit-command-list - :raw-latex:`\index[general]{Data Type!audit command list}` + :index:`pair: ` .. _`DataTypeAuditCommandList`: DataTypeAuditCommandList Specifies the commands @@ -1034,8 +1034,8 @@ audit-command-list Based on the type :raw-latex:`\dtStringList`. :raw-latex:`\yesno` - :raw-latex:`\index[general]{Data Type!\yesno}` - :raw-latex:`\index[general]{Data Type!boolean}` + :index:`pair: ` + :index:`pair: ` .. _`DataTypeYesNo`: DataTypeYesNo Either a @@ -1204,8 +1204,8 @@ variables can be used: Resource Types ~~~~~~~~~~~~~~ -:raw-latex:`\index[general]{Types!Resource}` -:raw-latex:`\index[general]{Resource Types}` +:index:`pair: ` +:index:`Resource Types` .. _`ResTypes`: ResTypes @@ -1318,8 +1318,8 @@ permitted resource. Names, Passwords and Authorization ---------------------------------- -:raw-latex:`\index[general]{Authorization!Names and Passwords}` -:raw-latex:`\index[general]{Passwords}` +:index:`pair: ` +:index:`Passwords` In order for one daemon to contact another daemon, it must authorize itself with a password. In most cases, the password corresponds to a diff --git a/docs/manuals/en/new_main_reference/source/consoleconf.rst b/docs/manuals/en/new_main_reference/source/consoleconf.rst index b91b1c55324..2e3604de71b 100644 --- a/docs/manuals/en/new_main_reference/source/consoleconf.rst +++ b/docs/manuals/en/new_main_reference/source/consoleconf.rst @@ -3,8 +3,8 @@ Console Configuration ===================== -:raw-latex:`\index[general]{Configuration!Console}` -:raw-latex:`\index[general]{Console Configuration}` +:index:`pair: ` +:index:`Console Configuration` The Console configuration file is the simplest of all the configuration files, and in general, you should not need to change it except for the @@ -23,8 +23,8 @@ The following Console Resource definition must be defined: Director Resource ----------------- -:raw-latex:`\index[general]{Director Resource}` -:raw-latex:`\index[general]{Resource!Director}` +:index:`Director Resource` +:index:`pair: ` The Director resource defines the attributes of the Director running on the network. You may have multiple Director resource specifications in a @@ -102,8 +102,8 @@ An actual example might be: Console Resource ---------------- -:raw-latex:`\index[general]{Console Resource}` -:raw-latex:`\index[general]{Resource!Console}` +:index:`Console Resource` +:index:`pair: ` There are three different kinds of consoles, which the administrator or user can use to interact with the Director. These three kinds of @@ -165,7 +165,7 @@ consoles as noted above. Example Console Configuration File ---------------------------------- -:raw-latex:`\index[general]{Configuration!bconsole}` +:index:`pair: ` A Console configuration file might look like this: diff --git a/docs/manuals/en/new_main_reference/source/critical.rst b/docs/manuals/en/new_main_reference/source/critical.rst index febfc889883..83c6697b5fe 100644 --- a/docs/manuals/en/new_main_reference/source/critical.rst +++ b/docs/manuals/en/new_main_reference/source/critical.rst @@ -3,8 +3,8 @@ Critical Items to Implement Before Production ============================================= -:raw-latex:`\index[general]{Production!Critical Items to Implement Before}` -:raw-latex:`\index[general]{Critical Items to Implement Before Production}` +:index:`pair: ` +:index:`Critical Items to Implement Before Production` We recommend you take your time before implementing a production on a Bareos backup system since Bareos is a rather complex program, and if @@ -24,7 +24,7 @@ us, so that we can document it to the benefit of everyone. Critical Items -------------- -:raw-latex:`\index[general]{Critical Items}` +:index:`Critical Items` The following assumes that you have installed Bareos, you more or less understand it, you have at least worked through the tutorial or have @@ -88,7 +88,7 @@ are in production, use the checklist anyway). Recommended Items ----------------- -:raw-latex:`\index[general]{Recommended Items}` +:index:`Recommended Items` Although these items may not be critical, they are recommended and will help you avoid problems. diff --git a/docs/manuals/en/new_main_reference/source/dataencryption.rst b/docs/manuals/en/new_main_reference/source/dataencryption.rst index b1213b55eca..b62dc37a2c1 100644 --- a/docs/manuals/en/new_main_reference/source/dataencryption.rst +++ b/docs/manuals/en/new_main_reference/source/dataencryption.rst @@ -3,8 +3,8 @@ Data Encryption =============== -:raw-latex:`\index[general]{Data Encryption}` -:raw-latex:`\index[general]{Encryption!Data}` +:index:`Data Encryption` +:index:`pair: ` Bareos permits file data encryption and signing within the File Daemon (or Client) prior to sending data to the Storage Daemon. Upon @@ -62,7 +62,7 @@ The basic algorithm used for each backup session (Job) is: Encryption Technical Details ---------------------------- -:raw-latex:`\index[general]{Encryption!Technical Details}` +:index:`pair: ` The implementation uses 128bit AES-CBC, with RSA encrypted symmetric session keys. The RSA key is user supplied. If you are running OpenSSL @@ -100,7 +100,7 @@ streaming DER decoder/encoder was not available. Generating Private/Public Encryption Keys ----------------------------------------- -:raw-latex:`\index[general]{Encryption!Generating Private/Public Encryption Keypairs}` +:index:`pair: ` Generate a Master Key Pair with: @@ -148,7 +148,7 @@ encoding that contains only a single public key. Example Data Encryption Configurations (bareos-fd.conf) ------------------------------------------------------- -:raw-latex:`\index[general]{Example!Data Encryption Configuration File}` +:index:`pair: ` .. raw:: latex @@ -157,8 +157,8 @@ Example Data Encryption Configurations (bareos-fd.conf) Decrypting with a Master Key ---------------------------- -:raw-latex:`\index[general]{Decrypting with a Master Key}` -:raw-latex:`\index[general]{Encryption!Decrypting with a Master Key}` +:index:`Decrypting with a Master Key` +:index:`pair: ` It is preferable to retain a secure, non-encrypted copy of the client’s own encryption keypair. However, should you lose the client’s keypair, diff --git a/docs/manuals/en/new_main_reference/source/debug.rst b/docs/manuals/en/new_main_reference/source/debug.rst index e88b1b9945b..ec9c76f80e5 100644 --- a/docs/manuals/en/new_main_reference/source/debug.rst +++ b/docs/manuals/en/new_main_reference/source/debug.rst @@ -1,5 +1,5 @@ -:raw-latex:`\index[general]{Crash}` -:raw-latex:`\index[general]{Debug!crash}` +:index:`Crash` +:index:`pair: ` This chapter describes, how to debug Bareos, when the program crashes. If you are just interested about how to get more information about a @@ -24,7 +24,7 @@ more details, please read on. Traceback ========= -:raw-latex:`\index[general]{Traceback}` +:index:`Traceback` Each of the three Bareos daemons has a built-in exception handler which, in case of an error, will attempt to produce a traceback. If successful @@ -51,7 +51,7 @@ correctly on your system: :raw-latex:`\host{localhost}`. #. Some Linux distributions, e.g. - Ubuntu:raw-latex:`\index[general]{Platform!Ubuntu!Debug}`, disable + Ubuntu:index:`triple: `, disable the possibility to examine the memory of other processes. While this is a good idea for hardening a system, our debug mechanismen will fail. To disable this feature, run (as root): @@ -68,7 +68,7 @@ true, you can run the debugger by hand as described below. Testing The Traceback ===================== -:raw-latex:`\index[general]{Traceback!Test}` +:index:`pair: ` To "manually" test the traceback feature, you simply start **Bareos** then obtain the **PID** of the main daemon thread (there are multiple @@ -100,7 +100,7 @@ Getting A Traceback On Other Systems It should be possible to produce a similar traceback on systems other than Linux, either using :program:`gdb` or some other -debugger. Solaris:raw-latex:`\index[general]{Platform!Solaris!Debug}` +debugger. Solaris:index:`triple: ` with :program:`dbx` loaded works quite fine. On other systems, you will need to modify the :program:`btraceback` program to invoke the correct debugger, and possibly correct the diff --git a/docs/manuals/en/new_main_reference/source/dirdconf.rst b/docs/manuals/en/new_main_reference/source/dirdconf.rst index c1d6ce54756..a164724df5a 100644 --- a/docs/manuals/en/new_main_reference/source/dirdconf.rst +++ b/docs/manuals/en/new_main_reference/source/dirdconf.rst @@ -6,8 +6,8 @@ Director Configuration .. _`DirectorConfChapter`: DirectorConfChapter -:raw-latex:`\index[general]{Director!Configuration}` -:raw-latex:`\index[general]{Configuration!Director}` +:index:`pair: ` +:index:`pair: ` Of all the configuration files needed to run Bareos, the Director’s is the most complicated and the one that you will need to modify the most @@ -16,9 +16,9 @@ often as you add clients or modify the FileSets. For a general discussion of configuration files and resources including the recognized data types see :ref:`ConfigureChapter`. -:raw-latex:`\index[general]{Types!Director Resource}` -:raw-latex:`\index[general]{Director!Resource Types}` -:raw-latex:`\index[dir]{Resource Types}` +:index:`pair: ` +:index:`pair: ` +:index:`Resource Types` Everything revolves around a job and is tied to a job in one way or another. @@ -78,8 +78,8 @@ The |bareosDir| knows about following resource types: Director Resource ----------------- -:raw-latex:`\index[general]{Director Resource}` -:raw-latex:`\index[general]{Resource!Director}` +:index:`Director Resource` +:index:`pair: ` The Director resource defines the attributes of the Directors running on the network. Only a single Director resource is allowed. @@ -105,8 +105,8 @@ Job Resource .. _`JobResource`: JobResource -:raw-latex:`\index[general]{Resource!Job}` -:raw-latex:`\index[general]{Job!Resource}` +:index:`pair: ` +:index:`pair: ` The Job resource defines a Job (Backup, Restore, ...) that Bareos must perform. Each Job resource definition contains the name of a Client and @@ -160,8 +160,8 @@ The following is an example of a valid Job resource definition: JobDefs Resource ---------------- -:raw-latex:`\index[general]{Job!JobDefs Resource}` -:raw-latex:`\index[general]{Resource!JobDefs}` +:index:`pair: ` +:index:`pair: ` The JobDefs resource permits all the same directives that can appear in a Job resource. However, a JobDefs resource does not create a Job, @@ -175,8 +175,8 @@ Only the changes from the defaults need to be mentioned in each Job. Schedule Resource ----------------- -:raw-latex:`\index[general]{Resource!Schedule}` -:raw-latex:`\index[general]{Schedule!Resource}` +:index:`pair: ` +:index:`pair: ` The Schedule resource provides a means of automatically scheduling a Job as well as the ability to override the default Level, Pool, Storage and @@ -302,7 +302,7 @@ it up as w03/w05. Technical Notes on Schedules ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -:raw-latex:`\index[general]{Schedule!Technical Notes on Schedules}` +:index:`pair: ` 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 @@ -332,8 +332,8 @@ FileSet Resource .. _`FileSetResource`: FileSetResource -:raw-latex:`\index[general]{Resource!FileSet}` -:raw-latex:`\index[general]{FileSet!Resource}` +:index:`pair: ` +:index:`pair: ` The FileSet resource defines what files are to be included or excluded in a backup job. A **FileSet** resource is required for each backup Job. @@ -352,8 +352,8 @@ created, Bareos will ensure that the next backup is always a Full save. Client Resource --------------- -:raw-latex:`\index[general]{Resource!Client}` -:raw-latex:`\index[general]{Client Resource}` +:index:`pair: ` +:index:`Client Resource` The Client (or FileDaemon) resource defines the attributes of the Clients that are served by this Director; that is the machines that are @@ -394,8 +394,8 @@ The following is an example of a Quota Configuration in Client resource: Storage Resource ---------------- -:raw-latex:`\index[general]{Resource!Storage}` -:raw-latex:`\index[general]{Storage Resource}` +:index:`pair: ` +:index:`Storage Resource` The Storage resource defines which Storage daemons are available for use by the Director. @@ -418,8 +418,8 @@ The following is an example of a valid Storage resource definition: Pool Resource ------------- -:raw-latex:`\index[general]{Resource!Pool}` -:raw-latex:`\index[general]{Pool Resource}` +:index:`pair: ` +:index:`Pool Resource` The Pool resource defines the set of storage Volumes (tapes or files) to be used by Bareos to write the data. By configuring different Pools, you @@ -510,8 +510,8 @@ The following is an example of a valid Pool resource definition: Scratch Pool ~~~~~~~~~~~~ -:raw-latex:`\index[general]{Scratch Pool}` -:raw-latex:`\index[general]{Pool!Scratch}` +:index:`Scratch Pool` +:index:`pair: ` In general, you can give your Pools any name you wish, but there is one important restriction: the Pool named **Scratch**, if it exists behaves @@ -525,8 +525,8 @@ pool into the Pool currently being used by the job. Catalog Resource ---------------- -:raw-latex:`\index[general]{Resource!Catalog}` -:raw-latex:`\index[general]{Catalog Resource}` +:index:`pair: ` +:index:`Catalog Resource` The Catalog Resource defines what catalog to use for the current job. Currently, Bareos can only handle a single database server (SQLite, @@ -577,8 +577,8 @@ or for a Catalog on another machine: Messages Resource ----------------- -:raw-latex:`\index[general]{Resource!Messages}` -:raw-latex:`\index[general]{Messages Resource}` +:index:`pair: ` +:index:`Messages Resource` For the details of the Messages Resource, please see the :ref:`MessagesChapter` of this manual. @@ -588,15 +588,15 @@ For the details of the Messages Resource, please see the Console Resource ---------------- -:raw-latex:`\index[general]{Console Resource}` -:raw-latex:`\index[general]{Resource!Console}` +:index:`Console Resource` +:index:`pair: ` There are three different kinds of consoles, which the administrator or user can use to interact with the Director. These three kinds of consoles comprise three different security levels. Default Console - :raw-latex:`\index[dir]{Console!Default Console}` the first console + :index:`pair: ` the first console type is an :raw-latex:`\bquote{anonymous}` or :raw-latex:`\bquote{default}` console, which has full privileges. There is no console resource necessary for this type since the @@ -606,9 +606,9 @@ Default Console use it only for administrators. Named Console - :raw-latex:`\index[dir]{Named Console}` - :raw-latex:`\index[dir]{Console!Named Console}` - :raw-latex:`\index[dir]{Console!Restricted Console}` the second type + :index:`Named Console` + :index:`pair: ` + :index:`pair: ` the second type of console, is a :raw-latex:`\bquote{named}` console (also called :raw-latex:`\bquote{Restricted Console}`) defined within a Console resource in both the Director’s configuration file and in the @@ -651,8 +651,8 @@ how to use a console resource for a connection from a client like Profile Resource ---------------- -:raw-latex:`\index[general]{Profile Resource}` -:raw-latex:`\index[general]{Resource!Profile}` +:index:`Profile Resource` +:index:`pair: ` The Profile Resource defines a set of ACLs. :ref:`DirectorResourceConsole`s can be tight to one or @@ -665,8 +665,8 @@ easier to use a common set of ACLs. Counter Resource ---------------- -:raw-latex:`\index[general]{Resource!Counter}` -:raw-latex:`\index[general]{Counter Resource}` +:index:`pair: ` +:index:`Counter Resource` The Counter Resource defines a counter variable that can be accessed by variable expansion used for creating Volume labels with the @@ -677,8 +677,8 @@ variable expansion used for creating Volume labels with the Example Director Configuration File ----------------------------------- -:raw-latex:`\index[general]{Configuration!Director!Example}` -:raw-latex:`\index[dir]{Configuration File Example}` +:index:`triple: ` +:index:`Configuration File Example` See below an example of a full Director configuration file: diff --git a/docs/manuals/en/new_main_reference/source/disk.rst b/docs/manuals/en/new_main_reference/source/disk.rst index 3bcbad774e1..715c8a33b92 100644 --- a/docs/manuals/en/new_main_reference/source/disk.rst +++ b/docs/manuals/en/new_main_reference/source/disk.rst @@ -1,8 +1,8 @@ .. _`DiskChapter`: DiskChapter -:raw-latex:`\index[general]{Volume!Management}` -:raw-latex:`\index[general]{Disk Volumes}` +:index:`pair: ` +:index:`Disk Volumes` This chapter presents most all the features needed to do Volume management. Most of the concepts apply equally well to both tape and @@ -20,7 +20,7 @@ that you can manage either disk or tape volumes. Key Concepts and Resource Records ================================= -:raw-latex:`\index[general]{Volume!Management!Key Concepts and Resource Records}` +:index:`triple: ` 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 @@ -94,7 +94,7 @@ of this chapter under :ref:`ConcurrentDiskJobs`. Pool Options to Limit the Volume Usage -------------------------------------- -:raw-latex:`\index[general]{Pool!Options to Limit the Volume Usage}` +:index:`pair: ` Some of the options you have, all of which are specified in the Pool record, are: @@ -156,8 +156,8 @@ will be done until Monday morning. Automatic Volume Labeling ------------------------- -:raw-latex:`\index[general]{Label!Automatic Volume Labeling}` -:raw-latex:`\index[general]{Volume!Labeling!Automatic}` +:index:`pair: ` +:index:`triple: ` Use of the above records brings up another problem – that of labeling your Volumes. For automated disk backup, you can either manually label @@ -223,8 +223,8 @@ details about the labeling format. Restricting the Number of Volumes and Recycling ----------------------------------------------- -:raw-latex:`\index[general]{Recycling!Restricting the Number of Volumes and Recycling}` -:raw-latex:`\index[general]{Restricting the Number of Volumes and Recycling}` +:index:`pair: ` +:index:`Restricting the Number of Volumes and Recycling` Automatic labeling discussed above brings up the problem of Volume management. With the above scheme, a new Volume will be created every @@ -311,7 +311,7 @@ specified volume. Concurrent Disk Jobs ==================== -:raw-latex:`\index[general]{Concurrent Disk Jobs}` +:index:`Concurrent Disk Jobs` .. _`ConcurrentDiskJobs`: ConcurrentDiskJobs Above, we discussed how you @@ -537,8 +537,8 @@ space used). Using Multiple Storage Devices ------------------------------ -:raw-latex:`\index[general]{Multiple Storage Devices}` -:raw-latex:`\index[general]{Storage Device!Multiple}` +:index:`Multiple Storage Devices` +:index:`pair: ` Bareos treats disk volumes similar to tape volumes as much as it can. This means that you can only have a single Volume mounted at one time on diff --git a/docs/manuals/en/new_main_reference/source/filedconf.rst b/docs/manuals/en/new_main_reference/source/filedconf.rst index 0c6b3b89cac..ef8f5778808 100644 --- a/docs/manuals/en/new_main_reference/source/filedconf.rst +++ b/docs/manuals/en/new_main_reference/source/filedconf.rst @@ -3,8 +3,8 @@ Client/File Daemon Configuration ================================ -:raw-latex:`\index[general]{Configuration!Client/File daemon}` -:raw-latex:`\index[general]{Client/File daemon Configuration}` +:index:`pair: ` +:index:`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 @@ -30,8 +30,8 @@ manual. The following Client Resource definitions must be defined: Client Resource --------------- -:raw-latex:`\index[general]{Resource!Client}` -:raw-latex:`\index[general]{Client Resource}` +:index:`pair: ` +:index:`Client Resource` The Client Resource (or FileDaemon) resource defines the name of the Client (as used by the Director) as well as the port on which the Client @@ -62,8 +62,8 @@ The following is an example of a valid Client resource definition: Director Resource ----------------- -:raw-latex:`\index[general]{Director Resource}` -:raw-latex:`\index[general]{Resource!Director}` +:index:`Director Resource` +:index:`pair: ` The Director resource defines the name and password of the Directors that are permitted to contact this Client. @@ -102,8 +102,8 @@ The following is an example of a valid Director resource definition: Messages Resource ----------------- -:raw-latex:`\index[general]{Messages Resource}` -:raw-latex:`\index[general]{Resource!Messages}` +:index:`Messages Resource` +:index:`pair: ` Please see the :ref:`Messages Resource ` Chapter of this manual for the details of the Messages Resource. diff --git a/docs/manuals/en/new_main_reference/source/general.rst b/docs/manuals/en/new_main_reference/source/general.rst index 2867ec78e9a..ac9689c8279 100644 --- a/docs/manuals/en/new_main_reference/source/general.rst +++ b/docs/manuals/en/new_main_reference/source/general.rst @@ -164,8 +164,8 @@ Storage daemon, and the Catalog service (MySQL, PostgreSQL or SQLite). Bareos Version Numbers and Releases ----------------------------------- -:raw-latex:`\index[general]{Version numbers}` -:raw-latex:`\index[general]{Releases}` +:index:`Version numbers` +:index:`Releases` Bareos version numbers consists of three parts: YY.Q.C @@ -360,18 +360,18 @@ finally the chapter on Terminology ----------- -:raw-latex:`\index[general]{Terminology}` +:index:`Terminology` Administrator - :raw-latex:`\index[general]{Administrator}` The person or persons + :index:`Administrator` The person or persons responsible for administrating the Bareos system. Backup - :raw-latex:`\index[general]{Backup}` The term Backup refers to a + :index:`Backup` The term Backup refers to a Bareos Job that saves files. Bootstrap File - :raw-latex:`\index[general]{Bootstrap File}` The bootstrap file is + :index:`Bootstrap File` The bootstrap file is an ASCII file containing a compact form of commands that allow Bareos or the stand-alone file extraction utility (bextract) to restore the contents of one or more Volumes, for example, the @@ -380,7 +380,7 @@ Bootstrap File bootstrap file from a Catalog to extract any file or files you wish. Catalog - :raw-latex:`\index[general]{Catalog}` The Catalog is used to store + :index:`Catalog` The Catalog is used to store summary information about the Jobs, Clients, and Files that were backed up and on what Volume or Volumes. The information saved in the Catalog permits the administrator or user to determine what jobs @@ -396,42 +396,42 @@ Catalog simple backup and archive programs such as dump and tar. Client - :raw-latex:`\index[general]{Client}` - :raw-latex:`\index[general]{File Daemon|see{Client}}` In Bareos’s + :index:`Client` + :index:`File Daemon|see{Client}` In Bareos’s terminology, the word Client refers to the machine being backed up, and it is synonymous with the File services or File daemon, and quite often, it is referred to it as the FD. A Client is defined in a configuration file resource. Console - :raw-latex:`\index[general]{Console}` The program that interfaces to + :index:`Console` The program that interfaces to the Director allowing the user or system administrator to control Bareos. Daemon - :raw-latex:`\index[general]{Daemon}` Unix terminology for a program + :index:`Daemon` Unix terminology for a program that is always present in the background to carry out a designated task. On Windows systems, as well as some Unix systems, daemons are called Services. Directive - :raw-latex:`\index[general]{Directive}` The term directive is used + :index:`Directive` The term directive is used to refer to a statement or a record within a Resource in a configuration file that defines one specific setting. For example, the **Name** directive defines the name of the Resource. Director - :raw-latex:`\index[general]{Director}` The main Bareos server daemon + :index:`Director` The main Bareos server daemon that schedules and directs all Bareos operations. Occasionally, the project refers to the Director as DIR. Differential - :raw-latex:`\index[general]{Differential}` A backup that includes + :index:`Differential` A backup that includes all files changed since the last Full save started. Note, other backup programs may define this differently. File Attributes - :raw-latex:`\index[general]{File Attributes}` The File Attributes + :index:`File Attributes` The File Attributes are all the information necessary about a file to identify it and all its properties such as size, creation date, modification date, permissions, etc. Normally, the attributes are handled entirely by @@ -439,7 +439,7 @@ File Attributes attributes do not include the file’s data. File daemon - :raw-latex:`\index[general]{File Daemon}` The daemon running on the + :index:`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. @@ -456,7 +456,7 @@ FileSet the Director chapter of this document. Incremental - :raw-latex:`\index[general]{Incremental}` A backup that includes all + :index:`Incremental` A backup that includes all files changed since the last Full, Differential, or Incremental backup started. It is normally specified on the **Level** directive within the Job resource definition, or in a Schedule resource. @@ -466,7 +466,7 @@ Incremental .. _`JobDef`: JobDef Job - :raw-latex:`\index[general]{Job}` A Bareos Job is a configuration + :index:`Job` A Bareos Job is a configuration resource that defines the work that Bareos must perform to backup or restore a particular Client. It consists of the **Type** (backup, restore, verify, etc), the **Level** (full, differential, @@ -476,12 +476,12 @@ Job chapter of this document. Monitor - :raw-latex:`\index[general]{Monitor}` The program that interfaces to + :index:`Monitor` The program that interfaces to all the daemons allowing the user or system administrator to monitor Bareos status. Resource - :raw-latex:`\index[general]{Resource}` A resource is a part of a + :index:`Resource` A resource is a part of a configuration file that defines a specific unit of information that is available to Bareos. It consists of several directives (individual configuration statements). For example, the **Job** @@ -489,7 +489,7 @@ Resource schedule, Volume pool, backup type, backup level, ... Restore - :raw-latex:`\index[general]{Restore}` A restore is a configuration + :index:`Restore` A restore is a configuration resource that describes the operation of recovering a file from backup media. It is the inverse of a save, except that in most cases, a restore will normally have a small set of files to restore, @@ -498,7 +498,7 @@ Restore Restore of all files that were on the system. Schedule - :raw-latex:`\index[general]{Schedule}` A Schedule is a configuration + :index:`Schedule` A Schedule is a configuration resource that defines when the Bareos Job will be scheduled for execution. To use the Schedule, the Job resource will refer to the name of the Schedule. For more details, see the @@ -506,12 +506,12 @@ Schedule chapter of this document. Service - :raw-latex:`\index[general]{Service}` This is a program that remains + :index:`Service` This is a program that remains permanently in memory awaiting instructions. In Unix environments, services are also known as **daemons**. Storage Coordinates - :raw-latex:`\index[general]{Storage Coordinates}` The information + :index:`Storage Coordinates` The information returned from the Storage Services that uniquely locates a file on a backup medium. It consists of two parts: one part pertains to each file saved, and the other part pertains to the whole Job. Normally, @@ -521,19 +521,19 @@ Storage Coordinates location of the information on the backup Volume. Storage Daemon - :raw-latex:`\index[general]{Storage Daemon}` The Storage daemon, + :index:`Storage Daemon` The Storage daemon, sometimes referred to as the SD, is the code that writes the attributes and data to a storage Volume (usually a tape or disk). Session - :raw-latex:`\index[general]{Session}` Normally refers to the + :index:`Session` Normally refers to the internal conversation between the File daemon and the Storage daemon. The File daemon opens a **session** with the Storage daemon to save a FileSet or to restore it. A session has a one-to-one correspondence to a Bareos Job (see above). Verify - :raw-latex:`\index[general]{Verify}` A verify is a job that compares + :index:`Verify` A verify is a job that compares the current file attributes to the attributes that have previously been stored in the Bareos Catalog. This feature can be used for detecting changes to critical system files similar to what a file @@ -550,7 +550,7 @@ Verify contents against the original files on disk. Retention Period - :raw-latex:`\index[general]{Retention Period}` There are various + :index:`Retention Period` There are various kinds of retention periods that Bareos recognizes. The most important are the **File** Retention Period, **Job** Retention Period, and the **Volume** Retention Period. Each of these retention @@ -595,7 +595,7 @@ Retention Period the retention periods defined. Scan - :raw-latex:`\index[general]{Scan}` A Scan operation causes the + :index:`Scan` A Scan operation causes the contents of a Volume or a series of Volumes to be scanned. These Volumes with the information on which files they contain are restored to the Bareos Catalog. Once the information is restored to @@ -608,7 +608,7 @@ Scan chapter of this manual for more details. Volume - :raw-latex:`\index[general]{Volume}` A Volume is an archive unit, + :index:`Volume` A Volume is an archive unit, normally a tape or a named disk file where Bareos stores the data from one or more backup jobs. All Bareos Volumes have a software label written to the Volume by Bareos so that it identifies what diff --git a/docs/manuals/en/new_main_reference/source/howto.rst b/docs/manuals/en/new_main_reference/source/howto.rst index 93a8a926ab2..60115659e0d 100644 --- a/docs/manuals/en/new_main_reference/source/howto.rst +++ b/docs/manuals/en/new_main_reference/source/howto.rst @@ -3,10 +3,12 @@ Use a dummy device to test the backup ===================================== -:raw-latex:`\label{TestUsingFifoDevice}` If your are testing your + + +.. _`TestUsingFifoDevice`: TestUsingFifoDevice If your are testing your configuration, but don’t want to store the backup data, it is possible to use a dummy FIFO device to test your configuration, see -:raw-latex:`\ilink{Stored configuration}{SetupFifo}`. +:ref:`Stored configuration `. Obviously, it can not be used to do a restore. @@ -29,9 +31,11 @@ Obviously, it can not be used to do a restore. Backup Of Third Party Databases =============================== -:raw-latex:`\index[general]{Backup!of Third Party Databases}` -:raw-latex:`\index[general]{Database!Backup Of Third Party}` -:raw-latex:`\label{BackupOtherDBs}` +:index:`pair: ` +:index:`pair: ` + + +.. _`BackupOtherDBs`: BackupOtherDBs If you are running a database in production mode on your machine, Bareos will happily backup the files, but if the database is in use while @@ -44,10 +48,12 @@ perhaps by dumping the database in ASCII format. Backup of MSSQL Databases with Bareos Plugin -------------------------------------------- -:raw-latex:`\index[general]{MSSQL Backup}` -:raw-latex:`\index[general]{Database!MSSQL}` -:raw-latex:`\index[general]{Plugin!MSSQL backup}` -:raw-latex:`\label{MSSQL}` +:index:`MSSQL Backup` +:index:`pair: ` +:index:`pair: ` + + +.. _`MSSQL`: MSSQL .. raw:: latex @@ -694,9 +700,11 @@ incremental backup with a replace of the original database: Backup of a PostgreSQL Database ------------------------------- -:raw-latex:`\index[general]{PostgreSQL!Backup}` -:raw-latex:`\index[general]{Database!PostgreSQL!Backup}` -:raw-latex:`\label{backup-postgresql}` +:index:`pair: ` +:index:`triple: ` + + +.. _`backup-postgresql`: backup-postgresql In this section, we describe different methods how to do backups of the PostgreSQL databases. @@ -704,10 +712,10 @@ PostgreSQL databases. Backup of a PostgreSQL Database by using the RunScript directive ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -:raw-latex:`\index[general]{RunScript!Example}` +:index:`pair: ` One method to backup a PostgreSQL database is to use the -:raw-latex:`\command{pg_dumpall}` tool to dump the database into a file +:program:`pg_dumpall` tool to dump the database into a file and then backup it as a normal file. After the backup, the file can be removed. It may also be an option not to remove it, so that the latest version is always available immediately. On the next job run it will be @@ -756,12 +764,12 @@ inside a Job Resource, for example: } } -Note that redirecting the :raw-latex:`\command{pg_dumpall}` output to a +Note that redirecting the :program:`pg_dumpall` output to a file requires to run the whole command line through a shell, otherwise -the :raw-latex:`\command{pg_dumpall}` would not know what do with the -:raw-latex:`\command{>}` character and the job would fail. As no shell +the :program:`pg_dumpall` would not know what do with the +:program:`>` character and the job would fail. As no shell features like redirection or piping are used for the -:raw-latex:`\command{rm}`, the :raw-latex:`\command{sh -c}` is not +:program:`rm`, the :program:`sh -c` is not needed there. See :raw-latex:`\linkResourceDirective{Dir}{Job}{Run Script}` for more details. @@ -769,11 +777,11 @@ details. Backup of a PostgreSQL Databases by using the bpipe plugin ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -:raw-latex:`\index[general]{bpipe!PostgreSQL backup}` +:index:`pair: ` Instead of creating a temporary database dump file, the bpipe plugin can be used. For general information about bpipe, see the -:raw-latex:`\nameref{bpipe}` section. The bpipe plugin is configured +:ref:`bpipe` section. The bpipe plugin is configured inside the :raw-latex:`\linkResourceDirective{Dir}{FileSet}{Include}` section of a File Set, e.g.: @@ -793,8 +801,8 @@ section of a File Set, e.g.: This causes the File Daemon to call bpipe plugin, which will write its data into the "pseudo" file :raw-latex:`\file{/POSTGRESQL/dump.sql}` by -calling the program :raw-latex:`\command{pg_dumpall -U postgres}` to -read the data during backup. The :raw-latex:`\command{pg_dumpall}` +calling the program :program:`pg_dumpall -U postgres` to +read the data during backup. The :program:`pg_dumpall` command outputs all the data for the database, which will be read by the plugin and stored in the backup. During restore, the data that was backed up will be sent to the program specified in the last field, which @@ -822,8 +830,10 @@ host: Backup of a PostgreSQL Databases by using the PGSQL-Plugin ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -:raw-latex:`\index[general]{Plugin!PostgreSQL Backup}` -:raw-latex:`\label{backup-postgresql-plugin}` +:index:`pair: ` + + +.. _`backup-postgresql-plugin`: backup-postgresql-plugin The PGSQL-Plugin supports an online (Hot) backup of database files and database transaction logs (WAL) archiving (with pgsql-archlog) and @@ -840,9 +850,11 @@ For a full description, see Backup of a MySQL Database -------------------------- -:raw-latex:`\index[general]{MySQL!Backup}` -:raw-latex:`\index[general]{Database!MySQL!Backup}` -:raw-latex:`\label{backup-mysql}` +:index:`pair: ` +:index:`triple: ` + + +.. _`backup-mysql`: backup-mysql In this section, we describe different methods to do a full backup of a MySQL database. @@ -850,19 +862,21 @@ MySQL database. Backup of MySQL Databases using the Bareos MySQL Percona xtrabackup Plugin ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -:raw-latex:`\index[general]{Plugin!MySQL Backup}` -:raw-latex:`\index[general]{Percona xtrabackup}` -:raw-latex:`\index[general]{xtrabackup}` -:raw-latex:`\label{backup-mysql-xtrabackup}` +:index:`pair: ` +:index:`Percona xtrabackup` +:index:`xtrabackup` + + +.. _`backup-mysql-xtrabackup`: backup-mysql-xtrabackup This plugin is available since :raw-latex:`\sinceVersion{fd}{MySQL Incremental Backup Plugin for using Percona xtrabackup}{16.2.4}`, -it uses the :raw-latex:`\command{xtrabackup}` tool from Percona to +it uses the :program:`xtrabackup` tool from Percona to perform full and incremental hot-backups of MySQL / MariaDB tables of type InnoDB. It can also backup MyISAM tables but only as full backups. On restore it requires a preparation using the xtrabackup tools, before the tables can be restored. If you simply want to backup full dumps, -then using :raw-latex:`\nameref{backup-mysql-python}` is the easier way. +then using :ref:`backup-mysql-python` is the easier way. Prerequisites ^^^^^^^^^^^^^ @@ -875,10 +889,10 @@ The plugin was successfully tested with xtrabackup versions 2.3.5 and As it is a Python plugin, it will also require to have the package :raw-latex:`\package{bareos-filedaemon-python-plugin}` installed on the -:raw-latex:`\bareosFd`, where you run it. +|bareosFd|, where you run it. For authentication the :raw-latex:`\file{.mycnf}` file of the user -running the :raw-latex:`\bareosFd`. Before proceeding, make sure that +running the |bareosFd|. Before proceeding, make sure that xtrabackup can connect to the database and create backups. Installation @@ -895,8 +909,8 @@ Configuration ^^^^^^^^^^^^^ Activate your plugin directory in the -:raw-latex:`\bareosFd `configuration. See -:raw-latex:`\nameref{fdPlugins}` for more about plugins in general. +|bareosFd| configuration. See +:ref:`fdPlugins` for more about plugins in general. :: @@ -942,10 +956,10 @@ by ’:’. The following options are available: - :raw-latex:`\parameter{dumpoptions}` to modify the options for xtrabackup. Default setting is: - :raw-latex:`\command{--backup --datadir=/var/lib/mysql/ --stream=xbstream --extra-lsndir=/tmp/individual_tempdir}` + :program:`--backup --datadir=/var/lib/mysql/ --stream=xbstream --extra-lsndir=/tmp/individual_tempdir` - :raw-latex:`\parameter{restorecommand}` to modify the command for - restore. Default setting is: :raw-latex:`\command{xbstream -x -C}` + restore. Default setting is: :program:`xbstream -x -C` - :raw-latex:`\parameter{strictIncremental}`: By default (false), an incremental backup will create data, even if the Log Sequence Number @@ -989,30 +1003,32 @@ Next line is the first incremental job with ID 335, starting at LSN ID 338. To further prepare the restored files, use the -:raw-latex:`\command{xtrabackup --prepare}` command. Read +:program:`xtrabackup --prepare` command. Read ``https://www.percona.com/doc/percona-xtrabackup/2.4/xtrabackup_bin/incremental_backups.html`` for more information. Backup of MySQL Databases using the Python MySQL plugin ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -:raw-latex:`\index[general]{Plugin!MySQL Backup}` -:raw-latex:`\label{backup-mysql-python}` +:index:`pair: ` + + +.. _`backup-mysql-python`: backup-mysql-python The Python plugin from ``https://github.com/bareos/bareos-contrib/tree/master/fd-plugins/mysql-python`` makes a backup of all or selected MySQL databases from the -:raw-latex:`\bareosFd `or any other MySQL server. It makes use of the +|bareosFd| or any other MySQL server. It makes use of the mysqldump command and basically grabs data from mysqldump via pipe. This plugin is suitable to backup database dumps. If you prefer to use mechanisms like incremental hot-backups of InnoDB tables, please use the Bareos MySQL / MariaDB Percona xtrabackup Plugin (see -:raw-latex:`\nameref{backup-mysql-xtrabackup}`). +:ref:`backup-mysql-xtrabackup`). Following settings must be done on the Bareos client -(:raw-latex:`\bareosFd`): +(|bareosFd|): -- install and enable the :raw-latex:`\bareosFd `Python plugin +- install and enable the |bareosFd| Python plugin - install the Python MySQL plugin (for some platforms it is available prepackaged from :raw-latex:`\contribDownloadBareosOrg`, on the other @@ -1030,7 +1046,7 @@ Following settings must be done on the Bareos client compatible = no } -Configure the plugin in the :raw-latex:`\bareosDir`: +Configure the plugin in the |bareosDir|: :: @@ -1093,15 +1109,15 @@ mysqlpassword On restore, the database dumps are restored to the subdirectory ``_mysqlbackups_`` in the restore path. The database restore must be triggered manually -(:raw-latex:`\command{mysql < _mysqlbackups_/DATABASENAME.sql}`). +(:program:`mysql < _mysqlbackups_/DATABASENAME.sql`). Backup of a MySQL Database by using the RunScript directive ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -:raw-latex:`\index[general]{RunScript!Example}` +:index:`pair: ` One method to backup a MySQL database is to use the -:raw-latex:`\command{mysqldump}` tool to dump the database into a file +:program:`mysqldump` tool to dump the database into a file and then backup it as a normal file. After the backup, the file can be removed. It may also be an option not to remove it, so that the latest version is always available immediately. On the next job run it will be @@ -1150,12 +1166,12 @@ for example: } } -Note that redirecting the :raw-latex:`\command{mysqldump}` output to a +Note that redirecting the :program:`mysqldump` output to a file requires to run the whole command line through a shell, otherwise -the :raw-latex:`\command{mysqldump}` would not know what do with the -:raw-latex:`\command{>}` character and the job would fail. As no shell +the :program:`mysqldump` would not know what do with the +:program:`>` character and the job would fail. As no shell features like redirection or piping are used for the -:raw-latex:`\command{rm}`, the :raw-latex:`\command{sh -c}` is not +:program:`rm`, the :program:`sh -c` is not needed there. See :raw-latex:`\linkResourceDirective{Dir}{Job}{Run Script}` for more details. @@ -1163,11 +1179,11 @@ details. Backup of a MySQL Database by using the bpipe plugin ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -:raw-latex:`\index[general]{bpipe!MySQL backup}` +:index:`pair: ` Instead of creating a temporary database dump file, the bpipe plugin can be used. For general information about bpipe, see the -:raw-latex:`\nameref{bpipe}` section. The bpipe plugin is configured +:ref:`bpipe` section. The bpipe plugin is configured inside the Include section of a File Set, e.g.: :: @@ -1221,7 +1237,7 @@ over the restore process, e.g.: } A very simple corresponding shell script -(:raw-latex:`\command{bpipe-restore.sh}`) to the method above might look +(:program:`bpipe-restore.sh`) to the method above might look like the following one: :: diff --git a/docs/manuals/en/new_main_reference/source/install.rst b/docs/manuals/en/new_main_reference/source/install.rst index c4766b5c0aa..e31ce94e1d9 100644 --- a/docs/manuals/en/new_main_reference/source/install.rst +++ b/docs/manuals/en/new_main_reference/source/install.rst @@ -118,9 +118,9 @@ Install on RedHat based Linux Distributions RHEL\ :math:`\ge`\ 7, CentOS\ :math:`\ge`\ 7, Fedora ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -:raw-latex:`\index[general]{Platform!RHEL}` -:raw-latex:`\index[general]{Platform!CentOS}` -:raw-latex:`\index[general]{Platform!Fedora}` +:index:`pair: ` +:index:`pair: ` +:index:`pair: ` Bareos :raw-latex:`\sinceVersion{dir}{requires!jansson}{15.2.0}` requires the :ref:`Jansson library ` package. On @@ -155,8 +155,8 @@ CentOS 7 and Fedora is it included on the main repository. RHEL 6, CentOS 6 ~~~~~~~~~~~~~~~~ -:raw-latex:`\index[general]{Platform!RHEL!6}` -:raw-latex:`\index[general]{Platform!CentOS!6}` +:index:`triple: ` +:index:`triple: ` Bareos :raw-latex:`\sinceVersion{dir}{requires!jansson}{15.2.0}` requires the :ref:`Jansson library ` package. This @@ -195,7 +195,7 @@ sure, it is available on your system. RHEL 5 ~~~~~~ -:raw-latex:`\index[general]{Platform!RHEL!5}` +:index:`triple: ` yum in RHEL 5/CentOS 5 has slightly different behaviour as far as dependency resolving is concerned: it sometimes install a dependent @@ -231,8 +231,8 @@ Install on SUSE based Linux Distributions SUSE Linux Enterprise Server (SLES), openSUSE ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -:raw-latex:`\index[general]{Platform!SLES}` -:raw-latex:`\index[general]{Platform!openSUSE}` +:index:`pair: ` +:index:`pair: ` :: @@ -269,8 +269,8 @@ Install on Debian based Linux Distributions Debian / Ubuntu ~~~~~~~~~~~~~~~ -:raw-latex:`\index[general]{Platform!Debian}` -:raw-latex:`\index[general]{Platform!Ubuntu}` +:index:`pair: ` +:index:`pair: ` Bareos :raw-latex:`\sinceVersion{dir}{requires!jansson}{15.2.0}` requires the :ref:`Jansson library ` package. On diff --git a/docs/manuals/en/new_main_reference/source/lanaddress.rst b/docs/manuals/en/new_main_reference/source/lanaddress.rst index 83ff34323ab..ebe54290e8e 100644 --- a/docs/manuals/en/new_main_reference/source/lanaddress.rst +++ b/docs/manuals/en/new_main_reference/source/lanaddress.rst @@ -3,7 +3,7 @@ Using different IP Adresses for SD – FD Communication ===================================================== -:raw-latex:`\index[general]{Lan Address}` +:index:`Lan Address` Bareos supports network topologies where the |bareosFd| and |bareosSd| are situated inside of a LAN, but the diff --git a/docs/manuals/en/new_main_reference/source/license.rst b/docs/manuals/en/new_main_reference/source/license.rst index ffed32ef148..d56b7b8ca4f 100644 --- a/docs/manuals/en/new_main_reference/source/license.rst +++ b/docs/manuals/en/new_main_reference/source/license.rst @@ -6,7 +6,7 @@ There are a number of different licenses that are used in Bareos. FDL --- -:raw-latex:`\index[general]{License!FDL}` +:index:`pair: ` The :ref:`GNU Free Documentation License (FDL) ` is used for this manual, which is a free and open license. This means that @@ -15,7 +15,7 @@ you may freely reproduce it and even make changes to it. AGPL ---- -:raw-latex:`\index[general]{License!AGPL}` +:index:`pair: ` The vast bulk of the source code is released under the :ref:`GNU Affero General Public License (AGPL) version 3 `. @@ -31,7 +31,7 @@ under different licenses which are compatible with the AGPL license. LGPL ---- -:raw-latex:`\index[general]{License!LGPL}` +:index:`pair: ` Some of the Bareos library source code is released under the :ref:`GNU Lesser General Public License (LGPL) `. @@ -41,7 +41,7 @@ proprietary programs to interface to Bareos. Public Domain ------------- -:raw-latex:`\index[general]{License!Public Domain}` +:index:`pair: ` Some of the Bareos code, or code that Bareos references, has been released to the public domain. E.g. md5.c, SQLite. @@ -49,7 +49,7 @@ released to the public domain. E.g. md5.c, SQLite. Trademark --------- -:raw-latex:`\index[general]{Trademark}` +:index:`Trademark` Bareos:raw-latex:`\raisebox{.6ex}{\textsuperscript{\textregistered}}` is a registered trademark of Bareos GmbH & Co. KG. @@ -60,7 +60,7 @@ a registered trademark of Kern Sibbald. Disclaimer ---------- -:raw-latex:`\index[general]{Disclaimer}` +:index:`Disclaimer` NO WARRANTY diff --git a/docs/manuals/en/new_main_reference/source/messagesres.rst b/docs/manuals/en/new_main_reference/source/messagesres.rst index 2677fd4cfcd..10e90458d82 100644 --- a/docs/manuals/en/new_main_reference/source/messagesres.rst +++ b/docs/manuals/en/new_main_reference/source/messagesres.rst @@ -6,8 +6,8 @@ Messages Resource .. _`ResourceMessages`: ResourceMessages -:raw-latex:`\index[general]{Resource!Messages}` -:raw-latex:`\index[general]{Messages Resource}` +:index:`pair: ` +:index:`Messages Resource` The Messages resource defines how messages are to be handled and destinations to which they should be sent. @@ -36,7 +36,7 @@ and should be flushed at the end of the next Job. The records contained in a Messages resource consist of a **destination** specification followed by a list of **message-types** in -the format: :raw-latex:`\index[dir]{Messages!destination}` +the format: :index:`pair: ` destination = message-type1, message-type2, message-type3, ... @@ -74,40 +74,40 @@ list of the following types or classes of messages: info | :raw-latex:`\hfill ` - | :raw-latex:`\index[general]{Messages!type!info}` General + | :index:`triple: ` General information messages. warning | :raw-latex:`\hfill ` - | :raw-latex:`\index[general]{Messages!type!warning}` Warning + | :index:`triple: ` Warning messages. Generally this is some unusual condition but not expected to be serious. error | :raw-latex:`\hfill ` - | :raw-latex:`\index[general]{Messages!type!error}` Non-fatal error + | :index:`triple: ` Non-fatal error messages. The job continues running. Any error message should be investigated as it means that something went wrong. fatal | :raw-latex:`\hfill ` - | :raw-latex:`\index[general]{Messages!type!fatal}` Fatal error + | :index:`triple: ` Fatal error messages. Fatal errors cause the job to terminate. terminate | :raw-latex:`\hfill ` - | :raw-latex:`\index[general]{Messages!type!terminate}` Message + | :index:`triple: ` Message generated when the daemon shuts down. notsaved | :raw-latex:`\hfill ` - | :raw-latex:`\index[general]{Messages!type!notsaved}` Files not + | :index:`triple: ` Files not saved because of some error. Usually because the file cannot be accessed (i.e. it does not exist or is not mounted). skipped | :raw-latex:`\hfill ` - | :raw-latex:`\index[general]{Messages!type!skipped}` Files that + | :index:`triple: ` Files that were skipped because of a user supplied option such as an incremental backup or a file that matches an exclusion pattern. This is not considered an error condition such as the files listed @@ -118,41 +118,41 @@ skipped mount | :raw-latex:`\hfill ` - | :raw-latex:`\index[general]{Messages!type!mount}` Volume mount or + | :index:`triple: ` Volume mount or intervention requests from the Storage daemon. These requests require a specific operator intervention for the job to continue. restored | :raw-latex:`\hfill ` - | :raw-latex:`\index[general]{Messages!type!restored}` The **ls** + | :index:`triple: ` The **ls** style listing generated for each file restored is sent to this message class. all | :raw-latex:`\hfill ` - | :raw-latex:`\index[general]{Messages!type!all}` All message types. + | :index:`triple: ` All message types. security | :raw-latex:`\hfill ` - | :raw-latex:`\index[general]{Messages!type!security}` Security + | :index:`triple: ` Security info/warning messages principally from unauthorized connection attempts. alert | :raw-latex:`\hfill ` - | :raw-latex:`\index[general]{Messages!type!alert}` Alert messages. + | :index:`triple: ` Alert messages. These are messages generated by tape alerts. volmgmt | :raw-latex:`\hfill ` - | :raw-latex:`\index[general]{Messages!type!volmgmt}` Volume + | :index:`triple: ` Volume management messages. Currently there are no volume management messages generated. audit | :raw-latex:`\hfill ` - | :raw-latex:`\index[general]{Messages!type!audit}` - :raw-latex:`\index[general]{auditing}` Audit messages. Interacting + | :index:`triple: ` + :index:`auditing` Audit messages. Interacting with the Bareos Director will be audited. Can be configured with in resource :raw-latex:`\linkResourceDirective{Dir}{Director}{Auditing}`. diff --git a/docs/manuals/en/new_main_reference/source/migration.rst b/docs/manuals/en/new_main_reference/source/migration.rst index a9600328fa9..4550d0b3d5d 100644 --- a/docs/manuals/en/new_main_reference/source/migration.rst +++ b/docs/manuals/en/new_main_reference/source/migration.rst @@ -3,8 +3,8 @@ Migration and Copy ================== -:raw-latex:`\index[general]{Migration}` -:raw-latex:`\index[general]{Copy}` +:index:`Migration` +:index:`Copy` The term Migration, as used in the context of Bareos, means moving data from one Volume to another. In particular it refers to a Job (similar to @@ -91,7 +91,7 @@ rather than simultaneously. Important Migration Considerations ---------------------------------- -:raw-latex:`\index[general]{Migration!Important Migration Considerations}` +:index:`pair: ` - Each Pool into which you migrate Jobs or Volumes **must** contain Volumes of only one @@ -215,7 +215,7 @@ Pool Resource Example Migration Jobs ~~~~~~~~~~~~~~~~~~~~~~ -:raw-latex:`\index[general]{Example!Migration Jobs}` +:index:`pair: ` Assume a simple configuration with a single backup job as described below. diff --git a/docs/manuals/en/new_main_reference/source/monitorconf.rst b/docs/manuals/en/new_main_reference/source/monitorconf.rst index 9f0070e911d..3354d906d35 100644 --- a/docs/manuals/en/new_main_reference/source/monitorconf.rst +++ b/docs/manuals/en/new_main_reference/source/monitorconf.rst @@ -3,8 +3,8 @@ Monitor Configuration ===================== -:raw-latex:`\index[general]{Monitor Configuration}` -:raw-latex:`\index[general]{Configuration!Monitor}` +:index:`Monitor Configuration` +:index:`pair: ` The Monitor configuration file is a stripped down version of the Director configuration file, mixed with a Console configuration file. It @@ -33,8 +33,8 @@ The following Monitor Resource definition must be defined: Monitor Resource ---------------- -:raw-latex:`\index[general]{Monitor Resource}` -:raw-latex:`\index[general]{Resource!Monitor}` +:index:`Monitor Resource` +:index:`pair: ` The Monitor resource defines the attributes of the Monitor running on the network. The parameters you define here must be configured as a @@ -46,8 +46,8 @@ Console resource in Directors configuration files. Director Resource ----------------- -:raw-latex:`\index[general]{Director Resource}` -:raw-latex:`\index[general]{Resource!Director}` +:index:`Director Resource` +:index:`pair: ` The Director resource defines the attributes of the Directors that are monitored by this Monitor. @@ -68,8 +68,8 @@ Monitor configuration file. Client Resource --------------- -:raw-latex:`\index[general]{Resource!Client}` -:raw-latex:`\index[general]{Client Resource}` +:index:`pair: ` +:index:`Client Resource` The Client resource defines the attributes of the Clients that are monitored by this Monitor. @@ -88,8 +88,8 @@ Monitor configuration file. Storage Resource ---------------- -:raw-latex:`\index[general]{Resource!Storage}` -:raw-latex:`\index[general]{Storage Resource}` +:index:`pair: ` +:index:`Storage Resource` The Storage resource defines the attributes of the Storages that are monitored by this Monitor. @@ -109,8 +109,8 @@ Tray Monitor Tray Monitor Security ~~~~~~~~~~~~~~~~~~~~~ -:raw-latex:`\index[general]{Tray Monitor Security}` -:raw-latex:`\index[general]{Security!Tray Monitor}` +:index:`Tray Monitor Security` +:index:`pair: ` There is no security problem in relaxing the permissions on tray-monitor.conf as long as FD, SD and DIR are configured properly, so @@ -136,8 +136,8 @@ being dangerous). Example Tray Monitor configuration ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -:raw-latex:`\index[general]{Tray Monitor!Configuration}` -:raw-latex:`\index[general]{Configuration!Tray Monitor}` +:index:`pair: ` +:index:`pair: ` An example Tray Monitor configuration file might be the following: diff --git a/docs/manuals/en/new_main_reference/source/ndmp.rst b/docs/manuals/en/new_main_reference/source/ndmp.rst index 11a8945ce61..249cc191acd 100644 --- a/docs/manuals/en/new_main_reference/source/ndmp.rst +++ b/docs/manuals/en/new_main_reference/source/ndmp.rst @@ -1,4 +1,4 @@ -:raw-latex:`\index[general]{NDMP!Overview}` +:index:`pair: ` NDMP Basics =========== @@ -284,7 +284,7 @@ recovered as NDMP stream from the NDMP resource. Example Setup for NDMP_BAREOS backup ------------------------------------ -:raw-latex:`\index[general]{NDMP!Example!NDMP\_BAREOS}` +:index:`triple: ` This example starts from a clean default Bareos installation. @@ -571,7 +571,7 @@ filesystem which can be accessed by NDMP. Which filesystems are available is showed in the :raw-latex:`\bcommand{status}{client}` output of the NDMP client. -:raw-latex:`\index[general]{NDMP!Environment variables}` Additionally, +:index:`pair: ` Additionally, NDMP can be configured via NDMP environment variables. These can be specified in the Options Block of the Fileset with the :raw-latex:`\configdirective{Meta}` keyword. Which variables are @@ -1051,8 +1051,8 @@ Example: NDMP Copy Jobs -------------- -:raw-latex:`\index[general]{Copy!NDMP}` -:raw-latex:`\index[general]{NDMP!Copy jobs}` +:index:`pair: ` +:index:`pair: ` To be able to do copy jobs, we need to have a second storage resource where we can copy the data to. Depending on your requirements, this @@ -1282,7 +1282,7 @@ limitation for all Bareos NDMP implementation, see NDMP Job limitations when scanning in volumes ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -:raw-latex:`\index[general]{NDMP!File History}` +:index:`pair: ` For NDMP jobs, all data is stored into a single big file. The file and directory information (File History in NDMP Terms) is stored as @@ -1333,7 +1333,7 @@ or offer it as an option, e.g. Isilon with there Example Setup for NDMP_NATIVE backup ------------------------------------ -:raw-latex:`\index[general]{NDMP!Example!NDMP\_NATIVE}` +:index:`triple: ` Configure a NDMP Client ~~~~~~~~~~~~~~~~~~~~~~~ @@ -2105,7 +2105,7 @@ implementation that are valid for all Bareos NDMP protocols. NDMP Backup Level ----------------- -:raw-latex:`\index[general]{NDMP!Level}` +:index:`pair: ` The trailing number in the main backup file (after the ``%`` character) indicates the NDMP backup level: diff --git a/docs/manuals/en/new_main_reference/source/pools.rst b/docs/manuals/en/new_main_reference/source/pools.rst index 408d0ff96d6..b0796803ace 100644 --- a/docs/manuals/en/new_main_reference/source/pools.rst +++ b/docs/manuals/en/new_main_reference/source/pools.rst @@ -3,10 +3,10 @@ Automated Disk Backup ===================== -:raw-latex:`\index[general]{Volumes!Using Pools to Manage}` -:raw-latex:`\index[general]{Disk!Automated Backup}` -:raw-latex:`\index[general]{Automated Disk Backup}` -:raw-latex:`\index[general]{Pool}` +:index:`pair: ` +:index:`pair: ` +:index:`Automated Disk Backup` +:index:`Pool` If you manage five or ten machines and have a nice tape backup, you don’t need Pools, and you may wonder what they are good for. In this @@ -91,8 +91,8 @@ accomplish the requirements. Full Pool ~~~~~~~~~ -:raw-latex:`\index[general]{Pool!Full}` -:raw-latex:`\index[general]{Full Pool}` +:index:`pair: ` +:index:`Full Pool` Putting a single Full backup on each Volume, will require six Full save Volumes, and a retention period of six months. The Pool needed to do @@ -136,8 +136,8 @@ possibly increase the maximum number of Volumes. Differential Pool ~~~~~~~~~~~~~~~~~ -:raw-latex:`\index[general]{Pool!Differential}` -:raw-latex:`\index[general]{Differential Pool}` +:index:`pair: ` +:index:`Differential Pool` For the Differential backup Pool, we choose a retention period of a bit longer than a month and ensure that there is at least one Volume for @@ -177,8 +177,8 @@ multiple clients. Incremental Pool ~~~~~~~~~~~~~~~~ -:raw-latex:`\index[general]{Incremental Pool}` -:raw-latex:`\index[general]{Pool!Incremental}` +:index:`Incremental Pool` +:index:`pair: ` Finally, here is the resource for the Incremental Pool: diff --git a/docs/manuals/en/new_main_reference/source/programs.rst b/docs/manuals/en/new_main_reference/source/programs.rst index 9ad140c66d8..5d55121f7c8 100644 --- a/docs/manuals/en/new_main_reference/source/programs.rst +++ b/docs/manuals/en/new_main_reference/source/programs.rst @@ -9,8 +9,8 @@ Bareos Daemons Daemon Command Line Options ~~~~~~~~~~~~~~~~~~~~~~~~~~~ -:raw-latex:`\index[general]{Daemon!Command Line Options}` -:raw-latex:`\index[general]{Command Line Options!Daemon}` +:index:`pair: ` +:index:`pair: ` Each of the three daemons (Director, File, Storage) accepts a small set of options on the command line. In general, each of the daemons as well @@ -65,8 +65,8 @@ as the Console program accepts the following options: bareos-dir ~~~~~~~~~~ -:raw-latex:`\index[general]{Command!bareos-dir}` -:raw-latex:`\index[dir]{Command Line Options}` +:index:`pair: ` +:index:`Command Line Options` |bareosDir|. @@ -75,8 +75,8 @@ bareos-dir bareos-sd ~~~~~~~~~ -:raw-latex:`\index[general]{Command!bareos-sd}` -:raw-latex:`\index[sd]{Command Line Options}` +:index:`pair: ` +:index:`Command Line Options` |bareosSd|. @@ -85,8 +85,8 @@ bareos-sd bareos-fd ~~~~~~~~~ -:raw-latex:`\index[general]{Command!bareos-fd}` -:raw-latex:`\index[fd]{Command Line Options}` +:index:`pair: ` +:index:`Command Line Options` |bareosFd|. @@ -108,7 +108,7 @@ For further information regarding the Bareos Webui, please refer to bat ~~~ -:raw-latex:`\index[general]{Command!bat}` +:index:`pair: ` .. _`bat`: bat @@ -123,8 +123,8 @@ it is no longer part of Bareos. We encourage the use of Volume Utility Commands ----------------------- -:raw-latex:`\index[general]{Volume Utility Tools}` -:raw-latex:`\index[general]{Tools!Volume Utility}` +:index:`Volume Utility Tools` +:index:`pair: ` .. _`section-VolumeUtilityCommands`: section-VolumeUtilityCommands @@ -189,8 +189,8 @@ filename is equivalent to the volume name. Specifying Volumes ^^^^^^^^^^^^^^^^^^ -:raw-latex:`\index[general]{Volumes!Specifying}` -:raw-latex:`\index[general]{Bootstrap}` +:index:`pair: ` +:index:`Bootstrap` Often you must specify the Volume name to the programs below. The best method to do so is to specify a bootstrap file on the command line with @@ -295,8 +295,8 @@ in the storage device resource, see bls ~~~ -:raw-latex:`\index[general]{bls}` -:raw-latex:`\index[general]{Command!bls}` +:index:`bls` +:index:`pair: ` :program:`bls` can be used to do an :program:`ls` type listing of a Bareos tape or file. It is @@ -410,7 +410,7 @@ For details about the Volume format, see Show Label Information ^^^^^^^^^^^^^^^^^^^^^^ -:raw-latex:`\index[general]{bls!Label}` +:index:`pair: ` Using the :raw-latex:`\parameter{-L}` the label information of a Volume is shown: @@ -439,8 +439,8 @@ is shown: Listing Jobs ^^^^^^^^^^^^ -:raw-latex:`\index[general]{Listing Jobs with bls}` -:raw-latex:`\index[general]{bls!Listing Jobs}` +:index:`Listing Jobs with bls` +:index:`pair: ` If you are listing a Volume to determine what Jobs to restore, normally the :raw-latex:`\parameter{-j}` option provides you with most of what @@ -479,8 +479,8 @@ information that is available for each record. Listing Blocks ^^^^^^^^^^^^^^ -:raw-latex:`\index[general]{Listing Blocks with bls}` -:raw-latex:`\index[general]{bls!Listing Blocks}` +:index:`Listing Blocks with bls` +:index:`pair: ` Normally, except for debugging purposes, you will not need to list Bareos blocks (the "primitive" unit of Bareos data on the Volume). @@ -556,9 +556,9 @@ to the command line to get a dump of every record in every block. bextract ~~~~~~~~ -:raw-latex:`\index[general]{bextract}` -:raw-latex:`\index[general]{Command!bextract}` -:raw-latex:`\index[general]{Disaster!Recovery!bextract}` +:index:`bextract` +:index:`pair: ` +:index:`triple: ` If you find yourself using :program:`bextract`, you probably have done something wrong. For example, if you are trying to recover a @@ -705,7 +705,7 @@ document. Extracting Under Windows ^^^^^^^^^^^^^^^^^^^^^^^^ -:raw-latex:`\index[general]{Windows!bextract}` +:index:`pair: ` .. raw:: latex @@ -746,8 +746,8 @@ first parameter. For example: bscan ~~~~~ -:raw-latex:`\index[general]{bscan}` -:raw-latex:`\index[general]{Command!bscan}` +:index:`bscan` +:index:`pair: ` If you find yourself using this program, you have probably done something wrong. For example, the best way to recover a lost or damaged @@ -936,7 +936,7 @@ should always attempt to recover you previous catalog backup. Using bscan to Compare a Volume to an existing Catalog ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -:raw-latex:`\index[general]{Catalog!Using bscan to Compare a Volume to an existing}` +:index:`pair: ` If you wish to compare the contents of a Volume to an existing catalog without changing the catalog, you can safely do so if and only if you do @@ -947,8 +947,8 @@ we don’t particularly recommend this mode other than for testing. Using bscan to Recreate a Catalog from a Volume ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -:raw-latex:`\index[general]{Catalog!Recreate Using bscan}` -:raw-latex:`\index[general]{bscan!Recreate Catalog}` +:index:`pair: ` +:index:`pair: ` This is the mode for which **bscan** is most useful. You can either **bscan** into a freshly created catalog, or directly into your existing @@ -1085,8 +1085,8 @@ command in :program:`bconsole`. Using bscan to Correct the Volume File Count ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -:raw-latex:`\index[general]{bscan!Correct Volume File Count}` -:raw-latex:`\index[general]{Volume!File Count}` +:index:`pair: ` +:index:`pair: ` If the Storage daemon crashes during a backup Job, the catalog will not be properly updated for the Volume being used at the time of the crash. @@ -1101,7 +1101,7 @@ to update only the final Media record for the Volumes read. After bscan ^^^^^^^^^^^ -:raw-latex:`\index[general]{bscan!after}` +:index:`pair: ` If you use **bscan** to enter the contents of the Volume into an existing catalog, you should be aware that the records you entered may @@ -1116,8 +1116,8 @@ VolStatus to **Used** and the Volume will be purged from the catalog. bcopy ~~~~~ -:raw-latex:`\index[general]{bcopy}` -:raw-latex:`\index[general]{Command!bcopy}` +:index:`bcopy` +:index:`pair: ` The :program:`bcopy` program can be used to copy one Bareos archive file to another. For example, you may copy a tape to a file, a @@ -1160,8 +1160,8 @@ to test this program with two tape drives. btape ~~~~~ -:raw-latex:`\index[general]{btape}` -:raw-latex:`\index[general]{Command!btape}` +:index:`btape` +:index:`pair: ` This program permits a number of elementary tape operations via a tty command interface. It works only with tapes and not with other kinds of @@ -1201,7 +1201,7 @@ file read by :program:`btape`. Using btape to Verify your Tape Drive ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -:raw-latex:`\index[general]{Drive!Verify using btape}` +:index:`pair: ` An important reason for this program is to ensure that a Storage daemon configuration file is defined so that Bareos will correctly read and @@ -1334,8 +1334,8 @@ You can change the block size in the Storage Daemon configuration file. bscrypto ~~~~~~~~ -:raw-latex:`\index[general]{bscrypto}` -:raw-latex:`\index[general]{Command!bscrypto}` +:index:`bscrypto` +:index:`pair: ` :program:`bscrypto` is used in the process of encrypting tapes (see also :ref:`LTOHardwareEncryptionGeneral`). @@ -1402,8 +1402,8 @@ not need a configuration file nor a device name. bsmtp ~~~~~ -:raw-latex:`\index[general]{bsmtp}` -:raw-latex:`\index[general]{Command!bsmtp}` +:index:`bsmtp` +:index:`pair: ` :program:`bsmtp` is a simple mail transport program that permits more flexibility than the standard mail programs typically found @@ -1504,9 +1504,9 @@ bareos-dbcheck .. _`dbcheck`: dbcheck -:raw-latex:`\index[general]{bareos-dbcheck}` -:raw-latex:`\index[general]{Command!bareos-dbcheck}` -:raw-latex:`\index[general]{Catalog!database check}` +:index:`bareos-dbcheck` +:index:`pair: ` +:index:`pair: ` :program:`bareos-dbcheck` is a simple program that will search for logical inconsistencies in the Bareos tables in your @@ -1725,8 +1725,8 @@ running :program:`bareos-dbcheck` too often. bregex ~~~~~~ -:raw-latex:`\index[general]{bregex}` -:raw-latex:`\index[general]{Command!bregex}` +:index:`bregex` +:index:`pair: ` :program:`bregex` is a simple program that will allow you to test regular expressions against a file of data. This can be useful @@ -1760,8 +1760,8 @@ against a list of filenames. bwild ~~~~~ -:raw-latex:`\index[general]{bwild}` -:raw-latex:`\index[general]{Command!bwild}` +:index:`bwild` +:index:`pair: ` :program:`bwild` is a simple program that will allow you to test wild-card expressions against a file of data. @@ -1793,8 +1793,8 @@ against a list of filenames. bpluginfo ~~~~~~~~~ -:raw-latex:`\index[general]{bpluginfo}` -:raw-latex:`\index[general]{Command!bpluginfo}` +:index:`bpluginfo` +:index:`pair: ` The main purpose of bpluginfo is to display different information about Bareos plugin. You can use it to check a plugin name, author, license diff --git a/docs/manuals/en/new_main_reference/source/quickstart.rst b/docs/manuals/en/new_main_reference/source/quickstart.rst index 6161daa6013..1b853ef0d08 100644 --- a/docs/manuals/en/new_main_reference/source/quickstart.rst +++ b/docs/manuals/en/new_main_reference/source/quickstart.rst @@ -1,7 +1,7 @@ Understanding Jobs and Schedules ================================ -:raw-latex:`\index[general]{Schedule!Understanding Schedules}` +:index:`pair: ` .. _`JobsandSchedules`: JobsandSchedules @@ -36,9 +36,9 @@ verify, and admin jobs, which have different requirements. Understanding Pools, Volumes and Labels ======================================= -:raw-latex:`\index[general]{Pools!Understanding}` -:raw-latex:`\index[general]{Volumes!Understanding}` -:raw-latex:`\index[general]{Label!Understanding Labels}` +:index:`pair: ` +:index:`pair: ` +:index:`pair: ` .. _`PoolsVolsLabels`: PoolsVolsLabels @@ -89,7 +89,7 @@ will come back to this subject later. Setting Up Bareos Configuration Files ===================================== -:raw-latex:`\index[general]{Configuration!Files}` +:index:`pair: ` On Unix, Bareos configuration files are usually located in the ``/etc/bareos/`` directory and are named accordingly to the programs @@ -105,7 +105,7 @@ subdirectories under :raw-latex:`\directory{bareos-dir.d}`, Testing your Configuration Files ================================ -:raw-latex:`\index[general]{Testing!Configuration Files}` +:index:`pair: ` You can test if your configuration file is syntactically correct by running the appropriate daemon with the :raw-latex:`\parameter{-t}` diff --git a/docs/manuals/en/new_main_reference/source/recycling.rst b/docs/manuals/en/new_main_reference/source/recycling.rst index 77e6e337ba0..4a0ed05e887 100644 --- a/docs/manuals/en/new_main_reference/source/recycling.rst +++ b/docs/manuals/en/new_main_reference/source/recycling.rst @@ -3,8 +3,8 @@ Automatic Volume Recycling ========================== -:raw-latex:`\index[general]{Recycle!Automatic Volume}` -:raw-latex:`\index[general]{Volume!Recycle!Automatic}` +:index:`pair: ` +:index:`triple: ` By default, once Bareos starts writing a Volume, it can append to the volume, but it will not overwrite the existing data thus destroying it. @@ -124,8 +124,8 @@ no longer appendable. Automatic Pruning ----------------- -:raw-latex:`\index[general]{Automatic!Pruning}` -:raw-latex:`\index[general]{Pruning!Automatic}` +:index:`pair: ` +:index:`pair: ` As Bareos writes files to tape, it keeps a list of files, jobs, and volumes in a database called the catalog. Among other things, the @@ -156,7 +156,7 @@ to save space. Manual pruning is done with the Pruning Directives ------------------ -:raw-latex:`\index[general]{Pruning!Directives}` +:index:`pair: ` There are three pruning durations. All apply to catalog database records and not to the actual data in a Volume. The pruning (or retention) @@ -267,8 +267,8 @@ volume. The Pool records that control the pruning are described below. Recycling Algorithm ------------------- -:raw-latex:`\index[general]{Algorithm!Recycling}` -:raw-latex:`\index[general]{Recycle!Algorithm}` +:index:`pair: ` +:index:`pair: ` .. _`RecyclingAlgorithm}` :raw-latex:`\label{Recycling`: RecyclingAlgorithm}` :raw-latex:`\label{Recycling @@ -290,8 +290,8 @@ Once both those conditions are satisfied, the volume can be marked :raw-latex:`\volumestatus{Purged}` and hence recycled. The full algorithm that Bareos uses when it needs a new Volume is: -:raw-latex:`\index[general]{New Volume Algorithm}` -:raw-latex:`\index[general]{Algorithm!New Volume}` +:index:`New Volume Algorithm` +:index:`pair: ` The algorithm described below assumes that :raw-latex:`\configdirective{Auto Prune}` is enabled, that Recycling is @@ -395,7 +395,7 @@ A few points from Alan Brown to keep in mind: Recycle Status -------------- -:raw-latex:`\index[general]{Recycle Status}` +:index:`Recycle Status` Each Volume inherits the Recycle status (yes or no) from the Pool resource record when the Media record is created (normally when the @@ -628,10 +628,10 @@ scheme? Automatic Pruning and Recycling Example --------------------------------------- -:raw-latex:`\index[general]{Automatic!Pruning and Recycling Example}` -:raw-latex:`\index[general]{Example!Automatic Pruning and Recycling}` -:raw-latex:`\index[general]{Pruning!Automatic!Example}` -:raw-latex:`\index[general]{Recycle!Automatic!Example}` +:index:`pair: ` +:index:`pair: ` +:index:`triple: ` +:index:`triple: ` Perhaps the best way to understand the various resource records that come into play during automatic pruning and recycling is to run a Job @@ -741,8 +741,8 @@ comment out the **Schedule** record in the **Job** resource. Manually Recycling Volumes -------------------------- -:raw-latex:`\index[general]{Volume!Recycle!Manual}` -:raw-latex:`\index[general]{Recycle!Manual}` +:index:`triple: ` +:index:`pair: ` Although automatic recycling of Volumes is implemented (see the :ref:`RecyclingChapter` chapter of this manual), you may diff --git a/docs/manuals/en/new_main_reference/source/releasenotes.rst b/docs/manuals/en/new_main_reference/source/releasenotes.rst index 8e130ac6de3..2d206005ffb 100644 --- a/docs/manuals/en/new_main_reference/source/releasenotes.rst +++ b/docs/manuals/en/new_main_reference/source/releasenotes.rst @@ -1,6 +1,6 @@ -.. _`releasenotes}` :raw-latex:`\index[general]{Releases`: releasenotes}` :raw-latex:`\index[general]{Releases +.. _`releasenotes}` :index:`Releases`: releasenotes` :raw-latex:`\index[general]{Releases The technical changelog is automatically generated from the Bareos bug tracking system, see ``http://bugs.bareos.org/changelog_page.php``. diff --git a/docs/manuals/en/new_main_reference/source/requirements.rst b/docs/manuals/en/new_main_reference/source/requirements.rst index 95a4177537c..d146ccb6294 100644 --- a/docs/manuals/en/new_main_reference/source/requirements.rst +++ b/docs/manuals/en/new_main_reference/source/requirements.rst @@ -3,8 +3,8 @@ System Requirements =================== -:raw-latex:`\index[general]{System Requirements}` -:raw-latex:`\index[general]{Requirements!System}` +:index:`System Requirements` +:index:`pair: ` - The minimum versions for each of the databases supported by Bareos are: @@ -28,8 +28,8 @@ System Requirements - Jansson library: .. _`jansson`: jansson - :raw-latex:`\index[general]{JSON}` - :raw-latex:`\index[general]{Jansson!\see{JSON}}` Bareos + :index:`JSON` + :index:`pair: ` Bareos :raw-latex:`\sinceVersion{dir}{requires!jansson}{15.2.0}` offers a JSON API mode, see :raw-latex:`\bareosDeveloperGuideApiModeJson`. On some platform, the Jansson library is directory available. On others diff --git a/docs/manuals/en/new_main_reference/source/rescue.rst b/docs/manuals/en/new_main_reference/source/rescue.rst index 9da9e97b1c3..7f15cd404f5 100644 --- a/docs/manuals/en/new_main_reference/source/rescue.rst +++ b/docs/manuals/en/new_main_reference/source/rescue.rst @@ -3,8 +3,8 @@ Disaster Recovery Using Bareos ============================== -:raw-latex:`\index[general]{Disaster!Recovery}` -:raw-latex:`\index[general]{Recovery!Disaster Recovery}` +:index:`pair: ` +:index:`pair: ` General ------- @@ -43,7 +43,7 @@ that you should take into account before a disaster strikes. Steps to Take Before Disaster Strikes ------------------------------------- -:raw-latex:`\index[general]{Disaster!Before}` +:index:`pair: ` - Create a rescue or CDROM for your systems. Generally, they are offered by each distribution, and there are many good rescue disks on @@ -94,7 +94,7 @@ Generally, following components are required for a Bare Metal Recovery: Linux ~~~~~ -:raw-latex:`\index[general]{Disaster!Recovery!Linux}` +:index:`triple: ` From the Relax-and-Recover web site (`http://relax-and-recover.org `_): @@ -353,7 +353,7 @@ that, ReaR will restore your bootloader. Recovery is complete. Restoring a Bareos Server ------------------------- -:raw-latex:`\index[general]{Restore!Bareos Server}` +:index:`pair: ` .. _`section-RestoreServer`: section-RestoreServer diff --git a/docs/manuals/en/new_main_reference/source/restore.rst b/docs/manuals/en/new_main_reference/source/restore.rst index f899fe34e72..a3c9d2629d3 100644 --- a/docs/manuals/en/new_main_reference/source/restore.rst +++ b/docs/manuals/en/new_main_reference/source/restore.rst @@ -3,7 +3,7 @@ The Restore Command =================== -:raw-latex:`\index[general]{Restore}` +:index:`Restore` General ------- @@ -55,7 +55,7 @@ you to run the job by selecting the **mod** option. The Restore Command ------------------- -:raw-latex:`\index[general]{Console!Command!restore}` +:index:`triple: ` Since Bareos maintains a catalog of your files and on which Volumes (disk or tape), they are stored, it can do most of the bookkeeping work, @@ -192,7 +192,7 @@ details of the above options are: before date (as with item 6). These JobIds will then be retained internally. - :raw-latex:`\index[general]{Restore Directories}` + :index:`Restore Directories` - Item 11 allows you to enter a list of JobIds from which you can select directories to be restored. The list of JobIds can have been @@ -455,7 +455,7 @@ If you now enter **yes**, Bareos will run the restore Job. Selecting Files by Filename --------------------------- -:raw-latex:`\index[general]{Restore!by filename}` +:index:`pair: ` If you have a small number of files to restore, and you know the filenames, you can either put the list of filenames in a file to be read @@ -699,7 +699,7 @@ The full list of possible command line arguments are: Using File Relocation --------------------- -:raw-latex:`\index[general]{File Relocation!using}` +:index:`pair: ` .. _`filerelocation`: filerelocation @@ -807,8 +807,8 @@ Examples Restoring Directory Attributes ------------------------------ -:raw-latex:`\index[general]{Attributes!Restoring Directory}` -:raw-latex:`\index[general]{Restoring Directory Attributes}` +:index:`pair: ` +:index:`Restoring Directory Attributes` Depending how you do the restore, you may or may not get the directory entries back to their original state. Here are a few of the problems you @@ -858,8 +858,8 @@ can encounter, and for same machine restores, how to avoid them. Restoring on Windows -------------------- -:raw-latex:`\index[general]{Restoring on Windows}` -:raw-latex:`\index[general]{Windows!Restoring on}` +:index:`Restoring on Windows` +:index:`pair: ` If you are restoring on Windows systems, Bareos will restore the files with the original ownerships and permissions as would be expected. This @@ -890,8 +890,8 @@ resolves the problem. Restore Errors -------------- -:raw-latex:`\index[general]{Errors!Restore}` -:raw-latex:`\index[general]{Restore Errors}` +:index:`pair: ` +:index:`Restore Errors` There are a number of reasons why there may be restore errors or warning messages. Some of the more common ones are: @@ -922,7 +922,7 @@ file size error Example Restore Job Resource ---------------------------- -:raw-latex:`\index[general]{Resource!Example Restore Job}` +:index:`pair: ` .. raw:: latex @@ -953,8 +953,8 @@ will be their original locations. File Selection Commands ----------------------- -:raw-latex:`\index[general]{Console!File Selection}` -:raw-latex:`\index[general]{File Selection Commands}` +:index:`pair: ` +:index:`File Selection Commands` After you have selected the Jobs to be restored and Bareos has created the in-memory directory tree, you will enter file selection mode as @@ -969,7 +969,7 @@ restore by marking them with the **mark** command. The available commands are: cd - :raw-latex:`\index[general]{Console!File Selection!cd}` The **cd** + :index:`triple: ` The **cd** command changes the current directory to the argument specified. It operates much like the Unix **cd** command. Wildcard specifications are not permitted. @@ -981,28 +981,28 @@ cd the first directory. dir - :raw-latex:`\index[general]{Console!File Selection!dir}` The **dir** + :index:`triple: ` The **dir** command is similar to the **ls** command, except that it prints it in long format (all details). This command can be a bit slower than the **ls** command because it must access the catalog database for the detailed information for each file. estimate - :raw-latex:`\index[general]{Console!File Selection!estimate}` The + :index:`triple: ` The **estimate** command prints a summary of the total files in the tree, how many are marked to be restored, and an estimate of the number of bytes to be restored. This can be useful if you are short on disk space on the machine where the files will be restored. find - :raw-latex:`\index[general]{Console!File Selection!find}` The + :index:`triple: ` The **find** command accepts one or more arguments and displays all files in the tree that match that argument. The argument may have wildcards. It is somewhat similar to the Unix command **find / -name arg**. ls - :raw-latex:`\index[general]{Console!File Selection!ls}` The **ls** + :index:`triple: ` The **ls** command produces a listing of all the files contained in the current directory much like the Unix **ls** command. You may specify an argument containing wildcards, in which case only those files will @@ -1013,13 +1013,13 @@ ls forward slash (**/**) to distinguish them from filenames. lsmark - :raw-latex:`\index[general]{Console!File Selection!lsmark}` The + :index:`triple: ` The **lsmark** command is the same as the **ls** except that it will print only those files marked for extraction. The other distinction is that it will recursively descend into any directory selected. mark - :raw-latex:`\index[general]{Console!File Selection!mark}` The + :index:`triple: ` The **mark** command allows you to mark files to be restored. It takes a single argument which is the filename or directory name in the current directory to be marked for extraction. The argument may be a @@ -1065,7 +1065,7 @@ mark if some files are marked. unmark - :raw-latex:`\index[general]{Console!File Selection!unmark}` The + :index:`triple: ` The **unmark** is identical to the **mark** command, except that it unmarks the specified file or files so that they will not be restored. Note: the **unmark** command works from the current @@ -1074,34 +1074,34 @@ unmark everything. pwd - :raw-latex:`\index[general]{Console!File Selection!pwd}` The **pwd** + :index:`triple: ` The **pwd** command prints the current working directory. It accepts no arguments. count - :raw-latex:`\index[general]{Console!File Selection!count}` The + :index:`triple: ` The **count** command prints the total files in the directory tree and the number of files marked to be restored. done - :raw-latex:`\index[general]{Console!File Selection!done}` This + :index:`triple: ` This command terminates file selection mode. exit - :raw-latex:`\index[general]{Console!File Selection!exit}` This + :index:`triple: ` This command terminates file selection mode (the same as done). quit - :raw-latex:`\index[general]{Console!File Selection!quit}` This + :index:`triple: ` This command terminates the file selection and does not run the restore job. help - :raw-latex:`\index[general]{Console!File Selection!help}` This + :index:`triple: ` This command prints a summary of the commands available. ? - :raw-latex:`\index[general]{Console!File Selection!?}` This command + :index:`triple: ` This command is the same as the **help** command. If your filename contains some weird caracters, you can use ``?``, ``*`` diff --git a/docs/manuals/en/new_main_reference/source/security.rst b/docs/manuals/en/new_main_reference/source/security.rst index 38f4b948466..dce832bb4c7 100644 --- a/docs/manuals/en/new_main_reference/source/security.rst +++ b/docs/manuals/en/new_main_reference/source/security.rst @@ -3,7 +3,7 @@ Bareos Security Issues ====================== -:raw-latex:`\index[general]{Security}` +:index:`Security` - Security means being able to restore your files, so read the :ref:`Critical Items Chapter ` of this manual. @@ -58,9 +58,9 @@ Bareos Security Issues Configuring and Testing TCP Wrappers ------------------------------------ -:raw-latex:`\index[general]{TCP Wrappers}` -:raw-latex:`\index[general]{Wrappers!TCP}` -:raw-latex:`\index[general]{libwrappers}` +:index:`TCP Wrappers` +:index:`pair: ` +:index:`libwrappers` The TCP wrapper functionality is available on different platforms. Be default, it is activated on Bareos for Linux. With this enabled, you may diff --git a/docs/manuals/en/new_main_reference/source/spooling.rst b/docs/manuals/en/new_main_reference/source/spooling.rst index cbe3047e90b..f54200db572 100644 --- a/docs/manuals/en/new_main_reference/source/spooling.rst +++ b/docs/manuals/en/new_main_reference/source/spooling.rst @@ -9,8 +9,8 @@ Data Spooling .. _`section-DataSpooling`: section-DataSpooling -:raw-latex:`\index[general]{Data Spooling}` -:raw-latex:`\index[general]{Spooling!Data}` +:index:`Data Spooling` +:index:`pair: ` Bareos allows you to specify that you want the Storage daemon to initially write your data to disk and then subsequently to tape. This @@ -51,7 +51,7 @@ can use in the spooling process. Data Spooling Directives ------------------------ -:raw-latex:`\index[general]{Data Spooling!Directives}` +:index:`pair: ` The following directives can be used to control data spooling. diff --git a/docs/manuals/en/new_main_reference/source/state.rst b/docs/manuals/en/new_main_reference/source/state.rst index 280824825ab..e834edc81cf 100644 --- a/docs/manuals/en/new_main_reference/source/state.rst +++ b/docs/manuals/en/new_main_reference/source/state.rst @@ -6,7 +6,7 @@ The Current State of Bareos What is Implemented ------------------- -:raw-latex:`\index[general]{Implementation!What is implemented}` +:index:`pair: ` - Job Control @@ -184,7 +184,7 @@ Advantages Over Other Backup Programs Current Implementation Restrictions ----------------------------------- -:raw-latex:`\index[general]{Restrictions!Current Implementation}` +:index:`pair: ` - @@ -207,8 +207,8 @@ Current Implementation Restrictions Design Limitations or Restrictions ---------------------------------- -:raw-latex:`\index[general]{Restrictions!Design Limitations}` -:raw-latex:`\index[general]{Design!Limitations}` +:index:`pair: ` +:index:`pair: ` - Names (resource names, volume names, and such) defined in Bareos configuration files are limited to a fixed number of characters. @@ -233,7 +233,7 @@ Design Limitations or Restrictions Items to Note ------------- -:raw-latex:`\index[general]{Items to Note}` +:index:`Items to Note` - Bareos’s Differential and Incremental *normal* backups are based on time stamps. Consequently, if you move files into an existing diff --git a/docs/manuals/en/new_main_reference/source/storedconf.rst b/docs/manuals/en/new_main_reference/source/storedconf.rst index b336296cb84..e20859fdb24 100644 --- a/docs/manuals/en/new_main_reference/source/storedconf.rst +++ b/docs/manuals/en/new_main_reference/source/storedconf.rst @@ -3,9 +3,9 @@ Storage Daemon Configuration ============================ -:raw-latex:`\index[sd]{Configuration}` -:raw-latex:`\index[general]{Storage Daemon!Configuration}` -:raw-latex:`\index[general]{Configuration!Storage Daemon}` +:index:`Configuration` +:index:`pair: ` +:index:`pair: ` The |bareosSd| configuration file has relatively few resource definitions. However, due to the great variation in backup @@ -46,8 +46,8 @@ Following resources are optional: Storage Resource ---------------- -:raw-latex:`\index[sd]{Resource!Storage}` -:raw-latex:`\index[sd]{Storage!Resource}` +:index:`pair: ` +:index:`pair: ` In general, the properties specified under the Storage resource define global properties of the Storage daemon. Each Storage daemon @@ -73,8 +73,8 @@ The following is a typical Storage daemon storage resource definition. Director Resource ----------------- -:raw-latex:`\index[sd]{Resource!Director}` -:raw-latex:`\index[sd]{Director!Resource}` +:index:`pair: ` +:index:`pair: ` The Director resource specifies the Name of the Director which is permitted to use the services of the Storage daemon. There may be @@ -99,8 +99,8 @@ NDMP Resource .. _`StorageResourceNDMP`: StorageResourceNDMP -:raw-latex:`\index[sd]{Resource!NDMP}` -:raw-latex:`\index[sd]{NDMP!Resource}` +:index:`pair: ` +:index:`pair: ` The NDMP Resource specifies the authentication details of each NDMP client. There may be multiple NDMP resources for a single Storage @@ -112,8 +112,8 @@ are specific to one client. Device Resource --------------- -:raw-latex:`\index[sd]{Resource!Device}` -:raw-latex:`\index[sd]{Device!Resource}` +:index:`pair: ` +:index:`pair: ` The Device Resource specifies the details of each device (normally a tape drive) that can be used by the Storage daemon. There may be @@ -124,8 +124,8 @@ Device. Edit Codes for Mount and Unmount Directives ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -:raw-latex:`\index[general]{Edit Codes for Mount and Unmount Directives}` -:raw-latex:`\index[general]{Mount and Unmount: use variables in directives}` +:index:`Edit Codes for Mount and Unmount Directives` +:index:`Mount and Unmount: use variables in directives` .. _`mountcodes`: mountcodes @@ -154,7 +154,7 @@ substitution of the following characters: Devices that require a mount (USB) ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -:raw-latex:`\index[general]{Devices that require a mount (USB)}` +:index:`Devices that require a mount (USB)` .. raw:: latex @@ -222,8 +222,8 @@ Devices that require a mount (USB) Messages Resource ----------------- -:raw-latex:`\index[general]{Resource!Messages}` -:raw-latex:`\index[general]{Messages!Resource}` +:index:`pair: ` +:index:`pair: ` For a description of the Messages Resource, please see the :ref:`MessagesChapter` chapter of this manual. diff --git a/docs/manuals/en/new_main_reference/source/supportedoses.rst b/docs/manuals/en/new_main_reference/source/supportedoses.rst index b1a897e72be..efbe54b4006 100644 --- a/docs/manuals/en/new_main_reference/source/supportedoses.rst +++ b/docs/manuals/en/new_main_reference/source/supportedoses.rst @@ -203,10 +203,10 @@ required packages where we decided to include them ourselves. Debian.org / Ubuntu Universe ---------------------------- -:raw-latex:`\index[general]{Platform!Debian!Debian.org}` -:raw-latex:`\index[general]{Platform!Debian!8}` -:raw-latex:`\index[general]{Platform!Ubuntu!Universe}` -:raw-latex:`\index[general]{Platform!Ubuntu!Universe!15.04}` +:index:`triple: ` +:index:`triple: ` +:index:`triple: ` +:index:`triple: ` .. _`section-DebianOrg`: section-DebianOrg @@ -240,7 +240,7 @@ Limitations of the Debian.org/Ubuntu Universe version of Bareos Mac OS X -------- -:raw-latex:`\index[general]{Platform!Mac!OS X}` +:index:`triple: ` .. _`section-macosx`: section-macosx @@ -262,7 +262,7 @@ Both packages contain the |bareosFd| and Installing the Bareos Client as PKG ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -:raw-latex:`\index[general]{Installation!MacOS}` +:index:`pair: ` The Bareos installer package for Mac OS X contains the |bareosFd| for Mac OS X 10.5 or later. diff --git a/docs/manuals/en/new_main_reference/source/tables.rst b/docs/manuals/en/new_main_reference/source/tables.rst index f1dc168ba34..14023fedf58 100644 --- a/docs/manuals/en/new_main_reference/source/tables.rst +++ b/docs/manuals/en/new_main_reference/source/tables.rst @@ -1,7 +1,7 @@ Catalog Tables ============== -:raw-latex:`\index[general]{Catalog}` +:index:`Catalog` Bareos stores its information in a database, named Catalog. It is configured by :ref:`DirectorResourceCatalog`. @@ -9,14 +9,14 @@ configured by :ref:`DirectorResourceCatalog`. Job --- -:raw-latex:`\index[general]{Catalog!Job}` -:raw-latex:`\index[general]{Job!Catalog}` +:index:`pair: ` +:index:`pair: ` JobStatus ~~~~~~~~~ -:raw-latex:`\index[general]{Job!JobStatus}` -:raw-latex:`\index[general]{Catalog!Job!JobStatus}` +:index:`pair: ` +:index:`triple: ` The status of a Bareos job is stored as abbreviation in the Catalog database table Job. It is also displayed by some bconsole commands, eg. diff --git a/docs/manuals/en/new_main_reference/source/tape-without-autochanger.rst b/docs/manuals/en/new_main_reference/source/tape-without-autochanger.rst index 554aa499598..4b5abbbe6dd 100644 --- a/docs/manuals/en/new_main_reference/source/tape-without-autochanger.rst +++ b/docs/manuals/en/new_main_reference/source/tape-without-autochanger.rst @@ -3,8 +3,8 @@ Using Tape Drives without Autochanger ===================================== -:raw-latex:`\index[general]{Strategy!Backup}` -:raw-latex:`\index[general]{Backup Strategies}` +:index:`pair: ` +:index:`Backup Strategies` Although Recycling and Backing Up to Disk Volume have been discussed in previous chapters, this chapter is meant to give you an overall view of @@ -16,8 +16,8 @@ disadvantages. Simple One Tape Backup ---------------------- -:raw-latex:`\index[general]{Backup!One Tape}` -:raw-latex:`\index[general]{One Tape Backup}` +:index:`pair: ` +:index:`One Tape Backup` Probably the simplest strategy is to back everything up to a single tape and insert a new (or recycled) tape when it fills and Bareos requests a @@ -68,7 +68,7 @@ month, and incremental backups the rest of the week. Manually Changing Tapes ----------------------- -:raw-latex:`\index[general]{Tape!Manually Changing}` +:index:`pair: ` If you use the strategy presented above, Bareos will ask you to change the tape, and you will **unmount** it and then remount it when you have @@ -142,8 +142,8 @@ are several ways to get Bareos to release the tape: Daily Tape Rotation ------------------- -:raw-latex:`\index[general]{Rotation!Daily Tape}` -:raw-latex:`\index[general]{Daily Tape Rotation}` +:index:`pair: ` +:index:`Daily Tape Rotation` This scheme is quite different from the one mentioned above in that a Full backup is done to a different tape every day of the week. diff --git a/docs/manuals/en/new_main_reference/source/tls.rst b/docs/manuals/en/new_main_reference/source/tls.rst index 7e499a0ecfd..34bb2c9e854 100644 --- a/docs/manuals/en/new_main_reference/source/tls.rst +++ b/docs/manuals/en/new_main_reference/source/tls.rst @@ -6,11 +6,11 @@ Transport Encryption .. _`section-TransportEncryption`: section-TransportEncryption -:raw-latex:`\index[general]{Communications Encryption}` -:raw-latex:`\index[general]{Encryption!Communication}` -:raw-latex:`\index[general]{Encryption!Transport}` -:raw-latex:`\index[general]{Transport Encryption}` -:raw-latex:`\index[general]{TLS}` :raw-latex:`\index[general]{SSL}` +:index:`Communications Encryption` +:index:`pair: ` +:index:`pair: ` +:index:`Transport Encryption` +:index:`TLS}` :raw-latex:`\index[general]{SSL` Bareos TLS (Transport Layer Security) is built-in network encryption code to provide secure network transport similar to that offered by @@ -154,8 +154,8 @@ easily manage your own CA with a Graphical User Interface. Example TLS Configuration Files ------------------------------- -:raw-latex:`\index[general]{Example!TLS Configuration Files}` -:raw-latex:`\index[general]{TLS Configuration Files}` +:index:`pair: ` +:index:`TLS Configuration Files` An example of the TLS portions of the configuration files are listed below. diff --git a/docs/manuals/en/new_main_reference/source/troubleshooting.rst b/docs/manuals/en/new_main_reference/source/troubleshooting.rst index 6af9f899253..8e59d142404 100644 --- a/docs/manuals/en/new_main_reference/source/troubleshooting.rst +++ b/docs/manuals/en/new_main_reference/source/troubleshooting.rst @@ -12,7 +12,7 @@ chapter about how to enable them. Client Access Problems ====================== -:raw-latex:`\index[general]{Problem!Cannot Access a Client}` There are +:index:`pair: ` There are several reasons why a |bareosDir| could not contact a client on a different machine. They are: @@ -43,7 +43,7 @@ or as :ref:`PassiveClient`. Difficulties Connecting from the FD to the SD --------------------------------------------- -:raw-latex:`\index[general]{Problem!Connecting from the FD to the SD}` +:index:`pair: ` If you are having difficulties getting one or more of your File daemons to connect to the Storage daemon, it is most likely because you have not @@ -81,8 +81,8 @@ SD communications in Bareos). Authorization Errors -------------------- -:raw-latex:`\index[general]{Problem!Authorization Errors}` -:raw-latex:`\index[general]{Concurrent Jobs}` +:index:`pair: ` +:index:`Concurrent Jobs` .. _`AuthorizationErrors`: AuthorizationErrors @@ -137,9 +137,9 @@ Bareos component will reject all new connections. Concurrent Jobs =============== -:raw-latex:`\index[general]{Job!Concurrent Jobs}` -:raw-latex:`\index[general]{Running Concurrent Jobs}` -:raw-latex:`\index[general]{Concurrent Jobs}` +:index:`pair: ` +:index:`Running Concurrent Jobs` +:index:`Concurrent Jobs` Bareos can run multiple concurrent jobs. Using the :raw-latex:`\configdirective{Maximum Concurrent Jobs}` directives, you @@ -259,8 +259,8 @@ the normal case. Media VolWrites: integer out of range ===================================== -:raw-latex:`\index[general]{Errors!integer out of range}` -:raw-latex:`\index[general]{Catalog!Media!VolWrites}` +:index:`pair: ` +:index:`triple: ` In some situation, you receive an error message similar to this: @@ -314,7 +314,7 @@ storing much larger numbers. Tape Drive ========== -:raw-latex:`\index[general]{Problem!Tape}` +:index:`pair: ` Autochanger =========== @@ -327,11 +327,11 @@ Testing Autochanger and Adapting mtx-changer script .. _`section-MtxChangerManualUsage`: section-MtxChangerManualUsage -:raw-latex:`\index[general]{Autochanger!Testing}` -:raw-latex:`\index[general]{Autochanger!mtx-changer}` -:raw-latex:`\index[general]{Command!mtx-changer}` -:raw-latex:`\index[general]{Problem!Autochanger}` -:raw-latex:`\index[general]{Problem!mtx-changer}` +:index:`pair: ` +:index:`pair: ` +:index:`pair: ` +:index:`pair: ` +:index:`pair: ` In case, Bareos does not work well with the Autochanger, it is preferable to "hand-test" that the changer works. To do so, we suggest @@ -343,7 +343,7 @@ Make sure Bareos is not running. \command{/usr/lib/bareos/scripts/mtx-changer /dev/sg0 list 0 /dev/nst0 0} -:raw-latex:`\index[sd]{mtx-changer list}` +:index:`mtx-changer list` This command should print: @@ -374,7 +374,7 @@ systems, the autochanger SCSI control device is generally \command{/usr/lib/bareos/scripts/mtx-changer /dev/sg0 listall 0 /dev/nst0 0} -:raw-latex:`\index[sd]{mtx-changer listall}` +:index:`mtx-changer listall` This command should print: @@ -407,7 +407,7 @@ This command should print: \command{/usr/lib/bareos/scripts/mtx-changer /dev/sg0 transfer 1 2} -:raw-latex:`\index[sd]{mtx-changer listall}` +:index:`mtx-changer listall` This command should transfer a volume from source (1) to destination (2) @@ -415,7 +415,7 @@ This command should transfer a volume from source (1) to destination (2) \command{/usr/lib/bareos/scripts/mtx-changer /dev/sg0 slots} -:raw-latex:`\index[sd]{mtx-changer slots}` +:index:`mtx-changer slots` This command should return the number of slots in your autochanger. @@ -423,7 +423,7 @@ This command should return the number of slots in your autochanger. \command{/usr/lib/bareos/scripts/mtx-changer /dev/sg0 unload 1 /dev/nst0 0} -:raw-latex:`\index[sd]{mtx-changer unload}` +:index:`mtx-changer unload` If a tape is loaded from slot 1, this should cause it to be unloaded. @@ -431,7 +431,7 @@ If a tape is loaded from slot 1, this should cause it to be unloaded. \command{/usr/lib/bareos/scripts/mtx-changer /dev/sg0 load 3 /dev/nst0 0} -:raw-latex:`\index[sd]{mtx-changer load}` +:index:`mtx-changer load` Assuming you have a tape in slot 3, it will be loaded into drive (0). @@ -439,7 +439,7 @@ Assuming you have a tape in slot 3, it will be loaded into drive (0). \command{/usr/lib/bareos/scripts/mtx-changer /dev/sg0 loaded 0 /dev/nst0 0} -:raw-latex:`\index[sd]{mtx-changer loaded}` +:index:`mtx-changer loaded` It should print "3" Note, we have used an "illegal" slot number 0. In this case, it is simply ignored because the slot number is not used. @@ -450,7 +450,7 @@ the command is needed to select the correct drive. \command{/usr/lib/bareos/scripts/mtx-changer /dev/sg0 unload 3 /dev/nst0 0} -:raw-latex:`\index[sd]{mtx-changer unload}` +:index:`mtx-changer unload` will unload the tape into slot 3. @@ -523,9 +523,9 @@ Restore Restore a pruned job using a pattern ------------------------------------ -:raw-latex:`\index[general]{Restore!pruned job}` -:raw-latex:`\index[general]{Problem!Restore!pruned job}` -:raw-latex:`\index[general]{Regex}` +:index:`pair: ` +:index:`triple: ` +:index:`Regex` It is possible to configure Bareos in a way, that job information are still stored in the Bareos catalog, while the individual file @@ -554,10 +554,10 @@ information. Problems Restoring Files ------------------------ -:raw-latex:`\index[general]{Restore!Files!Problem}` -:raw-latex:`\index[general]{Problem!Restoring Files}` -:raw-latex:`\index[general]{Problem!Tape!fixed mode}` -:raw-latex:`\index[general]{Problem!Tape!variable mode}` +:index:`triple: ` +:index:`pair: ` +:index:`triple: ` +:index:`triple: ` The most frequent problems users have restoring files are error messages such as: @@ -631,8 +631,8 @@ resource to what it is now after each individual test: Restoring Files Can Be Slow --------------------------- -:raw-latex:`\index[general]{Restore!slow}` -:raw-latex:`\index[general]{Problem!Restore!slow}` +:index:`pair: ` +:index:`triple: ` Restoring files is generally **much** slower than backing them up for several reasons. The first is that during a backup the tape is normally @@ -659,10 +659,10 @@ than backing up (sometimes it takes three times as long). Restoring When Things Go Wrong ------------------------------ -:raw-latex:`\index[general]{Catalog!Restore}` -:raw-latex:`\index[general]{Restore!Catalog}` -:raw-latex:`\index[general]{Disaster!Recovery!Catalog}` -:raw-latex:`\index[general]{Problem!Repair Catalog}` +:index:`pair: ` +:index:`pair: ` +:index:`triple: ` +:index:`pair: ` This and the following sections will try to present a few of the kinds of problems that can come up making restoring more difficult. We will diff --git a/docs/manuals/en/new_main_reference/source/tutorial.rst b/docs/manuals/en/new_main_reference/source/tutorial.rst index 4e567219ff2..4a8528d614d 100644 --- a/docs/manuals/en/new_main_reference/source/tutorial.rst +++ b/docs/manuals/en/new_main_reference/source/tutorial.rst @@ -3,7 +3,7 @@ Tutorial ======== -:raw-latex:`\index[general]{Tutorial}` +:index:`Tutorial` This chapter will guide you through running Bareos. To do so, we assume you have installed Bareos. However, we assume that you have not modified @@ -57,8 +57,8 @@ For installing Bareos, follow the instructions from the Starting the Daemons -------------------- -:raw-latex:`\index[general]{Starting the Daemons}` -:raw-latex:`\index[general]{Daemon!Start}` +:index:`Starting the Daemons` +:index:`pair: ` Assuming you have installed the packages, to start the three daemons, from your installation directory, simply enter: @@ -161,8 +161,8 @@ Details of the console program’s commands are explained in the Running a Job ------------- -:raw-latex:`\index[general]{Job!Running a}` -:raw-latex:`\index[general]{Running a Job}` +:index:`pair: ` +:index:`Running a Job` At this point, we assume you have done the following: @@ -469,8 +469,8 @@ read the following section. Restoring Your Files -------------------- -:raw-latex:`\index[general]{Files!Restoring Your}` -:raw-latex:`\index[general]{Restoring Your Files}` +:index:`pair: ` +:index:`Restoring Your Files` If you have run the default configuration and run the job as demonstrated above, you can restore the backed up files in the Console @@ -697,8 +697,8 @@ with: Quitting the Console Program ---------------------------- -:raw-latex:`\index[general]{Program!Quitting the Console}` -:raw-latex:`\index[general]{Quitting the Console Program}` +:index:`pair: ` +:index:`Quitting the Console Program` Simply enter the command :raw-latex:`\bcommand{quit}{}`. @@ -710,8 +710,8 @@ Adding a Client .. _`section-AddAClient`: section-AddAClient -:raw-latex:`\index[general]{Client!Adding a Second}` -:raw-latex:`\index[general]{Adding a Client}` +:index:`pair: ` +:index:`Adding a Client` If you have gotten the example shown above to work on your system, you may be ready to add a second Client (|bareosFd|). That is @@ -1014,7 +1014,7 @@ access it. Pools ----- -:raw-latex:`\index[general]{Pool!Overview}` +:index:`pair: ` Creating the Pool is automatically done when the |bareosDir| starts, so if you understand Pools, you can skip @@ -1059,7 +1059,7 @@ been recorded in the catalog. You can verify this by entering: Other Useful Console Commands ----------------------------- -:raw-latex:`\index[general]{Console!Commands!Useful}` +:index:`triple: ` help Show the list all all available commands. @@ -1069,53 +1069,53 @@ help list command :raw-latex:`\bcommand{list}{}`. status dir - :raw-latex:`\index[general]{Console!Command!status dir}` Print a + :index:`triple: ` Print a status of all running jobs and jobs scheduled in the next 24 hours. status - :raw-latex:`\index[general]{Console!Command!status}` The console + :index:`triple: ` The console program will prompt you to select a daemon type, then will request the daemon’s status. status jobid=nn - :raw-latex:`\index[general]{Console!Command!status jobid}` Print a + :index:`triple: ` Print a status of JobId nn if it is running. The Storage daemon is contacted and requested to print a current status of the job as well. list pools - :raw-latex:`\index[general]{Console!Command!list pools}` List the + :index:`triple: ` List the pools defined in the Catalog (normally only Default is used). list volumes - :raw-latex:`\index[general]{Console!Command!list volumes}` Lists all + :index:`triple: ` Lists all the media defined in the Catalog. list jobs - :raw-latex:`\index[general]{Console!Command!list jobs}` Lists all + :index:`triple: ` Lists all jobs in the Catalog that have run. list jobid=nn - :raw-latex:`\index[general]{Console!Command!list jobid}` Lists JobId + :index:`triple: ` Lists JobId nn from the Catalog. list jobtotals - :raw-latex:`\index[general]{Console!Command!list jobtotals}` Lists + :index:`triple: ` Lists totals for all jobs in the Catalog. list files jobid=nn - :raw-latex:`\index[general]{Console!Command!list files jobid}` List + :index:`triple: ` List the files that were saved for JobId nn. list jobmedia - :raw-latex:`\index[general]{Console!Command!list jobmedia}` List the + :index:`triple: ` List the media information for each Job run. messages - :raw-latex:`\index[general]{Console!Command!messages}` Prints any + :index:`triple: ` Prints any messages that have been directed to the console. quit - :raw-latex:`\index[general]{Console!Command!quit}` Exit or quit the + :index:`triple: ` Exit or quit the console program. Most of the commands given above, with the exception of **list**, will diff --git a/docs/manuals/en/new_main_reference/source/verify.rst b/docs/manuals/en/new_main_reference/source/verify.rst index 650350baa5c..155de72d247 100644 --- a/docs/manuals/en/new_main_reference/source/verify.rst +++ b/docs/manuals/en/new_main_reference/source/verify.rst @@ -3,8 +3,8 @@ Verify File Integrity with Bareos ================================= -:raw-latex:`\index[general]{Security!Using Bareos to Improve Computer}` -:raw-latex:`\index[general]{Verify!File Integrity}` +:index:`pair: ` +:index:`pair: ` Since Bareos maintains a catalog of files, their attributes, and either SHA1 or MD5 signatures, it can be an ideal tool for improving computer @@ -62,7 +62,7 @@ in the **FileSet** resource of your **Catalog** Jobs. The Details ----------- -:raw-latex:`\index[general]{Verify!Details}` +:index:`pair: ` In the discussion that follows, we will make reference to the Verify Configuration Example that is included below in the **A Verify @@ -124,7 +124,7 @@ none of these files change during normal operation of the system. Running the Verify ------------------ -:raw-latex:`\index[general]{Verify!Running}` +:index:`pair: ` The first thing you will want to do is to run an **InitCatalog** level Verify Job. This will initialize the catalog to contain the file @@ -274,7 +274,7 @@ line. It will run the Verify job against the specified job. What To Do When Differences Are Found ------------------------------------- -:raw-latex:`\index[general]{Verify!Differences}` +:index:`pair: ` If you have setup your messages correctly, you should be notified if there are any differences and exactly what they are. For example, below @@ -381,7 +381,7 @@ additional files that should be monitored. A Verify Configuration Example ------------------------------ -:raw-latex:`\index[general]{Verify!Example}` +:index:`pair: ` .. raw:: latex diff --git a/docs/manuals/en/new_main_reference/source/webui.rst b/docs/manuals/en/new_main_reference/source/webui.rst index ce79522c8eb..e23e81721e3 100644 --- a/docs/manuals/en/new_main_reference/source/webui.rst +++ b/docs/manuals/en/new_main_reference/source/webui.rst @@ -278,7 +278,7 @@ For details, please read :ref:`DirectorResourceProfile`. SELinux ~~~~~~~ -:raw-latex:`\index[general]{SELinux!bareos-webui}` +:index:`pair: ` To use |bareosDir| on a system with SELinux enabled, permission must be given to HTTPD to make network connections: @@ -291,7 +291,7 @@ permission must be given to HTTPD to make network connections: Configure your Apache Webserver ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -:raw-latex:`\index[general]{Apache!bareos-webui}` +:index:`pair: ` .. _`section-webui-apache`: section-webui-apache @@ -311,7 +311,7 @@ Apache webserver manually. Configure your /etc/bareos-webui/directors.ini ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -:raw-latex:`\index[general]{Configuration!WebUI}` +:index:`pair: ` .. _`section-webui-configuration-files`: section-webui-configuration-files @@ -541,7 +541,7 @@ Additional information NGINX ----- -:raw-latex:`\index[general]{nginx!bareos-webui}` +:index:`pair: ` If you prefer to use :raw-latex:`\bareosWebui `on Nginx with php5-fpm instead of Apache, a basic working configuration could look like this: diff --git a/docs/manuals/en/new_main_reference/source/win32.rst b/docs/manuals/en/new_main_reference/source/win32.rst index 89a9202b0ca..3ea53d67578 100644 --- a/docs/manuals/en/new_main_reference/source/win32.rst +++ b/docs/manuals/en/new_main_reference/source/win32.rst @@ -6,8 +6,8 @@ The Windows Version of Bareos .. _`section-windows`: section-windows -:raw-latex:`\index[general]{Platform!Windows}` -:raw-latex:`\index[general]{Windows}` +:index:`pair: ` +:index:`Windows` The Windows version of Bareos is a native Win32 port, but there are very few source code changes to the Unix code, which means that the Windows @@ -35,8 +35,8 @@ Windows Installation .. _`Windows:Configuration:Files`: Windows:Configuration:Files -:raw-latex:`\index[general]{Installation!Windows}` -:raw-latex:`\index[general]{Windows!File Daemon!Installation}` +:index:`pair: ` +:index:`triple: ` Normally, you will install the Windows version of Bareos from the binaries. The :raw-latex:`\name{winbareos}` binary packages are provided @@ -208,8 +208,8 @@ If login is not possible silent installer will abort Dealing with Windows Problems ----------------------------- -:raw-latex:`\index[general]{Problem!Windows}` -:raw-latex:`\index[general]{Windows!Dealing with Problems}` +:index:`pair: ` +:index:`pair: ` Antivirus Program ~~~~~~~~~~~~~~~~~ @@ -248,7 +248,7 @@ you have to use the :program:`bconsole` Windows Compatibility Considerations ------------------------------------ -:raw-latex:`\index[general]{Windows!Compatibility Considerations}` +:index:`pair: ` Exclusively Opened Files ~~~~~~~~~~~~~~~~~~~~~~~~ @@ -279,9 +279,9 @@ Windows Reparse Points \sinceVersion{fd}{Windows!Reparse points}{12.4.5} -:raw-latex:`\index[fd]{Windows!Symbolic links}` -:raw-latex:`\index[fd]{Windows!Junction points}` -:raw-latex:`\index[fd]{Windows!Volume Mount Points (VMP)}` +:index:`pair: ` +:index:`pair: ` +:index:`pair: ` Besides normal files and directories, Windows filesystems also support special files, called "Reparse Points". Bareos can handle the following @@ -403,7 +403,7 @@ FilesNotToBackup Registry Key \sinceVersion{fd}{Windows!FilesNotToBackup}{14.2.0} -:raw-latex:`\index[fd]{Windows!Exclude Files from Backup}` +:index:`pair: ` Windows supports a special Registry Key that specifies the names of the files and directories that backup applications should not backup or @@ -502,8 +502,8 @@ opaque data and not try to do anything special with it. Volume Shadow Copy Service (VSS) -------------------------------- -:raw-latex:`\index[general]{Windows!Volume Shadow Copy Service}` -:raw-latex:`\index[general]{Windows!VSS}` +:index:`pair: ` +:index:`pair: ` .. _`VSS`: VSS @@ -533,8 +533,8 @@ the backup process. VSS can be turned on by placing an -:raw-latex:`\index[dir]{Enable VSS}` -:raw-latex:`\index[general]{VSS!Enable}` +:index:`Enable VSS` +:index:`pair: ` :: @@ -602,10 +602,10 @@ the data handled by that writer. VSS Problems ~~~~~~~~~~~~ -:raw-latex:`\index[general]{Windows!Problem!VSS}` -:raw-latex:`\index[general]{Windows!VSS!Problem}` -:raw-latex:`\index[fd]{Windows!Problem!VSS}` -:raw-latex:`\index[general]{Problem!Windows!VSS}` +:index:`triple: ` +:index:`triple: ` +:index:`triple: ` +:index:`triple: ` If you are experiencing problems such as VSS hanging on MSDE, first try running **vssadmin** to check for problems, then try running @@ -625,8 +625,8 @@ The FD hang problems were reported with **MSDEwriter** when: Windows Firewalls ----------------- -:raw-latex:`\index[general]{Firewall!Windows}` -:raw-latex:`\index[general]{Windows!Firewall}` +:index:`pair: ` +:index:`pair: ` The Windows buildin Firewall is enabled since Windows version WinXP SP2. The Bareos installer opens the required network ports for Bareos. @@ -648,8 +648,8 @@ is listening, you can enter the following command in a shell window: Windows Restore Problems ------------------------ -:raw-latex:`\index[general]{Problem!Windows Restore}` -:raw-latex:`\index[general]{Windows!Restore Problem}` +:index:`pair: ` +:index:`pair: ` Please see the :ref:`section-RestoreOnWindows` chapter for problems that you might encounter doing a restore. @@ -657,8 +657,8 @@ for problems that you might encounter doing a restore. Windows Backup Problems ----------------------- -:raw-latex:`\index[general]{Problem!Windows Backup}` -:raw-latex:`\index[general]{Windows!Backup Problems}` +:index:`pair: ` +:index:`pair: ` If during a Backup, you get the message: **ERR=Access is denied** and you are using the portable option, you should try both adding both the @@ -703,8 +703,8 @@ Thanks to Georger Araujo for the above information. Windows Ownership and Permissions Problems ------------------------------------------ -:raw-latex:`\index[general]{Problem!Windows Ownership and Permissions}` -:raw-latex:`\index[general]{Windows!Ownership and Permissions Problems}` +:index:`pair: ` +:index:`pair: ` If you restore files backed up from Windows to an alternate directory, Bareos may need to create some higher level directories that were not @@ -835,7 +835,7 @@ and Windows Specific Command Line Options ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -:raw-latex:`\index[general]{Windows!File Daemon!Command Line Options}` +:index:`triple: ` These options are not normally seen or used by the user, and are documented here only for information purposes. At the current time, to