mir/bind
2
0
Fork 0
mirror of https://gitlab.isc.org/isc-projects/bind9 synced 2025-08-22 01:59:26 +00:00
Code Issues Releases Wiki Activity
bind/bin/dnssec/dnssec-revoke.rst

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

71 lines
1.8 KiB
ReStructuredText
Raw Normal View History

Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
.. Copyright (C) Internet Systems Consortium, Inc. ("ISC")
..
.. SPDX-License-Identifier: MPL-2.0
Update the copyright information in all files in the repository This commit converts the license handling to adhere to the REUSE specification. It specifically: 1. Adds used licnses to LICENSES/ directory 2. Add "isc" template for adding the copyright boilerplate 3. Changes all source files to include copyright and SPDX license header, this includes all the C sources, documentation, zone files, configuration files. There are notes in the doc/dev/copyrights file on how to add correct headers to the new files. 4. Handle the rest that can't be modified via .reuse/dep5 file. The binary (or otherwise unmodifiable) files could have license places next to them in <foo>.license file, but this would lead to cluttered repository and most of the files handled in the .reuse/dep5 file are system test files.
2021-06-03 08:37:05 +02:00
..
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
.. This Source Code Form is subject to the terms of the Mozilla Public
.. License, v. 2.0. If a copy of the MPL was not distributed with this
.. file, you can obtain one at https://mozilla.org/MPL/2.0/.
Update the copyright information in all files in the repository This commit converts the license handling to adhere to the REUSE specification. It specifically: 1. Adds used licnses to LICENSES/ directory 2. Add "isc" template for adding the copyright boilerplate 3. Changes all source files to include copyright and SPDX license header, this includes all the C sources, documentation, zone files, configuration files. There are notes in the doc/dev/copyrights file on how to add correct headers to the new files. 4. Handle the rest that can't be modified via .reuse/dep5 file. The binary (or otherwise unmodifiable) files could have license places next to them in <foo>.license file, but this would lead to cluttered repository and most of the files handled in the .reuse/dep5 file are system test files.
2021-06-03 08:37:05 +02:00
..
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
.. See the COPYRIGHT file distributed with this work for additional
.. information regarding copyright ownership.
.. highlight: console
Introduce new Sphinx role iscman for ISC manual pages The new directive and role "iscman" allow to tag & reference man pages in our source tree. Essentially it is just namespacing for ISC man pages, but it comes with couple benefits. Differences from .. _man_program label we formerly used: - Does not expand :ref:`man_program` into full text of the page header. - Generates index entry with category "manual page". - Rendering style is closer to ubiquitous to the one produced by ``named`` syntax. Differences from Sphinx built-in :manpage: role: - Supports all builders with support for cross-references. - Generates internal links (unlike :manpage: which generates external URLs). - Checks that target exists withing our source tree.
2022-03-03 15:32:35 +01:00
.. iscman:: dnssec-revoke
Add semantic markup for program names into manual pages It allows to cross-reference options in man pages from other documents using :option:`named -g` syntax.
2022-03-02 16:36:34 +01:00
.. program:: dnssec-revoke
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
.. _man_dnssec-revoke:
dnssec-revoke - set the REVOKED bit on a DNSSEC key
---------------------------------------------------
Synopsis
~~~~~~~~
Remove OpenSSL Engine support The OpenSSL 1.x Engines support has been deprecated in the OpenSSL 3.x and is going to be removed. Remove the OpenSSL Engine support in favor of OpenSSL Providers.
2024-08-05 11:40:42 +02:00
:program:`dnssec-revoke` [**-hr**] [**-v** level] [**-V**] [**-K** directory] [**-f**] [**-R**] {keyfile}
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
Description
~~~~~~~~~~~
Use semantic markup for :program: self-references Sphinx has it's own :program: syntax for refering to program names. Use it for self-references in manual pages. These self-references are not clickable and not as eye-cathing as links, which is a good thing. There is no point in attracting attention to ``dig`` several times on a single page dedicated to dig itself. Substituted automatically using: find bin -name *.rst | xargs fgrep --files-with-matches '.. program' | xargs -n1 bash /tmp/repl.sh With /tmp/repl.sh being: BASE=$(basename "$1" .rst) sed -i -e "s/\`\`$BASE\`\`/:program:\`$BASE\`/g" "$1"
2022-03-03 16:00:43 +01:00
:program:`dnssec-revoke` reads a DNSSEC key file, sets the REVOKED bit on the
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
key as defined in :rfc:`5011`, and creates a new pair of key files
containing the now-revoked key.
Options
~~~~~~~
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
.. option:: -h
Text and formatting edits to various manual pages. Follwing manual pages have been updated: rndc.conf.rst, rndc.rst nsec3hash.rst, dnstap-read.rst, named-nzd2nzf.rst, mdig.rst, named-rrchecker.rst, dnssec-revoke.rst, dnssec-cds.rst, dnssec-keyfromlabel.rst, and dnssec-keygen.rst
2020-06-03 20:01:17 +00:00
This option emits a usage message and exits.
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
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
.. option:: -K directory
Text and formatting edits to various manual pages. Follwing manual pages have been updated: rndc.conf.rst, rndc.rst nsec3hash.rst, dnstap-read.rst, named-nzd2nzf.rst, mdig.rst, named-rrchecker.rst, dnssec-revoke.rst, dnssec-cds.rst, dnssec-keyfromlabel.rst, and dnssec-keygen.rst
2020-06-03 20:01:17 +00:00
This option sets the directory in which the key files are to reside.
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
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
.. option:: -r
Text and formatting edits to various manual pages. Follwing manual pages have been updated: rndc.conf.rst, rndc.rst nsec3hash.rst, dnstap-read.rst, named-nzd2nzf.rst, mdig.rst, named-rrchecker.rst, dnssec-revoke.rst, dnssec-cds.rst, dnssec-keyfromlabel.rst, and dnssec-keygen.rst
2020-06-03 20:01:17 +00:00
This option indicates to remove the original keyset files after writing the new keyset files.
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
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
.. option:: -v level
Text and formatting edits to various manual pages. Follwing manual pages have been updated: rndc.conf.rst, rndc.rst nsec3hash.rst, dnstap-read.rst, named-nzd2nzf.rst, mdig.rst, named-rrchecker.rst, dnssec-revoke.rst, dnssec-cds.rst, dnssec-keyfromlabel.rst, and dnssec-keygen.rst
2020-06-03 20:01:17 +00:00
This option sets the debugging level.
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
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
.. option:: -V
Text and formatting edits to various manual pages. Follwing manual pages have been updated: rndc.conf.rst, rndc.rst nsec3hash.rst, dnstap-read.rst, named-nzd2nzf.rst, mdig.rst, named-rrchecker.rst, dnssec-revoke.rst, dnssec-cds.rst, dnssec-keyfromlabel.rst, and dnssec-keygen.rst
2020-06-03 20:01:17 +00:00
This option prints version information.
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
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
.. option:: -f
Use semantic markup for :program: self-references Sphinx has it's own :program: syntax for refering to program names. Use it for self-references in manual pages. These self-references are not clickable and not as eye-cathing as links, which is a good thing. There is no point in attracting attention to ``dig`` several times on a single page dedicated to dig itself. Substituted automatically using: find bin -name *.rst | xargs fgrep --files-with-matches '.. program' | xargs -n1 bash /tmp/repl.sh With /tmp/repl.sh being: BASE=$(basename "$1" .rst) sed -i -e "s/\`\`$BASE\`\`/:program:\`$BASE\`/g" "$1"
2022-03-03 16:00:43 +01:00
This option indicates a forced overwrite and causes :program:`dnssec-revoke` to write the new key pair,
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
even if a file already exists matching the algorithm and key ID of
the revoked key.
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
.. option:: -R
Text and formatting edits to various manual pages. Follwing manual pages have been updated: rndc.conf.rst, rndc.rst nsec3hash.rst, dnstap-read.rst, named-nzd2nzf.rst, mdig.rst, named-rrchecker.rst, dnssec-revoke.rst, dnssec-cds.rst, dnssec-keyfromlabel.rst, and dnssec-keygen.rst
2020-06-03 20:01:17 +00:00
This option prints the key tag of the key with the REVOKE bit set, but does not
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 12:49:47 +02:00
revoke the key.
See Also
~~~~~~~~
Add internal hyperlinks to See Also section of manual pages Replace :manpage: with :iscman: to generate internal hyperlinks. That way reader can use links even when offline, and jumps to man pages for the same version. Formerly HTML version of man pages did not have links in See Also section because :manpage: role in Sphinx can generate only external hyperlinks - and we do not have that enabled. Enabling the Sphinx :manpage: linking could reliably create hyperlinks only to external URLs, but that would take users to another version of docs. Generated by: find bin -name '*.rst' | xargs sed -i -e 's/:manpage:`\([^(]\+\)(\([0-9]\))`/:iscman:`\1(\2) <\1>`/g' + hand-edit to revert change for mmencode reference which is not provided in our source tree.
2022-03-04 13:10:25 +01:00
:iscman:`dnssec-keygen(8) <dnssec-keygen>`, BIND 9 Administrator Reference Manual, :rfc:`5011`.
Reference in New Issue Copy Permalink