Mirrors/rofi
2
0
Fork 0
mirror of https://github.com/lbonn/rofi synced 2024-11-23 04:13:03 +00:00
Code Issues Projects Releases Packages Wiki Activity
rofi/README.md

5.9 KiB
Raw Blame History

Issues Forks Stars Downloads Packages

A window switcher, Application launcher and dmenu replacement

This is a fork of Rofi with added support for Wayland via the layer shell protocol. For more information, see the Wayland support section

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 or fzf like sorting of matches (optional)
  • Drop-in dmenu replacement
    • Many added improvements
  • Easily extensible using scripts and plugins
  • Advanced Theming

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

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.

Wayland support

Wayland support is enabled by default in this fork, along with X11/xcb. You can build rofi without XCB, if you like:

meson build -Dxcb=disabled

The rest of the installation process is unchanged (see Installation).

Rofi can be invoked with the same CLI and configuration and can be forced to use X11 mode with the x11 flag (unless the X11 backend was disabled in build):

rofi -x11 ...

This port to layer shell is not yet in a stable state, so expect to encounter some rough edges. That said, the core of Rofi's functionalities is present.

Notable omissions:

  • native window mode when running under Wayland. Recommended solution: https://github.com/lbonn/i3-focus-last#menu-mode or https://sr.ht/~tsdh/swayr/
  • -normal-window flag in Wayland mode. Upstream rofi considers it a toy/deprecated feature AFAIK
  • selecting which monitor to run rofi on in Wayland mode, rofi only shows up on the currently focused monitor
  • some window locations parameters work partially, x-offset and y-offset are only working from screen edges
  • some X11-specific options like -dpi or fake transparency

If you find something does not work and is not listed here, please open a PR.

I do not intend to make releases from this fork at the moment, but will simply try to keep it regularly in sync with the develop branch upstream.

Screenshots

screenshot screenshot2 default

Manpage

For more up to date information, please see the manpages:

Installation

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

What is rofi not?

Rofi is not:

  • 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 or plugins, many exists.
  • Just a dmenu replacement. The dmenu functionality is a nice 'extra' to rofi, not its main purpose.