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,17 +1,17 @@
# rewrite
`rewrite` performs internal message rewriting. Rewrites are invisible to the client.
*rewrite* performs internal message rewriting. Rewrites are invisible to the client.
There are simple rewrites (fast) and complex rewrites (slower), but they're powerful enough to
accommodate most dynamic back-end applications.
## Syntax
~~~
rewrite from to
rewrite FROM TO
~~~
* from is the exact name of type to match
* to is the destination name or type to rewrite to
* **FROM** is the exact name of type to match
* **TO** is the destination name or type to rewrite to
If from *and* to look like a DNS type (`A`, `MX`, etc.), the type of the message will be rewriten;
e.g., to rewrite ANY queries to HINFO, use `rewrite ANY HINFO`.