summaryrefslogtreecommitdiff
path: root/Documentation/MANPAGE-XRAY.md
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation/MANPAGE-XRAY.md')
-rw-r--r--Documentation/MANPAGE-XRAY.md40
1 files changed, 40 insertions, 0 deletions
diff --git a/Documentation/MANPAGE-XRAY.md b/Documentation/MANPAGE-XRAY.md
new file mode 100644
index 0000000..e8952f6
--- /dev/null
+++ b/Documentation/MANPAGE-XRAY.md
@@ -0,0 +1,40 @@
+% GOCRYPTFS-XRAY(1)
+% github.com/rfjakob
+% Jan 2018
+
+NAME
+====
+
+gocryptfs-xray - examine gocryptfs-related data
+
+SYNOPSIS
+========
+
+#### Examine encrypted file/directory
+gocryptfs CIPHERDIR/ENCRYPTED-FILE-OR-DIR
+
+#### Decrypt and show master key
+gocryptfs -dumpmasterkey CIPHERDIR/gocryptfs.conf
+
+DESCRIPTION
+===========
+
+Available options are listed below.
+
+#### -dumpmasterkey
+Decrypts and shows the master key.
+
+EXAMPLES
+========
+
+Examine an encrypted file:
+
+ gocryptfs-xray myfs/mCXnISiv7nEmyc0glGuhTQ
+
+Print the master key:
+
+ gocryptfs-xray -dumpmasterkey myfs/gocryptfs.conf
+
+SEE ALSO
+========
+gocryptfs(1) fuse(8)