Rofi: A window switcher, application launcher and dmenu replacement
Go to file
Dave Davenport 7824b1c84e
Update README.md
Remove outdated information from README and point to manpage. Add platforms it is known to work on.
2021-04-22 11:10:28 +02:00
.github Update config.yml 2021-03-03 21:42:05 +01:00
Examples [Script] Add 'info' row option, that gets passed to ROFI_INFO environment. 2020-05-24 19:10:49 +02:00
config Add 'steal-focus' option instead of 'restore-focus' option. 2021-04-13 11:35:34 +02:00
data Add png version of logo. 2016-10-31 21:40:46 +01:00
doc Added -hover-select option that automatically selects the entry under the cursor (#1234) 2021-04-13 11:45:20 +02:00
include [hover-select] Change option to gboolean. 2021-04-13 11:49:42 +02:00
lexer [Lexer] Fix parsing string in dict not to match " in middle of string. 2020-10-02 19:15:19 +02:00
m4 Add lex version check. 2017-04-04 18:59:35 +02:00
pkgconfig Make -plugin-path commandline flag be read before loading plugins 2017-10-16 18:25:16 +02:00
releasenotes Update release notes 2020-11-22 18:04:51 +01:00
resources First testing to use GResource to load default theme. 2017-10-31 18:00:24 +01:00
script [ThemeSelector] Use rasi config file format, not xresources. 2020-06-17 13:53:18 +02:00
source Added -hover-select option that automatically selects the entry under the cursor (#1234) 2021-04-13 11:45:20 +02:00
subprojects submodules: Update libgwater 2021-01-20 15:32:29 +01:00
test [Test] fix theme parser test for latest change in grammar parser 2020-09-13 17:48:39 +02:00
themes Small fixes to docu theme 2021-02-14 13:31:47 +01:00
.gitignore Add support for additional field on script entries `meta` (#1052) 2020-02-01 13:49:11 +01:00
.gitlab-ci.yml Add texinfo. 2017-09-24 20:47:44 +02:00
.gitmodules changed ligbwater's url from git to https 2017-12-04 19:51:15 +01:00
.travis.yml [Travis] Add coverage for meson build 2020-05-14 12:44:59 +02:00
AUTHORS Update authors list. 2017-09-26 17:08:42 +02:00
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md (#608) 2017-06-17 13:20:34 +02:00
COPYING Update copyright dates. 2020-01-01 12:23:12 +01:00
Changelog Add ChangeLog and start working on release notes. 2020-11-22 11:30:59 +01:00
INSTALL.md Modifying installation on Fedora (#1257) 2021-01-21 15:13:50 +01:00
Makefile.am Small fixes to docu theme 2021-02-14 13:31:47 +01:00
README.md Update README.md 2021-04-22 11:10:28 +02:00
configure.ac configure.ac: Remove argument from AC_PROG_LEX (#1250) 2021-01-04 22:56:40 +01:00
libgwater-xcb-nolibtool.mk gitmodules: Move to subprojects/ 2017-05-04 21:50:07 +02:00
meson.build [Meson] Based on feedback from SardemFF7 set -lm requirement optional. 2021-02-18 10:41:46 +01:00
meson_options.txt [Timings] Move into new debug system. (#961) 2019-05-11 20:57:18 +02:00

README.md

Codacy Badge Build Status codecov.io Issues Forks Stars Downloads Coverity Forum Packages

A window switcher, Application launcher and dmenu replacement

Rofi started as a clone of simpleswitcher, written by Sean Pringle - a popup window switcher roughly based on superswitcher. Simpleswitcher laid the foundations, and therefore Sean Pringle deserves most of the credit for this tool. Rofi (renamed, as it lost the simple property) has been extended with extra features, like an application launcher and ssh-launcher, and can act as a drop-in dmenu replacement, making it a very versatile tool.

Rofi, like dmenu, will provide the user with a textual list of options where one or more can be selected. This can either be running an application, selecting a window, or options provided by an external script.

Its main features are:

  • Fully configurable keyboard navigation
  • Type to filter
    • Tokenized: type any word in any order to filter
    • Case insensitive (togglable)
    • Support for fuzzy-, regex-, and glob matching
  • UTF-8 enabled
    • UTF-8-aware string collating
    • International keyboard support (`e -> è)
  • RTL language support
  • Cairo drawing and Pango font rendering
  • Built-in modes:
    • Window switcher mode
      • EWMH compatible WM
    • Application launcher
    • Desktop file application launcher
    • SSH launcher mode
    • Combi mode, allowing several modes to be merged into one list
  • History-based ordering — last 25 choices are ordered on top based on use (optional)
  • Levenshtein distance ordering of matches (optional)
  • Drop-in dmenu replacement
    • Many added improvements
  • Easily extensible using scripts
  • Theming

Rofi has several built-in modi implementing common use cases and can be extended by scripts (either called from Rofi or calling Rofi).

Below is a list of the different modi:

  • run: launch applications from $PATH, with option to launch in terminal.
  • drun: launch applications based on desktop files. It tries to be compliant to the XDG standard.
  • window: Switch between windows on an EWMH compatible window manager.
  • ssh: Connect to a remote host via ssh.
  • file-browser: A basic file-browser for opening files.
  • keys: list internal keybindings.
  • script: Write (limited) custom mode using simple scripts.
  • combi: Combine multiple modi into one.

Rofi is known to work on Linux and BSD.

Manpage

For more up to date information, please see the manpage, the wiki, or the forum.

Installation

Please see the installation guide for instructions on how to install Rofi.

What is rofi not?

Rofi is not:

  • A preview application. In other words, it will not show a (small) preview of images, movies or other files.
  • A UI toolkit.
  • A library to be used in other applications.
  • An application that can support every possible use-case. It tries to be generic enough to be usable by everybody. Specific functionality can be added using scripts.
  • Just a dmenu replacement. The dmenu functionality is a nice 'extra' to rofi, not its main purpose.