diff options
| author | Jakob Unterwurzacher | 2019-11-17 11:04:41 +0100 |
|---|---|---|
| committer | Jakob Unterwurzacher | 2019-11-17 11:04:41 +0100 |
| commit | 9178aa153442a94ca119e85c26e37b252702a8d9 (patch) | |
| tree | 7cc6f17644b6aab93efba10707a0cdc590a0f298 /Documentation/MANPAGE.md | |
| parent | 8ec804d825370ccf06fd9a7c6fb5589e3c2c17c2 (diff) | |
MANPAGE: describe how to unmount, and that default options are fine
Feedback received during the recent Go user group. If you haven't
used FUSE before, you don't know how to unmount, and it was not
described in the man page!
As for the options, there are many, and new users are intimidated
by it. State clearly that defaults are fine.
Diffstat (limited to 'Documentation/MANPAGE.md')
| -rw-r--r-- | Documentation/MANPAGE.md | 17 |
1 files changed, 11 insertions, 6 deletions
diff --git a/Documentation/MANPAGE.md b/Documentation/MANPAGE.md index 11d4151..55939f4 100644 --- a/Documentation/MANPAGE.md +++ b/Documentation/MANPAGE.md @@ -10,12 +10,15 @@ gocryptfs - create or mount an encrypted filesystem SYNOPSIS ======== -#### Initialize encrypted filesystem +#### Initialize new encrypted filesystem `gocryptfs -init [OPTIONS] CIPHERDIR` #### Mount `gocryptfs [OPTIONS] CIPHERDIR MOUNTPOINT [-o COMMA-SEPARATED-OPTIONS]` +#### Unmount +`fusermount -u MOUNTPOINT` + #### Change password `gocryptfs -passwd [OPTIONS] CIPHERDIR` @@ -35,7 +38,8 @@ security issues while providing good performance. OPTIONS ======= -Available options are listed below. +Available options are listed below. Usually, you don't need any. +Defaults are fine. #### -aessiv Use the AES-SIV encryption mode. This is slower than GCM but is @@ -494,11 +498,12 @@ In short: EXAMPLES ======== -Create an encrypted filesystem in directory "g1" and mount it on "g2": +Create an encrypted filesystem in directory "g1", mount it on "g2", +look at the contents, and umount again: - mkdir g1 g2 - gocryptfs -init g1 - gocryptfs g1 g2 + mkdir cipher mnt + gocryptfs -init cipher + gocryptfs cipher mnt Mount an ecrypted view of joe's home directory using reverse mode: |