3 Michael Stapelberg <michael+i3@stapelberg.de>
8 i3status - Generates a status line for dzen2 or xmobar
12 i3status [-c configfile] [-h] [-v]
17 Specifies an alternate configuration file path. By default, i3status looks for
18 configuration files in the following order:
21 2. ~/.config/i3status/config (or $XDG_CONFIG_HOME/i3status/config if set)
23 4. /etc/xdg/i3status/config (or $XDG_CONFIG_DIRS/i3status/config if set)
27 i3status is a small program (about 1500 SLOC) for generating a status bar for
28 i3bar, dzen2, xmobar or similar programs. It is designed to be very
29 efficient by issuing a very small number of system calls, as one generally
30 wants to update such a status line every second. This ensures that even under
31 high load, your status bar is updated correctly. Also, it saves a bit of energy
32 by not hogging your CPU as much as spawning the corresponding amount of shell
37 Since version 2, the configuration file for i3status will be parsed using
38 libconfuse. This makes configuration easier in the programmer’s point of
39 view and more flexible for the user at the same time.
41 The basic idea of i3status is that you can specify which "modules" should
42 be used (the order directive). You can then configure each module with its
43 own section. For every module, you can specify the output format. See below
44 for a complete reference.
47 -------------------------------------------------------------
49 output_format = "dzen2"
56 order += "run_watch DHCP"
57 order += "run_watch VPN"
58 order += "wireless wlan0"
59 order += "ethernet eth0"
61 order += "cpu_temperature 0"
66 format_up = "W: (%quality at %essid, %bitrate) %ip"
67 format_down = "W: down"
71 # if you use %speed, i3status requires the cap_net_admin capability
72 format_up = "E: %ip (%speed)"
73 format_down = "E: down"
77 format = "%status %percentage %remaining %emptytime"
78 path = "/sys/class/power_supply/BAT%d/uevent"
82 pidfile = "/var/run/dhclient*.pid"
86 pidfile = "/var/run/vpnc/pid"
90 format = "%Y-%m-%d %H:%M:%S"
98 format = "T: %degrees °C"
99 path = "/sys/devices/platform/coretemp.0/temp1_input"
105 -------------------------------------------------------------
109 The +colors+ directive will disable all colors if you set it to +false+. You can
110 also specify the colors that will be used to display "good", "degraded" or "bad"
111 values using the +color_good+, +color_degraded+ or +color_bad+ directives,
112 respectively. Those directives are only used if color support is not disabled by
113 the +colors+ directive. The input format for color values is the canonical RGB
114 hexadecimal triplet (with no separators between the colors), prefixed by a hash
117 *Example configuration*:
118 -------------------------------------------------------------
119 color_good = "#00FF00"
120 -------------------------------------------------------------
122 Likewise, you can use the +color_separator+ directive to specify the color that
123 will be used to paint the separator bar. The separator is always output in
124 color, even when colors are disabled by the +colors+ directive.
126 The +interval+ directive specifies the time in seconds for which i3status will
127 sleep before printing the next status line.
129 Using +output_format+ you can chose which format strings i3status should
130 use in its output. Currently available are:
133 i3bar comes with i3 and provides a workspace bar which does the right thing in
134 multi-monitor situations. It also comes with tray support and can display the
135 i3status output. This output type uses JSON to pass as much meta-information to
136 i3bar as possible (like colors, which blocks can be shortened in which way,
139 Dzen is a general purpose messaging, notification and menuing program for X11.
140 It was designed to be scriptable in any language and integrate well with window
141 managers like dwm, wmii and xmonad though it will work with any windowmanger
143 xmobar is a minimalistic, text based, status bar. It was designed to work
144 with the xmonad Window Manager.
146 Does not use any color codes. Separates values by the pipe symbol. This should
147 be used with i3bar and can be used for custom scripts.
151 This module gets the IPv6 address used for outgoing connections (that is, the
152 best available public IPv6 address on your computer).
154 *Example format_up*: +%ip+
156 *Example format_down* +no IPv6+
160 Gets used, free, available and total amount of bytes on the given mounted filesystem.
162 *Example order*: +disk /mnt/usbstick+
164 *Example format*: +%free (%avail)/ %total+
168 Expands the given path to a pidfile and checks if the process ID found inside
169 is valid (that is, if the process is running). You can use this to check if
170 a specific application, such as a VPN client or your DHCP client is running.
172 *Example order*: +run_watch DHCP+
174 *Example format*: +%title: %status+
178 Gets the link quality and ESSID of the given wireless network interface. You
179 can specify different format strings for the network being connected or not
182 *Example order*: +wireless wlan0+
184 *Example format*: +W: (%quality at %essid, %bitrate) %ip+
188 Gets the IP address and (if possible) the link speed of the given ethernet
189 interface. Getting the link speed requires the cap_net_admin capability. Set
190 it using +setcap cap_net_admin=ep $(which i3status)+.
192 *Example order*: +ethernet eth0+
194 *Example format*: +E: %ip (%speed)+
198 Gets the status (charging, discharging, running), percentage and remaining
199 time of the given battery and when it's estimated to be empty. If you want
200 to use the last full capacity instead of the design capacity (when using
201 the design capacity, it may happen that your battery is at 23% when fully
202 charged because it’s old. In general, I want to see it this way, because
203 it tells me how worn off my battery is.), just specify
204 +last_full_capacity = true+.
206 If your battery is represented in a non-standard path in /sys, be sure to
207 modify the "path" property accordingly. The first occurence of %d gets replaced
208 with the battery number, but you can just hard-code a path as well.
210 *Example order*: +battery 0+
212 *Example format*: +%status %remaining (%emptytime)+
216 Gets the temperature of the given thermal zone.
218 *Example order*: +cpu_temperature 0+
220 *Example format*: +T: %degrees °C+
224 Gets the percentual CPU usage from +/proc/stat+.
226 *Example order*: +cpu_usage+
228 *Example format*: +%usage+
232 Gets the system load (number of processes waiting for CPU time in the last
233 1, 5 and 15 minutes).
235 *Example order*: +load+
237 *Example format*: +%1min %5min %15min+
241 Formats the current system time. See +strftime(3)+ for the format.
243 *Example order*: +time+
245 *Example format*: +%Y-%m-%d %H:%M:%S+
249 Outputs the current discordian date in user-specified format. See +ddate(1)+ for
250 details on the format string.
251 *Note*: Neither *%.* nor *%X* are implemented yet.
253 *Example order*: +ddate+
255 *Example format*: +%{%a, %b %d%}, %Y%N - %H+
259 Outputs the volume of the specified mixer on the specified device. Works only
260 on Linux because it uses ALSA.
262 *Example order*: +volume master+
264 *Example format*: +♪: %volume+
266 *Example configuration*:
267 -------------------------------------------------------------
269 format = "♪: %volume"
274 -------------------------------------------------------------
276 == Using i3status with dzen2
278 After installing dzen2, you can directly use it with i3status. Just ensure that
279 +output_format+ is set to +dzen2+.
281 *Example for usage of i3status with dzen2*:
282 --------------------------------------------------------------
283 i3status | dzen2 -fg white -ta r -w 1280 \
284 -fn "-misc-fixed-medium-r-normal--13-120-75-75-C-70-iso8859-1"
285 --------------------------------------------------------------
287 == Using i3status with xmobar
289 To get xmobar to start, you might need to copy the default configuration
290 file to +~/.xmobarrc+. Also, ensure that the +output_format+ option for i3status
293 *Example for usage of i3status with xmobar*:
294 ---------------------------------------------------------------------
295 i3status | xmobar -o -t "%StdinReader%" -c "[Run StdinReader]"
296 ---------------------------------------------------------------------
298 == What about memory usage or CPU frequency?
300 While talking about two specific things, please understand this section as a
301 general explanation why your favorite information is not included in i3status.
303 Let’s talk about memory usage specifically. It is hard to measure memory in a
304 way which is accurate or meaningful. An in-depth understanding of how paging
305 and virtual memory work in your operating system is required. Furthermore, even
306 if we had a well-defined way of displaying memory usage and you would
307 understand it, I think that it’s not helpful to repeatedly monitor your memory
308 usage. One reason for that is that I have not run out of memory in the last few
309 years. Memory has become so cheap that even in my 4 year old notebook, I have
310 8 GiB of RAM. Another reason is that your operating system will do the right
311 thing anyway: Either you have not enough RAM for your workload, but you need to
312 do it anyway, then your operating system will swap. Or you don’t have enough
313 RAM and you want to restrict your workload so that it fits, then the operating
314 system will kill the process using too much RAM and you can act accordingly.
316 For CPU frequency, the situation is similar. Many people don’t understand how
317 frequency scaling works precisely. The generally recommended CPU frequency
318 governor ("ondemand") changes the CPU frequency far more often than i3status
319 could display it. The display number is therefore often incorrect and doesn’t
320 tell you anything useful either.
322 In general, i3status wants to display things which you would often look at
323 anyways, like the current date/time, whether you are connected to a WiFi
324 network or not, and if you have enough disk space to fit that 4.3 GiB download.
326 However, if you need to look at some kind of information more than once in a
327 while (like checking repeatedly how full your RAM is), you are probably better
328 of with a script doing that, which pops up an alert when your RAM usage reaches
331 == External scripts/programs with i3status
333 In i3status, we don’t want to implement process management again. Therefore,
334 there is no module to run arbitrary scripts or commands. Instead, you should
335 use your shell, for example like this:
337 *Example for prepending the i3status output*:
338 --------------------------------------------------------------
340 # shell script to prepend i3status with more stuff
345 echo "mystuff | $line" || exit 1
347 --------------------------------------------------------------
349 Put that in some script, say +.bin/my_i3status.sh+ and execute that instead of i3status.
353 +strftime(3)+, +date(1)+, +glob(3)+, +dzen2(1)+, +xmobar(1)+
357 Michael Stapelberg and contributors
365 Fernando Tarlá Cardoso Lemos