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.markdown | |
parent | 406a6954aa468aba8dd8686bf62a2d32d7645c04 (diff) |
[Doc] Update manpage urls and add new-selection setting.
Diffstat (limited to 'doc/rofi-script.5.markdown')
-rw-r--r-- | doc/rofi-script.5.markdown | 17 |
1 files changed, 10 insertions, 7 deletions
diff --git a/doc/rofi-script.5.markdown b/doc/rofi-script.5.markdown index 805886d0..d021f781 100644 --- a/doc/rofi-script.5.markdown +++ b/doc/rofi-script.5.markdown @@ -7,8 +7,9 @@ ## DESCRIPTION -**rofi** 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. +**rofi** 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. ## USAGE @@ -25,10 +26,11 @@ The name should be unique. ## API -Rofi calls the executable without arguments on startup. This should generate a list of options, separated by a newline -(`\n`) (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 (`\n`) (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. A simple script would be: @@ -88,7 +90,8 @@ The following extra options exists: * **delim**: Set the delimiter for for next rows. Default is '\n' and this option should finish with this. Only call this on first call of script, it is remembered for consecutive calls. * **no-custom**: If set to 'true'; only accept listed entries, ignore custom input. * **use-hot-keys**: If set to true, it enabled the Custom keybindings for script. Warning this breaks the normal rofi flow. - * **keep-selection**: If set, the selection is not moved to the first entry, but the current position is maintained. + * **keep-selection**: If set, the selection is not moved to the first entry, but the current position is maintained. The filter is cleared. + * **new-selection**: If `keep-selection` is set, this allows you to override the selected entry (absolute position). * **data**: Passed data to the next execution of the script via **ROFI_DATA**. * **theme**: Small theme snippet to f.e. change the background color of a widget. |