hardcoresushi/libgocryptfs
1
0
Fork 0
Code Issues Pull Requests Releases Activity

MANPAGE: describe how to unmount, and that default options are fine

Browse Source 
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.
This commit is contained in:
Jakob Unterwurzacher 2019-11-17 11:04:41 +01:00
parent 8ec804d825
commit 9178aa1534
1 changed files with 11 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
Documentation/MANPAGE.md
View File

@ -10,12 +10,15 @@ gocryptfs - create or mount an encrypted filesystem
SYNOPSIS SYNOPSIS
======== ========
#### Initialize encrypted filesystem #### Initialize new encrypted filesystem
`gocryptfs -init [OPTIONS] CIPHERDIR` `gocryptfs -init [OPTIONS] CIPHERDIR`
#### Mount #### Mount
`gocryptfs [OPTIONS] CIPHERDIR MOUNTPOINT [-o COMMA-SEPARATED-OPTIONS]` `gocryptfs [OPTIONS] CIPHERDIR MOUNTPOINT [-o COMMA-SEPARATED-OPTIONS]`
#### Unmount
`fusermount -u MOUNTPOINT`
#### Change password #### Change password
`gocryptfs -passwd [OPTIONS] CIPHERDIR` `gocryptfs -passwd [OPTIONS] CIPHERDIR`
@ -35,7 +38,8 @@ security issues while providing good performance.
OPTIONS OPTIONS
======= =======
Available options are listed below. Available options are listed below. Usually, you don't need any.
Defaults are fine.
#### -aessiv #### -aessiv
Use the AES-SIV encryption mode. This is slower than GCM but is Use the AES-SIV encryption mode. This is slower than GCM but is
@ -494,11 +498,12 @@ In short:
EXAMPLES 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 mkdir cipher mnt
gocryptfs -init g1 gocryptfs -init cipher
gocryptfs g1 g2 gocryptfs cipher mnt
Mount an ecrypted view of joe's home directory using reverse mode: Mount an ecrypted view of joe's home directory using reverse mode: