veritysetup 2.8.8 flags: UDEV BLKID KEYRING FIPS KERNEL_CAPI HW_OPAL
Usage: veritysetup [OPTION...] <action> <action-specific>
Help options:
-?, --help Show this help message
--usage Display brief usage
-V, --version Print package version
--cancel-deferred Cancel a previously set deferred device
removal
--check-at-most-once Verify data block only the first time
it is read
--data-block-size=bytes Block size on the data device
--data-blocks=blocks The number of blocks in the data file
--debug Show debug messages
--deferred Device removal is deferred until the
last user closes it
--error-as-corruption Handle IO error as corruption.
--fec-device=path Path to device with error correction
data
--fec-offset=bytes Starting offset on the FEC device
--fec-roots=bytes FEC parity bytes
--format=number Format type (1 - normal, 0 - original
Chrome OS)
-h, --hash=string Hash algorithm
--hash-block-size=bytes Block size on the hash device
--hash-offset=bytes Starting offset on the hash device
--ignore-corruption Ignore corruption, log it only
--ignore-zero-blocks Do not verify zeroed blocks
--no-superblock Do not use verity superblock
--panic-on-corruption Panic kernel if corruption is detected
--restart-on-corruption Restart kernel if corruption is detected
--root-hash-file=STRING Path to root hash file
--root-hash-signature=STRING Path to root hash signature file
-s, --salt=hex string Salt
--shared Share data device with another verity
segment
--use-tasklets Use kernel tasklets for performance
--uuid=STRING UUID for device to use
-v, --verbose Shows more detailed error messages
<action> is one of:
format <data_device> <hash_device> - format device
verify <data_device> <hash_device> [<root_hash>] - verify device
open <data_device> <name> <hash_device> [<root_hash>] - open device as <name>
close <name> - close device (remove mapping)
status <name> - show active device status
dump <hash_device> - show on-disk information
<name> is the device to create under /dev/mapper
<data_device> is the data device
<hash_device> is the device containing verification data
<root_hash> hash of the root node on <hash_device>
Default compiled-in dm-verity parameters:
Hash: sha256, Data block (bytes): 4096, Hash block (bytes): 4096, Salt size: 32, Hash format: 1
Options (30)
| Option | Description | Source |
|---|
-?, --help | Show help text and default parameters. | help + man |
--usage | Show short option help. | help + man |
-V, --version | Show the program version. | help + man |
--cancel-deferred | Cancels a previously configured deferred device removal in the close command. | help + man |
--check-at-most-once | Instruct the kernel to verify blocks only once they are read from the data device, rather than every time. | help + man |
--data-block-size bytes | Used block size for the data device. | help + man |
--data-blocks blocks | Size of the data device used in verification. | help + man |
--debug | Run in debug mode with full diagnostic logs. | help + man |
--deferred | Defers device removal in the close command until the last user closes it. | help + man |
--error-as-corruption | Handle device I/O errors the same as data corruption. | help + man |
--fec-device path | Use forward error correction (FEC) to recover from corruption if hash verification fails. | help + man |
--fec-offset bytes | This is the offset, in bytes, from the start of the FEC device to the beginning of the encoding data. | help + man |
--fec-roots bytes | Number of generator roots. | help + man |
--format number | Format type (1 - normal, 0 - original Chrome OS) | help + man |
-h, --hash string | Hash algorithm for dm-verity. | help + man |
--hash-block-size bytes | Used block size for the hash device. | help + man |
--hash-offset bytes | Offset of hash area/superblock on hash_device. | help + man |
--ignore-corruption | Defines what to do if a data integrity problem (data corruption) is detected. | help + man |
--ignore-zero-blocks | Instruct the kernel not to verify blocks expected to contain zeroes and always directly return zeroes instead. | help + man |
--no-superblock | Create or use dm-verity without a permanent on-disk superblock. | help + man |
--panic-on-corruption | Panic kernel if corruption is detected | help |
--restart-on-corruption | Restart kernel if corruption is detected | help |
--root-hash-file STRING | Path to file with stored root hash in hex-encoded text. | help + man |
--root-hash-signature STRING | A path to the root hash signature file used to verify the root hash (in kernel). | help + man |
-s, --salt hex | Salt used for formatting or verification. | help + man |
--shared | Allows the data device to be used in shared mode. | help + man |
--use-tasklets | Try to use kernel tasklets in the dm-verity driver for performance reasons. | help + man |
--uuid STRING | Use the provided UUID for the format command instead of generating a new one. | help + man |
-v, --verbose | Print more information on command execution. | help + man |
--batch-mode, -q | Do not ask for confirmation. (in the manual page but not in --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.