From 5af7d3c699d1f78ba81b447285dd4ebae78ee644 Mon Sep 17 00:00:00 2001
From: Jakob Unterwurzacher
Date: Sun, 10 May 2020 00:14:03 +0200
Subject: gocryptfs-xray: document -encrypt-paths / -decrypt-paths

---
 Documentation/MANPAGE-XRAY.md | 20 ++++++++++++++++++++
 gocryptfs-xray/xray_main.go   |  3 ++-
 2 files changed, 22 insertions(+), 1 deletion(-)

diff --git a/Documentation/MANPAGE-XRAY.md b/Documentation/MANPAGE-XRAY.md
index da041b6..5a5162c 100644
--- a/Documentation/MANPAGE-XRAY.md
+++ b/Documentation/MANPAGE-XRAY.md
@@ -16,18 +16,32 @@ gocryptfs-xray CIPHERDIR/ENCRYPTED-FILE-OR-DIR
 #### Decrypt and show master key
 gocryptfs-xray -dumpmasterkey CIPHERDIR/gocryptfs.conf
 
+#### Encrypt paths
+gocryptfs-xray -encrypt-paths SOCKET
+
 DESCRIPTION
 ===========
 
 Available options are listed below.
 
+#### -0
+Use \\0 instead of \\n as separator for -decrypt-paths and -encrypt-paths.
+
 #### -aessiv
 Assume AES-SIV mode instead of AES-GCM when examining an encrypted file.
 Is not needed and has no effect in `-dumpmasterkey` mode.
 
+#### -decrypt-paths
+Decrypt file paths using gocryptfs control socket. Reads from stdin.
+See `-ctlsock` in gocryptfs(1).
+
 #### -dumpmasterkey
 Decrypts and shows the master key.
 
+#### -encrypt-paths
+Encrypt file paths using gocryptfs control socket. Reads from stdin.
+See `-ctlsock` in gocryptfs(1).
+
 EXAMPLES
 ========
 
@@ -39,6 +53,12 @@ Print the master key:
 
 	gocryptfs-xray -dumpmasterkey myfs/gocryptfs.conf
 
+Mount gocryptfs with control socket and use gocryptfs-xray to
+encrypt some paths:
+
+    gocryptfs -ctlsock myfs.sock myfs myfs.mnt
+    echo -e "foo\nbar" | gocryptfs-xray -encrypt-paths myfs.sock
+
 SEE ALSO
 ========
 gocryptfs(1) fuse(8)
diff --git a/gocryptfs-xray/xray_main.go b/gocryptfs-xray/xray_main.go
index 8dcaf8d..ea000c0 100644
--- a/gocryptfs-xray/xray_main.go
+++ b/gocryptfs-xray/xray_main.go
@@ -46,7 +46,8 @@ func usage() {
 	fmt.Fprintf(os.Stderr, "\n"+
 		"Examples:\n"+
 		"  gocryptfs-xray myfs/mCXnISiv7nEmyc0glGuhTQ\n"+
-		"  gocryptfs-xray -dumpmasterkey myfs/gocryptfs.conf\n")
+		"  gocryptfs-xray -dumpmasterkey myfs/gocryptfs.conf\n"+
+		"  gocryptfs-xray -encrypt-paths myfs.sock\n")
 }
 
 // sum counts the number of true values
-- 
cgit v1.2.3