Skip to content
Snippets Groups Projects
Commit bb39cd9c authored by Jan Včelák's avatar Jan Včelák :rocket:
Browse files

doc: describe knotc interactive mode

parent 8421f65e
No related branches found
No related tags found
No related merge requests found
......@@ -35,10 +35,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
\fBknotc\fP [\fIparameters\fP] \fIaction\fP [\fIaction_args\fP]
.SH DESCRIPTION
.sp
If no \fIaction\fP is specified, the program is executed in interactive mode. Then
various command or parameters completion is available via the TAB key. And
command history is enabled (see \fIeditrc(5)\fP for additional
customization).
If no \fIaction\fP is specified, the program is executed in interactive mode.
.SS Parameters
.INDENT 0.0
.TP
......@@ -151,13 +148,22 @@ Set the item data in the transaction.
\fBconf\-unset\fP [\fIitem\fP] [\fIdata\fP\&...]
Unset the item data in the transaction.
.UNINDENT
.SH NOTE
.SS Note
.sp
Empty \fIzone\fP parameter means all zones.
.sp
Type \fIitem\fP parameter in the form of \fIsection\fP[\fB[\fP\fIid\fP\fB]\fP][\fB\&.\fP\fIname\fP].
.sp
(*) indicates a local operation which requires a configuration.
.SS Interactive mode
.sp
The utility provides interactive mode with basic line editing functionality,
command completion, and command history.
.sp
Interactive mode behavior can be customized in \fI~/.editrc\fP\&. Refer to
\fIeditrc(5)\fP for details.
.sp
Command history is saved in \fI~/.knotc_history\fP\&.
.SH EXAMPLES
.SS Reload the whole server configuration
.INDENT 0.0
......
......@@ -11,10 +11,7 @@ Synopsis
Description
-----------
If no *action* is specified, the program is executed in interactive mode. Then
various command or parameters completion is available via the TAB key. And
command history is enabled (see :manpage:`editrc(5)` for additional
customization).
If no *action* is specified, the program is executed in interactive mode.
Parameters
..........
......@@ -131,7 +128,7 @@ Actions
Unset the item data in the transaction.
Note
----
....
Empty *zone* parameter means all zones.
......@@ -139,6 +136,17 @@ Type *item* parameter in the form of *section*\ [**[**\ *id*\ **]**\ ][**.**\ *n
(*) indicates a local operation which requires a configuration.
Interactive mode
................
The utility provides interactive mode with basic line editing functionality,
command completion, and command history.
Interactive mode behavior can be customized in `~/.editrc`. Refer to
:manpage:`editrc(5)` for details.
Command history is saved in `~/.knotc_history`.
Examples
--------
......
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