]> git.sur5r.net Git - i3/i3.github.io/commitdiff
update userguide, add missing i3-sync images
authorMichael Stapelberg <michael@stapelberg.de>
Wed, 16 Nov 2011 00:12:45 +0000 (00:12 +0000)
committerMichael Stapelberg <michael@stapelberg.de>
Wed, 16 Nov 2011 00:12:45 +0000 (00:12 +0000)
_docs/userguide
docs/i3-sync-working.png [new file with mode: 0644]
docs/i3-sync.png [new file with mode: 0644]
docs/userguide.html

index 3d78d16f83020e1f838df9cd119dd7d24eb7bdd1..79c97b1268796e7160dce4efe355a37496fec39e 100644 (file)
@@ -174,7 +174,7 @@ Floating windows are always on top of tiling windows.
 i3 stores all information about the X11 outputs, workspaces and layout of the
 windows on them in a tree. The root node is the X11 root window, followed by
 the X11 outputs, then dock areas and a content container, then workspaces and
-finally the windows themselve. In previous versions of i3 we had multiple lists
+finally the windows themselves. In previous versions of i3 we had multiple lists
 (of outputs, workspaces) and a table for each workspace. That approach turned
 out to be complicated to use (snapping), understand and implement.
 
@@ -812,7 +812,9 @@ status_command command
 
 *Example*:
 -------------------------------------------------
-status_command i3status --config ~/.i3status.conf
+bar {
+    status_command i3status --config ~/.i3status.conf
+}
 -------------------------------------------------
 
 === Display mode
@@ -834,7 +836,9 @@ mode <dock|hide>
 
 *Example*:
 ----------------
-mode hide
+bar {
+    mode hide
+}
 ----------------
 
 === Position
@@ -850,7 +854,9 @@ position <top|bottom>
 
 *Example*:
 ---------------------
-position top
+bar {
+    position top
+}
 ---------------------
 
 === Output(s)
@@ -859,6 +865,9 @@ You can restrict i3bar to one or more outputs (monitors). The default is to
 handle all outputs. Restricting the outputs is useful for using different
 options for different outputs by using multiple 'bar' blocks.
 
+To make a particular i3bar instance handle multiple outputs, specify the output
+directive multiple times.
+
 *Syntax*:
 ---------------
 output <output>
@@ -868,18 +877,20 @@ output <output>
 -------------------------------
 # big monitor: everything
 bar {
-       output HDMI2
-       status_command i3status
+    # The display is connected either via HDMI or via DisplayPort
+    output HDMI2
+    output DP2
+    status_command i3status
 }
 
 # laptop monitor: bright colors and i3status with less modules.
 bar {
-       output LVDS1
-       status_command i3status --config ~/.i3status-small.conf
-       colors {
-               background #000000
-               statusline #ffffff
-       }
+    output LVDS1
+    status_command i3status --config ~/.i3status-small.conf
+    colors {
+        background #000000
+        statusline #ffffff
+    }
 }
 -------------------------------
 
@@ -899,10 +910,14 @@ tray_output <none|output>
 *Example*:
 -------------------------
 # disable system tray
-tray_output none
+bar {
+    tray_output none
+}
 
 # show tray icons on the big monitor
-tray_output HDMI2
+bar {
+    tray_output HDMI2
+}
 -------------------------
 
 === Font
@@ -917,7 +932,9 @@ font <font>
 
 *Example*:
 --------------------------------------------------------------
-font -misc-fixed-medium-r-normal--13-120-75-75-C-70-iso10646-1
+bar {
+    font -misc-fixed-medium-r-normal--13-120-75-75-C-70-iso10646-1
+}
 --------------------------------------------------------------
 
 === Workspace buttons
@@ -934,7 +951,9 @@ workspace_buttons <yes|no>
 
 *Example*:
 --------------------
-workspace_buttons no
+bar {
+    workspace_buttons no
+}
 --------------------
 
 === Colors
@@ -974,14 +993,16 @@ colors {
 
 *Example*:
 --------------------------------------
-colors {
-    background #000000
-    statusline #ffffff
-
-    focused_workspace  #ffffff #285577
-    active_workspace   #ffffff #333333
-    inactive_workspace #888888 #222222
-    urgent_workspace   #ffffff #900000
+bar {
+    colors {
+        background #000000
+        statusline #ffffff
+
+        focused_workspace  #ffffff #285577
+        active_workspace   #ffffff #333333
+        inactive_workspace #888888 #222222
+        urgent_workspace   #ffffff #900000
+    }
 }
 --------------------------------------
 
@@ -1063,7 +1084,7 @@ exec [--no-startup-id] command
 bindsym mod+g exec gimp
 
 # Start the terminal emulator urxvt which is not yet startup-notification-aware
-bindsym mod+enter exec --no-startup-id urxvt
+bindsym mod+Return exec --no-startup-id urxvt
 ------------------------------
 
 The +--no-startup-id+ parameter disables startup-notification support for this
diff --git a/docs/i3-sync-working.png b/docs/i3-sync-working.png
new file mode 100644 (file)
index 0000000..dce44ac
Binary files /dev/null and b/docs/i3-sync-working.png differ
diff --git a/docs/i3-sync.png b/docs/i3-sync.png
new file mode 100644 (file)
index 0000000..b64cce2
Binary files /dev/null and b/docs/i3-sync.png differ
index 5ab81111d0ae137365e4c0298549886e8630c5e2..dc2607396375b5487b5928aa3560021c38fa7f38 100644 (file)
@@ -227,7 +227,7 @@ can also do that by using the <a href="#floating_modifier">[floating_modifier]</
 <div class="paragraph"><p>i3 stores all information about the X11 outputs, workspaces and layout of the\r
 windows on them in a tree. The root node is the X11 root window, followed by\r
 the X11 outputs, then dock areas and a content container, then workspaces and\r
-finally the windows themselve. In previous versions of i3 we had multiple lists\r
+finally the windows themselves. In previous versions of i3 we had multiple lists\r
 (of outputs, workspaces) and a table for each workspace. That approach turned\r
 out to be complicated to use (snapping), understand and implement.</p></div>\r
 <div class="sect2">\r
@@ -905,7 +905,9 @@ have to have correct quoting etc.</p></div>
 <div class="paragraph"><p><strong>Example</strong>:</p></div>\r
 <div class="listingblock">\r
 <div class="content">\r
-<pre><tt>status_command i3status --config ~/.i3status.conf</tt></pre>\r
+<pre><tt>bar {\r
+    status_command i3status --config ~/.i3status.conf\r
+}</tt></pre>\r
 </div></div>\r
 </div>\r
 <div class="sect2">\r
@@ -925,7 +927,9 @@ save battery power.</p></div>
 <div class="paragraph"><p><strong>Example</strong>:</p></div>\r
 <div class="listingblock">\r
 <div class="content">\r
-<pre><tt>mode hide</tt></pre>\r
+<pre><tt>bar {\r
+    mode hide\r
+}</tt></pre>\r
 </div></div>\r
 </div>\r
 <div class="sect2">\r
@@ -940,7 +944,9 @@ save battery power.</p></div>
 <div class="paragraph"><p><strong>Example</strong>:</p></div>\r
 <div class="listingblock">\r
 <div class="content">\r
-<pre><tt>position top</tt></pre>\r
+<pre><tt>bar {\r
+    position top\r
+}</tt></pre>\r
 </div></div>\r
 </div>\r
 <div class="sect2">\r
@@ -948,6 +954,8 @@ save battery power.</p></div>
 <div class="paragraph"><p>You can restrict i3bar to one or more outputs (monitors). The default is to\r
 handle all outputs. Restricting the outputs is useful for using different\r
 options for different outputs by using multiple <em>bar</em> blocks.</p></div>\r
+<div class="paragraph"><p>To make a particular i3bar instance handle multiple outputs, specify the output\r
+directive multiple times.</p></div>\r
 <div class="paragraph"><p><strong>Syntax</strong>:</p></div>\r
 <div class="listingblock">\r
 <div class="content">\r
@@ -958,18 +966,20 @@ options for different outputs by using multiple <em>bar</em> blocks.</p></div>
 <div class="content">\r
 <pre><tt># big monitor: everything\r
 bar {\r
-        output HDMI2\r
-        status_command i3status\r
+    # The display is connected either via HDMI or via DisplayPort\r
+    output HDMI2\r
+    output DP2\r
+    status_command i3status\r
 }\r
 \r
 # laptop monitor: bright colors and i3status with less modules.\r
 bar {\r
-        output LVDS1\r
-        status_command i3status --config ~/.i3status-small.conf\r
-        colors {\r
-                background #000000\r
-                statusline #ffffff\r
-        }\r
+    output LVDS1\r
+    status_command i3status --config ~/.i3status-small.conf\r
+    colors {\r
+        background #000000\r
+        statusline #ffffff\r
+    }\r
 }</tt></pre>\r
 </div></div>\r
 </div>\r
@@ -988,10 +998,14 @@ you can turn off the functionality entirely.</p></div>
 <div class="listingblock">\r
 <div class="content">\r
 <pre><tt># disable system tray\r
-tray_output none\r
+bar {\r
+    tray_output none\r
+}\r
 \r
 # show tray icons on the big monitor\r
-tray_output HDMI2</tt></pre>\r
+bar {\r
+    tray_output HDMI2\r
+}</tt></pre>\r
 </div></div>\r
 </div>\r
 <div class="sect2">\r
@@ -1006,7 +1020,9 @@ the bar.</p></div>
 <div class="paragraph"><p><strong>Example</strong>:</p></div>\r
 <div class="listingblock">\r
 <div class="content">\r
-<pre><tt>font -misc-fixed-medium-r-normal--13-120-75-75-C-70-iso10646-1</tt></pre>\r
+<pre><tt>bar {\r
+    font -misc-fixed-medium-r-normal--13-120-75-75-C-70-iso10646-1\r
+}</tt></pre>\r
 </div></div>\r
 </div>\r
 <div class="sect2">\r
@@ -1022,7 +1038,9 @@ you want to display a statusline-only bar containing additional information.</p>
 <div class="paragraph"><p><strong>Example</strong>:</p></div>\r
 <div class="listingblock">\r
 <div class="content">\r
-<pre><tt>workspace_buttons no</tt></pre>\r
+<pre><tt>bar {\r
+    workspace_buttons no\r
+}</tt></pre>\r
 </div></div>\r
 </div>\r
 <div class="sect2">\r
@@ -1099,14 +1117,16 @@ urgent_workspace
 <div class="paragraph"><p><strong>Example</strong>:</p></div>\r
 <div class="listingblock">\r
 <div class="content">\r
-<pre><tt>colors {\r
-    background #000000\r
-    statusline #ffffff\r
+<pre><tt>bar {\r
+    colors {\r
+        background #000000\r
+        statusline #ffffff\r
 \r
-    focused_workspace  #ffffff #285577\r
-    active_workspace   #ffffff #333333\r
-    inactive_workspace #888888 #222222\r
-    urgent_workspace   #ffffff #900000\r
+        focused_workspace  #ffffff #285577\r
+        active_workspace   #ffffff #333333\r
+        inactive_workspace #888888 #222222\r
+        urgent_workspace   #ffffff #900000\r
+    }\r
 }</tt></pre>\r
 </div></div>\r
 </div>\r
@@ -1225,7 +1245,7 @@ searched in your $PATH.</p></div>
 bindsym mod+g exec gimp\r
 \r
 # Start the terminal emulator urxvt which is not yet startup-notification-aware\r
-bindsym mod+enter exec --no-startup-id urxvt</tt></pre>\r
+bindsym mod+Return exec --no-startup-id urxvt</tt></pre>\r
 </div></div>\r
 <div class="paragraph"><p>The <tt>--no-startup-id</tt> parameter disables startup-notification support for this\r
 particular exec command. With startup-notification, i3 can make sure that a\r