summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/index.html3
-rw-r--r--doc/libs6dns/s6dns-resolve.html4
-rw-r--r--doc/s6-dnsip.html72
-rw-r--r--doc/upgrade.html6
4 files changed, 82 insertions, 3 deletions
diff --git a/doc/index.html b/doc/index.html
index 036dca0..4bd7ca3 100644
--- a/doc/index.html
+++ b/doc/index.html
@@ -60,7 +60,7 @@ requirement if you link against the shared version of the skalibs library. </li>
<h3> Download </h3>
<ul>
- <li> The current released version of s6-dns is <a href="s6-dns-2.3.2.0.tar.gz">2.3.2.0</a>. </li>
+ <li> The current released version of s6-dns is <a href="s6-dns-2.3.3.0.tar.gz">2.3.3.0</a>. </li>
<li> Alternatively, you can checkout a copy of the
<a href="//git.skarnet.org/cgi-bin/cgit.cgi/s6-dns/">s6-dns
git repository</a>:
@@ -100,6 +100,7 @@ relevant page.
<h4> Command-line DNS clients programs </h4>
<ul>
+<li><a href="s6-dnsip.html">The <tt>s6-dnsip</tt> program</a></li>
<li><a href="s6-dnsip4.html">The <tt>s6-dnsip4</tt> program</a></li>
<li><a href="s6-dnsip6.html">The <tt>s6-dnsip6</tt> program</a></li>
<li><a href="s6-dnsname.html">The <tt>s6-dnsname</tt> program</a></li>
diff --git a/doc/libs6dns/s6dns-resolve.html b/doc/libs6dns/s6dns-resolve.html
index 69596f8..5d021aa 100644
--- a/doc/libs6dns/s6dns-resolve.html
+++ b/doc/libs6dns/s6dns-resolve.html
@@ -191,7 +191,7 @@ Returns -1 if an error occurs, or 0 if no answer
can be obtained from servers, or a positive number if it succeeds: 1 if IPv4 addresses
were found, 2 if IPv6 addresses were found, and 3 if both were found.
The IPs are appended to the genalloc *<em>ips</em>, which contains an array of
-<tt>ip46_t</tt>, the skalibs structure used to store IPv4 and IPv6 addresses
+<tt>ip46full_t</tt>, the skalibs structure used to store IPv4 and IPv6 addresses
indiscriminately.
</p>
@@ -222,7 +222,7 @@ appended to the genalloc *<em>ds</em>, which contains an array of <tt>s6dns_doma
</p>
<p>
-<code> int s6dns_resolve_name46_g (genalloc *ds, ip46_t const *ip, tain_t const *deadline) </code> <br />
+<code> int s6dns_resolve_name46_g (genalloc *ds, ip46full_t const *ip, tain_t const *deadline) </code> <br />
Calls <tt>s6dns_resolve_name6_g()</tt> or <tt>s6dns_resolve_name4_g()</tt>
depending on which <em>ip</em> is an IPv6 or IPv4 address.
</p>
diff --git a/doc/s6-dnsip.html b/doc/s6-dnsip.html
new file mode 100644
index 0000000..47c4970
--- /dev/null
+++ b/doc/s6-dnsip.html
@@ -0,0 +1,72 @@
+<html>
+ <head>
+ <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>s6-dns: the s6-dnsip program</title>
+ <meta name="Description" content="s6-dns: the s6-dnsip program" />
+ <meta name="Keywords" content="s6-dns client s6-dnsip dnsip s6-dnsip6 s6-dnsip4 domain name ip address ipv6 ipv4" />
+ <!-- <link rel="stylesheet" type="text/css" href="//skarnet.org/default.css" /> -->
+ </head>
+<body>
+
+<p>
+<a href="index.html">s6-dns</a><br />
+<a href="//skarnet.org/software/">Software</a><br />
+<a href="//skarnet.org/">skarnet.org</a>
+</p>
+
+<h1> The s6-dnsip program </h1>
+
+<p>
+ s6-dnsip finds both the IPv6 and IPv4 addresses associated to a domain name.
+</p>
+
+<h2> Interface </h2>
+
+<pre>
+ s6-dnsip [ -q ] [ -r ] [ -t <em>timeout</em> ] <em>domain</em>
+</pre>
+
+<ul>
+ <li> s6-dnsip makes both an A and an AAAA query for the name <em>domain</em>,
+in parallel. It waits for the results and prints the obtained addresses,
+one per line, then exits 0. </li>
+ <li> If the domain exists but no relevant field has been found, it exits 1. </li>
+ <li> If the DNS answered but no answer is available, it prints a relevant
+error message and exits 2. </li>
+ <li> By default, s6-dnsip looks for DNS cache addresses in the
+<tt>/etc/resolv.conf</tt> file. If the DNSCACHEIP environment variable is set
+and contains a list of IP (v4 or v6) addresses, separated by commas,
+semicolons, spaces, tabs, newlines or carriage returns, then this list
+is used instead. </li>
+</ul>
+
+<h2> Options </h2>
+
+<ul>
+ <li> <tt>-q</tt>&nbsp;: qualify. Qualifies <em>domain</em> before resolution,
+according to suffixes found in <tt>/etc/resolv.conf</tt>. If the DNSQUALIFY
+environment variable is set and contains a list of suffixes separated by spaces,
+tabs, newlines or carriage returns, then this list is used instead. By
+default, no qualification is used: if <em>domain</em> is not a FQDN, a dot
+is just appended to it. </li>
+ <li> <tt>-r</tt>&nbsp;: random. By default, the program does not sort the
+result, but prints them in the order received from the DNS. With this
+option, it performs a random permutation on the results before printing
+them. </li>
+ <li> <tt>-t</tt>&nbsp;<em>timeout</em>&nbsp;: if the resolution takes more
+than <em>timeout</em> milliseconds, then it exits 99 right away with an error
+message. By default, <em>timeout</em> is 0, which means no timeout. </li>
+</ul>
+
+<h2> Notes </h2>
+
+<p>
+Even if the underlying skalibs has been compiled without IPv6 support,
+or IPv6 DNS transport is unavailable for any reason, s6-dnsip will still
+return IPv6 addresses if the AAAA query has a positive result.
+</p>
+
+</body>
+</html>
diff --git a/doc/upgrade.html b/doc/upgrade.html
index 3bf4b67..97dde72 100644
--- a/doc/upgrade.html
+++ b/doc/upgrade.html
@@ -18,6 +18,12 @@
<h1> What has changed in s6-dns </h1>
+<h2> in 2.3.3.0 </h2>
+
+<ul>
+ <li> New executable: <a href="s6-dnsip.html">s6-dnsip</a>. </li>
+</ul>
+
<h2> in 2.3.2.0 </h2>
<ul>