summaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorFelix Lechner2018-01-10 11:27:03 -0800
committerrfjakob2018-01-10 20:27:03 +0100
commita4dff6aea0b761a49ba3f3b6f25b7442c846afcf (patch)
tree70f97a7ed7980a7cc649fc2a5eb1f71eb0106c48 /Documentation
parent63c3878b7cafd518514e7f3f7267af8bbd42bfd3 (diff)
Provide basic man page for xray tool (#193)
Provide basic man page for xray tool
Diffstat (limited to 'Documentation')
-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)