]> git.ipfire.org Git - thirdparty/pdns.git/commitdiff
update zone2sql manpage with all current options
authorPieter Lexis <pieter.lexis@powerdns.com>
Thu, 7 Jan 2016 14:38:00 +0000 (15:38 +0100)
committerPieter Lexis <pieter.lexis@powerdns.com>
Wed, 10 Feb 2016 12:45:27 +0000 (13:45 +0100)
docs/manpages/zone2sql.1.md

index 4d5bf19c60f8a8e9fa1c0ebb256aafce255bcdac..1924e0d897322002c18d455d872f4adc1c8388f5 100644 (file)
@@ -18,8 +18,8 @@ also honour `$ORIGIN` and `$TTL`.
 For backends supporting slave operation there is also an option to keep slave
 zones as slaves, and not convert them to native operation.
 
-**zone2sql** can generate SQL for the Generic MySQL, Generic PostgreSQL and
-Oracle backends.
+**zone2sql** can generate SQL for the Generic MySQL, Generic PostgreSQL, Generic
+SQLite3 and Generic Oracle backends.
 
 # OPTIONS
 ## INPUT OPTIONS
@@ -33,7 +33,7 @@ Oracle backends.
 :    When parsing a single zone without $ORIGIN statement, set *ZONE* as the zone
      name.
 
-## OUTPUT OPTIONS
+## BACKENDS
 --gmysql
 :    Output in format suitable for the default configuration of the Generic MySQL
      backend.
@@ -42,27 +42,60 @@ Oracle backends.
 :    Output in format suitable for the default configuration of the Generic
      PostgreSQL backend.
 
---oracle
+--gsqlite
+:    Output in format suitable for the default configuration of the Generic
+     SQLite3 backend.
+
+--goracle
 :    Output in format suitable for the default configuration of the Generic Oracle
      backend.
 
+--mydns
+:    Output in a format suitable for the MyDNS backend.
+
+--oracle
+:    Output in format suitable for the default configuration of the Oracle backend.
+
+## OUTPUT OPTIONS
+--json-comments
+:    Parse JSON in zonefile comments to set the 'disabled' and 'comment' fields
+     in the database. See *JSON COMMENTS* for more information.
+
 --transactions
-:    For Oracle and PostgreSQL output, wrap each domain in a transaction for higher
-     speed and integrity.
+:    If the target SQL backend supports transactions, wrap every domain into
+     a transaction for integrity and possibly higher speed.
 
 ## OTHER OPTIONS
---slave
-:    Maintain slave status of zones listed in named.conf as being slaves. The
-     default behaviour is to convert all zones to native operation.
-
---on-error-resume-next
-:    Ignore missing files during parsing. Dangerous.
+--filter-duplicate-soa
+:    If there's more than one SOA record in the zone (possibly because it was
+     AXFR'd), ignore it. If this option is not set, all SOA records in the zone
+     are emitted.
 
 --help
 :    List all options
 
+--on-error-resume-next
+:    Ignore missing zone files during parsing. Dangerous.
+
+--slave
+:    Maintain slave status of zones listed in named.conf as being slaves. The
+     default behaviour is to convert all zones to native operation.
+
 --verbose
 :    Be verbose during conversion.
 
+# JSON COMMENTS
+The Generic SQL backends have the 'comment' and 'disabled' fields in the 'records'
+table. The 'comment' field contains a comment for this record (if any) and the
+'disabled' field tells PowerDNS if the record can be served to clients.
+
+When a zonefile contains a comment like `; json={"comment": "Something", "disabled": true}`
+and **--json-comments** is provided, the 'comment' field will contain "Something"
+and the 'disabled' field will be set to the database's native true value.
+
+WARNING: Using JSON comments to disable records means that the zone in PowerDNS
+is different from the one served by BIND, as BIND does not handle the disabled
+status in the comment.
+
 # SEE ALSO
 pdns_server(1)