Skip to content

Commit

Permalink
inline index works
Browse files Browse the repository at this point in the history
  • Loading branch information
pstorz committed Nov 27, 2018
1 parent 713fd27 commit 5ca36fd
Show file tree
Hide file tree
Showing 45 changed files with 752 additions and 728 deletions.
38 changes: 23 additions & 15 deletions docs/manuals/en/new_main_reference/replace.sh
Expand Up @@ -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: <Windows!File Daemon!Command Line Options>`
perl -i -pe 's#:raw-latex:`\\index\[(.*?)\]\{(.*?)!(.*?)!(.*?)\}`#:index:`triple: <\2;\3;\4>`#g' *.rst


#:raw-latex:`\index[general]{Problem!Windows}`
# ->
#:index:`pair: <Problem;Windows>`
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



Expand Down Expand Up @@ -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
##
#
Expand Down
Expand Up @@ -3,15 +3,15 @@
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}`.

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 -
Expand Down
52 changes: 26 additions & 26 deletions docs/manuals/en/new_main_reference/source/autochangers.rst
Expand Up @@ -3,8 +3,8 @@
Autochanger Support
===================

:raw-latex:`\index[general]{Support!Autochanger}`
:raw-latex:`\index[general]{Autochanger!Support}`
:index:`pair: <Support;Autochanger>`
:index:`pair: <Autochanger;Support>`

Bareos provides autochanger support for reading and writing tapes. In
order to work with an autochanger, Bareos requires a number of things,
Expand Down Expand Up @@ -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: <Devices;SCSI>`
:index:`pair: <Devices;Detecting>`

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

Expand Down Expand Up @@ -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: <Devices;Multiple>`
:index:`Multiple Devices`

Some autochangers have more than one read/write device (drive). The
:ref:`Autochanger resource <AutochangerRes>` permits you to
Expand Down Expand Up @@ -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.
Expand All @@ -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: <Label;Specifying Slots When Labeling>`


.. _`SpecifyingSlots`: SpecifyingSlots
Expand Down Expand Up @@ -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: <Cartridges;Changing>` 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:

Expand All @@ -378,7 +378,7 @@ while it has the drive mounted.
Dealing with Multiple Magazines
-------------------------------

:raw-latex:`\index[general]{Magazines!Dealing with Multiple}`
:index:`pair: <Magazines;Dealing with Multiple>`

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
Expand Down Expand Up @@ -497,7 +497,7 @@ several alternatives.
Update Slots Command
--------------------

:raw-latex:`\index[general]{Console!Command!update slots}`
:index:`triple: <Console;Command;update slots>`


.. _`updateslots`: updateslots
Expand Down Expand Up @@ -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: <Autochanger;Using the>`


.. _`using`: using
Expand Down Expand Up @@ -709,8 +709,8 @@ like the following:
Barcode Support
---------------

:raw-latex:`\index[general]{Support!Barcode}`
:raw-latex:`\index[general]{Barcode Support}`
:index:`pair: <Support;Barcode>`
:index:`Barcode Support`


.. _`Barcodes`: Barcodes
Expand Down Expand Up @@ -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`: autochanger-interface
Expand Down Expand Up @@ -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: <Tuning;Tape>`
:index:`pair: <Tuning;blocksize>`
:index:`pair: <Tape;speed>`
:index:`pair: <Blocksize;optimize>`


.. _`Tapespeed and blocksizes`: Tapespeed and blocksizes
Expand Down Expand Up @@ -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: <bls;block size>`
:index:`pair: <bextract;block size>`
:index:`triple: <Command;bls;block size>`
:index:`triple: <Command;bextract;block size>`

:program:`bls` and :program:`bextract` can
directly access Bareos volumes without catalog database. This means that
Expand Down
4 changes: 2 additions & 2 deletions 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
Expand Down

0 comments on commit 5ca36fd

Please sign in to comment.