Mirrors/coredns
1
0
Fork 0
mirror of https://github.com/coredns/coredns.git synced 2025-10-26 15:54:16 -04:00
Code Issues Packages Projects Releases Wiki Activity

Regenerate man page (#3946)

Browse Source 
Regenerate man page `make -f Makefile.doc`, in praparation for 1.7.0
release.

Signed-off-by: Yong Tang <yong.tang.github@outlook.com>
This commit is contained in:
Yong Tang
2020-06-13 07:41:05 -07:00
committed by GitHub
parent 4734c0db45
commit 9545346174
45 changed files with 77 additions and 62 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
man/coredns-acl.7
View File

@@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-ACL" 7 "April 2020" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-ACL" 7 "June 2020" "CoreDNS" "CoreDNS Plugins"
.SH "NAME"
.PP
@@ -80,7 +80,7 @@ Allow only DNS queries from 192.168.0.0/24 and 192.168.1.0/24:
.nf
\&. {
acl {
allow net 192.168.0.0/16 192.168.1.0/24
allow net 192.168.0.0/24 192.168.1.0/24
block
}
}

2
man/coredns-any.7
View File

@@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-ANY" 7 "April 2020" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-ANY" 7 "June 2020" "CoreDNS" "CoreDNS Plugins"
.SH "NAME"
.PP

2
man/coredns-auto.7
View File

@@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-AUTO" 7 "April 2020" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-AUTO" 7 "June 2020" "CoreDNS" "CoreDNS Plugins"
.SH "NAME"
.PP

2
man/coredns-autopath.7
View File

@@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-AUTOPATH" 7 "April 2020" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-AUTOPATH" 7 "June 2020" "CoreDNS" "CoreDNS Plugins"
.SH "NAME"
.PP

2
man/coredns-azure.7
View File

@@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-AZURE" 7 "April 2020" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-AZURE" 7 "June 2020" "CoreDNS" "CoreDNS Plugins"
.SH "NAME"
.PP

2
man/coredns-bind.7
View File

@@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-BIND" 7 "April 2020" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-BIND" 7 "June 2020" "CoreDNS" "CoreDNS Plugins"
.SH "NAME"
.PP

4
man/coredns-bufsize.7
View File

@@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-BUFSIZE" 7 "April 2020" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-BUFSIZE" 7 "June 2020" "CoreDNS" "CoreDNS Plugins"
.SH "NAME"
.PP
@@ -8,7 +8,7 @@
.SH "DESCRIPTION"
.PP
\fIbufsize\fP limits a requester's UDP payload size.
It prevents IP fragmentation so that to deal with DNS vulnerability.
It prevents IP fragmentation, mitigating certain DNS vulnerabilities.
.SH "SYNTAX"
.PP

2
man/coredns-cache.7
View File

@@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-CACHE" 7 "April 2020" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-CACHE" 7 "June 2020" "CoreDNS" "CoreDNS Plugins"
.SH "NAME"
.PP

2
man/coredns-cancel.7
View File

@@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-CANCEL" 7 "April 2020" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-CANCEL" 7 "June 2020" "CoreDNS" "CoreDNS Plugins"
.SH "NAME"
.PP

2
man/coredns-chaos.7
View File

@@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-CHAOS" 7 "April 2020" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-CHAOS" 7 "June 2020" "CoreDNS" "CoreDNS Plugins"
.SH "NAME"
.PP

2
man/coredns-clouddns.7
View File

@@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-CLOUDDNS" 7 "April 2020" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-CLOUDDNS" 7 "June 2020" "CoreDNS" "CoreDNS Plugins"
.SH "NAME"
.PP

2
man/coredns-debug.7
View File

@@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-DEBUG" 7 "April 2020" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-DEBUG" 7 "June 2020" "CoreDNS" "CoreDNS Plugins"
.SH "NAME"
.PP

13
man/coredns-dns64.7
View File

@@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-DNS64" 7 "April 2020" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-DNS64" 7 "June 2020" "CoreDNS" "CoreDNS Plugins"
.SH "NAME"
.PP
@@ -77,10 +77,17 @@ Use a custom prefix.
\&. {
dns64 64:1337::/96
}
~~~~
.fi
.RE
.PP
Or
~~~ corefile
.PP
.RS
.nf
\&. {
dns64 {
prefix 64:1337::/96

2
man/coredns-dnssec.7
View File

@@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-DNSSEC" 7 "April 2020" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-DNSSEC" 7 "June 2020" "CoreDNS" "CoreDNS Plugins"
.SH "NAME"
.PP

2
man/coredns-dnstap.7
View File

@@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-DNSTAP" 7 "April 2020" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-DNSTAP" 7 "June 2020" "CoreDNS" "CoreDNS Plugins"
.SH "NAME"
.PP

2
man/coredns-erratic.7
View File

@@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-ERRATIC" 7 "April 2020" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-ERRATIC" 7 "June 2020" "CoreDNS" "CoreDNS Plugins"
.SH "NAME"
.PP

2
man/coredns-errors.7
View File

@@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-ERRORS" 7 "April 2020" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-ERRORS" 7 "June 2020" "CoreDNS" "CoreDNS Plugins"
.SH "NAME"
.PP

2
man/coredns-etcd.7
View File

@@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-ETCD" 7 "April 2020" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-ETCD" 7 "June 2020" "CoreDNS" "CoreDNS Plugins"
.SH "NAME"
.PP

2
man/coredns-file.7
View File

@@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-FILE" 7 "April 2020" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-FILE" 7 "June 2020" "CoreDNS" "CoreDNS Plugins"
.SH "NAME"
.PP

8
man/coredns-forward.7
View File

@@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-FORWARD" 7 "April 2020" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-FORWARD" 7 "June 2020" "CoreDNS" "CoreDNS Plugins"
.SH "NAME"
.PP
@@ -150,12 +150,12 @@ Also note the TLS config is "global" for the whole forwarding proxy if you need
\fB\fCtls-name\fR for different upstreams you're out of luck.
.PP
On each endpoint, the timeouts of the communication are set by default and automatically tuned depending early results.
On each endpoint, the timeouts for communication are set as follows:
.IP \(bu 4
dialTimeout by default is 30 sec, and can decrease automatically down to 100ms
The dial timeout by default is 30s, and can decrease automatically down to 100ms based on early results.
.IP \(bu 4
readTimeout by default is 2 sec, and can decrease automatically down to 200ms
The read timeout is static at 2s.
.SH "METRICS"

2
man/coredns-grpc.7
View File

@@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-GRPC" 7 "April 2020" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-GRPC" 7 "June 2020" "CoreDNS" "CoreDNS Plugins"
.SH "NAME"
.PP

2
man/coredns-health.7
View File

@@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-HEALTH" 7 "April 2020" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-HEALTH" 7 "June 2020" "CoreDNS" "CoreDNS Plugins"
.SH "NAME"
.PP

2
man/coredns-hosts.7
View File

@@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-HOSTS" 7 "April 2020" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-HOSTS" 7 "June 2020" "CoreDNS" "CoreDNS Plugins"
.SH "NAME"
.PP

2
man/coredns-import.7
View File

@@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-IMPORT" 7 "April 2020" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-IMPORT" 7 "June 2020" "CoreDNS" "CoreDNS Plugins"
.SH "NAME"
.PP

2
man/coredns-k8s_external.7
View File

@@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-K8S_EXTERNAL" 7 "April 2020" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-K8S_EXTERNAL" 7 "June 2020" "CoreDNS" "CoreDNS Plugins"
.SH "NAME"
.PP

28
man/coredns-kubernetes.7
View File

@@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-KUBERNETES" 7 "April 2020" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-KUBERNETES" 7 "June 2020" "CoreDNS" "CoreDNS Plugins"
.SH "NAME"
.PP
@@ -241,7 +241,8 @@ upstreamNameservers: |
.PP
The \fIkubernetes\fP plugin can be used in conjunction with the \fIautopath\fP plugin. Using this
feature enables server-side domain search path completion in Kubernetes clusters. Note: \fB\fCpods\fR must
be set to \fB\fCverified\fR for this to function properly.
be set to \fB\fCverified\fR for this to function properly. Furthermore, the remote IP address in the DNS
packet received by CoreDNS must be the IP address of the Pod that sent the request.
.PP
.RS
@@ -294,23 +295,30 @@ The kubernetes plugin will publish the following metadata, if the \fImetadata\fP
plugin is also enabled:
.IP \(bu 4
kubernetes/endpoint: the endpoint name in the query
\fB\fCkubernetes/endpoint\fR: the endpoint name in the query
.IP \(bu 4
kubernetes/kind: the resource kind (pod or svc) in the query
\fB\fCkubernetes/kind\fR: the resource kind (pod or svc) in the query
.IP \(bu 4
kubernetes/namespace: the namespace in the query
\fB\fCkubernetes/namespace\fR: the namespace in the query
.IP \(bu 4
kubernetes/port-name: the port name in an SRV query
\fB\fCkubernetes/port-name\fR: the port name in an SRV query
.IP \(bu 4
kubernetes/protocol: the protocol in an SRV query
\fB\fCkubernetes/protocol\fR: the protocol in an SRV query
.IP \(bu 4
kubernetes/service: the service name in the query
\fB\fCkubernetes/service\fR: the service name in the query
.IP \(bu 4
kubernetes/client-namespace: the client pod's namespace, if \fB\fCpods verified\fR mode is enabled
\fB\fCkubernetes/client-namespace\fR: the client pod's namespace (see requirements below)
.IP \(bu 4
kubernetes/client-pod-name: the client pod's name, if \fB\fCpods verified\fR mode is enabled
\fB\fCkubernetes/client-pod-name\fR: the client pod's name (see requirements below)
.PP
The \fB\fCkubernetes/client-namespace\fR and \fB\fCkubernetes/client-pod-name\fR metadata work by reconciling the
client IP address in the DNS request packet to a known pod IP address. Therefore the following is required:
* \fB\fCpods verified\fR mode must be enabled
* the remote IP address in the DNS packet received by CoreDNS must be the IP address
of the Pod that sent the request.
.SH "METRICS"
.PP
If monitoring is enabled (via the \fIprometheus\fP plugin) then the following metrics are exported:

2
man/coredns-loadbalance.7
View File

@@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-LOADBALANCE" 7 "April 2020" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-LOADBALANCE" 7 "June 2020" "CoreDNS" "CoreDNS Plugins"
.SH "NAME"
.PP

2
man/coredns-log.7
View File

@@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-LOG" 7 "April 2020" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-LOG" 7 "June 2020" "CoreDNS" "CoreDNS Plugins"
.SH "NAME"
.PP

2
man/coredns-loop.7
View File

@@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-LOOP" 7 "April 2020" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-LOOP" 7 "June 2020" "CoreDNS" "CoreDNS Plugins"
.SH "NAME"
.PP

2
man/coredns-metadata.7
View File

@@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-METADATA" 7 "April 2020" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-METADATA" 7 "June 2020" "CoreDNS" "CoreDNS Plugins"
.SH "NAME"
.PP

2
man/coredns-metrics.7
View File

@@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-METRICS" 7 "April 2020" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-METRICS" 7 "June 2020" "CoreDNS" "CoreDNS Plugins"
.SH "NAME"
.PP

2
man/coredns-nsid.7
View File

@@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-NSID" 7 "April 2020" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-NSID" 7 "June 2020" "CoreDNS" "CoreDNS Plugins"
.SH "NAME"
.PP

2
man/coredns-pprof.7
View File

@@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-PPROF" 7 "April 2020" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-PPROF" 7 "June 2020" "CoreDNS" "CoreDNS Plugins"
.SH "NAME"
.PP

2
man/coredns-ready.7
View File

@@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-READY" 7 "April 2020" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-READY" 7 "June 2020" "CoreDNS" "CoreDNS Plugins"
.SH "NAME"
.PP

2
man/coredns-reload.7
View File

@@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-RELOAD" 7 "April 2020" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-RELOAD" 7 "June 2020" "CoreDNS" "CoreDNS Plugins"
.SH "NAME"
.PP

2
man/coredns-rewrite.7
View File

@@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-REWRITE" 7 "April 2020" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-REWRITE" 7 "June 2020" "CoreDNS" "CoreDNS Plugins"
.SH "NAME"
.PP

2
man/coredns-root.7
View File

@@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-ROOT" 7 "April 2020" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-ROOT" 7 "June 2020" "CoreDNS" "CoreDNS Plugins"
.SH "NAME"
.PP

2
man/coredns-route53.7
View File

@@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-ROUTE53" 7 "April 2020" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-ROUTE53" 7 "June 2020" "CoreDNS" "CoreDNS Plugins"
.SH "NAME"
.PP

2
man/coredns-secondary.7
View File

@@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-SECONDARY" 7 "April 2020" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-SECONDARY" 7 "June 2020" "CoreDNS" "CoreDNS Plugins"
.SH "NAME"
.PP

2
man/coredns-sign.7
View File

@@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-SIGN" 7 "April 2020" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-SIGN" 7 "June 2020" "CoreDNS" "CoreDNS Plugins"
.SH "NAME"
.PP

2
man/coredns-template.7
View File

@@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-TEMPLATE" 7 "April 2020" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-TEMPLATE" 7 "June 2020" "CoreDNS" "CoreDNS Plugins"
.SH "NAME"
.PP

2
man/coredns-tls.7
View File

@@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-TLS" 7 "April 2020" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-TLS" 7 "June 2020" "CoreDNS" "CoreDNS Plugins"
.SH "NAME"
.PP

2
man/coredns-trace.7
View File

@@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-TRACE" 7 "April 2020" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-TRACE" 7 "June 2020" "CoreDNS" "CoreDNS Plugins"
.SH "NAME"
.PP

4
man/coredns-transfer.7
View File

@@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-TRANSFER" 7 "April 2020" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-TRANSFER" 7 "June 2020" "CoreDNS" "CoreDNS Plugins"
.SH "NAME"
.PP
@@ -8,7 +8,7 @@
.SH "DESCRIPTION"
.PP
This plugin answers zone transfers for authoritative plugins that implement
\fB\fCtransfer.Transferer\fR.
\fB\fCtransfer.Transferer\fR. Currently, no internal plugins implement this interface.
.PP
Transfer answers full zone transfer (AXFR) requests and incremental zone transfer (IXFR) requests

2
man/coredns-whoami.7
View File

@@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-WHOAMI" 7 "April 2020" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-WHOAMI" 7 "June 2020" "CoreDNS" "CoreDNS Plugins"
.SH "NAME"
.PP