Skip to content

Commit

Permalink
next step
Browse files Browse the repository at this point in the history
  • Loading branch information
pstorz committed Nov 27, 2018
1 parent 2e38c4b commit 619e4c5
Show file tree
Hide file tree
Showing 23 changed files with 169 additions and 161 deletions.
18 changes: 13 additions & 5 deletions docs/manuals/en/new_main_reference/replace.sh
Expand Up @@ -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



Expand All @@ -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: <Windows!File Daemon!Command Line Options>`
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: <Problem;Windows>`
Expand All @@ -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



Expand Down Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions docs/manuals/en/new_main_reference/source/autochangers.rst
Expand Up @@ -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
Expand Down Expand Up @@ -451,15 +451,15 @@ several alternatives.

#. You can issue a

.. raw:: latex


\footnotesize

::

update slots scan

.. raw:: latex


\normalsize

Expand Down
26 changes: 13 additions & 13 deletions docs/manuals/en/new_main_reference/source/bconsole.rst
Expand Up @@ -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{<CONFIGDIR>/bareos-dir.d/<resourcetype>/<resourcename>.conf}

Expand All @@ -656,7 +656,7 @@ configure
resource, the :ref:`ClientResourceDirector` for
the |bareosFd| is also created and stored at:

.. raw:: latex


\file{<CONFIGDIR>/bareos-dir-export/client/<clientname>/bareos-fd.d/director/<clientname>.conf}

Expand All @@ -682,7 +682,7 @@ configure

-

.. raw:: latex


\file{/etc/bareos/bareos-dir.d/client/client2-fd.conf}

Expand All @@ -692,7 +692,7 @@ configure

-

.. raw:: latex


\file{/etc/bareos/bareos-dir.d/job/client2-job.conf}

Expand All @@ -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.}

Expand Down Expand Up @@ -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

Expand All @@ -1070,7 +1070,7 @@ label
mt rewind
mt weof

.. raw:: latex

\normalsize

Expand All @@ -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

Expand All @@ -1101,7 +1101,7 @@ label
mt -f /dev/st0 rewind
mt -f /dev/st0 weof

.. raw:: latex

\normalsize

Expand Down Expand Up @@ -2151,7 +2151,7 @@ update
which value you wish to change. The following Volume parameters may
be changed:

.. raw:: latex


\footnotesize

Expand All @@ -2173,7 +2173,7 @@ update
All Volumes from Pool
All Volumes from all Pools

.. raw:: latex

\normalsize

Expand Down Expand Up @@ -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

Expand All @@ -2330,7 +2330,7 @@ in the Bat Console. These commands are:
commands ...
@output

.. raw:: latex

\normalsize

Expand Down
30 changes: 15 additions & 15 deletions docs/manuals/en/new_main_reference/source/catmaintenance.rst
Expand Up @@ -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|
Expand All @@ -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}`.

Expand Down Expand Up @@ -139,7 +139,7 @@ normally at :raw-latex:`\scriptPathUnix`.
The database preparation scripts have following configuration options:

db_type
.. raw:: latex


\hfill

Expand All @@ -153,7 +153,7 @@ db_type
- fallback: postgresql

db_name
.. raw:: latex


\hfill

Expand All @@ -165,7 +165,7 @@ db_name
- default: bareos

db_user
.. raw:: latex


\hfill

Expand All @@ -177,7 +177,7 @@ db_user
- default: bareos

db_password
.. raw:: latex


\hfill

Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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:

::
Expand Down Expand Up @@ -1190,7 +1190,7 @@ following must be done:

#includedir /etc/sudoers.d

.. raw:: latex


\normalsize

Expand Down
8 changes: 4 additions & 4 deletions docs/manuals/en/new_main_reference/source/configure.rst
Expand Up @@ -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|).
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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
Expand All @@ -1089,7 +1089,7 @@ time
1 week 2 days 3 hours 10 mins
1 month 2 days 30 sec
.. raw:: latex
\normalsize
Expand Down
4 changes: 2 additions & 2 deletions docs/manuals/en/new_main_reference/source/debug.rst
Expand Up @@ -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,
Expand Down
2 changes: 1 addition & 1 deletion docs/manuals/en/new_main_reference/source/disk.rst
Expand Up @@ -262,7 +262,7 @@ are the following:

-

.. raw:: latex


\linkResourceDirective{Dir}{Pool}{Volume Retention}

Expand Down

0 comments on commit 619e4c5

Please sign in to comment.