]> git.sur5r.net Git - i3/i3.github.io/blobdiff - docs/4.15/i3.html
save docs for 4.15
[i3/i3.github.io] / docs / 4.15 / i3.html
diff --git a/docs/4.15/i3.html b/docs/4.15/i3.html
new file mode 100644 (file)
index 0000000..76e49c5
--- /dev/null
@@ -0,0 +1,530 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"\r
+    "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">\r
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">\r
+<head>\r
+<link rel="icon" type="image/x-icon" href="/favicon.ico">\r
+<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />\r
+<meta name="generator" content="AsciiDoc 8.6.8" />\r
+<title>i3: i3(1)</title>\r
+<link rel="stylesheet" href="/css/style.css" type="text/css" />\r
+<link rel="stylesheet" href="/css/xhtml11.css" type="text/css" />\r
+<script type="text/javascript">\r
+/*<![CDATA[*/\r
+document.addEventListener("DOMContentLoaded", function(){asciidoc.footnotes(); asciidoc.toc(2);}, false);\r
+/*]]>*/\r
+</script>\r
+<script type="text/javascript" src="/js/asciidoc-xhtml11.js"></script>\r
+</head>\r
+<body class="article">\r
+\r
+        <div id="main">\r
+            <a href="/"><h1 id="title">i3 - improved tiling WM</h1></a>\r
+                        <ul id="nav">\r
+                                <li><a style="border-bottom: 2px solid #fff" href="/docs">Docs</a></li>\r
+                                <li><a href="/screenshots">Screens</a></li>\r
+                                <li><a href="https://faq.i3wm.org/">FAQ</a></li>\r
+                                <li><a href="/contact">Contact</a></li>\r
+                                <li><a href="https://github.com/i3/i3/issues">Bugs</a></li>\r
+                        </ul>\r
+        <br style="clear: both">\r
+<div id="content">\r
+<div id="header">\r
+<h1>i3(1)</h1>\r
+<span id="author">Michael Stapelberg</span><br />\r
+<span id="email"><tt>&lt;<a href="mailto:michael+i3@stapelberg.de">michael+i3@stapelberg.de</a>&gt;</tt></span><br />\r
+<span id="revnumber">version 4.0,</span>\r
+<span id="revdate">July 2011</span>\r
+<div id="toc">
+  <div id="toctitle">Table of Contents</div>
+  <noscript><p><b>JavaScript must be enabled in your browser to display the table of contents.</b></p></noscript>
+</div>\r
+</div>\r
+<div class="sect1">\r
+<h2 id="_name">1. NAME</h2>\r
+<div class="sectionbody">\r
+<div class="paragraph"><p>i3 - an improved dynamic, tiling window manager</p></div>\r
+</div>\r
+</div>\r
+<div class="sect1">\r
+<h2 id="_synopsis">2. SYNOPSIS</h2>\r
+<div class="sectionbody">\r
+<div class="paragraph"><p>i3 [-a] [-c configfile] [-C] [-d &lt;loglevel&gt;] [-v] [-V]</p></div>\r
+</div>\r
+</div>\r
+<div class="sect1">\r
+<h2 id="_options">3. OPTIONS</h2>\r
+<div class="sectionbody">\r
+<div class="dlist"><dl>\r
+<dt class="hdlist1">\r
+-a\r
+</dt>\r
+<dd>\r
+<p>\r
+Disables autostart.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-c\r
+</dt>\r
+<dd>\r
+<p>\r
+Specifies an alternate configuration file path.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-C\r
+</dt>\r
+<dd>\r
+<p>\r
+Check the configuration file for validity and exit.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-d\r
+</dt>\r
+<dd>\r
+<p>\r
+Specifies the debug loglevel. To see the most output, use -d all.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dd>\r
+<p>\r
+Display version number (and date of the last commit).\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-V\r
+</dt>\r
+<dd>\r
+<p>\r
+Be verbose.\r
+</p>\r
+</dd>\r
+</dl></div>\r
+</div>\r
+</div>\r
+<div class="sect1">\r
+<h2 id="_description">4. DESCRIPTION</h2>\r
+<div class="sectionbody">\r
+<div class="sect2">\r
+<h3 id="_introduction">4.1. INTRODUCTION</h3>\r
+<div class="paragraph"><p>i3 was created because wmii, our favorite window manager at the time, didn’t\r
+provide some features we wanted (multi-monitor done right, for example), had\r
+some bugs, didn’t progress since quite some time and wasn’t easy to hack at all\r
+(source code comments/documentation completely lacking). Still, we think the\r
+wmii developers and contributors did a great job. Thank you for inspiring us to\r
+create i3.</p></div>\r
+<div class="paragraph"><p>Please be aware that i3 is primarily targeted at advanced users and developers.</p></div>\r
+</div>\r
+<div class="sect2">\r
+<h3 id="_important_note_to_nvidia_binary_driver_users">4.2. IMPORTANT NOTE TO nVidia BINARY DRIVER USERS</h3>\r
+<div class="paragraph"><p>If you are using the nVidia binary graphics driver (also known as <em>blob</em>)\r
+you need to use the <tt>--force-xinerama</tt> flag (in your ~/.xsession) when starting\r
+i3, like so:</p></div>\r
+<div class="listingblock">\r
+<div class="content">\r
+<pre><tt>exec i3 --force-xinerama -V &gt;&gt;~/.i3/i3log 2&gt;&amp;1</tt></pre>\r
+</div></div>\r
+<div class="paragraph"><p>See also docs/multi-monitor for the full explanation.</p></div>\r
+</div>\r
+<div class="sect2">\r
+<h3 id="_terminology">4.3. TERMINOLOGY</h3>\r
+<div class="dlist"><dl>\r
+<dt class="hdlist1">\r
+Tree\r
+</dt>\r
+<dd>\r
+<p>\r
+i3 keeps your layout in a tree data structure.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+Window\r
+</dt>\r
+<dd>\r
+<p>\r
+An X11 window, like the Firefox browser window or a terminal emulator.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+Split container\r
+</dt>\r
+<dd>\r
+<p>\r
+A split container contains multiple other split containers or windows.\r
+</p>\r
+<div class="paragraph"><p>Containers can be used in various layouts. The default mode is called "default"\r
+and just resizes each client equally so that it fits.</p></div>\r
+</dd>\r
+<dt class="hdlist1">\r
+Workspace\r
+</dt>\r
+<dd>\r
+<p>\r
+A workspace is a set of containers. Other window managers call this "Virtual\r
+Desktops".\r
+</p>\r
+<div class="paragraph"><p>In i3, each workspace is assigned to a specific virtual screen. By default,\r
+screen 1 has workspace 1, screen 2 has workspace 2 and so on… However, when you\r
+create a new workspace (by simply switching to it), it’ll be assigned the\r
+screen you are currently on.</p></div>\r
+</dd>\r
+<dt class="hdlist1">\r
+Output\r
+</dt>\r
+<dd>\r
+<p>\r
+Using XRandR, you can have an X11 screen spanning multiple real monitors.\r
+Furthermore, you can set them up in cloning mode or with positions (monitor 1\r
+is left of monitor 2).\r
+</p>\r
+<div class="paragraph"><p>i3 uses the RandR API to query which outputs are available and which screens\r
+are connected to these outputs.</p></div>\r
+</dd>\r
+</dl></div>\r
+</div>\r
+</div>\r
+</div>\r
+<div class="sect1">\r
+<h2 id="_keybindings">5. KEYBINDINGS</h2>\r
+<div class="sectionbody">\r
+<div class="paragraph"><p>Here is a short overview of the default keybindings:</p></div>\r
+<div class="dlist"><dl>\r
+<dt class="hdlist1">\r
+j/k/l/;\r
+</dt>\r
+<dd>\r
+<p>\r
+Direction keys (left, down, up, right). They are on your homerow (see the mark\r
+on your "j" key). Alternatively, you can use the cursor keys.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+Mod1+&lt;direction&gt;\r
+</dt>\r
+<dd>\r
+<p>\r
+Focus window in &lt;direction&gt;.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+Mod1+Shift+&lt;direction&gt;\r
+</dt>\r
+<dd>\r
+<p>\r
+Move window to &lt;direction&gt;.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+Mod1+&lt;number&gt;\r
+</dt>\r
+<dd>\r
+<p>\r
+Switch to workspace &lt;number&gt;.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+Mod1+Shift+&lt;number&gt;\r
+</dt>\r
+<dd>\r
+<p>\r
+Move window to workspace &lt;number&gt;.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+Mod1+f\r
+</dt>\r
+<dd>\r
+<p>\r
+Toggle fullscreen mode.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+Mod1+s\r
+</dt>\r
+<dd>\r
+<p>\r
+Enable stacking layout for the current container.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+Mod1+e\r
+</dt>\r
+<dd>\r
+<p>\r
+Enable default layout for the current container.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+Mod1+w\r
+</dt>\r
+<dd>\r
+<p>\r
+Enable tabbed layout for the current container.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+Mod1+Shift+Space\r
+</dt>\r
+<dd>\r
+<p>\r
+Toggle tiling/floating for the current container.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+Mod1+Space\r
+</dt>\r
+<dd>\r
+<p>\r
+Select the first tiling container if the current container is floating and\r
+vice-versa.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+Mod1+Shift+q\r
+</dt>\r
+<dd>\r
+<p>\r
+Kills the current window. This is equivalent to "clicking on the close button",\r
+meaning a polite request to the application to close this window. For example,\r
+Firefox will save its session upon such a request. If the application does not\r
+support that, the window will be killed and it depends on the application what\r
+happens.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+Mod1+Shift+r\r
+</dt>\r
+<dd>\r
+<p>\r
+Restarts i3 in place. Your layout will be preserved.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+Mod1+Shift+e\r
+</dt>\r
+<dd>\r
+<p>\r
+Exits i3.\r
+</p>\r
+</dd>\r
+</dl></div>\r
+</div>\r
+</div>\r
+<div class="sect1">\r
+<h2 id="_files">6. FILES</h2>\r
+<div class="sectionbody">\r
+<div class="sect2">\r
+<h3 id="_i3_config_or_config_i3_config">6.1. ~/.i3/config (or ~/.config/i3/config)</h3>\r
+<div class="paragraph"><p>When starting, i3 looks for configuration files in the following order:</p></div>\r
+<div class="olist arabic"><ol class="arabic">\r
+<li>\r
+<p>\r
+~/.config/i3/config (or $XDG_CONFIG_HOME/i3/config if set)\r
+</p>\r
+</li>\r
+<li>\r
+<p>\r
+/etc/xdg/i3/config (or $XDG_CONFIG_DIRS/i3/config if set)\r
+</p>\r
+</li>\r
+<li>\r
+<p>\r
+~/.i3/config\r
+</p>\r
+</li>\r
+<li>\r
+<p>\r
+/etc/i3/config\r
+</p>\r
+</li>\r
+</ol></div>\r
+<div class="paragraph"><p>You can specify a custom path using the -c option.</p></div>\r
+<div class="listingblock">\r
+<div class="title">Sample configuration</div>\r
+<div class="content">\r
+<pre><tt># i3 config file (v4)\r
+\r
+# font for window titles. ISO 10646 = Unicode\r
+font -misc-fixed-medium-r-normal--13-120-75-75-C-70-iso10646-1\r
+\r
+# use Mouse+Mod1 to drag floating windows to their wanted position\r
+floating_modifier Mod1\r
+\r
+# start a terminal\r
+bindsym Mod1+Return exec /usr/bin/urxvt\r
+\r
+# kill focused window\r
+bindsym Mod1+Shift+q kill\r
+\r
+# start dmenu (a program launcher)\r
+bindsym Mod1+d exec /usr/bin/dmenu_run\r
+\r
+# change focus\r
+bindsym Mod1+j focus left\r
+bindsym Mod1+k focus down\r
+bindsym Mod1+l focus up\r
+bindsym Mod1+semicolon focus right\r
+\r
+# alternatively, you can use the cursor keys:\r
+bindsym Mod1+Left focus left\r
+bindsym Mod1+Down focus down\r
+bindsym Mod1+Up focus up\r
+bindsym Mod1+Right focus right\r
+\r
+# move focused window\r
+bindsym Mod1+Shift+j move left\r
+bindsym Mod1+Shift+k move down\r
+bindsym Mod1+Shift+l move up\r
+bindsym Mod1+Shift+semicolon move right\r
+\r
+# alternatively, you can use the cursor keys:\r
+bindsym Mod1+Shift+Left move left\r
+bindsym Mod1+Shift+Down move down\r
+bindsym Mod1+Shift+Up move up\r
+bindsym Mod1+Shift+Right move right\r
+\r
+# split in horizontal orientation\r
+bindsym Mod1+h split h\r
+\r
+# split in vertical orientation\r
+bindsym Mod1+v split v\r
+\r
+# enter fullscreen mode for the focused container\r
+bindsym Mod1+f fullscreen\r
+\r
+# change container layout (stacked, tabbed, default)\r
+bindsym Mod1+s layout stacking\r
+bindsym Mod1+w layout tabbed\r
+bindsym Mod1+e layout default\r
+\r
+# toggle tiling / floating\r
+bindsym Mod1+Shift+space floating toggle\r
+\r
+# change focus between tiling / floating windows\r
+bindsym Mod1+space focus mode_toggle\r
+\r
+# focus the parent container\r
+bindsym Mod1+a focus parent\r
+\r
+# focus the child container\r
+#bindsym Mod1+d focus child\r
+\r
+# switch to workspace\r
+bindsym Mod1+1 workspace 1\r
+bindsym Mod1+2 workspace 2\r
+# ..\r
+\r
+# move focused container to workspace\r
+bindsym Mod1+Shift+1 move workspace 1\r
+bindsym Mod1+Shift+2 move workspace 2\r
+# ...\r
+\r
+# reload the configuration file\r
+bindsym Mod1+Shift+c reload\r
+# restart i3 inplace (preserves your layout/session, can be used to upgrade i3)\r
+bindsym Mod1+Shift+r restart\r
+# exit i3 (logs you out of your X session)\r
+bindsym Mod1+Shift+e exit\r
+\r
+# display workspace buttons plus a statusline generated by i3status\r
+bar {\r
+    status_command i3status\r
+}</tt></pre>\r
+</div></div>\r
+</div>\r
+<div class="sect2">\r
+<h3 id="_xsession">6.2. ~/.xsession</h3>\r
+<div class="paragraph"><p>This file is where you should configure your locales and start i3. It is run by\r
+your login manager (xdm, slim, gdm, …) as soon as you login.</p></div>\r
+<div class="listingblock">\r
+<div class="title">Sample xsession</div>\r
+<div class="content">\r
+<pre><tt># Disable DPMS turning off the screen\r
+xset -dpms\r
+xset s off\r
+\r
+# Disable bell\r
+xset -b\r
+\r
+# Enable zapping (C-A-&lt;Bksp&gt; kills X)\r
+setxkbmap -option terminate:ctrl_alt_bksp\r
+\r
+# Enforce correct locales from the beginning\r
+unset LC_COLLATE\r
+export LC_CTYPE=de_DE.UTF-8\r
+export LC_TIME=de_DE.UTF-8\r
+export LC_NUMERIC=de_DE.UTF-8\r
+export LC_MONETARY=de_DE.UTF-8\r
+export LC_MESSAGES=C\r
+export LC_PAPER=de_DE.UTF-8\r
+export LC_NAME=de_DE.UTF-8\r
+export LC_ADDRESS=de_DE.UTF-8\r
+export LC_TELEPHONE=de_DE.UTF-8\r
+export LC_MEASUREMENT=de_DE.UTF-8\r
+export LC_IDENTIFICATION=de_DE.UTF-8\r
+\r
+# Use XToolkit in java applications\r
+export AWT_TOOLKIT=XToolkit\r
+\r
+# Set background color\r
+xsetroot -solid "#333333"\r
+\r
+# Enable core dumps in case something goes wrong\r
+ulimit -c unlimited\r
+\r
+# Start i3 and log to ~/.i3/logfile\r
+echo "Starting at $(date)" &gt;&gt; ~/.i3/logfile\r
+exec /usr/bin/i3 -V -d all &gt;&gt; ~/.i3/logfile</tt></pre>\r
+</div></div>\r
+</div>\r
+</div>\r
+</div>\r
+<div class="sect1">\r
+<h2 id="_environment">7. ENVIRONMENT</h2>\r
+<div class="sectionbody">\r
+<div class="sect2">\r
+<h3 id="_i3sock">7.1. I3SOCK</h3>\r
+<div class="paragraph"><p>This variable overwrites the IPC socket path (placed in\r
+/tmp/i3-%u.XXXXXX/ipc-socket.%p by default, where %u is replaced with your UNIX\r
+username, %p is replaced with i3’s PID and XXXXXX is a string of random\r
+characters from the portable filename character set (see mkdtemp(3))). The IPC\r
+socket is used by external programs like i3-msg(1) or i3bar(1).</p></div>\r
+</div>\r
+</div>\r
+</div>\r
+<div class="sect1">\r
+<h2 id="_todo">8. TODO</h2>\r
+<div class="sectionbody">\r
+<div class="paragraph"><p>There is still lot of work to do. Please check our bugtracker for up-to-date\r
+information about tasks which are still not finished.</p></div>\r
+</div>\r
+</div>\r
+<div class="sect1">\r
+<h2 id="_see_also">9. SEE ALSO</h2>\r
+<div class="sectionbody">\r
+<div class="paragraph"><p>You should have a copy of the userguide (featuring nice screenshots/graphics\r
+which is why this is not integrated into this manpage), the debugging guide,\r
+and the "how to hack" guide. If you are building from source, run:\r
+ <tt>make -C docs</tt></p></div>\r
+<div class="paragraph"><p>You can also access these documents online at <a href="http://i3.zekjur.net/">http://i3.zekjur.net/</a></p></div>\r
+<div class="paragraph"><p>i3-input(1), i3-msg(1), i3-wsbar(1), i3-nagbar(1), i3-config-wizard(1),\r
+i3-migrate-config-to-v4(1)</p></div>\r
+</div>\r
+</div>\r
+<div class="sect1">\r
+<h2 id="_author">10. AUTHOR</h2>\r
+<div class="sectionbody">\r
+<div class="paragraph"><p>Michael Stapelberg and contributors</p></div>\r
+</div>\r
+</div>\r
+</div>\r
+<div id="footnotes"><hr /></div>\r
+<div id="footer" lang="de">\r
+© 2009-2011 Michael Stapelberg, <a href="/impress.html">Impressum</a>\r
+</div>\r
+</body>\r
+</html>\r