diff --git a/man/common_options.adoc b/man/common_options.adoc index bd446230..716ecfea 100644 --- a/man/common_options.adoc +++ b/man/common_options.adoc @@ -1,7 +1,7 @@ == OPTIONS ifdef::ACTION_LUKSFORMAT,ACTION_REENCRYPT[] -*--align-payload *:: +*--align-payload* __:: Align payload at a boundary of _value_ 512-byte sectors. + If not specified, cryptsetup tries to use the topology info provided by @@ -15,7 +15,7 @@ device. See also the --header option. + *WARNING:* This option is DEPRECATED and has often unexpected impact to the data offset and keyslot area size (for LUKS2) due to the complex -rounding. For fixed data device offset use _--offset_ option instead. +rounding. For fixed data device offset use --offset option instead. endif::[] ifdef::ACTION_OPEN,ACTION_REFRESH[] @@ -34,7 +34,7 @@ option is ignored. endif::[] ifdef::COMMON_OPTIONS[] -*--batch-mode, -q*:: +*--batch-mode*, *-q*:: Suppresses all confirmation questions. Use with care! + If the --verify-passphrase option is not specified, this option also @@ -42,7 +42,7 @@ switches off the passphrase verification. endif::[] ifdef::ACTION_REENCRYPT[] -*--block-size* _value_ *(LUKS1 only)*:: +*--block-size* _value_ (LUKS1 only):: Use re-encryption block size of _value_ in MiB. + Values can be between 1 and 64 MiB. @@ -55,7 +55,7 @@ command. endif::[] ifdef::ACTION_OPEN,ACTION_LUKSFORMAT,ACTION_REENCRYPT,ACTION_TCRYPTDUMP,ACTION_BENCHMARK[] -*--cipher, -c* __:: +*--cipher*, *-c* __:: ifdef::ACTION_OPEN,ACTION_TCRYPTDUMP[] Set the cipher specification string for _plain_ device type. + @@ -91,7 +91,7 @@ endif::[] endif::[] ifdef::COMMON_OPTIONS[] -*--debug or --debug-json*:: +*--debug* or *--debug-json*:: Run in debug mode with full diagnostic logs. Debug output lines are always prefixed by *#*. + @@ -187,25 +187,26 @@ JSON metadata area. endif::[] ifdef::ACTION_LUKSDUMP,ACTION_TCRYPTDUMP,ACTION_BITLKDUMP[] -*--dump-volume-key, --dump-master-key (OBSOLETE alias)*:: +*--dump-volume-key*:: +--dump-master-key (OBSOLETE alias):: Print the volume key in the displayed information. Use with care, as the volume key can be used to bypass the passphrases, see also option --volume-key-file. endif::[] ifdef::ACTION_REENCRYPT[] -*--encrypt, --new, -N*:: +*--encrypt*, *--new*, *-N*:: Initialize (and run) device in-place encryption mode. endif::[] ifdef::ACTION_RESIZE,ACTION_OPEN,ACTION_LUKSADDKEY,ACTION_LUKSDUMP,ACTION_LUKSRESUME,ACTION_TOKEN[] -*--external-tokens-path* _absolute_path_:: +*--external-tokens-path* __:: Override system directory path where cryptsetup searches for external token handlers (or token plugins). It must be absolute path (starting with '/' character). endif::[] ifdef::ACTION_REENCRYPT[] -*--force-no-keyslots (LUKS2 only)*:: +*--force-no-keyslots* (LUKS2 only):: Enforce initialization of reencryption operation with additional --volume-key-file, --new-volume-key-file, --volume-key-keyring or --new-volume-key-keyring parameters that would result in deletion of all remaining LUKS2 keyslots containing volume key. @@ -219,7 +220,7 @@ the device will become unusable and all data will be lost. endif::[] ifdef::ACTION_REENCRYPT[] -*--force-offline-reencrypt (LUKS2 only)*:: +*--force-offline-reencrypt* (LUKS2 only):: Bypass active device auto-detection and enforce offline reencryption. + This option is useful especially for reencryption of LUKS2 images put in @@ -244,7 +245,7 @@ For more info about password quality check, see the manual page for endif::[] ifdef::ACTION_OPEN,ACTION_LUKSFORMAT,ACTION_LUKSADDKEY,ACTION_LUKSCHANGEKEY,ACTION_LUKSCONVERTKEY,ACTION_TCRYPTDUMP,ACTION_BENCHMARK,ACTION_REENCRYPT[] -*--hash, -h* __:: +*--hash*, *-h* __:: ifdef::ACTION_OPEN,ACTION_TCRYPTDUMP[] Specifies the passphrase hash. Applies to _plain_ and _loopaes_ device types only. + @@ -275,7 +276,7 @@ endif::[] endif::[] ifndef::ACTION_BENCHMARK,ACTION_BITLKDUMP[] -*--header *:: +*--header* __:: ifndef::ACTION_OPEN,ACTION_ERASE[] Use a detached (separated) metadata device or file where the LUKS header is stored. This option allows one to store ciphertext and LUKS @@ -325,17 +326,17 @@ endif::[] endif::[] ifdef::ACTION_LUKSHEADERBACKUP,ACTION_LUKSHEADERRESTORE[] -*--header-backup-file *:: +*--header-backup-file* _file_:: Specify file with header backup file. endif::[] ifdef::COMMON_OPTIONS[] -*--help, -?*:: +*--help*, *-?*:: Show help text and default parameters. endif::[] ifdef::ACTION_REENCRYPT[] -*--hotzone-size* _size_ *(LUKS2 only)*:: +*--hotzone-size* _size_ (LUKS2 only):: This option can be used to set an upper limit on the size of reencryption area (hotzone). The _size_ can be specified with unit suffix (for example 50M). Note that actual hotzone size may be less @@ -357,7 +358,7 @@ ifdef::ACTION_ERASE[] *--hw-opal-factory-reset*:: Erase *ALL* data on the OPAL self-encrypted device, regardless of the partition it is ran on, if any, and does not require a valid LUKS2 header to be present on the device to run. After providing -correct PSID via interactive prompt or via *--key-file* parameter the device is erased. +correct PSID via interactive prompt or via --key-file parameter the device is erased. + PSID is usually printed on the OPAL device label (either directly or as a QR code). PSID must be entered without any dashes, spaces or underscores. @@ -383,14 +384,14 @@ decoupling of OPAL admin PIN access. endif::[] ifdef::ACTION_REENCRYPT[] -*--init-only (LUKS2 only)*:: +*--init-only* (LUKS2 only):: Initialize reencryption (any mode) operation in LUKS2 metadata only and exit. If any reencrypt operation is already initialized in metadata, the command with --init-only parameter fails. endif::[] ifdef::ACTION_LUKSFORMAT[] -*--integrity *:: +*--integrity* __:: Specify integrity algorithm to be used for authenticated disk encryption in LUKS2. + @@ -419,7 +420,7 @@ This option is available since the Linux kernel version 6.11. endif::[] ifdef::ACTION_LUKSFORMAT[] -*--integrity-key-size BYTES*:: +*--integrity-key-size* _bytes_:: The size of the data integrity key. Configurable only for HMAC integrity. Default integrity key size is set to the same as hash output length. endif::[] @@ -452,7 +453,7 @@ invalid integrity tag. endif::[] ifdef::ACTION_LUKSFORMAT,ACTION_LUKSADDKEY,ACTION_LUKSCHANGEKEY,ACTION_LUKSCONVERTKEY,ACTION_REENCRYPT,ACTION_BENCHMARK[] -*--iter-time, -i *:: +*--iter-time*, *-i* __:: ifndef::ACTION_REENCRYPT[] The number of milliseconds to spend with PBKDF passphrase processing. Specifying 0 as parameter selects the compiled-in default. @@ -491,12 +492,12 @@ Reencrypt only the LUKS1 header and keyslots. Skips data in-place reencryption. endif::[] ifdef::ACTION_OPEN,ACTION_LUKSFORMAT,ACTION_LUKSDUMP,ACTION_RESIZE,ACTION_LUKSRESUME,ACTION_LUKSADDKEY,ACTION_TOKEN[] -*--key-description *:: +*--key-description* _text_:: Set key description in keyring that will be used for passphrase retrieval. endif::[] ifdef::ACTION_OPEN,ACTION_RESIZE,ACTION_LUKSFORMAT,ACTION_LUKSRESUME,ACTION_LUKSADDKEY,ACTION_LUKSREMOVEKEY,ACTION_LUKSCHANGEKEY,ACTION_LUKSCONVERTKEY,ACTION_LUKSKILLSLOT,ACTION_LUKSDUMP,ACTION_TCRYPTDUMP,ACTION_REENCRYPT,ACTION_REPAIR,ACTION_BITLKDUMP[] -*--key-file, -d* _name_:: +*--key-file*, *-d* _file_:: Read the passphrase from file. + If the name given is "-", then the passphrase will be read from stdin. @@ -535,7 +536,7 @@ passphrases. endif::[] endif::[] ifdef::ACTION_ERASE[] -*--key-file, -d* _name_ *(LUKS2 with HW OPAL only)*:: +*--key-file*, *-d* _file_ (LUKS2 with HW OPAL only):: Read the Admin PIN or PSID (with --hw-opal-factory-reset) from file depending on options used. @@ -551,7 +552,7 @@ Skip _value_ bytes at the beginning of the key file. endif::[] ifdef::ACTION_OPEN,ACTION_RESIZE,ACTION_LUKSFORMAT,ACTION_LUKSRESUME,ACTION_LUKSADDKEY,ACTION_LUKSREMOVEKEY,ACTION_LUKSCHANGEKEY,ACTION_LUKSCONVERTKEY,ACTION_LUKSKILLSLOT,ACTION_LUKSDUMP,ACTION_REENCRYPT,ACTION_REPAIR,ACTION_BITLKDUMP[] -*--keyfile-size, -l* _value_:: +*--keyfile-size*, *-l* _value_:: Read a maximum of _value_ bytes from the key file. The default is to read the whole file up to the compiled-in maximum that can be queried with --help. Supplying more data than the compiled-in maximum aborts @@ -562,7 +563,7 @@ This option is useful to cut trailing newlines, for example. If endif::[] ifdef::ACTION_OPEN,ACTION_LUKSFORMAT,ACTION_REENCRYPT,ACTION_BENCHMARK,ACTION_LUKSADDKEY[] -*--key-size, -s* _bits_:: +*--key-size*, *-s* _bits_:: ifndef::ACTION_LUKSADDKEY,ACTION_REENCRYPT[] Sets key size in _bits_. The argument has to be a multiple of 8. The possible key-sizes are limited by the cipher and mode used. @@ -600,7 +601,7 @@ endif::[] endif::[] ifdef::ACTION_OPEN,ACTION_RESIZE,ACTION_LUKSFORMAT,ACTION_LUKSADDKEY,ACTION_LUKSCHANGEKEY,ACTION_LUKSCONVERTKEY,ACTION_LUKSDUMP,ACTION_LUKSRESUME,ACTION_TOKEN,ACTION_CONFIG,ACTION_TOKEN,ACTION_REPAIR,ACTION_REENCRYPT[] -*--key-slot, -S <0-N>*:: +*--key-slot*, *-S* _<0-N>_:: ifdef::ACTION_LUKSADDKEY[] When used together with parameter --new-key-slot this option allows you to specify which key slot is selected for unlocking volume key. @@ -634,19 +635,19 @@ size and key size, but a valid key slot ID can always be between 0 and endif::[] ifdef::ACTION_LUKSFORMAT,ACTION_LUKSADDKEY,ACTION_LUKSCHANGEKEY,ACTION_LUKSCONVERTKEY,ACTION_REENCRYPT[] -*--keyslot-cipher *:: +*--keyslot-cipher* __:: This option can be used to set specific cipher encryption for the LUKS2 keyslot area. endif::[] ifdef::ACTION_LUKSFORMAT,ACTION_LUKSADDKEY,ACTION_LUKSCHANGEKEY,ACTION_LUKSCONVERTKEY,ACTION_REENCRYPT[] -*--keyslot-key-size *:: +*--keyslot-key-size* __:: This option can be used to set specific key size for the LUKS2 keyslot area. endif::[] ifdef::ACTION_LUKSFORMAT,ACTION_CONFIG,ACTION_REENCRYPT[] -*--label