]> git.ipfire.org Git - thirdparty/bind9.git/commitdiff
More man page option hyperlinks
authorTony Finch <fanf@isc.org>
Thu, 3 Mar 2022 15:02:10 +0000 (15:02 +0000)
committerPetr Špaček <pspacek@isc.org>
Mon, 14 Mar 2022 09:46:36 +0000 (10:46 +0100)
The dig man page wanted -h option hyperlink and anchor, and there
were a couple of missing cross-references in the rndc man page.

bin/dig/dig.rst
bin/rndc/rndc.rst
doc/man/dig.1in
doc/man/dnssec-cds.1in
doc/man/rndc-confgen.8in
doc/man/rndc.8in

index b4f4295e0ad4a34d5dcf8da03537eda19844f62a..c2b51b151290a0f62e5a1bd6e4846bad4b73cc65 100644 (file)
@@ -38,7 +38,7 @@ than ``dig``.
 Although ``dig`` is normally used with command-line arguments, it also
 has a batch mode of operation for reading lookup requests from a file. A
 brief summary of its command-line arguments and options is printed when
-the ``-h`` option is given. The BIND 9
+the :option:`-h` option is given. The BIND 9
 implementation of ``dig`` allows multiple lookups to be issued from the
 command line.
 
@@ -125,6 +125,10 @@ Options
    same way it would be presented as a query to ``dig`` using the
    command-line interface.
 
+.. option:: -h
+
+   Print a usage summary.
+
 .. option:: -k keyfile
 
    This option tells ``named`` to sign queries using TSIG using a key read from the given file. Key
index 276d02e99a702eebb924f977dd24c35d732f4f8f..ec96bf963e966a611cda7a022f25aea245fcb51c 100644 (file)
@@ -386,7 +386,7 @@ Currently supported commands are:
 
    This command reloads the configuration file and loads new zones, but does not reload
    existing zone files even if they have changed. This is faster than a
-   full ``reload`` when there is a large number of zones, because it
+   full :option:`rndc reload` when there is a large number of zones, because it
    avoids the need to examine the modification times of the zone files.
 
 .. option:: recursing
@@ -434,7 +434,7 @@ Currently supported commands are:
 .. option:: scan
 
    This command scans the list of available network interfaces for changes, without
-   performing a full ``reconfig`` or waiting for the
+   performing a full :option:`rndc reconfig` or waiting for the
    ``interface-interval`` timer.
 
 .. option:: secroots [-] [view ...]
index 7181d1c84b08a9e2978fa86c77291137137062c4..670c72e9b57ca4ea92cc1a2161df740d1ce687c7 100644 (file)
@@ -49,7 +49,7 @@ than \fBdig\fP\&.
 Although \fBdig\fP is normally used with command\-line arguments, it also
 has a batch mode of operation for reading lookup requests from a file. A
 brief summary of its command\-line arguments and options is printed when
-the \fB\-h\fP option is given. The BIND 9
+the \fI\%\-h\fP option is given. The BIND 9
 implementation of \fBdig\fP allows multiple lookups to be issued from the
 command line.
 .sp
@@ -147,6 +147,11 @@ command\-line interface.
 .UNINDENT
 .INDENT 0.0
 .TP
+.B \-h
+Print a usage summary.
+.UNINDENT
+.INDENT 0.0
+.TP
 .B \-k keyfile
 This option tells \fBnamed\fP to sign queries using TSIG using a key read from the given file. Key
 files can be generated using \fBtsig\-keygen\fP\&. When using TSIG
index 9bc561f69d9f20ef2d3e0f7d4e34040a6c64cc3b..215fce457a6fdd4a59d3839140cbe5a5b3913535 100644 (file)
@@ -79,7 +79,7 @@ Be careful not to delete the DS records when \fBdnssec\-cds\fP fails!
 .UNINDENT
 .UNINDENT
 .sp
-Alternatively, \fBdnssec\-cds \-u\fP writes an \fBnsupdate\fP script to the
+Alternatively, :option\(gadnssec\-cds \-u\(ga writes an \fBnsupdate\fP script to the
 standard output. The \fI\%\-u\fP and \fI\%\-i\fP options can be used together to
 maintain a \fBdsset\-\fP file as well as emit an \fBnsupdate\fP script.
 .SH OPTIONS
index b937044f58d91c803d253048d30c16124b3eccd1..9433875a43111aff4a2927f90bfebd25561aa98b 100644 (file)
@@ -52,7 +52,7 @@ authentication key allowing \fBrndc\fP to communicate with \fBnamed\fP on
 the local host with no further configuration.
 .sp
 If a more elaborate configuration than that generated by
-\fBrndc\-confgen \-a\fP is required, for example if rndc is to be used
+\fI\%rndc\-confgen \-a\fP is required, for example if rndc is to be used
 remotely, run \fBrndc\-confgen\fP without the \fI\%\-a\fP option
 and set up \fBrndc.conf\fP and \fBnamed.conf\fP as directed.
 .UNINDENT
index ebded5438d4a896988f0515513d2dbd1f58c6862..d94b544c7eec721fb0e61046411515afd60382c0 100644 (file)
@@ -422,7 +422,7 @@ of \fBnamed.conf\fP, or by specifying \fBquerylog yes;\fP in the
 .B reconfig
 This command reloads the configuration file and loads new zones, but does not reload
 existing zone files even if they have changed. This is faster than a
-full \fBreload\fP when there is a large number of zones, because it
+full \fI\%rndc reload\fP when there is a large number of zones, because it
 avoids the need to examine the modification times of the zone files.
 .UNINDENT
 .INDENT 0.0
@@ -476,7 +476,7 @@ with new signatures.
 .TP
 .B scan
 This command scans the list of available network interfaces for changes, without
-performing a full \fBreconfig\fP or waiting for the
+performing a full \fI\%rndc reconfig\fP or waiting for the
 \fBinterface\-interval\fP timer.
 .UNINDENT
 .INDENT 0.0