mirror of
				https://github.com/coredns/coredns.git
				synced 2025-11-04 03:03:14 -05:00 
			
		
		
		
	Documentation improvements for dns64 plugin (#3777)
Minor typo and improvements to the dns64 plugin README. Signed-off-by: Ben Kochie <superq@gmail.com>
This commit is contained in:
		@@ -1,5 +1,5 @@
 | 
				
			|||||||
.\" Generated by Mmark Markdown Processer - mmark.miek.nl
 | 
					.\" 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"
 | 
					.SH "NAME"
 | 
				
			||||||
.PP
 | 
					.PP
 | 
				
			||||||
@@ -21,6 +21,10 @@ A records, synthesizes the AAAA records from the A records.
 | 
				
			|||||||
.PP
 | 
					.PP
 | 
				
			||||||
The synthesis in only performed if the query came in via IPv6.
 | 
					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
 | 
					.PP
 | 
				
			||||||
See RFC 6147
 | 
					See RFC 6147
 | 
				
			||||||
\[la]https://tools.ietf.org/html/rfc6147\[ra] for more information.
 | 
					\[la]https://tools.ietf.org/html/rfc6147\[ra] for more information.
 | 
				
			||||||
@@ -31,21 +35,21 @@ See RFC 6147
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
.nf
 | 
					.nf
 | 
				
			||||||
dns64 [PREFIX] {
 | 
					dns64 [PREFIX] {
 | 
				
			||||||
  [translate\\\_all]
 | 
					  [translate\_all]
 | 
				
			||||||
}
 | 
					}
 | 
				
			||||||
 | 
					
 | 
				
			||||||
.fi
 | 
					.fi
 | 
				
			||||||
.RE
 | 
					.RE
 | 
				
			||||||
 | 
					
 | 
				
			||||||
.IP \(bu 4
 | 
					.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
 | 
					.IP \(bu 4
 | 
				
			||||||
\fB\fCtranslate_all\fR translates all queries, including respones that have AAAA results.
 | 
					\fB\fCtranslate_all\fR translates all queries, including respones that have AAAA results.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
.SH "EXAMPLES"
 | 
					.SH "EXAMPLES"
 | 
				
			||||||
.PP
 | 
					.PP
 | 
				
			||||||
Translate with the default well known prefix. Applies to all queries
 | 
					Translate with the default well known prefix. Applies to all queries.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
.PP
 | 
					.PP
 | 
				
			||||||
.RS
 | 
					.RS
 | 
				
			||||||
@@ -57,7 +61,7 @@ dns64
 | 
				
			|||||||
.RE
 | 
					.RE
 | 
				
			||||||
 | 
					
 | 
				
			||||||
.PP
 | 
					.PP
 | 
				
			||||||
Use a custom prefix
 | 
					Use a custom prefix.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
.PP
 | 
					.PP
 | 
				
			||||||
.RS
 | 
					.RS
 | 
				
			||||||
@@ -72,7 +76,7 @@ dns64 {
 | 
				
			|||||||
.RE
 | 
					.RE
 | 
				
			||||||
 | 
					
 | 
				
			||||||
.PP
 | 
					.PP
 | 
				
			||||||
Enable translation even if an existing AAAA record is present
 | 
					Enable translation even if an existing AAAA record is present.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
.PP
 | 
					.PP
 | 
				
			||||||
.RS
 | 
					.RS
 | 
				
			||||||
@@ -100,6 +104,7 @@ Resolve PTR records
 | 
				
			|||||||
.IP \(bu 4
 | 
					.IP \(bu 4
 | 
				
			||||||
Follow CNAME records
 | 
					Follow CNAME records
 | 
				
			||||||
.IP \(bu 4
 | 
					.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]
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 
 | 
				
			|||||||
@@ -13,28 +13,30 @@ From Wikipedia:
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
The synthesis in only performed if the query came in via IPv6.
 | 
					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.
 | 
					See [RFC 6147](https://tools.ietf.org/html/rfc6147) for more information.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
## Syntax
 | 
					## Syntax
 | 
				
			||||||
 | 
					
 | 
				
			||||||
~~~
 | 
					~~~
 | 
				
			||||||
dns64 [PREFIX] {
 | 
					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.
 | 
					* `translate_all` translates all queries, including respones that have AAAA results.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
## Examples
 | 
					## Examples
 | 
				
			||||||
 | 
					
 | 
				
			||||||
Translate with the default well known prefix. Applies to all queries
 | 
					Translate with the default well known prefix. Applies to all queries.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
~~~
 | 
					~~~
 | 
				
			||||||
dns64
 | 
					dns64
 | 
				
			||||||
~~~
 | 
					~~~
 | 
				
			||||||
 | 
					
 | 
				
			||||||
Use a custom prefix
 | 
					Use a custom prefix.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
~~~
 | 
					~~~
 | 
				
			||||||
dns64 64:1337::/96
 | 
					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 {
 | 
					dns64 {
 | 
				
			||||||
 
 | 
				
			|||||||
		Reference in New Issue
	
	Block a user