From 3336c065f3dc752e6f058bd4d0c98644829d7217 Mon Sep 17 00:00:00 2001 From: brettlangdon Date: Sun, 17 Jan 2016 21:26:33 -0500 Subject: [PATCH] add doc.go --- doc.go | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 doc.go diff --git a/doc.go b/doc.go new file mode 100644 index 0000000..929acbf --- /dev/null +++ b/doc.go @@ -0,0 +1,38 @@ +/* +Package realm implements a simple non-recursive DNS server. + +INSTALLATION + +To install realm: + + go get -u github.com/brettlangdon/realm/cmd/... + +USAGE + +Realm will parse your server configuration from a DNS zone file see https://en.wikipedia.org/wiki/Zone_file for more information. + +To start a server: + + realm --zone ./domain.zone + +Full command usage: + + NAME: + realm - A new cli application + + USAGE: + realm [global options] command [command options] [arguments...] + + VERSION: + 0.1.0 + + COMMANDS: + help, h Shows a list of commands or help for one command + + GLOBAL OPTIONS: + --zone, -z location to DNS zone file [required] [$REALM_ZONE] + --bind, -b ':53' '[]:' to bind too [$REALM_BIND] + --help, -h show help + --version, -v print the version +*/ +package realm