From: Michael Stapelberg Date: Sun, 6 Mar 2016 15:18:25 +0000 (+0100) Subject: update docs for 4.12 X-Git-Url: https://git.sur5r.net/?a=commitdiff_plain;h=5f8114c4a6b86f2260a5ddf4efdf45e93914e599;p=i3%2Fi3.github.io update docs for 4.12 --- diff --git a/_docs/debugging b/_docs/debugging index 873c6fb..431a67a 100644 --- a/_docs/debugging +++ b/_docs/debugging @@ -10,7 +10,7 @@ Thank you for being interested in debugging i3. It really means something to us to get your bug fixed. If you have any questions about the process and/or need further help, do not hesitate to contact us! -== Verify you are using i3 ≥ 4.11 +== Verify you are using i3 ≥ 4.12 Only the latest major version of i3 is supported. To verify which version you are running, use: diff --git a/_docs/hacking-howto b/_docs/hacking-howto index d6e2b67..247a179 100644 --- a/_docs/hacking-howto +++ b/_docs/hacking-howto @@ -117,7 +117,7 @@ containers, searching containers, getting specific properties from containers, src/config.c:: Contains all functions handling the configuration file (calling the parser -(src/cfgparse.y) with the correct path, switching key bindings mode). +src/config_parser.c) with the correct path, switching key bindings mode). src/debug.c:: Contains debugging functions to print unhandled X events. diff --git a/_docs/i3bar-protocol b/_docs/i3bar-protocol index 6cb04bf..3ae1445 100644 --- a/_docs/i3bar-protocol +++ b/_docs/i3bar-protocol @@ -136,6 +136,10 @@ color:: when it is associated. Colors are specified in hex (like in HTML), starting with a leading hash sign. For example, +#ff0000+ means red. +background:: + Overrides the background color for this particular block. +border:: + Overrides the border color for this particular block. min_width:: The minimum width (in pixels) of the block. If the content of the +full_text+ key take less space than the specified min_width, the block @@ -207,6 +211,8 @@ An example of a block which uses all possible entries follows: "full_text": "E: 10.0.0.1 (1000 Mbit/s)", "short_text": "10.0.0.1", "color": "#00ff00", + "background": "#1c1c1c", + "border": "#ee0000", "min_width": 300, "align": "right", "urgent": false, diff --git a/_docs/ipc b/_docs/ipc index 5113d79..dc4e694 100644 --- a/_docs/ipc +++ b/_docs/ipc @@ -520,6 +520,14 @@ statusline:: Text color to be used for the statusline. separator:: Text color to be used for the separator. +focused_background:: + Background color of the bar on the currently focused monitor output. +focused_statusline:: + Text color to be used for the statusline on the currently focused + monitor output. +focused_separator:: + Text color to be used for the separator on the currently focused + monitor output. focused_workspace_text/focused_workspace_bg/focused_workspace_border:: Text/background/border color for a workspace button when the workspace has focus. @@ -717,11 +725,15 @@ This event consists of a single serialized map containing a property This event consists of a single serialized map containing a property +change (string)+ which holds the name of current mode in use. The name is the same as specified in config when creating a mode. The default -mode is simply named default. +mode is simply named default. It contains a second property, +pango_markup+, which +defines whether pango markup shall be used for displaying this mode. *Example:* --------------------------- -{ "change": "default" } +{ + "change": "default", + "pango_markup": true +} --------------------------- === window event @@ -814,6 +826,8 @@ know): C:: * i3 includes a headerfile +i3/ipc.h+ which provides you all constants. * https://github.com/acrisci/i3ipc-glib +C++:: + * https://github.com/drmgc/i3ipcpp Go:: * https://github.com/proxypoke/i3ipc JavaScript:: diff --git a/_docs/userguide b/_docs/userguide index 13dae4f..f3f80c9 100644 --- a/_docs/userguide +++ b/_docs/userguide @@ -4,8 +4,9 @@ Michael Stapelberg March 2013 This document contains all the information you need to configure and use the i3 -window manager. If it does not, please check http://faq.i3wm.org/ first, then -contact us on IRC (preferred) or post your question(s) on the mailing list. +window manager. If it does not, please check https://www.reddit.com/r/i3wm/ +first, then contact us on IRC (preferred) or post your question(s) on the +mailing list. == Default keybindings @@ -33,15 +34,15 @@ above, just decline i3-config-wizard’s offer and base your config on == Using i3 Throughout this guide, the keyword +$mod+ will be used to refer to the -configured modifier. This is the Alt key (Mod1) by default, with the Windows -key (Mod4) being a popular alternative. +configured modifier. This is the Alt key (+Mod1+) by default, with the Windows +key (+Mod4+) being a popular alternative. === Opening terminals and moving around One very basic operation is opening a new terminal. By default, the keybinding -for this is $mod+Enter, that is Alt+Enter in the default configuration. By -pressing $mod+Enter, a new terminal will be opened. It will fill the whole -space available on your screen. +for this is +$mod+Enter+, that is Alt+Enter (+Mod1+Enter+) in the default +configuration. By pressing +$mod+Enter+, a new terminal will be opened. It +will fill the whole space available on your screen. image:single_terminal.png[Single terminal] @@ -55,9 +56,9 @@ image:two_terminals.png[Two terminals] To move the focus between the two terminals, you can use the direction keys which you may know from the editor +vi+. However, in i3, your homerow is used for these keys (in +vi+, the keys are shifted to the left by one for -compatibility with most keyboard layouts). Therefore, +$mod+J+ is left, +$mod+K+ -is down, +$mod+L+ is up and `$mod+;` is right. So, to switch between the -terminals, use +$mod+K+ or +$mod+L+. Of course, you can also use the arrow keys. +compatibility with most keyboard layouts). Therefore, +$mod+j+ is left, +$mod+k+ +is down, +$mod+l+ is up and `$mod+;` is right. So, to switch between the +terminals, use +$mod+k+ or +$mod+l+. Of course, you can also use the arrow keys. At the moment, your workspace is split (it contains two terminals) in a specific direction (horizontal by default). Every window can be split @@ -114,7 +115,7 @@ create a keybinding for starting the application directly. See the section === Closing windows If an application does not provide a mechanism for closing (most applications -provide a menu, the escape key or a shortcut like +Control+W+ to close), you +provide a menu, the escape key or a shortcut like +Control+w+ to close), you can press +$mod+Shift+q+ to kill a window. For applications which support the WM_DELETE protocol, this will correctly close the application (saving any modifications or doing other cleanup). If the application doesn’t support @@ -149,8 +150,10 @@ it does not yet exist. The easiest way to resize a container is by using the mouse: Grab the border and move it to the wanted size. -See <> for how to configure i3 to be able to resize -columns/rows with your keyboard. +You can also use <> to define a mode for resizing via the +keyboard. To see an example for this, look at the +https://github.com/i3/i3/blob/next/i3.config.keycodes[default config] provided +by i3. === Restarting i3 inplace @@ -177,7 +180,8 @@ around. By grabbing the borders and moving them you can resize the window. You can also do that by using the <>. Another way to resize floating windows using the mouse is to right-click on the titlebar and drag. -For resizing floating windows with your keyboard, see <>. +For resizing floating windows with your keyboard, see the resizing binding mode +provided by the i3 https://github.com/i3/i3/blob/next/i3.config.keycodes[default config]. Floating windows are always on top of tiling windows. @@ -202,9 +206,8 @@ like this: image::tree-layout2.png["layout2",float="right"] image::tree-shot4.png["shot4",title="Two terminals on standard workspace"] -=== Orientation and Split Containers - [[OrientationSplit]] +=== Orientation and Split Containers It is only natural to use so-called +Split Containers+ in order to build a layout when using a tree as data structure. In i3, every +Container+ has an @@ -288,7 +291,7 @@ with a text editor. On first start (and on all following starts, unless you have a configuration file), i3 will offer you to create a configuration file. You can tell the -wizard to use either Alt (Mod1) or Windows (Mod4) as modifier in the config +wizard to use either Alt (+Mod1+) or Windows (+Mod4+) as modifier in the config file. Also, the created config file will use the key symbols of your current keyboard layout. To start the wizard, use the command +i3-config-wizard+. Please note that you must not have +~/.i3/config+, otherwise the wizard will @@ -306,7 +309,6 @@ a # and can only be used at the beginning of a line: ------------------- [[fonts]] - === Fonts i3 has support for both X core fonts and FreeType fonts (through Pango) to @@ -339,7 +341,6 @@ font pango:Terminus 11px -------------------------------------------------------------- [[keybindings]] - === Keyboard bindings A keyboard binding makes i3 execute a command (see below) upon pressing a @@ -404,7 +405,6 @@ corresponding group. For backwards compatibility, the group “Mode_switch” is alias for Group2. [[mousebindings]] - === Mouse bindings A mouse binding makes i3 execute a command upon pressing a specific mouse @@ -441,8 +441,59 @@ bindsym button9 move left bindsym button8 move right -------------------------------- -[[floating_modifier]] +[[binding_modes]] +=== Binding modes +You can have multiple sets of bindings by using different binding modes. When +you switch to another binding mode, all bindings from the current mode are +released and only the bindings defined in the new mode are valid for as long as +you stay in that binding mode. The only predefined binding mode is +default+, +which is the mode i3 starts out with and to which all bindings not defined in a +specific binding mode belong. + +Working with binding modes consists of two parts: defining a binding mode and +switching to it. For these purposes, there are one config directive and one +command, both of which are called +mode+. The directive is used to define the +bindings belonging to a certain binding mode, while the command will switch to +the specified mode. + +It is recommended to use binding modes in combination with <> in +order to make maintenance easier. Below is an example of how to use a binding +mode. + +Note that it is advisable to define bindings for switching back to the default +mode. + +Note that it is possible to use <> for binding modes, but you +need to enable it explicitly by passing the +--pango_markup+ flag to the mode +definition. + +*Syntax*: +---------------------------- +# config directive +mode [--pango_markup] + +# command +mode +---------------------------- + +*Example*: +------------------------------------------------------------------------ +# Press $mod+o followed by either f, t, Esc or Return to launch firefox, +# thunderbird or return to the default mode, respectively. +set $mode_launcher Launch: [f]irefox [t]hunderbird +bindsym $mod+o mode "$mode_launcher" + +mode "$mode_launcher" { + bindsym f exec firefox + bindsym t exec thunderbird + + bindsym Esc mode "default" + bindsym Return mode "default" +} +------------------------------------------------------------------------ + +[[floating_modifier]] === The floating modifier To move floating windows with your mouse, you can either grab their titlebar @@ -554,9 +605,10 @@ new_window pixel 3 --------------------- -=== Hiding vertical borders +[[_hiding_vertical_borders]] +=== Hiding borders adjacent to the screen edges -You can hide vertical borders adjacent to the screen edges using +You can hide container borders adjacent to the screen edges using +hide_edge_borders+. This is useful if you are using scrollbars, or do not want to waste even two pixels in displayspace. Default is none. @@ -570,9 +622,8 @@ hide_edge_borders none|vertical|horizontal|both hide_edge_borders vertical ---------------------- -=== Arbitrary commands for specific windows (for_window) - [[for_window]] +=== Arbitrary commands for specific windows (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 @@ -599,17 +650,20 @@ for_window [title="x200: ~/work"] floating enable The valid criteria are the same as those for commands, see <>. -=== Don't focus window upon opening - [[no_focus]] +=== Don't focus window upon opening 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 <>. +this from happening and must be used in combination with <>. 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 <>. ++no_focus+ will also be ignored for the first window on a workspace as there shouldn't be +a reason to not focus the window in this case. This allows for better usability in +combination with +workspace_layout+. + *Syntax*: ------------------- no_focus @@ -620,6 +674,7 @@ no_focus no_focus [window_role="pop-up"] ------------------------------- +[[variables]] === Variables As you learned in the section about keyboard bindings, you will have @@ -645,9 +700,8 @@ absolutely no plans to change this. If you need a more dynamic configuration you should create a little script which generates a configuration file and run it before starting i3 (for example in your +~/.xsession+ file). -=== Automatically putting clients on specific workspaces - [[assign_workspace]] +=== Automatically putting clients on specific workspaces To automatically make a specific window show up on a specific workspace, you can use an *assignment*. You can match windows by using any criteria, @@ -732,7 +786,7 @@ keyword. These commands will be run in order. See <> 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. +strings (as shown in <>) if they appear in your command. *Syntax*: --------------------------------------- @@ -752,7 +806,6 @@ exec --no-startup-id urxvt The flag --no-startup-id is explained in <>. [[workspace_screen]] - === Automatically putting workspaces on specific screens If you assign clients to workspaces, it might be handy to put the @@ -784,9 +837,9 @@ workspace "2: vim" output VGA1 You can change all colors which i3 uses to draw the window decorations. *Syntax*: ------------------------------------------------------- - ------------------------------------------------------- +-------------------------------------------------------------------- + +-------------------------------------------------------------------- Where colorclass can be one of: @@ -811,20 +864,20 @@ client.background:: Colors are in HTML hex format (#rrggbb), see the following example: *Examples (default colors)*: ---------------------------------------------------------- -# class border backgr. text indicator -client.focused #4c7899 #285577 #ffffff #2e9ef4 -client.focused_inactive #333333 #5f676a #ffffff #484e50 -client.unfocused #333333 #222222 #888888 #292d2e -client.urgent #2f343a #900000 #ffffff #900000 -client.placeholder #000000 #0c0c0c #ffffff #000000 +---------------------------------------------------------------------- +# class border backgr. text indicator child_border +client.focused #4c7899 #285577 #ffffff #2e9ef4 #285577 +client.focused_inactive #333333 #5f676a #ffffff #484e50 #5f676a +client.unfocused #333333 #222222 #888888 #292d2e #222222 +client.urgent #2f343a #900000 #ffffff #900000 #900000 +client.placeholder #000000 #0c0c0c #ffffff #000000 #0c0c0c client.background #ffffff ---------------------------------------------------------- +---------------------------------------------------------------------- Note that for the window decorations, the color around the child window is the -background color, and the border color is only the two thin lines at the top of -the window. +"child_border", and "border" color is only the two thin lines around the +titlebar. The indicator color is used for indicating where a new window will be opened. For horizontal split containers, the right border will be painted in indicator @@ -1011,9 +1064,8 @@ force_display_urgency_hint ms force_display_urgency_hint 500 ms --------------------------------- -=== Focus on window activation - [[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. @@ -1038,6 +1090,7 @@ focus:: none:: The window will neither be focused, nor be marked urgent. +[[show_marks]] === Drawing marks on window decoration If activated, marks on windows are drawn in their window decoration. However, @@ -1057,7 +1110,6 @@ show_marks yes -------------- [[line_continuation]] - === Line continuation Config files support line continuation, meaning when you end a line in a @@ -1186,7 +1238,7 @@ the windows key). The default value for the hidden_state is hide. ------------------------- mode dock|hide|invisible hidden_state hide|show -modifier +modifier |none ------------------------ *Example*: @@ -1198,7 +1250,8 @@ bar { } ---------------- -Available modifiers are Mod1-Mod5, Shift, Control (see +xmodmap(1)+). +Available modifiers are Mod1-Mod5, Shift, Control (see +xmodmap(1)+). You can +also use "none" if you don't want any modifier to trigger this behavior. === Mouse button commands @@ -1319,6 +1372,11 @@ NetworkManager, VLC, Pidgin, etc. can place little icons. You can configure on which output (monitor) the icons should be displayed or you can turn off the functionality entirely. +You can use mutliple +tray_output+ directives in your config to specify a list +of outputs on which you want the tray to appear. The first available output in +that list as defined by the order of the directives will be used for the tray +output. + *Syntax*: --------------------------------- tray_output none|primary| @@ -1451,8 +1509,8 @@ bar { Specifies whether the current binding mode indicator should be shown or not. This is useful if you want to hide the workspace buttons but still be able -to see the current binding mode indicator. -For an example of a +mode+ definition, see <>. +to see the current binding mode indicator. See <> to learn what +modes are and how to use them. The default is to show the mode indicator. @@ -1479,6 +1537,15 @@ statusline:: Text color to be used for the statusline. separator:: Text color to be used for the separator. +focused_background:: + Background color of the bar on the currently focused monitor output. If + not used, the color will be taken from +background+. +focused_statusline:: + Text color to be used for the statusline on the currently focused + monitor output. If not used, the color will be taken from +statusline+. +focused_separator:: + Text color to be used for the separator on the currently focused + monitor output. If not used, the color will be taken from +separator+. focused_workspace:: Border, background and text color for a workspace button when the workspace has focus. @@ -1580,25 +1647,25 @@ The criteria which are currently implemented are: class:: Compares the window class (the second part of WM_CLASS). Use the - special value +__focused__+ to match all windows having the same window + special value +\_\_focused__+ to match all windows having the same window class as the currently focused window. instance:: Compares the window instance (the first part of WM_CLASS). Use the - special value +__focused__+ to match all windows having the same window + special value +\_\_focused__+ to match all windows having the same window instance as the currently focused window. window_role:: Compares the window role (WM_WINDOW_ROLE). Use the special value - +__focused__+ to match all windows having the same window role as the + +\_\_focused__+ to match all windows having the same window role as the currently focused window. window_type:: Compare the window type (_NET_WM_WINDOW_TYPE). Possible values are +normal+, +dialog+, +utility+, +toolbar+, +splash+, +menu+, +dropdown_menu+, - +popup_menu+ and +tooltip+. + +popup_menu+, +tooltip+ and +notification+. id:: Compares the X11 window ID, which you can get via +xwininfo+ for example. title:: - Compares the X11 window title (_NET_WM_NAME or WM_NAME as fallback). - Use the special value +__focused__+ to match all windows having the + Compares the X11 window title (\_NET_WM_NAME or WM_NAME as fallback). + Use the special value +\_\_focused__+ to match all windows having the same window title as the currently focused window. urgent:: Compares the urgent state of the window. Can be "latest" or "oldest". @@ -1606,20 +1673,22 @@ urgent:: (The following aliases are also available: newest, last, recent, first) workspace:: Compares the workspace name of the workspace the window belongs to. Use - the special value +__focused__+ to match all windows in the currently + the special value +\_\_focused__+ to match all windows in the currently focused workspace. con_mark:: - Compares the mark set for this container, see <>. + Compares the marks set for this container, see <>. A + match is made if any of the container's marks matches the specified + mark. con_id:: Compares the i3-internal container ID, which you can get via the IPC - interface. Handy for scripting. + interface. Handy for scripting. Use the special value +\_\_focused__+ + to match only the currently focused window. 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]] - === Executing applications (exec) What good is a window manager if you can’t actually start any applications? @@ -1629,7 +1698,7 @@ searched in your +$PATH+. See <> 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. +strings (as shown in <>) if they appear in your command. *Syntax*: -------------------------------- @@ -1653,6 +1722,27 @@ launching. So, if an application is not startup-notification aware (most GTK and Qt using applications seem to be, though), you will end up with a watch cursor for 60 seconds. +[[exec_quoting]] +If the command to be executed contains a +;+ (semicolon) and/or a +,+ (comma), +the entire command must be quoted. For example, to have a keybinding for the +shell command +notify-send Hello, i3+, you would add an entry to your +configuration file like this: + +*Example*: +------------------------------ +# Execute a command with a comma in it +bindsym $mod+p exec "notify-send Hello, i3" +------------------------------ + +If however a command with a comma and/or semicolon itself requires quotes, you +must escape the internal quotation marks with double backslashes, like this: + +*Example*: +------------------------------ +# Execute a command with a comma, semicolon and internal quotes +bindsym $mod+p exec "notify-send \\"Hello, i3; from $USER\\"" +------------------------------ + === Splitting containers The split command makes the current window a split container. Split containers @@ -1662,20 +1752,24 @@ get placed below the current one (splitv). If you apply this command to a split container with the same orientation, nothing will happen. If you use a different orientation, the split container’s -orientation will be changed (if it does not have more than one window). Use -+layout toggle split+ to change the layout of any split container from splitv -to splith or vice-versa. +orientation will be changed (if it does not have more than one window). +The +toggle+ option will toggle the orientation of the split container if it +contains a single window. Otherwise it makes the current window a split +container with opposite orientation compared to the parent container. +Use +layout toggle split+ to change the layout of any split container from +splitv to splith or vice-versa. *Syntax*: -------------------------- -split vertical|horizontal -------------------------- +-------------------------------- +split vertical|horizontal|toggle +-------------------------------- *Example*: ------------------------------- +------------------------------- bindsym $mod+v split vertical bindsym $mod+h split horizontal ------------------------------- +bindsym $mod+t split toggle +------------------------------- === Manipulating layout @@ -1717,7 +1811,6 @@ bindsym $mod+t floating toggle -------------- [[_focusing_moving_containers]] - === Focusing containers To change focus, you can use the +focus+ command. The following options are @@ -1833,8 +1926,11 @@ for_window [instance=notepad] sticky enable === Changing (named) workspaces/moving to workspaces To change to a specific workspace, use the +workspace+ command, followed by the -number or name of the workspace. To move containers to specific workspaces, use -+move container to workspace+. +number or name of the workspace. Pass the optional flag ++--no-auto-back-and-forth+ to disable <> for this specific call +only. + +To move containers to specific workspaces, use +move container to workspace+. 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 @@ -1845,6 +1941,10 @@ container to workspace next+, +move container to workspace prev+ to move a container to the next/previous workspace and +move container to workspace current+ (the last one makes sense only when used with criteria). ++workspace next+ cycles through either numbered or named workspaces. But when it +reaches the last numbered/named workspace, it looks for named workspaces after +exhausting numbered ones and looks for numbered ones after exhausting named ones. + See <> for how to move a container/workspace to a different RandR output. @@ -1858,16 +1958,16 @@ back_and_forth+; likewise, you can move containers to the previously focused workspace using +move container to workspace back_and_forth+. *Syntax*: ------------------------------------ +-------------------------------------------------------------------------------- workspace next|prev|next_on_output|prev_on_output workspace back_and_forth -workspace -workspace number +workspace [--no-auto-back-and-forth] +workspace [--no-auto-back-and-forth] number -move [window|container] [to] workspace -move [window|container] [to] workspace number +move [--no-auto-back-and-forth] [window|container] [to] workspace +move [--no-auto-back-and-forth] [window|container] [to] workspace number move [window|container] [to] workspace prev|next|current ------------------------------------ +-------------------------------------------------------------------------------- *Examples*: ------------------------- @@ -1949,9 +2049,8 @@ bindsym $mod+r exec i3-input -F 'rename workspace to "%s"' -P 'New name: ' See <> for how to move a container/workspace to a different RandR output. -=== Moving containers/workspaces to RandR outputs - [[move_to_outputs]] +=== Moving containers/workspaces to RandR outputs To move a container to another RandR output (addressed by names like +LVDS1+ or +VGA1+) or to a RandR output identified by a specific direction (like +left+, @@ -1973,7 +2072,7 @@ bindsym $mod+x move workspace to output right bindsym $mod+x move container to output VGA1 -------------------------------------------------------- -=== Moving containers/workspaces to marks +=== Moving containers/windows to marks To move a container to another container with a specific mark (see <>), you can use the following command. @@ -1994,7 +2093,6 @@ for_window [instance="tabme"] move window to mark target -------------------------------------------------------- [[resizingconfig]] - === Resizing containers/windows If you want to resize containers/windows using your keyboard, you can use the @@ -2015,38 +2113,12 @@ many percentage points a *tiling container* should be grown or shrunk (the default is 10 percentage points). Note that +resize set+ will only work for floating containers. -I recommend using the resize command inside a so called +mode+: - -.Example: Configuration file, defining a mode for resizing ----------------------------------------------------------------------- -mode "resize" { - # These bindings trigger as soon as you enter the resize mode - - # Pressing left will shrink the window’s width. - # Pressing right will grow the window’s width. - # Pressing up will shrink the window’s height. - # Pressing down will grow the window’s height. - bindsym j resize shrink width 10 px or 10 ppt - bindsym k resize grow height 10 px or 10 ppt - bindsym l resize shrink height 10 px or 10 ppt - bindsym semicolon resize grow width 10 px or 10 ppt - - # same bindings, but for the arrow keys - bindsym Left resize shrink width 10 px or 10 ppt - bindsym Down resize grow height 10 px or 10 ppt - bindsym Up resize shrink height 10 px or 10 ppt - bindsym Right resize grow width 10 px or 10 ppt - - # back to normal: Enter or Escape - bindsym Return mode "default" - bindsym Escape mode "default" -} - -# Enter resize mode -bindsym $mod+r mode "resize" ----------------------------------------------------------------------- +It is recommended to define bindings for resizing in a dedicated binding mode. +See <> and the example in the i3 +https://github.com/i3/i3/blob/next/i3.config.keycodes[default config] for more +context. -*Example 2 - setting urxvt size to 640x480:* +*Example*: ------------------------------------------------ for_window [class="urxvt"] resize set 640 480 ------------------------------------------------ @@ -2072,9 +2144,8 @@ with criteria for that. bindsym $mod+a [class="urxvt" title="VIM"] focus ------------------------------------------------ -=== VIM-like marks (mark/goto) - [[vim_like_marks]] +=== VIM-like marks (mark/goto) This feature is like the jump feature: It allows you to directly jump to a specific window (this means switching to the appropriate workspace and setting @@ -2090,24 +2161,36 @@ 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. +this mark or add it otherwise. Note that you may need to use this in +combination with +--add+ (see below) as any other marks will otherwise be +removed. + +By default, a window can only have one mark. You can use the +--add+ flag to +put more than one mark on a window. -Refer to +show_marks+ if you don't want marks to be shown in the window decoration. +Refer to <> if you don't want marks to be shown in the window decoration. *Syntax*: ------------------------------- -mark [--toggle] +---------------------------------------------- +mark [--add|--replace] [--toggle] [con_mark="identifier"] focus unmark ------------------------------- +---------------------------------------------- *Example (in a terminal)*: ------------------------------- -$ i3-msg mark irssi -$ i3-msg '[con_mark="irssi"] focus' -$ i3-msg unmark irssi ------------------------------- +--------------------------------------------------------- +# marks the focused container +mark irssi + +# focus the container with the mark "irssi" +'[con_mark="irssi"] focus' + +# remove the mark "irssi" from whichever container has it +unmark irssi + +# remove all marks on all firefox windows +[class="(?i)firefox"] unmark +--------------------------------------------------------- /////////////////////////////////////////////////////////////////// TODO: make i3-input replace %s @@ -2124,6 +2207,7 @@ 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. /////////////////////////////////////////////////////////////////// +[[pango_markup]] === Window title format By default, i3 will simply print the X11 window title. Using +title_format+, @@ -2133,11 +2217,14 @@ https://developer.gnome.org/pango/stable/PangoMarkupFormat.html[Pango markup] and the following placeholders which will be replaced: +%title+:: - The X11 window title (_NET_WM_NAME or WM_NAME as fallback). -+%class+: + For normal windows, this is the X11 window title (_NET_WM_NAME or WM_NAME + as fallback). When used on containers without a window (e.g., a split + container inside a tabbed/stacked layout), this will be the tree + representation of the container (e.g., "H[xterm xterm]"). ++%class+:: The X11 window class (second part of WM_CLASS). This corresponds to the +class+ criterion, see <>. -+%instance+: ++%instance+:: The X11 window instance (first part of WM_CLASS). This corresponds to the +instance+ criterion, see <>. @@ -2169,6 +2256,10 @@ and +border none+ to make the client borderless. There is also +border toggle+ which will toggle the different border styles. +Note that "pixel" refers to logical pixel. On HiDPI displays, a logical pixel +may be represented by multiple physical pixels, so +pixel 1+ might not +necessarily translate into a single pixel row wide border. + *Syntax*: ----------------------------------------------- border normal|pixel [] @@ -2189,7 +2280,6 @@ bindsym $mod+u border none ---------------------------------------------- [[shmlog]] - === Enabling shared memory logging As described in http://i3wm.org/docs/debugging.html, i3 can log to a shared @@ -2338,7 +2428,6 @@ bindsym $mod+Shift+b bar mode invisible bar-1 ------------------------------------------------ [[multi_monitor]] - == Multiple monitors As you can see in the goal list on the website, i3 was specifically developed @@ -2468,6 +2557,7 @@ position the window either at the top or at the bottom of the screen, depending on which hint the application sets. With i3bar, you can configure its position, see <>. +[[presentations]] === Giving presentations (multi-monitor) When giving a presentation, you typically want the audience to see what you see @@ -2476,7 +2566,6 @@ simple). For more complex presentations, you might want to have some notes which only you can see on your screen, while the audience can only see the slides. -[[presentations]] ==== Case 1: everybody gets the same output This is the simple case. You connect your computer to the video projector, turn on both (computer and video projector) and configure your X server to diff --git a/docs/debugging.html b/docs/debugging.html index 7e0420c..9e61131 100644 --- a/docs/debugging.html +++ b/docs/debugging.html @@ -44,7 +44,7 @@ process and/or need further help, do not hesitate to contact us!

-

1. Verify you are using i3 ≥ 4.11

+

1. Verify you are using i3 ≥ 4.12

Only the latest major version of i3 is supported. To verify which version you are running, use:

diff --git a/docs/hacking-howto.html b/docs/hacking-howto.html index fffc7cd..a2a6646 100644 --- a/docs/hacking-howto.html +++ b/docs/hacking-howto.html @@ -236,7 +236,7 @@ src/config.c

Contains all functions handling the configuration file (calling the parser -(src/cfgparse.y) with the correct path, switching key bindings mode). +src/config_parser.c) with the correct path, switching key bindings mode).

diff --git a/docs/i3bar-protocol.html b/docs/i3bar-protocol.html index 3285613..1e9cb2d 100644 --- a/docs/i3bar-protocol.html +++ b/docs/i3bar-protocol.html @@ -230,6 +230,22 @@ color

+background +
+
+

+ Overrides the background color for this particular block. +

+
+
+border +
+
+

+ Overrides the border color for this particular block. +

+
+
min_width
@@ -340,6 +356,8 @@ used to set the minimum width:

"full_text": "E: 10.0.0.1 (1000 Mbit/s)", "short_text": "10.0.0.1", "color": "#00ff00", + "background": "#1c1c1c", + "border": "#ee0000", "min_width": 300, "align": "right", "urgent": false, diff --git a/docs/ipc.html b/docs/ipc.html index 5f25c82..9f55e32 100644 --- a/docs/ipc.html +++ b/docs/ipc.html @@ -947,6 +947,32 @@ separator

+focused_background +
+
+

+ Background color of the bar on the currently focused monitor output. +

+
+
+focused_statusline +
+
+

+ Text color to be used for the statusline on the currently focused + monitor output. +

+
+
+focused_separator +
+
+

+ Text color to be used for the separator on the currently focused + monitor output. +

+
+
focused_workspace_text/focused_workspace_bg/focused_workspace_border
@@ -1238,11 +1264,15 @@ property.

This event consists of a single serialized map containing a property change (string) which holds the name of current mode in use. The name is the same as specified in config when creating a mode. The default -mode is simply named default.

+mode is simply named default. It contains a second property, pango_markup, which +defines whether pango markup shall be used for displaying this mode.

Example:

-
{ "change": "default" }
+
{
+  "change": "default",
+  "pango_markup": true
+}
@@ -1413,6 +1443,18 @@ i3 includes a headerfile i3/ipc.h which provides you all constants.
+C++ +
+
+
+
+
Go
diff --git a/docs/userguide.html b/docs/userguide.html index 5dd9e0d..81c9104 100644 --- a/docs/userguide.html +++ b/docs/userguide.html @@ -41,8 +41,9 @@ document.addEventListener("DOMContentLoaded", function(){asciidoc.footnotes(); a

This document contains all the information you need to configure and use the i3 -window manager. If it does not, please check http://faq.i3wm.org/ first, then -contact us on IRC (preferred) or post your question(s) on the mailing list.

+window manager. If it does not, please check https://www.reddit.com/r/i3wm/ +first, then contact us on IRC (preferred) or post your question(s) on the +mailing list.

@@ -76,14 +77,14 @@ above, just decline i3-config-wizard’s offer and base your config on

2. Using i3

Throughout this guide, the keyword $mod will be used to refer to the -configured modifier. This is the Alt key (Mod1) by default, with the Windows -key (Mod4) being a popular alternative.

+configured modifier. This is the Alt key (Mod1) by default, with the Windows +key (Mod4) being a popular alternative.

2.1. Opening terminals and moving around

One very basic operation is opening a new terminal. By default, the keybinding -for this is $mod+Enter, that is Alt+Enter in the default configuration. By -pressing $mod+Enter, a new terminal will be opened. It will fill the whole -space available on your screen.

+for this is $mod+Enter, that is Alt+Enter (Mod1+Enter) in the default +configuration. By pressing $mod+Enter, a new terminal will be opened. It +will fill the whole space available on your screen.

Single terminal

@@ -97,9 +98,9 @@ existing window (rotated displays).

To move the focus between the two terminals, you can use the direction keys which you may know from the editor vi. However, in i3, your homerow is used for these keys (in vi, the keys are shifted to the left by one for -compatibility with most keyboard layouts). Therefore, $mod+J is left, $mod+K -is down, $mod+L is up and $mod+; is right. So, to switch between the -terminals, use $mod+K or $mod+L. Of course, you can also use the arrow keys.

+compatibility with most keyboard layouts). Therefore, $mod+j is left, $mod+k +is down, $mod+l is up and $mod+; is right. So, to switch between the +terminals, use $mod+k or $mod+l. Of course, you can also use the arrow keys.

At the moment, your workspace is split (it contains two terminals) in a specific direction (horizontal by default). Every window can be split horizontally or vertically again, just like the workspace. The terminology is @@ -170,7 +171,7 @@ create a keybinding for starting the application directly. See the section

2.5. Closing windows

If an application does not provide a mechanism for closing (most applications -provide a menu, the escape key or a shortcut like Control+W to close), you +provide a menu, the escape key or a shortcut like Control+w to close), you can press $mod+Shift+q to kill a window. For applications which support the WM_DELETE protocol, this will correctly close the application (saving any modifications or doing other cleanup). If the application doesn’t support @@ -202,8 +203,10 @@ it does not yet exist.

2.8. Resizing

The easiest way to resize a container is by using the mouse: Grab the border and move it to the wanted size.

-

See [resizingconfig] for how to configure i3 to be able to resize -columns/rows with your keyboard.

+

You can also use [binding_modes] to define a mode for resizing via the +keyboard. To see an example for this, look at the +default config provided +by i3.

2.9. Restarting i3 inplace

@@ -228,7 +231,8 @@ dragging the window’s titlebar with your mouse you can move the window around. By grabbing the borders and moving them you can resize the window. You can also do that by using the [floating_modifier]. Another way to resize floating windows using the mouse is to right-click on the titlebar and drag.

-

For resizing floating windows with your keyboard, see [resizingconfig].

+

For resizing floating windows with your keyboard, see the resizing binding mode +provided by the i3 default config.

Floating windows are always on top of tiling windows.

@@ -263,8 +267,8 @@ like this:

-

3.2. Orientation and Split Containers

-

It is only natural to use so-called Split Containers in order to build a +

3.2. Orientation and Split Containers

+

It is only natural to use so-called Split Containers in order to build a layout when using a tree as data structure. In i3, every Container has an orientation (horizontal, vertical or unspecified) and the orientation depends on the layout the container is in (vertical for splitv and stacking, horizontal @@ -354,7 +358,7 @@ can bind your keys to do useful things.

with a text editor.

On first start (and on all following starts, unless you have a configuration file), i3 will offer you to create a configuration file. You can tell the -wizard to use either Alt (Mod1) or Windows (Mod4) as modifier in the config +wizard to use either Alt (Mod1) or Windows (Mod4) as modifier in the config file. Also, the created config file will use the key symbols of your current keyboard layout. To start the wizard, use the command i3-config-wizard. Please note that you must not have ~/.i3/config, otherwise the wizard will @@ -513,7 +517,54 @@ bindsym button8 move right

-

4.5. The floating modifier

+

4.5. Binding modes

+

You can have multiple sets of bindings by using different binding modes. When +you switch to another binding mode, all bindings from the current mode are +released and only the bindings defined in the new mode are valid for as long as +you stay in that binding mode. The only predefined binding mode is default, +which is the mode i3 starts out with and to which all bindings not defined in a +specific binding mode belong.

+

Working with binding modes consists of two parts: defining a binding mode and +switching to it. For these purposes, there are one config directive and one +command, both of which are called mode. The directive is used to define the +bindings belonging to a certain binding mode, while the command will switch to +the specified mode.

+

It is recommended to use binding modes in combination with [variables] in +order to make maintenance easier. Below is an example of how to use a binding +mode.

+

Note that it is advisable to define bindings for switching back to the default +mode.

+

Note that it is possible to use [pango_markup] for binding modes, but you +need to enable it explicitly by passing the --pango_markup flag to the mode +definition.

+

Syntax:

+
+
+
# config directive
+mode [--pango_markup] <name>
+
+# command
+mode <name>
+
+

Example:

+
+
+
# Press $mod+o followed by either f, t, Esc or Return to launch firefox,
+# thunderbird or return to the default mode, respectively.
+set $mode_launcher Launch: [f]irefox [t]hunderbird
+bindsym $mod+o mode "$mode_launcher"
+
+mode "$mode_launcher" {
+    bindsym f exec firefox
+    bindsym t exec thunderbird
+
+    bindsym Esc mode "default"
+    bindsym Return mode "default"
+}
+
+
+
+

4.6. The floating modifier

To move floating windows with your mouse, you can either grab their titlebar or configure the so called floating modifier which you can then press and click anywhere in the window itself to move it. The most common setup is to @@ -536,7 +587,7 @@ ratio will be preserved).

-

4.6. Constraining floating window size

+

4.7. Constraining floating window size

The maximum and minimum dimensions of floating windows can be specified. If either dimension of floating_maximum_size is specified as -1, that dimension will be unconstrained with respect to its maximum value. If either dimension of @@ -557,7 +608,7 @@ floating_maximum_size -1 x -1

-

4.7. Orientation for new workspaces

+

4.8. Orientation for new workspaces

New workspaces get a reasonable default orientation: Wide-screen monitors (anything wider than high) get horizontal orientation, rotated monitors (anything higher than wide) get vertical orientation.

@@ -575,7 +626,7 @@ behavior.

-

4.8. Layout mode for new containers

+

4.9. Layout mode for new containers

This option determines in which mode new containers on workspace level will start.

Syntax:

@@ -590,7 +641,7 @@ start.

-

4.9. Border style for new windows

+

4.10. 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, but not windows that are floated later on.

@@ -620,8 +671,8 @@ new_window pixel 3
-

4.10. Hiding vertical borders

-

You can hide vertical borders adjacent to the screen edges using +

4.11. Hiding borders adjacent to the screen edges

+

You can hide container borders adjacent to the screen edges using hide_edge_borders. This is useful if you are using scrollbars, or do not want to waste even two pixels in displayspace. Default is none.

Syntax:

@@ -636,8 +687,8 @@ to waste even two pixels in displayspace. Default is none.

-

4.11. Arbitrary commands for specific windows (for_window)

-

With the for_window command, you can let i3 execute any command when it +

4.12. Arbitrary commands for specific windows (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:

@@ -662,12 +713,15 @@ for_window [title="x200: ~/work"] floating enable

The valid criteria are the same as those for commands, see [command_criteria].

-

4.12. Don’t focus window upon opening

-

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].

+

4.13. Don’t focus window upon opening

+

When a new window appears, it will be focused. The no_focus directive allows preventing +this from happening and must 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].

+

no_focus will also be ignored for the first window on a workspace as there shouldn’t be +a reason to not focus the window in this case. This allows for better usability in +combination with workspace_layout.

Syntax:

@@ -680,7 +734,7 @@ causing it to request being focused. To configure the behavior in such cases, re
-

4.13. Variables

+

4.14. Variables

As you learned in the section about keyboard bindings, you will have to configure lots of bindings containing modifier keys. If you want to save yourself some typing and be able to change the modifier you use later, @@ -704,8 +758,8 @@ you should create a little script which generates a configuration file and run it before starting i3 (for example in your ~/.xsession file).

-

4.14. Automatically putting clients on specific workspaces

-

To automatically make a specific window show up on a specific workspace, you +

4.15. Automatically putting clients on specific workspaces

+

To automatically make a specific window show up on a specific workspace, you can use an assignment. You can match windows by using any criteria, see [command_criteria]. It is recommended that you match on window classes (and instances, when appropriate) instead of window titles whenever possible @@ -773,7 +827,7 @@ exec --no-startup-id i3-msg 'workspace 3; exec iceweasel; workspace 1'

-

4.15. Automatically starting applications on i3 startup

+

4.16. Automatically starting applications on i3 startup

By using the exec keyword outside a keybinding, you can configure which commands will be performed by i3 on initial startup. exec commands will not run when restarting i3, if you need a command to run @@ -781,7 +835,7 @@ 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.

+strings (as shown in [exec_quoting]) if they appear in your command.

Syntax:

@@ -800,7 +854,7 @@ exec --no-startup-id urxvt

The flag --no-startup-id is explained in [exec].

-

4.16. Automatically putting workspaces on specific screens

+

4.17. Automatically putting workspaces on specific screens

If you assign clients to workspaces, it might be handy to put the workspaces on specific screens. Also, the assignment of workspaces to screens will determine which workspace i3 uses for a new screen when adding screens @@ -824,12 +878,12 @@ workspace "2: vim" output VGA1

-

4.17. Changing colors

+

4.18. Changing colors

You can change all colors which i3 uses to draw the window decorations.

Syntax:

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

Where colorclass can be one of:

@@ -891,18 +945,18 @@ client.background

Examples (default colors):

-
# class                 border  backgr. text    indicator
-client.focused          #4c7899 #285577 #ffffff #2e9ef4
-client.focused_inactive #333333 #5f676a #ffffff #484e50
-client.unfocused        #333333 #222222 #888888 #292d2e
-client.urgent           #2f343a #900000 #ffffff #900000
-client.placeholder      #000000 #0c0c0c #ffffff #000000
+
# class                 border  backgr. text    indicator child_border
+client.focused          #4c7899 #285577 #ffffff #2e9ef4   #285577
+client.focused_inactive #333333 #5f676a #ffffff #484e50   #5f676a
+client.unfocused        #333333 #222222 #888888 #292d2e   #222222
+client.urgent           #2f343a #900000 #ffffff #900000   #900000
+client.placeholder      #000000 #0c0c0c #ffffff #000000   #0c0c0c
 
 client.background       #ffffff

Note that for the window decorations, the color around the child window is the -background color, and the border color is only the two thin lines at the top of -the window.

+"child_border", and "border" color is only the two thin lines around the +titlebar.

The indicator color is used for indicating where a new window will be opened. For horizontal split containers, the right border will be painted in indicator color, for vertical split containers, the bottom border. This only applies to @@ -910,7 +964,7 @@ single windows within a split container, which are otherwise indistinguishable from single windows outside of a split container.

-

4.18. Interprocess communication

+

4.19. Interprocess communication

i3 uses Unix sockets to provide an IPC interface. This allows third-party programs to get information from i3, such as the current workspaces (to display a workspace bar), and to control i3.

@@ -932,7 +986,7 @@ user can create that directory.

the next section.

-

4.19. Focus follows mouse

+

4.20. Focus follows mouse

By default, window focus follows your mouse movements. However, if you have a setup where your mouse usually is in your way (like a touchpad on your laptop which you do not want to disable completely), you might want to disable focus @@ -951,7 +1005,7 @@ links in your browser window).

-

4.20. Mouse warping

+

4.21. Mouse warping

By default, when switching focus to a window on a different output (e.g. focusing a window on workspace 3 on output VGA-1, coming from workspace 2 on LVDS-1), the mouse cursor is warped to the center of that window.

@@ -970,7 +1024,7 @@ behavior described above.

-

4.21. Popups during fullscreen mode

+

4.22. Popups during fullscreen mode

When you are in fullscreen mode, some applications still open popup windows (take Xpdf for example). This is because these applications may not be aware that they are in fullscreen mode (they do not check the corresponding hint). @@ -1007,7 +1061,7 @@ Leave fullscreen mode.

-

4.22. Focus wrapping

+

4.23. Focus wrapping

When being in a tabbed or stacked container, the first container will be focused when you use focus down on the last container — the focus wraps. If however there is another stacked/tabbed container in that direction, focus will @@ -1029,7 +1083,7 @@ will always wrap.

-

4.23. Forcing Xinerama

+

4.24. Forcing Xinerama

As explained in-depth in http://i3wm.org/docs/multi-monitor.html, some X11 video drivers (especially the nVidia binary driver) only provide support for Xinerama instead of RandR. In such a situation, i3 must be told to use the @@ -1052,7 +1106,7 @@ that’s it).

Xinerama, instead they are counted up, starting at 0: xinerama-0, xinerama-1, …

-

4.24. Automatic back-and-forth when switching to the current workspace

+

4.25. Automatic back-and-forth when switching to the current workspace

This configuration directive enables automatic workspace back_and_forth (see [back_and_forth]) when switching to the workspace that is currently focused.

For instance: Assume you are on workspace "1: www" and switch to "2: IM" using @@ -1070,7 +1124,7 @@ came from now, you can just press $mod+2 again to switch back to "1: www".

-

4.25. Delaying urgency hint reset on workspace change

+

4.26. Delaying urgency hint reset on workspace change

If an application on another workspace sets an urgency hint, switching to this workspace may lead to immediate focus of the application, which also means the window decoration color would be immediately reset to client.focused. This @@ -1092,8 +1146,8 @@ value to 0 disables this feature.

-

4.26. Focus on window activation

-

If a window is activated, e.g., via google-chrome www.google.com, it may request +

4.27. 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].

@@ -1140,7 +1194,7 @@ none
-

4.27. Drawing marks on window decoration

+

4.28. 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.

@@ -1157,7 +1211,7 @@ this option is activated.

-

4.28. Line continuation

+

4.29. Line continuation

Config files support line continuation, meaning when you end a line in a backslash character (\), the line-break will be ignored by the parser. This feature can be used to create more readable configuration files.

@@ -1288,7 +1342,7 @@ the windows key). The default value for the hidden_state is hide.

mode dock|hide|invisible
 hidden_state hide|show
-modifier <Modifier>
+modifier <Modifier>|none

Example:

@@ -1299,7 +1353,8 @@ modifier <Modifier> modifier Mod1 }
-

Available modifiers are Mod1-Mod5, Shift, Control (see xmodmap(1)).

+

Available modifiers are Mod1-Mod5, Shift, Control (see xmodmap(1)). You can +also use "none" if you don’t want any modifier to trigger this behavior.

5.4. Mouse button commands

@@ -1444,6 +1499,10 @@ bar { NetworkManager, VLC, Pidgin, etc. can place little icons.

You can configure on which output (monitor) the icons should be displayed or you can turn off the functionality entirely.

+

You can use mutliple tray_output directives in your config to specify a list +of outputs on which you want the tray to appear. The first available output in +that list as defined by the order of the directives will be used for the tray +output.

Syntax:

@@ -1573,8 +1632,8 @@ workspaces to "1:I", "2:II", "3:III", "4:IV", …

5.14. Binding Mode indicator

Specifies whether the current binding mode indicator should be shown or not. This is useful if you want to hide the workspace buttons but still be able -to see the current binding mode indicator. -For an example of a mode definition, see [resizingconfig].

+to see the current binding mode indicator. See [binding_modes] to learn what +modes are and how to use them.

The default is to show the mode indicator.

Syntax:

@@ -1619,6 +1678,33 @@ separator

+focused_background +
+
+

+ Background color of the bar on the currently focused monitor output. If + not used, the color will be taken from background. +

+
+
+focused_statusline +
+
+

+ Text color to be used for the statusline on the currently focused + monitor output. If not used, the color will be taken from statusline. +

+
+
+focused_separator +
+
+

+ Text color to be used for the separator on the currently focused + monitor output. If not used, the color will be taken from separator. +

+
+
focused_workspace
@@ -1749,7 +1835,7 @@ class

Compares the window class (the second part of WM_CLASS). Use the - special value focused to match all windows having the same window + special value __focused__ to match all windows having the same window class as the currently focused window.

@@ -1759,7 +1845,7 @@ instance

Compares the window instance (the first part of WM_CLASS). Use the - special value focused to match all windows having the same window + special value __focused__ to match all windows having the same window instance as the currently focused window.

@@ -1769,7 +1855,7 @@ window_role

Compares the window role (WM_WINDOW_ROLE). Use the special value - focused to match all windows having the same window role as the + __focused__ to match all windows having the same window role as the currently focused window.

@@ -1780,7 +1866,7 @@ window_type

Compare the window type (_NET_WM_WINDOW_TYPE). Possible values are normal, dialog, utility, toolbar, splash, menu, dropdown_menu, - popup_menu and tooltip. + popup_menu, tooltip and notification.

@@ -1797,7 +1883,7 @@ title

Compares the X11 window title (_NET_WM_NAME or WM_NAME as fallback). - Use the special value focused to match all windows having the + Use the special value __focused__ to match all windows having the same window title as the currently focused window.

@@ -1817,7 +1903,7 @@ workspace

Compares the workspace name of the workspace the window belongs to. Use - the special value focused to match all windows in the currently + the special value __focused__ to match all windows in the currently focused workspace.

@@ -1826,7 +1912,9 @@ con_mark

- Compares the mark set for this container, see [vim_like_marks]. + Compares the marks set for this container, see [vim_like_marks]. A + match is made if any of the container’s marks matches the specified + mark.

@@ -1835,7 +1923,8 @@ con_id

Compares the i3-internal container ID, which you can get via the IPC - interface. Handy for scripting. + interface. Handy for scripting. Use the special value __focused__ + to match only the currently focused window.

@@ -1850,7 +1939,7 @@ shell. This implies that you can use globbing (wildcards) and programs will be 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.

+strings (as shown in [exec_quoting]) if they appear in your command.

Syntax:

@@ -1872,6 +1961,24 @@ will change the X11 cursor to watch (a clock) while the application is launching. So, if an application is not startup-notification aware (most GTK and Qt using applications seem to be, though), you will end up with a watch cursor for 60 seconds.

+

If the command to be executed contains a ; (semicolon) and/or a , (comma), +the entire command must be quoted. For example, to have a keybinding for the +shell command notify-send Hello, i3, you would add an entry to your +configuration file like this:

+

Example:

+
+
+
# Execute a command with a comma in it
+bindsym $mod+p exec "notify-send Hello, i3"
+
+

If however a command with a comma and/or semicolon itself requires quotes, you +must escape the internal quotation marks with double backslashes, like this:

+

Example:

+
+
+
# Execute a command with a comma, semicolon and internal quotes
+bindsym $mod+p exec "notify-send \\"Hello, i3; from $USER\\""
+

6.2. Splitting containers

@@ -1881,19 +1988,23 @@ new windows get placed to the right of the current one (splith) or new windows get placed below the current one (splitv).

If you apply this command to a split container with the same orientation, nothing will happen. If you use a different orientation, the split container’s -orientation will be changed (if it does not have more than one window). Use -layout toggle split to change the layout of any split container from splitv -to splith or vice-versa.

+orientation will be changed (if it does not have more than one window). +The toggle option will toggle the orientation of the split container if it +contains a single window. Otherwise it makes the current window a split +container with opposite orientation compared to the parent container. +Use layout toggle split to change the layout of any split container from +splitv to splith or vice-versa.

Syntax:

-
split vertical|horizontal
+
split vertical|horizontal|toggle

Example:

bindsym $mod+v split vertical
-bindsym $mod+h split horizontal
+bindsym $mod+h split horizontal +bindsym $mod+t split toggle
@@ -2090,8 +2201,10 @@ for_window [instance=notepad] sticky enable

6.7. Changing (named) workspaces/moving to workspaces

To change to a specific workspace, use the workspace command, followed by the -number or name of the workspace. To move containers to specific workspaces, use -move container to workspace.

+number or name of the workspace. Pass the optional flag +--no-auto-back-and-forth to disable [back_and_forth] for this specific call +only.

+

To move containers to specific workspaces, use move container to workspace.

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 @@ -2100,6 +2213,9 @@ next_on_output and workspace prev_on_output. Similarly, you can us container to workspace next, move container to workspace prev to move a container to the next/previous workspace and move container to workspace current (the last one makes sense only when used with criteria).

+

workspace next cycles through either numbered or named workspaces. But when it +reaches the last numbered/named workspace, it looks for named workspaces after +exhausting numbered ones and looks for numbered ones after exhausting named ones.

See [move_to_outputs] for how to move a container/workspace to a different RandR output.

Workspace names are parsed as @@ -2113,11 +2229,11 @@ workspace using move container to workspace back_and_forth.

workspace next|prev|next_on_output|prev_on_output
 workspace back_and_forth
-workspace <name>
-workspace number <name>
+workspace [--no-auto-back-and-forth] <name>
+workspace [--no-auto-back-and-forth] number <name>
 
-move [window|container] [to] workspace <name>
-move [window|container] [to] workspace number <name>
+move [--no-auto-back-and-forth] [window|container] [to] workspace <name>
+move [--no-auto-back-and-forth] [window|container] [to] workspace number <name>
 move [window|container] [to] workspace prev|next|current

Examples:

@@ -2200,8 +2316,8 @@ bindsym $mod+r exec i3-input -F 'rename workspace to "%s"' -P 'New name: '< RandR output.

-

6.9. Moving containers/workspaces to RandR outputs

-

To move a container to another RandR output (addressed by names like LVDS1 or +

6.9. Moving containers/workspaces to RandR outputs

+

To move a container to another RandR output (addressed by names like LVDS1 or VGA1) or to a RandR output identified by a specific direction (like left, right, up or down), there are two commands:

Syntax:

@@ -2222,7 +2338,7 @@ bindsym $mod+x move container to output VGA1
-

6.10. Moving containers/workspaces to marks

+

6.10. Moving containers/windows 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 @@ -2258,37 +2374,11 @@ is 10 pixels). The ppt argument means percentage points and specifies by how many percentage points a tiling container should be grown or shrunk (the default is 10 percentage points). Note that resize set will only work for floating containers.

-

I recommend using the resize command inside a so called mode:

-
-
Example: Configuration file, defining a mode for resizing
-
-
mode "resize" {
-        # These bindings trigger as soon as you enter the resize mode
-
-        # Pressing left will shrink the window’s width.
-        # Pressing right will grow the window’s width.
-        # Pressing up will shrink the window’s height.
-        # Pressing down will grow the window’s height.
-        bindsym j           resize shrink width 10 px or 10 ppt
-        bindsym k           resize grow height 10 px or 10 ppt
-        bindsym l           resize shrink height 10 px or 10 ppt
-        bindsym semicolon   resize grow width 10 px or 10 ppt
-
-        # same bindings, but for the arrow keys
-        bindsym Left        resize shrink width 10 px or 10 ppt
-        bindsym Down        resize grow height 10 px or 10 ppt
-        bindsym Up          resize shrink height 10 px or 10 ppt
-        bindsym Right       resize grow width 10 px or 10 ppt
-
-        # back to normal: Enter or Escape
-        bindsym Return mode "default"
-        bindsym Escape mode "default"
-}
-
-# Enter resize mode
-bindsym $mod+r mode "resize"
-
-

Example 2 - setting urxvt size to 640x480:

+

It is recommended to define bindings for resizing in a dedicated binding mode. +See [binding_modes] and the example in the i3 +default config for more +context.

+

Example:

for_window [class="urxvt"] resize set 640 480
@@ -2316,8 +2406,8 @@ bindsym $mod+a [class="urxvt" title="VIM"] focus
-

6.13. VIM-like marks (mark/goto)

-

This feature is like the jump feature: It allows you to directly jump to a +

6.13. VIM-like marks (mark/goto)

+

This feature is like the jump feature: It allows you to directly jump to a specific window (this means switching to the appropriate workspace and setting focus to the windows). However, you can directly mark a specific window with an arbitrary label and use it afterwards. You can unmark the label in the same @@ -2329,26 +2419,37 @@ 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.

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.

+this mark or add it otherwise. Note that you may need to use this in +combination with --add (see below) as any other marks will otherwise be +removed.

+

By default, a window can only have one mark. You can use the --add flag to +put more than one mark on a window.

+

Refer to [show_marks] if you don’t want marks to be shown in the window decoration.

Syntax:

-
mark [--toggle] <identifier>
+
mark [--add|--replace] [--toggle] <identifier>
 [con_mark="identifier"] focus
 unmark <identifier>

Example (in a terminal):

-
$ i3-msg mark irssi
-$ i3-msg '[con_mark="irssi"] focus'
-$ i3-msg unmark irssi
+
# marks the focused container
+mark irssi
+
+# focus the container with the mark "irssi"
+'[con_mark="irssi"] focus'
+
+# remove the mark "irssi" from whichever container has it
+unmark irssi
+
+# remove all marks on all firefox windows
+[class="(?i)firefox"] unmark
-

6.14. Window title format

+

6.14. Window title format

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 @@ -2360,11 +2461,26 @@ and the following placeholders which will be replaced:

- The X11 window title (_NET_WM_NAME or WM_NAME as fallback). -%class: + For normal windows, this is the X11 window title (_NET_WM_NAME or WM_NAME + as fallback). When used on containers without a window (e.g., a split + container inside a tabbed/stacked layout), this will be the tree + representation of the container (e.g., "H[xterm xterm]"). +

+
+
+%class +
+
+

The X11 window class (second part of WM_CLASS). This corresponds to the class criterion, see [command_criteria]. -%instance: +

+
+
+%instance +
+
+

The X11 window instance (first part of WM_CLASS). This corresponds to the instance criterion, see [command_criteria].

@@ -2396,6 +2512,9 @@ for_window [class="(?i)firefox"] title_format "<span foreground='red'>%tit border (including window title), border pixel 1 to use a 1-pixel border (no window title) and border none to make the client borderless.

There is also border toggle which will toggle the different border styles.

+

Note that "pixel" refers to logical pixel. On HiDPI displays, a logical pixel +may be represented by multiple physical pixels, so pixel 1 might not +necessarily translate into a single pixel row wide border.

Syntax:

@@ -2706,14 +2825,14 @@ on which hint the application sets. With i3bar, you can configure its position, see [i3bar_position].

-

8.2. Giving presentations (multi-monitor)

+

8.2. Giving presentations (multi-monitor)

When giving a presentation, you typically want the audience to see what you see on your screen and then go through a series of slides (if the presentation is simple). For more complex presentations, you might want to have some notes which only you can see on your screen, while the audience can only see the slides.

-

8.2.1. Case 1: everybody gets the same output

+

8.2.1. Case 1: everybody gets the same output

This is the simple case. You connect your computer to the video projector, turn on both (computer and video projector) and configure your X server to clone the internal flat panel of your computer to the video output: