2
0
mirror of https://gitlab.isc.org/isc-projects/bind9 synced 2025-08-23 10:39:16 +00:00

More man page option hyperlinks

The dig man page wanted -h option hyperlink and anchor, and there
were a couple of missing cross-references in the rndc man page.
This commit is contained in:
Tony Finch 2022-03-03 15:02:10 +00:00 committed by Petr Špaček
parent a85df3ff9c
commit ccc6378355
No known key found for this signature in database
GPG Key ID: ABD587CDF06581AE
6 changed files with 17 additions and 8 deletions

View File

@ -38,7 +38,7 @@ than ``dig``.
Although ``dig`` is normally used with command-line arguments, it also 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 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 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 implementation of ``dig`` allows multiple lookups to be issued from the
command line. command line.
@ -125,6 +125,10 @@ Options
same way it would be presented as a query to ``dig`` using the same way it would be presented as a query to ``dig`` using the
command-line interface. command-line interface.
.. option:: -h
Print a usage summary.
.. option:: -k keyfile .. option:: -k keyfile
This option tells ``named`` to sign queries using TSIG using a key read from the given file. Key This option tells ``named`` to sign queries using TSIG using a key read from the given file. Key

View File

@ -386,7 +386,7 @@ Currently supported commands are:
This command reloads the configuration file and loads new zones, but does not reload 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 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. avoids the need to examine the modification times of the zone files.
.. option:: recursing .. option:: recursing
@ -434,7 +434,7 @@ Currently supported commands are:
.. option:: scan .. option:: scan
This command scans the list of available network interfaces for changes, without 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. ``interface-interval`` timer.
.. option:: secroots [-] [view ...] .. option:: secroots [-] [view ...]

View File

@ -49,7 +49,7 @@ than \fBdig\fP\&.
Although \fBdig\fP is normally used with command\-line arguments, it also 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 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 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 implementation of \fBdig\fP allows multiple lookups to be issued from the
command line. command line.
.sp .sp
@ -147,6 +147,11 @@ command\-line interface.
.UNINDENT .UNINDENT
.INDENT 0.0 .INDENT 0.0
.TP .TP
.B \-h
Print a usage summary.
.UNINDENT
.INDENT 0.0
.TP
.B \-k keyfile .B \-k keyfile
This option tells \fBnamed\fP to sign queries using TSIG using a key read from the given file. Key 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 files can be generated using \fBtsig\-keygen\fP\&. When using TSIG

View File

@ -79,7 +79,7 @@ Be careful not to delete the DS records when \fBdnssec\-cds\fP fails!
.UNINDENT .UNINDENT
.UNINDENT .UNINDENT
.sp .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 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. maintain a \fBdsset\-\fP file as well as emit an \fBnsupdate\fP script.
.SH OPTIONS .SH OPTIONS

View File

@ -52,7 +52,7 @@ authentication key allowing \fBrndc\fP to communicate with \fBnamed\fP on
the local host with no further configuration. the local host with no further configuration.
.sp .sp
If a more elaborate configuration than that generated by 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 remotely, run \fBrndc\-confgen\fP without the \fI\%\-a\fP option
and set up \fBrndc.conf\fP and \fBnamed.conf\fP as directed. and set up \fBrndc.conf\fP and \fBnamed.conf\fP as directed.
.UNINDENT .UNINDENT

View File

@ -422,7 +422,7 @@ of \fBnamed.conf\fP, or by specifying \fBquerylog yes;\fP in the
.B reconfig .B reconfig
This command reloads the configuration file and loads new zones, but does not reload 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 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. avoids the need to examine the modification times of the zone files.
.UNINDENT .UNINDENT
.INDENT 0.0 .INDENT 0.0
@ -476,7 +476,7 @@ with new signatures.
.TP .TP
.B scan .B scan
This command scans the list of available network interfaces for changes, without 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. \fBinterface\-interval\fP timer.
.UNINDENT .UNINDENT
.INDENT 0.0 .INDENT 0.0