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

   1 .de Vb \" Begin verbatim text
   2 .ft CW
   3 .nf
   4 .ne \\$1
   5 ..
   6 .de Ve \" End verbatim text
   7 .ft R
   8 .fi
   9 ..
  10
  11 .TH i3status 1 "APRIL 2009" Linux "User Manuals"
  12
  13 .SH NAME
  14 i3status \- Generates a status line for dzen2 or wmii
  15 .SH SYNOPSIS
  16 .B i3status
  17 .RB [\|\-c
  18 .IR configfile \|]
  19
  20 .SH DESCRIPTION
  21
  22 .B i3status
  23 is a small program (around 500 SLOC) for filling dzen2 or wmii's status bar via
  24 its 9P 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.
  29
  30 .SH CONFIGURATION
  31 .TP
  32 .B wlan
  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.
  35
  36 .TP
  37 .B eth
  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.
  40
  41 .TP
  42 .B wmii_path
  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.
  45
  46 .TP
  47 .B time_format
  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.
  50
  51 .TP
  52 .B battery_path
  53 The path to your battery's uevent file in /sys, e.g.
  54 /sys/class/power_supply/BAT0/uevent. You can specify this directive multiple
  55 times to display data of more than one battery. Don't specify if you don't have
  56 a battery.
  57
  58 .TP
  59 .B run_watch
  60 You can specify this directive multiple times. Each line first has a name (one
  61 word, separated by space) followed by a path (can contain wildcards, given to
  62 glob(3)). The path is the path to a PID-file which contains just the process ID
  63 of a process. i3status will then check if the process is still running and
  64 displays "yes" or "no" depending on the status. This is useful for displaying
  65 if your VPN is running, or dhclient for DHCP and so on...
  66
  67 .TP
  68 .B order
  69 Followed by a comma separated list of the modules (run, wlan, eth, battery,
  70 load, time) this directive specifies the order of the information which should
  71 be displayed. An order is accomplished by prefixing the files in wmii's /rbar
  72 directory with a number, that is 0VPN, 1DHCP, 2time and so on..
  73
  74 .TP
  75 .B color
  76 If specified, color mode is on. This affects WLAN which will be displayed red
  77 if WLAN is down and the run_watch system which will display the status in
  78 red/green.
  79
  80 .TP
  81 .B get_ethspeed
  82 Get current speed of the ethernet interface using the same mechanism as
  83 ethtool. You need to start i3status with root privileges to use this.
  84
  85 .TP
  86 .B normcolors
  87 Specifies the colors for background/border in the same format (html colorcodes)
  88 as wmii's configuration (just the last two values), that is #222222 #333333 for
  89 example. Text color will be determined automatically (red/green/#888888),
  90 depending on context.
  91
  92 .TP
  93 .B interval
  94 Specifies the interval in which the status bar will be updated. If you got a
  95 very slow system or feel you don't need so much information, you may want to
  96 increase it.
  97
  98 .SH FILES
  99 .TP
 100 .B /etc/i3status.conf
 101 System-wide configuration file.
 102
 103 .SH EXAMPLE CONFIGURATION
 104 .PP
 105 .Vb 10
 106 \&wlan wlan0
 107 \&eth eth0
 108 \&wmii_path /mnt/wmii/rbar/
 109 \&time_format %d.%m.%Y %H:%M:%S
 110 \&battery_path /sys/class/power_supply/BAT0/uevent
 111 \&run_watch DHCP /var/run/dhclient*.pid
 112 \&run_watch VPN /var/run/vpnc*.pid
 113 \&order run,wlan,eth,battery,load,time
 114 \&normcolors #000000 #333333
 115 \&color
 116 .Ve
 117
 118 .SH MOUNTING WMII'S PSEUDO FILESYSTEM
 119 As of now (February 2009, Linux 2.6.28) you can mount wmii's 9P pseudo filesystem using:
 120 .PP
 121 .Vb 3
 122 mount -t 9p -o rw,trans=unix,uname=michael,dfltuid=1000,dfltgid=50,name=michael,noauto,noextend /tmp/ns.michael.:0/wmii /mnt/wmii
 123 # Perhaps you need to load module 9pnet_fd if that does not work
 124 modprobe 9pnet_fd
 125 .Ve
 126
 127 .SH BUGS
 128 Sometimes, i3status crashes when the wlan interface vanishes (killswitch). I
 129 haven't yet found the bug, as it is not reproducible. If you can reproduce
 130 this, please fix it and send me a patch.
 131
 132 .SH SEE ALSO
 133 .BR strftime (3),
 134 .BR date (1),
 135 .BR glob (3)
 136
 137 .SH AUTHOR
 138 Michael Stapelberg <michael+i3status at stapelberg dot de>
 139
 140 .SH WEBSITE
 141 See http://michael.stapelberg.de/i3status for the newest release.