'\" t
.\"     Title: cryptsetup-config
.\"    Author: [see the "AUTHOR(S)" section]
.\" Generator: Asciidoctor 2.0.20
.\"      Date: 2024-01-05
.\"    Manual: Maintenance Commands
.\"    Source: cryptsetup 2.6.1
.\"  Language: English
.\"
.TH "CRYPTSETUP\-CONFIG" "8" "2024-01-05" "cryptsetup 2.6.1" "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-config \- set permanent configuration options (store to LUKS header)
.SH "SYNOPSIS"
.sp
\fBcryptsetup \fIconfig\fP <options> <device>\fP
.SH "DESCRIPTION"
.sp
Set permanent configuration options (store to LUKS header). The \fIconfig\fP
command is supported only for LUKS2.
.sp
The permanent options can be \fI\-\-priority\fP to set priority (normal,
prefer, ignore) for keyslot (specified by \fI\-\-key\-slot\fP) or \fI\-\-label\fP and
\fI\-\-subsystem\fP.
.sp
\fB<options>\fP can be [\-\-priority, \-\-label, \-\-subsystem, \-\-key\-slot,
\-\-header, \-\-disable\-locks].
.SH "OPTIONS"
.sp
\fB\-\-key\-slot, \-S <0\-N>\fP
.RS 4
For LUKS operations that add key material, this option allows you to
specify which key slot is selected for the new key.
.sp
The maximum number of key slots depends on the LUKS version. LUKS1 can have up
to 8 key slots. LUKS2 can have up to 32 key slots based on key slot area
size and key size, but a valid key slot ID can always be between 0 and
31 for LUKS2.
.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\-\-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\-\-priority <normal|prefer|ignore>\fP
.RS 4
Set a priority for LUKS2 keyslot. The \fIprefer\fP priority marked slots
are tried before \fInormal\fP priority. The \fIignored\fP priority means, that
slot is never used, if not explicitly requested by \fI\-\-key\-slot\fP
option.
.RE
.sp
\fB\-\-label <LABEL> \-\-subsystem <SUBSYSTEM>\fP
.RS 4
Set label and subsystem description for LUKS2 device.
The label and subsystem are optional fields and can be later used
in udev scripts for triggering user actions once the device marked
by these labels is detected.
.RE
.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\-\-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\-\-version, \-V\fP
.RS 4
Show the program version.
.RE
.sp
\fB\-\-usage\fP
.RS 4
Show short option help.
.RE
.sp
\fB\-\-help, \-?\fP
.RS 4
Show help text and default parameters.
.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" "."