From 4b028c4edb90e9bb69b4e6f838aaeff567c817a8 Mon Sep 17 00:00:00 2001 From: Knut Ahlers Date: Sat, 25 May 2019 17:13:54 +0200 Subject: [PATCH] Add usage examples to README Signed-off-by: Knut Ahlers --- README.md | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) diff --git a/README.md b/README.md index 327bb42..56ba0b9 100644 --- a/README.md +++ b/README.md @@ -6,3 +6,40 @@ # Luzifer / rootzone `rootzone` is a small util for my [personal-dns](https://github.com/luzifer-docker/personal-dns) project to collect all IANA and OpenNIC TLDs and generate a named stub file for bind to be able to resolve those TLDs without delegation to third-party nameservers which might be modifying the original responses from the root nameservers. + +## Building + +```console +$ go get github.com/Luzifer/rootzone +``` + +## Usage + +```console +$ rootzone --help +Usage of rootzone: + --concurrency-limit int How many queries to execute in parallel (default 50) + --iana-filter strings IANA TLDs to igore (default [arpa.]) + --iana-tld-list string IANA TLD list file (default "https://data.iana.org/TLD/tlds-alpha-by-domain.txt") + --internic-root-file string Internic root nameserver file (default "https://www.internic.net/domain/named.root") + --log-level string Log level (debug, info, warn, error, fatal) (default "info") + --opennic-filter strings OpenNIC TLDs to ignore (default [.,opennic.glue.]) + --opennic-root string OpenNIC root server (default "75.127.96.89:53") + --version Prints current version and exits +``` + +```console +$ rootzone | head -n12 +# Autogenerated with rootzone dev +# +zone "aaa." in { + type static-stub; + server-addresses { 156.154.144.2; 156.154.145.2; 156.154.156.2; 156.154.157.2; 156.154.158.2; 156.154.159.2; }; +}; +# +zone "aarp." in { + type static-stub; + server-addresses { 192.42.173.30; 192.42.174.30; 192.42.175.30; 192.42.176.30; }; +}; +# +```