diff options
| author |  Miek Gieben <miek@miek.nl>
| 2018-01-04 12:53:07 +0000 |
|---|---|---|
| committer |  GitHub <noreply@github.com>
| 2018-01-04 12:53:07 +0000 |
| commit | 58221f55db5675c6107d19679c46a216ed072aca (patch) | |
| tree | f4f86c8ecd35538da492524dec549566daf40809 /plugin/cache/README.md | |
| parent | 0600f8c058f39c7afec9f915657e06f158d21c47 (diff) | |
| download | coredns-58221f55db5675c6107d19679c46a216ed072aca.tar.gz coredns-58221f55db5675c6107d19679c46a216ed072aca.tar.zst coredns-58221f55db5675c6107d19679c46a216ed072aca.zip | |
Manual pages (#1346)
* Add manual pages
Generate manual pages from the README and extend README with Name and
Description sections.
The generation requires 'ronn' which may not be available. Just check in
all generated manual pages.
Diffstat (limited to 'plugin/cache/README.md')
| -rw-r--r-- | plugin/cache/README.md | 10 |
1 files changed, 9 insertions, 1 deletions
diff --git a/plugin/cache/README.md b/plugin/cache/README.md index 9adb4582f..edbc6f8fc 100644 --- a/plugin/cache/README.md +++ b/plugin/cache/README.md @@ -1,6 +1,14 @@ # cache -*cache* enables a frontend cache. It will cache all records except zone transfers and metadata records. +## Name + +*cache* - enables a frontend cache. + +## Description + +With *cache* enabled all records except zone transfers and metadata records will be cached for up to +3600s. Caching is mostly useful in a scenario when fetching data from the backend (upstream, +database, etc.) is expensive. ## Syntax |