diff options
Diffstat (limited to 'doc/s6-dnstxt.html')
| -rw-r--r-- | doc/s6-dnstxt.html | 77 |
1 files changed, 77 insertions, 0 deletions
diff --git a/doc/s6-dnstxt.html b/doc/s6-dnstxt.html new file mode 100644 index 0000000..fa84174 --- /dev/null +++ b/doc/s6-dnstxt.html @@ -0,0 +1,77 @@ +<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-dnstxt program</title> + <meta name="Description" content="s6-dns: the s6-dnstxt program" /> + <meta name="Keywords" content="s6-dns client s6-dnstxt dnstxt domain name txt text 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-dnstxt program </h1> + +<p> + s6-dnstxt finds the TXT information associated to a domain name. +</p> + +<h2> Interface </h2> + +<pre> + s6-dnstxt [ -q ] [ -r ] [ -t <em>timeout</em> ] <em>domain</em> +</pre> + +<ul> + <li> s6-dnstxt makes a TXT query for the name <em>domain</em>. It +waits for the result and prints the obtained strings, one by line, +in a quoted form similar to +<a href="http://skarnet.org/software/s6-portable-utils/s6-quote.html">s6-quote</a>'s +output. You can pipe s6-dnstxt's output through +<a href="http://skarnet.org/software/s6-portable-utils/s6-unquote-filter.html">s6-unquote-filter</a> +to get unquoted TXT fields. </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-dnstxt 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> : 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> : 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> <em>timeout</em> : 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> + There can be more than one character-string in a TXT RR, and there can be +more than one TXT RR per domain. DNS clients usually concatenate all this +and only give one string. s6-dnstxt concatenates all the character-strings +in one TXT record, but separates different TXT records, printing each one +on a separate line. +</p> + +</body> +</html> |