example config section in manual.

git-svn-id: file:///svn/unbound/trunk@448 be551aaa-1e26-0410-a405-d3ace91eadb9

diff --git a/doc/Changelog b/doc/Changelog
index 500c6e73b34c74594adf9b583aab21037f4f789b..ad83b52a2c8dc83278c748b5b3284dabe066335f 100644 (file)
--- a/doc/Changelog
+++ b/doc/Changelog
@@ -1,3 +1,6 @@
+24 July 2007: Wouter
+       - Example section in config manual.
+
 20 July 2007: Wouter
        - Check CNAME chain before returning cache entry with CNAMEs.
        - Option harden-glue, default is on. It will discard out of zone

diff --git a/doc/unbound.conf.5 b/doc/unbound.conf.5
index 0dc2d87dfba938fdca2b5ed03bb3536a9c37cacb..83c16b1d8b839e1f51aa0a8a2b06d3bbfcf218c2 100644 (file)
--- a/doc/unbound.conf.5
+++ b/doc/unbound.conf.5
@@ -24,6 +24,31 @@ The notation is: attribute: value.
 Comments start with # and last to the end of line. Empty lines are
 ignored as is whitespace at the beginning of a line.
 
+.El
+.Sh EXAMPLE
+An example config file is shown below. Copy this to /etc/unbound/unbound.conf
+and start the server with:
+.nf
+       $ unbound -c /etc/unbound/unbound.conf 
+.fi
+Most settings are the defaults. Stop the server with:
+.nf
+       $ kill `cat /etc/unbound/unbound.pid`
+.fi
+Below is a minimal config file. The source distribution contains an extensive
+example.conf file with all the options.
+
+.nf
+# unbound.conf(5) config file for unbound(8).
+server:
+       directory: "/etc/unbound"
+       username: unbound       # make sure it can write to pidfile, logfile.
+       chroot: "/etc/unbound"
+       logfile: "/etc/unbound/unbound.log"
+       pidfile: "/etc/unbound/unbound.pid"
+       # verbosity: 1          # uncomment and increase to get more logging.
+.fi
+
 .El
 .Sh FILE FORMAT
 There must be whitespace between keywords. Attribute keywords end with a colon ':'. An attribute