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.
2026-04-22 14:49:20 -04:00 · 2022-03-02 16:36:34 +01:00 · 2022-03-02 16:36:34 +01:00 · 8537878c01
commit 8537878c01
parent ec30944aa4
30 changed files with 30 additions and 2 deletions
--- 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
--- 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
--- 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
--- 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
--- 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
--- 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
--- 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
--- a/bin/dig/dig.rst
+++ b/bin/dig/dig.rst
@ -11,6 +11,7 @@

 .. highlight: console

+.. program:: dig
 .. _man_dig:

 dig - DNS lookup utility
--- a/bin/dig/host.rst
+++ b/bin/dig/host.rst
@ -11,6 +11,7 @@

 .. highlight: console

+.. program:: host
 .. _man_host:

 host - DNS lookup utility
--- 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
--- 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
--- 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
--- 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
--- 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
--- 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
--- 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
--- 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
--- 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
--- 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
--- 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
--- 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
--- 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
--- 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
--- 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
--- 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
--- 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
--- 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
--- 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
--- 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
--- a/bin/tools/nsec3hash.rst
+++ b/bin/tools/nsec3hash.rst
@ -11,6 +11,7 @@

 .. highlight: console

+.. program:: nsec3hash
 .. _man_nsec3hash:

 nsec3hash - generate NSEC3 hash