2
0
mirror of https://gitlab.isc.org/isc-projects/bind9 synced 2025-10-29 15:20:23 +00:00
Files
bind/doc/man/nsec3hash.1in
Michał Kępień 6a2daddf5b Regenerate man pages with docutils 0.16
Commit bdb777b2a2 updated the man pages
to contents produced using:

  - Sphinx 4.0.2
  - sphinx-rtd-theme 0.5.2
  - docutils 0.17.1

However, sphinx-rtd-theme 0.5.2 is incompatible with versions 0.17+ of
the docutils package.  This problem was addressed in the Docker image
used for building man pages by downgrading the docutils package to
version 0.16.

Regenerate the man pages again, this time using:

  - Sphinx 4.0.2
  - sphinx-rtd-theme 0.5.2
  - docutils 0.16

This is necessary to prevent the "docs" GitLab CI job from failing.
2021-05-31 11:22:52 +02:00

79 lines
2.3 KiB
Plaintext

.\" Man page generated from reStructuredText.
.
.TH "NSEC3HASH" "1" "@RELEASE_DATE@" "@PACKAGE_VERSION@" "BIND 9"
.SH NAME
nsec3hash \- generate NSEC3 hash
.
.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
..
.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 \fBsalt\fP
This is the salt provided to the hash algorithm.
.TP
.B \fBalgorithm\fP
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.
.TP
.B \fBflags\fP
This is provided for compatibility with NSEC3 record presentation format, but
is ignored since the flags do not affect the hash.
.TP
.B \fBiterations\fP
This is the number of additional times the hash should be performed.
.TP
.B \fBdomain\fP
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
2021, Internet Systems Consortium
.\" Generated by docutils manpage writer.
.