Add hyperlinks from program options to definition in man pages

Side-effect of hyperlinking is that typos in program and option names
are now detected by Sphinx.

Candidate -options were detected using:
    find -name *.rst | xargs grep '``-[^`]'
and then modified from ``-o`` to :option:`-o` using regex
    s/``\(-[^`]\+\)``/:option:`\1`/
+ manual modifications where necessary.

Non-hyphenated options were detected by looking at context around
program names:
    find bin -name *.rst | xargs -I{} -n1 basename {} .rst | sort -u
and grepping for program name with trailing whitespace.

Stand-alone program names like ``named`` are not hyperlinked in this
commit.
This commit is contained in:
Petr Špaček
2022-03-02 16:54:31 +01:00
parent 5f0ee7c303
commit a85df3ff9c
70 changed files with 464 additions and 437 deletions

View File

@@ -65,7 +65,7 @@ Options
.. option:: -p
This option prints out the ``named.conf`` and included files in canonical form if
no errors were detected. See also the ``-x`` option.
no errors were detected. See also the :option:`-x` option.
.. option:: -t directory
@@ -84,7 +84,7 @@ Options
(``?``). This allows the contents of ``named.conf`` and related files
to be shared - for example, when submitting bug reports -
without compromising private data. This option cannot be used without
``-p``.
:option:`-p`.
.. option:: -z

View File

@@ -61,7 +61,7 @@ Options
.. option:: -J filename
When loading the zone file, this option tells ``named`` to read the journal from the given file, if
it exists. This implies ``-j``.
it exists. This implies :option:`-j`.
.. option:: -c class

View File

@@ -63,7 +63,7 @@ Options
.. option:: -J filename
When loading the zone file, this option tells ``named`` to read the journal from the given file, if
it exists. This implies ``-j``.
it exists. This implies :option:`-j`.
.. option:: -c class