]> granicus.if.org Git - pdns/commitdiff
docs: Fix the Authoritative Server manpages' intro
authorPieter Lexis <pieter.lexis@powerdns.com>
Fri, 1 Dec 2017 10:35:46 +0000 (11:35 +0100)
committerPieter Lexis <pieter.lexis@powerdns.com>
Mon, 4 Dec 2017 14:20:20 +0000 (15:20 +0100)
Also set the name to PowerDNS Authoritative Server.

22 files changed:
docs/conf.py
docs/manpages/calidns.1.rst
docs/manpages/dnsbulktest.1.rst
docs/manpages/dnsgram.1.rst
docs/manpages/dnspcap2protobuf.1.rst
docs/manpages/dnsreplay.1.rst
docs/manpages/dnsscan.1.rst
docs/manpages/dnsscope.1.rst
docs/manpages/dnstcpbench.1.rst
docs/manpages/dnswasher.1.rst
docs/manpages/dumresp.1.rst
docs/manpages/ixplore.1.rst
docs/manpages/nsec3dig.1.rst
docs/manpages/pdns_control.1.rst
docs/manpages/pdns_notify.1.rst
docs/manpages/pdns_server.1.rst
docs/manpages/pdnsutil.1.rst
docs/manpages/saxfr.1.rst
docs/manpages/sdig.1.rst
docs/manpages/zone2json.1.rst
docs/manpages/zone2ldap.1.rst
docs/manpages/zone2sql.1.rst

index 4655bd470587696b0dca6bc25a8767ad68cb5f9d..ca7be80a8c52b6e9dd578778357158a0b84c21ea 100644 (file)
@@ -50,7 +50,7 @@ source_suffix = '.rst'
 master_doc = 'indexTOC'
 
 # General information about the project.
-project = 'PowerDNS Recursor'
+project = 'PowerDNS Authoritative Server'
 copyright = '2017, PowerDNS.COM BV'
 author = 'PowerDNS.COM BV'
 
@@ -166,11 +166,35 @@ latex_logo = 'common/powerdns-logo-500px.png'
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
+descriptions = {
+    'calidns': 'A DNS recursor testing tool',
+    'dnsbulktest': 'A debugging tool for intermittent resolver failures',
+    'dnsgram': 'A debugging tool for intermittent resolver failures',
+    'dnspcap2protobuf': 'A tool to convert PCAPs of DNS traffic to PowerDNS Protobuf',
+    'dnsreplay': 'A PowerDNS nameserver debugging tool',
+    'dnsscan': 'List the amount of queries per qtype in a pcap',
+    'dnsscope': 'A PowerDNS nameserver debugging tool',
+    'dnstcpbench': 'tool to perform TCP benchmarking of nameservers',
+    'dnswasher': 'A PowerDNS nameserver debugging tool',
+    'dumresp': 'A dumb DNS responder',
+    'ixplore': 'A tool that provides insights into IXFRs',
+    'nsec3dig': 'Show and validate NSEC3 proofs',
+    'pdns_control': 'Control the PowerDNS nameserver',
+    'pdns_notify': 'A simple DNS NOTIFY sender',
+    'pdns_server': 'The PowerDNS Authoritative Namserver',
+    'pdnsutil': 'PowerDNS record and DNSSEC command and control',
+    'saxfr': 'Perform AXFRs and show information about it',
+    'sdig': 'Perform a DNS query and show the results',
+    'zone2json': 'convert BIND zones to JSON',
+    'zone2ldap': 'convert zonefiles to ldif',
+    'zone2sql': 'convert BIND zones to SQL',
+}
 man_pages = []
 for f in glob.glob('manpages/*.1.rst'):
     srcname = '.'.join(f.split('.')[:-1])
     destname = srcname.split('/')[-1][:-2]
-    man_pages.append((srcname, destname, '', [author], 1))
+    man_pages.append((srcname, destname, descriptions.get(destname, ''),
+                      [author], 1))
 
 # -- Options for Texinfo output -------------------------------------------
 
index f2f27b027d73dd17c07d6b20161cf35e3a03c6f0..e43a83268690a2f5178cdcd12ba200421ec3c2c2 100644 (file)
@@ -1,8 +1,6 @@
 calidns
 =======
 
-:program:`calidns` - A DNS recursor testing tool
-
 Synopsis
 --------
 
index cd24568bdc00e11819d18a393c1fbdc9e2f6f497..fce6b236b69933ee22cea620082656c5afee837f 100644 (file)
@@ -1,8 +1,6 @@
 dnsbulktest
 ===========
 
-:program:`dnsbulktest` - A debugging tool for intermittent resolver failures
-
 Synopsis
 --------
 
index 1118e766b22c1f138c82f20c17294db5c46343d9..2a568215f195fef429086e7d4a815704907e2d07 100644 (file)
@@ -1,8 +1,6 @@
 dnsgram
 =======
 
-:program:`dnsgram` - A debugging tool for intermittent resolver failures
-
 Synopsis
 --------
 
index 269bb4f73423248906ea072b4373639bff17e069..150a2adea3d6e93688fa673318ec879afe88eff4 100644 (file)
@@ -1,9 +1,6 @@
 dnspcap2protobuf
 ================
 
-:program:`dnspcap2protobuf` - A tool to convert PCAPs of DNS traffic to
-PowerDNS Protobuf
-
 Synopsis
 --------
 
index 00cefa6b78fe171d7be6b9b92e37f8fd91b2d278..76367df92bc4b5b46846754ac40ccb00efb3ee1b 100644 (file)
@@ -1,8 +1,6 @@
 dnsreplay
 =========
 
-:program:`dnsreplay` - A PowerDNS nameserver debugging tool
-
 Synopsis
 --------
 
index 1c6451cb9165fb8094e9233a3a010de8639f9cca..4a022b912c626711c5f7dc8459fcaec65e416df6 100644 (file)
@@ -1,8 +1,6 @@
 dnsscan
 =======
 
-:program:`dnsscan` - List the amount of queries per qtype in a pcap
-
 Synopsis
 --------
 
index e9c34e18323c5ae7943058f262b22e0c0995c1c0..aa96e845dbe6d7fc666fb7efced17cfdd5caa154 100644 (file)
@@ -1,8 +1,6 @@
 dnsscope
 ========
 
-:program:`dnsscope` - A PowerDNS nameserver debugging tool
-
 Synopsis
 --------
 
index 39032fa4e130458c3111acf66c4ce7348f93ec79..c5b18f2371110fe3442d35519297884da6726c3e 100644 (file)
@@ -1,8 +1,6 @@
 dnstcpbench
 ===========
 
-:program:`dnstcpbench` - tool to perform TCP benchmarking of nameservers
-
 Synopsis
 --------
 
index 6be7e7412da072293803e3d7f146b7b382d958e7..46f5de42d818ab5cca86a28ad0fb15a241cb2cd4 100644 (file)
@@ -1,8 +1,6 @@
 dnswasher
 =========
 
-:program:`dnswasher` - A PowerDNS nameserver debugging tool
-
 Synopsis
 --------
 
index ff65b6e0364caac2322c4bf67b4af8d7299f7072..510d33828331db9d164ca2488b03a9ccf4591f5a 100644 (file)
@@ -1,8 +1,6 @@
 dumresp
 =======
 
-:program:`dumresp` - A dumb DNS responder
-
 Synopsis
 --------
 
index 64305a42a67bfb9888ad05d436828d3e62a995b3..1fb08b2f672013c52fbc7b59ba92551fe513de01 100644 (file)
@@ -1,8 +1,6 @@
 ixplore
 =======
 
-:program:`ixplore` - A tool that provides insights into IXFRs
-
 Synopsis
 --------
 
index 737a9923e4575cab9ba01d12983b0aaafc504e36..12c7bb810af7ae0c96b228643ced36f75cd24d2a 100644 (file)
@@ -1,8 +1,6 @@
 nsec3dig
 ========
 
-:program:`nsec3dig` - Show and validate NSEC3 proofs
-
 Synopsis
 --------
 
index 95f833342d4ea30a2e4c7bfaf51c18b9b51d7330..0bac0c9492b7ecd7b27bb2d3c35c6b7798d73ca4 100644 (file)
@@ -1,8 +1,6 @@
 pdns_control
 ============
 
-:program:`pdns_control` - Control the PowerDNS nameserver
-
 Synopsis
 --------
 
index 7ecc6bcfafe3c5ad8b82445c5a5f8eb76b050340..220b9aa286f5259cf4b6bf45d10ebac6f9a17ea2 100644 (file)
@@ -1,8 +1,6 @@
 pdns_notify
 ===========
 
-:program:`pdns_notify` - A simple DNS NOTIFY sender
-
 Synopsis
 --------
 
index 11133dc8e53150d89ebd5d3bd6bf00e77f2d66d2..4f0ea24c19eb3cfa6233210c2ca40c97c61d4333 100644 (file)
@@ -1,8 +1,6 @@
 pdns_server
 ===========
 
-:program:`pdns_server` - The PowerDNS Authoritative Namserver
-
 Synopsis
 --------
 
index 6008071af41f7d7d8cad31b8853fd03d400c1b97..132de940d9c555fea1192d0191d8123ca0bc359a 100644 (file)
@@ -1,8 +1,6 @@
 pdnsutil
 ========
 
-pdnsutil - PowerDNS dnssec command and control
-
 Synopsis
 --------
 
index aaba5d21fec254dd4c934f7a2efc4b4dc02b1e91..00ae38164aa91aaa29e11afb9e3c942aeffa244f 100644 (file)
@@ -1,8 +1,6 @@
 saxfr
 =====
 
-:program:`saxfr` - Perform AXFRs and show information about it
-
 Synopsis
 --------
 
index 6d91f32fdc4e83165a1542cd737a4c7943e79857..fc19e119b80ffa1012f61e18400e0428322bec8d 100644 (file)
@@ -1,8 +1,6 @@
 sdig
 ====
 
-:program:`sdig` - Perform a DNS query and show the results
-
 Synopsis
 --------
 
index c98a4852df8ccd427488549c6b0e8bc537f78fe0..8748435a187bc0f2a28f5935cb5cc0543dfaff98 100644 (file)
@@ -1,8 +1,6 @@
 zone2json
 =========
 
-:program:`zone2json` - convert BIND zones to JSON
-
 Synopsis
 --------
 
index 477e4d9267940c538a75da0617aba88990b77f13..369ab8da8ab18e0a7cce3adfb5ed500e6e824175 100644 (file)
@@ -1,8 +1,6 @@
 zone2ldap
 =========
 
-:program:`zone2ldap` - convert zonefiles to ldif
-
 Synopsis
 --------
 
index ebc938522d999364690f614d16b645d00c01e7fe..cdd8cf06bfa6badcdd525fac8321b0573d18a2af 100644 (file)
@@ -1,8 +1,6 @@
 zone2sql
 ========
 
-:program:`zone2sql` - convert BIND zones to SQL
-
 Synopsis
 --------