Skip to content
Snippets Groups Projects
Commit e36cfcdc authored by Lubos Slovak's avatar Lubos Slovak
Browse files

knotc: Updated doxygen + man + help

parent 9a6547fe
No related branches found
No related tags found
No related merge requests found
......@@ -49,15 +49,15 @@ If you want to control the daemon directly, use ``SIGINT`` to quit the process o
Actions:
stop Stop server.
reload <zone> Reload zone or reload whole configuration and changed zones.
refresh <zone> Refresh slave zone (all if not specified).
flush <zone> Flush journal and update zone files. (all if not specified)
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 zone (all if not specified).
zonestatus <zone> ... Show status of configured zones (all if not specified).
checkconf Check current server configuration.
checkzone <zone> Check zone (all if not specified).
memstats <zone> Estimate memory consumption for zone (all if not
specified).
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).
Also, the server needs to create several files in order to run properly. These
files are stored in the folowing directories.
......
......@@ -39,29 +39,32 @@ Print help and usage.
\fBstop\fR
Stop server (no\-op if not running).
.TP
\fBreload\fR [\fIzone\fR]...
Reload configuration and changed zones (all if not specified).
\fBreload\fR [\fIzone\fR] ...
Reload zones or reload whole configuration and changed zones (if not specified).
.TP
\fBflush\fR [\fIzone\fR]...
\fBflush\fR [\fIzone\fR] ...
Flush journal and update zone files (all if not specified).
.TP
\fBstatus\fR
Check if server is running.
.TP
\fBzonestatus\fR
Show status of configured zones.
\fBzonestatus\fR [\fIzone\fR] ...
Show status of configured zones (all if not specified).
.TP
\fBrefresh\fR [\fIzone\fR]...
\fBrefresh\fR [\fIzone\fR] ...
Refresh slave zones (all if not specified).
.TP
\fBcheckconf\fR
Check current server configuration.
.TP
\fBcheckzone\fR [\fIzone\fR]...
Check zone (all if not specified).
\fBcheckzone\fR [\fIzone\fR] ...
Check zones (all if not specified).
.TP
\fBmemstats\fR [\fIzone\fR]...
Estimate memory consumption for zone (all if not specified).
\fBmemstats\fR [\fIzone\fR] ...
Estimate memory consumption for zones (all if not specified).
.TP
\fBsignzone\fR \fIzone\fR ...
Sign zone with available DNSSEC keys (zone must be specified).
.SH EXAMPLES
.TP
.B Setup a keyfile for remote control
......
......@@ -78,22 +78,22 @@ 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>", "\tReload zone or reload whole configuration and changed zones."},
{&cmd_refresh, 0, "refresh", "<zone>", "\tRefresh slave zone (all if not specified). Flag '-f' forces retransfer."},
{&cmd_flush, 0, "flush", "<zone>", "\tFlush journal and update zone file (all if not specified)."},
{&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>" "\tShow status of configured zone (all if not specified)."},
{&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 zone (all if not specified)."},
{&cmd_memstats, 1, "memstats", "<zone>", "Estimate memory use for zone (all if not specified)."},
{&cmd_signzone, 0, "signzone", "<zone>", "Sign all zones with available DNSSEC keys."},
{&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)."},
{NULL, 0, NULL, NULL, NULL}
};
/*! \brief Print help. */
void help(void)
{
printf("Usage: %sc [parameters] <action>\n", PACKAGE_NAME);
printf("Usage: %sc [parameters] <action> [action_args]\n", PACKAGE_NAME);
printf("\nParameters:\n"
" -c, --config <file> \tSelect configuration file.\n"
" -s <server> \tRemote UNIX socket/IP address (default %s).\n"
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment