Update repub branch u/fanf2/patch to rebasing branch u/fanf2/rebasing revision v9_13_...
[ipreg/bind9.git] / bin / dnssec / dnssec-revoke.8
CommitLineData
b4d3f782 1.\" Copyright (C) 2009, 2011, 2014-2016, 2018, 2019 Internet Systems Consortium, Inc. ("ISC")
bef75d63 2.\"
6807a2dc
TU
3.\" This Source Code Form is subject to the terms of the Mozilla Public
4.\" License, v. 2.0. If a copy of the MPL was not distributed with this
5.\" file, You can obtain one at http://mozilla.org/MPL/2.0/.
cfb1587e 6.\"
cfb1587e
EH
7.hy 0
8.ad l
2eeb74d1
TU
9'\" t
10.\" Title: dnssec-revoke
0ae35ecf 11.\" Author:
fd2597f7 12.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
2eeb74d1 13.\" Date: 2014-01-15
0ae35ecf 14.\" Manual: BIND9
2eeb74d1
TU
15.\" Source: ISC
16.\" Language: English
0ae35ecf 17.\"
2eeb74d1
TU
18.TH "DNSSEC\-REVOKE" "8" "2014\-01\-15" "ISC" "BIND9"
19.\" -----------------------------------------------------------------
20.\" * Define some portability stuff
21.\" -----------------------------------------------------------------
22.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
23.\" http://bugs.debian.org/507673
24.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
25.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
26.ie \n(.g .ds Aq \(aq
27.el .ds Aq '
28.\" -----------------------------------------------------------------
29.\" * set default formatting
30.\" -----------------------------------------------------------------
0ae35ecf
AU
31.\" disable hyphenation
32.nh
33.\" disable justification (adjust text to left margin only)
34.ad l
2eeb74d1
TU
35.\" -----------------------------------------------------------------
36.\" * MAIN CONTENT STARTS HERE *
37.\" -----------------------------------------------------------------
0ae35ecf 38.SH "NAME"
dec590a3 39dnssec-revoke \- set the REVOKED bit on a DNSSEC key
cfb1587e 40.SH "SYNOPSIS"
fd2597f7 41.HP \w'\fBdnssec\-revoke\fR\ 'u
6f120589 42\fBdnssec\-revoke\fR [\fB\-hr\fR] [\fB\-v\ \fR\fB\fIlevel\fR\fR] [\fB\-V\fR] [\fB\-K\ \fR\fB\fIdirectory\fR\fR] [\fB\-E\ \fR\fB\fIengine\fR\fR] [\fB\-f\fR] [\fB\-R\fR] {keyfile}
cfb1587e
EH
43.SH "DESCRIPTION"
44.PP
0ae35ecf 45\fBdnssec\-revoke\fR
2eeb74d1 46reads a DNSSEC key file, sets the REVOKED bit on the key as defined in RFC 5011, and creates a new pair of key files containing the now\-revoked key\&.
cfb1587e 47.SH "OPTIONS"
0ae35ecf
AU
48.PP
49\-h
50.RS 4
2eeb74d1 51Emit usage message and exit\&.
0ae35ecf
AU
52.RE
53.PP
0a7ed886 54\-K \fIdirectory\fR
0ae35ecf 55.RS 4
2eeb74d1 56Sets the directory in which the key files are to reside\&.
0ae35ecf
AU
57.RE
58.PP
59\-r
60.RS 4
2eeb74d1 61After writing the new keyset files remove the original keyset files\&.
0ae35ecf
AU
62.RE
63.PP
cfb1587e 64\-v \fIlevel\fR
0ae35ecf 65.RS 4
2eeb74d1 66Sets the debugging level\&.
0ae35ecf
AU
67.RE
68.PP
6f120589
TU
69\-V
70.RS 4
2eeb74d1 71Prints version information\&.
6f120589
TU
72.RE
73.PP
8ec3c085
AU
74\-E \fIengine\fR
75.RS 4
2eeb74d1 76Specifies the cryptographic hardware to use, when applicable\&.
6ea23853 77.sp
2eeb74d1 78When BIND is built with OpenSSL PKCS#11 support, this defaults to the string "pkcs11", which identifies an OpenSSL engine that can drive a cryptographic accelerator or hardware service module\&. When BIND is built with native PKCS#11 cryptography (\-\-enable\-native\-pkcs11), it defaults to the path of the PKCS#11 provider library specified via "\-\-with\-pkcs11"\&.
8ec3c085
AU
79.RE
80.PP
0ae35ecf
AU
81\-f
82.RS 4
83Force overwrite: Causes
84\fBdnssec\-revoke\fR
2eeb74d1 85to write the new key pair even if a file already exists matching the algorithm and key ID of the revoked key\&.
0ae35ecf 86.RE
12bfbed8
AU
87.PP
88\-R
89.RS 4
2eeb74d1 90Print the key tag of the key with the REVOKE bit set but do not revoke the key\&.
12bfbed8 91.RE
cfb1587e
EH
92.SH "SEE ALSO"
93.PP
2eeb74d1 94\fBdnssec-keygen\fR(8),
0ae35ecf 95BIND 9 Administrator Reference Manual,
2eeb74d1 96RFC 5011\&.
cfb1587e
EH
97.SH "AUTHOR"
98.PP
2eeb74d1 99\fBInternet Systems Consortium, Inc\&.\fR
0ae35ecf 100.SH "COPYRIGHT"
2eeb74d1 101.br
b4d3f782 102Copyright \(co 2009, 2011, 2014-2016, 2018, 2019 Internet Systems Consortium, Inc. ("ISC")
0ae35ecf 103.br