diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/index.html | 2 | ||||
| -rw-r--r-- | doc/libresolv.html | 10 | ||||
| -rw-r--r-- | doc/libs6dns/s6dns-ip46.html | 5 | ||||
| -rw-r--r-- | doc/libs6dns/s6dns-resolve.html | 4 | ||||
| -rw-r--r-- | doc/s6-dnsip4-filter.html | 2 | ||||
| -rw-r--r-- | doc/s6-dnsip6-filter.html | 2 | ||||
| -rw-r--r-- | doc/s6-dnsname-filter.html | 2 | ||||
| -rw-r--r-- | doc/skadns/index.html | 7 |
8 files changed, 19 insertions, 15 deletions
diff --git a/doc/index.html b/doc/index.html index 37ca3ed..11279ed 100644 --- a/doc/index.html +++ b/doc/index.html @@ -76,6 +76,8 @@ point in the future. the previous versions of s6-dns and the current one. </li> </ul> +<hr /> + <h2> Reference </h2> <h3> Commands </h3> diff --git a/doc/libresolv.html b/doc/libresolv.html index c7f07c7..c98b398 100644 --- a/doc/libresolv.html +++ b/doc/libresolv.html @@ -68,9 +68,9 @@ of their dependencies if they need asynchronous DNS resolution. <p> libs6dns provides several layers of asynchronous interfaces. The user has access to -<a href="libs6dns/s6dns_engine.html">low-level packet sending +<a href="libs6dns/s6dns-engine.html">low-level packet sending and receiving</a>, to -<a href="libs6dns/s6dns_resolve.html#parallel">synchronous +<a href="libs6dns/s6dns-resolve.html#parallel">synchronous resolution of several queries at once</a>, and to a <a href="skadns/">real high-level asynchronous DNS library</a>. </p> @@ -131,8 +131,10 @@ there has been nothing better so far. </p> <p> - s6-dns tries to be an alternative solution - not as ambitious, -but based on solid design principles and a reliable code base. + s6-dns tries to be an alternative solution, +based on solid design principles and a reliable code base. +It just works, and it makes DNS resolution nice and easy for +users. </p> </body> diff --git a/doc/libs6dns/s6dns-ip46.html b/doc/libs6dns/s6dns-ip46.html index 27cbe2c..52b837d 100644 --- a/doc/libs6dns/s6dns-ip46.html +++ b/doc/libs6dns/s6dns-ip46.html @@ -34,8 +34,9 @@ i.e. to be able to work with both IPv4 and IPv6. <p> If the underlying <a href="http://skarnet.org/software/skalibs/">skalibs</a> -has been compiled with - <a href="http://skarnet.org/software/skalibs/flags.html#noipv6">flag-noipv6</a>, +has been compiled with the + <a href="http://skarnet.org/software/skalibs/flags.html#noipv6">--disable-ipv6</a> +configure option, or if it has detected at build time that the target host does not support IPv6, then the s6dns-ip46 abstraction will be totally transparent and use no resources at all. diff --git a/doc/libs6dns/s6dns-resolve.html b/doc/libs6dns/s6dns-resolve.html index bad7c15..3a6abcb 100644 --- a/doc/libs6dns/s6dns-resolve.html +++ b/doc/libs6dns/s6dns-resolve.html @@ -35,7 +35,7 @@ to perform high level synchronous DNS resolution. they can block for a non-negligible amount of time. To avoid unbounded waiting times, they always take 2 arguments at the end, <em>deadline</em> and <em>stamp</em>. <em>deadline</em> is the read-only address of a -<a href="http://skarnet.org/software/skalibs/libstddjb/tai.h">tain_t</a> +<a href="http://skarnet.org/software/skalibs/libstddjb/tai.html">tain_t</a> containing an absolute time which is the deadline for the function, and <em>stamp</em> is the read-write address of a <tt>tain_t</tt> being an accurate enough representation of the current absolute time. If @@ -355,7 +355,7 @@ It must be in encoded form. </li> A list of valid query types can be found in the <tt>s6dns-constants.h</tt> header. </li> <li> <tt>options</tt> : a <tt>uint32</tt> containing options passed -to <a href="s6dns_engine.html">s6dns_engine_init()</a>. </li> +to <a href="s6dns-engine.html">s6dns_engine_init()</a>. </li> <li> <tt>deadline</tt> : a <tt>tain_t</tt> containing the deadline for this query, i.e. the query will fail with an ETIMEDOUT code if no answer has arrived by then. Note that the <em>deadline</em> diff --git a/doc/s6-dnsip4-filter.html b/doc/s6-dnsip4-filter.html index 5433438..94beb58 100644 --- a/doc/s6-dnsip4-filter.html +++ b/doc/s6-dnsip4-filter.html @@ -101,7 +101,7 @@ argument to <a href="s6-dnsq.html">s6-dnsq</a>. <h2> Notes </h2> <p> - s6-dnsip4-filter does not perform DNS resolutions itself. Instead, if forks + s6-dnsip4-filter does not perform DNS resolutions itself. Instead, it forks a <a href="skadns/skadnsd.html">skadnsd</a> child and sends it queries, getting the results asynchronously. The s6-dns filter programs have actually been written as example uses of the <a href="skadns/">skadns library</a>. diff --git a/doc/s6-dnsip6-filter.html b/doc/s6-dnsip6-filter.html index 7cbad6b..56c5ba9 100644 --- a/doc/s6-dnsip6-filter.html +++ b/doc/s6-dnsip6-filter.html @@ -89,7 +89,7 @@ program how a line must be printed. The following sequences are recognized: <h2> Notes </h2> <p> - s6-dnsip6-filter does not perform DNS resolutions itself. Instead, if forks + s6-dnsip6-filter does not perform DNS resolutions itself. Instead, it forks a <a href="skadns/skadnsd.html">skadnsd</a> child and sends it queries, getting the results asynchronously. The s6-dns filter programs have actually been written as example uses of the <a href="skadns/">skadns library</a>. diff --git a/doc/s6-dnsname-filter.html b/doc/s6-dnsname-filter.html index 1554270..28f10e0 100644 --- a/doc/s6-dnsname-filter.html +++ b/doc/s6-dnsname-filter.html @@ -93,7 +93,7 @@ program how a line must be printed. The following sequences are recognized: <h2> Notes </h2> <p> - s6-dnsname-filter does not perform DNS resolutions itself. Instead, if forks + s6-dnsname-filter does not perform DNS resolutions itself. Instead, it forks a <a href="skadns/skadnsd.html">skadnsd</a> child and sends it queries, getting the results asynchronously. The s6-dns filter programs have actually been written as example uses of the <a href="skadns/">skadns library</a>. diff --git a/doc/skadns/index.html b/doc/skadns/index.html index f02f2dd..551b341 100644 --- a/doc/skadns/index.html +++ b/doc/skadns/index.html @@ -25,13 +25,12 @@ resolution. <h2> Compiling </h2> <ul> -<ul> <li> Make sure the s6-dns headers, as well as the skalibs headers, are visible in your header search path. </li> <li> Use <tt>#include <s6-dns/skadns.h></tt> </li> <li> You might also want to include the <tt>s6-dns/s6dns.h</tt> header for the definition of the <tt>s6dns_domain_t</tt> type and the various -qtype constants </li> +qtype constants. </li> </ul> <h2> Linking </h2> @@ -40,8 +39,8 @@ qtype constants </li> <li> Make sure the s6 libraries, as well as the skalibs libraries, are visible in your library search path. </li> <li> Link against <tt>-lskadns</tt> and <tt>-lskarnet</tt>. </li> - <li> If you're using a skadnsd service, also add `cat $SYSDEPS/socket.lib` -to the end of your linking command line, $SYSDEPS standing for your + <li> If you're using a skadnsd service, also add <tt>`cat $sysdeps/socket.lib`</tt> +to the end of your linking command line, <tt>$sysdeps</tt> standing for your skalibs sysdeps directory. </li> </ul> |