TrueCloudLab/coredns
16
0
Fork 2
Code Issues Pull requests 4 Projects Releases Packages Wiki Activity Actions

Regenerate man-page (#3530)

Browse source 
Signed-off-by: Yong Tang <yong.tang.github@outlook.com>
This commit is contained in:
Yong Tang 2019-12-11 06:49:38 -08:00 • committed by GitHub
parent 2e7dbfdcf0
commit fdb3cff87c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
44 changed files with 77 additions and 61 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
man/coredns-acl.7
View file

@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-ACL" 7 "October 2019" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-ACL" 7 "December 2019" "CoreDNS" "CoreDNS Plugins"
.PP
\fIacl\fP - enforces access control policies on source ip and prevents unauthorized access to DNS servers.

2
man/coredns-any.7
View file

@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-ANY" 7 "September 2019" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-ANY" 7 "December 2019" "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 "September 2019" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-AUTO" 7 "December 2019" "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 "November 2019" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-AUTOPATH" 7 "December 2019" "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 "September 2019" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-AZURE" 7 "December 2019" "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 "October 2019" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-BIND" 7 "December 2019" "CoreDNS" "CoreDNS Plugins"
.SH "NAME"
.PP

2
man/coredns-bufsize.7
View file

@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-BUFSIZE" 7 "November 2019" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-BUFSIZE" 7 "December 2019" "CoreDNS" "CoreDNS Plugins"
.SH "NAME"
.PP

10
man/coredns-cache.7
View file

@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-CACHE" 7 "October 2019" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-CACHE" 7 "December 2019" "CoreDNS" "CoreDNS Plugins"
.SH "NAME"
.PP
@ -48,6 +48,7 @@ cache [TTL] [ZONES...] {
success CAPACITY [TTL] [MINTTL]
denial CAPACITY [TTL] [MINTTL]
prefetch AMOUNT [[DURATION] [PERCENTAGE%]]
serve\_stale [DURATION]
}
.fi
@ -70,6 +71,11 @@ Popular means \fBAMOUNT\fP queries have been seen with no gaps of \fBDURATION\fP
\fBDURATION\fP defaults to 1m. Prefetching will happen when the TTL drops below \fBPERCENTAGE\fP,
which defaults to \fB\fC10%\fR, or latest 1 second before TTL expiration. Values should be in the range \fB\fC[10%, 90%]\fR.
Note the percent sign is mandatory. \fBPERCENTAGE\fP is treated as an \fB\fCint\fR.
.IP \(bu 4
\fB\fCserve_stale\fR, when serve_stale is set, cache always will serve an expired entry to a client if there is one
available. When this happens, cache will attempt to refresh the cache entry after sending the expired cache
entry to the client. The responses have a TTL of 0. \fBDURATION\fP is how far back to consider
stale responses as fresh. The default duration is 1h.
.SH "CAPACITY AND EVICTION"
@ -95,6 +101,8 @@ If monitoring is enabled (via the \fIprometheus\fP plugin) then the following me
\fB\fCcoredns_cache_misses_total{server}\fR - Counter of cache misses.
.IP \(bu 4
\fB\fCcoredns_cache_drops_total{server}\fR - Counter of dropped messages.
.IP \(bu 4
\fB\fCcoredns_cache_served_stale_total{server}\fR - Counter of requests served from stale cache entries.
.PP

2
man/coredns-cancel.7
View file

@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-CANCEL" 7 "September 2019" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-CANCEL" 7 "December 2019" "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 "September 2019" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-CHAOS" 7 "December 2019" "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 "November 2019" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-CLOUDDNS" 7 "December 2019" "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 "September 2019" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-DEBUG" 7 "December 2019" "CoreDNS" "CoreDNS Plugins"
.SH "NAME"
.PP

2
man/coredns-dnssec.7
View file

@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-DNSSEC" 7 "October 2019" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-DNSSEC" 7 "December 2019" "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 "September 2019" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-DNSTAP" 7 "December 2019" "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 "October 2019" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-ERRATIC" 7 "December 2019" "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 "September 2019" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-ERRORS" 7 "December 2019" "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 "September 2019" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-ETCD" 7 "December 2019" "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 "October 2019" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-FILE" 7 "December 2019" "CoreDNS" "CoreDNS Plugins"
.SH "NAME"
.PP

2
man/coredns-forward.7
View file

@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-FORWARD" 7 "November 2019" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-FORWARD" 7 "December 2019" "CoreDNS" "CoreDNS Plugins"
.SH "NAME"
.PP

2
man/coredns-grpc.7
View file

@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-GRPC" 7 "October 2019" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-GRPC" 7 "December 2019" "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 "October 2019" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-HEALTH" 7 "December 2019" "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 "October 2019" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-HOSTS" 7 "December 2019" "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 "October 2019" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-IMPORT" 7 "December 2019" "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 "September 2019" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-K8S_EXTERNAL" 7 "December 2019" "CoreDNS" "CoreDNS Plugins"
.SH "NAME"
.PP

2
man/coredns-kubernetes.7
View file

@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-KUBERNETES" 7 "October 2019" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-KUBERNETES" 7 "December 2019" "CoreDNS" "CoreDNS Plugins"
.SH "NAME"
.PP

2
man/coredns-loadbalance.7
View file

@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-LOADBALANCE" 7 "September 2019" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-LOADBALANCE" 7 "December 2019" "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 "September 2019" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-LOG" 7 "December 2019" "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 "September 2019" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-LOOP" 7 "December 2019" "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 "September 2019" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-METADATA" 7 "December 2019" "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 "September 2019" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-METRICS" 7 "December 2019" "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 "September 2019" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-NSID" 7 "December 2019" "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 "September 2019" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-PPROF" 7 "December 2019" "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 "September 2019" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-READY" 7 "December 2019" "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 "November 2019" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-RELOAD" 7 "December 2019" "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 "September 2019" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-REWRITE" 7 "December 2019" "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 "August 2019" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-ROOT" 7 "December 2019" "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 "September 2019" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-ROUTE53" 7 "December 2019" "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 "September 2019" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-SECONDARY" 7 "December 2019" "CoreDNS" "CoreDNS Plugins"
.SH "NAME"
.PP

32
man/coredns-sign.7
View file

@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-SIGN" 7 "November 2019" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-SIGN" 7 "December 2019" "CoreDNS" "CoreDNS Plugins"
.SH "NAME"
.PP
@ -10,8 +10,7 @@
The \fIsign\fP plugin is used to sign (see RFC 6781) zones. In this process DNSSEC resource records are
added. The signatures that sign the resource records sets have an expiration date, this means the
signing process must be repeated before this expiration data is reached. Otherwise the zone's data
will go BAD (RFC 4035, Section 5.5). The \fIsign\fP plugin takes care of this. \fISign\fP works, but has
a couple of limitations, see the "Bugs" section.
will go BAD (RFC 4035, Section 5.5). The \fIsign\fP plugin takes care of this.
.PP
Only NSEC is supported, \fIsign\fP does not support NSEC3.
@ -43,9 +42,12 @@ the signature only has 14 days left before expiring.
Both these dates are only checked on the SOA's signature(s).
.IP \(bu 4
Create signatures that have an inception of -3 hours (minus a jitter between 0 and 18 hours)
Create RRSIGs that have an inception of -3 hours (minus a jitter between 0 and 18 hours)
and a expiration of +32 days for every given DNSKEY.
.IP \(bu 4
Add NSEC records for all names in the zone. The TTL for these is the negative cache TTL from the
SOA record.
.IP \(bu 4
Add or replace \fIall\fP apex CDS/CDNSKEY records with the ones derived from the given keys. For
each key two CDS are created one with SHA1 and another with SHA256.
.IP \(bu 4
@ -54,8 +56,8 @@ overwrite \fIany\fP previous serial number.
.PP
Thus there are two ways that dictate when a zone is signed. Normally every 6 days (plus jitter) it
will be resigned. If for some reason we fail this check, the 14 days before expiring kicks in.
There are two ways that dictate when a zone is signed. Normally every 6 days (plus jitter) it will
be resigned. If for some reason we fail this check, the 14 days before expiring kicks in.
.PP
Keys are named (following BIND9): \fB\fCK<name>+<alg>+<id>.key\fR and \fB\fCK<name>+<alg>+<id>.private\fR.
@ -200,8 +202,8 @@ This will lead to \fB\fCdb.example.org\fR be signed \fItwice\fP, as this entire
you have specified the origins \fB\fCexample.org\fR and \fB\fCexample.net\fR in the server block.
.PP
Forcibly resigning a zone can be accomplished by removing the signed zone file (CoreDNS will keep on
serving it from memory), and sending SIGUSR1 to the process to make it reload and resign the zone
Forcibly resigning a zone can be accomplished by removing the signed zone file (CoreDNS will keep
on serving it from memory), and sending SIGUSR1 to the process to make it reload and resign the zone
file.
.SH "ALSO SEE"
@ -210,11 +212,17 @@ The DNSSEC RFCs: RFC 4033, RFC 4034 and RFC 4035. And the BCP on DNSSEC, RFC 678
manual pages coredns-keygen(1) and dnssec-keygen(8). And the \fIfile\fP plugin's documentation.
.PP
Coredns-keygen can be found at https://github.com/coredns/coredns-utils
\[la]https://github.com/coredns/coredns-utils\[ra] in the coredns-keygen directory.
Coredns-keygen can be found at
https://github.com/coredns/coredns-utils
\[la]https://github.com/coredns/coredns-utils\[ra] in the
coredns-keygen directory.
.PP
Other useful DNSSEC tools can be found in ldns
\[la]https://nlnetlabs.nl/projects/ldns/about/\[ra], e.g.
\fB\fCldns-key2ds\fR to create DS records from DNSKEYs.
.SH "BUGS"
.PP
\fB\fCkeys directory\fR is not implemented. Glue records are currently signed, and no DS records are added
for child zones.
\fB\fCkeys directory\fR is not implemented.

2
man/coredns-template.7
View file

@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-TEMPLATE" 7 "October 2019" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-TEMPLATE" 7 "December 2019" "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 "October 2019" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-TLS" 7 "December 2019" "CoreDNS" "CoreDNS Plugins"
.SH "NAME"
.PP

14
man/coredns-trace.7
View file

@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-TRACE" 7 "August 2019" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-TRACE" 7 "December 2019" "CoreDNS" "CoreDNS Plugins"
.SH "NAME"
.PP
@ -41,9 +41,9 @@ Additional features can be enabled with this syntax:
.nf
trace [ENDPOINT\-TYPE] [ENDPOINT] {
every AMOUNT
service NAME
client\_server
every AMOUNT
service NAME
client\_server
}
.fi
@ -132,9 +132,9 @@ Trace one query every 10000 queries, rename the service, and enable same span:
.nf
trace tracinghost:9411 {
every 10000
service dnsproxy
client\_server
every 10000
service dnsproxy
client\_server
}
.fi

2
man/coredns-transfer.7
View file

@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl
.TH "COREDNS-TRANSFER" 7 "November 2019" "CoreDNS" "CoreDNS Plugins"
.TH "COREDNS-TRANSFER" 7 "December 2019" "CoreDNS" "CoreDNS Plugins"
.SH "NAME"
.PP

2
man/coredns-whoami.7
View file

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