Use semantic markup for :program: self-references
Sphinx has it's own :program: syntax for refering to program names.
Use it for self-references in manual pages. These self-references are
not clickable and not as eye-cathing as links, which is a good thing.
There is no point in attracting attention to ``dig`` several times on a
single page dedicated to dig itself.
Substituted automatically using:
find bin -name *.rst | xargs fgrep --files-with-matches '.. program' | xargs -n1 bash /tmp/repl.sh
With /tmp/repl.sh being:
BASE=$(basename "$1" .rst)
sed -i -e "s/\`\`$BASE\`\`/:program:\`$BASE\`/g" "$1"
This commit is contained in:
@@ -27,7 +27,7 @@ Synopsis
|
||||
Description
|
||||
~~~~~~~~~~~
|
||||
|
||||
``ddns-confgen`` is an utility that generates keys for use in TSIG signing.
|
||||
:program:`ddns-confgen` is an utility that generates keys for use in TSIG signing.
|
||||
The resulting keys can be used, for example, to secure dynamic DNS updates
|
||||
to a zone, or for the ``rndc`` command channel.
|
||||
|
||||
@@ -40,7 +40,7 @@ command-channel security.)
|
||||
|
||||
Note that ``named`` itself can configure a local DDNS key for use with
|
||||
:option:`nsupdate -l`; it does this when a zone is configured with
|
||||
``update-policy local;``. ``ddns-confgen`` is only needed when a more
|
||||
``update-policy local;``. :program:`ddns-confgen` is only needed when a more
|
||||
elaborate configuration is required: for instance, if ``nsupdate`` is to
|
||||
be used from a remote system.
|
||||
|
||||
|
||||
@@ -26,7 +26,7 @@ Synopsis
|
||||
Description
|
||||
~~~~~~~~~~~
|
||||
|
||||
``rndc-confgen`` generates configuration files for ``rndc``. It can be
|
||||
:program:`rndc-confgen` generates configuration files for ``rndc``. It can be
|
||||
used as a convenient alternative to writing the ``rndc.conf`` file and
|
||||
the corresponding ``controls`` and ``key`` statements in ``named.conf``
|
||||
by hand. Alternatively, it can be run with the :option:`-a` option to set up a
|
||||
@@ -46,7 +46,7 @@ Options
|
||||
|
||||
If a more elaborate configuration than that generated by
|
||||
:option:`rndc-confgen -a` is required, for example if rndc is to be used
|
||||
remotely, run ``rndc-confgen`` without the :option:`-a` option
|
||||
remotely, run :program:`rndc-confgen` without the :option:`-a` option
|
||||
and set up ``rndc.conf`` and ``named.conf`` as directed.
|
||||
|
||||
.. option:: -A algorithm
|
||||
@@ -68,7 +68,7 @@ Options
|
||||
.. option:: -h
|
||||
|
||||
This option prints a short summary of the options and arguments to
|
||||
``rndc-confgen``.
|
||||
:program:`rndc-confgen`.
|
||||
|
||||
.. option:: -k keyname
|
||||
|
||||
@@ -113,7 +113,7 @@ To allow ``rndc`` to be used with no manual configuration, run:
|
||||
To print a sample ``rndc.conf`` file and the corresponding ``controls`` and
|
||||
``key`` statements to be manually inserted into ``named.conf``, run:
|
||||
|
||||
``rndc-confgen``
|
||||
:program:`rndc-confgen`
|
||||
|
||||
See Also
|
||||
~~~~~~~~
|
||||
|
||||
@@ -27,7 +27,7 @@ Synopsis
|
||||
Description
|
||||
~~~~~~~~~~~
|
||||
|
||||
``tsig-keygen`` is an utility that generates keys for use in TSIG signing.
|
||||
:program:`tsig-keygen` is an utility that generates keys for use in TSIG signing.
|
||||
The resulting keys can be used, for example, to secure dynamic DNS updates
|
||||
to a zone, or for the ``rndc`` command channel.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user