diff options
Diffstat (limited to 'doc/man_kjournalprint.rst')
-rw-r--r-- | doc/man_kjournalprint.rst | 88 |
1 files changed, 88 insertions, 0 deletions
diff --git a/doc/man_kjournalprint.rst b/doc/man_kjournalprint.rst new file mode 100644 index 0000000..0753ae3 --- /dev/null +++ b/doc/man_kjournalprint.rst @@ -0,0 +1,88 @@ +.. highlight:: console + +``kjournalprint`` – Knot DNS journal print utility +================================================== + +Synopsis +-------- + +:program:`kjournalprint` [*config_option* *config_argument*] [*option*...] *zone_name* + +:program:`kjournalprint` [*config_option* *config_argument*] **-z** + +Description +----------- + +The program prints zone history stored in a journal database. As default, +changes are colored for terminal. + +Config options +.............. + +**-c**, **--config** *file* + Use a textual configuration file (default is :file:`@config_dir@/knot.conf`). + +**-C**, **--confdb** *directory* + Use a binary configuration database directory (default is :file:`@storage_dir@/confdb`). + The default configuration database, if exists, has a preference to the default + configuration file. + +**-D**, **--dir** *path* + Use specified journal database path and default configuration. + +Options +....... + +**-z**, **--zone-list** + Instead of reading the journal, display the list of zones in the DB. + +**-l**, **--limit** *limit* + Limits the number of displayed changes. + +**-s**, **--serial** *soa* + Start at a specific SOA serial. + +**-H**, **--check** + Enable additional journal semantic checks during printing. + +**-d**, **--debug** + Debug mode brief output. + +**-x**, **--mono** + Don't generate colorized output. + +**-n**, **--no-color** + An alias for **-x**. Use of this option is deprecated, it will be removed in the future. + +**-X**, **--color** + Force colorized output. + +**-h**, **--help** + Print the program help. + +**-V**, **--version** + Print the program version. + +Parameters +.......... + +*zone_name* + A name of the zone to print the history for. + +Exit values +----------- + +Exit status of 0 means successful operation. Any other exit status indicates +an error. + +Examples +-------- + +Last (most recent) 5 changes without colors:: + + $ kjournalprint -nl 5 /var/lib/knot/journal example.com. + +See Also +-------- + +:manpage:`knotd(8)`, :manpage:`knot.conf(5)`. |