From: Pieter Lexis Date: Thu, 7 Jan 2016 16:09:42 +0000 (+0100) Subject: Add zone2json manpage X-Git-Tag: auth-4.0.0-alpha2~45^2~7 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=8803cb05e4e76e9715086ea5eb3c4bdc79b6c182;p=pdns Add zone2json manpage --- diff --git a/build-scripts/build-auth-rpm b/build-scripts/build-auth-rpm index 973c96dce..644100464 100755 --- a/build-scripts/build-auth-rpm +++ b/build-scripts/build-auth-rpm @@ -212,6 +212,7 @@ fi %{_mandir}/man1/pdns_control.1.gz %{_mandir}/man1/pdns_server.1.gz %{_mandir}/man1/zone2sql.1.gz +%{_mandir}/man1/zone2json.1.gz %{_mandir}/man1/zone2ldap.1.gz %{_mandir}/man1/pdnsutil.1.gz %{_initrddir}/pdns @@ -483,6 +484,7 @@ exit 0 %{_mandir}/man1/pdns_control.1.gz %{_mandir}/man1/pdns_server.1.gz %{_mandir}/man1/zone2sql.1.gz +%{_mandir}/man1/zone2json.1.gz %{_mandir}/man1/pdns-zone2ldap.1.gz %{_mandir}/man1/pdnsutil.1.gz %{_unitdir}/pdns.service diff --git a/build-scripts/debian-authoritative/pdns-server.manpages b/build-scripts/debian-authoritative/pdns-server.manpages index a6704f761..a6d07dd73 100644 --- a/build-scripts/debian-authoritative/pdns-server.manpages +++ b/build-scripts/debian-authoritative/pdns-server.manpages @@ -1,4 +1,5 @@ debian/tmp/usr/share/man/man1/pdns_control.1 debian/tmp/usr/share/man/man1/pdns_server.1 debian/tmp/usr/share/man/man1/zone2sql.1 +debian/tmp/usr/share/man/man1/zone2json.1 debian/tmp/usr/share/man/man1/pdnsutil.1 diff --git a/docs/Makefile.am b/docs/Makefile.am index 10a402146..a20c6a171 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -1,6 +1,7 @@ MANPAGES_TARGET_AUTH = pdns_server.1 \ pdns_control.1 \ pdnsutil.1 \ + zone2json.1 \ zone2ldap.1 \ zone2sql.1 diff --git a/docs/manpages/zone2json.1.md b/docs/manpages/zone2json.1.md new file mode 100644 index 000000000..5e7a24af0 --- /dev/null +++ b/docs/manpages/zone2json.1.md @@ -0,0 +1,41 @@ +% ZONE2JSON(1) +% PowerDNS +% January 2016 + +# NAME +**zone2json** - convert BIND zones to JSON + +# SYNOPSIS +**zone2json** {**--named-conf=***PATH*,**--zone-file=***PATH* [**--zone-name=***NAME*]} [*OPTIONS*] + +# DESCRIPTION +**zone2json** parses Bind named.conf files and zonefiles and outputs JSON +on standard out, which can then be fed to the PowerDNS API. + +**zone2json** understands the Bind master file extension `$GENERATE` and will +also honour `$ORIGIN` and `$TTL`. + +# OPTIONS +## INPUT OPTIONS +--named-conf=*PATH* +: Read *PATH* to get the bind configuration + +--zone=*PATH* +: Parse only the zone file at *PATH* Conflicts with **--named-conf** parameter. + +--zone-name=*NAME* +: When parsing a single zone without $ORIGIN statement, set *ZONE* as the zone + name. + +## OTHER OPTIONS +--help +: List all options + +--on-error-resume-next +: Ignore missing zone files during parsing. Dangerous. + +--verbose +: Be verbose during conversion. + +# SEE ALSO +pdns_server(1) diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 82c5a0dd2..28024731d 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -33,6 +33,7 @@ pages: - Recursion with the Authoritative Server: authoritative/recursion.md - Serving DNSSEC Signed Data: authoritative/dnssec.md - List of Settings: authoritative/settings.md + - 'Manpage: zone2json.1': manpages/zone2json.1.md - 'Manpage: zone2ldap.1': manpages/zone2ldap.1.md - 'Manpage: zone2sql.1': manpages/zone2sql.1.md - 'Manpage: pdns_control.1': manpages/pdns_control.1.md