diff options
| author | Dave Davenport <qball@blame.services> | 2022-07-31 16:28:05 +0200 |
|---|---|---|
| committer | Dave Davenport <qball@blame.services> | 2022-07-31 16:28:05 +0200 |
| commit | 8e8765e2ce36622e50f0cb5d1f06bd9eb374bdf4 (patch) | |
| tree | c3c958552789c6a85b05d6cfa48c1e07f50e6944 /doc/rofi-script.5 | |
| parent | 406a6954aa468aba8dd8686bf62a2d32d7645c04 (diff) | |
[Doc] Update manpage urls and add new-selection setting.
Diffstat (limited to 'doc/rofi-script.5')
| -rw-r--r-- | doc/rofi-script.5 | 18 |
1 files changed, 11 insertions, 7 deletions
diff --git a/doc/rofi-script.5 b/doc/rofi-script.5 index 689f4155..6e8b9b17 100644 --- a/doc/rofi-script.5 +++ b/doc/rofi-script.5 @@ -6,8 +6,9 @@ .SH DESCRIPTION .PP -\fBrofi\fP supports modes that use simple scripts in the background to generate a list and process the result from user -actions. This provide a simple interface to make simple extensions to rofi. +\fBrofi\fP supports modes that use simple scripts in the background to generate a +list and process the result from user actions. This provide a simple interface +to make simple extensions to rofi. .SH USAGE .PP @@ -30,10 +31,11 @@ The name should be unique. .SH API .PP -Rofi calls the executable without arguments on startup. This should generate a list of options, separated by a newline -(\fB\fC\\n\fR) (This can be changed by the script). -If the user selects an option, rofi calls the executable with the text of that option as the first argument. -If the script returns no entries, rofi quits. +Rofi calls the executable without arguments on startup. This should generate a +list of options, separated by a newline (\fB\fC\\n\fR) (This can be changed by the +script). If the user selects an option, rofi calls the executable with the text +of that option as the first argument. If the script returns no entries, rofi +quits. .PP A simple script would be: @@ -124,7 +126,9 @@ 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. .IP \(bu 2 -\fBkeep-selection\fP: If set, the selection is not moved to the first entry, but the current position is maintained. +\fBkeep-selection\fP: If set, the selection is not moved to the first entry, but the current position is maintained. The filter is cleared. +.IP \(bu 2 +\fBnew-selection\fP: If \fB\fCkeep-selection\fR is set, this allows you to override the selected entry (absolute position). .IP \(bu 2 \fBdata\fP: Passed data to the next execution of the script via \fBROFI_DATA\fP\&. .IP \(bu 2 |