]> git.ipfire.org Git - thirdparty/knot-dns.git/commitdiff
doc/knotc: describe the meaning of the OK response, improve zone-freeze
authorDavid Vašek <david.vasek@nic.cz>
Mon, 24 Aug 2020 12:03:34 +0000 (14:03 +0200)
committerDaniel Salzman <daniel.salzman@nic.cz>
Mon, 24 Aug 2020 17:13:07 +0000 (19:13 +0200)
doc/man/knotc.8in
doc/man_knotc.rst

index c1ba732eef270fc6c69437af9431319fcecc359d..1bab594d02c9ce860376b2acec481e7378f0a5bf 100644 (file)
@@ -142,11 +142,12 @@ the user confirms manually that the parent zone contains DS record for the new
 KSK in submission phase and the old KSK can be retired. (#)
 .TP
 \fBzone\-freeze\fP [\fIzone\fP\&...]
-Temporarily postpone zone\-changing events (load, refresh, update, flush, and
-DNSSEC signing). (#)
+Trigger a zone freeze. All running events will be finished and all new and pending
+(planned) zone\-changing events (load, refresh, update, flush, and DNSSEC signing)
+will be held up until the zone is thawed. (#)
 .TP
 \fBzone\-thaw\fP [\fIzone\fP\&...]
-Dismiss zone freeze. (#)
+Trigger dismissal of zone freeze. (#)
 .TP
 \fBzone\-read\fP \fIzone\fP [\fIowner\fP [\fItype\fP]]
 Get zone data that are currently being presented.
@@ -242,6 +243,10 @@ Type \fIitem\fP parameter in the form of \fIsection\fP[\fB[\fP\fIid\fP\fB]\fP][\
 (#) indicates an optionally blocking operation.
 .sp
 The \fI\-b\fP and \fI\-f\fP options can be placed right after the command name.
+.sp
+The \fIOK\fP response to triggering commands means that the command has been successfully sent
+to the server. To verify if the operation succeeded it\(aqs necessary to check the server
+log.
 .SS Interactive mode
 .sp
 The utility provides interactive mode with basic line editing functionality,
index adb4b8e9957727e91da9a2761c8fb67ec2ca91d1..35e88e2410ffc2f950e5e0de9aec639deafb41dc 100644 (file)
@@ -119,11 +119,12 @@ Actions
   KSK in submission phase and the old KSK can be retired. (#)
 
 **zone-freeze** [*zone*...]
-  Temporarily postpone zone-changing events (load, refresh, update, flush, and
-  DNSSEC signing). (#)
+  Trigger a zone freeze. All running events will be finished and all new and pending
+  (planned) zone-changing events (load, refresh, update, flush, and DNSSEC signing)
+  will be held up until the zone is thawed. (#)
 
 **zone-thaw** [*zone*...]
-  Dismiss zone freeze. (#)
+  Trigger dismissal of zone freeze. (#)
 
 **zone-read** *zone* [*owner* [*type*]]
   Get zone data that are currently being presented.
@@ -221,6 +222,10 @@ Type *item* parameter in the form of *section*\ [**[**\ *id*\ **]**\ ][**.**\ *n
 
 The *-b* and *-f* options can be placed right after the command name.
 
+The *OK* response to triggering commands means that the command has been successfully sent
+to the server. To verify if the operation succeeded it's necessary to check the server
+log.
+
 Interactive mode
 ................