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,7 +1,8 @@
# loadbalance
`loadbalance` acts as a round-robin DNS loadbalancer by randomizing the order of A and AAAA records in the answer. See [Wikipedia](https://en.wikipedia.org/wiki/Round-robin_DNS) about the pros and cons
on this setup.
*loadbalance* acts as a round-robin DNS loadbalancer by randomizing the order of A and AAAA records
in the answer. See [Wikipedia](https://en.wikipedia.org/wiki/Round-robin_DNS) about the pros and
cons on this setup.
It will take care to sort any CNAMEs before any address records, because some stub resolver
implementations (like glibc) are particular about that.
@@ -9,10 +10,10 @@ implementations (like glibc) are particular about that.
## Syntax
~~~
loadbalance [policy]
loadbalance [POLICY]
~~~
* `policy` is how to balance, the default is "round_robin"
* **POLICY** is how to balance, the default is "round_robin"
## Examples