From: Petr Špaček Date: Fri, 4 Mar 2022 12:10:25 +0000 (+0100) Subject: Add internal hyperlinks to See Also section of manual pages X-Git-Tag: v9.19.0~66^2~1 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=1d4d008fc98ce819e07d27c6a3072cf9e474a47e;p=thirdparty%2Fbind9.git Add internal hyperlinks to See Also section of manual pages Replace :manpage: with :iscman: to generate internal hyperlinks. That way reader can use links even when offline, and jumps to man pages for the same version. Formerly HTML version of man pages did not have links in See Also section because :manpage: role in Sphinx can generate only external hyperlinks - and we do not have that enabled. Enabling the Sphinx :manpage: linking could reliably create hyperlinks only to external URLs, but that would take users to another version of docs. Generated by: find bin -name '*.rst' | xargs sed -i -e 's/:manpage:`\([^(]\+\)(\([0-9]\))`/:iscman:`\1(\2) <\1>`/g' + hand-edit to revert change for mmencode reference which is not provided in our source tree. --- diff --git a/bin/check/named-checkconf.rst b/bin/check/named-checkconf.rst index a09e8149feb..b3065a512a4 100644 --- a/bin/check/named-checkconf.rst +++ b/bin/check/named-checkconf.rst @@ -105,4 +105,4 @@ and 0 otherwise. See Also ~~~~~~~~ -:manpage:`named(8)`, :manpage:`named-checkzone(8)`, BIND 9 Administrator Reference Manual. +:iscman:`named(8) `, :iscman:`named-checkzone(8) `, BIND 9 Administrator Reference Manual. diff --git a/bin/check/named-checkzone.rst b/bin/check/named-checkzone.rst index 232d2734c0f..563752f476e 100644 --- a/bin/check/named-checkzone.rst +++ b/bin/check/named-checkzone.rst @@ -218,5 +218,5 @@ and 0 otherwise. See Also ~~~~~~~~ -:manpage:`named(8)`, :manpage:`named-checkconf(8)`, :manpage:`named-compilezone(8)`, -:rfc:`1035`, BIND 9 Administrator Reference Manual. +:iscman:`named(8) `, :iscman:`named-checkconf(8) `, :iscman:`named-compilezone(8) `, :rfc:`1035`, BIND 9 Administrator Reference +Manual. diff --git a/bin/check/named-compilezone.rst b/bin/check/named-compilezone.rst index be719150ca5..fa47f154c28 100644 --- a/bin/check/named-compilezone.rst +++ b/bin/check/named-compilezone.rst @@ -220,5 +220,5 @@ and 0 otherwise. See Also ~~~~~~~~ -:manpage:`named(8)`, :manpage:`named-checkconf(8)`, :manpage:`named-checkzone(8)`, -:rfc:`1035`, BIND 9 Administrator Reference Manual. +:iscman:`named(8) `, :iscman:`named-checkconf(8) `, :iscman:`named-checkzone(8) `, `:rfc:`1035`, +BIND 9 Administrator Reference Manual. diff --git a/bin/confgen/ddns-confgen.rst b/bin/confgen/ddns-confgen.rst index f4daccc0658..9dd9d5ef5f0 100644 --- a/bin/confgen/ddns-confgen.rst +++ b/bin/confgen/ddns-confgen.rst @@ -93,4 +93,4 @@ Options See Also ~~~~~~~~ -:manpage:`nsupdate(1)`, :manpage:`named.conf(5)`, :manpage:`named(8)`, BIND 9 Administrator Reference Manual. +:iscman:`nsupdate(1) `, :iscman:`named.conf(5) `, :iscman:`named(8) `, BIND 9 Administrator Reference Manual. diff --git a/bin/confgen/rndc-confgen.rst b/bin/confgen/rndc-confgen.rst index c32db065a23..0a91489c489 100644 --- a/bin/confgen/rndc-confgen.rst +++ b/bin/confgen/rndc-confgen.rst @@ -118,4 +118,4 @@ To print a sample :iscman:`rndc.conf` file and the corresponding ``controls`` an See Also ~~~~~~~~ -:manpage:`rndc(8)`, :manpage:`rndc.conf(5)`, :manpage:`named(8)`, BIND 9 Administrator Reference Manual. +:iscman:`rndc(8) `, :iscman:`rndc.conf(5) `, :iscman:`named(8) `, BIND 9 Administrator Reference Manual. diff --git a/bin/confgen/tsig-keygen.rst b/bin/confgen/tsig-keygen.rst index 4580ceb3e6a..7420bede434 100644 --- a/bin/confgen/tsig-keygen.rst +++ b/bin/confgen/tsig-keygen.rst @@ -51,4 +51,4 @@ Options See Also ~~~~~~~~ -:manpage:`nsupdate(1)`, :manpage:`named.conf(5)`, :manpage:`named(8)`, BIND 9 Administrator Reference Manual. +:iscman:`nsupdate(1) `, :iscman:`named.conf(5) `, :iscman:`named(8) `, BIND 9 Administrator Reference Manual. diff --git a/bin/delv/delv.rst b/bin/delv/delv.rst index f78ef4115d2..3d064485637 100644 --- a/bin/delv/delv.rst +++ b/bin/delv/delv.rst @@ -361,4 +361,4 @@ Files See Also ~~~~~~~~ -:manpage:`dig(1)`, :manpage:`named(8)`, :rfc:`4034`, :rfc:`4035`, :rfc:`4431`, :rfc:`5074`, :rfc:`5155`. +:iscman:`dig(1) `, :iscman:`named(8) `, :rfc:`4034`, :rfc:`4035`, :rfc:`4431`, :rfc:`5074`, :rfc:`5155`. diff --git a/bin/dig/dig.rst b/bin/dig/dig.rst index cbfdf857f45..07505b18dc4 100644 --- a/bin/dig/dig.rst +++ b/bin/dig/dig.rst @@ -769,7 +769,7 @@ Files See Also ~~~~~~~~ -:manpage:`delv(1)`, :manpage:`host(1)`, :manpage:`named(8)`, :manpage:`dnssec-keygen(8)`, :rfc:`1035`. +:iscman:`delv(1) `, :iscman:`host(1) `, :iscman:`named(8) `, :iscman:`dnssec-keygen(8) `, :rfc:`1035`. Bugs ~~~~ diff --git a/bin/dig/host.rst b/bin/dig/host.rst index bbc565253e4..2647d36a73c 100644 --- a/bin/dig/host.rst +++ b/bin/dig/host.rst @@ -190,4 +190,4 @@ Files See Also ~~~~~~~~ -:manpage:`dig(1)`, :manpage:`named(8)`. +:iscman:`dig(1) `, :iscman:`named(8) `. diff --git a/bin/dig/nslookup.rst b/bin/dig/nslookup.rst index 0462112ab44..2b92aa761bb 100644 --- a/bin/dig/nslookup.rst +++ b/bin/dig/nslookup.rst @@ -205,4 +205,4 @@ Files See Also ~~~~~~~~ -:manpage:`dig(1)`, :manpage:`host(1)`, :manpage:`named(8)`. +:iscman:`dig(1) `, :iscman:`host(1) `, :iscman:`named(8) `. diff --git a/bin/dnssec/dnssec-cds.rst b/bin/dnssec/dnssec-cds.rst index 69b652db092..09960e91d3c 100644 --- a/bin/dnssec/dnssec-cds.rst +++ b/bin/dnssec/dnssec-cds.rst @@ -217,5 +217,5 @@ protection time. See Also ~~~~~~~~ -:manpage:`dig(1)`, :manpage:`dnssec-settime(8)`, :manpage:`dnssec-signzone(8)`, :manpage:`nsupdate(1)`, BIND 9 Administrator +:iscman:`dig(1) `, :iscman:`dnssec-settime(8) `, :iscman:`dnssec-signzone(8) `, :iscman:`nsupdate(1) `, BIND 9 Administrator Reference Manual, :rfc:`7344`. diff --git a/bin/dnssec/dnssec-dsfromkey.rst b/bin/dnssec/dnssec-dsfromkey.rst index 2819b028f3e..9ca025a319d 100644 --- a/bin/dnssec/dnssec-dsfromkey.rst +++ b/bin/dnssec/dnssec-dsfromkey.rst @@ -154,6 +154,6 @@ A keyfile error may return "file not found," even if the file exists. See Also ~~~~~~~~ -:manpage:`dnssec-keygen(8)`, :manpage:`dnssec-signzone(8)`, BIND 9 Administrator Reference Manual, +:iscman:`dnssec-keygen(8) `, :iscman:`dnssec-signzone(8) `, BIND 9 Administrator Reference Manual, :rfc:`3658` (DS RRs), :rfc:`4509` (SHA-256 for DS RRs), :rfc:`6605` (SHA-384 for DS RRs), :rfc:`7344` (CDS and CDNSKEY RRs). diff --git a/bin/dnssec/dnssec-importkey.rst b/bin/dnssec/dnssec-importkey.rst index 73f011f615a..b8b70d13fdd 100644 --- a/bin/dnssec/dnssec-importkey.rst +++ b/bin/dnssec/dnssec-importkey.rst @@ -121,5 +121,5 @@ or the full file name ``Knnnn.+aaa+iiiii.key``, as generated by See Also ~~~~~~~~ -:manpage:`dnssec-keygen(8)`, :manpage:`dnssec-signzone(8)`, BIND 9 Administrator Reference Manual, +:iscman:`dnssec-keygen(8) `, :iscman:`dnssec-signzone(8) `, BIND 9 Administrator Reference Manual, :rfc:`5011`. diff --git a/bin/dnssec/dnssec-keyfromlabel.rst b/bin/dnssec/dnssec-keyfromlabel.rst index bbb26f1584f..c5d79ea612f 100644 --- a/bin/dnssec/dnssec-keyfromlabel.rst +++ b/bin/dnssec/dnssec-keyfromlabel.rst @@ -273,5 +273,5 @@ security reasons, this file does not have general read permission. See Also ~~~~~~~~ -:manpage:`dnssec-keygen(8)`, :manpage:`dnssec-signzone(8)`, BIND 9 Administrator Reference Manual, +:iscman:`dnssec-keygen(8) `, :iscman:`dnssec-signzone(8) `, BIND 9 Administrator Reference Manual, :rfc:`4034`, :rfc:`7512`. diff --git a/bin/dnssec/dnssec-keygen.rst b/bin/dnssec/dnssec-keygen.rst index 12b240bcc38..700149ffc8d 100644 --- a/bin/dnssec/dnssec-keygen.rst +++ b/bin/dnssec/dnssec-keygen.rst @@ -339,5 +339,5 @@ To generate a matching key-signing key, issue the command: See Also ~~~~~~~~ -:manpage:`dnssec-signzone(8)`, BIND 9 Administrator Reference Manual, :rfc:`2539`, +:iscman:`dnssec-signzone(8) `, BIND 9 Administrator Reference Manual, :rfc:`2539`, :rfc:`2845`, :rfc:`4034`. diff --git a/bin/dnssec/dnssec-revoke.rst b/bin/dnssec/dnssec-revoke.rst index 53aa8a9d0dd..052865fb7ce 100644 --- a/bin/dnssec/dnssec-revoke.rst +++ b/bin/dnssec/dnssec-revoke.rst @@ -75,4 +75,4 @@ Options See Also ~~~~~~~~ -:manpage:`dnssec-keygen(8)`, BIND 9 Administrator Reference Manual, :rfc:`5011`. +:iscman:`dnssec-keygen(8) `, BIND 9 Administrator Reference Manual, :rfc:`5011`. diff --git a/bin/dnssec/dnssec-settime.rst b/bin/dnssec/dnssec-settime.rst index 1f87049d70b..a71712ca04d 100644 --- a/bin/dnssec/dnssec-settime.rst +++ b/bin/dnssec/dnssec-settime.rst @@ -252,5 +252,5 @@ associated with a key. See Also ~~~~~~~~ -:manpage:`dnssec-keygen(8)`, :manpage:`dnssec-signzone(8)`, BIND 9 Administrator Reference Manual, +:iscman:`dnssec-keygen(8) `, :iscman:`dnssec-signzone(8) `, BIND 9 Administrator Reference Manual, :rfc:`5011`. diff --git a/bin/dnssec/dnssec-signzone.rst b/bin/dnssec/dnssec-signzone.rst index df84f98515b..244fc64d61c 100644 --- a/bin/dnssec/dnssec-signzone.rst +++ b/bin/dnssec/dnssec-signzone.rst @@ -423,5 +423,5 @@ The private keys are assumed to be in the current directory. See Also ~~~~~~~~ -:manpage:`dnssec-keygen(8)`, BIND 9 Administrator Reference Manual, :rfc:`4033`, +:iscman:`dnssec-keygen(8) `, BIND 9 Administrator Reference Manual, :rfc:`4033`, :rfc:`4641`. diff --git a/bin/dnssec/dnssec-verify.rst b/bin/dnssec/dnssec-verify.rst index cba858612d0..870089482b2 100644 --- a/bin/dnssec/dnssec-verify.rst +++ b/bin/dnssec/dnssec-verify.rst @@ -104,4 +104,4 @@ Options See Also ~~~~~~~~ -:manpage:`dnssec-signzone(8)`, BIND 9 Administrator Reference Manual, :rfc:`4033`. +:iscman:`dnssec-signzone(8) `, BIND 9 Administrator Reference Manual, :rfc:`4033`. diff --git a/bin/named/named.conf.rst b/bin/named/named.conf.rst index aeda5c9490a..3ce51e38ad9 100644 --- a/bin/named/named.conf.rst +++ b/bin/named/named.conf.rst @@ -904,5 +904,5 @@ Files See Also ~~~~~~~~ -:manpage:`named(8)`, :manpage:`named-checkconf(8)`, :manpage:`rndc(8)`, :manpage:`rndc-confgen(8)`, :manpage:`tsig-keygen(8)`, BIND 9 Administrator Reference Manual. +:iscman:`named(8) `, :iscman:`named-checkconf(8) `, :iscman:`rndc(8) `, :iscman:`rndc-confgen(8) `, :iscman:`tsig-keygen(8) `, BIND 9 Administrator Reference Manual. diff --git a/bin/named/named.rst b/bin/named/named.rst index f3557b01e44..21a82c4dbd3 100644 --- a/bin/named/named.rst +++ b/bin/named/named.rst @@ -238,4 +238,4 @@ Files See Also ~~~~~~~~ -:rfc:`1033`, :rfc:`1034`, :rfc:`1035`, :manpage:`named-checkconf(8)`, :manpage:`named-checkzone(8)`, :manpage:`rndc(8)`, :manpage:`named.conf(5)`, BIND 9 Administrator Reference Manual. +:rfc:`1033`, :rfc:`1034`, :rfc:`1035`, :iscman:`named-checkconf(8) `, :iscman:`named-checkzone(8) `, :iscman:`rndc(8) `, :iscman:`named.conf(5) `, BIND 9 Administrator Reference Manual. diff --git a/bin/nsupdate/nsupdate.rst b/bin/nsupdate/nsupdate.rst index 05fe3e4fe04..3d9425a5cb5 100644 --- a/bin/nsupdate/nsupdate.rst +++ b/bin/nsupdate/nsupdate.rst @@ -375,7 +375,7 @@ See Also ~~~~~~~~ :rfc:`2136`, :rfc:`3007`, :rfc:`2104`, :rfc:`2845`, :rfc:`1034`, :rfc:`2535`, :rfc:`2931`, -:manpage:`named(8)`, :manpage:`dnssec-keygen(8)`, :manpage:`tsig-keygen(8)`. +:iscman:`named(8) `, :iscman:`dnssec-keygen(8) `, :iscman:`tsig-keygen(8) `. Bugs ~~~~ diff --git a/bin/rndc/rndc.conf.rst b/bin/rndc/rndc.conf.rst index 7a63998e39f..20e6bc97a4b 100644 --- a/bin/rndc/rndc.conf.rst +++ b/bin/rndc/rndc.conf.rst @@ -155,4 +155,4 @@ details. See Also ~~~~~~~~ -:manpage:`rndc(8)`, :manpage:`rndc-confgen(8)`, :manpage:`mmencode(1)`, BIND 9 Administrator Reference Manual. +:iscman:`rndc(8) `, :iscman:`rndc-confgen(8) `, :manpage:`mmencode(1)`, BIND 9 Administrator Reference Manual. diff --git a/bin/rndc/rndc.rst b/bin/rndc/rndc.rst index c241d7ec48e..c5f2b29281c 100644 --- a/bin/rndc/rndc.rst +++ b/bin/rndc/rndc.rst @@ -646,6 +646,6 @@ Several error messages could be clearer. See Also ~~~~~~~~ -:manpage:`rndc.conf(5)`, :manpage:`rndc-confgen(8)`, -:manpage:`named(8)`, :manpage:`named.conf(5)`, BIND 9 Administrator +:iscman:`rndc.conf(5) `, :iscman:`rndc-confgen(8) `, +:iscman:`named(8) `, :iscman:`named.conf(5) `, BIND 9 Administrator Reference Manual. diff --git a/bin/tools/dnstap-read.rst b/bin/tools/dnstap-read.rst index 49dceab4338..a5956825fcd 100644 --- a/bin/tools/dnstap-read.rst +++ b/bin/tools/dnstap-read.rst @@ -55,4 +55,4 @@ Options See Also ~~~~~~~~ -:manpage:`named(8)`, :manpage:`rndc(8)`, BIND 9 Administrator Reference Manual. +:iscman:`named(8) `, :iscman:`rndc(8) `, BIND 9 Administrator Reference Manual. diff --git a/bin/tools/mdig.rst b/bin/tools/mdig.rst index ec9487bbfd1..a3e1c056bc2 100644 --- a/bin/tools/mdig.rst +++ b/bin/tools/mdig.rst @@ -373,4 +373,4 @@ The local query options are: See Also ~~~~~~~~ -:manpage:`dig(1)`, :rfc:`1035`. +:iscman:`dig(1) `, :rfc:`1035`. diff --git a/bin/tools/named-journalprint.rst b/bin/tools/named-journalprint.rst index 73cd69a2337..9d568018644 100644 --- a/bin/tools/named-journalprint.rst +++ b/bin/tools/named-journalprint.rst @@ -63,4 +63,4 @@ bug in that release.) Note that these options *must not* be used while See Also ~~~~~~~~ -:manpage:`named(8)`, :manpage:`nsupdate(1)`, BIND 9 Administrator Reference Manual. +:iscman:`named(8) `, :iscman:`nsupdate(1) `, BIND 9 Administrator Reference Manual. diff --git a/bin/tools/named-rrchecker.rst b/bin/tools/named-rrchecker.rst index 6b736c249c5..28da236b726 100644 --- a/bin/tools/named-rrchecker.rst +++ b/bin/tools/named-rrchecker.rst @@ -59,4 +59,4 @@ Options See Also ~~~~~~~~ -:rfc:`1034`, :rfc:`1035`, :manpage:`named(8)`. +:rfc:`1034`, :rfc:`1035`, :iscman:`named(8) `. diff --git a/doc/man/named-checkzone.1in b/doc/man/named-checkzone.1in index 0cd75f13ed6..4290c4760cc 100644 --- a/doc/man/named-checkzone.1in +++ b/doc/man/named-checkzone.1in @@ -246,8 +246,8 @@ This is the name of the zone file. and 0 otherwise. .SH SEE ALSO .sp -\fBnamed(8)\fP, \fBnamed\-checkconf(8)\fP, \fBnamed\-compilezone(8)\fP, -\fI\%RFC 1035\fP, BIND 9 Administrator Reference Manual. +\fBnamed(8)\fP, \fBnamed\-checkconf(8)\fP, \fBnamed\-compilezone(8)\fP, \fI\%RFC 1035\fP, BIND 9 Administrator Reference +Manual. .SH AUTHOR Internet Systems Consortium .SH COPYRIGHT diff --git a/doc/man/named-compilezone.1in b/doc/man/named-compilezone.1in index 8ae678cf5c7..16872ec748d 100644 --- a/doc/man/named-compilezone.1in +++ b/doc/man/named-compilezone.1in @@ -248,8 +248,8 @@ This is the name of the zone file. and 0 otherwise. .SH SEE ALSO .sp -\fBnamed(8)\fP, \fBnamed\-checkconf(8)\fP, \fBnamed\-checkzone(8)\fP, -\fI\%RFC 1035\fP, BIND 9 Administrator Reference Manual. +\fBnamed(8)\fP, \fBnamed\-checkconf(8)\fP, \fBnamed\-checkzone(8)\fP, \fI:rfc:\(ga1035\fP, +BIND 9 Administrator Reference Manual. .SH AUTHOR Internet Systems Consortium .SH COPYRIGHT diff --git a/doc/man/rndc.8in b/doc/man/rndc.8in index f23f8f06a60..619840268cd 100644 --- a/doc/man/rndc.8in +++ b/doc/man/rndc.8in @@ -35,8 +35,7 @@ rndc \- name server control utility \fBrndc\fP [\fB\-b\fP source\-address] [\fB\-c\fP config\-file] [\fB\-k\fP key\-file] [\fB\-s\fP server] [\fB\-p\fP port] [\fB\-q\fP] [\fB\-r\fP] [\fB\-V\fP] [\fB\-y\fP key_id] [[\fB\-4\fP] | [\fB\-6\fP]] {command} .SH DESCRIPTION .sp -\fBrndc\fP controls the operation of a name server; it supersedes the -\fBndc\fP utility. If \fBrndc\fP is +\fBrndc\fP controls the operation of a name server. If \fBrndc\fP is invoked with no command line options or arguments, it prints a short summary of the supported commands and the available options and their arguments. @@ -703,7 +702,7 @@ Several error messages could be clearer. .SH SEE ALSO .sp \fBrndc.conf(5)\fP, \fBrndc\-confgen(8)\fP, -\fBnamed(8)\fP, \fBnamed.conf(5)\fP, \fBndc(8)\fP, BIND 9 Administrator +\fBnamed(8)\fP, \fBnamed.conf(5)\fP, BIND 9 Administrator Reference Manual. .SH AUTHOR Internet Systems Consortium