From 2d53833508c08b9271160b14e56b090f1e5437aa Mon Sep 17 00:00:00 2001
From: Marek Vavrusa <marek.vavrusa@nic.cz>
Date: Wed, 15 Aug 2012 17:12:16 +0200
Subject: [PATCH] References to git,sources,more knotc,formatting for PDF.
refs #1877
---
doc/installation.texi | 3 +++
doc/running.texi | 54 +++++++++++++++++++++++++++----------------
2 files changed, 37 insertions(+), 20 deletions(-)
diff --git a/doc/installation.texi b/doc/installation.texi
index fafa5c5ecf..cde283670b 100644
--- a/doc/installation.texi
+++ b/doc/installation.texi
@@ -80,6 +80,9 @@ OpenBSD,NetBSD and OS X platforms are supported from version 0.7.0.
@node Installation from the sources
@section Installation from the sources
+You can find the source files for the latest release on @url{www.knot-dns.cz}.
+Alternatively, you can fetch the sources from git repository @url{git://git.nic.cz/knot-dns.git}
+
After unpacking the sources, the compilation and installation is
a quite straightforward process using autotools.
diff --git a/doc/running.texi b/doc/running.texi
index cc5b0a3d89..c9afb2ac09 100644
--- a/doc/running.texi
+++ b/doc/running.texi
@@ -15,33 +15,35 @@ $ knotc -c knot.conf compile
@end example
Or alternatively, you can compile automatically using the @code{-a} flag.
@example
-$ knotc -a -c knot.conf start
-$ knotc -a -c knot.conf reload
-$ knotc -a -c knot.conf restart
+$ knotc -a -c knot.conf start|reload|restart
@end example
The tool @code{knotc} is designed as a front-end for user, making it easier
to do everything from zone compilation to controlling the server daemon.
-Here's a list of all possible actions:
+To communicate with the binary, it reads the process PID from the @emph{pidfile} specified in the configuration and sends POSIX signals to it.
+If you want to control the daemon directly, use @code{SIGINT} to quit the process or @code{SIGHUP} to reload configuration. Signal @code{SIGUSR2} is currently used to refresh slave zones.
@example
Usage: knotc [parameters] start|stop|restart|reload|running|compile
- [additional]
-
Parameters:
- -c [file], --config=[file] Select configuration file.
- -j [num], --jobs=[num] Number of parallel tasks to run when
- compiling.
- -f, --force Force operation - override some checks.
- -v, --verbose Verbose mode - additional runtime
- information.
- -V, --version Print knot server version.
- -w, --wait Wait for the server to finish start/stop
- operations.
- -i, --interactive Interactive mode (do not daemonize).
- -a, --auto Enable automatic recompilation (start or
- reload).
- -h, --help Print help and usage.
+ -c [file], --config=[file]
+ Select configuration file.
+ -j [num], --jobs=[num]
+ Number of parallel tasks to run when compiling.
+ -f, --force
+ Force operation - override some checks.
+ -v, --verbose
+ Verbose mode - additional runtime information.
+ -V, --version
+ Print knot server version.
+ -w, --wait
+ Wait for the server to finish start/stop operations.
+ -i, --interactive
+ Interactive mode (do not daemonize).
+ -a, --auto
+ Enable automatic recompilation (start or reload).
+ -h, --help
+ Print help and usage.
Actions:
start Start knot server zone (no-op if running).
@@ -51,12 +53,24 @@ Actions:
refresh Refresh all slave zones.
running Check if server is running.
checkconf Check server configuration.
-
checkzone Check zones (accepts specific zones,
e.g. 'knotc checkzone example1.com example2.com').
compile Compile zones (accepts specific zones, see above).
@end example
+But if you want to run Knot DNS daemon directly, you can use @code{knotd} binary
+to do that. It accepts just configuration file and option to run in background.
+@example
+Usage: knotd [parameters]
+
+Parameters:
+ -c, --config [file] Select configuration file.
+ -d, --daemonize Run server as a daemon.
+ -v, --verbose Verbose mode - additional runtime information.
+ -V, --version Print version of the server.
+ -h, --help Print help and usage.
+@end example
+
Also, the server needs to create several files in order to run properly.
All files are placed in the directory described by @ref{storage}.
PID file can be placed elsewhere using the statement @ref{pidfile}.
--
GitLab