Skip to content

Commit

Permalink
Remove manpage_url and :manpage: role; it doesn't seem to work for in…
Browse files Browse the repository at this point in the history
…terdirectory linking.
  • Loading branch information
gthess committed Oct 20, 2022
1 parent b9f5536 commit 1efcef2
Show file tree
Hide file tree
Showing 11 changed files with 34 additions and 36 deletions.
2 changes: 0 additions & 2 deletions source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -188,8 +188,6 @@
'Unbound DNS validating resolver functions.', unbound_authors, 3)
]

manpages_url = '{page}.html'

# -- Options for Texinfo output ----------------------------------------------

# Grouping the document tree into Texinfo files. List of tuples
Expand Down
14 changes: 7 additions & 7 deletions source/manpages/libunbound.rst
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ Description

Unbound is an implementation of a DNS resolver, that does caching and DNSSEC
validation. This is the library API, for using the ``-lunbound`` library. The
server daemon is described in :manpage:`unbound(8)`. The library works
server daemon is described in :doc:`/manpages/unbound`. The library works
independent from a running unbound server, and can be used to convert hostnames
to ip addresses, and back, and obtain other information from the DNS. The
library performs public-key validation of results with DNSSEC.
Expand Down Expand Up @@ -189,7 +189,7 @@ Functions

ub_ctx_set_option
A power-user interface that lets you specify one of the options from the
config file format, see :manpage:`unbound.conf(5)`. Not all options are
config file format, see :doc:`/manpages/unbound.conf`. Not all options are
relevant. For some specific options, such as adding trust anchors, special
routines exist. Pass the option name with the trailing ``':'``.

Expand All @@ -200,7 +200,7 @@ Functions

ub_ctx_config
A power-user interface that lets you specify an unbound config file, see
:manpage:`unbound.conf(5)`, which is read for configuration. Not all options
:doc:`/manpages/unbound.conf`, which is read for configuration. Not all options
are relevant. For some specific options, such as adding trust anchors,
special routines exist. This function is thread-safe only if a single
instance of **ub_ctx** exists in the application. If several instances
Expand Down Expand Up @@ -256,7 +256,7 @@ Functions
ub_ctx_add_ta_autr
Add filename with automatically tracked trust anchor to the given context.
Pass name of a file with the managed trust anchor. You can create this file
with :manpage:`unbound-anchor(8)` for the root anchor. You can also create
with :doc:`/manpages/unbound-anchor` for the root anchor. You can also create
it with an initial file with one line with a DNSKEY or DS record. If the
file is writable, it is updated when the trust anchor changes. At this time
it is only possible to add trusted keys before the first resolve is done.
Expand Down Expand Up @@ -347,14 +347,14 @@ Functions

ub_ctx_zone_add
Add new zone to local authority info, like local-zone
:manpage:`unbound.conf(5)` statement.
:doc:`/manpages/unbound.conf` statement.

ub_ctx_zone_remove
Delete zone from local authority info.

ub_ctx_data_add
Add resource record data to local authority info, like local-data
:manpage:`unbound.conf(5)` statement.
:doc:`/manpages/unbound.conf` statement.

ub_ctx_data_remove
Delete local authority data from the name given.
Expand Down Expand Up @@ -404,4 +404,4 @@ with file read failure.
See Also
--------

:manpage:`unbound.conf(5)`, :manpage:`unbound(8)`.
:doc:`/manpages/unbound.conf`, :doc:`/manpages/unbound`.
4 changes: 2 additions & 2 deletions source/manpages/unbound-anchor.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Description
DNSSEC validation. The program fetches the trust anchor with the method from
:RFC:`7958` when regular :RFC:`5011` update fails to bring it up to date. It can
be run (as root) from the commandline, or run as part of startup scripts. Before
you start the :manpage:`unbound(8)` DNS server.
you start the :doc:`/manpages/unbound` DNS server.

Suggested usage:

Expand Down Expand Up @@ -219,4 +219,4 @@ https://data.iana.org/root-anchors/root-anchors.p7s
See Also
--------

:manpage:`unbound.conf(5)`, :manpage:`unbound(8)`.
:doc:`/manpages/unbound.conf`, :doc:`/manpages/unbound`.
6 changes: 3 additions & 3 deletions source/manpages/unbound-checkconf.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ Description
-----------

:command:`Unbound-checkconf` checks the configuration file for the
:manpage:`unbound(8)` DNS resolver for syntax and other errors. The config file
syntax is described in :manpage:`unbound.conf(5)`.
:doc:`/manpages/unbound` DNS resolver for syntax and other errors. The config file
syntax is described in :doc:`/manpages/unbound.conf`.

The available options are:

Expand Down Expand Up @@ -50,4 +50,4 @@ Files
See Also
--------

:manpage:`unbound.conf(5)`, :manpage:`unbound(8)`.
:doc:`/manpages/unbound.conf`, :doc:`/manpages/unbound`.
8 changes: 4 additions & 4 deletions source/manpages/unbound-control.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Description
-----------

:command:`Unbound-control` performs remote administration on the
:manpage:`unbound(8)` DNS server. It reads the configuration file, contacts the
:doc:`/manpages/unbound` DNS server. It reads the configuration file, contacts the
unbound server over TLS sends the command and displays the result.

The available options are:
Expand Down Expand Up @@ -40,7 +40,7 @@ Commands
There are several commands that the server understands.

start
Start the server. Simply execs :manpage:`unbound(8)`. The unbound executable
Start the server. Simply execs :doc:`/manpages/unbound`. The unbound executable
is searched for in the **PATH** set in the environment. It is started with
the config file specified using :option:`-c` or the default config file.

Expand All @@ -52,7 +52,7 @@ reload

verbosity *number*
Change verbosity value for logging. Same values as **verbosity** keyword in
:manpage:`unbound.conf(5)`. This new setting lasts until the server is
:doc:`/manpages/unbound.conf`. This new setting lasts until the server is
issued a reload (taken from config file again), or the next verbosity
control command.

Expand Down Expand Up @@ -721,4 +721,4 @@ Files
See Also
--------

:manpage:`unbound.conf(5)`, :manpage:`unbound(8)`.
:doc:`/manpages/unbound.conf`, :doc:`/manpages/unbound`.
4 changes: 2 additions & 2 deletions source/manpages/unbound-host.rst
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ The available options are:

.. option:: -C configfile

Uses the specified unbound.conf to prime :manpage:`libunbound(3)`. Pass
Uses the specified unbound.conf to prime :doc:`/manpages/libunbound`. Pass
it as first argument if you want to override some options from the config
file with further arguments on the commandline.

Expand Down Expand Up @@ -132,4 +132,4 @@ lookup encountered a fatal error.
See Also
--------

:manpage:`unbound.conf(5)`, :manpage:`unbound(8)`.
:doc:`/manpages/unbound.conf`, :doc:`/manpages/unbound`.
18 changes: 9 additions & 9 deletions source/manpages/unbound.conf.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,14 @@ Synopsis
Description
-----------

:command:`unbound.conf` is used to configure :manpage:`unbound(8)`. The file
:command:`unbound.conf` is used to configure :doc:`/manpages/unbound`. The file
format has attributes and values. Some attributes have attributes inside them.
The notation is: ``attribute: value``.

Comments start with ``#`` and last to the end of line. Empty lines are ignored
as is whitespace at the beginning of a line.

The utility :manpage:`unbound-checkconf(8)` can be used to check unbound.conf
The utility :doc:`/manpages/unbound-checkconf` can be used to check unbound.conf
prior to usage.

Example
Expand Down Expand Up @@ -93,7 +93,7 @@ These options are part of the **server:** clause.
information, output per query. Level 4 gives algorithm level information.
Level 5 logs client identification for cache misses. Default is level 1. The
verbosity can also be increased from the commandline, see
:manpage:`unbound(8)`.
:doc:`/manpages/unbound`.

statistics-interval: *<seconds>*
The number of seconds between printing statistics to the log for every
Expand All @@ -109,9 +109,9 @@ These options are part of the **server:** clause.

extended-statistics: *<yes or no>*
If enabled, extended statistics are printed from
:manpage:`unbound-control(8)`. Default is off, because keeping track of more
:doc:`/manpages/unbound-control`. Default is off, because keeping track of more
statistics takes time. The counters are listed in
:manpage:`unbound-control(8)`.
:doc:`/manpages/unbound-control`.

num-threads: *<number>*
The number of threads to create to serve clients. Use 1 for no threading.
Expand Down Expand Up @@ -1712,12 +1712,12 @@ Remote Control Options
^^^^^^^^^^^^^^^^^^^^^^

In the **remote-control:** clause are the declarations for the remote control
facility. If this is enabled, the :manpage:`unbound-control(8)` utility can be
facility. If this is enabled, the :doc:`/manpages/unbound-control` utility can be
used to send commands to the running unbound server. The server uses these
clauses to setup TLSv1 security for the connection. The
:manpage:`unbound-control(8)` utility also reads the **remote-control** section
:doc:`/manpages/unbound-control` utility also reads the **remote-control** section
for options. To setup the correct self-signed certificates use the
:manpage:`unbound-control-setup(8)` utility.
**unbound-control-setup** utility.

.. glossary::

Expand Down Expand Up @@ -2676,4 +2676,4 @@ unbound.log
See Also
--------

:manpage:`unbound(8)`, :manpage:`unbound-checkconf(8)`.
:doc:`/manpages/unbound`, :doc:`/manpages/unbound-checkconf`.
4 changes: 2 additions & 2 deletions source/manpages/unbound.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ The available options are:

Set the config file with settings for unbound to read instead of reading the
file at the default location, :file:`/usr/local/etc/unbound/unbound.conf`.
The syntax is described in :manpage:`unbound.conf(5)`.
The syntax is described in :doc:`/manpages/unbound.conf`.

.. option:: -d

Expand All @@ -71,5 +71,5 @@ The available options are:
See Also
--------

:manpage:`unbound.conf(5)`, :manpage:`unbound-checkconf(8)`,
:doc:`/manpages/unbound.conf`, :doc:`/manpages/unbound-checkconf`,
:external+nsd:doc:`manpages/nsd`.
2 changes: 1 addition & 1 deletion source/topics/core/serve-stale.rst
Original file line number Diff line number Diff line change
Expand Up @@ -138,4 +138,4 @@ directing your clients to places long gone.
:term:`serve-expired-ttl-reset<serve-expired-ttl-reset: <yes or no>>`,
:term:`serve-expired-reply-ttl<serve-expired-reply-ttl: <seconds>>` and
:term:`serve-expired-client-timeout<serve-expired-client-timeout: <msec>>`
in the :manpage:`unbound.conf(5)` manpage.
in the :doc:`/manpages/unbound.conf` manpage.
6 changes: 3 additions & 3 deletions source/topics/filtering/rpz.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ policies from external sources.
To get these external sources to work manually, you have to fetch the external
policies in the offered format, reformat it in such a way that Unbound will
understand, and keep this list up-to-date, for example using
:manpage:`unbound-control(8)`.
:doc:`/manpages/unbound-control`.

To automate this process in a generic, standardised way, Response Policy Zones
(RPZ) is a policy format that will work on different resolver implementations,
Expand Down Expand Up @@ -199,7 +199,7 @@ How to use RPZ with Unbound
The RPZ implementation in Unbound depends on the ``respip`` module, this module
needs to be loaded using ``module-config``. Each policy zone is configured in
Unbound using the ``rpz`` clause. The full documentation for RPZ in Unbound can
be found in the :manpage:`unbound.conf(5)`. A minimal configuration
be found in the :doc:`/manpages/unbound.conf`. A minimal configuration
with a single policy zone can look like, where additional elements can be
uncommented:

Expand Down Expand Up @@ -390,7 +390,7 @@ zones.
:term:`define-tag<define-tag: <"list of tags">>`,
:term:`access-control-tag<access-control-tag: <IP netblock> <"list
of tags">>`, and :term:`extended-statistics<extended-statistics:
<yes or no>>` in the :manpage:`unbound.conf(5)` manpage.
<yes or no>>` in the :doc:`/manpages/unbound.conf` manpage.



Expand Down
2 changes: 1 addition & 1 deletion source/topics/filtering/tags-views.rst
Original file line number Diff line number Diff line change
Expand Up @@ -161,4 +161,4 @@ If view-first is enabled, Unbound will try to use the view's local-zone tree,
and if there is no match it will search the global tree.

.. seealso:: :ref:`manpages/unbound.conf:View Options` in
the :manpage:`unbound.conf(5)` manpage.
the :doc:`/manpages/unbound.conf` manpage.

0 comments on commit 1efcef2

Please sign in to comment.