Don’t use a default setting for 'order'

[i3/i3status] / man / i3status.man

diff --git a/man/i3status.man b/man/i3status.man
index 57a991c85483c43ba875244744637f1635807937..b1564ff7b1219129401329f08fab68bb79d8719c 100644 (file)
--- a/man/i3status.man
+++ b/man/i3status.man
@@ -1,7 +1,7 @@
 i3status(1)
 ===========
 Michael Stapelberg <michael+i3@stapelberg.de>
-v2.2, September 2010
+v2.3, July 2011
 
 == NAME
 
@@ -17,19 +17,20 @@ i3status [-c configfile] [-h] [-v]
 Specifies an alternate configuration file path. By default, i3status looks for
 configuration files in the following order:
 
-1. ~/.i3status/config
+1. ~/.i3status.conf
 2. ~/.config/i3status/config (or $XDG_CONFIG_HOME/i3status/config if set)
-3. /etc/i3status/config
+3. /etc/i3status.conf
 4. /etc/xdg/i3status/config (or $XDG_CONFIG_DIRS/i3status/config if set)
 
 == DESCRIPTION
 
-i3status is a small program (less than 1000 SLOC) for generating a status bar
-for dzen2, xmobar or similar programs. It is designed to be very efficient by
-issuing a very small number of system calls, as one generally wants to update
-such a status line every second. This ensures that even under high load, your
-status bar is updated correctly. Also, it saves a bit of energy by not hogging
-your CPU as much as spawning the corresponding amount of shell commands would.
+i3status is a small program (about 1500 SLOC) for generating a status bar for
+i3bar, dzen2, xmobar or similar programs. It is designed to be very
+efficient by issuing a very small number of system calls, as one generally
+wants to update such a status line every second. This ensures that even under
+high load, your status bar is updated correctly. Also, it saves a bit of energy
+by not hogging your CPU as much as spawning the corresponding amount of shell
+commands would.
 
 == CONFIGURATION
 
@@ -50,7 +51,7 @@ general {
         interval = 5
 }
 
-order  = "ipv6"
+order += "ipv6"
 order += "disk /"
 order += "run_watch DHCP"
 order += "run_watch VPN"
@@ -68,7 +69,8 @@ wireless wlan0 {
 
 ethernet eth0 {
         # if you use %speed, i3status requires the cap_net_admin capability
-        format = "E: %ip (%speed)"
+        format_up = "E: %ip (%speed)"
+        format_down = "E: down"
 }
 
 battery 0 {
@@ -93,6 +95,7 @@ load {
 
 cpu_temperature 0 {
        format = "T: %degrees °C"
+       path = "/sys/devices/platform/coretemp.0/temp1_input"
 }
 
 disk "/" {
@@ -110,7 +113,10 @@ the +colors+ directive. The input format for color values is the canonical RGB
 hexadecimal triplet (with no separators between the colors), prefixed by a hash
 character ("#").
 
-*Example color_good*: +#00FF00+
+*Example configuration*:
+-------------------------------------------------------------
+color_good = "#00FF00"
+-------------------------------------------------------------
 
 Likewise, you can use the +color_separator+ directive to specify the color that
 will be used to paint the separator bar. The separator is always output in
@@ -130,7 +136,8 @@ xmobar::
 xmobar is a minimalistic, text based, status bar. It was designed to work
 with the xmonad Window Manager.
 none::
-Does not use any color codes. Separates values by the pipe symbol.
+Does not use any color codes. Separates values by the pipe symbol. This should
+be used with i3bar and can be used for custom scripts.
 
 === IPv6
 
@@ -198,14 +205,22 @@ Gets the temperature of the given thermal zone.
 
 *Example format*: +T: %degrees °C+
 
+=== CPU Usage
+
+Gets the percentual CPU usage from +/proc/stat+.
+
+*Example order*: +cpu_usage+
+
+*Example format*: +%usage+
+
 === Load
 
 Gets the system load (number of processes waiting for CPU time in the last
-5, 10 and 15 minutes).
+1, 5 and 15 minutes).
 
 *Example order*: +load+
 
-*Example format*: +%5min %10min %15min+
+*Example format*: +%1min %5min %15min+
 
 === Time
 
@@ -266,6 +281,21 @@ is set to +xmobar+.
 i3status | xmobar -o -t "%StdinReader%" -c "[Run StdinReader]"
 ---------------------------------------------------------------------
 
+== External scripts/programs with i3status
+
+In i3status, we don’t want to implement process management again. Therefore,
+there is no module to run arbitrary scripts or commands. Instead, you should
+use your shell, for example like this:
+
+*Example for prepending the i3status output*:
+--------------------------------------------------------------
+i3status | while :
+do
+       read line
+       echo "mystuff | $line"
+done | i3bar -d
+--------------------------------------------------------------
+
 == SEE ALSO
 
 +strftime(3)+, +date(1)+, +glob(3)+, +dzen2(1)+, +xmobar(1)+
@@ -277,3 +307,7 @@ Michael Stapelberg and contributors
 Thorsten Toepper
 
 Baptiste Daroussin
+
+Axel Wagner
+
+Fernando Tarlá Cardoso Lemos