3 Michael Stapelberg <michael@i3wm.org>
8 i3status - Generates a status line for i3bar, dzen2, xmobar or lemonbar
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, lemonbar 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 The basic idea of i3status is that you can specify which "modules" should
38 be used (the order directive). You can then configure each module with its
39 own section. For every module, you can specify the output format. See below
40 for a complete reference.
43 -------------------------------------------------------------
45 output_format = "dzen2"
52 order += "run_watch DHCP"
53 order += "run_watch VPNC"
54 order += "path_exists VPN"
55 order += "wireless wlan0"
56 order += "ethernet eth0"
58 order += "cpu_temperature 0"
60 order += "tztime local"
61 order += "tztime berlin"
64 format_up = "W: (%quality at %essid, %bitrate) %ip"
65 format_down = "W: down"
69 # if you use %speed, i3status requires the cap_net_admin capability
70 format_up = "E: %ip (%speed)"
71 format_down = "E: down"
75 format = "%status %percentage %remaining %emptytime"
76 format_down = "No battery"
79 status_full = "☻ FULL"
80 path = "/sys/class/power_supply/BAT%d/uevent"
85 pidfile = "/var/run/dhclient*.pid"
89 # file containing the PID of a vpnc process
90 pidfile = "/var/run/vpnc/pid"
94 # path exists when a VPN tunnel launched by nmcli/nm-applet is active
95 path = "/proc/sys/net/ipv4/conf/tun0"
99 format = "%Y-%m-%d %H:%M:%S"
103 format = "%Y-%m-%d %H:%M:%S %Z"
104 timezone = "Europe/Berlin"
112 format = "T: %degrees °C"
113 path = "/sys/devices/platform/coretemp.0/temp1_input"
119 -------------------------------------------------------------
123 The +colors+ directive will disable all colors if you set it to +false+. You can
124 also specify the colors that will be used to display "good", "degraded" or "bad"
125 values using the +color_good+, +color_degraded+ or +color_bad+ directives,
126 respectively. Those directives are only used if color support is not disabled by
127 the +colors+ directive. The input format for color values is the canonical RGB
128 hexadecimal triplet (with no separators between the colors), prefixed by a hash
131 *Example configuration*:
132 -------------------------------------------------------------
133 color_good = "#00FF00"
134 -------------------------------------------------------------
136 Likewise, you can use the +color_separator+ directive to specify the color that
137 will be used to paint the separator bar. The separator is always output in
138 color, even when colors are disabled by the +colors+ directive. This option has
139 no effect when +output_format+ is set to +i3bar+ or +none+.
141 The +interval+ directive specifies the time in seconds for which i3status will
142 sleep before printing the next status line.
144 Using +output_format+ you can chose which format strings i3status should
145 use in its output. Currently available are:
148 i3bar comes with i3 and provides a workspace bar which does the right thing in
149 multi-monitor situations. It also comes with tray support and can display the
150 i3status output. This output type uses JSON to pass as much meta-information to
151 i3bar as possible (like colors, which blocks can be shortened in which way,
154 Dzen is a general purpose messaging, notification and menuing program for X11.
155 It was designed to be scriptable in any language and integrate well with window
156 managers like dwm, wmii and xmonad though it will work with any windowmanger
158 xmobar is a minimalistic, text based, status bar. It was designed to work
159 with the xmonad Window Manager.
161 lemonbar is a lightweight bar based entirely on XCB. It has full UTF-8 support
162 and is EWMH compliant.
164 Use ANSI Escape sequences to produce a terminal-output as close as possible to
165 the graphical outputs. This makes debugging your config file a little bit
166 easier because the terminal-output of i3status becomes much more readable, but
167 should only used for such quick glances, because it will only support very
168 basic output-features (for example you only get 3 bits of color depth).
170 Does not use any color codes. Separates values by the pipe symbol by default.
171 This should be used with i3bar and can be used for custom scripts.
173 It's also possible to use the color_good, color_degraded, color_bad directives
174 to define specific colors per module. If one of these directives is defined
175 in a module section its value will override the value defined in the general
176 section just for this module.
178 If you don't fancy the vertical separators between modules i3status/i3bar
179 uses by default, you can employ the +separator+ directive to configure how
180 modules are separated. You can either disable the default separator altogether
181 setting it to the empty string. You might then define separation as part of a
182 module's format string. This is your only option when using the i3bar output
183 format as the separator is drawn by i3bar directly otherwise. For the other
184 output formats, the provided non-empty string will be automatically enclosed
185 with the necessary coloring bits if color support is enabled.
187 i3bar supports Pango markup, allowing your format strings to specify font
188 color, size, etc. by setting the +markup+ directive to "pango". Note that the
189 ampersand ("&"), less-than ("<"), greater-than (">"), single-quote ("'"), and
190 double-quote (""") characters need to be replaced with "`&`", "`<`",
191 "`>`", "`'`", and "`"`" respectively. This is done automatically
192 for generated content (e.g. wireless ESSID, time).
194 *Example configuration*:
195 -------------------------------------------------------------
197 output_format = "xmobar"
205 format = "[ load: %1min, %5min, %15min ]"
210 -------------------------------------------------------------
214 This module gets the IPv6 address used for outgoing connections (that is, the
215 best available public IPv6 address on your computer).
217 *Example format_up*: +%ip+
219 *Example format_down*: +no IPv6+
223 Gets used, free, available and total amount of bytes on the given mounted filesystem.
225 These values can also be expressed in percentages with the percentage_used,
226 percentage_free, percentage_avail and percentage_used_of_avail formats.
228 Byte sizes are presented in a human readable format using a set of prefixes
229 whose type can be specified via the "prefix_type" option. Three sets of
230 prefixes are available:
233 IEC prefixes (Ki, Mi, Gi, Ti) represent multiples of powers of 1024.
236 SI prefixes (k, M, G, T) represent multiples of powers of 1000.
238 The custom prefixes (K, M, G, T) represent multiples of powers of 1024.
240 It is possible to define a low_threshold that causes the disk text to be
241 displayed using color_bad. The low_threshold type can be of threshold_type
242 "bytes_free", "bytes_avail", "percentage_free", or "percentage_avail", where
243 the former two can be prepended by a generic prefix (k, m, g, t) having
244 prefix_type. So, if you configure low_threshold to 2, threshold_type to
245 "gbytes_avail", and prefix_type to "binary", and the remaining available disk
246 space is below 2 GiB, it will be colored bad. If not specified, threshold_type
247 is assumed to be "percentage_avail" and low_threshold to be set to 0, which
248 implies no coloring at all.
250 You can define a different format with the option "format_not_mounted"
251 which is used if the path does not exist or is not a mount point. So you can just empty
252 the output for the given path with adding +format_not_mounted=""+
253 to the config section.
255 *Example order*: +disk /mnt/usbstick+
257 *Example format*: +%free (%avail)/ %total+
259 *Example format*: +%percentage_used used, %percentage_free free, %percentage_avail avail+
261 *Example prefix_type*: +custom+
263 *Example low_threshold*: +5+
265 *Example threshold_type*: +percentage_free+
269 Expands the given path to a pidfile and checks if the process ID found inside
270 is valid (that is, if the process is running). You can use this to check if
271 a specific application, such as a VPN client or your DHCP client is running.
272 There also is an option "format_down". You can hide the output with
275 *Example order*: +run_watch DHCP+
277 *Example format*: +%title: %status+
281 Checks if the given path exists in the filesystem. You can use this to check if
282 something is active, like for example a VPN tunnel managed by NetworkManager.
283 There also is an option "format_down". You can hide the output with
286 *Example order*: +path_exists VPN+
288 *Example format*: +%title: %status+
292 Gets the link quality, frequency and ESSID of the given wireless network
293 interface. You can specify different format strings for the network being
294 connected or not connected.
296 The special interface name `_first_` will be replaced by the first wireless
297 network interface found on the system (excluding devices starting with "lo").
299 *Example order*: +wireless wlan0+
301 *Example format*: +W: (%quality at %essid, %bitrate / %frequency) %ip+
305 Gets the IP address and (if possible) the link speed of the given ethernet
306 interface. Getting the link speed requires the cap_net_admin capability. Set
307 it using +setcap cap_net_admin=ep $(which i3status)+.
309 The special interface name `_first_` will be replaced by the first non-wireless
310 network interface found on the system (excluding devices starting with "lo").
312 *Example order*: +ethernet eth0+
314 *Example format*: +E: %ip (%speed)+
318 Gets the status (charging, discharging, running), percentage, remaining
319 time and power consumption (in Watts) of the given battery and when it's
320 estimated to be empty. If you want to use the last full capacity instead of the
321 design capacity (when using the design capacity, it may happen that your
322 battery is at 23% when fully charged because it’s old. In general, I want to
323 see it this way, because it tells me how worn off my battery is.), just specify
324 +last_full_capacity = true+. You can hide seconds in the remaining time and
325 empty time estimations by setting +hide_seconds = true+.
327 If you want the battery percentage to be shown without decimals, add
328 +integer_battery_capacity = true+.
330 If your battery is represented in a non-standard path in /sys, be sure to
331 modify the "path" property accordingly, i.e. pointing to the uevent file on
332 your system. The first occurence of %d gets replaced with the battery number,
333 but you can just hard-code a path as well.
335 It is possible to define a low_threshold that causes the battery text to be
336 colored red. The low_threshold type can be of threshold_type "time" or
337 "percentage". So, if you configure low_threshold to 10 and threshold_type to
338 "time", and your battery lasts another 9 minutes, it will be colored red.
340 Optionally custom strings including any UTF-8 symbols can be used for different
341 battery states. This makes it possible to display individual symbols
342 for each state (charging, discharging, full)
343 Of course it will also work with special iconic fonts, such as FontAwesome.
344 If any of this special status strings is omitted, the default (CHR, BAT, FULL)
347 *Example order*: +battery 0+
349 *Example format*: +%status %remaining (%emptytime %consumption)+
351 *Example format_down*: +No battery+
353 *Example status_chr*: +⚇ CHR+
355 *Example status_bat*: +⚡ BAT+
357 *Example status_full*: +☻ FULL+
359 *Example low_threshold*: +30+
361 *Example threshold_type*: +time+
363 *Example path*: +/sys/class/power_supply/CMB1/uevent+
367 Gets the temperature of the given thermal zone. It is possible to
368 define a max_threshold that will color the temperature red in case the
369 specified thermal zone is getting too hot. Defaults to 75 degrees C.
371 *Example order*: +cpu_temperature 0+
373 *Example format*: +T: %degrees °C+
375 *Example max_threshold*: +42+
377 *Example path*: +/sys/devices/platform/coretemp.0/temp1_input+
381 Gets the percentual CPU usage from +/proc/stat+ (Linux) or +sysctl(3)+ (FreeBSD/OpenBSD).
383 *Example order*: +cpu_usage+
385 *Example format*: +%usage+
389 Gets the system load (number of processes waiting for CPU time in the last
390 1, 5 and 15 minutes). It is possible to define a max_threshold that will
391 color the load value red in case the load average of the last minute is
392 getting higher than the configured threshold. Defaults to 5.
394 *Example order*: +load+
396 *Example format*: +%1min %5min %15min+
398 *Example max_threshold*: +"0,1"+
402 Outputs the current time in the local timezone.
403 To use a different timezone, you can set the TZ environment variable,
404 or use the +tztime+ module.
405 See +strftime(3)+ for details on the format string.
407 *Example order*: +time+
409 *Example format*: +%Y-%m-%d %H:%M:%S+
413 Outputs the current time in the given timezone.
414 If no timezone is given, local time will be used.
415 See +strftime(3)+ for details on the format string.
416 The system's timezone database is usually installed in +/usr/share/zoneinfo+.
417 Files below that path make for valid timezone strings, e.g. for
418 +/usr/share/zoneinfo/Europe/Berlin+ you can set timezone to +Europe/Berlin+
419 in the +tztime+ module.
421 *Example order*: +tztime berlin+
423 *Example format*: +%Y-%m-%d %H:%M:%S %Z+
425 *Example timezone*: +Europe/Berlin+
427 If you would like to use markup in this section, there is a separate
428 +format_time+ option that is automatically escaped. Its output then replaces
429 %time in the format string.
431 *Example configuration (markup)*:
432 -------------------------------------------------------------
434 format = "<span foreground='#ffffff'>time:</span> %time"
435 format_time = "%H:%M %Z"
437 -------------------------------------------------------------
441 Outputs the current discordian date in user-specified format. See +ddate(1)+ for
442 details on the format string.
443 *Note*: Neither *%.* nor *%X* are implemented yet.
445 *Example order*: +ddate+
447 *Example format*: +%{%a, %b %d%}, %Y%N - %H+
451 Outputs the volume of the specified mixer on the specified device. PulseAudio
452 and ALSA (Linux only) are supported. If PulseAudio is absent, a simplified
453 configuration can be used on FreeBSD and OpenBSD due to the lack of ALSA, the
454 +device+ and +mixer+ options can be ignored on these systems. On these systems
455 the OSS API is used instead to query +/dev/mixer+ directly if +mixer_idx+ is
456 -1, otherwise +/dev/mixer++mixer_idx+.
458 To get PulseAudio volume information, one must use the following format in the
467 where N is the index of the PulseAudio sink. If no sink is specified the
468 default is used. If the device string is missing or is set to "default",
469 PulseAudio will be tried if detected and will fallback to ALSA (Linux)
470 or OSS (FreeBSD/OpenBSD).
472 *Example order*: +volume master+
474 *Example format*: +♪: %volume+
476 *Example format_muted*: +♪: 0%%+
478 *Example configuration*:
479 -------------------------------------------------------------
481 format = "♪: %volume"
482 format_muted = "♪: muted (%volume)"
487 -------------------------------------------------------------
488 *Example configuration (PulseAudio)*:
489 -------------------------------------------------------------
491 format = "♪: %volume"
492 format_muted = "♪: muted (%volume)"
495 -------------------------------------------------------------
497 == Universal module options
499 When using the i3bar output format, there are a few additional options that
500 can be used with all modules to customize their appearance:
503 The alignment policy to use when the minimum width (see below) is not
504 reached. Either +center+ (default), +right+ or +left+.
506 The minimum width (in pixels) the module should occupy. If the module takes
507 less space than the specified size, the block will be padded to the left
508 and/or the right side, according to the defined alignment policy. This is
509 useful when you want to prevent the whole status line from shifting when
510 values take more or less space between each iteration.
511 The option can also be a string. In this case, the width of the given text
512 determines the minimum width of the block. This is useful when you want to
513 set a sensible minimum width regardless of which font you are using, and at
514 what particular size. Please note that a number enclosed with quotes will
515 still be treated as a number.
517 *Example configuration*:
518 -------------------------------------------------------------
524 -------------------------------------------------------------
526 == Using i3status with dzen2
528 After installing dzen2, you can directly use it with i3status. Just ensure that
529 +output_format+ is set to +dzen2+.
531 *Example for usage of i3status with dzen2*:
532 --------------------------------------------------------------
533 i3status | dzen2 -fg white -ta r -w 1280 \
534 -fn "-misc-fixed-medium-r-normal--13-120-75-75-C-70-iso8859-1"
535 --------------------------------------------------------------
537 == Using i3status with xmobar
539 To get xmobar to start, you might need to copy the default configuration
540 file to +~/.xmobarrc+. Also, ensure that the +output_format+ option for i3status
543 *Example for usage of i3status with xmobar*:
544 ---------------------------------------------------------------------
545 i3status | xmobar -o -t "%StdinReader%" -c "[Run StdinReader]"
546 ---------------------------------------------------------------------
548 == What about memory usage or CPU frequency?
550 While talking about two specific things, please understand this section as a
551 general explanation why your favorite information is not included in i3status.
553 Let’s talk about memory usage specifically. It is hard to measure memory in a
554 way which is accurate or meaningful. An in-depth understanding of how paging
555 and virtual memory work in your operating system is required. Furthermore, even
556 if we had a well-defined way of displaying memory usage and you would
557 understand it, I think that it’s not helpful to repeatedly monitor your memory
558 usage. One reason for that is that I have not run out of memory in the last few
559 years. Memory has become so cheap that even in my 4 year old notebook, I have
560 8 GiB of RAM. Another reason is that your operating system will do the right
561 thing anyway: Either you have not enough RAM for your workload, but you need to
562 do it anyway, then your operating system will swap. Or you don’t have enough
563 RAM and you want to restrict your workload so that it fits, then the operating
564 system will kill the process using too much RAM and you can act accordingly.
566 For CPU frequency, the situation is similar. Many people don’t understand how
567 frequency scaling works precisely. The generally recommended CPU frequency
568 governor ("ondemand") changes the CPU frequency far more often than i3status
569 could display it. The display number is therefore often incorrect and doesn’t
570 tell you anything useful either.
572 In general, i3status wants to display things which you would look at
573 occasionally anyways, like the current date/time, whether you are connected to
574 a WiFi network or not, and if you have enough disk space to fit that 4.3 GiB
577 However, if you need to look at some kind of information more than once in a
578 while (like checking repeatedly how full your RAM is), you are probably better
579 off with a script doing that, which pops up an alert when your RAM usage reaches
580 a certain threshold. After all, the point of computers is not to burden you
581 with additional boring tasks like repeatedly checking a number.
583 == External scripts/programs with i3status
585 In i3status, we don’t want to implement process management again. Therefore,
586 there is no module to run arbitrary scripts or commands. Instead, you should
587 use your shell, for example like this:
589 *Example for prepending the i3status output*:
590 --------------------------------------------------------------
592 # shell script to prepend i3status with more stuff
597 echo "mystuff | $line" || exit 1
599 --------------------------------------------------------------
601 Put that in some script, say +.bin/my_i3status.sh+ and execute that instead of i3status.
603 Note that if you want to use the JSON output format (with colors in i3bar), you
604 need to use a slightly more complex wrapper script. There are examples in the
605 contrib/ folder, see http://code.i3wm.org/i3status/tree/contrib
609 When receiving +SIGUSR1+, i3status’s nanosleep() will be interrupted and thus
610 you will force an update. You can use killall -USR1 i3status to force an update
611 after changing the system volume, for example.
615 +strftime(3)+, +date(1)+, +glob(3)+, +dzen2(1)+, +xmobar(1)+
619 Michael Stapelberg and contributors
627 Fernando Tarlá Cardoso Lemos