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.
This commit is contained in:
Miek Gieben
2018-01-04 12:53:07 +00:00
committed by GitHub
parent 0600f8c058
commit 58221f55db
62 changed files with 3397 additions and 97 deletions

View File

@@ -1,8 +1,16 @@
# dnstap
*dnstap* enables logging to dnstap, a flexible, structured binary log format for DNS software: http://dnstap.info.
## Name
There is a buffer, expect at least 13 requests before the server sends its dnstap messages to the socket.
*dnstap* - enable logging to dnstap
## Description
dnstap is a flexible, structured binary log format for DNS software: http://dnstap.info. With this
plugin you make CoreDNS output dnstap logging.
Note that there is an internal buffer, so expect at least 13 requests before the server sends its
dnstap messages to the socket.
## Syntax
@@ -33,14 +41,10 @@ Log to a remote endpoint.
dnstap tcp://127.0.0.1:6000 full
~~~
## Dnstap command line tool
## Command Line Tool
~~~ sh
% go get github.com/dnstap/golang-dnstap
% cd $GOPATH/src/github.com/dnstap/golang-dnstap/dnstap
% go build
% ./dnstap
~~~
Dnstap has a command line tool that can be used to inspect the logging. The tool can be found
at Github: <https://github.com/dnstap/golang-dnstap>. It's written in Go.
The following command listens on the given socket and decodes messages to stdout.
@@ -59,3 +63,7 @@ Listen for dnstap messages on port 6000.
~~~ sh
% dnstap -l 127.0.0.1:6000
~~~
# See Also
[dnstap.info](http://dnstap.info).