Mirrors/coredns
1
0
Fork 0
mirror of https://github.com/coredns/coredns.git synced 2025-10-27 08:14:18 -04:00
Code Issues Packages Projects Releases Wiki Activity

docs: rewrite using manpage style (#327)

Browse Source 
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
Download Patch File Download Diff File Expand all files Collapse all files

19
middleware/log/README.md
View File

@@ -1,6 +1,6 @@
# log
`log` enables query logging.
*log* enables query logging.
## Syntax
@@ -9,31 +9,30 @@ log
~~~
* With no arguments, a query log entry is written to query.log in the common log format for all requests
(base name = .).
~~~ txt
log file
log FILE
~~~
* file is the log file to create (or append to). The base name is assumed to be '.' .
* **FILE** is the log file to create (or append to).
~~~ txt
log [name] [file] [format]
log [NAME] FILE [FORMAT]
~~~
* `name` is the base name to match in order to be logged
* `file` is the log file to create (or append to)
* `format` is the log format to use (default is Common Log Format)
* `NAME` is the name to match in order to be logged
* `FILE` is the log file to create (or append to)
* `FORMAT` is the log format to use (default is Common Log Format)
You can further specify the class of responses that get logged:
~~~ txt
log [name] [file] [format] {
log [NAME] FILE [FORMAT] {
class [success|denial|error|all]
}
~~~
Here *success*, *denial* and *error* denotes the class of responses that should be logged. The
Here `success` `denial` and `error` denotes the class of responses that should be logged. The
classes have the following meaning:
* `success`: successful response