aboutsummaryrefslogtreecommitdiff
path: root/Documentation/MANPAGE.md
diff options
context:
space:
mode:
authorJakob Unterwurzacher2016-11-01 15:53:16 +0100
committerJakob Unterwurzacher2016-11-01 15:55:05 +0100
commit75b776cb3dd4cfb16c518e1ebd1447440989d847 (patch)
tree240d713beb27c287b1e381e545ca58af542bc183 /Documentation/MANPAGE.md
parente993fd5fbcf8c261cc71fcb96b7fb48dcae8eb2b (diff)
MANPAGE: add reverse example, move "-o" into alphabetical list
People will search for "-o" alphabetically, so put it into the alphabetical option list, even if it is not a real option.
Diffstat (limited to 'Documentation/MANPAGE.md')
-rw-r--r--Documentation/MANPAGE.md24
1 files changed, 13 insertions, 11 deletions
diff --git a/Documentation/MANPAGE.md b/Documentation/MANPAGE.md
index a7d3d8b..6f8939a 100644
--- a/Documentation/MANPAGE.md
+++ b/Documentation/MANPAGE.md
@@ -107,6 +107,11 @@ Options:
: Send USR1 to the specified process after successful mount. This is
used internally for daemonization.
+**-o COMMA-SEPARATED-OPTIONS**
+: For compatibility with mount(1), options are also accepted as
+ "-o COMMA-SEPARATED-OPTIONS" at the end of the command line.
+ For example, "-o q,zerokey" is equivalent to passing "-q -zerokey".
+
**-openssl bool/"auto"**
: Use OpenSSL instead of built-in Go crypto (default "auto"). Using
built-in crypto is 4x slower unless your CPU has AES instructions and
@@ -161,23 +166,20 @@ Options:
: Use all-zero dummy master key. This options is only intended for
automated testing as it does not provide any security.
-
-Comma-Separated-Options:
-
-For compatibility with mount(1), options are also accepted as
-"-o COMMA-SEPARATED-OPTIONS" at the end of the command line.
-For example, "-o q,zerokey" is equivalent to "-q -zerokey".
-
EXAMPLES
========
-Create and mount an encrypted filesystem:
+Create an encrypted filesystem in directory "g1" and mount it on "g2":
-mkdir /tmp/g1 /tmp/g2
+ mkdir g1 g2
+ gocryptfs -init g1
+ gocryptfs g1 g2
-gocryptfs -init /tmp/g1
-gocryptfs /tmp/g1 /tmp/g2
+Mount an ecrypted view of joe's home directory using reverse mode:
+ mkdir /home/joe.crypt
+ gocryptfs -init -reverse /home/joe
+ gocryptfs -reverse /home/joe /home/joe.crypt
SEE ALSO
========