Merge 'knotc: extend commands description'

doc/man/knot.conf.5in

@@ -181,7 +181,7 @@ A path for storing run\-time data (PID file, unix sockets, etc.).
 \fIDefault:\fP \fB${localstatedir}/run/knot\fP (configured with \fB\-\-with\-rundir=path\fP)
 .SS user
 .sp
-A system user with an optional system group (\fIuser\fP:\fIgroup\fP) under which the
+A system user with an optional system group (\fBuser:group\fP) under which the
 server is run after starting and binding to interfaces. Linux capabilities
 are employed if supported.
 .sp

doc/man/knotc.8in

@@ -70,31 +70,37 @@ Check if the server is running.
 Stop the server if running.
 .TP
 \fBreload\fP
-Reload the server configuration.
+Reload the server configuration and modified zone files.
 .TP
 \fBzone\-check\fP [\fIzone\fP\&...]
-Check the zone. (*)
+Test if the server can load the zone. Semantic checks are executed if enabled
+in the configuration. (*)
 .TP
 \fBzone\-memstats\fP [\fIzone\fP\&...]
 Estimate memory use for the zone. (*)
 .TP
 \fBzone\-status\fP [\fIzone\fP\&...]
-Show the status of the zone. (*)
+Show the zone status. (*)
 .TP
 \fBzone\-reload\fP [\fIzone\fP\&...]
-Trigger a zone reload.
+Trigger zone reload from a disk without checking it\(aqs modification time. For
+slave zone, the refresh from a master server is scheduled; for master zone,
+the notification of slave servers is scheduled.
 .TP
 \fBzone\-refresh\fP [\fIzone\fP\&...]
-Trigger a zone refresh (if slave).
+Trigger check for the zone serial on the zone\(aqs master. If the master has a
+newer zone, a transfer is scheduled. This command is valid for slave zones.
 .TP
 \fBzone\-retransfer\fP [\fIzone\fP\&...]
-Trigger a zone retransfer (if slave).
+Trigger zone transfer from the zone\(aqs master. The server doesn\(aqt check the
+serial of the master\(aqs zone. This command is valid for slave zones.
 .TP
 \fBzone\-flush\fP [\fIzone\fP\&...]
 Trigger a zone journal flush into the zone file.
 .TP
 \fBzone\-sign\fP [\fIzone\fP\&...]
-Trigger a zone resign (if enabled).
+Trigger DNSSEC re\-sign of the zone. Existing signature will be dropped. This
+command is valid for zones with automatic DNSSEC signing.
 .TP
 \fBconf\-init\fP
 Initialize the configuration database. (*)

doc/man_knotc.rst

@@ -47,32 +47,38 @@ Actions
   Stop the server if running.
 
 **reload**
-  Reload the server configuration.
+  Reload the server configuration and modified zone files.
 
 
 **zone-check** [*zone*...]
-  Check the zone. (*)
+  Test if the server can load the zone. Semantic checks are executed if enabled
+  in the configuration. (*)
 
 **zone-memstats** [*zone*...]
   Estimate memory use for the zone. (*)
 
 **zone-status** [*zone*...]
-  Show the status of the zone. (*)
+  Show the zone status. (*)
 
 **zone-reload** [*zone*...]
-  Trigger a zone reload.
+  Trigger a zone reload from a disk without checking its modification time. For
+  slave zone, the refresh from a master server is scheduled; for master zone,
+  the notification of slave servers is scheduled.
 
 **zone-refresh** [*zone*...]
-  Trigger a zone refresh (if slave).
+  Trigger a check for the zone serial on the zone's master. If the master has a
+  newer zone, a transfer is scheduled. This command is valid for slave zones.
 
 **zone-retransfer** [*zone*...]
-  Trigger a zone retransfer (if slave).
+  Trigger a zone transfer from the zone's master. The server doesn't check the
+  serial of the master's zone. This command is valid for slave zones.
 
 **zone-flush** [*zone*...]
   Trigger a zone journal flush into the zone file.
 
 **zone-sign** [*zone*...]
-  Trigger a zone resign (if enabled).
+  Trigger a DNSSEC re-sign of the zone. Existing signatures will be dropped.
+  This command is valid for zones with automatic DNSSEC signing.
 
 
 **conf-init**

src/utils/knotc/commands.c

@@ -505,16 +505,16 @@ const cmd_desc_old_t cmd_table_old[] = {
 const cmd_help_t cmd_help_table[] = {
 	{ CMD_STATUS,          "",                     "Check if the server is running." },
 	{ CMD_STOP,            "",                     "Stop the server if running." },
-	{ CMD_RELOAD,          "",                     "Reload the server configuration." },
+	{ CMD_RELOAD,          "",                     "Reload the server configuration and modified zones." },
 	{ "",                  "",                     "" },
-	{ CMD_ZONE_CHECK,      "[<zone>...]",          "Check the zone. (*)" },
+	{ CMD_ZONE_CHECK,      "[<zone>...]",          "Check if the zone can be loaded. (*)" },
 	{ CMD_ZONE_MEMSTATS,   "[<zone>...]",          "Estimate memory use for the zone. (*)" },
-	{ CMD_ZONE_STATUS,     "[<zone>...]",          "Show the status of the zone." },
-	{ CMD_ZONE_RELOAD,     "[<zone>...]",          "Trigger a zone reload." },
-	{ CMD_ZONE_REFRESH,    "[<zone>...]",          "Trigger a zone refresh (if slave)." },
-	{ CMD_ZONE_RETRANSFER, "[<zone>...]",          "Trigger a zone retransfer (if slave)." },
-	{ CMD_ZONE_FLUSH,      "[<zone>...]",          "Trigger a zone journal flush into the zone file." },
-	{ CMD_ZONE_SIGN,       "[<zone>...]",          "Trigger a zone resign (if enabled)." },
+	{ CMD_ZONE_STATUS,     "[<zone>...]",          "Show the zone status." },
+	{ CMD_ZONE_RELOAD,     "[<zone>...]",          "Reload a zone from a disk." },
+	{ CMD_ZONE_REFRESH,    "[<zone>...]",          "Force slave zone refresh." },
+	{ CMD_ZONE_RETRANSFER, "[<zone>...]",          "Force slave zone retransfer (no serial check)." },
+	{ CMD_ZONE_FLUSH,      "[<zone>...]",          "Flush zone journal into the zone file." },
+	{ CMD_ZONE_SIGN,       "[<zone>...]",          "Re-sign the automatically signed zone." },
 	{ "",                  "",                     "" },
 	{ CMD_CONF_INIT,       "",                     "Initialize the confdb. (*)" },
 	{ CMD_CONF_CHECK,      "",                     "Check the server configuration. (*)" },