Skip to content

greshake/i3status-rust

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

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 bars that support the i3bar protocol.

Getting Started

Install from one of the packages below:

Packaging status

Otherwise refer to manual install docs

Configuration

After installing i3status-rust, edit the example configuration to your liking. The default location is $XDG_CONFIG_HOME/i3status-rust/config.toml.

There are some optional global configuration variables, defined either at the top-level or in a TOML table.

[icons] table:

Key Description Default
icons The icon set that should be used. "none"
[icons.icons_overrides] Refer to Themes and Icons below. None

[theme] table:

Key Description Default
theme The theme that should be used. "plain"
[theme.theme_overrides] Refer to Themes and Icons below. None

Global variables:

Key Description Default
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, " <span font_family='NotoSans Nerd Font'>{icon}</span> ". " {icon} "
scrolling The direction of scrolling, either natural or reverse. "reverse"
error_format A string to customise how block errors are displayed. See below for available placeholders. "$short_error_message|X"
error_fullscreen_format A string to customise how block errors are displayed when clicked. See below for available placeholders. "$full_error_message"

Available error_format and error_fullscreen_format placeholders:

Placeholder Value
full_error_message The full error message
short_error_message The short error message, if available

Blocks are defined as a TOML array of tables: [[block]]

Key Description Default
block Name of the i3status-rs block you want to use. See Blocks below for valid block names. -
signal Signal value that causes an update for this block with 0 corresponding to -SIGRTMIN+0 and the largest value being -SIGRTMAX None
if_command Only display the block if the supplied command returns 0 on startup. None
icons_format Overrides global icons_format None
error_format Overrides global error_format None
error_fullscreen_format Overrides global error_fullscreen_format None
error_interval How long to wait until restarting the block after an error occurred. 5
[block.theme_overrides] Same as top-level config option, but for this block only. Refer to Themes and Icons below. None
[block.icons_overrides] Same as top-level config option, but for this block only. Refer to Themes and Icons below. None
[[block.click]] Set or override click action for the block. See below for details. Block default / None

Per block click configuration [[block.click]]:

Key Description Default
button left, right, etc. For more info see here. -
cmd Command to run when mouse button event is detected. None
sync Whether to wait for command to exit or not. false
update Whether to update the block on click. false
pass Whether to also pass click event to the block (if block has an action for the button and cmd is also defined, both will be run if pass is true). true

Further documentation:

Documentation Latest release (v0.22) Git master (v0.30)
Blocks click click
Formatting click click
Themes and Icons click click

Integrate it into i3/sway

Next, edit your 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/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.

$ 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.

$ 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.

Behavior

Each block has a State that defines its colors: one of "Idle", "Info", "Good", "Warning", "Critical" or "Error". The state is determined by the logic in each block, for example, the Music block state is "Info" when there is an active player.

When the state is "Error", a short error will be displayed in the block. The full message can be toggled by clicking on the block (overrides any click actions defined in the config). The block will be restarted after error_interval has elapsed.

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-stop argument, which changes the signal sent by i3 from SIGSTOP to SIGCONT.

In addition to the per-block signal config option, i3status-rs can be signalled to force an update of all blocks by sending it the SIGUSR1 signal. It can also be restarted in place (useful for testing changes to the config file) by sending it the SIGUSR2 signal.

Debugging

Run i3status-rust in a terminal to check the JSON it is outputting.
In addition, some blocks have debug logs that can be enabled like so: RUST_LOG=block=debug i3status-rs where "block" is the block name.

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.