summaryrefslogtreecommitdiff
path: root/doc/s6-dnssoa.html
diff options
context:
space:
mode:
authorLaurent Bercot <ska-skaware@skarnet.org>2014-12-10 03:05:47 +0000
committerLaurent Bercot <ska-skaware@skarnet.org>2014-12-10 03:05:47 +0000
commit416ef5e2bf59bb2e45066a1d5d91ac677c0f48e5 (patch)
tree1c746d673dcec7a8488c6ac51db8245411034376 /doc/s6-dnssoa.html
downloads6-dns-416ef5e2bf59bb2e45066a1d5d91ac677c0f48e5.tar.xz
Initial commit
Diffstat (limited to 'doc/s6-dnssoa.html')
-rw-r--r--doc/s6-dnssoa.html65
1 files changed, 65 insertions, 0 deletions
diff --git a/doc/s6-dnssoa.html b/doc/s6-dnssoa.html
new file mode 100644
index 0000000..6f4a8f2
--- /dev/null
+++ b/doc/s6-dnssoa.html
@@ -0,0 +1,65 @@
+<html>
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+ <meta http-equiv="Content-Language" content="en" />
+ <title>s6-dns: the s6-dnssoa program</title>
+ <meta name="Description" content="s6-dns: the s6-dnssoa program" />
+ <meta name="Keywords" content="s6-dns client s6-dnssoa domain soa start of authority rr field" />
+ <!-- <link rel="stylesheet" type="text/css" href="http://skarnet.org/default.css" /> -->
+ </head>
+<body>
+
+<p>
+<a href="index.html">s6-dns</a><br />
+<a href="http://skarnet.org/software/">Software</a><br />
+<a href="http://skarnet.org/">skarnet.org</a>
+</p>
+
+<h1> The s6-dnssoa program </h1>
+
+<p>
+ s6-dnssoa finds the SOA information associated to a domain.
+</p>
+
+<h2> Interface </h2>
+
+<pre>
+ s6-dnssoa [ -q ] [ -r ] [ -t <em>timeout</em> ] <em>domain</em>
+</pre>
+
+<ul>
+ <li> s6-dnsmx makes an SOA query for the name <em>domain</em>. It
+waits for the result and prints the obtained information line by line,
+then exits 0. It prints the mname, the rname, the serial number, and
+the refresh, retry, expiration and minimum times, in that order,
+separated by spaces. </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-dnssoa 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>
+
+</body>
+</html>