From 89d5bbe28a0221f960f7b82d58c55b28acacd864 Mon Sep 17 00:00:00 2001 From: Pieter Lexis Date: Fri, 1 Dec 2017 11:35:46 +0100 Subject: [PATCH] docs: Fix the Authoritative Server manpages' intro Also set the name to PowerDNS Authoritative Server. --- docs/conf.py | 28 ++++++++++++++++++++++++++-- docs/manpages/calidns.1.rst | 2 -- docs/manpages/dnsbulktest.1.rst | 2 -- docs/manpages/dnsgram.1.rst | 2 -- docs/manpages/dnspcap2protobuf.1.rst | 3 --- docs/manpages/dnsreplay.1.rst | 2 -- docs/manpages/dnsscan.1.rst | 2 -- docs/manpages/dnsscope.1.rst | 2 -- docs/manpages/dnstcpbench.1.rst | 2 -- docs/manpages/dnswasher.1.rst | 2 -- docs/manpages/dumresp.1.rst | 2 -- docs/manpages/ixplore.1.rst | 2 -- docs/manpages/nsec3dig.1.rst | 2 -- docs/manpages/pdns_control.1.rst | 2 -- docs/manpages/pdns_notify.1.rst | 2 -- docs/manpages/pdns_server.1.rst | 2 -- docs/manpages/pdnsutil.1.rst | 2 -- docs/manpages/saxfr.1.rst | 2 -- docs/manpages/sdig.1.rst | 2 -- docs/manpages/zone2json.1.rst | 2 -- docs/manpages/zone2ldap.1.rst | 2 -- docs/manpages/zone2sql.1.rst | 2 -- 22 files changed, 26 insertions(+), 45 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 4655bd470..ca7be80a8 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -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 ------------------------------------------- diff --git a/docs/manpages/calidns.1.rst b/docs/manpages/calidns.1.rst index f2f27b027..e43a83268 100644 --- a/docs/manpages/calidns.1.rst +++ b/docs/manpages/calidns.1.rst @@ -1,8 +1,6 @@ calidns ======= -:program:`calidns` - A DNS recursor testing tool - Synopsis -------- diff --git a/docs/manpages/dnsbulktest.1.rst b/docs/manpages/dnsbulktest.1.rst index cd24568bd..fce6b236b 100644 --- a/docs/manpages/dnsbulktest.1.rst +++ b/docs/manpages/dnsbulktest.1.rst @@ -1,8 +1,6 @@ dnsbulktest =========== -:program:`dnsbulktest` - A debugging tool for intermittent resolver failures - Synopsis -------- diff --git a/docs/manpages/dnsgram.1.rst b/docs/manpages/dnsgram.1.rst index 1118e766b..2a568215f 100644 --- a/docs/manpages/dnsgram.1.rst +++ b/docs/manpages/dnsgram.1.rst @@ -1,8 +1,6 @@ dnsgram ======= -:program:`dnsgram` - A debugging tool for intermittent resolver failures - Synopsis -------- diff --git a/docs/manpages/dnspcap2protobuf.1.rst b/docs/manpages/dnspcap2protobuf.1.rst index 269bb4f73..150a2adea 100644 --- a/docs/manpages/dnspcap2protobuf.1.rst +++ b/docs/manpages/dnspcap2protobuf.1.rst @@ -1,9 +1,6 @@ dnspcap2protobuf ================ -:program:`dnspcap2protobuf` - A tool to convert PCAPs of DNS traffic to -PowerDNS Protobuf - Synopsis -------- diff --git a/docs/manpages/dnsreplay.1.rst b/docs/manpages/dnsreplay.1.rst index 00cefa6b7..76367df92 100644 --- a/docs/manpages/dnsreplay.1.rst +++ b/docs/manpages/dnsreplay.1.rst @@ -1,8 +1,6 @@ dnsreplay ========= -:program:`dnsreplay` - A PowerDNS nameserver debugging tool - Synopsis -------- diff --git a/docs/manpages/dnsscan.1.rst b/docs/manpages/dnsscan.1.rst index 1c6451cb9..4a022b912 100644 --- a/docs/manpages/dnsscan.1.rst +++ b/docs/manpages/dnsscan.1.rst @@ -1,8 +1,6 @@ dnsscan ======= -:program:`dnsscan` - List the amount of queries per qtype in a pcap - Synopsis -------- diff --git a/docs/manpages/dnsscope.1.rst b/docs/manpages/dnsscope.1.rst index e9c34e183..aa96e845d 100644 --- a/docs/manpages/dnsscope.1.rst +++ b/docs/manpages/dnsscope.1.rst @@ -1,8 +1,6 @@ dnsscope ======== -:program:`dnsscope` - A PowerDNS nameserver debugging tool - Synopsis -------- diff --git a/docs/manpages/dnstcpbench.1.rst b/docs/manpages/dnstcpbench.1.rst index 39032fa4e..c5b18f237 100644 --- a/docs/manpages/dnstcpbench.1.rst +++ b/docs/manpages/dnstcpbench.1.rst @@ -1,8 +1,6 @@ dnstcpbench =========== -:program:`dnstcpbench` - tool to perform TCP benchmarking of nameservers - Synopsis -------- diff --git a/docs/manpages/dnswasher.1.rst b/docs/manpages/dnswasher.1.rst index 6be7e7412..46f5de42d 100644 --- a/docs/manpages/dnswasher.1.rst +++ b/docs/manpages/dnswasher.1.rst @@ -1,8 +1,6 @@ dnswasher ========= -:program:`dnswasher` - A PowerDNS nameserver debugging tool - Synopsis -------- diff --git a/docs/manpages/dumresp.1.rst b/docs/manpages/dumresp.1.rst index ff65b6e03..510d33828 100644 --- a/docs/manpages/dumresp.1.rst +++ b/docs/manpages/dumresp.1.rst @@ -1,8 +1,6 @@ dumresp ======= -:program:`dumresp` - A dumb DNS responder - Synopsis -------- diff --git a/docs/manpages/ixplore.1.rst b/docs/manpages/ixplore.1.rst index 64305a42a..1fb08b2f6 100644 --- a/docs/manpages/ixplore.1.rst +++ b/docs/manpages/ixplore.1.rst @@ -1,8 +1,6 @@ ixplore ======= -:program:`ixplore` - A tool that provides insights into IXFRs - Synopsis -------- diff --git a/docs/manpages/nsec3dig.1.rst b/docs/manpages/nsec3dig.1.rst index 737a9923e..12c7bb810 100644 --- a/docs/manpages/nsec3dig.1.rst +++ b/docs/manpages/nsec3dig.1.rst @@ -1,8 +1,6 @@ nsec3dig ======== -:program:`nsec3dig` - Show and validate NSEC3 proofs - Synopsis -------- diff --git a/docs/manpages/pdns_control.1.rst b/docs/manpages/pdns_control.1.rst index 95f833342..0bac0c949 100644 --- a/docs/manpages/pdns_control.1.rst +++ b/docs/manpages/pdns_control.1.rst @@ -1,8 +1,6 @@ pdns_control ============ -:program:`pdns_control` - Control the PowerDNS nameserver - Synopsis -------- diff --git a/docs/manpages/pdns_notify.1.rst b/docs/manpages/pdns_notify.1.rst index 7ecc6bcfa..220b9aa28 100644 --- a/docs/manpages/pdns_notify.1.rst +++ b/docs/manpages/pdns_notify.1.rst @@ -1,8 +1,6 @@ pdns_notify =========== -:program:`pdns_notify` - A simple DNS NOTIFY sender - Synopsis -------- diff --git a/docs/manpages/pdns_server.1.rst b/docs/manpages/pdns_server.1.rst index 11133dc8e..4f0ea24c1 100644 --- a/docs/manpages/pdns_server.1.rst +++ b/docs/manpages/pdns_server.1.rst @@ -1,8 +1,6 @@ pdns_server =========== -:program:`pdns_server` - The PowerDNS Authoritative Namserver - Synopsis -------- diff --git a/docs/manpages/pdnsutil.1.rst b/docs/manpages/pdnsutil.1.rst index 6008071af..132de940d 100644 --- a/docs/manpages/pdnsutil.1.rst +++ b/docs/manpages/pdnsutil.1.rst @@ -1,8 +1,6 @@ pdnsutil ======== -pdnsutil - PowerDNS dnssec command and control - Synopsis -------- diff --git a/docs/manpages/saxfr.1.rst b/docs/manpages/saxfr.1.rst index aaba5d21f..00ae38164 100644 --- a/docs/manpages/saxfr.1.rst +++ b/docs/manpages/saxfr.1.rst @@ -1,8 +1,6 @@ saxfr ===== -:program:`saxfr` - Perform AXFRs and show information about it - Synopsis -------- diff --git a/docs/manpages/sdig.1.rst b/docs/manpages/sdig.1.rst index 6d91f32fd..fc19e119b 100644 --- a/docs/manpages/sdig.1.rst +++ b/docs/manpages/sdig.1.rst @@ -1,8 +1,6 @@ sdig ==== -:program:`sdig` - Perform a DNS query and show the results - Synopsis -------- diff --git a/docs/manpages/zone2json.1.rst b/docs/manpages/zone2json.1.rst index c98a4852d..8748435a1 100644 --- a/docs/manpages/zone2json.1.rst +++ b/docs/manpages/zone2json.1.rst @@ -1,8 +1,6 @@ zone2json ========= -:program:`zone2json` - convert BIND zones to JSON - Synopsis -------- diff --git a/docs/manpages/zone2ldap.1.rst b/docs/manpages/zone2ldap.1.rst index 477e4d926..369ab8da8 100644 --- a/docs/manpages/zone2ldap.1.rst +++ b/docs/manpages/zone2ldap.1.rst @@ -1,8 +1,6 @@ zone2ldap ========= -:program:`zone2ldap` - convert zonefiles to ldif - Synopsis -------- diff --git a/docs/manpages/zone2sql.1.rst b/docs/manpages/zone2sql.1.rst index ebc938522..cdd8cf06b 100644 --- a/docs/manpages/zone2sql.1.rst +++ b/docs/manpages/zone2sql.1.rst @@ -1,8 +1,6 @@ zone2sql ======== -:program:`zone2sql` - convert BIND zones to SQL - Synopsis -------- -- 2.40.0