From 619e4c59fd996bd1bd027e09ea1c9f0325e7cfdc Mon Sep 17 00:00:00 2001 From: Philipp Storz Date: Tue, 27 Nov 2018 14:42:43 +0100 Subject: [PATCH] next step --- docs/manuals/en/new_main_reference/replace.sh | 18 +++++-- .../source/autochangers.rst | 6 +-- .../en/new_main_reference/source/bconsole.rst | 26 +++++----- .../source/catmaintenance.rst | 30 +++++------ .../new_main_reference/source/configure.rst | 8 +-- .../en/new_main_reference/source/debug.rst | 4 +- .../en/new_main_reference/source/disk.rst | 2 +- .../en/new_main_reference/source/general.rst | 24 ++++----- .../en/new_main_reference/source/howto.rst | 4 +- .../en/new_main_reference/source/install.rst | 32 ++++++------ .../new_main_reference/source/migration.rst | 6 +-- .../en/new_main_reference/source/ndmp.rst | 12 ++--- .../new_main_reference/source/recycling.rst | 12 ++--- .../source/releasenotes.rst | 28 +++++------ .../en/new_main_reference/source/restore.rst | 8 +-- .../en/new_main_reference/source/security.rst | 10 ++-- .../en/new_main_reference/source/spooling.rst | 2 +- .../source/supportedoses.rst | 2 +- .../source/tape-without-autochanger.rst | 8 +-- .../source/troubleshooting.rst | 50 +++++++++---------- .../en/new_main_reference/source/tutorial.rst | 22 ++++---- .../en/new_main_reference/source/update.rst | 6 +-- .../en/new_main_reference/source/webui.rst | 10 ++-- 23 files changed, 169 insertions(+), 161 deletions(-) diff --git a/docs/manuals/en/new_main_reference/replace.sh b/docs/manuals/en/new_main_reference/replace.sh index 06fee072c0b..12445230d31 100755 --- a/docs/manuals/en/new_main_reference/replace.sh +++ b/docs/manuals/en/new_main_reference/replace.sh @@ -22,6 +22,7 @@ sed -i -E 's|:raw-latex:`\\label\{(.*)\}`|\n\n.. _`\1`: \1|g' *.rst # link targets perl -i -pe 's|:raw-latex:`\\ilink\{(.*?)\}\{(.*?)\}`|:ref:`\1 <\2>`|g' *.rst perl -i -pe 's|:raw-latex:`\\nameref\{(.*?)\}`|:ref:`\1`|g' *.rst +perl -i -pe 's|\\nameref\{(.*?)\}|:ref:`\1`|g' *.rst @@ -42,15 +43,17 @@ sed -i 's#:raw-latex:`\\vSphere`#\|vsphere\|#g' *.rst perl -i -pe 's#:raw-latex:`\\command\{(.*?)\}`#:program:`\1`#g' *.rst -# rename sec: to sec- as : has special meaning in sphinx +# rename sec: to section- as : has special meaning in sphinx sed -i -E 's#sec:#section-#g' *.rst +####### +# index +####### #:raw-latex:`\index[general]{Windows!File Daemon!Command Line Options}` # -> #:index:`triple: ` perl -i -pe 's#^( *):raw-latex:`\\index\[(.*?)\]\{(.*?)!(.*?)!(.*?)\}`#\1.. index::\n\1 triple: \3; \4; \5;\n\1#g' *.rst - #:raw-latex:`\index[general]{Problem!Windows}` # -> #:index:`pair: ` @@ -64,10 +67,16 @@ perl -i -pe 's#^( *):raw-latex:`\\index\[(.*?)\]\{(.*)\}`#\1.. index::\n\1 si +# \package +sed -i -E 's|:raw-latex:`\\package\{(.*)\}`|**\1**|g' *.rst + + +# remove nonsense lines +sed -i -E 's# .. raw:: latex##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 @@ -151,7 +160,6 @@ perl -i -pe 's#^( *):raw-latex:`\\index\[(.*?)\]\{(.*)\}`#\1.. index::\n\1 si # #sed -i -E 's|:raw-latex:`\\email\{(.*)\}`|**\1**|g' *.rst # -#sed -i -E 's|:raw-latex:`\\package\{(.*)\}`|**\1**|g' *.rst # #sed -i -E 's|:raw-latex:`\\pool\{(.*)\}`|**\1**|g' *.rst #sed -i -E 's|:raw-latex:`\\volumestatus\{(.*)\}`|**\1**|g' *.rst diff --git a/docs/manuals/en/new_main_reference/source/autochangers.rst b/docs/manuals/en/new_main_reference/source/autochangers.rst index 332222ff0e9..b9eee567a8b 100644 --- a/docs/manuals/en/new_main_reference/source/autochangers.rst +++ b/docs/manuals/en/new_main_reference/source/autochangers.rst @@ -14,7 +14,7 @@ Bareos provides autochanger support for reading and writing tapes. In order to work with an autochanger, Bareos requires a number of things, each of which is explained in more detail after this list: -- The package :raw-latex:`\package{bareos-storage-tape}` must be +- The package **bareos-storage-tape** must be installed. - A script that actually controls the autochanger according to commands @@ -451,7 +451,7 @@ several alternatives. #. You can issue a - .. raw:: latex + \footnotesize @@ -459,7 +459,7 @@ several alternatives. update slots scan - .. raw:: latex + \normalsize diff --git a/docs/manuals/en/new_main_reference/source/bconsole.rst b/docs/manuals/en/new_main_reference/source/bconsole.rst index b65cc2f0557..567323e3f06 100644 --- a/docs/manuals/en/new_main_reference/source/bconsole.rst +++ b/docs/manuals/en/new_main_reference/source/bconsole.rst @@ -641,7 +641,7 @@ configure The command generates and loads a new valid resource. As the new resource is also stored at - .. raw:: latex + \file{/bareos-dir.d//.conf} @@ -656,7 +656,7 @@ configure resource, the :ref:`ClientResourceDirector` for the |bareosFd| is also created and stored at: - .. raw:: latex + \file{/bareos-dir-export/client//bareos-fd.d/director/.conf} @@ -682,7 +682,7 @@ configure - - .. raw:: latex + \file{/etc/bareos/bareos-dir.d/client/client2-fd.conf} @@ -692,7 +692,7 @@ configure - - .. raw:: latex + \file{/etc/bareos/bareos-dir.d/job/client2-job.conf} @@ -701,7 +701,7 @@ configure they can be copied to new clients to configure these clients for the |bareosDir|. - .. raw:: latex + \warning{Don't be confused by the extensive output of \bcommand{help}{configure}. As \bcommand{configure}{add} allows configuring arbitrary resources, the output of \bcommand{help}{configure} lists all the resources, each with all valid directives. The same data is also used for \command{bconsole} command line completion.} @@ -1061,7 +1061,7 @@ label labeled. If you wish to avoid getting these messages, please write an EOF mark on your tape before attempting to label it: - .. raw:: latex + \footnotesize @@ -1070,7 +1070,7 @@ label mt rewind mt weof - .. raw:: latex + \normalsize @@ -1092,7 +1092,7 @@ label label. The brute force method is to write an end of file mark on the tape using the system **mt** program, something like the following: - .. raw:: latex + \footnotesize @@ -1101,7 +1101,7 @@ label mt -f /dev/st0 rewind mt -f /dev/st0 weof - .. raw:: latex + \normalsize @@ -2151,7 +2151,7 @@ update which value you wish to change. The following Volume parameters may be changed: - .. raw:: latex + \footnotesize @@ -2173,7 +2173,7 @@ update All Volumes from Pool All Volumes from all Pools - .. raw:: latex + \normalsize @@ -2320,7 +2320,7 @@ in the Bat Console. These commands are: filename specification. WARNING: be careful not to overwrite a valid file. A typical example during a regression test might be: - .. raw:: latex + \footnotesize @@ -2330,7 +2330,7 @@ in the Bat Console. These commands are: commands ... @output - .. raw:: latex + \normalsize diff --git a/docs/manuals/en/new_main_reference/source/catmaintenance.rst b/docs/manuals/en/new_main_reference/source/catmaintenance.rst index 8519131efa4..da8255c773b 100644 --- a/docs/manuals/en/new_main_reference/source/catmaintenance.rst +++ b/docs/manuals/en/new_main_reference/source/catmaintenance.rst @@ -48,16 +48,16 @@ dbconfig-common (Debian) Since Bareos :raw-latex:`\sinceVersion{dir}{dbconfig-common (Debian)}{14.2.0}` the Debian (and Ubuntu) based packages support the -:raw-latex:`\package{dbconfig-common}` mechanism to create and update +**dbconfig-common** mechanism to create and update the Bareos database, according to the user choices. -The first choice is, if :raw-latex:`\package{dbconfig-common}` should be +The first choice is, if **dbconfig-common** should be used at all. If you decide against it, the database must be configured manually, see :ref:`CatMaintenanceManualConfiguration`. -If you decided to use :raw-latex:`\package{dbconfig-common}`, the next +If you decided to use **dbconfig-common**, the next question will only be asked, if more than one Bareos database backend -(:raw-latex:`\package{bareos-database-*}`) is installed. If this is the +(**bareos-database-***) is installed. If this is the case, select the database backend you want to use. |image| |image| @@ -66,9 +66,9 @@ Depending on the selected database backend, more questions about how to access the database will be asked. Often, the default values are suitable. -The :raw-latex:`\package{dbconfig-common}` configuration (and +The **dbconfig-common** configuration (and credentials) is done by the -:raw-latex:`\package{bareos-database-common}` package. Settings are +**bareos-database-common** package. Settings are stored in the file :raw-latex:`\file{/etc/dbconfig-common/bareos-database-common.conf}`. @@ -139,7 +139,7 @@ normally at :raw-latex:`\scriptPathUnix`. The database preparation scripts have following configuration options: db_type - .. raw:: latex + \hfill @@ -153,7 +153,7 @@ db_type - fallback: postgresql db_name - .. raw:: latex + \hfill @@ -165,7 +165,7 @@ db_name - default: bareos db_user - .. raw:: latex + \hfill @@ -177,7 +177,7 @@ db_user - default: bareos db_password - .. raw:: latex + \hfill @@ -401,14 +401,14 @@ you need to correct the PostgreSQL servers configuration files. One way to manually create the database would be calling the bareos database preparation scripts with the :raw-latex:`\parameter{--host}` option, explained later. How ever, it is advised to use the -:raw-latex:`\package{dbconfig-common}`. Both methods require you to add +**dbconfig-common**. Both methods require you to add the database hostname/address as :raw-latex:`\linkResourceDirective{Dir}{Catalog}{DB Address}`. -If you’re using :raw-latex:`\package{dbconfig-common}` you should choose +If you’re using **dbconfig-common** you should choose :raw-latex:`\parameter{New Host}`, enter the hostname or the local address followed by the password. As -:raw-latex:`\package{dbconfig-common}` uses the +**dbconfig-common** uses the :raw-latex:`\parameter{ident}` authentication by default the first try to connect will fail. Don’t be bothered by that. Choose :raw-latex:`\parameter{Retry}` when prompted. From there, read carefully @@ -438,7 +438,7 @@ recent changes: db_type=PostgreSQL working_dir=/var/lib/bareos -If :raw-latex:`\package{dbconfig-common}` did not succeed or you choosed +If **dbconfig-common** did not succeed or you choosed not to use it, run the Bareos database preparation scripts with: :: @@ -1190,7 +1190,7 @@ following must be done: #includedir /etc/sudoers.d - .. raw:: latex + \normalsize diff --git a/docs/manuals/en/new_main_reference/source/configure.rst b/docs/manuals/en/new_main_reference/source/configure.rst index aefd28459bc..5140218de9a 100644 --- a/docs/manuals/en/new_main_reference/source/configure.rst +++ b/docs/manuals/en/new_main_reference/source/configure.rst @@ -318,7 +318,7 @@ Updates from Bareos :math:`<` 16.2.4 - - .. raw:: latex + \warning{Problems can occur if you have implemented an own wildcard mechanism to load your configuration from the same subdirectories as used by the new packages (\verb|CONFIGDIR/COMPONENT.d/*/*.conf|). @@ -728,7 +728,7 @@ acl Comamnd ACL = !set(ip|debug) Comamnd ACL = *all* - .. raw:: latex + \warning{ ACL checking stops at the first match. So the following definition allows all commands, which might not be what you expected: @@ -1080,7 +1080,7 @@ time The specification of a time may have as many number/modifier parts as you wish. For example: - .. raw:: latex + \footnotesize @@ -1089,7 +1089,7 @@ time 1 week 2 days 3 hours 10 mins 1 month 2 days 30 sec - .. raw:: latex + \normalsize diff --git a/docs/manuals/en/new_main_reference/source/debug.rst b/docs/manuals/en/new_main_reference/source/debug.rst index 23a1a44e1e0..21c7db2d72a 100644 --- a/docs/manuals/en/new_main_reference/source/debug.rst +++ b/docs/manuals/en/new_main_reference/source/debug.rst @@ -42,8 +42,8 @@ correctly on your system: #. You must have a version of Bareos with debug information and not stripped of debugging symbols. When using a packaged version of Bareos, this requires to install the Bareos debug packages - (:raw-latex:`\package{bareos-debug}` on RPM based systems, - :raw-latex:`\package{bareos-dbg}` on Debian based systems). + (**bareos-debug** on RPM based systems, + **bareos-dbg** on Debian based systems). #. On Linux, :program:`gdb` (the GNU debugger) must be installed. On some systems such as Solaris, diff --git a/docs/manuals/en/new_main_reference/source/disk.rst b/docs/manuals/en/new_main_reference/source/disk.rst index 93fb364ceee..b89a710341b 100644 --- a/docs/manuals/en/new_main_reference/source/disk.rst +++ b/docs/manuals/en/new_main_reference/source/disk.rst @@ -262,7 +262,7 @@ are the following: - - .. raw:: latex + \linkResourceDirective{Dir}{Pool}{Volume Retention} diff --git a/docs/manuals/en/new_main_reference/source/general.rst b/docs/manuals/en/new_main_reference/source/general.rst index e22dc6b8fb3..a0ef8357f01 100644 --- a/docs/manuals/en/new_main_reference/source/general.rst +++ b/docs/manuals/en/new_main_reference/source/general.rst @@ -318,32 +318,32 @@ available on all platforms. For details, see Additionally, packages containing debug information are available. These are named differently depending on the distribution -(:raw-latex:`\package{bareos-debuginfo}` or -:raw-latex:`\package{bareos-dbg}` or :math:`\ldots`). +(**bareos-debuginfo** or +**bareos-dbg** or :math:`\ldots`). Not all packages are required to run Bareos. - For the Bareos Director, the package - :raw-latex:`\package{bareos-director}` and one of - :raw-latex:`\package{bareos-database-postgresql}`, - :raw-latex:`\package{bareos-database-mysql}` or - :raw-latex:`\package{bareos-database-sqlite3}` are required. It is - recommended to use :raw-latex:`\package{bareos-database-postgresql}`. + **bareos-director** and one of + **bareos-database-postgresql**, + **bareos-database-mysql** or + **bareos-database-sqlite3** are required. It is + recommended to use **bareos-database-postgresql**. - For the |bareosSd|, the package - :raw-latex:`\package{bareos-storage}` is required. If you plan to + **bareos-storage** is required. If you plan to connect tape drives to the storage director, also install the package - :raw-latex:`\package{bareos-storage-tape}`. This is kept separately, + **bareos-storage-tape**. This is kept separately, because it has additional dependencies for tape tools. - On a client, only the package - :raw-latex:`\package{bareos-filedaemon}` is required. If you run it + **bareos-filedaemon** is required. If you run it on a workstation, the packages - :raw-latex:`\package{bareos-traymonitor}` gives the user information + **bareos-traymonitor** gives the user information about running backups. - On a Backup Administration system you need to install at least - :raw-latex:`\package{bareos-bconsole}` to have an interactive console + **bareos-bconsole** to have an interactive console to the |bareosDir|. Quick Start diff --git a/docs/manuals/en/new_main_reference/source/howto.rst b/docs/manuals/en/new_main_reference/source/howto.rst index 668e82c3cb6..16ddf4933f3 100644 --- a/docs/manuals/en/new_main_reference/source/howto.rst +++ b/docs/manuals/en/new_main_reference/source/howto.rst @@ -550,7 +550,7 @@ recoverafterrestore= GO - .. raw:: latex + \normalsize @@ -918,7 +918,7 @@ The plugin was successfully tested with xtrabackup versions 2.3.5 and 2.4.4. As it is a Python plugin, it will also require to have the package -:raw-latex:`\package{bareos-filedaemon-python-plugin}` installed on the +**bareos-filedaemon-python-plugin** installed on the |bareosFd|, where you run it. For authentication the :raw-latex:`\file{.mycnf}` file of the user diff --git a/docs/manuals/en/new_main_reference/source/install.rst b/docs/manuals/en/new_main_reference/source/install.rst index 528539549b3..5946530c68c 100644 --- a/docs/manuals/en/new_main_reference/source/install.rst +++ b/docs/manuals/en/new_main_reference/source/install.rst @@ -14,27 +14,27 @@ a running Bareos system: #. - .. raw:: latex - \nameref{section-AddSoftwareRepository} + + :ref:`section-AddSoftwareRepository` #. - .. raw:: latex - \nameref{section-InstallBareosPackages} + + :ref:`section-InstallBareosPackages` #. - .. raw:: latex - \nameref{section-CreateDatabase} + + :ref:`section-CreateDatabase` #. - .. raw:: latex - \nameref{section-StartDaemons} + + :ref:`section-StartDaemons` This will start a very basic Bareos installation which will regularly backup a directory to disk. In order to fit it to your needs, you’ll @@ -67,12 +67,12 @@ Decide about the Database Backend Bareos offers the following database backends: - PostgreSQL by package - :raw-latex:`\package{bareos-database-postgresql}`. This is the + **bareos-database-postgresql**. This is the recommended backend. -- MariaDB/MySQL by package :raw-latex:`\package{bareos-database-mysql}` +- MariaDB/MySQL by package **bareos-database-mysql** -- | Sqlite by package :raw-latex:`\package{bareos-database-sqlite3}` +- | Sqlite by package **bareos-database-sqlite3** | :raw-latex:`\warning{The Sqlite backend is only intended for testing, not for productive use.}` PostgreSQL @@ -104,13 +104,13 @@ installed packages, this may differ. Install the Bareos Software Packages ==================================== -The package :raw-latex:`\package{bareos}` is only a meta package, that +The package **bareos** is only a meta package, that contains dependencies to the main components of Bareos, see :ref:`section-BareosPackages`. If you want to setup a distributed environment (like one Director, separate database server, multiple Storage daemons) you have to choose the corresponding Bareos packages to install on each hosts instead of just installing the -:raw-latex:`\package{bareos}` package. +**bareos** package. Install on RedHat based Linux Distributions ------------------------------------------- @@ -368,7 +368,7 @@ Debian based Linux Distributions Since Bareos :raw-latex:`\sinceVersion{dir}{dbconfig-common (Debian)}{14.2.0}` the Debian (and Ubuntu) based packages support the -:raw-latex:`\package{dbconfig-common}` mechanism to create and update +**dbconfig-common** mechanism to create and update the Bareos database. Follow the instructions during install to configure it according to your @@ -376,13 +376,13 @@ needs. |image| |image| -If you decide not to use :raw-latex:`\package{dbconfig-common}` +If you decide not to use **dbconfig-common** (selecting :raw-latex:`\parameter{}` on the initial dialog), follow the instructions for :ref:`section-CreateDatabaseOtherDistributions`. The selectable database backends depend on the -:raw-latex:`\package{bareos-database-*}` packages installed. +**bareos-database-*** packages installed. For details see :ref:`section-dbconfig`. diff --git a/docs/manuals/en/new_main_reference/source/migration.rst b/docs/manuals/en/new_main_reference/source/migration.rst index 8e8150bb4a8..565e56afeec 100644 --- a/docs/manuals/en/new_main_reference/source/migration.rst +++ b/docs/manuals/en/new_main_reference/source/migration.rst @@ -174,13 +174,13 @@ Job Resource - - .. raw:: latex + \linkResourceDirective{Dir}{Job}{Selection Type} - - .. raw:: latex + \linkResourceDirective{Dir}{Job}{Selection Pattern} @@ -191,7 +191,7 @@ Job Resource - - .. raw:: latex + \linkResourceDirective{Dir}{Job}{Purge Migration Job} diff --git a/docs/manuals/en/new_main_reference/source/ndmp.rst b/docs/manuals/en/new_main_reference/source/ndmp.rst index f55921cbc83..eb9d894a8b0 100644 --- a/docs/manuals/en/new_main_reference/source/ndmp.rst +++ b/docs/manuals/en/new_main_reference/source/ndmp.rst @@ -1305,7 +1305,7 @@ hardlinks to this big file. \limitation*{NDMP}{File information are not available in the Bareos backup stream}{% As hardlink information is only stored in the Bareos database, but not int the backup stream itself, it is not possible to recover the file history information from the NDMP stream with \command{bscan}. - As storing the database dump for disaster recovery and storing the bootstrap file offsite is recommended anyway (see \nameref{section-before-disaster}), this should be not a big problem in correctly setup environments. + As storing the database dump for disaster recovery and storing the bootstrap file offsite is recommended anyway (see :ref:`section-before-disaster`), this should be not a big problem in correctly setup environments. For the same reason, the information about the number of files of a job (e.g. JobFiles with \bcommand{list}{jobs} command) is limited to the number of NDMP backup files in copied jobs. } @@ -2162,31 +2162,31 @@ To debug the NDMP backups, these settings can be adapted: - - .. raw:: latex + \linkResourceDirective{Dir}{Director}{NDMP Snooping} - - .. raw:: latex + \linkResourceDirective{Dir}{Director}{NDMP Log Level} - - .. raw:: latex + \linkResourceDirective{Dir}{Client}{NDMP Log Level} - - .. raw:: latex + \linkResourceDirective{Sd}{Storage}{NDMP Snooping} - - .. raw:: latex + \linkResourceDirective{Sd}{Storage}{NDMP Log Level} diff --git a/docs/manuals/en/new_main_reference/source/recycling.rst b/docs/manuals/en/new_main_reference/source/recycling.rst index 57d4848370a..8579b1954f5 100644 --- a/docs/manuals/en/new_main_reference/source/recycling.rst +++ b/docs/manuals/en/new_main_reference/source/recycling.rst @@ -43,7 +43,7 @@ records are: - - .. raw:: latex + \linkResourceDirective{Dir}{Pool}{Volume Retention} @@ -51,7 +51,7 @@ records are: - - .. raw:: latex + \linkResourceDirective{Dir}{Pool}{Recycle Pool} @@ -62,19 +62,19 @@ is full, you can use one or more additional directives such as: - - .. raw:: latex + \linkResourceDirective{Dir}{Pool}{Volume Use Duration} - - .. raw:: latex + \linkResourceDirective{Dir}{Pool}{Maximum Volume Jobs} - - .. raw:: latex + \linkResourceDirective{Dir}{Pool}{Maximum Volume Bytes} @@ -801,5 +801,5 @@ If you wish to reuse the tape by giving it a new name, use the \warning{The \bcommand{delete}{} command can be dangerous. Once it is done, to recover the File records, you must either restore your database as it - was before the \bcommand{delete}{} command or use the \nameref{bscan} utility program to + was before the \bcommand{delete}{} command or use the :ref:`bscan` utility program to scan the tape and recreate the database entries.} diff --git a/docs/manuals/en/new_main_reference/source/releasenotes.rst b/docs/manuals/en/new_main_reference/source/releasenotes.rst index 8e130ac6de3..788aa26517c 100644 --- a/docs/manuals/en/new_main_reference/source/releasenotes.rst +++ b/docs/manuals/en/new_main_reference/source/releasenotes.rst @@ -90,7 +90,7 @@ releases are only published on https://download.bareos.com.\| This release contains several bugfixes and enhancements. Excerpt: \begin{itemize} \item \bareosFd is ready for \os{AIX}{7.1.0.0}. - \item \nameref{VMwarePlugin} is also provided for \os{Debian}{9}. + \item :ref:`VMwarePlugin` is also provided for \os{Debian}{9}. \item NDMP fixes \item Virtual Backup fixes \item \package{bareos-storage-droplet}: improvements @@ -130,13 +130,13 @@ releases are only published on https://download.bareos.com.\| \item \package{bareos-storage-droplet} is a storage backend for the droplet library. Most notably it allows backup and restores to a S3 environment. \betaSince{sd}{bareos-storage-droplet}{17.2.4} - \item \package{bat} has been removed, see section \nameref{bat}. + \item \package{bat} has been removed, see section :ref:`bat`. \item platforms: \begin{itemize} \item Windows Clients are still supported since Windows Vista. \item MacOS: added to build chain. \item \bareosFd is ready for HP-UX 11.31 (ia64). - \item Linux Distribution: Bareos tries to provide packages for all current platforms. For details, refer to \nameref{section-packages}. + \item Linux Distribution: Bareos tries to provide packages for all current platforms. For details, refer to :ref:`section-packages`. \end{itemize} \item Linux RPM packages: allow read access to /etc/bareos/ for all users (however, relevant files are still only readable for the user \user{bareos}). This allows other programs associated with Bareos to also use this directory. @@ -151,8 +151,8 @@ releases are only published on https://download.bareos.com.\| \item The \dbtable{Filename} database table does no longer exists. Therefore the \bcommand{.bvfs_*}{} commands do no longer output the \dbcolumn{FilenameId} column. \end{itemize} - \item NDMP\_NATIVE support has been added. This include the NDMP features DAR and DDAR. For details see \nameref{section-NdmpNative}. - \item Updated the package \package{bareos-vmware-plugin} to utilize the Virtual Disk Development Kit (VDDK) 6.5.x. This includes support for \vSphere 6.5 and the next major release (except new features) and backward compatible with \vSphere 5.5 and 6.0. For details see \nameref{VMwarePlugin}. + \item NDMP\_NATIVE support has been added. This include the NDMP features DAR and DDAR. For details see :ref:`section-NdmpNative`. + \item Updated the package \package{bareos-vmware-plugin} to utilize the Virtual Disk Development Kit (VDDK) 6.5.x. This includes support for \vSphere 6.5 and the next major release (except new features) and backward compatible with \vSphere 5.5 and 6.0. For details see :ref:`VMwarePlugin`. \item Soft Quota: automatic quota grace period reset if a job does not exceed the quota. \item \command{bareos-dbcheck}: disable all interactive questions in batch mode. \item \bcommand{list}{files}: also show deleted files (accurate mode). @@ -257,7 +257,7 @@ releases are only published on https://download.bareos.com.\| \item Prevent from director crash when using incorrect paramaters of \bcommand{.bvfs_*}{} commands. \item Director now closes all configuration files when reloading failed. \item Storage daemon now closes the network connection when MaximumConcurrentJobs reached. - \item New directive \configdirective{LanAddress} was added to the Client and Storage Resources of the director to facilitate a network topology where client and storage are situated inside of a LAN, but the Director is outside of that LAN. See \nameref{LanAddress} for details. + \item New directive \configdirective{LanAddress} was added to the Client and Storage Resources of the director to facilitate a network topology where client and storage are situated inside of a LAN, but the Director is outside of that LAN. See :ref:`LanAddress` for details. \item A Problem in the storage abstraction layer was fixed where the director picked the wrong storage daemon when multiple storages/storage daemons were used. \item The device spool size calculation when using secure erase was fixed. \item \bcommand{.bvfs_lsdirs}{} no longer shows empty directories from accurate jobs. @@ -338,8 +338,8 @@ releases are only published on https://download.bareos.com.\| \begin{itemize} \item Configuration \begin{itemize} - \item Bareos packages contain the default configuration in \nameref{section-ConfigurationSubdirectories}. Please read \nameref{section-UpdateToConfigurationSubdirectories} before updating (make a copy of your configuration directories for your \bareosDir and \bareosSd before updating). Note: as the old configuration files are still supported, in most cases no changes are required. - \item The default configuration does no longer name the \resourcetype{Dir}{Director} and \resourcetype{Sd}{Storage} resources after the systems hostname (\verb|$HOSTNAME-dir| resp. \verb|$HOSTNAME-sd|) but use \resourcename{Dir}{Director}{bareos-dir} resp. \resourcename{Sd}{Storage}{bareos-sd} as defaults. The prior solution had the disadvantage, that \verb|$HOSTNAME-dir| has also been set on \bareosFd not running on the \bareosDir, which almost ever did require changing this setting. Also the new approach aligns better with \nameref{section-ConfigurationSubdirectories}. + \item Bareos packages contain the default configuration in :ref:`section-ConfigurationSubdirectories`. Please read :ref:`section-UpdateToConfigurationSubdirectories` before updating (make a copy of your configuration directories for your \bareosDir and \bareosSd before updating). Note: as the old configuration files are still supported, in most cases no changes are required. + \item The default configuration does no longer name the \resourcetype{Dir}{Director} and \resourcetype{Sd}{Storage} resources after the systems hostname (\verb|$HOSTNAME-dir| resp. \verb|$HOSTNAME-sd|) but use \resourcename{Dir}{Director}{bareos-dir} resp. \resourcename{Sd}{Storage}{bareos-sd} as defaults. The prior solution had the disadvantage, that \verb|$HOSTNAME-dir| has also been set on \bareosFd not running on the \bareosDir, which almost ever did require changing this setting. Also the new approach aligns better with :ref:`section-ConfigurationSubdirectories`. \item Due to limitation of the build system, the default resource \resourcename{Dir}{FileSet}{Linux All} have been renamed to \resourcename{Dir}{FileSet}{LinuxAll} (no space between Linux and All). \item The configuration of the \package{bareos-traymonitor} has also been split into resource files. Additional, these resource files are now packaged in other packages: @@ -426,7 +426,7 @@ releases are only published on https://download.bareos.com.\| \begin{tabular}{p{0.2\textwidth} p{0.8\textwidth}} Code Release & 2015-11-19\\ Database Version & 2004\\ - & Database update required (if coming from bareos-14.2). See the \nameref{bareos-update} section.\\ + & Database update required (if coming from bareos-14.2). See the :ref:`bareos-update` section.\\ Release Ticket & \ticket{554} \\ Url & \releaseUrlDownloadBareosOrg{15.2} \\ & \releaseUrlDownloadBareosCom{15.2} \\ @@ -450,7 +450,7 @@ releases are only published on https://download.bareos.com.\| \begin{tabular}{p{0.2\textwidth} p{0.8\textwidth}} Code Release & 2015-09-16\\ Database Version & 2004\\ - & Database update required, see the \nameref{bareos-update} section.\\ + & Database update required, see the :ref:`bareos-update` section.\\ Release Ticket & \ticket{501} \\ Url & \releaseUrlDownloadBareosOrg{15.2} \\ \end{tabular} @@ -616,7 +616,7 @@ plan to ensure this in future version of Bareos. Code Release & 2014-12-12 \\ Database Version & 2003 (unchanged)\\ & Database update required if updating from version $<$ 14.2.\\ - & See the \nameref{bareos-update} section for details.\\ + & See the :ref:`bareos-update` section for details.\\ Url & \releaseUrlDownloadBareosOrg{14.2} \\ & \releaseUrlDownloadBareosCom{14.2} \\ \end{tabular} @@ -631,7 +631,7 @@ plan to ensure this in future version of Bareos. \begin{tabular}{p{0.2\textwidth} p{0.8\textwidth}} Code Release & 2014-09-22 \\ Database Version & 2003\\ - & Database update required, see the \nameref{bareos-update} section.\\ + & Database update required, see the :ref:`bareos-update` section.\\ Url & \releaseUrlDownloadBareosOrg{14.2} \\ \end{tabular} @@ -673,7 +673,7 @@ plan to ensure this in future version of Bareos. \begin{tabular}{p{0.2\textwidth} p{0.8\textwidth}} Code Release & 2014-03-11 \\ Database Version & 2002\\ - & Database update required, see the \nameref{bareos-update} section.\\ + & Database update required, see the :ref:`bareos-update` section.\\ Url & \releaseUrlDownloadBareosCom{13.2} \\ \end{tabular} @@ -777,5 +777,5 @@ plan to ensure this in future version of Bareos. This have been the initial release of Bareos. - Information about migrating from Bacula to Bareos are available at \elink{Howto upgrade from Bacula to Bareos}{http://www.bareos.org/en/HOWTO/articles/upgrade_bacula_bareos.html} and in section \nameref{compat-bacula}. + Information about migrating from Bacula to Bareos are available at \elink{Howto upgrade from Bacula to Bareos}{http://www.bareos.org/en/HOWTO/articles/upgrade_bacula_bareos.html} and in section :ref:`compat-bacula`. } diff --git a/docs/manuals/en/new_main_reference/source/restore.rst b/docs/manuals/en/new_main_reference/source/restore.rst index f2659b3142f..a436e6cc31e 100644 --- a/docs/manuals/en/new_main_reference/source/restore.rst +++ b/docs/manuals/en/new_main_reference/source/restore.rst @@ -1078,7 +1078,7 @@ mark After executing the **mark** command, it will print a brief summary: - .. raw:: latex + \footnotesize @@ -1086,13 +1086,13 @@ mark No files marked. - .. raw:: latex + \normalsize If no files were marked, or: - .. raw:: latex + \footnotesize @@ -1100,7 +1100,7 @@ mark nn files marked. - .. raw:: latex + \normalsize diff --git a/docs/manuals/en/new_main_reference/source/security.rst b/docs/manuals/en/new_main_reference/source/security.rst index dc9b1c05689..5f5d410fa67 100644 --- a/docs/manuals/en/new_main_reference/source/security.rst +++ b/docs/manuals/en/new_main_reference/source/security.rst @@ -331,19 +331,19 @@ This directive is optional and can be configured in: - - .. raw:: latex + \linkResourceDirective{Dir}{Director}{Secure Erase Command} - - .. raw:: latex + \linkResourceDirective{Sd}{Storage}{Secure Erase Command} - - .. raw:: latex + \linkResourceDirective{Fd}{Client}{Secure Erase Command} @@ -382,12 +382,12 @@ Example: Example for Secure Erase Command Settings: Linux: - .. raw:: latex + \configdirective{Secure Erase Command = "/usr/bin/wipe -V"} Windows: - .. raw:: latex + \configdirective{Secure Erase Command = "C:/cygwin64/bin/shred.exe"} diff --git a/docs/manuals/en/new_main_reference/source/spooling.rst b/docs/manuals/en/new_main_reference/source/spooling.rst index 854dbacb8d8..437919b992a 100644 --- a/docs/manuals/en/new_main_reference/source/spooling.rst +++ b/docs/manuals/en/new_main_reference/source/spooling.rst @@ -95,7 +95,7 @@ Additional Notes - - .. raw:: latex + \warning{Exclude your the spool directory from any backup, otherwise, your job will write enormous amounts of data to the Volume, and diff --git a/docs/manuals/en/new_main_reference/source/supportedoses.rst b/docs/manuals/en/new_main_reference/source/supportedoses.rst index 7855c3beaa9..90693e8b961 100644 --- a/docs/manuals/en/new_main_reference/source/supportedoses.rst +++ b/docs/manuals/en/new_main_reference/source/supportedoses.rst @@ -242,7 +242,7 @@ Limitations of the Debian.org/Ubuntu Universe version of Bareos support :ref:`section-TransportEncryption` but no :ref:`DataEncryption`. -- Debian.org does not include the :raw-latex:`\package{bareos-webui}` +- Debian.org does not include the **bareos-webui** package. Mac OS X 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 41988e76988..1b75030d864 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 @@ -98,7 +98,7 @@ are several ways to get Bareos to release the tape: This could also be an **Admin** job that runs after all your backup jobs. The script could be something like: - .. raw:: latex + \footnotesize @@ -109,7 +109,7 @@ are several ways to get Bareos to release the tape: release storage=your-storage-name END_OF_DATA - .. raw:: latex + \normalsize @@ -123,7 +123,7 @@ are several ways to get Bareos to release the tape: would use the unmount command to force Bareos to release the drive. Then you would eject the tape, and remount it as follows: - .. raw:: latex + \footnotesize @@ -141,7 +141,7 @@ are several ways to get Bareos to release the tape: mount storage=your-storage-name END_OF_DATA - .. raw:: latex + \normalsize diff --git a/docs/manuals/en/new_main_reference/source/troubleshooting.rst b/docs/manuals/en/new_main_reference/source/troubleshooting.rst index 6eb7ef3db9f..00756acd821 100644 --- a/docs/manuals/en/new_main_reference/source/troubleshooting.rst +++ b/docs/manuals/en/new_main_reference/source/troubleshooting.rst @@ -164,25 +164,25 @@ can configure how many and which jobs can be run simultaneously: - - .. raw:: latex + \linkResourceDirective{Dir}{Director}{Maximum Concurrent Jobs} - - .. raw:: latex + \linkResourceDirective{Dir}{Client}{Maximum Concurrent Jobs} - - .. raw:: latex + \linkResourceDirective{Dir}{Job}{Maximum Concurrent Jobs} - - .. raw:: latex + \linkResourceDirective{Dir}{Storage}{Maximum Concurrent Jobs} @@ -191,13 +191,13 @@ can configure how many and which jobs can be run simultaneously: - - .. raw:: latex + \linkResourceDirective{Sd}{Storage}{Maximum Concurrent Jobs} - - .. raw:: latex + \linkResourceDirective{Sd}{Device}{Maximum Concurrent Jobs} @@ -206,7 +206,7 @@ can configure how many and which jobs can be run simultaneously: - - .. raw:: latex + \linkResourceDirective{Fd}{Client}{Maximum Concurrent Jobs} @@ -785,7 +785,7 @@ Solution with a Catalog backup **RestoreFiles**. Most likely it will prompt you with something such as: - .. raw:: latex + \footnotesize @@ -804,7 +804,7 @@ Solution with a Catalog backup Priority: 10 OK to run? (yes/mod/no): - .. raw:: latex + \normalsize @@ -838,7 +838,7 @@ Solution with a Job listing Volume name(s), the Volume Session Id and the Volume Session Time. If you know those, you can easily restore your Catalog. - .. raw:: latex + \footnotesize @@ -872,7 +872,7 @@ Solution with a Job listing SD termination status: OK Termination: Backup OK - .. raw:: latex + \normalsize @@ -881,7 +881,7 @@ Solution with a Job listing your database. A reconstructed bootstrap file for the above backup Job would look like the following: - .. raw:: latex + \footnotesize @@ -892,7 +892,7 @@ Solution with a Job listing VolSessionTime=1114075126 FileIndex=1-1 - .. raw:: latex + \normalsize @@ -907,7 +907,7 @@ Solution with a Job listing Volume to find the requested file. A fully specified bootstrap file would have the File and Blocks specified as follows: - .. raw:: latex + \footnotesize @@ -920,7 +920,7 @@ Solution with a Job listing VolBlock=0-4053 FileIndex=1-1 - .. raw:: latex + \normalsize @@ -952,7 +952,7 @@ Problem 3 on the restore menu then the JobId to restore, but Bareos then reports: - .. raw:: latex + \footnotesize @@ -960,7 +960,7 @@ Problem 1 Job 0 Files - .. raw:: latex + \normalsize @@ -972,7 +972,7 @@ Solution the Job. By using the "llist jobid=nn" command, you can obtain all the important information about the job: - .. raw:: latex + \footnotesize @@ -1002,13 +1002,13 @@ Solution Job.FileSetId: 1 FileSet.FileSet: BackupSet - .. raw:: latex + \normalsize Then you can find the Volume(s) used by doing: - .. raw:: latex + \footnotesize @@ -1017,7 +1017,7 @@ Solution sql select VolumeName from JobMedia,Media where JobId=1 and JobMedia.MediaId=Media.MediaId; - .. raw:: latex + \normalsize @@ -1039,7 +1039,7 @@ Solution it is on the tape, then use :program:`bextract` to restore the database. For example, - .. raw:: latex + \footnotesize @@ -1047,7 +1047,7 @@ Solution ./bls -j -V DLT-22Apr05 /dev/nst0 - .. raw:: latex + \normalsize @@ -1072,7 +1072,7 @@ Solution Volume "DLT-22Apr05" 21-Jul 18:34 bls: End of all volumes. - .. raw:: latex + \normalsize @@ -1120,7 +1120,7 @@ Solution 16: List Volumes likely to need replacement from age or errors Choose a query (1-16): - .. raw:: latex + \normalsize diff --git a/docs/manuals/en/new_main_reference/source/tutorial.rst b/docs/manuals/en/new_main_reference/source/tutorial.rst index 1941c539a9b..44a57047de1 100644 --- a/docs/manuals/en/new_main_reference/source/tutorial.rst +++ b/docs/manuals/en/new_main_reference/source/tutorial.rst @@ -20,9 +20,9 @@ The general flow of running Bareos is: #. - .. raw:: latex - \nameref{InstallChapter} + + :ref:`InstallChapter` #. Start the Bareos Daemons @@ -742,7 +742,7 @@ following settings about the machine you want to add to your backup environment: Hostname (FQDN) - .. raw:: latex + \host{client2.example.com} @@ -760,7 +760,7 @@ Client: install package See :ref:`InstallChapter` about how to add the Bareos repository. The only part you need installed on the other machine is the -:raw-latex:`\package{bareos-filedaemon}`. +**bareos-filedaemon**. Director: configure client ~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -788,7 +788,7 @@ This creates two resource configuration files: - - .. raw:: latex + \file{/etc/bareos/bareos-dir.d/client/client2-fd.conf} @@ -835,31 +835,31 @@ created directly on the client, see below. Client: configure ~~~~~~~~~~~~~~~~~ -The package :raw-latex:`\package{bareos-filedaemon}` +The package **bareos-filedaemon** :raw-latex:`\sinceVersion{Fd}{Client resource files}{16.2.4}` brings several configuration files: - - .. raw:: latex + \file{/etc/bareos/bareos-fd.d/client/myself.conf} - - .. raw:: latex + \file{/etc/bareos/bareos-fd.d/director/bareos-dir.conf} - - .. raw:: latex + \file{/etc/bareos/bareos-fd.d/director/bareos-mon.conf} - - .. raw:: latex + \file{/etc/bareos/bareos-fd.d/messages/Standard.conf} @@ -886,7 +886,7 @@ In detail: installation, the :raw-latex:`\linkResourceDirective{Fd}{Director}{Password}` is set to a random value. This resource is intended to be used by the local - :raw-latex:`\package{bareos-tray-monitor}`. + **bareos-tray-monitor**. :raw-latex:`\file{messages/Standard.conf}` defines, how messages should be handled. The default sends all diff --git a/docs/manuals/en/new_main_reference/source/update.rst b/docs/manuals/en/new_main_reference/source/update.rst index a83c80f6a86..d44c6ae32b8 100644 --- a/docs/manuals/en/new_main_reference/source/update.rst +++ b/docs/manuals/en/new_main_reference/source/update.rst @@ -58,7 +58,7 @@ Debian based Linux Distributions Since Bareos :raw-latex:`\sinceVersion{dir}{dbconfig-common (Debian)}{14.2.0}` the Debian (and Ubuntu) based packages support the -:raw-latex:`\package{dbconfig-common}` mechanism to create and update +**dbconfig-common** mechanism to create and update the Bareos database. If this is properly configured, the database schema will be automatically adapted by the Bareos packages. @@ -73,7 +73,7 @@ will be automatically adapted by the Bareos packages. For details see :ref:`section-dbconfig`. -If you disabled the usage of :raw-latex:`\package{dbconfig-common}`, +If you disabled the usage of **dbconfig-common**, follow the instructions for :ref:`section-UpdateDatabaseOtherDistributions`. @@ -96,7 +96,7 @@ different preparations. More details can be found in chapter .. raw:: latex - \warning{If you're updating to Bareos $<=$ 13.2.3 and have configured the Bareos database during install using Bareos environment variables (\variable{db_name}, \variable{db_user} or \variable{db_password}, see \nameref{CatMaintenanceChapter}), make sure to have these variables defined in the same way when calling the update and grant scripts. Newer versions of Bareos read these variables from the Director configuration file \configFileDirUnix. However, make sure that the user running the database scripts has read access to this file (or set the environment variables). The \user{postgres} user normally does not have the required permissions.} + \warning{If you're updating to Bareos $<=$ 13.2.3 and have configured the Bareos database during install using Bareos environment variables (\variable{db_name}, \variable{db_user} or \variable{db_password}, see :ref:`CatMaintenanceChapter`), make sure to have these variables defined in the same way when calling the update and grant scripts. Newer versions of Bareos read these variables from the Director configuration file \configFileDirUnix. However, make sure that the user running the database scripts has read access to this file (or set the environment variables). The \user{postgres} user normally does not have the required permissions.} PostgreSQL ~~~~~~~~~~ diff --git a/docs/manuals/en/new_main_reference/source/webui.rst b/docs/manuals/en/new_main_reference/source/webui.rst index f0c413801be..41350639d1d 100644 --- a/docs/manuals/en/new_main_reference/source/webui.rst +++ b/docs/manuals/en/new_main_reference/source/webui.rst @@ -52,7 +52,7 @@ Features System Requirements =================== -- A platform, for which the :raw-latex:`\package{bareos-webui}` package +- A platform, for which the **bareos-webui** package is available, see :ref:`section-BareosPackages`. - A working Bareos environment. @@ -77,7 +77,7 @@ Version :math:`<` 16.2 :raw-latex:`\bareosWebui `:raw-latex:`\sinceVersion{}{bareos-webui incorporates Zend Framework 2}{16.2.4}` incorporates the required Zend Framework 2 components, no extra Zend Framework installation is required. For older versions of -:raw-latex:`\package{bareos-webui}`, you must install Zend Framework +**bareos-webui**, you must install Zend Framework separately. Unfortunately, not all distributions offer Zend Framework 2 packages. The following list shows where to get the Zend Framework 2 package: @@ -237,7 +237,7 @@ For details, please read :ref:`DirectorResourceConsole`. Configuration of profile resources ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -The package :raw-latex:`\package{bareos-webui}` comes with a predefined +The package **bareos-webui** comes with a predefined profile for |bareosWebui|: :raw-latex:`\resourcename{Dir}{Profile}{webui-admin}`. @@ -300,7 +300,7 @@ Configure your Apache Webserver .. _`section-webui-apache`: section-webui-apache -The package :raw-latex:`\package{bareos-webui}` provides a default +The package **bareos-webui** provides a default configuration for Apache. Depending on your distribution, it is installed at :raw-latex:`\file{/etc/apache2/conf.d/bareos-webui.conf}`, :raw-latex:`\file{/etc/httpd/conf.d/bareos-webui.conf}` or @@ -309,7 +309,7 @@ installed at :raw-latex:`\file{/etc/apache2/conf.d/bareos-webui.conf}`, The required Apache modules, :raw-latex:`\argument{setenv}`, :raw-latex:`\argument{rewrite}` and :raw-latex:`\argument{php}` are enabled via package postinstall script. However, after installing the -:raw-latex:`\package{bareos-webui}` package, you need to restart your +**bareos-webui** package, you need to restart your Apache webserver manually. Configure your /etc/bareos-webui/directors.ini