mirror of
https://github.com/coredns/coredns.git
synced 2025-10-27 08:14:18 -04: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,11 +1,11 @@
|
||||
.\" Generated by Mmark Markdown Processer - mmark.nl
|
||||
.TH "COREDNS-AUTOPATH" "7" "April 2019" "CoreDNS" "CoreDNS Plugins"
|
||||
.TH "COREDNS-AUTOPATH" 7 "June 2019" "CoreDNS" "CoreDNS Plugins"
|
||||
|
||||
.SH NAME
|
||||
.SH "NAME"
|
||||
.PP
|
||||
\fIautopath\fP - allows for server-side search path completion.
|
||||
|
||||
.SH DESCRIPTION
|
||||
.SH "DESCRIPTION"
|
||||
.PP
|
||||
If it sees a query that matches the first element of the configured search path, \fIautopath\fP will
|
||||
follow the chain of search path elements and return the first reply that is not NXDOMAIN. On any
|
||||
@@ -13,7 +13,7 @@ failures, the original reply is returned. Because \fIautopath\fP returns a reply
|
||||
the original question it will add a CNAME that points from the original name (with the search path
|
||||
element in it) to the name of this answer.
|
||||
|
||||
.SH SYNTAX
|
||||
.SH "SYNTAX"
|
||||
.PP
|
||||
.RS
|
||||
|
||||
@@ -34,7 +34,7 @@ query) to retrieve the search list it should use.
|
||||
.PP
|
||||
If a plugin implements the \fB\fCAutoPather\fR interface then it can be used.
|
||||
|
||||
.SH METRICS
|
||||
.SH "METRICS"
|
||||
.PP
|
||||
If monitoring is enabled (via the \fIprometheus\fP directive) then the following metric is exported:
|
||||
|
||||
@@ -45,7 +45,7 @@ If monitoring is enabled (via the \fIprometheus\fP directive) then the following
|
||||
.PP
|
||||
The \fB\fCserver\fR label is explained in the \fImetrics\fP plugin documentation.
|
||||
|
||||
.SH EXAMPLES
|
||||
.SH "EXAMPLES"
|
||||
.PP
|
||||
.RS
|
||||
|
||||
@@ -71,7 +71,7 @@ autopath @kubernetes
|
||||
.PP
|
||||
Use the search path dynamically retrieved from the \fIkubernetes\fP plugin.
|
||||
|
||||
.SH KNOWN ISSUES
|
||||
.SH "KNOWN ISSUES"
|
||||
.PP
|
||||
In Kubernetes, \fIautopath\fP is not compatible with pods running from Windows nodes.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user