From 1342b733af6a8de481ac35a33cb352c21efcd0b5 Mon Sep 17 00:00:00 2001
From: Dave Davenport <qball@gmpclient.org>
Date: Sun, 24 May 2020 19:09:06 +0200
Subject: [Script] Add 'info' row option, that gets passed to ROFI_INFO
 environment.

---
 doc/rofi-script.5          | 18 ++++++++++++++++++
 doc/rofi-script.5.markdown | 11 +++++++++++
 2 files changed, 29 insertions(+)

(limited to 'doc')

diff --git a/doc/rofi-script.5 b/doc/rofi-script.5
index e5fa1b96..93318765 100644
--- a/doc/rofi-script.5
+++ b/doc/rofi-script.5
@@ -73,6 +73,10 @@ An integer number with the current state:
 .IP \(bu 2
 \fB10\-28\fP: Custom keybinding 1\-19
 
+.SS \fB\fCROFI\_INFO\fR
+.PP
+Environment get set when selected entry get set with the property value of the 'info' row option, if set.
+
 .SH Passing mode options
 .PP
 Extra options, like setting the prompt, can be set by the script.
@@ -132,6 +136,20 @@ The following options are supported:
 \fBmeta\fP: Specify invisible search terms.
 .IP \(bu 2
 \fBnonselectable\fP: If true the row cannot activated.
+.IP \(bu 2
+\fBinfo\fP: Info that, on selection, gets placed in the \fB\fCROFI\_INFO\fR environment variable. This entry does not get searched.
+
+.PP
+multiple entries can be passed using the \fB\fC\\x1f\fR separator.
+
+.PP
+.RS
+
+.nf
+    echo \-en "aap\\0icon\\x1ffolder\\x1finfo\\x1ftest\\n"
+
+.fi
+.RE
 
 .SH SEE ALSO
 .PP
diff --git a/doc/rofi-script.5.markdown b/doc/rofi-script.5.markdown
index 7f63b439..f9f85800 100644
--- a/doc/rofi-script.5.markdown
+++ b/doc/rofi-script.5.markdown
@@ -59,6 +59,10 @@ An integer number with the current state:
  * **2**: Selected a custom entry.
  * **10-28**: Custom keybinding 1-19
 
+### `ROFI_INFO`
+
+Environment get set when selected entry get set with the property value of the 'info' row option, if set.
+
 ## Passing mode options
 
 Extra options, like setting the prompt, can be set by the script.
@@ -96,6 +100,13 @@ The following options are supported:
  * **icon**: Set the icon for that row.
  * **meta**: Specify invisible search terms.
  * **nonselectable**: If true the row cannot activated.
+ * **info**: Info that, on selection, gets placed in the `ROFI_INFO` environment variable. This entry does not get searched.
+
+multiple entries can be passed using the `\x1f` separator.
+
+```bash
+    echo -en "aap\0icon\x1ffolder\x1finfo\x1ftest\n"
+```
 
 
 
-- 
cgit v1.2.3