From: Petr Špaček Date: Wed, 2 Mar 2022 15:36:34 +0000 (+0100) Subject: Add semantic markup for program names into manual pages X-Git-Tag: v9.19.0~66^2~9 X-Git-Url: http://git.ipfire.org/gitweb/?a=commitdiff_plain;h=8537878c01307bf1aa9532b68697a0b021f08e76;p=thirdparty%2Fbind9.git Add semantic markup for program names into manual pages It allows to cross-reference options in man pages from other documents using :option:`named -g` syntax. --- diff --git a/bin/check/named-checkconf.rst b/bin/check/named-checkconf.rst index 4bc2deada79..2073db84e7e 100644 --- a/bin/check/named-checkconf.rst +++ b/bin/check/named-checkconf.rst @@ -11,6 +11,7 @@ .. highlight: console +.. program:: named-checkconf .. _man_named-checkconf: named-checkconf - named configuration file syntax checking tool diff --git a/bin/check/named-checkzone.rst b/bin/check/named-checkzone.rst index 19b1d6a4cc6..5102f8675be 100644 --- a/bin/check/named-checkzone.rst +++ b/bin/check/named-checkzone.rst @@ -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 diff --git a/bin/check/named-compilezone.rst b/bin/check/named-compilezone.rst index b638cd92fd8..82dcb2bcff9 100644 --- a/bin/check/named-compilezone.rst +++ b/bin/check/named-compilezone.rst @@ -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 diff --git a/bin/confgen/ddns-confgen.rst b/bin/confgen/ddns-confgen.rst index 467dc82594a..719628bc83d 100644 --- a/bin/confgen/ddns-confgen.rst +++ b/bin/confgen/ddns-confgen.rst @@ -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 diff --git a/bin/confgen/rndc-confgen.rst b/bin/confgen/rndc-confgen.rst index e689000185a..eab7201c293 100644 --- a/bin/confgen/rndc-confgen.rst +++ b/bin/confgen/rndc-confgen.rst @@ -11,6 +11,7 @@ .. highlight: console +.. program:: rndc-confgen .. _man_rndc-confgen: rndc-confgen - rndc key generation tool diff --git a/bin/confgen/tsig-keygen.rst b/bin/confgen/tsig-keygen.rst index 3ff279ac0ba..65582e2f084 100644 --- a/bin/confgen/tsig-keygen.rst +++ b/bin/confgen/tsig-keygen.rst @@ -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 diff --git a/bin/delv/delv.rst b/bin/delv/delv.rst index 6b2469b0f00..2e1669a78dc 100644 --- a/bin/delv/delv.rst +++ b/bin/delv/delv.rst @@ -11,6 +11,7 @@ .. highlight: console +.. program:: delv .. _man_delv: delv - DNS lookup and validation utility diff --git a/bin/dig/dig.rst b/bin/dig/dig.rst index 9fd5eec7ae6..26d75046fab 100644 --- a/bin/dig/dig.rst +++ b/bin/dig/dig.rst @@ -11,6 +11,7 @@ .. highlight: console +.. program:: dig .. _man_dig: dig - DNS lookup utility diff --git a/bin/dig/host.rst b/bin/dig/host.rst index 27058eba75a..033c9214f3d 100644 --- a/bin/dig/host.rst +++ b/bin/dig/host.rst @@ -11,6 +11,7 @@ .. highlight: console +.. program:: host .. _man_host: host - DNS lookup utility diff --git a/bin/dig/nslookup.rst b/bin/dig/nslookup.rst index 2d1e1238283..04cebd6a175 100644 --- a/bin/dig/nslookup.rst +++ b/bin/dig/nslookup.rst @@ -11,6 +11,7 @@ .. highlight: console +.. program:: nslookup .. _man_nslookup: nslookup - query Internet name servers interactively diff --git a/bin/dnssec/dnssec-cds.rst b/bin/dnssec/dnssec-cds.rst index df471daa460..f7d36fc5144 100644 --- a/bin/dnssec/dnssec-cds.rst +++ b/bin/dnssec/dnssec-cds.rst @@ -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 diff --git a/bin/dnssec/dnssec-dsfromkey.rst b/bin/dnssec/dnssec-dsfromkey.rst index a9b010ebebc..8f29a053431 100644 --- a/bin/dnssec/dnssec-dsfromkey.rst +++ b/bin/dnssec/dnssec-dsfromkey.rst @@ -11,6 +11,7 @@ .. highlight: console +.. program:: dnssec-dsfromkey .. _man_dnssec-dsfromkey: dnssec-dsfromkey - DNSSEC DS RR generation tool diff --git a/bin/dnssec/dnssec-importkey.rst b/bin/dnssec/dnssec-importkey.rst index 969791e1397..093ca31eb3a 100644 --- a/bin/dnssec/dnssec-importkey.rst +++ b/bin/dnssec/dnssec-importkey.rst @@ -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 diff --git a/bin/dnssec/dnssec-keyfromlabel.rst b/bin/dnssec/dnssec-keyfromlabel.rst index 3f635e74d13..668929f665d 100644 --- a/bin/dnssec/dnssec-keyfromlabel.rst +++ b/bin/dnssec/dnssec-keyfromlabel.rst @@ -11,6 +11,7 @@ .. highlight: console +.. program:: dnssec-keyfromlabel .. _man_dnssec-keyfromlabel: dnssec-keyfromlabel - DNSSEC key generation tool diff --git a/bin/dnssec/dnssec-keygen.rst b/bin/dnssec/dnssec-keygen.rst index 65f0beb09a8..536f6a67e61 100644 --- a/bin/dnssec/dnssec-keygen.rst +++ b/bin/dnssec/dnssec-keygen.rst @@ -11,6 +11,7 @@ .. highlight: console +.. program:: dnssec-keygen .. _man_dnssec-keygen: dnssec-keygen: DNSSEC key generation tool diff --git a/bin/dnssec/dnssec-revoke.rst b/bin/dnssec/dnssec-revoke.rst index 0d748f5b0a4..ef41812ee81 100644 --- a/bin/dnssec/dnssec-revoke.rst +++ b/bin/dnssec/dnssec-revoke.rst @@ -11,6 +11,7 @@ .. highlight: console +.. program:: dnssec-revoke .. _man_dnssec-revoke: dnssec-revoke - set the REVOKED bit on a DNSSEC key diff --git a/bin/dnssec/dnssec-settime.rst b/bin/dnssec/dnssec-settime.rst index e21e57acaec..f6a04f317ac 100644 --- a/bin/dnssec/dnssec-settime.rst +++ b/bin/dnssec/dnssec-settime.rst @@ -11,6 +11,7 @@ .. highlight: console +.. program:: dnssec-settime .. _man_dnssec-settime: dnssec-settime: set the key timing metadata for a DNSSEC key diff --git a/bin/dnssec/dnssec-signzone.rst b/bin/dnssec/dnssec-signzone.rst index 4288acd496c..6675f3d076b 100644 --- a/bin/dnssec/dnssec-signzone.rst +++ b/bin/dnssec/dnssec-signzone.rst @@ -11,6 +11,7 @@ .. highlight: console +.. program:: dnssec-signzone .. _man_dnssec-signzone: dnssec-signzone - DNSSEC zone signing tool diff --git a/bin/dnssec/dnssec-verify.rst b/bin/dnssec/dnssec-verify.rst index 5d8c7c0b569..c0806c6d6d9 100644 --- a/bin/dnssec/dnssec-verify.rst +++ b/bin/dnssec/dnssec-verify.rst @@ -11,6 +11,7 @@ .. highlight: console +.. program:: dnssec-verify .. _man_dnssec-verify: dnssec-verify - DNSSEC zone verification tool diff --git a/bin/named/named.rst b/bin/named/named.rst index b9cd8ed503a..43a04e2193f 100644 --- a/bin/named/named.rst +++ b/bin/named/named.rst @@ -11,6 +11,7 @@ .. highlight: console +.. program:: named .. _man_named: named - Internet domain name server diff --git a/bin/nsupdate/nsupdate.rst b/bin/nsupdate/nsupdate.rst index 1bd4cdedc8c..7c033f8501a 100644 --- a/bin/nsupdate/nsupdate.rst +++ b/bin/nsupdate/nsupdate.rst @@ -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 diff --git a/bin/rndc/rndc.conf.rst b/bin/rndc/rndc.conf.rst index b02e780351a..0824f71bcf4 100644 --- a/bin/rndc/rndc.conf.rst +++ b/bin/rndc/rndc.conf.rst @@ -11,6 +11,7 @@ .. highlight: console +.. program:: rndc.conf .. _man_rndc.conf: rndc.conf - rndc configuration file diff --git a/bin/rndc/rndc.rst b/bin/rndc/rndc.rst index 0f76030534b..5b92f72478e 100644 --- a/bin/rndc/rndc.rst +++ b/bin/rndc/rndc.rst @@ -11,6 +11,7 @@ .. highlight: console +.. program:: rndc .. _man_rndc: rndc - name server control utility diff --git a/bin/tools/arpaname.rst b/bin/tools/arpaname.rst index c932f6e33f3..ffe711f7322 100644 --- a/bin/tools/arpaname.rst +++ b/bin/tools/arpaname.rst @@ -11,6 +11,7 @@ .. highlight: console +.. program:: arpaname .. _man_arpaname: arpaname - translate IP addresses to the corresponding ARPA names diff --git a/bin/tools/dnstap-read.rst b/bin/tools/dnstap-read.rst index dc04f4ec1c6..af726f3fee0 100644 --- a/bin/tools/dnstap-read.rst +++ b/bin/tools/dnstap-read.rst @@ -11,6 +11,7 @@ .. highlight: console +.. program:: dnstap-read .. _man_dnstap-read: dnstap-read - print dnstap data in human-readable form diff --git a/bin/tools/mdig.rst b/bin/tools/mdig.rst index eb6fbdb4595..fab3ee1f762 100644 --- a/bin/tools/mdig.rst +++ b/bin/tools/mdig.rst @@ -11,6 +11,7 @@ .. highlight: console +.. program:: mdig .. _man_mdig: mdig - DNS pipelined lookup utility diff --git a/bin/tools/named-journalprint.rst b/bin/tools/named-journalprint.rst index 1b9b057bd7d..2fb08f5cacd 100644 --- a/bin/tools/named-journalprint.rst +++ b/bin/tools/named-journalprint.rst @@ -11,6 +11,7 @@ .. highlight: console +.. program:: named-journalprint .. _man_named-journalprint: named-journalprint - print zone journal in human-readable form diff --git a/bin/tools/named-nzd2nzf.rst b/bin/tools/named-nzd2nzf.rst index 634cc855610..2562d1c1167 100644 --- a/bin/tools/named-nzd2nzf.rst +++ b/bin/tools/named-nzd2nzf.rst @@ -11,6 +11,7 @@ .. highlight: console +.. program:: named-nzd2nzf .. _man_named-nzd2nzf: named-nzd2nzf - convert an NZD database to NZF text format diff --git a/bin/tools/named-rrchecker.rst b/bin/tools/named-rrchecker.rst index 7ea9c39de8c..84ab3880932 100644 --- a/bin/tools/named-rrchecker.rst +++ b/bin/tools/named-rrchecker.rst @@ -11,6 +11,7 @@ .. highlight: console +.. program:: named-rrchecker .. _man_named-rrchecker: named-rrchecker - syntax checker for individual DNS resource records diff --git a/bin/tools/nsec3hash.rst b/bin/tools/nsec3hash.rst index 9facfc773e5..58550e1b254 100644 --- a/bin/tools/nsec3hash.rst +++ b/bin/tools/nsec3hash.rst @@ -11,6 +11,7 @@ .. highlight: console +.. program:: nsec3hash .. _man_nsec3hash: nsec3hash - generate NSEC3 hash