Doxy.page.h 2.29 KB
Newer Older
1 2
/*!

3 4 5
\defgroup server            Server control module.
\defgroup threading         Threading API.
\defgroup network           Socket API.
Lubos Slovak's avatar
Lubos Slovak committed
6
\defgroup config            Server configuration.
7
\defgroup query_processing  DNS query processing.
8 9 10 11
\defgroup utils             Utilities, constants and macros.
\defgroup debugging         Server debugging API.
\defgroup logging           Server logging API.
\defgroup statistics        Statistics module (optional).
Lubos Slovak's avatar
Lubos Slovak committed
12
\defgroup libknot           libknot - library of DNS-related functions
13
\defgroup hashing           Hash table and functions.
14
\defgroup common_lib        Common library.
15
\defgroup alloc             Memory allocation.
16
\defgroup tests             Unit tests.
17
\defgroup zoneparser        Zone compiler utility
18
\defgroup ctl               Control utility
Lubos Slovak's avatar
Lubos Slovak committed
19 20
\defgroup zone-load-dump    Zone loading and dumping
\defgroup xfr               Zone transfers
21 22
\defgroup zone_scanner      Zone scanner (core)
\defgroup zone_scanner_test Zone scanner testing environment
23
\defgroup knot_utils        DNS utilities like host, dig and nsupdate
24

25
\mainpage Knot API documentation.
26

27
Knot is an open-source, high-performace, purely authoritative DNS server.
28

Lubos Slovak's avatar
Lubos Slovak committed
29
<h2>Features</h2>
30

Lubos Slovak's avatar
Lubos Slovak committed
31 32 33 34 35
Knot DNS supports the following DNS features:
- TCP/UDP protocols
- AXFR - master, slave
- IXFR - master (primary master experimental), slave
- TSIG
36
- EDNS0
Lubos Slovak's avatar
Lubos Slovak committed
37 38 39
- DNSSEC, including NSEC3
- NSID
- Unknown RR types
Lubos Slovak's avatar
Lubos Slovak committed
40

Lubos Slovak's avatar
Lubos Slovak committed
41 42 43 44 45
Server features:
- Adding/removing zones on-the-fly
- Reconfiguring server instance on-the-fly
- IPv4 / IPv6 support
- Semantic checks of zones
Lubos Slovak's avatar
Lubos Slovak committed
46

Lubos Slovak's avatar
Lubos Slovak committed
47
<h2>Compiling and running the server</h2>
48

Lubos Slovak's avatar
Lubos Slovak committed
49 50
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>.
Lubos Slovak's avatar
Lubos Slovak committed
51

Lubos Slovak's avatar
Lubos Slovak committed
52
Alternatively you can generate the manual from the sources in Info format:
53
\code
Lubos Slovak's avatar
Lubos Slovak committed
54
$ make doc
55 56
\endcode

Lubos Slovak's avatar
Lubos Slovak committed
57 58
or in PDF:

59
\code
Lubos Slovak's avatar
Lubos Slovak committed
60
$ make pdf
61 62
\endcode

63
<h2>Server modules</h2>
64
- \ref server
65
- \ref threading
66
- \ref network
Lubos Slovak's avatar
Lubos Slovak committed
67
- \ref config
68 69
- \ref query_processing
- \ref utils
70 71
- \ref debugging
- \ref logging
72 73 74
- \ref statistics

<h2>DNS library</h2>
Lubos Slovak's avatar
Lubos Slovak committed
75
- \ref libknot
76
- \ref hashing
Lubos Slovak's avatar
Lubos Slovak committed
77
- \ref xfr
78

Lubos Slovak's avatar
Lubos Slovak committed
79 80 81
<h2>Zone processing</h2>
- \ref zoneparser
- \ref zone-load-dump
82 83
- \ref zone_scanner
- \ref zone_scanner_test
84

Lubos Slovak's avatar
Lubos Slovak committed
85
<h2>Common library</h2>
86 87
- \ref common_lib
- \ref alloc
88

89 90 91
<h2>Other modules</h2>
- \ref tests
- \ref ctl
92
 */