coredns/man/coredns.1
Miek Gieben 2c418b9fd5 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>
2019-04-22 05:38:40 +08:00

65 lines
2.4 KiB
Groff

.\" Generated by Mmark Markdown Processer - mmark.nl
.TH "COREDNS" 1 "April 2019" "CoreDNS" "CoreDNS"
.SH "COREDNS"
.PP
\fIcoredns\fP - plugable DNS nameserver optimized for service discovery and flexibility.
.SH "SYNOPSIS"
.PP
\fIcoredns\fP \fB[-conf FILE]\fP \fB[-dns.port PORT}\fP \fB[OPTION]\fP...
.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 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 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:
.TP
\fB-conf\fP \fBFILE\fP
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.
.TP
\fB-dns.port\fP \fBPORT\fP
override default port (53) to listen on.
.TP
\fB-pidfile\fP \fBFILE\fP
write PID to \fBFILE\fP.
.TP
\fB-plugins\fP
list all plugins and quit.
.TP
\fB-quiet\fP
don't print any version and port information on startup.
.TP
\fB-version\fP
show version and quit.
.SH "AUTHORS"
.PP
CoreDNS Authors.
.SH "COPYRIGHT"
.PP
Apache License 2.0
.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).