Merge pull request #1632 from Deiz/binding-border

[i3/i3] / docs / userguide

diff --git a/docs/userguide b/docs/userguide
index 3d935e40aac7c2fbf8f5d5f6c2b45e47db4dec8b..96b369024d40a7c2eeb98554cf469aae98f4d614 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


@@ -404,13 +405,16 @@ can configure mouse bindings in a similar way to key bindings.
 
 *Syntax*:
 ----------------------------------
 
 *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*:
 --------------------------------


@@ -589,6 +593,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


@@ -981,6 +1006,51 @@ force_display_urgency_hint <timeout> ms
 force_display_urgency_hint 500 ms
 ---------------------------------
 
 force_display_urgency_hint 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


@@ -1252,8 +1322,7 @@ bar {
 === Custom separator symbol
 
 Specifies a custom symbol to be used for the separator as opposed to the vertical,
 === Custom separator symbol
 
 Specifies a custom symbol to be used for the separator as opposed to the vertical,

-one pixel thick separator. Note that you may have to adjust the +sep_block_width+ 
-property.
+one pixel thick separator.

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


@@ -1857,9 +1926,15 @@ 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
 unmark identifier
 ------------------------------
 [con_mark="identifier"] focus
 unmark identifier
 ------------------------------