Merge branch 'upstream' into tizen
[platform/upstream/cryptsetup.git] / man / cryptsetup-luksSuspend.8.adoc
1 = cryptsetup-luksSuspend(8)
2 :doctype: manpage
3 :manmanual: Maintenance Commands
4 :mansource: cryptsetup {release-version}
5 :man-linkstyle: pass:[blue R < >]
6 :COMMON_OPTIONS:
7 :ACTION_LUKSSUSPEND:
8
9 == Name
10
11 cryptsetup-luksSuspend - suspends an active device and wipes the key
12
13 == SYNOPSIS
14
15 *cryptsetup _luksSuspend_ [<options>] <name>*
16
17 == DESCRIPTION
18
19 Suspends an active device (all IO operations will block and accesses to
20 the device will wait indefinitely) and wipes the encryption key from
21 kernel memory. Needs kernel 2.6.19 or later.
22
23 After this operation, you have to use _luksResume_ to reinstate the
24 encryption key and unblock the device or _close_ to remove the mapped
25 device.
26
27 *<options>* can be [--header, --disable-locks].
28
29 *WARNING:* Never suspend the device on which the cryptsetup binary
30 resides.
31
32 include::man/common_options.adoc[]
33 include::man/common_footer.adoc[]