auto make -f Makefile.doc

This commit is contained in:
coredns-auto-go-mod-tidy[bot]
2020-09-24 18:30:59 +00:00
parent 9798dd067f
commit 8c6ca43571
7 changed files with 67 additions and 53 deletions

View File

@@ -3,19 +3,23 @@
.SH "NAME"
.PP
\fItransfer\fP - perform zone transfers for other plugins.
\fItransfer\fP - perform (outgoing) zone transfers for other plugins.
.SH "DESCRIPTION"
.PP
This plugin answers zone transfers for authoritative plugins that implement
\fB\fCtransfer.Transferer\fR. Currently, no internal plugins implement this interface.
This plugin answers zone transfers for authoritative plugins that implement \fB\fCtransfer.Transferer\fR.
.PP
Transfer answers full zone transfer (AXFR) requests and incremental zone transfer (IXFR) requests
\fItransfer\fP answers full zone transfer (AXFR) requests and incremental zone transfer (IXFR) requests
with AXFR fallback if the zone has changed.
.PP
Notifies are not currently supported.
When a plugin wants to notify it's secondaries it will call back into the \fItransfer\fP plugin.
.PP
The following plugins implement zone transfers using this plugin: \fIfile\fP, \fIauto\fP, \fIsecondary\fP, and
\fIkubernetes\fP. See \fB\fCtransfer.go\fR for implementation details if you are a plugin author that wants to
use this plugin.
.SH "SYNTAX"
.PP
@@ -23,23 +27,24 @@ Notifies are not currently supported.
.nf
transfer [ZONE...] {
to HOST...
to ADDRESS...
}
.fi
.RE
.IP \(bu 4
\fBZONES\fP The zones \fItransfer\fP will answer zone requests for. If left blank,
the zones are inherited from the enclosing server block. To answer zone
transfers for a given zone, there must be another plugin in the same server
block that serves the same zone, and implements \fB\fCtransfer.Transferer\fR.
\fBZONE\fP The zones \fItransfer\fP will answer zone transfer requests for. If left blank, the zones
are inherited from the enclosing server block. To answer zone transfers for a given zone,
there must be another plugin in the same server block that serves the same zone, and implements
\fB\fCtransfer.Transferer\fR.
.IP \(bu 4
\fB\fCto\fR \fBHOST...\fP The hosts \fItransfer\fP will transfer to. Use \fB\fC*\fR to permit
transfers to all hosts.
\fB\fCto\fR \fBADDRESS...\fP The hosts \fItransfer\fP will transfer to. Use \fB\fC*\fR to permit transfers to all
addresses. \fBADDRESS\fP must be denoted in CIDR notation (e.g., 127.0.0.1/32) or just as plain
addresses. \fB\fCto\fR may be specified multiple times.
.SH "EXAMPLES"
.PP
TODO
See the specific plugins using this plugin for examples on it's usage.