From: Mark Andrews Date: Mon, 4 May 2015 06:21:00 +0000 (+1000) Subject: 4111. [doc] Alphabetize rndc man page. [RT #39360] X-Git-Tag: v9.11.0a1~843 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=52aa2f94981aa570a37c659b451541171f7537a4;p=thirdparty%2Fbind9.git 4111. [doc] Alphabetize rndc man page. [RT #39360] --- diff --git a/CHANGES b/CHANGES index f3d379eb2be..5eb43440a62 100644 --- a/CHANGES +++ b/CHANGES @@ -1,3 +1,5 @@ +4111. [doc] Alphabetize rndc man page. [RT #39360] + 4110. [bug] Address memory leaks / null pointer dereferences on out of memory. [RT #39310] diff --git a/bin/rndc/rndc.docbook b/bin/rndc/rndc.docbook index bb99a70781a..9cf6d0f8916 100644 --- a/bin/rndc/rndc.docbook +++ b/bin/rndc/rndc.docbook @@ -222,291 +222,143 @@ - - reload - - - Reload configuration file and zones. - - - - - - reload zone class view - - - Reload the given zone. - - - - - - refresh zone class view - - - Schedule zone maintenance for the given zone. - - - - - - retransfer zone class view - - - Retransfer the given slave zone from the master server. - - - If the zone is configured to use - inline-signing, the signed - version of the zone is discarded; after the - retransfer of the unsigned version is complete, the - signed version will be regenerated with all new - signatures. - - - - sign zone class view + addzone zone class view configuration - Fetch all DNSSEC keys for the given zone - from the key directory (see the - key-directory option in - the BIND 9 Administrator Reference Manual). If they are within - their publication period, merge them into the - zone's DNSKEY RRset. If the DNSKEY RRset - is changed, then the zone is automatically - re-signed with the new key set. - - - This command requires that the - auto-dnssec zone option be set - to allow or - maintain, - and also requires the zone to be configured to - allow dynamic DNS. - (See "Dynamic Update Policies" in the Administrator - Reference Manual for more details.) + Add a zone while the server is running. This + command requires the + allow-new-zones option to be set + to yes. The + configuration string + specified on the command line is the zone + configuration text that would ordinarily be + placed in named.conf. - - - - - loadkeys zone class view - - Fetch all DNSSEC keys for the given zone - from the key directory. If they are within - their publication period, merge them into the - zone's DNSKEY RRset. Unlike rndc - sign, however, the zone is not - immediately re-signed by the new keys, but is - allowed to incrementally re-sign over time. + The configuration is saved in a file called + name.nzf, + where name is the + name of the view, or if it contains characters + that are incompatible with use as a file name, a + cryptographic hash generated from the name + of the view. + When named is + restarted, the file will be loaded into the view + configuration, so that zones that were added + can persist after a restart. - This command requires that the - auto-dnssec zone option - be set to maintain, - and also requires the zone to be configured to - allow dynamic DNS. - (See "Dynamic Update Policies" in the Administrator - Reference Manual for more details.) + This sample addzone command + would add the zone example.com + to the default view: - - - - - freeze zone class view - - Suspend updates to a dynamic zone. If no zone is - specified, then all zones are suspended. This allows - manual edits to be made to a zone normally updated by - dynamic update. It also causes changes in the - journal file to be synced into the master file. - All dynamic update attempts will be refused while - the zone is frozen. +$ rndc addzone example.com '{ type master; file "example.com.db"; };' - - - - - thaw zone class view - - Enable updates to a frozen dynamic zone. If no - zone is specified, then all frozen zones are - enabled. This causes the server to reload the zone - from disk, and re-enables dynamic updates after the - load has completed. After a zone is thawed, - dynamic updates will no longer be refused. If - the zone has changed and the - ixfr-from-differences option is - in use, then the journal file will be updated to - reflect changes in the zone. Otherwise, if the - zone has changed, any existing journal file will be - removed. + (Note the brackets and semi-colon around the zone + configuration text.) - - - - - scan - - Scan the list of available network interfaces - for changes, without performing a full - reconfig or waiting for the - interface-interval timer. + See also rndc delzone and rndc modzone. - sync -clean zone class view + delzone -clean zone class view - Sync changes in the journal file for a dynamic zone - to the master file. If the option is - specified, the journal file is also removed. If - no zone is specified, then all zones are synced. + Delete a zone while the server is running. - - - - - notify zone class view - - Resend NOTIFY messages for the zone. + If the is specified, + the zone's master file (and journal file, if any) + will be deleted along with the zone. Without the + option, zone files must + be cleaned up by hand. (If the zone is of + type "slave" or "stub", the files needing to + be cleaned up will be reported in the output + of the rndc delzone command.) - - - - - reconfig - - Reload the configuration file and load new zones, - but do not reload existing zone files even if they - have changed. - This is faster than a full reload when there - is a large number of zones because it avoids the need - to examine the - modification times of the zones files. + If the zone was originally added via + rndc addzone, then it will be + removed permanently. However, if it was originally + configured in named.conf, then + that original configuration is still in place; when + the server is restarted or reconfigured, the zone will + come back. To remove it permanently, it must also be + removed from named.conf - - - - - zonestatus zone class view - - Displays the current status of the given zone, - including the master file name and any include - files from which it was loaded, when it was most - recently loaded, the current serial number, the - number of nodes, whether the zone supports - dynamic updates, whether the zone is DNSSEC - signed, whether it uses automatic DNSSEC key - management or inline signing, and the scheduled - refresh or expiry times for the zone. + See also rndc addzone and rndc modzone. - managed-keys (status | refresh | sync) class view + dumpdb -all|-cache|-zone view ... - When run with the "status" keyword, print the current - status of the managed-keys database for the specified - view, or for all views if none is specified. When run - with the "refresh" keyword, force an immediate refresh - of all the managed-keys in the specified view, or all - views. When run with the "sync" keyword, force an - immediate dump of the managed-keys database to disk (in - the file managed-keys.bind or - (viewname.mkeys). + Dump the server's caches (default) and/or zones to + the + dump file for the specified views. If no view is + specified, all + views are dumped. + (See the dump-file option in + the BIND 9 Administrator Reference Manual.) - stats + flush - Write server statistics to the statistics file. + Flushes the server's cache. - querylog on|off + flushname name view - Enable or disable query logging. (For backward - compatibility, this command can also be used without - an argument to toggle query logging on and off.) - - - Query logging can also be enabled - by explicitly directing the queries - category to a - channel in the - logging section of - named.conf or by specifying - querylog yes; in the - options section of - named.conf. + Flushes the given name from the view's DNS cache + and, if applicable, from the view's nameserver address + database, bad server cache and SERVFAIL cache. - dumpdb -all|-cache|-zone view ... + flushtree name view - Dump the server's caches (default) and/or zones to - the - dump file for the specified views. If no view is - specified, all - views are dumped. + Flushes the given name, and all of its subdomains, + from the view's DNS cache, address database, + bad server cache, and SERVFAIL cache. - secroots - view ... + freeze zone class view - Dump the server's security roots and negative trust anchors - for the specified views. If no view is specified, all views - are dumped. - - - If the first argument is "-", then the output is - returned via the rndc response channel - and printed to the standard output. - Otherwise, it is written to the secroots dump file, which - defaults to named.secroots, but can be - overridden via the option in - named.conf. + Suspend updates to a dynamic zone. If no zone is + specified, then all zones are suspended. This allows + manual edits to be made to a zone normally updated by + dynamic update. It also causes changes in the + journal file to be synced into the master file. + All dynamic update attempts will be refused while + the zone is frozen. - - - - - stop -p - - Stop the server, making sure any recent changes - made through dynamic update or IXFR are first saved to - the master files of the updated zones. - If is specified named's process id is returned. - This allows an external process to determine when named - had completed stopping. + See also rndc thaw. @@ -523,101 +375,103 @@ This allows an external process to determine when named had completed halting. - - - - - trace - - Increment the servers debugging level by one. + See also rndc stop. - trace level + loadkeys zone class view - Sets the server's debugging level to an explicit - value. + Fetch all DNSSEC keys for the given zone + from the key directory. If they are within + their publication period, merge them into the + zone's DNSKEY RRset. Unlike rndc + sign, however, the zone is not + immediately re-signed by the new keys, but is + allowed to incrementally re-sign over time. - - - - - notrace - - Sets the server's debugging level to 0. + This command requires that the + auto-dnssec zone option + be set to maintain, + and also requires the zone to be configured to + allow dynamic DNS. + (See "Dynamic Update Policies" in the Administrator + Reference Manual for more details.) - flush + managed-keys (status | refresh | sync) class view - Flushes the server's cache. + When run with the "status" keyword, print the current + status of the managed-keys database for the specified + view, or for all views if none is specified. When run + with the "refresh" keyword, force an immediate refresh + of all the managed-keys in the specified view, or all + views. When run with the "sync" keyword, force an + immediate dump of the managed-keys database to disk (in + the file managed-keys.bind or + (viewname.mkeys). - flushname name view + modzone zone class view configuration - Flushes the given name from the view's DNS cache - and, if applicable, from the view's nameserver address - database, bad server cache and SERVFAIL cache. + Modify the configuration of a zone while the server + is running. This command requires the + allow-new-zones option to be + set to yes. As with + addzone, the + configuration string + specified on the command line is the zone + configuration text that would ordinarily be + placed in named.conf. - - - - - flushtree name view - - Flushes the given name, and all of its subdomains, - from the view's DNS cache, address database, - bad server cache, and SERVFAIL cache. + If the zone was originally added via + rndc addzone, the configuration + changes will be recorded permanently and will still be + in effect after the server is restarted or reconfigured. + However, if it was originally configured in + named.conf, then that original + configuration is still in place; when the server is + restarted or reconfigured, the zone will revert to + its original configuration. To make the changes + permanent, it must also be modified in + named.conf - - - - - status - - Display status of the server. - Note that the number of zones includes the internal bind/CH zone - and the default ./IN - hint zone if there is not an - explicit root zone configured. + See also rndc addzone and rndc delzone. - recursing + notify zone class view - Dump the list of queries named is currently recursing - on. + Resend NOTIFY messages for the zone. - validation ( on | off | check ) view ... + notrace - Enable, disable, or check the current status of - DNSSEC validation. - Note dnssec-enable also needs to be - set to yes or - auto to be effective. - It defaults to enabled. + Sets the server's debugging level to 0. + + + See also rndc trace. @@ -698,124 +552,127 @@ - tsig-list + querylog on|off - List the names of all TSIG keys currently configured - for use by named in each view. The - list both statically configured keys and dynamic - TKEY-negotiated keys. + Enable or disable query logging. (For backward + compatibility, this command can also be used without + an argument to toggle query logging on and off.) + + + Query logging can also be enabled + by explicitly directing the queries + category to a + channel in the + logging section of + named.conf or by specifying + querylog yes; in the + options section of + named.conf. - tsig-delete keyname view + reconfig - Delete a given TKEY-negotiated key from the server. - (This does not apply to statically configured TSIG - keys.) + Reload the configuration file and load new zones, + but do not reload existing zone files even if they + have changed. + This is faster than a full reload when there + is a large number of zones because it avoids the need + to examine the + modification times of the zones files. - addzone zone class view configuration + recursing - Add a zone while the server is running. This - command requires the - allow-new-zones option to be set - to yes. The - configuration string - specified on the command line is the zone - configuration text that would ordinarily be - placed in named.conf. - - - The configuration is saved in a file called - name.nzf, - where name is the - name of the view, or if it contains characters - that are incompatible with use as a file name, a - cryptographic hash generated from the name - of the view. - When named is - restarted, the file will be loaded into the view - configuration, so that zones that were added - can persist after a restart. + Dump the list of queries named is currently recursing + on. + + + + + refresh zone class view + - This sample addzone command - would add the zone example.com - to the default view: + Schedule zone maintenance for the given zone. + + + + + reload + -$ rndc addzone example.com '{ type master; file "example.com.db"; };' + Reload configuration file and zones. + + + + + reload zone class view + - (Note the brackets and semi-colon around the zone - configuration text.) + Reload the given zone. - modzone zone class view configuration + retransfer zone class view - Modify the configuration of a zone while the server - is running. This command requires the - allow-new-zones option to be - set to yes. As with - addzone, the - configuration string - specified on the command line is the zone - configuration text that would ordinarily be - placed in named.conf. + Retransfer the given slave zone from the master server. - If the zone was originally added via - rndc addzone, the configuration - changes will be recorded permanently and will still be - in effect after the server is restarted or reconfigured. - However, if it was originally configured in - named.conf, then that original - configuration is still in place; when the server is - restarted or reconfigured, the zone will revert to - its original configuration. To make the changes - permanent, it must also be modified in - named.conf + If the zone is configured to use + inline-signing, the signed + version of the zone is discarded; after the + retransfer of the unsigned version is complete, the + signed version will be regenerated with all new + signatures. - delzone -clean zone class view + scan - Delete a zone while the server is running. + Scan the list of available network interfaces + for changes, without performing a full + reconfig or waiting for the + interface-interval timer. + + + + + secroots - view ... + - If the is specified, - the zone's master file (and journal file, if any) - will be deleted along with the zone. Without the - option, zone files must - be cleaned up by hand. (If the zone is of - type "slave" or "stub", the files needing to - be cleaned up will be reported in the output - of the rndc delzone command.) + Dump the server's security roots and negative trust anchors + for the specified views. If no view is specified, all views + are dumped. - If the zone was originally added via - rndc addzone, then it will be - removed permanently. However, if it was originally - configured in named.conf, then - that original configuration is still in place; when - the server is restarted or reconfigured, the zone will - come back. To remove it permanently, it must also be - removed from named.conf + If the first argument is "-", then the output is + returned via the rndc response channel + and printed to the standard output. + Otherwise, it is written to the secroots dump file, which + defaults to named.secroots, but can be + overridden via the option in + named.conf. + + + See also rndc managed-keys. @@ -826,6 +683,38 @@ Print the configuration of a running zone. + + See also rndc zonestatus. + + + + + + sign zone class view + + + Fetch all DNSSEC keys for the given zone + from the key directory (see the + key-directory option in + the BIND 9 Administrator Reference Manual). If they are within + their publication period, merge them into the + zone's DNSKEY RRset. If the DNSKEY RRset + is changed, then the zone is automatically + re-signed with the new key set. + + + This command requires that the + auto-dnssec zone option be set + to allow or + maintain, + and also requires the zone to be configured to + allow dynamic DNS. + (See "Dynamic Update Policies" in the Administrator + Reference Manual for more details.) + + + See also rndc loadkeys. + @@ -901,6 +790,158 @@ + + + stats + + + Write server statistics to the statistics file. + (See the statistics-file option in + the BIND 9 Administrator Reference Manual.) + + + + + + status + + + Display status of the server. + Note that the number of zones includes the internal bind/CH zone + and the default ./IN + hint zone if there is not an + explicit root zone configured. + + + + + + stop -p + + + Stop the server, making sure any recent changes + made through dynamic update or IXFR are first saved to + the master files of the updated zones. + If is specified named's process id is returned. + This allows an external process to determine when named + had completed stopping. + + See also rndc halt. + + + + + sync -clean zone class view + + + Sync changes in the journal file for a dynamic zone + to the master file. If the "-clean" option is + specified, the journal file is also removed. If + no zone is specified, then all zones are synced. + + + + + + thaw zone class view + + + Enable updates to a frozen dynamic zone. If no + zone is specified, then all frozen zones are + enabled. This causes the server to reload the zone + from disk, and re-enables dynamic updates after the + load has completed. After a zone is thawed, + dynamic updates will no longer be refused. If + the zone has changed and the + ixfr-from-differences option is + in use, then the journal file will be updated to + reflect changes in the zone. Otherwise, if the + zone has changed, any existing journal file will be + removed. + + See also rndc freeze. + + + + + trace + + + Increment the servers debugging level by one. + + + + + + trace level + + + Sets the server's debugging level to an explicit + value. + + + See also rndc notrace. + + + + + + tsig-delete keyname view + + + Delete a given TKEY-negotiated key from the server. + (This does not apply to statically configured TSIG + keys.) + + + + + + tsig-list + + + List the names of all TSIG keys currently configured + for use by named in each view. The + list both statically configured keys and dynamic + TKEY-negotiated keys. + + + + + + validation ( on | off | check ) view ... + + + Enable, disable, or check the current status of + DNSSEC validation. + Note dnssec-enable also needs to be + set to yes or + auto to be effective. + It defaults to enabled. + + + + + + zonestatus zone class view + + + Displays the current status of the given zone, + including the master file name and any include + files from which it was loaded, when it was most + recently loaded, the current serial number, the + number of nodes, whether the zone supports + dynamic updates, whether the zone is DNSSEC + signed, whether it uses automatic DNSSEC key + management or inline signing, and the scheduled + refresh or expiry times for the zone. + + + See also rndc showzone. + + + +