Implemented a ddate-module

[i3/i3status] / man / i3status.man

diff --git a/man/i3status.man b/man/i3status.man
index eb16bf6434628fa1affead33204da0e0c01fe5b5..b7f362e950b7ff809848c73016ff884b53224dba 100644 (file)
--- a/man/i3status.man
+++ b/man/i3status.man
@@ -1,7 +1,7 @@
 i3status(1)
 ===========
 Michael Stapelberg <michael+i3@stapelberg.de>
-v2, October 2009
+v2.1, April 2010
 
 == NAME
 
@@ -21,7 +21,7 @@ or ~/.i3status.conf).
 
 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 systemcalls, as one generally wants to update
+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.
@@ -40,8 +40,9 @@ for a complete reference.
 .Sample configuration
 -------------------------------------------------------------
 general {
+        output_format = "dzen2"
         colors = true
-       interval = 5
+        interval = 5
 }
 
 order  = "ipv6"
@@ -61,12 +62,12 @@ wireless wlan0 {
 }
 
 ethernet eth0 {
-        # if you use %speed, i3status requires root privileges
+        # if you use %speed, i3status requires the cap_net_admin capability
         format = "E: %ip (%speed)"
 }
 
 battery 0 {
-        format = "%status %remaining"
+        format = "%status %percentage %remaining"
 }
 
 run_watch DHCP {
@@ -100,12 +101,27 @@ The colors directive will disable all colors if you set it to +false+.
 +interval+ is the time in seconds which i3status will sleep until printing
 the next status line.
 
+Using +output_format+ you can chose which format strings i3status should
+use in its output. Currently available are:
+
+dzen2::
+Dzen is a general purpose messaging, notification and menuing program for X11.
+It was designed to be scriptable in any language and integrate well with window
+managers like dwm, wmii and xmonad though it will work with any windowmanger
+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.
+
 === IPv6
 
 This module gets the IPv6 address used for outgoing connections (that is, the
 best available public IPv6 address on your computer).
 
-*Example format*: +%ip+
+*Example format_up*: +%ip+
+
+*Example format_down* +no IPv6+
 
 === Disk
 
@@ -136,7 +152,8 @@ connected.
 === Ethernet
 
 Gets the IP address and (if possible) the link speed of the given ethernet
-interface. Getting the link speed requires root privileges.
+interface. Getting the link speed requires the cap_net_admin capability. Set
+it using +setcap cap_net_admin=ep $(which i3status)+.
 
 *Example order*: +ethernet eth0+
 
@@ -180,6 +197,16 @@ Formats the current system time. See +strftime(3)+ for the format.
 
 *Example format*: +%Y-%m-%d %H:%M:%S+
 
+=== DDate
+
+Outputs the current discordian date in user-specified format. See +ddate(1)+ for
+details on the format string.
+*Note*: Neither *%.* nor *%X* are implemented yet.
+
+*Example order*: +ddate+
+
+*Example format*: +%{%a, %b %d%}, %Y%N - %H+
+
 == Using i3status with dzen2
 
 After installing dzen2, you can directly use it with i3status: