Generate man-pages (#2439)

Almost 100% mechanical change, except the fact that import/import.md
is moved to import/README.md

No content changes.

Signed-off-by: Miek Gieben <miek@miek.nl>
This commit is contained in:
Miek Gieben
2019-01-06 09:15:34 +00:00
committed by GitHub
parent fb32f7a358
commit 06efc07f46
13 changed files with 158 additions and 26 deletions

73
plugin/import/README.md Normal file
View File

@@ -0,0 +1,73 @@
# import
## Name
*import* - include files or reference snippets from a Corefile.
## Description
The *import* plugin can be used to incude files into the main configuration. Another use it to
reference predefined snippets. Both can help to avoid some duplication.
This is a unique directive in that *import* 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.
## Syntax
~~~
import PATTERN
~~~
* **PATTERN** is the file, glob pattern (`*`) or snippet to include. Its contents will replace
this line, as if that file's contents appeared here to begin with.
## Files
You can use *import* 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.
## Snippets
You can define snippets to be reused later in your Corefile by defining a block with a single-token
label surrounded by parentheses:
~~~ corefile
(mysnippet) {
...
}
~~~
Then you can invoke the snippet with *import*:
~~~
import mysnippet
~~~
## Examples
Import a shared configuration:
~~~
. {
import config/common.conf
}
~~~
Where `config/common.conf` contains:
~~~
prometheus
errors
log
~~~
This imports files found in the zones directory:
~~~
import ../zones/*
~~~
## Also See
See corefile(5).