X-Git-Url: https://git.sur5r.net/?a=blobdiff_plain;f=docs%2Fuserguide.html;h=05da6d2b027a9b7411a05f63d795d67211520ba4;hb=e22c9eefd3ed353ec9ad85bbce8f8f38e3ce21b6;hp=8192d6ac05863833074185a974841d7088ffcb37;hpb=eee149f9ffa4fe019179bd14159eb0a4bd3762c0;p=i3%2Fi3.github.io diff --git a/docs/userguide.html b/docs/userguide.html index 8192d6a..05da6d2 100644 --- a/docs/userguide.html +++ b/docs/userguide.html @@ -2,9 +2,9 @@ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
- + - +To display a window in fullscreen mode or to go out of fullscreen mode again, press $mod+f.
There is also a global fullscreen mode in i3 in which the client will span all -available outputs (the command is fullscreen global).
To cleanly exit i3 without killing your X server, you can use $mod+Shift+e.
To cleanly exit i3 without killing your X server, you can use $mod+Shift+e. +By default, a dialog will ask you to confirm if you really want to quit.
# Fullscreen -bindsym $mod+f fullscreen +bindsym $mod+f fullscreen toggle # Restart bindsym $mod+Shift+r restart @@ -469,7 +471,39 @@ workspaces is totally convenient. Try it :-).
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+
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 @@ -492,7 +526,7 @@ ratio will be preserved).
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 @@ -513,7 +547,7 @@ floating_maximum_size -1 x -1
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.
This option determines in which mode new containers on workspace level will start.
Syntax:
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.
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.
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.
The valid criteria are the same as those for commands, see [command_criteria].
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, @@ -640,7 +674,7 @@ you should create a little script which generates a configuration file and run it before starting i3 (for example in your ~/.xsession file).
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 @@ -709,7 +743,7 @@ exec --no-startup-id i3-msg 'workspace 3; exec iceweasel; workspace 1'
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 @@ -733,7 +767,7 @@ exec --no-startup-id urxvt
The flag --no-startup-id is explained in [exec].
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 @@ -757,7 +791,7 @@ workspace "2: vim" output VGA1
You can change all colors which i3 uses to draw the window decorations.
Syntax:
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.
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 @@ -881,7 +915,7 @@ links in your browser window).
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.
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). @@ -937,7 +971,7 @@ Leave fullscreen mode.
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 @@ -959,7 +993,7 @@ will always wrap.
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 @@ -982,7 +1016,7 @@ thatâs it).
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 @@ -1000,7 +1034,7 @@ came from now, you can just press $mod+2 again to switch back to "1: www".
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 @@ -1149,7 +1183,28 @@ modifier <Modifier>
Available modifiers are Mod1-Mod5, Shift, Control (see xmodmap(1)).
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 +}+
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, …).
This option determines in which edge of the screen i3bar should show up.
The default is bottom.
Syntax:
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.
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 @@ -1251,7 +1306,7 @@ bar {
Specifies the font to be used in the bar. See [fonts].
Syntax:
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.
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.
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. @@ -1329,7 +1384,7 @@ For an example of a mode definition, see [res
As with i3, colors are in HTML hex format (#rrggbb). The following colors can be configured at the moment:
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, to make -it floating (or tiling again) use floating enable respectively floating disable -(or floating toggle):
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:
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; likewise, you can move containers to the previously focused workspace using move container to workspace back_and_forth.
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