Mirrors/coredns
1
0
Fork 0
mirror of https://github.com/coredns/coredns.git synced 2025-12-06 02:15:11 -05:00
Code Issues Packages Projects Releases Wiki Activity

Doc update (#2792)

Browse Source 
* 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
Download Patch File Download Diff File Expand all files Collapse all files

38
man/corefile.5
View File

@@ -1,13 +1,13 @@
.\" Generated by Mmark Markdown Processer - mmark.nl
.TH "COREFILE" "5" "April 2019" "CoreDNS" "CoreDNS"
.TH "COREFILE" 5 "April 2019" "CoreDNS" "CoreDNS"
.SH NAME
.SH "NAME"
.PP
\fIcorefile\fP - configuration file for CoreDNS
\fIcorefile\fP - configuration file for CoreDNS.
.SH DESCRIPTION
.SH "DESCRIPTION"
.PP
A \fIcorefile\fP specifies the (internal) servers CoreDNS should run and what plugins each of these
A \fIcorefile\fP specifies the internal servers CoreDNS should run and what plugins each of these
should chain. The syntax is as follows:
.PP
@@ -32,7 +32,7 @@ The optional \fBSCHEME\fP defaults to \fB\fCdns://\fR, but can also be \fB\fCtls
.PP
The optional \fBPORT\fP controls on which port the server will bind, this default to 53. If you use
a port number here, you \fIcan't\fP override it with \fB\fC-dns.port\fR (coredns(1)).
a port number here, you \fIcan't\fP override it with \fB\fC-dns.port\fR (coredns(1)), also see coredns-bind(7).
.PP
Specifying a \fBZONE\fP \fIand\fP \fBPORT\fP combination multiple times for \fIdifferent\fP servers will lead to
@@ -56,7 +56,7 @@ Environment variables are supported and either the Unix or Windows form may be u
or \fB\fC{%ENV_VAR_2%}\fR.
.PP
You can use the \fB\fCimport\fR "plugin" to include parts of other files.
You can use the \fB\fCimport\fR "plugin" (See coredns-import(7)) to include parts of other files.
.PP
If CoreDNS can’t find a Corefile to load it loads the following builtin one:
@@ -72,12 +72,13 @@ If CoreDNS can’t find a Corefile to load it loads the following builtin one:
.fi
.RE
.SH IMPORT
.SH "IMPORT"
.PP
You can use the \fB\fCimport\fR "plugin" to include parts of other files, see https://coredns.io/plugins/import
\[la]https://coredns.io/plugins/import\[ra].
You can use the \fB\fCimport\fR "plugin" to include parts of other files, see
https://coredns.io/plugins/import
\[la]https://coredns.io/plugins/import\[ra], and coredns-import(7).
.SH SNIPPETS
.SH "SNIPPETS"
.PP
If you want to reuse a snippet you can define one with and then use it with \fIimport\fP.
@@ -97,10 +98,10 @@ If you want to reuse a snippet you can define one with and then use it with \fIi
.fi
.RE
.SH EXAMPLES
.SH "EXAMPLES"
.PP
The \fBZONE\fP is root zone \fB\fC.\fR, the \fBPLUGIN\fP is chaos. The chaos plugin takes an argument:
\fB\fCCoreDNS-001\fR. This text is returned on a CH class query: \fB\fCdig CH txt version.bind @localhost\fR.
The \fBZONE\fP is root zone \fB\fC.\fR, the \fBPLUGIN\fP is \fIchaos\fP. The \fIchaos\fP plugin takes an (optional) argument:
\fB\fCCoreDNS-001\fR. This text is returned on a CH class query: \fB\fCdig CH TXT version.bind @localhost\fR.
.PP
.RS
@@ -187,18 +188,19 @@ This also works on a non octet boundary:
.fi
.RE
.SH AUTHORS
.SH "AUTHORS"
.PP
CoreDNS Authors.
.SH COPYRIGHT
.SH "COPYRIGHT"
.PP
Apache License 2.0
.SH SEE ALSO
.SH "SEE ALSO"
.PP
The manual page for CoreDNS: coredns(1) and more documentation on https://coredns.io
\[la]https://coredns.io\[ra].
Also see the \fIimport\fP
\[la]https://coredns.io/plugins/import\[ra]'s documentation.
\[la]https://coredns.io/plugins/import\[ra]'s documentation and all the manual pages
for the plugins.