Giter Club home page Giter Club logo

rofi's Introduction

Rofi

A window switcher, Application launcher and dmenu replacement.

vid-2021-10-29-165650.mp4

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.

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.

Table of Contents

Features

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

Modi

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

Build

Please follow the meson build instructions to build this fork, as autotools builds are not yet supported.

Wayland support is enabled by default in this fork, along with X11/xcb.

rofi can also be built without XCB:

meson build -Dxcb=disabled

Usage

Rofi options an configurations are compatible with this fork. It should automatically select the xcb or wayland backend depending on the environment it is run on.

To force the use of the xcb backend (if enabled during build), the -x11 option can be used:

rofi -x11 ...

Differences with rofi (in wayland mode)

  • native window selection 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. Though it is also considered as a toy/deprecated feature in Upstream rofi
  • 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

Manpage

For more up to date information, please see the manpages. The other sections and links might have outdated information as they have relatively less maintainance than the manpages. So, if you come across any issues please consult manpages, discussion and issue traker before filing new issue.

Installation

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

Quickstart

Usage

This section just gives a brief overview of the various options. To get the full set of options see the manpages section above

Running rofi

To launch rofi directly in a certain mode, specify a mode with rofi -show <mode>. To show the run dialog:

rofi -show run

Or get the options from a script:

~/my_script.sh | rofi -dmenu

Specify an ordered, comma-separated list of modes to enable. 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:

rofi -modi "run,ssh" -show run

The modi to combine in combi mode. For syntax to -combi-modi, see -modi. To get one merge view, of window,run, and ssh:

rofi -show combi -combi-modi "window,run,ssh" -modi combi

Configuration

Generate a default configuration file

mkdir -p ~/.config/rofi
rofi -dump-config > ~/.config/rofi/config.rasi

This creates a file called config.rasi in the ~/.config/rofi/ folder. You can modify this file to set configuration settings and modify themes. config.rasi is the file rofi looks to by default.

Please see the configuration guide for a summary of configuration options. More detailed options are provided in the manpages.

Themes

Please see the themes manpages for a detailed description.

The latest bundled themes can be found here.

Screenshots

Rezlooks:

screenshot

Arthur:

screenshot2

Default theme:

default

Wiki

❗ **The Wiki is currently unmaintained and might contain outdated data **

Go to wiki .

Contents

Discussion places:

The GitHub Discussions is the preferred location for discussions.

Stargazers over time

Stargazers over time

rofi's People

Contributors

davedavenport avatar sardemff7 avatar lbonn avatar carnager avatar seanpringle avatar jirutka avatar martijnktue avatar nick87720z avatar toncherami avatar larkery avatar shade-of-noon avatar dannycolin avatar jpleau avatar tblue avatar blueyed avatar jasperla avatar semka95 avatar jubalh avatar gbitzes avatar vimeitor avatar refacto avatar a1346054 avatar t-wissmann avatar ashyisme avatar ianremmler avatar johnbeard avatar seletskiy avatar patricol avatar fdmarcin avatar unisgn avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.