diff --git a/docs/manuals/en/new_main_reference/latex-scan.py b/docs/manuals/en/new_main_reference/latex-scan.py index bb4f747d39a..022c921503b 100755 --- a/docs/manuals/en/new_main_reference/latex-scan.py +++ b/docs/manuals/en/new_main_reference/latex-scan.py @@ -145,6 +145,11 @@ def __init__(self): 'flags': re.VERBOSE, 'replace': r'/include/images/\1.*\n' }, + 'LOWERBAREOS': { + 'pattern': r' _LOWERBAREOS-', + 'flags': re.VERBOSE, + 'replace': r'_bareos-' + }, 'EnvBareosConfigResource': { 'pattern': r'::\n\n(\s*)\\begin{bareosConfigResource}{(.*?)}{(.*?)}{(.*?)}\s*\n(.*?)\n\s*\\end{bareosConfigResource}', 'flags': self.regexOpts, @@ -1280,7 +1285,7 @@ def user(item): # @staticmethod def variable(item): - item.replace(r'**{0}**'.format(*item.getParameters())) + item.replace(r'``{0}``\ '.format(*item.getParameters())) @staticmethod def volume(item): diff --git a/docs/manuals/en/new_main_reference/pre_conversion_changes.sh b/docs/manuals/en/new_main_reference/pre_conversion_changes.sh index 042b03290c1..423ad7c6122 100755 --- a/docs/manuals/en/new_main_reference/pre_conversion_changes.sh +++ b/docs/manuals/en/new_main_reference/pre_conversion_changes.sh @@ -49,9 +49,9 @@ for FILENAME in ${SOURCEFILES}; do \ | perl -0 -pe 's|\\subsubsubsection\{|\\paragraph\{|g' \ \ - | perl -0 -pe 's|\\releasenoteSection\{(.*?)\}|\\section*{\1}\n\n|smg' \ + | perl -0 -pe 's|\\releasenoteSection\{(.*?)\}|\\section{\1}|smg' \ \ - | perl -0 -pe 's|\\releasenote\{(.*?)\}|\\subsection*{bareos-\1}\n\\index[general]{bareos-\1!Release Notes}\n\n|smg' \ + | perl -0 -pe 's|\\releasenote\{(.*?)\}|\\subsection{bareos-\1}\n\n\\label{LOWERBAREOS-\1}\n\n\\index[general]{bareos-\1!Release Notes}\n\n|smg' \ \ | perl -0 -pe 's|\\releasenoteUnstable\{(.*?)\}|\\subsection*{\\textit{bareos-\1 (unstable)}}\n\n|smg' \ \ diff --git a/docs/manuals/en/new_main_reference/source/DocumentationStyleGuide.rst b/docs/manuals/en/new_main_reference/source/DocumentationStyleGuide.rst new file mode 100644 index 00000000000..e2a5d803340 --- /dev/null +++ b/docs/manuals/en/new_main_reference/source/DocumentationStyleGuide.rst @@ -0,0 +1,13 @@ + +Documentation Style Guide +========================= + + +.. toctree:: + + /DocumentationStyleGuide/Introduction.rst + /DocumentationStyleGuide/RestOverview.rst + /DocumentationStyleGuide/CommonNames.rst + /DocumentationStyleGuide/SpecificFormatting.rst + /DocumentationStyleGuide/BareosSpecificFormatting.rst + /DocumentationStyleGuide/Gotchas.rst diff --git a/docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/BareosSpecificFormatting.rst b/docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/BareosSpecificFormatting.rst new file mode 100644 index 00000000000..67836016d06 --- /dev/null +++ b/docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/BareosSpecificFormatting.rst @@ -0,0 +1,14 @@ +Bareos Specific Formatting +========================== + +.. toctree:: + + /DocumentationStyleGuide/BareosSpecificFormatting/DocumentFileStructure.rst + /DocumentationStyleGuide/BareosSpecificFormatting/BareosHostNames.rst + /DocumentationStyleGuide/BareosSpecificFormatting/BareosConfiguration.rst + /DocumentationStyleGuide/BareosSpecificFormatting/Bconsole.rst + /DocumentationStyleGuide/BareosSpecificFormatting/BareosLogging.rst + /DocumentationStyleGuide/BareosSpecificFormatting/Limitation.rst + /DocumentationStyleGuide/BareosSpecificFormatting/Ticket.rst + /DocumentationStyleGuide/BareosSpecificFormatting/BareosVersions.rst + /DocumentationStyleGuide/BareosSpecificFormatting/Release.rst diff --git a/docs/manuals/en/style_guide/source/BareosSpecificFormatting/BareosConfiguration.rst b/docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/BareosSpecificFormatting/BareosConfiguration.rst similarity index 94% rename from docs/manuals/en/style_guide/source/BareosSpecificFormatting/BareosConfiguration.rst rename to docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/BareosSpecificFormatting/BareosConfiguration.rst index 70dae91277e..b81e06c1ca0 100644 --- a/docs/manuals/en/style_guide/source/BareosSpecificFormatting/BareosConfiguration.rst +++ b/docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/BareosSpecificFormatting/BareosConfiguration.rst @@ -9,12 +9,12 @@ To display a Bareos specific resource configuration file, use a code block: .. ${PERL} 's#\{bareosConfigResource\}\{(.*?)\}\{(.*?)\}\{(.*?)\}#\n.. code-block:: sh\n :caption: \1 \2 \3\n#g' ${DESTFILE} perl -i -pe 's#\{bareosConfigResource\}\{(.*)\}\{(.*)\}\{(.*)\}#\n.. code-block:: sh\n :caption: daemon:\1 resource:\2 name:\3\n#g' ${DESTFILE} -.. literalinclude:: /example/code-block-bareosconfig.rst.inc +.. literalinclude:: /DocumentationStyleGuide/example/code-block-bareosconfig.rst.inc :language: none which will be displayed as -.. include:: /example/code-block-bareosconfig.rst.inc +.. include:: /DocumentationStyleGuide/example/code-block-bareosconfig.rst.inc The *caption* shows the relevant path where to expect the configuration resource: @@ -147,7 +147,7 @@ For example: .. note:: - If the reference to a Resource Directive does not match a :ref:`BareosSpecificFormatting/BareosConfiguration:Resource Directive Definition`, + If the reference to a Resource Directive does not match a :ref:`DocumentationStyleGuide/BareosSpecificFormatting/BareosConfiguration:Resource Directive Definition`, the displayed text will look the same, but there will be no hyperlink behind it. Unfortenatly, if this is the case (the reference is wrong (e.g. because of a typo)) diff --git a/docs/manuals/en/style_guide/source/BareosSpecificFormatting/BareosHostNames.rst b/docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/BareosSpecificFormatting/BareosHostNames.rst similarity index 80% rename from docs/manuals/en/style_guide/source/BareosSpecificFormatting/BareosHostNames.rst rename to docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/BareosSpecificFormatting/BareosHostNames.rst index 977700d9c97..478cb7f09c1 100644 --- a/docs/manuals/en/style_guide/source/BareosSpecificFormatting/BareosHostNames.rst +++ b/docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/BareosSpecificFormatting/BareosHostNames.rst @@ -15,11 +15,11 @@ If you want to display a hostname, the following formatting should be followed: .. code-block:: sh - :strong:`client1.example.com` + :strong:`host1.example.com` The output should look like this: -:strong:`client1.example.com` +:strong:`host1.example.com` .. csv-table:: Host Names @@ -29,4 +29,5 @@ The output should look like this: ":strong:`bareos-sd.example.com`", "Bareos Storage Daemon host, if only one Storage Daemon is used." ":strong:`bareos-sd1.example.com`, :strong:`bareos-sd2.example.com`, ...", "Bareos Storage Daemon host, if multiple Storage Daemons are used." ":strong:`bareos-sd-tape.example.com`", "Bareos Storage Daemon with a specific backend." - ":strong:`client1.example.com`, :strong:`client2.example.com`, ...", "Bareos File Daemon" + ":strong:`host.example.com`", "An arbitrary system, without special requirements." + ":strong:`host1.example.com`, :strong:`host2.example.com`, ...", "Bareos File Daemon" diff --git a/docs/manuals/en/style_guide/source/BareosSpecificFormatting/BareosLogging.rst b/docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/BareosSpecificFormatting/BareosLogging.rst similarity index 59% rename from docs/manuals/en/style_guide/source/BareosSpecificFormatting/BareosLogging.rst rename to docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/BareosSpecificFormatting/BareosLogging.rst index f52bfc6198d..080cd8c7600 100644 --- a/docs/manuals/en/style_guide/source/BareosSpecificFormatting/BareosLogging.rst +++ b/docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/BareosSpecificFormatting/BareosLogging.rst @@ -5,8 +5,8 @@ If you want to display Bareos specific logs, use following formatting: .. ${PERL} 's#\{logging\}\{(.*)\}#\n.. code-block:: sh\n :caption: \1\n#g' ${DESTFILE} -.. literalinclude:: /example/code-block-bareoslog.rst.inc +.. literalinclude:: /DocumentationStyleGuide/example/code-block-bareoslog.rst.inc The output will look like this: -.. include:: /example/code-block-bareoslog.rst.inc +.. include:: /DocumentationStyleGuide/example/code-block-bareoslog.rst.inc diff --git a/docs/manuals/en/style_guide/source/BareosSpecificFormatting/BareosVersions.rst b/docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/BareosSpecificFormatting/BareosVersions.rst similarity index 86% rename from docs/manuals/en/style_guide/source/BareosSpecificFormatting/BareosVersions.rst rename to docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/BareosSpecificFormatting/BareosVersions.rst index 7b19811de70..bb833abd21b 100644 --- a/docs/manuals/en/style_guide/source/BareosSpecificFormatting/BareosVersions.rst +++ b/docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/BareosSpecificFormatting/BareosVersions.rst @@ -32,12 +32,12 @@ and Example: -.. literalinclude:: /example/sinceVersion-configuration-scheme.rst.inc +.. literalinclude:: /DocumentationStyleGuide/example/sinceVersion-documentation-sphinx.rst.inc :language: none This will be displayed as: -.. include:: /example/sinceVersion-configuration-scheme.rst.inc +.. include:: /DocumentationStyleGuide/example/sinceVersion-documentation-sphinx.rst.inc Note diff --git a/docs/manuals/en/style_guide/source/BareosSpecificFormatting/Bconsole.rst b/docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/BareosSpecificFormatting/Bconsole.rst similarity index 88% rename from docs/manuals/en/style_guide/source/BareosSpecificFormatting/Bconsole.rst rename to docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/BareosSpecificFormatting/Bconsole.rst index 7ff411ece22..cfae9724837 100644 --- a/docs/manuals/en/style_guide/source/BareosSpecificFormatting/Bconsole.rst +++ b/docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/BareosSpecificFormatting/Bconsole.rst @@ -44,12 +44,12 @@ Bconsole session If you want to show complete Bareos console session, then it needs to be put in a code block. -.. literalinclude:: /example/code-block-bconsole-configure-add.rst.inc +.. literalinclude:: /DocumentationStyleGuide/example/code-block-bconsole-configure-add.rst.inc :language: none The output will look like this: -.. include:: /example/code-block-bconsole-configure-add.rst.inc +.. include:: /DocumentationStyleGuide/example/code-block-bconsole-configure-add.rst.inc A prompt is indicated by ''*''. diff --git a/docs/manuals/en/style_guide/source/BareosSpecificFormatting/DocumentFileStructure.rst b/docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/BareosSpecificFormatting/DocumentFileStructure.rst similarity index 87% rename from docs/manuals/en/style_guide/source/BareosSpecificFormatting/DocumentFileStructure.rst rename to docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/BareosSpecificFormatting/DocumentFileStructure.rst index 60525526227..9011c432a8b 100644 --- a/docs/manuals/en/style_guide/source/BareosSpecificFormatting/DocumentFileStructure.rst +++ b/docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/BareosSpecificFormatting/DocumentFileStructure.rst @@ -40,7 +40,7 @@ The first heading should be underlined by ``=``, like:: Section Heading =============== -Please read :ref:`RestOverview:Sections` to get known to the section ordering conventions. +Please read :ref:`DocumentationStyleGuide/RestOverview:Sections` to get known to the section ordering conventions. All documents should only contain one highest level section (underlined by ``=``). @@ -61,10 +61,10 @@ Files included by toctree will be inserted as one section level below the sectio .. warning:: Changing the file names will change the published URLs - and the autosectionlabels (see :ref:`RestOverview:Cross-linking markup`). + and the autosectionlabels (see :ref:`DocumentationStyleGuide/RestOverview:Cross-linking markup`). So link used from external source and also some internal links will no longer work. - See :ref:`Gotchas:toctree vs include`. + See :ref:`DocumentationStyleGuide/Gotchas:toctree vs include`. (Even without changing the file name, changing the section name will also break links.) diff --git a/docs/manuals/en/style_guide/source/BareosSpecificFormatting/Limitation.rst b/docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/BareosSpecificFormatting/Limitation.rst similarity index 75% rename from docs/manuals/en/style_guide/source/BareosSpecificFormatting/Limitation.rst rename to docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/BareosSpecificFormatting/Limitation.rst index e6020245759..55fe9a70557 100644 --- a/docs/manuals/en/style_guide/source/BareosSpecificFormatting/Limitation.rst +++ b/docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/BareosSpecificFormatting/Limitation.rst @@ -14,9 +14,9 @@ The short description should be as short as possible, as it will get part of the Example: -.. literalinclude:: /example/limitation-vm-configuration.rst.inc +.. literalinclude:: /DocumentationStyleGuide/example/limitation-example.rst.inc :language: none This will be displayed as: -.. include:: /example/limitation-vm-configuration.rst.inc +.. include:: /DocumentationStyleGuide/example/limitation-example.rst.inc diff --git a/docs/manuals/en/style_guide/source/BareosSpecificFormatting/Release.rst b/docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/BareosSpecificFormatting/Release.rst similarity index 89% rename from docs/manuals/en/style_guide/source/BareosSpecificFormatting/Release.rst rename to docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/BareosSpecificFormatting/Release.rst index e3a4b791221..d941c108a0c 100644 --- a/docs/manuals/en/style_guide/source/BareosSpecificFormatting/Release.rst +++ b/docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/BareosSpecificFormatting/Release.rst @@ -14,16 +14,16 @@ If you want to display the release notes of a Bareos stable release, use the fol #2 } -.. literalinclude:: /example/releasenotes-template.rst.inc +.. literalinclude:: /DocumentationStyleGuide/example/releasenotes-template.rst.inc Example: -.. literalinclude:: /example/releasenotes.rst.inc +.. literalinclude:: /DocumentationStyleGuide/example/releasenotes-17.2.7.rst.inc -Output: +See the output at :ref:`bareos-17.2.7`\ . -.. include:: /example/releasenotes.rst.inc +.. COMMENT include:: /DocumentationStyleGuide/example/releasenotes.rst.inc diff --git a/docs/manuals/en/style_guide/source/BareosSpecificFormatting/Ticket.rst b/docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/BareosSpecificFormatting/Ticket.rst similarity index 58% rename from docs/manuals/en/style_guide/source/BareosSpecificFormatting/Ticket.rst rename to docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/BareosSpecificFormatting/Ticket.rst index 2a8ff46b328..4a80a611221 100644 --- a/docs/manuals/en/style_guide/source/BareosSpecificFormatting/Ticket.rst +++ b/docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/BareosSpecificFormatting/Ticket.rst @@ -6,12 +6,12 @@ bugs.bareos.org If you want to reference to a ticket in https://bugs.bareos.org, the following formatting should be used: -.. literalinclude:: /example/ticket.rst.inc +.. literalinclude:: /DocumentationStyleGuide/example/ticket.rst.inc :language: none This will be displayed as: -.. include:: /example/ticket.rst.inc +.. include:: /DocumentationStyleGuide/example/ticket.rst.inc Github ------ @@ -28,12 +28,12 @@ Pull request Refer to a Github Pull request by: -.. literalinclude:: /example/github-pull-request.rst.inc +.. literalinclude:: /DocumentationStyleGuide/example/github-pull-request.rst.inc :language: none This will be displayed as: -.. include:: /example/github-pull-request.rst.inc +.. include:: /DocumentationStyleGuide/example/github-pull-request.rst.inc Commit @@ -41,9 +41,9 @@ Commit Refer to a Github Commit by: -.. literalinclude:: /example/github-commit.rst.inc +.. literalinclude:: /DocumentationStyleGuide/example/github-commit.rst.inc :language: none This will be displayed as: -.. include:: /example/github-commit.rst.inc +.. include:: /DocumentationStyleGuide/example/github-commit.rst.inc diff --git a/docs/manuals/en/style_guide/source/CommonNames.rst b/docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/CommonNames.rst similarity index 95% rename from docs/manuals/en/style_guide/source/CommonNames.rst rename to docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/CommonNames.rst index c88cb1e8614..988d5f9b664 100644 --- a/docs/manuals/en/style_guide/source/CommonNames.rst +++ b/docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/CommonNames.rst @@ -70,20 +70,6 @@ NDMP |ndmpbareos|, ``|ndmpbareos|`` |ndmpnative|, ``|ndmpnative|`` -.. _section-NdmpBareos: - -NDMP_BAREOS -~~~~~~~~~~~ - -This is only a fake section to demonstrate ``|ndmpbareos|``. Ignore it. - -.. _section-NdmpNative: - -NDMP_NATIVE -~~~~~~~~~~~ - -This is only a fake section to demonstrate ``|ndmpnative|``. Ignore it. - Products -------- diff --git a/docs/manuals/en/style_guide/source/Gotchas.rst b/docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/Gotchas.rst similarity index 84% rename from docs/manuals/en/style_guide/source/Gotchas.rst rename to docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/Gotchas.rst index 0f204ef868c..f38e38e988a 100644 --- a/docs/manuals/en/style_guide/source/Gotchas.rst +++ b/docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/Gotchas.rst @@ -13,7 +13,7 @@ or run :program:`make clean` before. Not shown text -------------- -When using :ref:`RestOverview:Directives`, they are prepanded by the comment directives: ''.. '' +When using :ref:`DocumentationStyleGuide/RestOverview:Directives`, they are prepanded by the comment directives: ''.. '' For this reason, any mispelled directives will not be shown at all (and not even are warning is shown during sphinx-build). @@ -29,14 +29,19 @@ For example, config directives can be defined and later on referenced by:: :config:option:`...` -If the link target :ref:`BareosSpecificFormatting/BareosConfiguration:Reference to a Resource Directive` is unknown, +If the link target :ref:`DocumentationStyleGuide/BareosSpecificFormatting/BareosConfiguration:Reference to a Resource Directive` is unknown, the displayed text will not alter. There will not even be a warning during Sphinx build, making it really hard to find typos in this kind of references. -TODO: example +* valid reference: + * :config:option:`dir/job/AlwaysIncrementalJobRetention` + +* invalid reference: + + * :config:option:`dir/job/ThisIsaDeadEntry` toctree vs include ------------------ @@ -75,4 +80,4 @@ toctree Don't use the ``:options:`` role, as this tries to refers to a option definition, which we don't have. Also, as we document different programs, using option would require to prefix it with the program name, see https://www.sphinx-doc.org/en/1.7/domains.html#directive-program. -This only applies to ``:options:`` without domain. We do you ``:config:option:`` in :ref:`BareosSpecificFormatting/BareosConfiguration:Bareos Configuration`. +This only applies to ``:options:`` without domain. We do you ``:config:option:`` in :ref:`DocumentationStyleGuide/BareosSpecificFormatting/BareosConfiguration:Bareos Configuration`. diff --git a/docs/manuals/en/style_guide/source/Introduction.rst b/docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/Introduction.rst similarity index 50% rename from docs/manuals/en/style_guide/source/Introduction.rst rename to docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/Introduction.rst index c7c92340e4f..d7960721eb0 100644 --- a/docs/manuals/en/style_guide/source/Introduction.rst +++ b/docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/Introduction.rst @@ -1,7 +1,7 @@ Introduction ============ -This is a complete guide to the language and style conventions used for Bareos Main Reference and Documentation. The Sphinx tool has been used to produce a presentable documentation using the reStructuredText (reST) files present in https://github.com/bareos/bareos/tree/master/docs/manuals/en/new_main_reference/source\ . +This is a complete guide to the language and style conventions used for Bareos Documentation. The Sphinx tool has been used to produce a presentable documentation using the reStructuredText (reST) files present in https://github.com/bareos/bareos/tree/master/docs/manuals/en/new_main_reference/source\ . The primary output format is HTML. It is doubtfull, is PDFs can be created easily (internally, Sphinx would convert to Latex first, and than use Latex to create the PDF). diff --git a/docs/manuals/en/style_guide/source/RestOverview.rst b/docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/RestOverview.rst similarity index 94% rename from docs/manuals/en/style_guide/source/RestOverview.rst rename to docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/RestOverview.rst index 3148ab56144..80cb0a52997 100644 --- a/docs/manuals/en/style_guide/source/RestOverview.rst +++ b/docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/RestOverview.rst @@ -23,7 +23,7 @@ reST/Sphinx have some specific wording. Role ~~~~ -A role is an inline markup (see :ref:`RestOverview:Inline markup`\ ). Own roles can be created. +A role is an inline markup (see :ref:`DocumentationStyleGuide/RestOverview:Inline markup`\ ). Own roles can be created. They are used inside other text structures. Usage:: @@ -37,7 +37,7 @@ Output: Directive ~~~~~~~~~ -A directive is an Explicit Markup (see :ref:`RestOverview:Explicit markup`\ ). Own directives can be created. +A directive is an Explicit Markup (see :ref:`DocumentationStyleGuide/RestOverview:Explicit markup`\ ). Own directives can be created. Directives are written as a block. Usage:: @@ -59,12 +59,12 @@ Usage:: Example: -.. literalinclude:: /example/code-block-bareosconfig.rst.inc +.. literalinclude:: /DocumentationStyleGuide/example/code-block-bareosconfig.rst.inc :language: none Output: -.. include:: /example/code-block-bareosconfig.rst.inc +.. include:: /DocumentationStyleGuide/example/code-block-bareosconfig.rst.inc Domain @@ -252,12 +252,12 @@ finds links and mail addresses in ordinary text. Example: -.. literalinclude:: /example/urls.rst.inc +.. literalinclude:: /DocumentationStyleGuide/example/urls.rst.inc :language: none Output: -.. include:: /example/urls.rst.inc +.. include:: /DocumentationStyleGuide/example/urls.rst.inc Internal links @@ -331,9 +331,9 @@ This prefix each section label with the name (including the relative path from t Example:: - :ref:`RestOverview:Cross-linking markup` + :ref:`DocumentationStyleGuide/RestOverview:Cross-linking markup` -This will link to :ref:`RestOverview:Cross-linking markup`\ . +This will link to :ref:`DocumentationStyleGuide/RestOverview:Cross-linking markup`\ . @@ -382,7 +382,7 @@ Our convention is to use them in this order: This convention has be introduced from the conversion of the original LaTex source to reST, -as :program:`pandoc` has created RST file with this section markers (except of parts, which are not created at all). +as :program:`pandoc` has created reST file with this section markers (except of parts, which are not created at all). The part section header is not used at all by us. @@ -392,7 +392,7 @@ Therefore the specific names part, chapter, section ... might not match the actu .. note:: - With RST, there is no leaving out a section level. + With reST, there is no leaving out a section level. If you write a chapter it is not possible to continue with a paragraph. Instead the next section must be of the type section. @@ -458,11 +458,11 @@ Backslashes (Windows paths) ``\`` have to written as ``\\``: The formatting looks a follows: -.. literalinclude:: /example/file.rst.inc +.. literalinclude:: /DocumentationStyleGuide/example/file.rst.inc Output: -.. include:: /example/file.rst.inc +.. include:: /DocumentationStyleGuide/example/file.rst.inc @@ -632,7 +632,7 @@ To work around these problem, following substitution have been used:: is substitted by:: - :index:`[TAG=Console->Command->restore] ` + :index:`[TAG=Console->Command->restore] ` Disadvantages: The text ``[TAG=Console->Command->restore]`` will be shown. diff --git a/docs/manuals/en/style_guide/source/SpecificFormatting.rst b/docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/SpecificFormatting.rst similarity index 73% rename from docs/manuals/en/style_guide/source/SpecificFormatting.rst rename to docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/SpecificFormatting.rst index 078b5f65680..c6d7345e238 100644 --- a/docs/manuals/en/style_guide/source/SpecificFormatting.rst +++ b/docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/SpecificFormatting.rst @@ -6,17 +6,17 @@ Configuration File Configuration file (snippets) should be formatted as -.. literalinclude:: /example/code-block-cfg-mysql.rst.inc +.. literalinclude:: /DocumentationStyleGuide/example/code-block-cfg-mysql.rst.inc :language: none This will be displayed as: -.. include:: /example/code-block-cfg-mysql.rst.inc +.. include:: /DocumentationStyleGuide/example/code-block-cfg-mysql.rst.inc The code-block highlighting scheme should be suitable for all kind of configuration files, especially ini files. However, Bareos configuration resources, we use our own scheme, -see :ref:`BareosSpecificFormatting/BareosConfiguration:Bareos Configuration Resource`. +see :ref:`DocumentationStyleGuide/BareosSpecificFormatting/BareosConfiguration:Bareos Configuration Resource`. -.. seealso:: :ref:`BareosSpecificFormatting/BareosConfiguration:Bareos Configuration Resource` +.. seealso:: :ref:`DocumentationStyleGuide/BareosSpecificFormatting/BareosConfiguration:Bareos Configuration Resource` Configuration @@ -35,7 +35,7 @@ The output should look like this: ``host = s3.amazonaws.com`` -However, for a Bareos configuration directive with value use :ref:`BareosSpecificFormatting/BareosConfiguration:Resource Directive With Value`\ . +However, for a Bareos configuration directive with value use :ref:`DocumentationStyleGuide/BareosSpecificFormatting/BareosConfiguration:Resource Directive With Value`\ . @@ -46,12 +46,12 @@ If you want to display a unix command, then it needs to be put in a code block. Example: -.. literalinclude:: /example/code-block-shell-session.rst.inc +.. literalinclude:: /DocumentationStyleGuide/example/code-block-shell-session.rst.inc :language: none This will be displayed as: -.. include:: /example/code-block-shell-session.rst.inc +.. include:: /DocumentationStyleGuide/example/code-block-shell-session.rst.inc Unix Commmand Prompt @@ -62,7 +62,7 @@ Normally, we assume a root console on Linux: ``root@host:~#``\ . Mind a space af The hostname **host** is used, if it is a generic host. If the command runs on a specific Bareos server, -the specific host name from :ref:`BareosSpecificFormatting/BareosHostNames:Bareos Host Names` should be used. +the specific host name from :ref:`DocumentationStyleGuide/BareosSpecificFormatting/BareosHostNames:Bareos Host Names` should be used. System Command ~~~~~~~~~~~~~~ @@ -130,28 +130,28 @@ SQL Example: -.. literalinclude:: /example/code-block-sql-create-index.rst.inc +.. literalinclude:: /DocumentationStyleGuide/example/code-block-sql-create-index.rst.inc :language: none This will be displayed as: -.. include:: /example/code-block-sql-create-index.rst.inc +.. include:: /DocumentationStyleGuide/example/code-block-sql-create-index.rst.inc Logging ------- -Currently, only Bareos logs (:ref:`BareosSpecificFormatting/BareosLogging:Bareos Logging`) +Currently, only Bareos logs (:ref:`DocumentationStyleGuide/BareosSpecificFormatting/BareosLogging:Bareos Logging`) are part of the documentation. General logs are currently not used. If they should be used in the future, use -.. literalinclude:: /example/logfile.rst.inc +.. literalinclude:: /DocumentationStyleGuide/example/logfile.rst.inc :language: none The output will look like this: -.. include:: /example/logfile.rst.inc +.. include:: /DocumentationStyleGuide/example/logfile.rst.inc If logfiles should be shown more often, an own language marker can be implemented for it. @@ -178,7 +178,6 @@ Especially it should be used for: * Software Package (e.g. package **bareos-common**, has been ``\package{}`` in Latex. Did create indices in the past.) * System User (e.g. user **root**, has been ``\user{}`` in Latex)) * System Group (e.g. group **bareos**, has been ``\group{}`` in Latex)) -* Variable Name (has been ``\variable{}`` in Latex) * Volume Name (has been ``\volume{}`` in Latex) * Volume Status (UPPPERCASE) (has been ``\volumestatus{}`` in Latex) @@ -186,10 +185,11 @@ Unless a specific rule for this kind of item exists. Specific rules exist for: -* Substitutions form :ref:`CommonNames:Common Names`. -* :ref:`BareosSpecificFormatting/BareosHostNames:Bareos Host Names`. -* :ref:`SpecificFormatting:Operating System`. -* :ref:`Configuration Resource Names `. +* Substitutions form :ref:`DocumentationStyleGuide/CommonNames:Common Names`. +* :ref:`DocumentationStyleGuide/BareosSpecificFormatting/BareosHostNames:Bareos Host Names`. +* :ref:`DocumentationStyleGuide/SpecificFormatting:Operating System`. +* :ref:`DocumentationStyleGuide/SpecificFormatting:Environment Variable`. +* :ref:`Configuration Resource Names `. @@ -230,12 +230,12 @@ Operating System If you want to display an operating system name, the following formatting should be used: -.. literalinclude:: /example/os.rst.inc +.. literalinclude:: /DocumentationStyleGuide/example/os.rst.inc :language: none The output will look like this: -.. include:: /example/os.rst.inc +.. include:: /DocumentationStyleGuide/example/os.rst.inc As an index is generated from the operation systems, the naming should be identical in all occurances. The first space seperates the platform from the version. @@ -260,8 +260,8 @@ Backus–Naur form To display Backus–Naur form (BNF) definitions, use following formatting: -.. literalinclude:: /example/code-block-bnf.rst.inc +.. literalinclude:: /DocumentationStyleGuide/example/code-block-bnf.rst.inc The output will look like this: -.. include:: /example/code-block-bnf.rst.inc +.. include:: /DocumentationStyleGuide/example/code-block-bnf.rst.inc diff --git a/docs/manuals/en/style_guide/source/example/code-block-bareosconfig.rst.inc b/docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/example/code-block-bareosconfig.rst.inc similarity index 100% rename from docs/manuals/en/style_guide/source/example/code-block-bareosconfig.rst.inc rename to docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/example/code-block-bareosconfig.rst.inc diff --git a/docs/manuals/en/style_guide/source/example/code-block-bareoslog.rst.inc b/docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/example/code-block-bareoslog.rst.inc similarity index 100% rename from docs/manuals/en/style_guide/source/example/code-block-bareoslog.rst.inc rename to docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/example/code-block-bareoslog.rst.inc diff --git a/docs/manuals/en/style_guide/source/example/code-block-bconsole-configure-add.rst.inc b/docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/example/code-block-bconsole-configure-add.rst.inc similarity index 100% rename from docs/manuals/en/style_guide/source/example/code-block-bconsole-configure-add.rst.inc rename to docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/example/code-block-bconsole-configure-add.rst.inc diff --git a/docs/manuals/en/style_guide/source/example/code-block-bnf.rst.inc b/docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/example/code-block-bnf.rst.inc similarity index 100% rename from docs/manuals/en/style_guide/source/example/code-block-bnf.rst.inc rename to docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/example/code-block-bnf.rst.inc diff --git a/docs/manuals/en/style_guide/source/example/code-block-cfg-mysql.rst.inc b/docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/example/code-block-cfg-mysql.rst.inc similarity index 100% rename from docs/manuals/en/style_guide/source/example/code-block-cfg-mysql.rst.inc rename to docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/example/code-block-cfg-mysql.rst.inc diff --git a/docs/manuals/en/style_guide/source/example/code-block-shell-session.rst.inc b/docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/example/code-block-shell-session.rst.inc similarity index 100% rename from docs/manuals/en/style_guide/source/example/code-block-shell-session.rst.inc rename to docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/example/code-block-shell-session.rst.inc diff --git a/docs/manuals/en/style_guide/source/example/code-block-sql-create-index.rst.inc b/docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/example/code-block-sql-create-index.rst.inc similarity index 100% rename from docs/manuals/en/style_guide/source/example/code-block-sql-create-index.rst.inc rename to docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/example/code-block-sql-create-index.rst.inc diff --git a/docs/manuals/en/style_guide/source/example/file.rst.inc b/docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/example/file.rst.inc similarity index 100% rename from docs/manuals/en/style_guide/source/example/file.rst.inc rename to docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/example/file.rst.inc diff --git a/docs/manuals/en/style_guide/source/example/github-commit.rst.inc b/docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/example/github-commit.rst.inc similarity index 100% rename from docs/manuals/en/style_guide/source/example/github-commit.rst.inc rename to docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/example/github-commit.rst.inc diff --git a/docs/manuals/en/style_guide/source/example/github-pull-request.rst.inc b/docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/example/github-pull-request.rst.inc similarity index 100% rename from docs/manuals/en/style_guide/source/example/github-pull-request.rst.inc rename to docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/example/github-pull-request.rst.inc diff --git a/docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/example/limitation-example.rst.inc b/docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/example/limitation-example.rst.inc new file mode 100644 index 00000000000..319adb6e969 --- /dev/null +++ b/docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/example/limitation-example.rst.inc @@ -0,0 +1,4 @@ +.. limitation:: Style Guide: Example + + This is not a real limitation, but only a Style Guide example. + The description can contain multiple lines. diff --git a/docs/manuals/en/style_guide/source/example/logfile.rst.inc b/docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/example/logfile.rst.inc similarity index 100% rename from docs/manuals/en/style_guide/source/example/logfile.rst.inc rename to docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/example/logfile.rst.inc diff --git a/docs/manuals/en/style_guide/source/example/os.rst.inc b/docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/example/os.rst.inc similarity index 100% rename from docs/manuals/en/style_guide/source/example/os.rst.inc rename to docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/example/os.rst.inc diff --git a/docs/manuals/en/style_guide/source/example/releasenotes.rst.inc b/docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/example/releasenotes-17.2.7.rst.inc similarity index 100% rename from docs/manuals/en/style_guide/source/example/releasenotes.rst.inc rename to docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/example/releasenotes-17.2.7.rst.inc diff --git a/docs/manuals/en/style_guide/source/example/releasenotes-template.rst.inc b/docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/example/releasenotes-template.rst.inc similarity index 100% rename from docs/manuals/en/style_guide/source/example/releasenotes-template.rst.inc rename to docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/example/releasenotes-template.rst.inc diff --git a/docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/example/sinceVersion-documentation-sphinx.rst.inc b/docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/example/sinceVersion-documentation-sphinx.rst.inc new file mode 100644 index 00000000000..9c30de57f0f --- /dev/null +++ b/docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/example/sinceVersion-documentation-sphinx.rst.inc @@ -0,0 +1 @@ +From Bareos :sinceVersion:`19.2.1: Documentation converted from Latex to Sphinx` on, the Bareos documentation is written in reST/Sphinx instead of Latex. diff --git a/docs/manuals/en/style_guide/source/example/ticket.rst.inc b/docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/example/ticket.rst.inc similarity index 100% rename from docs/manuals/en/style_guide/source/example/ticket.rst.inc rename to docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/example/ticket.rst.inc diff --git a/docs/manuals/en/style_guide/source/example/urls.rst.inc b/docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/example/urls.rst.inc similarity index 100% rename from docs/manuals/en/style_guide/source/example/urls.rst.inc rename to docs/manuals/en/new_main_reference/source/DocumentationStyleGuide/example/urls.rst.inc diff --git a/docs/manuals/en/new_main_reference/source/developers/releasenotes.rst b/docs/manuals/en/new_main_reference/source/developers/releasenotes.rst index 15cbd6d07e7..e453f601be3 100644 --- a/docs/manuals/en/new_main_reference/source/developers/releasenotes.rst +++ b/docs/manuals/en/new_main_reference/source/developers/releasenotes.rst @@ -2,6 +2,8 @@ .. _bareos-1826-releasenotes: +.. _bareos-18.2.6: + Bareos 18.2.6 Release Notes =========================== @@ -59,6 +61,8 @@ New Features .. _bareos-1825-releasenotes: +.. _bareos-18.2.5: + Bareos 18.2.5 Release Notes =========================== diff --git a/docs/manuals/en/new_main_reference/source/index.rst b/docs/manuals/en/new_main_reference/source/index.rst index 180b8343ac2..459c73ed30b 100644 --- a/docs/manuals/en/new_main_reference/source/index.rst +++ b/docs/manuals/en/new_main_reference/source/index.rst @@ -22,4 +22,5 @@ The Information regarding the newest release in the :ref:`bareos-current-release /developers.rst /bareos-18.2.rst /webui-tls.rst + /DocumentationStyleGuide.rst /genindex diff --git a/docs/manuals/en/new_main_reference/split.py b/docs/manuals/en/new_main_reference/split.py index 48420174e0e..77e9d778ec9 100755 --- a/docs/manuals/en/new_main_reference/split.py +++ b/docs/manuals/en/new_main_reference/split.py @@ -228,7 +228,7 @@ class LatexParts(LatexSplit): def __init__(self, text, targetdir, relpath, write = True): super(LatexParts, self).__init__(text, r'\\part', 1, targetdir, relpath, write) - self.toc_extra_nodes = [ '/developers/releasenotes.rst', '/developers.rst', '/bareos-18.2.rst', '/webui-tls.rst', '/genindex' ] + self.toc_extra_nodes = [ '/developers/releasenotes.rst', '/developers.rst', '/bareos-18.2.rst', '/webui-tls.rst', '/DocumentationStyleGuide.rst', '/genindex' ] def getToc(self): ''' diff --git a/docs/manuals/en/style_guide/Makefile b/docs/manuals/en/style_guide/Makefile deleted file mode 100644 index ffe123ac96c..00000000000 --- a/docs/manuals/en/style_guide/Makefile +++ /dev/null @@ -1,29 +0,0 @@ -# Minimal makefile for Sphinx documentation -# - -# You can set these variables from the command line. -SPHINXOPTS = -SPHINXBUILD = sphinx-build -SPHINXPROJ = -SOURCEDIR = source -BUILDDIR = destination - - -# Put it first so that "make" without argument is like "make help". -all: - @$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) - #@$(SPHINXBUILD) -M latexpdf "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) - -help: - @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) - -check: - @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) - - -.PHONY: help Makefile - -# Catch-all target: route all unknown targets to Sphinx using the new -# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). -%: Makefile - @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/manuals/en/style_guide/source/BareosSpecificFormatting.rst b/docs/manuals/en/style_guide/source/BareosSpecificFormatting.rst deleted file mode 100644 index 75dc96e1f06..00000000000 --- a/docs/manuals/en/style_guide/source/BareosSpecificFormatting.rst +++ /dev/null @@ -1,14 +0,0 @@ -Bareos Specific Formatting -========================== - -.. toctree:: - - /BareosSpecificFormatting/DocumentFileStructure.rst - /BareosSpecificFormatting/BareosHostNames.rst - /BareosSpecificFormatting/BareosConfiguration.rst - /BareosSpecificFormatting/Bconsole.rst - /BareosSpecificFormatting/BareosLogging.rst - /BareosSpecificFormatting/Limitation.rst - /BareosSpecificFormatting/Ticket.rst - /BareosSpecificFormatting/BareosVersions.rst - /BareosSpecificFormatting/Release.rst diff --git a/docs/manuals/en/style_guide/source/_extensions b/docs/manuals/en/style_guide/source/_extensions deleted file mode 120000 index ae2ead7442a..00000000000 --- a/docs/manuals/en/style_guide/source/_extensions +++ /dev/null @@ -1 +0,0 @@ -../../new_main_reference/source/_extensions \ No newline at end of file diff --git a/docs/manuals/en/style_guide/source/conf.py b/docs/manuals/en/style_guide/source/conf.py deleted file mode 120000 index cf4500acdca..00000000000 --- a/docs/manuals/en/style_guide/source/conf.py +++ /dev/null @@ -1 +0,0 @@ -../../new_main_reference/source/conf.py \ No newline at end of file diff --git a/docs/manuals/en/style_guide/source/config b/docs/manuals/en/style_guide/source/config deleted file mode 120000 index 467dad8a61b..00000000000 --- a/docs/manuals/en/style_guide/source/config +++ /dev/null @@ -1 +0,0 @@ -../../main/config \ No newline at end of file diff --git a/docs/manuals/en/style_guide/source/example/limitation-vm-configuration.rst.inc b/docs/manuals/en/style_guide/source/example/limitation-vm-configuration.rst.inc deleted file mode 100644 index c7a85c00358..00000000000 --- a/docs/manuals/en/style_guide/source/example/limitation-vm-configuration.rst.inc +++ /dev/null @@ -1,4 +0,0 @@ -.. limitation:: VMware Plugin: VM configuration is not backed up - - The VM configuration is not backed up, - so that it is not yet possible to recreate a completely deleted VM. diff --git a/docs/manuals/en/style_guide/source/example/sinceVersion-configuration-scheme.rst.inc b/docs/manuals/en/style_guide/source/example/sinceVersion-configuration-scheme.rst.inc deleted file mode 100644 index 4d461aea037..00000000000 --- a/docs/manuals/en/style_guide/source/example/sinceVersion-configuration-scheme.rst.inc +++ /dev/null @@ -1 +0,0 @@ -From Bareos :sinceVersion:`16.2.4: Subdirectory Configuration Scheme used as Default` on, new installations will use configuration subdirectories by default. diff --git a/docs/manuals/en/style_guide/source/get-version.sh b/docs/manuals/en/style_guide/source/get-version.sh deleted file mode 120000 index 31179f9d96d..00000000000 --- a/docs/manuals/en/style_guide/source/get-version.sh +++ /dev/null @@ -1 +0,0 @@ -../../new_main_reference/source/get-version.sh \ No newline at end of file diff --git a/docs/manuals/en/style_guide/source/index.rst b/docs/manuals/en/style_guide/source/index.rst deleted file mode 100644 index c2f7fc870a4..00000000000 --- a/docs/manuals/en/style_guide/source/index.rst +++ /dev/null @@ -1,17 +0,0 @@ -.. master index - -Bareos Style Guide -================== - - -.. toctree:: - :caption: Table of Contents - :maxdepth: 2 - :numbered: - - Introduction.rst - RestOverview.rst - CommonNames.rst - SpecificFormatting.rst - BareosSpecificFormatting.rst - Gotchas.rst diff --git a/docs/manuals/en/style_guide/source/notes.txt b/docs/manuals/en/style_guide/source/notes.txt deleted file mode 100644 index 973618cf243..00000000000 --- a/docs/manuals/en/style_guide/source/notes.txt +++ /dev/null @@ -1,765 +0,0 @@ -.. _Guidelines: - -Guidelines for Bareos Manual -============================ - -.. _General: - -.. toctree:: - :maxdepth: 3 - - important_text - seldom_text - text_replacing - -\def\idir{images/} ..........................done (incomplete) - - - -\newcommand{\subsubsubsection}[1]{\paragraph{#1}}....... not handled in post - -.....................done......................................... -\newcommand{\bareosFd}{Bareos File Daemon\xspace} -\newcommand{\bareosSd}{Bareos Storage Daemon\xspace} -\newcommand{\bareosDir}{Bareos Director\xspace} -\newcommand{\bareosTrayMonitor}{Bareos Tray Monitor\xspace} -\newcommand{\bareosWebui}{Bareos Webui\xspace} -.................................................................. -% -% Bareos paths and filenames -% -\newcommand{\fileStoragePath}{\path|/var/lib/bareos/storage/|} -\newcommand{\scriptPathUnix}{\path|/usr/lib/bareos/scripts/|} -\newcommand{\configPathUnix}{\path|/etc/bareos/|} - -\newcommand{\configFileDirUnix}{\path|/etc/bareos/bareos-dir.conf|} -\newcommand{\configFileSdUnix}{\path|/etc/bareos/bareos-sd.conf|} -\newcommand{\configFileFdUnix}{\path|/etc/bareos/bareos-fd.conf|} -\newcommand{\configFileBconsoleUnix}{\path|/etc/bareos/bconsole.conf|} -\newcommand{\configFileTrayMonitorUnix}{\path|/etc/bareos/tray-monitor.conf|} -\newcommand{\configFileBatUnix}{\path|/etc/bareos/bat.conf|} - -\newcommand{\configDirectoryDirUnix}{\path|/etc/bareos/bareos-dir.d/|} -\newcommand{\configDirectorySdUnix}{\path|/etc/bareos/bareos-sd.d/|} -\newcommand{\configDirectoryFdUnix}{\path|/etc/bareos/bareos-fd.d/|} -\newcommand{\configDirectoryBconsoleUnix}{\path|/etc/bareos/bconsole.d/|} -\newcommand{\configDirectoryTrayMonitorUnix}{\path|/etc/bareos/tray-monitor.d/|} - -\newcommand{\logfileUnix}{\path|/var/log/bareos/bareos.log|} - -\newcommand{\yesno}{yes{\textbar}no} -% .............will discuss later -% data type definitions. -% all data types should be defined here. -% use them in xdirective. -\csdef{dtAcl}{\ilink{acl}{DataTypeAcl}} -\csdef{dtAddress}{\ilink{net-address}{DataTypeNetAddress}} -\csdef{dtAddresses}{\ilink{net-addresses}{DataTypeNetAddresses}} -\csdef{dtAuditCommandList}{\ilink{audit-command-list}{DataTypeAuditCommandList}} -\csdef{dtAuthType}{\ilink{None{\textbar}Clear{\textbar}MD5}{DataTypeAuthType}} -\csdef{dtAutopassword}{\ilink{password}{DataTypePassword}} -% internaly, bit and boolean are handled differently. -% However, for the user this does not matter. -\csdef{dtBit}{\ilink{\yesno}{DataTypeYesNo}} -\csdef{dtBoolean}{\ilink{\yesno}{DataTypeYesNo}} -\csdef{dtDirectory}{\ilink{path}{DataTypeDirectory}} -\csdef{dtName}{\ilink{name}{DataTypeName}} -\csdef{dtNetAddress}{\ilink{net-address}{DataTypeNetAddress}} -\csdef{dtNetAddresses}{\ilink{net-addresses}{DataTypeNetAddresses}} -\csdef{dtNetPort}{\ilink{net-port}{DataTypeNetPort}} -\csdef{dtMessages}{[ address = ] \ilink{message-type}{MessageTypes} [ , \ilink{message-type}{MessageTypes} ]* } -\csdef{dtPassword}{\ilink{password}{DataTypePassword}} -\csdef{dtPath}{\ilink{path}{DataTypePath}} -% use csdef instead of newcommand, because command contains numbers -\csdef{dtPint32}{\dtUInt} -\csdef{dtProtocolType}{\ilink{job protocol}{DataTypeJobProtocol}} -\csdef{dtRes}{\ilink{resource-name}{DataTypeRes}} -\csdef{dtPort}{\dtNetPort} -\csdef{dtScheduleRunCommand}{{job-overrides{\gt} {\lt}date-time-specification}} -\csdef{dtSize}{\ilink{size}{DataTypeSize}} -\csdef{dtSpeed}{\ilink{speed}{DataTypeSpeed}} -\csdef{dtString}{\ilink{string}{DataTypeString}} -\csdef{dtStringList}{\ilink{string-list}{DataTypeStringList}} -\csdef{dtStrname}{\ilink{strname}{DataTypeStrname}} -\csdef{dtTime}{\ilink{time}{DataTypeTime}} -\csdef{dtUInt}{\ilink{positive-integer}{DataTypePositiveInteger}} -\csdef{dtYesNo}{\ilink{\yesno}{DataTypeYesNo}} - -\newcommand{\dt}[1]{% - \ifcsdef{dt#1}{\csuse{dt#1}}{\path|#1|}% -} -................................................................................ -............................will discuss later -% 1: text, 2. label -% \ilink{target}{text} -% Inserts the text indicated (highlighted) and provides -% an internal hyperlink to the target. Target must be a -% \label somewhere in the same document. -\newcommand*{\ilink}[2]{% - %\htmlref{#1}{#2}% - \hyperref[#2]{#1}% -} - -% or use \nameref{label} or \autoref{label} - -% check mark internal link -\newcommand{\cmlink}[1]{\ilink{\bcheckmark}{#1}} - -........................................................................ -\newcommand{\ticket}[1]{% - \href{https://bugs.bareos.org/view.php?id=#1}{Ticket \##1}% -} - -\newcommand{\releaseUrlDownloadBareosOrg}[1]{% -\url{http://download.bareos.org/bareos/release/#1/}% -} - -\newcommand{\releaseUrlDownloadBareosCom}[1]{% -\url{https://download.bareos.com/bareos/release/#1/}% -} - -\newcommand{\contribDownloadBareosOrg}{% -\url{http://download.bareos.org/bareos/contrib/}% -} -..................................................will discuss later -% handle links to the Bareos Developer Guide via own commands -% to keep track of cross links -\newcommand{\developerGuide}[1]{% -\elink{Bareos Developer Guide (#1)}{http://doc.bareos.org/master/html/bareos-developer-guide.html\##1}% -} - -\newcommand{\bareosDeveloperGuideDotCommands}{% -\developerGuide{dot-commands} -} -\newcommand{\bareosDeveloperGuideApiModeJson}{% -\developerGuide{api-mode-2-json} -} -\newcommand{\bareosDeveloperGuideStorageMediaOutputFormat}{% -\developerGuide{storage-media-output-format} -} -\newcommand{\bareosWhitepaperTapeSpeedTuning}{% -\elink{Bareos Whitepaper Tape Speed Tuning}{http://www.bareos.org/en/Whitepapers/articles/Speed_Tuning_of_Tape_Drives.html}\xspace% -} - -\newcommand{\bareosMigrateConfigSh}{% -\elink{bareos-migrate-config.sh}{https://github.com/bareos/bareos-contrib/blob/master/misc/bareos-migrate-config/bareos-migrate-config.sh}\xspace% -} - -\newcommand{\bareosTlsConfigurationExample}{% -\elink{Bareos Regression Testing Base Configuration}{https://github.com/bareos/bareos-regress/tree/master/configs/BASE/}\xspace% -} - -\newcommand{\externalReferenceDroplet}{% -\url{https://github.com/scality/Droplet}\xspace% -} - -\newcommand{\externalReferenceIsilonNdmpEnvironmentVariables}{% -\elink{Isilon OneFS 7.2.0 CLI Administration Guide}{https://www.emc.com/collateral/TechnicalDocument/docu56048.pdf}, section \bquote{NDMP environment variables}\xspace% -} -.................................................................... - -% these characters must be quoted in Bareos config files: &<>()@^| -\newcommand{\configCharsToQuote}{\parameter{&<>()@^}\textbar\ } - ...........implement the above and document - - - -\newcommand{\resourcename}{% -\@ifstar{% -\resourcenameStar% -}{% -\resourcenameNostar% -}% -} -\makeatother -\newcommand{\resourcenameStar}[3]{\path|#3|}............not in tex -\newcommand{\resourcenameNostar}[3]{\path|#3|$^{\mbox{\tiny #1}}_{\mbox{\tiny #2}}$}.............not in tex - - - -% NDMP -........................done........................... -\newcommand{\DataManagementAgent}{Data Management Agent\xspace} -\newcommand{\DataAgent}{Data Agent\xspace} -\newcommand{\TapeAgent}{Tape Agent\xspace} -\newcommand{\RobotAgent}{Robot Agent\xspace} - -................................................... -\newcommand{\NdmpBareos}{\ilink{NDMP\_BAREOS}{sec:NdmpBareos}} -\newcommand{\NdmpNative}{\ilink{NDMP\_NATIVE}{sec:NdmpNative}} -..................................................................... - -% Bareos quote -\newcommand{\bquote}[1]{``#1''} - -\newcommand{\warning}[1]{Please note! \textit{#1}} - - -..... later to be seen..... -\newcommand{\releasenoteSection}[1]{ - \section*{#1} - \addcontentsline{toc}{section}{\protect\numberline{}#1}% -} -................................. - -% 1: version, 2: description -\newcommand{\releasenote}[2]{ - \subsection*{bareos-#1} - \addcontentsline{toc}{subsection}{\protect\numberline{}#1}% - \label{bareos-#1} - \index[general]{bareos-#1!Release Notes}% - #2 -} - -\newcommand{\releasenoteUnstable}[2]{ - \subsection*{\textit{bareos-#1 (unstable)}} - %\addcontentsline{toc}{subsection}{\protect\numberline{}#1}% - %\index[general]{bareos-#1!Release Notes}% - #2 -}....... not been handled by post - - -\newcommand{\sinceVersion}[3]{% -% 1: daemon (dir|sd|fd), -% 2: item, -% 3: version -\edef\pv{#3}% -\ifcsvoid{pv}{}{% -Version $>=$ #3% -%\index[#1]{#2}% -% expand variables -\edef\temp{\noexpand\index[general]{bareos-#3!#2}}% -\temp% -}% -} - - -\makeatletter -\newcommand{\limitation}{% -\@ifstar{% -\limitationStar -}{% -\limitationNostar -}% -} -\makeatother...... see how to implement and document - -\newcommand{\limitationStar}[3]{% -\paragraph{#2.} -%\limitationCommon{#1}{#2}{#3} -#3 -\index[general]{Limitation!#1!#2}% -\index[general]{#1!Limitation!#2}% -} - -\newcommand{\limitationNostar}[3]{% -\paragraph{Limitation: #1: #2.} -%\limitationCommon{#1}{#2}{#3} -#3 -\index[general]{Limitation!#1!#2}% -\index[general]{#1!Limitation!#2}% -}.................. not present in tex - - -% #1 backend name (Rados) -% [ #2: backend category (CEPH Object Store) ] -\newcommand{\sdBackend}[2]{% - \ifthenelse{\isempty{#2}}{% - \path|#1|% - \index[general]{#1}% - \index[sd]{Backend!#1}% - }{% - \path|#1| (#2)% - \index[general]{#1 (#2)}% - \index[general]{#2!#1}% - \index[sd]{Backend!#1 (#2)}% - }% -} ............. not being handled by post - -.... check if used at all.... -\newcommand{\betaSince}[3]{\index[#1]{#2}Included as beta since version #3. Don't use in productive environment!} .... used once -\newcommand{\deprecatedSince}[3]{This option is deprecated since version #3} .......not used -\newcommand{\removedSince}[3]{This option is removed since version #3} ..........not used - -\newcommand{\xdirective}[8]{ ..................only used in scripts -% 1: config file (Dir | Sd | Fd | Console) -% 2: Resource -% 3: directive name -% 4: directive data type (\dtXXX) or value -% 5: "required" | "" -% 6: default value -% 7: "deprecated" | since version -% 8: description -% -% translate daemon name to lowercase. -% Unfortunally, the result of -% \MakeLowercase{#1} or \makefirstuc{#1} -% can be used for \index -\ifthenelse{\equal{#1}{Dir}}{ - \def\daemon{dir} -}{ - \ifthenelse{\equal{#1}{Sd}}{ - \def\daemon{sd} - }{ - \ifthenelse{\equal{#1}{Fd}}{ - \def\daemon{fd} - }{ - \ifthenelse{\equal{#1}{Console}}{ - \def\daemon{console} - }{ - % hopefully, no translatation needed. Take original parameter - \def\daemon{#1} - } - } - } -} -% -\item [\hypertarget{directive#1#2#3}{#3} = {\textless}#4{\textgreater}]% - \hfill% - \ifthenelse{\isempty{#6}}{}{(default: #6)}% - \ifthenelse{\isempty{#5}}{}{(#5)}% - \hfill \\% - %\index[\daemon]{#3|textbf}% - \index[\daemon]{Configuration Directive!#3|textbf}% - \ifthenelse{\equal{#7}{deprecated}}{% -\warning{This directive is deprecated.\\} - }{}% -#8\ \\% - \ifthenelse{\equal{#7}{deprecated}}{}{% - \ifthenelse{\equal{#7}{}}{}{% - \sinceVersion{\daemon}{#3}{#7}% - }% - }% -} -% usage: -% \xdirective{Dir|Sd|Fd}{Resource}{Name}{\dtXXX}{required}{default}{version}{% -% } -% \xdirective{}{}{}{}{required}{}{}{} - - -\newcommand{\defDirective}[6]{% ................ only used by scripts -% defDirective: -% provide additional information to a directive. -% These information will not displayed right away, -% but used by \resourceDirective -% which will be used at autogenerated/*-resource-*-description.tex -% -% 1: daemon (Dir | Sd | Fd | Console) -% 2: Resource -% 3: DirectiveName -% 4: "" | parameter (postgresql | mysql | ...) -% 5: "" | since version -% 6: description -% can't contain verbatim/lstlisting parts. -% Therefore use \bconfiginput{filename} to include config examples. -\def\pp{#4} -\def\pv{#5} -\def\pd{#6} -\ifcsvoid{pp}{}{% - \csdef{directiveParameter#1#2#3}{#4}% -}% -\ifcsvoid{pv}{}{% - \csdef{directiveSinceVersion#1#2#3}{#5}% -}% -\ifcsvoid{pd}{}{% - \csdef{directiveDescription#1#2#3}{#6}% -}% -% -\ifcsvoid{resourceDirectiveDefined#1#2#3}{% -\wlog{Warning: defDirective{#1}{#2}{#3} has no matching resourceDirective and will be ignored} -}{}% -} - -\newcommand{\resourceDirective}[8]{% ..... only used in scripts -% 1: config file (Dir | Sd | Fd) -% 2: Resource -% 3: directive name -% 4: directive data type (\dtXXX) or value -% 5: "required" | "" -% 6: default value -% 7: "deprecated" | since version -% 8: description -\ifcsdef{directiveParameter#1#2#3}{% - \csletcs{resourceDirectiveParameter}{directiveParameter#1#2#3}% -}{% - \csdef{resourceDirectiveParameter}{#4}% -}% -\ifcsdef{directiveSinceVersion#1#2#3}{% - \csletcs{resourceDirectiveVersion}{directiveSinceVersion#1#2#3}% -}{% - \csedef{resourceDirectiveVersion}{#7}% -}% -\xdirective{#1}{#2}{#3}{\resourceDirectiveParameter}{#5}{#6}{\resourceDirectiveVersion}{% -\ifthenelse{\isempty{#8}}{}{% -#8 - -}% -\ifcsdef{directiveDescription#1#2#3}{\csuse{directiveDescription#1#2#3}}{}% -}% -} - -\makeatletter -\newcommand{\linkResourceDirective}{% -\@ifstar{% -\linkResourceDirectiveStar% -}{% -\linkResourceDirectiveNostar% -}% -} -\makeatother - -\newcommand{\linkResourceDirectiveStar}[3]{% -\linkResourceDirectiveOpt{#1}{#2}{#3}{#3}% -} - -\newcommand{\linkResourceDirectiveNostar}[3]{% -\linkResourceDirectiveOpt{#1}{#2}{#3}{#3 $^{\mbox{\tiny #1}}_{\mbox{\tiny #2}}$}% -} - -\newcommand{\linkResourceDirectiveOpt}[4]{% -% 1: config file (Dir | Sd | Fd) -% 2: Resource -% 3: Directive Name -% -\ifthenelse{\equal{#1}{Dir}}{% - \def\daemon{dir}% -}{% - \ifthenelse{\equal{#1}{Sd}}{% - \def\daemon{sd}% - }{% - \ifthenelse{\equal{#1}{Fd}}{% - \def\daemon{fd}% - }{% - \ifthenelse{\equal{#1}{Console}}{ - \def\daemon{console}% - }{% - % hopefully, no translatation needed. Take original parameter - \def\daemon{#1}% - }% - }% - }% -}% -\index[\daemon]{Configuration Directive!#3}% -\hyperlink{directive#1#2#3}{#4}% -} - -\newcommand{\linkResourceDirectiveValue}[4]{% -\linkResourceDirective{#1}{#2}{#3} \path|= #4|% -} - -\newcommand{\resourceDirectiveValue}[4]{% -\linkResourceDirectiveValue{#1}{#2}{#3}{#4}% -} - -% -% lstnewenvironment -% -% columns=fullflexible, keepspaces=true: prevents spaces between characters on copy-and-paste -% literate={-}{-}1: prevents that a minus ("-") get displayed as long minus (and causing erros on copy-and-paste) -% - -\lstnewenvironment{bconsole}[1]{ - % #1 caption - \renewcommand*{\lstlistingname}{bconsole} - \definecolor{colorBconsole}{gray}{0.9} - \lstset{ - %label=bconsole:#1, - breaklines=true, - breakatwhitespace=true, - prebreak=\raisebox{0ex}[0ex][0ex]{ \ensuremath{\swarrow}}, - postbreak=\raisebox{0ex}[0ex][0ex]{\ensuremath{\hookrightarrow} }, - caption=\mbox{#1}, - basicstyle=\ttfamily\small, - %columns=fixed, - columns=fullflexible, - keepspaces=true, - literate={-}{-}1 - {ch}{c{}h}2 - {ck}{c{}k}2 - {fb}{f{}b}2 - {ff}{f{}f}2 - {fh}{f{}h}2 - {fi}{f{}i}2 - {fj}{f{}j}2 - {fl}{f{}l}2 - {fk}{f{}k}2 - {ll}{l{}l}2 - {th}{t{}h}2 - {tt}{t{}t}2 - , - backgroundcolor=\color{colorBconsole}, - frame=single, - framerule=0pt, - captionpos=b, - %moredelim=[l][\bf]{* }, - %moredelim=[l][\bf]{Select\ item: }, - %moredelim=[l][\bf]{Select\ Client }, - moredelim=[is][\bf]{}{}, - moredelim=[is][\underline]{}{}, .... bconsole session is put in code block - } -}{} - - -\lstnewenvironment{bmessage}[1]{% - % #1 caption - \renewcommand*{\lstlistingname}{Messages} - \footnotesize - \definecolor{colorConfig}{gray}{0.9} - \lstset{ - backgroundcolor=\color{colorConfig}, - breaklines=true, - breakatwhitespace=true, - prebreak=\raisebox{0ex}[0ex][0ex]{ \ensuremath{\swarrow}}, - postbreak=\raisebox{0ex}[0ex][0ex]{\ensuremath{\hookrightarrow} }, - frame=single, - framerule=0pt, - basicstyle=\ttfamily, - columns=fullflexible, - keepspaces=true, - literate={-}{-}1 - {ch}{c{}h}2 - {ck}{c{}k}2 - {fb}{f{}b}2 - {ff}{f{}f}2 - {fh}{f{}h}2 - {fi}{f{}i}2 - {fj}{f{}j}2 - {fl}{f{}l}2 - {fk}{f{}k}2 - {ll}{l{}l}2 - {th}{t{}h}2 - {tt}{t{}t}2 - , - %label=config:#1, - caption=\mbox{#1}, - captionpos=b, - moredelim=[is][\it]{}{}, - moredelim=[is][\underline]{}{}, - } -}{} ....................later - - -\definecolor{colorConfig}{gray}{0.9} - -\lstnewenvironment{bconfig}[1]{% .............part of a bareos config file - % #1 caption - \renewcommand*{\lstlistingname}{Configuration} - \footnotesize - \lstset{ - backgroundcolor=\color{colorConfig}, - breaklines=true, - prebreak=\raisebox{0ex}[0ex][0ex]{ \ensuremath{\swarrow}}, - postbreak=\raisebox{0ex}[0ex][0ex]{\ensuremath{\hookrightarrow} }, - frame=single, - framerule=0pt, - basicstyle=\ttfamily, - columns=fullflexible, - keepspaces=true, - literate={-}{-}1 - {ch}{c{}h}2 - {ck}{c{}k}2 - {fb}{f{}b}2 - {ff}{f{}f}2 - {fh}{f{}h}2 - {fi}{f{}i}2 - {fj}{f{}j}2 - {fl}{f{}l}2 - {fk}{f{}k}2 - {ll}{l{}l}2 - {th}{t{}h}2 - {tt}{t{}t}2 - , - caption=\mbox{#1}, - captionpos=b, - moredelim=[is][\it]{}{}, - moredelim=[is][\underline]{}{}, - } -}{} - -\newcommand{\bconfigInput}[1]{ - { - \footnotesize -% \lstinputlisting[backgroundcolor=\color{colorConfig},frame=single,framerule=0pt,basicstyle=\ttfamily,keepspaces=true,columns=fullflexible,moredelim=[is][\it]{}{},moredelim=[is][\underline]{}{}]{#1} - \lstinputlisting[ - backgroundcolor=\color{colorConfig}, - frame=single,framerule=0pt, - basicstyle=\ttfamily, - columns=fullflexible, - keepspaces=true, - literate={-}{-}1 - ]{#1} - } ..............if config file is somewhere else, we can import it by this -} - -\lstnewenvironment{bareosConfigResource}[3]{% - % #1 component - % #2 resource type - % #3 resource name - \renewcommand*{\lstlistingname}{Resource} - \footnotesize - \lstset{ - backgroundcolor=\color{colorConfig}, - breaklines=true, - %breakatwhitespace=true, - prebreak=\raisebox{0ex}[0ex][0ex]{ \ensuremath{\swarrow}}, - postbreak=\raisebox{0ex}[0ex][0ex]{\ensuremath{\hookrightarrow} }, - frame=single, - framerule=0pt, - basicstyle=\ttfamily, - columns=fullflexible, - keepspaces=true, - literate={-}{-}1 - {ch}{c{}h}2 - {ck}{c{}k}2 - {fb}{f{}b}2 - {ff}{f{}f}2 - {fh}{f{}h}2 - {fi}{f{}i}2 - {fj}{f{}j}2 - {fl}{f{}l}2 - {fk}{f{}k}2 - {ll}{l{}l}2 - {th}{t{}h}2 - {tt}{t{}t}2 - , - caption=#1.d/#2/#3.conf, .............daemon name, resource type, resource name - captionpos=b, - moredelim=[is][\it]{}{}, - - \lstnewenvironment{config}[1]{% - % #1 caption - \renewcommand*{\lstlistingname}{Configuration} - \footnotesize - \definecolor{colorConfig}{gray}{0.9} - \lstset{ - backgroundcolor=\color{colorConfig}, - breaklines=true, - breakatwhitespace=true, - prebreak=\raisebox{0ex}[0ex][0ex]{ \ensuremath{\swarrow}}, - postbreak=\raisebox{0ex}[0ex][0ex]{\ensuremath{\hookrightarrow} }, - frame=single, - framerule=0pt, - basicstyle=\ttfamily, - columns=fullflexible, - keepspaces=true, - literate={-}{-}1 - {ch}{c{}h}2 - {ck}{c{}k}2 - {fb}{f{}b}2 - {ff}{f{}f}2 - {fh}{f{}h}2 - {fi}{f{}i}2 - {fj}{f{}j}2 - {fl}{f{}l}2 - {fk}{f{}k}2 - {ll}{l{}l}2 - {th}{t{}h}2 - {tt}{t{}t}2 - , - caption=#1, - captionpos=b, - moredelim=[is][\it]{}{}, - moredelim=[is][\underline]{}{}, - }.............. general config file that is not bareos specific -}{} - - -\lstnewenvironment{commands}[1]{% .... general unix commands - % #1 caption - \renewcommand*{\lstlistingname}{Commands} - \footnotesize - \definecolor{colorConfig}{gray}{0.9} - \lstset{ - backgroundcolor=\color{colorConfig}, - breaklines=true, - breakatwhitespace=true, - prebreak=\raisebox{0ex}[0ex][0ex]{ \ensuremath{\swarrow}}, - postbreak=\raisebox{0ex}[0ex][0ex]{\ensuremath{\hookrightarrow} }, - frame=single, - framerule=0pt, - basicstyle=\ttfamily, - columns=fullflexible, - keepspaces=true, - literate={-}{-}1 - {ch}{c{}h}2 - {ck}{c{}k}2 - {fb}{f{}b}2 - {ff}{f{}f}2 - {fh}{f{}h}2 - {fi}{f{}i}2 - {fj}{f{}j}2 - {fl}{f{}l}2 - {fk}{f{}k}2 - {ll}{l{}l}2 - {th}{t{}h}2 - {tt}{t{}t}2 - , - caption=\mbox{#1}, - captionpos=b, - % command only work for single commands without parameter. - % as workaround, split a command and its parameter as in following example: - % su - bareos - moredelim=[is][\commandPrompt\bf]{}{}, - moredelim=[is][\bf]{}{}, - moredelim=[is][\bf]{}{}, - moredelim=[is][\underline]{}{}, - } -}{} - -.......check if used -\newfloat{floatCommandOut}{h}{lop} -\floatname{floatCommandOut}{Command} - -\newenvironment{commandOut}[3]{% - % #1 caption - % #2 prompt - % #3 command - \footnotesize - \def\commandOut1{#1} - \ifthenelse{\isempty{#2}}{ - \def\commandOutPrompt{\commandPrompt} - }{ - \def\commandOutPrompt{#2} - } - - % \definecolor{shadecolor}{gray}{0.95} - % TODO: does not work with htlatex - % \snugshade - \verbatim -\commandOutPrompt{}#3 -} -{ - \endverbatim - % \endsnugshade - \ifthenelse{\isempty{\commandOut1}}{ - }{ - \captionof{floatCommandOut}{\commandOut1} - } -} - -\definecolor{colorLog}{gray}{0.9} - -\lstnewenvironment{logging}[1]{% ............if u specify thec contents of a bareos log file - % #1 caption - \renewcommand*{\lstlistingname}{Logging} - \footnotesize - \lstset{ - backgroundcolor=\color{colorLog}, - breaklines=true, - %breakatwhitespace=true, - prebreak=\raisebox{0ex}[0ex][0ex]{ \ensuremath{\swarrow}}, - postbreak=\raisebox{0ex}[0ex][0ex]{\ensuremath{\hookrightarrow} }, - frame=single, - framerule=0pt, - basicstyle=\ttfamily, - columns=fullflexible, - keepspaces=true, - literate={-}{-}1, - caption=\mbox{#1}, - captionpos=b, - moredelim=[is][\it]{}{}, - moredelim=[is][\underline]{}{}, - } -}{} - -\endinput