aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Eklöf <daniel@ekloef.se>2020-07-15 15:48:37 +0000
committerDaniel Eklöf <daniel@ekloef.se>2020-07-15 15:48:37 +0000
commit48fa484f1838d10067e355f57faa3334657d0e0c (patch)
treed1acde4927375bc2a8945d30c4fd22254671560f
parentconfig: oopsie, need to use strndup() on the pipe command (diff)
doc: foot.5: document pipe-visible and pipe-scrollback
-rw-r--r--doc/foot.5.scd17
1 files changed, 17 insertions, 0 deletions
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.