diff options
| -rw-r--r-- | .gitignore | 5 | ||||
| -rwxr-xr-x | MANPAGE-render.bash | 7 | ||||
| -rw-r--r-- | MANPAGE.md | 71 | ||||
| -rw-r--r-- | USAGE.txt | 24 |
4 files changed, 82 insertions, 25 deletions
@@ -1,4 +1,4 @@ -# binary +# the gocryptfs executable /gocryptfs # temporary files created by the tests @@ -6,3 +6,6 @@ # binary releases /*.tar.gz + +# manpage generated by MANPAGE-render.bash +/gocryptfs.1 diff --git a/MANPAGE-render.bash b/MANPAGE-render.bash new file mode 100755 index 0000000..9ea268d --- /dev/null +++ b/MANPAGE-render.bash @@ -0,0 +1,7 @@ +#!/bin/bash + +set -eux + +# Render MANPAGE.md to a proper man(1) manpage + +pandoc MANPAGE.md -s -t man -o gocryptfs.1 && man ./gocryptfs.1 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 + diff --git a/USAGE.txt b/USAGE.txt deleted file mode 100644 index 3e33074..0000000 --- a/USAGE.txt +++ /dev/null @@ -1,24 +0,0 @@ -Usage: gocryptfs [OPTIONS] CIPHERDIR MOUNTPOINT - -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 - -openssl - 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 - -version - Print version and exit - -zerokey - Use all-zero dummy master key |