1 .de Vb \" Begin verbatim text
6 .de Ve \" End verbatim text
11 .TH i3status 1 "MAY 2009" Linux "User Manuals"
14 i3status \- Generates a status line for wmii
23 is a small program (around 500 SLOC) for filling wmii's status bar via its 9P
24 pseudo filesystem. It is designed to be very efficient by issuing a very
25 small number of systemcalls (as the bar should be updated every second or at
26 your specified interval). This ensures that even under high load, your status bar
27 is updated correctly and it saves a little bit of battery life by not spawning
28 new processes every second like shell scripts do.
33 Specifies the name of your WLAN interface (e.g. wlan0 or ath0 or eth1). Don't
34 specify if you don't have a WLAN interface or if it should not be displayed.
38 Specifies the name of your ethernet interface (e.g. eth0). Don't specify if you
39 don't have an ethernet interface or if it should not be displayed.
43 Specifies the path to the rbar-folder of your mounted wmii pseudo file system
44 (e.g. /mnt/wmii/rbar/). It has to be terminated by a slash.
48 Format for the time/date to be displayed. See strftime(3) or date(1). Don't
49 specify it if you don't want the time to be shown.
53 The number of the battery you want to display. This option can be specified
54 multiple times to display multiple batteries. Don't specify it if you don't
55 have a battery. To get the number of the specific battery, see
56 /sys/class/power_supply/BAT*
58 If you want i3status to use the last full capacity instead of the design capacity
59 of the battery, specify the f-flag, like this:
62 # Use the last full capacity
68 You can specify this directive multiple times. Each line first has a name (one
69 word, separated by space) followed by a path (can contain wildcards, given to
70 glob(3)). The path is the path to a PID-file which contains just the process ID
71 of a process. i3status will then check if the process is still running and
72 displays "yes" or "no" depending on the status. This is useful for displaying
73 if your VPN is running, or dhclient for DHCP and so on...
77 Followed by a comma separated list of the modules (run, wlan, eth, battery,
78 load, time) this directive specifies the order of the information which should
79 be displayed. An order is accomplished by prefixing the files in wmii's /rbar
80 directory with a number, that is 0VPN, 1DHCP, 2time and so on..
84 If specified, color mode is on. This affects WLAN which will be displayed red
85 if WLAN is down and the run_watch system which will display the status in
90 Get current speed of the ethernet interface using the same mechanism as
91 ethtool. You need to start i3status with root privileges to use this.
94 .B get_cpu_temperature
95 Gets the temperature of the first thermal zone or the specified thermal zone
96 (if any). Use it to display your CPU temperature.
100 Specifies the colors for background/border in the same format (html colorcodes)
101 as wmii's configuration (just the last two values), that is #222222 #333333 for
102 example. Text color will be determined automatically (red/green/#888888),
103 depending on context.
107 Specifies the interval in which the status bar will be updated. If you got a
108 very slow system or feel you don't need so much information, you may want to
113 .B /etc/i3status.conf
114 System-wide configuration file.
116 .SH EXAMPLE CONFIGURATION
121 \&wmii_path /mnt/wmii/rbar/
122 \&time_format %d.%m.%Y %H:%M:%S
125 \&run_watch DHCP /var/run/dhclient*.pid
126 \&run_watch VPN /var/run/vpnc*.pid
127 \&order run,wlan,eth,battery,load,time
128 \&normcolors #000000 #333333
130 \&get_cpu_temperature
133 .SH MOUNTING WMII'S PSEUDO FILESYSTEM
134 As of now (February 2009, Linux 2.6.28) you can mount wmii's 9P pseudo filesystem using:
137 mount -t 9p -o rw,trans=unix,uname=michael,dfltuid=1000,dfltgid=50,name=michael,noauto,noextend /tmp/ns.michael.:0/wmii /mnt/wmii
138 # Perhaps you need to load module 9pnet_fd if that does not work
143 Sometimes, i3status crashes when the wlan interface vanishes (killswitch). I
144 haven't yet found the bug, as it is not reproducible. If you can reproduce
145 this, please fix it and send me a patch.
153 Michael Stapelberg <michael+i3status at stapelberg dot de>
155 Thorsten Toepper <atsutane at freethoughts dot de>
158 See http://i3.zekjur.net/i3status for the newest release.