Commit e652cc33 authored by Daniel Salzman's avatar Daniel Salzman

doc: post-review fixes

parent e641f205
...@@ -93,33 +93,37 @@ Trigger a zone retransfer (if slave). ...@@ -93,33 +93,37 @@ Trigger a zone retransfer (if slave).
\fBzone\-flush\fP [\fIzone\fP\&...] \fBzone\-flush\fP [\fIzone\fP\&...]
Trigger a zone journal flush into the zone file. Trigger a zone journal flush into the zone file.
.TP .TP
\fBzone\-sing\fP [\fIzone\fP\&...] \fBzone\-sign\fP [\fIzone\fP\&...]
Trigger a zone resign (if enabled). Trigger a zone resign (if enabled).
.TP .TP
\fBconf\-init\fP
Initialize the configuration database. (*)
.TP
\fBconf\-check\fP \fBconf\-check\fP
Check the server configuration. (*) Check the server configuration. (*)
.TP .TP
\fBconf\-import\fP \fIfilename\fP \fBconf\-import\fP \fIfilename\fP
Import a config file into the confdb. Ensure the server is not accessing Import a configuration file into the configuration database. Ensure the
the confdb! (*) server is not using the configuration database! (*)
.TP .TP
\fBconf\-export\fP \fIfilename\fP \fBconf\-export\fP \fIfilename\fP
Export the confdb into a config file. (*) Export the configuration database into a config file. (*)
.TP .TP
\fBconf\-list\fP [\fIitem\fP] \fBconf\-list\fP [\fIitem\fP]
List the confdb sections or section items. List the configuration database sections or section items.
.TP .TP
\fBconf\-read\fP [\fIitem\fP] \fBconf\-read\fP [\fIitem\fP]
Read the item from the active confdb. Read the item from the active configuration database.
.TP .TP
\fBconf\-begin\fP \fBconf\-begin\fP
Begin a writing confdb transaction. Only one transaction can be opened at a time. Begin a writing configuration database transaction. Only one transaction
can be opened at a time.
.TP .TP
\fBconf\-commit\fP \fBconf\-commit\fP
Commit the confdb transaction. Commit the configuration database transaction.
.TP .TP
\fBconf\-abort\fP \fBconf\-abort\fP
Rollback the confdb transaction. Rollback the configuration database transaction.
.TP .TP
\fBconf\-diff\fP [\fIitem\fP] \fBconf\-diff\fP [\fIitem\fP]
Get the item difference in the transaction. Get the item difference in the transaction.
...@@ -139,7 +143,7 @@ Empty \fIzone\fP parameter means all zones. ...@@ -139,7 +143,7 @@ Empty \fIzone\fP parameter means all zones.
.sp .sp
Type \fIitem\fP parameter in the form of \fIsection\fP[\fB[\fP\fIid\fP\fB]\fP][\fB\&.\fP\fIname\fP]. Type \fIitem\fP parameter in the form of \fIsection\fP[\fB[\fP\fIid\fP\fB]\fP][\fB\&.\fP\fIname\fP].
.sp .sp
(*) indicates a local operation requiring a configuration specified. (*) indicates a local operation which requires a configuration available.
.SH EXAMPLES .SH EXAMPLES
.SS Reload the whole server configuration .SS Reload the whole server configuration
.INDENT 0.0 .INDENT 0.0
...@@ -152,13 +156,13 @@ $ knotc reload ...@@ -152,13 +156,13 @@ $ knotc reload
.fi .fi
.UNINDENT .UNINDENT
.UNINDENT .UNINDENT
.SS Flush the example.com and example.eu zones .SS Flush the example.com and example.org zones
.INDENT 0.0 .INDENT 0.0
.INDENT 3.5 .INDENT 3.5
.sp .sp
.nf .nf
.ft C .ft C
$ knotc zone\-flush example.com example.eu $ knotc zone\-flush example.com example.org
.ft P .ft P
.fi .fi
.UNINDENT .UNINDENT
...@@ -196,15 +200,15 @@ $ knotc conf\-read zone[example.com].master ...@@ -196,15 +200,15 @@ $ knotc conf\-read zone[example.com].master
.fi .fi
.UNINDENT .UNINDENT
.UNINDENT .UNINDENT
.SS Add example.eu zone with a zonefile location .SS Add example.org zone with a zonefile location
.INDENT 0.0 .INDENT 0.0
.INDENT 3.5 .INDENT 3.5
.sp .sp
.nf .nf
.ft C .ft C
$ knotc conf\-begin $ knotc conf\-begin
$ knotc conf\-set zone[example.eu] $ knotc conf\-set zone[example.org]
$ knotc conf\-set zone[example.eu].file "/var/zones/example.eu.zone" $ knotc conf\-set zone[example.org].file "/var/zones/example.org.zone"
$ knotc conf\-commit $ knotc conf\-commit
.ft P .ft P
.fi .fi
......
...@@ -71,37 +71,38 @@ Actions ...@@ -71,37 +71,38 @@ Actions
**zone-flush** [*zone*...] **zone-flush** [*zone*...]
Trigger a zone journal flush into the zone file. Trigger a zone journal flush into the zone file.
**zone-sing** [*zone*...] **zone-sign** [*zone*...]
Trigger a zone resign (if enabled). Trigger a zone resign (if enabled).
**conf-init** **conf-init**
Initialize the confdb. (*) Initialize the configuration database. (*)
**conf-check** **conf-check**
Check the server configuration. (*) Check the server configuration. (*)
**conf-import** *filename* **conf-import** *filename*
Import a config file into the confdb. Ensure the server is not accessing Import a configuration file into the configuration database. Ensure the
the confdb! (*) server is not using the configuration database! (*)
**conf-export** *filename* **conf-export** *filename*
Export the confdb into a config file. (*) Export the configuration database into a config file. (*)
**conf-list** [*item*] **conf-list** [*item*]
List the confdb sections or section items. List the configuration database sections or section items.
**conf-read** [*item*] **conf-read** [*item*]
Read the item from the active confdb. Read the item from the active configuration database.
**conf-begin** **conf-begin**
Begin a writing confdb transaction. Only one transaction can be opened at a time. Begin a writing configuration database transaction. Only one transaction
can be opened at a time.
**conf-commit** **conf-commit**
Commit the confdb transaction. Commit the configuration database transaction.
**conf-abort** **conf-abort**
Rollback the confdb transaction. Rollback the configuration database transaction.
**conf-diff** [*item*] **conf-diff** [*item*]
Get the item difference in the transaction. Get the item difference in the transaction.
...@@ -122,7 +123,7 @@ Empty *zone* parameter means all zones. ...@@ -122,7 +123,7 @@ Empty *zone* parameter means all zones.
Type *item* parameter in the form of *section*\ [**[**\ *id*\ **]**\ ][**.**\ *name*]. Type *item* parameter in the form of *section*\ [**[**\ *id*\ **]**\ ][**.**\ *name*].
(*) indicates a local operation requiring a configuration specified. (*) indicates a local operation which requires a configuration available.
Examples Examples
-------- --------
...@@ -134,12 +135,12 @@ Reload the whole server configuration ...@@ -134,12 +135,12 @@ Reload the whole server configuration
$ knotc reload $ knotc reload
Flush the example.com and example.eu zones Flush the example.com and example.org zones
.......................................... ...........................................
:: ::
$ knotc zone-flush example.com example.eu $ knotc zone-flush example.com example.org
Get the current server configuration Get the current server configuration
.................................... ....................................
...@@ -162,14 +163,14 @@ Get the master remotes for the example.com zone ...@@ -162,14 +163,14 @@ Get the master remotes for the example.com zone
$ knotc conf-read zone[example.com].master $ knotc conf-read zone[example.com].master
Add example.eu zone with a zonefile location Add example.org zone with a zonefile location
............................................ .............................................
:: ::
$ knotc conf-begin $ knotc conf-begin
$ knotc conf-set zone[example.eu] $ knotc conf-set zone[example.org]
$ knotc conf-set zone[example.eu].file "/var/zones/example.eu.zone" $ knotc conf-set zone[example.org].file "/var/zones/example.org.zone"
$ knotc conf-commit $ knotc conf-commit
See Also See Also
......
...@@ -15,9 +15,9 @@ the process or ``SIGHUP`` to reload the configuration. ...@@ -15,9 +15,9 @@ the process or ``SIGHUP`` to reload the configuration.
If you pass neither configuration file (``-c`` parameter) nor configuration If you pass neither configuration file (``-c`` parameter) nor configuration
database (``-C`` parameter), the server will first attempt to use the default database (``-C`` parameter), the server will first attempt to use the default
configuration database stored in ``LOCALSTATEDIR/lib/knot/confdb`` or the configuration database stored in ``/var/lib/knot/confdb`` or the
default configuration file stored in ``SYSCONFDIR/knot/knot.conf``. Both the default configuration file stored in ``/etc/knot/knot.conf``. Both the
default paths can be reconfigured with ``--with-storage=path`` or default paths can be reconfigured with ``--with-storage=path`` or
``--with-configdir=path`` respectively. ``--with-configdir=path`` respectively.
Example of server start as a daemon:: Example of server start as a daemon::
...@@ -71,7 +71,7 @@ configuration will be temporary (until the server stop). ...@@ -71,7 +71,7 @@ configuration will be temporary (until the server stop).
Most of the commands get an item name and value parameters. The item name is Most of the commands get an item name and value parameters. The item name is
in the form of ``section[identifier].name``. If the item is multivalued, in the form of ``section[identifier].name``. If the item is multivalued,
more values can be specified with a space separation. more values can be specified as individual (command line) arguments.
To get the list of configuration sections or to get the list of section items:: To get the list of configuration sections or to get the list of section items::
...@@ -106,7 +106,7 @@ section identifier or to add a value to all identified sections:: ...@@ -106,7 +106,7 @@ section identifier or to add a value to all identified sections::
$ knotc conf-set zone.slave slave2 $ knotc conf-set zone.slave slave2
*Note:* Also the include operation can be performed. A non-absolute file *Note:* Also the include operation can be performed. A non-absolute file
location is relative to the server binary path (not to the control binary path)!:: location is relative to the server binary path, not to the control binary path!::
$ knotc conf-set include /tmp/new_zones.conf $ knotc conf-set include /tmp/new_zones.conf
......
...@@ -54,7 +54,7 @@ static void print_help(void) ...@@ -54,7 +54,7 @@ static void print_help(void)
"Note:\n" "Note:\n"
" Empty <zone> parameter means all zones.\n" " Empty <zone> parameter means all zones.\n"
" Type <item> parameter in the form of <section>[<identifier>].<name>.\n" " Type <item> parameter in the form of <section>[<identifier>].<name>.\n"
" (*) indicates a local operation requiring a configuration specified.\n"); " (*) indicates a local operation which requires a configuration available.\n");
} }
static int set_config(const cmd_desc_t *desc, const char *confdb, static int set_config(const cmd_desc_t *desc, const char *confdb,
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment