git.sur5r.net Git - i3/i3status/blob - debian/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 "JUNE 2009" Linux "User Manuals"
  12
  13 .SH NAME
  14 i3status \- Generates a status line for dzen2
  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. It is designed to be
  24 very efficient by issuing a very small number of systemcalls (as the bar should
  25 be updated every second or at your specified interval). This ensures that even
  26 under high load, your status bar is updated correctly and it saves a little bit
  27 of battery life by not spawning new processes every second like shell scripts do.
  28
  29 .SH CONFIGURATION
  30 .TP
  31 .B wlan
  32 Specifies the name of your WLAN interface (e.g. wlan0 or ath0 or eth1). Don't
  33 specify if you don't have a WLAN interface or if it should not be displayed.
  34
  35 .TP
  36 .B eth
  37 Specifies the name of your ethernet interface (e.g. eth0). Don't specify if you
  38 don't have an ethernet interface or if it should not be displayed.
  39
  40 .TP
  41 .B time_format
  42 Format for the time/date to be displayed. See strftime(3) or date(1). Don't
  43 specify it if you don't want the time to be shown.
  44
  45 .TP
  46 .B battery
  47 The number of the battery you want to display. This option can be specified
  48 multiple times to display multiple batteries. Don't specify it if you don't
  49 have a battery. To get the number of the specific battery, see
  50 /sys/class/power_supply/BAT*
  51
  52 If you want i3status to use the last full capacity instead of the design capacity
  53 of the battery, specify the f-flag, like this:
  54
  55 .Vb 10
  56 # Use the last full capacity
  57 battery 0,f
  58 .Ve
  59
  60 .TP
  61 .B run_watch
  62 You can specify this directive multiple times. Each line first has a name (one
  63 word, separated by space) followed by a path (can contain wildcards, given to
  64 glob(3)). The path is the path to a PID-file which contains just the process ID
  65 of a process. i3status will then check if the process is still running and
  66 displays "yes" or "no" depending on the status. This is useful for displaying
  67 if your VPN is running, or dhclient for DHCP and so on...
  68
  69 .TP
  70 .B order
  71 Followed by a comma separated list of the modules (run, wlan, eth, battery,
  72 load, time) this directive specifies the order of the information which should
  73 be displayed. An order is accomplished by prefixing the files in wmii's /rbar
  74 directory with a number, that is 0VPN, 1DHCP, 2time and so on..
  75
  76 .TP
  77 .B color
  78 If specified, color mode is on. This affects WLAN which will be displayed red
  79 if WLAN is down and the run_watch system which will display the status in
  80 red/green.
  81
  82 .TP
  83 .B get_ethspeed
  84 Get current speed of the ethernet interface using the same mechanism as
  85 ethtool. You need to start i3status with root privileges to use this.
  86
  87 .TP
  88 .B get_cpu_temperature
  89 Gets the temperature of the first thermal zone or the specified thermal zone
  90 (if any). Use it to display your CPU temperature.
  91
  92 .TP
  93 .B normcolors
  94 Specifies the colors for background/border in the same format (html colorcodes)
  95 as wmii's configuration (just the last two values), that is #222222 #333333 for
  96 example. Text color will be determined automatically (red/green/#888888),
  97 depending on context.
  98
  99 .TP
 100 .B interval
 101 Specifies the interval in which the status bar will be updated. If you got a
 102 very slow system or feel you don't need so much information, you may want to
 103 increase it.
 104
 105 .SH FILES
 106 .TP
 107 .B /etc/i3status.conf
 108 System-wide configuration file.
 109
 110 .SH EXAMPLE CONFIGURATION
 111 .PP
 112 .Vb 10
 113 \&wlan wlan0
 114 \&eth eth0
 115 \&time_format %d.%m.%Y %H:%M:%S
 116 \&battery 0
 117 \&battery 1,f
 118 \&run_watch DHCP /var/run/dhclient*.pid
 119 \&run_watch VPN /var/run/vpnc*.pid
 120 \&order run,wlan,eth,battery,load,time
 121 \&normcolors #000000 #333333
 122 \&color
 123 \&get_cpu_temperature
 124 .Ve
 125
 126 .SH BUGS
 127 Sometimes, i3status crashes when the wlan interface vanishes (killswitch). I
 128 haven't yet found the bug, as it is not reproducible. If you can reproduce
 129 this, please fix it and send me a patch.
 130
 131 .SH SEE ALSO
 132 .BR strftime (3),
 133 .BR date (1),
 134 .BR glob (3)
 135
 136 .SH AUTHORS
 137 Michael Stapelberg <michael+i3status at stapelberg dot de>
 138
 139 Thorsten Toepper <atsutane at freethoughts dot de>
 140
 141 .SH WEBSITE
 142 See http://i3.zekjur.net/i3status for the newest release.