Default configuration paths ordered the same way as i3. Fixes #129 (#130)

[i3/i3status] / man / i3status.man

diff --git a/man/i3status.man b/man/i3status.man
index d550b812ce2fa0418116c6c8ae4c0edfdd3ed0c2..c43e4d325d6a607519ef4539611bca63a8aba3db 100644 (file)
--- a/man/i3status.man
+++ b/man/i3status.man
@@ -1,7 +1,7 @@
 i3status(1)
 ===========
 Michael Stapelberg <michael@i3wm.org>
-v2.9, March 2015
+v2.10, January 2016
 
 == NAME
 
@@ -17,10 +17,10 @@ i3status [-c configfile] [-h] [-v]
 Specifies an alternate configuration file path. By default, i3status looks for
 configuration files in the following order:
 
-1. ~/.i3status.conf
-2. ~/.config/i3status/config (or $XDG_CONFIG_HOME/i3status/config if set)
-3. /etc/i3status.conf
-4. /etc/xdg/i3status/config (or $XDG_CONFIG_DIRS/i3status/config if set)
+1. ~/.config/i3status/config (or $XDG_CONFIG_HOME/i3status/config if set)
+2. /etc/xdg/i3status/config (or $XDG_CONFIG_DIRS/i3status/config if set)
+3. ~/.i3status.conf
+4. /etc/i3status.conf
 
 == DESCRIPTION
 
@@ -74,8 +74,9 @@ ethernet eth0 {
 battery 0 {
         format = "%status %percentage %remaining %emptytime"
         format_down = "No battery"
-        status_chr = "⚇ CHR"
-        status_bat = "⚡ BAT"
+        status_chr = "⚡ CHR"
+        status_bat = "🔋 BAT"
+        status_unk = "? UNK"
         status_full = "☻ FULL"
         path = "/sys/class/power_supply/BAT%d/uevent"
         low_threshold = 10
@@ -184,6 +185,13 @@ format as the separator is drawn by i3bar directly otherwise. For the other
 output formats, the provided non-empty string will be automatically enclosed
 with the necessary coloring bits if color support is enabled.
 
+i3bar supports Pango markup, allowing your format strings to specify font
+color, size, etc. by setting the +markup+ directive to "pango". Note that the
+ampersand ("&"), less-than ("<"), greater-than (">"), single-quote ("'"), and
+double-quote (""") characters need to be replaced with "`&amp;`", "`&lt;`",
+"`&gt;`", "`&apos;`", and "`&quot;`" respectively. This is done automatically
+for generated content (e.g. wireless ESSID, time).
+
 *Example configuration*:
 -------------------------------------------------------------
 general {
@@ -308,7 +316,7 @@ network interface found on the system (excluding devices starting with "lo").
 
 === Battery
 
-Gets the status (charging, discharging, running), percentage, remaining
+Gets the status (charging, discharging, unknown, full), percentage, remaining
 time and power consumption (in Watts) of the given battery and when it's
 estimated to be empty. If you want to use the last full capacity instead of the
 design capacity (when using the design capacity, it may happen that your
@@ -332,10 +340,10 @@ colored red. The low_threshold type can be of threshold_type "time" or
 
 Optionally custom strings including any UTF-8 symbols can be used for different
 battery states. This makes it possible to display individual symbols
-for each state (charging, discharging, full)
+for each state (charging, discharging, unknown, full)
 Of course it will also work with special iconic fonts, such as FontAwesome.
-If any of this special status strings is omitted, the default (CHR, BAT, FULL)
-is used.
+If any of these special status strings are omitted, the default (CHR, BAT, UNK,
+FULL) is used.
 
 *Example order*: +battery 0+
 
@@ -343,9 +351,11 @@ is used.
 
 *Example format_down*: +No battery+
 
-*Example status_chr*: +⚇ CHR+
+*Example status_chr*: +⚡ CHR+
+
+*Example status_bat*: +🔋 BAT+
 
-*Example status_bat*: +⚡ BAT+
+*Example status_unk*: +? UNK+
 
 *Example status_full*: +☻ FULL+
 
@@ -417,6 +427,18 @@ in the +tztime+ module.
 
 *Example timezone*: +Europe/Berlin+
 
+If you would like to use markup in this section, there is a separate
++format_time+ option that is automatically escaped. Its output then replaces
+%time in the format string.
+
+*Example configuration (markup)*:
+-------------------------------------------------------------
+tztime time {
+       format = "<span foreground='#ffffff'>time:</span> %time"
+       format_time = "%H:%M %Z"
+}
+-------------------------------------------------------------
+
 === DDate
 
 Outputs the current discordian date in user-specified format. See +ddate(1)+ for
@@ -494,6 +516,15 @@ min_width::
        set a sensible minimum width regardless of which font you are using, and at
        what particular size. Please note that a number enclosed with quotes will
        still be treated as a number.
+separator::
+       A boolean value which specifies whether a separator line should be drawn
+       after this block. The default is true, meaning the separator line will be
+       drawn. Note that if you disable the separator line, there will still be a
+       gap after the block, unless you also use separator_block_width.
+separator_block_width::
+       The amount of pixels to leave blank after the block. In the middle of this
+       gap, a separator symbol will be drawn unless separator is disabled. This is
+       why the specified width should leave enough space for the separator symbol.
 
 *Example configuration*:
 -------------------------------------------------------------
@@ -501,6 +532,8 @@ disk "/" {
     format = "%avail"
     align = "left"
     min_width = 100
+    separator = false
+    separator_block_width = 1
 }
 -------------------------------------------------------------
 
@@ -583,7 +616,7 @@ Put that in some script, say +.bin/my_i3status.sh+ and execute that instead of i
 
 Note that if you want to use the JSON output format (with colors in i3bar), you
 need to use a slightly more complex wrapper script. There are examples in the
-contrib/ folder, see http://code.i3wm.org/i3status/tree/contrib
+contrib/ folder, see http://code.i3wm.org/i3status/tree/master/contrib
 
 == SIGNALS