From 1660d4b7a65d9ad2ce0deaa19d35579ca4084ac5 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Wed, 17 Apr 2024 10:06:26 +0200 Subject: Adding upstream version 2:2.6.1. Signed-off-by: Daniel Baumann --- man/cryptsetup-luksFormat.8.adoc | 51 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 51 insertions(+) create mode 100644 man/cryptsetup-luksFormat.8.adoc (limited to 'man/cryptsetup-luksFormat.8.adoc') diff --git a/man/cryptsetup-luksFormat.8.adoc b/man/cryptsetup-luksFormat.8.adoc new file mode 100644 index 0000000..be241f8 --- /dev/null +++ b/man/cryptsetup-luksFormat.8.adoc @@ -0,0 +1,51 @@ += cryptsetup-luksFormat(8) +:doctype: manpage +:manmanual: Maintenance Commands +:mansource: cryptsetup {release-version} +:man-linkstyle: pass:[blue R < >] +:COMMON_OPTIONS: +:ACTION_LUKSFORMAT: + +== Name + +cryptsetup-luksFormat - initialize a LUKS partition and set the initial passphrase + +== SYNOPSIS + +*cryptsetup _luksFormat_ [] []* + +== DESCRIPTION + +Initializes a LUKS partition and sets the initial passphrase (for +key-slot 0), either via prompting or via . Note that if the +second argument is present, then the passphrase is taken from the file +given there, without the need to use the --key-file option. Also note +that for both forms of reading the passphrase from a file you can give +'-' as file name, which results in the passphrase being read from stdin +and the safety-question being skipped. + +You cannot call luksFormat on a device or filesystem that is mapped or +in use, e.g., mounted filesystem, used in LVM, active RAID member, etc. The +device or filesystem has to be un-mounted in order to call luksFormat. + +To use specific version of LUKS format, use _--type luks1_ or _type luks2_. + +** can be [--hash, --cipher, --verify-passphrase, --key-size, +--key-slot, --key-file (takes precedence over optional second argument), +--keyfile-offset, --keyfile-size, --use-random, --use-urandom, --uuid, +--volume-key-file, --iter-time, --header, --pbkdf-force-iterations, +--force-password, --disable-locks, --timeout, --type, --offset, +--align-payload (deprecated)]. + +For LUKS2, additional ** can be [--integrity, +--integrity-no-wipe, --sector-size, --label, --subsystem, --pbkdf, +--pbkdf-memory, --pbkdf-parallel, --disable-locks, --disable-keyring, +--luks2-metadata-size, --luks2-keyslots-size, --keyslot-cipher, +--keyslot-key-size, --integrity-legacy-padding]. + +*WARNING:* Doing a luksFormat on an existing LUKS container will make +all data in the old container permanently irretrievable unless you have a +header backup. + +include::man/common_options.adoc[] +include::man/common_footer.adoc[] -- cgit v1.2.3