1
0
Fork 0
mirror of https://github.com/davatorium/rofi.git synced 2024-11-25 13:55:34 -05:00

Update manpage to be a bit more consistent.

This commit is contained in:
Dave Davenport 2015-01-19 15:49:23 +01:00
parent f828c70399
commit d3cd99fddd
2 changed files with 280 additions and 128 deletions

View file

@ -6,20 +6,51 @@ rofi - A window switcher, run dialog and dmenu replacement
## SYNOPSIS ## SYNOPSIS
**rofi** [ -width *pct_scr* ] [ -lines *lines* ] [ -columns *columns* ] [ -font *pangofont* ] [ -fg **rofi**
*color* ] [ -bg *color* ] [ -bgalt *color* ] [ -hlfg *color* ] [ -hlbg *color* ] [ -key *combo* ] [ [ -width *pct_scr* ]
-dkey *comdo* ] [ -rkey *comdo* ] [ -terminal *terminal* ] [ -location *position* ] [ -hmode ] [ [ -lines *lines* ]
-fixed-num-lines ] [ -padding *padding* ] [ -opacity *opacity%* ] [ -display *display* ] [ -bc [ -columns *columns* ]
*color* ] [ -bw *width* ] [ -dmenu [ -p *prompt* ] ] [ -ssh-client *client* ] [ -ssh-command [ -font *pangofont* ]
*command* ] [ -now ] [ -rnow ] [ -snow ] [ -version ] [ -help] [ -dump-xresources ] [ [ -fg *color* ]
-disable-history ] [ -levenshtein-sort ] [ -case-sensitive ] [ -show *mode* ] [ -switcher *mode1, [ -bg *color* ]
mode2* ] [ -e *message*] [ -sep *separator* ] [ -eh *element height* ] [ -l *selected line* ] [ [ -bgalt *color* ]
-run-list-command *cmd* ] [ -lazy-filter-limit *limit* ] [ -hlfg *color* ]
[ -hlbg *color* ]
[ -key *combo* ]
[ -dkey *comdo* ]
[ -rkey *comdo* ]
[ -terminal *terminal* ]
[ -location *position* ]
[ -hmode ]
[ -fixed-num-lines ]
[ -padding *padding* ]
[ -opacity *opacity%* ]
[ -display *display* ]
[ -bc *color* ]
[ -bw *width* ]
[ -dmenu [ -p *prompt* ] [ -sep *separator* ] [ -l *selected line* ] ]
[ -ssh-client *client* ]
[ -ssh-command *command* ]
[ -disable-history ]
[ -levenshtein-sort ]
[ -case-sensitive ]
[ -show *mode* ]
[ -switcher *mode1,mode2* ]
[ -eh *element height* ]
[ -lazy-filter-limit *limit* ]
[ -e *message*]
[ -now ]
[ -rnow ]
[ -snow ]
[ -version ]
[ -help]
[ -dump-xresources ]
## DESCRIPTION ## DESCRIPTION
**rofi** is an X11 popup window switcher. A list is displayed center-screen showing open window titles, WM_CLASS, and desktop number. **rofi** is an X11 popup window switcher, run dialog, dmenu replacement and more. It focusses on
The user may filter the list by typing, navigate with Up/Down or Tab keys, and select a window with Return (Enter). Escape cancels. being fast to use and have minimal distraction. It supports keyboard and mouse navigation, type to
filter, tokenized search and more.
## License ## License
@ -42,39 +73,45 @@ The default key combinations are:
* `mod1-F3` * `mod1-F3`
Show run-dialog. Show ssh-dialog.
## OPTIONS ## OPTIONS
`-key` `-key`
Change the key combination to display all windows (default: F12). Change the key combination to display all windows.
rofi -key F12 rofi -key F12
rofi -key control+shift+s rofi -key control+shift+s
rofi -key mod1+Tab rofi -key mod1+Tab
Default: *F12*
`-rkey` `-rkey`
Change the key combination to display the run dialog (default: mod1-F2). Change the key combination to display the run dialog.
rofi -rkey F11 rofi -rkey F11
rofi -rkey control+shift+d rofi -rkey control+shift+d
rofi -rkey mod1+grave (grave=backtick) rofi -rkey mod1+grave (grave=backtick)
Default: *Alt-F2*
`-skey` `-skey`
Change the key combination to display the ssh dialog (default: Alt-F3). Change the key combination to display the ssh dialog.
rofi -skey F10 rofi -skey F10
rofi -skey control+shift+s rofi -skey control+shift+s
rofi -skey mod1+grave (grave=backtick) rofi -skey mod1+grave (grave=backtick)
Default: *Alt-F3*
`-now` `-now`
@ -124,64 +161,75 @@ The default key combinations are:
Start in case sensitive mode. Start in case sensitive mode.
### Theming ### Theming
`-bg` `-bg`
Set the background text color (X11 named color or hex #rrggbb) for the menu (default: #222222). Set the background text color (X11 named color or hex #rrggbb) for the menu.
rofi -bg "#222222" rofi -bg "#222222"
`-bg` Default: *#f2f1f0*
Set the background text color for alternating rows (X11 named color or hex #rrggbb) for the menu `-bgalt`
(default: #222222).
Set the background text color for alternating rows (X11 named color or hex #rrggbb) for the menu.
rofi -bgalt "#222222" rofi -bgalt "#222222"
Default: *#f2f1f0*
`-bc` `-bc`
Set the border color (X11 named color or hex #rrggbb) for the menu (default: #000000). Set the border color (X11 named color or hex #rrggbb) for the menu.
rofi -bc black rofi -bc black
Default: *black*
`-bw` `-bw`
Set the border width in pixels (default: 1). Set the border width in pixels.
rofi -bw 1 rofi -bw 1
Default: *1*
`-fg` `-fg`
Set the foreground text color (X11 named color or hex #rrggbb) for the menu (default: #cccccc). Set the foreground text color (X11 named color or hex #rrggbb) for the menu.
rofi -fg "#cccccc" rofi -fg "#cccccc"
`-font` Default: *#222222*
Pango font name for use by the menu (default: mono 14).
rofi -font monospace\ 14
`-hlbg` `-hlbg`
Set the background text color (X11 named color or hex #rrggbb) for the highlighted item in the Set the background text color (X11 named color or hex #rrggbb) for the highlighted item in the
menu (default: #005577). menu.
rofi -fg "#005577" rofi -fg "#005577"
Default: *#005577*
`-hlfg` `-hlfg`
Set the foreground text color (X11 named color or hex #rrggbb) for the highlighted item in the Set the foreground text color (X11 named color or hex #rrggbb) for the highlighted item in the
menu (default: #ffffff). menu.
rofi -fg "#ffffff" rofi -fg "#ffffff"
Default: *#FFFFFF*
`-font`
Pango font name for use by the menu.
rofi -font monospace\ 14
Default: *mono 12*
`-opacity` `-opacity`
@ -189,23 +237,37 @@ The default key combinations are:
rofi -opacity "75" rofi -opacity "75"
Default: *100*
`-eh` *element height*
The height of a field in lines. e.g.
echo -e "a\n3|b\n4|c\n5" | rofi -sep '|' -eh 2 -dmenu
Default: *1*
### Layout ### Layout
`-lines` `-lines`
Maximum number of lines the menu may show before scrolling (default: 25). Maximum number of lines the menu may show before scrolling.
rofi -lines 25 rofi -lines 25
Default: *15*
`-columns` `-columns`
The number of columns the menu may show before scrolling (default: 25). The number of columns the menu may show before scrolling.
rofi -columns 2 rofi -columns 2
Default: *1*
`-width` [value] `-width` [value]
Set the width of the menu as a percentage of the screen width (default: 60). Set the width of the menu as a percentage of the screen width.
rofi -width 60 rofi -width 60
@ -219,6 +281,8 @@ The default key combinations are:
Character width is a rough estimation, and might not be correct, but should work for most monospaced fonts. Character width is a rough estimation, and might not be correct, but should work for most monospaced fonts.
Default: *50*
`-location` `-location`
Specify where the window should be located. The numbers map to the following location on the Specify where the window should be located. The numbers map to the following location on the
@ -228,6 +292,8 @@ The default key combinations are:
8 0 4 8 0 4
7 6 5 7 6 5
Default: *0*
`-hmode` `-hmode`
Switch to horizontal mode (ala dmenu). The number of elements is the number of `lines` times the Switch to horizontal mode (ala dmenu). The number of elements is the number of `lines` times the
@ -239,12 +305,14 @@ The default key combinations are:
`-padding` `-padding`
Define the inner margin of the window. Default is 5 pixels. Define the inner margin of the window.
To make rofi look like dmenu: To make rofi look like dmenu:
rofi -hmode -padding 0 rofi -hmode -padding 0
Default: *5*
`-sidebar-mode` `-sidebar-mode`
Go into side-bar mode, it will show list of modi at the bottom. Go into side-bar mode, it will show list of modi at the bottom.
@ -256,51 +324,60 @@ The default key combinations are:
The number of entries required for Rofi to go into lazy filter mode. The number of entries required for Rofi to go into lazy filter mode.
In lazy filter mode, it won't refilter the list on each keypress, but only after rofi been idle In lazy filter mode, it won't refilter the list on each keypress, but only after rofi been idle
for 250ms. Default is 5000 lines, set to 0 to always enable. for 250ms. Experiments shows that the default (5000 lines) works well, set to 0 to always enable.
### Pattern setting Default: *5000*
### PATTERN setting
`-terminal` `-terminal`
Specify what terminal to start (default x-terminal-emulator) Specify what terminal to start.
rofi -terminal xterm rofi -terminal xterm
Pattern: *{terminal}*
Default: *x-terminal-emulator*
`-ssh-client` *client* `-ssh-client` *client*
Override the used ssh client. Default is `ssh`. Override the used ssh client.
Pattern: *{ssh-client}*
Default: *ssh*
### SSH settings ### SSH settings
`-ssh-set-title` *true|false*
SSH dialogs tries to set 'ssh hostname' of the spawned terminal.
Not all terminals support this.
Default value is true.
*This command has been deprecated for the ssh-command string*
`-ssh-command` *cmd* `-ssh-command` *cmd*
Set the command to execute when starting a ssh session. Set the command to execute when starting a ssh session.
The pattern *{host}* is replaced by the selected ssh entry.
Default: *{terminal} -e {ssh-client} {host}*
### Run settings ### Run settings
`-run-command` *cmd* `-run-command` *cmd*
Set the command to execute when running an application. Set the command (*{cmd}*) to execute when running an application.
See *PATTERN*. See *PATTERN*.
Default: *{cmd}*
`-run-shell-command` *cmd* `-run-shell-command` *cmd*
Set the command to execute when running an application in a shell. Set the command to execute when running an application in a shell.
See *PATTERN*. See *PATTERN*.
Default: *{terminal} -e {cmd}*
`-run-list-command` *cmd* `-run-list-command` *cmd*
If set, use an external tool to generate list of executable commands. Uses 'run-command' If set, use an external tool to generate list of executable commands. Uses 'run-command'
Default: *""*
### History and Sorting ### History and Sorting
`-disable-history` `-disable-history`
@ -327,16 +404,14 @@ The default key combinations are:
echo "a|b|c|d|e" | rofi -sep '|' -dmenu -p "monkey:" echo "a|b|c|d|e" | rofi -sep '|' -dmenu -p "monkey:"
`-eh` *element height* Default: *dmenu*
The height of a field in lines. e.g.
echo -e "a\n3|b\n4|c\n5" | rofi -sep '|' -eh 2 -dmenu
`-l` *selected line* `-l` *selected line*
Select a certain line. Select a certain line.
Default: *0*
### Message dialog ### Message dialog
`-e` *message* `-e` *message*
@ -350,7 +425,7 @@ The default key combinations are:
Dump the current active configuration in xresources format to the command-line. Dump the current active configuration in xresources format to the command-line.
## Pattern ## PATTERN
To launch commands (e.g. when using the ssh dialog) the user can enter the used commandline, To launch commands (e.g. when using the ssh dialog) the user can enter the used commandline,
the following keys can be used that will be replaced at runtime: the following keys can be used that will be replaced at runtime:
@ -372,7 +447,8 @@ This way it can be used as a drop-in replacement for dmenu. just copy or symlink
`HUP` `HUP`
If in daemon mode, reload the configuration from Xresources. (arguments still override). If in daemon mode, reload the configuration from Xresources. (commandline arguments still
override xresources).
## Keybindings ## Keybindings

View file

@ -4,19 +4,50 @@
rofi \- A window switcher, run dialog and dmenu replacement rofi \- A window switcher, run dialog and dmenu replacement
.SH SYNOPSIS .SH SYNOPSIS
.PP .PP
\fBrofi\fP [ \-width \fIpct_scr\fP ] [ \-lines \fIlines\fP ] [ \-columns \fIcolumns\fP ] [ \-font \fIpangofont\fP ] [ \-fg \fBrofi\fP
\fIcolor\fP ] [ \-bg \fIcolor\fP ] [ \-bgalt \fIcolor\fP ] [ \-hlfg \fIcolor\fP ] [ \-hlbg \fIcolor\fP ] [ \-key \fIcombo\fP ] [ [ \-width \fIpct_scr\fP ]
\-dkey \fIcomdo\fP ] [ \-rkey \fIcomdo\fP ] [ \-terminal \fIterminal\fP ] [ \-location \fIposition\fP ] [ \-hmode ] [ [ \-lines \fIlines\fP ]
\-fixed\-num\-lines ] [ \-padding \fIpadding\fP ] [ \-opacity \fIopacity%\fP ] [ \-display \fIdisplay\fP ] [ \-bc [ \-columns \fIcolumns\fP ]
\fIcolor\fP ] [ \-bw \fIwidth\fP ] [ \-dmenu [ \-p \fIprompt\fP ] ] [ \-ssh\-client \fIclient\fP ] [ \-ssh\-command [ \-font \fIpangofont\fP ]
\fIcommand\fP ] [ \-now ] [ \-rnow ] [ \-snow ] [ \-version ] [ \-help] [ \-dump\-xresources ] [ [ \-fg \fIcolor\fP ]
\-disable\-history ] [ \-levenshtein\-sort ] [ \-case\-sensitive ] [ \-show \fImode\fP ] [ \-switcher \fImode1, [ \-bg \fIcolor\fP ]
mode2\fP ] [ \-e \fImessage\fP] [ \-sep \fIseparator\fP ] [ \-eh \fIelement height\fP ] [ \-l \fIselected line\fP ] [ [ \-bgalt \fIcolor\fP ]
\-run\-list\-command \fIcmd\fP ] [ \-lazy\-filter\-limit \fIlimit\fP ] [ \-hlfg \fIcolor\fP ]
[ \-hlbg \fIcolor\fP ]
[ \-key \fIcombo\fP ]
[ \-dkey \fIcomdo\fP ]
[ \-rkey \fIcomdo\fP ]
[ \-terminal \fIterminal\fP ]
[ \-location \fIposition\fP ]
[ \-hmode ]
[ \-fixed\-num\-lines ]
[ \-padding \fIpadding\fP ]
[ \-opacity \fIopacity%\fP ]
[ \-display \fIdisplay\fP ]
[ \-bc \fIcolor\fP ]
[ \-bw \fIwidth\fP ]
[ \-dmenu [ \-p \fIprompt\fP ] [ \-sep \fIseparator\fP ] [ \-l \fIselected line\fP ] ]
[ \-ssh\-client \fIclient\fP ]
[ \-ssh\-command \fIcommand\fP ]
[ \-disable\-history ]
[ \-levenshtein\-sort ]
[ \-case\-sensitive ]
[ \-show \fImode\fP ]
[ \-switcher \fImode1,mode2\fP ]
[ \-eh \fIelement height\fP ]
[ \-lazy\-filter\-limit \fIlimit\fP ]
[ \-e \fImessage\fP]
[ \-now ]
[ \-rnow ]
[ \-snow ]
[ \-version ]
[ \-help]
[ \-dump\-xresources ]
.SH DESCRIPTION .SH DESCRIPTION
.PP .PP
\fBrofi\fP is an X11 popup window switcher. A list is displayed center\-screen showing open window titles, WM_CLASS, and desktop number. \fBrofi\fP is an X11 popup window switcher, run dialog, dmenu replacement and more. It focusses on
The user may filter the list by typing, navigate with Up/Down or Tab keys, and select a window with Return (Enter). Escape cancels. being fast to use and have minimal distraction. It supports keyboard and mouse navigation, type to
filter, tokenized search and more.
.SH License .SH License
.PP .PP
MIT/X11 MIT/X11
@ -43,12 +74,12 @@ The default key combinations are:
\fB\fCmod1\-F3\fR \fB\fCmod1\-F3\fR
.RE .RE
.PP .PP
Show run\-dialog. Show ssh\-dialog.
.SH OPTIONS .SH OPTIONS
.PP .PP
\fB\fC\-key\fR \fB\fC\-key\fR
.IP .IP
Change the key combination to display all windows (default: F12). Change the key combination to display all windows.
.PP .PP
.RS .RS
.nf .nf
@ -57,10 +88,12 @@ Change the key combination to display all windows (default: F12).
rofi \-key mod1+Tab rofi \-key mod1+Tab
.fi .fi
.RE .RE
.IP
Default: \fIF12\fP
.PP .PP
\fB\fC\-rkey\fR \fB\fC\-rkey\fR
.IP .IP
Change the key combination to display the run dialog (default: mod1\-F2). Change the key combination to display the run dialog.
.PP .PP
.RS .RS
.nf .nf
@ -69,10 +102,12 @@ Change the key combination to display the run dialog (default: mod1\-F2).
rofi \-rkey mod1+grave (grave=backtick) rofi \-rkey mod1+grave (grave=backtick)
.fi .fi
.RE .RE
.IP
Default: \fIAlt\-F2\fP
.PP .PP
\fB\fC\-skey\fR \fB\fC\-skey\fR
.IP .IP
Change the key combination to display the ssh dialog (default: Alt\-F3). Change the key combination to display the ssh dialog.
.PP .PP
.RS .RS
.nf .nf
@ -81,6 +116,8 @@ Change the key combination to display the ssh dialog (default: Alt\-F3).
rofi \-skey mod1+grave (grave=backtick) rofi \-skey mod1+grave (grave=backtick)
.fi .fi
.RE .RE
.IP
Default: \fIAlt\-F3\fP
.PP .PP
\fB\fC\-now\fR \fB\fC\-now\fR
.IP .IP
@ -149,86 +186,101 @@ Start in case sensitive mode.
.PP .PP
\fB\fC\-bg\fR \fB\fC\-bg\fR
.IP .IP
Set the background text color (X11 named color or hex #rrggbb) for the menu (default: #222222). Set the background text color (X11 named color or hex #rrggbb) for the menu.
.PP .PP
.RS .RS
.nf .nf
rofi \-bg "#222222" rofi \-bg "#222222"
.fi .fi
.RE .RE
.PP
\fB\fC\-bg\fR
.IP .IP
Set the background text color for alternating rows (X11 named color or hex #rrggbb) for the menu Default: \fI#f2f1f0\fP
(default: #222222). .PP
\fB\fC\-bgalt\fR
.IP
Set the background text color for alternating rows (X11 named color or hex #rrggbb) for the menu.
.PP .PP
.RS .RS
.nf .nf
rofi \-bgalt "#222222" rofi \-bgalt "#222222"
.fi .fi
.RE .RE
.IP
Default: \fI#f2f1f0\fP
.PP .PP
\fB\fC\-bc\fR \fB\fC\-bc\fR
.IP .IP
Set the border color (X11 named color or hex #rrggbb) for the menu (default: #000000). Set the border color (X11 named color or hex #rrggbb) for the menu.
.PP .PP
.RS .RS
.nf .nf
rofi \-bc black rofi \-bc black
.fi .fi
.RE .RE
.IP
Default: \fIblack\fP
.PP .PP
\fB\fC\-bw\fR \fB\fC\-bw\fR
.IP .IP
Set the border width in pixels (default: 1). Set the border width in pixels.
.PP .PP
.RS .RS
.nf .nf
rofi \-bw 1 rofi \-bw 1
.fi .fi
.RE .RE
.IP
Default: \fI1\fP
.PP .PP
\fB\fC\-fg\fR \fB\fC\-fg\fR
.IP .IP
Set the foreground text color (X11 named color or hex #rrggbb) for the menu (default: #cccccc). Set the foreground text color (X11 named color or hex #rrggbb) for the menu.
.PP .PP
.RS .RS
.nf .nf
rofi \-fg "#cccccc" rofi \-fg "#cccccc"
.fi .fi
.RE .RE
.PP
\fB\fC\-font\fR
.IP .IP
Pango font name for use by the menu (default: mono 14). Default: \fI#222222\fP
.PP
.RS
.nf
rofi \-font monospace\\ 14
.fi
.RE
.PP .PP
\fB\fC\-hlbg\fR \fB\fC\-hlbg\fR
.IP .IP
Set the background text color (X11 named color or hex #rrggbb) for the highlighted item in the Set the background text color (X11 named color or hex #rrggbb) for the highlighted item in the
menu (default: #005577). menu.
.PP .PP
.RS .RS
.nf .nf
rofi \-fg "#005577" rofi \-fg "#005577"
.fi .fi
.RE .RE
.IP
Default: \fI#005577\fP
.PP .PP
\fB\fC\-hlfg\fR \fB\fC\-hlfg\fR
.IP .IP
Set the foreground text color (X11 named color or hex #rrggbb) for the highlighted item in the Set the foreground text color (X11 named color or hex #rrggbb) for the highlighted item in the
menu (default: #ffffff). menu.
.PP .PP
.RS .RS
.nf .nf
rofi \-fg "#ffffff" rofi \-fg "#ffffff"
.fi .fi
.RE .RE
.IP
Default: \fI#FFFFFF\fP
.PP
\fB\fC\-font\fR
.IP
Pango font name for use by the menu.
.PP
.RS
.nf
rofi \-font monospace\\ 14
.fi
.RE
.IP
Default: \fImono 12\fP
.PP .PP
\fB\fC\-opacity\fR \fB\fC\-opacity\fR
.IP .IP
@ -239,31 +291,49 @@ Set the window opacity (0\-100).
rofi \-opacity "75" rofi \-opacity "75"
.fi .fi
.RE .RE
.IP
Default: \fI100\fP
.PP
\fB\fC\-eh\fR \fIelement height\fP
.IP
The height of a field in lines. e.g.
.PP
.RS
.nf
echo \-e "a\\n3|b\\n4|c\\n5" | rofi \-sep '|' \-eh 2 \-dmenu
.fi
.RE
.IP
Default: \fI1\fP
.SS Layout .SS Layout
.PP .PP
\fB\fC\-lines\fR \fB\fC\-lines\fR
.IP .IP
Maximum number of lines the menu may show before scrolling (default: 25). Maximum number of lines the menu may show before scrolling.
.PP .PP
.RS .RS
.nf .nf
rofi \-lines 25 rofi \-lines 25
.fi .fi
.RE .RE
.IP
Default: \fI15\fP
.PP .PP
\fB\fC\-columns\fR \fB\fC\-columns\fR
.IP .IP
The number of columns the menu may show before scrolling (default: 25). The number of columns the menu may show before scrolling.
.PP .PP
.RS .RS
.nf .nf
rofi \-columns 2 rofi \-columns 2
.fi .fi
.RE .RE
.IP
Default: \fI1\fP
.PP .PP
\fB\fC\-width\fR [value] \fB\fC\-width\fR [value]
.IP .IP
Set the width of the menu as a percentage of the screen width (default: 60). Set the width of the menu as a percentage of the screen width.
.PP .PP
.RS .RS
.nf .nf
@ -288,6 +358,8 @@ If the value is negative, it tries to estimates a character width. To show 30 ch
.RE .RE
.IP .IP
Character width is a rough estimation, and might not be correct, but should work for most monospaced fonts. Character width is a rough estimation, and might not be correct, but should work for most monospaced fonts.
.IP
Default: \fI50\fP
.PP .PP
\fB\fC\-location\fR \fB\fC\-location\fR
.IP .IP
@ -301,6 +373,8 @@ monitor:
7 6 5 7 6 5
.fi .fi
.RE .RE
.IP
Default: \fI0\fP
.PP .PP
\fB\fC\-hmode\fR \fB\fC\-hmode\fR
.IP .IP
@ -313,7 +387,7 @@ Keep a fixed number of visible lines (See the \fB\fC\-lines\fR option.)
.PP .PP
\fB\fC\-padding\fR \fB\fC\-padding\fR
.IP .IP
Define the inner margin of the window. Default is 5 pixels. Define the inner margin of the window.
.IP .IP
To make rofi look like dmenu: To make rofi look like dmenu:
.PP .PP
@ -322,6 +396,8 @@ To make rofi look like dmenu:
rofi \-hmode \-padding 0 rofi \-hmode \-padding 0
.fi .fi
.RE .RE
.IP
Default: \fI5\fP
.PP .PP
\fB\fC\-sidebar\-mode\fR \fB\fC\-sidebar\-mode\fR
.PP .PP
@ -337,50 +413,59 @@ To show sidebar use:
.PP .PP
The number of entries required for Rofi to go into lazy filter mode. The number of entries required for Rofi to go into lazy filter mode.
In lazy filter mode, it won't refilter the list on each keypress, but only after rofi been idle In lazy filter mode, it won't refilter the list on each keypress, but only after rofi been idle
for 250ms. Default is 5000 lines, set to 0 to always enable. for 250ms. Experiments shows that the default (5000 lines) works well, set to 0 to always enable.
.SS Pattern setting .PP
Default: \fI5000\fP
.SS PATTERN setting
.PP .PP
\fB\fC\-terminal\fR \fB\fC\-terminal\fR
.IP .IP
Specify what terminal to start (default x\-terminal\-emulator) Specify what terminal to start.
.PP .PP
.RS .RS
.nf .nf
rofi \-terminal xterm rofi \-terminal xterm
.fi .fi
.RE .RE
.IP
Pattern: \fI{terminal}\fP
Default: \fIx\-terminal\-emulator\fP
.PP .PP
\fB\fC\-ssh\-client\fR \fIclient\fP \fB\fC\-ssh\-client\fR \fIclient\fP
.IP .IP
Override the used ssh client. Default is \fB\fCssh\fR\&. Override the used ssh client.
.IP
Pattern: \fI{ssh\-client}\fP
Default: \fIssh\fP
.SS SSH settings .SS SSH settings
.PP .PP
\fB\fC\-ssh\-set\-title\fR \fItrue|false\fP
.IP
SSH dialogs tries to set 'ssh hostname' of the spawned terminal.
Not all terminals support this.
Default value is true.
.IP
\fIThis command has been deprecated for the ssh\-command string\fP
.PP
\fB\fC\-ssh\-command\fR \fIcmd\fP \fB\fC\-ssh\-command\fR \fIcmd\fP
.IP .IP
Set the command to execute when starting a ssh session. Set the command to execute when starting a ssh session.
The pattern \fI{host}\fP is replaced by the selected ssh entry.
.IP
Default: \fI{terminal} \-e {ssh\-client} {host}\fP
.SS Run settings .SS Run settings
.PP .PP
\fB\fC\-run\-command\fR \fIcmd\fP \fB\fC\-run\-command\fR \fIcmd\fP
.IP .IP
Set the command to execute when running an application. Set the command (\fI{cmd}\fP) to execute when running an application.
See \fIPATTERN\fP\&. See \fIPATTERN\fP\&.
.IP
Default: \fI{cmd}\fP
.PP .PP
\fB\fC\-run\-shell\-command\fR \fIcmd\fP \fB\fC\-run\-shell\-command\fR \fIcmd\fP
.IP .IP
Set the command to execute when running an application in a shell. Set the command to execute when running an application in a shell.
See \fIPATTERN\fP\&. See \fIPATTERN\fP\&.
.IP
Default: \fI{terminal} \-e {cmd}\fP
.PP .PP
\fB\fC\-run\-list\-command\fR \fIcmd\fP \fB\fC\-run\-list\-command\fR \fIcmd\fP
.IP .IP
If set, use an external tool to generate list of executable commands. Uses 'run\-command' If set, use an external tool to generate list of executable commands. Uses 'run\-command'
.IP
Default: \fI""\fP
.SS History and Sorting .SS History and Sorting
.PP .PP
\fB\fC\-disable\-history\fR \fB\fC\-disable\-history\fR
@ -409,15 +494,7 @@ Separator for dmenu. For example to show list a to e with '|' as separator:
.nf .nf
Specify the prompt to show in dmenu mode. E.g. select monkey a,b,c,d or e. Specify the prompt to show in dmenu mode. E.g. select monkey a,b,c,d or e.
echo "a|b|c|d|e" | rofi \-sep '|' \-dmenu \-p "monkey:" echo "a|b|c|d|e" | rofi \-sep '|' \-dmenu \-p "monkey:"
.fi Default: *dmenu*
.RE
.PP
\fB\fC\-eh\fR \fIelement height\fP
.PP
.RS
.nf
The height of a field in lines. e.g.
echo \-e "a\\n3|b\\n4|c\\n5" | rofi \-sep '|' \-eh 2 \-dmenu
.fi .fi
.RE .RE
.PP .PP
@ -426,6 +503,7 @@ The height of a field in lines. e.g.
.RS .RS
.nf .nf
Select a certain line. Select a certain line.
Default: *0*
.fi .fi
.RE .RE
.SS Message dialog .SS Message dialog
@ -443,7 +521,7 @@ Message can be multi\-line.
\fB\fC\-dump\-xresources\fR \fB\fC\-dump\-xresources\fR
.IP .IP
Dump the current active configuration in xresources format to the command\-line. Dump the current active configuration in xresources format to the command\-line.
.SH Pattern .SH PATTERN
.PP .PP
To launch commands (e.g. when using the ssh dialog) the user can enter the used commandline, To launch commands (e.g. when using the ssh dialog) the user can enter the used commandline,
the following keys can be used that will be replaced at runtime: the following keys can be used that will be replaced at runtime:
@ -473,9 +551,11 @@ ln \-s /usr/bin/dmenu /usr/bin/rofi
.PP .PP
.RS .RS
.nf .nf
If in daemon mode, reload the configuration from Xresources. (arguments still override). If in daemon mode, reload the configuration from Xresources. (commandline arguments still
.fi .fi
.RE .RE
.PP
override xresources).
.SH Keybindings .SH Keybindings
.PP .PP
Rofi supports the following keybindings: Rofi supports the following keybindings:
@ -545,18 +625,14 @@ Check quotes used on the commandline: e.g. used “ instead of ".
.SH WEBSITE .SH WEBSITE
.PP .PP
\fBrofi\fP website can be found at here \fBrofi\fP website can be found at here
.UR https://davedavenport.github.io/rofi/ \[la]https://davedavenport.github.io/rofi/\[ra]
.UE
.PP .PP
\fBrofi\fP bugtracker can be found here \fBrofi\fP bugtracker can be found here
.UR https://github.com/DaveDavenport/rofi/issues \[la]https://github.com/DaveDavenport/rofi/issues\[ra]
.UE
.SH AUTHOR .SH AUTHOR
.PP .PP
Qball Cow Qball Cow
.MT qball@gmpclient.org \[la]qball@gmpclient.org\[ra]
.ME
.PP .PP
Original code based on work by: Sean Pringle Original code based on work by: Sean Pringle
.MT sean.pringle@gmail.com \[la]sean.pringle@gmail.com\[ra]
.ME