Skip to content

Commit

Permalink
docs: (Sphinx) update doc by running auto conversion script
Browse files Browse the repository at this point in the history
This time also all the configuration directive descripted converted from Latex have been added.
  • Loading branch information
joergsteffens committed Feb 28, 2019
1 parent e3e1eab commit 35578c9
Show file tree
Hide file tree
Showing 1,321 changed files with 2,865 additions and 258 deletions.
Expand Up @@ -117,13 +117,13 @@ Parameter
Specifying the Configuration
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Each of the utilities that deal with Volumes require a valid |bareosSd| configuration (actually, the only part of the configuration file that these programs need is the :sup:`Sd`\ :strong:`Device` resource definitions). This permits the programs to find the configuration parameters for your **Archive Device**:sup:`Sd`:sub:`Device`\ . Using the ``-c`` option a custom |bareosSd| configuration file or directory can be
Each of the utilities that deal with Volumes require a valid |bareosSd| configuration (actually, the only part of the configuration file that these programs need is the :sup:`Sd`\ :strong:`Device` resource definitions). This permits the programs to find the configuration parameters for your :config:option:`sd/device/ArchiveDevice`\ . Using the ``-c`` option a custom |bareosSd| configuration file or directory can be
selected.

Specifying a Device
^^^^^^^^^^^^^^^^^^^

Each of these programs require a ``device-name`` where the Volume can be found. The device-name is either the name of the |bareosSd| device (**Name**:sup:`Sd`:sub:`Device`\ ) or its **Archive Device**:sup:`Sd`:sub:`Device`\ .
Each of these programs require a ``device-name`` where the Volume can be found. The device-name is either the name of the |bareosSd| device (:config:option:`sd/device/Name`\ ) or its :config:option:`sd/device/ArchiveDevice`\ .

Specifying a Device Name For a Tape
'''''''''''''''''''''''''''''''''''
Expand All @@ -144,7 +144,7 @@ In the case of a tape, this is the physical device name such as /dev/nst0 or /de
Specifying a Device Name For a File
'''''''''''''''''''''''''''''''''''

If you are attempting to read or write an archive file rather than a tape, the ``device-name`` can be the full path to the archive location specified at **Archive Device**:sup:`Sd`:sub:`Device`\ or this including the filename of the volume. The filename (last part of the specification) will be stripped and used as the Volume name So, the path is equivalent to the **Archive Device**:sup:`Sd`:sub:`Device`\ and the filename is
If you are attempting to read or write an archive file rather than a tape, the ``device-name`` can be the full path to the archive location specified at :config:option:`sd/device/ArchiveDevice`\ or this including the filename of the volume. The filename (last part of the specification) will be stripped and used as the Volume name So, the path is equivalent to the :config:option:`sd/device/ArchiveDevice`\ and the filename is
equivalent to the volume name.

Specifying Volumes
Expand Down Expand Up @@ -224,7 +224,7 @@ or
Specifying Maximum Block Size
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

If you use Bareos with non-default block sizes defined in the pools (**Maximum Block Size**:sup:`Dir`:sub:`Pool`\ ), it might be necessary to specify the **Maximum Block Size**:sup:`Sd`:sub:`Device`\ also in the storage device resource, see :ref:`Direct access to Volumes with non-default blocksizes <direct-access-to-volumes-with-non-default-blocksizes>`.
If you use Bareos with non-default block sizes defined in the pools (:config:option:`dir/pool/MaximumBlockSize`\ ), it might be necessary to specify the :config:option:`sd/device/MaximumBlockSize`\ also in the storage device resource, see :ref:`Direct access to Volumes with non-default blocksizes <direct-access-to-volumes-with-non-default-blocksizes>`.

bls
~~~
Expand Down Expand Up @@ -908,7 +908,7 @@ To determine the best configuration of your tape drive, you can run the new ``sp

This command can have the following arguments:

- Specify the **Maximum File Size**:sup:`Sd`:sub:`Device`\ for this test. This counter is in GB.
- Specify the :config:option:`sd/device/MaximumFileSize`\ for this test. This counter is in GB.

- Specify the number of file to be written. The amount of data should be greater than your memory (file_size :math:`*` nb_file).

Expand Down Expand Up @@ -1044,7 +1044,7 @@ When running :command:`bsmtp` by hand, you will need to terminate the message by
If you are getting incorrect dates (e.g. 1970) and you are running with a non-English language setting, you might try adding a :command:`LANG=C` immediately before the :command:`bsmtp` call.

In general, :command:`bsmtp` attempts to cleanup email addresses that you specify in the from, copy, mailhost, and recipient fields, by adding the necessary < and > characters around the address part. However, if you include a display-name (see RFC 5332), some SMTP servers such as Exchange may not accept the message if the display-name is also included in < and >. As mentioned above, you must test, and if you run into this situation, you may manually add the < and > to the Bareos
**Mail Command**:sup:`Dir`:sub:`Messages`\ or **Operator Command**:sup:`Dir`:sub:`Messages`\ and when :command:`bsmtp` is formatting an address if it already contains a < or > character, it will leave the address unchanged.
:config:option:`dir/messages/MailCommand`\ or :config:option:`dir/messages/OperatorCommand`\ and when :command:`bsmtp` is formatting an address if it already contains a < or > character, it will leave the address unchanged.

bareos-dbcheck
~~~~~~~~~~~~~~
Expand Down
Expand Up @@ -10,7 +10,7 @@ The Bootstrap File

.. TODO: This chapter is going to be rewritten (by Philipp).
The information in this chapter is provided so that you may either create your own bootstrap files, or so that you can edit a bootstrap file produced by Bareos. However, normally the bootstrap file will be automatically created for you during the :strong:`restore` in the Console program, or by using a **Write Bootstrap**:sup:`Dir`:sub:`Job`\ record in your Backup Jobs, and thus you will never need to know the details of this file.
The information in this chapter is provided so that you may either create your own bootstrap files, or so that you can edit a bootstrap file produced by Bareos. However, normally the bootstrap file will be automatically created for you during the :strong:`restore` in the Console program, or by using a :config:option:`dir/job/WriteBootstrap`\ record in your Backup Jobs, and thus you will never need to know the details of this file.

The bootstrap file contains ASCII information that permits precise specification of what files should be restored, what volume they are on, and where they are on the volume. It is a relatively compact form of specifying the information, is human readable, and can be edited with any text editor.

Expand Down
24 changes: 12 additions & 12 deletions docs/manuals/en/new_main_reference/source/appendix-h/howto.rst
Expand Up @@ -650,7 +650,7 @@ Backup of a PostgreSQL Database by using the RunScript directive
One method to backup a PostgreSQL database is to use the :command:`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 overwritten anyway.
This can be done by using **Run Script**:sup:`Dir`:sub:`Job`\ directives inside a Job Resource, for example:
This can be done by using :config:option:`dir/job/RunScript`\ directives inside a Job Resource, for example:
.. code-block:: sh
:caption: RunScript job resource for a PostgreSQL backup
Expand Down Expand Up @@ -691,14 +691,14 @@ 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.
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 :config:option:`dir/job/RunScript`\ for more details.
Backup of a PostgreSQL Databases by using the bpipe plugin
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
:index:`[TAG=bpipe->PostgreSQL backup] <pair: bpipe; PostgreSQL backup>`
Instead of creating a temporary database dump file, the bpipe plugin can be used. For general information about bpipe, see the :ref:`bpipe` section. The bpipe plugin is configured inside the **Include**:sup:`Dir`:sub:`FileSet`\ section of a File Set, e.g.:
Instead of creating a temporary database dump file, the bpipe plugin can be used. For general information about bpipe, see the :ref:`bpipe` section. The bpipe plugin is configured inside the :config:option:`dir/fileset/Include`\ section of a File Set, e.g.:
.. code-block:: sh
:caption: bpipe directive for PostgreSQL backup
Expand Down Expand Up @@ -940,7 +940,7 @@ Backup of a MySQL Database by using the RunScript directive
One method to backup a MySQL database is to use the :command:`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 overwritten anyway.
This can be done by using **Run Script**:sup:`Dir`:sub:`Job`\ directives, for example:
This can be done by using :config:option:`dir/job/RunScript`\ directives, for example:
.. code-block:: sh
:caption: RunScript job resource for a MySQL backup
Expand Down Expand Up @@ -981,7 +981,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.
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 :config:option:`dir/job/RunScript`\ for more details.
Backup of a MySQL Database by using the bpipe plugin
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand Down Expand Up @@ -1059,40 +1059,40 @@ Director Configuration - Director Resource Directives
-
**Statistics Collect Interval**:sup:`Dir`:sub:`Director`\
:config:option:`dir/director/StatisticsCollectInterval`\
-
**Statistics Retention**:sup:`Dir`:sub:`Director`\
:config:option:`dir/director/StatisticsRetention`\
Director Configuration - Storage Resource Directives
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
**Collect Statistics**:sup:`Dir`:sub:`Storage`\
:config:option:`dir/storage/CollectStatistics`\
Storage Configuration - Storage Resource Directives
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
**Collect Device Statistics**:sup:`Sd`:sub:`Storage`\
:config:option:`sd/storage/CollectDeviceStatistics`\
-
**Collect Job Statistics**:sup:`Sd`:sub:`Storage`\
:config:option:`sd/storage/CollectJobStatistics`\
-
**Statistics Collect Interval**:sup:`Sd`:sub:`Storage`\
:config:option:`sd/storage/StatisticsCollectInterval`\
Storage Configuration - Device Resource Directives
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
**Collect Statistics**:sup:`Sd`:sub:`Device`\
:config:option:`sd/device/CollectStatistics`\
See chapter :ref:`section-JobStatistics` for additional information.
Expand Up @@ -35,7 +35,7 @@ Difficulties Connecting from the FD to the SD

:index:`[TAG=Problem->Connecting from the FD to the SD] <pair: Problem; Connecting from the FD to the SD>`

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 used a fully qualified domain name on the **Address**:sup:`Dir`:sub:`Storage`\ directive. That is the resolver on the File daemon’s machine (not on the Director’s) must be able to resolve the name you supply into an IP address. An example of an address that is guaranteed not to work: :strong:`localhost`. An example that
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 used a fully qualified domain name on the :config:option:`dir/storage/Address`\ directive. That is the resolver on the File daemon’s machine (not on the Director’s) must be able to resolve the name you supply into an IP address. An example of an address that is guaranteed not to work: :strong:`localhost`. An example that
may work: :strong:`bareos-sd1`. An example that is more likely to work: :strong:`bareos-sd1.example.com`.

You can verify how a |bareosFd| resolves a DNS name by the following command:
Expand Down Expand Up @@ -97,37 +97,37 @@ Bareos can run multiple concurrent jobs. Using the :strong:`Maximum Concurrent J
-

**Maximum Concurrent Jobs**:sup:`Dir`:sub:`Director`\
:config:option:`dir/director/MaximumConcurrentJobs`\

-

**Maximum Concurrent Jobs**:sup:`Dir`:sub:`Client`\
:config:option:`dir/client/MaximumConcurrentJobs`\

-

**Maximum Concurrent Jobs**:sup:`Dir`:sub:`Job`\
:config:option:`dir/job/MaximumConcurrentJobs`\

-

**Maximum Concurrent Jobs**:sup:`Dir`:sub:`Storage`\
:config:option:`dir/storage/MaximumConcurrentJobs`\

|bareosSd|
|
-

**Maximum Concurrent Jobs**:sup:`Sd`:sub:`Storage`\
:config:option:`sd/storage/MaximumConcurrentJobs`\

-

**Maximum Concurrent Jobs**:sup:`Sd`:sub:`Device`\
:config:option:`sd/device/MaximumConcurrentJobs`\

|bareosFd|
|
-

**Maximum Concurrent Jobs**:sup:`Fd`:sub:`Client`\
:config:option:`fd/client/MaximumConcurrentJobs`\

For example, if you want two different jobs to run simultaneously backing up the same Client to the same Storage device, they will run concurrently only if you have set :strong:`Maximum Concurrent Jobs` greater than one in the :strong:`Director` resource, the :strong:`Client` resource, and the :strong:`Storage` resource in |bareosDir| configuration.

Expand Down

0 comments on commit 35578c9

Please sign in to comment.