Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Man pages: document the bang feature #1126

Merged
merged 1 commit into from
May 12, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion doc/rofi.1
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
12 changes: 11 additions & 1 deletion doc/rofi.1.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.
Expand Down