1ROFI(1) General Commands Manual ROFI(1)
2
6 rofi - A window switcher, application launcher, ssh dialog, dmenu re‐
7 placement and more
8
11 rofi [ -show mode ]|[ -dmenu ]|[ -e msg ] [ CONFIGURATION ]
12
15 rofi is an X11 pop-up window switcher, run dialog, dmenu replacement,
16 and more. It focuses on being fast to use and have minimal distraction.
17 It supports keyboard and mouse navigation, type to filter, tokenized
18 search and more.
19
22 rofi's main functionality is to assist in your workflow, allowing you
23 to quickly switch between windows, start applications or log into a re‐
24 mote machine via ssh. There are different modi for different types of
25 actions.
26 rofi can also function as (drop-in) replacement for dmenu(1).
29 Running rofi
32 To launch rofi directly in a certain mode, specify a mode with rofi
33 -show <mode>. To show the run dialog:
34 rofi -show run
37 Emulating dmenu
41 rofi can emulate dmenu(1) (a dynamic menu for X11) when launched with
42 the -dmenu flag.
43 The website for dmenu can be found here ⟨http://tools.suck‐
46 less.org/dmenu/⟩.
47 rofi does not aim to be 100% compatible with dmenu. There are simply
50 too many flavors of dmenu. The idea is that the basic usage com‐
51 mand-line flags are obeyed, theme-related flags are not. Besides, rofi
52 offers some extended features (like multi-select, highlighting, message
53 bar, extra key bindings).
54 Display Error message
57 rofi error dialog can also be called from the command line.
58 rofi -e "my message"
61 Markup support can be enabled, see CONFIGURATION options.
65
68 There are currently three methods of setting configuration options
69 (evaluated in order below):
70 • System configuration file (for example /etc/rofi.rasi). It
73 first checks XDG_CONFIG_DIRS, and then SYSCONFDIR (that is
74 passed at compile time). It loads the first config file it
75 finds, it does not merge multiple system configuration files.
76 • Rasi theme file: The new theme format can be used to set con‐
78 figuration values.
79 • Command-line options: Arguments passed to rofi.
81 To get a template config file, run: rofi -dump-config > config.rasi
85 This will contain (commented) all current configuration options, modi‐
88 fied options are uncommented.
89 The configuration system supports the following types:
92 • string
95 • integer (signed and unsigned)
97 • char
99 • boolean
101 • lists
103 For the syntax of these options, see the rofi-theme(5) manpage.
107 For use on the command line, Boolean options have a non-default com‐
110 mand-line syntax. Example to enable option X:
111 -X
114 To disable option X:
118 -no-X
121 Below is a list of the most important options:
125 General
128 -help
129 The help option shows the full list of command-line options and the
132 current set values. These include dynamic (run-time generated) op‐
133 tions.
134 -version
137 Show the rofi version and exit.
140 -dump-config
143 Dump the current active configuration, in rasi format, to stdout and
146 exit. Information about the rasi format can be found in the
147 rofi-theme(5) manpage.
148 -dump-theme
151 Dump the current active theme, in rasi format, to stdout and exit.
154 -rasi-validate filename
157 Try to parse the file and return 0 when successful, non-zero when
160 failed.
161 -threads num
164 Specify the number of threads rofi should use:
167 • 0: Autodetect the number of supported hardware threads.
170 • 1: Disable threading
172 •
174 2..n: Specify the maximum number of threads to use in the thread
177 pool.
178 Default: Autodetect
180 -display display
184 The X server to contact. Default is $DISPLAY.
187 -dmenu
190 Run rofi in dmenu mode. This allows for interactive scripts. In dmenu
193 mode, rofi reads from STDIN, and output to STDOUT. A simple example,
194 displaying three pre-defined options:
195 echo -e "Option #1\nOption #2\nOption #3" | rofi -dmenu
198 Or get the options from a script:
202 /my_script.sh | rofi -dmenu
205 -show mode
209 Open rofi in a certain mode. Available modes are window, run, drun,
212 ssh, combi. The special argument keys can be used to open a searchable
213 list of supported key bindings (see KEY BINDINGS)
214 To show the run-dialog:
217 rofi -show run
220 If -show is the last option passed to rofi, the first enabled modi is
224 shown.
225 -modi mode1,mode2
228 Specify an ordered, comma-separated list of modes to enable. Enabled
231 modes can be changed at runtime. Default key is Ctrl+Tab. If no modes
232 are specified, all configured modes will be enabled. To only show the
233 run and ssh launcher:
234 rofi -modi "run,ssh" -show run
237 Custom modes can be added using the internal script mode. Each such
241 mode has two parameters:
242 <name>:<script>
245 Example: Have a mode called 'Workspaces' using the
249 i3_switch_workspaces.sh script:
250 rofi -modi "window,run,ssh,Workspaces:i3_switch_workspaces.sh" -show Workspaces
253 Notes: The i3 window manager dislikes commas in the command when speci‐
257 fying an exec command. For that case, # can be used as a separator.
258 TIP: The name is allowed to contain spaces:
261 rofi -modi "My File Browser:fb.sh" -show "My File Browser"
264 -case-sensitive
268 Start in case-sensitive mode. This option can be changed at run-time
271 using the -kb-toggle-case-sensitivity key binding.
272 -cycle
275 Cycle through the result list. Default is 'true'.
278 -filter filter
281 Filter the list by setting text in input bar to filter
284 -config filename
287 Load an alternative configuration file.
290 -cache-dir filename
293 Directory that is used to place temporary files, like history.
296 -scroll-method method
299 Select the scrolling method. 0: Per page, 1: continuous.
302 -normalize-match
305 Normalize the string before matching, so o will match ö, and é matches
308 e.
309 This is not a perfect implementation, but works. For now, it disables
310 highlighting of the matched part.
311 -no-lazy-grab
314 Disables lazy grab, this forces the keyboard being grabbed before gui
317 is shown.
318 -no-plugins
321 Disable plugin loading.
324 -plugin-path directory
327 Specify the directory where rofi should look for plugins.
330 -show-icons
333 Show application icons in drun and window modes.
336 -icon-theme
339 Specify icon theme to be used. If not specified default theme from DE
342 is used, Adwaita and gnome themes act as fallback themes.
343 -fallback-application-icon
346 Specify an icon to be used when the application icon in run/drun are
349 not yet loaded or is not available.
350 -markup
353 Use Pango markup to format output wherever possible.
356 -normal-window
359 Make rofi react like a normal application window. Useful for scripts
362 like Clerk that are basically an application.
363 -[no-]steal-focus
366 Make rofi steal focus on launch and restore close to window that held
369 it when launched.
370 Matching
373 -matching method
374 Specify the matching algorithm used. Currently, the following methods
377 are supported:
378 • normal: match the int string
381 • regex: match a regex input
383 • glob: match a glob pattern
385 • fuzzy: do a fuzzy match
387 • prefix: match prefix
389 Default: normal
393 Note: glob matching might be slow for larger lists
396 -tokenize
399 Tokenize the input.
402 -drun-categories category1,category2
405 Only show desktop files that are present in the listed categories.
408 -drun-match-fields field1,field2,...
411 When using drun, match only with the specified Desktop entry fields.
414 The different fields are:
415 • name: the application's name
418 • generic: the application's generic name
420 • exec: the application's executable
422 • categories: the application's categories
424 • comment: the application comment
426 •
428 all: all the above
431 Default: name,generic,exec,categories,keywords
433 -drun-display-format
437 The format string for the drun dialog:
440 • name: the application's name
443 • generic: the application's generic name
445 • exec: the application's executable
447 • categories: the application's categories
449 • comment: the application comment
451 Pango markup can be used to formatting the output.
455 Default: {name} [<span weight='light' size='small'><i>({generic})</i></span>]
458 Note: Only fields enabled in -drun-match-fields can be used in the for‐
462 mat string.
463 -[no-]drun-show-actions
466 Show actions present in the Desktop files.
469 Default: false
472 -window-match-fields field1,field2,...
476 When using window mode, match only with the specified fields. The dif‐
479 ferent fields are:
480 • title: window's title
483 • class: window's class
485 • role: window's role
487 • name: window's name
489 • desktop: window's current desktop
491 •
493 all: all the above
496 Default: all
498 -matching-negate-char char
502 Set the character used to negate the query (i.e. if it does not match
505 the next keyword). Set to '\x0' to disable.
506 Default: '-'
509 Layout and Theming
513 IMPORTANT:
514 In newer rofi releases, all the theming options have been moved into
515 the new theme format. They are no longer normal
516 rofi options that can be passed directly on the command line (there
517 are too many).
518 Small snippets can be passed on the command line: rofi -theme-str
519 'window {width: 50%;}' to override a single
520 setting. They are merged into the current theme.
521 They can also be appended at the end of the rofi config file to over‐
522 ride parts of the theme.
523 Most of the following options are deprecated and should not be used.
526 Please use the new theme format to customize rofi. More information
527 about the new format can be found in the rofi-theme(5) manpage.
528 -location
531 Specify where the window should be located. The numbers map to the fol‐
534 lowing locations on screen:
535 1 2 3
538 8 0 4
539 7 6 5
540 Default: 0
544 -fixed-num-lines
547 Keep a fixed number of visible lines (See the -lines option.)
550 -sidebar-mode
553 Open in sidebar-mode. In this mode, a list of all enabled modes is
556 shown at the bottom. (See -modi option) To show sidebar, use:
557 rofi -show run -sidebar-mode -lines 0
560 -hover-select
564 Automatically select the entry the mouse is hovering over. This option
567 is best combined with custom mouse bindings. To utilize hover-select
568 and accept an entry in a single click, use:
569 rofi -show run -hover-select -me-select-entry '' -me-accept-entry MousePrimary
572 -eh number
576 Set row height (in chars) Default: 1
579 -auto-select
582 When one entry is left, automatically select it.
585 -m num
588 -m name
591 -monitor num
594 -monitor name
597 Select monitor to display rofi on. It accepts as input: primary (if
600 primary output is set), the xrandr output name, or integer number (in
601 order of detection). Negative numbers are handled differently:
602 • -1: the currently focused monitor.
605 • -2: the currently focused window (that is, rofi will be dis‐
607 played on top of the focused window).
608 • -3: Position of mouse (overrides the location setting to get
610 normal context menu behavior.)
611 • -4: the monitor with the focused window.
613 •
615 -5: the monitor that shows the mouse pointer.
618 Default: -5
620 See rofi -h output for the detected monitors, their position, and size.
624 -theme filename
627 Path to the new theme file format. This overrides the old theme set‐
630 tings.
631 -theme-str string
634 Allow theme parts to be specified on the command line as an override.
637 For example:
640 rofi -theme-str '#window { fullscreen: true; }'
643 This option can be specified multiple times. This is now the method to
647 tweak the theme via the command line.
648 -dpi number
651 Override the default DPI setting.
654 • If set to 0, it tries to auto-detect based on X11 screen size
657 (similar to i3 and GTK).
658 • If set to 1, it tries to auto-detect based on the size of the
660 monitor that rofi is displayed on (similar to latest Qt 5).
661 -selected-row selected row
665 Select a certain row.
668 Default: 0
671 PATTERN setting
674 -terminal
675 Specify which terminal to start.
678 rofi -terminal xterm
681 Pattern: {terminal}
685 Default: x-terminal-emulator
688 -ssh-client client
691 Override the used ssh client.
694 Pattern: {ssh-client}
697 Default: ssh
700 SSH settings
703 -ssh-command cmd
704 Set the command to execute when starting an ssh session. The pattern
707 {host} is replaced by the selected ssh entry.
708 Pattern: {ssh-client}
711 Default: {terminal} -e {ssh-client} {host}
714 -parse-hosts
717 Parse the /etc/hosts file for entries.
720 Default: disabled
723 -parse-known-hosts -no-parse-known-hosts
726 Parse the /.ssh/known_hosts file for entries.
729 Default: enabled
732 Run settings
735 -run-command cmd
736 Set command ({cmd}) to execute when running an application. See PAT‐
739 TERN.
740 Default: {cmd}
743 -run-shell-command cmd
746 Set command to execute when running an application in a shell. See
749 PATTERN.
750 Default: {terminal} -e {cmd}
753 -run-list-command cmd
756 If set, use an external tool to generate a list of executable commands.
759 Uses run-command.
760 Default: {cmd}
763 Window switcher settings
766 -window-format format
767 Format what is being displayed for windows.
770 format: {field[:len]}
773 field:
776 • w: desktop name
779 • t: title of window
781 • n: name
783 • r: role
785 • c: class
787 len: maximum field length (0 for auto-size). If length and window width
791 are negative, field length is width - len.
792 If length is positive, the entry will be truncated or padded to fill
793 that length.
794 default: {w} {c} {t}
797 -window-command cmd
800 Set command to execute on selected window for an alt action (-kb-ac‐
803 cept-alt). See PATTERN.
804 Default: "wmctrl -i -R {window}"
807 -window-thumbnail
810 Show window thumbnail (if available) as icon in the window switcher.
813 You can stop rofi from exiting when closing a window (allowing multiple
816 to be closed in a row).
817 configuration {
820 window {
821 close-on-delete: false;
822 }
823 }
824 Combi settings
828 -combi-modi mode1,mode2
829 The modi to combine in combi mode. For syntax to -combi-modi, see
832 -modi. To get one merge view, of window,run, and ssh:
833 rofi -show combi -combi-modi "window,run,ssh" -modi combi
836 NOTE: The i3 window manager dislikes commas in the command when speci‐
840 fying an exec command. For that case, # can be used as a separator.
841 History and Sorting
844 -disable-history -no-disable-history (re-enable history)
845 Disable history
848 -sort to enable -no-sort to disable
851 Enable, disable sorting. This setting can be changed at runtime (see
854 -kb-toggle-sort).
855 -sorting-method 'method' to specify the sorting method.
858 There are 2 sorting methods:
861 • levenshtein (Default)
864 • fzf sorting.
866 -max-history-size number
870 Maximum number of entries to store in history. Defaults to 25. (WARN‐
873 ING: can cause slowdowns when set too high)
874 Dmenu specific
877 -sep separator
878 Separator for dmenu. Example: To show a list of 'a' to 'e' with '|' as
881 a separator:
882 echo "a|b|c|d|e" | rofi -sep '|' -dmenu
885 -p prompt
889 Specify the prompt to show in dmenu mode. For example, select 'monkey',
892 a,b,c,d, or e.
893 echo "a|b|c|d|e" | rofi -sep '|' -dmenu -p "monkey"
896 Default: dmenu
900 -l number of lines to show
903 Maximum number of lines the menu may show before scrolling.
906 rofi -lines 25
909 Default: 15
913 -i
916 Makes dmenu searches case-insensitive
919 -a X
922 Active row, mark X as active. Where X is a comma-separated list of
925 python(1)-style indices and ranges, e.g. indices start at 0, -1 refers
926 to the last row with -2 preceding it, ranges are left-open and
927 right-close, and so on. You can specify:
928 • A single row: '5'
931 • A range of (last 3) rows: '-3:'
933 • 4 rows starting from row 7: '7:11' (or in legacy notation:
935 '7-10')
936 • A set of rows: '2,0,-9'
938 • Or any combination: '5,-3:,7:11,2,0,-9'
940 -u X
944 Urgent row, mark X as urgent. See -a option for details.
947 -only-match
950 Only return a selected item, do not allow custom entry. This mode al‐
953 ways returns an entry. It will not return if no matching entry is se‐
954 lected.
955 -no-custom
958 Only return a selected item, do not allow custom entry. This mode re‐
961 turns directly when no entries given.
962 -format format
965 Allows the output of dmenu to be customized (N is the total number of
968 input entries):
969 • 's' selected string
972 • 'i' index (0 - (N-1))
974 • 'd' index (1 - N)
976 • 'q' quote string
978 • 'p' Selected string stripped from Pango markup (Needs to be a
980 valid string)
981 • 'f' filter string (user input)
983 • 'F' quoted filter string (user input)
985 Default: 's'
989 -select string
992 Select first line that matches the given string
995 -mesg string
998 Add a message line below the filter entry box. Supports Pango markup.
1001 For more information on supported markup, see here ⟨https://devel‐
1002 oper.gnome.org/pygtk/stable/pango-markup-language.html⟩
1003 -dump
1006 Dump the filtered list to stdout and quit. This can be used to get the
1009 list as rofi would filter it. Use together with -filter command.
1010 -input file
1013 Reads from file instead of stdin.
1016 -password
1019 Hide the input text. This should not be considered secure!
1022 -markup-rows
1025 Tell rofi that DMenu input is Pango markup encoded, and should be ren‐
1028 dered. See here ⟨https://developer.gnome.org/pygtk/stable/pango-
1029 markup-language.html⟩ for details about Pango markup.
1030 -multi-select
1033 Allow multiple lines to be selected. Adds a small selection indicator
1036 to the left of each entry.
1037 -sync
1040 Force rofi mode to first read all data from stdin before showing the
1043 selection window. This is original dmenu behavior.
1044 Note: the default asynchronous mode will also be automatically disabled
1047 if used with conflicting options, such as -dump, -only-match or
1048 -auto-select.
1049 -async-pre-read number
1052 Reads the first number entries blocking, then switches to async mode.
1055 This makes it feel more 'snappy'.
1056 default: 25
1059 -window-title title
1062 Set name used for the window title. Will be shown as Rofi - title
1065 -w windowid
1068 Position rofi over the window with the given X11 window ID.
1071 -keep-right
1074 Set ellipsize mode to start. So, the end of the string is visible.
1077 Message dialog
1080 -e message
1081 Pops up a message dialog (used internally for showing errors) with mes‐
1084 sage. Message can be multi-line.
1085 File browser settings
1088 File browser behavior can be controlled via the following options:
1089 configuration {
1092 filebrowser {
1093 /** Directory the file browser starts in. */
1094 directory: "/some/directory";
1095 /**
1096 * Sorting method. Can be set to:
1097 * - "name"
1098 * - "mtime" (modification time)
1099 * - "atime" (access time)
1100 * - "ctime" (change time)
1101 */
1102 sorting-method: "name";
1103 /** Group directories before files. */
1104 directories-first: true;
1105 }
1106 }
1107 Other
1111 -drun-use-desktop-cache
1112 Build and use a cache with the content of desktop files. Usable for
1115 systems with slow hard drives.
1116 -drun-reload-desktop-cache
1119 If drun-use-desktop-cache is enabled, rebuild a cache with the content
1122 of desktop files.
1123 -drun-url-launcher command
1126 Command to open a Desktop Entry that is a Link.
1129 -pid path
1132 Make rofi create a pid file and check this on startup. The pid file
1135 prevents multiple rofi instances from running simultaneously. This is
1136 useful when running rofi from a key-binding daemon.
1137 -display-{mode} string
1140 Set the name to use for mode. This is used as prompt and in
1143 combi-browser.
1144 It is now preferred to use the configuration file:
1147 configuration {
1150 {mode} {
1151 display-name: *string*;
1152 }
1153 }
1154 -click-to-exit -no-click-to-exit
1158 Click the mouse outside the rofi window to exit.
1161 Default: enabled
1164
1167 To launch commands (for example, when using the ssh launcher), the user
1168 can enter the used command-line. The following keys can be used that
1169 will be replaced at runtime:
1170 • {host}: the host to connect to
1173 • {terminal}: the configured terminal (see -terminal-emulator)
1175 • {ssh-client}: the configured ssh client (see -ssh-client)
1177 • {cmd}: the command to execute
1179 • {window}: the window ID of the selected window (in window-com‐
1181 mand)
1182
1186 If argv[0] (calling command) is dmenu, rofi will start in dmenu mode.
1187 This way, it can be used as a drop-in replacement for dmenu. Just copy
1188 or symlink rofi to dmenu in $PATH.
1189 ln -s /usr/bin/rofi /usr/bin/dmenu
1192
1196 Please see rofi-theme(5) manpage for more information on theming.
1197
1200 rofi has the following key bindings:
1201 • Control-v, Insert: Paste from clipboard
1204 • Control-Shift-v, Shift-Insert: Paste primary selection
1206 • Control-u: Clear the line
1208 • Control-a: Beginning of line
1210 • Control-e: End of line
1212 • Control-f, Right: Forward one character
1214 • Alt-f, Control-Right: Forward one word
1216 • Control-b, Left: Back one character
1218 • Alt-b, Control-Left: Back one word
1220 • Control-d, Delete: Delete character
1222 • Control-Alt-d: Delete word
1224 • Control-h, Backspace, Shift-Backspace: Backspace (delete pre‐
1226 vious character)
1227 • Control-Alt-h: Delete previous word
1229 • Control-j,Control-m,Enter: Accept entry
1231 • Control-n,Down: Select next entry
1233 • Control-p,Up: Select previous entry
1235 • Page Up: Go to previous page
1237 • Page Down: Go to next page
1239 • Control-Page Up: Go to previous column
1241 • Control-Page Down: Go to next column
1243 • Control-Enter: Use entered text as a command (in ssh/run modi)
1245 • Shift-Enter: Launch the application in a terminal (in run
1247 mode)
1248 • Control-Shift-Enter: As Control-Enter and run the command in
1250 terminal (in run mode)
1251 • Shift-Enter: Return the selected entry and move to the next
1253 item while keeping rofi open. (in dmenu)
1254 • Shift-Right: Switch to the next mode. The list can be custom‐
1256 ized with the -modi argument.
1257 • Shift-Left: Switch to the previous mode. The list can be cus‐
1259 tomized with the -modi argument.
1260 • Control-Tab: Switch to the next mode. The list can be custom‐
1262 ized with the -modi argument.
1263 • Control-Shift-Tab: Switch to the previous mode. The list can
1265 be customized with the -modi argument.
1266 • Control-space: Set selected item as input text.
1268 • Shift-Del: Delete entry from history.
1270 • grave: Toggle case sensitivity.
1272 • Alt-grave: Toggle sorting.
1274 • Alt-Shift-S: Take a screenshot and store it in the Pictures
1276 directory.
1277 • Control-l: File complete for run dialog.
1279 This list might not be complete, to get a full list of all key bindings
1283 supported in your rofi, see rofi -h. The options starting with -kb are
1284 keybindings.
1285 Key bindings can be modified using the configuration systems. Multiple
1288 keys can be bound to one action by comma separating them. For example
1289 -kb-primary-paste "Conctrol+v,Insert"
1290 To get a searchable list of key bindings, run rofi -show keys.
1293 A key binding starting with ! will act when all keys have been re‐
1296 leased.
1297
1300 window
1301 Show a list of all the windows and allow switching between them.
1302 Pressing the delete-entry binding (shift-delete) will close the window.
1303 Pressing the accept-custom binding (control-enter or shift-enter) will
1304 run a command on the window. (See option window-command );
1305 If there is no match, it will try to launch the input.
1308 windowcd
1311 Shows a list of the windows on the current desktop and allows switching
1312 between them. Pressing the delete-entry binding (shift-delete) will
1313 kill the window. Pressing the accept-custom binding (control-enter or
1314 shift-enter) will run a command on the window. (See option window-com‐
1315 mand );
1316 If there is no match, it will try to launch the input.
1319 run
1322 Shows a list of executables in $PATH and can launch them (optional in a
1323 terminal). Pressing the delete-entry binding (shift-delete) will re‐
1324 move this entry from the run history. Pressing the accept-custom bind‐
1325 ing (control-enter) will run the command as entered in the entry box.
1326 Pressing the accept-alt binding (shift-enter) will run the command in a
1327 terminal.
1328 When pressing the mode-complete binding (Control-l), you can use the
1331 File Browser mode to launch the application with a file as the first
1332 argument.
1333 drun
1336 Same as the run launches, but the list is created from the installed
1337 desktop files. It automatically launches them in a terminal if speci‐
1338 fied in the Desktop File. Pressing the delete-entry binding
1339 (shift-delete) will remove this entry from the run history. Pressing
1340 the accept-custom binding (control-enter) will run the command as en‐
1341 tered in the entry box. Pressing the accept-alt binding (shift-enter)
1342 will run the command in a terminal.
1343 When pressing the mode-complete binding (Control-l), you can use the
1346 File Browser mode to launch the application passing a file as argument
1347 if specified in the desktop file.
1348 The DRUN mode tries to follow the XDG Desktop Entry Specification
1351 ⟨https://freedesktop.org/wiki/Specifications/desktop-entry-spec/⟩ and
1352 should be compatible with applications using this standard. Some ap‐
1353 plications create invalid desktop files, rofi will discard these en‐
1354 tries. See the debugging section for more info on DRUN mode, this will
1355 print why desktop files are discarded.
1356 There are two advanced options to tweak the behaviour:
1359 configuration {
1362 drun {
1363 /** Parse user desktop files. */
1364 parse-user: true;
1365 /** Parse system desktop files. */
1366 parse-system: false;
1367 }
1368 }
1369 ssh
1373 Shows a list of SSH targets based on your ssh config file, and allows
1374 to quickly ssh into them.
1375 keys
1378 Shows a searchable list of key bindings.
1379 script
1382 Allows custom scripted Modi to be added, see the rofi-script(5) manpage
1383 for more information.
1384 combi
1387 Combines multiple modi in one list. Specify which modi are included
1388 with the -combi-modi option.
1389 When using the combi mode, a !bang can be used to filter the results by
1392 modi. All modi that match the bang as a prefix are included. For ex‐
1393 ample, say you have specified -combi-modi run,window,windowcd. If your
1394 query begins with the bang !w, only results from the window and win‐
1395 dowcd modi are shown, even if the rest of the input text would match
1396 results from run.
1397 If no match, the input is handled by the first combined modi.
1400
1403 The text in the window switcher is not nicely aligned.
1404 Try using a mono-space font.
1405 The window is completely black.
1408 Check quotes used on the command-line: you might have used “ ("smart
1409 quotes") instead of " ("machine quotes").
1410 What does the icon in the top right show?
1413 The indicator shows:
1414 ` ` Case insensitive and no sorting.
1417 `-` Case sensitivity enabled, no sorting.
1418 `+` Case insensitive and Sorting enabled
1419 `±` Sorting and Case sensitivity enabled"
1420
1424 Some basic usage examples of rofi:
1425 Show the run dialog:
1428 rofi -modi run -show run
1431 Show the run dialog, and allow switching to Desktop File run dialog
1435 (drun):
1436 rofi -modi run,drun -show run
1439 Combine the run and Desktop File run dialog (drun):
1443 rofi -modi combi -show combi -combi-modi run,drun
1446 Combine the run and Desktop File run dialog (drun), and allow switching
1450 to window switcher:
1451 rofi -modi combi,window -show combi -combi-modi run,drun
1454 Pop up a text message claiming that this is the end:
1458 rofi -e "This is the end"
1461 Pop up a text message in red, bold font claiming that this is still the
1465 end:
1466 rofi -e "<span color='red'><b>This is still the end</b></span>" -markup
1469 Show all key bindings:
1473 rofi -show keys
1476 Use qalc to get a simple calculator in rofi:
1480 rofi -show calc -modi "calc:qalc +u8 -nocurrencies"
1483
1487 In i3 ⟨http://i3wm.org/⟩ you want to bind rofi to be launched on key
1488 release. Otherwise, it cannot grab the keyboard. See also the i3 man‐
1489 ual ⟨http://i3wm.org/docs/userguide.html⟩:
1490 Some tools (such as import or xdotool) might be unable to run upon a
1493 KeyPress event, because the keyboard/pointer is still grabbed. For
1494 these situations, the --release flag can be used, as it will execute
1495 the command after the keys have been released.
1496
1499 MIT/X11
1500 Permission is hereby granted, free of charge, to any person obtaining
1502 a copy of this software and associated documentation files (the
1503 "Software"), to deal in the Software without restriction, including
1504 without limitation the rights to use, copy, modify, merge, publish,
1505 distribute, sublicense, and/or sell copies of the Software, and to
1506 permit persons to whom the Software is furnished to do so, subject to
1507 the following conditions:
1508 The above copyright notice and this permission notice shall be
1510 included in all copies or substantial portions of the Software.
1511 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
1513 OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
1514 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
1515 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
1516 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
1517 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
1518 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
1519
1523 rofi website can be found here ⟨https://davedavenport.github.io/rofi/⟩
1524
1527 rofi support can be obtained:
1528 * GitHub Discussions ⟨https://github.com/davatorium/rofi/discussions⟩
1529 * Forum (Reddit) ⟨https://reddit.com/r/qtools//⟩
1530 * IRC ⟨irc://irc.libera.chat:6697/#rofi⟩ (#rofi on irc.libera.chat),
1531
1534 To debug, it is smart to first try disabling your custom configuration:
1535 -no-config
1536 Disable parsing of configuration. This runs rofi in stock mode.
1539 If you run custom C plugins, you can disable them using:
1542 -no-plugins
1545 Disables the loading of plugins.
1548 To further debug the plugin, you can get a trace with (lots of) debug
1551 information. This debug output can be enabled for multiple parts in
1552 rofi using the glib debug framework. Debug domains can be enabled by
1553 setting the G_MESSAGES_DEBUG environment variable. At the time of cre‐
1554 ation of this page, the following debug domains exist:
1555 • all: Show debug information from all domains.
1558 • X11Helper: The X11 Helper functions.
1560 • View: The main window view functions.
1562 • Widgets.Box: The Box widget.
1564 • Dialogs.DMenu: The dmenu mode.
1566 • Dialogs.Run: The run mode.
1568 • Dialogs.DRun: The desktop file run mode.
1570 • Dialogs.Window: The window mode.
1572 • Dialogs.Script: The script mode.
1574 • Dialogs.Combi: The script mode.
1576 • Dialogs.Ssh: The ssh mode.
1578 • Rofi: The main application.
1580 • Timings: Get timing output.
1582 • Theme: Theme engine debug output. (warning lots of output).
1584 • Widgets.Icon: The Icon widget.
1586 • Widgets.Box: The box widget.
1588 • Widgets.Container: The container widget.
1590 • Widgets.Window: The window widget.
1592 • Helpers.IconFetcher: Information about icon lookup.
1594 The output of this can provide useful information when writing an is‐
1598 sue.
1599 More information (possibly outdated) see this ⟨https://github.com/Dave‐
1602 Davenport/rofi/wiki/Debugging%20Rofi⟩ wiki entry.
1603
1606 The rofi issue tracker can be found here ⟨https://github.com/DaveDaven‐
1607 port/rofi/issues⟩
1608 When creating an issue, please read this ⟨https://github.com/DaveDaven‐
1611 port/rofi/blob/master/.github/CONTRIBUTING.md⟩ first.
1612
1615 rofi-sensible-terminal(1), dmenu(1), rofi-theme(5), rofi-script(5),
1616 rofi-theme-selector(1)
1617
1620 • Qball Cow ⟨qball@blame.services⟩
1621 • Rasmus Steinke ⟨rasi@xssn.at⟩
1623 • Quentin Glidic ⟨sardemff7+rofi@sardemff7.net⟩
1625 Original code based on work by: Sean Pringle ⟨https://github.com/sean‐
1629 pringle/simpleswitcher⟩ ⟨sean.pringle@gmail.com⟩
1630 For a full list of authors, check the AUTHORS file.
1633 rofi ROFI(1)