summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLaurent Bercot <ska-skaware@skarnet.org>2023-07-12 17:13:42 +0000
committerLaurent Bercot <ska@appnovation.com>2023-07-12 17:13:42 +0000
commitecbc657934249a2642ed542a9544a7ef5ea84021 (patch)
tree3ea8a2bcdc829c63231f0dfdacea8b35b5779ca8
parent207845f50a8fb54fe8e584928078dc3687399caf (diff)
downloads6-dns-ecbc657934249a2642ed542a9544a7ef5ea84021.tar.xz
Update documentation
Signed-off-by: Laurent Bercot <ska@appnovation.com>
-rw-r--r--doc/s6-dns-hosts-compile.html5
-rw-r--r--doc/s6-dnsip.html8
-rw-r--r--doc/s6-dnsip4.html8
-rw-r--r--doc/s6-dnsip6.html8
-rw-r--r--doc/s6-dnsname.html8
5 files changed, 31 insertions, 6 deletions
diff --git a/doc/s6-dns-hosts-compile.html b/doc/s6-dns-hosts-compile.html
index c499ded..537c025 100644
--- a/doc/s6-dns-hosts-compile.html
+++ b/doc/s6-dns-hosts-compile.html
@@ -31,7 +31,7 @@ data contained in the hosts file.
</pre>
<ul>
- <li> s6-randomip reads the <tt>/etc/hosts</tt> file, which must follow the
+ <li> s6-dns-hosts-compile reads the <tt>/etc/hosts</tt> file, which must follow the
<a href="https://man7.org/linux/man-pages/man5/hosts.5.html">traditional hosts format</a>. </li>
<li> It outputs a CDB database in the <tt>/etc/hosts.cdb</tt> file. </li>
<li> It exits 0. </li>
@@ -68,7 +68,8 @@ invocations of s6-dns tools. </li>
<li> If s6-dns tools detect that <tt>/etc/hosts</tt> has been modified more recently
than <tt>/etc/hosts.cdb</tt>, they will not use <tt>/etc/hosts.cdb</tt> and will
perform the compilation step into a temporary file. So, remember to run
-s6-dns-hosts-compile after modifying your <tt>/etc/hosts</tt>. </li>
+s6-dns-hosts-compile after modifying your <tt>/etc/hosts</tt> if you want to keep
+the tiny performance improvement. </li>
</ul>
</body>
diff --git a/doc/s6-dnsip.html b/doc/s6-dnsip.html
index 47c4970..58d538f 100644
--- a/doc/s6-dnsip.html
+++ b/doc/s6-dnsip.html
@@ -25,7 +25,7 @@
<h2> Interface </h2>
<pre>
- s6-dnsip [ -q ] [ -r ] [ -t <em>timeout</em> ] <em>domain</em>
+ s6-dnsip [ -q ] [ -H | -h ] [ -r ] [ -t <em>timeout</em> ] <em>domain</em>
</pre>
<ul>
@@ -51,6 +51,12 @@ 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>-H</tt>&nbsp;: do not use data from <tt>/etc/hosts</tt>. This is
+the default. </li>
+ <li> <tt>-h</tt>&nbsp;: use data from <tt>/etc/hosts</tt>, if available.
+If there's a compiled <tt>/etc/hosts.cdb</tt> file that is newer than <tt>/etc/hosts</tt>,
+it will be used instead. (See
+<a href="s6-dns-hosts-compile.html">s6-dns-hosts-compile</a> for details.) </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
diff --git a/doc/s6-dnsip4.html b/doc/s6-dnsip4.html
index d650ec9..ad29c7d 100644
--- a/doc/s6-dnsip4.html
+++ b/doc/s6-dnsip4.html
@@ -25,7 +25,7 @@
<h2> Interface </h2>
<pre>
- s6-dnsip4 [ -q ] [ -r ] [ -t <em>timeout</em> ] <em>domain</em>
+ s6-dnsip4 [ -q ] [ -H | -h ] [ -r ] [ -t <em>timeout</em> ] <em>domain</em>
</pre>
<ul>
@@ -51,6 +51,12 @@ 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>-H</tt>&nbsp;: do not use data from <tt>/etc/hosts</tt>. This is
+the default. </li>
+ <li> <tt>-h</tt>&nbsp;: use data from <tt>/etc/hosts</tt>, if available.
+If there's a compiled <tt>/etc/hosts.cdb</tt> file that is newer than <tt>/etc/hosts</tt>,
+it will be used instead. (See
+<a href="s6-dns-hosts-compile.html">s6-dns-hosts-compile</a> for details.) </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
diff --git a/doc/s6-dnsip6.html b/doc/s6-dnsip6.html
index 369c58a..c8ec11d 100644
--- a/doc/s6-dnsip6.html
+++ b/doc/s6-dnsip6.html
@@ -25,7 +25,7 @@
<h2> Interface </h2>
<pre>
- s6-dnsip6 [ -q ] [ -r ] [ -t <em>timeout</em> ] <em>domain</em>
+ s6-dnsip6 [ -q ] [ -H | -h ] [ -r ] [ -t <em>timeout</em> ] <em>domain</em>
</pre>
<ul>
@@ -51,6 +51,12 @@ 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>-H</tt>&nbsp;: do not use data from <tt>/etc/hosts</tt>. This is
+the default. </li>
+ <li> <tt>-h</tt>&nbsp;: use data from <tt>/etc/hosts</tt>, if available.
+If there's a compiled <tt>/etc/hosts.cdb</tt> file that is newer than <tt>/etc/hosts</tt>,
+it will be used instead. (See
+<a href="s6-dns-hosts-compile.html">s6-dns-hosts-compile</a> for details.) </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
diff --git a/doc/s6-dnsname.html b/doc/s6-dnsname.html
index 4d979d3..63e7e15 100644
--- a/doc/s6-dnsname.html
+++ b/doc/s6-dnsname.html
@@ -25,7 +25,7 @@
<h2> Interface </h2>
<pre>
- s6-dnsname [ -4 | -6 ] [ -r ] [ -t <em>timeout</em> ] <em>ip</em>
+ s6-dnsname [ -4 | -6 ] [ -H | -h ] [ -r ] [ -t <em>timeout</em> ] <em>ip</em>
</pre>
<ul>
@@ -52,6 +52,12 @@ is used instead. </li>
If neither of the <tt>-4</tt> and <tt>-6</tt> is given, or if both are
given, then <em>ip</em> will be interpreted as v4 or v6 depending on
its syntax. </li>
+ <li> <tt>-H</tt>&nbsp;: do not use data from <tt>/etc/hosts</tt>. This is
+the default. </li>
+ <li> <tt>-h</tt>&nbsp;: use data from <tt>/etc/hosts</tt>, if available.
+If there's a compiled <tt>/etc/hosts.cdb</tt> file that is newer than <tt>/etc/hosts</tt>,
+it will be used instead. (See
+<a href="s6-dns-hosts-compile.html">s6-dns-hosts-compile</a> for details.) </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