Skip to content

Commit

Permalink
Add update manual
Browse files Browse the repository at this point in the history
  • Loading branch information
mozzieongit committed Nov 14, 2024
1 parent 37fc0c1 commit 35c7bc0
Show file tree
Hide file tree
Showing 2 changed files with 92 additions and 0 deletions.
46 changes: 46 additions & 0 deletions doc/manual/source/man/dnst-update.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
dnst-update
===============

Synopsis
--------

:program:`dnst update` ``<DOMAIN NAME>`` ``[<ZONE>]`` ``<IP>``
``[<TSIG KEY NAME> <TSIG ALGORITHM> <TSIG KEY DATA>]``

Description
-----------

**dnst update** sends a dynamic update packet to update an IP (or delete all
existing IPs) for a domain name.

Options
-------

.. option:: <DOMAIN NAME>

The domain name to update the IP address of

.. option:: <ZONE>

The zone to send the update to (if omitted, derived from SOA record)

.. option:: <IP>

The IP to update the domain with (``none`` to remove any existing IPs)

.. option:: <TSIG KEY NAME>

TSIG key name

.. option:: <TSIG ALGORITHM>

TSIG algorithm (e.g. "hmac-sha256")

.. option:: <TSIG KEY DATA>

Base64 encoded TSIG key data.

.. option:: -h, --help

Print the help text (short summary with ``-h``, long help with
``--help``).
46 changes: 46 additions & 0 deletions doc/manual/source/man/ldns-update.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
ldns-update
===============

Synopsis
--------

:program:`ldns-update` ``<DOMAIN NAME>`` ``[<ZONE>]`` ``<IP>``
``[<TSIG KEY NAME> <TSIG ALGORITHM> <TSIG KEY DATA>]``

Description
-----------

**ldns-update** sends a dynamic update packet to update an IP (or delete all
existing IPs) for a domain name.

Options
-------

.. option:: <DOMAIN NAME>

The domain name to update the IP address of

.. option:: <ZONE>

The zone to send the update to (if omitted, derived from SOA record)

.. option:: <IP>

The IP to update the domain with (``none`` to remove any existing IPs)

.. option:: <TSIG KEY NAME>

TSIG key name

.. option:: <TSIG ALGORITHM>

TSIG algorithm (e.g. "hmac-sha256")

.. option:: <TSIG KEY DATA>

Base64 encoded TSIG key data.

.. option:: -h, --help

Print the help text (short summary with ``-h``, long help with
``--help``).

0 comments on commit 35c7bc0

Please sign in to comment.