mirror of
https://gitlab.com/cryptsetup/cryptsetup.git
synced 2025-12-11 19:00:02 +01:00
Split manual pages into per-action page and use AsciiDoc format
Use pre-generated man pages in make dist. [Added fixes and updates from Ondrej Kozina and Milan Broz]
This commit is contained in:
committed by
Milan Broz
parent
fec2517386
commit
a2afe0396f
50
man/cryptsetup-luksFormat.8.adoc
Normal file
50
man/cryptsetup-luksFormat.8.adoc
Normal file
@@ -0,0 +1,50 @@
|
||||
= 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_ [<options>] <device> [<key file>]*
|
||||
|
||||
== DESCRIPTION
|
||||
|
||||
Initializes a LUKS partition and sets the initial passphrase (for
|
||||
key-slot 0), either via prompting or via <key file>. 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 LUKS2, specify _--type luks2_.
|
||||
|
||||
*<options>* 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].
|
||||
|
||||
For LUKS2, additional *<options>* 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].
|
||||
|
||||
*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[]
|
||||
Reference in New Issue
Block a user