git.sur5r.net Git - i3/i3.github.io/blob - docs/4.13/i3.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"\r
   2     "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">\r
   3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">\r
   4 <head>\r
   5 <link rel="icon" type="image/x-icon" href="/favicon.ico">\r
   6 <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />\r
   7 <meta name="generator" content="AsciiDoc 8.6.8" />\r
   8 <title>i3: i3(1)</title>\r
   9 <link rel="stylesheet" href="/css/style.css" type="text/css" />\r
  10 <link rel="stylesheet" href="/css/xhtml11.css" type="text/css" />\r
  11 <script type="text/javascript">\r
  12 /*<![CDATA[*/\r
  13 document.addEventListener("DOMContentLoaded", function(){asciidoc.footnotes(); asciidoc.toc(2);}, false);\r
  14 /*]]>*/\r
  15 </script>\r
  16 <script type="text/javascript" src="/js/asciidoc-xhtml11.js"></script>\r
  17 </head>\r
  18 <body class="article">\r
  19 \r
  20         <div id="main">\r
  21             <a href="/"><h1 id="title">i3 - improved tiling WM</h1></a>\r
  22                         <ul id="nav">\r
  23                                 <li><a style="border-bottom: 2px solid #fff" href="/docs">Docs</a></li>\r
  24                                 <li><a href="/screenshots">Screens</a></li>\r
  25                                 <li><a href="https://faq.i3wm.org/">FAQ</a></li>\r
  26                                 <li><a href="/contact">Contact</a></li>\r
  27                                 <li><a href="https://github.com/i3/i3/issues">Bugs</a></li>\r
  28                         </ul>\r
  29         <br style="clear: both">\r
  30 <div id="content">\r
  31 <div id="header">\r
  32 <h1>i3(1)</h1>\r
  33 <span id="author">Michael Stapelberg</span><br />\r
  34 <span id="email"><tt>&lt;<a href="mailto:michael+i3@stapelberg.de">michael+i3@stapelberg.de</a>&gt;</tt></span><br />\r
  35 <span id="revnumber">version 4.0,</span>\r
  36 <span id="revdate">July 2011</span>\r
  37 <div id="toc">
  38   <div id="toctitle">Table of Contents</div>
  39   <noscript><p><b>JavaScript must be enabled in your browser to display the table of contents.</b></p></noscript>
  40 </div>\r
  41 </div>\r
  42 <div class="sect1">\r
  43 <h2 id="_name">1. NAME</h2>\r
  44 <div class="sectionbody">\r
  45 <div class="paragraph"><p>i3 - an improved dynamic, tiling window manager</p></div>\r
  46 </div>\r
  47 </div>\r
  48 <div class="sect1">\r
  49 <h2 id="_synopsis">2. SYNOPSIS</h2>\r
  50 <div class="sectionbody">\r
  51 <div class="paragraph"><p>i3 [-a] [-c configfile] [-C] [-d &lt;loglevel&gt;] [-v] [-V]</p></div>\r
  52 </div>\r
  53 </div>\r
  54 <div class="sect1">\r
  55 <h2 id="_options">3. OPTIONS</h2>\r
  56 <div class="sectionbody">\r
  57 <div class="dlist"><dl>\r
  58 <dt class="hdlist1">\r
  59 -a\r
  60 </dt>\r
  61 <dd>\r
  62 <p>\r
  63 Disables autostart.\r
  64 </p>\r
  65 </dd>\r
  66 <dt class="hdlist1">\r
  67 -c\r
  68 </dt>\r
  69 <dd>\r
  70 <p>\r
  71 Specifies an alternate configuration file path.\r
  72 </p>\r
  73 </dd>\r
  74 <dt class="hdlist1">\r
  75 -C\r
  76 </dt>\r
  77 <dd>\r
  78 <p>\r
  79 Check the configuration file for validity and exit.\r
  80 </p>\r
  81 </dd>\r
  82 <dt class="hdlist1">\r
  83 -d\r
  84 </dt>\r
  85 <dd>\r
  86 <p>\r
  87 Specifies the debug loglevel. To see the most output, use -d all.\r
  88 </p>\r
  89 </dd>\r
  90 <dt class="hdlist1">\r
  91 -v\r
  92 </dt>\r
  93 <dd>\r
  94 <p>\r
  95 Display version number (and date of the last commit).\r
  96 </p>\r
  97 </dd>\r
  98 <dt class="hdlist1">\r
  99 -V\r
 100 </dt>\r
 101 <dd>\r
 102 <p>\r
 103 Be verbose.\r
 104 </p>\r
 105 </dd>\r
 106 </dl></div>\r
 107 </div>\r
 108 </div>\r
 109 <div class="sect1">\r
 110 <h2 id="_description">4. DESCRIPTION</h2>\r
 111 <div class="sectionbody">\r
 112 <div class="sect2">\r
 113 <h3 id="_introduction">4.1. INTRODUCTION</h3>\r
 114 <div class="paragraph"><p>i3 was created because wmii, our favorite window manager at the time, didn’t\r
 115 provide some features we wanted (multi-monitor done right, for example), had\r
 116 some bugs, didn’t progress since quite some time and wasn’t easy to hack at all\r
 117 (source code comments/documentation completely lacking). Still, we think the\r
 118 wmii developers and contributors did a great job. Thank you for inspiring us to\r
 119 create i3.</p></div>\r
 120 <div class="paragraph"><p>Please be aware that i3 is primarily targeted at advanced users and developers.</p></div>\r
 121 </div>\r
 122 <div class="sect2">\r
 123 <h3 id="_important_note_to_nvidia_binary_driver_users">4.2. IMPORTANT NOTE TO nVidia BINARY DRIVER USERS</h3>\r
 124 <div class="paragraph"><p>If you are using the nVidia binary graphics driver (also known as <em>blob</em>)\r
 125 you need to use the <tt>--force-xinerama</tt> flag (in your ~/.xsession) when starting\r
 126 i3, like so:</p></div>\r
 127 <div class="listingblock">\r
 128 <div class="content">\r
 129 <pre><tt>exec i3 --force-xinerama -V &gt;&gt;~/.i3/i3log 2&gt;&amp;1</tt></pre>\r
 130 </div></div>\r
 131 <div class="paragraph"><p>See also docs/multi-monitor for the full explanation.</p></div>\r
 132 </div>\r
 133 <div class="sect2">\r
 134 <h3 id="_terminology">4.3. TERMINOLOGY</h3>\r
 135 <div class="dlist"><dl>\r
 136 <dt class="hdlist1">\r
 137 Tree\r
 138 </dt>\r
 139 <dd>\r
 140 <p>\r
 141 i3 keeps your layout in a tree data structure.\r
 142 </p>\r
 143 </dd>\r
 144 <dt class="hdlist1">\r
 145 Window\r
 146 </dt>\r
 147 <dd>\r
 148 <p>\r
 149 An X11 window, like the Firefox browser window or a terminal emulator.\r
 150 </p>\r
 151 </dd>\r
 152 <dt class="hdlist1">\r
 153 Split container\r
 154 </dt>\r
 155 <dd>\r
 156 <p>\r
 157 A split container contains multiple other split containers or windows.\r
 158 </p>\r
 159 <div class="paragraph"><p>Containers can be used in various layouts. The default mode is called "default"\r
 160 and just resizes each client equally so that it fits.</p></div>\r
 161 </dd>\r
 162 <dt class="hdlist1">\r
 163 Workspace\r
 164 </dt>\r
 165 <dd>\r
 166 <p>\r
 167 A workspace is a set of containers. Other window managers call this "Virtual\r
 168 Desktops".\r
 169 </p>\r
 170 <div class="paragraph"><p>In i3, each workspace is assigned to a specific virtual screen. By default,\r
 171 screen 1 has workspace 1, screen 2 has workspace 2 and so on… However, when you\r
 172 create a new workspace (by simply switching to it), it’ll be assigned the\r
 173 screen you are currently on.</p></div>\r
 174 </dd>\r
 175 <dt class="hdlist1">\r
 176 Output\r
 177 </dt>\r
 178 <dd>\r
 179 <p>\r
 180 Using XRandR, you can have an X11 screen spanning multiple real monitors.\r
 181 Furthermore, you can set them up in cloning mode or with positions (monitor 1\r
 182 is left of monitor 2).\r
 183 </p>\r
 184 <div class="paragraph"><p>i3 uses the RandR API to query which outputs are available and which screens\r
 185 are connected to these outputs.</p></div>\r
 186 </dd>\r
 187 </dl></div>\r
 188 </div>\r
 189 </div>\r
 190 </div>\r
 191 <div class="sect1">\r
 192 <h2 id="_keybindings">5. KEYBINDINGS</h2>\r
 193 <div class="sectionbody">\r
 194 <div class="paragraph"><p>Here is a short overview of the default keybindings:</p></div>\r
 195 <div class="dlist"><dl>\r
 196 <dt class="hdlist1">\r
 197 j/k/l/;\r
 198 </dt>\r
 199 <dd>\r
 200 <p>\r
 201 Direction keys (left, down, up, right). They are on your homerow (see the mark\r
 202 on your "j" key). Alternatively, you can use the cursor keys.\r
 203 </p>\r
 204 </dd>\r
 205 <dt class="hdlist1">\r
 206 Mod1+&lt;direction&gt;\r
 207 </dt>\r
 208 <dd>\r
 209 <p>\r
 210 Focus window in &lt;direction&gt;.\r
 211 </p>\r
 212 </dd>\r
 213 <dt class="hdlist1">\r
 214 Mod1+Shift+&lt;direction&gt;\r
 215 </dt>\r
 216 <dd>\r
 217 <p>\r
 218 Move window to &lt;direction&gt;.\r
 219 </p>\r
 220 </dd>\r
 221 <dt class="hdlist1">\r
 222 Mod1+&lt;number&gt;\r
 223 </dt>\r
 224 <dd>\r
 225 <p>\r
 226 Switch to workspace &lt;number&gt;.\r
 227 </p>\r
 228 </dd>\r
 229 <dt class="hdlist1">\r
 230 Mod1+Shift+&lt;number&gt;\r
 231 </dt>\r
 232 <dd>\r
 233 <p>\r
 234 Move window to workspace &lt;number&gt;.\r
 235 </p>\r
 236 </dd>\r
 237 <dt class="hdlist1">\r
 238 Mod1+f\r
 239 </dt>\r
 240 <dd>\r
 241 <p>\r
 242 Toggle fullscreen mode.\r
 243 </p>\r
 244 </dd>\r
 245 <dt class="hdlist1">\r
 246 Mod1+s\r
 247 </dt>\r
 248 <dd>\r
 249 <p>\r
 250 Enable stacking layout for the current container.\r
 251 </p>\r
 252 </dd>\r
 253 <dt class="hdlist1">\r
 254 Mod1+e\r
 255 </dt>\r
 256 <dd>\r
 257 <p>\r
 258 Enable default layout for the current container.\r
 259 </p>\r
 260 </dd>\r
 261 <dt class="hdlist1">\r
 262 Mod1+w\r
 263 </dt>\r
 264 <dd>\r
 265 <p>\r
 266 Enable tabbed layout for the current container.\r
 267 </p>\r
 268 </dd>\r
 269 <dt class="hdlist1">\r
 270 Mod1+Shift+Space\r
 271 </dt>\r
 272 <dd>\r
 273 <p>\r
 274 Toggle tiling/floating for the current container.\r
 275 </p>\r
 276 </dd>\r
 277 <dt class="hdlist1">\r
 278 Mod1+Space\r
 279 </dt>\r
 280 <dd>\r
 281 <p>\r
 282 Select the first tiling container if the current container is floating and\r
 283 vice-versa.\r
 284 </p>\r
 285 </dd>\r
 286 <dt class="hdlist1">\r
 287 Mod1+Shift+q\r
 288 </dt>\r
 289 <dd>\r
 290 <p>\r
 291 Kills the current window. This is equivalent to "clicking on the close button",\r
 292 meaning a polite request to the application to close this window. For example,\r
 293 Firefox will save its session upon such a request. If the application does not\r
 294 support that, the window will be killed and it depends on the application what\r
 295 happens.\r
 296 </p>\r
 297 </dd>\r
 298 <dt class="hdlist1">\r
 299 Mod1+Shift+r\r
 300 </dt>\r
 301 <dd>\r
 302 <p>\r
 303 Restarts i3 in place. Your layout will be preserved.\r
 304 </p>\r
 305 </dd>\r
 306 <dt class="hdlist1">\r
 307 Mod1+Shift+e\r
 308 </dt>\r
 309 <dd>\r
 310 <p>\r
 311 Exits i3.\r
 312 </p>\r
 313 </dd>\r
 314 </dl></div>\r
 315 </div>\r
 316 </div>\r
 317 <div class="sect1">\r
 318 <h2 id="_files">6. FILES</h2>\r
 319 <div class="sectionbody">\r
 320 <div class="sect2">\r
 321 <h3 id="_i3_config_or_config_i3_config">6.1. ~/.i3/config (or ~/.config/i3/config)</h3>\r
 322 <div class="paragraph"><p>When starting, i3 looks for configuration files in the following order:</p></div>\r
 323 <div class="olist arabic"><ol class="arabic">\r
 324 <li>\r
 325 <p>\r
 326 ~/.config/i3/config (or $XDG_CONFIG_HOME/i3/config if set)\r
 327 </p>\r
 328 </li>\r
 329 <li>\r
 330 <p>\r
 331 /etc/xdg/i3/config (or $XDG_CONFIG_DIRS/i3/config if set)\r
 332 </p>\r
 333 </li>\r
 334 <li>\r
 335 <p>\r
 336 ~/.i3/config\r
 337 </p>\r
 338 </li>\r
 339 <li>\r
 340 <p>\r
 341 /etc/i3/config\r
 342 </p>\r
 343 </li>\r
 344 </ol></div>\r
 345 <div class="paragraph"><p>You can specify a custom path using the -c option.</p></div>\r
 346 <div class="listingblock">\r
 347 <div class="title">Sample configuration</div>\r
 348 <div class="content">\r
 349 <pre><tt># i3 config file (v4)\r
 350 \r
 351 # font for window titles. ISO 10646 = Unicode\r
 352 font -misc-fixed-medium-r-normal--13-120-75-75-C-70-iso10646-1\r
 353 \r
 354 # use Mouse+Mod1 to drag floating windows to their wanted position\r
 355 floating_modifier Mod1\r
 356 \r
 357 # start a terminal\r
 358 bindsym Mod1+Return exec /usr/bin/urxvt\r
 359 \r
 360 # kill focused window\r
 361 bindsym Mod1+Shift+q kill\r
 362 \r
 363 # start dmenu (a program launcher)\r
 364 bindsym Mod1+d exec /usr/bin/dmenu_run\r
 365 \r
 366 # change focus\r
 367 bindsym Mod1+j focus left\r
 368 bindsym Mod1+k focus down\r
 369 bindsym Mod1+l focus up\r
 370 bindsym Mod1+semicolon focus right\r
 371 \r
 372 # alternatively, you can use the cursor keys:\r
 373 bindsym Mod1+Left focus left\r
 374 bindsym Mod1+Down focus down\r
 375 bindsym Mod1+Up focus up\r
 376 bindsym Mod1+Right focus right\r
 377 \r
 378 # move focused window\r
 379 bindsym Mod1+Shift+j move left\r
 380 bindsym Mod1+Shift+k move down\r
 381 bindsym Mod1+Shift+l move up\r
 382 bindsym Mod1+Shift+semicolon move right\r
 383 \r
 384 # alternatively, you can use the cursor keys:\r
 385 bindsym Mod1+Shift+Left move left\r
 386 bindsym Mod1+Shift+Down move down\r
 387 bindsym Mod1+Shift+Up move up\r
 388 bindsym Mod1+Shift+Right move right\r
 389 \r
 390 # split in horizontal orientation\r
 391 bindsym Mod1+h split h\r
 392 \r
 393 # split in vertical orientation\r
 394 bindsym Mod1+v split v\r
 395 \r
 396 # enter fullscreen mode for the focused container\r
 397 bindsym Mod1+f fullscreen\r
 398 \r
 399 # change container layout (stacked, tabbed, default)\r
 400 bindsym Mod1+s layout stacking\r
 401 bindsym Mod1+w layout tabbed\r
 402 bindsym Mod1+e layout default\r
 403 \r
 404 # toggle tiling / floating\r
 405 bindsym Mod1+Shift+space floating toggle\r
 406 \r
 407 # change focus between tiling / floating windows\r
 408 bindsym Mod1+space focus mode_toggle\r
 409 \r
 410 # focus the parent container\r
 411 bindsym Mod1+a focus parent\r
 412 \r
 413 # focus the child container\r
 414 #bindsym Mod1+d focus child\r
 415 \r
 416 # switch to workspace\r
 417 bindsym Mod1+1 workspace 1\r
 418 bindsym Mod1+2 workspace 2\r
 419 # ..\r
 420 \r
 421 # move focused container to workspace\r
 422 bindsym Mod1+Shift+1 move workspace 1\r
 423 bindsym Mod1+Shift+2 move workspace 2\r
 424 # ...\r
 425 \r
 426 # reload the configuration file\r
 427 bindsym Mod1+Shift+c reload\r
 428 # restart i3 inplace (preserves your layout/session, can be used to upgrade i3)\r
 429 bindsym Mod1+Shift+r restart\r
 430 # exit i3 (logs you out of your X session)\r
 431 bindsym Mod1+Shift+e exit\r
 432 \r
 433 # display workspace buttons plus a statusline generated by i3status\r
 434 bar {\r
 435     status_command i3status\r
 436 }</tt></pre>\r
 437 </div></div>\r
 438 </div>\r
 439 <div class="sect2">\r
 440 <h3 id="_xsession">6.2. ~/.xsession</h3>\r
 441 <div class="paragraph"><p>This file is where you should configure your locales and start i3. It is run by\r
 442 your login manager (xdm, slim, gdm, …) as soon as you login.</p></div>\r
 443 <div class="listingblock">\r
 444 <div class="title">Sample xsession</div>\r
 445 <div class="content">\r
 446 <pre><tt># Disable DPMS turning off the screen\r
 447 xset -dpms\r
 448 xset s off\r
 449 \r
 450 # Disable bell\r
 451 xset -b\r
 452 \r
 453 # Enable zapping (C-A-&lt;Bksp&gt; kills X)\r
 454 setxkbmap -option terminate:ctrl_alt_bksp\r
 455 \r
 456 # Enforce correct locales from the beginning\r
 457 unset LC_COLLATE\r
 458 export LC_CTYPE=de_DE.UTF-8\r
 459 export LC_TIME=de_DE.UTF-8\r
 460 export LC_NUMERIC=de_DE.UTF-8\r
 461 export LC_MONETARY=de_DE.UTF-8\r
 462 export LC_MESSAGES=C\r
 463 export LC_PAPER=de_DE.UTF-8\r
 464 export LC_NAME=de_DE.UTF-8\r
 465 export LC_ADDRESS=de_DE.UTF-8\r
 466 export LC_TELEPHONE=de_DE.UTF-8\r
 467 export LC_MEASUREMENT=de_DE.UTF-8\r
 468 export LC_IDENTIFICATION=de_DE.UTF-8\r
 469 \r
 470 # Use XToolkit in java applications\r
 471 export AWT_TOOLKIT=XToolkit\r
 472 \r
 473 # Set background color\r
 474 xsetroot -solid "#333333"\r
 475 \r
 476 # Enable core dumps in case something goes wrong\r
 477 ulimit -c unlimited\r
 478 \r
 479 # Start i3 and log to ~/.i3/logfile\r
 480 echo "Starting at $(date)" &gt;&gt; ~/.i3/logfile\r
 481 exec /usr/bin/i3 -V -d all &gt;&gt; ~/.i3/logfile</tt></pre>\r
 482 </div></div>\r
 483 </div>\r
 484 </div>\r
 485 </div>\r
 486 <div class="sect1">\r
 487 <h2 id="_environment">7. ENVIRONMENT</h2>\r
 488 <div class="sectionbody">\r
 489 <div class="sect2">\r
 490 <h3 id="_i3sock">7.1. I3SOCK</h3>\r
 491 <div class="paragraph"><p>This variable overwrites the IPC socket path (placed in\r
 492 /tmp/i3-%u.XXXXXX/ipc-socket.%p by default, where %u is replaced with your UNIX\r
 493 username, %p is replaced with i3’s PID and XXXXXX is a string of random\r
 494 characters from the portable filename character set (see mkdtemp(3))). The IPC\r
 495 socket is used by external programs like i3-msg(1) or i3bar(1).</p></div>\r
 496 </div>\r
 497 </div>\r
 498 </div>\r
 499 <div class="sect1">\r
 500 <h2 id="_todo">8. TODO</h2>\r
 501 <div class="sectionbody">\r
 502 <div class="paragraph"><p>There is still lot of work to do. Please check our bugtracker for up-to-date\r
 503 information about tasks which are still not finished.</p></div>\r
 504 </div>\r
 505 </div>\r
 506 <div class="sect1">\r
 507 <h2 id="_see_also">9. SEE ALSO</h2>\r
 508 <div class="sectionbody">\r
 509 <div class="paragraph"><p>You should have a copy of the userguide (featuring nice screenshots/graphics\r
 510 which is why this is not integrated into this manpage), the debugging guide,\r
 511 and the "how to hack" guide. If you are building from source, run:\r
 512  <tt>make -C docs</tt></p></div>\r
 513 <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
 514 <div class="paragraph"><p>i3-input(1), i3-msg(1), i3-wsbar(1), i3-nagbar(1), i3-config-wizard(1),\r
 515 i3-migrate-config-to-v4(1)</p></div>\r
 516 </div>\r
 517 </div>\r
 518 <div class="sect1">\r
 519 <h2 id="_author">10. AUTHOR</h2>\r
 520 <div class="sectionbody">\r
 521 <div class="paragraph"><p>Michael Stapelberg and contributors</p></div>\r
 522 </div>\r
 523 </div>\r
 524 </div>\r
 525 <div id="footnotes"><hr /></div>\r
 526 <div id="footer" lang="de">\r
 527 © 2009-2011 Michael Stapelberg, <a href="/impress.html">Impressum</a>\r
 528 </div>\r
 529 </body>\r
 530 </html>\r