git.sur5r.net Git - i3/i3status/blob - man/i3status.man

   1 i3status(1)
   2 ===========
   3 Michael Stapelberg <michael+i3@stapelberg.de>
   4 v2.4, December 2011
   5
   6 == NAME
   7
   8 i3status - Generates a status line for dzen2 or xmobar
   9
  10 == SYNOPSIS
  11
  12 i3status [-c configfile] [-h] [-v]
  13
  14 == OPTIONS
  15
  16 -c::
  17 Specifies an alternate configuration file path. By default, i3status looks for
  18 configuration files in the following order:
  19
  20 1. ~/.i3status.conf
  21 2. ~/.config/i3status/config (or $XDG_CONFIG_HOME/i3status/config if set)
  22 3. /etc/i3status.conf
  23 4. /etc/xdg/i3status/config (or $XDG_CONFIG_DIRS/i3status/config if set)
  24
  25 == DESCRIPTION
  26
  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
  33 commands would.
  34
  35 == CONFIGURATION
  36
  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.
  40
  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.
  45
  46 .Sample configuration
  47 -------------------------------------------------------------
  48 general {
  49         output_format = "dzen2"
  50         colors = true
  51         interval = 5
  52 }
  53
  54 order += "ipv6"
  55 order += "disk /"
  56 order += "run_watch DHCP"
  57 order += "run_watch VPN"
  58 order += "wireless wlan0"
  59 order += "ethernet eth0"
  60 order += "battery 0"
  61 order += "cpu_temperature 0"
  62 order += "load"
  63 order += "time"
  64
  65 wireless wlan0 {
  66         format_up = "W: (%quality at %essid, %bitrate) %ip"
  67         format_down = "W: down"
  68 }
  69
  70 ethernet eth0 {
  71         # if you use %speed, i3status requires the cap_net_admin capability
  72         format_up = "E: %ip (%speed)"
  73         format_down = "E: down"
  74 }
  75
  76 battery 0 {
  77         format = "%status %percentage %remaining"
  78         path = "/sys/class/power_supply/BAT%d/uevent"
  79 }
  80
  81 run_watch DHCP {
  82         pidfile = "/var/run/dhclient*.pid"
  83 }
  84
  85 run_watch VPN {
  86         pidfile = "/var/run/vpnc/pid"
  87 }
  88
  89 time {
  90         format = "%Y-%m-%d %H:%M:%S"
  91 }
  92
  93 load {
  94         format = "%5min"
  95 }
  96
  97 cpu_temperature 0 {
  98         format = "T: %degrees °C"
  99         path = "/sys/devices/platform/coretemp.0/temp1_input"
 100 }
 101
 102 disk "/" {
 103         format = "%free"
 104 }
 105 -------------------------------------------------------------
 106
 107 === General
 108
 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
 115 character ("#").
 116
 117 *Example configuration*:
 118 -------------------------------------------------------------
 119 color_good = "#00FF00"
 120 -------------------------------------------------------------
 121
 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.
 125
 126 The +interval+ directive specifies the time in seconds for which i3status will
 127 sleep before printing the next status line.
 128
 129 Using +output_format+ you can chose which format strings i3status should
 130 use in its output. Currently available are:
 131
 132 dzen2::
 133 Dzen is a general purpose messaging, notification and menuing program for X11.
 134 It was designed to be scriptable in any language and integrate well with window
 135 managers like dwm, wmii and xmonad though it will work with any windowmanger
 136 xmobar::
 137 xmobar is a minimalistic, text based, status bar. It was designed to work
 138 with the xmonad Window Manager.
 139 none::
 140 Does not use any color codes. Separates values by the pipe symbol. This should
 141 be used with i3bar and can be used for custom scripts.
 142
 143 === IPv6
 144
 145 This module gets the IPv6 address used for outgoing connections (that is, the
 146 best available public IPv6 address on your computer).
 147
 148 *Example format_up*: +%ip+
 149
 150 *Example format_down* +no IPv6+
 151
 152 === Disk
 153
 154 Gets used, free, available and total amount of bytes on the given mounted filesystem.
 155
 156 *Example order*: +disk /mnt/usbstick+
 157
 158 *Example format*: +%free (%avail)/ %total+
 159
 160 === Run-watch
 161
 162 Expands the given path to a pidfile and checks if the process ID found inside
 163 is valid (that is, if the process is running). You can use this to check if
 164 a specific application, such as a VPN client or your DHCP client is running.
 165
 166 *Example order*: +run_watch DHCP+
 167
 168 === Wireless
 169
 170 Gets the link quality and ESSID of the given wireless network interface. You
 171 can specify different format strings for the network being connected or not
 172 connected.
 173
 174 *Example order*: +wireless wlan0+
 175
 176 *Example format*: +W: (%quality at %essid, %bitrate) %ip+
 177
 178 === Ethernet
 179
 180 Gets the IP address and (if possible) the link speed of the given ethernet
 181 interface. Getting the link speed requires the cap_net_admin capability. Set
 182 it using +setcap cap_net_admin=ep $(which i3status)+.
 183
 184 *Example order*: +ethernet eth0+
 185
 186 *Example format*: +E: %ip (%speed)+
 187
 188 === Battery
 189
 190 Gets the status (charging, discharging, running), percentage and remaining
 191 time of the given battery. If you want to use the last full capacity instead
 192 of the design capacity (when using the design capacity, it may happen that
 193 your battery is at 23% when fully charged because it’s old. In general, I
 194 want to see it this way, because it tells me how worn off my battery is.),
 195 just specify +last_full_capacity = true+.
 196
 197 If your battery is represented in a non-standard path in /sys, be sure to
 198 modify the "path" property accordingly. The first occurence of %d gets replaced
 199 with the battery number, but you can just hard-code a path as well.
 200
 201 *Example order*: +battery 0+
 202
 203 *Example format*: +%status %remaining+
 204
 205 === CPU-Temperature
 206
 207 Gets the temperature of the given thermal zone.
 208
 209 *Example order*: +cpu_temperature 0+
 210
 211 *Example format*: +T: %degrees °C+
 212
 213 === CPU Usage
 214
 215 Gets the percentual CPU usage from +/proc/stat+.
 216
 217 *Example order*: +cpu_usage+
 218
 219 *Example format*: +%usage+
 220
 221 === Load
 222
 223 Gets the system load (number of processes waiting for CPU time in the last
 224 1, 5 and 15 minutes).
 225
 226 *Example order*: +load+
 227
 228 *Example format*: +%1min %5min %15min+
 229
 230 === Time
 231
 232 Formats the current system time. See +strftime(3)+ for the format.
 233
 234 *Example order*: +time+
 235
 236 *Example format*: +%Y-%m-%d %H:%M:%S+
 237
 238 === DDate
 239
 240 Outputs the current discordian date in user-specified format. See +ddate(1)+ for
 241 details on the format string.
 242 *Note*: Neither *%.* nor *%X* are implemented yet.
 243
 244 *Example order*: +ddate+
 245
 246 *Example format*: +%{%a, %b %d%}, %Y%N - %H+
 247
 248 === Volume
 249
 250 Outputs the volume of the specified mixer on the specified device. Works only
 251 on Linux because it uses ALSA.
 252
 253 *Example order*: +volume master+
 254
 255 *Example format*: +♪: %volume+
 256
 257 *Example configuration*:
 258 -------------------------------------------------------------
 259 volume master {
 260         format = "♪: %volume"
 261         device = "default"
 262         mixer = "Master"
 263         mixer_idx = 0
 264 }
 265 -------------------------------------------------------------
 266
 267 == Using i3status with dzen2
 268
 269 After installing dzen2, you can directly use it with i3status. Just ensure that
 270 +output_format+ is set to +dzen2+.
 271
 272 *Example for usage of i3status with dzen2*:
 273 --------------------------------------------------------------
 274 i3status | dzen2 -fg white -ta r -w 1280 \
 275 -fn "-misc-fixed-medium-r-normal--13-120-75-75-C-70-iso8859-1"
 276 --------------------------------------------------------------
 277
 278 == Using i3status with xmobar
 279
 280 To get xmobar to start, you might need to copy the default configuration
 281 file to +~/.xmobarrc+. Also, ensure that the +output_format+ option for i3status
 282 is set to +xmobar+.
 283
 284 *Example for usage of i3status with xmobar*:
 285 ---------------------------------------------------------------------
 286 i3status | xmobar -o -t "%StdinReader%" -c "[Run StdinReader]"
 287 ---------------------------------------------------------------------
 288
 289 == External scripts/programs with i3status
 290
 291 In i3status, we don’t want to implement process management again. Therefore,
 292 there is no module to run arbitrary scripts or commands. Instead, you should
 293 use your shell, for example like this:
 294
 295 *Example for prepending the i3status output*:
 296 --------------------------------------------------------------
 297 #!/bin/sh
 298 # shell script to prepend i3status with more stuff
 299
 300 i3status | while :
 301 do
 302         read line
 303         echo "mystuff | $line"
 304 done
 305 --------------------------------------------------------------
 306
 307 Put that in some script, say +.bin/my_i3status.sh+ and execute that instead of i3status.
 308
 309 == SEE ALSO
 310
 311 +strftime(3)+, +date(1)+, +glob(3)+, +dzen2(1)+, +xmobar(1)+
 312
 313 == AUTHORS
 314
 315 Michael Stapelberg and contributors
 316
 317 Thorsten Toepper
 318
 319 Baptiste Daroussin
 320
 321 Axel Wagner
 322
 323 Fernando Tarlá Cardoso Lemos