* <xyz> denotes that some string must be used which is not a fixed value (e.g., a command), but a variable string (text, a number, ...)
* [xyz] denotes that the parameter is optional
* abc|xyz denotes that either abc or xyz must be given
*Syntax*:
------------------------------
font <X core font description>
*Syntax*:
------------------------------
font <X core font description>
-font pango:[family list] [style options] [size]
+font pango:<family list> [<style options>] <size>
------------------------------
*Examples*:
------------------------------
*Examples*:
*Syntax*:
----------------------------------
*Syntax*:
----------------------------------
-bindsym [--release] [Modifiers+]keysym command
-bindcode [--release] [Modifiers+]keycode command
+bindsym [--release] [<Modifiers>+]<keysym> command
+bindcode [--release] [<Modifiers>+]<keycode> command
----------------------------------
*Examples*:
----------------------------------
*Examples*:
can configure mouse bindings in a similar way to key bindings.
*Syntax*:
can configure mouse bindings in a similar way to key bindings.
*Syntax*:
-----------------------------------
-bindsym [--release] [--border] [--whole-window] [Modifiers+]button[n] command
-----------------------------------
+-------------------------------------------------------------------------------
+bindsym [--release] [--border] [--whole-window] [<Modifiers>+]button<n> command
+-------------------------------------------------------------------------------
By default, the binding will only run when you click on the titlebar of the
window. If the +--release+ flag is given, it will run when the mouse button
By default, the binding will only run when you click on the titlebar of the
window. If the +--release+ flag is given, it will run when the mouse button
*Syntax*:
--------------------------------
*Syntax*:
--------------------------------
-floating_modifier <Modifiers>
+floating_modifier <Modifier>
--------------------------------
*Example*:
--------------------------------
*Example*:
-----------------------------------------------
-default_orientation <horizontal|vertical|auto>
-----------------------------------------------
+--------------------------------------------
+default_orientation horizontal|vertical|auto
+--------------------------------------------
*Example*:
----------------------------
*Example*:
----------------------------
*Syntax*:
---------------------------------------------
*Syntax*:
---------------------------------------------
-workspace_layout <default|stacking|tabbed>
+workspace_layout default|stacking|tabbed
---------------------------------------------
/////////////////////////////////////////////
new_container stack-limit <cols|rows> <value>
---------------------------------------------
/////////////////////////////////////////////
new_container stack-limit <cols|rows> <value>
*Syntax*:
---------------------------------------------
*Syntax*:
---------------------------------------------
-new_window <normal|1pixel|none|pixel>
-new_float <normal|1pixel|none|pixel>
+new_window normal|1pixel|none|pixel
+new_window normal|pixel <px>
+new_float normal|1pixel|none|pixel
+new_float normal|pixel <px>
---------------------------------------------
*Example*:
---------------------------------------------
*Example*:
to waste even two pixels in displayspace. Default is none.
*Syntax*:
to waste even two pixels in displayspace. Default is none.
*Syntax*:
-----------------------------
-hide_edge_borders <none|vertical|horizontal|both>
-----------------------------
+-----------------------------------------------
+hide_edge_borders none|vertical|horizontal|both
+-----------------------------------------------
*Example*:
----------------------
*Example*:
----------------------
change their border style, for example.
*Syntax*:
change their border style, for example.
*Syntax*:
------------------------------
-for_window <criteria> command
------------------------------
+-------------------------------
+for_window <criteria> <command>
+-------------------------------
*Examples*:
------------------------------------------------
*Examples*:
------------------------------------------------
variables can be handy.
*Syntax*:
variables can be handy.
*Syntax*:
---------------
-set $name value
---------------
+-------------------
+set $<name> <value>
+-------------------
*Example*:
------------------------
*Example*:
------------------------
*Syntax*:
------------------------------------------------------------
*Syntax*:
------------------------------------------------------------
-assign <criteria> [→] workspace
+assign <criteria> [→] [workspace] <workspace>
------------------------------------------------------------
*Examples*:
------------------------------------------------------------
*Examples*:
you want to use them in your command.
*Syntax*:
you want to use them in your command.
*Syntax*:
--------------------
-exec [--no-startup-id] command
-exec_always [--no-startup-id] command
--------------------
+---------------------------------------
+exec [--no-startup-id] <command>
+exec_always [--no-startup-id] <command>
+---------------------------------------
*Examples*:
--------------------------------
*Examples*:
--------------------------------
the second screen and so on).
*Syntax*:
the second screen and so on).
*Syntax*:
-----------------------------------
+-------------------------------------
workspace <workspace> output <output>
workspace <workspace> output <output>
-----------------------------------
+-------------------------------------
The 'output' is the name of the RandR output you attach your screen to. On a
laptop, you might have VGA1 and LVDS1 as output names. You can see the
The 'output' is the name of the RandR output you attach your screen to. On a
laptop, you might have VGA1 and LVDS1 as output names. You can see the
You can change all colors which i3 uses to draw the window decorations.
*Syntax*:
You can change all colors which i3 uses to draw the window decorations.
*Syntax*:
---------------------------------------------
-colorclass border background text indicator
---------------------------------------------
+------------------------------------------------------
+<colorclass> <border> <background> <text> <indicator>
+------------------------------------------------------
Where colorclass can be one of:
Where colorclass can be one of:
will be rendered.
*Syntax*:
will be rendered.
*Syntax*:
------------------------
-client.background color
------------------------
+-------------------------
+client.background <color>
+-------------------------
Only clients that do not cover the whole area of this window expose the color
used to paint it.
Only clients that do not cover the whole area of this window expose the color
used to paint it.
links in your browser window).
*Syntax*:
links in your browser window).
*Syntax*:
-----------------------------
-focus_follows_mouse <yes|no>
-----------------------------
+--------------------------
+focus_follows_mouse yes|no
+--------------------------
*Example*:
----------------------
*Example*:
----------------------
behavior described above.
*Syntax*:
behavior described above.
*Syntax*:
----------------------------
-mouse_warping <output|none>
----------------------------
+-------------------------
+mouse_warping output|none
+-------------------------
*Example*:
------------------
*Example*:
------------------
3. Leave fullscreen mode.
*Syntax*:
3. Leave fullscreen mode.
*Syntax*:
--------------------------------------------------
-popup_during_fullscreen <smart|ignore|leave_fullscreen>
--------------------------------------------------
+-----------------------------------------------------
+popup_during_fullscreen smart|ignore|leave_fullscreen
+-----------------------------------------------------
*Example*:
------------------------------
*Example*:
------------------------------
will always wrap.
*Syntax*:
will always wrap.
*Syntax*:
------------------------------
-force_focus_wrapping <yes|no>
------------------------------
+---------------------------
+force_focus_wrapping yes|no
+---------------------------
*Example*:
------------------------
*Example*:
------------------------
+--force-xinerama+ commandline parameter, a configuration option is provided:
*Syntax*:
+--force-xinerama+ commandline parameter, a configuration option is provided:
*Syntax*:
------------------------
-force_xinerama <yes|no>
------------------------
+---------------------
+force_xinerama yes|no
+---------------------
*Example*:
------------------
*Example*:
------------------
came from now, you can just press $mod+2 again to switch back to "1: www".
*Syntax*:
came from now, you can just press $mod+2 again to switch back to "1: www".
*Syntax*:
---------------------------------------
-workspace_auto_back_and_forth <yes|no>
---------------------------------------
+------------------------------------
+workspace_auto_back_and_forth yes|no
+------------------------------------
*Example*:
---------------------------------
*Example*:
---------------------------------
from being focused, see <<no_focus>>.
*Syntax*:
from being focused, see <<no_focus>>.
*Syntax*:
-----------------------------------------------------
-focus_on_window_activation <smart|urgent|focus|none>
-----------------------------------------------------
+--------------------------------------------------
+focus_on_window_activation smart|urgent|focus|none
+--------------------------------------------------
The different modes will act as follows:
The different modes will act as follows:
The default for this option is +yes+.
*Syntax*:
The default for this option is +yes+.
*Syntax*:
--------------------
-show_marks [yes|no]
--------------------
+-----------------
+show_marks yes|no
+-----------------
*Example*:
--------------
*Example*:
--------------
have to have correct quoting etc.
*Syntax*:
have to have correct quoting etc.
*Syntax*:
-----------------------
-i3bar_command command
-----------------------
+-----------------------
+i3bar_command <command>
+-----------------------
*Example*:
-------------------------------------------------
*Example*:
-------------------------------------------------
have to have correct quoting etc.
*Syntax*:
have to have correct quoting etc.
*Syntax*:
-----------------------
-status_command command
-----------------------
+------------------------
+status_command <command>
+------------------------
*Example*:
-------------------------------------------------
*Example*:
-------------------------------------------------
the windows key). The default value for the hidden_state is hide.
*Syntax*:
the windows key). The default value for the hidden_state is hide.
*Syntax*:
-----------------
-mode <dock|hide|invisible>
-hidden_state <hide|show>
+-------------------------
+mode dock|hide|invisible
+hidden_state hide|show
+------------------------
*Example*:
----------------
*Example*:
----------------
The default is bottom.
*Syntax*:
The default is bottom.
*Syntax*:
----------------------
-position <top|bottom>
----------------------
+-------------------
+position top|bottom
+-------------------
*Example*:
---------------------
*Example*:
---------------------
you can turn off the functionality entirely.
*Syntax*:
you can turn off the functionality entirely.
*Syntax*:
--------------------------
-tray_output <none|primary|output>
--------------------------
+-------------------------------
+tray_output none|primary|output
+-------------------------------
*Example*:
-------------------------
*Example*:
-------------------------
The default is to show workspace buttons.
*Syntax*:
The default is to show workspace buttons.
*Syntax*:
---------------------------
-workspace_buttons <yes|no>
---------------------------
+------------------------
+workspace_buttons yes|no
+------------------------
*Example*:
------------------------
*Example*:
------------------------
The default is to display the full name within the workspace button.
*Syntax*:
The default is to display the full name within the workspace button.
*Syntax*:
-----------------------------------
-strip_workspace_numbers <yes|no>
-----------------------------------
+------------------------------
+strip_workspace_numbers yes|no
+------------------------------
*Example*:
----------------------------
*Example*:
----------------------------
The default is to show the mode indicator.
*Syntax*:
The default is to show the mode indicator.
*Syntax*:
--------------------------------
-binding_mode_indicator <yes|no>
--------------------------------
+-----------------------------
+binding_mode_indicator yes|no
+-----------------------------
*Example*:
-----------------------------
*Example*:
-----------------------------
statusline <color>
separator <color>
statusline <color>
separator <color>
- colorclass <border> <background> <text>
+ <colorclass> <border> <background> <text>
}
----------------------------------------
}
----------------------------------------
you want to use them in your command.
*Syntax*:
you want to use them in your command.
*Syntax*:
-------------------------------
-exec [--no-startup-id] command
-------------------------------
+--------------------------------
+exec [--no-startup-id] <command>
+--------------------------------
*Example*:
------------------------------
*Example*:
------------------------------
to splith or vice-versa.
*Syntax*:
to splith or vice-versa.
*Syntax*:
----------------------------
-split <vertical|horizontal>
----------------------------
+-------------------------
+split vertical|horizontal
+-------------------------
*Example*:
------------------------------
*Example*:
------------------------------
enable+ respectively +floating disable+ (or +floating toggle+):
*Syntax*:
enable+ respectively +floating disable+ (or +floating toggle+):
*Syntax*:
---------------
-layout <default|tabbed|stacking|splitv|splith>
+--------------------------------------------
+layout default|tabbed|stacking|splitv|splith
layout toggle [split|all]
layout toggle [split|all]
+--------------------------------------------
*Examples*:
--------------
*Examples*:
--------------
*Syntax*:
-----------------------------------
*Syntax*:
-----------------------------------
-workspace <next|prev|next_on_output|prev_on_output>
+workspace next|prev|next_on_output|prev_on_output
workspace back_and_forth
workspace <name>
workspace number <name>
move [window|container] [to] workspace <name>
move [window|container] [to] workspace number <name>
workspace back_and_forth
workspace <name>
workspace number <name>
move [window|container] [to] workspace <name>
move [window|container] [to] workspace number <name>
-move [window|container] [to] workspace <prev|next|current>
+move [window|container] [to] workspace prev|next|current
-----------------------------------
*Examples*:
-----------------------------------
*Examples*:
+right+, +up+ or +down+), there are two commands:
*Syntax*:
+right+, +up+ or +down+), there are two commands:
*Syntax*:
---------------------------------------------------------
-move container to output <<left|right|down|up>|<output>>
-move workspace to output <<left|right|down|up>|<output>>
---------------------------------------------------------
+----------------------------------------------------
+move container to output left|right|down|up|<output>
+move workspace to output left|right|down|up|<output>
+----------------------------------------------------
*Examples*:
--------------------------------------------------------
*Examples*:
--------------------------------------------------------
+resize+ command:
*Syntax*:
+resize+ command:
*Syntax*:
----------------------------------------------------------
-resize <grow|shrink> <direction> [<px> px [or <ppt> ppt]]
----------------------------------------------------------
+-------------------------------------------------------
+resize grow|shrink <direction> [<px> px [or <ppt> ppt]]
+-------------------------------------------------------
Direction can either be one of +up+, +down+, +left+ or +right+. Or you can be
less specific and use +width+ or +height+, in which case i3 will take/give
Direction can either be one of +up+, +down+, +left+ or +right+. Or you can be
less specific and use +width+ or +height+, in which case i3 will take/give
*Syntax*:
------------------------------
*Syntax*:
------------------------------
-mark [--toggle] identifier
+mark [--toggle] <identifier>
[con_mark="identifier"] focus
[con_mark="identifier"] focus
------------------------------
*Example (in a terminal)*:
------------------------------
*Example (in a terminal)*:
you limited) automatically as needed.
*Syntax*:
you limited) automatically as needed.
*Syntax*:
---------------------------------
-stack-limit <cols|rows> <value>
---------------------------------
+-----------------------------
+stack-limit cols|rows <value>
+-----------------------------
*Examples*:
-------------------
*Examples*:
-------------------
*Syntax*:
------------------------------
shmlog <size_in_bytes>
*Syntax*:
------------------------------
shmlog <size_in_bytes>
------------------------------
*Examples*:
------------------------------
*Examples*:
likely useful in combination with the above-described <<shmlog>> command.
*Syntax*:
likely useful in combination with the above-described <<shmlog>> command.
*Syntax*:
-------------------------
-debuglog <on|off|toggle>
-------------------------
+----------------------
+debuglog on|off|toggle
+----------------------
*Examples*:
------------------------
*Examples*:
------------------------
# new_window <normal|1pixel|none>
# new_float <normal|1pixel|none>
# new_window <normal|1pixel|none>
# new_float <normal|1pixel|none>
-# TODO: new_float is not in the userguide yet
-# TODO: pixel is not in the userguide yet
state NEW_WINDOW:
border = 'normal', 'pixel'
-> NEW_WINDOW_PIXELS
state NEW_WINDOW:
border = 'normal', 'pixel'
-> NEW_WINDOW_PIXELS