diff options
author | Jakob Unterwurzacher | 2015-12-01 18:19:24 +0100 |
---|---|---|
committer | Jakob Unterwurzacher | 2015-12-01 18:19:24 +0100 |
commit | accf8144ca627ffc0a282259d28b8fe6e583eed6 (patch) | |
tree | 41b4279a84faa2e5b621e7277376bc63be4f0007 /Documentation/MANPAGE.md | |
parent | cbb18380bee538f3b1f26e3588857bcdf8a1b964 (diff) |
Move docs to Documentation folder
Diffstat (limited to 'Documentation/MANPAGE.md')
-rw-r--r-- | Documentation/MANPAGE.md | 79 |
1 files changed, 79 insertions, 0 deletions
diff --git a/Documentation/MANPAGE.md b/Documentation/MANPAGE.md new file mode 100644 index 0000000..517cc82 --- /dev/null +++ b/Documentation/MANPAGE.md @@ -0,0 +1,79 @@ +% GOCRYPTFS(1) +% github.com/rfjakob +% Nov 2015 + +NAME +==== + +gocryptfs - mount an encrypted directory + +SYNOPSIS +======== + +Initialize encrypted filesystem +------------------------------- + +gocryptfs -init [OPTIONS] CIPHERDIR + +Mount +----- + +gocryptfs [OPTIONS] CIPHERDIR MOUNTPOINT + +Change password +--------------- + +gocryptfs -passwd [OPTIONS] CIPHERDIR + +DESCRIPTION +=========== + +Options: + +**-config string** +: Use specified config file instead of CIPHERDIR/gocryptfs.conf + +**-cpuprofile string** +: Write cpu profile to specified file + +**-debug** +: Enable debug output + +**-extpass string** +: Use an external program (like ssh-askpass) for the password prompt. +The program should return the password on stdout, a trailing newline is +stripped by gocryptfs. + +**-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 + +**-q** +: Quiet - silence informational messages + +**-version** +: Print version and exit + +**-zerokey** +: Use all-zero dummy master key + |