diff options
| author | John Beard <john.j.beard@gmail.com> | 2020-05-12 20:12:45 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-05-12 21:12:45 +0200 |
| commit | 0a33aadd8b011fac91d694b3f1356fef1994a799 (patch) | |
| tree | 24918b245fdbcc7b0512e4ea1c20e85c83aaf12c | |
| parent | 8a2e67f6fec417a874a09ccf1eb3e2a7fbb3d423 (diff) | |
Man pages: document the bang feature (#1126)
| -rw-r--r-- | doc/rofi.1 | 13 | ||||
| -rw-r--r-- | doc/rofi.1.markdown | 12 |
2 files changed, 23 insertions, 2 deletions
@@ -987,7 +987,7 @@ rofi \-show combi \-combi\-modi "window,run,ssh" \-modi combi .RE .PP -Notes: The i3 window manager does not like commas in the command when specifying an exec command. +\fBNOTE\fP: The i3 window manager does not like commas in the command when specifying an exec command. For that case '#' can be used as a separator. .SS History and Sorting @@ -1600,6 +1600,17 @@ Shows a searchable list of key bindings. .PP Allows custom scripted Modi to be added. +.SS combi +.PP +Combines multiple modi in one list. Specify which modi are included with the \fB\fC\-combi\-modi\fR option. + +.PP +When using the combi mode, a \fI!bang\fP can be used to filter the results by modi. +All modi that match the bang as a prefix are included. +For example, say you have specified \fB\fC\-combi\-modi run,window,windowcd\fR\&. If your +query begins with the bang \fB\fC!w\fR, only results from the \fB\fCwindow\fR and \fB\fCwindowcd\fR +modi are shown, even if the rest of the input text would match results from \fB\fCrun\fR\&. + .SH FAQ .SS The text in the window switcher is not nicely aligned. .PP diff --git a/doc/rofi.1.markdown b/doc/rofi.1.markdown index 67b540cd..224a5b34 100644 --- a/doc/rofi.1.markdown +++ b/doc/rofi.1.markdown @@ -568,7 +568,7 @@ To get one merge view, of `window`,`run`, and `ssh`: rofi -show combi -combi-modi "window,run,ssh" -modi combi -Notes: The i3 window manager does not like commas in the command when specifying an exec command. +**NOTE**: The i3 window manager does not like commas in the command when specifying an exec command. For that case '#' can be used as a separator. ### History and Sorting @@ -946,6 +946,16 @@ Shows a searchable list of key bindings. Allows custom scripted Modi to be added. +### combi + +Combines multiple modi in one list. Specify which modi are included with the `-combi-modi` option. + +When using the combi mode, a *!bang* can be used to filter the results by modi. +All modi that match the bang as a prefix are included. +For example, say you have specified `-combi-modi run,window,windowcd`. If your +query begins with the bang `!w`, only results from the `window` and `windowcd` +modi are shown, even if the rest of the input text would match results from `run`. + ## FAQ ### The text in the window switcher is not nicely aligned. |