---
name: "i3status-rs"
section: "1"
platform: "linux"
package: "i3status-rust"
version: "0.36.2-1"
release: "Arch Linux 2026-11-01"
platforms: ["linux"]
url: "https://new.carta.tech/i3status-rs"
---

# i3status-rs(1)

A feature-rich and resource-friendly replacement for i3status, written in Rust.

## NAME

i3status-rs - A feature-rich and resource-friendly replacement for i3status, written in Rust.

## SYNOPSIS

**i3status-rs** \[**--never-pause**\] \[**-j**\|**--threads**\] \[**-h**\|**--help**\] \[**-V**\|**--version**\] \[*CONFIG*\]

## DESCRIPTION

A feature-rich and resource-friendly replacement for [i3status(1)](/i3status/1.md), written in Rust. The i3status-rs program writes a stream of configurable "blocks" of system information (time, battery status, volume, etc.) to standard output in the JSON format understood by [i3bar(1)](/i3bar/1.md) and [sway-bar(5)](/sway-bar/5.md).

## OPTIONS

- **--never-pause**

  Ignore any attempts by i3 to pause the bar when hidden/fullscreen

- **-j**, **--threads**=*BLOCKING\_THREADS* \[default: 2\]

  The maximum number of blocking threads spawned by tokio

- **-h**, **--help**

  Print help (see a summary with '-h')

- **-V**, **--version**

  Print version

- \[*CONFIG*\] \[default: config.toml\]

  Sets a TOML config file

  1\. If full absolute path given, then use it as is: \`/home/foo/i3rs-config.toml\`

  2\. If filename given, e.g. "custom\_theme.toml", then first look in \`$XDG\_CONFIG\_HOME/i3status-rust\`

  3\. Then look for it in \`$XDG\_DATA\_HOME/i3status-rust\`

  4\. Otherwise look for it in \`/usr/share/i3status-rust\`

## BLOCKS

### amd\_gpu

Display the stats of your AMD GPU

### Configuration

| | | |
| --- | --- | --- |
| Key | Values | Default |
| `device` | The device in `/sys/class/drm/` to read from. | Any AMD card |
| `format` | A \[MultiFormat\]\[MaybeMultiFormatConfig\] string to customise the output of this block. See below for available placeholders. | `[" $icon $utilization "]` |
| `interval` | Update interval in seconds | `5` |

| | | | |
| --- | --- | --- | --- |
| Placeholder | Value | Type | Unit |
| `icon` | A static icon | Icon | - |
| `utilization` | GPU utilization | Number | % |
| `vram_total` | Total VRAM | Number | Bytes |
| `vram_used` | Used VRAM | Number | Bytes |
| `vram_used_percents` | Used VRAM / Total VRAM | Number | % |

| | | |
| --- | --- | --- |
| Action | Description | Default button |
| `toggle_format` **DEPRECATED** | Toggles between `format` and `format_alt` | - |
| `next_format` | Switches to the next format in the list | Left |
| `prev_format` | Switches to the previous format in the list | Right |

### Example

-

  ```
  [[block]]
  block = "amd_gpu"
  format = " $icon $utilization "
  format_alt = " $icon MEM: $vram_used_percents ($vram_used/$vram_total) "
  interval = 1
  ```

### Icons Used

- •

  `gpu` (`$icon`)

### backlight

The brightness of a backlight device

This block reads brightness information directly from the filesystem, so it works under both X11 and Wayland. The block uses `inotify` to listen for changes in the device’s brightness directly, so there is no need to set an update interval. This block uses DBus to set brightness level using the mouse wheel, but will fallback to sysfs if `systemd-logind` is not used.

### Root scaling

Some devices expose raw values that are best handled with nonlinear scaling. The human perception of lightness is close to the cube root of relative luminance, so settings for `root_scaling` between 2.4 and 3.0 are worth trying. For devices with few discrete steps this should be 1.0 (linear). More information: ⟨https://en.wikipedia.org/wiki/Lightness⟩\\c

### Configuration

| | | |
| --- | --- | --- |
| Key | Values | Default |
| `device` | A regex to match against `/sys/class/backlight` devices to read brightness information from (can match 1 or more devices). When there is no `device` specified, this block will display information for all devices found in the `/sys/class/backlight` directory. | Default device |
| `format` | A string to customise the output of this block. See below for available placeholders. | `" $icon $brightness "` |
| `missing_format` | A string to customise the output of this block. No placeholders available | `" no backlight devices "` |
| `step_width` | The brightness increment to use when scrolling, in percent | `5` |
| `minimum` | The minimum brightness that can be scrolled down to | `5` |
| `maximum` | The maximum brightness that can be scrolled up to | `100` |
| `cycle` | The brightnesses to cycle through on each click | `[minimum, maximum]` |
| `root_scaling` | Scaling exponent reciprocal (ie. root) | `1.0` |
| `invert_icons` | Invert icons’ ordering, useful if you have colorful emoji | `false` |
| `ddcci_sleep_multiplier` | See ddcutil documentation | `1.0` |
| `ddcci_max_tries_write_read` | The maximum number of times to attempt writing to or reading from a ddcci monitor | `10` |

| | | | |
| --- | --- | --- | --- |
| Placeholder | Value | Type | Unit |
| `icon` | Icon based on backlight’s state | Icon | - |
| `brightness` | Current brightness | Number | % |

| | |
| --- | --- |
| Action | Default button |
| `cycle` | Left |
| `brightness_up` | Wheel Up |
| `brightness_down` | Wheel Down |

### Example

-

  ```
  [[block]]
  block = "backlight"
  device = "intel_backlight"
  ```

Hide missing backlight:

-

  ```
  [[block]]
  block = "backlight"
  missing_format = ""
  ```

### calibright

Additional display brightness calibration can be set in `$XDG_CONFIG_HOME/calibright/config.toml` See ⟨https://github.com/bim9262/calibright⟩\\c  for more details. This block will override any global config set in `$XDG_CONFIG_HOME/calibright/config.toml`

### D-Bus Fallback

If you don’t use `systemd-logind` i3status-rust will attempt to set the brightness using sysfs. In order to do this you’ll need to have write permission. You can do this by writing a `udev` rule for your system.

First, check that your user is a member of the “video” group using the `groups` command. Then add a rule in the `/etc/udev/rules.d/` directory containing the following, for example in `backlight.rules`:

-

  ```
  ACTION=="add", SUBSYSTEM=="backlight", GROUP="video", MODE="0664"
  ```

This will allow the video group to modify all backlight devices. You will also need to restart for this rule to take effect.

### Icons Used

- •

  `backlight` (`$icon`, as a progression)

### battery

Information about the internal power supply

This block can display the current battery state (Full, Charging or Discharging), percentage charged and estimate time until (dis)charged for an internal power supply.

### Configuration

| | | |
| --- | --- | --- |
| Key | Values | Default |
| `device` | sysfs/UPower: The device in `/sys/class/power_supply/` to read from (can also be “DisplayDevice” for UPower, which is a single logical power source representing all physical power sources. This is for example useful if your system has multiple batteries, in which case the DisplayDevice behaves as if you had a single larger battery.). apc\_ups: IPv4Address:port or hostname:port | sysfs: the first battery device found in /sys/class/power\_supply, with “BATx” or “CMBx” entries taking precedence. apc\_ups: “localhost:3551”. upower: `DisplayDevice` |
| `driver` | One of `"sysfs"`, `"apc_ups"`, or `"upower"` | `"sysfs"` |
| `model` | If present, the contents of `/sys/class/power_supply/.../model_name` must match this value. Typical use is to select by model name on devices that change their path. | N/A |
| `interval` | Update interval, in seconds. Only relevant for driver = “sysfs” or “apc\_ups”. | `10` |
| `format` | A string to customise the output of this block. See below for available placeholders. | `" $icon $percentage "` |
| `full_format` | Same as `format` but for when the battery is full | `" $icon "` |
| `charging_format` | Same as `format` but for when the battery is charging | Links to `format` |
| `empty_format` | Same as `format` but for when the battery is empty | `" $icon "` |
| `not_charging_format` | Same as `format` but for when the battery is not charging. Defaults to the full battery icon as many batteries report this status when they are full. | `" $icon "` |
| `missing_format` | Same as `format` if the battery cannot be found. | `" $icon "` |
| `info` | Minimum battery level, where state is set to info | `60` |
| `good` | Minimum battery level, where state is set to good | `60` |
| `warning` | Minimum battery level, where state is set to warning | `30` |
| `critical` | Minimum battery level, where state is set to critical | `15` |
| `full_threshold` | Percentage above which the battery is considered full (`full_format` shown) | `95` |
| `empty_threshold` | Percentage below which the battery is considered empty | `7.5` |

| | | | |
| --- | --- | --- | --- |
| Placeholder | Value | Type | Unit |
| `icon` | Icon based on battery’s state | Icon | - |
| `percentage` | Battery level, in percent | Number | Percents |
| `time_remaining` | Time remaining until (dis)charge is complete. Presented only if battery’s status is (dis)charging. | Duration | - |
| `time` | Time remaining until (dis)charge is complete. Presented only if battery’s status is (dis)charging. | String *DEPRECATED* | - |
| `power` | Power consumption by the battery or from the power supply when charging | String or Float | Watts |

`time` has been deprecated in favor of `time_remaining`.

### Examples

Basic usage:

-

  ```
  [[block]]
  block = "battery"
  format = " $icon $percentage "
  ```

-

  ```
  [[block]]
  block = "battery"
  format = " $percentage {$time_remaining.dur(hms:true, min_unit:m) |}"
  device = "DisplayDevice"
  driver = "upower"
  ```

Hide missing battery:

-

  ```
  [[block]]
  block = "battery"
  missing_format = ""
  ```

### Icons Used

- •

  `bat` (`$icon`, in `format` `full_format` `empty_format` `not_charging_format`, as a progression)

- •

  `bat_charging` (`$icon`, in `charging_format`, as a progression)

- •

  `bat_not_available` (`$icon`, in `missing_format`)

### bluetooth

Monitor Bluetooth device

This block displays the connectivity of a given Bluetooth device and the battery level if this is supported. Relies on the Bluez D-Bus API.

When the device can be identified as an audio headset, a keyboard, joystick, or mouse, use the relevant icon. Otherwise, fall back on the generic Bluetooth symbol.

Right-clicking the block will attempt to connect (or disconnect) the device.

Note: battery level information is not reported for some devices.Enabling experimental features of `bluez` ⟨https://wiki.archlinux.org/title/bluetooth#Enabling\_experimental\_features⟩\\c  may fix it.

### Configuration

| | | |
| --- | --- | --- |
| Key | Values | Default |
| `mac` | MAC address of the Bluetooth device | **Required** |
| `adapter_mac` | MAC Address of the Bluetooth adapter (in case your device was connected to multiple currently available adapters) | `None` |
| `format` | A string to customise the output of this block. See below for available placeholders. | " $icon $name{ $percentage\|} " |
| `disconnected_format` | A string to customise the output of this block. See below for available placeholders. | " $icon{ $name\|} " |
| `battery_state` | A mapping from battery percentage to block’s state (color). See example below. | 0..15 -\> critical, 16..30 -\> warning, 31..60 -\> info, 61..100 -\> good |

| | | | |
| --- | --- | --- | --- |
| Placeholder | Value | Type | Unit |
| `icon` | Icon based on what type of device is connected | Icon | - |
| `name` | Device’s name | Text | - |
| `percentage` | Device’s battery level (may be absent if the device is not supported) | Number | % |
| `battery_icon` | Battery icon (may be absent if the device is not supported) | Icon | - |
| `available` | Present if the device is available | Flag | - |

| | |
| --- | --- |
| Action | Default button |
| `toggle` | Right |

### Examples

This example just shows the icon when device is connected.

-

  ```
  [[block]]
  block = "bluetooth"
  mac = "00:18:09:92:1B:BA"
  disconnected_format = ""
  format = " $icon "
  [block.battery_state]
  "0..20" = "critical"
  "21..70" = "warning"
  "71..100" = "good"
  ```

### Icons Used

- •

  `headphones` (`$icon`) for bluetooth devices identifying as “audio-card”, “audio-headset” or “audio-headphones”

- •

  `joystick` (`$icon`) for bluetooth devices identifying as “input-gaming”

- •

  `keyboard` (`$icon`) for bluetooth devices identifying as “input-keyboard”

- •

  `mouse` (`$icon`) for bluetooth devices identifying as “input-mouse”

- •

  `bluetooth` (`$icon`) for all other devices, and when the device is unavailable

- •

  `bat` (`$battery_icon`, as a progression) for devices reporting a battery level

### calendar

Calendar

This block displays upcoming calendar events retrieved from a CalDav ICalendar server.

### Configuration

| | | |
| --- | --- | --- |
| Key | Values | Default |
| `next_event_format` | A string to customize the output of this block when there is a next event in the calendar. See below for available placeholders. | " $icon $start.datetime(f:\`%a %H:%M') $summary " |
| `ongoing_event_format` | A string to customize the output of this block when an event is ongoing. | " $icon $summary (ends at $end.datetime(f:\`%H:%M')) " |
| `no_events_format` | A string to customize the output of this block when there are no events | " $icon " |
| `redirect_format` | A string to customize the output of this block when the authorization is asked | " $icon Check your web browser " |
| `fetch_interval` | Fetch events interval in seconds | `60` |
| `alternate_events_interval` | Alternate overlapping events interval in seconds | `10` |
| `events_within_hours` | Number of hours to look for events in the future | `48` |
| `source` | Array of sources to pull calendars from | `[]` |
| `warning_threshold` | Warning threshold in seconds for the upcoming event | `300` |
| `browser_cmd` | Command to open event details in a browser. The block passes the HTML link as an argument | `"xdg-open"` |

### Source Configuration

| | | |
| --- | --- | --- |
| Key | Values | Default |
| `url` | CalDav calendar server URL | N/A |
| `auth` | Authentication configuration (unauthenticated, basic, or oauth2) | `unauthenticated` |
| `calendars` | List of calendar names to monitor. If empty, all calendars will be fetched. | `[]` |

Note: Currently only one source is supported

| | | |
| --- | --- | --- |
| Action | Description | Default button |
| `open_link` | Opens the HTML link of the event | Left |

### Examples

### Unauthenticated

-

  ```
  [[block]]
  block = "calendar"
  next_event_format = " $icon $start.datetime(f:'%a %H:%M') $summary "
  ongoing_event_format = " $icon $summary (ends at $end.datetime(f:'%H:%M')) "
  no_events_format = " $icon no events "
  fetch_interval = 30
  alternate_events_interval = 10
  events_within_hours = 48
  warning_threshold = 600
  browser_cmd = "firefox"
  [[block.source]]
  url = "https://caldav.example.com/calendar/"
  calendars = ["user/calendar"]
  [block.source.auth]
  type = "unauthenticated"
  ```

### Basic Authentication

-

  ```
  [[block]]
  block = "calendar"
  next_event_format = " $icon $start.datetime(f:'%a %H:%M') $summary "
  ongoing_event_format = " $icon $summary (ends at $end.datetime(f:'%H:%M')) "
  no_events_format = " $icon no events "
  fetch_interval = 30
  alternate_events_interval = 10
  events_within_hours = 48
  warning_threshold = 600
  browser_cmd = "firefox"
  [[block.source]]
  url = "https://caldav.example.com/calendar/"
  calendars = [ "Holidays" ]
  [block.source.auth]
  type = "basic"
  username = "your_username"
  password = "your_password"
  ```

Note: You can also configure the `username` and `password` in a separate TOML file.

`~/.config/i3status-rust/example_credentials.toml`

-

  ```
  username = "my-username"
  password = "my-password"
  ```

Source auth configuration with `credentials_path`:

-

  ```
  [block.source.auth]
  type = "basic"
  credentials_path = "~/.config/i3status-rust/example_credentials.toml"
  ```

### OAuth2 Authentication (Google Calendar)

To access the CalDav API of Google, follow these steps to enable the API and obtain the `client_id` and `client_secret`: 1. **Go to the Google Cloud Console**: Navigate to the Google Cloud Console ⟨https://console.cloud.google.com/⟩\\c . 2. **Create a New Project**: If you don’t already have a project, click on the project dropdown and select “New Project”. Give your project a name and click “Create”. 3. **Enable the CalDAV API**: In the project dashboard, go to the “APIs & Services” \> “Library”. Search for “CalDAV API” and click on it, then click “Enable”. 4. **Set Up OAuth Consent Screen**: Go to “APIs & Services” \> “OAuth consent screen”. Fill out the required information and save. 5. **Create Credentials**: - Navigate to “APIs & Services” \> “Credentials”. - Click “Create Credentials” and select “OAuth 2.0 Client IDs”. - Configure the consent screen if you haven’t already. - Set the application type to “Web application”. - Add your authorized redirect URIs. For example, `http://localhost:8080`. - Click “Create” and note down the `client_id` and `client_secret`. 6. **Download the Credentials**: Click on the download icon next to your OAuth 2.0 Client ID to download the JSON file containing your client ID and client secret. Use these values in your configuration.

-

  ```
  [[block]]
  block = "calendar"
  next_event_format = " $icon $start.datetime(f:'%a %H:%M') $summary "
  ongoing_event_format = " $icon $summary (ends at $end.datetime(f:'%H:%M')) "
  no_events_format = " $icon no events "
  fetch_interval = 30
  alternate_events_interval = 10
  events_within_hours = 48
  warning_threshold = 600
  browser_cmd = "firefox"
  [[block.source]]
  url = "https://apidata.googleusercontent.com/caldav/v2/"
  calendars = ["primary"]
  [block.source.auth]
  type = "oauth2"
  client_id = "your_client_id"
  client_secret = "your_client_secret"
  auth_url = "https://accounts.google.com/o/oauth2/auth"
  token_url = "https://oauth2.googleapis.com/token"
  auth_token = "~/.config/i3status-rust/calendar.auth_token"
  redirect_port = 8080
  scopes = ["https://www.googleapis.com/auth/calendar", "https://www.googleapis.com/auth/calendar.events"]
  ```

Note: You can also configure the `client_id` and `client_secret` in a separate TOML file.

`~/.config/i3status-rust/google_credentials.toml`

-

  ```
  client_id = "my-client_id"
  client_secret = "my-client_secret"
  ```

Source auth configuration with `credentials_path`:

-

  ```
  [block.source.auth]
  type = "oauth2"
  credentials_path = "~/.config/i3status-rust/google_credentials.toml"
  auth_url = "https://accounts.google.com/o/oauth2/auth"
  token_url = "https://oauth2.googleapis.com/token"
  auth_token = "~/.config/i3status-rust/calendar.auth_token"
  redirect_port = 8080
  scopes = ["https://www.googleapis.com/auth/calendar", "https://www.googleapis.com/auth/calendar.events"]
  ```

### Format Configuration

The format configuration is a string that can include placeholders to be replaced with dynamic content. Placeholders can be: - `$summary`: Summary of the event - `$description`: Description of the event - `$url`: Url of the event - `$location`: Location of the event - `$start`: Start time of the event - `$end`: End time of the event

### Icons Used

- •

  `calendar` (`$icon`)

### cpu

CPU statistics

### Configuration

| | | |
| --- | --- | --- |
| Key | Values | Default |
| `format` | A \[MultiFormat\]\[MaybeMultiFormatConfig\] string to customise the output of this block. See below for available placeholders. | `[" $icon $utilization "]` |
| `interval` | Update interval in seconds | `5` |
| `info_cpu` | Percentage of CPU usage, where state is set to info | `30.0` |
| `warning_cpu` | Percentage of CPU usage, where state is set to warning | `60.0` |
| `critical_cpu` | Percentage of CPU usage, where state is set to critical | `90.0` |

| | | | |
| --- | --- | --- | --- |
| Placeholder | Value | Type | Unit |
| `icon` | An icon | Icon | - |
| `utilization` | Average CPU utilization | Number | % |
| `utilization<N>` | Utilization of Nth logical CPU | Number | % |
| `barchart` | Utilization of all logical CPUs presented as a barchart | Text | - |
| `frequency` | Average CPU frequency (may be absent if CPU is not supported) | Number | Hz |
| `frequency<N>` | Frequency of Nth logical CPU (may be absent if CPU is not supported) | Number | Hz |
| `max_frequency` | Max frequency of all logical CPUs | Number | Hz |
| `boost` | CPU turbo boost status (may be absent if CPU is not supported) | Text | - |

| | | |
| --- | --- | --- |
| Action | Description | Default button |
| `toggle_format` **DEPRECATED** | Toggles between `format` and `format_alt` | - |
| `next_format` | Switches to the next format in the list | Left |
| `prev_format` | Switches to the previous format in the list | Right |

### Example

-

  ```
  [[block]]
  block = "cpu"
  interval = 1
  format = " $icon $barchart $utilization "
  format_alt = " $icon $frequency{ $boost|} "
  info_cpu = 20
  warning_cpu = 50
  critical_cpu = 90
  ```

### Icons Used

- •

  `cpu` (`$icon`, as a progression)

- •

  `cpu_boost_on` (`$boost`)

- •

  `cpu_boost_off` (`$boost`)

### custom

The output of a custom shell command

For further customisation, use the `json` option and have the shell command output valid JSON in the schema below:

-

  ```
  {"icon": "...", "state": "...", "text": "...", "short_text": "..."}
  ```

`icon` is optional (default ““) `state` is optional, it may be Idle, Info, Good, Warning, Critical (default Idle) `short_text` is optional.

### Configuration

| | | |
| --- | --- | --- |
| Key | Values | Default |
| `format` | A string to customise the output of this block. See below for available placeholders. | "{ $icon\|} $text.pango-str() " |
| `command` | Shell command to execute & display | `None` |
| `persistent` | Run command in the background; update display for each output line of the command | `false` |
| `cycle` | Commands to execute and change when the button is clicked | `None` |
| `interval` | Update interval in seconds (or “once” to update only once) | `10` |
| `json` | Use JSON from command output to format the block. If the JSON is not valid, the block will error out. | `false` |
| `watch_files` | Watch files to trigger update on file modification. Supports path expansions e.g. `~`. | `None` |
| `hide_when_empty` | Hides the block when the command output (or json text field) is empty | `false` |
| `shell` | Specify the shell to use when running commands | `$SHELL` if set, otherwise fallback to `sh` |

| | | | |
| --- | --- | --- | --- |
| Placeholder | Value | Type | Unit |
| `icon` | Value of icon field from JSON output when it’s non-empty | Icon | - |
| `text` | Output of the script or text field from JSON output | Text |  |
| `short_text` | short\_text field from JSON output | Text |  |

| | |
| --- | --- |
| Action | Default button |
| `cycle` | Left |

### Examples

Display temperature, update every 10 seconds:

-

  ```
  [[block]]
  block = "custom"
  command = ''' cat /sys/class/thermal/thermal_zone0/temp | awk '{printf("%.1f\n",$1/1000)}' '''
  ```

Cycle between “ON” and “OFF”, update every 1 second, run next cycle command when block is clicked:

-

  ```
  [[block]]
  block = "custom"
  cycle = ["echo ON", "echo OFF"]
  interval = 1
  [[block.click]]
  button = "left"
  action = "cycle"
  ```

Use JSON output:

-

  ```
  [[block]]
  block = "custom"
  command = "echo '{\"icon\":\"weather_thunder\",\"state\":\"Critical\", \"text\": \"Danger!\"}'"
  json = true
  ```

Display kernel, update the block only once:

-

  ```
  [[block]]
  block = "custom"
  command = "uname -r"
  interval = "once"
  ```

Display the screen brightness on an intel machine and update this only when `pkill -SIGRTMIN+4 i3status-rs` is called:

-

  ```
  [[block]]
  block = "custom"
  command = ''' cat /sys/class/backlight/intel_backlight/brightness | awk '{print $1}' '''
  signal = 4
  interval = "once"
  ```

Update block when one or more specified files are modified:

-

  ```
  [[block]]
  block = "custom"
  command = "cat custom_status"
  watch_files = ["custom_status"]
  interval = "once"
  ```

### TODO:

- •

  Use `shellexpand`

### custom\_dbus

A block controlled by the DBus

This block creates a new DBus object in `rs.i3status` service. This object implements `rs.i3status.custom` interface which allows you to set block’s icon, text and state.

Output of `busctl --user introspect rs.i3status /<path> rs.i3status.custom`:

-

  ```
  NAME                                TYPE      SIGNATURE RESULT/VALUE FLAGS
  rs.i3status.custom                  interface -         -            -
  .SetIcon                            method    s         s            -
  .SetState                           method    s         s            -
  .SetText                            method    ss        s            -
  ```

### Configuration

| | | |
| --- | --- | --- |
| Key | Values | Default |
| `format` | A string to customise the output of this block. | "{ $icon\|}{ $text.pango-str()\|} " |

| | | | |
| --- | --- | --- | --- |
| Placeholder | Value | Type | Unit |
| `icon` | Value of icon set via `SetIcon` if the value is non-empty string. | Icon | - |
| `text` | Value of the first string from SetText | Text | - |
| `short_text` | Value of the second string from SetText | Text | - |

### Example

Config:

-

  ```
  [[block]]
  block = "custom_dbus"
  path = "/my_path"
  ```

Usage:

-

  ```
  # set full text to 'hello' and short text to 'hi'
  busctl --user call rs.i3status /my_path rs.i3status.custom SetText ss hello hi
  # set icon to 'music'
  busctl --user call rs.i3status /my_path rs.i3status.custom SetIcon s music
  # set state to 'good'
  busctl --user call rs.i3status /my_path rs.i3status.custom SetState s good
  ```

Because it’s impossible to publish objects to the same name from different processes, having multiple dbus blocks in different bars won’t work. As a workaround, you can set the env var `I3RS_DBUS_NAME` to set the interface a bar works on to differentiate between different processes. For example, setting this to \`top', will allow you to use `rs.i3status.top`.

### TODO

- •

  Send a signal on click?

### disk\_iostats

Disk I/O statistics

### Configuration

| | | |
| --- | --- | --- |
| Key | Values | Default |
| `device` | Block device or partition name to monitor (as specified in `/dev/`) | If not set, device will be automatically selected every `interval` |
| `format` | A string to customise the output of this block. See below for available placeholders. | `" $icon $speed_read.eng(prefix:K) $speed_write.eng(prefix:K) "` |
| `interval` | Update interval in seconds | `2` |
| `missing_format` | Same as `format` but for when the device is missing | `" × "` |

| | | | |
| --- | --- | --- | --- |
| Placeholder | Value | Type | Unit |
| `icon` | A static icon | Icon | - |
| `device` | The name of device | Text | - |
| `speed_read` | Read speed | Number | Bytes per second |
| `speed_write` | Write speed | Number | Bytes per second |

### Examples

-

  ```
  [[block]]
  block = "disk_iostats"
  device = "sda"
  format = " $icon $speed_write.eng(prefix:K) "
  ```

Use labeled Games partition via persistent device names from /dev/disk/by-\*/

-

  ```
  [[block]]
  block = "disk_iostats"
  device = "disk/by-partlabel/Games"
  format = " $icon $speed_write.eng(prefix:K) "
  ```

### Icons Used

- •

  `disk_drive` (`$icon`)

### disk\_space

Disk usage statistics

### Configuration

| | | |
| --- | --- | --- |
| Key | Values | Default |
| `path` | Path to collect information from. Supports path expansions e.g. `~`. | `"/"` |
| `interval` | Update time in seconds | `20` |
| `format` | A \[MultiFormat\]\[MaybeMultiFormatConfig\] string to customise the output of this block. See below for available placeholders. | `[" $icon $available "]` |
| `warning` | A value which will trigger warning block state | `20.0` |
| `alert` | A value which will trigger critical block state | `10.0` |
| `info_type` | Determines which information will affect the block state. Possible values are `"available"`, `"free"` and `"used"` | `"available"` |
| `alert_unit` | The unit of `alert` and `warning` options. If not set, percents are used. Possible values are `"B"`, `"kB"`, `"KB"`, `"KiB"`, `"MB"`, `"MiB"`, `"GB"`, `"Gib"`, `"TB"` and `"TiB"` | `None` |
| `backend` | The backend to use when querying disk usage. Possible values are `"vfs"` (like `du(1)`) and `"btrfs"` | `"vfs"` |

| | | | |
| --- | --- | --- | --- |
| Placeholder | Value | Type | Unit |
| `icon` | A static icon | Icon | - |
| `path` | The value of `path` option | Text | - |
| `percentage` | Free or used percentage. Depends on `info_type` | Number | % |
| `total` | Total disk space | Number | Bytes |
| `used` | Used disk space | Number | Bytes |
| `free` | Free disk space | Number | Bytes |
| `available` | Available disk space (free disk space minus reserved system space) | Number | Bytes |

| | | |
| --- | --- | --- |
| Action | Description | Default button |
| `toggle_format` **DEPRECATED** | Toggles between `format` and `format_alt` | - |
| `next_format` | Switches to the next format in the list | Left |
| `prev_format` | Switches to the previous format in the list | Right |

### Examples

-

  ```
  [[block]]
  block = "disk_space"
  info_type = "available"
  alert_unit = "GB"
  alert = 10.0
  warning = 15.0
  format = " $icon $available "
  format_alt = " $icon $available / $total "
  ```

Update block on right click:

-

  ```
  [[block]]
  block = "disk_space"
  [[block.click]]
  button = "right"
  update = true
  ```

Show the block only if less than 10GB is available:

-

  ```
  [[block]]
  block = "disk_space"
  format = " $free.eng(range:..10e9) |"
  ```

### Icons Used

- •

  `disk_drive` (`$icon`)

### docker

Local docker daemon status

### Configuration

| | | |
| --- | --- | --- |
| Key | Values | Default |
| `interval` | Update interval, in seconds. | `5` |
| `format` | A string to customise the output of this block. See below for available placeholders. | `" $icon $running.eng(w:1) "` |
| `socket_path` | The path to the docker socket. Supports path expansions e.g. `~`. | `"/var/run/docker.sock"` |

| | | | |
| --- | --- | --- | --- |
| Key | Value | Type | Unit |
| `icon` | A static icon | Icon | - |
| `total` | Total containers on the host | Number | - |
| `running` | Containers running on the host | Number | - |
| `stopped` | Containers stopped on the host | Number | - |
| `paused` | Containers paused on the host | Number | - |
| `images` | Total images on the host | Number | - |

### Examples

-

  ```
  [[block]]
  block = "docker"
  interval = 2
  format = " $icon $running/$total "
  ```

This example allows showing Podman status by setting the socket path (path is dependent on your own setup).

-

  ```
  [[block]]
  block = "docker"
  format = " $icon $running/$total "
  socket_path = "$XDG_RUNTIME_DIR/podman/podman.sock"
  # socket_path = "/run/user/1000/podman/podman.sock"
  ```

### Icons Used

- •

  `docker` (`$icon`)

### external\_ip

External IP address and various information about it

### Configuration

| | | |
| --- | --- | --- |
| Key | Values | Default |
| `format` | A string to customise the output of this block. See below for available placeholders. | `" $ip $country_flag "` |
| `interval` | Interval in seconds for automatic updates | `300` |
| `autolocate_interval` | How long in seconds to reuse the last result from the geolocation service instead of contacting it again. Kept small by default so that network changes are picked up promptly. | `1` |
| `with_network_manager` | If \`true', listen for NetworkManager events and update the IP immediately if there was a change | `true` |
| `use_ipv4` | If \`true', use IPv4 for obtaining all info | `false` |

| | | | |
| --- | --- | --- | --- |
| Key | Value | Type | Unit |
| `ip` | The external IP address, as seen from a remote server | Text | - |
| `version` | IPv4 or IPv6 | Text | - |
| `city` | City name, such as “San Francisco” | Text | - |
| `region` | Region name, such as “California” | Text | - |
| `region_code` | Region code, such as “CA” for California | Text | - |
| `country` | Country code (2 letter, ISO 3166-1 alpha-2) | Text | - |
| `country_name` | Short country name | Text | - |
| `country_code` | Country code (2 letter, ISO 3166-1 alpha-2) | Text | - |
| `country_code_iso3` | Country code (3 letter, ISO 3166-1 alpha-3) | Text | - |
| `country_capital` | Capital of the country | Text | - |
| `country_tld` | Country specific TLD (top-level domain) | Text | - |
| `continent_code` | Continent code | Text | - |
| `in_eu` | Region code, such as “CA” | Flag | - |
| `postal` | ZIP / Postal code | Text | - |
| `latitude` | Latitude | Number | - (TODO: make degrees?) |
| `longitude` | Longitude | Number | - (TODO: make degrees?) |
| `timezone` | City | Text | - |
| `utc_offset` | UTC offset (with daylight saving time) as +HHMM or -HHMM (HH is hours, MM is minutes) | Text | - |
| `country_calling_code` | Country calling code (dial in code, comma separated) | Text | - |
| `currency` | Currency code (ISO 4217) | Text | - |
| `currency_name` | Currency name | Text | - |
| `languages` | Languages spoken (comma separated 2 or 3 letter ISO 639 code with optional hyphen separated country suffix) | Text | - |
| `country_area` | Area of the country (in sq km) | Number | - |
| `country_population` | Population of the country | Number | - |
| `timezone` | Time zone | Text | - |
| `org` | Organization | Text | - |
| `asn` | Autonomous system (AS) | Text | - |
| `country_flag` | Flag of the country | Text (glyph) | - |

### Example

-

  ```
  [[block]]
  block = "external_ip"
  format = " $ip $country_code "
  ```

### Notes

All the information comes from ⟨https://ipapi.co/json/⟩\\c  Check their documentation here: ⟨https://ipapi.co/api/#complete-location5⟩\\c

The IP is queried, 1) When i3status-rs starts, 2) When a signal is received on D-Bus about a network configuration change, 3) Every 5 minutes. This periodic refresh exists to catch IP updates that don’t trigger a notification, for example due to a IP refresh at the router.

If the service reports rate limiting, the block keeps showing the last known IP and waits for the geolocator’s `rate_limit_interval` (10 minutes by default) before asking again.

Flags: They are not icons but unicode glyphs. You will need a font that includes them. Tested with: ⟨https://www.babelstone.co.uk/Fonts/Flags.html⟩\\c

### focused\_window

Currently focused window

This block displays the title and/or the active marks (when used with `sway`/`i3`) of the currently focused window. Supported WMs are: `sway`, `i3` and most wlroots-based compositors. See `driver` option for more info.

### Configuration

| | | |
| --- | --- | --- |
| Key | Values | Default |
| `format` | A string to customise the output of this block. See below for available placeholders. | " $title.str(max\_w:21) \|" |
| `driver` | Which driver to use. Available values: `sway_ipc` - for `i3` and `sway`, `wlr_toplevel_management` - for Wayland compositors that implement wlr-foreign-toplevel-management-unstable-v1 , `auto` - try to automatically guess which driver to use. | `"auto"` |

| | | | |
| --- | --- | --- | --- |
| Placeholder | Value | Type | Unit |
| `title` | Window’s title (may be absent) | Text | - |
| `marks` | Window’s marks (present only with sway/i3) | Text | - |
| `visible_marks` | Window’s marks that do not start with `_` (present only with sway/i3) | Text | - |

### Example

-

  ```
  [[block]]
  block = "focused_window"
  [block.format]
  full = " $title.str(max_w:15) |"
  short = " $title.str(max_w:10) |"
  ```

This example instead of hiding block when the window’s title is empty displays “Missing”

-

  ```
  [[block]]
  block = "focused_window"
  format = " $title.str(0,21) | Missing "
  ```

### github

The number of GitHub notifications

This block shows the unread notification count for a GitHub account. A GitHub personal access token ⟨https://github.com/settings/tokens/new⟩\\c  with the “notifications” scope is required, and must be passed using the `I3RS_GITHUB_TOKEN` environment variable or `token` configuration option. Optionally the colour of the block is determined by the highest notification in the following lists from highest to lowest: `critical`,`warning`,`info`,`good`

### Configuration

| | | |
| --- | --- | --- |
| Key | Values | Default |
| `format` | A string to customise the output of this block. See below for available placeholders. | `" $icon $total.eng(w:1) "` |
| `interval` | Update interval in seconds | `30` |
| `token` | A GitHub personal access token with the “notifications” scope | `None` |
| `hide_if_total_is_zero` | Hide this block if the total count of notifications is zero | `false` |
| `critical` | List of notification types that change the block to the critical colour | `None` |
| `warning` | List of notification types that change the block to the warning colour | `None` |
| `info` | List of notification types that change the block to the info colour | `None` |
| `good` | List of notification types that change the block to the good colour | `None` |

All the placeholders are numbers without a unit.

| | |
| --- | --- |
| Placeholder | Value |
| `icon` | A static icon |
| `total` | The total number of notifications |
| `assign` | You were assigned to the issue |
| `author` | You created the thread |
| `comment` | You commented on the thread |
| `ci_activity` | A GitHub Actions workflow run that you triggered was completed |
| `invitation` | You accepted an invitation to contribute to the repository |
| `manual` | You subscribed to the thread (via an issue or pull request) |
| `mention` | You were specifically @mentioned in the content |
| `review_requested` | You, or a team you’re a member of, were requested to review a pull request |
| `security_alert` | GitHub discovered a security vulnerability in your repository |
| `state_change` | You changed the thread state (for example, closing an issue or merging a pull request) |
| `subscribed` | You’re watching the repository |
| `team_mention` | You were on a team that was mentioned |

### Examples

-

  ```
  [[block]]
  block = "github"
  format = " $icon $total.eng(w:1)|$mention.eng(w:1) "
  interval = 60
  token = "..."
  ```

-

  ```
  [[block]]
  block = "github"
  token = "..."
  format = " $icon $total.eng(w:1) "
  info = ["total"]
  warning = ["mention","review_requested"]
  hide_if_total_is_zero = true
  ```

### Icons Used

- •

  `github` (`$icon`)

### hueshift

Manage display temperature

This block displays the current color temperature in Kelvin. When scrolling upon the block the color temperature is changed. A left click on the block sets the color temperature to `click_temp` that is by default to `6500K`. A right click completely resets the color temperature to its default value (`6500K`).

### Configuration

| | | |
| --- | --- | --- |
| Key | Values | Default |
| `format` | A string to customise the output of this block. See below for available placeholders. | `" $temperature "` |
| `step` | The step color temperature is in/decreased in Kelvin. | `100` |
| `hue_shifter` | Program used to control screen color. | Detect automatically |
| `max_temp` | Max color temperature in Kelvin. | `10000` |
| `min_temp` | Min color temperature in Kelvin. | `1000` |
| `click_temp` | Left click color temperature in Kelvin. | `6500` |

| | | | |
| --- | --- | --- | --- |
| Placeholder | Value | Type | Unit |
| `temperature` | Current temperature | Number | - |

| | |
| --- | --- |
| Action | Default button |
| `set_click_temp` | Left |
| `reset` | Right |
| `temperature_up` | Wheel Up |
| `temperature_down` | Wheel Down |

### Available Hue Shifters

| | |
| --- | --- |
| Name | Supports |
| `"redshift"` | X11 |
| `"sct"` | X11 |
| `"xsct"` | X11 |
| `"gammastep"` | X11 and Wayland |
| `"wl_gammarelay"` | Wayland |
| `"wl_gammarelay_rs"` | Wayland |
| `"wlsunset"` | Wayland |

Note that at the moment, only `wl_gammarelay` ⟨https://github.com/jeremija/wl-gammarelay⟩\\c  and `wl_gammarelay_rs` ⟨https://github.com/MaxVerevkin/wl-gammarelay-rs⟩\\c  subscribe to the events and update the bar when the temperature is modified externally. Also, these are the only drivers at the moment that work under Wayland without flickering.

### Example

-

  ```
  [[block]]
  block = "hueshift"
  hue_shifter = "redshift"
  step = 50
  click_temp = 3500
  ```

A hard limit is set for the `max_temp` to `10000K` and the same for the `min_temp` which is `1000K`. The `step` has a hard limit as well, defined to `500K` to avoid too brutal changes.

### kdeconnect

KDEConnect ⟨https://community.kde.org/KDEConnect⟩\\c  indicator

Display info from the currently connected device in KDEConnect, updated asynchronously.

Block colours are updated based on the battery level, unless all bat\_\* thresholds are set to 0, in which case the block colours will depend on the notification count instead.

### Configuration

| | | |
| --- | --- | --- |
| Key | Values | Default |
| `device_id` | Device ID as per the output of `kdeconnect --list-devices`. | Chooses the first found device, if any. |
| `format` | A string to customise the output of this block. See below for available placeholders. | " $icon $name{ $bat\_icon $bat\_charge\|}{ $notif\_icon\|} " |
| `format_disconnected` | Same as `format` but when device is disconnected | `" $icon "` |
| `format_missing` | Same as `format` but when device does not exist | `" $icon x "` |
| `bat_info` | Min battery level below which state is set to info. | `60` |
| `bat_good` | Min battery level below which state is set to good. | `60` |
| `bat_warning` | Min battery level below which state is set to warning. | `30` |
| `bat_critical` | Min battery level below which state is set to critical. | `15` |

| | | | |
| --- | --- | --- | --- |
| Placeholder | Value | Type | Unit |
| `icon` | Icon based on connection’s status | Icon | - |
| `bat_icon` | Battery level indicator (only when connected and if supported) | Icon | - |
| `bat_charge` | Battery charge level (only when connected and if supported) | Number | % |
| `network_icon` | Cell Network indicator (only when connected and if supported) | Icon | - |
| `network_type` | Cell Network type (only when connected and if supported) | Text | - |
| `network_strength` | Cell Network level (only when connected and if supported) | Number | % |
| `notif_icon` | Only when connected and there are notifications | Icon | - |
| `notif_count` | Number of notifications on your phone (only when connected and non-zero) | Number | - |
| `name` | Name of your device as reported by KDEConnect (if available) | Text | - |

### Example

Do not show the name, do not set the “good” state.

-

  ```
  [[block]]
  block = "kdeconnect"
  format = " $icon {$bat_icon $bat_charge |}{$notif_icon |}{$network_icon$network_strength $network_type |}"
  bat_good = 101
  ```

### Icons Used

- •

  `bat` (`$bat_icon`, as a progression)

- •

  `bat_charging` (`$bat_icon`, as a progression)

- •

  `net_cellular` (`$network_icon`, as a progression)

- •

  `notification` (`$notif_icon`)

- •

  `phone` (`$icon`, in `format`)

- •

  `phone_disconnected` (`$icon`, in `disconnected_format` `missing_format`)

### keyboard\_layout

Keyboard layout indicator

Six drivers are available: - `xkbevent` which can read asynchronous updates from the x11 events - `setxkbmap` (alias for `xkbevent`) *DEPRECATED* - `xkbswitch` (alias for `xkbevent`) *DEPRECATED* - `localebus` which can read asynchronous updates from the systemd `org.freedesktop.locale1` D-Bus path - `kbddbus` which uses kbdd ⟨https://github.com/qnikst/kbdd⟩\\c  to monitor per-window layout changes via DBus - `sway` which can read asynchronous updates from the sway IPC

`setxkbmap` and `xkbswitch` are deprecated and will be removed in v0.35.0.

Which of these methods is appropriate will depend on your system setup.

### Configuration

| | | |
| --- | --- | --- |
| Key | Values | Default |
| `driver` | One of `"xkbevent"`, `"setxkbmap"`, `"xkbswitch"`, `"localebus"`, `"kbddbus"` or `"sway"`, depending on your system. | `"xkbevent"` |
| `interval` *DEPRECATED* | Update interval, in seconds. Only used by the `"setxkbmap"` driver. | `60` |
| `format` | A string to customise the output of this block. See below for available placeholders. | `" $layout "` |
| `sway_kb_identifier` | Identifier of the device you want to monitor, as found in the output of `swaymsg -t get_inputs`. | Defaults to first input found |
| `mappings` | Map `layout (variant)` to custom short name. | `None` |

`interval` is deprecated and will be removed in v0.35.0.

| | | |
| --- | --- | --- |
| Key | Value | Type |
| `layout` | Keyboard layout name | String |
| `variant` | Keyboard variant name or `N/A` if not applicable | String |

### Examples

Listen to D-Bus for changes:

-

  ```
  [[block]]
  block = "keyboard_layout"
  driver = "localebus"
  ```

Listen to kbdd for changes, the text is in the following format: “English (US)” - {$layout ($variant)} use block.mappings to override with shorter names as shown below. Also use format = ” $layout ($variant) ” to see the full text to map, or you can use: dbus-monitor interface=ru.gentoo.kbdd to see the exact variant spelling

-

  ```
  [[block]]
  block = "keyboard_layout"
  driver = "kbddbus"
  [block.mappings]
  "English (US)" = "us"
  "Bulgarian (new phonetic)" = "bg"
  ```

Listen to sway for changes:

-

  ```
  [[block]]
  block = "keyboard_layout"
  driver = "sway"
  sway_kb_identifier = "1133:49706:Gaming_Keyboard_G110"
  ```

Listen to sway for changes and override mappings:

-

  ```
  [[block]]
  block = "keyboard_layout"
  driver = "sway"
  format = " $layout "
  [block.mappings]
  "English (Workman)" = "EN"
  "Russian (N/A)" = "RU"
  ```

Listen to xkb events for changes:

-

  ```
  [[block]]
  block = "keyboard_layout"
  driver = "xkbevent"
  ```

### load

System load average

### Configuration

| | | |
| --- | --- | --- |
| Key | Values | Default |
| `format` | A string to customise the output of this block. See below for available placeholders. | `" $icon $1m.eng(w:4) "` |
| `interval` | Update interval in seconds | `3` |
| `info` | Minimum load, where state is set to info | `0.3` |
| `warning` | Minimum load, where state is set to warning | `0.6` |
| `critical` | Minimum load, where state is set to critical | `0.9` |

| | | | |
| --- | --- | --- | --- |
| Placeholder | Value | Type | Unit |
| `icon` | A static icon | Icon | - |
| `1m` | 1 minute load average | Number | - |
| `5m` | 5 minute load average | Number | - |
| `15m` | 15 minute load average | Number | - |

### Example

-

  ```
  [[block]]
  block = "load"
  format = " $icon 1min avg: $1m.eng(w:4) "
  interval = 1
  ```

### Icons Used

- •

  `cogs` (`$icon`)

### maildir

Unread mail. Only supports maildir format.

Note that you need to enable `maildir` feature to use this block:

-

  ```
  cargo build --release --features maildir
  ```

### Configuration

| | | |
| --- | --- | --- |
| Key | Values | Default |
| `format` | A string to customise the output of this block. See below for available placeholders. | `" $icon $status "` |
| `inboxes` | List of maildir inboxes to look for mails in. Supports path/glob expansions (e.g. `~` and `*`). | **Required** |
| `threshold_warning` | Number of unread mails where state is set to warning. | `1` |
| `threshold_critical` | Number of unread mails where state is set to critical. | `10` |
| `interval` | Update interval, in seconds. | `5` |
| `display_type` | Which part of the maildir to count: `"new"`, `"cur"`, or `"all"`. | `"new"` |

| | | | |
| --- | --- | --- | --- |
| Placeholder | Value | Type | Unit |
| `icon` | A static icon | Icon | - |
| `status` | Number of emails | Number | - |

### Examples

-

  ```
  [[block]]
  block = "maildir"
  interval = 60
  inboxes = ["~/mail/local", "~/maildir/account1/*"]
  threshold_warning = 1
  threshold_critical = 10
  display_type = "new"
  ```

### Icons Used

- •

  `mail` (`$icon`)

### memory

Memory and swap usage

### Configuration

| | | |
| --- | --- | --- |
| Key | Values | Default |
| `format` | A \[MultiFormat\]\[MaybeMultiFormatConfig\] string to customise the output of this block when in “Memory” view. See below for available placeholders. | `[" $icon $mem_used.eng(prefix:Mi)/$mem_total.eng(prefix:Mi)($mem_used_percents.eng(w:2)) "]` |
| `interval` | Update interval in seconds | `5` |
| `warning_mem` | Percentage of memory usage, where state is set to warning | `80.0` |
| `warning_swap` | Percentage of swap usage, where state is set to warning | `80.0` |
| `critical_mem` | Percentage of memory usage, where state is set to critical | `95.0` |
| `critical_swap` | Percentage of swap usage, where state is set to critical | `95.0` |

| | | | |
| --- | --- | --- | --- |
| Placeholder | Value | Type | Unit |
| `icon` | Memory icon | Icon | - |
| `icon_swap` | Swap icon | Icon | - |
| `mem_total` | Total physical ram available | Number | Bytes |
| `mem_free` | Free memory not yet used by the kernel or userspace (in general you should use mem\_avail) | Number | Bytes |
| `mem_free_percents` | as above but as a percentage of total memory | Number | Percents |
| `mem_avail` | Kernel estimate of usable free memory which includes cached memory and buffers | Number | Bytes |
| `mem_avail_percents` | as above but as a percentage of total memory | Number | Percents |
| `mem_total_used` | mem\_total - mem\_free | Number | Bytes |
| `mem_total_used_percents` | as above but as a percentage of total memory | Number | Percents |
| `mem_used` | Memory used, excluding cached memory and buffers; same as htop’s green bar | Number | Bytes |
| `mem_used_percents` | as above but as a percentage of total memory | Number | Percents |
| `buffers` | Buffers, similar to htop’s blue bar | Number | Bytes |
| `buffers_percent` | as above but as a percentage of total memory | Number | Percents |
| `cached` | Cached memory (taking into account ZFS ARC cache), similar to htop’s yellow bar | Number | Bytes |
| `cached_percent` | as above but as a percentage of total memory | Number | Percents |
| `swap_total` | Swap total | Number | Bytes |
| `swap_free` | Swap free | Number | Bytes |
| `swap_free_percents` | as above but as a percentage of total memory | Number | Percents |
| `swap_used` | Swap used | Number | Bytes |
| `swap_used_percents` | as above but as a percentage of total memory | Number | Percents |
| `zram_compressed` | Compressed zram memory usage | Number | Bytes |
| `zram_decompressed` | Decompressed zram memory usage | Number | Bytes |
| \`zram\_comp\_ratio' | Ratio of the decompressed/compressed zram memory | Number | - |
| `zswap_compressed` | Compressed zswap memory usage (\>=Linux 5.19) | Number | Bytes |
| `zswap_decompressed` | Decompressed zswap memory usage (\>=Linux 5.19) | Number | Bytes |
| `zswap_decompressed_percents` | as above but as a percentage of total zswap memory (\>=Linux 5.19) | Number | Percents |
| \`zswap\_comp\_ratio' | Ratio of the decompressed/compressed zswap memory (\>=Linux 5.19) | Number | - |

| | | |
| --- | --- | --- |
| Action | Description | Default button |
| `toggle_format` **DEPRECATED** | Toggles between `format` and `format_alt` | - |
| `next_format` | Switches to the next format in the list | Left |
| `prev_format` | Switches to the previous format in the list | Right |

### Examples

-

  ```
  [[block]]
  block = "memory"
  format = " $icon $mem_used_percents.eng(w:1) "
  format_alt = " $icon_swap $swap_free.eng(w:3,u:B,p:Mi)/$swap_total.eng(w:3,u:B,p:Mi)($swap_used_percents.eng(w:2)) "
  interval = 30
  warning_mem = 70
  critical_mem = 90
  ```

Show swap and hide if it is zero:

-

  ```
  [[block]]
  block = "memory"
  format = " $icon $swap_used.eng(range:1..) |"
  ```

### Icons Used

- •

  `memory_mem` (`$icon`)

- •

  `memory_swap` (`$icon_swap`)

### menu

A custom menu

This block allows you to quickly run a custom shell command. Left-click on this block to activate it, then scroll through configured items. Left-click on the item to run it and optionally confirm your action by left-clicking again. Right-click any time to deactivate this block.

### Configuration

| | | |
| --- | --- | --- |
| Key | Values | Default |
| `text` | Text that will be displayed when the block is inactive. | **Required** |
| `items` | A list of “items”. See examples below. | **Required** |

### Example

-

  ```
  [[block]]
  block = "menu"
  text = "\uf011"
  [[block.items]]
  display = " -&gt;   Sleep   &lt;-"
  cmd = "systemctl suspend"
  [[block.items]]
  display = " -&gt; Power Off &lt;-"
  cmd = "poweroff"
  confirm_msg = "Are you sure you want to power off?"
  [[block.items]]
  display = " -&gt;  Reboot   &lt;-"
  cmd = "reboot"
  confirm_msg = "Are you sure you want to reboot?"
  ```

### music

The current song title and artist

Also provides buttons for play/pause, previous and next.

Supports all music players that implement the MediaPlayer2 Interface ⟨https://specifications.freedesktop.org/mpris-spec/latest/Player\_Interface.html⟩\\c . This includes:

- •

  Spotify

- •

  VLC

- •

  mpd (via mpDris2 ⟨https://github.com/eonpatapon/mpDris2⟩\\c )

and many others.

By default the block tracks all players available on the MPRIS bus. Right clicking on the block will cycle it to the next player. You can pin the widget to a given player via the “player” setting.

### Configuration

| | | |
| --- | --- | --- |
| Key | Values | Default |
| `format` | A \[MultiFormat\]\[MaybeMultiFormatConfig\] string to customise the output of this block. See below for available placeholders. | \[" $icon {$combo.str(max\_w:25,rot\_interval:0.5) $play \|}"\] |
| `player` | Name(s) of the music player(s) MPRIS interface. This can be either a music player name or an array of music player names. Run busctl --user list \| grep "org.mpris.MediaPlayer2." \| cut -d' ' -f1 and the name is the part after “org.mpris.MediaPlayer2.”. | `None` |
| `interface_name_exclude` | A list of regex patterns for player MPRIS interface names to ignore. | `["playerctld"]` |
| `separator` | String to insert between artist and title. | `" - "` |
| `seek_step_secs` | Positive number of seconds to seek forward/backward when scrolling on the bar. Does not need to be an integer. | `1` |
| `seek_forward_step_secs` | Positive number of seconds to seek forward when scrolling on the bar. Does not need to be an integer. | `seek_step_secs` |
| `seek_backward_step_secs` | Positive number of seconds to seek backward when scrolling on the bar. Does not need to be an integer. | `seek_step_secs` |
| `volume_step` | The percent volume level is increased/decreased for the selected audio device when scrolling. Capped automatically at 50. | `5` |

Note: All placeholders except `icon` can be absent. See the examples below to learn how to handle this.

| | | |
| --- | --- | --- |
| Placeholder | Value | Type |
| `icon` | A static icon | Icon |
| `artist` | Current artist | Text |
| `title` | Current title | Text |
| `url` | Current song url | Text |
| `combo` | Resolves to `"$title[sep]$artist"`, `"$artist"`, `"$title"`, or `"$url"` depending on what information is available. `[sep]` is set by `separator` option. | Text |
| `combo_reversed` | Resolves to `"$artist[sep]$title"`, `"$artist"`, `"$title"`, or `"$url"` depending on what information is available. `[sep]` is set by `separator` option. | Text |
| `player` | Name of the current player (taken from the last part of its MPRIS bus name) | Text |
| `avail` | Total number of players available to switch between | Number |
| `cur` | The current player index of the available players | Number |
| `play` | Play/Pause button | Clickable icon |
| `next` | Next button | Clickable icon |
| `prev` | Previous button | Clickable icon |
| `volume_icon` | Icon based on volume. Missing if unsupported. | Icon |
| `volume` | Current volume. Missing if muted or unsupported. | Number |

| | |
| --- | --- |
| Widget | Placeholder |
| `play_pause_btn` | `$play` |
| `next_btn` | `$next` |
| `prev_btn` | `$prev` |

| | |
| --- | --- |
| Action | Default button |
| `play_pause` | Left on `play_pause_btn` |
| `next` | Left on `next_btn` |
| `prev` | Left on `prev_btn` |
| `next_player` | Right |
| `seek_forward` | Wheel Up |
| `seek_backward` | Wheel Down |
| `volume_up` | - |
| `volume_down` | - |
| `toggle_format` **DEPRECATED** | - |
| `next_format` | Left |
| `prev_format` | - |

### Examples

Show the currently playing song on Spotify only, with play & next buttons and limit the width to 20 characters:

-

  ```
  [[block]]
  block = "music"
  format = " $icon {$combo.str(max_w:20) $play $next |}"
  player = "spotify"
  ```

Same thing for any compatible player, takes the first active on the bus, but ignores “mpd” or anything with “kdeconnect” in the name:

-

  ```
  [[block]]
  block = "music"
  format = " $icon {$combo.str(max_w:20) $play $next |}"
  interface_name_exclude = [".*kdeconnect.*", "mpd"]
  ```

Same as above, but displays with rotating text

-

  ```
  [[block]]
  block = "music"
  format = " $icon {$combo.str(max_w:20,rot_interval:0.5) $play $next |}"
  interface_name_exclude = [".*kdeconnect.*", "mpd"]
  ```

Click anywhere to play/pause, middle click to toggle format:

-

  ```
  [[block]]
  block = "music"
  format = " format 1 "
  format_alt = " format 2 "
  [[block.click]]
  button = "left"
  action = "play_pause"
  [[block.click]]
  button = "middle"
  widget = "."
  action = "next_format"
  ```

Scroll to change the player volume, use the forward and back buttons to seek:

-

  ```
  [[block]]
  block = "music"
  format = " $icon $volume_icon $combo $play $next| "
  seek_step_secs = 10
  [[block.click]]
  button = "up"
  action = "volume_up"
  [[block.click]]
  button = "down"
  action = "volume_down"
  [[block.click]]
  button = "forward"
  action = "seek_forward"
  [[block.click]]
  button = "back"
  action = "seek_backward"
  ```

### Icons Used

- •

  `music` (`$icon`)

- •

  `music_next` (`$next`)

- •

  `music_pause` (`$play`)

- •

  `music_play` (`$play`)

- •

  `music_prev` (`$prev`)

- •

  `volume` (`$volume_icon`, as a progression)

### net

Network information

This block uses `sysfs` and `netlink` and thus does not require any external dependencies.

### Configuration

| | | |
| --- | --- | --- |
| Key | Values | Default |
| `device` | Network interface to monitor (as specified in `/sys/class/net/`). Supports regex. | If not set, device will be automatically selected every `interval` |
| `interval` | Update interval in seconds | `2` |
| `format` | A \[MultiFormat\]\[MaybeMultiFormatConfig\] string to customise the output of this block. See below for available placeholders. | `[" $icon ^icon_net_down $speed_down.eng(prefix:K) ^icon_net_up $speed_up.eng(prefix:K) "]` |
| `inactive_format` | Same as `format` but for when the interface is inactive | `" $icon Down "` |
| `missing_format` | Same as `format` but for when the device is missing | `" × "` |

| | | |
| --- | --- | --- |
| Action | Description | Default button |
| `toggle_format` **DEPRECATED** | Toggles between `format` and `format_alt` | - |
| `next_format` | Switches to the next format in the list | Left |
| `prev_format` | Switches to the previous format in the list | Right |

| | | | |
| --- | --- | --- | --- |
| Placeholder | Value | Type | Unit |
| `icon` | Icon based on device’s type | Icon | - |
| `speed_down` | Download speed | Number | Bytes per second |
| `speed_up` | Upload speed | Number | Bytes per second |
| `graph_down` | Download speed graph | Text | - |
| `graph_up` | Upload speed graph | Text | - |
| `device` | The name of device | Text | - |
| `ssid` | Network SSID (WiFi only) | Text | - |
| `frequency` | WiFi frequency | Number | Hz |
| `signal_strength` | WiFi signal | Number | % |
| `bitrate` | WiFi connection bitrate | Number | Bits per second |
| `ip` | IPv4 address of the iface | Text | - |
| `ipv6` | IPv6 address of the iface | Text | - |
| `nameserver` | Nameserver | Text | - |
| `enabled` | Present if the device is switched on (not turned off with `rfkill` or `ip link set down`) | Flag | - |

### Example

Display WiFi info if available

-

  ```
  [[block]]
  block = "net"
  format = " $icon {$signal_strength $ssid $frequency|Wired connection} via $device "
  ```

Display exact device

-

  ```
  [[block]]
  block = "net"
  device = "^wlo0$"
  ```

Tell a WiFi device that is not connected from one that is switched off (with `rfkill` for example)

-

  ```
  [[block]]
  block = "net"
  device = "^wlan0$"
  format = " $icon $signal_strength "
  inactive_format = " {$enabled{not connected}|switched off} "
  ```

### Icons Used

- •

  `net_loopback` (`$icon`)

- •

  `net_vpn` (`$icon`)

- •

  `net_wired` (`$icon`)

- •

  `net_wireless` (`$icon`, as a progression)

- •

  `net_up` (`^icon_net_up`)

- •

  `net_down` (`^icon_net_down`)

### notify

Display and toggle the state of notifications daemon

Left-clicking on this block will enable/disable notifications.

### Configuration

| | | |
| --- | --- | --- |
| Key | Values | Default |
| `driver` | Which notifications daemon is running. Available drivers are: `"dunst"` and `"swaync"` | `"dunst"` |
| `format` | A string to customise the output of this block. See below for available placeholders. | `" $icon "` |

| | | | |
| --- | --- | --- | --- |
| Placeholder | Value | Type | Unit |
| `icon` | Icon based on notification’s state | Icon | - |
| `notification_count`\[1\] | The number of notification (omitted if 0) | Number | - |
| `history_count`\[2\] | The number of notification in history (omitted if 0) | Number | - |
| `paused` | Present only if notifications are disabled | Flag | - |

| | |
| --- | --- |
| Action | Default button |
| `toggle_paused` | Left |
| `show` | - |
| `show_all` | - |

The `show` and `show_all` actions are the same for SwayNC.

### Examples

How to use `paused` flag

-

  ```
  [[block]]
  block = "notify"
  format = " $icon {$paused{Off}|On} "
  ```

How to use `notification_count`

-

  ```
  [[block]]
  block = "notify"
  format = " $icon {($notification_count.eng(w:1)) |}"
  ```

How to remap actions

-

  ```
  [[block]]
  block = "notify"
  driver = "swaync"
  [[block.click]]
  button = "left"
  action = "show"
  [[block.click]]
  button = "right"
  action = "toggle_paused"
  ```

### Icons Used

- •

  `bell` (`$icon`)

- •

  `bell-slash` (`$icon`)

### notmuch

Count of notmuch messages

This block queries a notmuch database and displays the count of messages.

The simplest configuration will return the total count of messages in the notmuch database stored at $HOME/.mail

Note that you need to enable `notmuch` feature to use this block:

-

  ```
  cargo build --release --features notmuch
  ```

### Configuration

| | | |
| --- | --- | --- |
| Key | Values | Default |
| `format` | A string to customise the output of this block. See below for available placeholders. | `" $icon $count "` |
| `maildir` | Path to the directory containing the notmuch database. Supports path expansions e.g. `~`. | `~/.mail` |
| `query` | Query to run on the database. | `""` |
| `threshold_critical` | Mail count that triggers `critical` state. | `99999` |
| `threshold_warning` | Mail count that triggers `warning` state. | `99999` |
| `threshold_good` | Mail count that triggers `good` state. | `99999` |
| `threshold_info` | Mail count that triggers `info` state. | `99999` |
| `interval` | Update interval in seconds. | `10` |

| | | | |
| --- | --- | --- | --- |
| Placeholder | Value | Type | Unit |
| `icon` | A static icon | Icon | - |
| `count` | Number of messages for the query | Number | - |

### Example

-

  ```
  [[block]]
  block = "notmuch"
  query = "tag:alert and not tag:trash"
  threshold_warning = 1
  threshold_critical = 10
  [[block.click]]
  button = "left"
  update = true
  ```

### Icons Used

- •

  `mail` (`$icon`)

### nvidia\_gpu

Display the stats of your NVidia GPU

By default `show_temperature` shows the used memory. Clicking the left mouse on the “temperature” part of the block will alternate it between showing used or total available memory.

Clicking the left mouse button on the “fan speed” part of the block will cause it to enter into a fan speed setting mode. In this mode you can scroll the mouse wheel over the block to change the fan speeds, and left click to exit the mode.

Requires `nvidia-smi` for displaying info and `nvidia_settings` for setting fan speed.

On laptops with switchable graphics, `nvidia-smi` powers on the dedicated GPU every time it runs, which keeps the GPU awake and raises power consumption. Increase `interval` or avoid this block if that matters on battery.

### Configuration

| | | |
| --- | --- | --- |
| Key | Values | Default |
| `gpu_id` | GPU id in system. | `0` |
| `format` | A string to customise the output of this block. See below for available placeholders. | `" $icon $utilization $memory $temperature "` |
| `interval` | Update interval in seconds. | `1` |
| `idle` | Maximum temperature, below which state is set to idle | `50` |
| `good` | Maximum temperature, below which state is set to good | `70` |
| `info` | Maximum temperature, below which state is set to info | `75` |
| `warning` | Maximum temperature, below which state is set to warning | `80` |

| | | |
| --- | --- | --- |
| Placeholder | Type | Unit |
| `icon` | Icon | - |
| `name` | Text | - |
| `utilization` | Number | Percents |
| `memory` | Number | Bytes |
| `temperature` | Number | Degrees |
| `fan_speed` | Number | Percents |
| `clocks` | Number | Hertz |
| `power` | Number | Watts |

| | |
| --- | --- |
| Widget | Placeholder |
| `mem_btn` | `$memory` |
| `fan_btn` | `$fan_speed` |

| | |
| --- | --- |
| Action | Default button |
| `toggle_mem_total` | Left on `mem_btn` |
| `toggle_fan_controlled` | Left on `fan_btn` |
| `fan_speed_up` | Wheel Up on `fan_btn` |
| `fan_speed_down` | Wheel Down on `fan_btn` |

### Example

-

  ```
  [[block]]
  block = "nvidia_gpu"
  interval = 1
  format = " $icon GT 1030 $utilization $temperature $clocks "
  ```

### Icons Used

- •

  `gpu` (`$icon`)

### TODO

- •

  Provide a `mappings` option similar to `keyboard_layout`’s to map GPU names to labels?

### packages

Pending updates for different package manager like apt, pacman, etc.

Currently, these package managers are supported: - `apk` for Alpine Linux - `apt` for Debian/Ubuntu-based systems - `aur` for Arch-based systems - `brew` for the Homebrew Package Manager - `dnf` for Fedora-based systems - `flatpak` for Flatpak packages - `pacman` for Arch-based systems - `snap` for Snap packages - `xbps` for Void Linux - `zypper` for openSUSE

### Configuration

| | | |
| --- | --- | --- |
| Key | Values | Default |
| `interval` | Update interval in seconds. | `600` |
| `package_manager` | Package manager to check for updates | Automatically derived from format templates, but can be used to influence the `$total` value |
| `format` | A string to customise the output of this block. See below for available placeholders. | `" $icon $total.eng(w:1) "` |
| `format_singular` | Same as `format`, but for when exactly one update is available. | `" $icon $total.eng(w:1) "` |
| `format_up_to_date` | Same as `format`, but for when no updates are available. | `" $icon $total.eng(w:1) "` |
| `warning_updates_regex` | Display block as warning if updates matching regex are available. | `None` |
| `critical_updates_regex` | Display block as critical if updates matching regex are available. | `None` |
| `ignore_updates_regex` | Doesn’t include updates matching regex in the count. | `None` |
| `ignore_phased_updates` | Doesn’t include potentially held back phased updates in the count. (For Debian/Ubuntu-based systems) | `false` |
| `aur_command` | AUR command to check available updates, which outputs in the same format as pacman. E.g. `yay -Qua` (For Arch-based systems) | Required if `$aur` is used |

| | | | |
| --- | --- | --- | --- |
| Placeholder | Value | Type | Unit |
| `icon` | A static icon | Icon | - |
| `apk` | Number of updates available in Alpine Linux | Number | - |
| `apt` | Number of updates available in Debian/Ubuntu-based systems | Number | - |
| `aur` | Number of updates available in Arch-based systems | Number | - |
| `brew` | Number of updates available in the Homebrew Package Manager | Number | - |
| `dnf` | Number of updates available in Fedora-based systems | Number | - |
| `flatpak` | Number of updates available in Flatpak packages | Number | - |
| `pacman` | Number of updates available in Arch-based systems | Number | - |
| `snap` | Number of updates available in Snap packages | Number | - |
| `xbps` | Number of updates available in Void Linux | Number | - |
| `zypper` | Number of updates available in openSUSE | Number | - |
| `total` | Number of updates available in all package manager listed | Number | - |

### Apt

Behind the scenes this uses `apt`, and in order to run it without root privileges i3status-rust will create its own package database in `/tmp/i3rs-apt/` which may take up several MB or more. If you have a custom apt config then this block may not work as expected - in that case please open an issue.

Tip: You can grab the list of available updates using `APT_CONFIG=/tmp/i3rs-apt/apt.conf apt list --upgradable`

### Pacman

Requires fakeroot to be installed (only required for pacman).

Tip: You can grab the list of available updates using `fakeroot pacman -Qu --dbpath /tmp/checkup-db-i3statusrs-$USER/`. If you have the `CHECKUPDATES_DB` env var set on your system then substitute that dir instead.

Note: `pikaur` may hang the whole block if there is no internet connectivity reference ⟨https://github.com/actionless/pikaur/issues/595⟩\\c . In that case, try a different AUR helper.

### Pacman hook

Tip: On Arch Linux you can setup a `pacman` hook to signal i3status-rs to update after packages have been upgraded, so you won’t have stale info in your pacman block.

In the block configuration, set `signal = 1` (or another number if `1` is being used by some other block):

-

  ```
  [[block]]
  block = "packages"
  signal = 1
  ```

Create `/etc/pacman.d/hooks/i3status-rust.hook` with the below contents:

-

  ```
  [Trigger]
  Operation = Upgrade
  Type = Package
  Target = *
  [Action]
  When = PostTransaction
  Exec = /usr/bin/pkill -SIGRTMIN+1 i3status-rs
  ```

### Example

Apk-only config:

-

  ```
  [[block]]
  block = "packages"
  package_manager = ["apk"]
  interval = 1800
  error_interval = 300
  max_retries = 5
  format = " $icon $apk.eng(w:1) updates available "
  format_singular = " $icon One update available "
  format_up_to_date = " $icon system up to date "
  [[block.click]]
  # shows dmenu with available updates. Any dmenu alternative should also work.
  button = "left"
  cmd = "apk --no-cache --upgradable list | dmenu -l 10"
  ```

Apt-only config

-

  ```
  [[block]]
  block = "packages"
  interval = 1800
  error_interval = 300
  max_retries = 5
  package_manager = ["apt"]
  format = " $icon $apt updates available"
  format_singular = " $icon One update available "
  format_up_to_date = " $icon system up to date "
  [[block.click]]
  # shows dmenu with cached available updates. Any dmenu alternative should also work.
  button = "left"
  cmd = "APT_CONFIG=/tmp/i3rs-apt/apt.conf apt list --upgradable | tail -n +2 | rofi -dmenu"
  [[block.click]]
  # Updates the block on right click
  button = "right"
  update = true
  ```

Brew-only config:

-

  ```
  [[block]]
  block = "packages"
  package_manager = ["brew"]
  interval = 1800
  error_interval = 300
  max_retries = 5
  format = " $icon $brew.eng(w:1) updates available "
  format_singular = " $icon One update available "
  format_up_to_date = " $icon system up to date "
  [[block.click]]
  # shows dmenu with available updates. Any dmenu alternative should also work.
  button = "left"
  cmd = "brew outdated | dmenu -l 10"
  ```

Dnf-only config:

-

  ```
  [[block]]
  block = "packages"
  package_manager = ["dnf"]
  interval = 1800
  error_interval = 300
  max_retries = 5
  format = " $icon $dnf.eng(w:1) updates available "
  format_singular = " $icon One update available "
  format_up_to_date = " $icon system up to date "
  [[block.click]]
  # shows dmenu with cached available updates. Any dmenu alternative should also work.
  button = "left"
  cmd = "dnf list -q --upgrades | tail -n +2 | rofi -dmenu"
  ```

Flatpak-only config:

-

  ```
  [[block]]
  block = "packages"
  package_manager = ["flatpak"]
  interval = 1800
  error_interval = 300
  max_retries = 5
  format = " $icon $flatpak.eng(w:1) updates available "
  format_singular = " $icon One update available "
  format_up_to_date = " $icon system up to date "
  [[block.click]]
  # shows dmenu with cached available updates. Any dmenu alternative should also work.
  button = "left"
  cmd = "flatpak remote-ls --updates --columns=ref | rofi -dmenu"
  ```

Pacman-only config:

-

  ```
  [[block]]
  block = "packages"
  package_manager = ["pacman"]
  interval = 600
  error_interval = 300
  max_retries = 5
  format = " $icon $pacman updates available "
  format_singular = " $icon $pacman update available "
  format_up_to_date = " $icon system up to date "
  [[block.click]]
  # pop-up a menu showing the available updates. Replace wofi with your favourite menu command.
  button = "left"
  cmd = "fakeroot pacman -Qu --dbpath /tmp/checkup-db-i3statusrs-$USER/ | wofi --show dmenu"
  [[block.click]]
  # Updates the block on right click
  button = "right"
  update = true
  ```

Pacman and AUR helper config:

-

  ```
  [[block]]
  block = "packages"
  package_manager = ["pacman", "aur"]
  interval = 600
  error_interval = 300
  max_retries = 5
  format = " $icon $pacman + $aur = $total updates available "
  format_singular = " $icon $total update available "
  format_up_to_date = " $icon system up to date "
  # aur_command should output available updates to stdout (ie behave as echo -ne "update\n")
  aur_command = "yay -Qua"
  ```

Snap-only config:

-

  ```
  [[block]]
  block = "packages"
  package_manager = ["snap"]
  interval = 1800
  error_interval = 300
  max_retries = 5
  format = " $icon $snap.eng(w:1) updates available "
  format_singular = " $icon One update available "
  format_up_to_date = " $icon system up to date "
  [[block.click]]
  # shows dmenu with available updates. Any dmenu alternative should also work.
  button = "left"
  cmd = "snap refresh --list | dmenu -l 10"
  ```

Xbps-only config:

-

  ```
  [[block]]
  block = "packages"
  package_manager = ["xbps"]
  interval = 1800
  error_interval = 300
  max_retries = 5
  format = " $icon $xbps.eng(w:1) updates available "
  format_singular = " $icon One update available "
  format_up_to_date = " $icon system up to date "
  [[block.click]]
  # shows dmenu with available updates. Any dmenu alternative should also work.
  button = "left"
  cmd = "xbps-install -Mun | dmenu -l 10"
  ```

Zypper-only config:

-

  ```
  [[block]]
  block = "packages"
  package_manager = ["zypper"]
  interval = 1800
  error_interval = 300
  max_retries = 5
  format = " $icon $zypper.eng(w:1) updates available "
  format_singular = " $icon One update available "
  format_up_to_date = " $icon system up to date "
  [[block.click]]
  # shows dmenu with available updates. Any dmenu alternative should also work.
  button = "left"
  cmd = "zypper -q list-updates | tail -n +3 | rofi -dmenu -window-title 'Upgradable packages:'"
  ```

Multiple package managers config:

Update the list of pending updates every thirty minutes (1800 seconds):

-

  ```
  [[block]]
  block = "packages"
  package_manager = ["apk", "apt", "aur", "brew", "dnf", "flatpak", "pacman", "snap", "xbps", "zypper"]
  interval = 1800
  error_interval = 300
  max_retries = 5
  format = " $icon $apk + $apt + $aur + $brew + $dnf + $flatpak + $pacman + $snap + $xbps + $zypper = $total updates available "
  format_singular = " $icon One update available "
  format_up_to_date = " $icon system up to date "
  # If a linux update is available, but no ZFS package, it won't be possible to
  # actually perform a system upgrade, so we show a warning.
  warning_updates_regex = "(linux|linux-lts|linux-zen)"
  # If ZFS is available, we know that we can and should do an upgrade, so we show
  # the status as critical.
  critical_updates_regex = "(zfs|zfs-lts)"
  ```

### Icons Used

- •

  `update` (`$icon`)

### pomodoro

A pomodoro timer ⟨https://en.wikipedia.org/wiki/Pomodoro\_Technique⟩\\c

### Technique

There are six steps in the original technique: 1) Decide on the task to be done. 2) Set the pomodoro timer (traditionally to 25 minutes). 3) Work on the task. 4) End work when the timer rings and put a checkmark on a piece of paper. 5) If you have fewer than four checkmarks, take a short break (3–5 minutes) and then return to step 2. 6) After four pomodoros, take a longer break (15–30 minutes), reset your checkmark count to zero, then go to step 1.

### Configuration

| | | |
| --- | --- | --- |
| Key | Values | Default |
| `format` | The format used when in idle, prompt, or notify states | " $icon{ $message\|} " |
| `pomodoro_format` | The format used when the pomodoro is running or paused | " $icon $status\_icon{ $completed\_pomodoros.tally()\|} $time\_remaining.duration(hms:true) " |
| `break_format` | The format used when the pomodoro is during the break | " $icon $status\_icon Break: $time\_remaining.duration(hms:true) " |
| `message` | Message when timer expires | `"Pomodoro over! Take a break!"` |
| `break_message` | Message when break is over | `"Break over! Time to work!"` |
| `notify_cmd` | A shell command to run as a notifier. `{msg}` will be substituted with either `message` or `break_message`. | `None` |
| `blocking_cmd` | Is `notify_cmd` blocking? If it is, then pomodoro block will wait until the command finishes before proceeding. Otherwise, you will have to click on the block in order to proceed. | `false` |

| | | | |
| --- | --- | --- | --- |
| Placeholder | Value | Type | Supported by |
| `icon` | A static icon | Icon | All formats |
| `status_icon` | An icon that reflects the pomodoro state | Icon | `pomodoro_format`, `break_format` |
| `message` | Current message | Text | `format` |
| `time_remaining` | How much time is left (minutes) | Duration | `pomodoro_format`, `break_format` |
| `completed_pomodoros` | The number of completed pomodoros | Number | `pomodoro_format` |

### Example

Use `swaynag` as a notifier:

-

  ```
  [[block]]
  block = "pomodoro"
  notify_cmd = "swaynag -m '{msg}'"
  blocking_cmd = true
  ```

Use `notify-send` as a notifier:

-

  ```
  [[block]]
  block = "pomodoro"
  notify_cmd = "notify-send '{msg}'"
  blocking_cmd = false
  ```

### Icons Used

- •

  `pomodoro` (`$icon`)

- •

  `pomodoro_started` (`$status_icon`, in `pomodoro_format`)

- •

  `pomodoro_stopped` (`$status_icon`, in `format`)

- •

  `pomodoro_paused` (`$status_icon`, in `pomodoro_format`)

- •

  `pomodoro_break` (`$status_icon`, in `break_format`)

### privacy

Privacy Monitor

### Configuration

| | | |
| --- | --- | --- |
| Key | Values | Default |
| `driver` | The configuration of a driver (see below). | **Required** |
| `format` | \[MultiFormat\]\[MaybeMultiFormatConfig\] string. | \["{ $icon\_audio \|}{ $icon\_audio\_sink \|}{ $icon\_video \|}{ $icon\_webcam \|}{ $icon\_unknown \|}", "{ $icon\_audio $info\_audio \|}{ $icon\_audio\_sink $info\_audio\_sink \|}{ $icon\_video $info\_video \|}{ $icon\_webcam $info\_webcam \|}{ $icon\_unknown $info\_unknown \|}"\] |

### pipewire Options (requires the pipewire feature to be enabled)

| | | | |
| --- | --- | --- | --- |
| Key | Values | Required | Default |
| `name` | `pipewire` | Yes | None |
| `exclude_output` | An output node to ignore, example: `["HD Pro Webcam C920"]` | No | `[]` |
| `exclude_input` | An input node to ignore, example: `["openrgb"]` | No | `[]` |
| `display` | Which node field should be used as a display name, options: `name`, `description`, `nickname` | No | `name` |

### vl4 Options

| | | | |
| --- | --- | --- | --- |
| Key | Values | Required | Default |
| `name` | `vl4` | Yes | None |
| `exclude_device` | A device to ignore, example: `["/dev/video5"]` | No | `[]` |
| `exclude_consumer` | Processes to ignore | No | `["pipewire", "wireplumber"]` |

### Available Format Keys

| | | | |
| --- | --- | --- | --- |
| Placeholder | Value | Type | Unit |
| `icon_{audio,audio_sink,video,webcam,unknown}` | A static icon | Icon | - |
| `info_{audio,audio_sink,video,webcam,unknown}` | The mapping of which source are being consumed | Text | - |

You can use the suffixes noted above to get the following:

| | |
| --- | --- |
| Suffix | Description |
| `audio` | Captured audio (ex. Mic) |
| `audio_sink` | Audio captured from a sink (ex. openrgb) |
| `video` | Video capture (ex. screen capture) |
| `webcam` | Webcam capture |
| `unknown` | Anything else |

### Available Actions

| | | |
| --- | --- | --- |
| Action | Description | Default button |
| `toggle_format` **DEPRECATED** | Toggles between `format` and `format_alt` | - |
| `next_format` | Switches to the next format in the list | Left |
| `prev_format` | Switches to the previous format in the list | Right |

### Example

-

  ```
  [[block]]
  block = "privacy"
  [[block.driver]]
  name = "v4l"
  [[block.driver]]
  name = "pipewire"
  exclude_input = ["openrgb"]
  display = "nickname"
  ```

### Icons Used

- •

  `microphone` (`$icon_audio`)

- •

  `volume` (`$icon_audio_sink`)

- •

  `xrandr` (`$icon_video`)

- •

  `webcam` (`$icon_webcam`)

- •

  `unknown` (`$icon_unknown`)

### rofication

The number of pending notifications in rofication-daemon

A different color is used if there are critical notifications.

### Configuration

| | | |
| --- | --- | --- |
| Key | Values | Default |
| `interval` | Refresh rate in seconds. | `1` |
| `format` | A string to customise the output of this block. See below for placeholders. | `" $icon $num.eng(w:1) "` |
| `socket_path` | Socket path for the rofication daemon. Supports path expansions e.g. `~`. | `"/tmp/rofi_notification_daemon"` |

| | | | |
| --- | --- | --- | --- |
| Placeholder | Value | Type | Unit |
| `icon` | A static icon | Icon | - |
| `num` | Number of pending notifications | Number | - |

### Example

-

  ```
  [[block]]
  block = "rofication"
  interval = 1
  socket_path = "/tmp/rofi_notification_daemon"
  [[block.click]]
  button = "left"
  cmd = "rofication-gui"
  ```

### Icons Used

- •

  `bell` (`$icon`)

### scratchpad

Scratchpad indicator

### Configuration

| | | |
| --- | --- | --- |
| Key | Values | Default |
| `format` | A string to customise the output of this block | `$icon $count.eng(range:1..) \|` |

| | | | |
| --- | --- | --- | --- |
| Placeholder | Value | Type | Unit |
| `icon` | A static icon | Icon | - |
| `count` | Number of windows in scratchpad | Number | - |

### Example

-

  ```
  [[block]]
  block = "scratchpad"
  ```

### Icons Used

- •

  `scratchpad` (`$icon`)

### service\_status

Display the status of a service

Right now only `systemd` is supported.

### Configuration

| | | |
| --- | --- | --- |
| Key | Values | Default |
| `driver` | Which init system is running the service. Available drivers are: `"systemd"` | `"systemd"` |
| `service` | The name of the service | **Required** |
| `user` | If true, monitor the status of a user service instead of a system service. | `false` |
| `active_format` | A string to customise the output of this block. See below for available placeholders. | `" $service active "` |
| `inactive_format` | A string to customise the output of this block. See below for available placeholders. | `" $service inactive "` |
| `active_state` | A valid \[`State`\] | \[`State::Idle`\] |
| `inactive_state` | A valid \[`State`\] | \[`State::Critical`\] |

| | | | |
| --- | --- | --- | --- |
| Placeholder | Value | Type | Unit |
| `service` | The name of the service | Text | - |

### Example

Example using an icon:

-

  ```
  [[block]]
  block = "service_status"
  service = "cups"
  active_format = " ^icon_tea "
  inactive_format = " no ^icon_tea "
  ```

Example overriding the default `inactive_state`:

-

  ```
  [[block]]
  block = "service_status"
  service = "shadow"
  active_format = ""
  inactive_format = " Integrity of password and group files failed "
  inactive_state = "Warning"
  ```

### sound

Volume level

This block displays the volume level (according to PulseAudio or ALSA). Right click to toggle mute, scroll to adjust volume.

Requires a PulseAudio installation or `alsa-utils` for ALSA.

Note that if you are using PulseAudio commands (such as `pactl`) to control your volume, you should select the `"pulseaudio"` (or `"auto"`) driver to see volume changes that exceed 100%.

### Configuration

| | | |
| --- | --- | --- |
| Key | Values | Default |
| `driver` | `"auto"`, `pipewire`, `"pulseaudio"`, `"alsa"`. | `"auto"` (Pipewire with Pulseaudio fallback with ALSA fallback) |
| `format` | A \[MultiFormat\]\[MaybeMultiFormatConfig\] string to customise the output of this block. See below for available placeholders. | \[" $icon {$volume.eng(w:2) \|}"\] |
| `name` | PulseAudio device name, or the ALSA control name as found in the output of `amixer -D yourdevice scontrols`. | PulseAudio: `@DEFAULT_SINK@` / ALSA: `Master` |
| `device` | ALSA device name, usually in the form “hw:X” or “hw:X,Y” where `X` is the card number and `Y` is the device number as found in the output of `aplay -l`. | `default` |
| `device_kind` | PulseAudio device kind: `source` or `sink`. | `"sink"` |
| `natural_mapping` | When using the ALSA driver, display the “mapped volume” as given by `alsamixer`/`amixer -M`, which represents the volume level more naturally with respect for the human ear. | `false` |
| `step_width` | The percent volume level is increased/decreased for the selected audio device when scrolling. Capped automatically at 50. | `5` |
| `max_vol` | Max volume in percent that can be set via scrolling. Note it can still be set above this value if changed by another application. | `None` |
| `show_volume_when_muted` | Show the volume even if it is currently muted. | `false` |
| `headphones_indicator` | Change icon when headphones are plugged in (pulseaudio only) | `false` |
| `mappings` | Map `output_name` to a custom name. | `None` |
| `mappings_use_regex` | Let `mappings` match using regex instead of string equality. The replacement will be regex aware and can contain capture groups. | `true` |
| `active_port_mappings` | Map `active_port` to a custom name. The replacement will be regex aware and can contain capture groups. | `None` |

| | | | |
| --- | --- | --- | --- |
| Placeholder | Value | Type | Unit |
| `icon` | Icon based on volume | Icon | - |
| `volume` | Current volume. Missing if muted. | Number | % |
| `output_name` | PulseAudio or ALSA device name | Text | - |
| `output_description` | PulseAudio device description, will fallback to `output_name` if no description is available and will be overwritten by mappings (mappings will still use `output_name`) | Text | - |
| `active_port` | Active port (same as information in Ports section of `pactl list cards`). Will be absent if not supported by `driver` or if mapped to `""` in `active_port_mappings`. | Text | - |

| | | |
| --- | --- | --- |
| Action | Description | Default button |
| `toggle_mute` | Toggle mute | Right |
| `volume_down` | Decrease volume | Wheel Down |
| `volume_up` | Increase volume | Wheel Up |
| `toggle_format` **DEPRECATED** | Toggles between `format` and `format_alt` | - |
| `next_format` | Switches to the next format in the list | Left |
| `prev_format` | Switches to the previous format in the list | - |

### Examples

Change the default scrolling step width to 3 percent:

-

  ```
  [[block]]
  block = "sound"
  step_width = 3
  ```

Change the output name shown:

-

  ```
  [[block]]
  block = "sound"
  format = " $icon $output_name{ $volume|} "
  [block.mappings]
  "alsa_output.usb-Harman_Multimedia_JBL_Pebbles_1.0.0-00.analog-stereo" = "Speakers"
  "alsa_output.pci-0000_00_1b.0.analog-stereo" = "Headset"
  ```

Since the default value for the `device_kind` key is `sink`, to display ***microphone*** block you have to use the `source` value:

-

  ```
  [[block]]
  block = "sound"
  driver = "pulseaudio"
  device_kind = "source"
  ```

Display warning in block if microphone if using the wrong port:

-

  ```
  [[block]]
  block = "sound"
  driver = "pulseaudio"
  device_kind = "source"
  format = " $icon { $volume|} {$active_port |}"
  [block.active_port_mappings]
  "analog-input-rear-mic" = "" # Mapping to an empty string makes `$active_port` absent
  "analog-input-front-mic" = "ERR!"
  ```

### Icons Used

- •

  `microphone_muted` (`$icon`, as a progression)

- •

  `microphone` (`$icon`, as a progression)

- •

  `volume_muted` (`$icon`, as a progression)

- •

  `volume` (`$icon`, as a progression)

- •

  `headphones` (`$icon`)

### speedtest

Ping, jitter, download, and upload speeds

This block uses Cloudflare’s networkquality-rs ⟨https://github.com/cloudflare/networkquality-rs⟩\\c  (nq) library to run a speedtest and report the ping, jitter, download speed, and upload speed.

The block can be configured to use custom endpoints for the speedtest, but by default Cloudflare’s nq endpoints are used.

For example setting `config_url` to `"https://mensura.cdn-apple.com/.well-known/nq"` will use Apple’s nq endpoints instead of Cloudflare’s.

nq is based on the IETF draft: “Responsiveness under Working Conditions” ⟨https://datatracker.ietf.org/doc/draft-ietf-ippm-responsiveness/⟩\\c .

The draft defines “responsiveness”, measured in **R**ound trips **P**er **M**inute (RPM), as a useful measurement of network quality.

### Configuration

| | | |
| --- | --- | --- |
| Key | Values | Default |
| `format` | A string to customise the output of this block. See below for available placeholders. | `" ^icon_ping $ping.eng(prefix:m) ^icon_net_down $speed_down ^icon_net_up $speed_up "` |
| `interval` | Update interval in seconds | `1800` |
| `config_url` | The endpoint to get the responsiveness config from. See \[`SpeedtestConfig::config_url`\] for the expected format of the configuration JSON returned by this endpoint. | `None` |
| `large_download_url` | The large file endpoint which should be multiple GBs. | `"https://h3.speed.cloudflare.com/__down?bytes=10000000000"` |
| `small_download_url` | The small file endpoint which should be very small, only a few bytes. | `"https://h3.speed.cloudflare.com/__down?bytes=10"` |
| `upload_url` | The upload url which accepts an arbitrary amount of data. | `"https://h3.speed.cloudflare.com/__up"` |
| `latency` | Arguments for the latency test. | See table below |
| `rpm` | Arguments for the RPM test. | See table below |

### Latency Configuration (settings used for `ping` and `jitter`)

| | | |
| --- | --- | --- |
| Key | Values | Default |
| `runs` | The number of latency test runs to perform. | `20` |

### RPM Configuration (settings used for `speed_down` and `speed_up`)

| | | |
| --- | --- | --- |
| Key | Values | Default |
| `moving_average_distance` | The number of intervals to use when calculating the moving average. | `4` |
| `std_tolerance` | How far a measurement is allowed to be from the previous moving average before the measurement is considered unstable. | `0.05` |
| `trimmed_mean_percent` | Determines which percentile to use for averaging when calculating the trimmed mean of throughputs or RPM scores. A value of `0.95` means to only use values in the 95th percentile to calculate an average. | `0.95` |
| `max_loaded_connections` | The maximum number of loaded connections that the test can use to saturate the network. | `16` |
| `interval_duration_ms` | The duration between test intervals in milliseconds (ms). | `500` (0.5 seconds) |
| `test_duration_ms` | The overall test duration in milliseconds (ms). | `12_000` (12 seconds) |
| `conn_type` | The type of connection to use for the speed test. One of `"h1"`, `"h2"`, or `"h3"` | `"h2"` |
| `upload_bytes_per_request` | The number of bytes to upload per request during the speed test. | `100_000_000` |

### Available Format Keys

| | | | |
| --- | --- | --- | --- |
| Placeholder | Value | Type | Unit |
| `ping` | Ping delay | Number | Seconds |
| `jitter` | Jitter | Number | Seconds |
| `speed_down` | Download speed | Number | Bits per second |
| `speed_up` | Upload speed | Number | Bits per second |

### Examples

Show only ping (with an icon)

-

  ```
  [[block]]
  block = "speedtest"
  format = " ^icon_ping $ping "
  ```

Hide ping and display speed in bytes per second each using 4 characters (without icons)

-

  ```
  [[block]]
  block = "speedtest"
  format = " $speed_down.eng(w:4,u:B) $speed_up(w:4,u:B) "
  ```

Advanced configuration

-

  ```
  [[block]]
  block = "speedtest"
  [block.latency]
  runs = 5
  [block.rpm]
  conn_type = "h1"
  ```

### Icons Used

- •

  `ping` (`^icon_ping`)

- •

  `net_down` (`^icon_net_down`)

- •

  `net_up` (`^icon_net_up`)

### taskwarrior

The number of tasks from the taskwarrior list

Clicking the right mouse button on the icon cycles the view of the block through the user’s filters.

### Configuration

| | | |
| --- | --- | --- |
| Key | Values | Default |
| `interval` | Update interval in seconds | `600` (10min) |
| `warning_threshold` | The threshold of pending (or started) tasks when the block turns into a warning state | `10` |
| `critical_threshold` | The threshold of pending (or started) tasks when the block turns into a critical state | `20` |
| `filters` | A list of tables describing filters (see bellow) | `[{name = "pending", filter = "-COMPLETED -DELETED"}]` |
| `format` | A string to customise the output of this block. See below for available placeholders. | `" $icon $count.eng(w:1) "` |
| `format_singular` | Same as `format` but for when exactly one task is pending. | `" $icon $count.eng(w:1) "` |
| `format_everything_done` | Same as `format` but for when all tasks are completed. | `" $icon $count.eng(w:1) "` |
| `data_location` | Directory in which taskwarrior stores its data files. Supports path expansions e.g. `~`. | `"~/.task"` |

### Filter configuration

| | | |
| --- | --- | --- |
| Key | Values | Default |
| `name` | The name of the filter |  |
| `filter` | Specifies the criteria that must be met for a task to be counted towards this filter |  |
| `config_override` | An array containing configuration overrides, useful for explicitly setting context or other configuration variables | `[]` |

### Placeholders

| | | | |
| --- | --- | --- | --- |
| Placeholder | Value | Type | Unit |
| `icon` | A static icon | Icon | - |
| `count` | The number of tasks matching current filter | Number | - |
| `filter_name` | The name of current filter | Text | - |

### Actions

| | |
| --- | --- |
| Action | Default button |
| `next_filter` | Right |

### Example

In this example, block will be hidden if `count` is zero.

-

  ```
  [[block]]
  block = "taskwarrior"
  interval = 60
  format = " $icon count.eng(w:1) tasks "
  format_singular = " $icon 1 task "
  format_everything_done = ""
  warning_threshold = 10
  critical_threshold = 20
  [[block.filters]]
  name = "today"
  filter = "+PENDING +OVERDUE or +DUETODAY"
  [[block.filters]]
  name = "some-project"
  filter = "project:some-project +PENDING"
  config_override = ["rc.context:none"]
  ```

### Icons Used

- •

  `tasks` (`$icon`)

### tea\_timer

Timer

### Configuration

| | | |
| --- | --- | --- |
| Key | Values | Default |
| `format` | A string to customise the output of this block. See below for available placeholders. | " $icon {$time.duration(hms:true) \|}" |
| `increment` | The numbers of seconds to add each time the block is clicked. | 30 |
| `done_cmd` | A command to run in `sh` when timer finishes. | None |

| | | | |
| --- | --- | --- | --- |
| Placeholder | Value | Type | Unit |
| `icon` | A static icon | Icon | - |
| `time` | The time remaining on the timer | Duration | - |
| `hours` *DEPRECATED* | The hours remaining on the timer | Text | h |
| `minutes` *DEPRECATED* | The minutes remaining on the timer | Text | mn |
| `seconds` *DEPRECATED* | The seconds remaining on the timer | Text | s |

`time`, `hours`, `minutes`, and `seconds` are unset when the timer is inactive.

`hours`, `minutes`, and `seconds` have been deprecated in favor of `time`.

| | |
| --- | --- |
| Action | Default button |
| `increment` | Left / Wheel Up |
| `decrement` | Wheel Down |
| `reset` | Right |

### Example

-

  ```
  [[block]]
  block = "tea_timer"
  format = " $icon {$minutes:$seconds |}"
  done_cmd = "notify-send 'Timer Finished'"
  ```

### Icons Used

- •

  `tea` (`$icon`)

### temperature

The system temperature

This block displays the system temperature, based on `libsensors` library.

This block has two modes: “collapsed”, which uses only color as an indicator, and “expanded”, which shows the content of a `format` string. The average, minimum, and maximum temperatures are computed using all sensors displayed by `sensors`, or optionally filtered by `chip` and `inputs`.

Requires `libsensors` and appropriate kernel modules for your hardware.

Run `sensors` command to list available chips and inputs.

Note that the colour of the block is always determined by the maximum temperature across all sensors, not the average. You may need to keep this in mind if you have a misbehaving sensor.

### Configuration

| | | |
| --- | --- | --- |
| Key | Values | Default |
| `format` | A \[MultiFormat\]\[MaybeMultiFormatConfig\] string to customise the output of this block. See below for available placeholders | `[" $icon $average avg, $max max "]` |
| `interval` | Update interval in seconds | `5` |
| `scale` | Either `"celsius"` or `"fahrenheit"` | `"celsius"` |
| `good` | Maximum temperature to set state to good | `20` °C (`68` °F) |
| `idle` | Maximum temperature to set state to idle | `45` °C (`113` °F) |
| `info` | Maximum temperature to set state to info | `60` °C (`140` °F) |
| `warning` | Maximum temperature to set state to warning. Beyond this temperature, state is set to critical | `80` °C (`176` °F) |
| `chip` | Narrows the results to a given chip name. `*` may be used as a wildcard. | None |
| `inputs` | Narrows the results to individual inputs reported by each chip. | None |

| | | |
| --- | --- | --- |
| Action | Description | Default button |
| `toggle_format` **DEPRECATED** | Toggles between `format` and `format_alt` | - |
| `next_format` | Switches to the next format in the list | Left |
| `prev_format` | Switches to the previous format in the list | Right |

| | | | |
| --- | --- | --- | --- |
| Placeholder | Value | Type | Unit |
| `min` | Minimum temperature among all inputs | Number | Degrees |
| `average` | Average temperature among all inputs | Number | Degrees |
| `max` | Maximum temperature among all inputs | Number | Degrees |

Note that when block is collapsed, no placeholders are provided.

### Example

-

  ```
  [[block]]
  block = "temperature"
  format = " $icon $max max "
  format_alt = " $icon $min min, $max max, $average avg "
  interval = 10
  chip = "*-isa-*"
  ```

### Icons Used

- •

  `thermometer` (`$icon`)

### time

The current time.

### Configuration

| | | |
| --- | --- | --- |
| Key | Values | Default |
| `format` | \[MultiFormat\]\[MaybeMultiFormatConfig\] string. See chrono docs for all options. | `[" $icon $timestamp.datetime() "]` |
| `interval` | Update interval in seconds | `10` |
| `timezone` | A timezone specifier (e.g. “Europe/Lisbon”) | Local timezone |

| | | | |
| --- | --- | --- | --- |
| Placeholder | Value | Type | Unit |
| `icon` | A static icon | Icon | - |
| `timestamp` | The current time | Datetime | - |

| | |
| --- | --- |
| Action | Default button |
| `next_timezone` | Left |
| `prev_timezone` | Right |
| `next_format` | - |
| `prev_format` | - |

### Example

-

  ```
  [[block]]
  block = "time"
  interval = 60
  [block.format]
  full = " $icon $timestamp.datetime(f:'%a %Y-%m-%d %R %Z', l:fr_BE) "
  short = " $icon $timestamp.datetime(f:%R) "
  ```

### Non Gregorian calendars

You can use calendars other than the Gregorian calendar by adding the calendar specifier in the locale string. When using this feature you can’t use chrono style format string, and you should use one of the options provided by the `icu4x` crate: `short`, `medium`, `long`, `full`. If you set `precision` to `hours`/`hour`/`h`, `minutes`/`minute`/`m`, or `seconds`/`second`/`s` then then the datetime will be formatted accordingly, otherwise only the date will be displayed.

\*\* Only available using feature `icu_calendar`. \*\*

### Example

-

  ```
  [[block]]
  block = "time"
  interval = 60
  format = "$timestamp.datetime(locale:'fa-IR-u-ca-persian', f:'full', precision: minutes)"
  ```

### Icons Used

- •

  `time` (`$icon`)

### toggle

A Toggle block

You can add commands to be executed to disable the toggle (`command_off`), and to enable it (`command_on`). If these command exit with a non-zero status, the block will not be toggled and the block state will be changed to `critical` to give a visual warning of the failure. You also need to specify a command to determine the state of the toggle (`command_state`). When the command outputs nothing, the toggle is disabled, otherwise enabled. By specifying the interval property you can let the command\_state be executed continuously.

To run those commands, the shell form `$SHELL` environment variable is used. If such variable is not presented, `sh` is used.

### Configuration

| | | |
| --- | --- | --- |
| Key | Values | Default |
| `format` | A string to customise the output of this block. See below for available placeholders | `" $icon "` |
| `command_on` | Shell command to enable the toggle | **Required** |
| `command_off` | Shell command to disable the toggle | **Required** |
| `command_state` | Shell command to determine the state. Empty output =\> No, otherwise =\> Yes. | **Required** |
| `icon_on` | Icon override for the toggle button while on | `"toggle_on"` |
| `icon_off` | Icon override for the toggle button while off | `"toggle_off"` |
| `interval` | Update interval in seconds. If not set, `command_state` will run only on click. | None |
| `state_on` | \[`State`\] (color) of this block while on | \[idle\]\[State::Idle\] |
| `state_off` | \[`State`\] (color) of this block while off | \[idle\]\[State::Idle\] |

| | | | |
| --- | --- | --- | --- |
| Placeholder | Value | Type | Unit |
| `icon` | Icon based on toggle’s state | Icon | - |

| | |
| --- | --- |
| Action | Default button |
| `toggle` | Left |

### Examples

This is what can be used to toggle an external monitor configuration:

-

  ```
  [[block]]
  block = "toggle"
  format = " $icon 4k "
  command_state = "xrandr | grep 'DP1 connected 38' | grep -v eDP1"
  command_on = "~/.screenlayout/4kmon_default.sh"
  command_off = "~/.screenlayout/builtin.sh"
  interval = 5
  state_on = "good"
  state_off = "warning"
  ```

### Icons Used

- •

  `toggle_off` (`$icon`)

- •

  `toggle_on` (`$icon`)

### uptime

System’s uptime

This block displays system uptime in terms of two biggest units, so minutes and seconds, or hours and minutes or days and hours or weeks and days.

### Configuration

| | | |
| --- | --- | --- |
| Key | Values | Default |
| `format` | A string to customise the output of this block. See below for available placeholders | `" $icon $uptime "` |
| `interval` | Update interval in seconds | `60` |

| | | | |
| --- | --- | --- | --- |
| Placeholder | Value | Type | Unit |
| `icon` | A static icon | Icon | - |
| `text` *DEPRECATED* | Current uptime | Text | - |
| `uptime` | Current uptime | Duration | - |

`text` has been deprecated in favor of `uptime`.

### Example

-

  ```
  [[block]]
  block = "uptime"
  interval = 3600 # update every hour
  ```

### Used Icons

- •

  `uptime`

### vpn

Shows the current connection status for VPN networks

This widget toggles the connection on left click.

### Configuration

| | | |
| --- | --- | --- |
| Key | Values | Default |
| `driver` | Which vpn should be used . Available drivers are: `"nordvpn"`, `"mullvad"`, `"tailscale"` | `"nordvpn"` |
| `interval` | Update interval in seconds. | `10` |
| `format_connected` | A string to customise the output in case the network is connected. See below for available placeholders. | `" VPN: $icon "` |
| `format_disconnected` | A string to customise the output in case the network is disconnected. See below for available placeholders. | `" VPN: $icon "` |
| `format_connecting` | A string to customise the output in case the network is in a connecting state. See below for available placeholders. | `" VPN: $icon "` |
| `state_connected` | The widgets state if the vpn network is connected. | `info` |
| `state_disconnected` | The widgets state if the vpn network is disconnected | `idle` |

| | | | |
| --- | --- | --- | --- |
| Placeholder | Value | Type | Unit |
| `icon` | A static icon | Icon | - |
| `country` | Country currently connected to | Text | - |
| `flag` | Country specific flag (depends on a font supporting them) | Text | - |
| `profile` | Currently selected profile configuration (tailnet) | Text | - |
| `error` | Error message if any | Text | - |

| | | |
| --- | --- | --- |
| Action | Default button | Description |
| `toggle` | Left | toggles the vpn network connection |

### Drivers

### Mullvad

Behind the scenes the mullvad driver uses the `mullvad` command line binary. In order for this to work properly the binary should be executable and mullvad daemon should be running.

### nordvpn

Behind the scenes the nordvpn driver uses the `nordvpn` command line binary. In order for this to work properly the binary should be executable without root privileges.

### Tailscale

Behind the scenes the tailscale driver uses the `tailscale` command line binary. In order for this to work properly the tailscale daemon should be running and the user must be configured as operator:

-

  ```
  sudo tailscale set --operator=$USER
  ```

### Cloudflare WARP

Behind the scenes the WARP driver uses the `warp-cli` command line binary. Just ensure the binary is executable without root privileges.

### Example

Shows the current vpn network state:

-

  ```
  [[block]]
  block = "vpn"
  driver = "nordvpn"
  interval = 10
  format_connected = "VPN: $icon "
  format_disconnected = "VPN: $icon "
  format_connecting = "VPN: $icon "
  state_connected = "good"
  state_disconnected = "warning"
  ```

Possible values for `state_connected` and `state_disconnected`:

-

  ```
  warning
  critical
  good
  info
  idle
  ```

### Icons Used

- •

  `net_vpn` (`$icon`, in `format_connected`)

- •

  `net_wired` (`$icon`, in `format_disconnected`)

- •

  `net_wireless` (`$icon`, in `format_connecting`)

- •

  `net_down` (`$icon`, in `format_disconnected`, on errors)

- •

  country code flags (if supported by font)

Flags: They are not icons but unicode glyphs. You will need a font that includes them. Tested with: ⟨https://www.babelstone.co.uk/Fonts/Flags.html⟩\\c

### watson

Watson statistics

Watson ⟨http://tailordev.github.io/Watson/⟩\\c  is a simple CLI time tracking application. This block will show the name of your current active project, tags and optionally recorded time. Clicking the widget will toggle the `show_time` variable dynamically.

### Configuration

| | | |
| --- | --- | --- |
| Key | Values | Default |
| `format` | A string to customise the output of this block. See below for available placeholders | `" $text \|"` |
| `show_time` | Whether to show recorded time. | `false` |
| `state_path` | Path to the Watson state file. Supports path expansions e.g. `~`. | `$XDG_CONFIG_HOME/watson/state` |
| `interval` | Update interval, in seconds. | `60` |

| | | | |
| --- | --- | --- | --- |
| Placeholder | Value | Type | Unit |
| `text` | Current activity | Text | - |

| | | |
| --- | --- | --- |
| Action | Description | Default button |
| `toggle_show_time` | Toggle the value of `show_time` | Left |

### Example

-

  ```
  [[block]]
  block = "watson"
  show_time = true
  state_path = "~/.config/watson/state"
  ```

### TODO

- •

  Extend functionality: start / stop watson using this block

### weather

Current weather

This block displays local weather and temperature information. In order to use this block, you will need access to a supported weather API service. At the time of writing, OpenWeatherMap, met.no, and the US National Weather Service are supported.

Configuring this block requires configuring a weather service, which may require API keys and other parameters.

If using the `autolocate` feature, set the autolocate update interval such that you do not exceed ipapi.co’s free daily limit of 1000 hits. Or use `autolocate_interval = "once"` to only run on initialization.

### Configuration

| | | |
| --- | --- | --- |
| Key | Values | Default |
| `service` | The configuration of a weather service (see below). | **Required** |
| `format` | A \[MultiFormat\]\[MaybeMultiFormatConfig\] string to customise the output of this block. See below for available placeholders. Text may need to be escaped, refer to Escaping Text. | `[" $icon $weather $temp "]` |
| `interval` | Update interval, in seconds. | `600` |
| `autolocate` | Gets your location using the ipapi.co IP location service (no API key required). If the API call fails then the block will fallback to service specific location config. | `false` |
| `autolocate_interval` | Update interval for `autolocate` in seconds or “once” | `interval` |
| `units` | Either `"metric"` (°C, m/s) or `"imperial"` (°F, mph). If set, will supersede any `units` setting in the service-specific config. | `"metric"` |

### OpenWeatherMap Options

To use the service you will need a (free) API key.

| | | | |
| --- | --- | --- | --- |
| Key | Values | Required | Default |
| `name` | `openweathermap`. | Yes | None |
| `api_key` | Your OpenWeatherMap API key. | Yes | None |
| `coordinates` | GPS latitude longitude coordinates as a tuple, example: `["39.2362","9.3317"]` | Yes\* | None |
| `city_id` | OpenWeatherMap’s ID for the city. (Deprecated) | Yes\* | None |
| `place` | OpenWeatherMap \`By {city name},{state code},{country code}' search query. See here . Consumes an additional API call | Yes\* | None |
| `zip` | OpenWeatherMap \`By {zip code},{country code}' search query. See here . Consumes an additional API call | Yes\* | None |
| `units` *DEPRECATED* | Either `"metric"` or `"imperial"`. | No | `"metric"` |
| `lang` | Language code. See here . Currently only affects `weather_verbose` key. | No | `"en"` |
| `forecast_hours` | How many hours should be forecast (must be increments of 3 hours, max 120 hours) | No | 12 |

One of `coordinates`, `city_id`, `place`, or `zip` is required. If more than one are supplied, `coordinates` takes precedence over `city_id` which takes precedence over `place` which takes precedence over `zip`.

The options `api_key`, `city_id`, `place`, `zip`, can be omitted from configuration, in which case they must be provided in the environment variables `OPENWEATHERMAP_API_KEY`, `OPENWEATHERMAP_CITY_ID`, `OPENWEATHERMAP_PLACE`, `OPENWEATHERMAP_ZIP`.

Forecasts are only fetched if forecast\_hours \> 0 and the format has keys related to forecast.

### met.no Options

| | | | |
| --- | --- | --- | --- |
| Key | Values | Required | Default |
| `name` | `metno`. | Yes | None |
| `coordinates` | GPS latitude longitude coordinates as a tuple, example: `["39.2362","9.3317"]` | Required if `autolocate = false` | None |
| `lang` | Language code: `en`, `nn` or `nb` | No | `en` |
| `altitude` | Meters above sea level of the ground | No | Approximated by server |
| `forecast_hours` | How many hours should be forecast | No | 12 |

Met.no does not support location name, but if autolocate is enabled then autolocate’s city value is used.

### US National Weather Service Options

| | | | |
| --- | --- | --- | --- |
| Key | Values | Required | Default |
| `name` | `nws`. | Yes | None |
| `coordinates` | GPS latitude longitude coordinates as a tuple, example: `["39.2362","9.3317"]` | Required if `autolocate = false` | None |
| `forecast_hours` | How many hours should be forecast | No | 12 |
| `units` *DEPRECATED* | Either `"metric"` or `"imperial"`. | No | `"metric"` |

Forecasts gather statistics from each hour between now and the `forecast_hours` value, and provide predicted weather at the set number of hours into the future.

### Available Format Keys

| | | | |
| --- | --- | --- | --- |
| Key | Value | Type | Unit |
| `location` | Location name (exact format depends on the service) | Text | - |
| `icon{,_ffin}` | Icon representing the weather | Icon | - |
| `weather{,_ffin}` | Textual brief description of the weather, e.g. “Raining” | Text | - |
| `weather_verbose{,_ffin}` | Textual verbose description of the weather, e.g. “overcast clouds” | Text | - |
| `temp{,_{favg,fmin,fmax,ffin}}` | Temperature (°C or °F, based on `units`) | Number | degrees |
| `apparent{,_{favg,fmin,fmax,ffin}}` | Australian Apparent Temperature (°C or °F, based on `units`) | Number | degrees |
| `humidity{,_{favg,fmin,fmax,ffin}}` | Humidity | Number | % |
| `wind{,_{favg,fmin,fmax,ffin}}` | Wind speed (m/s or mph, based on `units`) | Number | - |
| `wind_kmh{,_{favg,fmin,fmax,ffin}}` | Wind speed. The wind speed in km/h | Number | - |
| `direction{,_{favg,fmin,fmax,ffin}}` | Wind direction, e.g. “NE” | Text | - |
| `sunrise` | Time of sunrise (may be absent if it’s a polar day or polar night)\[3\] | DateTime | - |
| `sunset` | Time of sunset (may be absent if it’s a polar day or polar night)\[4\] | DateTime | - |

You can use the suffixes noted above to get the following:

| | |
| --- | --- |
| Suffix | Description |
| None | Current weather |
| `_favg` | Average forecast value |
| `_fmin` | Minimum forecast value |
| `_fmax` | Maximum forecast value |
| `_ffin` | Final forecast value |

| | | |
| --- | --- | --- |
| Action | Description | Default button |
| `toggle_format` **DEPRECATED** | Toggles between `format` and `format_alt` | - |
| `next_format` | Switches to the next format in the list | Left |
| `prev_format` | Switches to the previous format in the list | Right |

### Examples

Show detailed weather in San Francisco through the OpenWeatherMap service:

-

  ```
  [[block]]
  block = "weather"
  format = " $icon $weather ($location) $temp, $wind m/s $direction "
  format_alt = " $icon_ffin Forecast (9 hour avg) {$temp_favg ({$temp_fmin}-{$temp_fmax})|Unavailable} "
  [block.service]
  name = "openweathermap"
  api_key = "XXX"
  city_id = "5398563"
  units = "metric"
  forecast_hours = 9
  ```

Show sunrise and sunset times in null island

-

  ```
  [[block]]
  block = "weather"
  format = "up $sunrise.datetime(f:'%R') down $sunset.datetime(f:'%R')"
  [block.service]
  name = "metno"
  coordinates = ["0", "0"]
  ```

### Used Icons

- •

  `weather_sun` (`$icon` `$icon_ffin`, when weather is reported as “Clear” during the day)

- •

  `weather_moon` (`$icon` `$icon_ffin`, when weather is reported as “Clear” at night)

- •

  `weather_clouds` (`$icon` `$icon_ffin`, when weather is reported as “Clouds” during the day)

- •

  `weather_clouds_night` (`$icon` `$icon_ffin`, when weather is reported as “Clouds” at night)

- •

  `weather_fog` (`$icon` `$icon_ffin`, when weather is reported as “Fog” or “Mist” during the day)

- •

  `weather_fog_night` (`$icon` `$icon_ffin`, when weather is reported as “Fog” or “Mist” at night)

- •

  `weather_rain` (`$icon` `$icon_ffin`, when weather is reported as “Rain” or “Drizzle” during the day)

- •

  `weather_rain_night` (`$icon` `$icon_ffin`, when weather is reported as “Rain” or “Drizzle” at night)

- •

  `weather_snow` (`$icon` `$icon_ffin`, when weather is reported as “Snow”)

- •

  `weather_thunder` (`$icon` `$icon_ffin`, when weather is reported as “Thunderstorm” during the day)

- •

  `weather_thunder_night` (`$icon` `$icon_ffin`, when weather is reported as “Thunderstorm” at night)

- •

  `weather_default` (`$icon` `$icon_ffin`, in all other cases)

### xrandr

X11 screen information

X11 screen information (name, brightness, resolution, refresh rate). With a click you can toggle through your active screens, and scrolling the wheel up/down, you can adjust the selected screens’ brightness. Regarding brightness control, xrandr changes the brightness of the display using gamma rather than changing the brightness in hardware, so if that is not desirable, then consider using the `backlight` block instead.

NOTE: Some users report issues (e.g. here ⟨https://github.com/greshake/i3status-rust/issues/274⟩\\c  and here ⟨https://github.com/greshake/i3status-rust/issues/668⟩\\c  when using this block. The cause is currently unknown, however, setting a higher update interval may help.

### Configuration

| | | |
| --- | --- | --- |
| Key | Values | Default |
| `format` | A string to customise the output of this block. See below for available placeholders. | `" $icon $display $brightness_icon $brightness "` |
| `step_width` | The steps brightness is in/decreased for the selected screen (When greater than 50 it gets limited to 50). | `5` |
| `interval` | Update interval in seconds. | `5` |
| `invert_icons` | Invert icons’ ordering, useful if you have colourful emoji | `false` |

| | | | |
| --- | --- | --- | --- |
| Placeholder | Value | Type | Unit |
| `icon` | A static icon | Icon | - |
| `display` | The monitor name | Text | - |
| `brightness` | The monitor brightness | Number | % |
| `brightness_icon` | A static icon | Icon | - |
| `resolution` | The monitor resolution | Text | - |
| `res_icon` | A static icon | Icon | - |
| `refresh_rate` | The monitor refresh rate | Number | Hertz |

| | |
| --- | --- |
| Action | Default button |
| `cycle_outputs` | Left |
| `brightness_up` | Wheel Up |
| `brightness_down` | Wheel Down |

### Example

-

  ```
  [[block]]
  block = "xrandr"
  format = " $icon $brightness $resolution $refresh_rate "
  ```

### Used Icons

- •

  `xrandr`

- •

  `backlight`

- •

  `resolution`

## NOTES

### \[1\]

when using `notification_count` with the `dunst` driver use dunst \> 1.9.0

### \[2\]

`history_count` is the same as `notification_count` in SwayNC

### \[3\]

On polar days and polar nights, sunrise or sunset may not occur on a given day, and thus the corresponding value may be absent. This behaviour depends on the weather service used. For met.no and nws, both sunrise and sunset will be absent on polar days and polar nights, but OpenWeatherMap will show the same time for both sunrise and sunset.

### \[4\]

On polar days and polar nights, sunrise or sunset may not occur on a given day, and thus the corresponding value may be absent. This behaviour depends on the weather service used. For met.no and nws, both sunrise and sunset will be absent on polar days and polar nights, but OpenWeatherMap will show the same time for both sunrise and sunset.

## THEMES

### Choosing your theme and icon set

To use a theme or icon set other than the default, add them to your configuration file like so:

-

  ```
  [theme]
  theme = "solarized-dark"
  [icons]
  icons = "awesome6"
  ```

Both the theme and icon set can be loaded from a separate file.

-

  ```
  [theme]
  theme = "<file>"
  [icons]
  icons = "<file>"
  ```

where `<file>` can be either a filename or a full path and will be checked in this order:

- 1\.

  If full absolute path given, then use it as is: `/home/foo/custom_theme.toml`

- 2\.

  If filename given, e.g. “custom\_theme.toml”, then first check `$XDG_CONFIG_HOME/i3status-rust/themes`

- 3\.

  Then look for it in `$XDG_DATA_HOME/i3status-rust/themes`

- 4\.

  Otherwise look for it in `/usr/share/i3status-rust/themes`

Notes: - In case with icon sets, the file should be in the `icons` subdirectory instead of `themes`. - You can omit the `.toml` extension while specifying `file` parameters. - All the predefined themes are provided as files, so you use them as examples of how to write your own themes/icon sets.

### Available themes

Note: screenshots were generated using this config with this swaybar config.

- •

  `plain` (default) \[IMAGE: plain\]

- •

  `solarized-dark` \[IMAGE: solarized-dark\]

- •

  `solarized-light` \[IMAGE: solarized-light\]

- •

  `slick` \[IMAGE: slick\]

- •

  `modern` \[IMAGE: modern\]

- •

  `bad-wolf` \[IMAGE: bad-wolf\]

- •

  `gruvbox-light` \[IMAGE: gruvbox-light\]

- •

  `gruvbox-dark` \[IMAGE: gruvbox-dark\]

- •

  `space-villain` \[IMAGE: space-villain\]

- •

  `native` (like plain with no background and native separators) \[IMAGE: native\]

- •

  `semi-native` (like native but with background) \[IMAGE: semi-native\]

- •

  `nord-dark` (polar night) \[IMAGE: nord-dark\]

- •

  `dracula` \[IMAGE: dracula\]

- •

  `srcery` \[IMAGE: srcery\]

- •

  `ctp-frappe` \[IMAGE: ctp-frappe\]

- •

  `ctp-latte` \[IMAGE: ctp-latte\]

- •

  `ctp-macchiato` \[IMAGE: ctp-macchiato\]

- •

  `ctp-mocha` \[IMAGE: ctp-mocha\]

- •

  `tomorrow-night` \[IMAGE: tomorrow-night\]

### Available icon sets

- •

  `none` (default. Uses text labels instead of icons)

- •

  `awesome4` (Font Awesome 4.x)

- •

  `awesome5` (Font Awesome 5.x)

- •

  `awesome6` (Font Awesome 6.x)

- •

  `awesome7` (Font Awesome 7.x)

- •

  `awesome7pro` (Font Awesome 7.x Pro)

- •

  `emoji`

- •

  `material`

- •

  `material-nf` (Any font from Nerd Fonts collection)

**Note**: In order to use the material icon set, you need a patched material icons font which can be found here ⟨https://gist.github.com/draoncc/3c20d8d4262892ccd2e227eefeafa8ef/raw/3e6e12c213fba1ec28aaa26430c3606874754c30/MaterialIcons-Regular-for-inline.ttf⟩\\c . Make sure to pass it in your i3 configuration bar block.

### Overriding themes and icon sets

Create a block in the configuration called `theme` or `icons` like so:

-

  ```
  [theme]
  theme = "solarized-dark"
  [theme.overrides]
  # Example: redefine `idle` colors
  idle_bg = "#123456"
  idle_fg = "#abcdef"
  # Example: swap `good` and `warning` colors
  good_fg = { link = "warning_fg" }
  good_bg = { link = "warning_bg" }
  warning_fg = { link = "good_fg" }
  warning_bg = { link = "good_bg" }
  [icons]
  icons = "awesome6"
  [icons.overrides]
  bat = [
      "| |",
      "|¼|",
      "|½|",
      "|¾|",
      "|X|",
  ]
  bat_charging = "|^|"
  ```

Besides global overrides you may also use per-block overrides using the `theme_overrides`, `icons_overrides` and `icons_format` options available for all blocks. For example:

-

  ```
  [[block]]
  block = "cpu"
  icons_format = "{icon}"
  [block.theme_overrides]
  idle_bg = "#123456"
  idle_fg = "#abcdef"
  [block.icons_overrides]
  cpu_boost_on = "ON"
  cpu_boost_off = "OFF"
  ```

If you define colors in`~/.Xresources` like `*background: #aabbcc` you can use them like:

-

  ```
  [theme]
  theme = "solarized-dark"
  [theme.overrides]
  # Example: redefine `idle_bg` with the background color
  idle_bg = "x:background"
  ```

If you use sway, you can also reference a bar color like:

-

  ```
  [theme]
  theme = "solarized-dark"
  [theme.overrides]
  # Example: redefine `critical` colors
  critical_bg = "sway:urgent_workspace_bg"
  critical_fg = "sway:urgent_workspace_text"
  ```

These are the available sway colors:

- •

  `active_workspace_bg`

- •

  `active_workspace_border`

- •

  `active_workspace_text`

- •

  `background`

- •

  `binding_mode_bg`

- •

  `binding_mode_border`

- •

  `binding_mode_text`

- •

  `focused_background`

- •

  `focused_separator`

- •

  `focused_statusline`

- •

  `focused_workspace_bg`

- •

  `focused_workspace_border`

- •

  `focused_workspace_text`

- •

  `inactive_workspace_bg`

- •

  `inactive_workspace_border`

- •

  `inactive_workspace_text`

- •

  `separator`

- •

  `statusline`

- •

  `urgent_workspace_bg`

- •

  `urgent_workspace_border`

- •

  `urgent_workspace_text`

You can see the current values for your bar with `swaymsg -t get_bar_config <bar-name>`.

### Available theme overrides

All `bg` and `fg` overrides are either

- •

  html hex color codes like `#000000` or `#789ABC`; a fourth byte for alpha (like `#acbdef42`) works on some systems. `00` is transparent, `FF` is opaque, or

- •

  a reference to another override, e.g., `{ link = "idle-bg" }`, or

- •

  a reference to a color name defined in `~/.Xresources`, e.g., `x:background` looks for a line like `*background: #aabbcc` in `~/.Xresources` (see also.Xresources ⟨https://wiki.debian.org/Xresources⟩\\c ).

The tints are added to every second block counting from the right. They will therefore always brighten the block and never darken it. The alpha channel, if it works, can also be alternated in the same way.

Feel free to take a look at the provided color schemes for reference.

- •

  `idle_bg`

- •

  `idle_fg`

- •

  `good_bg`

- •

  `good_fg`

- •

  `warning_bg`

- •

  `warning_fg`

- •

  `critical_bg`

- •

  `critical_fg`

- •

  `info_bg`

- •

  `info_fg`

- •

  `alternating_tint_bg`

- •

  `alternating_tint_fg`

- •

  `separator_bg`

- •

  `separator_fg`

- •

  `separator`

- •

  `end_separator`

- •

  `start_separator`

### Available icon overrides

These can be directly set to a string containing the desired unicode codepoint(s) or use a TOML escape sequence like `"\uf0f3"` for up to 4-nibble codepoints and `"\U0001f312"` for up to 8-nibble codepoints.

You can find the codepoints in the documentation of the icon font you’re using.

Refer to individual block’s documentation for a list of used icons or provided icon sets for a complete list of icons.

## VERSION

v0.36.2 (commit  )

## AUTHORS

Kai Greshake \<development@kai-greshake.de\>, Contributors on GitHub (https, //github.com/greshake/i3status-rust/graphs/contributors)