Skip to content

Latest commit

 

History

History
84 lines (55 loc) · 3.9 KB

README.md

File metadata and controls

84 lines (55 loc) · 3.9 KB
Raw

i3status-rust

demo1

i3status-rs is a feature-rich and resource-friendly replacement for i3status, written in pure Rust. It provides a way to display "blocks" of system information (time, battery status, volume, etc) on the i3 bar. It is also compatible with sway.

For a list of available blocks, see the block documentation. Further information can be found on the Wiki.

Requirements

The Rust language and the cargo package manager are required to build the binary.

We also require Libdbus 1.6 or higher. On some older systems this may require installing libdbus-1-dev. See #194 if you are having dbus-related compilation issues.

Compilation is only tested with very recent stable versions of rustc. If you use a distro with older Rust packages, consider using rustup to install a newer toolchain.

Most blocks assume you are running Linux, and some have their own system requirements; these are mentioned in the block documentation.

Optional:

  • Font Awesome 4.x is required when using the icons config name = "awesome". For version 5, use name = "awesome5". On Arch Linux version 4 is available in the AUR, and version 5 is available here.
  • Powerline Fonts are required for all themes using the powerline arrow char.
  • gperftools is required for building with the "profiling" feature flag (disabled by default).

Getting Started

Stable releases are packaged on some distributions:

  • On Arch Linux, you can install from the AUR: i3status-rust or i3status-rust-git.

  • On Fedora 31+: sudo dnf install i3status-rs For older releases and CentOS, you can install from the COPR.

  • On Void Linux: xbps-install -S i3status-rust

  • On NixOS: nix-env -iA nixos.i3status-rust

Otherwise, you can install from source:

$ git clone https://github.com/greshake/i3status-rust
$ cd i3status-rust && cargo build --release
# Optional:
$ cp target/release/i3status-rs ~/bin/i3status-rs

Now you need to create a configuration. Edit the example configuration to your liking and put it to a sensible place (e.g. ~/.config/i3/status.toml).

Next, edit your i3 bar configuration to use i3status-rust. For example:

bar {
    font pango:DejaVu Sans Mono, FontAwesome 12
    position top
    status_command path/to/i3status-rs path/to/config.toml
    colors {
        separator #666666
        background #222222
        statusline #dddddd
        focused_workspace #0088CC #0088CC #ffffff
        active_workspace #333333 #333333 #ffffff
        inactive_workspace #333333 #333333 #888888
        urgent_workspace #2f343a #900000 #ffffff
    }
}

In order to use the built-in support for the Font Awesome icon set, you will need to include it in the font parameter, as above. Check to make sure that "FontAwesome" will correctly identify the font by using fc-match, e.g.

$ fc-match FontAwesome
fontawesome-webfont.ttf: "FontAwesome" "Regular"

(Note that the name of the Font Awesome font may have changed in version 5. See #130 for some discussion.)

Finally, reload i3: i3 reload.

Contributing

We welcome new contributors! Take a gander at CONTRIBUTING.md.

License

This project is licensed under the GPLv3. See the LICENSE.md file for details.