TrueCloudLab/coredns
16
0
Fork 2
Code Issues Pull requests 2 Projects Releases Packages Wiki Activity Actions
coredns/man/coredns.1

63 lines
2.5 KiB
Groff
Raw Permalink Normal View History

Run makefile.doc (#3365) Generate manual pages; no other changes. Signed-off-by: Miek Gieben <miek@miek.nl>
2019-10-10 07:45:28 +01:00
.\" Generated by Mmark Markdown Processer - mmark.miek.nl
Add -p for port flag (#4653) -p is the default flag in DNS software for setting the port, we use 'dns.port' because of preventing clashes with other caddy software users. This is no longer an issue, so we can do what we want here. Add -p to works like -dns.port. (this PR includes generated manpage, but that shouldn't matter too much) Signed-off-by: Miek Gieben <miek@miek.nl>
2021-05-28 16:08:13 +02:00
.TH "COREDNS" 1 "May 2021" "CoreDNS" "CoreDNS"
docs: Regenerate all manpages using mmark (#2762) Mmark recently became able to create manual pages. This removed the dependency on 'ronn' and just uses mmark (Go program). Re-hookup Makefile.doc to generate the correct header mmark needs to see and regenate them all. Spot checking a few pages suggest they look good and actually better than rendered with ronn, esp. lists in lists. Fixes #2757 Signed-off-by: Miek Gieben <miek@miek.nl>
2019-04-06 08:42:40 +01:00
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-21 22:38:40 +01:00
.SH "COREDNS"
docs: Regenerate all manpages using mmark (#2762) Mmark recently became able to create manual pages. This removed the dependency on 'ronn' and just uses mmark (Go program). Re-hookup Makefile.doc to generate the correct header mmark needs to see and regenate them all. Spot checking a few pages suggest they look good and actually better than rendered with ronn, esp. lists in lists. Fixes #2757 Signed-off-by: Miek Gieben <miek@miek.nl>
2019-04-06 08:42:40 +01:00
.PP
Run makefile.doc (#3365) Generate manual pages; no other changes. Signed-off-by: Miek Gieben <miek@miek.nl>
2019-10-10 07:45:28 +01:00
\fIcoredns\fP - pluggable DNS nameserver optimized for service discovery and flexibility.
docs: Regenerate all manpages using mmark (#2762) Mmark recently became able to create manual pages. This removed the dependency on 'ronn' and just uses mmark (Go program). Re-hookup Makefile.doc to generate the correct header mmark needs to see and regenate them all. Spot checking a few pages suggest they look good and actually better than rendered with ronn, esp. lists in lists. Fixes #2757 Signed-off-by: Miek Gieben <miek@miek.nl>
2019-04-06 08:42:40 +01:00
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-21 22:38:40 +01:00
.SH "SYNOPSIS"
docs: Regenerate all manpages using mmark (#2762) Mmark recently became able to create manual pages. This removed the dependency on 'ronn' and just uses mmark (Go program). Re-hookup Makefile.doc to generate the correct header mmark needs to see and regenate them all. Spot checking a few pages suggest they look good and actually better than rendered with ronn, esp. lists in lists. Fixes #2757 Signed-off-by: Miek Gieben <miek@miek.nl>
2019-04-06 08:42:40 +01:00
.PP
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-21 22:38:40 +01:00
\fIcoredns\fP \fB[-conf FILE]\fP \fB[-dns.port PORT}\fP \fB[OPTION]\fP...
docs: Regenerate all manpages using mmark (#2762) Mmark recently became able to create manual pages. This removed the dependency on 'ronn' and just uses mmark (Go program). Re-hookup Makefile.doc to generate the correct header mmark needs to see and regenate them all. Spot checking a few pages suggest they look good and actually better than rendered with ronn, esp. lists in lists. Fixes #2757 Signed-off-by: Miek Gieben <miek@miek.nl>
2019-04-06 08:42:40 +01:00
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-21 22:38:40 +01:00
.SH "DESCRIPTION"
docs: Regenerate all manpages using mmark (#2762) Mmark recently became able to create manual pages. This removed the dependency on 'ronn' and just uses mmark (Go program). Re-hookup Makefile.doc to generate the correct header mmark needs to see and regenate them all. Spot checking a few pages suggest they look good and actually better than rendered with ronn, esp. lists in lists. Fixes #2757 Signed-off-by: Miek Gieben <miek@miek.nl>
2019-04-06 08:42:40 +01:00
.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
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-21 22:38:40 +01:00
\[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
docs: Regenerate all manpages using mmark (#2762) Mmark recently became able to create manual pages. This removed the dependency on 'ronn' and just uses mmark (Go program). Re-hookup Makefile.doc to generate the correct header mmark needs to see and regenate them all. Spot checking a few pages suggest they look good and actually better than rendered with ronn, esp. lists in lists. Fixes #2757 Signed-off-by: Miek Gieben <miek@miek.nl>
2019-04-06 08:42:40 +01:00
\[la]https://coredns.io/explugins\[ra].
.PP
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-21 22:38:40 +01:00
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
docs: Regenerate all manpages using mmark (#2762) Mmark recently became able to create manual pages. This removed the dependency on 'ronn' and just uses mmark (Go program). Re-hookup Makefile.doc to generate the correct header mmark needs to see and regenate them all. Spot checking a few pages suggest they look good and actually better than rendered with ronn, esp. lists in lists. Fixes #2757 Signed-off-by: Miek Gieben <miek@miek.nl>
2019-04-06 08:42:40 +01:00
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
Manual pages (#1346) * Add manual pages Generate manual pages from the README and extend README with Name and Description sections. The generation requires 'ronn' which may not be available. Just check in all generated manual pages.
2018-01-04 12:53:07 +00:00
Available options:
docs: Regenerate all manpages using mmark (#2762) Mmark recently became able to create manual pages. This removed the dependency on 'ronn' and just uses mmark (Go program). Re-hookup Makefile.doc to generate the correct header mmark needs to see and regenate them all. Spot checking a few pages suggest they look good and actually better than rendered with ronn, esp. lists in lists. Fixes #2757 Signed-off-by: Miek Gieben <miek@miek.nl>
2019-04-06 08:42:40 +01:00
Manual pages (#1346) * Add manual pages Generate manual pages from the README and extend README with Name and Description sections. The generation requires 'ronn' which may not be available. Just check in all generated manual pages.
2018-01-04 12:53:07 +00:00
.TP
docs: Regenerate all manpages using mmark (#2762) Mmark recently became able to create manual pages. This removed the dependency on 'ronn' and just uses mmark (Go program). Re-hookup Makefile.doc to generate the correct header mmark needs to see and regenate them all. Spot checking a few pages suggest they look good and actually better than rendered with ronn, esp. lists in lists. Fixes #2757 Signed-off-by: Miek Gieben <miek@miek.nl>
2019-04-06 08:42:40 +01:00
\fB-conf\fP \fBFILE\fP
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-21 22:38:40 +01:00
specify Corefile to load, if not given CoreDNS will look for a \fB\fCCorefile\fR in the current
directory.
Manual pages (#1346) * Add manual pages Generate manual pages from the README and extend README with Name and Description sections. The generation requires 'ronn' which may not be available. Just check in all generated manual pages.
2018-01-04 12:53:07 +00:00
.TP
Add -p for port flag (#4653) -p is the default flag in DNS software for setting the port, we use 'dns.port' because of preventing clashes with other caddy software users. This is no longer an issue, so we can do what we want here. Add -p to works like -dns.port. (this PR includes generated manpage, but that shouldn't matter too much) Signed-off-by: Miek Gieben <miek@miek.nl>
2021-05-28 16:08:13 +02:00
\fB-dns.port\fP \fBPORT\fP or \fB-p\fP \fBPORT\fP
docs: Regenerate all manpages using mmark (#2762) Mmark recently became able to create manual pages. This removed the dependency on 'ronn' and just uses mmark (Go program). Re-hookup Makefile.doc to generate the correct header mmark needs to see and regenate them all. Spot checking a few pages suggest they look good and actually better than rendered with ronn, esp. lists in lists. Fixes #2757 Signed-off-by: Miek Gieben <miek@miek.nl>
2019-04-06 08:42:40 +01:00
override default port (53) to listen on.
Manual pages (#1346) * Add manual pages Generate manual pages from the README and extend README with Name and Description sections. The generation requires 'ronn' which may not be available. Just check in all generated manual pages.
2018-01-04 12:53:07 +00:00
.TP
docs: Regenerate all manpages using mmark (#2762) Mmark recently became able to create manual pages. This removed the dependency on 'ronn' and just uses mmark (Go program). Re-hookup Makefile.doc to generate the correct header mmark needs to see and regenate them all. Spot checking a few pages suggest they look good and actually better than rendered with ronn, esp. lists in lists. Fixes #2757 Signed-off-by: Miek Gieben <miek@miek.nl>
2019-04-06 08:42:40 +01:00
\fB-pidfile\fP \fBFILE\fP
write PID to \fBFILE\fP.
Manual pages (#1346) * Add manual pages Generate manual pages from the README and extend README with Name and Description sections. The generation requires 'ronn' which may not be available. Just check in all generated manual pages.
2018-01-04 12:53:07 +00:00
.TP
docs: Regenerate all manpages using mmark (#2762) Mmark recently became able to create manual pages. This removed the dependency on 'ronn' and just uses mmark (Go program). Re-hookup Makefile.doc to generate the correct header mmark needs to see and regenate them all. Spot checking a few pages suggest they look good and actually better than rendered with ronn, esp. lists in lists. Fixes #2757 Signed-off-by: Miek Gieben <miek@miek.nl>
2019-04-06 08:42:40 +01:00
\fB-plugins\fP
list all plugins and quit.
Manual pages (#1346) * Add manual pages Generate manual pages from the README and extend README with Name and Description sections. The generation requires 'ronn' which may not be available. Just check in all generated manual pages.
2018-01-04 12:53:07 +00:00
.TP
docs: Regenerate all manpages using mmark (#2762) Mmark recently became able to create manual pages. This removed the dependency on 'ronn' and just uses mmark (Go program). Re-hookup Makefile.doc to generate the correct header mmark needs to see and regenate them all. Spot checking a few pages suggest they look good and actually better than rendered with ronn, esp. lists in lists. Fixes #2757 Signed-off-by: Miek Gieben <miek@miek.nl>
2019-04-06 08:42:40 +01:00
\fB-quiet\fP
don't print any version and port information on startup.
Manual pages (#1346) * Add manual pages Generate manual pages from the README and extend README with Name and Description sections. The generation requires 'ronn' which may not be available. Just check in all generated manual pages.
2018-01-04 12:53:07 +00:00
.TP
docs: Regenerate all manpages using mmark (#2762) Mmark recently became able to create manual pages. This removed the dependency on 'ronn' and just uses mmark (Go program). Re-hookup Makefile.doc to generate the correct header mmark needs to see and regenate them all. Spot checking a few pages suggest they look good and actually better than rendered with ronn, esp. lists in lists. Fixes #2757 Signed-off-by: Miek Gieben <miek@miek.nl>
2019-04-06 08:42:40 +01:00
\fB-version\fP
show version and quit.
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-21 22:38:40 +01:00
.SH "AUTHORS"
docs: Regenerate all manpages using mmark (#2762) Mmark recently became able to create manual pages. This removed the dependency on 'ronn' and just uses mmark (Go program). Re-hookup Makefile.doc to generate the correct header mmark needs to see and regenate them all. Spot checking a few pages suggest they look good and actually better than rendered with ronn, esp. lists in lists. Fixes #2757 Signed-off-by: Miek Gieben <miek@miek.nl>
2019-04-06 08:42:40 +01:00
.PP
CoreDNS Authors.
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-21 22:38:40 +01:00
.SH "COPYRIGHT"
docs: Regenerate all manpages using mmark (#2762) Mmark recently became able to create manual pages. This removed the dependency on 'ronn' and just uses mmark (Go program). Re-hookup Makefile.doc to generate the correct header mmark needs to see and regenate them all. Spot checking a few pages suggest they look good and actually better than rendered with ronn, esp. lists in lists. Fixes #2757 Signed-off-by: Miek Gieben <miek@miek.nl>
2019-04-06 08:42:40 +01:00
.PP
Apache License 2.0
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-21 22:38:40 +01:00
.SH "SEE ALSO"
docs: Regenerate all manpages using mmark (#2762) Mmark recently became able to create manual pages. This removed the dependency on 'ronn' and just uses mmark (Go program). Re-hookup Makefile.doc to generate the correct header mmark needs to see and regenate them all. Spot checking a few pages suggest they look good and actually better than rendered with ronn, esp. lists in lists. Fixes #2757 Signed-off-by: Miek Gieben <miek@miek.nl>
2019-04-06 08:42:40 +01:00
.PP
Add -p for port flag (#4653) -p is the default flag in DNS software for setting the port, we use 'dns.port' because of preventing clashes with other caddy software users. This is no longer an issue, so we can do what we want here. Add -p to works like -dns.port. (this PR includes generated manpage, but that shouldn't matter too much) Signed-off-by: Miek Gieben <miek@miek.nl>
2021-05-28 16:08:13 +02:00
Corefile(5) coredns-k8s_external(7) coredns-any(7) coredns-hosts(7) coredns-acl(7) coredns-dnssec(7) coredns-health(7) coredns-grpc(7) coredns-sign(7) coredns-log(7) coredns-tls(7) coredns-file(7) coredns-root(7) coredns-loop(7) coredns-chaos(7) coredns-dnstap(7) coredns-pprof(7) coredns-bufsize(7) coredns-clouddns(7) coredns-loadbalance(7) coredns-cache(7) coredns-whoami(7) coredns-minimal(7) coredns-dns64(7) coredns-erratic(7) coredns-auto(7) coredns-import(7) coredns-debug(7) coredns-template(7) coredns-azure(7) coredns-autopath(7) coredns-kubernetes(7) coredns-forward(7) coredns-nsid(7) coredns-secondary(7) coredns-route53(7) coredns-local(7) coredns-bind(7) coredns-errors(7) coredns-transfer(7) coredns-ready(7) coredns-reload(7) coredns-rewrite(7) coredns-metrics(7) coredns-metadata(7) coredns-etcd(7) coredns-cancel(7) coredns-trace(7).
docs: Regenerate all manpages using mmark (#2762) Mmark recently became able to create manual pages. This removed the dependency on 'ronn' and just uses mmark (Go program). Re-hookup Makefile.doc to generate the correct header mmark needs to see and regenate them all. Spot checking a few pages suggest they look good and actually better than rendered with ronn, esp. lists in lists. Fixes #2757 Signed-off-by: Miek Gieben <miek@miek.nl>
2019-04-06 08:42:40 +01:00
Reference in a new issue Copy permalink