knotc: Updated and unified man, help and doc

doc/running.rst

@@ -48,16 +48,18 @@ If you want to control the daemon directly, use ``SIGINT`` to quit the process o
      -h, --help             Print help and usage.
 
     Actions:
-     stop                   Stop server.
-     reload <zone> ...      Reload zones or reload whole configuration and changed zones (if not specified).
-     refresh <zone> ...     Refresh slave zones (all if not specified).
-     flush <zone> ...       Flush journal and update zone files. (all if not specified)
-     status                 Check if server is running.
-     zonestatus <zone> ...  Show status of configured zones (all if not specified).
-     checkconf              Check current server configuration.
-     checkzone <zone> ...   Check zones (all if not specified).
-     memstats <zone> ...    Estimate memory consumption for zones (all if not specified).
-     signzone <zone>        Sign zone with available DNSSEC keys (zone must be specified).
+     stop                    Stop server.
+     reload [<zone>...]      Reload particular zones or reload whole configuration and changed zones.
+     refresh [<zone>...]     Refresh slave zones. Flag '-f' forces retransfer (zone(s) must be specified).
+     flush [<zone>...]       Flush journal and update zone files.
+     status                  Check if server is running.
+     zonestatus [<zone>...]  Show status of configured zones.
+     checkconf               Check current server configuration.
+     checkzone [<zone>...]   Check zones.
+     memstats [<zone>...]    Estimate memory consumption for zones.
+     signzone <zone>         Sign zones with available DNSSEC keys.
+
+    Note: If <zone> parameter is not specified, command is applied to all zones.
 
 Also, the server needs to create several files in order to run properly. These
 files are stored in the folowing directories.

man/knotc.8.in

@@ -36,35 +36,37 @@ Print version of the server.
 Print help and usage.
 .SS "Actions:"
 .TP
+If an optional \fIzone\fR argument is not specified, the command is applied to all zones.
+.TP
 \fBstop\fR
 Stop server (no\-op if not running).
 .TP
 \fBreload\fR [\fIzone\fR] ...
-Reload zones or reload whole configuration and changed zones (if not specified).
+Reload particular zones or reload whole configuration and changed zones.
 .TP
 \fBflush\fR [\fIzone\fR] ...
-Flush journal and update zone files (all if not specified).
+Flush journal and update zone files.
 .TP
 \fBstatus\fR
 Check if server is running.
 .TP
 \fBzonestatus\fR [\fIzone\fR] ...
-Show status of configured zones (all if not specified).
+Show status of configured zones.
 .TP
 \fBrefresh\fR [\fIzone\fR] ...
-Refresh slave zones (all if not specified).
+Refresh slave zones. Flag '-f' forces retransfer (zone(s) must be specified).
 .TP
 \fBcheckconf\fR
 Check current server configuration.
 .TP
 \fBcheckzone\fR [\fIzone\fR] ...
-Check zones (all if not specified).
+Check zones.
 .TP
 \fBmemstats\fR [\fIzone\fR] ...
-Estimate memory consumption for zones (all if not specified).
+Estimate memory consumption for zones.
 .TP
 \fBsignzone\fR \fIzone\fR ...
-Sign zone with available DNSSEC keys (zone must be specified).
+Sign zones with available DNSSEC keys.
 .SH EXAMPLES
 .TP
 .B Setup a keyfile for remote control

src/knot/ctl/knotc_main.c

@@ -77,16 +77,16 @@ static int cmd_signzone(int argc, char *argv[], unsigned flags);
 
 /*! \brief Table of remote commands. */
 knot_cmd_t knot_cmd_tbl[] = {
-	{&cmd_stop,       0, "stop",       "",       "\t\tStop server."},
-	{&cmd_reload,     0, "reload",     "<zone> ...", "Reload zones or reload whole configuration and changed zones (if not specified)."},
-	{&cmd_refresh,    0, "refresh",    "<zone> ...", "Refresh slave zones (all if not specified). Flag '-f' forces retransfer."},
-	{&cmd_flush,      0, "flush",      "<zone> ...", "Flush journal and update zone files (all if not specified)."},
-	{&cmd_status,     0, "status",     "",       "\tCheck if server is running."},
-	{&cmd_zonestatus, 0, "zonestatus", "<zone> ...", "Show status of configured zones (all if not specified)."},
-	{&cmd_checkconf,  1, "checkconf",  "",       "\tCheck current server configuration."},
-	{&cmd_checkzone,  1, "checkzone",  "<zone> ...", "Check zones (all if not specified)."},
-	{&cmd_memstats,   1, "memstats",   "<zone> ...", "Estimate memory use for zones (all if not specified)."},
-	{&cmd_signzone,   0, "signzone",   "<zone> ...", "Sign zone with available DNSSEC keys (zone must be specified)."},
+	{&cmd_stop,       0, "stop",       "",           "\t\tStop server."},
+	{&cmd_reload,     0, "reload",     "[<zone>...]", "Reload particular zones or reload whole configuration and changed zones."},
+	{&cmd_refresh,    0, "refresh",    "[<zone>...]", "Refresh slave zones. Flag '-f' forces retransfer (zone(s) must be specified)."},
+	{&cmd_flush,      0, "flush",      "[<zone>...]", "Flush journal and update zone files."},
+	{&cmd_status,     0, "status",     "",           "\tCheck if server is running."},
+	{&cmd_zonestatus, 0, "zonestatus", "[<zone>...]", "Show status of configured zones."},
+	{&cmd_checkconf,  1, "checkconf",  "",           "\tCheck current server configuration."},
+	{&cmd_checkzone,  1, "checkzone",  "[<zone>...]", "Check zones."},
+	{&cmd_memstats,   1, "memstats",   "[<zone>...]", "Estimate memory use for zones."},
+	{&cmd_signzone,   0, "signzone",   "<zone>...", "Sign zones with available DNSSEC keys (at least one zone must be specified)."},
 	{NULL, 0, NULL, NULL, NULL}
 };
 
@@ -111,6 +111,7 @@ void help(void)
 		printf(" %s %s\t\t%s\n", c->name, c->params, c->desc);
 		++c;
 	}
+	printf("\nNote: If <zone> parameter is not specified, command is applied to all zones.\n\n");
 }
 
 static int cmd_remote_print_reply(const knot_rrset_t *rr)