Documentation
¶
Overview ¶
Package i3status-custom is a subset of my personal i3status configuration.
In general, all modules use left-clicks to trigger actions, right-clicks to change views, middle-clicks to open an external application with more details, and scrolling to change values.
Most modules use DBus or another event-driven protocol rather than polling for efficiency and responsiveness, and avoid calling external commands or using CGO.
Icons from Font Awesome 5 Pro are used in the output.
The modules are documented below and can be used as a starting point for making your own ones.
backlight ¶
Reads backlight values from sysfs, and sets them using systemd-logind over DBus.
battery ¶
Shows battery information for a specific battery using UPower over DBus, plus sysfs for showing charge thresholds if supported.
bluez ¶
Shows the connection status of the specified bluetooth device, disconnecting and connecting on click. Uses BlueZ over DBus. Starts blueman on middle-click.
cmus ¶
Shows the status of cmus using MPRIS over DBus. Starts it in an xfce4-terminal window when middle-clicked, showing and hiding it from the i3 scratchpad on scroll. Supports metadata, seeking, volume, and more.
cpu ¶
Shows the CPU usage percent over the specified interval, optionally expanding to show all CPUs. Reads from procfs. Starts htop sorted by CPU usage on middle-click.
disk ¶
Shows the disk usage of the specified mountpoint. Updates using polling at the configured interval. Starts gnome-disks on middle-click.
dunst ¶
Uses dunst over DBus. Toggles do-not-disturb on click. Shows and hides notification history on scroll. Allows notification actions for the last notification to be selected on middle-click.
interfaces ¶
Polls netlink at the configured interval for getting interface information. Shows filtered interface status, throughput, and IPv4 address. Starts the NetworkManager connection editor on middle-click.
memory ¶
Polls memory usage from procfs at the configured interval. Shows used memory similar to the "free" command. Starts htop sorted by memory usage on middle-click.
pulseaudio ¶
Controls sink/source volume/mute/default using the PulseAudio native API. Has reasonable thresholds for the volume step. Starts pavucontrol with the sink/source tab selected on middle-click.
redshift ¶
Like redshift, but deeply integrated into the status bar. Supports setting a custom color temperature by scrolling and enabling/disabling/resetting by clicking. Uses X11 to set color temperature directly. Automatically updates when outputs are changed.
temperature ¶
Polls sysfs for the hwmon temperature of the configured chip and sensor index.
time ¶
Renders the current time at the configured interval using the specified stdlib layout.
wifi ¶
Polls netlink at the configured interval for wifi information. Shows network info and throughput.
xrandr ¶
Shows the current XRANDR outputs. When there are exactly two outputs, it lets you swap which one is the primary display, and provides seven preset layouts using the preferred mode for the output. Starts arandr on middle-click. Not tested on hidpi displays not running at 1:1. Does not currently support rotation.
Source Files