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

   1 i3status(1)
   2 ===========
   3 Michael Stapelberg <michael+i3@stapelberg.de>
   4 v2.1, April 2010
   5
   6 == NAME
   7
   8 i3status - Generates a status line for dzen2 or xmobar
   9
  10 == SYNOPSIS
  11
  12 i3status [-c configfile]
  13
  14 == OPTIONS
  15
  16 -c::
  17 Specifies an alternate configuration file path (default is /etc/i3status.conf
  18 or ~/.i3status.conf).
  19
  20 == DESCRIPTION
  21
  22 i3status is a small program (less than 1000 SLOC) for generating a status bar
  23 for dzen2, xmobar or similar programs. It is designed to be very efficient by
  24 issuing a very small number of system calls, as one generally wants to update
  25 such a status line every second. This ensures that even under high load, your
  26 status bar is updated correctly. Also, it saves a bit of energy by not hogging
  27 your CPU as much as spawning the corresponding amount of shell commands would.
  28
  29 == CONFIGURATION
  30
  31 Since version 2, the configuration file for i3status will be parsed using
  32 libconfuse. This makes configuration easier in the programmer’s point of
  33 view and more flexible for the user at the same time.
  34
  35 The basic idea of i3status is that you can specify which "modules" should
  36 be used (the order directive). You can then configure each module with its
  37 own section. For every module, you can specify the output format. See below
  38 for a complete reference.
  39
  40 .Sample configuration
  41 -------------------------------------------------------------
  42 general {
  43         output_format = "dzen2"
  44         colors = true
  45         interval = 5
  46 }
  47
  48 order  = "ipv6"
  49 order += "disk /"
  50 order += "run_watch DHCP"
  51 order += "run_watch VPN"
  52 order += "wireless wlan0"
  53 order += "ethernet eth0"
  54 order += "battery 0"
  55 order += "cpu_temperature 0"
  56 order += "load"
  57 order += "time"
  58
  59 wireless wlan0 {
  60         format_up = "W: (%quality at %essid) %ip"
  61         format_down = "W: down"
  62 }
  63
  64 ethernet eth0 {
  65         # if you use %speed, i3status requires the cap_net_admin capability
  66         format = "E: %ip (%speed)"
  67 }
  68
  69 battery 0 {
  70         format = "%status %percentage %remaining"
  71 }
  72
  73 run_watch DHCP {
  74         pidfile = "/var/run/dhclient*.pid"
  75 }
  76
  77 run_watch VPN {
  78         pidfile = "/var/run/vpnc/pid"
  79 }
  80
  81 time {
  82         format = "%Y-%m-%d %H:%M:%S"
  83 }
  84
  85 load {
  86         format = "%5min"
  87 }
  88
  89 cpu_temperature 0 {
  90         format = "T: %degrees °C"
  91 }
  92
  93 disk "/" {
  94         format = "%free"
  95 }
  96 -------------------------------------------------------------
  97
  98 === General
  99
 100 The colors directive will disable all colors if you set it to +false+.
 101 +interval+ is the time in seconds which i3status will sleep until printing
 102 the next status line.
 103
 104 Using +output_format+ you can chose which format strings i3status should
 105 use in its output. Currently available are:
 106
 107 dzen2::
 108 Dzen is a general purpose messaging, notification and menuing program for X11.
 109 It was designed to be scriptable in any language and integrate well with window
 110 managers like dwm, wmii and xmonad though it will work with any windowmanger
 111 xmobar::
 112 xmobar is a minimalistic, text based, status bar. It was designed to work
 113 with the xmonad Window Manager.
 114 none::
 115 Does not use any color codes. Separates values by the pipe symbol.
 116
 117 === IPv6
 118
 119 This module gets the IPv6 address used for outgoing connections (that is, the
 120 best available public IPv6 address on your computer).
 121
 122 *Example format_up*: +%ip+
 123
 124 *Example format_down* +no IPv6+
 125
 126 === Disk
 127
 128 Gets used, free, available and total amount of bytes on the given mounted filesystem.
 129
 130 *Example order*: +disk /mnt/usbstick+
 131
 132 *Example format*: +%free (%avail)/ %total+
 133
 134 === Run-watch
 135
 136 Expands the given path to a pidfile and checks if the process ID found inside
 137 is valid (that is, if the process is running). You can use this to check if
 138 a specific application, such as a VPN client or your DHCP client is running.
 139
 140 *Example order*: +run_watch DHCP+
 141
 142 === Wireless
 143
 144 Gets the link quality and ESSID of the given wireless network interface. You
 145 can specify different format strings for the network being connected or not
 146 connected.
 147
 148 *Example order*: +wireless wlan0+
 149
 150 *Example format*: +W: (%quality at %essid) %ip+
 151
 152 === Ethernet
 153
 154 Gets the IP address and (if possible) the link speed of the given ethernet
 155 interface. Getting the link speed requires the cap_net_admin capability. Set
 156 it using +setcap cap_net_admin=ep $(which i3status)+.
 157
 158 *Example order*: +ethernet eth0+
 159
 160 *Example format*: +E: %ip (%speed)+
 161
 162 === Battery
 163
 164 Gets the status (charging, discharging, running), percentage and remaining
 165 time of the given battery. If you want to use the last full capacity instead
 166 of the design capacity (when using the design capacity, it may happen that
 167 your battery is at 23% when fully charged because it’s old. In general, I
 168 want to see it this way, because it tells me how worn off my battery is.),
 169 just specify +last_full_capacity = true+.
 170
 171 *Example order*: +battery 0+
 172
 173 *Example format*: +%status %remaining+
 174
 175 === CPU-Temperature
 176
 177 Gets the temperature of the given thermal zone.
 178
 179 *Example order*: +cpu_temperature 0+
 180
 181 *Example format*: +T: %degrees °C+
 182
 183 === Load
 184
 185 Gets the system load (number of processes waiting for CPU time in the last
 186 5, 10 and 15 minutes).
 187
 188 *Example order*: +load+
 189
 190 *Example format*: +%5min %10min %15min+
 191
 192 === Time
 193
 194 Formats the current system time. See +strftime(3)+ for the format.
 195
 196 *Example order*: +time+
 197
 198 *Example format*: +%Y-%m-%d %H:%M:%S+
 199
 200 === DDate
 201
 202 Outputs the current discordian date in user-specified format. See +ddate(1)+ for
 203 details on the format string.
 204 *Note*: Neither *%.* nor *%X* are implemented yet.
 205
 206 *Example order*: +ddate+
 207
 208 *Example format*: +%{%a, %b %d%}, %Y%N - %H+
 209
 210 == Using i3status with dzen2
 211
 212 After installing dzen2, you can directly use it with i3status:
 213
 214 *Example for usage of i3status with dzen2*:
 215 --------------------------------------------------------------
 216 i3status | dzen2 -fg white -ta r -w 1280 \
 217 -fn "-misc-fixed-medium-r-normal--13-120-75-75-C-70-iso8859-1"
 218 --------------------------------------------------------------
 219
 220 == Using i3status with xmobar
 221
 222 To get xmobar to start, you might need to copy the default configuration
 223 file to +~/.xmobarrc+.
 224
 225 *Example for usage of i3status with xmobar*:
 226 ---------------------------------------------------------------------
 227 i3status-xmobar | xmobar -o -t "%StdinReader%" -c "[Run StdinReader]"
 228 ---------------------------------------------------------------------
 229
 230 == SEE ALSO
 231
 232 +strftime(3)+, +date(1)+, +glob(3)+, +dzen2(1)+, +xmobar(1)+
 233
 234 == AUTHORS
 235
 236 Michael Stapelberg and contributors
 237
 238 Thorsten Toepper
 239
 240 Baptiste Daroussin