summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDave Davenport <qball@gmpclient.org>2021-03-10 20:45:53 +0100
committerDave Davenport <qball@gmpclient.org>2021-03-10 20:45:53 +0100
commit53533acb77e75076530c699c94afd368e24a924d (patch)
tree8d37169b1615f4ba8421d22f6808593fd2b84db5
parent347bc9517c98c3b31f8ae967b5e467ce2492af2f (diff)
[Doc] update rofi-script to hint about coproc.
Thx to jose1711
-rw-r--r--doc/rofi-script.517
-rw-r--r--doc/rofi-script.5.markdown14
2 files changed, 30 insertions, 1 deletions
diff --git a/doc/rofi-script.5 b/doc/rofi-script.5
index 5c83915d..ff06dcb3 100644
--- a/doc/rofi-script.5
+++ b/doc/rofi-script.5
@@ -163,6 +163,23 @@ multiple entries can be passed using the \fB\fC\\x1f\fR separator.
.fi
.RE
+.SH Executing external program
+.PP
+If you want to launch an external program from the script, you need to make sure it is launched in the background.
+If not rofi will wait for its output (to display).
+
+.PP
+In bash the best way to do this is using \fB\fCcoproc\fR\&.
+
+.PP
+.RS
+
+.nf
+ coproc ( myApp > /dev/null 2>\&1 )
+
+.fi
+.RE
+
.SH DASH shell
.PP
If you use the \fB\fCdash\fR shell for your script, take special care with how dash handles escaped values for the separators.
diff --git a/doc/rofi-script.5.markdown b/doc/rofi-script.5.markdown
index 3c6eeae6..eaf932e0 100644
--- a/doc/rofi-script.5.markdown
+++ b/doc/rofi-script.5.markdown
@@ -2,7 +2,7 @@
## NAME
-**rofi script mode** - Rofi format for scriptable modi.
+**rofi script mode** - Rofi format for scriptable modi.
## DESCRIPTION
@@ -108,6 +108,18 @@ multiple entries can be passed using the `\x1f` separator.
echo -en "aap\0icon\x1ffolder\x1finfo\x1ftest\n"
```
+## Executing external program
+
+If you want to launch an external program from the script, you need to make sure it is launched in the background.
+If not rofi will wait for its output (to display).
+
+In bash the best way to do this is using `coproc`.
+
+```bash
+ coproc ( myApp > /dev/null 2>&1 )
+```
+
+
## DASH shell
If you use the `dash` shell for your script, take special care with how dash handles escaped values for the separators.