Merge pull request #72 from ixjlyons/pango-setting

[i3/i3status] / man / i3status.man

diff --git a/man/i3status.man b/man/i3status.man
index a3a8c60e97d4dc58ebe458f84d860862bca87088..0b5b36765b0e7088492a368adc7e7450790b853c 100644 (file)
--- a/man/i3status.man
+++ b/man/i3status.man
@@ -5,7 +5,7 @@ v2.9, March 2015
 
 == NAME
 
-i3status - Generates a status line for i3bar, dzen2 or xmobar
+i3status - Generates a status line for i3bar, dzen2, xmobar or lemonbar
 
 == SYNOPSIS
 
@@ -25,7 +25,7 @@ configuration files in the following order:
 == DESCRIPTION
 
 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
+i3bar, dzen2, xmobar, lemonbar 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
@@ -157,6 +157,9 @@ 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.
+lemonbar::
+lemonbar is a lightweight bar based entirely on XCB. It has full UTF-8 support
+and is EWMH compliant.
 term::
 Use ANSI Escape sequences to produce a terminal-output as close as possible to
 the graphical outputs. This makes debugging your config file a little bit
@@ -181,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 {
@@ -238,7 +248,7 @@ is assumed to be "percentage_avail" and low_threshold to be set to 0, which
 implies no coloring at all.
 
 You can define a different format with the option "format_not_mounted"
-which is used if the path is not a mount point. So you can just empty
+which is used if the path does not exist or is not a mount point. So you can just empty
 the output for the given path with adding +format_not_mounted=""+
 to the config section.
 
@@ -414,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