From: Pieter Lexis Date: Wed, 17 Dec 2014 19:01:14 +0000 (+0100) Subject: Remove unused classes from docs X-Git-Tag: rec-3.7.0-rc1~109^2~5^2 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=3c4f5b873bf495ade9b62dd6a97a73b62e9dd781;p=pdns Remove unused classes from docs --- diff --git a/pdns/docs/markdown/appendix/backend-writers-guide.md b/pdns/docs/markdown/appendix/backend-writers-guide.md index 18f55508b..4aacc300f 100644 --- a/pdns/docs/markdown/appendix/backend-writers-guide.md +++ b/pdns/docs/markdown/appendix/backend-writers-guide.md @@ -458,7 +458,7 @@ This method should remove all the records with `qname` of type `qt`. `qt` might # DNS update support To make your backend DNS update compatible, it needs to implement a number of new functions and functions already used for slave-operation. The new functions are not DNS update specific and might be used for other update/remove functionality at a later stage. -``` {.programlisting} +``` class DNSBackend { public: /* ... */ @@ -487,7 +487,7 @@ See [Read/write slave-capable backends](#read-write-slave-capable-backends). Ple virtual bool listSubZone(const string &name, int domain\_id); This method is needed for rectification of a zone after NS-records have been added. For DNSSEC, we need to know which records are below the currently added record. `listSubZone()` is used like `list()` which means PowerDNS will call `get()` after this method. The default SQL query looks something like this: -``` {.programlisting} +``` // First %s is 'sub.zone.com', second %s is '*.sub.zone.com' select content,ttl,prio,type,domain_id,name from records where (name='%s' OR name like '%s') and domain_id=%d ``` diff --git a/pdns/docs/markdown/authoritative/backend-pipe.md b/pdns/docs/markdown/authoritative/backend-pipe.md index cb010d1f5..43b32290c 100644 --- a/pdns/docs/markdown/authoritative/backend-pipe.md +++ b/pdns/docs/markdown/authoritative/backend-pipe.md @@ -162,7 +162,7 @@ This is a typical zone transfer. For abi-version 3, DATA-responses get two extra fields: -``` {.screen} +``` DATA scopebits auth qname qclass qtype ttl id content ``` diff --git a/pdns/docs/markdown/authoritative/dnsupdate.md b/pdns/docs/markdown/authoritative/dnsupdate.md index 07a9ddd38..8bb7af5d7 100644 --- a/pdns/docs/markdown/authoritative/dnsupdate.md +++ b/pdns/docs/markdown/authoritative/dnsupdate.md @@ -37,7 +37,7 @@ For permissions, a number of per zone settings are available via the domain meta ## ALLOW-DNSUPDATE-FROM This setting has the same function as described in the configuration options (See [above](#configuration-options)). Only one item is allowed per row, but multiple rows can be added. An example: -``` {.programlisting} +``` sql> select id from domains where name='example.org'; 5 sql> insert into domainmetadata(domain_id, kind, content) values(5, ‘ALLOW-DNSUPDATE-FROM’,’198.51.100.0/8’); @@ -49,7 +49,7 @@ This will allow 198.51.100.0/8 and 203.0.113.2/32 to send DNS update messages fo ## TSIG-ALLOW-DNSUPDATE This setting allows you to set the TSIG key required to do an DNS update. An example: -``` {.programlisting} +``` sql> insert into tsigkeys (name, algorithm, secret) values ('test', 'hmac-md5', 'kp4/24gyYsEzbuTVJRUMoqGFmN3LYgVDzJ/3oRSP7ys='); sql> select id from domains where name='example.org'; 5 @@ -58,7 +58,7 @@ sql> insert into domainmetadata (domain_id, kind, content) values (5, 'TSIG-ALLO An example of how to use a TSIG key with the **nsupdate** command: -``` {.programlisting} +``` nsupdate < zone example.org @@ -73,7 +73,7 @@ If a TSIG key is set for the domain, it is required to be used for the update. T ## FORWARD-DNSUPDATE See [Section 1, “Configuration options”](dnsupdate.html#dnsupdate-configuration "1. Configuration options") for what it does, but per domain. -``` {.programlisting} +``` sql> select id from domains where name='example.org'; 5 sql> insert into domainmetadata(domain_id, kind, content) values(5, ‘FORWARD-DNSUPDATE’,’’); @@ -93,7 +93,7 @@ RFC2136 (Section 3.6) defines some specific behaviour for updates of SOA records An example: -``` {.programlisting} +``` sql> select id from domains where name='example.org'; 5 sql> insert into domainmetadata(domain_id, kind, content) values(5, ‘SOA-EDIT-DNSUPDATE’,’INCREASE’); @@ -116,13 +116,13 @@ DNS update is often used with DHCP to automatically provide a hostname whenever ## Setting up dhcpd We're going to use a TSIG key for security. We're going to generate a key using the following command: -``` {.programlisting} +``` dnssec-keygen -a hmac-md5 -b 128 -n USER dhcpdupdate ``` This generates two files (Kdhcpdupdate.\*.key and Kdhcpdupdate.\*.private). You're interested in the .key file: -``` {.programlisting} +``` # ls -l Kdhcp* -rw------- 1 root root 53 Aug 26 19:29 Kdhcpdupdate.+157+20493.key -rw------- 1 root root 165 Aug 26 19:29 Kdhcpdupdate.+157+20493.private @@ -135,7 +135,7 @@ The important bits are the name of the key (**dhcpdupdate**) and the hash of the Using the details from the key you've just generated. Add the following to your dhcpd.conf: -``` {.programlisting} +``` key "dhcpdupdate" { algorithm hmac-md5; secret "FYhvwsW1ZtFZqWzsMpqhbg=="; @@ -144,7 +144,7 @@ key "dhcpdupdate" { You must also tell dhcpd that you want dynamic dns to work, add the following section: -``` {.programlisting} +``` ddns-updates on; ddns-update-style interim; update-static-leases on; @@ -160,7 +160,7 @@ For more information on this, consult the dhcpd.conf manual. Per subnet, you also have to tell **dhcpd** which (reverse-)domain it should update and on which master domain server it is running. -``` {.programlisting} +``` ddns-domainname "example.org"; ddns-rev-domainname "in-addr.arpa."; @@ -189,7 +189,7 @@ A number of small changes are needed to powerdns to make it accept dynamic updat Enabled DNS update (RFC2136) support functionality in PowerDNS by adding the following to the PowerDNS configuration file (pdns.conf). -``` {.programlisting} +``` experimental-dnsupdate=yes allow-dnsupdate-from= ``` @@ -201,7 +201,7 @@ This tells PowerDNS to: We just told powerdns (via the configuration file) that we accept updates from nobody via the [`allow-dnsupdate-from`](settings.md#allow-dnsupdate-from) parameter. That's not very useful, so we're going to give permissions per zone, via the domainmetadata table. -``` {.programlisting} +``` sql> select id from domains where name='example.org'; 5 sql> insert into domainmetadata(domain_id, kind, content) values(5, ‘ALLOW-DNSUPDATE-FROM’,’127.0.0.1’); @@ -211,7 +211,7 @@ This gives the ip '127.0.0.1' access to send update messages. Make sure you use Another thing we want to do, is add TSIG security. This can only be done via the domainmetadata table: -``` {.programlisting} +``` sql> insert into tsigkeys (name, algorithm, secret) values ('dhcpdupdate', 'hmac-md5', 'FYhvwsW1ZtFZqWzsMpqhbg=='); sql> select id from domains where name='example.org'; 5 diff --git a/pdns/docs/markdown/authoritative/domainmetadata.md b/pdns/docs/markdown/authoritative/domainmetadata.md index bb7b09239..85827cfce 100644 --- a/pdns/docs/markdown/authoritative/domainmetadata.md +++ b/pdns/docs/markdown/authoritative/domainmetadata.md @@ -10,7 +10,7 @@ Each ACL row can list one subnet (v4 or v6), or the magical value 'AUTO-NS' that Example: -``` {.programlisting} +``` sql> select id from domains where name='example.com'; 7 sql> insert into domainmetadata (domain_id, kind, content) values (7,'ALLOW-AXFR-FROM','AUTO-NS'); diff --git a/pdns/docs/markdown/authoritative/internals.md b/pdns/docs/markdown/authoritative/internals.md index 3d437abab..4a7e8c9e1 100644 --- a/pdns/docs/markdown/authoritative/internals.md +++ b/pdns/docs/markdown/authoritative/internals.md @@ -133,7 +133,7 @@ The 'includeboilerplate(TLSA)' generates the four methods that do everything Pow The [actual parsing code](http://wiki.powerdns.com/trac/browser/trunk/pdns/pdns/dnsrecords.cc?rev=2638#L226): -``` {.screen} +``` boilerplate_conv(TLSA, 52, conv.xfr8BitInt(d_certusage); conv.xfr8BitInt(d_selector); diff --git a/pdns/docs/markdown/authoritative/modes-of-operation.md b/pdns/docs/markdown/authoritative/modes-of-operation.md index 2dfbee0f2..ceca9bcf4 100644 --- a/pdns/docs/markdown/authoritative/modes-of-operation.md +++ b/pdns/docs/markdown/authoritative/modes-of-operation.md @@ -131,7 +131,7 @@ To actually provision a named secret permission to AXFR a zone, set a metadata i As an example: -``` {.programlisting} +``` sql> insert into tsigkeys (name, algorithm, secret) values ('test', 'hmac-md5', 'kp4/24gyYsEzbuTVJRUMoqGFmN3LYgVDzJ/3oRSP7ys='); sql> select id from domains where name='powerdnssec.org'; 5 @@ -142,7 +142,7 @@ $ dig -t axfr powerdnssec.org @127.0.0.1 -y 'test:kp4/24gyYsEzbuTVJRUMoqGFmN3LYg To ease interoperability, the equivalent configuration above in BIND would look like this: -``` {.programlisting} +``` key test. { algorithm hmac-md5; secret "kp4/24gyYsEzbuTVJRUMoqGFmN3LYgVDzJ/3oRSP7ys="; @@ -164,7 +164,7 @@ The actual TSIG key must also be provisioned, as outlined in the previous sectio For the popular Generic SQL backends, configuring the use of TSIG for AXFR requests could be achieved as follows: -``` {.programlisting} +``` sql> insert into tsigkeys (name, algorithm, secret) values ('test', 'hmac-md5', 'kp4/24gyYsEzbuTVJRUMoqGFmN3LYgVDzJ/3oRSP7ys='); sql> select id from domains where name='powerdnssec.org'; 5 @@ -175,7 +175,7 @@ This setup corresponds to the TSIG-ALLOW-AXFR access rule defined in the previou In the interest of interoperability, the configuration above is (not quite) similar to the following BIND statements: -``` {.programlisting} +``` key test. { algorithm hmac-md5; secret "kp4/24gyYsEzbuTVJRUMoqGFmN3LYgVDzJ/3oRSP7ys="; diff --git a/pdns/docs/markdown/recursor/running.md b/pdns/docs/markdown/recursor/running.md index 6fba5d182..2631f04e0 100644 --- a/pdns/docs/markdown/recursor/running.md +++ b/pdns/docs/markdown/recursor/running.md @@ -3,7 +3,7 @@ To control and query the PowerDNS recursor, the tool `rec_control` is provided. As a sample command, try: -``` {.screen} +``` # rec_control ping pong ```