Skip to content
Snippets Groups Projects
Commit 2620e0f4 authored by Lubos Slovak's avatar Lubos Slovak
Browse files

Doxygen main page updated.

parent f8caf366
Branches
Tags
No related merge requests found
Makefile
Doxy.page.h
CodingStyle
src/common.h
src/main.c
src/hash/cuckoo-hash-table.c
......
......@@ -13,33 +13,54 @@
\defgroup debugging Project debugging API.
\defgroup logging Logging API.
\defgroup tests Unit tests.
\defgroup zoneparser Zone parser utility
\defgroup ctl Control utility
\mainpage CuteDNS API documentation.
CuteDNS is an open-source, high-performace, purely authoritative DNS server.
<h2>Requirements</h2>
- ldns (at least 1.6.4): http://www.nlnetlabs.nl/projects/ldns/
- liburcu (at least 0.4.5): http://lttng.org/urcu
<h2>Installation</h2>
- Compile the server.
- Compile the server (and all utilities).
\code
make
$ make
\endcode
- Parse and pre-process zones (output is stored in ***.dump file, where *** is
the file name of the original zone file).
<h2>Starting the server</h2>
<h3>Manual approach</h3>
1. Compile zones
\code
$ bin/zoneparser -o example.com.db example.com. samples/example.com.zone
$ bin/zoneparser -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/cutedns example.com.db other-zone.db
\endcode
<h3>Using cutectl</h3>
- This approach currently supports only one zone file.
- Compiled zone is stored in user's home directory.
1. Add path to cutedns and zonecompiler executables to PATH
2. Compile zone
\code
bin/zoneparser example.com. samples/example.com.zone
$ bin/cutectl compile example.com. samples/example.com.zone
\endcode
- Run the server.
3. Run the server
\code
bin/cutedns samples/example.com.zone.dump
$ bin/cutectl start
\endcode
<h2>API modules</h2>
<h2>Server modules</h2>
- \ref server
- \ref threading
- \ref network
......@@ -52,6 +73,9 @@ bin/cutedns samples/example.com.zone.dump
- \ref statistics
- \ref debugging
- \ref logging
- \ref tests
<h2>Other modules</h2>
- \ref tests
- \ref zoneparser
- \ref ctl
*/
......@@ -28,8 +28,8 @@ void help(int argc, char **argv)
" running Check if server is running.\n"
"\n"
" compile <zone_name> <zone> Compile zone file.\n"
" (<zone_name> should be a fully-"
"qualified domain name.)",
" <zone_name> should be a fully-"
"qualified domain name\n",
PROJECT_NAME, PROJECT_NAME, PROJECT_NAME, PROJECT_NAME);
}
......
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