Merge pull request #72 from ixjlyons/pango-setting

[i3/i3status] / man / i3status.man

diff --git a/man/i3status.man b/man/i3status.man
index d550b812ce2fa0418116c6c8ae4c0edfdd3ed0c2..0b5b36765b0e7088492a368adc7e7450790b853c 100644 (file)
--- a/man/i3status.man
+++ b/man/i3status.man
@@ -184,6 +184,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 {
@@ -417,6 +424,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