b4e46de257
The markup allows referencing individual options, and also makes them
more legible (no more thin red text on gray background).
Most of the work was done using regexes:
s/^``-\(.*\)``$/.. option:: -\1\r/
s/^``+\(.*\)``$/.. option:: +\1\r/
on bin/**/*.rst files along with visual inspection and hand-edits,
mostly for positional arguments.
Regex for rndc.rst:
s/^``\(.*\)``/.. option:: \1\r/
+ hand edits to remove extra asterisk and whitespace here and there.
(cherry picked from commit ec30944aa4)
87 lines
2.3 KiB
Plaintext
87 lines
2.3 KiB
Plaintext
.\" Man page generated from reStructuredText.
|
|
.
|
|
.
|
|
.nr rst2man-indent-level 0
|
|
.
|
|
.de1 rstReportMargin
|
|
\\$1 \\n[an-margin]
|
|
level \\n[rst2man-indent-level]
|
|
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
-
|
|
\\n[rst2man-indent0]
|
|
\\n[rst2man-indent1]
|
|
\\n[rst2man-indent2]
|
|
..
|
|
.de1 INDENT
|
|
.\" .rstReportMargin pre:
|
|
. RS \\$1
|
|
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
|
|
. nr rst2man-indent-level +1
|
|
.\" .rstReportMargin post:
|
|
..
|
|
.de UNINDENT
|
|
. RE
|
|
.\" indent \\n[an-margin]
|
|
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
.nr rst2man-indent-level -1
|
|
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
|
|
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
|
|
..
|
|
.TH "NSEC3HASH" "1" "@RELEASE_DATE@" "@PACKAGE_VERSION@" "BIND 9"
|
|
.SH NAME
|
|
nsec3hash \- generate NSEC3 hash
|
|
.SH SYNOPSIS
|
|
.sp
|
|
\fBnsec3hash\fP {salt} {algorithm} {iterations} {domain}
|
|
.sp
|
|
\fBnsec3hash\fP \fB\-r\fP {algorithm} {flags} {iterations} {salt} {domain}
|
|
.SH DESCRIPTION
|
|
.sp
|
|
\fBnsec3hash\fP generates an NSEC3 hash based on a set of NSEC3
|
|
parameters. This can be used to check the validity of NSEC3 records in a
|
|
signed zone.
|
|
.sp
|
|
If this command is invoked as \fBnsec3hash \-r\fP, it takes arguments in
|
|
order, matching the first four fields of an NSEC3 record followed by the
|
|
domain name: \fBalgorithm\fP, \fBflags\fP, \fBiterations\fP, \fBsalt\fP, \fBdomain\fP\&. This makes it
|
|
convenient to copy and paste a portion of an NSEC3 or NSEC3PARAM record
|
|
into a command line to confirm the correctness of an NSEC3 hash.
|
|
.SH ARGUMENTS
|
|
.INDENT 0.0
|
|
.TP
|
|
.B salt
|
|
This is the salt provided to the hash algorithm.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B algorithm
|
|
This is a number indicating the hash algorithm. Currently the only supported
|
|
hash algorithm for NSEC3 is SHA\-1, which is indicated by the number
|
|
1; consequently "1" is the only useful value for this argument.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B flags
|
|
This is provided for compatibility with NSEC3 record presentation format, but
|
|
is ignored since the flags do not affect the hash.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B iterations
|
|
This is the number of additional times the hash should be performed.
|
|
.UNINDENT
|
|
.INDENT 0.0
|
|
.TP
|
|
.B domain
|
|
This is the domain name to be hashed.
|
|
.UNINDENT
|
|
.SH SEE ALSO
|
|
.sp
|
|
BIND 9 Administrator Reference Manual, \fI\%RFC 5155\fP\&.
|
|
.SH AUTHOR
|
|
Internet Systems Consortium
|
|
.SH COPYRIGHT
|
|
2022, Internet Systems Consortium
|
|
.\" Generated by docutils manpage writer.
|
|
.
|