Skip to content

Commit 7883d38

Browse files
committed
MANPAGE: emphasize that -reverse implies -aessiv, so you must specify it with -masterkey
Fixes: #841
1 parent 8ced867 commit 7883d38

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

Documentation/MANPAGE.md

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,10 @@ mounted using gocryptfs v1.2 and higher. Default true.
155155

156156
#### -reverse
157157
Reverse mode shows a read-only encrypted view of a plaintext
158-
directory. Implies "-aessiv".
158+
directory. Implies `-aessiv`.
159+
160+
If you want to mount the encrypted view using `-masterkey`, you *must*
161+
specify `-aessiv`.
159162

160163
#### -xchacha
161164
Use XChaCha20-Poly1305 file content encryption. This should be much faster
@@ -501,10 +504,14 @@ settings have to be passed on the command line: `-aessiv` when you
501504
mount a filesystem that was created using reverse mode, or
502505
`-plaintextnames` for a filesystem that was created with that option.
503506

504-
Examples:
507+
Example 1: Mount a filesystem that was created using default options:
508+
509+
gocryptfs -masterkey=6f717d8b-6b5f8e8a-fd0aa206-778ec093-62c5669b-abd229cd-241e00cd-b4d6713d cipher mnt
510+
gocryptfs -masterkey=stdin cipher mnt
511+
512+
Example 2: Mount a `gocryptfs -reverse` filesystem (note that you *must* specify `-aessiv`):
505513

506-
-masterkey=6f717d8b-6b5f8e8a-fd0aa206-778ec093-62c5669b-abd229cd-241e00cd-b4d6713d
507-
-masterkey=stdin
514+
gocryptfs -masterkey=stdin -aessiv cipher mnt
508515

509516
Applies to: all actions that ask for a password.
510517

0 commit comments

Comments
 (0)