Run make -f Makefile.doc (#1875)

Fix typo corendns -> coredns in coredns.1

9 files changed, 50 insertions, 71 deletions

diff --git a/Makefile.doc b/Makefile.doc
index 5676bee3a..dd2aac58f 100644
--- a/Makefile.doc
+++ b/Makefile.doc
@@ -3,7 +3,7 @@ RONN:=ronn -r
 PLUGINS:=$(wildcard plugin/*/README.md)
 READMES:=$(subst plugin/,,$(PLUGINS))
 READMES:=$(subst /README.md,,$(READMES))
-PLUGINS:=$(subst plugin/,corendns-,$(PLUGINS))
+PLUGINS:=$(subst plugin/,coredns-,$(PLUGINS))
 PLUGINS:=$(subst /README.md,(7),$(PLUGINS))
 
 ifeq (, $(shell which ronn))
diff --git a/coredns.1.md b/coredns.1.md
index ddee3864e..f89c0ed53 100644
--- a/coredns.1.md
+++ b/coredns.1.md
@@ -1,6 +1,6 @@
 ## Name
 
-*coredns* - plugable DNS nameserver optimized for service discovery.
+*coredns* - plugable DNS nameserver optimized for service discovery and flexibility.
 
 ## Synopsis
 
@@ -10,7 +10,8 @@
 
 CoreDNS is a DNS server that chains plugins. Each plugin handles a DNS feature, like rewriting
 queries, kubernetes service discovery or just exporting metrics. There are many other plugins,
-each described on <https://coredns.io/plugins> and there respective manual pages.
+each described on <https://coredns.io/plugins> and there respective manual pages. Plugins not
+bundled in CoreDNS are listed on <https://coredns.io/explugins>.
 
 When started with no options CoreDNS will looks for a file names `Corefile` in the current
 directory, if found it will parse its contents and start up accordingly. If no `Corefile` is found
@@ -26,7 +27,7 @@ Available options:
 : specify maximum CPU capacity in percent.
 
 **-dns.port** **PORT**
-: override default port to listen on.
+: override default port (53) to listen on.
 
 **-pidfile** **FILE**
 : write PID to **FILE**.
diff --git a/man/coredns-hosts.7 b/man/coredns-hosts.7
index 8a2f7f8a5..c89b01614 100644
--- a/man/coredns-hosts.7
+++ b/man/coredns-hosts.7
@@ -1,17 +1,42 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "COREDNS\-HOSTS" "7" "May 2018" "CoreDNS" "CoreDNS plugins"
+.TH "COREDNS\-HOSTS" "7" "June 2018" "CoreDNS" "CoreDNS plugins"
 .
 .SH "NAME"
 \fIhosts\fR \- enables serving zone data from a \fB/etc/hosts\fR style file\.
 .
 .SH "DESCRIPTION"
-The hosts plugin is useful for serving zones from a /etc/hosts file\. It serves from a preloaded file that exists on disk\. It checks the file for changes and updates the zones accordingly\. This plugin only supports A, AAAA, and PTR records\. The hosts plugin can be used with readily available hosts files that block access to advertising servers\.
+The hosts plugin is useful for serving zones from a \fB/etc/hosts\fR file\. It serves from a preloaded file that exists on disk\. It checks the file for changes and updates the zones accordingly\. This plugin only supports A, AAAA, and PTR records\. The hosts plugin can be used with readily available hosts files that block access to advertising servers\.
 .
 .P
 This plugin can only be used once per Server Block\.
 .
+.SH "THE HOSTS FILE"
+Commonly the entries are of the from \fBIP_address canonical_hostname [aliases\.\.\.]\fR as explained by the hosts(5) man page\.
+.
+.P
+Examples:
+.
+.IP "" 4
+.
+.nf
+
+# THE FOLLOWING LINES ARE DESIRABLE FOR IPV4 CAPABLE HOSTS
+127\.0\.0\.1       localhost
+192\.168\.1\.10    example\.com            example
+
+# THE FOLLOWING LINES ARE DESIRABLE FOR IPV6 CAPABLE HOSTS
+::1                     localhost ip6\-localhost ip6\-loopback
+fdfc:a744:27b5:3b0e::1  example\.com example
+.
+.fi
+.
+.IP "" 0
+.
+.SS "PTR RECORDS"
+PTR records for reverse lookups are generated automatically by CoreDNS (based on the hosts file entries) and cannot be created manually\.
+.
 .SH "SYNTAX"
 .
 .nf
@@ -101,4 +126,6 @@ Load hosts file inlined in Corefile\.
 .fi
 .
 .IP "" 0
-
+.
+.SH "SEE ALSO"
+The form of the entries in the \fB/etc/hosts\fR file are based on IETF RFC 952 \fIhttps://tools\.ietf\.org/html/rfc952\fR which was updated by IETF RFC 1123 \fIhttps://tools\.ietf\.org/html/rfc1123\fR\.
diff --git a/man/coredns-kubernetes.7 b/man/coredns-kubernetes.7
index 660d70b13..4fe003222 100644
--- a/man/coredns-kubernetes.7
+++ b/man/coredns-kubernetes.7
@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "COREDNS\-KUBERNETES" "7" "May 2018" "CoreDNS" "CoreDNS plugins"
+.TH "COREDNS\-KUBERNETES" "7" "June 2018" "CoreDNS" "CoreDNS plugins"
 .
 .SH "NAME"
 \fIkubernetes\fR \- enables the reading zone data from a Kubernetes cluster\.
diff --git a/man/coredns-pprof.7 b/man/coredns-pprof.7
index 00d4ab612..88738e25a 100644
--- a/man/coredns-pprof.7
+++ b/man/coredns-pprof.7
@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "COREDNS\-PPROF" "7" "May 2018" "CoreDNS" "CoreDNS plugins"
+.TH "COREDNS\-PPROF" "7" "June 2018" "CoreDNS" "CoreDNS plugins"
 .
 .SH "NAME"
 \fIpprof\fR \- publishes runtime profiling data at endpoints under \fB/debug/pprof\fR\.
diff --git a/man/coredns-proxy.7 b/man/coredns-proxy.7
index f035f978a..667edcfd9 100644
--- a/man/coredns-proxy.7
+++ b/man/coredns-proxy.7
@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "COREDNS\-PROXY" "7" "May 2018" "CoreDNS" "CoreDNS plugins"
+.TH "COREDNS\-PROXY" "7" "June 2018" "CoreDNS" "CoreDNS plugins"
 .
 .SH "NAME"
 \fIproxy\fR \- facilitates both a basic reverse proxy and a robust load balancer\.
@@ -44,7 +44,7 @@ proxy FROM TO\.\.\. {
     health_check PATH:PORT [DURATION]
     except IGNORED_NAMES\.\.\.
     spray
-    protocol [dns [force_tcp]|https_google [bootstrap ADDRESS\.\.\.]|grpc [insecure|CACERT|KEY CERT|KEY CERT CACERT]]
+    protocol [dns [force_tcp]|grpc [insecure|CACERT|KEY CERT|KEY CERT CACERT]]
 }
 .
 .fi
@@ -76,7 +76,7 @@ proxy FROM TO\.\.\. {
 \fBspray\fR when all backends are unhealthy, randomly pick one to send the traffic to\. (This is a failsafe\.)
 .
 .IP "\(bu" 4
-\fBprotocol\fR specifies what protocol to use to speak to an upstream, \fBdns\fR (the default) is plain old DNS, and \fBhttps_google\fR uses \fBhttps://dns\.google\.com\fR and speaks a JSON DNS dialect\. Note when using this \fBTO\fR will be ignored\. The \fBgrpc\fR option will talk to a server that has implemented the DnsService \fIhttps://github\.com/coredns/coredns/blob/master/pb/dns\.proto\fR\.
+\fBprotocol\fR specifies what protocol to use to speak to an upstream, \fBdns\fR (the default) is plain old DNS\. The \fBgrpc\fR option will talk to a server that has implemented the DnsService \fIhttps://github\.com/coredns/coredns/blob/master/pb/dns\.proto\fR\.
 .
 .IP "" 0
 .
@@ -87,7 +87,6 @@ There are four load\-balancing policies available: * \fBrandom\fR (default) \- R
 All polices implement randomly spraying packets to backend hosts when \fIno healthy\fR hosts are available\. This is to preeempt the case where the healthchecking (as a mechanism) fails\.
 .
 .SH "UPSTREAM PROTOCOLS"
-Currently \fBprotocol\fR supports \fBdns\fR (i\.e\., standard DNS over UDP/TCP) and \fBhttps_google\fR (JSON payload over HTTPS)\. Note that with \fBhttps_google\fR the entire transport is encrypted\. Only \fIyou\fR and \fIGoogle\fR can see your DNS activity\.
 .
 .TP
 \fBdns\fR
@@ -115,13 +114,6 @@ None \- No client authentication is used, and the system CAs are used to verify
 .IP "" 0
 
 .
-.TP
-\fBhttps_google\fR
-bootstrap \fBADDRESS\.\.\.\fR is used to (re\-)resolve \fBdns\.google\.com\fR\.
-.
-.IP
-This happens every 300s\. If not specified the default is used: 8\.8\.8\.8:53/8\.8\.4\.4:53\. Note that \fBTO\fR is \fIignored\fR when \fBhttps_google\fR is used, as its upstream is defined as \fBdns\.google\.com\fR\.
-.
 .SH "METRICS"
 If monitoring is enabled (via the \fIprometheus\fR directive) then the following metric is exported:
 .
@@ -134,7 +126,7 @@ If monitoring is enabled (via the \fIprometheus\fR directive) then the following
 .IP "" 0
 .
 .P
-Where \fBproxy_proto\fR is the protocol used (\fBdns\fR, \fBgrpc\fR, or \fBhttps_google\fR) and \fBto\fR is \fBTO\fR specified in the config, \fBproto\fR is the protocol used by the incoming query ("tcp" or "udp"), family the transport family ("1" for IPv4, and "2" for IPv6)\. \fBServer\fR is the server responsible for the request (and metric)\. See the documention in the metrics plugin\.
+Where \fBproxy_proto\fR is the protocol used (\fBdns\fR or \fBgrpc\fR) and \fBto\fR is \fBTO\fR specified in the config, \fBproto\fR is the protocol used by the incoming query ("tcp" or "udp"), family the transport family ("1" for IPv4, and "2" for IPv6)\. \fBServer\fR is the server responsible for the request (and metric)\. See the documention in the metrics plugin\.
 .
 .SH "EXAMPLES"
 Proxy all requests within example\.org\. to a backend system:
@@ -232,45 +224,4 @@ Proxy everything except \fBexample\.org\fR using the host\'s \fBresolv\.conf\fR\
 .fi
 .
 .IP "" 0
-.
-.P
-Proxy all requests within \fBexample\.org\fR to Google\'s \fBdns\.google\.com\fR\.
-.
-.IP "" 4
-.
-.nf
-
-\&\. {
-    proxy example\.org 1\.2\.3\.4:53 {
-        protocol https_google
-    }
-}
-.
-.fi
-.
-.IP "" 0
-.
-.P
-Proxy everything with HTTPS to \fBdns\.google\.com\fR, except \fBexample\.org\fR\. Then have another proxy in another stanza that uses plain DNS to resolve names under \fBexample\.org\fR\.
-.
-.IP "" 4
-.
-.nf
 
-\&\. {
-    proxy \. 1\.2\.3\.4:53 {
-        except example\.org
-        protocol https_google
-    }
-}
-
-example\.org {
-    proxy \. 8\.8\.8\.8:53
-}
-.
-.fi
-.
-.IP "" 0
-.
-.SH "BUGS"
-When using the \fBgoogle_https\fR protocol the health checking will health check the wrong endpoint\. See \fIhttps://github\.com/coredns/coredns/issues/1202\fR for some background\.
diff --git a/man/coredns-rewrite.7 b/man/coredns-rewrite.7
index 400ee2d8f..8750e87c3 100644
--- a/man/coredns-rewrite.7
+++ b/man/coredns-rewrite.7
@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "COREDNS\-REWRITE" "7" "May 2018" "CoreDNS" "CoreDNS plugins"
+.TH "COREDNS\-REWRITE" "7" "June 2018" "CoreDNS" "CoreDNS plugins"
 .
 .SH "NAME"
 \fIrewrite\fR \- performs internal message rewriting\.
diff --git a/man/coredns-template.7 b/man/coredns-template.7
index 3ee650664..7137c3652 100644
--- a/man/coredns-template.7
+++ b/man/coredns-template.7
@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "COREDNS\-TEMPLATE" "7" "May 2018" "CoreDNS" "CoreDNS plugins"
+.TH "COREDNS\-TEMPLATE" "7" "June 2018" "CoreDNS" "CoreDNS plugins"
 .
 .SH "NAME"
 \fItemplate\fR \- allows for dynamic responses based on the incoming query\.
@@ -141,7 +141,7 @@ The answer is always NXDOMAIN
 .IP "" 0
 .
 .SS "RESOLVE \.INVALID AS NXDOMAIN"
-The \fB\.invalid\fR domain is a reserved TLD (see RFC\-2606 Reserved Top Level DNS Names \fIhttps://tools\.ietf\.org/html/rfc2606#section\-2\fR) to indicate invalid domains\.
+The \fB\.invalid\fR domain is a reserved TLD (see RFC 2606 Reserved Top Level DNS Names \fIhttps://tools\.ietf\.org/html/rfc2606#section\-2\fR) to indicate invalid domains\.
 .
 .IP "" 4
 .
@@ -337,7 +337,7 @@ Go regexp \fIhttps://golang\.org/pkg/regexp/\fR for details about the regex impl
 RE2 syntax reference \fIhttps://github\.com/google/re2/wiki/Syntax\fR for details about the regex syntax
 .
 .IP "\(bu" 4
-RFC\-1034 \fIhttps://tools\.ietf\.org/html/rfc1034#section\-3\.6\.1\fR and RFC 1035 \fIhttps://tools\.ietf\.org/html/rfc1035#section\-5\fR for the resource record format
+RFC 1034 \fIhttps://tools\.ietf\.org/html/rfc1034#section\-3\.6\.1\fR and RFC 1035 \fIhttps://tools\.ietf\.org/html/rfc1035#section\-5\fR for the resource record format
 .
 .IP "\(bu" 4
 Go template \fIhttps://golang\.org/pkg/text/template/\fR for the template language reference
diff --git a/man/coredns.1 b/man/coredns.1
index 95814f87d..0f8576b63 100644
--- a/man/coredns.1
+++ b/man/coredns.1
@@ -1,19 +1,19 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "COREDNS" "1" "May 2018" "CoreDNS" "CoreDNS"
+.TH "COREDNS" "1" "June 2018" "CoreDNS" "CoreDNS"
 .
 .SH "NAME"
 \fBcoredns\fR
 .
 .SH "NAME"
-\fIcoredns\fR \- plugable DNS nameserver optimized for service discovery\.
+\fIcoredns\fR \- plugable DNS nameserver optimized for service discovery and flexibility\.
 .
 .SH "SYNOPSIS"
 \fIcoredns\fR \fI[OPTION]\fR\.\.\.
 .
 .SH "DESCRIPTION"
-CoreDNS is a DNS server that chains plugins\. Each plugin handles a DNS feature, like rewriting queries, kubernetes service discovery or just exporting metrics\. There are many other plugins, each described on \fIhttps://coredns\.io/plugins\fR and there respective manual pages\.
+CoreDNS is a DNS server that chains plugins\. Each plugin handles a DNS feature, like rewriting queries, kubernetes service discovery or just exporting metrics\. There are many other plugins, each described on \fIhttps://coredns\.io/plugins\fR and there respective manual pages\. Plugins not bundled in CoreDNS are listed on \fIhttps://coredns\.io/explugins\fR\.
 .
 .P
 When started with no options CoreDNS will looks for a file names \fBCorefile\fR in the current directory, if found it will parse its contents and start up accordingly\. If no \fBCorefile\fR is found it will start with the \fIwhoami\fR plugin (coredns\-whoami(7)) and start listening on port 53 (unless overriden with \fB\-dns\.port\fR)\.
@@ -31,7 +31,7 @@ specify maximum CPU capacity in percent\.
 .
 .TP
 \fB\-dns\.port\fR \fBPORT\fR
-override default port to listen on\.
+override default port (53) to listen on\.
 .
 .TP
 \fB\-pidfile\fR \fBFILE\fR
@@ -56,4 +56,4 @@ CoreDNS Authors\.
 Apache License 2\.0
 .
 .SH "SEE ALSO"
-Corefile(5) corendns\-erratic(7) corendns\-hosts(7) corendns\-dnssec(7) corendns\-health(7) corendns\-file(7) corendns\-root(7) corendns\-auto(7) corendns\-dnstap(7) corendns\-pprof(7) corendns\-tls(7) corendns\-loadbalance(7) corendns\-cache(7) corendns\-whoami(7) corendns\-bind(7) corendns\-chaos(7) corendns\-template(7) corendns\-proxy(7) corendns\-autopath(7) corendns\-log(7) corendns\-kubernetes(7) corendns\-forward(7) corendns\-debug(7) corendns\-nsid(7) corendns\-secondary(7) corendns\-route53(7) corendns\-reverse(7) corendns\-errors(7) corendns\-metrics(7) corendns\-reload(7) corendns\-rewrite(7) corendns\-federation(7) corendns\-etcd(7) corendns\-trace(7)\.
+Corefile(5) coredns\-debug(7) coredns\-dnssec(7) coredns\-health(7) coredns\-log(7) coredns\-file(7) coredns\-nsid(7) coredns\-auto(7) coredns\-erratic(7) coredns\-chaos(7) coredns\-dnstap(7) coredns\-pprof(7) coredns\-tls(7) coredns\-loadbalance(7) coredns\-cache(7) coredns\-root(7) coredns\-whoami(7) coredns\-bind(7) coredns\-hosts(7) coredns\-template(7) coredns\-proxy(7) coredns\-autopath(7) coredns\-kubernetes(7) coredns\-forward(7) coredns\-secondary(7) coredns\-route53(7) coredns\-errors(7) coredns\-metrics(7) coredns\-reload(7) coredns\-rewrite(7) coredns\-federation(7) coredns\-etcd(7) coredns\-trace(7)\.