mirror of
https://github.com/coredns/coredns.git
synced 2025-11-18 09:52:17 -05:00
doc: make -f Makefile.doc (#2919)
mechanical change: create the manual pages. Signed-off-by: Miek Gieben <miek@miek.nl>
This commit is contained in:
@@ -1,20 +1,20 @@
|
||||
.\" Generated by Mmark Markdown Processer - mmark.nl
|
||||
.TH "COREDNS-DEBUG" "7" "April 2019" "CoreDNS" "CoreDNS Plugins"
|
||||
.TH "COREDNS-DEBUG" 7 "June 2019" "CoreDNS" "CoreDNS Plugins"
|
||||
|
||||
.SH NAME
|
||||
.SH "NAME"
|
||||
.PP
|
||||
\fIdebug\fP - disables the automatic recovery upon a crash so that you'll get a nice stack trace.
|
||||
|
||||
.SH DESCRIPTION
|
||||
.SH "DESCRIPTION"
|
||||
.PP
|
||||
Normally CoreDNS will recover from panics, using \fIdebug\fP inhibits this. The main use of \fIdebug\fP is
|
||||
to help testing. A side effect of using \fIdebug\fP is that \fB\fClog.Debug\fR and \fB\fClog.Debugf\fR will be printed
|
||||
to standard output.
|
||||
Normally CoreDNS will recover from panics; using \fIdebug\fP inhibits this. The main use of \fIdebug\fP is
|
||||
to help in testing. A side effect of using \fIdebug\fP is that \fB\fClog.Debug\fR and \fB\fClog.Debugf\fR messages
|
||||
will be printed to standard output.
|
||||
|
||||
.PP
|
||||
Note that the \fIerrors\fP plugin (if loaded) will also set a \fB\fCrecover\fR negating this setting.
|
||||
Note that the \fIerrors\fP plugin (if loaded) will also set a \fB\fCrecover\fR, negating this setting.
|
||||
|
||||
.SH SYNTAX
|
||||
.SH "SYNTAX"
|
||||
.PP
|
||||
.RS
|
||||
|
||||
@@ -25,7 +25,7 @@ debug
|
||||
.RE
|
||||
|
||||
.PP
|
||||
Some plugin will debug log DNS messages. This is done in the following format:
|
||||
Some plugins will send debug log DNS messages. This is done in the following format:
|
||||
|
||||
.PP
|
||||
.RS
|
||||
@@ -40,14 +40,14 @@ debug: 00002a
|
||||
.RE
|
||||
|
||||
.PP
|
||||
Using \fB\fCtext2pcap\fR (part of Wireshark) this can be converted back to binary, with the following
|
||||
command line: \fB\fCtext2pcap -i 17 -u 53,53\fR. Where 17 is the protocol (UDP) and 53 are the ports. These
|
||||
ports allow wireshark to detect these packets as DNS messages.
|
||||
Using \fB\fCtext2pcap\fR (part of Wireshark), this can be converted back to binary, with the following
|
||||
command line: \fB\fCtext2pcap -i 17 -u 53,53\fR, where 17 is the protocol (UDP) and 53 are the ports. These
|
||||
ports allow Wireshark to detect these packets as DNS messages.
|
||||
|
||||
.PP
|
||||
Each plugin can decide to dump messages to aid in debugging.
|
||||
Each plugin can decide whether to dump messages to aid in debugging.
|
||||
|
||||
.SH EXAMPLES
|
||||
.SH "EXAMPLES"
|
||||
.PP
|
||||
Disable the ability to recover from crashes and show debug logging:
|
||||
|
||||
@@ -62,7 +62,7 @@ Disable the ability to recover from crashes and show debug logging:
|
||||
.fi
|
||||
.RE
|
||||
|
||||
.SH ALSO SEE
|
||||
.SH "ALSO SEE"
|
||||
.PP
|
||||
https://www.wireshark.org/docs/man-pages/text2pcap.html
|
||||
\[la]https://www.wireshark.org/docs/man-pages/text2pcap.html\[ra].
|
||||
|
||||
Reference in New Issue
Block a user