]> git.sur5r.net Git - i3/i3.github.io/commitdiff
add i3status manpage
authorMichael Stapelberg <michael@stapelberg.de>
Fri, 22 Jul 2011 20:32:19 +0000 (22:32 +0200)
committerMichael Stapelberg <michael@stapelberg.de>
Fri, 22 Jul 2011 20:32:19 +0000 (22:32 +0200)
_docs/Makefile
_docs/i3status.man [new file with mode: 0644]
i3status/manpage.html [new file with mode: 0644]

index 8914d06c1aa924e5fd5b20e069f16f339fb668fb..4be3918591df4679d985a9cebd39208ea879b98e 100644 (file)
@@ -1,5 +1,5 @@
 
-all: hacking-howto.html debugging.html userguide.html ipc.html multi-monitor.html wsbar.html tree-migrating.html
+all: hacking-howto.html debugging.html userguide.html ipc.html multi-monitor.html wsbar.html tree-migrating.html i3status.html
 
 hacking-howto.html: hacking-howto
        asciidoc -a linkcss -a stylesdir=/css -a scriptsdir=/js --backend=xhtml11 -f conf/i3html.conf -a toc -n $<
@@ -22,6 +22,9 @@ multi-monitor.html: multi-monitor
 wsbar.html: wsbar
        asciidoc -a linkcss -a stylesdir=/css -a scriptsdir=/js --backend=xhtml11 -f conf/i3html.conf -a toc -n $<
 
+i3status.html: i3status.man
+       asciidoc -a linkcss -a stylesdir=/css -a scriptsdir=/js --backend=xhtml11 -f conf/i3html.conf -a toc -n $<
+
 clean:
        rm -f */*.{aux,log,toc,bm,pdf,dvi}
        rm -f *.log *.html
diff --git a/_docs/i3status.man b/_docs/i3status.man
new file mode 100644 (file)
index 0000000..0c81f16
--- /dev/null
@@ -0,0 +1,298 @@
+i3status(1)
+===========
+Michael Stapelberg <michael+i3@stapelberg.de>
+v2.3, July 2011
+
+== NAME
+
+i3status - Generates a status line for dzen2 or xmobar
+
+== SYNOPSIS
+
+i3status [-c configfile] [-h] [-v]
+
+== OPTIONS
+
+-c::
+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)
+
+== 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
+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
+
+Since version 2, the configuration file for i3status will be parsed using
+libconfuse. This makes configuration easier in the programmer’s point of
+view and more flexible for the user at the same time.
+
+The basic idea of i3status is that you can specify which "modules" should
+be used (the order directive). You can then configure each module with its
+own section. For every module, you can specify the output format. See below
+for a complete reference.
+
+.Sample configuration
+-------------------------------------------------------------
+general {
+        output_format = "dzen2"
+        colors = true
+        interval = 5
+}
+
+order  = "ipv6"
+order += "disk /"
+order += "run_watch DHCP"
+order += "run_watch VPN"
+order += "wireless wlan0"
+order += "ethernet eth0"
+order += "battery 0"
+order += "cpu_temperature 0"
+order += "load"
+order += "time"
+
+wireless wlan0 {
+        format_up = "W: (%quality at %essid, %bitrate) %ip"
+        format_down = "W: down"
+}
+
+ethernet eth0 {
+        # if you use %speed, i3status requires the cap_net_admin capability
+        format_up = "E: %ip (%speed)"
+        format_down = "E: down"
+}
+
+battery 0 {
+        format = "%status %percentage %remaining"
+}
+
+run_watch DHCP {
+        pidfile = "/var/run/dhclient*.pid"
+}
+
+run_watch VPN {
+        pidfile = "/var/run/vpnc/pid"
+}
+
+time {
+       format = "%Y-%m-%d %H:%M:%S"
+}
+
+load {
+       format = "%5min"
+}
+
+cpu_temperature 0 {
+       format = "T: %degrees °C"
+       path = "/sys/devices/platform/coretemp.0/temp1_input"
+}
+
+disk "/" {
+       format = "%free"
+}
+-------------------------------------------------------------
+
+=== General
+
+The +colors+ directive will disable all colors if you set it to +false+. You can
+also specify the colors that will be used to display "good", "degraded" or "bad"
+values using the +color_good+, +color_degraded+ or +color_bad+ directives,
+respectively. Those directives are only used if color support is not disabled by
+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 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
+color, even when colors are disabled by the +colors+ directive.
+
+The +interval+ directive specifies the time in seconds for which i3status will
+sleep before 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. This should
+be used with i3bar and can be used for custom scripts.
+
+=== IPv6
+
+This module gets the IPv6 address used for outgoing connections (that is, the
+best available public IPv6 address on your computer).
+
+*Example format_up*: +%ip+
+
+*Example format_down* +no IPv6+
+
+=== Disk
+
+Gets used, free, available and total amount of bytes on the given mounted filesystem.
+
+*Example order*: +disk /mnt/usbstick+
+
+*Example format*: +%free (%avail)/ %total+
+
+=== Run-watch
+
+Expands the given path to a pidfile and checks if the process ID found inside
+is valid (that is, if the process is running). You can use this to check if
+a specific application, such as a VPN client or your DHCP client is running.
+
+*Example order*: +run_watch DHCP+
+
+=== Wireless
+
+Gets the link quality and ESSID of the given wireless network interface. You
+can specify different format strings for the network being connected or not
+connected.
+
+*Example order*: +wireless wlan0+
+
+*Example format*: +W: (%quality at %essid, %bitrate) %ip+
+
+=== Ethernet
+
+Gets the IP address and (if possible) the link speed of the given ethernet
+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+
+
+*Example format*: +E: %ip (%speed)+
+
+=== Battery
+
+Gets the status (charging, discharging, running), percentage and remaining
+time of the given battery. If you want to use the last full capacity instead
+of the design capacity (when using the design capacity, it may happen that
+your battery is at 23% when fully charged because it’s old. In general, I
+want to see it this way, because it tells me how worn off my battery is.),
+just specify +last_full_capacity = true+.
+
+*Example order*: +battery 0+
+
+*Example format*: +%status %remaining+
+
+=== CPU-Temperature
+
+Gets the temperature of the given thermal zone.
+
+*Example order*: +cpu_temperature 0+
+
+*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).
+
+*Example order*: +load+
+
+*Example format*: +%5min %10min %15min+
+
+=== Time
+
+Formats the current system time. See +strftime(3)+ for the format.
+
+*Example order*: +time+
+
+*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+
+
+=== Volume
+
+Outputs the volume of the specified mixer on the specified device. Works only
+on Linux because it uses ALSA.
+
+*Example order*: +volume master+
+
+*Example format*: +♪: %volume+
+
+*Example configuration*:
+-------------------------------------------------------------
+volume master {
+       format = "♪: %volume"
+       device = "default"
+       mixer = "Master"
+       mixer_idx = 0
+}
+-------------------------------------------------------------
+
+== Using i3status with dzen2
+
+After installing dzen2, you can directly use it with i3status. Just ensure that
++output_format+ is set to +dzen2+.
+
+*Example for usage of i3status with dzen2*:
+--------------------------------------------------------------
+i3status | dzen2 -fg white -ta r -w 1280 \
+-fn "-misc-fixed-medium-r-normal--13-120-75-75-C-70-iso8859-1"
+--------------------------------------------------------------
+
+== Using i3status with xmobar
+
+To get xmobar to start, you might need to copy the default configuration
+file to +~/.xmobarrc+. Also, ensure that the +output_format+ option for i3status
+is set to +xmobar+.
+
+*Example for usage of i3status with xmobar*:
+---------------------------------------------------------------------
+i3status | xmobar -o -t "%StdinReader%" -c "[Run StdinReader]"
+---------------------------------------------------------------------
+
+== SEE ALSO
+
++strftime(3)+, +date(1)+, +glob(3)+, +dzen2(1)+, +xmobar(1)+
+
+== AUTHORS
+
+Michael Stapelberg and contributors
+
+Thorsten Toepper
+
+Baptiste Daroussin
+
+Axel Wagner
+
+Fernando Tarlá Cardoso Lemos
diff --git a/i3status/manpage.html b/i3status/manpage.html
new file mode 100644 (file)
index 0000000..b2402fa
--- /dev/null
@@ -0,0 +1,371 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"\r
+    "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">\r
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">\r
+<head>\r
+<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />\r
+<meta name="generator" content="AsciiDoc 8.6.4" />\r
+<title>i3: i3status(1)</title>\r
+<link rel="stylesheet" href="/css/style.css" type="text/css" />\r
+<link rel="stylesheet" href="/css/xhtml11.css" type="text/css" />\r
+<script type="text/javascript">\r
+/*<![CDATA[*/\r
+window.onload = function(){asciidoc.footnotes(); asciidoc.toc(2);}\r
+/*]]>*/\r
+</script>\r
+<script type="text/javascript" src="/js/asciidoc-xhtml11.js"></script>\r
+</head>\r
+<body class="article">\r
+\r
+        <div id="main">\r
+            <a href="/"><h1 id="title">i3 - improved tiling WM</h1></a>\r
+                        <ul id="nav">\r
+                                <li><a style="border-bottom: 2px solid #fff" href="/docs">Docs</a></li>\r
+                                <li><a href="/screenshots">Screens</a></li>\r
+                                <li><a href="/contact">Contact</a></li>\r
+                                <li><a href="http://bugs.i3wm.org/">Bugs</a></li>\r
+                        </ul>\r
+        <br style="clear: both">\r
+<div id="content">\r
+<div id="header">\r
+<h1>i3status(1)</h1>\r
+<span id="author">Michael Stapelberg</span><br />\r
+<span id="email"><tt>&lt;<a href="mailto:michael+i3@stapelberg.de">michael+i3@stapelberg.de</a>&gt;</tt></span><br />\r
+<span id="revnumber">version 2.3,</span>\r
+<span id="revdate">July 2011</span>\r
+<div id="toc">
+  <div id="toctitle">Table of Contents</div>
+  <noscript><p><b>JavaScript must be enabled in your browser to display the table of contents.</b></p></noscript>
+</div>\r
+</div>\r
+<div class="sect1">\r
+<h2 id="_name">1. NAME</h2>\r
+<div class="sectionbody">\r
+<div class="paragraph"><p>i3status - Generates a status line for dzen2 or xmobar</p></div>\r
+</div>\r
+</div>\r
+<div class="sect1">\r
+<h2 id="_synopsis">2. SYNOPSIS</h2>\r
+<div class="sectionbody">\r
+<div class="paragraph"><p>i3status [-c configfile] [-h] [-v]</p></div>\r
+</div>\r
+</div>\r
+<div class="sect1">\r
+<h2 id="_options">3. OPTIONS</h2>\r
+<div class="sectionbody">\r
+<div class="dlist"><dl>\r
+<dt class="hdlist1">\r
+-c\r
+</dt>\r
+<dd>\r
+<p>\r
+Specifies an alternate configuration file path. By default, i3status looks for\r
+configuration files in the following order:\r
+</p>\r
+<div class="olist arabic"><ol class="arabic">\r
+<li>\r
+<p>\r
+~/.i3status.conf\r
+</p>\r
+</li>\r
+<li>\r
+<p>\r
+~/.config/i3status/config (or $XDG_CONFIG_HOME/i3status/config if set)\r
+</p>\r
+</li>\r
+<li>\r
+<p>\r
+/etc/i3status.conf\r
+</p>\r
+</li>\r
+<li>\r
+<p>\r
+/etc/xdg/i3status/config (or $XDG_CONFIG_DIRS/i3status/config if set)\r
+</p>\r
+</li>\r
+</ol></div>\r
+</dd>\r
+</dl></div>\r
+</div>\r
+</div>\r
+<div class="sect1">\r
+<h2 id="_description">4. DESCRIPTION</h2>\r
+<div class="sectionbody">\r
+<div class="paragraph"><p>i3status is a small program (about 1500 SLOC) for generating a status bar for\r
+i3bar, dzen2, xmobar or similar programs. It is designed to be very\r
+efficient by issuing a very small number of system calls, as one generally\r
+wants to update such a status line every second. This ensures that even under\r
+high load, your status bar is updated correctly. Also, it saves a bit of energy\r
+by not hogging your CPU as much as spawning the corresponding amount of shell\r
+commands would.</p></div>\r
+</div>\r
+</div>\r
+<div class="sect1">\r
+<h2 id="_configuration">5. CONFIGURATION</h2>\r
+<div class="sectionbody">\r
+<div class="paragraph"><p>Since version 2, the configuration file for i3status will be parsed using\r
+libconfuse. This makes configuration easier in the programmer’s point of\r
+view and more flexible for the user at the same time.</p></div>\r
+<div class="paragraph"><p>The basic idea of i3status is that you can specify which "modules" should\r
+be used (the order directive). You can then configure each module with its\r
+own section. For every module, you can specify the output format. See below\r
+for a complete reference.</p></div>\r
+<div class="listingblock">\r
+<div class="title">Sample configuration</div>\r
+<div class="content">\r
+<pre><tt>general {\r
+        output_format = "dzen2"\r
+        colors = true\r
+        interval = 5\r
+}\r
+\r
+order  = "ipv6"\r
+order += "disk /"\r
+order += "run_watch DHCP"\r
+order += "run_watch VPN"\r
+order += "wireless wlan0"\r
+order += "ethernet eth0"\r
+order += "battery 0"\r
+order += "cpu_temperature 0"\r
+order += "load"\r
+order += "time"\r
+\r
+wireless wlan0 {\r
+        format_up = "W: (%quality at %essid, %bitrate) %ip"\r
+        format_down = "W: down"\r
+}\r
+\r
+ethernet eth0 {\r
+        # if you use %speed, i3status requires the cap_net_admin capability\r
+        format_up = "E: %ip (%speed)"\r
+        format_down = "E: down"\r
+}\r
+\r
+battery 0 {\r
+        format = "%status %percentage %remaining"\r
+}\r
+\r
+run_watch DHCP {\r
+        pidfile = "/var/run/dhclient*.pid"\r
+}\r
+\r
+run_watch VPN {\r
+        pidfile = "/var/run/vpnc/pid"\r
+}\r
+\r
+time {\r
+        format = "%Y-%m-%d %H:%M:%S"\r
+}\r
+\r
+load {\r
+        format = "%5min"\r
+}\r
+\r
+cpu_temperature 0 {\r
+        format = "T: %degrees °C"\r
+        path = "/sys/devices/platform/coretemp.0/temp1_input"\r
+}\r
+\r
+disk "/" {\r
+        format = "%free"\r
+}</tt></pre>\r
+</div></div>\r
+<div class="sect2">\r
+<h3 id="_general">5.1. General</h3>\r
+<div class="paragraph"><p>The <tt>colors</tt> directive will disable all colors if you set it to <tt>false</tt>. You can\r
+also specify the colors that will be used to display "good", "degraded" or "bad"\r
+values using the <tt>color_good</tt>, <tt>color_degraded</tt> or <tt>color_bad</tt> directives,\r
+respectively. Those directives are only used if color support is not disabled by\r
+the <tt>colors</tt> directive. The input format for color values is the canonical RGB\r
+hexadecimal triplet (with no separators between the colors), prefixed by a hash\r
+character ("#").</p></div>\r
+<div class="paragraph"><p><strong>Example configuration</strong>:</p></div>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt>color_good = "#00FF00"</tt></pre>\r
+</div></div>\r
+<div class="paragraph"><p>Likewise, you can use the <tt>color_separator</tt> directive to specify the color that\r
+will be used to paint the separator bar. The separator is always output in\r
+color, even when colors are disabled by the <tt>colors</tt> directive.</p></div>\r
+<div class="paragraph"><p>The <tt>interval</tt> directive specifies the time in seconds for which i3status will\r
+sleep before printing the next status line.</p></div>\r
+<div class="paragraph"><p>Using <tt>output_format</tt> you can chose which format strings i3status should\r
+use in its output. Currently available are:</p></div>\r
+<div class="dlist"><dl>\r
+<dt class="hdlist1">\r
+dzen2\r
+</dt>\r
+<dd>\r
+<p>\r
+Dzen is a general purpose messaging, notification and menuing program for X11.\r
+It was designed to be scriptable in any language and integrate well with window\r
+managers like dwm, wmii and xmonad though it will work with any windowmanger\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+xmobar\r
+</dt>\r
+<dd>\r
+<p>\r
+xmobar is a minimalistic, text based, status bar. It was designed to work\r
+with the xmonad Window Manager.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+none\r
+</dt>\r
+<dd>\r
+<p>\r
+Does not use any color codes. Separates values by the pipe symbol. This should\r
+be used with i3bar and can be used for custom scripts.\r
+</p>\r
+</dd>\r
+</dl></div>\r
+</div>\r
+<div class="sect2">\r
+<h3 id="_ipv6">5.2. IPv6</h3>\r
+<div class="paragraph"><p>This module gets the IPv6 address used for outgoing connections (that is, the\r
+best available public IPv6 address on your computer).</p></div>\r
+<div class="paragraph"><p><strong>Example format_up</strong>: <tt>%ip</tt></p></div>\r
+<div class="paragraph"><p><strong>Example format_down</strong> <tt>no IPv6</tt></p></div>\r
+</div>\r
+<div class="sect2">\r
+<h3 id="_disk">5.3. Disk</h3>\r
+<div class="paragraph"><p>Gets used, free, available and total amount of bytes on the given mounted filesystem.</p></div>\r
+<div class="paragraph"><p><strong>Example order</strong>: <tt>disk /mnt/usbstick</tt></p></div>\r
+<div class="paragraph"><p><strong>Example format</strong>: <tt>%free (%avail)/ %total</tt></p></div>\r
+</div>\r
+<div class="sect2">\r
+<h3 id="_run_watch">5.4. Run-watch</h3>\r
+<div class="paragraph"><p>Expands the given path to a pidfile and checks if the process ID found inside\r
+is valid (that is, if the process is running). You can use this to check if\r
+a specific application, such as a VPN client or your DHCP client is running.</p></div>\r
+<div class="paragraph"><p><strong>Example order</strong>: <tt>run_watch DHCP</tt></p></div>\r
+</div>\r
+<div class="sect2">\r
+<h3 id="_wireless">5.5. Wireless</h3>\r
+<div class="paragraph"><p>Gets the link quality and ESSID of the given wireless network interface. You\r
+can specify different format strings for the network being connected or not\r
+connected.</p></div>\r
+<div class="paragraph"><p><strong>Example order</strong>: <tt>wireless wlan0</tt></p></div>\r
+<div class="paragraph"><p><strong>Example format</strong>: <tt>W: (%quality at %essid, %bitrate) %ip</tt></p></div>\r
+</div>\r
+<div class="sect2">\r
+<h3 id="_ethernet">5.6. Ethernet</h3>\r
+<div class="paragraph"><p>Gets the IP address and (if possible) the link speed of the given ethernet\r
+interface. Getting the link speed requires the cap_net_admin capability. Set\r
+it using <tt>setcap cap_net_admin=ep $(which i3status)</tt>.</p></div>\r
+<div class="paragraph"><p><strong>Example order</strong>: <tt>ethernet eth0</tt></p></div>\r
+<div class="paragraph"><p><strong>Example format</strong>: <tt>E: %ip (%speed)</tt></p></div>\r
+</div>\r
+<div class="sect2">\r
+<h3 id="_battery">5.7. Battery</h3>\r
+<div class="paragraph"><p>Gets the status (charging, discharging, running), percentage and remaining\r
+time of the given battery. If you want to use the last full capacity instead\r
+of the design capacity (when using the design capacity, it may happen that\r
+your battery is at 23% when fully charged because it’s old. In general, I\r
+want to see it this way, because it tells me how worn off my battery is.),\r
+just specify <tt>last_full_capacity = true</tt>.</p></div>\r
+<div class="paragraph"><p><strong>Example order</strong>: <tt>battery 0</tt></p></div>\r
+<div class="paragraph"><p><strong>Example format</strong>: <tt>%status %remaining</tt></p></div>\r
+</div>\r
+<div class="sect2">\r
+<h3 id="_cpu_temperature">5.8. CPU-Temperature</h3>\r
+<div class="paragraph"><p>Gets the temperature of the given thermal zone.</p></div>\r
+<div class="paragraph"><p><strong>Example order</strong>: <tt>cpu_temperature 0</tt></p></div>\r
+<div class="paragraph"><p><strong>Example format</strong>: <tt>T: %degrees °C</tt></p></div>\r
+</div>\r
+<div class="sect2">\r
+<h3 id="_cpu_usage">5.9. CPU Usage</h3>\r
+<div class="paragraph"><p>Gets the percentual CPU usage from <tt>/proc/stat</tt>.</p></div>\r
+<div class="paragraph"><p><strong>Example order</strong>: <tt>cpu_usage</tt></p></div>\r
+<div class="paragraph"><p><strong>Example format</strong>: <tt>%usage</tt></p></div>\r
+</div>\r
+<div class="sect2">\r
+<h3 id="_load">5.10. Load</h3>\r
+<div class="paragraph"><p>Gets the system load (number of processes waiting for CPU time in the last\r
+5, 10 and 15 minutes).</p></div>\r
+<div class="paragraph"><p><strong>Example order</strong>: <tt>load</tt></p></div>\r
+<div class="paragraph"><p><strong>Example format</strong>: <tt>%5min %10min %15min</tt></p></div>\r
+</div>\r
+<div class="sect2">\r
+<h3 id="_time">5.11. Time</h3>\r
+<div class="paragraph"><p>Formats the current system time. See <tt>strftime(3)</tt> for the format.</p></div>\r
+<div class="paragraph"><p><strong>Example order</strong>: <tt>time</tt></p></div>\r
+<div class="paragraph"><p><strong>Example format</strong>: <tt>%Y-%m-%d %H:%M:%S</tt></p></div>\r
+</div>\r
+<div class="sect2">\r
+<h3 id="_ddate">5.12. DDate</h3>\r
+<div class="paragraph"><p>Outputs the current discordian date in user-specified format. See <tt>ddate(1)</tt> for\r
+details on the format string.\r
+<strong>Note</strong>: Neither <strong>%.</strong> nor <strong>%X</strong> are implemented yet.</p></div>\r
+<div class="paragraph"><p><strong>Example order</strong>: <tt>ddate</tt></p></div>\r
+<div class="paragraph"><p><strong>Example format</strong>: <tt>%{%a, %b %d%}, %Y%N - %H</tt></p></div>\r
+</div>\r
+<div class="sect2">\r
+<h3 id="_volume">5.13. Volume</h3>\r
+<div class="paragraph"><p>Outputs the volume of the specified mixer on the specified device. Works only\r
+on Linux because it uses ALSA.</p></div>\r
+<div class="paragraph"><p><strong>Example order</strong>: <tt>volume master</tt></p></div>\r
+<div class="paragraph"><p><strong>Example format</strong>: <tt>♪: %volume</tt></p></div>\r
+<div class="paragraph"><p><strong>Example configuration</strong>:</p></div>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt>volume master {\r
+        format = "♪: %volume"\r
+        device = "default"\r
+        mixer = "Master"\r
+        mixer_idx = 0\r
+}</tt></pre>\r
+</div></div>\r
+</div>\r
+</div>\r
+</div>\r
+<div class="sect1">\r
+<h2 id="_using_i3status_with_dzen2">6. Using i3status with dzen2</h2>\r
+<div class="sectionbody">\r
+<div class="paragraph"><p>After installing dzen2, you can directly use it with i3status. Just ensure that\r
+<tt>output_format</tt> is set to <tt>dzen2</tt>.</p></div>\r
+<div class="paragraph"><p><strong>Example for usage of i3status with dzen2</strong>:</p></div>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt>i3status | dzen2 -fg white -ta r -w 1280 \\r
+-fn "-misc-fixed-medium-r-normal--13-120-75-75-C-70-iso8859-1"</tt></pre>\r
+</div></div>\r
+</div>\r
+</div>\r
+<div class="sect1">\r
+<h2 id="_using_i3status_with_xmobar">7. Using i3status with xmobar</h2>\r
+<div class="sectionbody">\r
+<div class="paragraph"><p>To get xmobar to start, you might need to copy the default configuration\r
+file to <tt>~/.xmobarrc</tt>. Also, ensure that the <tt>output_format</tt> option for i3status\r
+is set to <tt>xmobar</tt>.</p></div>\r
+<div class="paragraph"><p><strong>Example for usage of i3status with xmobar</strong>:</p></div>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt>i3status | xmobar -o -t "%StdinReader%" -c "[Run StdinReader]"</tt></pre>\r
+</div></div>\r
+</div>\r
+</div>\r
+<div class="sect1">\r
+<h2 id="_see_also">8. SEE ALSO</h2>\r
+<div class="sectionbody">\r
+<div class="paragraph"><p><tt>strftime(3)</tt>, <tt>date(1)</tt>, <tt>glob(3)</tt>, <tt>dzen2(1)</tt>, <tt>xmobar(1)</tt></p></div>\r
+</div>\r
+</div>\r
+<div class="sect1">\r
+<h2 id="_authors">9. AUTHORS</h2>\r
+<div class="sectionbody">\r
+<div class="paragraph"><p>Michael Stapelberg and contributors</p></div>\r
+<div class="paragraph"><p>Thorsten Toepper</p></div>\r
+<div class="paragraph"><p>Baptiste Daroussin</p></div>\r
+<div class="paragraph"><p>Axel Wagner</p></div>\r
+<div class="paragraph"><p>Fernando Tarlá Cardoso Lemos</p></div>\r
+</div>\r
+</div>\r
+</div>\r
+<div id="footnotes"><hr /></div>\r
+<div id="footer" lang="de">\r
+© 2009-2011 Michael Stapelberg, <a href="/impress.html">Impressum</a>\r
+</div>\r
+</body>\r
+</html>\r