]> git.ipfire.org Git - thirdparty/bind9.git/commitdiff
Add internal hyperlinks to See Also section of manual pages
authorPetr Špaček <pspacek@isc.org>
Fri, 4 Mar 2022 12:10:25 +0000 (13:10 +0100)
committerPetr Špaček <pspacek@isc.org>
Mon, 14 Mar 2022 09:46:36 +0000 (10:46 +0100)
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.

31 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.conf.rst
bin/named/named.rst
bin/nsupdate/nsupdate.rst
bin/rndc/rndc.conf.rst
bin/rndc/rndc.rst
bin/tools/dnstap-read.rst
bin/tools/mdig.rst
bin/tools/named-journalprint.rst
bin/tools/named-rrchecker.rst
doc/man/named-checkzone.1in
doc/man/named-compilezone.1in
doc/man/rndc.8in

index a09e8149feb071a226c6ec91e4bab688c63f2a61..b3065a512a42899091252159ff923ba7af1c8157 100644 (file)
@@ -105,4 +105,4 @@ and 0 otherwise.
 See Also
 ~~~~~~~~
 
-:manpage:`named(8)`, :manpage:`named-checkzone(8)`, BIND 9 Administrator Reference Manual.
+:iscman:`named(8) <named>`, :iscman:`named-checkzone(8) <named-checkzone>`, BIND 9 Administrator Reference Manual.
index 232d2734c0f599ffa4c385bcf49aebadcf8fcb64..563752f476e3f9bdd7314697aef9a433e3b63424 100644 (file)
@@ -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) <named>`, :iscman:`named-checkconf(8) <named-checkconf>`, :iscman:`named-compilezone(8) <named-compilezone>`, :rfc:`1035`, BIND 9 Administrator Reference
+Manual.
index be719150ca5e44c68a59cf231f1df0a6df072511..fa47f154c2870654154df1678b1c017e56aaadce 100644 (file)
@@ -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) <named>`, :iscman:`named-checkconf(8) <named-checkconf>`, :iscman:`named-checkzone(8) <named-checkzone>`, `:rfc:`1035`,
+BIND 9 Administrator Reference Manual.
index f4daccc06582f2a7000448db7f21d0c50d2103ec..9dd9d5ef5f09865b8b46df0cc1dd3e444976d767 100644 (file)
@@ -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) <nsupdate>`, :iscman:`named.conf(5) <named.conf>`, :iscman:`named(8) <named>`, BIND 9 Administrator Reference Manual.
index c32db065a23621de3938050375b2fd422c8ac8cc..0a91489c48923bcc09477e6845c31277dec1977a 100644 (file)
@@ -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) <rndc>`, :iscman:`rndc.conf(5) <rndc.conf>`, :iscman:`named(8) <named>`, BIND 9 Administrator Reference Manual.
index 4580ceb3e6a880b47001e7d613f621003df3c564..7420bede434e47b5c56ffef153b8d0383e13d93c 100644 (file)
@@ -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) <nsupdate>`, :iscman:`named.conf(5) <named.conf>`, :iscman:`named(8) <named>`, BIND 9 Administrator Reference Manual.
index f78ef4115d2f1b935a0fcd780eb0bf0afc7820ea..3d0644856379a1b199f47427e43d3e2a23c9cfd7 100644 (file)
@@ -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) <dig>`, :iscman:`named(8) <named>`, :rfc:`4034`, :rfc:`4035`, :rfc:`4431`, :rfc:`5074`, :rfc:`5155`.
index cbfdf857f4594c45846d630a87e000dcf2b02fcd..07505b18dc493c9f2a0d2fee7a86e13c9644e11c 100644 (file)
@@ -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) <delv>`, :iscman:`host(1) <host>`, :iscman:`named(8) <named>`, :iscman:`dnssec-keygen(8) <dnssec-keygen>`, :rfc:`1035`.
 
 Bugs
 ~~~~
index bbc565253e4ff52b23110bb9fed937378f549a37..2647d36a73c428dca7a7e2051d593b7e71d6a353 100644 (file)
@@ -190,4 +190,4 @@ Files
 See Also
 ~~~~~~~~
 
-:manpage:`dig(1)`, :manpage:`named(8)`.
+:iscman:`dig(1) <dig>`, :iscman:`named(8) <named>`.
index 0462112ab447b2ad64638cdeb980726cff100f45..2b92aa761bb9f8990d44f9358933a953af00376d 100644 (file)
@@ -205,4 +205,4 @@ Files
 See Also
 ~~~~~~~~
 
-:manpage:`dig(1)`, :manpage:`host(1)`, :manpage:`named(8)`.
+:iscman:`dig(1) <dig>`, :iscman:`host(1) <host>`, :iscman:`named(8) <named>`.
index 69b652db092b5ed03ad72045c467e44309268f83..09960e91d3c4f8164b2181f9aa9f8b72980159fa 100644 (file)
@@ -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) <dig>`, :iscman:`dnssec-settime(8) <dnssec-settime>`, :iscman:`dnssec-signzone(8) <dnssec-signzone>`, :iscman:`nsupdate(1) <nsupdate>`, BIND 9 Administrator
 Reference Manual, :rfc:`7344`.
index 2819b028f3e63d63200324ded434e0421fee1f8e..9ca025a319dd2254821b7d496eae9c263e943f6d 100644 (file)
@@ -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) <dnssec-keygen>`, :iscman:`dnssec-signzone(8) <dnssec-signzone>`, 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).
index 73f011f615a8edd5ff06c5eb2334f91e4b994242..b8b70d13fdd555bf058ed7caf7f2d97f2df598c9 100644 (file)
@@ -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) <dnssec-keygen>`, :iscman:`dnssec-signzone(8) <dnssec-signzone>`, BIND 9 Administrator Reference Manual,
 :rfc:`5011`.
index bbb26f1584ff400f1414205fa32a437a40dfa8e7..c5d79ea612f114dd100345a0ac5882f8890ba36f 100644 (file)
@@ -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) <dnssec-keygen>`, :iscman:`dnssec-signzone(8) <dnssec-signzone>`, BIND 9 Administrator Reference Manual,
 :rfc:`4034`, :rfc:`7512`.
index 12b240bcc389c21ed6dbd2ddf53ddb7add27b42a..700149ffc8d9f9ae5b7bea64543305af4e643b94 100644 (file)
@@ -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) <dnssec-signzone>`, BIND 9 Administrator Reference Manual, :rfc:`2539`,
 :rfc:`2845`, :rfc:`4034`.
index 53aa8a9d0dd4c7ed18860066075abea0792f93bf..052865fb7ced07fa0dcab819dcbe6d04de9c61dd 100644 (file)
@@ -75,4 +75,4 @@ Options
 See Also
 ~~~~~~~~
 
-:manpage:`dnssec-keygen(8)`, BIND 9 Administrator Reference Manual, :rfc:`5011`.
+:iscman:`dnssec-keygen(8) <dnssec-keygen>`, BIND 9 Administrator Reference Manual, :rfc:`5011`.
index 1f87049d70b9916e740011eccdd51deea8df8f49..a71712ca04d67901c8b95e4b83766a57854b12e0 100644 (file)
@@ -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) <dnssec-keygen>`, :iscman:`dnssec-signzone(8) <dnssec-signzone>`, BIND 9 Administrator Reference Manual,
 :rfc:`5011`.
index df84f98515b16fcaee19a3ea27664329a7e6a658..244fc64d61cc59cfaeef0c2cefa10a5fa74d2154 100644 (file)
@@ -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) <dnssec-keygen>`, BIND 9 Administrator Reference Manual, :rfc:`4033`,
 :rfc:`4641`.
index cba858612d0f7294bf91802cb08a9860afbb2a62..870089482b28e1090bdc8bad59b555dc0d7520d5 100644 (file)
@@ -104,4 +104,4 @@ Options
 See Also
 ~~~~~~~~
 
-:manpage:`dnssec-signzone(8)`, BIND 9 Administrator Reference Manual, :rfc:`4033`.
+:iscman:`dnssec-signzone(8) <dnssec-signzone>`, BIND 9 Administrator Reference Manual, :rfc:`4033`.
index aeda5c9490a547cc66816c7da75bc4afbf08bd63..3ce51e38ad95ef7a46d8494167293f72fe542347 100644 (file)
@@ -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) <named>`, :iscman:`named-checkconf(8) <named-checkconf>`, :iscman:`rndc(8) <rndc>`, :iscman:`rndc-confgen(8) <rndc-confgen>`, :iscman:`tsig-keygen(8) <tsig-keygen>`, BIND 9 Administrator Reference Manual.
 
index f3557b01e44e78bdb9a909d5073c636f7bed56af..21a82c4dbd319544543104a63fc4de20b5a7ae69 100644 (file)
@@ -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) <named-checkconf>`, :iscman:`named-checkzone(8) <named-checkzone>`, :iscman:`rndc(8) <rndc>`, :iscman:`named.conf(5) <named.conf>`, BIND 9 Administrator Reference Manual.
index 05fe3e4fe044aa5cd708f3c816068ebdb8d4be2e..3d9425a5cb51593dda3c30bc19cd444f75d73f77 100644 (file)
@@ -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) <named>`, :iscman:`dnssec-keygen(8) <dnssec-keygen>`, :iscman:`tsig-keygen(8) <tsig-keygen>`.
 
 Bugs
 ~~~~
index 7a63998e39f35e254f83a07af3ce9aa2472cd39b..20e6bc97a4be2827f17477f3f791faa503b139ec 100644 (file)
@@ -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) <rndc>`, :iscman:`rndc-confgen(8) <rndc-confgen>`, :manpage:`mmencode(1)`, BIND 9 Administrator Reference Manual.
index c241d7ec48e32b05da0f1902d28cc39286aa0fad..c5f2b29281c928365ac85b3a3c0402145d674acd 100644 (file)
@@ -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) <rndc.conf>`, :iscman:`rndc-confgen(8) <rndc-confgen>`,
+:iscman:`named(8) <named>`, :iscman:`named.conf(5) <named.conf>`, BIND 9 Administrator
 Reference Manual.
index 49dceab4338128b0a5975c6a7c878c5145ab5f4d..a5956825fcdf2027799396a6e674e5e14485c99b 100644 (file)
@@ -55,4 +55,4 @@ Options
 See Also
 ~~~~~~~~
 
-:manpage:`named(8)`, :manpage:`rndc(8)`, BIND 9 Administrator Reference Manual.
+:iscman:`named(8) <named>`, :iscman:`rndc(8) <rndc>`, BIND 9 Administrator Reference Manual.
index ec9487bbfd19aa3f1e6a79caa311d522caefe235..a3e1c056bc2562445e02bb2a77ddba52713b02f7 100644 (file)
@@ -373,4 +373,4 @@ The local query options are:
 See Also
 ~~~~~~~~
 
-:manpage:`dig(1)`, :rfc:`1035`.
+:iscman:`dig(1) <dig>`, :rfc:`1035`.
index 73cd69a233751891c08ecab91d55a98140aa5dc3..9d56801864499f117a51d1308d544ba7a2d49b98 100644 (file)
@@ -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) <named>`, :iscman:`nsupdate(1) <nsupdate>`, BIND 9 Administrator Reference Manual.
index 6b736c249c5eddddd08a17d14e56acb68648c6a6..28da236b726829b41dc438e08e22087d1a6ea705 100644 (file)
@@ -59,4 +59,4 @@ Options
 See Also
 ~~~~~~~~
 
-:rfc:`1034`, :rfc:`1035`, :manpage:`named(8)`.
+:rfc:`1034`, :rfc:`1035`, :iscman:`named(8) <named>`.
index 0cd75f13ed6a5dab39b4d424ff432443ffcbebef..4290c4760cc1aeaf31755200e227b235a2d66524 100644 (file)
@@ -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
index 8ae678cf5c794809577685b2f4891a02ab4577c5..16872ec748d2fed31f0e3c1cc2d8ce4cc5372260 100644 (file)
@@ -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
index f23f8f06a60c8b9a931e2563230a72078e80d567..619840268cda94ae86fc540e153d6624f691c1fa 100644 (file)
@@ -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