]> git.sur5r.net Git - i3/i3.github.io/blobdiff - docs/4.16/manpage.html
save docs for 4.16
[i3/i3.github.io] / docs / 4.16 / manpage.html
diff --git a/docs/4.16/manpage.html b/docs/4.16/manpage.html
new file mode 100644 (file)
index 0000000..80fa2ec
--- /dev/null
@@ -0,0 +1,528 @@
+<!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
+<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />\r
+<meta name="generator" content="AsciiDoc 8.6.4" />\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
+window.onload = function(){asciidoc.footnotes(); asciidoc.toc(2);}\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="/contact">Contact</a></li>\r
+                                <li><a href="http://bugs.i3wm.org/">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 3.epsilon,</span>\r
+<span id="revdate">March 2010</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
+Client\r
+</dt>\r
+<dd>\r
+<p>\r
+A client is X11-speak for a window.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+Table\r
+</dt>\r
+<dd>\r
+<p>\r
+Your workspace is managed using a table. You can move windows around and create\r
+new columns (move a client to the right) or rows (move it to the bottom)\r
+implicitly.\r
+</p>\r
+<div class="paragraph"><p>By "snapping" a client in a specific direction, you increase its colspan/rowspan.</p></div>\r
+</dd>\r
+<dt class="hdlist1">\r
+Container\r
+</dt>\r
+<dd>\r
+<p>\r
+A container contains a variable number of clients. Each cell of the table is a\r
+container.\r
+</p>\r
+<div class="paragraph"><p>Containers can be used in various modes. 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 clients (technically speaking, it’s just a table).\r
+Other window managers call this "Virtual 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
+Mod3+&lt;direction&gt;\r
+</dt>\r
+<dd>\r
+<p>\r
+Focus container 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
+Mod3+Shift+&lt;direction&gt;\r
+</dt>\r
+<dd>\r
+<p>\r
+Move container to &lt;direction&gt;.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+Mod1+Control+&lt;direction&gt;\r
+</dt>\r
+<dd>\r
+<p>\r
+Snap container 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+h\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+Shift+Space\r
+</dt>\r
+<dd>\r
+<p>\r
+Toggle tiling/floating for the current window.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+Mod1+t\r
+</dt>\r
+<dd>\r
+<p>\r
+Select the first tiling window if the current window is floating and 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 (without losing any windows, but at this time, the layout\r
+and placement of windows is not retained).\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>font -misc-fixed-medium-r-normal--13-120-75-75-C-70-iso10646-1\r
+\r
+# Start terminal (Mod1+Enter)\r
+bind Mod1+36 exec /usr/bin/urxvt\r
+\r
+# Start dmenu (Mod1+v)\r
+bind Mod1+55 exec /usr/bin/dmenu_run\r
+\r
+# Kill current client (Mod1+Shift+q)\r
+bind Mod1+Shift+24 kill\r
+\r
+# Beamer on/off\r
+bind Mod1+73 exec /home/michael/toggle_beamer.sh\r
+\r
+# Screen locking\r
+bind Mod1+68 exec /usr/bin/i3lock\r
+\r
+# Restart i3 inplace (Mod1+Shift+r)\r
+bind Mod1+Shift+27 restart\r
+\r
+# Exit i3 (Mod1+Shift+e)\r
+bind Mod1+Shift+26 exit\r
+\r
+# Brightness\r
+bind Mod1+97 exec sudo sh -c "echo up &gt; /proc/acpi/ibm/brightness"\r
+bind Mod1+103 exec sudo sh -c "echo down &gt; /proc/acpi/ibm/brightness"\r
+\r
+# Fullscreen (Mod1+f)\r
+bind Mod1+41 f\r
+\r
+# Stacking (Mod1+h)\r
+bind Mod1+43 s\r
+\r
+# Default (Mod1+e)\r
+bind Mod1+26 d\r
+\r
+# Toggle tiling/floating of the current window (Mod1+Shift+Space)\r
+bind Mod1+Shift+65 t\r
+\r
+# Go into the tiling layer / floating layer, depending on whether\r
+# the current window is tiling / floating (Mod1+t)\r
+bind Mod1+28 focus ft\r
+\r
+# Focus (Mod1+j/k/l/;)\r
+bind Mod1+44 h\r
+bind Mod1+45 j\r
+bind Mod1+46 k\r
+bind Mod1+47 l\r
+\r
+# Focus Container (Mod3+j/k/l/;)\r
+bind Mod3+44 wch\r
+bind Mod3+45 wcj\r
+bind Mod3+46 wck\r
+bind Mod3+47 wcl\r
+\r
+# Snap (Mod1+Control+j/k/l/;)\r
+bind Mod1+Control+44 sh\r
+bind Mod1+Control+45 sj\r
+bind Mod1+Control+46 sk\r
+bind Mod1+Control+47 sl\r
+\r
+# Move (Mod1+Shift+j/k/l/;)\r
+bind Mod1+Shift+44 mh\r
+bind Mod1+Shift+45 mj\r
+bind Mod1+Shift+46 mk\r
+bind Mod1+Shift+47 ml\r
+\r
+# Move Container (Mod3+Shift+j/k/l/;)\r
+bind Mod3+Shift+44 wcmh\r
+bind Mod3+Shift+45 wcmj\r
+bind Mod3+Shift+46 wcmk\r
+bind Mod3+Shift+47 wcml\r
+\r
+# Workspaces\r
+bind Mod1+10 1\r
+bind Mod1+11 2\r
+...\r
+\r
+# Move to Workspace\r
+bind Mod1+Shift+10 1\r
+bind Mod1+Shift+11 2\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 force on\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="_todo">7. 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">8. 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)</p></div>\r
+</div>\r
+</div>\r
+<div class="sect1">\r
+<h2 id="_author">9. 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