From: Josh Soref <2119212+jsoref@users.noreply.github.com> Date: Thu, 20 Feb 2025 22:01:40 +0000 (-0500) Subject: docs: link to doc:pdnsutil X-Git-Tag: dnsdist-2.0.0-alpha1~72^2 X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=refs%2Fpull%2F15191%2Fhead;p=thirdparty%2Fpdns.git docs: link to doc:pdnsutil Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> --- diff --git a/docs/appendices/backend-writers-guide.rst b/docs/appendices/backend-writers-guide.rst index f55272cf00..d67a2ac4a9 100644 --- a/docs/appendices/backend-writers-guide.rst +++ b/docs/appendices/backend-writers-guide.rst @@ -234,7 +234,7 @@ and such. as 'overlay', makes the zone incompatible with some operations that assume that a single zone is always entirely stored in the same backend. Such operations include zone transfers, listing and editing zone content via - the API or ``pdnsutil``. + the API or :doc:`pdnsutil `. .. warning:: When the content of a zone is spread across multiple backends, all the types diff --git a/docs/backends/generic-sql.rst b/docs/backends/generic-sql.rst index 95b7914a37..a433cc2a37 100644 --- a/docs/backends/generic-sql.rst +++ b/docs/backends/generic-sql.rst @@ -101,7 +101,7 @@ setting "disabled" to ``1`` (for PostgreSQL: ``true``). By extension, when the SOA record for a domain is disabled, the entire domain is considered to be disabled. -This value cannot be set with ``pdnsutil``. +This value cannot be set with :doc:`pdnsutil `. Effects: the record (or domain, respectively) will not be visible to DNS clients. The REST API will still see the record (or domain). Even if a diff --git a/docs/backends/geoip.rst b/docs/backends/geoip.rst index 539d16767f..13857851f4 100644 --- a/docs/backends/geoip.rst +++ b/docs/backends/geoip.rst @@ -86,7 +86,7 @@ Specifies the full path of the zone configuration file to use. The file is re-op Specifies the full path of a directory that will contain DNSSEC keys. This option enables DNSSEC on the backend. Keys can be created/managed -with ``pdnsutil``, and the backend stores these keys in files with key +with :doc:`pdnsutil `, and the backend stores these keys in files with key flags and active/disabled state encoded in the key filenames. Zonefile format diff --git a/docs/changelog/4.0.rst b/docs/changelog/4.0.rst index 84e3c94f45..367641e8b4 100644 --- a/docs/changelog/4.0.rst +++ b/docs/changelog/4.0.rst @@ -395,7 +395,7 @@ In addition to this cleanup, 4.0.0 brings the following new features: - Experimental support for ed25519 DNSSEC signatures (when compiled with libsodium support). - IXFR consumption support. -- Many new ``pdnsutil`` commands +- Many new :doc:`pdnsutil ` commands - ``help`` command now produces the help - Warns if the configuration file cannot be read @@ -417,7 +417,7 @@ The following backend have been dropped in 4.0.0: Important changes: -- ``pdnssec`` has been renamed to ``pdnsutil`` +- ``pdnssec`` has been renamed to :doc:`pdnsutil ` - PowerDNS Authoritative Server now listens by default on all IPv6 addresses. - The default for ``pdnsutil secure-zone`` has been changed from 1 2048 diff --git a/docs/changelog/4.1.rst b/docs/changelog/4.1.rst index 2ca9b77138..0531e3ad1a 100644 --- a/docs/changelog/4.1.rst +++ b/docs/changelog/4.1.rst @@ -517,7 +517,7 @@ Changelogs for 4.1.x This is the second release in the 4.1 train. - This is a bug-fix only release, with fixes to the LDAP and MySQL backends, the ``pdnsutil`` tool, and PDNS internals. + This is a bug-fix only release, with fixes to the LDAP and MySQL backends, the :doc:`pdnsutil ` tool, and PDNS internals. Changes since 4.1.1: @@ -643,7 +643,7 @@ Changelogs for 4.1.x This is the third release candidate of the PowerDNS Authoritative Server in the 4.1 release train. This release features various bug fixes and some improvements to - ``pdnsutil``. + :doc:`pdnsutil `. .. change:: :tags: Bug Fixes @@ -682,7 +682,7 @@ Changelogs for 4.1.x :pullreq: 5883 :tickets: 5853 - Add ``add-meta`` command to ``pdnsutil`` that can be used to append + Add ``add-meta`` command to :doc:`pdnsutil ` that can be used to append to existing metadata without clobbering it. .. change:: diff --git a/docs/changelog/4.7.rst b/docs/changelog/4.7.rst index ff9705b055..9722bfaff2 100644 --- a/docs/changelog/4.7.rst +++ b/docs/changelog/4.7.rst @@ -215,7 +215,7 @@ Changelogs for 4.7.x * lmdbbackend databases now get a UUID assigned, making it easy for external software to spot if a database was completely replaced * lmdbbackend databases now optionally use random IDs for objects * a new LUA function called ``ifurlextup``, and improvements in other LUA record functions - * autoprimary management in ``pdnsutil`` and the HTTP API + * autoprimary management in :doc:`pdnsutil ` and the HTTP API * in beta, a key roller daemon, currently not packaged Please make sure to read the :doc:`upgrade notes <../upgrading>` before upgrading. @@ -258,7 +258,7 @@ Changelogs for 4.7.x * lmdbbackend databases now get a UUID assigned, making it easy for external software to spot if a database was completely replaced * lmdbbackend databases now optionally use random IDs for objects * a new LUA function called ``ifurlextup``, and improvements in other LUA record functions - * autoprimary management in ``pdnsutil`` and the HTTP API + * autoprimary management in :doc:`pdnsutil ` and the HTTP API * in beta, a key roller daemon, currently not packaged Please make sure to read the :doc:`upgrade notes <../upgrading>` before upgrading. @@ -320,7 +320,7 @@ Changelogs for 4.7.x * lmdbbackend databases now get a UUID assigned, making it easy for external software to spot if a database was completely replaced * lmdbbackend databases now optionally use random IDs for objects * a new LUA function called ``ifurlextup``, and improvements in other LUA record functions - * autoprimary management in ``pdnsutil`` and the HTTP API + * autoprimary management in :doc:`pdnsutil ` and the HTTP API Please make sure to read the :doc:`upgrade notes <../upgrading>` before upgrading. @@ -519,7 +519,7 @@ Changelogs for 4.7.x * lmdbbackend databases now get a UUID assigned, making it easy for external software to spot if a database was completely replaced * lmdbbackend databases now optionally use random IDs for objects * a new LUA function called ``ifurlextup`` - * autoprimary management in ``pdnsutil`` and the HTTP API + * autoprimary management in :doc:`pdnsutil ` and the HTTP API Please make sure to read the :doc:`upgrade notes <../upgrading>` before upgrading. diff --git a/docs/dnssec/migration.rst b/docs/dnssec/migration.rst index 9217cc4a34..4fd45e3531 100644 --- a/docs/dnssec/migration.rst +++ b/docs/dnssec/migration.rst @@ -81,7 +81,7 @@ automatically. From existing DNSSEC non-PowerDNS setups, live signing ------------------------------------------------------ -The ``pdnsutil`` tool features the option to import zone keys in the +The :doc:`pdnsutil ` tool features the option to import zone keys in the industry standard private key format, version 1.2. To import an existing KSK, use diff --git a/docs/guides/basic-database.rst b/docs/guides/basic-database.rst index 233518b6b1..e3bccbe676 100644 --- a/docs/guides/basic-database.rst +++ b/docs/guides/basic-database.rst @@ -77,9 +77,9 @@ Now, let's add a zone and some records:: This should be done as the ``pdns`` user (or root), as sqlite3 requires write access to the directory of the database file. .. note:: - ``pdnsutil`` is a tool that can manipulate zones, set DNSSEC parameters for zones and does :doc:`many other <../manpages/pdnsutil.1>` things. - It is *highly* recommended to use ``pdnsutil`` or the :doc:`HTTP API <../http-api/index>` to modify zones instead of using raw SQL, - as ``pdnsutil`` and the API perform checks on the data and post-store changes to prevent issues when serving DNS data. + :doc:`pdnsutil ` is a tool that can manipulate zones, set DNSSEC parameters for zones and does :doc:`many other <../manpages/pdnsutil.1>` things. + It is *highly* recommended to use :doc:`pdnsutil ` or the :doc:`HTTP API <../http-api/index>` to modify zones instead of using raw SQL, + as :doc:`pdnsutil ` and the API perform checks on the data and post-store changes to prevent issues when serving DNS data. If we now requery our database, ``www.example.com`` should be present:: diff --git a/docs/running.rst b/docs/running.rst index e24bd70b53..181c732701 100644 --- a/docs/running.rst +++ b/docs/running.rst @@ -111,7 +111,7 @@ Backend manipulation ``pdnsutil`` ~~~~~~~~~~~~ -To perform zone and record changes using inbuilt tools, the ``pdnsutil`` command can be used. All available options are described in the online :doc:`manual page <../manpages/pdnsutil.1>` as well as in ``man pdnsutil``. +To perform zone and record changes using inbuilt tools, the :doc:`pdnsutil ` command can be used. All available options are described in the online :doc:`manual page <../manpages/pdnsutil.1>` as well as in ``man pdnsutil``. The SysV init script -------------------- diff --git a/docs/upgrading.rst b/docs/upgrading.rst index 3ff117fe47..4d36304c18 100644 --- a/docs/upgrading.rst +++ b/docs/upgrading.rst @@ -25,7 +25,7 @@ If you want to listen on both IPv4 and IPv6, you need to add a line with ``0.0.0 pdnsutil behaviour changes ^^^^^^^^^^^^^^^^^^^^^^^^^^ -A few changes of behaviour have been implemented in ``pdnsutil``. +A few changes of behaviour have been implemented in :doc:`pdnsutil `. * The ``add-zone-key`` command used to default to creating a ZSK, if no key type was given. This default has changed to KSK.