OS Manuals

/usr/bin/integritysetup

Userspace setup tool for transparent encryption of block devices using the Linux 2.6 cryptoapi

From cryptsetup 2.8.8-r4 (os), captured 2026-11-10 by running integritysetup --help (exit 0). permalink

Also provided by 1 other package version
integritysetup 2.8.8 flags: UDEV BLKID KEYRING KERNEL_CAPI HW_OPAL
Usage: integritysetup [OPTION...] <action> <action-specific>

Help options:
  -?, --help                                  Show this help message
      --usage                                 Display brief usage
  -V, --version                               Print package version
      --allow-discards                        Allow discards (aka TRIM)
                                              requests for device
      --allow-discards-keyed                  Allow secure keyed discards (aka
                                              TRIM) requests for device
  -q, --batch-mode                            Do not ask for confirmation
      --buffer-sectors=SECTORS                Buffers size
      --bitmap-flush-time=ms                  Bitmap mode flush time
      --bitmap-sectors-per-bit=INT            Number of 512-byte sectors per
                                              bit (bitmap mode)
      --cancel-deferred                       Cancel a previously set deferred
                                              device removal
      --data-device=path                      Path to data device (if
                                              separated)
      --debug                                 Show debug messages
      --deferred                              Device removal is deferred until
                                              the last user closes it
      --device-size=bytes                     Use only specified device size
                                              (ignore rest of device),
                                              DANGEROUS!
      --disable-blkid                         Disable blkid on-disk signature
                                              detection and wiping
  -I, --integrity=STRING                      Data integrity algorithm
  -B, --integrity-bitmap-mode                 Use bitmap to track changes and
                                              disable journal for integrity
                                              device
      --integrity-inline                      Use inline integrity mode (HW
                                              sector tags)
      --integrity-key-file=STRING             Read the integrity key from a
                                              file
      --integrity-key-size=bytes              The size of the data integrity
                                              key
      --integrity-legacy-padding              Use inefficient legacy padding
                                              (old kernels)
      --integrity-legacy-hmac                 Do not protect superblock with
                                              HMAC (old kernels)
      --integrity-legacy-recalculate          Allow recalculating of volumes
                                              with HMAC keys (old kernels)
  -D, --integrity-no-journal                  Disable journal for integrity
                                              device
      --integrity-recalculate                 Recalculate initial tags
                                              automatically
      --integrity-recalculate-reset           Reset automatic recalculate
                                              position
  -R, --integrity-recovery-mode               Recovery mode (no journal, no
                                              tag checking)
      --interleave-sectors=SECTORS            Interleave sectors
      --journal-commit-time=ms                Journal commit time
      --journal-integrity=STRING              Journal integrity algorithm
      --journal-integrity-key-size=bytes      The size of the journal
                                              integrity key
      --journal-integrity-key-file=STRING     Read the journal integrity key
                                              from a file
      --journal-crypt=STRING                  Journal encryption algorithm
      --journal-crypt-key-file=STRING         Read the journal encryption key
                                              from a file
      --journal-crypt-key-size=bytes          The size of the journal
                                              encryption key
  -j, --journal-size=bytes                    Journal size
      --journal-watermark=percent             Journal watermark
      --no-wipe                               Do not wipe device after format
      --progress-frequency=secs               Progress line update (in seconds)
      --progress-json                         Print wipe progress data in json
                                              format (suitable for machine
                                              processing)
  -s, --sector-size=bytes                     Sector size
  -b, --size=SECTORS                          The size of the device
  -t, --tag-size=bytes                        Tag size (per-sector)
  -v, --verbose                               Shows more detailed error
                                              messages
      --wipe                                  Wipe the end of the device after
                                              resize

<action> is one of:
	format <integrity_device> - format device
	open <integrity_device> <name> - open device as <name>
	close <name> - close device (remove mapping)
	status <name> - show active device status
	dump <integrity_device> - show on-disk information
	resize <name> - resize active device

<name> is the device to create under /dev/mapper
<integrity_device> is the device containing data with integrity tags

Default compiled-in dm-integrity parameters:
	Checksum algorithm: crc32c
	Maximum keyfile size: 4kB
Options (45)
OptionDescriptionSource
-?, --helpShow help text and default parameters.help + man
--usageShow short option help.help + man
-V, --versionShow the program version.help + man
--allow-discardsAllow the use of discard (TRIM) requests for the device.help + man
--allow-discards-keyedAllow secure keyed discards (aka TRIM) requests for devicehelp + man
-q, --batch-modeDo not ask for confirmation.help + man
--buffer-sectors SECTORSThe number of sectors in one buffer.help + man
--bitmap-flush-time msBitmap flush time in milliseconds.help + man
--bitmap-sectors-per-bit INTThe number of 512-byte sectors per bitmap bit must be a power of two.help + man
--cancel-deferredRemoves a previously configured deferred device removal in the close command.help + man
--data-device pathSpecify a separate data device that contains existing data.help + man
--debugRun in debug mode with full diagnostic logs.help + man
--deferredDefers device removal in the close command until the last user closes it.help + man
--device-size bytesUse only specified device size (ignore rest of device), DANGEROUS!help
--disable-blkidDisable blkid on-disk signature detection and wipinghelp
-I, --integrity STRINGUse internal integrity calculation (standalone mode).help + man
-B, --integrity-bitmap-modeUse alternate bitmap mode (available since Linux kernel 5.2), where dm-integrity uses a bitmap instead of a journal.help + man
--integrity-inlineStore integrity tags in hardware sector integrity fields.help + man
--integrity-key-file STRINGRead the integrity key from a filehelp + man
--integrity-key-size bytesThe size of the data integrity key.help + man
--integrity-legacy-paddingUse inefficient legacy padding (old kernels)help + man
--integrity-legacy-hmacUse old flawed HMAC calculation (also does not protect superblock).help + man
--integrity-legacy-recalculateAllow insecure recalculating of volumes with HMAC keys (recalculation offset in superblock is not protected).help + man
-D, --integrity-no-journalDisable the journal for the integrity device.help + man
--integrity-recalculateAutomatically recalculate integrity tags in the kernel on activation.help + man
--integrity-recalculate-resetRestart recalculation from the beginning of the device.help + man
-R, --integrity-recovery-modeRecovery mode (no journal, no tag checking).help + man
--interleave-sectors SECTORSThe number of interleaved sectors.help + man
--journal-commit-time msCommit time in milliseconds.help + man
--journal-integrity STRINGIntegrity algorithm for the journal area.help + man
--journal-integrity-key-size bytesThe size of the journal integrity key.help + man
--journal-integrity-key-file STRINGRead the journal integrity key from a filehelp + man
--journal-crypt STRINGEncryption algorithm for the journal data area.help + man
--journal-crypt-key-file STRINGRead the journal encryption key from a filehelp + man
--journal-crypt-key-size bytesThe size of the journal encryption key.help + man
-j, --journal-size bytesSize of the journal.help + man
--journal-watermark percentJournal watermark in percent.help + man
--no-wipeDo not wipe the device after formatting.help + man
--progress-frequency secsPrint a separate line every <seconds> with wipe progress.help + man
--progress-jsonPrints wipe progress data in JSON format, which is suitable mostly for machine processing.help + man
-s, --sector-size bytesSector size (power of two: 512, 1024, 2048, 4096).help + man
-b, --size SECTORSThe size of the devicehelp
-t, --tag-size bytesSize of the integrity tag per-sector (here, the integrity function will store the authentication tag).help + man
-v, --verbosePrint more information on command execution.help + man
--wipeWipe the newly allocated area after resizing to a bigger size.help + man

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.