- Update unbound manpage with more explanation (from Florian Obser).

- Removed .LP after .SH.

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

diff --git a/doc/Changelog b/doc/Changelog
index 62e48fa335feb22b804513029240fc2d4cf2c1b2..aabd7b67727d014ddb6ffa89d72d3d52d73d9903 100644 (file)
--- a/doc/Changelog
+++ b/doc/Changelog
@@ -1,3 +1,6 @@
+19 August 2014: Wouter
+       - Update unbound manpage with more explanation (from Florian Obser).
+
 18 August 2014: Wouter
        - Fix #603: unbound-checkconf -o <option> should skip verification
          checks.

diff --git a/doc/libunbound.3.in b/doc/libunbound.3.in
index 8807ac12897b50bd6c1c6ff85bc8a6f08b586f71..14e2a059f6e3c8a71fb886f74b7747cac8f6ac2f 100644 (file)
--- a/doc/libunbound.3.in
+++ b/doc/libunbound.3.in
@@ -8,7 +8,6 @@
 .\"
 .\"
 .SH "NAME"
-.LP
 .B libunbound,
 .B unbound.h,
 .B ub_ctx,
@@ -44,7 +43,6 @@
 .B ub_ctx_data_remove
 \- Unbound DNS validating resolver @version@ functions.
 .SH "SYNOPSIS"
-.LP
 .B #include <unbound.h>
 .LP
 \fIstruct ub_ctx *\fR
@@ -137,7 +135,6 @@
 \fIint\fR
 \fBub_ctx_data_remove\fR(\fIstruct ub_ctx*\fR ctx, \fIchar*\fR data);
 .SH "DESCRIPTION"
-.LP
 .B Unbound 
 is an implementation of a DNS resolver, that does caching and 
 DNSSEC validation. This is the library API, for using the \-lunbound library.
@@ -342,7 +339,6 @@ Add resource record data to local authority info, like local\-data
 .B ub_ctx_data_remove
 Delete local authority data from the name given.
 .SH "RESULT DATA STRUCTURE"
-.LP
 The result of the DNS resolution and validation is returned as 
 \fIstruct ub_result\fR. The result structure contains the following entries.
 .P

diff --git a/doc/unbound-anchor.8.in b/doc/unbound-anchor.8.in
index 64a4ef3ba154b20ddfeeb753fdc2a602914e402c..0c0e9e14258cd09ecf9361ba72302fb40c0d0fc3 100644 (file)
--- a/doc/unbound-anchor.8.in
+++ b/doc/unbound-anchor.8.in
@@ -8,7 +8,6 @@
 .\"
 .\"
 .SH "NAME"
-.LP
 .B unbound\-anchor
 \- Unbound anchor utility.
 .SH "SYNOPSIS"

diff --git a/doc/unbound-checkconf.8.in b/doc/unbound-checkconf.8.in
index 9b452122200078d21cfd3e79b6032f0c53f99bd1..6d0e54516bc9a3dc6eec0b6e2aff6d561a465b33 100644 (file)
--- a/doc/unbound-checkconf.8.in
+++ b/doc/unbound-checkconf.8.in
@@ -8,7 +8,6 @@
 .\"
 .\"
 .SH "NAME"
-.LP
 unbound\-checkconf
 \- Check unbound configuration file for errors.
 .SH "SYNOPSIS"

diff --git a/doc/unbound-control.8.in b/doc/unbound-control.8.in
index 6478af0107be138153943a2a407680b8c1a90491..b050ac7b46f1f2fefa7ec92b1ddf428eae28414a 100644 (file)
--- a/doc/unbound-control.8.in
+++ b/doc/unbound-control.8.in
@@ -8,7 +8,6 @@
 .\"
 .\"
 .SH "NAME"
-.LP
 .B unbound\-control,
 .B unbound\-control\-setup
 \- Unbound remote server control utility.

diff --git a/doc/unbound-host.1.in b/doc/unbound-host.1.in
index 29865217f286eea790166d66f83d21c9607851aa..0d45c50ca1871a85adee9f6ecdd5cf70fb52059f 100644 (file)
--- a/doc/unbound-host.1.in
+++ b/doc/unbound-host.1.in
@@ -8,11 +8,9 @@
 .\"
 .\"
 .SH "NAME"
-.LP
 .B unbound\-host
 \- unbound DNS lookup utility
 .SH "SYNOPSIS"
-.LP
 .B unbound\-host
 .RB [ \-vdhr46D ]
 .RB [ \-c 
@@ -29,7 +27,6 @@
 .RB [ \-C
 .IR configfile ]
 .SH "DESCRIPTION"
-.LP
 .B Unbound\-host
 uses the unbound validating resolver to query for the hostname and display
 results. With the \fB\-v\fR option it displays validation 
@@ -102,7 +99,6 @@ Use solely the IPv4 network for sending packets.
 .B \-6
 Use solely the IPv6 network for sending packets.
 .SH "EXAMPLES"
-.LP
 Some examples of use. The keys shown below are fakes, thus a security failure
 is encountered.
 .P

diff --git a/doc/unbound.8.in b/doc/unbound.8.in
index c801bfd0dddfc0d72e59c66c2a7ca49ac0b3806f..36014430dc29c52082397c96c53c16572a37378e 100644 (file)
--- a/doc/unbound.8.in
+++ b/doc/unbound.8.in
@@ -8,22 +8,47 @@
 .\"
 .\"
 .SH "NAME"
-.LP
 .B unbound
 \- Unbound DNS validating resolver @version@.
 .SH "SYNOPSIS"
-.LP
 .B unbound
 .RB [ \-h ]
 .RB [ \-d ]
 .RB [ \-v ]
-.RB [ \-c 
+.RB [ \-c
 .IR cfgfile ]
 .SH "DESCRIPTION"
-.LP
-.B Unbound 
-is an implementation of a DNS resolver, that does caching and 
-DNSSEC validation.
+.B Unbound
+is a caching DNS resolver.
+.P
+It uses a built in list of authoritative nameservers for the root zone (.),
+the so called root hints.
+On receiving a DNS query it will ask the root nameservers for
+an answer and will in almost all cases receive a delegation to a top level
+domain (TLD) authoritative nameserver.
+It will then ask that nameserver for an answer.
+It will recursively continue until an answer is found or no answer is
+available (NXDOMAIN).
+For performance and efficiency reasons that answer is cached for a
+certain time (the answer's time\-to\-live or TTL).
+A second query for the same name will then be answered from the cache.
+Unbound can also do DNSSEC validation.
+.P
+To use a locally running
+.B Unbound
+for resolving put
+.sp
+.RS 6n
+nameserver 127.0.0.1
+.RE
+.sp
+into
+.IR resolv.conf (5).
+.P
+If authoritative DNS is needed as well using
+.IR nsd (8),
+careful setup is required because authoritative nameservers and
+resolvers are using the same port number (53).
 .P
 The available options are:
 .TP
@@ -31,7 +56,7 @@ The available options are:
 Show the version and commandline option help.
 .TP
 .B \-c\fI cfgfile
-Set the config file with settings for unbound to read instead of reading the 
+Set the config file with settings for unbound to read instead of reading the
 file at the default location, @ub_conf_file@. The syntax is
 described in \fIunbound.conf\fR(5).
 .TP
@@ -46,8 +71,9 @@ or to syslog, but the log messages are printed to stderr all the time.
 Increase verbosity. If given multiple times, more information is logged.
 This is in addition to the verbosity (if any) from the config file.
 .SH "SEE ALSO"
-\fIunbound.conf\fR(5), 
-\fIunbound\-checkconf\fR(8).
+\fIunbound.conf\fR(5),
+\fIunbound\-checkconf\fR(8),
+\fInsd\fR(8).
 .SH "AUTHORS"
 .B Unbound
 developers are mentioned in the CREDITS file in the distribution.

diff --git a/doc/unbound.conf.5.in b/doc/unbound.conf.5.in
index d98492ca34a3d1bcfc5bd36ac67324802d52b48f..11c77fdfeda00c900f7e30978abb0ef1d9291f61 100644 (file)
--- a/doc/unbound.conf.5.in
+++ b/doc/unbound.conf.5.in
@@ -8,14 +8,11 @@
 .\"
 .\"
 .SH "NAME"
-.LP
 .B unbound.conf
 \- Unbound configuration file.
 .SH "SYNOPSIS"
-.LP
 .B unbound.conf
 .SH "DESCRIPTION"
-.LP
 .B unbound.conf
 is used to configure
 \fIunbound\fR(8).
@@ -65,7 +62,6 @@ server:
        access\-control: 2001:DB8::/64 allow
 .fi
 .SH "FILE FORMAT"
-.LP
 There must be whitespace between keywords. Attribute keywords end with a colon ':'. An attribute
 is followed by its containing attributes, or a value.
 .P