From 48fa484f1838d10067e355f57faa3334657d0e0c Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Daniel=20Ekl=C3=B6f?= <daniel@ekloef.se>
Date: Wed, 15 Jul 2020 17:48:37 +0200
Subject: [PATCH] doc: foot.5: document pipe-visible and pipe-scrollback

---
 doc/foot.5.scd | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/doc/foot.5.scd b/doc/foot.5.scd
index 747c9cb3..2673bfef 100644
--- a/doc/foot.5.scd
+++ b/doc/foot.5.scd
@@ -234,6 +234,23 @@ e.g. *search-start=none*.
 *fullscreen*
 	Toggles the fullscreen state. Default: _not bound_.
 
+*pipe-visible*, *pipe-scrollback*
+	Pipes the currently visible text, or the entire scrollback, to an
+	external tool. The syntax for this option is a bit special; the
+	first part of the value is the command to execute enclosed in
+	"[]", followed by the binding(s).
+	
+	You can configure multiple pipes as long as the command strings
+	are different and the key bindings are unique.
+	
+	Note that the command is *not* automatically run inside a shell;
+	use *sh -c "command line"* if you need that.
+	
+	Example:
+		*pipe-visible=[sh -c "xurls | fuzzel --dmenu | xargs -r firefox"] Control+Print*
+	
+	Default: _not bound_
+
 # SECTION: mouse-bindings
 
 This section lets you override the default mouse bindings.