From: Pieter Lexis Date: Fri, 1 Dec 2017 10:48:53 +0000 (+0100) Subject: Recursor: Fix some manpage issues X-Git-Tag: dnsdist-1.3.0~216^2 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=f52b0223fe256de9436bfa71fb3ad968d3e83bde;p=pdns Recursor: Fix some manpage issues --- diff --git a/pdns/recursordist/Makefile.am b/pdns/recursordist/Makefile.am index 7b440bfe5..f732e5cf1 100644 --- a/pdns/recursordist/Makefile.am +++ b/pdns/recursordist/Makefile.am @@ -369,7 +369,7 @@ dist_man_MANS=$(MANPAGES) if HAVE_VIRTUALENV if !HAVE_MANPAGES -$(MANPAGES): %.1: docs/manpages/%.rst .venv +$(MANPAGES): %: docs/manpages/%.rst .venv .venv/bin/python -msphinx -b man docs . $< endif # if !HAVE_MANPAGES diff --git a/pdns/recursordist/docs/conf.py b/pdns/recursordist/docs/conf.py index 286246993..8778c52a3 100644 --- a/pdns/recursordist/docs/conf.py +++ b/pdns/recursordist/docs/conf.py @@ -61,7 +61,7 @@ author = 'PowerDNS.COM BV' # The short X.Y version. version = '4.1' # The full version, including alpha/beta/rc tags. -release = '4.1.0-alpha1' +#release = '4.1.0-alpha1' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -169,8 +169,8 @@ latex_logo = 'common/powerdns-logo-500px.png' # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - ('manpages/rec_control', 'rec_control', 'Command line tool to control a running Recursor', [author], 1), - ('manpages/pdns_recursor', 'pdns_recursor', 'The PowerDNS Recursor binary', [author], 1) + ('manpages/rec_control.1', 'rec_control', 'Command line tool to control a running Recursor', [author], 1), + ('manpages/pdns_recursor.1', 'pdns_recursor', 'The PowerDNS Recursor binary', [author], 1) ] diff --git a/pdns/recursordist/docs/dnssec.rst b/pdns/recursordist/docs/dnssec.rst index 110a82041..1c5e3a8b6 100644 --- a/pdns/recursordist/docs/dnssec.rst +++ b/pdns/recursordist/docs/dnssec.rst @@ -94,7 +94,7 @@ Now (re)start the recursor to load these trust anchors. Runtime Configuration of Trust Anchors ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -To change or add trust anchors at runtime, use the :doc:`manpages/rec_control` tool. +To change or add trust anchors at runtime, use the :doc:`manpages/rec_control.1` tool. These runtime settings are not saved to disk. To make them permanent, they should be added to the :ref:`setting-lua-config-file` as described above. @@ -142,7 +142,7 @@ This function requires the name of the zone and an optional reason: Runtime Configuration of Negative Trust Anchors ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -The :doc:`manpages/rec_control` command can be used to manage the negative trust anchors of a running instance. +The :doc:`manpages/rec_control.1` command can be used to manage the negative trust anchors of a running instance. These runtime settings are lost when restarting the recursor, more permanent NTAs should be added to the :ref:`setting-lua-config-file` with ``addNTA()``. Adding a negative trust anchor is done with the ``add-nta`` command (that optionally accepts a reason): diff --git a/pdns/recursordist/docs/indexTOC.rst b/pdns/recursordist/docs/indexTOC.rst index 88df07bbc..2f884b45a 100644 --- a/pdns/recursordist/docs/indexTOC.rst +++ b/pdns/recursordist/docs/indexTOC.rst @@ -17,7 +17,7 @@ PowerDNS Recursor dns64 security settings - manpages/* + manpages/index security-advisories/index upgrade changelog/index diff --git a/pdns/recursordist/docs/manpages/index.rst b/pdns/recursordist/docs/manpages/index.rst new file mode 100644 index 000000000..048cb4a8b --- /dev/null +++ b/pdns/recursordist/docs/manpages/index.rst @@ -0,0 +1,8 @@ +Manual Pages +============ + +.. toctree:: + :maxdepth: 1 + :glob: + + *.1 diff --git a/pdns/recursordist/docs/manpages/pdns_recursor.rst b/pdns/recursordist/docs/manpages/pdns_recursor.1.rst similarity index 98% rename from pdns/recursordist/docs/manpages/pdns_recursor.rst rename to pdns/recursordist/docs/manpages/pdns_recursor.1.rst index a6b5c51e2..be117f450 100644 --- a/pdns/recursordist/docs/manpages/pdns_recursor.rst +++ b/pdns/recursordist/docs/manpages/pdns_recursor.1.rst @@ -1,5 +1,5 @@ -pdns_recursor manual page -======================= +pdns_recursor +============= Synopsis -------- diff --git a/pdns/recursordist/docs/manpages/rec_control.rst b/pdns/recursordist/docs/manpages/rec_control.1.rst similarity index 99% rename from pdns/recursordist/docs/manpages/rec_control.rst rename to pdns/recursordist/docs/manpages/rec_control.1.rst index 649d29879..3692416fd 100644 --- a/pdns/recursordist/docs/manpages/rec_control.rst +++ b/pdns/recursordist/docs/manpages/rec_control.1.rst @@ -1,5 +1,5 @@ -rec_control manual page -======================= +rec_control +=========== Synopsis -------- diff --git a/pdns/recursordist/docs/metrics.rst b/pdns/recursordist/docs/metrics.rst index 63d442dd2..73de56f1e 100644 --- a/pdns/recursordist/docs/metrics.rst +++ b/pdns/recursordist/docs/metrics.rst @@ -59,7 +59,7 @@ This endpoint exports all statistics in a single JSON document. Using ``rec_control`` ^^^^^^^^^^^^^^^^^^^^^ -Metrics can also be gathered on the system itself by invoking :doc:`rec_control `:: +Metrics can also be gathered on the system itself by invoking :doc:`rec_control `:: rec_control get-all diff --git a/regression-tests.recursor/rec_control-manpage/command b/regression-tests.recursor/rec_control-manpage/command index a84e9a063..6254d0a97 100755 --- a/regression-tests.recursor/rec_control-manpage/command +++ b/regression-tests.recursor/rec_control-manpage/command @@ -10,7 +10,7 @@ fi missing_elements="" for element in $elements; do - grep -q -e "^$element" ../pdns/recursordist/docs/manpages/rec_control.rst || missing_elements="$element\n$missing_elements" + grep -q -e "^$element" ../pdns/recursordist/docs/manpages/rec_control.1.rst || missing_elements="$element\n$missing_elements" done if [ "x$missing_elements" != "x" ]; then