← Back to branch summary

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

« back to all changes in this revision

Viewing changes to doc/manpage/umount.ecryptfs_private.1

  • Committer: Bazaar Package Importer
  • Author(s): Daniel Baumann
  • Date: 2008-10-24 06:42:00 UTC
  • mfrom: (1.1.11 upstream)
  • mto: This revision was merged to the branch mainline in revision 10.
  • Revision ID: james.westby@ubuntu.com-20081024064200-oh6xmd4e4ogs7m2l
Tags: 63-1
Merging upstream version 63.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/manpage/umount.ecryptfs_private.1
 
1
.TH umount.ecryptfs_private 1 "2008-07-21" ecryptfs-utils "eCryptfs"
 
2
.SH NAME
 
3
umount.ecryptfs_private \- eCryptfs private unmount helper.
 
4
 
 
5
.SH SYNOPSIS
 
6
\fBumount.ecryptfs_private\fP [\-f]
 
7
 
 
8
.SH OPTIONS
 
9
Options available for the \fBumount.ecryptfs_private\fP command:
 
10
.TP
 
11
.B \-f
 
12
Force the unmount, ignoring the value of the mount counter in \fI/tmp/ecryptfs-USERNAME-Private\fP
 
13
 
 
14
.SH DESCRIPTION
 
15
\fBumount.ecryptfs_private\fP is a mount helper utility for non-root users to unmount a cryptographically mounted private directory, ~/Private.
 
16
 
 
17
If, and only if:
 
18
  - the private mount passphrase is in their kernel keyring, and
 
19
  - the current user owns both ~/.Private and ~/Private, and
 
20
  - ~/.Private is currently mounted on ~/Private
 
21
  - the mount counter is 0 (counter is ignored if \-f option is used)
 
22
 
 
23
This program will:
 
24
  - unmount ~/Private
 
25
 
 
26
The only setuid operationis in this program are the call to \fBumount\fP and updating \fB/etc/mtab\fP.
 
27
 
 
28
The system administrator can add the pam_ecryptfs.so module to the PAM stack and automatically perform the unmount on logout. See \fBpam_ecryptfs\fP(8).
 
29
 
 
30
.SH FILES
 
31
\fI~/.Private\fP - underlying directory containing encrypted data
 
32
 
 
33
\fI~/Private\fP - mountpoint containing decrypted data (when mounted)
 
34
 
 
35
\fI~/.ecryptfs/Private.sig\fP - file containing signature of mountpoint passphrase
 
36
 
 
37
\fI/tmp/ecryptfs-USERNAME-Private\fP - file containing the mount counter, incremented on each mount, decremented on each unmount
 
38
 
 
39
.SH SEE ALSO
 
40
.PD 0
 
41
.TP
 
42
\fBecryptfs\fP(7), \fBecryptfs-setup-private\fP(1), \fBkeyctl\fP(1), \fBmount\fP(8), \fBmount.ecryptfs_private\fP(1), \fBpam_ecryptfs\fP(8)
 
43
 
 
44
.TP
 
45
\fI/usr/share/doc/ecryptfs-utils/ecryptfs-faq.html\fP
 
46
 
 
47
.TP
 
48
\fIhttp://ecryptfs.sourceforge.net/\fP
 
49
.PD
 
50
 
 
51
.SH AUTHOR
 
52
This manpage and the \fBumount.ecryptfs_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.
 
53
 
 
54
On Debian systems, the complete text of the GNU General Public License can be found in /usr/share/common-licenses/GPL.