Commit 6bee4aa1 authored by Lubos Slovak's avatar Lubos Slovak

Doxygen updated.

- Reorganized groups.
- Updated main page.

refs #1996 @30m
parent ba342ddb
......@@ -3,68 +3,65 @@
\defgroup server Server control module.
\defgroup threading Threading API.
\defgroup network Socket API.
\defgroup config Server configuration.
\defgroup query_processing DNS query processing.
\defgroup utils Utilities, constants and macros.
\defgroup debugging Server debugging API.
\defgroup logging Server logging API.
\defgroup statistics Statistics module (optional).
\defgroup dnslib dnslib - Generic DNS library.
\defgroup libknot libknot - library of DNS-related functions
\defgroup hashing Hash table and functions.
\defgroup common_lib Common library.
\defgroup alloc Memory allocation.
\defgroup tests Unit tests.
\defgroup zoneparser Zone compiler utility
\defgroup ctl Control utility
\defgroup zone-load-dump Zone loading and dumping
\defgroup xfr Zone transfers
\mainpage Knot API documentation.
Knot is an open-source, high-performace, purely authoritative DNS server.
<h2>Requirements</h2>
- liburcu (at least 0.4.5): http://lttng.org/urcu
- automake
- autoconf
- libtool
<h2>Features</h2>
<h2>Installation</h2>
Knot uses autotools to generate makefiles.
Knot DNS supports the following DNS features:
- TCP/UDP protocols
- AXFR - master, slave
- IXFR - master (primary master experimental), slave
- TSIG
- ENDS0
- DNSSEC, including NSEC3
- NSID
- Unknown RR types
\todo Add some more info about usage and requirements.
Server features:
- Adding/removing zones on-the-fly
- Reconfiguring server instance on-the-fly
- IPv4 / IPv6 support
- Semantic checks of zones
\code
$ autoreconf -i
$ ./configure
$ make
\endcode
<h2>Starting the server</h2>
<h2>Compiling and running the server</h2>
When compiled, the following executables are created (in the src/ directory):
- \em knotd - The server
- \em knotc - Control utility
- \em knot-zcompile - Zone compiler
- \em unittests - Unit tests for the server and dnslib
- \em unittests-zcompile - Unit tests for the zone compiler
See the User manual - links to current version are provided in the
<a href="https://git.nic.cz/redmine/projects/knot-dns/wiki">Knot DNS Wiki</a>.
1. Add path to knotd and knot-zcompile executables to PATH
2. Prepare a configuration file. You may copy and edit the one provided with
the server (\em samples/knot.conf.sample).
2. Compile zone
Alternatively you can generate the manual from the sources in Info format:
\code
$ src/knotc -c path-to-config-file compile
$ make doc
\endcode
3. Run the server
or in PDF:
\code
$ src/knotc -c path-to-config-file start
$ make pdf
\endcode
<h2>Server modules</h2>
- \ref server
- \ref threading
- \ref network
- \ref config
- \ref query_processing
- \ref utils
- \ref debugging
......@@ -72,17 +69,19 @@ $ src/knotc -c path-to-config-file start
- \ref statistics
<h2>DNS library</h2>
- \ref dnslib
- \ref libknot
- \ref hashing
- \ref xfr
<h2>Common library</h2>
<h2>Zone processing</h2>
- \ref zoneparser
- \ref zone-load-dump
<h2>Common library</h2>
- \ref common_lib
- \ref alloc
<h2>Other modules</h2>
- \ref tests
- \ref zoneparser
- \ref ctl
*/
......@@ -31,7 +31,7 @@ PROJECT_NAME = Knot
# This could be handy for archiving the generated documentation or
# if some version control system is used.
PROJECT_NUMBER = 0.1.0
PROJECT_NUMBER = 1.1.0
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
# base path where the generated documentation will be put.
......
......@@ -20,7 +20,7 @@
*
* \brief DNS zone semantic checks.
*
* \addtogroup dnslib
* \addtogroup zoneparser
* @{
*/
......
......@@ -20,7 +20,7 @@
*
* \brief Functions for dumping zone to text file.
*
* \addtogroup dnslib
* \addtogroup zone-load-dump
* @{
*/
......
......@@ -20,7 +20,7 @@
*
* \brief Functions for dumping zone to binary file.
*
* \addtogroup dnslib
* \addtogroup zone-load-dump
* @{
*/
......
......@@ -20,7 +20,7 @@
*
* \brief Loader of previously parsed zone
*
* \addtogroup dnslib
* \addtogroup zone-load-dump
* @{
*/
......
......@@ -5,7 +5,7 @@
*
* \brief Structure for representing IXFR/DDNS changeset and its API.
*
* \addtogroup libknot
* \addtogroup xfr
* @{
*/
/* Copyright (C) 2011 CZ.NIC, z.s.p.o. <knot-dns@labs.nic.cz>
......
......@@ -5,7 +5,7 @@
*
* \brief Dynamic updates processing.
*
* \addtogroup query_processing
* \addtogroup ddns
* @{
*/
/* Copyright (C) 2011 CZ.NIC, z.s.p.o. <knot-dns@labs.nic.cz>
......
......@@ -5,7 +5,7 @@
*
* \brief XFR client API.
*
* \addtogroup query_processing
* \addtogroup xfr
* @{
*/
/* Copyright (C) 2011 CZ.NIC, z.s.p.o. <knot-dns@labs.nic.cz>
......
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