mirror of
https://github.com/coredns/coredns.git
synced 2025-12-05 01:45:11 -05: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:
@@ -1,103 +1,111 @@
|
||||
.\" generated with Ronn/v0.7.3
|
||||
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
||||
.
|
||||
.TH "COREDNS\-IMPORT" "7" "March 2019" "CoreDNS" "CoreDNS plugins"
|
||||
.
|
||||
.SH "NAME"
|
||||
\fIimport\fR \- include files or reference snippets from a Corefile\.
|
||||
.
|
||||
.SH "DESCRIPTION"
|
||||
The \fIimport\fR plugin can be used to include files into the main configuration\. Another use it to reference predefined snippets\. Both can help to avoid some duplication\.
|
||||
.
|
||||
.P
|
||||
This is a unique directive in that \fIimport\fR can appear outside of a server block\. In other words, it can appear at the top of a Corefile where an address would normally be\.
|
||||
.
|
||||
.SH "SYNTAX"
|
||||
.
|
||||
.nf
|
||||
.\" Generated by Mmark Markdown Processer - mmark.nl
|
||||
.TH "COREDNS-IMPORT" "7" "April 2019" "CoreDNS" "CoreDNS Plugins"
|
||||
|
||||
.SH IMPORT
|
||||
.SH NAME
|
||||
.PP
|
||||
\fIimport\fP - include files or reference snippets from a Corefile.
|
||||
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
The \fIimport\fP plugin can be used to include files into the main configuration. Another use it to
|
||||
reference predefined snippets. Both can help to avoid some duplication.
|
||||
|
||||
.PP
|
||||
This is a unique directive in that \fIimport\fP can appear outside of a server block. In other words, it
|
||||
can appear at the top of a Corefile where an address would normally be.
|
||||
|
||||
.SH SYNTAX
|
||||
.PP
|
||||
.RS
|
||||
|
||||
.nf
|
||||
import PATTERN
|
||||
.
|
||||
.fi
|
||||
.
|
||||
.IP "\(bu" 4
|
||||
\fBPATTERN\fR is the file, glob pattern (\fB*\fR) or snippet to include\. Its contents will replace this line, as if that file\'s contents appeared here to begin with\.
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.SH "FILES"
|
||||
You can use \fIimport\fR to include a file or files\. This file\'s location is relative to the Corefile\'s location\. It is an error if a specific file cannot be found, but an empty glob pattern is not an error\.
|
||||
.
|
||||
.SH "SNIPPETS"
|
||||
You can define snippets to be reused later in your Corefile by defining a block with a single\-token label surrounded by parentheses:
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
.nf
|
||||
|
||||
.fi
|
||||
.RE
|
||||
|
||||
.IP \(bu 4
|
||||
\fBPATTERN\fP is the file, glob pattern (\fB\fC*\fR) or snippet to include. Its contents will replace
|
||||
this line, as if that file's contents appeared here to begin with.
|
||||
|
||||
|
||||
.SH FILES
|
||||
.PP
|
||||
You can use \fIimport\fP to include a file or files. This file's location is relative to the
|
||||
Corefile's location. It is an error if a specific file cannot be found, but an empty glob pattern is
|
||||
not an error.
|
||||
|
||||
.SH SNIPPETS
|
||||
.PP
|
||||
You can define snippets to be reused later in your Corefile by defining a block with a single-token
|
||||
label surrounded by parentheses:
|
||||
|
||||
.PP
|
||||
.RS
|
||||
|
||||
.nf
|
||||
(mysnippet) {
|
||||
\.\.\.
|
||||
...
|
||||
}
|
||||
.
|
||||
.fi
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
Then you can invoke the snippet with \fIimport\fR:
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
.nf
|
||||
|
||||
.fi
|
||||
.RE
|
||||
|
||||
.PP
|
||||
Then you can invoke the snippet with \fIimport\fP:
|
||||
|
||||
.PP
|
||||
.RS
|
||||
|
||||
.nf
|
||||
import mysnippet
|
||||
.
|
||||
|
||||
.fi
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.SH "EXAMPLES"
|
||||
.RE
|
||||
|
||||
.SH EXAMPLES
|
||||
.PP
|
||||
Import a shared configuration:
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
.nf
|
||||
|
||||
\&\. {
|
||||
import config/common\.conf
|
||||
.PP
|
||||
.RS
|
||||
|
||||
.nf
|
||||
\&. {
|
||||
import config/common.conf
|
||||
}
|
||||
.
|
||||
.fi
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
Where \fBconfig/common\.conf\fR contains:
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
.nf
|
||||
|
||||
.fi
|
||||
.RE
|
||||
|
||||
.PP
|
||||
Where \fB\fCconfig/common.conf\fR contains:
|
||||
|
||||
.PP
|
||||
.RS
|
||||
|
||||
.nf
|
||||
prometheus
|
||||
errors
|
||||
log
|
||||
.
|
||||
.fi
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.P
|
||||
This imports files found in the zones directory:
|
||||
.
|
||||
.IP "" 4
|
||||
.
|
||||
.nf
|
||||
|
||||
import \.\./zones/*
|
||||
.
|
||||
.fi
|
||||
.
|
||||
.IP "" 0
|
||||
.
|
||||
.SH "ALSO SEE"
|
||||
See corefile(5)\.
|
||||
.RE
|
||||
|
||||
.PP
|
||||
This imports files found in the zones directory:
|
||||
|
||||
.PP
|
||||
.RS
|
||||
|
||||
.nf
|
||||
import ../zones/*
|
||||
|
||||
.fi
|
||||
.RE
|
||||
|
||||
.SH ALSO SEE
|
||||
.PP
|
||||
See corefile(5).
|
||||
|
||||
|
||||
Reference in New Issue
Block a user