docs: rewrite using manpage style (#327)

This still needs cleanup, but this is a first pass the cleans some
cruft and documents our style (in middleware.md) and makes all the
docs match that style.
This commit is contained in:
Miek Gieben
2016-10-10 20:13:22 +01:00
committed by GitHub
parent c22b7b2252
commit faf83b00dd
18 changed files with 154 additions and 128 deletions

View File

@@ -1,16 +1,16 @@
# chaos
The `chaos` middleware allows CoreDNS to respond to TXT queries in the CH class.
The *chaos* middleware allows CoreDNS to respond to TXT queries in the CH class.
This is useful for retrieving version or author information from the server.
## Syntax
~~~
chaos [version] [authors...]
chaos [VERSION] [AUTHORS...]
~~~
* `version` the version to return. Defaults to CoreDNS-<version>, if not set.
* `authors` what authors to return. No default.
* **VERSION** the version to return. Defaults to CoreDNS-<version>, if not set.
* **AUTHORS** what authors to return. No default.
Note that you have to make sure that this middleware will get actual queries for the
following zones: `version.bind`, `version.server`, `authors.bind`, `hostname.bind` and