Imported Upstream version 2.6.1
[platform/upstream/cryptsetup.git] / man / cryptsetup-convert.8.adoc
1 = cryptsetup-convert(8)
2 :doctype: manpage
3 :manmanual: Maintenance Commands
4 :mansource: cryptsetup {release-version}
5 :man-linkstyle: pass:[blue R < >]
6 :COMMON_OPTIONS:
7 :ACTION_CONVERT:
8
9 == Name
10
11 cryptsetup-convert - converts the device between LUKS1 and LUKS2 format
12
13 == SYNOPSIS
14
15 *cryptsetup _convert_ --type <format> [<options>] <device>*
16
17 == DESCRIPTION
18
19 Converts the device between LUKS1 and LUKS2 format (if possible). The
20 conversion will not be performed if there is an additional LUKS2 feature
21 or LUKS1 has unsupported header size.
22
23 Conversion (both directions) must be performed on inactive device. There
24 must not be active dm-crypt mapping established for LUKS header
25 requested for conversion.
26
27 The *--type* option is mandatory with the following accepted values: _luks1_ or
28 _luks2_.
29
30 *WARNING:* The _convert_ action can destroy the LUKS header in the case
31 of a crash during conversion or if a media error occurs. Always create a
32 header backup before performing this operation!
33
34 *<options>* can be [--header, --type, --disable-locks].
35
36 include::man/common_options.adoc[]
37 include::man/common_footer.adoc[]