summaryrefslogtreecommitdiffstats
path: root/doc/rofi-script.5
diff options
context:
space:
mode:
authorDave Davenport <qball@blame.services>2021-06-15 20:10:04 +0200
committerDave Davenport <qball@blame.services>2021-06-15 20:10:04 +0200
commit824b21b4fb99cf78f6d7ddafee2bde618a5a5ed8 (patch)
treec11d0d857182c263b547e2806bf6c4b20fe1bb47 /doc/rofi-script.5
parentf38f8324054cd524dd29403a79aed711f1d93b18 (diff)
[doc] small textual tweak
Diffstat (limited to 'doc/rofi-script.5')
-rw-r--r--doc/rofi-script.512
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/rofi-script.5 b/doc/rofi-script.5
index 96aef1e2..bc6b98bc 100644
--- a/doc/rofi-script.5
+++ b/doc/rofi-script.5
@@ -64,6 +64,8 @@ Rofi sets the following environment variable when executing the script:
.SS \fB\fCROFI\_RETV\fR
.PP
An integer number with the current state:
+
+.RS
.IP \(bu 2
\fB0\fP: Initial call of script.
.IP \(bu 2
@@ -73,6 +75,8 @@ An integer number with the current state:
.IP \(bu 2
\fB10\-28\fP: Custom keybinding 1\-19 ( need to be explicitely enabled by script ).
+.RE
+
.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.
@@ -96,6 +100,8 @@ For example to set the prompt:
.PP
The following extra options exists:
+
+.RS
.IP \(bu 2
\fBprompt\fP: Update the prompt text.
.IP \(bu 2
@@ -113,6 +119,8 @@ The following extra options exists:
.IP \(bu 2
\fBuse\-hot\-keys\fP: If set to true, it enabled the Custom keybindings for script. Warning this breaks the normal rofi flow.
+.RE
+
.SH Parsing row options
.PP
Extra options for individual rows can be set.
@@ -132,6 +140,8 @@ For example:
.PP
The following options are supported:
+
+.RS
.IP \(bu 2
\fBicon\fP: Set the icon for that row.
.IP \(bu 2
@@ -141,6 +151,8 @@ The following options are supported:
.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.
+.RE
+
.PP
multiple entries can be passed using the \fB\fC\\x1f\fR separator.