Man pages: document the bang feature (#1126)

davatorium · May 12, 2020 · 0a33aad · 0a33aad
1 parent 8a2e67f
commit 0a33aad
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 2 deletions.
diff --git a/doc/rofi.1 b/doc/rofi.1
@@ -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
@@ -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.