docs: (Sphinx) replaces all include:: by toctree:: to reduce the numb…

…er od warnings

Reduced number of sphinx warnings for 1800 to 280.
Also runs the conversion script from LaTex to Sphinx/RST documentation.

docs/manuals/en/new_main_reference/source/appendix-b/supportedoses.rst

@@ -1,6 +1,13 @@
 .. ATTENTION do not edit this file manually.
    It was automatically converted from the corresponding .tex file
 
+.. _SupportedOSes:
+
+Operating Systems
+=================
+
+:index:`[TAG=Systems->Supported Operating Systems] <pair: Systems; Supported Operating Systems>` :index:`[TAG=Support->Operating Systems] <pair: Support; Operating Systems>`
+
 The Bareos project provides and supports packages that have been released at http://download.bareos.org/bareos/release/
 
 However, the following tabular gives an overview, what components are expected on which platforms to run:
@@ -148,7 +155,7 @@ True64
 .. _section-packages:
 
 Packages for the different Linux platforms
-------------------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 The following tables summarize what packages are available for the different Linux platforms.
 
@@ -165,7 +172,7 @@ Packages names not containing the word **bareos** are required packages where we
 
 
 Debian.org / Ubuntu Universe
-----------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 :index:`[TAG=Platform->Debian->Debian.org] <triple: Platform; Debian; Debian.org>` :index:`[TAG=Platform->Debian->8] <triple: Platform; Debian; 8>` :index:`[TAG=Platform->Ubuntu->Universe] <triple: Platform; Ubuntu; Universe>` \index[general]{Platform!Ubuntu!Universe!15.04} 
 
@@ -180,14 +187,14 @@ In the further text, these version will be named **Bareos (Debian.org)** (also f
 .. _section-DebianOrgLimitations:
 
 Limitations of the Debian.org/Ubuntu Universe version of Bareos
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 -  Debian.org does not include the libfastlz compression library and therefore the Bareos (Debian.org) packages do not offer the fileset options ``compression=LZFAST``, ``compression=LZ4`` and ``compression=LZ4HC``.
 
 -  Debian.org does not include the **bareos-webui** package.
 
 Mac OS X
---------
+~~~~~~~~
 
 :index:`[TAG=Platform->Mac->OS X] <triple: Platform; Mac; OS X>` 
 
@@ -206,7 +213,7 @@ However, you have to choose upfront, which client you want to use. Otherwise con
 Both packages contain the |bareosFd| and :command:`bconsole`.
 
 Installing the Bareos Client as PKG
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 :index:`[TAG=Installation->MacOS] <pair: Installation; MacOS>`
 
@@ -221,7 +228,7 @@ Find the .pkg you just downloaded. Install the .pkg by holding the CTRL key, lef
 Follow the directions given to you and finish the installation.
 
 Configuration
-~~~~~~~~~~~~~
+^^^^^^^^^^^^^
 
 To make use of your |bareosFd| on your system, it is required to configure the |bareosDir| and the local |bareosFd|.
 
@@ -230,8 +237,7 @@ Configure the server-side by follow the instructions at :ref:`section-AddAClient
 After configuring the server-side you can either transfer the necessary configuration file using following command or configure the client locally.
 
 Option 1: Copy the director resource from the Bareos Director to the Client
-"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
-
+'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
 
 Assuming your client has the DNS entry :strong:`client2.example.com` and has been added to |bareosDir| as **client2-fd**:sup:`bareos-dir`:sub:`client` :
 
@@ -242,8 +248,7 @@ Assuming your client has the DNS entry :strong:`client2.example.com` and has bee
 This differs in so far, as on Linux the configuration files are located under :file:`/etc/bareos/`, while on MacOS they are located at :file:`/usr/local/etc/bareos/`.
 
 Option 2: Edit the director resource on the Client
-""""""""""""""""""""""""""""""""""""""""""""""""""
-
+''''''''''''''''''''''''''''''''''''''''''''''''''
 
 Alternatively, you can edit the file :file:`/usr/local/etc/bareos/bareos-fd.d/director/bareos-dir.conf`.
 
@@ -276,7 +281,7 @@ Set this client-side password to the same value as given on the server-side.
    The configuration file contains passwords and therefore must not be accessible for any users except admin users.
 
 Restart bareos-fd after changing the configuration
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 The bareos-fd must be restarted to reread its configuration:
 
@@ -287,7 +292,7 @@ The bareos-fd must be restarted to reread its configuration:
    sudo launchctl start org.bareos.bareos-fd
 
 Verify that the Bareos File Daemon is working
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Open the :command:`bconsole` on your |bareosDir| and check the status of the client with
 

docs/manuals/en/new_main_reference/source/appendix-h/howto.rst

@@ -1,10 +1,13 @@
 .. ATTENTION do not edit this file manually.
    It was automatically converted from the corresponding .tex file
 
+Howtos
+======
+
 .. _dummydevice:
 
 Use a dummy device to test the backup
-=====================================
+-------------------------------------
 
 
 
@@ -31,7 +34,7 @@ Obviously, it can not be used to do a restore.
    }
 
 Backup Of Third Party Databases
-===============================
+-------------------------------
 
 :index:`[TAG=Backup->of Third Party Databases] <pair: Backup; of Third Party Databases>` :index:`[TAG=Database->Backup Of Third Party] <pair: Database; Backup Of Third Party>` 
 
@@ -44,7 +47,7 @@ If you are running a database in production mode on your machine, Bareos will ha
 The best solution is to shutdown your database before backing it up, or use some tool specific to your database to make a valid live copy perhaps by dumping the database in ASCII format.
 
 Backup of MSSQL Databases with Bareos Plugin
---------------------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 :index:`[TAG=MSSQL Backup] <single: MSSQL Backup>` :index:`[TAG=Database->MSSQL] <pair: Database; MSSQL>` :index:`[TAG=Plugin->MSSQL backup] <pair: Plugin; MSSQL backup>` 
 
@@ -55,7 +58,7 @@ Backup of MSSQL Databases with Bareos Plugin
 :index:`Version >= 13.2.0 <pair: bareos-13.2.0; MSSQL>`
 
 Preparation
-~~~~~~~~~~~
+^^^^^^^^^^^
 
 If you like to use the MSSQL-Plugin to backing up your Databases you need to consider some things:
 
@@ -88,17 +91,17 @@ There is no difference for the rights and roles between using a systemaccount (t
 .. _MssqlPluginInstallation:
 
 MSSQL Plugin Installation
-~~~~~~~~~~~~~~~~~~~~~~~~~
+^^^^^^^^^^^^^^^^^^^^^^^^^
 
 For Bareos < 14.2, install the Bareos MSSQL plugin onto the MSSQL server you want to backup. Bareos >= 14.2 also allows to backup remote MSSQL servers (option ``serveraddress``).
 
 Bareos Windows-Installer
-^^^^^^^^^^^^^^^^^^^^^^^^
+''''''''''''''''''''''''
 
 Install the Bareos filedaemon including the component "Bareos FileDameon Plugins". Make sure, that you install the file daemon without the "compatible" option.
 
 Manual install
-^^^^^^^^^^^^^^
+''''''''''''''
 
 After downloading the plugin you need to copy it into :file:`C:\Program Files\Bareos\Plugins`. Then you need to define the plugin directory and which plugin the bareos-filedaemon should use. You have to edit the bareos-filedaemon resource in :file:`C:\Program Data\bareos-fd.conf` as follows:
 
@@ -117,7 +120,7 @@ After downloading the plugin you need to copy it into :file:`C:\Program Files\Ba
    }
 
 Plugin Test
-~~~~~~~~~~~
+^^^^^^^^^^^
 
 .. code-block:: sh
    :caption: status client=mssqlserver-fd
@@ -155,7 +158,7 @@ Plugin Test
      log sequence number: 'lsn:15000000040000037'
 
 Configure the FileSet
-~~~~~~~~~~~~~~~~~~~~~
+^^^^^^^^^^^^^^^^^^^^^
 
 To use the plugin you need to configure it in the fileset as a plugin resource. For each database instance you need to define a exclusive backup job and fileset.
 
@@ -197,7 +200,7 @@ It is recommend to define an additional restore job.
 For every database separate job and FileSet are required.
 
 Run Backups
-~~~~~~~~~~~
+^^^^^^^^^^^
 
 Here you can see an example for a backup:
 
@@ -304,7 +307,7 @@ Incremental FileSet example:
 
 
 Restores
-~~~~~~~~
+^^^^^^^^
 
 If you want to perfom a restore of a full backup without differentials or incrementals you have some options which helps you to restore even the corrupted database still exist. But you have to specifiy the options like plugin, instance and database during every backup.
 
@@ -460,7 +463,7 @@ Example for a full restore:
      Termination:            Restore OK
 
 Restore a Backup Chain
-^^^^^^^^^^^^^^^^^^^^^^
+''''''''''''''''''''''
 
 If you like to restore a specific state or a whole chain consists of full, incremental and differential backups you need to use the "norecovery=yes" option. After this the database is in "recovery mode". You can also use a option which put the database right after the restore back into the right mode. If you like to restore certains point with protocols or "LSN" it it not recommend to work with this option.
 
@@ -630,7 +633,7 @@ Followed is a example for a restore of full, differential and incremental backup
      Termination:            Restore OK
 
 Backup of a PostgreSQL Database
--------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 :index:`[TAG=PostgreSQL->Backup] <pair: PostgreSQL; Backup>` :index:`[TAG=Database->PostgreSQL->Backup] <triple: Database; PostgreSQL; Backup>` 
 
@@ -641,7 +644,7 @@ Backup of a PostgreSQL Database
 In this section, we describe different methods how to do backups of the PostgreSQL databases.
 
 Backup of a PostgreSQL Database by using the RunScript directive
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 :index:`[TAG=RunScript->Example] <pair: RunScript; Example>`
 
@@ -691,7 +694,7 @@ This can be done by using **Run Script**:sup:`Dir`:sub:`Job`\  directives inside
 Note that redirecting the :command:`pg_dumpall` output to a file requires to run the whole command line through a shell, otherwise the :command:`pg_dumpall` would not know what do with the :command:`>` character and the job would fail. As no shell features like redirection or piping are used for the :command:`rm`, the :command:`sh -c` is not needed there. See **Run Script**:sup:`Dir`:sub:`Job`\  for more details.
 
 Backup of a PostgreSQL Databases by using the bpipe plugin
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 :index:`[TAG=bpipe->PostgreSQL backup] <pair: bpipe; PostgreSQL backup>`
 
@@ -731,7 +734,7 @@ This can also be used, to backup a database that is running on a remote host:
    }
 
 Backup of a PostgreSQL Databases by using the PGSQL-Plugin
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 :index:`[TAG=Plugin->PostgreSQL Backup] <pair: Plugin; PostgreSQL Backup>` 
 
@@ -746,7 +749,7 @@ Database recovery is performed fully automatic with dedicated pgsql-restore util
 For a full description, see https://github.com/bareos/contrib-pgsql-plugin/wiki.
 
 Backup of a MySQL Database
---------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 :index:`[TAG=MySQL->Backup] <pair: MySQL; Backup>` :index:`[TAG=Database->MySQL->Backup] <triple: Database; MySQL; Backup>` 
 
@@ -757,7 +760,7 @@ Backup of a MySQL Database
 In this section, we describe different methods to do a full backup of a MySQL database.
 
 Backup of MySQL Databases using the Bareos MySQL Percona xtrabackup Plugin
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 :index:`[TAG=Plugin->MySQL Backup] <pair: Plugin; MySQL Backup>` :index:`[TAG=Percona xtrabackup] <single: Percona xtrabackup>` :index:`[TAG=xtrabackup] <single: xtrabackup>` 
 
@@ -769,7 +772,7 @@ This plugin is available since :index:`Version >= 16.2.4 <pair: bareos-16.2.4; M
 :ref:`backup-mysql-python` is the easier way.
 
 Prerequisites
-^^^^^^^^^^^^^
+'''''''''''''
 
 Install the xtrabackup tool from Percona. Documentation and packages are available here: https://www.percona.com/software/mysql-database/percona-xtrabackup. The plugin was successfully tested with xtrabackup versions 2.3.5 and 2.4.4.
 
@@ -778,12 +781,12 @@ As it is a Python plugin, it will also require to have the package **bareos-file
 For authentication the :file:`.mycnf` file of the user running the |bareosFd|. Before proceeding, make sure that xtrabackup can connect to the database and create backups.
 
 Installation
-^^^^^^^^^^^^
+''''''''''''
 
 Make sure you have met the prerequisites. Install the files :file:`BareosFdPercona.py` and :file:`bareos-fd-percona.py` in your Bareos plugin directory (usually :file:`/usr/lib64/bareos/plugins`). These files are available in the Git repository https://github.com/bareos/bareos-contrib/tree/master/fd-plugins/bareos_percona.
 
 Configuration
-^^^^^^^^^^^^^
+'''''''''''''
 
 Activate your plugin directory in the |bareosFd| configuration. See :ref:`fdPlugins` for more about plugins in general.
 
@@ -829,7 +832,7 @@ You can append options to the plugin call as key=value pairs, separated by ’:
 -  ``strictIncremental``: By default (false), an incremental backup will create data, even if the Log Sequence Number (LSN) wasn’t increased since last backup. This is to ensure, that eventual changes to MYISAM tables get into the backup. MYISAM does not support incremental backups, you will always get a full bakcup of these tables. If set to true, no data will be written into backup, if the LSN wasn’t changed.
 
 Restore
-^^^^^^^
+'''''''
 
 With the usual Bareos restore mechanism a file-hierarchy will be created on the restore client under the default restore location:
 
@@ -855,7 +858,7 @@ Next line is the first incremental job with ID 335, starting at LSN 10129154 unt
 To further prepare the restored files, use the :command:`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
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 :index:`[TAG=Plugin->MySQL Backup] <pair: Plugin; MySQL Backup>` 
 
@@ -931,7 +934,7 @@ mysqlpassword
 On restore, the database dumps are restored to the subdirectory :file:`_mysqlbackups_` in the restore path. The database restore must be triggered manually (:command:`mysql < _mysqlbackups_/DATABASENAME.sql`).
 
 Backup of a MySQL Database by using the RunScript directive
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 :index:`[TAG=RunScript->Example] <pair: RunScript; Example>`
 
@@ -981,7 +984,7 @@ This can be done by using **Run Script**:sup:`Dir`:sub:`Job`\  directives, for e
 Note that redirecting the :command:`mysqldump` output to a file requires to run the whole command line through a shell, otherwise the :command:`mysqldump` would not know what do with the :command:`>` character and the job would fail. As no shell features like redirection or piping are used for the :command:`rm`, the :command:`sh -c` is not needed there. See **Run Script**:sup:`Dir`:sub:`Job`\  for more details.
 
 Backup of a MySQL Database by using the bpipe plugin
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 :index:`[TAG=bpipe->MySQL backup] <pair: bpipe; MySQL backup>`
 
@@ -1045,14 +1048,14 @@ A very simple corresponding shell script (:command:`bpipe-restore.sh`) to the me
 .. _section-StatisticCollection:
 
 Statistics Collection
-=====================
+---------------------
 
 Statistics Collection can be controlled by a number of configuration directives. If Statistics Collection is enabled, statistics are collected by the |bareosDir| and stored into the Catalog database. So enabling this feature will increase your database size.
 
 The Statistics are used by the |bareosWebui| to show the status of a running job. :index:`[TAG=Webui->Configure Statistics Collection] <pair: Webui; Configure Statistics Collection>`
 
 Director Configuration - Director Resource Directives
------------------------------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 -  
 
@@ -1063,14 +1066,14 @@ Director Configuration - Director Resource Directives
    **Statistics Retention**:sup:`Dir`:sub:`Director`\ 
 
 Director Configuration - Storage Resource Directives
-----------------------------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 -  
 
    **Collect Statistics**:sup:`Dir`:sub:`Storage`\ 
 
 Storage Configuration - Storage Resource Directives
----------------------------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 -  
 
@@ -1085,7 +1088,7 @@ Storage Configuration - Storage Resource Directives
    **Statistics Collect Interval**:sup:`Sd`:sub:`Storage`\ 
 
 Storage Configuration - Device Resource Directives
---------------------------------------------------
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 -