Merge pull request #1805 from lasers/next

[i3/i3] / docs / userguide

diff --git a/docs/userguide b/docs/userguide
index 45b05a062fcbaf020521fee55a0362cca997bc5f..816fbc34336e9f2195afac31eba5b83b4731fa85 100644 (file)
--- a/docs/userguide
+++ b/docs/userguide
@@ -256,8 +256,9 @@ workspace node’s orientation will be changed to +vertical+. The terminal windo
 you moved down is directly attached to the workspace and appears on the bottom
 of the screen. A new (horizontal) container was created to accommodate the
 other two terminal windows. You will notice this when switching to tabbed mode
 you moved down is directly attached to the workspace and appears on the bottom
 of the screen. A new (horizontal) container was created to accommodate the
 other two terminal windows. You will notice this when switching to tabbed mode

-(for example). You would end up having one tab called "another container" and
-the other one being the terminal window you moved down.
+(for example). You would end up having one tab with a representation of the split
+container (e.g., "H[urxvt firefox]") and the other one being the terminal window
+you moved down.

 
 [[configuring]]
 == Configuring i3
 
 [[configuring]]
 == Configuring i3


@@ -319,7 +320,7 @@ and fall back to a working font.
 *Syntax*:
 ------------------------------
 font <X core font description>
 *Syntax*:
 ------------------------------
 font <X core font description>

-font pango:[family list] [style options] [size]
+font pango:<family list> [<style options>] <size>

 ------------------------------
 
 *Examples*:
 ------------------------------
 
 *Examples*:


@@ -360,8 +361,8 @@ after the keys have been released.
 
 *Syntax*:
 ----------------------------------
 
 *Syntax*:
 ----------------------------------

-bindsym [--release] [Modifiers+]keysym command
-bindcode [--release] [Modifiers+]keycode command
+bindsym [--release] [<Modifiers>+]<keysym> command
+bindcode [--release] [<Modifiers>+]<keycode> command

 ----------------------------------
 
 *Examples*:
 ----------------------------------
 
 *Examples*:


@@ -403,14 +404,17 @@ button in the scope of the clicked container (see <<command_criteria>>). You
 can configure mouse bindings in a similar way to key bindings.
 
 *Syntax*:
 can configure mouse bindings in a similar way to key bindings.
 
 *Syntax*:

-----------------------------------
-bindsym [--release] [--whole-window] [Modifiers+]button[n] command
-----------------------------------
+-------------------------------------------------------------------------------
+bindsym [--release] [--border] [--whole-window] [<Modifiers>+]button<n> command
+-------------------------------------------------------------------------------

 
 By default, the binding will only run when you click on the titlebar of the
 
 By default, the binding will only run when you click on the titlebar of the

-window. If the +--whole-window+ flag is given, it will run when any part of the
-window is clicked. If the +--release+ flag is given, it will run when the mouse
-button is released.
+window. If the +--release+ flag is given, it will run when the mouse button
+is released.
+
+If the +--whole-window+ flag is given, the binding will also run when any part
+of the window is clicked, with the exception of the border. To have a bind run
+when the border is clicked, specify the +--border+ flag.

 
 *Examples*:
 --------------------------------
 
 *Examples*:
 --------------------------------


@@ -447,7 +451,7 @@ ratio will be preserved).
 
 *Syntax*:
 --------------------------------
 
 *Syntax*:
 --------------------------------

-floating_modifier <Modifiers>
+floating_modifier <Modifier>

 --------------------------------
 
 *Example*:
 --------------------------------
 
 *Example*:


@@ -486,9 +490,9 @@ With the +default_orientation+ configuration directive, you can override that
 behavior.
 
 *Syntax*:
 behavior.
 
 *Syntax*:

-----------------------------------------------
-default_orientation <horizontal|vertical|auto>
-----------------------------------------------
+--------------------------------------------
+default_orientation horizontal|vertical|auto
+--------------------------------------------

 
 *Example*:
 ----------------------------
 
 *Example*:
 ----------------------------


@@ -499,17 +503,11 @@ default_orientation vertical
 
 This option determines in which mode new containers on workspace level will
 start.
 
 This option determines in which mode new containers on workspace level will
 start.

-///////////////////////////////
-See also <<stack-limit>>.
-//////////////////////////////

 
 *Syntax*:
 ---------------------------------------------
 
 *Syntax*:
 ---------------------------------------------

-workspace_layout <default|stacking|tabbed>
+workspace_layout default|stacking|tabbed

 ---------------------------------------------
 ---------------------------------------------

-/////////////////////////////////////////////
-new_container stack-limit <cols|rows> <value>
-/////////////////////////////////////////////

 
 *Example*:
 ---------------------
 
 *Example*:
 ---------------------


@@ -519,18 +517,20 @@ workspace_layout tabbed
 === Border style for new windows
 
 This option determines which border style new windows will have. The default is
 === Border style for new windows
 
 This option determines which border style new windows will have. The default is

-"normal". Note that new_float applies only to windows which are starting out as
-floating windows, e.g. dialog windows.
++normal+. Note that new_float applies only to windows which are starting out as
+floating windows, e.g., dialog windows, but not windows that are floated later on.

 
 *Syntax*:
 ---------------------------------------------
 
 *Syntax*:
 ---------------------------------------------

-new_window <normal|1pixel|none|pixel>
-new_float <normal|1pixel|none|pixel>
+new_window normal|none|pixel
+new_window normal|pixel <px>
+new_float normal|none|pixel
+new_float normal|pixel <px>

 ---------------------------------------------
 
 *Example*:
 ---------------------
 ---------------------------------------------
 
 *Example*:
 ---------------------

-new_window 1pixel
+new_window pixel

 ---------------------
 
 The "normal" and "pixel" border styles support an optional border width in
 ---------------------
 
 The "normal" and "pixel" border styles support an optional border width in


@@ -553,9 +553,9 @@ You can hide vertical borders adjacent to the screen edges using
 to waste even two pixels in displayspace. Default is none.
 
 *Syntax*:
 to waste even two pixels in displayspace. Default is none.
 
 *Syntax*:

-----------------------------
-hide_edge_borders <none|vertical|horizontal|both>
-----------------------------
+-----------------------------------------------
+hide_edge_borders none|vertical|horizontal|both
+-----------------------------------------------

 
 *Example*:
 ----------------------
 
 *Example*:
 ----------------------


@@ -564,14 +564,16 @@ hide_edge_borders vertical
 
 === Arbitrary commands for specific windows (for_window)
 
 
 === Arbitrary commands for specific windows (for_window)
 

+[[for_window]]
+

 With the +for_window+ command, you can let i3 execute any command when it
 encounters a specific window. This can be used to set windows to floating or to
 change their border style, for example.
 
 *Syntax*:
 With the +for_window+ command, you can let i3 execute any command when it
 encounters a specific window. This can be used to set windows to floating or to
 change their border style, for example.
 
 *Syntax*:

------------------------------
-for_window <criteria> command
------------------------------
+-------------------------------
+for_window <criteria> <command>
+-------------------------------

 
 *Examples*:
 ------------------------------------------------
 
 *Examples*:
 ------------------------------------------------


@@ -579,7 +581,7 @@ for_window <criteria> command
 for_window [class="XTerm"] floating enable
 
 # Make all urxvts use a 1-pixel border:
 for_window [class="XTerm"] floating enable
 
 # Make all urxvts use a 1-pixel border:

-for_window [class="urxvt"] border 1pixel
+for_window [class="urxvt"] border pixel 1

 
 # A less useful, but rather funny example:
 # makes the window floating as soon as I change
 
 # A less useful, but rather funny example:
 # makes the window floating as soon as I change


@@ -589,6 +591,27 @@ for_window [title="x200: ~/work"] floating enable
 
 The valid criteria are the same as those for commands, see <<command_criteria>>.
 
 
 The valid criteria are the same as those for commands, see <<command_criteria>>.
 

+=== Don't focus window upon opening
+
+[[no_focus]]
+
+When a new window appears, it will be focused. The +no_focus+ directive allows preventing
+this from happening and can be used in combination with <<command_criteria>>.
+
+Note that this does not apply to all cases, e.g., when feeding data into a running application
+causing it to request being focused. To configure the behavior in such cases, refer to
+<<focus_on_window_activation>>.
+
+*Syntax*:
+-------------------
+no_focus <criteria>
+-------------------
+
+*Example*:
+-------------------------------
+no_focus [window_role="pop-up"]
+-------------------------------
+

 === Variables
 
 As you learned in the section about keyboard bindings, you will have
 === Variables
 
 As you learned in the section about keyboard bindings, you will have


@@ -597,9 +620,9 @@ yourself some typing and be able to change the modifier you use later,
 variables can be handy.
 
 *Syntax*:
 variables can be handy.
 
 *Syntax*:

---------------
-set $name value
---------------
+-------------------
+set $<name> <value>
+-------------------

 
 *Example*:
 ------------------------
 
 *Example*:
 ------------------------


@@ -635,7 +658,7 @@ considered.
 
 *Syntax*:
 ------------------------------------------------------------
 
 *Syntax*:
 ------------------------------------------------------------

-assign <criteria> [→] workspace
+assign <criteria> [→] [workspace] <workspace>

 ------------------------------------------------------------
 
 *Examples*:
 ------------------------------------------------------------
 
 *Examples*:


@@ -699,11 +722,15 @@ commands will not run when restarting i3, if you need a command to run
 also when restarting i3 you should use the +exec_always+
 keyword. These commands will be run in order.
 
 also when restarting i3 you should use the +exec_always+
 keyword. These commands will be run in order.
 

+See <<command_chaining>> for details on the special meaning of +;+ (semicolon)
+and +,+ (comma): they chain commands together in i3, so you need to use quoted
+strings if they appear in your command.
+

 *Syntax*:
 *Syntax*:

--------------------
-exec [--no-startup-id] command
-exec_always [--no-startup-id] command
--------------------
+---------------------------------------
+exec [--no-startup-id] <command>
+exec_always [--no-startup-id] <command>
+---------------------------------------

 
 *Examples*:
 --------------------------------
 
 *Examples*:
 --------------------------------


@@ -727,9 +754,9 @@ or when starting (e.g., by default it will use 1 for the first screen, 2 for
 the second screen and so on).
 
 *Syntax*:
 the second screen and so on).
 
 *Syntax*:

-----------------------------------
+-------------------------------------

 workspace <workspace> output <output>
 workspace <workspace> output <output>

-----------------------------------
+-------------------------------------

 
 The 'output' is the name of the RandR output you attach your screen to. On a
 laptop, you might have VGA1 and LVDS1 as output names. You can see the
 
 The 'output' is the name of the RandR output you attach your screen to. On a
 laptop, you might have VGA1 and LVDS1 as output names. You can see the


@@ -749,9 +776,9 @@ workspace "2: vim" output VGA1
 You can change all colors which i3 uses to draw the window decorations.
 
 *Syntax*:
 You can change all colors which i3 uses to draw the window decorations.
 
 *Syntax*:

---------------------------------------------
-colorclass border background text indicator
---------------------------------------------
+------------------------------------------------------
+<colorclass> <border> <background> <text> <indicator>
+------------------------------------------------------

 
 Where colorclass can be one of:
 
 
 Where colorclass can be one of:
 


@@ -773,9 +800,9 @@ windows. This color will be used to paint the window on top of which the client
 will be rendered.
 
 *Syntax*:
 will be rendered.
 
 *Syntax*:

------------------------
-client.background color
------------------------
+-------------------------
+client.background <color>
+-------------------------

 
 Only clients that do not cover the whole area of this window expose the color
 used to paint it.
 
 Only clients that do not cover the whole area of this window expose the color
 used to paint it.


@@ -837,9 +864,9 @@ still be useful inside the currently active window (for example to click on
 links in your browser window).
 
 *Syntax*:
 links in your browser window).
 
 *Syntax*:

-----------------------------
-focus_follows_mouse <yes|no>
-----------------------------
+--------------------------
+focus_follows_mouse yes|no
+--------------------------

 
 *Example*:
 ----------------------
 
 *Example*:
 ----------------------


@@ -857,9 +884,9 @@ be warped. +none+ disables warping entirely, whereas +output+ is the default
 behavior described above.
 
 *Syntax*:
 behavior described above.
 
 *Syntax*:

----------------------------
-mouse_warping <output|none>
----------------------------
+-------------------------
+mouse_warping output|none
+-------------------------

 
 *Example*:
 ------------------
 
 *Example*:
 ------------------


@@ -881,9 +908,9 @@ There are three things which are possible to do in this situation:
 3. Leave fullscreen mode.
 
 *Syntax*:
 3. Leave fullscreen mode.
 
 *Syntax*:

--------------------------------------------------
-popup_during_fullscreen <smart|ignore|leave_fullscreen>
--------------------------------------------------
+-----------------------------------------------------
+popup_during_fullscreen smart|ignore|leave_fullscreen
+-----------------------------------------------------

 
 *Example*:
 ------------------------------
 
 *Example*:
 ------------------------------


@@ -904,9 +931,9 @@ parent+ to switch to different containers, you can use the
 will always wrap.
 
 *Syntax*:
 will always wrap.
 
 *Syntax*:

------------------------------
-force_focus_wrapping <yes|no>
------------------------------
+---------------------------
+force_focus_wrapping yes|no
+---------------------------

 
 *Example*:
 ------------------------
 
 *Example*:
 ------------------------


@@ -926,9 +953,9 @@ For people who cannot modify their +~/.xsession+ to add the
 +--force-xinerama+ commandline parameter, a configuration option is provided:
 
 *Syntax*:
 +--force-xinerama+ commandline parameter, a configuration option is provided:
 
 *Syntax*:

------------------------
-force_xinerama <yes|no>
------------------------
+---------------------
+force_xinerama yes|no
+---------------------

 
 *Example*:
 ------------------
 
 *Example*:
 ------------------


@@ -948,9 +975,9 @@ mod+2 because somebody sent you a message. You don’t need to remember where yo
 came from now, you can just press $mod+2 again to switch back to "1: www".
 
 *Syntax*:
 came from now, you can just press $mod+2 again to switch back to "1: www".
 
 *Syntax*:

---------------------------------------
-workspace_auto_back_and_forth <yes|no>
---------------------------------------
+------------------------------------
+workspace_auto_back_and_forth yes|no
+------------------------------------

 
 *Example*:
 ---------------------------------
 
 *Example*:
 ---------------------------------


@@ -981,6 +1008,76 @@ force_display_urgency_hint <timeout> ms
 force_display_urgency_hint 500 ms
 ---------------------------------
 
 force_display_urgency_hint 500 ms
 ---------------------------------
 

+=== Delaying exiting on zero displays
+
+Outputs may disappear momentarily and come back later. For example,
+using a docking station that does not announce the undock (e.g. ACPI Undock 
+event triggered through manually pushing a button before actually ejecting 
+the notebook). During the removal of the notebook from the docking station,
+all outputs disappear momentarily.
+
+To prevent i3 from exiting when no output is available momentarily, you can 
+tell i3 to delay a certain time first and check available outputs again using 
+the +delay_exit_on_zero_displays+ directive. Setting the value to 0 disables 
+this feature.
+
+The default is 500ms.
+
+*Syntax*:
+----------------------------------------
+delay_exit_on_zero_displays <timeout> ms
+----------------------------------------
+
+*Example*:
+----------------------------------
+delay_exit_on_zero_displays 500 ms
+----------------------------------
+
+=== Focus on window activation
+
+[[focus_on_window_activation]]
+
+If a window is activated, e.g., via +google-chrome www.google.com+, it may request
+to take focus. Since this may not preferable, different reactions can be configured.
+
+Note that this may not affect windows that are being opened. To prevent new windows
+from being focused, see <<no_focus>>.
+
+*Syntax*:
+--------------------------------------------------
+focus_on_window_activation smart|urgent|focus|none
+--------------------------------------------------
+
+The different modes will act as follows:
+
+smart::
+    This is the default behavior. If the window requesting focus is on an active
+    workspace, it will receive the focus. Otherwise, the urgency hint will be set.
+urgent::
+    The window will always be marked urgent, but the focus will not be stolen.
+focus::
+    The window will always be focused and not be marked urgent.
+none::
+    The window will neither be focused, nor be marked urgent.
+
+=== Drawing marks on window decoration
+
+If activated, marks on windows are drawn in their window decoration. However,
+any mark starting with an underscore in its name (+_+) will not be drawn even if
+this option is activated.
+
+The default for this option is +yes+.
+
+*Syntax*:
+-----------------
+show_marks yes|no
+-----------------
+
+*Example*:
+--------------
+show_marks yes
+--------------
+

 == Configuring i3bar
 
 The bar at the bottom of your monitor is drawn by a separate process called
 == Configuring i3bar
 
 The bar at the bottom of your monitor is drawn by a separate process called


@@ -1023,9 +1120,9 @@ The specified command will be passed to +sh -c+, so you can use globbing and
 have to have correct quoting etc.
 
 *Syntax*:
 have to have correct quoting etc.
 
 *Syntax*:

-----------------------
-i3bar_command command
-----------------------
+-----------------------
+i3bar_command <command>
+-----------------------

 
 *Example*:
 -------------------------------------------------
 
 *Example*:
 -------------------------------------------------


@@ -1042,17 +1139,23 @@ right hand side of the bar. This is useful to display system information like
 your current IP address, battery status or date/time.
 
 The specified command will be passed to +sh -c+, so you can use globbing and
 your current IP address, battery status or date/time.
 
 The specified command will be passed to +sh -c+, so you can use globbing and

-have to have correct quoting etc.
+have to have correct quoting etc. Note that for signal handling, depending on
+your shell (users of dash(1) are known to be affected), you have to use the
+shell’s exec command so that signals are passed to your program, not to the
+shell.

 
 *Syntax*:
 
 *Syntax*:

-----------------------
-status_command command
-----------------------
+------------------------
+status_command <command>
+------------------------

 
 *Example*:
 -------------------------------------------------
 bar {
     status_command i3status --config ~/.i3status.conf
 
 *Example*:
 -------------------------------------------------
 bar {
     status_command i3status --config ~/.i3status.conf

+
+    # For dash(1) users who want signal handling to work:
+    status_command exec ~/.bin/my_status_command

 }
 -------------------------------------------------
 
 }
 -------------------------------------------------
 


@@ -1088,11 +1191,11 @@ The default mode is dock mode; in hide mode, the default modifier is Mod4 (usual
 the windows key). The default value for the hidden_state is hide.
 
 *Syntax*:
 the windows key). The default value for the hidden_state is hide.
 
 *Syntax*:

-----------------
-mode <dock|hide|invisible>
-hidden_state <hide|show>
+-------------------------
+mode dock|hide|invisible
+hidden_state hide|show

 modifier <Modifier>
 modifier <Modifier>

-----------------
+------------------------

 
 *Example*:
 ----------------
 
 *Example*:
 ----------------


@@ -1108,23 +1211,41 @@ Available modifiers are Mod1-Mod5, Shift, Control (see +xmodmap(1)+).
 === Mouse button commands
 
 Specifies a command to run when a button was pressed on i3bar to override the
 === Mouse button commands
 
 Specifies a command to run when a button was pressed on i3bar to override the

-default behavior. Currently only the mouse wheel buttons are supported. This is
-useful for disabling the scroll wheel action or running scripts that implement
-custom behavior for these buttons.
+default behavior. This is useful, e.g., for disabling the scroll wheel action
+or running scripts that implement custom behavior for these buttons.
+
+A button is always named +button<n>+, where 1 to 5 are default buttons as follows and higher
+numbers can be special buttons on devices offering more buttons:
+
+button1::
+    Left mouse button.
+button2::
+    Middle mouse button.
+button3::
+    Right mouse button.
+button4::
+    Scroll wheel up.
+button5::
+    Scroll wheel down.
+
+Please note that the old +wheel_up_cmd+ and +wheel_down_cmd+ commands are deprecated
+and will be removed in a future release. We strongly recommend using the more general
++bindsym+ with +button4+ and +button5+ instead.

 
 *Syntax*:
 
 *Syntax*:

----------------------
-wheel_up_cmd <command>
-wheel_down_cmd <command>
----------------------
+----------------------------
+bindsym button<n> <command>
+----------------------------

 
 *Example*:
 
 *Example*:

----------------------
+---------------------------------------------------------

 bar {
 bar {

-    wheel_up_cmd nop
-    wheel_down_cmd exec ~/.i3/scripts/custom_wheel_down
+    # disable clicking on workspace buttons
+    bindsym button1 nop
+    # execute custom script when scrolling downwards
+    bindsym button5 exec ~/.i3/scripts/custom_wheel_down

 }
 }

----------------------
+---------------------------------------------------------

 
 === Bar ID
 
 
 === Bar ID
 


@@ -1152,9 +1273,9 @@ This option determines in which edge of the screen i3bar should show up.
 The default is bottom.
 
 *Syntax*:
 The default is bottom.
 
 *Syntax*:

----------------------
-position <top|bottom>
----------------------
+-------------------
+position top|bottom
+-------------------

 
 *Example*:
 ---------------------
 
 *Example*:
 ---------------------


@@ -1207,9 +1328,9 @@ You can configure on which output (monitor) the icons should be displayed or
 you can turn off the functionality entirely.
 
 *Syntax*:
 you can turn off the functionality entirely.
 
 *Syntax*:

--------------------------
-tray_output <none|primary|output>
--------------------------
+---------------------------------
+tray_output none|primary|<output>
+---------------------------------

 
 *Example*:
 -------------------------
 
 *Example*:
 -------------------------


@@ -1219,7 +1340,9 @@ bar {
 }
 
 # show tray icons on the primary monitor
 }
 
 # show tray icons on the primary monitor

-tray_output primary
+bar {
+    tray_output primary
+}

 
 # show tray icons on the big monitor
 bar {
 
 # show tray icons on the big monitor
 bar {


@@ -1232,6 +1355,23 @@ Note that you might not have a primary output configured yet. To do so, run:
 xrandr --output <output> --primary
 -------------------------
 
 xrandr --output <output> --primary
 -------------------------
 

+=== Tray padding
+
+The tray is shown on the right-hand side of the bar. By default, a padding of 2
+pixels is used for the upper, lower and right-hand side of the tray area and
+between the individual icons.
+
+*Syntax*:
+-------------------------
+tray_padding <px> [px]
+-------------------------
+
+*Example*:
+-------------------------
+# Obey Fitts's law
+tray_padding 0
+-------------------------
+

 === Font
 
 Specifies the font to be used in the bar. See <<fonts>>.
 === Font
 
 Specifies the font to be used in the bar. See <<fonts>>.


@@ -1249,6 +1389,23 @@ bar {
 }
 --------------------------------------------------------------
 
 }
 --------------------------------------------------------------
 

+=== Custom separator symbol
+
+Specifies a custom symbol to be used for the separator as opposed to the vertical,
+one pixel thick separator.
+
+*Syntax*:
+-------------------------
+separator_symbol <symbol>
+-------------------------
+
+*Example*:
+------------------------
+bar {
+    separator_symbol ":|:"
+}
+------------------------
+

 === Workspace buttons
 
 Specifies whether workspace buttons should be shown or not. This is useful if
 === Workspace buttons
 
 Specifies whether workspace buttons should be shown or not. This is useful if


@@ -1257,9 +1414,9 @@ you want to display a statusline-only bar containing additional information.
 The default is to show workspace buttons.
 
 *Syntax*:
 The default is to show workspace buttons.
 
 *Syntax*:

---------------------------
-workspace_buttons <yes|no>
---------------------------
+------------------------
+workspace_buttons yes|no
+------------------------

 
 *Example*:
 ------------------------
 
 *Example*:
 ------------------------


@@ -1282,9 +1439,9 @@ workspaces to "1:I", "2:II", "3:III", "4:IV", ...
 The default is to display the full name within the workspace button.
 
 *Syntax*:
 The default is to display the full name within the workspace button.
 
 *Syntax*:

-----------------------------------
-strip_workspace_numbers <yes|no>
-----------------------------------
+------------------------------
+strip_workspace_numbers yes|no
+------------------------------

 
 *Example*:
 ----------------------------
 
 *Example*:
 ----------------------------


@@ -1303,9 +1460,9 @@ For an example of a +mode+ definition, see <<resizingconfig>>.
 The default is to show the mode indicator.
 
 *Syntax*:
 The default is to show the mode indicator.
 
 *Syntax*:

--------------------------------
-binding_mode_indicator <yes|no>
--------------------------------
+-----------------------------
+binding_mode_indicator yes|no
+-----------------------------

 
 *Example*:
 -----------------------------
 
 *Example*:
 -----------------------------


@@ -1339,7 +1496,10 @@ inactive_workspace::
        will be the case for most workspaces.
 urgent_workspace::
        Border, background and text color for a workspace button when the workspace
        will be the case for most workspaces.
 urgent_workspace::
        Border, background and text color for a workspace button when the workspace

-       contains a window with the urgency hint set. Also applies to +mode+ indicators.
+       contains a window with the urgency hint set.
+binding_mode::
+        Border, background and text color for the binding mode indicator. If not used,
+        the colors will be taken from +urgent_workspace+.

 
 *Syntax*:
 ----------------------------------------
 
 *Syntax*:
 ----------------------------------------


@@ -1348,7 +1508,7 @@ colors {
     statusline <color>
     separator <color>
 
     statusline <color>
     separator <color>
 

-    colorclass <border> <background> <text>
+    <colorclass> <border> <background> <text>

 }
 ----------------------------------------
 
 }
 ----------------------------------------
 


@@ -1364,6 +1524,7 @@ bar {
         active_workspace   #333333 #5f676a #ffffff
         inactive_workspace #333333 #222222 #888888
         urgent_workspace   #2f343a #900000 #ffffff
         active_workspace   #333333 #5f676a #ffffff
         inactive_workspace #333333 #222222 #888888
         urgent_workspace   #2f343a #900000 #ffffff

+        binding_mode       #2f343a #900000 #ffffff

     }
 }
 --------------------------------------
     }
 }
 --------------------------------------


@@ -1380,6 +1541,8 @@ do this is to use the +i3-msg+ utility:
 i3-msg border none
 --------------------------
 
 i3-msg border none
 --------------------------
 

+[[command_chaining]]
+

 Commands can be chained by using +;+ (a semicolon). So, to move a window to a
 specific workspace and immediately switch to that workspace, you can configure
 the following keybinding:
 Commands can be chained by using +;+ (a semicolon). So, to move a window to a
 specific workspace and immediately switch to that workspace, you can configure
 the following keybinding:


@@ -1424,6 +1587,10 @@ instance::
        Compares the window instance (the first part of WM_CLASS)
 window_role::
        Compares the window role (WM_WINDOW_ROLE).
        Compares the window instance (the first part of WM_CLASS)
 window_role::
        Compares the window role (WM_WINDOW_ROLE).

+window_type::
+        Compare the window type (_NET_WM_WINDOW_TYPE). Possible values are
+        +normal+, +dialog+, +utility+, +toolbar+, +splash+, +menu+, +dropdown_menu+,
+        +popup_menu+ and +toolti+.

 id::
        Compares the X11 window ID, which you can get via +xwininfo+ for example.
 title::
 id::
        Compares the X11 window ID, which you can get via +xwininfo+ for example.
 title::


@@ -1432,14 +1599,16 @@ urgent::
        Compares the urgent state of the window. Can be "latest" or "oldest".
        Matches the latest or oldest urgent window, respectively.
        (The following aliases are also available: newest, last, recent, first)
        Compares the urgent state of the window. Can be "latest" or "oldest".
        Matches the latest or oldest urgent window, respectively.
        (The following aliases are also available: newest, last, recent, first)

+workspace::
+       Compares the workspace name of the workspace the window belongs to.

 con_mark::
        Compares the mark set for this container, see <<vim_like_marks>>.
 con_id::
        Compares the i3-internal container ID, which you can get via the IPC
        interface. Handy for scripting.
 
 con_mark::
        Compares the mark set for this container, see <<vim_like_marks>>.
 con_id::
        Compares the i3-internal container ID, which you can get via the IPC
        interface. Handy for scripting.
 

-The criteria +class+, +instance+, +role+, +title+ and +mark+ are actually
-regular expressions (PCRE). See +pcresyntax(3)+ or +perldoc perlre+ for
+The criteria +class+, +instance+, +role+, +title+, +workspace+ and +mark+ are
+actually regular expressions (PCRE). See +pcresyntax(3)+ or +perldoc perlre+ for

 information on how to use them.
 
 [[exec]]
 information on how to use them.
 
 [[exec]]


@@ -1449,12 +1618,16 @@ information on how to use them.
 What good is a window manager if you can’t actually start any applications?
 The exec command starts an application by passing the command you specify to a
 shell. This implies that you can use globbing (wildcards) and programs will be
 What good is a window manager if you can’t actually start any applications?
 The exec command starts an application by passing the command you specify to a
 shell. This implies that you can use globbing (wildcards) and programs will be

-searched in your $PATH.
+searched in your +$PATH+.
+
+See <<command_chaining>> for details on the special meaning of +;+ (semicolon)
+and +,+ (comma): they chain commands together in i3, so you need to use quoted
+strings if they appear in your command.

 
 *Syntax*:
 
 *Syntax*:

-------------------------------
-exec [--no-startup-id] command
-------------------------------
+--------------------------------
+exec [--no-startup-id] <command>
+--------------------------------

 
 *Example*:
 ------------------------------
 
 *Example*:
 ------------------------------


@@ -1487,9 +1660,9 @@ orientation will be changed (if it does not have more than one window). Use
 to splith or vice-versa.
 
 *Syntax*:
 to splith or vice-versa.
 
 *Syntax*:

----------------------------
-split <vertical|horizontal>
----------------------------
+-------------------------
+split vertical|horizontal
+-------------------------

 
 *Example*:
 ------------------------------
 
 *Example*:
 ------------------------------


@@ -1512,10 +1685,10 @@ Likewise, to make the current window floating (or tiling again) use +floating
 enable+ respectively +floating disable+ (or +floating toggle+):
 
 *Syntax*:
 enable+ respectively +floating disable+ (or +floating toggle+):
 
 *Syntax*:

---------------
-layout <default|tabbed|stacking|splitv|splith>
+--------------------------------------------
+layout default|tabbed|stacking|splitv|splith

 layout toggle [split|all]
 layout toggle [split|all]

---------------
+--------------------------------------------

 
 *Examples*:
 --------------
 
 *Examples*:
 --------------


@@ -1536,15 +1709,17 @@ bindsym $mod+f fullscreen toggle
 bindsym $mod+t floating toggle
 --------------
 
 bindsym $mod+t floating toggle
 --------------
 

-=== Focusing/Moving containers
+[[_focusing_moving_containers]]

 
 

-To change the focus, use the focus command: +focus left+, +focus right+, +focus
-down+ and +focus up+.
+=== Focusing containers

 
 

-There are a few special parameters you can use for the focus command:
+To change focus, you can use the +focus+ command. The following options are
+available:

 
 

+left|right|up|down::
+        Sets focus to the nearest container in the given direction.

 parent::
 parent::

-       Sets focus to the +Parent Container+ of the current +Container+.
+       Sets focus to the parent container of the current container.

 child::
        The opposite of +focus parent+, sets the focus to the last focused
        child container.
 child::
        The opposite of +focus parent+, sets the focus to the last focused
        child container.


@@ -1558,23 +1733,16 @@ output::
        Followed by a direction or an output name, this will focus the
        corresponding output.
 
        Followed by a direction or an output name, this will focus the
        corresponding output.
 

-For moving, use +move left+, +move right+, +move down+ and +move up+.
-

 *Syntax*:
 *Syntax*:

------------------------------------
-focus <left|right|down|up>
-focus <parent|child|floating|tiling|mode_toggle>
-focus output <<left|right|down|up>|output>
-move <left|right|down|up> [<px> px]
-move [absolute] position [[<px> px] [<px> px]|center]
------------------------------------
-
-Note that the amount of pixels you can specify for the +move+ command is only
-relevant for floating containers. The default amount is 10 pixels.
+----------------------------------------------
+focus left|right|down|up
+focus parent|child|floating|tiling|mode_toggle
+focus output left|right|up|down|<output>
+----------------------------------------------

 
 *Examples*:
 
 *Examples*:

-----------------------
-# Focus container on the left, bottom, top, right:
+-------------------------------------------------
+# Focus container on the left, bottom, top, right

 bindsym $mod+j focus left
 bindsym $mod+k focus down
 bindsym $mod+l focus up
 bindsym $mod+j focus left
 bindsym $mod+k focus down
 bindsym $mod+l focus up


@@ -1591,8 +1759,33 @@ bindsym $mod+x focus output right
 
 # Focus the big output
 bindsym $mod+x focus output HDMI-2
 
 # Focus the big output
 bindsym $mod+x focus output HDMI-2

+-------------------------------------------------
+
+=== Moving containers

 
 

-# Move container to the left, bottom, top, right:
+Use the +move+ command to move a container.
+
+*Syntax*:
+-----------------------------------------------------
+# Moves the container into the given direction.
+# The optional pixel argument specifies how far the
+# container should be moved if it is floating and
+# defaults to 10 pixels.
+move <left|right|down|up> [<px> px]
+
+# Moves the container either to a specific location
+# or to the center of the screen. If 'absolute' is
+# used, it is moved to the center of all outputs.
+move [absolute] position [[<px> px] [<px> px]|center]
+
+# Moves the container to the current position of the
+# mouse cursor. Only affects floating containers.
+move position mouse
+-----------------------------------------------------
+
+*Examples*:
+-------------------------------------------------------
+# Move container to the left, bottom, top, right

 bindsym $mod+j move left
 bindsym $mod+k move down
 bindsym $mod+l move up
 bindsym $mod+j move left
 bindsym $mod+k move down
 bindsym $mod+l move up


@@ -1602,10 +1795,12 @@ bindsym $mod+semicolon move right
 # move more than the default
 bindsym $mod+j move left 20 px
 
 # move more than the default
 bindsym $mod+j move left 20 px
 

-# Move floating container to the center
-# of all outputs
+# Move floating container to the center of all outputs

 bindsym $mod+c move absolute position center
 bindsym $mod+c move absolute position center

-----------------------
+
+# Move container to the current position of the cursor
+bindsym $mod+m move position mouse
+-------------------------------------------------------

 
 === Changing (named) workspaces/moving to workspaces
 
 
 === Changing (named) workspaces/moving to workspaces
 


@@ -1636,14 +1831,14 @@ workspace using +move container to workspace back_and_forth+.
 
 *Syntax*:
 -----------------------------------
 
 *Syntax*:
 -----------------------------------

-workspace <next|prev|next_on_output|prev_on_output>
+workspace next|prev|next_on_output|prev_on_output

 workspace back_and_forth
 workspace <name>
 workspace number <name>
 
 move [window|container] [to] workspace <name>
 move [window|container] [to] workspace number <name>
 workspace back_and_forth
 workspace <name>
 workspace number <name>
 
 move [window|container] [to] workspace <name>
 move [window|container] [to] workspace number <name>

-move [window|container] [to] workspace <prev|next|current>
+move [window|container] [to] workspace prev|next|current

 -----------------------------------
 
 *Examples*:
 -----------------------------------
 
 *Examples*:


@@ -1735,10 +1930,10 @@ To move a container to another RandR output (addressed by names like +LVDS1+ or
 +right+, +up+ or +down+), there are two commands:
 
 *Syntax*:
 +right+, +up+ or +down+), there are two commands:
 
 *Syntax*:

---------------------------------------------------------
-move container to output <<left|right|down|up>|<output>>
-move workspace to output <<left|right|down|up>|<output>>
---------------------------------------------------------
+----------------------------------------------------
+move container to output left|right|down|up|<output>
+move workspace to output left|right|down|up|<output>
+----------------------------------------------------

 
 *Examples*:
 --------------------------------------------------------
 
 *Examples*:
 --------------------------------------------------------


@@ -1750,6 +1945,26 @@ bindsym $mod+x move workspace to output right
 bindsym $mod+x move container to output VGA1
 --------------------------------------------------------
 
 bindsym $mod+x move container to output VGA1
 --------------------------------------------------------
 

+=== Moving containers/workspaces to marks
+
+To move a container to another container with a specific mark (see <<vim_like_marks>>),
+you can use the following command.
+
+The window will be moved right after the marked container in the tree, i.e., it ends up
+in the same position as if you had opened a new window when the marked container was
+focused. If the mark is on a split container, the window will appear as a new child
+after the currently focused child within that container.
+
+*Syntax*:
+------------------------------------
+move window|container to mark <mark>
+------------------------------------
+
+*Example*:
+--------------------------------------------------------
+for_window [instance="tabme"] move window to mark target
+--------------------------------------------------------
+

 [[resizingconfig]]
 
 === Resizing containers/windows
 [[resizingconfig]]
 
 === Resizing containers/windows


@@ -1758,9 +1973,9 @@ If you want to resize containers/windows using your keyboard, you can use the
 +resize+ command:
 
 *Syntax*:
 +resize+ command:
 
 *Syntax*:

----------------------------------------------------------
-resize <grow|shrink> <direction> [<px> px [or <ppt> ppt]]
----------------------------------------------------------
+-------------------------------------------------------
+resize grow|shrink <direction> [<px> px [or <ppt> ppt]]
+-------------------------------------------------------

 
 Direction can either be one of +up+, +down+, +left+ or +right+. Or you can be
 less specific and use +width+ or +height+, in which case i3 will take/give
 
 Direction can either be one of +up+, +down+, +left+ or +right+. Or you can be
 less specific and use +width+ or +height+, in which case i3 will take/give


@@ -1839,11 +2054,17 @@ window, you cannot simply bind it to a key.  +i3-input+ is a tool created
 for this purpose: It lets you input a command and sends the command to i3. It
 can also prefix this command and display a custom prompt for the input dialog.
 
 for this purpose: It lets you input a command and sends the command to i3. It
 can also prefix this command and display a custom prompt for the input dialog.
 

+The additional +--toggle+ option will remove the mark if the window already has
+this mark, add it if the window has none or replace the current mark if it has
+another mark.
+
+Refer to +show_marks+ if you don't want marks to be shown in the window decoration.
+

 *Syntax*:
 ------------------------------
 *Syntax*:
 ------------------------------

-mark identifier
+mark [--toggle] <identifier>

 [con_mark="identifier"] focus
 [con_mark="identifier"] focus

-unmark identifier
+unmark <identifier>

 ------------------------------
 
 *Example (in a terminal)*:
 ------------------------------
 
 *Example (in a terminal)*:


@@ -1868,52 +2089,63 @@ Alternatively, if you do not want to mess with +i3-input+, you could create
 seperate bindings for a specific set of labels and then only use those labels.
 ///////////////////////////////////////////////////////////////////
 
 seperate bindings for a specific set of labels and then only use those labels.
 ///////////////////////////////////////////////////////////////////
 

-=== Changing border style
+=== Window title format

 
 

-To change the border of the current client, you can use +border normal+ to use the normal
-border (including window title), +border 1pixel+ to use a 1-pixel border (no window title)
-and +border none+ to make the client borderless.
+By default, i3 will simply print the X11 window title. Using +title_format+,
+this can be customized by setting the format to the desired output. This
+directive supports
+https://developer.gnome.org/pango/stable/PangoMarkupFormat.html[Pango markup]
+and the following placeholders which will be replaced:

 
 

-There is also +border toggle+ which will toggle the different border styles.
++%title+::
+    The X11 window title (_NET_WM_NAME or WM_NAME as fallback).
+
+Using the <<for_window>> directive, you can set the title format for any window
+based on <<command_criteria>>.
+
+*Syntax*:
+---------------------
+title_format <format>
+---------------------

 
 *Examples*:
 
 *Examples*:

-----------------------------
-bindsym $mod+t border normal
-bindsym $mod+y border 1pixel
-bindsym $mod+u border none
-----------------------------
+-------------------------------------------------------------------------------------
+# give the focused window a prefix
+bindsym $mod+p title_format "Important | %title"

 
 

-[[stack-limit]]
+# print all window titles bold
+for_window [class=".*"] title_format "<b>%title</b>"

 
 

-///////////////////////////////////////////////////////////////////////////////
-TODO: not yet implemented
-=== Changing the stack-limit of a container
+# print window titles of firefox windows red
+for_window [class="(?i)firefox"] title_format "<span foreground='red'>%title</span>"
+-------------------------------------------------------------------------------------

 
 

-If you have a single container with a lot of windows inside it (say, more than
-10), the default layout of a stacking container can get a little unhandy.
-Depending on your screen’s size, you might end up with only half of the title
-lines being actually used, wasting a lot of screen space.
+=== Changing border style

 
 

-Using the +stack-limit+ command, you can limit the number of rows or columns
-in a stacking container. i3 will create columns or rows (depending on what
-you limited) automatically as needed.
+To change the border of the current client, you can use +border normal+ to use the normal
+border (including window title), +border pixel 1+ to use a 1-pixel border (no window title)
+and +border none+ to make the client borderless.

 
 

-*Syntax*:
---------------------------------
-stack-limit <cols|rows> <value>
---------------------------------
+There is also +border toggle+ which will toggle the different border styles.

 
 

-*Examples*:
--------------------
-# I always want to have two window titles in one line
-stack-limit cols 2
+*Syntax*:
+-----------------------------------------------
+border normal|pixel [<n>]
+border none|toggle

 
 

-# Not more than 5 rows in this stacking container
-stack-limit rows 5
--------------------
+# legacy syntax, equivalent to "border pixel 1"
+border 1pixel
+-----------------------------------------------

 
 

-image:stacklimit.png[Container limited to two columns]
-///////////////////////////////////////////////////////////////////////////////
+*Examples*:
+----------------------------------------------
+# use window title, but no border
+bindsym $mod+t border normal 0
+# use no window title and a thick border
+bindsym $mod+y border pixel 3
+# use neither window title nor border
+bindsym $mod+u border none
+----------------------------------------------

 
 [[shmlog]]
 
 
 [[shmlog]]
 


@@ -1929,7 +2161,7 @@ discarded and a new one will be started.
 *Syntax*:
 ------------------------------
 shmlog <size_in_bytes>
 *Syntax*:
 ------------------------------
 shmlog <size_in_bytes>

-shmlog <on|off|toggle>
+shmlog on|off|toggle

 ------------------------------
 
 *Examples*:
 ------------------------------
 
 *Examples*:


@@ -1950,9 +2182,9 @@ command does not activate shared memory logging (shmlog), and as such is most
 likely useful in combination with the above-described <<shmlog>> command.
 
 *Syntax*:
 likely useful in combination with the above-described <<shmlog>> command.
 
 *Syntax*:

-------------------------
-debuglog <on|off|toggle>
-------------------------
+----------------------
+debuglog on|off|toggle
+----------------------

 
 *Examples*:
 ------------------------
 
 *Examples*:
 ------------------------


@@ -2011,6 +2243,27 @@ bindsym $mod+minus scratchpad show
 bindsym mod4+s [title="^Sup ::"] scratchpad show
 ------------------------------------------------
 
 bindsym mod4+s [title="^Sup ::"] scratchpad show
 ------------------------------------------------
 

+=== Nop
+
+There is a no operation command +nop+ which allows you to override default
+behavior. This can be useful for, e.g., disabling a focus change on clicks with
+the middle mouse button.
+
+The optional +comment+ argument is ignored, but will be printed to the log file
+for debugging purposes.
+
+*Syntax*:
+---------------
+nop [<comment>]
+---------------
+
+*Example*:
+----------------------------------------------
+# Disable focus change for clicks on titlebars
+# with the middle mouse button
+bindsym button2 nop
+----------------------------------------------
+

 === i3bar control
 
 There are two options in the configuration of each i3bar instance that can be
 === i3bar control
 
 There are two options in the configuration of each i3bar instance that can be