Commit 3a773c45 authored by Lubos Slovak's avatar Lubos Slovak

Improved documentation.

- Two documentations may be generated - API documentation
  (Doxyfile) and developer documentation (includes documentation of
  static functions, Doxyfile.devel).
- Developer documentation is generated into the doc-devel/
  directory.

refs #680
parent 2f6f3f2a
......@@ -22,42 +22,57 @@ 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>Installation</h2>
- Compile the server (and all utilities).
Knot uses autotools to generate makefiles.
\todo Add some more info about usage and requirements.
\code
$ autoreconf -i
$ ./configure
$ make
\endcode
<h2>Starting 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
<h3>Manual approach</h3>
1. Compile zones
\code
$ bin/knot-zoneparser -o example.com.db example.com. samples/example.com.zone
$ bin/knot-zoneparser -o other-zone.db other-zone.com. other-zone.com.zone
$ src/knot-zcompile -o example.com.db example.com. samples/example.com.zone
$ src/knot-zcompile -o other-zone.db other-zone.com. other-zone.com.zone
\endcode
2. Run the server with the compiled zones (use -d to run as a daemon)
\code
$ bin/knot example.com.db other-zone.db
$ src/knotd example.com.db other-zone.db
\endcode
<h3>Using knotc</h3>
- This approach currently supports only one zone file.
- Compiled zone is stored in user's home directory.
1. Add path to knotd and knot-zcompile executables to PATH
1. Add path to knot and knot-zoneparser 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
\code
$ bin/knotc compile example.com. samples/example.com.zone
$ src/knotc -c path-to-config-file compile
\endcode
3. Run the server
\code
$ bin/knotc start
$ src/knotc -c path-to-config-file start
\endcode
<h2>Server modules</h2>
......
This diff is collapsed.
This diff is collapsed.
......@@ -2,6 +2,7 @@ CodingStyle
Makefile.am
Doxy.page.h
Doxyfile
Doxyfile.devel
src/Makefile.am
src/common/slab/malloc.c
src/common/slab/malloc.h
......
......@@ -125,8 +125,8 @@ static const dnslib_zone_t *ns_get_zone_for_qname(dnslib_zonedb_t *zdb,
* \return The synthetized RRSet (this is a newly created RRSet, remember to
* free it).
*/
dnslib_rrset_t *ns_synth_from_wildcard(const dnslib_rrset_t *wildcard_rrset,
const dnslib_dname_t *qname)
static dnslib_rrset_t *ns_synth_from_wildcard(
const dnslib_rrset_t *wildcard_rrset, const dnslib_dname_t *qname)
{
debug_ns("Synthetizing RRSet from wildcard...\n");
......
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