From: Michael Stapelberg <michael@stapelberg.de>
Date: Thu, 25 Mar 2010 01:47:01 +0000 (+0100)
Subject: Add documentation for the workspace_bar option
X-Git-Tag: 3.e~6^2~35
X-Git-Url: https://git.sur5r.net/?a=commitdiff_plain;h=239dbbb4f5b87110a1b992bbc14c1b1878092d33;p=i3%2Fi3

Add documentation for the workspace_bar option
---

diff --git a/docs/userguide b/docs/userguide
index f4a27743..c8821961 100644
--- a/docs/userguide
+++ b/docs/userguide
@@ -527,6 +527,26 @@ focus_follows_mouse <yes|no>
 focus_follows_mouse no
 ----------------------
 
+=== Internal workspace bar
+
+The internal workspace bar (the thing at the bottom of your screen) is very
+simple -- it does not provide a way to display custom text and it does not
+offer advanced customization features. This is intended because we do not
+want to duplicate functionality of tools like +dzen2+, +xmobar+ and so on
+(they render bars, we manage windows). Instead, there is an option which will
+turn off the internal bar completely, so that you can use a separate program to
+display it (see +i3-wsbar+, a sample implementation of such a program):
+
+*Syntax*:
+----------------------
+workspace_bar <yes|no>
+----------------------
+
+*Examples*:
+----------------
+workspace_bar no
+----------------
+
 == List of commands
 
 === Manipulating layout