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

   1 i3status(1)
   2 ===========
   3 Michael Stapelberg <michael+i3@stapelberg.de>
   4 v2, October 2009
   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 systemcalls, 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 root privileges
  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*: +%ip+
 123
 124 === Disk
 125
 126 Gets used, free and total amount of bytes on the given mounted filesystem.
 127
 128 *Example order*: +disk /mnt/usbstick+
 129
 130 *Example format*: +%free / %total+
 131
 132 === Run-watch
 133
 134 Expands the given path to a pidfile and checks if the process ID found inside
 135 is valid (that is, if the process is running). You can use this to check if
 136 a specific application, such as a VPN client or your DHCP client is running.
 137
 138 *Example order*: +run_watch DHCP+
 139
 140 === Wireless
 141
 142 Gets the link quality and ESSID of the given wireless network interface. You
 143 can specify different format strings for the network being connected or not
 144 connected.
 145
 146 *Example order*: +wireless wlan0+
 147
 148 *Example format*: +W: (%quality at %essid) %ip+
 149
 150 === Ethernet
 151
 152 Gets the IP address and (if possible) the link speed of the given ethernet
 153 interface. Getting the link speed requires root privileges.
 154
 155 *Example order*: +ethernet eth0+
 156
 157 *Example format*: +E: %ip (%speed)+
 158
 159 === Battery
 160
 161 Gets the status (charging, discharging, running), percentage and remaining
 162 time of the given battery. If you want to use the last full capacity instead
 163 of the design capacity (when using the design capacity, it may happen that
 164 your battery is at 23% when fully charged because it’s old. In general, I
 165 want to see it this way, because it tells me how worn off my battery is.),
 166 just specify +last_full_capacity = true+.
 167
 168 *Example order*: +battery 0+
 169
 170 *Example format*: +%status %remaining+
 171
 172 === CPU-Temperature
 173
 174 Gets the temperature of the given thermal zone.
 175
 176 *Example order*: +cpu_temperature 0+
 177
 178 *Example format*: +T: %degrees °C+
 179
 180 === Load
 181
 182 Gets the system load (number of processes waiting for CPU time in the last
 183 5, 10 and 15 minutes).
 184
 185 *Example order*: +load+
 186
 187 *Example format*: +%5min %10min %15min+
 188
 189 === Time
 190
 191 Formats the current system time. See +strftime(3)+ for the format.
 192
 193 *Example order*: +time+
 194
 195 *Example format*: +%Y-%m-%d %H:%M:%S+
 196
 197 == Using i3status with dzen2
 198
 199 After installing dzen2, you can directly use it with i3status:
 200
 201 *Example for usage of i3status with dzen2*:
 202 --------------------------------------------------------------
 203 i3status | dzen2 -fg white -ta r -w 1280 \
 204 -fn "-misc-fixed-medium-r-normal--13-120-75-75-C-70-iso8859-1"
 205 --------------------------------------------------------------
 206
 207 == Using i3status with xmobar
 208
 209 To get xmobar to start, you might need to copy the default configuration
 210 file to +~/.xmobarrc+.
 211
 212 *Example for usage of i3status with xmobar*:
 213 ---------------------------------------------------------------------
 214 i3status-xmobar | xmobar -o -t "%StdinReader%" -c "[Run StdinReader]"
 215 ---------------------------------------------------------------------
 216
 217 == SEE ALSO
 218
 219 +strftime(3)+, +date(1)+, +glob(3)+, +dzen2(1)+, +xmobar(1)+
 220
 221 == AUTHORS
 222
 223 Michael Stapelberg and contributors
 224
 225 Thorsten Toepper
 226
 227 Baptiste Daroussin