Doc update (#2792)

* Fix spelling in coredns.1 and corefile.7 md files
* Run make -f Makefile.doc

Signed-off-by: Miek Gieben <miek@miek.nl>
This commit is contained in:
Miek Gieben
2019-04-21 22:38:40 +01:00
committed by Yong Tang
parent 98c7a6effb
commit 2c418b9fd5
10 changed files with 112 additions and 124 deletions

View File

@@ -1,10 +1,10 @@
## Name
*corefile* - configuration file for CoreDNS
*corefile* - configuration file for CoreDNS.
## Description
A *corefile* specifies the (internal) servers CoreDNS should run and what plugins each of these
A *corefile* specifies the internal servers CoreDNS should run and what plugins each of these
should chain. The syntax is as follows:
~~~ txt
@@ -21,7 +21,7 @@ The optional **SCHEME** defaults to `dns://`, but can also be `tls://` (DNS over
(DNS over gRPC) or `https://` (DNS over HTTP/2).
The optional **PORT** controls on which port the server will bind, this default to 53. If you use
a port number here, you *can't* override it with `-dns.port` (coredns(1)).
a port number here, you *can't* override it with `-dns.port` (coredns(1)), also see coredns-bind(7).
Specifying a **ZONE** *and* **PORT** combination multiple times for *different* servers will lead to
an error on startup.
@@ -39,7 +39,7 @@ Comments may be started anywhere on a line.
Environment variables are supported and either the Unix or Windows form may be used: `{$ENV_VAR_1}`
or `{%ENV_VAR_2%}`.
You can use the `import` "plugin" to include parts of other files.
You can use the `import` "plugin" (See coredns-import(7)) to include parts of other files.
If CoreDNS cant find a Corefile to load it loads the following builtin one:
@@ -51,7 +51,8 @@ If CoreDNS cant find a Corefile to load it loads the following builtin one:
## Import
You can use the `import` "plugin" to include parts of other files, see <https://coredns.io/plugins/import>.
You can use the `import` "plugin" to include parts of other files, see
<https://coredns.io/plugins/import>, and coredns-import(7).
## Snippets
@@ -70,8 +71,8 @@ If you want to reuse a snippet you can define one with and then use it with *imp
## Examples
The **ZONE** is root zone `.`, the **PLUGIN** is chaos. The chaos plugin takes an argument:
`CoreDNS-001`. This text is returned on a CH class query: `dig CH txt version.bind @localhost`.
The **ZONE** is root zone `.`, the **PLUGIN** is *chaos*. The *chaos* plugin takes an (optional) argument:
`CoreDNS-001`. This text is returned on a CH class query: `dig CH TXT version.bind @localhost`.
~~~ corefile
. {
@@ -134,4 +135,5 @@ Apache License 2.0
## See Also
The manual page for CoreDNS: coredns(1) and more documentation on <https://coredns.io>.
Also see the [*import*](https://coredns.io/plugins/import)'s documentation.
Also see the [*import*](https://coredns.io/plugins/import)'s documentation and all the manual pages
for the plugins.