diff --git a/CuteDNS.files b/CuteDNS.files index 3198fc5ab5ac5b6ee44223d347f55d06a32bd993..aee335c70faed5ac9757d4c2f7bf5498c5309c00 100644 --- a/CuteDNS.files +++ b/CuteDNS.files @@ -1,4 +1,6 @@ Makefile +Doxy.page.h +CodingStyle src/common.h src/main.c src/hash/cuckoo-hash-table.c diff --git a/Doxy.page.h b/Doxy.page.h index f4bb5771967ec10d8f5d4641b34557402e1539b5..50a83ea1bfdfa09bcdb25ec90ba78219f2c6bff8 100644 --- a/Doxy.page.h +++ b/Doxy.page.h @@ -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 */ diff --git a/src/ctl/main.c b/src/ctl/main.c index 9b3de62188d47006e73e6776210bcf0a935648e9..b477cba576c1cedcbd978dd24c7b3a96f3826958 100644 --- a/src/ctl/main.c +++ b/src/ctl/main.c @@ -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); }