Files
bind9/doc/man/pkcs11-destroy.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

75 lines
2.2 KiB
Plaintext

.\" Man page generated from reStructuredText.
.
.TH "PKCS11-DESTROY" "1" "@RELEASE_DATE@" "@PACKAGE_VERSION@" "BIND 9"
.SH NAME
pkcs11-destroy \- destroy PKCS#11 objects
.
.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
..
pkcs11\-destroy \- destroy PKCS#11 objects
.sp
\fBpkcs11\-destroy\fP [\fB\-m\fP module] [\fB\-s\fP slot] [\fB\-i\fP ID] [\fB\-l\fP label] [\fB\-p\fP PIN] [\fB\-w\fP seconds]
.sp
\fBpkcs11\-destroy\fP destroys keys stored in a PKCS#11 device, identified
by their \fBID\fP or \fBlabel\fP\&.
.sp
Matching keys are displayed before being destroyed. By default, there is
a five\-second delay to allow the user to interrupt the process before
the destruction takes place.
.INDENT 0.0
.TP
.B \fB\-m module\fP
This option specifies the PKCS#11 provider module. This must be the full path to a
shared library object implementing the PKCS#11 API for the device.
.TP
.B \fB\-s slot\fP
This option opens the session with the given PKCS#11 slot. The default is slot 0.
.TP
.B \fB\-i ID\fP
This option destroys keys with the given object ID.
.TP
.B \fB\-l label\fP
This option destroys keys with the given label.
.TP
.B \fB\-p PIN\fP
This option specifies the \fBPIN\fP for the device. If no \fBPIN\fP is provided on the command
line, \fBpkcs11\-destroy\fP prompts for it.
.TP
.B \fB\-w seconds\fP
This option specifies how long, in seconds, to pause before carrying out key destruction. The
default is 5 seconds. If set to \fB0\fP, destruction is
immediate.
.UNINDENT
.sp
\fBpkcs11\-keygen(8)\fP, \fBpkcs11\-list(8)\fP, \fBpkcs11\-tokens(8)\fP
.SH AUTHOR
Internet Systems Consortium
.SH COPYRIGHT
2021, Internet Systems Consortium
.\" Generated by docutils manpage writer.
.