Doc: regenerate the man-pages (coredns#2739)

A 'make -f Makefile.doc clean all'. Signed-off-by: Miek Gieben <miek@miek.nl>
horahoradev · Mar 30, 2019 · c5bad4f · c5bad4f
1 parent b75478e
commit c5bad4f
Show file tree

Hide file tree

Showing 40 changed files with 460 additions and 204 deletions.
diff --git a/man/coredns-auto.7 b/man/coredns-auto.7
@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "COREDNS\-AUTO" "7" "February 2019" "CoreDNS" "CoreDNS plugins"
+.TH "COREDNS\-AUTO" "7" "March 2019" "CoreDNS" "CoreDNS plugins"
 .
 .SH "NAME"
 \fIauto\fR \- enables serving zone data from an RFC 1035\-style master file, which is automatically picked up from disk\.

diff --git a/man/coredns-autopath.7 b/man/coredns-autopath.7
@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "COREDNS\-AUTOPATH" "7" "December 2018" "CoreDNS" "CoreDNS plugins"
+.TH "COREDNS\-AUTOPATH" "7" "March 2019" "CoreDNS" "CoreDNS plugins"
 .
 .SH "NAME"
 \fIautopath\fR \- allows for server\-side search path completion\.

diff --git a/man/coredns-bind.7 b/man/coredns-bind.7
@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "COREDNS\-BIND" "7" "October 2018" "CoreDNS" "CoreDNS plugins"
+.TH "COREDNS\-BIND" "7" "March 2019" "CoreDNS" "CoreDNS plugins"
 .
 .SH "NAME"
 \fIbind\fR \- overrides the host to which the server should bind\.

diff --git a/man/coredns-cache.7 b/man/coredns-cache.7
@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "COREDNS\-CACHE" "7" "February 2019" "CoreDNS" "CoreDNS plugins"
+.TH "COREDNS\-CACHE" "7" "March 2019" "CoreDNS" "CoreDNS plugins"
 .
 .SH "NAME"
 \fIcache\fR \- enables a frontend cache\.
@@ -112,7 +112,7 @@ Proxy to Google Public DNS and only cache responses for example\.org (or below)\
 .nf
 
 \&\. {
-    proxy \. 8\.8\.8\.8:53
+    forward \. 8\.8\.8\.8:53
     cache example\.org
 }
 .
@@ -121,4 +121,20 @@ Proxy to Google Public DNS and only cache responses for example\.org (or below)\
 .IP "" 0
 .
 .P
-Enable caching for all zones, keep a positive cache size of 5000 and a negative cache size of 2500: ~~~ corefile \. { cache { success 5000 denial 2500 } } ~~~
+Enable caching for all zones, keep a positive cache size of 5000 and a negative cache size of 2500:
+.
+.IP "" 4
+.
+.nf
+
+ \. {
+     cache {
+         success 5000
+         denial 2500
+    }
+ }
+.
+.fi
+.
+.IP "" 0
+
diff --git a/man/coredns-cancel.7 b/man/coredns-cancel.7
@@ -0,0 +1,61 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "COREDNS\-CANCEL" "7" "March 2019" "CoreDNS" "CoreDNS plugins"
+.
+.SH "NAME"
+\fIcancel\fR \- a plugin that cancels a request\'s context after 5001 milliseconds\.
+.
+.SH "DESCRIPTION"
+The \fIcancel\fR plugin creates a canceling context for each request\. It adds a timeout that gets triggered after 5001 milliseconds\.
+.
+.P
+The 5001 number is chosen because the default timeout for DNS clients is 5 seconds, after that they give up\.
+.
+.P
+A plugin interested in the cancellation status should call \fBplugin\.Done()\fR on the context\. If the context was canceled due to a timeout the plugin should not write anything back to the client and return a value indicating CoreDNS should not either; a zero return value should suffice for that\.
+.
+.IP "" 4
+.
+.nf
+
+cancel [TIMEOUT]
+.
+.fi
+.
+.IP "" 0
+.
+.IP "\(bu" 4
+\fBTIMEOUT\fR allows setting a custom timeout\. The default timeout is 5001 milliseconds (\fB5001 ms\fR)
+.
+.IP "" 0
+.
+.SH "EXAMPLES"
+.
+.nf
+
+\&\. {
+    cancel
+    whoami
+}
+.
+.fi
+.
+.P
+Or with a custom timeout:
+.
+.IP "" 4
+.
+.nf
+
+\&\. {
+    cancel 1s
+    whoami
+}
+.
+.fi
+.
+.IP "" 0
+.
+.SH "ALSO SEE"
+The Go documentation for the context package\.
diff --git a/man/coredns-chaos.7 b/man/coredns-chaos.7
@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "COREDNS\-CHAOS" "7" "October 2018" "CoreDNS" "CoreDNS plugins"
+.TH "COREDNS\-CHAOS" "7" "March 2019" "CoreDNS" "CoreDNS plugins"
 .
 .SH "NAME"
 \fIchaos\fR \- allows for responding to TXT queries in the CH class\.

diff --git a/man/coredns-debug.7 b/man/coredns-debug.7
@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "COREDNS\-DEBUG" "7" "October 2018" "CoreDNS" "CoreDNS plugins"
+.TH "COREDNS\-DEBUG" "7" "March 2019" "CoreDNS" "CoreDNS plugins"
 .
 .SH "NAME"
 \fIdebug\fR \- disables the automatic recovery upon a crash so that you\'ll get a nice stack trace\.

diff --git a/man/coredns-dnssec.7 b/man/coredns-dnssec.7
@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "COREDNS\-DNSSEC" "7" "December 2018" "CoreDNS" "CoreDNS plugins"
+.TH "COREDNS\-DNSSEC" "7" "March 2019" "CoreDNS" "CoreDNS plugins"
 .
 .SH "NAME"
 \fIdnssec\fR \- enable on\-the\-fly DNSSEC signing of served data\.

diff --git a/man/coredns-dnstap.7 b/man/coredns-dnstap.7
@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "COREDNS\-DNSTAP" "7" "October 2018" "CoreDNS" "CoreDNS plugins"
+.TH "COREDNS\-DNSTAP" "7" "March 2019" "CoreDNS" "CoreDNS plugins"
 .
 .SH "NAME"
 \fIdnstap\fR \- enable logging to dnstap\.

diff --git a/man/coredns-erratic.7 b/man/coredns-erratic.7
@@ -38,8 +38,8 @@ erratic {
 .P
 In case of a zone transfer and truncate the final SOA record \fIisn\'t\fR added to the response\.
 .
-.SH "HEALTH"
-This plugin implements dynamic health checking\. For every dropped query it turns unhealthy\.
+.SH "READY"
+This plugin reports readiness to the ready plugin\.
 .
 .SH "EXAMPLES"
 .

diff --git a/man/coredns-errors.7 b/man/coredns-errors.7
@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "COREDNS\-ERRORS" "7" "December 2018" "CoreDNS" "CoreDNS plugins"
+.TH "COREDNS\-ERRORS" "7" "March 2019" "CoreDNS" "CoreDNS plugins"
 .
 .SH "NAME"
 \fIerrors\fR \- enable error logging\.

diff --git a/man/coredns-etcd.7 b/man/coredns-etcd.7
@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "COREDNS\-ETCD" "7" "February 2019" "CoreDNS" "CoreDNS plugins"
+.TH "COREDNS\-ETCD" "7" "March 2019" "CoreDNS" "CoreDNS plugins"
 .
 .SH "NAME"
 \fIetcd\fR \- enables reading zone data from an etcd version 3 instance\.
@@ -10,7 +10,7 @@
 The data in etcd instance has to be encoded as a message \fIhttps://github\.com/skynetservices/skydns/blob/2fcff74cdc9f9a7dd64189a447ef27ac354b725f/msg/service\.go#L26\fR like SkyDNS \fIhttps://github\.com/skynetservices/skydns\fR\. It should also work just like SkyDNS\.
 .
 .P
-The etcd plugin makes extensive use of the proxy plugin to forward and query other servers in the network\.
+The etcd plugin makes extensive use of the forward plugin to forward and query other servers in the network\.
 .
 .SH "SYNTAX"
 .
@@ -61,7 +61,7 @@ etcd [ZONES\.\.\.] {
 \fBcredentials\fR is used to set the \fBUSERNAME\fR and \fBPASSWORD\fR for accessing the etcd cluster\.
 .
 .IP "\(bu" 4
-\fBupstream\fR upstream resolvers to be used resolve external names found in etcd (think CNAMEs) pointing to external names\. If you want CoreDNS to act as a proxy for clients, you\'ll need to add the proxy plugin\. If no \fBADDRESS\fR is given, CoreDNS will resolve CNAMEs against itself\. \fBADDRESS\fR can be an IP address, and IP:port or a string pointing to a file that is structured as /etc/resolv\.conf\.
+\fBupstream\fR upstream resolvers to be used resolve external names found in etcd (think CNAMEs) pointing to external names\. If you want CoreDNS to act as a proxy for clients, you\'ll need to add the \fIforward\fR plugin\. If no \fBADDRESS\fR is given, CoreDNS will resolve CNAMEs against itself\. \fBADDRESS\fR can be an IP address, and IP:port or a string pointing to a file that is structured as /etc/resolv\.conf\.
 .
 .IP "\(bu" 4
 \fBtls\fR followed by:
@@ -114,7 +114,7 @@ This is the default SkyDNS setup, with everything specified in full:
     prometheus
     cache 160 skydns\.local
     loadbalance
-    proxy \. 8\.8\.8\.8:53 8\.8\.4\.4:53
+    forward \. 8\.8\.8\.8:53 8\.8\.4\.4:53
 }
 .
 .fi
@@ -134,7 +134,7 @@ Or a setup where we use \fB/etc/resolv\.conf\fR as the basis for the proxy and t
         upstream
     }
     cache 160 skydns\.local
-    proxy \. /etc/resolv\.conf
+    forward \. /etc/resolv\.conf
 }
 .
 .fi

diff --git a/man/coredns-federation.7 b/man/coredns-federation.7
@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "COREDNS\-FEDERATION" "7" "February 2019" "CoreDNS" "CoreDNS plugins"
+.TH "COREDNS\-FEDERATION" "7" "March 2019" "CoreDNS" "CoreDNS plugins"
 .
 .SH "NAME"
 \fIfederation\fR \- enables federated queries to be resolved via the kubernetes plugin\.

diff --git a/man/coredns-file.7 b/man/coredns-file.7
@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "COREDNS\-FILE" "7" "February 2019" "CoreDNS" "CoreDNS plugins"
+.TH "COREDNS\-FILE" "7" "March 2019" "CoreDNS" "CoreDNS plugins"
 .
 .SH "NAME"
 \fIfile\fR \- enables serving zone data from an RFC 1035\-style master file\.

diff --git a/man/coredns-forward.7 b/man/coredns-forward.7
@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "COREDNS\-FORWARD" "7" "February 2019" "CoreDNS" "CoreDNS plugins"
+.TH "COREDNS\-FORWARD" "7" "March 2019" "CoreDNS" "CoreDNS plugins"
 .
 .SH "NAME"
 \fIforward\fR \- facilitates proxying DNS messages to upstream resolvers\.