From fecece18f6f3cb799f2c8e0a0e1d3f7137565719 Mon Sep 17 00:00:00 2001 From: Michael Stapelberg Date: Sat, 24 Dec 2011 16:38:34 +0100 Subject: [PATCH] update docs for v4.1.1 --- _docs/userguide | 90 ++++++++++++++++++--------------------------- docs/userguide.html | 87 ++++++++++++++++++------------------------- 2 files changed, 71 insertions(+), 106 deletions(-) diff --git a/_docs/userguide b/_docs/userguide index 79c97b1..e75f1ca 100644 --- a/_docs/userguide +++ b/_docs/userguide @@ -323,7 +323,7 @@ bindcode [Modifiers+]keycode command *Examples*: -------------------------------- # Fullscreen -bindsym mod+f f +bindsym mod+f fullscreen # Restart bindsym mod+Shift+r restart @@ -519,7 +519,7 @@ use it, it has to be a UTF-8 encoded arrow, not `->` or something like that. To get the class and instance, you can use +xprop+. After clicking on the window, you will see the following output: -*xwininfo*: +*xprop*: ----------------------------------- WM_CLASS(STRING) = "irssi", "URxvt" ----------------------------------- @@ -619,7 +619,7 @@ Only clients that do not cover the whole area of this window expose the color used to paint it. If you use a color other than black for your terminals, you most likely want to set the client background color to the same color as your terminal program's background color to avoid black gaps between the rendered -area of the termianal and the i3 border. +area of the terminal and the i3 border. Colors are in HTML hex format (#rrggbb), see the following example: @@ -643,16 +643,19 @@ programs to get information from i3, such as the current workspaces (to display a workspace bar), and to control i3. The IPC socket is enabled by default and will be created in -+/tmp/i3-%u/ipc-socket.%p+ where +%u+ is your UNIX username and +%p+ is the PID -of i3. ++/tmp/i3-%u.XXXXXX/ipc-socket.%p+ where +%u+ is your UNIX username, +%p+ is +the PID of i3 and XXXXXX is a string of random characters from the portable +filename character set (see mkdtemp(3)). You can override the default path through the environment-variable +I3SOCK+ or by specifying the +ipc-socket+ directive. This is discouraged, though, since i3 -does the right thing by default. +does the right thing by default. If you decide to change it, it is strongly +recommended to set this to a location in your home directory so that no other +user can create that directory. *Examples*: ---------------------------- -ipc-socket /tmp/i3-ipc.sock +ipc-socket ~/.i3/i3-ipc.sock ---------------------------- You can then use the +i3-msg+ application to perform any command listed in @@ -812,9 +815,7 @@ status_command command *Example*: ------------------------------------------------- -bar { - status_command i3status --config ~/.i3status.conf -} +status_command i3status --config ~/.i3status.conf ------------------------------------------------- === Display mode @@ -836,9 +837,7 @@ mode *Example*: ---------------- -bar { - mode hide -} +mode hide ---------------- === Position @@ -854,9 +853,7 @@ position *Example*: --------------------- -bar { - position top -} +position top --------------------- === Output(s) @@ -865,9 +862,6 @@ 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 @@ -877,20 +871,18 @@ output ------------------------------- # big monitor: everything bar { - # The display is connected either via HDMI or via DisplayPort - output HDMI2 - output DP2 - status_command i3status + output HDMI2 + 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 + } } ------------------------------- @@ -910,14 +902,10 @@ tray_output *Example*: ------------------------- # disable system tray -bar { - tray_output none -} +tray_output none # show tray icons on the big monitor -bar { - tray_output HDMI2 -} +tray_output HDMI2 ------------------------- === Font @@ -932,9 +920,7 @@ font *Example*: -------------------------------------------------------------- -bar { - font -misc-fixed-medium-r-normal--13-120-75-75-C-70-iso10646-1 -} +font -misc-fixed-medium-r-normal--13-120-75-75-C-70-iso10646-1 -------------------------------------------------------------- === Workspace buttons @@ -951,9 +937,7 @@ workspace_buttons *Example*: -------------------- -bar { - workspace_buttons no -} +workspace_buttons no -------------------- === Colors @@ -993,16 +977,14 @@ colors { *Example*: -------------------------------------- -bar { - colors { - background #000000 - statusline #ffffff - - focused_workspace #ffffff #285577 - active_workspace #ffffff #333333 - inactive_workspace #888888 #222222 - urgent_workspace #ffffff #900000 - } +colors { + background #000000 + statusline #ffffff + + focused_workspace #ffffff #285577 + active_workspace #ffffff #333333 + inactive_workspace #888888 #222222 + urgent_workspace #ffffff #900000 } -------------------------------------- @@ -1084,7 +1066,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+Return exec --no-startup-id urxvt +bindsym mod+enter exec --no-startup-id urxvt ------------------------------ The +--no-startup-id+ parameter disables startup-notification support for this @@ -1203,7 +1185,7 @@ number or name of the workspace. To move containers to specific workspaces, use You can also switch to the next and previous workspace with the commands +workspace next+ and +workspace prev+, which is handy, for example, if you have workspace 1, 3, 4 and 9 and you want to cycle through them with a single key -combination. Similarily, you can use +move workspace next+ and +move workspace +combination. Similarly, you can use +move workspace next+ and +move workspace prev+ to move a container to the next/previous workspace. [[back_and_forth]] @@ -1213,7 +1195,7 @@ back_and_forth+. To move a container to another xrandr output such as +LVDS1+ or +VGA1+, you can use the +move output+ command followed by the name of the target output. You may also use +left+, +right+, +up+, +down+ instead of the xrandr output name to -move to the the next output in the specified direction. +move to the next output in the specified direction. *Examples*: ------------------------- diff --git a/docs/userguide.html b/docs/userguide.html index dc26073..3df88cc 100644 --- a/docs/userguide.html +++ b/docs/userguide.html @@ -394,7 +394,7 @@ bindcode [Modifiers+]keycode command 
# Fullscreen
-bindsym mod+f f
+bindsym mod+f fullscreen
 
 # Restart
 bindsym mod+Shift+r restart
@@ -584,7 +584,7 @@ assign [class="^URxvt$" instance="^irssi$"] → 3
use it, it has to be a UTF-8 encoded arrow, not -> or something like that.

To get the class and instance, you can use xprop. After clicking on the window, you will see the following output:

-

xwininfo:

+

xprop:

WM_CLASS(STRING) = "irssi", "URxvt"
@@ -700,7 +700,7 @@ will be rendered.

used to paint it. If you use a color other than black for your terminals, you most likely want to set the client background color to the same color as your terminal program’s background color to avoid black gaps between the rendered -area of the termianal and the i3 border.

+area of the terminal and the i3 border.

Colors are in HTML hex format (#rrggbb), see the following example:

Examples (default colors):

@@ -721,15 +721,18 @@ the window.

programs to get information from i3, such as the current workspaces (to display a workspace bar), and to control i3.

The IPC socket is enabled by default and will be created in -/tmp/i3-%u/ipc-socket.%p where %u is your UNIX username and %p is the PID -of i3.

+/tmp/i3-%u.XXXXXX/ipc-socket.%p where %u is your UNIX username, %p is +the PID of i3 and XXXXXX is a string of random characters from the portable +filename character set (see mkdtemp(3)).

You can override the default path through the environment-variable I3SOCK or by specifying the ipc-socket directive. This is discouraged, though, since i3 -does the right thing by default.

+does the right thing by default. If you decide to change it, it is strongly +recommended to set this to a location in your home directory so that no other +user can create that directory.

Examples:

-
ipc-socket /tmp/i3-ipc.sock
+
ipc-socket ~/.i3/i3-ipc.sock

You can then use the i3-msg application to perform any command listed in the next section.

@@ -905,9 +908,7 @@ have to have correct quoting etc.

Example:

-
bar {
-    status_command i3status --config ~/.i3status.conf
-}
+
status_command i3status --config ~/.i3status.conf
@@ -927,9 +928,7 @@ save battery power.

Example:

-
bar {
-    mode hide
-}
+
mode hide
@@ -944,9 +943,7 @@ save battery power.

Example:

-
bar {
-    position top
-}
+
position top
@@ -954,8 +951,6 @@ save battery power.

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:

@@ -966,20 +961,18 @@ directive multiple times.

# big monitor: everything
 bar {
-    # The display is connected either via HDMI or via DisplayPort
-    output HDMI2
-    output DP2
-    status_command i3status
+        output HDMI2
+        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
+        }
 }
@@ -998,14 +991,10 @@ you can turn off the functionality entirely.

# disable system tray
-bar {
-    tray_output none
-}
+tray_output none
 
 # show tray icons on the big monitor
-bar {
-    tray_output HDMI2
-}
+tray_output HDMI2
@@ -1020,9 +1009,7 @@ the bar.

Example:

-
bar {
-    font -misc-fixed-medium-r-normal--13-120-75-75-C-70-iso10646-1
-}
+
font -misc-fixed-medium-r-normal--13-120-75-75-C-70-iso10646-1
@@ -1038,9 +1025,7 @@ you want to display a statusline-only bar containing additional information.

Example:

-
bar {
-    workspace_buttons no
-}
+
workspace_buttons no
@@ -1117,16 +1102,14 @@ urgent_workspace

Example:

-
bar {
-    colors {
-        background #000000
-        statusline #ffffff
+
colors {
+    background #000000
+    statusline #ffffff
 
-        focused_workspace  #ffffff #285577
-        active_workspace   #ffffff #333333
-        inactive_workspace #888888 #222222
-        urgent_workspace   #ffffff #900000
-    }
+    focused_workspace  #ffffff #285577
+    active_workspace   #ffffff #333333
+    inactive_workspace #888888 #222222
+    urgent_workspace   #ffffff #900000
 }
@@ -1245,7 +1228,7 @@ searched in your $PATH.

bindsym mod+g exec gimp # Start the terminal emulator urxvt which is not yet startup-notification-aware -bindsym mod+Return exec --no-startup-id urxvt +bindsym mod+enter exec --no-startup-id urxvt

The --no-startup-id parameter disables startup-notification support for this particular exec command. With startup-notification, i3 can make sure that a @@ -1388,14 +1371,14 @@ number or name of the workspace. To move containers to specific workspaces, use

You can also switch to the next and previous workspace with the commands workspace next and workspace prev, which is handy, for example, if you have workspace 1, 3, 4 and 9 and you want to cycle through them with a single key -combination. Similarily, you can use move workspace next and move workspace +combination. Similarly, you can use move workspace next and move workspace prev to move a container to the next/previous workspace.

To switch back to the previously focused workspace, use workspace back_and_forth.

To move a container to another xrandr output such as LVDS1 or VGA1, you can use the move output command followed by the name of the target output. You may also use left, right, up, down instead of the xrandr output name to -move to the the next output in the specified direction.

+move to the next output in the specified direction.

Examples:

-- 2.39.5