summaryrefslogtreecommitdiff
path: root/doc/manpage/ecryptfs-setup-swap.1
diff options
context:
space:
mode:
authorJussi Laako <jussi.laako@linux.intel.com>2014-03-25 15:25:44 +0200
committerJussi Laako <jussi.laako@linux.intel.com>2014-03-25 15:26:50 +0200
commitbb0ada3bddfeeb4e98d3415c37266061c865005f (patch)
treef644444272c1a5f01b333977a94677bdc80f2184 /doc/manpage/ecryptfs-setup-swap.1
downloadecryptfs-utils-bb0ada3bddfeeb4e98d3415c37266061c865005f.tar.gz
ecryptfs-utils-bb0ada3bddfeeb4e98d3415c37266061c865005f.tar.bz2
ecryptfs-utils-bb0ada3bddfeeb4e98d3415c37266061c865005f.zip
Change-Id: I5f609bdfdf73bda344b01c41519f6cd65ea76f55
Diffstat (limited to 'doc/manpage/ecryptfs-setup-swap.1')
-rw-r--r--doc/manpage/ecryptfs-setup-swap.129
1 files changed, 29 insertions, 0 deletions
diff --git a/doc/manpage/ecryptfs-setup-swap.1 b/doc/manpage/ecryptfs-setup-swap.1
new file mode 100644
index 0000000..7104436
--- /dev/null
+++ b/doc/manpage/ecryptfs-setup-swap.1
@@ -0,0 +1,29 @@
+.TH ecryptfs-setup-swap 1 2009-08-17 ecryptfs-utils "eCryptfs"
+.SH NAME
+ecryptfs-setup-swap \- ensure that any swap space is encrypted
+
+.SH SYNOPSIS
+\fBecryptfs-setup-swap\fP [-f|--force]
+
+.SH DESCRIPTION
+This script will detect existing swap partitions or swap files, and encrypt them, using cryptsetup.
+
+Encrypted swap is essential to securing any system using eCryptfs, since decrypted file contents will exist in the system's memory, which may be swapped to disk at any time. If the system swap space is not also encrypted, it is possible that decrypted files could be written to disk in clear text.
+
+Note that most Linux distributions do not yet support resuming from an encrypted swap space, and thus hibernate/resume will not work. Suspend/resume is unaffected.
+
+Upon running the utility, the user will be informed of the hibernate/resume break, and asked to confirm the behavior. The -f|--force option can be used to bypass this interactive prompt.
+
+.SH SEE ALSO
+.PD 0
+.TP
+\fBcryptsetup\fP(8)
+
+.TP
+\fIhttp://ecryptfs.org/\fP
+.PD
+
+.SH AUTHOR
+This manpage and the utility was written by Dustin Kirkland <kirkland@ubuntu.com> for Ubuntu systems (but may be used by others). Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 2 or any later version published by the Free Software Foundation.
+
+On Debian and Ubuntu systems, the complete text of the GNU General Public License can be found in /usr/share/common-licenses/GPL.