aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGravatar Ben Kochie <superq@gmail.com> 2020-03-26 09:22:29 +0100
committerGravatar GitHub <noreply@github.com> 2020-03-26 09:22:29 +0100
commit14ca4549818c00c31dbcc861d7b12de2929e014c (patch)
treebef177b48d977c84010c6450a64ca95bfee26dd3
parent19cfa2960cc415e0e38d36fc9d9325bd636c000e (diff)
downloadcoredns-14ca4549818c00c31dbcc861d7b12de2929e014c.tar.gz
coredns-14ca4549818c00c31dbcc861d7b12de2929e014c.tar.zst
coredns-14ca4549818c00c31dbcc861d7b12de2929e014c.zip
Documentation improvements for dns64 plugin (#3777)
Minor typo and improvements to the dns64 plugin README. Signed-off-by: Ben Kochie <superq@gmail.com>
-rw-r--r--man/coredns-dns64.719
-rw-r--r--plugin/dns64/README.md12
2 files changed, 19 insertions, 12 deletions
diff --git a/man/coredns-dns64.7 b/man/coredns-dns64.7
index 0454ba8a3..5c97ace3a 100644
--- a/man/coredns-dns64.7
+++ b/man/coredns-dns64.7
@@ -1,5 +1,5 @@
.\" Generated by Mmark Markdown Processer - mmark.miek.nl
-.TH "COREDNS-DNS64" 7 "January 2020" "CoreDNS" "CoreDNS Plugins"
+.TH "COREDNS-DNS64" 7 "March 2020" "CoreDNS" "CoreDNS Plugins"
.SH "NAME"
.PP
@@ -22,6 +22,10 @@ A records, synthesizes the AAAA records from the A records.
The synthesis in only performed if the query came in via IPv6.
.PP
+This translation is for IPv6-only networks that have NAT64
+\[la]https://en.wikipedia.org/wiki/NAT64\[ra].
+
+.PP
See RFC 6147
\[la]https://tools.ietf.org/html/rfc6147\[ra] for more information.
@@ -31,21 +35,21 @@ See RFC 6147
.nf
dns64 [PREFIX] {
- [translate\\\_all]
+ [translate\_all]
}
.fi
.RE
.IP \(bu 4
-[PREFIX] defines a custom prefix instead of the default \fB\fC64:ff9b::/96\fR
+[PREFIX] defines a custom prefix instead of the default \fB\fC64:ff9b::/96\fR.
.IP \(bu 4
\fB\fCtranslate_all\fR translates all queries, including respones that have AAAA results.
.SH "EXAMPLES"
.PP
-Translate with the default well known prefix. Applies to all queries
+Translate with the default well known prefix. Applies to all queries.
.PP
.RS
@@ -57,7 +61,7 @@ dns64
.RE
.PP
-Use a custom prefix
+Use a custom prefix.
.PP
.RS
@@ -72,7 +76,7 @@ dns64 {
.RE
.PP
-Enable translation even if an existing AAAA record is present
+Enable translation even if an existing AAAA record is present.
.PP
.RS
@@ -100,6 +104,7 @@ Resolve PTR records
.IP \(bu 4
Follow CNAME records
.IP \(bu 4
-Make resolver DNSSEC aware
+Make resolver DNSSEC aware. See: RFC 6147 Section 3
+\[la]https://tools.ietf.org/html/rfc6147#section-3\[ra]
diff --git a/plugin/dns64/README.md b/plugin/dns64/README.md
index 6b9c0c54b..ef3d90867 100644
--- a/plugin/dns64/README.md
+++ b/plugin/dns64/README.md
@@ -13,28 +13,30 @@ From Wikipedia:
The synthesis in only performed if the query came in via IPv6.
+This translation is for IPv6-only networks that have [NAT64](https://en.wikipedia.org/wiki/NAT64).
+
See [RFC 6147](https://tools.ietf.org/html/rfc6147) for more information.
## Syntax
~~~
dns64 [PREFIX] {
- [translate\_all]
+ [translate_all]
}
~~~
-* [PREFIX] defines a custom prefix instead of the default `64:ff9b::/96`
+* [PREFIX] defines a custom prefix instead of the default `64:ff9b::/96`.
* `translate_all` translates all queries, including respones that have AAAA results.
## Examples
-Translate with the default well known prefix. Applies to all queries
+Translate with the default well known prefix. Applies to all queries.
~~~
dns64
~~~
-Use a custom prefix
+Use a custom prefix.
~~~
dns64 64:1337::/96
@@ -44,7 +46,7 @@ dns64 {
}
~~~
-Enable translation even if an existing AAAA record is present
+Enable translation even if an existing AAAA record is present.
~~~
dns64 {