]> git.ipfire.org Git - thirdparty/bind9.git/commitdiff
Add a glossary definition for duration
authorMatthijs Mekking <matthijs@isc.org>
Fri, 1 Sep 2023 09:14:29 +0000 (11:14 +0200)
committerMatthijs Mekking <matthijs@isc.org>
Fri, 1 Sep 2023 09:14:29 +0000 (11:14 +0200)
We don't yet explain the syntax of TTL-style suffixes or ISO 8601
duration formats.

In 9.16 the terms are not sorted alphabetically, so I added the
duration explanation at the end of the list.

(manually picked from commit cc122d22b46af7117b034d0732a3074e349e8e98)

doc/arm/reference.rst

index 55af7b8b423f85ad6dacce7542830ed62a9a0c75..1ca866c47d2826fd49a61adeaa42fa38c3b41b08 100644 (file)
@@ -93,6 +93,26 @@ file documentation:
     ``dialup_option``
         One of ``yes``, ``no``, ``notify``, ``notify-passive``, ``refresh``, or  ``passive``. When used in a zone, ``notify-passive``, ``refresh``, and ``passive`` are restricted to secondary and stub zones.
 
+    ``duration``
+        A duration in BIND 9 can be written in three ways: as single number
+        representing seconds, as a string of numbers with TTL-style
+        time-unit suffixes, or in ISO 6801 duration format.
+
+        Allowed TTL time-unit suffixes are: "W" (week), "D" (day), "H" (hour),
+        "M" (minute), and "S" (second). Examples: "1W" (1 week), "3d12h"
+        (3 days, 12 hours).
+
+        ISO 8601 duration format consists of the letter "P", followed by an
+       optional series of numbers with unit suffixes "Y" (year), "M" (month),
+        "W" (week), and "D" (day); this may optionally be followed by the
+        letter "T", and another series of numbers with unit suffixes
+        "H" (hour), "M" (minute), and "S" (second). Examples: "P3M10D"
+        (3 months, 10 days), "P2WT12H" (2 weeks, 12 hours), "pt15m"
+        (15 minutes).  For more information on ISO 8601 duration format,
+        see :rfc:`3339`, appendix A.
+
+        Both TTL-style and ISO 8601 duration formats are case-insensitive.
+
 .. _address_match_lists:
 
 Address Match Lists