~ecryptfs/ecryptfs/trunk

« back to all changes in this revision

Viewing changes to doc/manpage/ecryptfs-setup-private.1

  • Committer: Dustin Kirkland
  • Date: 2016-02-27 00:00:23 UTC
  • Revision ID: kirkland@ubuntu.com-20160227000023-h0e4oui5y1vbaurd
openingĀ 112

Show diffs side-by-side

added added

removed removed

Lines of Context:
3
3
ecryptfs-setup-private \- setup an eCryptfs private directory.
4
4
 
5
5
.SH SYNOPSIS
6
 
.BI "ecryptfs-setup-private [\-f|\-\-force] [\-w|\-\-wrapping] [\-a|\-\-all\-home] [\-n|\-\-no-fnek] [\-\-nopwcheck] [\-u|\-\-username USER] [\-l|\-\-loginpass LOGINPASS] [\-m|\-\-mountpass MOUNTPASS]"
 
6
.BI "ecryptfs-setup-private [\-f|\-\-force] [\-w|\-\-wrapping] [\-b|\-\-bootstrap] [\-n|\-\-no-fnek] [\-\-nopwcheck] [\-u|\-\-username USER] [\-l|\-\-loginpass LOGINPASS] [\-m|\-\-mountpass MOUNTPASS]"
7
7
 
8
8
.SH OPTIONS
9
9
Options available for the \fBecryptfs-setup-private\fP command:
21
21
System passphrase for USER, used to wrap MOUNTPASS, will interactively prompt if omitted
22
22
.TP
23
23
.B \-m, \-\-mountpass MOUNTPASS
24
 
Passphrase for mounting the ecryptfs directory, default is 16 bytes from /dev/urandom if omitted
 
24
Passphrase for mounting the ecryptfs directory, default is 16 bytes from /dev/random if omitted
25
25
.TP
26
 
.B \-a, \-\-all\-home
27
 
Generate a setup for encrypting the user's entire home directory
 
26
.B \-b, \-\-bootstrap
 
27
Bootstrap a new user's entire home directory
28
28
.TP
29
29
.B \-\-undo
30
30
Display instructions on how to undo an encrypted private setup
43
43
 
44
44
 
45
45
.SH DESCRIPTION
46
 
\fBecryptfs-setup-private\fP is a program that sets up a private cryptographic mountpoint for a non-root user, who is a member of \fBecryptfs\fP group.
 
46
\fBecryptfs-setup-private\fP is a program that sets up a private cryptographic mountpoint for a non-root user.
47
47
 
48
48
Be sure to properly escape your parameters according to your shell's special character nuances, and also surround the parameters by double quotes, if necessary. Any of the parameters may be:
49
49
 
89
89
\fI/usr/share/doc/ecryptfs-utils/ecryptfs-faq.html\fP
90
90
 
91
91
.TP
92
 
\fIhttp://launchpad.net/ecryptfs/\fP
 
92
\fIhttp://ecryptfs.org/\fP
93
93
.PD
94
94
 
95
95
.SH AUTHOR
96
 
This manpage and the \fBecryptfs-setup-private\fP utility was written by Dustin Kirkland <kirkland@canonical.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.
 
96
This manpage and the \fBecryptfs-setup-private\fP 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.
97
97
 
98
 
On Debian systems, the complete text of the GNU General Public License can be found in /usr/share/common-licenses/GPL.
 
98
On Debian and Ubuntu systems, the complete text of the GNU General Public License can be found in /usr/share/common-licenses/GPL.