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,36 +1,36 @@
.\" Generated by Mmark Markdown Processer - mmark.nl
.TH "COREDNS" "1" "April 2019" "CoreDNS" "CoreDNS"
.TH "COREDNS" 1 "April 2019" "CoreDNS" "CoreDNS"
.SH NAME
.SH "COREDNS"
.PP
\fIcoredns\fP - plugable DNS nameserver optimized for service discovery and flexibility.
.SH SYNOPSIS
.SH "SYNOPSIS"
.PP
\fIcoredns\fP \fI[OPTION]\fP...
\fIcoredns\fP \fB[-conf FILE]\fP \fB[-dns.port PORT}\fP \fB[OPTION]\fP...
.SH DESCRIPTION
.SH "DESCRIPTION"
.PP
CoreDNS is a DNS server that chains plugins. Each plugin handles a DNS feature, like rewriting
queries, kubernetes service discovery or just exporting metrics. There are many other plugins,
each described on https://coredns.io/plugins
\[la]https://coredns.io/plugins\[ra] and there respective manual pages. Plugins not
bundled in CoreDNS are listed on https://coredns.io/explugins
\[la]https://coredns.io/plugins\[ra] and their respective manual pages. Plugins not
bundled by default in CoreDNS are listed on https://coredns.io/explugins
\[la]https://coredns.io/explugins\[ra].
.PP
When started with no options CoreDNS will looks for a file names \fB\fCCorefile\fR in the current
directory, if found it will parse its contents and start up accordingly. If no \fB\fCCorefile\fR is found
When started without options CoreDNS will look for a file named \fB\fCCorefile\fR in the current
directory, if found, it will parse its contents and start up accordingly. If no \fB\fCCorefile\fR is found
it will start with the \fIwhoami\fP plugin (coredns-whoami(7)) and start listening on port 53 (unless
overridden with \fB\fC-dns.port\fR).
.PP
Available options:
.RS
.TP
\fB-conf\fP \fBFILE\fP
specify Corefile to load.
specify Corefile to load, if not given CoreDNS will look for a \fB\fCCorefile\fR in the current
directory.
.TP
\fB-cpu\fP \fBCAP\fP
specify maximum CPU capacity in percent.
@@ -50,17 +50,16 @@ don't print any version and port information on startup.
\fB-version\fP
show version and quit.
.RE
.SH AUTHORS
.SH "AUTHORS"
.PP
CoreDNS Authors.
.SH COPYRIGHT
.SH "COPYRIGHT"
.PP
Apache License 2.0
.SH SEE ALSO
.SH "SEE ALSO"
.PP
Corefile(5) coredns-k8s_external(7) coredns-erratic(7) coredns-nsid(7) coredns-hosts(7) coredns-dnssec(7) coredns-health(7) coredns-grpc(7) coredns-ready(7) coredns-file(7) coredns-root(7) coredns-autopath(7) coredns-auto(7) coredns-dnstap(7) coredns-pprof(7) coredns-tls(7) coredns-loadbalance(7) coredns-cache(7) coredns-whoami(7) coredns-bind(7) coredns-loop(7) coredns-import(7) coredns-chaos(7) coredns-template(7) coredns-log(7) coredns-kubernetes(7) coredns-forward(7) coredns-debug(7) coredns-secondary(7) coredns-route53(7) coredns-errors(7) coredns-metrics(7) coredns-reload(7) coredns-rewrite(7) coredns-metadata(7) coredns-federation(7) coredns-etcd(7) coredns-cancel(7) coredns-trace(7).