PolytreeDE/rofi
1
0
Fork 0
mirror of https://github.com/davatorium/rofi.git synced 2025-04-21 17:52:51 -04:00
Code Releases Activity

[Doc] Update rofi.1.markdown with markdown fixes.

Browse source
This commit is contained in:
Dave Davenport 2023-03-27 02:01:28 +02:00
parent 127275c261
commit ebae594c08
2 changed files with 519 additions and 369 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

413
doc/rofi.1
View file

@ -2,7 +2,8 @@
.TH ROFI 1 rofi
.SH NAME
.PP
\fBrofi\fP - A window switcher, application launcher, ssh dialog, dmenu replacement and more
\fBrofi\fP - A window switcher, application launcher, ssh dialog, dmenu
replacement and more
.SH SYNOPSIS
.PP
@ -25,8 +26,8 @@ replacement for \fBdmenu(1)\fP\&. See emulating dmenu below.
.SS Running rofi
.PP
To launch \fBrofi\fP directly in a certain mode, specify a mode with \fB\fCrofi -show <mode>\fR\&.
To show the \fB\fCdrun\fR dialog:
To launch \fBrofi\fP directly in a certain mode, specify a mode with \fB\fCrofi -show
<mode>\fR\&. To show the \fB\fCdrun\fR dialog:
.PP
.RS
@ -71,7 +72,7 @@ For more information see \fBrofi-dmenu(5)\fP\&.
.RS
.nf
rofi -e "my message"
rofi -e "my message"
.fi
.RE
@ -81,15 +82,18 @@ Markup support can be enabled, see CONFIGURATION options.
.SH CONFIGURATION
.PP
There are currently three methods of setting configuration options (evaluated in order below):
There are currently three methods of setting configuration options (evaluated
in order below):
.RS
.IP \(bu 2
System configuration file (for example \fB\fC/etc/rofi.rasi\fR).
It first checks \fB\fCXDG_CONFIG_DIRS\fR, and then \fB\fCSYSCONFDIR\fR (that is passed at compile time).
It loads the first config file it finds, it does not merge multiple system configuration files.
System configuration file (for example \fB\fC/etc/rofi.rasi\fR). It first checks
\fB\fCXDG_CONFIG_DIRS\fR, and then \fB\fCSYSCONFDIR\fR (that is passed at compile time).
It loads the first config file it finds, it does not merge multiple system
configuration files.
.IP \(bu 2
Rasi theme file: The new \fItheme\fP format can be used to set configuration values.
Rasi theme file: The new \fItheme\fP format can be used to set configuration
values.
.IP \(bu 2
Command-line options: Arguments passed to \fBrofi\fP\&.
@ -99,13 +103,16 @@ Command-line options: Arguments passed to \fBrofi\fP\&.
To get a template config file, run: \fB\fCrofi -dump-config > config.rasi\fR
.PP
This will contain (commented) all current configuration options, modified options are uncommented.
This will contain (commented) all current configuration options, modified
options are uncommented.
.PP
To get a template config file that sets the icon-theme run: \fB\fCrofi -icon-theme hicolor -dump-config\fR\&.
To get a template config file that sets the icon-theme run: \fB\fCrofi -icon-theme
hicolor -dump-config\fR\&.
.PP
It is \fBstrongly\fP recommended to use this as a starting point for your configuration.
It is \fBstrongly\fP recommended to use this as a starting point for your
configuration.
.PP
An empty configuration section in the config file looks like:
@ -167,7 +174,7 @@ syntax. Example to enable option X:
.RS
.nf
-X
-X
.fi
.RE
@ -179,7 +186,7 @@ To disable option X:
.RS
.nf
-no-X
-no-X
.fi
.RE
@ -239,10 +246,13 @@ Specify the number of threads \fBrofi\fP should use:
.IP \(bu 2
1: Disable threading
.IP \(bu 2
2..n: Specify the maximum number of threads to use in the thread pool.Default: Autodetect
2..n: Specify the maximum number of threads to use in the thread pool.
.RE
.PP
Default: Autodetect
.PP
\fB\fC-display\fR \fIdisplay\fP
@ -261,7 +271,7 @@ A simple example, displaying three pre-defined options:
.RS
.nf
echo -e "Option #1\\nOption #2\\nOption #3" | rofi -dmenu
echo -e "Option #1\\nOption #2\\nOption #3" | rofi -dmenu
.fi
.RE
@ -273,7 +283,7 @@ Or get the options from a script:
.RS
.nf
~/my_script.sh | rofi -dmenu
~/my_script.sh | rofi -dmenu
.fi
.RE
@ -297,7 +307,7 @@ To show the run-dialog:
.RS
.nf
rofi -show run
rofi -show run
.fi
.RE
@ -318,7 +328,7 @@ To only show the \fB\fCrun\fR and \fB\fCssh\fR launcher:
.RS
.nf
rofi -modes "run,ssh" -show run
rofi -modes "run,ssh" -show run
.fi
.RE
@ -337,13 +347,14 @@ two parameters:
.RE
.PP
Example: Have a mode called 'Workspaces' using the \fB\fCi3_switch_workspaces.sh\fR script:
Example: Have a mode called 'Workspaces' using the \fB\fCi3_switch_workspaces.sh\fR
script:
.PP
.RS
.nf
rofi -modes "window,run,ssh,Workspaces:i3_switch_workspaces.sh" -show Workspaces
rofi -modes "window,run,ssh,Workspaces:i3_switch_workspaces.sh" -show Workspaces
.fi
.RE
@ -359,7 +370,7 @@ exec command. For that case, \fB\fC#\fR can be used as a separator.
.RS
.nf
rofi -modes "My File Browser:fb.sh" -show "My File Browser"
rofi -modes "My File Browser:fb.sh" -show "My File Browser"
.fi
.RE
@ -368,8 +379,8 @@ rofi -modes "My File Browser:fb.sh" -show "My File Browser"
\fB\fC-case-sensitive\fR
.PP
Start in case-sensitive mode.
This option can be changed at run-time using the \fB\fC-kb-toggle-case-sensitivity\fR key binding.
Start in case-sensitive mode. This option can be changed at run-time using the
\fB\fC-kb-toggle-case-sensitivity\fR key binding.
.PP
\fB\fC-cycle\fR
@ -405,9 +416,9 @@ Select the scrolling method. 0: Per page, 1: continuous.
\fB\fC-normalize-match\fR
.PP
Normalize the string before matching, so \fB\fCo\fR will match \fB\fCö\fR, and \fB\fCé\fR matches \fB\fCe\fR\&.
.br
This is not a perfect implementation, but works. For now, it disables highlighting of the matched part.
Normalize the string before matching, so \fB\fCo\fR will match \fB\fCö\fR, and \fB\fCé\fR matches
\fB\fCe\fR\&. This is not a perfect implementation, but works. For now, it disables
highlighting of the matched part.
.PP
\fB\fC-no-lazy-grab\fR
@ -437,9 +448,8 @@ Show application icons in \fB\fCdrun\fR and \fB\fCwindow\fR modes.
\fB\fC-icon-theme\fR
.PP
Specify icon theme to be used.
If not specified default theme from DE is used, \fIAdwaita\fP and \fIgnome\fP themes act as
fallback themes.
Specify icon theme to be used. If not specified default theme from DE is used,
\fIAdwaita\fP and \fIgnome\fP themes act as fallback themes.
.PP
\fB\fC-markup\fR
@ -451,19 +461,22 @@ Use Pango markup to format output wherever possible.
\fB\fC-normal-window\fR
.PP
Make \fBrofi\fP react like a normal application window. Useful for scripts like Clerk that are basically an application.
Make \fBrofi\fP react like a normal application window. Useful for scripts like
Clerk that are basically an application.
.PP
\fB\fC-[no-]steal-focus\fR
.PP
Make rofi steal focus on launch and restore close to window that held it when launched.
Make rofi steal focus on launch and restore close to window that held it when
launched.
.PP
\fB\fC-refilter-timeout-limit\fR
.PP
The time (in ms) boundary filter may take before switch from instant to delayed filter mode.
The time (in ms) boundary filter may take before switch from instant to delayed
filter mode.
.PP
Default: 300
@ -559,10 +572,13 @@ The different fields are:
.IP \(bu 2
\fBcomment\fP: the application comment
.IP \(bu 2
\fBall\fP: all the aboveDefault: \fIname,generic,exec,categories,keywords\fP
\fBall\fP: all the above
.RE
.PP
Default: \fIname,generic,exec,categories,keywords\fP
.PP
\fB\fC-drun-display-format\fR
@ -587,16 +603,11 @@ The format string for the \fB\fCdrun\fR dialog:
Pango markup can be used to formatting the output.
.PP
.RS
.nf
Default: {name} [<span weight='light' size='small'><i>({generic})</i></span>]
.fi
.RE
Default: {name} [({generic})]
.PP
Note: Only fields enabled in \fB\fC-drun-match-fields\fR can be used in the format string.
Note: Only fields enabled in \fB\fC-drun-match-fields\fR can be used in the format
string.
.PP
\fB\fC-[no-]drun-show-actions\fR
@ -605,14 +616,8 @@ Note: Only fields enabled in \fB\fC-drun-match-fields\fR can be used in the form
Show actions present in the Desktop files.
.PP
.RS
.nf
Default: false
.fi
.RE
.PP
\fB\fC-window-match-fields\fR \fIfield1\fP,\fIfield2\fP,...
@ -632,52 +637,52 @@ The different fields are:
.IP \(bu 2
\fBdesktop\fP: window's current desktop
.IP \(bu 2
\fBall\fP: all the aboveDefault: \fIall\fP
\fBall\fP: all the above
.RE
.PP
Default: \fIall\fP
.PP
\fB\fC-matching-negate-char\fR \fIchar\fP
.PP
Set the character used to negate the query (i.e. if it does \fBnot\fP match the next keyword).
Set to '\\x0' to disable.
Set the character used to negate the query (i.e. if it does \fBnot\fP match the
next keyword). Set to '\\x0' to disable.
.PP
.RS
.nf
Default: '-'
.fi
.RE
.SS Layout and Theming
.PP
\fBIMPORTANT:\fP
In newer \fBrofi\fP releases, all the theming options have been moved into the new theme format. They are no longer normal
\fBrofi\fP options that can be passed directly on the command line (there are too many).
Small snippets can be passed on the command line: \fB\fCrofi -theme-str 'window {width: 50%;}'\fR to override a single
setting. They are merged into the current theme.
They can also be appended at the end of the \fBrofi\fP config file to override parts of the theme.
\fBIMPORTANT:\fP In newer \fBrofi\fP releases, all the theming options have been
moved into the new theme format. They are no longer normal \fBrofi\fP options
that can be passed directly on the command line (there are too many). Small
snippets can be passed on the command line: \fB\fCrofi -theme-str 'window {width:
50%;}'\fR to override a single setting. They are merged into the current theme.
They can also be appended at the end of the \fBrofi\fP config file to override
parts of the theme.
.PP
Most of the following options are \fBdeprecated\fP and should not be used. Please use the new theme format to customize
\fBrofi\fP\&. More information about the new format can be found in the \fBrofi-theme(5)\fP manpage.
Most of the following options are \fBdeprecated\fP and should not be used. Please
use the new theme format to customize \fBrofi\fP\&. More information about the new
format can be found in the \fBrofi-theme(5)\fP manpage.
.PP
\fB\fC-location\fR
.PP
Specify where the window should be located. The numbers map to the following locations on screen:
Specify where the window should be located. The numbers map to the following
locations on screen:
.PP
.RS
.nf
1 2 3
8 0 4
7 6 5
1 2 3
8 0 4
7 6 5
.fi
.RE
@ -695,15 +700,14 @@ Keep a fixed number of visible lines.
\fB\fC-sidebar-mode\fR
.PP
Open in sidebar-mode. In this mode, a list of all enabled modes is shown at the bottom.
(See \fB\fC-modes\fR option)
To show sidebar, use:
Open in sidebar-mode. In this mode, a list of all enabled modes is shown at the
bottom (See \fB\fC-modes\fR option). To show sidebar, use:
.PP
.RS
.nf
rofi -show run -sidebar-mode
rofi -show run -sidebar-mode
.fi
.RE
@ -712,14 +716,15 @@ rofi -show run -sidebar-mode
\fB\fC-hover-select\fR
.PP
Automatically select the entry the mouse is hovering over. This option is best combined with custom mouse bindings.
To utilize hover-select and accept an entry in a single click, use:
Automatically select the entry the mouse is hovering over. This option is best
combined with custom mouse bindings. To utilize hover-select and accept an
entry in a single click, use:
.PP
.RS
.nf
rofi -show run -hover-select -me-select-entry '' -me-accept-entry MousePrimary
rofi -show run -hover-select -me-select-entry '' -me-accept-entry MousePrimary
.fi
.RE
@ -750,25 +755,29 @@ When one entry is left, automatically select it.
\fB\fC-monitor\fR \fIname\fP
.PP
Select monitor to display \fBrofi\fP on.
It accepts as input: \fIprimary\fP (if primary output is set), the \fIxrandr\fP output name, or integer number (in order of
detection). Negative numbers are handled differently:
Select monitor to display \fBrofi\fP on. It accepts as input: \fIprimary\fP (if
primary output is set), the \fIxrandr\fP output name, or integer number (in order
of detection). Negative numbers are handled differently:
.RS
.IP \(bu 2
\fB-1\fP: the currently focused monitor.
.IP \(bu 2
\fB-2\fP: the currently focused window (that is, \fBrofi\fP will be displayed on top of the focused window).
\fB-2\fP: the currently focused window (that is, \fBrofi\fP will be displayed
on top of the focused window).
.IP \(bu 2
\fB-3\fP: Position of mouse (overrides the location setting to get normal context menu
behavior.)
\fB-3\fP: Position of mouse (overrides the location setting to get normal
context menu behavior.)
.IP \(bu 2
\fB-4\fP: the monitor with the focused window.
.IP \(bu 2
\fB-5\fP: the monitor that shows the mouse pointer.Default: \fI-5\fP
\fB-5\fP: the monitor that shows the mouse pointer.
.RE
.PP
Default: \fI-5\fP
.PP
See \fB\fCrofi -h\fR output for the detected monitors, their position, and size.
@ -791,7 +800,7 @@ For example:
.RS
.nf
rofi -theme-str '#window { fullscreen: true; }'
rofi -theme-str '#window { fullscreen: true; }'
.fi
.RE
@ -808,9 +817,11 @@ Override the default DPI setting.
.RS
.IP \(bu 2
If set to \fB\fC0\fR, it tries to auto-detect based on X11 screen size (similar to i3 and GTK).
If set to \fB\fC0\fR, it tries to auto-detect based on X11 screen size (similar to
i3 and GTK).
.IP \(bu 2
If set to \fB\fC1\fR, it tries to auto-detect based on the size of the monitor that \fBrofi\fP is displayed on (similar to latest Qt 5).
If set to \fB\fC1\fR, it tries to auto-detect based on the size of the monitor
that \fBrofi\fP is displayed on (similar to latest Qt 5).
.RE
@ -834,7 +845,7 @@ Specify which terminal to start.
.RS
.nf
rofi -terminal xterm
rofi -terminal xterm
.fi
.RE
@ -902,7 +913,8 @@ See \fIPATTERN\fP\&.
Default: \fI{cmd}\fP
.PP
Example to run applications in a dedicated cgroup with systemd. Requires a shell to escape and interpolate the unit name correctly.
Example to run applications in a dedicated cgroup with systemd. Requires a
shell to escape and interpolate the unit name correctly.
.PP
.RS
@ -927,7 +939,8 @@ Default: \fI{terminal} -e {cmd}\fP
\fB\fC-run-list-command\fR \fIcmd\fP
.PP
If set, use an external tool to generate a list of executable commands. Uses \fB\fCrun-command\fR\&.
If set, use an external tool to generate a list of executable commands. Uses
\fB\fCrun-command\fR\&.
.PP
Default: \fI{cmd}\fP
@ -960,8 +973,9 @@ Format what is being displayed for windows.
.RE
.PP
\fIlen\fP: maximum field length (0 for auto-size). If length is negative, the entry will be unchanged.
If length is positive, the entry will be truncated or padded to fill that length.
\fIlen\fP: maximum field length (0 for auto-size). If length is negative, the entry
will be unchanged. If length is positive, the entry will be truncated or padded
to fill that length.
.PP
default: {w} {c} {t}
@ -983,7 +997,8 @@ Default: \fI"wmctrl -i -R {window}"\fP
Show window thumbnail (if available) as icon in the window switcher.
.PP
You can stop rofi from exiting when closing a window (allowing multiple to be closed in a row).
You can stop rofi from exiting when closing a window (allowing multiple to be
closed in a row).
.PP
.RS
@ -1018,7 +1033,8 @@ configuration {
or pass \fB\fC-window-hide-active-window true\fR on command line.
.PP
You can prefer the icon theme above the window set icon with the 'prefer-icon-theme' setting:
You can prefer the icon theme above the window set icon with the
'prefer-icon-theme' setting:
.PP
.RS
@ -1049,14 +1065,14 @@ To get one merge view, of \fB\fCwindow\fR,\fB\fCrun\fR, and \fB\fCssh\fR:
.RS
.nf
rofi -show combi -combi-modes "window,run,ssh" -modes combi
rofi -show combi -combi-modes "window,run,ssh" -modes combi
.fi
.RE
.PP
\fBNOTE\fP: The i3 window manager dislikes commas in the command when specifying an exec command.
For that case, \fB\fC#\fR can be used as a separator.
\fBNOTE\fP: The i3 window manager dislikes commas in the command when specifying
an exec command. For that case, \fB\fC#\fR can be used as a separator.
.PP
\fB\fC-combi-display-format\fR
@ -1076,14 +1092,8 @@ The format string for entries in the \fB\fCcombi\fR dialog:
Pango markup can be used to formatting the output.
.PP
.RS
.nf
Default: {mode} {text}
.fi
.RE
.PP
Note: This setting is ignored if \fB\fCcombi-hide-mode-prefix\fR is enabled.
@ -1121,7 +1131,8 @@ fzf sorting.
\fB\fC-max-history-size\fR \fInumber\fP
.PP
Maximum number of entries to store in history. Defaults to 25. (WARNING: can cause slowdowns when set too high)
Maximum number of entries to store in history. Defaults to 25. (WARNING: can
cause slowdowns when set too high)
.SS Message dialog
.PP
@ -1207,13 +1218,15 @@ By default the file is stored in the systems cache directory, in a file called
\fB\fC-drun-use-desktop-cache\fR
.PP
Build and use a cache with the content of desktop files. Usable for systems with slow hard drives.
Build and use a cache with the content of desktop files. Usable for systems
with slow hard drives.
.PP
\fB\fC-drun-reload-desktop-cache\fR
.PP
If \fB\fCdrun-use-desktop-cache\fR is enabled, rebuild a cache with the content of desktop files.
If \fB\fCdrun-use-desktop-cache\fR is enabled, rebuild a cache with the content of
desktop files.
.PP
\fB\fC-drun-url-launcher\fR \fIcommand\fP
@ -1225,7 +1238,9 @@ Command to open a Desktop Entry that is a Link.
\fB\fC-pid\fR \fIpath\fP
.PP
Make \fBrofi\fP create a pid file and check this on startup. The pid file prevents multiple \fBrofi\fP instances from running simultaneously. This is useful when running \fBrofi\fP from a key-binding daemon.
Make \fBrofi\fP create a pid file and check this on startup. The pid file
prevents multiple \fBrofi\fP instances from running simultaneously. This is
useful when running \fBrofi\fP from a key-binding daemon.
.PP
\fB\fC-replace\fR
@ -1269,14 +1284,17 @@ Default: \fIenabled\fP
\fB\fC-xserver-i300-workaround\fR
.PP
Workaround for bug in Xserver. See issue #611 and #1642 on the rofi issue tracker.
Workaround for bug in Xserver. See issue #611 and #1642 on the rofi issue
tracker.
.PP
Default: \fIdisabled\fP
.SH PATTERN
.PP
To launch commands (for example, when using the ssh launcher), the user can enter the used command-line. The following keys can be used that will be replaced at runtime:
To launch commands (for example, when using the ssh launcher), the user can
enter the used command-line. The following keys can be used that will be
replaced at runtime:
.RS
.IP \(bu 2
@ -1298,7 +1316,8 @@ Please see \fBrofi-theme(5)\fP manpage for more information on theming.
.SH KEY BINDINGS
.PP
Please see the \fBrofi-keys(5)\fP manpage for the keybindings and how to set them up.
Please see the \fBrofi-keys(5)\fP manpage for the keybindings and how to set them
up.
.PP
The keybinding can also be used for actions, when the action is executed the
@ -1344,54 +1363,78 @@ configuration {
.SH Available Modes
.SS window
.PP
Show a list of all the windows and allow switching between them.
Pressing the \fB\fCdelete-entry\fR binding (\fB\fCshift-delete\fR) will close the window.
Pressing the \fB\fCaccept-custom\fR binding (\fB\fCcontrol-enter\fR or \fB\fCshift-enter\fR) will run a command on the window.
(See option \fB\fCwindow-command\fR );
Show a list of all the windows and allow switching between them. Pressing the
\fB\fCdelete-entry\fR binding (\fB\fCshift-delete\fR) will close the window. Pressing the
\fB\fCaccept-custom\fR binding (\fB\fCcontrol-enter\fR or \fB\fCshift-enter\fR) will run a command
on the window. (See option \fB\fCwindow-command\fR );
.PP
If there is no match, it will try to launch the input.
.SS windowcd
.PP
Shows a list of the windows on the current desktop and allows switching between them.
Pressing the \fB\fCdelete-entry\fR binding (\fB\fCshift-delete\fR) will kill the window.
Pressing the \fB\fCaccept-custom\fR binding (\fB\fCcontrol-enter\fR or \fB\fCshift-enter\fR) will run a command on the window.
(See option \fB\fCwindow-command\fR );
Shows a list of the windows on the current desktop and allows switching between
them. Pressing the \fB\fCdelete-entry\fR binding (\fB\fCshift-delete\fR) will kill the
window. Pressing the \fB\fCaccept-custom\fR binding (\fB\fCcontrol-enter\fR or \fB\fCshift-enter\fR)
will run a command on the window. (See option \fB\fCwindow-command\fR );
.PP
If there is no match, it will try to launch the input.
.SS run
.PP
Shows a list of executables in \fB\fC$PATH\fR and can launch them (optional in a terminal).
Pressing the \fB\fCdelete-entry\fR binding (\fB\fCshift-delete\fR) will remove this entry from the run history.
Pressing the \fB\fCaccept-custom\fR binding (\fB\fCcontrol-enter\fR) will run the command as entered in the entry box.
Pressing the \fB\fCaccept-alt\fR binding (\fB\fCshift-enter\fR) will run the command in a terminal.
Shows a list of executables in \fB\fC$PATH\fR and can launch them (optional in a
terminal).
.RS
.IP \(bu 2
Pressing the \fB\fCdelete-entry\fR binding (\fB\fCshift-delete\fR) will remove this entry
from the run history.
.IP \(bu 2
Pressing the \fB\fCaccept-custom\fR binding (\fB\fCcontrol-enter\fR) will run the command
as entered in the entry box.
.IP \(bu 2
Pressing the \fB\fCaccept-alt\fR binding (\fB\fCshift-enter\fR) will run the command in a
terminal.
.RE
.PP
When pressing the \fB\fCmode-complete\fR binding (\fB\fCControl-l\fR), you can use the File Browser mode to launch the application
with a file as the first argument.
When pressing the \fB\fCmode-complete\fR binding (\fB\fCControl-l\fR), you can use the File
Browser mode to launch the application with a file as the first argument.
.SS drun
.PP
Same as the \fBrun\fP launches, but the list is created from the installed desktop files. It automatically launches them
in a terminal if specified in the Desktop File.
Pressing the \fB\fCdelete-entry\fR binding (\fB\fCshift-delete\fR) will remove this entry from the run history.
Pressing the \fB\fCaccept-custom\fR binding (\fB\fCcontrol-enter\fR) will run the command as entered in the entry box.
Pressing the \fB\fCaccept-alt\fR binding (\fB\fCshift-enter\fR) will run the command in a terminal.
Same as the \fBrun\fP launches, but the list is created from the installed
desktop files. It automatically launches them in a terminal if specified in the
Desktop File.
.RS
.IP \(bu 2
Pressing the \fB\fCdelete-entry\fR binding (\fB\fCshift-delete\fR) will remove this entry
from the run history.
.IP \(bu 2
Pressing the \fB\fCaccept-custom\fR binding (\fB\fCcontrol-enter\fR) will run the command
as entered in the entry box.
.IP \(bu 2
Pressing the \fB\fCaccept-alt\fR binding (\fB\fCshift-enter\fR) will run the command in a
terminal.
.RE
.PP
When pressing the \fB\fCmode-complete\fR binding (\fB\fCControl-l\fR), you can use the File Browser mode to launch the application
passing a file as argument if specified in the desktop file.
When pressing the \fB\fCmode-complete\fR binding (\fB\fCControl-l\fR), you can use the File
Browser mode to launch the application passing a file as argument if specified
in the desktop file.
.PP
The DRUN mode tries to follow the XDG Desktop Entry
Specification
\[la]https://freedesktop.org/wiki/Specifications/desktop-entry-spec/\[ra] and should be compatible with
applications using this standard. Some applications create invalid desktop files, \fBrofi\fP will discard these entries.
See the debugging section for more info on DRUN mode, this will print why desktop files are
discarded.
\[la]https://freedesktop.org/wiki/Specifications/desktop-entry-spec/\[ra]
and should be compatible with applications using this standard. Some
applications create invalid desktop files, \fBrofi\fP will discard these entries.
See the debugging section for more info on DRUN mode, this will print why
desktop files are discarded.
.PP
There are two advanced options to tweak the behaviour:
@ -1414,7 +1457,8 @@ configuration {
.SS ssh
.PP
Shows a list of SSH targets based on your \fB\fCssh\fR config file, and allows to quickly \fB\fCssh\fR into them.
Shows a list of SSH targets based on your \fB\fCssh\fR config file, and allows to
quickly \fB\fCssh\fR into them.
.SS keys
.PP
@ -1422,11 +1466,13 @@ Shows a searchable list of key bindings.
.SS script
.PP
Allows custom scripted Modes to be added, see the \fBrofi-script(5)\fP manpage for more information.
Allows custom scripted Modes to be added, see the \fBrofi-script(5)\fP manpage
for more information.
.SS combi
.PP
Combines multiple modes in one list. Specify which modes are included with the \fB\fC-combi-modes\fR option.
Combines multiple modes in one list. Specify which modes are included with the
\fB\fC-combi-modes\fR option.
.PP
When using the combi mode, a \fI!bang\fP can be used to filter the results by modes.
@ -1439,28 +1485,29 @@ modes are shown, even if the rest of the input text would match results from \fB
If no match, the input is handled by the first combined modes.
.SH FAQ
.SS The text in the window switcher is not nicely aligned.
.SS The text in the window switcher is not nicely aligned
.PP
Try using a mono-space font or tabs + the tab-stops setting..
.SS The window is completely black.
.SS The window is completely black
.PP
Check quotes used on the command-line: you might have used \fB\fC“\fR ("smart quotes") instead of \fB\fC"\fR ("machine quotes").
Check quotes used on the command-line: you might have used \fB\fC“\fR ("smart quotes")
instead of \fB\fC"\fR ("machine quotes").
.SS What does the icon in the top right show?
.PP
The indicator shows:
.PP
.RS
.IP \(bu 2
Case insensitive and no sorting.
.IP \(bu 2
\fB\fC-\fR Case sensitivity enabled, no sorting.
.IP \(bu 2
\fB\fC+\fR Case insensitive and Sorting enabled
.IP \(bu 2
\fB\fC±\fR Sorting and Case sensitivity enabled"
.nf
` ` Case insensitive and no sorting.
`-` Case sensitivity enabled, no sorting.
`+` Case insensitive and Sorting enabled
`±` Sorting and Case sensitivity enabled"
.fi
.RE
.SS Why do I see different icons for run,drun and window mode
@ -1470,7 +1517,8 @@ Each of these modes uses different methods of resolving the icon:
.RS
.IP \(bu 2
Window: It first uses the icon that the application exposes via the X11
Server, if none is set it does a lookup of the window Class name in the icon theme.
Server, if none is set it does a lookup of the window Class name in the icon
theme.
.IP \(bu 2
drun: It uses the icon set in the desktop file.
.IP \(bu 2
@ -1489,7 +1537,7 @@ Show the run dialog:
.RS
.nf
rofi -modes run -show run
rofi -modes run -show run
.fi
.RE
@ -1501,7 +1549,7 @@ Show the run dialog, and allow switching to Desktop File run dialog (\fB\fCdrun\
.RS
.nf
rofi -modes run,drun -show run
rofi -modes run,drun -show run
.fi
.RE
@ -1513,19 +1561,20 @@ Combine the run and Desktop File run dialog (\fB\fCdrun\fR):
.RS
.nf
rofi -modes combi -show combi -combi-modes run,drun
rofi -modes combi -show combi -combi-modes run,drun
.fi
.RE
.PP
Combine the run and Desktop File run dialog (\fB\fCdrun\fR), and allow switching to window switcher:
Combine the run and Desktop File run dialog (\fB\fCdrun\fR), and allow switching to
window switcher:
.PP
.RS
.nf
rofi -modes combi,window -show combi -combi-modes run,drun
rofi -modes combi,window -show combi -combi-modes run,drun
.fi
.RE
@ -1537,7 +1586,7 @@ Pop up a text message claiming that this is the end:
.RS
.nf
rofi -e "This is the end"
rofi -e "This is the end"
.fi
.RE
@ -1549,7 +1598,7 @@ Pop up a text message in red, bold font claiming that this is still the end:
.RS
.nf
rofi -e "<span color='red'><b>This is still the end</b></span>" -markup
rofi -e "<span color='red'><b>This is still the end</b></span>" -markup
.fi
.RE
@ -1561,7 +1610,7 @@ Show all key bindings:
.RS
.nf
rofi -show keys
rofi -show keys
.fi
.RE
@ -1569,40 +1618,42 @@ rofi -show keys
.SH i3
.PP
In i3
\[la]http://i3wm.org/\[ra] you want to bind \fBrofi\fP to be launched on key release. Otherwise, it cannot grab the keyboard.
See also the i3 manual
\[la]http://i3wm.org/\[ra] you want to bind \fBrofi\fP to be launched on key
release. Otherwise, it cannot grab the keyboard. See also the i3
manual
\[la]http://i3wm.org/docs/userguide.html\[ra]:
.PP
Some tools (such as \fB\fCimport\fR or \fB\fCxdotool\fR) might be unable to run upon a KeyPress event, because the keyboard/pointer is
still grabbed. For these situations, the \fB\fC--release\fR flag can be used, as it will execute the command after the keys have
been released.
Some tools (such as \fB\fCimport\fR or \fB\fCxdotool\fR) might be unable to run upon a
KeyPress event, because the keyboard/pointer is still grabbed. For these
situations, the \fB\fC--release\fR flag can be used, as it will execute the command
after the keys have been released.
.SH LICENSE
.PP
.RS
.nf
MIT/X11
MIT/X11
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
.fi
.RE
@ -1642,7 +1693,9 @@ first.
.SH SEE ALSO
.PP
\fBrofi-sensible-terminal(1)\fP, \fBdmenu(1)\fP, \fBrofi-debugging(5)\fP, \fBrofi-theme(5)\fP, \fBrofi-script(5)\fP, \fBrofi-keys(5)\fP,\fBrofi-theme-selector(1)\fP,\fBrofi-dmenu(5)\fP
\fBrofi-sensible-terminal(1)\fP, \fBdmenu(1)\fP, \fBrofi-debugging(5)\fP,
\fBrofi-theme(5)\fP, \fBrofi-script(5)\fP,
\fBrofi-keys(5)\fP,\fBrofi-theme-selector(1)\fP,\fBrofi-dmenu(5)\fP
.SH AUTHOR
.RS

475
doc/rofi.1.markdown
View file

@ -2,20 +2,19 @@
## NAME
**rofi** - A window switcher, application launcher, ssh dialog, dmenu replacement and more
**rofi** - A window switcher, application launcher, ssh dialog, dmenu
replacement and more
## SYNOPSIS
**rofi** [ -show *mode* ]|[ -dmenu ]|[ -e *msg* ] [ CONFIGURATION ]
## DESCRIPTION
**rofi** is an X11 pop-up window switcher, run dialog, dmenu replacement, and
more. It focuses on being fast to use and have minimal distraction. It supports
keyboard and mouse navigation, type to filter, tokenized search and more.
## USAGE
**rofi**'s main functionality is to assist in your workflow, allowing you to
@ -27,8 +26,8 @@ replacement for **dmenu(1)**. See emulating dmenu below.
### Running rofi
To launch **rofi** directly in a certain mode, specify a mode with `rofi -show <mode>`.
To show the `drun` dialog:
To launch **rofi** directly in a certain mode, specify a mode with `rofi -show
<mode>`. To show the `drun` dialog:
```bash
rofi -show drun
@ -45,7 +44,6 @@ In this setup it first list all open applications, then all installed
applications. So if you type firefox and hit return, it will switch to the
running firefox, or launch it when it is not running.
### Emulating dmenu
**rofi** can emulate **dmenu(1)** (a dynamic menu for X11) when launched with
@ -57,27 +55,37 @@ For more information see **rofi-dmenu(5)**.
**rofi** error dialog can also be called from the command line.
```bash
rofi -e "my message"
```
Markup support can be enabled, see CONFIGURATION options.
## CONFIGURATION
There are currently three methods of setting configuration options (evaluated in order below):
There are currently three methods of setting configuration options (evaluated
in order below):
* System configuration file (for example `/etc/rofi.rasi`).
It first checks `XDG_CONFIG_DIRS`, and then `SYSCONFDIR` (that is passed at compile time).
It loads the first config file it finds, it does not merge multiple system configuration files.
* Rasi theme file: The new *theme* format can be used to set configuration values.
* Command-line options: Arguments passed to **rofi**.
- System configuration file (for example `/etc/rofi.rasi`). It first checks
`XDG_CONFIG_DIRS`, and then `SYSCONFDIR` (that is passed at compile time).
It loads the first config file it finds, it does not merge multiple system
configuration files.
- Rasi theme file: The new *theme* format can be used to set configuration
values.
- Command-line options: Arguments passed to **rofi**.
To get a template config file, run: `rofi -dump-config > config.rasi`
This will contain (commented) all current configuration options, modified options are uncommented.
This will contain (commented) all current configuration options, modified
options are uncommented.
To get a template config file that sets the icon-theme run: `rofi -icon-theme hicolor -dump-config`.
To get a template config file that sets the icon-theme run: `rofi -icon-theme
hicolor -dump-config`.
It is **strongly** recommended to use this as a starting point for your configuration.
It is **strongly** recommended to use this as a starting point for your
configuration.
An empty configuration section in the config file looks like:
@ -100,22 +108,26 @@ configuration {
The configuration system supports the following types:
* string
* integer (signed and unsigned)
* char
* boolean
* lists
- string
- integer (signed and unsigned)
- char
- boolean
- lists
For the syntax of these options, see the **rofi-theme(5)** manpage.
For use on the command line, Boolean options have a non-default command-line
syntax. Example to enable option X:
```text
-X
```
To disable option X:
```text
-no-X
```
Below is a list of the most important options:
@ -152,11 +164,11 @@ look for duplicate bindings.
Specify the number of threads **rofi** should use:
* 0: Autodetect the number of supported hardware threads.
* 1: Disable threading
* 2..n: Specify the maximum number of threads to use in the thread pool.
- 0: Autodetect the number of supported hardware threads.
- 1: Disable threading
- 2..n: Specify the maximum number of threads to use in the thread pool.
Default: Autodetect
Default: Autodetect
`-display` *display*
@ -168,11 +180,15 @@ Run **rofi** in dmenu mode. This allows for interactive scripts.
In `dmenu` mode, **rofi** reads from STDIN, and output to STDOUT.
A simple example, displaying three pre-defined options:
```bash
echo -e "Option #1\nOption #2\nOption #3" | rofi -dmenu
```
Or get the options from a script:
```bash
~/my_script.sh | rofi -dmenu
```
See the **rofi-dmenu(5)** manpage for more information.
@ -185,7 +201,9 @@ list of supported key bindings
To show the run-dialog:
```bash
rofi -show run
```
If `-show` is the last option passed to rofi, the first enabled modes is shown.
@ -196,28 +214,37 @@ Enabled modes can be changed at runtime. Default key is `Ctrl+Tab`.
If no modes are specified, all configured modes will be enabled.
To only show the `run` and `ssh` launcher:
```bash
rofi -modes "run,ssh" -show run
```
Custom modes can be added using the internal `script` mode. Each such mode has
two parameters:
<name>:<script>
```text
<name>:<script>
```
Example: Have a mode called 'Workspaces' using the `i3_switch_workspaces.sh` script:
Example: Have a mode called 'Workspaces' using the `i3_switch_workspaces.sh`
script:
```bash
rofi -modes "window,run,ssh,Workspaces:i3_switch_workspaces.sh" -show Workspaces
```
Notes: The i3 window manager dislikes commas in the command when specifying an
exec command. For that case, `#` can be used as a separator.
**TIP**: The name is allowed to contain spaces:
```bash
rofi -modes "My File Browser:fb.sh" -show "My File Browser"
```
`-case-sensitive`
Start in case-sensitive mode.
This option can be changed at run-time using the `-kb-toggle-case-sensitivity` key binding.
Start in case-sensitive mode. This option can be changed at run-time using the
`-kb-toggle-case-sensitivity` key binding.
`-cycle`
@ -241,8 +268,9 @@ Select the scrolling method. 0: Per page, 1: continuous.
`-normalize-match`
Normalize the string before matching, so `o` will match `ö`, and `é` matches `e`.
This is not a perfect implementation, but works. For now, it disables highlighting of the matched part.
Normalize the string before matching, so `o` will match `ö`, and `é` matches
`e`. This is not a perfect implementation, but works. For now, it disables
highlighting of the matched part.
`-no-lazy-grab`
@ -262,9 +290,8 @@ Show application icons in `drun` and `window` modes.
`-icon-theme`
Specify icon theme to be used.
If not specified default theme from DE is used, *Adwaita* and *gnome* themes act as
fallback themes.
Specify icon theme to be used. If not specified default theme from DE is used,
*Adwaita* and *gnome* themes act as fallback themes.
`-markup`
@ -272,15 +299,18 @@ Use Pango markup to format output wherever possible.
`-normal-window`
Make **rofi** react like a normal application window. Useful for scripts like Clerk that are basically an application.
Make **rofi** react like a normal application window. Useful for scripts like
Clerk that are basically an application.
`-[no-]steal-focus`
Make rofi steal focus on launch and restore close to window that held it when launched.
Make rofi steal focus on launch and restore close to window that held it when
launched.
`-refilter-timeout-limit`
The time (in ms) boundary filter may take before switch from instant to delayed filter mode.
The time (in ms) boundary filter may take before switch from instant to delayed
filter mode.
Default: 300
@ -303,8 +333,6 @@ configuration {
}
```
### Matching
`-matching` *method*
@ -312,13 +340,13 @@ configuration {
Specify the matching algorithm used.
Currently, the following methods are supported:
* **normal**: match the int string
* **regex**: match a regex input
* **glob**: match a glob pattern
* **fuzzy**: do a fuzzy match
* **prefix**: match prefix
- **normal**: match the int string
- **regex**: match a regex input
- **glob**: match a glob pattern
- **fuzzy**: do a fuzzy match
- **prefix**: match prefix
Default: *normal*
Default: *normal*
Note: glob matching might be slow for larger lists
@ -335,78 +363,83 @@ Only show desktop files that are present in the listed categories.
When using `drun`, match only with the specified Desktop entry fields.
The different fields are:
* **name**: the application's name
* **generic**: the application's generic name
* **exec**: the application's executable
* **categories**: the application's categories
* **comment**: the application comment
* **all**: all the above
- **name**: the application's name
- **generic**: the application's generic name
- **exec**: the application's executable
- **categories**: the application's categories
- **comment**: the application comment
- **all**: all the above
Default: *name,generic,exec,categories,keywords*
Default: *name,generic,exec,categories,keywords*
`-drun-display-format`
The format string for the `drun` dialog:
* **name**: the application's name
* **generic**: the application's generic name
* **exec**: the application's executable
* **categories**: the application's categories
* **comment**: the application comment
- **name**: the application's name
- **generic**: the application's generic name
- **exec**: the application's executable
- **categories**: the application's categories
- **comment**: the application comment
Pango markup can be used to formatting the output.
Default: {name} [<span weight='light' size='small'><i>({generic})</i></span>]
Default: {name} [<span weight='light' size='small'><i>({generic})</i></span>]
Note: Only fields enabled in `-drun-match-fields` can be used in the format string.
Note: Only fields enabled in `-drun-match-fields` can be used in the format
string.
`-[no-]drun-show-actions`
Show actions present in the Desktop files.
Default: false
Default: false
`-window-match-fields` *field1*,*field2*,...
When using window mode, match only with the specified fields.
The different fields are:
* **title**: window's title
* **class**: window's class
* **role**: window's role
* **name**: window's name
* **desktop**: window's current desktop
* **all**: all the above
- **title**: window's title
- **class**: window's class
- **role**: window's role
- **name**: window's name
- **desktop**: window's current desktop
- **all**: all the above
Default: *all*
Default: *all*
`-matching-negate-char` *char*
Set the character used to negate the query (i.e. if it does **not** match the next keyword).
Set to '\x0' to disable.
Default: '-'
Set the character used to negate the query (i.e. if it does **not** match the
next keyword). Set to '\x0' to disable.
Default: '-'
### Layout and Theming
**IMPORTANT:**
In newer **rofi** releases, all the theming options have been moved into the new theme format. They are no longer normal
**rofi** options that can be passed directly on the command line (there are too many).
Small snippets can be passed on the command line: `rofi -theme-str 'window {width: 50%;}'` to override a single
setting. They are merged into the current theme.
They can also be appended at the end of the **rofi** config file to override parts of the theme.
**IMPORTANT:** In newer **rofi** releases, all the theming options have been
moved into the new theme format. They are no longer normal **rofi** options
that can be passed directly on the command line (there are too many). Small
snippets can be passed on the command line: `rofi -theme-str 'window {width:
50%;}'` to override a single setting. They are merged into the current theme.
They can also be appended at the end of the **rofi** config file to override
parts of the theme.
Most of the following options are **deprecated** and should not be used. Please use the new theme format to customize
**rofi**. More information about the new format can be found in the **rofi-theme(5)** manpage.
Most of the following options are **deprecated** and should not be used. Please
use the new theme format to customize **rofi**. More information about the new
format can be found in the **rofi-theme(5)** manpage.
`-location`
Specify where the window should be located. The numbers map to the following locations on screen:
Specify where the window should be located. The numbers map to the following
locations on screen:
```text
1 2 3
8 0 4
7 6 5
```
Default: *0*
@ -416,18 +449,22 @@ Keep a fixed number of visible lines.
`-sidebar-mode`
Open in sidebar-mode. In this mode, a list of all enabled modes is shown at the bottom.
(See `-modes` option)
To show sidebar, use:
Open in sidebar-mode. In this mode, a list of all enabled modes is shown at the
bottom (See `-modes` option). To show sidebar, use:
```bash
rofi -show run -sidebar-mode
```
`-hover-select`
Automatically select the entry the mouse is hovering over. This option is best combined with custom mouse bindings.
To utilize hover-select and accept an entry in a single click, use:
Automatically select the entry the mouse is hovering over. This option is best
combined with custom mouse bindings. To utilize hover-select and accept an
entry in a single click, use:
```bash
rofi -show run -hover-select -me-select-entry '' -me-accept-entry MousePrimary
```
`-eh` *number*
@ -446,22 +483,26 @@ When one entry is left, automatically select it.
`-monitor` *name*
Select monitor to display **rofi** on.
It accepts as input: *primary* (if primary output is set), the *xrandr* output name, or integer number (in order of
detection). Negative numbers are handled differently:
Select monitor to display **rofi** on. It accepts as input: *primary* (if
primary output is set), the *xrandr* output name, or integer number (in order
of detection). Negative numbers are handled differently:
* **-1**: the currently focused monitor.
* **-2**: the currently focused window (that is, **rofi** will be displayed on top of the focused window).
* **-3**: Position of mouse (overrides the location setting to get normal context menu
behavior.)
* **-4**: the monitor with the focused window.
* **-5**: the monitor that shows the mouse pointer.
- **-1**: the currently focused monitor.
Default: *-5*
- **-2**: the currently focused window (that is, **rofi** will be displayed
on top of the focused window).
- **-3**: Position of mouse (overrides the location setting to get normal
context menu behavior.)
- **-4**: the monitor with the focused window.
- **-5**: the monitor that shows the mouse pointer.
Default: *-5*
See `rofi -h` output for the detected monitors, their position, and size.
`-theme` *filename*
Path to the new theme file format. This overrides the old theme settings.
@ -472,7 +513,9 @@ Allow theme parts to be specified on the command line as an override.
For example:
```bash
rofi -theme-str '#window { fullscreen: true; }'
```
This option can be specified multiple times.
This is now the method to tweak the theme via the command line.
@ -481,8 +524,11 @@ This is now the method to tweak the theme via the command line.
Override the default DPI setting.
* If set to `0`, it tries to auto-detect based on X11 screen size (similar to i3 and GTK).
* If set to `1`, it tries to auto-detect based on the size of the monitor that **rofi** is displayed on (similar to latest Qt 5).
- If set to `0`, it tries to auto-detect based on X11 screen size (similar to
i3 and GTK).
- If set to `1`, it tries to auto-detect based on the size of the monitor
that **rofi** is displayed on (similar to latest Qt 5).
`-selected-row` *selected row*
@ -496,7 +542,9 @@ Default: *0*
Specify which terminal to start.
```bash
rofi -terminal xterm
```
Pattern: *{terminal}*
@ -543,9 +591,10 @@ See *PATTERN*.
Default: *{cmd}*
Example to run applications in a dedicated cgroup with systemd. Requires a shell to escape and interpolate the unit name correctly.
Example to run applications in a dedicated cgroup with systemd. Requires a
shell to escape and interpolate the unit name correctly.
```
```bash
"bash -c 'systemd-run --user --unit=app-rofi-\$(systemd-escape {cmd})-\$RANDOM {cmd}'"
```
@ -558,7 +607,8 @@ Default: *{terminal} -e {cmd}*
`-run-list-command` *cmd*
If set, use an external tool to generate a list of executable commands. Uses `run-command`.
If set, use an external tool to generate a list of executable commands. Uses
`run-command`.
Default: *{cmd}*
@ -572,15 +622,15 @@ Format what is being displayed for windows.
*field*:
* **w**: desktop name
* **t**: title of window
* **n**: name
* **r**: role
* **c**: class
*len*: maximum field length (0 for auto-size). If length is negative, the entry will be unchanged.
If length is positive, the entry will be truncated or padded to fill that length.
- **w**: desktop name
- **t**: title of window
- **n**: name
- **r**: role
- **c**: class
*len*: maximum field length (0 for auto-size). If length is negative, the entry
will be unchanged. If length is positive, the entry will be truncated or padded
to fill that length.
default: {w} {c} {t}
@ -591,13 +641,12 @@ See *PATTERN*.
Default: *"wmctrl -i -R {window}"*
`-window-thumbnail`
Show window thumbnail (if available) as icon in the window switcher.
You can stop rofi from exiting when closing a window (allowing multiple to be closed in a row).
You can stop rofi from exiting when closing a window (allowing multiple to be
closed in a row).
```css
configuration {
@ -618,7 +667,8 @@ configuration {
or pass `-window-hide-active-window true` on command line.
You can prefer the icon theme above the window set icon with the 'prefer-icon-theme' setting:
You can prefer the icon theme above the window set icon with the
'prefer-icon-theme' setting:
```css
configuration {
@ -638,25 +688,26 @@ The modes to combine in combi mode.
For syntax to `-combi-modes`, see `-modes`.
To get one merge view, of `window`,`run`, and `ssh`:
```bash
rofi -show combi -combi-modes "window,run,ssh" -modes combi
```
**NOTE**: The i3 window manager dislikes commas in the command when specifying an exec command.
For that case, `#` can be used as a separator.
**NOTE**: The i3 window manager dislikes commas in the command when specifying
an exec command. For that case, `#` can be used as a separator.
`-combi-display-format`
The format string for entries in the `combi` dialog:
* **mode**: the mode display name
* **text**: the entry text
- **mode**: the mode display name
- **text**: the entry text
Pango markup can be used to formatting the output.
Default: {mode} {text}
Default: {mode} {text}
Note: This setting is ignored if `combi-hide-mode-prefix` is enabled.
### History and Sorting
`-disable-history`
@ -674,13 +725,13 @@ This setting can be changed at runtime (see `-kb-toggle-sort`).
There are 2 sorting methods:
* levenshtein (Default)
* fzf sorting.
- levenshtein (Default)
- fzf sorting.
`-max-history-size` *number*
Maximum number of entries to store in history. Defaults to 25. (WARNING: can cause slowdowns when set too high)
Maximum number of entries to store in history. Defaults to 25. (WARNING: can
cause slowdowns when set too high)
### Message dialog
@ -746,11 +797,13 @@ By default the file is stored in the systems cache directory, in a file called
`-drun-use-desktop-cache`
Build and use a cache with the content of desktop files. Usable for systems with slow hard drives.
Build and use a cache with the content of desktop files. Usable for systems
with slow hard drives.
`-drun-reload-desktop-cache`
If `drun-use-desktop-cache` is enabled, rebuild a cache with the content of desktop files.
If `drun-use-desktop-cache` is enabled, rebuild a cache with the content of
desktop files.
`-drun-url-launcher` *command*
@ -758,7 +811,9 @@ Command to open a Desktop Entry that is a Link.
`-pid` *path*
Make **rofi** create a pid file and check this on startup. The pid file prevents multiple **rofi** instances from running simultaneously. This is useful when running **rofi** from a key-binding daemon.
Make **rofi** create a pid file and check this on startup. The pid file
prevents multiple **rofi** instances from running simultaneously. This is
useful when running **rofi** from a key-binding daemon.
`-replace`
@ -778,7 +833,6 @@ configuration {
}
```
`-click-to-exit`
`-no-click-to-exit`
@ -788,20 +842,22 @@ Default: *enabled*
`-xserver-i300-workaround`
Workaround for bug in Xserver. See issue #611 and #1642 on the rofi issue tracker.
Workaround for bug in Xserver. See issue #611 and #1642 on the rofi issue
tracker.
Default: *disabled*
## PATTERN
To launch commands (for example, when using the ssh launcher), the user can enter the used command-line. The following keys can be used that will be replaced at runtime:
* `{host}`: the host to connect to
* `{terminal}`: the configured terminal (see -terminal)
* `{ssh-client}`: the configured ssh client (see -ssh-client)
* `{cmd}`: the command to execute
* `{window}`: the window ID of the selected window (in `window-command`)
To launch commands (for example, when using the ssh launcher), the user can
enter the used command-line. The following keys can be used that will be
replaced at runtime:
- `{host}`: the host to connect to
- `{terminal}`: the configured terminal (see -terminal)
- `{ssh-client}`: the configured ssh client (see -ssh-client)
- `{cmd}`: the command to execute
- `{window}`: the window ID of the selected window (in `window-command`)
## THEMING
@ -809,7 +865,8 @@ Please see **rofi-theme(5)** manpage for more information on theming.
## KEY BINDINGS
Please see the **rofi-keys(5)** manpage for the keybindings and how to set them up.
Please see the **rofi-keys(5)** manpage for the keybindings and how to set them
up.
The keybinding can also be used for actions, when the action is executed the
mentioned keystroke is inserted:
@ -845,49 +902,64 @@ configuration {
### window
Show a list of all the windows and allow switching between them.
Pressing the `delete-entry` binding (`shift-delete`) will close the window.
Pressing the `accept-custom` binding (`control-enter` or `shift-enter`) will run a command on the window.
(See option `window-command` );
Show a list of all the windows and allow switching between them. Pressing the
`delete-entry` binding (`shift-delete`) will close the window. Pressing the
`accept-custom` binding (`control-enter` or `shift-enter`) will run a command
on the window. (See option `window-command` );
If there is no match, it will try to launch the input.
### windowcd
Shows a list of the windows on the current desktop and allows switching between them.
Pressing the `delete-entry` binding (`shift-delete`) will kill the window.
Pressing the `accept-custom` binding (`control-enter` or `shift-enter`) will run a command on the window.
(See option `window-command` );
Shows a list of the windows on the current desktop and allows switching between
them. Pressing the `delete-entry` binding (`shift-delete`) will kill the
window. Pressing the `accept-custom` binding (`control-enter` or `shift-enter`)
will run a command on the window. (See option `window-command` );
If there is no match, it will try to launch the input.
### run
Shows a list of executables in `$PATH` and can launch them (optional in a terminal).
Pressing the `delete-entry` binding (`shift-delete`) will remove this entry from the run history.
Pressing the `accept-custom` binding (`control-enter`) will run the command as entered in the entry box.
Pressing the `accept-alt` binding (`shift-enter`) will run the command in a terminal.
Shows a list of executables in `$PATH` and can launch them (optional in a
terminal).
When pressing the `mode-complete` binding (`Control-l`), you can use the File Browser mode to launch the application
with a file as the first argument.
- Pressing the `delete-entry` binding (`shift-delete`) will remove this entry
from the run history.
- Pressing the `accept-custom` binding (`control-enter`) will run the command
as entered in the entry box.
- Pressing the `accept-alt` binding (`shift-enter`) will run the command in a
terminal.
When pressing the `mode-complete` binding (`Control-l`), you can use the File
Browser mode to launch the application with a file as the first argument.
### drun
Same as the **run** launches, but the list is created from the installed desktop files. It automatically launches them
in a terminal if specified in the Desktop File.
Pressing the `delete-entry` binding (`shift-delete`) will remove this entry from the run history.
Pressing the `accept-custom` binding (`control-enter`) will run the command as entered in the entry box.
Pressing the `accept-alt` binding (`shift-enter`) will run the command in a terminal.
Same as the **run** launches, but the list is created from the installed
desktop files. It automatically launches them in a terminal if specified in the
Desktop File.
When pressing the `mode-complete` binding (`Control-l`), you can use the File Browser mode to launch the application
passing a file as argument if specified in the desktop file.
- Pressing the `delete-entry` binding (`shift-delete`) will remove this entry
from the run history.
- Pressing the `accept-custom` binding (`control-enter`) will run the command
as entered in the entry box.
- Pressing the `accept-alt` binding (`shift-enter`) will run the command in a
terminal.
When pressing the `mode-complete` binding (`Control-l`), you can use the File
Browser mode to launch the application passing a file as argument if specified
in the desktop file.
The DRUN mode tries to follow the [XDG Desktop Entry
Specification](https://freedesktop.org/wiki/Specifications/desktop-entry-spec/) and should be compatible with
applications using this standard. Some applications create invalid desktop files, **rofi** will discard these entries.
See the debugging section for more info on DRUN mode, this will print why desktop files are
discarded.
Specification](https://freedesktop.org/wiki/Specifications/desktop-entry-spec/)
and should be compatible with applications using this standard. Some
applications create invalid desktop files, **rofi** will discard these entries.
See the debugging section for more info on DRUN mode, this will print why
desktop files are discarded.
There are two advanced options to tweak the behaviour:
@ -901,12 +973,10 @@ configuration {
}
}
```
### ssh
Shows a list of SSH targets based on your `ssh` config file, and allows to quickly `ssh` into them.
Shows a list of SSH targets based on your `ssh` config file, and allows to
quickly `ssh` into them.
### keys
@ -914,11 +984,13 @@ Shows a searchable list of key bindings.
### script
Allows custom scripted Modes to be added, see the **rofi-script(5)** manpage for more information.
Allows custom scripted Modes to be added, see the **rofi-script(5)** manpage
for more information.
### combi
Combines multiple modes in one list. Specify which modes are included with the `-combi-modes` option.
Combines multiple modes in one list. Specify which modes are included with the
`-combi-modes` option.
When using the combi mode, a *!bang* can be used to filter the results by modes.
All modes that match the bang as a prefix are included.
@ -930,31 +1002,35 @@ If no match, the input is handled by the first combined modes.
## FAQ
### The text in the window switcher is not nicely aligned.
### The text in the window switcher is not nicely aligned
Try using a mono-space font or tabs + the tab-stops setting..
### The window is completely black.
### The window is completely black
Check quotes used on the command-line: you might have used `“` ("smart quotes") instead of `"` ("machine quotes").
Check quotes used on the command-line: you might have used `“` ("smart quotes")
instead of `"` ("machine quotes").
### What does the icon in the top right show?
The indicator shows:
` ` Case insensitive and no sorting.
`-` Case sensitivity enabled, no sorting.
`+` Case insensitive and Sorting enabled
`±` Sorting and Case sensitivity enabled"
- ` ` Case insensitive and no sorting.
- `-` Case sensitivity enabled, no sorting.
- `+` Case insensitive and Sorting enabled
- `±` Sorting and Case sensitivity enabled"
### Why do I see different icons for run,drun and window mode
Each of these modes uses different methods of resolving the icon:
* Window: It first uses the icon that the application exposes via the X11
Server, if none is set it does a lookup of the window Class name in the icon theme.
* drun: It uses the icon set in the desktop file.
* run: It does a lookup using the executable name.
- Window: It first uses the icon that the application exposes via the X11
Server, if none is set it does a lookup of the window Class name in the icon
theme.
- drun: It uses the icon set in the desktop file.
- run: It does a lookup using the executable name.
## EXAMPLES
@ -962,43 +1038,61 @@ Some basic usage examples of **rofi**:
Show the run dialog:
```bash
rofi -modes run -show run
```
Show the run dialog, and allow switching to Desktop File run dialog (`drun`):
```bash
rofi -modes run,drun -show run
```
Combine the run and Desktop File run dialog (`drun`):
```bash
rofi -modes combi -show combi -combi-modes run,drun
```
Combine the run and Desktop File run dialog (`drun`), and allow switching to window switcher:
Combine the run and Desktop File run dialog (`drun`), and allow switching to
window switcher:
```bash
rofi -modes combi,window -show combi -combi-modes run,drun
```
Pop up a text message claiming that this is the end:
```bash
rofi -e "This is the end"
```
Pop up a text message in red, bold font claiming that this is still the end:
```bash
rofi -e "<span color='red'><b>This is still the end</b></span>" -markup
```
Show all key bindings:
```bash
rofi -show keys
```
## i3
In [i3](http://i3wm.org/) you want to bind **rofi** to be launched on key release. Otherwise, it cannot grab the keyboard.
See also the i3 [manual](http://i3wm.org/docs/userguide.html):
In [i3](http://i3wm.org/) you want to bind **rofi** to be launched on key
release. Otherwise, it cannot grab the keyboard. See also the i3
[manual](http://i3wm.org/docs/userguide.html):
Some tools (such as `import` or `xdotool`) might be unable to run upon a KeyPress event, because the keyboard/pointer is
still grabbed. For these situations, the `--release` flag can be used, as it will execute the command after the keys have
been released.
Some tools (such as `import` or `xdotool`) might be unable to run upon a
KeyPress event, because the keyboard/pointer is still grabbed. For these
situations, the `--release` flag can be used, as it will execute the command
after the keys have been released.
## LICENSE
```text
MIT/X11
Permission is hereby granted, free of charge, to any person obtaining
@ -1019,6 +1113,7 @@ been released.
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
```
## WEBSITE
@ -1028,8 +1123,8 @@ been released.
**rofi** support can be obtained:
* [GitHub Discussions](https://github.com/davatorium/rofi/discussions)
* [IRC](irc://irc.libera.chat:6697/#rofi) (#rofi on irc.libera.chat),
- [GitHub Discussions](https://github.com/davatorium/rofi/discussions)
- [IRC](irc://irc.libera.chat:6697/#rofi) (#rofi on irc.libera.chat),
## DEBUGGING
@ -1044,13 +1139,15 @@ first.
## SEE ALSO
**rofi-sensible-terminal(1)**, **dmenu(1)**, **rofi-debugging(5)**, **rofi-theme(5)**, **rofi-script(5)**, **rofi-keys(5)**,**rofi-theme-selector(1)**,**rofi-dmenu(5)**
**rofi-sensible-terminal(1)**, **dmenu(1)**, **rofi-debugging(5)**,
**rofi-theme(5)**, **rofi-script(5)**,
**rofi-keys(5)**,**rofi-theme-selector(1)**,**rofi-dmenu(5)**
## AUTHOR
* Qball Cow <qball@blame.services>
* Rasmus Steinke <rasi@xssn.at>
* Morgane Glidic <sardemff7+rofi@sardemff7.net>
- Qball Cow <qball@blame.services>
- Rasmus Steinke <rasi@xssn.at>
- Morgane Glidic <sardemff7+rofi@sardemff7.net>
Original code based on work by: [Sean Pringle](https://github.com/seanpringle/simpleswitcher) <sean.pringle@gmail.com>