diff options
author | Jakob Unterwurzacher | 2015-11-11 09:15:14 +0100 |
---|---|---|
committer | Jakob Unterwurzacher | 2015-11-11 09:15:14 +0100 |
commit | 0084087d35cd8eed4b9a1fa39f532beb612c9c21 (patch) | |
tree | 1203637e255a9860a0ada040c873fa3376db2870 /MANPAGE.md | |
parent | e43733ca0d995a48324ef75c952cc6cf25000650 (diff) |
Add MANPAGE.md and MANPAGE-render.bash
MANPAGE-render.bash renders the markdown to a proper man(1) manpage
Diffstat (limited to 'MANPAGE.md')
-rw-r--r-- | MANPAGE.md | 71 |
1 files changed, 71 insertions, 0 deletions
diff --git a/MANPAGE.md b/MANPAGE.md new file mode 100644 index 0000000..14bf188 --- /dev/null +++ b/MANPAGE.md @@ -0,0 +1,71 @@ +% GOCRYPTFS(1) +% github.com/rfjakob +% Nov 2015 + +NAME +==== + +gocryptfs - mount and encrypted directory + +SYNOPSIS +======== + +Initialize encrypted filesystem +------------------------------- + +gocryptfs -init [OPTIONS] CIPHERDIR + +Mount +----- + +gocryptfs [OPTIONS] CIPHERDIR MOUNTPOINT + +Change password +--------------- + +gocryptfs -passwd CIPHERDIR + +DESCRIPTION +=========== + +Options: + +**-cpuprofile string** +: Write cpu profile to specified file + +**-debug** +: Enable debug output + +**-f** +: Stay in the foreground + +**-fusedebug** +: Enable fuse library debug output + +**-init** +: Initialize encrypted directory + +**-masterkey string** +: Mount with explicit master key + +**-notifypid int** +: Send USR1 to the specified process after successful mount - used internally for daemonization + +**-openssl bool** +: Use OpenSSL instead of built-in Go crypto (default true) + +**-passwd** +: Change password + +**-plaintextnames** +: Do not encrypt file names - can only be used together with -init + +**-q** +: Quiet - silence informational messages + +**-version** +: Print version and exit + +**-zerokey** +: Use all-zero dummy master key + |