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.
Most blocks assume you are running Linux, and some have their own system requirements; refer to the block documentation.
Optional:
name = "awesome", name = "awesome5" or name = "awesome6". On Arch Linux version 4 and version 5 'here' are available in the AUR, and version 6 here.name = material, a patched version of Google's MaterialIcons-Regular.ttf is required which includes \u{0020} (space), sets a descent ands lower all glyphs to properly align. It can be found here.Stable releases are packaged on some distributions:
On Arch Linux: sudo pacman -Syu i3status-rust. The latest development version can be installed from the AUR.
On Fedora/CentOS: you can install the package from the COPR.
On Void Linux: xbps-install -S i3status-rust
On NixOS: nix-env -iA nixos.i3status-rust
On Gentoo, it is avaliable in the GURU overlay: emerge --ask x11-misc/i3status-rust
With Home Manager: programs.i3status-rust.enable = true see available options
Otherwise refer to manual install docs
After installing i3status-rust, you need to create a configuration file.
Edit the example configuration to your liking.
The default location is $XDG_CONFIG_HOME/i3status-rust/config.toml.
There are some top-level configuration variables:
Key | Description | Required | Default
----|-------------|----------|--------
icons | The icon set that should be used. Possible values are none, awesome, awesome5, material and material-nf. Check themes.md for more information | No | none
icons_format | A string to customise the appearance of each icon. Can be used to edit icons' spacing or specify a font that will be applied only to icons via pango markup. For example, set it to " <span font_family='NotoSans Nerd Font'>{icon}</span> " to set font of the icons to be 'NotoSans Nerd Font' | No | " {icon} "
theme | The predefined theme that should be used. You can also add your own overrides. Check themes.md for all available themes. | No | plain
scrolling | The direction of scrolling, either natural or reverse | No | reverse
block | All blocks that will exist in your i3bar. Check blocks.md for all blocks and their parameters. | No | none
Refer to formatting documentation to customize formatting strings' placeholders.
Next, edit your i3 bar configuration to use i3status-rust. For example:
text
bar {
font pango:DejaVu Sans Mono, FontAwesome 12
position top
status_command path/to/i3status-rs path/to/your/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.
shell
$ fc-match FontAwesome
fontawesome-webfont.ttf: "FontAwesome" "Regular"
Note that the name of the Font Awesome font may have changed in version 5.
You can use fc-list to see the names of your available Awesome Fonts.
shell
$ fc-list | grep -i awesome
/usr/share/fonts/TTF/fa-solid-900.ttf: Font Awesome 5 Free,Font Awesome 5 Free Solid:style=Solid
/usr/share/fonts/TTF/fa-regular-400.ttf: Font Awesome 5 Free,Font Awesome 5 Free Regular:style=Regular
In this example, you have to use Font Awesome 5 Free instead of the FontAwesome 12 in the example configuration above.
You can verify the name again using fc-match
See #130 for further discussion.
Finally, reload i3: i3 reload.
i3bar has a "power savings" feature that pauses the bar via SIGSTOP when it is hidden or obscured by a fullscreen container. If this causes issues with your bar, try running i3status-rs with the --never-pause argument, which changes the signal sent by i3 from SIGSTOP to SIGCONT.
Each block has a signal option (see blocks.md). Alternatively, i3status-rs can be signalled to force an update of all blocks by sending it the SIGUSR1 signal.
i3status-rs can also be restarted in place (useful for testing changes to the config file) by sending it the SIGUSR2 signal.
We welcome new contributors! Take a gander at CONTRIBUTING.md.
Note that new development is taking place in the async branch.
This project is licensed under the GPLv3. See the LICENSE file for details.