X-Git-Url: https://git.sur5r.net/?a=blobdiff_plain;f=docs%2Fuserguide.html;h=4a52eedf663644f4f1f78e50500eb79b84d00700;hb=0e69cc7cbb7767b8175d29222e76a9ad084c3e64;hp=a0cdea97b2420a0e8256425b27fc623ec2ee3f1f;hpb=a51955422cfef50d617cd856bddec422cb8c3493;p=i3%2Fi3.github.io diff --git a/docs/userguide.html b/docs/userguide.html index a0cdea9..4a52eed 100644 --- a/docs/userguide.html +++ b/docs/userguide.html @@ -2,15 +2,15 @@ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> - + - + i3: i3 User’s Guide @@ -22,16 +22,17 @@ window.onload = function(){asciidoc.footnotes(); asciidoc.toc(2);}

4. Configuring i3

-

This is where the real fun begins ;-). Most things are very dependant on your +

This is where the real fun begins ;-). Most things are very dependent on your ideal working environment so we can’t make reasonable defaults for them.

While not using a programming language for the configuration, i3 stays quite flexible in regards to the things you usually want your window manager @@ -341,21 +364,31 @@ a # and can only be used at the beginning of a line:

-

4.2. Fonts

-

i3 uses X core fonts (not Xft) for rendering window titles. You can use -xfontsel(1) to generate such a font description. To see special characters -(Unicode), you need to use a font which supports the ISO-10646 encoding.

+

4.2. Fonts

+

i3 has support for both X core fonts and FreeType fonts (through Pango) to +render window titles.

+

To generate an X core font description, you can use xfontsel(1). To see +special characters (Unicode), you need to use a font which supports the +ISO-10646 encoding.

+

A FreeType font description is composed by a font family, a style, a weight, +a variant, a stretch and a size. +FreeType fonts support right-to-left rendering and contain often more +Unicode glyphs than X core fonts.

If i3 cannot open the configured font, it will output an error in the logfile and fall back to a working font.

Syntax:

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

Examples:

-
font -misc-fixed-medium-r-normal--13-120-75-75-C-70-iso10646-1
+
font -misc-fixed-medium-r-normal--13-120-75-75-C-70-iso10646-1
+font pango:DejaVu Sans Mono 10
+font pango:DejaVu Sans Mono, Terminus Bold Semi-Condensed 11
+font pango:Terminus 11px
@@ -385,23 +418,33 @@ Keycodes do not need to have a symbol assigned (handy for custom vendor your bindings in the same physical location on the keyboard, use keycodes. If you don’t switch layouts, and want a clean and simple config file, use keysyms.

+

Some tools (such as import or xdotool) might be unable to run upon a +KeyPress event, because the keyboard/pointer is still grabbed. For these +situations, the --release flag can be used, which will execute the command +after the keys have been released.

Syntax:

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

Examples:

# Fullscreen
-bindsym mod+f fullscreen
+bindsym $mod+f fullscreen toggle
 
 # Restart
-bindsym mod+Shift+r restart
+bindsym $mod+Shift+r restart
 
 # Notebook-specific hotkeys
-bindcode 214 exec /home/michael/toggle_beamer.sh
+bindcode 214 exec --no-startup-id /home/michael/toggle_beamer.sh + +# Simulate ctrl+v upon pressing $mod+x +bindsym --release $mod+x exec --no-startup-id xdotool key --clearmodifiers ctrl+v + +# Take a screenshot upon pressing $mod+x (select an area) +bindsym --release $mod+x exec --no-startup-id import /tmp/latest-screenshot.png

Available Modifiers:

@@ -428,7 +471,39 @@ workspaces is totally convenient. Try it :-).
-

4.4. The floating modifier

+

4.4. Mouse bindings

+

A mouse binding makes i3 execute a command upon pressing a specific mouse +button in the scope of the clicked container (see [command_criteria]). You +can configure mouse bindings in a similar way to key bindings.

+

Syntax:

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

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.

+

Examples:

+
+
+
# The middle button over a titlebar kills the window
+bindsym --release button2 kill
+
+# The middle button and a modifer over any part of the window kills the window
+bindsym --whole-window $mod+button2 kill
+
+# The right button toggles floating
+bindsym button3 floating toggle
+bindsym $mod+button3 floating toggle
+
+# The side buttons move the window around
+bindsym button9 move left
+bindsym button8 move right
+
+
+
+

4.5. 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 @@ -451,7 +526,7 @@ ratio will be preserved).

-

4.5. Constraining floating window size

+

4.6. 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 @@ -472,12 +547,12 @@ floating_maximum_size -1 x -1

-

4.6. Orientation for new workspaces

+

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

With the default_orientation configuration directive, you can override that -behaviour.

+behavior.

Syntax:

@@ -490,7 +565,7 @@ behaviour.

-

4.7. Layout mode for new containers

+

4.8. Layout mode for new containers

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

Syntax:

@@ -505,21 +580,51 @@ start.

-

4.8. Border style for new windows

-

This option determines which border style new windows will have.

+

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

Syntax:

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

Example:

new_window 1pixel
+

The "normal" and "pixel" border styles support an optional border width in +pixels:

+

Example:

+
+
+
# The same as new_window none
+new_window pixel 0
+
+# A 3 px border
+new_window pixel 3
+
-

4.9. Arbitrary commands for specific windows (for_window)

+

4.10. Hiding vertical borders

+

You can hide vertical 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:

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

Example:

+
+
+
hide_edge_borders vertical
+
+
+
+

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

@@ -545,7 +650,7 @@ for_window [title="x200: ~/work"] floating enable

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

-

4.10. Variables

+

4.12. 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, @@ -561,14 +666,15 @@ variables can be handy.

set $m Mod1
 bindsym $m+Shift+r restart
-

Variables are directly replaced in the file when parsing. There is no fancy -handling and there are 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).

+

Variables are directly replaced in the file when parsing. Variables expansion +is not recursive so it is not possible to define a variable with a value +containing another variable. There is no fancy handling and there are +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).

-

4.11. Automatically putting clients on specific workspaces

+

4.13. 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 @@ -579,6 +685,9 @@ starts up being named Firefox, and only when Vimperator is loaded does the title change. As i3 will get the title as soon as the application maps the window (mapping means actually displaying it on the screen), you’d need to have to match on Firefox in this case.

+

Assignments are processed by i3 in the order in which they appear in the config +file. The first one which matches the window wins and later assignments are not +considered.

Syntax:

@@ -617,9 +726,24 @@ second part is the class ("URxvt" in this example).

logfile first (see http://i3wm.org/docs/debugging.html). It includes more details about the matching process and the window’s actual class, instance and title when starting up.

+

Note that if you want to start an application just once on a specific +workspace, but you don’t want to assign all instances of it permanently, you +can make use of i3’s startup-notification support (see [exec]) in your config +file in the following way:

+

Start iceweasel on workspace 3 (once):

+
+
+
# Start iceweasel on workspace 3, then switch back to workspace 1
+# (Being a command-line utility, i3-msg does not support startup notifications,
+#  hence the exec --no-startup-id.)
+# (Starting iceweasel with i3’s exec command is important in order to make i3
+#  create a startup notification context, without which the iceweasel window(s)
+#  cannot be matched onto the workspace on which the command was started.)
+exec --no-startup-id i3-msg 'workspace 3; exec iceweasel; workspace 1'
+
-

4.12. Automatically starting applications on i3 startup

+

4.14. 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 @@ -643,7 +767,7 @@ exec --no-startup-id urxvt

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

-

4.13. Automatically putting workspaces on specific screens

+

4.15. 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 @@ -667,7 +791,7 @@ workspace "2: vim" output VGA1

-

4.14. Changing colors

+

4.16. Changing colors

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

Syntax:

@@ -709,6 +833,15 @@ client.urgent A client which has its urgency hint activated.

+
+client.placeholder +
+
+

+ Background and text color are used to draw placeholder window contents + (when restoring layouts). Border and indicator are ignored. +

+

You can also specify the color to be used to paint the background of the client windows. This color will be used to paint the window on top of which the client @@ -719,10 +852,7 @@ will be rendered.

client.background color

Only clients that do not cover the whole area of this window expose the color -used to paint it. If you use a color other than black for your terminals, you -most likely want to set the client background color to the same color as your -terminal program’s background color to avoid black gaps between the rendered -area of the terminal and the i3 border.

+used to paint it.

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

Examples (default colors):

@@ -731,7 +861,8 @@ area of the terminal and the i3 border.

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.urgent #2f343a #900000 #ffffff #900000 +client.placeholder #000000 #0c0c0c #ffffff #000000

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 @@ -743,8 +874,8 @@ single windows within a split container, which are otherwise indistinguishable from single windows outside of a split container.

-

4.15. Interprocess communication

-

i3 uses unix sockets to provide an IPC interface. This allows third-party +

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

The IPC socket is enabled by default and will be created in @@ -765,12 +896,13 @@ user can create that directory.

the next section.

-

4.16. Focus follows mouse

-

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 follows mouse and control focus only by using your keyboard. -The mouse will still be useful inside the currently active window (for example -to click on links in your browser window).

+

4.18. 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 +follows mouse and control focus only by using your keyboard. The mouse will +still be useful inside the currently active window (for example to click on +links in your browser window).

Syntax:

@@ -783,14 +915,39 @@ to click on links in your browser window).

-

4.17. Popups during fullscreen mode

+

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

+

With the mouse_warping option, you can control when the mouse cursor should +be warped. none disables warping entirely, whereas output is the default +behavior described above.

+

Syntax:

+
+
+
mouse_warping <output|none>
+
+

Example:

+
+
+
mouse_warping none
+
+
+
+

4.20. 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). -There are two things which are possible to do in this situation:

+There are three things which are possible to do in this situation:

  1. +Display the popup if it belongs to the fullscreen application only. This is + the default and should be reasonable behavior for most users. +

    +
    2. +
  2. +

    Just ignore the popup (don’t map it). This won’t interrupt you while you are in fullscreen. However, some apps might react badly to this (deadlock until you go out of fullscreen). @@ -798,27 +955,27 @@ Just ignore the popup (don’t map it). This won’t interrupt you while you are

  3. -Leave fullscreen mode. This is the default. +Leave fullscreen mode.

Syntax:

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

Example:

-
popup_during_fullscreen ignore
+
popup_during_fullscreen smart
-

4.18. Focus wrapping

+

4.21. 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 -be set on that container. This is the default behaviour so you can navigate to +be set on that container. This is the default behavior so you can navigate to all your windows without having to use focus parent.

If you want the focus to always wrap and you are aware of using focus parent to switch to different containers, you can use the @@ -836,14 +993,14 @@ will always wrap.

-

4.19. Forcing Xinerama

+

4.22. 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 inferior Xinerama API explicitly and therefore don’t provide support for reconfiguring your screens on the fly (they are read only once on startup and that’s it).

-

For people who do cannot modify their ~/.xsession to add the +

For people who cannot modify their ~/.xsession to add the --force-xinerama commandline parameter, a configuration option is provided:

Syntax:

@@ -859,12 +1016,12 @@ that’s it).

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

-

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

+

4.23. 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 mod+2 because somebody sent you a message. You don’t need to remember where you -came from now, you can just press mod+2 again to switch back to "1: www".

+came from now, you can just press $mod+2 again to switch back to "1: www".

Syntax:

@@ -876,6 +1033,28 @@ came from now, you can just press mod+2 again to switch back to "1: www".

workspace_auto_back_and_forth yes
+
+

4.24. 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 +may make it unnecessarily hard to tell which window originally raised the +event.

+

In order to prevent this, you can tell i3 to delay resetting the urgency state +by a certain time using the force_display_urgency_hint directive. Setting the +value to 0 disables this feature.

+

The default is 500ms.

+

Syntax:

+
+
+
force_display_urgency_hint <timeout> ms
+
+

Example:

+
+
+
force_display_urgency_hint 500 ms
+
+
@@ -963,18 +1142,33 @@ have to have correct quoting etc.

5.3. Display mode

-

You can have i3bar either be visible permanently at one edge of the screen -(dock mode) or make it show up when you press your modifier key (hide +

You can either have i3bar be visible permanently at one edge of the screen +(dock mode) or make it show up when you press your modifier key (hide mode). +It is also possible to force i3bar to always stay hidden (invisible mode). The modifier key can be configured using the modifier option.

+

The mode option can be changed during runtime through the bar mode command. +On reload the mode will be reverted to its configured value.

The hide mode maximizes screen space that can be used for actual windows. Also, i3bar sends the SIGSTOP and SIGCONT signals to the statusline process to save battery power.

-

The default is dock mode; in hide mode, the default modifier is Mod4 (usually -the windows key).

+

Invisible mode allows to permanently maximize screen space, as the bar is never +shown. Thus, you can configure i3bar to not disturb you by popping up because +of an urgency hint or because the modifier key is pressed.

+

In order to control whether i3bar is hidden or shown in hide mode, there exists +the hidden_state option, which has no effect in dock mode or invisible mode. It +indicates the current hidden_state of the bar: (1) The bar acts like in normal +hide mode, it is hidden and is only unhidden in case of urgency hints or by +pressing the modifier key (hide state), or (2) it is drawn on top of the +currently visible workspace (show state).

+

Like the mode, the hidden_state can also be controlled through i3, this can be +done by using the bar hidden_state command.

+

The default mode is dock mode; in hide mode, the default modifier is Mod4 (usually +the windows key). The default value for the hidden_state is hide.

Syntax:

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

Example:

@@ -982,13 +1176,53 @@ modifier <Modifier> 
bar {
     mode hide
+    hidden_state hide
     modifier Mod1
 }

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

-

5.4. Position

+

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

+

Syntax:

+
+
+
wheel_up_cmd <command>
+wheel_down_cmd <command>
+
+

Example:

+
+
+
bar {
+    wheel_up_cmd nop
+    wheel_down_cmd exec ~/.i3/scripts/custom_wheel_down
+}
+
+
+
+

5.5. Bar ID

+

Specifies the bar ID for the configured bar instance. If this option is missing, +the ID is set to bar-x, where x corresponds to the position of the embedding +bar block in the config file (bar-0, bar-1, …).

+

Syntax:

+
+
+
id <bar_id>
+
+

Example:

+
+
+
bar {
+    id bar-1
+}
+
+
+
+

5.6. Position

This option determines in which edge of the screen i3bar should show up.

The default is bottom.

Syntax:

@@ -1005,7 +1239,7 @@ modifier <Modifier>
-

5.5. Output(s)

+

5.7. Output(s)

You can restrict i3bar to one or more outputs (monitors). The default is to handle all outputs. Restricting the outputs is useful for using different options for different outputs by using multiple bar blocks.

@@ -1039,7 +1273,7 @@ bar {
-

5.6. Tray output

+

5.8. Tray output

i3bar by default provides a system tray area where programs such as NetworkManager, VLC, Pidgin, etc. can place little icons.

You can configure on which output (monitor) the icons should be displayed or @@ -1072,9 +1306,8 @@ bar {

-

5.7. Font

-

Specifies the font (again, X core font, not Xft, just like in i3) to be used in -the bar.

+

5.9. Font

+

Specifies the font to be used in the bar. See [fonts].

Syntax:

@@ -1085,11 +1318,29 @@ the bar.

bar {
     font -misc-fixed-medium-r-normal--13-120-75-75-C-70-iso10646-1
+    font pango:DejaVu Sans Mono 10
+}
+
+
+
+

5.10. 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 ":|:"
 }
-

5.8. Workspace buttons

+

5.11. Workspace buttons

Specifies whether workspace buttons should be shown or not. This is useful if you want to display a statusline-only bar containing additional information.

The default is to show workspace buttons.

@@ -1107,7 +1358,50 @@ you want to display a statusline-only bar containing additional information.

-

5.9. Colors

+

5.12. Strip workspace numbers

+

Specifies whether workspace numbers should be displayed within the workspace +buttons. This is useful if you want to have a named workspace that stays in +order on the bar according to its number without displaying the number prefix.

+

When strip_workspace_numbers is set to yes, any workspace that has a name of +the form "[n]:[NAME]" will display only the name. You could use this, for +instance, to display Roman numerals rather than digits by naming your +workspaces to "1:I", "2:II", "3:III", "4:IV", …

+

The default is to display the full name within the workspace button.

+

Syntax:

+
+
+
strip_workspace_numbers <yes|no>
+
+

Example:

+
+
+
bar {
+    strip_workspace_numbers yes
+}
+
+
+
+

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

+

The default is to show the mode indicator.

+

Syntax:

+
+
+
binding_mode_indicator <yes|no>
+
+

Example:

+
+
+
bar {
+    binding_mode_indicator no
+}
+
+
+
+

5.14. Colors

As with i3, colors are in HTML hex format (#rrggbb). The following colors can be configured at the moment:

@@ -1128,6 +1422,14 @@ statusline

+separator +
+
+

+ Text color to be used for the separator. +

+
+
focused_workspace
@@ -1163,7 +1465,7 @@ urgent_workspace

Border, background and text color for a workspace button when the workspace - window with the urgency hint set. + contains a window with the urgency hint set. Also applies to mode indicators.

@@ -1173,6 +1475,7 @@ urgent_workspace 
colors {
     background <color>
     statusline <color>
+    separator <color>
 
     colorclass <border> <background> <text>
 }
@@ -1184,6 +1487,7 @@ urgent_workspace colors { background #000000 statusline #ffffff + separator #666666 focused_workspace #4c7899 #285577 #ffffff active_workspace #333333 #5f676a #ffffff @@ -1213,19 +1517,30 @@ the following keybinding:

Example:

-
bindsym mod+x move container to workspace 3; workspace 3
+
bindsym $mod+x move container to workspace 3; workspace 3
-

Furthermore, you can change the scope of a command, that is, which containers -should be affected by that command, by using various criteria. These are -prefixed in square brackets to every command. If you want to kill all windows -which have the class Firefox, use:

+

Furthermore, you can change the scope of a command - that is, which containers +should be affected by that command, by using various criteria. The criteria +are specified before any command in a pair of square brackets and are separated +by space.

+

When using multiple commands, separate them by using a , (a comma) instead of +a semicolon. Criteria apply only until the next semicolon, so if you use a +semicolon to separate commands, only the first one will be executed for the +matched window(s).

Example:

-
bindsym mod+x [class="Firefox"] kill
+
# if you want to kill all windows which have the class Firefox, use:
+bindsym $mod+x [class="Firefox"] kill
 
 # same thing, but case-insensitive
-bindsym mod+x [class="(?i)firefox"] kill

+bindsym $mod+x [class="(?i)firefox"] kill
+
+# kill only the About dialog from Firefox
+bindsym $mod+x [class="Firefox" window_role="About"] kill
+
+# enable floating mode and move container to workspace 4
+for_window [class="^evil-app$"] floating enable, move container to workspace 4

The criteria which are currently implemented are:

@@ -1315,10 +1630,10 @@ searched in your $PATH.

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

The --no-startup-id parameter disables startup-notification support for this particular exec command. With startup-notification, i3 can make sure that a @@ -1331,12 +1646,14 @@ cursor for 60 seconds.

6.2. Splitting containers

The split command makes the current window a split container. Split containers -can contain multiple windows. Every split container has an orientation, it is -either split horizontally (a new window gets placed to the right of the current -one) or vertically (a new window gets placed below the current one).

+can contain multiple windows. Depending on the layout of the split container, +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).

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

Syntax:

@@ -1345,29 +1662,45 @@ orientation will be changed (if it does not have more than one window).

Example:

-
bindsym mod+v split vertical
-bindsym mod+h split horizontal
+
bindsym $mod+v split vertical
+bindsym $mod+h split horizontal

6.3. Manipulating layout

-

Use layout default, layout stacking or layout tabbed to change the -current container layout to default, stacking or tabbed layout, respectively.

-

To make the current window (!) fullscreen, use fullscreen, to make -it floating (or tiling again) use floating enable respectively floating disable -(or floating toggle):

+

Use layout toggle split, layout stacking, layout tabbed, layout splitv +or layout splith to change the current container layout to splith/splitv, +stacking, tabbed layout, splitv or splith, respectively.

+

To make the current window (!) fullscreen, use fullscreen enable (or +fullscreen enable global for the global mode), to leave either fullscreen +mode use fullscreen disable, and to toggle between these two states use +fullscreen toggle (or fullscreen toggle global).

+

Likewise, to make the current window floating (or tiling again) use floating +enable respectively floating disable (or floating toggle):

+

Syntax:

+
+
+
layout <default|tabbed|stacking|splitv|splith>
+layout toggle [split|all]
+

Examples:

-
bindsym mod+s layout stacking
-bindsym mod+l layout default
-bindsym mod+w layout tabbed
+
bindsym $mod+s layout stacking
+bindsym $mod+l layout toggle split
+bindsym $mod+w layout tabbed
+
+# Toggle between stacking/tabbed/split:
+bindsym $mod+x layout toggle
+
+# Toggle between stacking/tabbed/splith/splitv:
+bindsym $mod+x layout toggle all
 
 # Toggle fullscreen
-bindsym mod+f fullscreen
+bindsym $mod+f fullscreen toggle
 
 # Toggle floating/tiling
-bindsym mod+t floating toggle

+bindsym $mod+t floating toggle
@@ -1443,36 +1776,36 @@ relevant for floating containers. The default amount is 10 pixels.

# 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+semicolon focus right
+bindsym $mod+j focus left
+bindsym $mod+k focus down
+bindsym $mod+l focus up
+bindsym $mod+semicolon focus right
 
 # Focus parent container
-bindsym mod+u focus parent
+bindsym $mod+u focus parent
 
 # Focus last floating/tiling container
-bindsym mod+g focus mode_toggle
+bindsym $mod+g focus mode_toggle
 
 # Focus the output right to the current one
-bindsym mod+x focus output right
+bindsym $mod+x focus output right
 
 # Focus the big output
-bindsym mod+x focus output HDMI-2
+bindsym $mod+x focus output HDMI-2
 
 # 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+semicolon move right
+bindsym $mod+j move left
+bindsym $mod+k move down
+bindsym $mod+l move up
+bindsym $mod+semicolon move right
 
 # Move container, but make floating containers
 # move more than the default
-bindsym mod+j move left 20 px
+bindsym $mod+j move left 20 px
 
 # Move floating container to the center
 # of all outputs
-bindsym mod+c move absolute position center
+bindsym $mod+c move absolute position center
@@ -1485,34 +1818,50 @@ number or name of the workspace. To move containers to specific workspaces, use workspace 1, 3, 4 and 9 and you want to cycle through them with a single key combination. To restrict those to the current output, use workspace next_on_output and workspace prev_on_output. Similarly, you can use move -container to workspace next and move container to workspace prev to move a -container to the next/previous workspace.

+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).

+

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

+

Workspace names are parsed as +Pango markup +by i3bar.

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

-

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

-

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

+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 <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>
+

Examples:

-
bindsym mod+1 workspace 1
-bindsym mod+2 workspace 2
+
bindsym $mod+1 workspace 1
+bindsym $mod+2 workspace 2
+bindsym $mod+3 workspace 3:<span foreground="red">vim</span>
 ...
 
-bindsym mod+Shift+1 move container to workspace 1
-bindsym mod+Shift+2 move container to workspace 2
+bindsym $mod+Shift+1 move container to workspace 1
+bindsym $mod+Shift+2 move container to workspace 2
 ...
 
 # switch between the current and the previously focused one
-bindsym mod+b workspace back_and_forth
+bindsym $mod+b workspace back_and_forth
+bindsym $mod+Shift+b move container to workspace back_and_forth
 
 # move the whole workspace to the next output
-bindsym mod+x move workspace to output right

+bindsym $mod+x move workspace to output right
+
+# move firefox to current workspace
+bindsym $mod+F1 [class="Firefox"] move workspace current

6.5.1. Named workspaces

@@ -1521,7 +1870,7 @@ workspace command, you can use an arbitrary name:

Example:

-
bindsym mod+1 workspace mail
+
bindsym $mod+1 workspace mail
 ...

If you want the workspace to have a number and a name, just prefix the @@ -1529,8 +1878,8 @@ number, like this:

Example:

-
bindsym mod+1 workspace 1: mail
-bindsym mod+2 workspace 2: www
+
bindsym $mod+1 workspace 1: mail
+bindsym $mod+2 workspace 2: www
 ...

Note that the workspace will really be named "1: mail". i3 treats workspace @@ -1539,35 +1888,68 @@ workspaces are ordered the way they appeared. When they start with a number, i3 will order them numerically. Also, you will be able to use workspace number 1 to switch to the workspace which begins with number 1, regardless of which name it has. This is useful in case you are changing the workspace’s name -dynamically.

- +dynamically. To combine both commands you can use workspace number 1: mail to +specify a default name if there’s currently no workspace starting with a "1".

-
-

6.6. Renaming workspaces

+
+

6.5.2. Renaming workspaces

You can rename workspaces. This might be useful to start with the default numbered workspaces, do your work, and rename the workspaces afterwards to -reflect what’s actually on them.

+reflect what’s actually on them. You can also omit the old name to rename +the currently focused workspace. This is handy if you want to use the +rename command with i3-input.

Syntax:

-
rename workspace <old_name> to <new_name>
+
rename workspace <old_name> to <new_name>
+rename workspace to <new_name>

Examples:

i3-msg 'rename workspace 5 to 6'
 i3-msg 'rename workspace 1 to "1: www"'
-i3-msg 'rename workspace "1: www" to "10: www"'
+i3-msg 'rename workspace "1: www" to "10: www"' +i3-msg 'rename workspace to "2: mail" +bindsym $mod+r exec i3-input -F 'rename workspace to "%s"' -P 'New name: '
+
-

6.7. Resizing containers/windows

+

6.6. Moving workspaces to a different screen

+

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

+
+
+

6.7. 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:

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

Examples:

+
+
+
# Move the current workspace to the next output
+# (effectively toggles when you only have two outputs)
+bindsym $mod+x move workspace to output right
+
+# Put this window on the presentation output.
+bindsym $mod+x move container to output VGA1
+
+
+
+

6.8. Resizing containers/windows

If you want to resize containers/windows using your keyboard, you can use the 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 @@ -1604,15 +1986,15 @@ default is 10 percentage points).

} # Enter resize mode -bindsym mod+r mode "resize" +bindsym $mod+r mode "resize"
-

6.8. Jumping to specific windows

+

6.9. Jumping to specific windows

Often when in a multi-monitor environment, you want to quickly jump to a specific window. For example, while working on workspace 3 you may want to jump to your mail client to email your boss that you’ve achieved some -important goal. Instead of figuring out how to navigate to your mailclient, +important goal. Instead of figuring out how to navigate to your mail client, it would be more convenient to have a shortcut. You can use the focus command with criteria for that.

Syntax:

@@ -1625,17 +2007,18 @@ with criteria for that.

# Get me to the next open VIM instance
-bindsym mod+a [class="urxvt" title="VIM"] focus
+bindsym $mod+a [class="urxvt" title="VIM"] focus
-

6.9. VIM-like marks (mark/goto)

+

6.10. 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 do not need to ensure that your -windows have unique classes or titles, and you do not need to change your -configuration file.

+an arbitrary label and use it afterwards. You can unmark the label in the same +way, using the unmark command. If you don’t specify a label, unmark removes all +marks. You do not need to ensure that your windows have unique classes or +titles, and you do not need to change your configuration file.

As the command needs to include the label with which you want to mark the 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 @@ -1644,17 +2027,19 @@ can also prefix this command and display a custom prompt for the input dialog. 

mark identifier
-[con_mark="identifier"] focus
+[con_mark="identifier"] focus +unmark identifier

Example (in a terminal):

$ i3-msg mark irssi
-$ i3-msg '[con_mark="irssi"] focus'
+$ i3-msg '[con_mark="irssi"] focus' +$ i3-msg unmark irssi
-

6.10. Changing border style

+

6.11. Changing border style

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.

@@ -1662,13 +2047,55 @@ and border none to make the client borderless.

Examples:

-
bindsym mod+t border normal
-bindsym mod+y border 1pixel
-bindsym mod+u border none
+
bindsym $mod+t border normal
+bindsym $mod+y border 1pixel
+bindsym $mod+u border none
+
+ +
+

6.12. Enabling shared memory logging

+

As described in http://i3wm.org/docs/debugging.html, i3 can log to a shared +memory buffer, which you can dump using i3-dump-log. The shmlog command +allows you to enable or disable the shared memory logging at runtime.

+

Note that when using shmlog <size_in_bytes>, the current log will be +discarded and a new one will be started.

+

Syntax:

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

Examples:

+
+
+
# Enable/disable logging
+bindsym $mod+x shmlog toggle
+
+# or, from a terminal:
+# increase the shared memory log buffer to 50 MiB
+i3-msg shmlog $((50*1024*1024))
-

6.11. Reloading/Restarting/Exiting

+

6.13. Enabling debug logging

+

The debuglog command allows you to enable or disable debug logging at +runtime. Debug logging is much more verbose than non-debug logging. This +command does not activate shared memory logging (shmlog), and as such is most +likely useful in combination with the above-described [shmlog] command.

+

Syntax:

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

Examples:

+
+
+
# Enable/disable logging
+bindsym $mod+x debuglog toggle
+
+
+
+

6.14. Reloading/Restarting/Exiting

You can make i3 reload its configuration file with reload. You can also restart i3 inplace with the restart command to get it out of some weird state (if that should ever happen) or to perform an upgrade without having to restart @@ -1677,20 +2104,22 @@ however you don’t need to (simply killing your X session is fine as well).

Examples:

-
bindsym mod+Shift+r restart
-bindsym mod+Shift+w reload
-bindsym mod+Shift+e exit
+
bindsym $mod+Shift+r restart
+bindsym $mod+Shift+w reload
+bindsym $mod+Shift+e exit
-

6.12. Scratchpad

+

6.15. Scratchpad

There are two commands to use any existing window as scratchpad window. move scratchpad will move a window to the scratchpad workspace. This will make it invisible until you show it again. There is no way to open that workspace. Instead, when using scratchpad show, the window will be shown again, as a floating window, centered on your current workspace (using scratchpad show on a visible scratchpad window will make it hidden again, so you can have a -keybinding to toggle).

+keybinding to toggle). Note that this is just a normal floating window, so if +you want to "remove it from scratchpad", you can simple make it tiling again +(floating toggle).

As the name indicates, this is useful for having a window with your favorite editor always at hand. However, you can also use this for other permanently running applications which you don’t want to see all the time: Your music @@ -1706,15 +2135,67 @@ scratchpad show 

# Make the currently focused window a scratchpad
-bindsym mod+Shift+minus move scratchpad
+bindsym $mod+Shift+minus move scratchpad
 
 # Show the first scratchpad window
-bindsym mod+minus scratchpad show
+bindsym $mod+minus scratchpad show
 
 # Show the sup-mail scratchpad window, if any.
 bindsym mod4+s [title="^Sup ::"] scratchpad show
+
+

6.16. 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
+
+
+
+

6.17. i3bar control

+

There are two options in the configuration of each i3bar instance that can be +changed during runtime by invoking a command through i3. The commands bar +hidden_state and bar mode allow setting the current hidden_state +respectively mode option of each bar. It is also possible to toggle between +hide state and show state as well as between dock mode and hide mode. Each +i3bar instance can be controlled individually by specifying a bar_id, if none +is given, the command is executed for all bar instances.

+

Syntax:

+
+
+
bar hidden_state hide|show|toggle [<bar_id>]
+
+bar mode dock|hide|invisible|toggle [<bar_id>]
+
+

Examples:

+
+
+
# Toggle between hide state and show state
+bindsym $mod+m bar hidden_state toggle
+
+# Toggle between dock mode and hide mode
+bindsym $mod+n bar mode toggle
+
+# Set the bar instance with id 'bar-1' to switch to hide mode
+bindsym $mod+b bar mode hide bar-1
+
+# Set the bar instance with id 'bar-1' to always stay hidden
+bindsym $mod+Shift+b bar mode invisible bar-1
+
+
@@ -1830,6 +2311,12 @@ If you have many workspaces on many monitors, it might get hard to keep quickly switch between windows. See [vim_like_marks].

+
  • +

    +For information on how to move existing workspaces between monitors, + see [_moving_containers_workspaces_to_randr_outputs]. +

    +