Skip to content

Commit

Permalink
Liniting, typos
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexanderBand committed Dec 21, 2021
1 parent fc987bf commit cc7da81
Show file tree
Hide file tree
Showing 4 changed files with 44 additions and 41 deletions.
38 changes: 19 additions & 19 deletions source/manpages/libunbound.rst
Original file line number Diff line number Diff line change
Expand Up @@ -151,11 +151,11 @@ Description
-----------

Unbound is an implementation of a DNS resolver, that does caching and DNSSEC
validation. This is the library API, for using the -lunbound library. The server
daemon is described in :manpage:`unbound(8)`. The library works independent from
a running unbound server, and can be used to convert hostnames to ip addresses,
and back, and obtain other information from the DNS. The library performs
public-key validation of results with DNSSEC.
validation. This is the library API, for using the ``-lunbound`` library. The
server daemon is described in :manpage:`unbound(8)`. The library works
independent from a running unbound server, and can be used to convert hostnames
to ip addresses, and back, and obtain other information from the DNS. The
library performs public-key validation of results with DNSSEC.

The library uses a variable of type struct **ub_ctx** to keep context between
calls. The user must maintain it, creating it with **ub_ctx_create** and
Expand Down Expand Up @@ -368,22 +368,22 @@ The result of the DNS resolution and validation is returned as struct
.. code-block:: c
struct ub_result {
char* qname; /* text string, original question */
int qtype; /* type code asked for */
int qclass; /* class code asked for */
char** data; /* array of rdata items, NULL terminated*/
int* len; /* array with lengths of rdata items */
char* canonname; /* canonical name of result */
int rcode; /* additional error code in case of no data */
char* qname; /* text string, original question */
int qtype; /* type code asked for */
int qclass; /* class code asked for */
char** data; /* array of rdata items, NULL terminated*/
int* len; /* array with lengths of rdata items */
char* canonname; /* canonical name of result */
int rcode; /* additional error code in case of no data */
void* answer_packet; /* full network format answer packet */
int answer_len; /* length of packet in octets */
int havedata; /* true if there is data */
int nxdomain; /* true if nodata because name does not exist */
int secure; /* true if result is secure */
int bogus; /* true if a security failure happened */
char* why_bogus; /* string with error if bogus */
int answer_len; /* length of packet in octets */
int havedata; /* true if there is data */
int nxdomain; /* true if nodata because name does not exist */
int secure; /* true if result is secure */
int bogus; /* true if a security failure happened */
char* why_bogus; /* string with error if bogus */
int was_ratelimited; /* true if the query was ratelimited (SERVFAIL) by unbound */
int ttl; /* number of seconds the result is valid */
int ttl; /* number of seconds the result is valid */
};
If both secure and bogus are false, security was not enabled for the domain of
Expand Down
9 changes: 5 additions & 4 deletions source/manpages/unbound-anchor.rst
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,8 @@ The available options are:

The emailAddress for the Subject of the signer's certificate from the p7s
signature file. Only signatures from this name are allowed. default is
dnssec@iana.org. If you pass ``""`` then the emailAddress is not checked.
``dnssec@iana.org``. If you pass ``""`` then the emailAddress is not
checked.

.. option:: -4

Expand Down Expand Up @@ -146,7 +147,7 @@ The available options are:

.. option:: -C unbound.conf

Debug option to read :file:`unbound.conf`` into the resolver process
Debug option to read :file:`unbound.conf` into the resolver process
used.

.. option:: -P port
Expand Down Expand Up @@ -191,8 +192,8 @@ convenience and under the terms of our license (see the LICENSE file in the
source distribution or https://github.com/NLnetLabs/unbound/blob/master/LICENSE
and might be stale or not suitable to your purpose.

By running :command:`unbound-anchor -l` the keys and certificate that are
configured in the code are printed for your convenience.
By running ``unbound-anchor -l`` the keys and certificate that are configured in
the code are printed for your convenience.

The built-in configuration can be overridden by providing a root-cert file and a
rootkey file.
Expand Down
20 changes: 11 additions & 9 deletions source/manpages/unbound-control.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,9 @@ The available options are:

Quiet, if the option is given it does not print anything if it works ok.

COMMANDS
Commands
--------

There are several commands that the server understands.

start
Expand Down Expand Up @@ -194,13 +196,13 @@ set_option *opt: val*

get_option *opt*
Get the value of the option. Give the option name without a trailing
``':'``. The value is printed. If the value is "", nothing is printed and
the connection closes. On error 'error ...' is printed (it gives a syntax
error on unknown option). For some options a list of values, one on each
line, is printed. The options are shown from the config file as modified
with set_option. For some options an override may have been taken that does
not show up with this command, not results from e.g. the verbosity and
forward control commands. Not all options work, see list_stubs,
``':'``. The value is printed. If the value is ``""``, nothing is printed
and the connection closes. On error ``'error ...'`` is printed (it gives a
syntax error on unknown option). For some options a list of values, one on
each line, is printed. The options are shown from the config file as
modified with set_option. For some options an override may have been taken
that does not show up with this command, not results from e.g. the verbosity
and forward control commands. Not all options work, see list_stubs,
list_forwards, list_local_zones and list_local_data for those.

list_stubs
Expand All @@ -222,7 +224,7 @@ list_local_data
insecure_add *zone*
Add a domain-insecure for the given zone, like the statement in
unbound.conf. Adds to the running unbound without affecting the cache
contents (which may still be bogus, use flush_zone to re- move it), does not
contents (which may still be bogus, use flush_zone to remove it), does not
affect the config file.

insecure_remove *zone*
Expand Down
18 changes: 9 additions & 9 deletions source/manpages/unbound.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,15 @@ Description

:command:`Unbound` is a caching DNS resolver.

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.
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.

To use a locally running :command:`Unbound` for resolving put

Expand Down

0 comments on commit cc7da81

Please sign in to comment.