← Back to branch summary

~ubuntu-branches/debian/stretch/ecryptfs-utils/stretch

« back to all changes in this revision

Viewing changes to doc/manpage/ecryptfs-migrate-home.8

  • Committer: Package Import Robot
  • Author(s): Daniel Baumann
  • Date: 2013-02-09 08:07:34 UTC
  • mto: This revision was merged to the branch mainline in revision 35.
  • Revision ID: package-import@ubuntu.com-20130209080734-998qg3tcjjvaof00
Tags: upstream-103
Import upstream version 103

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/manpage/ecryptfs-migrate-home.8
 
1
.TH ecryptfs-migrate-home 8 2012-01-24 ecryptfs-utils "eCryptfs"
 
2
.SH NAME
 
3
ecryptfs-migrate-home \- migrate a user's home to directory to an encrypted home setup
 
4
 
 
5
.SH SYNOPSIS
 
6
\fBecryptfs-migrate-home\fP [-u|--user USER]
 
7
 
 
8
.SH OPTIONS
 
9
.TP
 
10
.B -u, --user USER
 
11
Migrate USER's home directory to an encrypted home directory
 
12
 
 
13
.SH DESCRIPTION
 
14
\fBWARNING\fP: Make a complete backup copy of the non-encrypted data to another system or external media. This script is dangerous and in case of an error, could result in data lost, or lock USER out of the system!
 
15
 
 
16
This program must be executed by root.
 
17
 
 
18
This program will attempt to migrate a user's home directory to an encrypted home directory.
 
19
 
 
20
This program requires free disk space 2.5x the current size of the home directory to be migrated.  Once successful, you can recover most of this space by deleting the cleartext directory.
 
21
 
 
22
The USER must be logged out of all sessions in order to perform the migration, and have no open files according to \fBlsof\fP(1).
 
23
 
 
24
Once the migration has completed, the USER must login immediately, \fbBEFORE THE NEXT REBOOT\fP in order to complete the migration.
 
25
 
 
26
After logging in, if USER can read and write files in their home directory successfully, then the migration has completed successfully and can remove the cleartext backup in \fI/home/\fP.
 
27
 
 
28
After a successful migration, the USER really must run \fBecryptfs-unwrap-passphrase\fP(1) or \fBzescrow\fP(1) and record their randomly generated mount passphrase.
 
29
 
 
30
If swap is not already encrypted, it is highly recommended that your administrator setup encrypted swap using \fBecryptfs-setup-swap\fP(1).
 
31
 
 
32
.SH SEE ALSO
 
33
\fBecryptfs-unwrap-passphrase\fP(1), \fBecryptfs-setup-private\fP(1), \fBecryptfs-setup-swap\fP(1), \fBlsof\fP(1), \fBrsync\fP(1), \fBzescrow\fP(1)
 
34
 
 
35
\fIhttp://ecryptfs.org/\fP
 
36
 
 
37
.SH AUTHOR
 
38
This manpage 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.
 
39
 
 
40
On Debian and Ubuntu systems, the complete text of the GNU General Public License can be found in /usr/share/common-licenses/GPL.