mir/bind
2
0
Fork 0
mirror of https://gitlab.isc.org/isc-projects/bind9 synced 2025-08-26 03:58:15 +00:00
Code Issues Releases Wiki Activity
bind/doc/man/tsig-keygen.8in

67 lines
1.9 KiB
Plaintext
Raw Normal View History

use 'tsig-keygen' as the primary name for the tool 'ddns-confgen' is now an alias for 'tsig-keygen', rather than the other way around.
2020-07-02 15:27:54 -07:00
.\" 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
..
Regenerate man pages with docutils 0.17.1 The Debian 10 (buster) Docker image, which GitLab CI uses for building documentation, currently contains the following package versions: - Sphinx 4.2.0 - sphinx-rtd-theme 1.0.0 - docutils 0.17.1 Regenerate the man pages to match contents produced in a Sphinx environment using the above package versions. This is necessary to prevent the "docs" GitLab CI job from failing.
2021-09-16 10:57:04 +02:00
.TH "TSIG-KEYGEN" "8" "@RELEASE_DATE@" "@PACKAGE_VERSION@" "BIND 9"
.SH NAME
tsig-keygen \- TSIG key generation tool
Fixup the manpages after ddns-confgen.rst -> tsig-keygen.rst rename There were some missing bits in the other rst files and Makefile.am(s) that didn't reflect the rename of the main document. Also add ddns-confgen.8 manpage.
2020-07-07 16:11:24 +02:00
.SH SYNOPSIS
.sp
Remove nonexistent option -r from confgen man pages Fixes omission in !269. Fixes: #2826
2022-03-01 17:53:59 +01:00
\fBtsig\-keygen\fP [\fB\-a\fP algorithm] [\fB\-h\fP] [name]
Fixup the manpages after ddns-confgen.rst -> tsig-keygen.rst rename There were some missing bits in the other rst files and Makefile.am(s) that didn't reflect the rename of the main document. Also add ddns-confgen.8 manpage.
2020-07-07 16:11:24 +02:00
.SH DESCRIPTION
.sp
Split out ddns-confgen and tsig-keygen man pages Both utilities were included as one man page, but this caused a problem: Sphinx directive .. include was used twice on the same file, which prevented us from using labels (or anything with unique identifier) in the man pages. This effectivelly prevented linking to them. Splitting man pages allows us to solve the linking problems and also clearly make text easier to follow because it does not mention two tools at the same time. This change causes duplication of text, but given the frequecy of changes to these tools I think it is acceptable. Related: #2799
2022-03-01 17:45:10 +01:00
\fBtsig\-keygen\fP is an utility that generates keys for use in TSIG signing.
The resulting keys can be used, for example, to secure dynamic DNS updates
Regenerate man pages with Sphinx 4.5.0 The Debian 11 (bullseye) Docker image, which GitLab CI uses for building documentation, currently contains the following package versions: - Sphinx 4.5.0 - sphinx-rtd-theme 1.0.0 - docutils 0.17.1 Regenerate the man pages to match contents produced in a Sphinx environment using the above package versions. This is necessary to prevent the "docs" GitLab CI job from failing.
2022-04-22 13:05:10 +02:00
to a zone, or for the \fI\%rndc\fP command channel.
Fixup the manpages after ddns-confgen.rst -> tsig-keygen.rst rename There were some missing bits in the other rst files and Makefile.am(s) that didn't reflect the rename of the main document. Also add ddns-confgen.8 manpage.
2020-07-07 16:11:24 +02:00
.sp
Split out ddns-confgen and tsig-keygen man pages Both utilities were included as one man page, but this caused a problem: Sphinx directive .. include was used twice on the same file, which prevented us from using labels (or anything with unique identifier) in the man pages. This effectivelly prevented linking to them. Splitting man pages allows us to solve the linking problems and also clearly make text easier to follow because it does not mention two tools at the same time. This change causes duplication of text, but given the frequecy of changes to these tools I think it is acceptable. Related: #2799
2022-03-01 17:45:10 +01:00
A domain name can be specified on the command line to be used as the name
of the generated key. If no name is specified, the default is \fBtsig\-key\fP\&.
Fixup the manpages after ddns-confgen.rst -> tsig-keygen.rst rename There were some missing bits in the other rst files and Makefile.am(s) that didn't reflect the rename of the main document. Also add ddns-confgen.8 manpage.
2020-07-07 16:11:24 +02:00
.SH OPTIONS
.INDENT 0.0
.TP
Denote all command line options using semantic markup (.. option::) 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.
2022-03-02 15:12:17 +01:00
.B \-a algorithm
Fixup the manpages after ddns-confgen.rst -> tsig-keygen.rst rename There were some missing bits in the other rst files and Makefile.am(s) that didn't reflect the rename of the main document. Also add ddns-confgen.8 manpage.
2020-07-07 16:11:24 +02:00
This option specifies the algorithm to use for the TSIG key. Available
choices are: hmac\-md5, hmac\-sha1, hmac\-sha224, hmac\-sha256, hmac\-sha384,
and hmac\-sha512. The default is hmac\-sha256. Options are
case\-insensitive, and the "hmac\-" prefix may be omitted.
Denote all command line options using semantic markup (.. option::) 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.
2022-03-02 15:12:17 +01:00
.UNINDENT
.INDENT 0.0
Fixup the manpages after ddns-confgen.rst -> tsig-keygen.rst rename There were some missing bits in the other rst files and Makefile.am(s) that didn't reflect the rename of the main document. Also add ddns-confgen.8 manpage.
2020-07-07 16:11:24 +02:00
.TP
Denote all command line options using semantic markup (.. option::) 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.
2022-03-02 15:12:17 +01:00
.B \-h
Fixup the manpages after ddns-confgen.rst -> tsig-keygen.rst rename There were some missing bits in the other rst files and Makefile.am(s) that didn't reflect the rename of the main document. Also add ddns-confgen.8 manpage.
2020-07-07 16:11:24 +02:00
This option prints a short summary of options and arguments.
.UNINDENT
.SH SEE ALSO
.sp
Regenerate man pages with Sphinx 4.5.0 The Debian 11 (bullseye) Docker image, which GitLab CI uses for building documentation, currently contains the following package versions: - Sphinx 4.5.0 - sphinx-rtd-theme 1.0.0 - docutils 0.17.1 Regenerate the man pages to match contents produced in a Sphinx environment using the above package versions. This is necessary to prevent the "docs" GitLab CI job from failing.
2022-04-22 13:05:10 +02:00
\fI\%nsupdate(1)\fP, \fI\%named.conf(5)\fP, \fI\%named(8)\fP, BIND 9 Administrator Reference Manual.
use 'tsig-keygen' as the primary name for the tool 'ddns-confgen' is now an alias for 'tsig-keygen', rather than the other way around.
2020-07-02 15:27:54 -07:00
.SH AUTHOR
Internet Systems Consortium
.SH COPYRIGHT
Update copyrights to 2022
2022-01-03 10:29:49 +01:00
2022, Internet Systems Consortium
use 'tsig-keygen' as the primary name for the tool 'ddns-confgen' is now an alias for 'tsig-keygen', rather than the other way around.
2020-07-02 15:27:54 -07:00
.\" Generated by docutils manpage writer.
.
Reference in New Issue Copy Permalink