'\" t
.\"     Title: cryptsetup-close
.\"    Author: [see the "AUTHOR(S)" section]
.\" Generator: Asciidoctor 2.0.20
.\"      Date: 2023-07-18
.\"    Manual: Maintenance Commands
.\"    Source: cryptsetup 2.7.2
.\"  Language: English
.\"
.TH "CRYPTSETUP\-CLOSE" "8" "2023-07-18" "cryptsetup 2.7.2" "Maintenance Commands"
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.ss \n[.ss] 0
.nh
.ad l
.de URL
\fI\\$2\fP <\\$1>\\$3
..
.als MTO URL
.if \n[.g] \{\
.  mso www.tmac
.  am URL
.    ad l
.  .
.  am MTO
.    ad l
.  .
.  LINKSTYLE blue R < >
.\}
.SH "NAME"
cryptsetup-close \- removes the existing mapping <name> (and the associated key)
.SH "SYNOPSIS"
.sp
\fBcryptsetup \fIclose\fP [<options>] <name>\fP
.SH "DESCRIPTION"
.sp
Removes the existing mapping <name> and wipes the key from kernel
memory.
.sp
For backward compatibility, there are \fBclose\fP command aliases: \fBremove\fP,
\fBplainClose\fP, \fBluksClose\fP, \fBloopaesClose\fP, \fBtcryptClose\fP, \fBbitlkClose\fP
(all behave exactly the same, device type is determined automatically
from the active device).
.sp
\fB<options>\fP can be [\-\-deferred, \-\-cancel\-deferred, \-\-header, \-\-disable\-locks].
.SH "OPTIONS"
.sp
\fB\-\-batch\-mode, \-q\fP
.RS 4
Suppresses all confirmation questions. Use with care!
.sp
If the \-\-verify\-passphrase option is not specified, this option also
switches off the passphrase verification.
.RE
.sp
\fB\-\-cancel\-deferred\fP
.RS 4
Removes a previously configured deferred device removal in \fIclose\fP
command.
.RE
.sp
\fB\-\-debug or \-\-debug\-json\fP
.RS 4
Run in debug mode with full diagnostic logs. Debug output lines are
always prefixed by \fB#\fP.
.sp
If \-\-debug\-json is used, additional LUKS2 JSON data structures are printed.
.RE
.sp
\fB\-\-deferred\fP
.RS 4
Defers device removal in \fIclose\fP command until the last user closes
it.
.RE
.sp
\fB\-\-disable\-locks\fP
.RS 4
Disable lock protection for metadata on disk. This option is valid
only for LUKS2 and ignored for other formats.
.sp
\fBWARNING:\fP Do not use this option unless you run cryptsetup in a
restricted environment where locking is impossible to perform (where
/run directory cannot be used).
.RE
.sp
\fB\-\-header <device or file storing the LUKS header>\fP
.RS 4
Use a detached (separated) metadata device or file where the LUKS
header is stored. This option allows one to store ciphertext and LUKS
header on different devices.
.sp
For commands that change the LUKS header (e.g. \fIluksAddKey\fP),
specify the device or file with the LUKS header directly as the LUKS
device.
.RE
.sp
\fB\-\-help, \-?\fP
.RS 4
Show help text and default parameters.
.RE
.sp
\fB\-\-usage\fP
.RS 4
Show short option help.
.RE
.sp
\fB\-\-version, \-V\fP
.RS 4
Show the program version.
.RE
.SH "REPORTING BUGS"
.sp
Report bugs at \c
.MTO "cryptsetup\(atlists.linux.dev" "\fBcryptsetup mailing list\fP"
or in \c
.URL "https://gitlab.com/cryptsetup/cryptsetup/\-/issues/new" "\fBIssues project section\fP" "."
.sp
Please attach output of the failed command with \-\-debug option added.
.SH "SEE ALSO"
.sp
.URL "https://gitlab.com/cryptsetup/cryptsetup/wikis/FrequentlyAskedQuestions" "\fBCryptsetup FAQ\fP" ""
.sp
\fBcryptsetup\fP(8), \fBintegritysetup\fP(8) and \fBveritysetup\fP(8)
.SH "CRYPTSETUP"
.sp
Part of \c
.URL "https://gitlab.com/cryptsetup/cryptsetup/" "\fBcryptsetup project\fP" "."