mirror of
https://github.com/coredns/coredns.git
synced 2025-11-01 18:53:43 -04:00
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>
This commit is contained in:
Miek Gieben
GitHub
@@ -1,125 +1,138 @@
|
||||
.\" generated with Ronn/v0.7.3
|
||||
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
||||
.
|
||||
.TH "COREDNS\-ERRATIC" "7" "March 2019" "CoreDNS" "CoreDNS plugins"
|
||||
.
|
||||
.SH "NAME"
|
||||
\fIerratic\fR \- a plugin useful for testing client behavior\.
|
||||
.
|
||||
.SH "DESCRIPTION"
|
||||
\fIerratic\fR returns a static response to all queries, but the responses can be delayed, dropped or truncated\. The \fIerratic\fR plugin will respond to every A or AAAA query\. For any other type it will return a SERVFAIL response\. The reply for A will return 192\.0\.2\.53 (see RFC 5737 \fIhttps://tools\.ietf\.org/html/rfc5737\fR, for AAAA it returns 2001:DB8::53 (see RFC 3849 \fIhttps://tools\.ietf\.org/html/rfc3849\fR) and for an AXFR request it will respond with a small zone transfer\.
|
||||
.
|
||||
.P
|
||||
\fIerratic\fR can also be used in conjunction with the \fIautopath\fR plugin\. This is mostly to aid in testing\.
|
||||
.
|
||||
.SH "SYNTAX"
|
||||
.
|
||||
.nf
|
||||
.\" Generated by Mmark Markdown Processer - mmark.nl
|
||||
.TH "COREDNS-ERRATIC" "7" "April 2019" "CoreDNS" "CoreDNS Plugins"
|
||||
|
||||
.SH ERRATIC
|
||||
.SH NAME
|
||||
.PP
|
||||
\fIerratic\fP - a plugin useful for testing client behavior.
|
||||
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
\fIerratic\fP returns a static response to all queries, but the responses can be delayed, dropped or truncated.
|
||||
The \fIerratic\fP plugin will respond to every A or AAAA query. For any other type it will return
|
||||
a SERVFAIL response. The reply for A will return 192.0.2.53 (see RFC
|
||||
5737
|
||||
\[la]https://tools.ietf.org/html/rfc5737\[ra],
|
||||
for AAAA it returns 2001:DB8::53 (see RFC 3849
|
||||
\[la]https://tools.ietf.org/html/rfc3849\[ra]) and for an
|
||||
AXFR request it will respond with a small zone transfer.
|
||||
|
||||
.PP
|
||||
\fIerratic\fP can also be used in conjunction with the \fIautopath\fP plugin. This is mostly to aid in
|
||||
testing.
|
||||
|
||||
.SH SYNTAX
|
||||
.PP
|
||||
.RS
|
||||
|
||||
.nf
|
||||
erratic {
|
||||
drop [AMOUNT]
|
||||
truncate [AMOUNT]
|
||||
delay [AMOUNT [DURATION]]
|
||||
}
|
||||
.
|
||||
.fi
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fBdrop\fR: drop 1 per \fBAMOUNT\fR of queries, the default is 2\.
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fBtruncate\fR: truncate 1 per \fBAMOUNT\fR of queries, the default is 2\.
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fBdelay\fR: delay 1 per \fBAMOUNT\fR of queries for \fBDURATION\fR, the default for \fBAMOUNT\fR is 2 and the default for \fBDURATION\fR is 100ms\.
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
In case of a zone transfer and truncate the final SOA record \fIisn\'t\fR added to the response\.
|
||||
.
|
||||
.SH "READY"
|
||||
This plugin reports readiness to the ready plugin\.
|
||||
.
|
||||
.SH "EXAMPLES"
|
||||
.
|
||||
.nf
|
||||
|
||||
\&\. {
|
||||
.fi
|
||||
.RE
|
||||
|
||||
.IP \(bu 4
|
||||
\fB\fCdrop\fR: drop 1 per \fBAMOUNT\fP of queries, the default is 2.
|
||||
.IP \(bu 4
|
||||
\fB\fCtruncate\fR: truncate 1 per \fBAMOUNT\fP of queries, the default is 2.
|
||||
.IP \(bu 4
|
||||
\fB\fCdelay\fR: delay 1 per \fBAMOUNT\fP of queries for \fBDURATION\fP, the default for \fBAMOUNT\fP is 2 and
|
||||
the default for \fBDURATION\fP is 100ms.
|
||||
|
||||
|
||||
.PP
|
||||
In case of a zone transfer and truncate the final SOA record \fIisn't\fP added to the response.
|
||||
|
||||
.SH READY
|
||||
.PP
|
||||
This plugin reports readiness to the ready plugin.
|
||||
|
||||
.SH EXAMPLES
|
||||
.PP
|
||||
.RS
|
||||
|
||||
.nf
|
||||
\&. {
|
||||
erratic {
|
||||
drop 3
|
||||
}
|
||||
}
|
||||
.
|
||||
.fi
|
||||
.
|
||||
.P
|
||||
Or even shorter if the defaults suits you\. Note this only drops queries, it does not delay them\.
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
.nf
|
||||
|
||||
\&\. {
|
||||
.fi
|
||||
.RE
|
||||
|
||||
.PP
|
||||
Or even shorter if the defaults suits you. Note this only drops queries, it does not delay them.
|
||||
|
||||
.PP
|
||||
.RS
|
||||
|
||||
.nf
|
||||
\&. {
|
||||
erratic
|
||||
}
|
||||
.
|
||||
.fi
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
Delay 1 in 3 queries for 50ms
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
.nf
|
||||
|
||||
\&\. {
|
||||
.fi
|
||||
.RE
|
||||
|
||||
.PP
|
||||
Delay 1 in 3 queries for 50ms
|
||||
|
||||
.PP
|
||||
.RS
|
||||
|
||||
.nf
|
||||
\&. {
|
||||
erratic {
|
||||
delay 3 50ms
|
||||
}
|
||||
}
|
||||
.
|
||||
.fi
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
Delay 1 in 3 and truncate 1 in 5\.
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
.nf
|
||||
|
||||
\&\. {
|
||||
.fi
|
||||
.RE
|
||||
|
||||
.PP
|
||||
Delay 1 in 3 and truncate 1 in 5.
|
||||
|
||||
.PP
|
||||
.RS
|
||||
|
||||
.nf
|
||||
\&. {
|
||||
erratic {
|
||||
delay 3 5ms
|
||||
truncate 5
|
||||
}
|
||||
}
|
||||
.
|
||||
.fi
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
Drop every second query\.
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
.nf
|
||||
|
||||
\&\. {
|
||||
.fi
|
||||
.RE
|
||||
|
||||
.PP
|
||||
Drop every second query.
|
||||
|
||||
.PP
|
||||
.RS
|
||||
|
||||
.nf
|
||||
\&. {
|
||||
erratic {
|
||||
drop 2
|
||||
truncate 2
|
||||
}
|
||||
}
|
||||
.
|
||||
|
||||
.fi
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.SH "ALSO SEE"
|
||||
RFC 3849 \fIhttps://tools\.ietf\.org/html/rfc3849\fR and RFC 5737 \fIhttps://tools\.ietf\.org/html/rfc5737\fR\.
|
||||
.RE
|
||||
|
||||
.SH ALSO SEE
|
||||
.PP
|
||||
RFC 3849
|
||||
\[la]https://tools.ietf.org/html/rfc3849\[ra] and
|
||||
RFC 5737
|
||||
\[la]https://tools.ietf.org/html/rfc5737\[ra].
|
||||
|
||||
|
||||
Reference in New Issue
Block a user