]> git.ipfire.org Git - thirdparty/bind9.git/commitdiff
Add semantic markup for program names into manual pages
authorPetr Špaček <pspacek@isc.org>
Wed, 2 Mar 2022 15:36:34 +0000 (16:36 +0100)
committerPetr Špaček <pspacek@isc.org>
Mon, 14 Mar 2022 09:46:36 +0000 (10:46 +0100)
It allows to cross-reference options in man pages from other
documents using :option:`named -g` syntax.

30 files changed:
bin/check/named-checkconf.rst
bin/check/named-checkzone.rst
bin/check/named-compilezone.rst
bin/confgen/ddns-confgen.rst
bin/confgen/rndc-confgen.rst
bin/confgen/tsig-keygen.rst
bin/delv/delv.rst
bin/dig/dig.rst
bin/dig/host.rst
bin/dig/nslookup.rst
bin/dnssec/dnssec-cds.rst
bin/dnssec/dnssec-dsfromkey.rst
bin/dnssec/dnssec-importkey.rst
bin/dnssec/dnssec-keyfromlabel.rst
bin/dnssec/dnssec-keygen.rst
bin/dnssec/dnssec-revoke.rst
bin/dnssec/dnssec-settime.rst
bin/dnssec/dnssec-signzone.rst
bin/dnssec/dnssec-verify.rst
bin/named/named.rst
bin/nsupdate/nsupdate.rst
bin/rndc/rndc.conf.rst
bin/rndc/rndc.rst
bin/tools/arpaname.rst
bin/tools/dnstap-read.rst
bin/tools/mdig.rst
bin/tools/named-journalprint.rst
bin/tools/named-nzd2nzf.rst
bin/tools/named-rrchecker.rst
bin/tools/nsec3hash.rst

index 4bc2deada79527d15d3477d09c9cea1d482be7c2..2073db84e7eae6f3ebccf8f5bbdf31768b3e62cd 100644 (file)
@@ -11,6 +11,7 @@
 
 .. highlight: console
 
+.. program:: named-checkconf
 .. _man_named-checkconf:
 
 named-checkconf - named configuration file syntax checking tool
index 19b1d6a4cc63b453a8b17d59d6c2cbff84156bb5..5102f8675be4a5edd9e6db395ac8c79f5368bcf5 100644 (file)
@@ -13,6 +13,7 @@
 
 .. BEWARE: Do not forget to edit also named-compilezone.rst!
 
+.. program:: named-checkzone
 .. _man_named-checkzone:
 
 named-checkzone - zone file validation tool
index b638cd92fd896a27fdbadd3c7146e0bf31a61ea9..82dcb2bcff980bd1a3f3b8c8d548d09a4c1d84ec 100644 (file)
@@ -13,6 +13,7 @@
 
 .. BEWARE: Do not forget to edit also named-checkzone.rst!
 
+.. program:: named-compilezone
 .. _man_named-compilezone:
 
 named-compilezone - zone file converting tool
index 467dc82594a9968478c35a2999cc2c32fb150877..719628bc83d193e29e66a7229f5d85e4a95cae3b 100644 (file)
@@ -13,6 +13,7 @@
 
 .. BEWARE: Do not forget to edit also tsig-keygen.rst!
 
+.. program:: ddns-confgen
 .. _man_ddns-confgen:
 
 ddns-confgen - TSIG key generation tool
index e689000185a866bdbd2a33c183ed146e61129de6..eab7201c293b5d3f10aa29ad796837fea062e246 100644 (file)
@@ -11,6 +11,7 @@
 
 .. highlight: console
 
+.. program:: rndc-confgen
 .. _man_rndc-confgen:
 
 rndc-confgen - rndc key generation tool
index 3ff279ac0ba316a48bdb625b1221537cd99fe576..65582e2f0847252a7ec482ecbbc8bb3c3f425437 100644 (file)
@@ -13,6 +13,7 @@
 
 .. BEWARE: Do not forget to edit also ddns-confgen.rst!
 
+.. program:: tsig-keygen
 .. _man_tsig-keygen:
 
 tsig-keygen - TSIG key generation tool
index 6b2469b0f00ce9e5c78dd2414efa5d4c8ab9bcae..2e1669a78dcd1387d3c159b48ce88829477a0075 100644 (file)
@@ -11,6 +11,7 @@
 
 .. highlight: console
 
+.. program:: delv
 .. _man_delv:
 
 delv - DNS lookup and validation utility
index 9fd5eec7ae60683f45af1714ef28362f46cc1925..26d75046fabd325d8f4f79ee3274372c6204eb1e 100644 (file)
@@ -11,6 +11,7 @@
 
 .. highlight: console
 
+.. program:: dig
 .. _man_dig:
 
 dig - DNS lookup utility
index 27058eba75a5dd4dc6532505c5a0c8df0b082b5a..033c9214f3d9c63086d7c33a521400461c1dfa58 100644 (file)
@@ -11,6 +11,7 @@
 
 .. highlight: console
 
+.. program:: host
 .. _man_host:
 
 host - DNS lookup utility
index 2d1e12382830431e1360493f3a6cfcc26056dbaa..04cebd6a1754c1259b4f86b99c218b81486b81af 100644 (file)
@@ -11,6 +11,7 @@
 
 .. highlight: console
 
+.. program:: nslookup
 .. _man_nslookup:
 
 nslookup - query Internet name servers interactively
index df471daa460ccdf5a3272a0d6d36977494a3708c..f7d36fc514403ebbeaf8600f80cd693142250dcd 100644 (file)
@@ -11,6 +11,7 @@
 
 .. highlight: console
 
+.. program:: dnssec-cds
 .. _man_dnssec-cds:
 
 dnssec-cds - change DS records for a child zone based on CDS/CDNSKEY
index a9b010ebebcbb33f84e0e883b8c51be9a779fc8c..8f29a053431b24bb05b651cef113d956b9eb4651 100644 (file)
@@ -11,6 +11,7 @@
 
 .. highlight: console
 
+.. program:: dnssec-dsfromkey
 .. _man_dnssec-dsfromkey:
 
 dnssec-dsfromkey - DNSSEC DS RR generation tool
index 969791e13971f691fbee6a91e61ca46fd47f884d..093ca31eb3acd65bc5447ee1c5d531d4a9cfcce5 100644 (file)
@@ -11,6 +11,7 @@
 
 .. highlight: console
 
+.. program:: dnssec-importkey
 .. _man_dnssec-importkey:
 
 dnssec-importkey - import DNSKEY records from external systems so they can be managed
index 3f635e74d13246e0239e72ca87300d4012301630..668929f665d47a4f313076c2b083ebc7e495143d 100644 (file)
@@ -11,6 +11,7 @@
 
 .. highlight: console
 
+.. program:: dnssec-keyfromlabel
 .. _man_dnssec-keyfromlabel:
 
 dnssec-keyfromlabel - DNSSEC key generation tool
index 65f0beb09a8ba8e6475cc6a4e93d6c704dcf2162..536f6a67e614445a0bbab2b28aecaaea99973cee 100644 (file)
@@ -11,6 +11,7 @@
 
 .. highlight: console
 
+.. program:: dnssec-keygen
 .. _man_dnssec-keygen:
 
 dnssec-keygen: DNSSEC key generation tool
index 0d748f5b0a49169e55b1607b131cb81dd6c54c15..ef41812ee810b9438e7bee0a9df19287d5caf5a1 100644 (file)
@@ -11,6 +11,7 @@
 
 .. highlight: console
 
+.. program:: dnssec-revoke
 .. _man_dnssec-revoke:
 
 dnssec-revoke - set the REVOKED bit on a DNSSEC key
index e21e57acaeced8e9ea16c75de1010509df635606..f6a04f317ac58ed5057423f8b3949c8c290e58a2 100644 (file)
@@ -11,6 +11,7 @@
 
 .. highlight: console
 
+.. program:: dnssec-settime
 .. _man_dnssec-settime:
 
 dnssec-settime: set the key timing metadata for a DNSSEC key
index 4288acd496c4f5930ac4bad82fe0d35d24434297..6675f3d076b47bfbd524732fa1f3b933430973cc 100644 (file)
@@ -11,6 +11,7 @@
 
 .. highlight: console
 
+.. program:: dnssec-signzone
 .. _man_dnssec-signzone:
 
 dnssec-signzone - DNSSEC zone signing tool
index 5d8c7c0b56935a6bd31a295127bd7c4e9e8e17eb..c0806c6d6d9c8d3e982bbe3d6282fbf7b3e51734 100644 (file)
@@ -11,6 +11,7 @@
 
 .. highlight: console
 
+.. program:: dnssec-verify
 .. _man_dnssec-verify:
 
 dnssec-verify - DNSSEC zone verification tool
index b9cd8ed503a3dc17e91194b69bb203c5835e9928..43a04e2193ff53b6c6b44bd34b012e7938f8d0e6 100644 (file)
@@ -11,6 +11,7 @@
 
 .. highlight: console
 
+.. program:: named
 .. _man_named:
 
 named - Internet domain name server
index 1bd4cdedc8cc8ba69a21ba3edd9474abc430df58..7c033f8501a9efcb926b3e5e9e273cddbfe4b957 100644 (file)
@@ -9,8 +9,7 @@
 .. See the COPYRIGHT file distributed with this work for additional
 .. information regarding copyright ownership.
 
-.. highlight: console
-
+.. program:: nsupdate
 .. _man_nsupdate:
 
 nsupdate - dynamic DNS update utility
index b02e780351af7c953b425ef016255d0d9ce7d536..0824f71bcf46656003154dc3b01c70e1b4f1cb86 100644 (file)
@@ -11,6 +11,7 @@
 
 .. highlight: console
 
+.. program:: rndc.conf
 .. _man_rndc.conf:
 
 rndc.conf - rndc configuration file
index 0f76030534bd76b77a6a6c274f1f3c936e55d486..5b92f72478e992c3a2c0d0cfbee41f02c1b44e31 100644 (file)
@@ -11,6 +11,7 @@
 
 .. highlight: console
 
+.. program:: rndc
 .. _man_rndc:
 
 rndc - name server control utility
index c932f6e33f3795fc9a9bf57b4955e8dea577511c..ffe711f7322c699b589175f064d7f68b8eb5f02e 100644 (file)
@@ -11,6 +11,7 @@
 
 .. highlight: console
 
+.. program:: arpaname
 .. _man_arpaname:
 
 arpaname - translate IP addresses to the corresponding ARPA names
index dc04f4ec1c64cf29dfa58d8dc14d2a18a453fe1f..af726f3fee0f0f753312c88c938d83ebec5e53fc 100644 (file)
@@ -11,6 +11,7 @@
 
 .. highlight: console
 
+.. program:: dnstap-read
 .. _man_dnstap-read:
 
 dnstap-read - print dnstap data in human-readable form
index eb6fbdb45950ea5c7628c5c1aaad5f3a6977439f..fab3ee1f762abaa7b1730f18b5d1d1b261d37ecd 100644 (file)
@@ -11,6 +11,7 @@
 
 .. highlight: console
 
+.. program:: mdig
 .. _man_mdig:
 
 mdig - DNS pipelined lookup utility
index 1b9b057bd7d04151cca37b6e8569d3f51da82632..2fb08f5cacdc71b04e9f7e754f38de490e1f6270 100644 (file)
@@ -11,6 +11,7 @@
 
 .. highlight: console
 
+.. program:: named-journalprint
 .. _man_named-journalprint:
 
 named-journalprint - print zone journal in human-readable form
index 634cc8556105111c9c092f68cc8bdca956caf4b2..2562d1c11676448de746f99e067f74f3646d6736 100644 (file)
@@ -11,6 +11,7 @@
 
 .. highlight: console
 
+.. program:: named-nzd2nzf
 .. _man_named-nzd2nzf:
 
 named-nzd2nzf - convert an NZD database to NZF text format
index 7ea9c39de8c45e6d2a4624dcdd3dafc5ea099756..84ab38809328f3373f27c86eb99a7098bf8052e3 100644 (file)
@@ -11,6 +11,7 @@
 
 .. highlight: console
 
+.. program:: named-rrchecker
 .. _man_named-rrchecker:
 
 named-rrchecker - syntax checker for individual DNS resource records
index 9facfc773e5d3a826d1ee1686bef97323c49c254..58550e1b2540358f41a3df0de44105fe09f4e334 100644 (file)
@@ -11,6 +11,7 @@
 
 .. highlight: console
 
+.. program:: nsec3hash
 .. _man_nsec3hash:
 
 nsec3hash - generate NSEC3 hash