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