diff options
| author | Dave Davenport <qball@gmpclient.org> | 2020-05-24 19:09:06 +0200 |
|---|---|---|
| committer | Dave Davenport <qball@gmpclient.org> | 2020-05-24 19:10:49 +0200 |
| commit | 1342b733af6a8de481ac35a33cb352c21efcd0b5 (patch) | |
| tree | 0b76a9f6d7f90e7a24ce7e1ce3ad78a756a135c1 /doc | |
| parent | 0e880e76a21969f42ee3cd764a459f0d504c5a57 (diff) | |
[Script] Add 'info' row option, that gets passed to ROFI_INFO environment.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/rofi-script.5 | 18 | ||||
| -rw-r--r-- | doc/rofi-script.5.markdown | 11 |
2 files changed, 29 insertions, 0 deletions
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" +``` |